Update PPB_VideoDecoder documentation.

ppapi/c/ppb_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_video_decoder.idl modified Tue May  6 05:19:45 2014. */
+/* From ppb_video_decoder.idl modified Wed May 21 09:50:52 2014. */
 
 #ifndef PPAPI_C_PPB_VIDEO_DECODER_H_
 #define PPAPI_C_PPB_VIDEO_DECODER_H_
 
 #include "ppapi/c/pp_bool.h"
 #include "ppapi/c/pp_codecs.h"
 #include "ppapi/c/pp_completion_callback.h"
 #include "ppapi/c/pp_instance.h"
 #include "ppapi/c/pp_macros.h"
 #include "ppapi/c/pp_resource.h"
@@ skipping 76 matching lines @@
    * requested profile is not supported. In this case, the client may call
    * Initialize() again with different parameters to find a good configuration.
    */
   int32_t (*Initialize)(PP_Resource video_decoder,
                         PP_Resource graphics3d_context,
                         PP_VideoProfile profile,
                         PP_Bool allow_software_fallback,
                         struct PP_CompletionCallback callback);
   /**
    * Decodes a bitstream buffer. Copies |size| bytes of data from the plugin's
-   * |buffer|. The plugin should maintain the buffer and not call Decode() again
-   * until the decoder signals completion by returning PP_OK or by running
-   * |callback|.
+   * |buffer|. The plugin should wait until the decoder signals completion by
+   * returning PP_OK or by running |callback| before calling Decode() again.
    *
    * In general, each bitstream buffer should contain a demuxed bitstream frame
    * for the selected video codec. For example, H264 decoders expect to receive
    * one AnnexB NAL unit, including the 4 byte start code prefix, while VP8
    * decoders expect to receive a bitstream frame without the IVF frame header.
    *
    * If the call to Decode() eventually results in a picture, the |decode_id|
    * parameter is copied into the returned picture. The plugin can use this to
    * associate decoded pictures with Decode() calls (e.g. to assign timestamps
    * or frame numbers to pictures.) This value is opaque to the API so the
    * plugin is free to pass any value.
    *
    * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
    * decoder.
    * @param[in] decode_id An optional value, chosen by the plugin, that can be
    * used to associate calls to Decode() with decoded pictures returned by
    * GetPicture().
    * @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 on
    * completion.
    *
    * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   * Returns PP_ERROR_FAILED if the decoder isn't initialized or if a Flush()
+   * or Reset() call is pending.
+   * Returns PP_ERROR_INPROGRESS if there is another Decode() call pending.
+   * Returns PP_ERROR_NOMEMORY if a bitstream buffer can't be created.
+   * Returns PP_ERROR_ABORTED when Reset() is called while Decode() is pending.
    */
   int32_t (*Decode)(PP_Resource video_decoder,
                     uint32_t decode_id,
                     uint32_t size,
                     const void* buffer,
                     struct PP_CompletionCallback callback);
   /**
    * Gets the next picture from the decoder. The picture is valid after the
    * decoder signals completion by returning PP_OK or running |callback|. The
    * plugin can call GetPicture() again after the decoder signals completion.
    * When the plugin is finished using the picture, it should return it to the
    * system by calling RecyclePicture().
    *
    * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
    * decoder.
    * @param[out] picture A <code>PP_VideoPicture</code> to hold the decoded
    * picture.
    * @param[in] callback A <code>PP_CompletionCallback</code> to be called on
    * completion.
    *
    * @return An int32_t containing an error code from <code>pp_errors.h</code>.
-   * Returns PP_OK if a picture is available.
+   * Returns PP_ERROR_FAILED if the decoder isn't initialized or if a Reset()
+   * call is pending.
+   * Returns PP_ERROR_INPROGRESS if there is another GetPicture() call pending.
    * Returns PP_ERROR_ABORTED when Reset() is called, or if a call to Flush()
    * completes while GetPicture() is pending.
    */
   int32_t (*GetPicture)(PP_Resource video_decoder,
                         struct PP_VideoPicture* picture,
                         struct PP_CompletionCallback callback);
   /**
    * Recycles a picture that the plugin has received from the decoder.
    * The plugin should call this as soon as it has finished using the texture so
    * the decoder can decode more pictures.
    *
    * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
    * decoder.
    * @param[in] picture A <code>PP_VideoPicture</code> to return to
    * the decoder.
    */
   void (*RecyclePicture)(PP_Resource video_decoder,
                          const struct PP_VideoPicture* picture);
   /**
-   * Flushes the decoder. The plugin should call this when it reaches the end of
-   * its video stream in order to stop cleanly. The decoder will run all pending
-   * calls to completion. The plugin should make no further calls to the decoder
-   * other than GetPicture() and RecyclePicture() until the decoder signals
-   * completion by running the callback. Just before completion, any pending
-   * GetPicture() call will complete by running the callback with result
-   * PP_ERROR_ABORTED to signal that no more pictures are available.
+   * Flushes the decoder. The plugin should call Flush() when it reaches the
+   * end of its video stream in order to stop cleanly. The decoder will run any
+   * pending Decode() call to completion. The plugin should make no further
+   * calls to the decoder other than GetPicture() and RecyclePicture() until
+   * the decoder signals completion by running |callback|. Just before
+   * completion, any pending GetPicture() call will complete by running its
+   * callback with result PP_ERROR_ABORTED to signal that no more pictures are
+   * available. The plugin should recycle any pictures it is using before
+   * resuming decoding.
    *
    * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
    * decoder.
    * @param[in] callback A <code>PP_CompletionCallback</code> to be called on
    * completion.
    *
    * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   * Returns PP_ERROR_FAILED if the decoder isn't initialized.
    */
   int32_t (*Flush)(PP_Resource video_decoder,
                    struct PP_CompletionCallback callback);
   /**
    * Resets the decoder as quickly as possible. The plugin can call Reset() to
-   * skip to another position in the video stream. Pending calls to Decode() and
-   * GetPicture()) are immediately aborted, causing their callbacks to run with
-   * PP_ERROR_ABORTED. The plugin should not make any further calls to the
-   * decoder until the decoder signals completion by running |callback|.
+   * skip to another position in the video stream. After Reset() returns, any
+   * pending calls to Decode() and GetPicture()) abort, causing their callbacks
+   * to run with PP_ERROR_ABORTED. The plugin should not make further calls to
+   * the decoder until the decoder signals completion by running |callback|.
+   * The pictures in use by the plugin remain valid until decoding is resumed,
+   * but need not be recycled.
    *
    * @param[in] video_decoder A <code>PP_Resource</code> identifying the video
    * decoder.
    * @param[in] callback A <code>PP_CompletionCallback</code> to be called on
    * completion.
    *
    * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   * Returns PP_ERROR_FAILED if the decoder isn't initialized.
    */
   int32_t (*Reset)(PP_Resource video_decoder,
                    struct PP_CompletionCallback callback);
 };
 /**
  * @}
  */
 
 #endif  /* PPAPI_C_PPB_VIDEO_DECODER_H_ */