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 Thu Apr 10 18:28:10 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 Decode() to send a bitstream buffer 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. Video decoding is not
+   * supported on all platforms.
+   *
+   * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
+   * decoder.
+   * @param[in] graphics3d_context A <code>PPB_Graphics3D</code> resource to use
+   * during 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 here or to the callback if video decoding is
+   * not available.
+   */
+  int32_t (*Initialize)(PP_Resource video_decoder,
+                        PP_Resource context,
+                        PP_MediaCodec_Profile profile,
+                        struct PP_CompletionCallback callback);
+  /**
+   * Decodes a bitstream buffer. Copies |size| bytes of data from the plugin's
+   * |buffer|. The plugin should maintain the buffer until the callback is run.
+   * If the bitstream buffer results in a picture, the |picture_id| parameter
+   * will be copied into the picture buffer that is returned by
+   * GetPictureBuffer(). This can be used to associate Decode calls with decoded
+   * pictures (e.g. to associate timestamps with pictures.) The plugin can use
+   * the callback to throttle calls to Decode to some constant number to avoid
+   * over consuming system resources.
+   *
+   * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
+   * decoder.
+   * @param[in] picture_id An identifier that can be used to associate calls to
+   * Decode() with decoded pictures returned by GetPictureBuffer().
+   * @param[in] size Buffer size in bytes.
+   * @param[in] buffer Starting address of buffer.
+   * @param[in] callback A <code>PP_CompletionCallback</code> to be called when
+   * the decoder has finished reading the buffer.
+   *
+   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   */
+  int32_t (*Decode)(PP_Resource video_decoder,
+                    uint32_t picture_id,
+                    uint32_t size,
+                    const void* 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 at any time after
+   * |callback| is called. In particular, the plugin can call it from within
+   * |callback| to request another 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. |picture_buffer| will describe the buffer if successful.
+   *
+   * @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 calls to the decoder are completed,
+   * including callbacks to the plugin. Once flushed, the decoder will call
+   * |callback|. While flushing, the plugin should not make any calls to the
+   * decoder. The plugin should call Flush() to signal end of stream to the
+   * decoder.
+   *
+   * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
+   * decoder.
+   * @param[in] callback A <code>PP_CompletionCallback</code> to be called when
+   * flushing is complete.
+   *
+   * @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 calls are aborted,
+   * causing callbacks to run with PP_ERROR_ABORTED. The decoder is put back
+   * into a state ready to receive further Decode calls and |callback| is
+   * called. While resetting, the plugin should not make any calls to the
+   * decoder. The plugin can use Reset() when it needs to seek to a new position
+   * in the stream.
+   *
+   * @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_ */
+