Rename PPAPI Video Stream APIs.

ppapi/c/private/ppb_video_source_private.h

 /* Copyright (c) 2013 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_reader.idl modified Thu Apr  4 13:47:30 2013. */
+/* From private/ppb_video_source_private.idl,
+ *   modified Thu Apr 25 11:51:30 2013.
+ */
 
-#ifndef PPAPI_C_PPB_VIDEO_READER_H_
-#define PPAPI_C_PPB_VIDEO_READER_H_
+#ifndef PPAPI_C_PRIVATE_PPB_VIDEO_SOURCE_PRIVATE_H_
+#define PPAPI_C_PRIVATE_PPB_VIDEO_SOURCE_PRIVATE_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_resource.h"
 #include "ppapi/c/pp_stdint.h"
 #include "ppapi/c/pp_time.h"
 #include "ppapi/c/pp_var.h"
-#include "ppapi/c/pp_video_frame.h"
+#include "ppapi/c/private/pp_video_frame_private.h"
 
-#define PPB_VIDEOREADER_INTERFACE_0_1 "PPB_VideoReader;0.1"
-#define PPB_VIDEOREADER_INTERFACE PPB_VIDEOREADER_INTERFACE_0_1
+#define PPB_VIDEOSOURCE_PRIVATE_INTERFACE_0_1 "PPB_VideoSource_Private;0.1"
+#define PPB_VIDEOSOURCE_PRIVATE_INTERFACE PPB_VIDEOSOURCE_PRIVATE_INTERFACE_0_1
 
 /**
  * @file
- * This file defines the <code>PPB_VideoReader</code> struct for a video reader
- * resource.
+ * This file defines the <code>PPB_VideoSource_Private</code> interface for a
+ * video source resource, which receives video frames from a MediaStream video
+ * track in the browser.
  */
 
 
 /**
  * @addtogroup Interfaces
  * @{
  */
 /**
- * The <code>PPB_VideoReader</code> interface contains pointers to several
- * functions for creating video reader resources and using them to consume
- * streams of video frames.
+ * The <code>PPB_VideoSource_Private</code> interface contains pointers to
+ * several functions for creating video source resources and using them to
+ * receive video frames from a MediaStream video track in the browser.
  */
-struct PPB_VideoReader_0_1 {
+struct PPB_VideoSource_Private_0_1 {
   /**
-   * Creates a video reader resource.
+   * Creates a video source resource.
    *
-   * @param[in] instance A <code>PP_Instance</code> identifying one instance
-   * of a module.
+   * @param[in] instance A <code>PP_Instance</code> identifying an instance of
+   * a module.
    *
    * @return A <code>PP_Resource</code> with a nonzero ID on success or zero on
    * failure. Failure means the instance was invalid.
    */
   PP_Resource (*Create)(PP_Instance instance);
   /**
-   * Determines if a given resource is a video reader.
+   * Determines if a resource is a video source resource.
    *
-   * @param[in] resource A <code>PP_Resource</code> corresponding to a resource.
+   * @param[in] resource The <code>PP_Resource</code> to test.
    *
    * @return A <code>PP_Bool</code> with <code>PP_TRUE</code> if the given
-   * resource is a video reader or <code>PP_FALSE</code> otherwise.
+   * resource is a video source resource or <code>PP_FALSE</code> otherwise.
    */
-  PP_Bool (*IsVideoReader)(PP_Resource resource);
+  PP_Bool (*IsVideoSource)(PP_Resource resource);
   /**
-   * Opens a video stream with the given id for reading.
+   * Opens a video source for getting frames.
    *
-   * @param[in] reader A <code>PP_Resource</code> corresponding to a video
-   * reader resource.
-   * @param[in] stream_id A <code>PP_Var</code> holding a string uniquely
-   * identifying the stream. This string is application defined.
+   * @param[in] source A <code>PP_Resource</code> corresponding to a video
+   * source resource.
+   * @param[in] stream_url A <code>PP_Var</code> string holding a URL
+   * identifying a MediaStream.
    * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
    * completion of Open().
    *
-   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
-   * Returns PP_ERROR_BADRESOURCE if reader isn't a valid video reader.
-   * Returns PP_ERROR_INPROGRESS if the reader has already opened a stream.
+   * @return An int32_t containing a result code from <code>pp_errors.h</code>.
+   * Returns PP_ERROR_BADRESOURCE if source isn't a valid video source.
+   * Returns PP_ERROR_INPROGRESS if source is already open.
+   * Returns PP_ERROR_FAILED if the MediaStream doesn't exist or if there is
+   * some other browser error.
    */
-  int32_t (*Open)(PP_Resource reader,
-                  struct PP_Var stream_id,
+  int32_t (*Open)(PP_Resource source,
+                  struct PP_Var stream_url,
                   struct PP_CompletionCallback callback);
   /**
-   * Gets the next frame of video from the reader's open stream. The image data
-   * resource returned in the frame will have its reference count incremented by
-   * one and must be managed by the plugin.
+   * Gets a frame from the video source.
+   * The image data resource inside the returned frame will have its reference
+   * count incremented by one and must be managed by the plugin.
    *
-   * @param[in] reader A <code>PP_Resource</code> corresponding to a video
-   * reader resource.
-   * @param[out] frame A <code>PP_VideoFrame</code> to hold a video frame to
-   * read from the open stream.
+   * @param[in] source A <code>PP_Resource</code> corresponding to a video
+   * source resource.
+   * @param[out] frame A <code>PP_VideoFrame_Private</code> to hold a video
+   * frame from the source.
    * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
    * completion of GetNextFrame().
    *
-   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
-   * Returns PP_ERROR_BADRESOURCE if reader isn't a valid video reader.
-   * Returns PP_ERROR_FAILED if the reader has not opened a stream, if the video
-   * frame has an invalid image data resource, or if some other error occurs.
+   * @return An int32_t containing a result code from <code>pp_errors.h</code>.
+   * Returns PP_ERROR_BADRESOURCE if source isn't a valid video source.
+   * Returns PP_ERROR_FAILED if the source is not open, or if some other
+   * browser error occurs.
    */
-  int32_t (*GetFrame)(PP_Resource reader,
-                      struct PP_VideoFrame* frame,
+  int32_t (*GetFrame)(PP_Resource source,
+                      struct PP_VideoFrame_Private* frame,
                       struct PP_CompletionCallback callback);
   /**
-   * Closes the reader's video stream.
+   * Closes the video source.
    *
-   * @param[in] reader A <code>PP_Resource</code> corresponding to a video
-   * reader resource.
+   * @param[in] source A <code>PP_Resource</code> corresponding to a video
+   * source resource.
    */
-  void (*Close)(PP_Resource reader);
+  void (*Close)(PP_Resource source);
 };
 
-typedef struct PPB_VideoReader_0_1 PPB_VideoReader;
+typedef struct PPB_VideoSource_Private_0_1 PPB_VideoSource_Private;
 /**
  * @}
  */
 
-#endif  /* PPAPI_C_PPB_VIDEO_READER_H_ */
+#endif  /* PPAPI_C_PRIVATE_PPB_VIDEO_SOURCE_PRIVATE_H_ */