Pepper VideoDecoder API definition.

ppapi/c/ppb_media_codec_video_decoder.h

+/* Copyright (c) 2014 The Chromium Authors. All rights reserved.
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+/* From ppb_media_codec_video_decoder.idl modified Wed Apr  9 08:24:30 2014. */
+
+#ifndef PPAPI_C_PPB_MEDIA_CODEC_VIDEO_DECODER_H_
+#define PPAPI_C_PPB_MEDIA_CODEC_VIDEO_DECODER_H_
+
+#include "ppapi/c/pp_bool.h"
+#include "ppapi/c/pp_completion_callback.h"
+#include "ppapi/c/pp_instance.h"
+#include "ppapi/c/pp_macros.h"
+#include "ppapi/c/pp_media_codec.h"
+#include "ppapi/c/pp_resource.h"
+#include "ppapi/c/pp_size.h"
+#include "ppapi/c/pp_stdint.h"
+
+#define PPB_MEDIACODECVIDEODECODER_INTERFACE_0_1 \
+    "PPB_MediaCodecVideoDecoder;0.1" /* dev */
+/**
+ * @file
+ * This file defines the <code>PPB_MediaCodecVideoDecoder</code> interface.
+ */
+
+
+/**
+ * @addtogroup Interfaces
+ * @{
+ */
+/**
+ * Video decoder interface.
+ *
+ * Typical usage:
+ * - Call Create() to create a new video decoder resource.
+ * - Call Initialize() to initialize it with a 3d graphics context.
+ * - Call GetBitstreamBuffer() to get a buffer to hold bitstream data.
+ * - Fill the bitstream buffer with video data to decode.
+ * - Call Decode() to send the bitstream data to the decoder.
+ * - Call GetPictureBuffer() to get the next decoded picture.
+ * - To signal end of stream to the decoder: call Flush() and wait for the
+ *   callback.
+ * - To reset the decoder (e.g. to implement Seek): call Reset() and wait for
+ *   the callback.
+ */
+struct PPB_MediaCodecVideoDecoder_0_1 { /* dev */
+  /**
+   * Creates a new video decoder resource.
+   *
+   * @param[in] instance A <code>PP_Instance</code> identifying the instance
+   * with the video decoder.
+   *
+   * @return A <code>PP_Resource</code> corresponding to a video decoder if
+   * successful or 0 otherwise.
+   */
+  PP_Resource (*Create)(PP_Instance instance);
+  /**
+   * Determines if the given resource is a video decoder.
+   *
+   * @param[in] resource A <code>PP_Resource</code> identifying a resource.
+   *
+   * @return <code>PP_TRUE</code> if the resource is a
+   * <code>PPB_MediaCodecVideoDecoder</code>, <code>PP_FALSE</code> if the
+   * resource is invalid or some other type.
+   */
+  PP_Bool (*IsMediaCodecVideoDecoder)(PP_Resource resource);
+  /**
+   * Initializes a video decoder resource. This should only be called once,
+   * after Create() and before any other functions. Hardware video decoding is
+   * not supported on all platforms.
+   *
+   * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
+   * decoder.
+   * @param[in] context A <code>PPB_Graphics3D</code> resource to use for
+   * decoding.
+   * @param[in] profile A <code>PP_MediaCodec_Profile</code> specifying the
+   * video stream profile.
+   * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
+   * completion.
+   *
+   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   * Returns PP_ERROR_NOTSUPPORTED on platforms where hardware video decoding is
+   * not available.
+   */
+  int32_t (*Initialize)(PP_Resource video_decoder,
+                        PP_Resource context,
+                        PP_MediaCodec_Profile profile,
+                        struct PP_CompletionCallback callback);
+  /**
+   * Gets a bitstream buffer to hold video data to be decoded. The bitstream
+   * buffer is a read-only struct describing the buffer. The plugin can have
+   * multiple requests for bitstream buffers pending. It should bound the number
+   * of decodes it has in flight to some constant number by throttling its calls
+   * to GetBitstreamBuffer().
+   *
+   * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
+   * decoder.
+   * @param[in] size The size of the buffer in bytes.
+   * @param[out] bitstream_buffer A <code>PP_MediaCodec_BitstreamBuffer</code>
+   * to hold the bitstream buffer.
+   * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
+   * completion.
+   *
+   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   */
+  int32_t (*GetBitstreamBuffer)(
+      PP_Resource video_decoder,
+      uint32_t size,
+      struct PP_MediaCodec_BitstreamBuffer* bitstream_buffer,
+      struct PP_CompletionCallback callback);
+  /**
+   * Decodes a bitstream buffer. The plugin should have first called
+   * GetBitstreamBuffer() and filled the returned buffer with bitstream data.
+   * Decode() takes back ownership of the bitstream buffer. The plugin should
+   * not use |bitstream_buffer| after calling Decode().
+   *
+   * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
+   * decoder.
+   * @param[in] bitstream_buffer A <code>PP_MediaCodec_BitstreamBuffer</code>
+   * holding the bitstream data. This contains a |buffer_id| field that can be
+   * used to associate bitstream buffers with picture buffers.
+   * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
+   * completion.
+   *
+   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   */
+  int32_t (*Decode)(
+      PP_Resource video_decoder,
+      const struct PP_MediaCodec_BitstreamBuffer* bitstream_buffer,
+      struct PP_CompletionCallback callback);
+  /**
+   * Gets the next picture buffer from the decoder. When the plugin is finished
+   * with the picture, it should call RecyclePictureBuffer() to return it to the
+   * system. The plugin can call GetPictureBuffer() again in its callback to
+   * request the next picture.
+   *
+   * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
+   * decoder.
+   * @param[out] picture_buffer A <code>PP_MediaCodec_PictureBuffer</code> to
+   * hold the decoded picture.
+   * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
+   * completion.
+   *
+   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   */
+  int32_t (*GetPictureBuffer)(
+      PP_Resource video_decoder,
+      struct PP_MediaCodec_PictureBuffer* picture_buffer,
+      struct PP_CompletionCallback callback);
+  /**
+   * Recycles a picture buffer that the plugin has received from the decoder.
+   * The plugin should call this as soon as it has finished using the texture so
+   * the system can decode more pictures.
+   *
+   * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
+   * decoder.
+   * @param[in] picture_buffer A <code>PP_MediaCodec_PictureBuffer</code> to
+   * return to the system.
+   */
+  void (*RecyclePictureBuffer)(
+      PP_Resource video_decoder,
+      const struct PP_MediaCodec_PictureBuffer* picture_buffer);
+  /**
+   * Flushes the decoder.  Any pending decodes are completed including callbacks
+   * to the plugin. Once done flushing, the decoder will call |callback|. While
+   * flushing, the plugin should not attempt to decode more video.
+   *
+   * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
+   * decoder.
+   * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
+   * completion.
+   *
+   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   */
+  int32_t (*Flush)(PP_Resource video_decoder,
+                   struct PP_CompletionCallback callback);
+  /**
+   * Resets the decoder as quickly as possible.  Pending decodes are aborted
+   * and the decoder is put back into a state ready to receive further decode
+   * calls. Once all decodes are aborted and reset is complete, |callback| will
+   * be called.
+   *
+   * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
+   * decoder.
+   * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
+   * completion.
+   *
+   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   */
+  int32_t (*Reset)(PP_Resource video_decoder,
+                   struct PP_CompletionCallback callback);
+};
+/**
+ * @}
+ */
+
+#endif  /* PPAPI_C_PPB_MEDIA_CODEC_VIDEO_DECODER_H_ */
+