diff options
Diffstat (limited to 'ppapi/c')
| -rw-r--r-- | ppapi/c/dev/pp_video_capture_dev.h | 49 | ||||
| -rw-r--r-- | ppapi/c/dev/ppb_video_capture_dev.h | 91 | ||||
| -rw-r--r-- | ppapi/c/dev/ppp_video_capture_dev.h | 69 |
3 files changed, 209 insertions, 0 deletions
diff --git a/ppapi/c/dev/pp_video_capture_dev.h b/ppapi/c/dev/pp_video_capture_dev.h new file mode 100644 index 0000000..6f35313 --- /dev/null +++ b/ppapi/c/dev/pp_video_capture_dev.h @@ -0,0 +1,49 @@ +/* Copyright (c) 2011 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. + */ +#ifndef PPAPI_C_DEV_PP_VIDEO_CAPTURE_DEV_H_ +#define PPAPI_C_DEV_PP_VIDEO_CAPTURE_DEV_H_ + +#include "ppapi/c/pp_stdint.h" + +/** + * PP_VideoCaptureDeviceInfo_Dev is a structure that represent a video capture + * configuration, such as resolution and frame rate. + */ +struct PP_VideoCaptureDeviceInfo_Dev { + uint32_t width; + uint32_t height; + uint32_t frames_per_second; +}; +PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_VideoCaptureDeviceInfo_Dev, 12); + +/** + * PP_VideoCaptureStatus_Dev is an enumeration that defines the various possible + * states of a VideoCapture. + */ +typedef enum { + /** + * Initial state, capture is stopped. + */ + PP_VIDEO_CAPTURE_STATUS_STOPPED, + /** + * StartCapture has been called, but capture hasn't started yet. + */ + PP_VIDEO_CAPTURE_STATUS_STARTING, + /** + * Capture is started. + */ + PP_VIDEO_CAPTURE_STATUS_STARTED, + /** + * Capture has been started, but is paused because no buffer is available. + */ + PP_VIDEO_CAPTURE_STATUS_PAUSED, + /** + * StopCapture has been called, but capture hasn't stopped yet. + */ + PP_VIDEO_CAPTURE_STATUS_STOPPING +} PP_VideoCaptureStatus_Dev; +PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_VideoCaptureStatus_Dev, 4); + +#endif /* PPAPI_C_DEV_PP_VIDEO_CAPTURE_DEV_H_ */ diff --git a/ppapi/c/dev/ppb_video_capture_dev.h b/ppapi/c/dev/ppb_video_capture_dev.h new file mode 100644 index 0000000..21a18de --- /dev/null +++ b/ppapi/c/dev/ppb_video_capture_dev.h @@ -0,0 +1,91 @@ +/* Copyright (c) 2011 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. + */ +#ifndef PPAPI_C_DEV_PPB_VIDEO_CAPTURE_DEV_H_ +#define PPAPI_C_DEV_PPB_VIDEO_CAPTURE_DEV_H_ + +#include "ppapi/c/dev/pp_video_capture_dev.h" +#include "ppapi/c/pp_bool.h" +#include "ppapi/c/pp_instance.h" +#include "ppapi/c/pp_resource.h" +#include "ppapi/c/pp_stdint.h" + +#define PPB_VIDEO_CAPTURE_DEV_INTERFACE_0_1 "PPB_VideoCapture(Dev);0.1" +#define PPB_VIDEO_CAPTURE_DEV_INTERFACE PPB_VIDEO_CAPTURE_DEV_INTERFACE_0_1 + +/** + * Video capture interface. It goes hand-in-hand with PPP_VideoCapture_Dev. + * + * Theory of operation: + * 1- Create a VideoCapture resource using Create. + * 2- Start the capture using StartCapture. You pass in the requested info + * (resolution, frame rate), as well as suggest a number of buffers you will + * need. + * 3- Receive the OnDeviceInfo callback, in PPP_VideoCapture_Dev, which will + * give you the actual capture info (the requested one is not guaranteed), as + * well as an array of buffers allocated by the browser. + * 4- On every frame captured by the browser, OnBufferReady (in + * PPP_VideoCapture_Dev) is called with the index of the buffer from the array + * containing the new frame. The buffer is now "owned" by the plugin, and the + * browser won't reuse it until ReuseBuffer is called. + * 5- When the plugin is done with the buffer, call ReuseBuffer + * 6- Stop the capture using StopCapture. + * + * The browser may change the resolution based on the constraints of the system, + * in which case OnDeviceInfo will be called again, with new buffers. + * + * The buffers contain the pixel data for a frame. The format is planar YUV + * 4:2:0, one byte per pixel, tightly packed (width x height Y values, then + * width/2 x height/2 U values, then width/2 x height/2 V values). + */ +struct PPB_VideoCapture_Dev { + /** + * Creates a new VideoCapture. + */ + PP_Resource (*Create)(PP_Instance instance); + + /** + * Returns PP_TRUE if the given resource is a VideoCapture. + */ + PP_Bool (*IsVideoCapture)(PP_Resource video_capture); + + /** + * Starts the capture. |requested_info| is a pointer to a structure containing + * the requested resolution and frame rate. |buffer_count| is the number of + * buffers requested by the plugin. Note: it is only used as advisory, the + * browser may allocate more of fewer based on available resources. + * How many buffers depends on usage. At least 2 to make sure latency doesn't + * cause lost frames. If the plugin expects to hold on to more than one buffer + * at a time (e.g. to do multi-frame processing, like video encoding), it + * should request that many more. + * + * Returns PP_ERROR_FAILED if called when the capture was already started, or + * PP_OK on success. + */ + int32_t (*StartCapture)( + PP_Resource video_capture, + const struct PP_VideoCaptureDeviceInfo_Dev* requested_info, + uint32_t buffer_count); + + /** + * Allows the browser to reuse a buffer that was previously sent by + * PPP_VideoCapture_Dev.OnBufferReady. |buffer| is the index of the buffer in + * the array returned by PPP_VideoCapture_Dev.OnDeviceInfo. + * + * Returns PP_ERROR_BADARGUMENT if buffer is out of range (greater than the + * number of buffers returned by PPP_VideoCapture_Dev.OnDeviceInfo), or if it + * is not currently owned by the plugin. Returns PP_OK otherwise. + */ + int32_t (*ReuseBuffer)(PP_Resource video_capture, uint32_t buffer); + + /** + * Stops the capture. + * + * Returns PP_ERROR_FAILED if the capture wasn't already started, or PP_OK on + * success. + */ + int32_t (*StopCapture)(PP_Resource video_capture); +}; + +#endif /* PPAPI_C_DEV_PPB_VIDEO_CAPTURE_DEV_H_ */ diff --git a/ppapi/c/dev/ppp_video_capture_dev.h b/ppapi/c/dev/ppp_video_capture_dev.h new file mode 100644 index 0000000..390ea6f --- /dev/null +++ b/ppapi/c/dev/ppp_video_capture_dev.h @@ -0,0 +1,69 @@ +/* Copyright (c) 2011 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. + */ +#ifndef PPAPI_C_DEV_PPP_VIDEO_CAPTURE_DEV_H_ +#define PPAPI_C_DEV_PPP_VIDEO_CAPTURE_DEV_H_ + +#include "ppapi/c/dev/pp_video_capture_dev.h" +#include "ppapi/c/pp_instance.h" +#include "ppapi/c/pp_resource.h" +#include "ppapi/c/pp_stdint.h" + +#define PPP_VIDEO_CAPTURE_DEV_INTERFACE_0_1 "PPP_VideoCapture(Dev);0.1" +#define PPP_VIDEO_CAPTURE_DEV_INTERFACE PPP_VIDEO_CAPTURE_DEV_INTERFACE_0_1 + +/** + * Video Capture client interface. See |PPB_VideoCapture_Dev| for general theory + * of operation. + */ +struct PPP_VideoCapture_Dev { + /** + * Signals the capture device information, such as resolution and frame rate, + * and the array of buffers that the browser will use to send pixel data. + * + * |info| is a pointer to the PP_VideoCaptureDeviceInfo_Dev structure + * containing resolution and frame rate. + * |buffer_count| is the number of buffers, and |buffers| is the array of + * PPB_Buffer_Dev buffers. + * + * Note: the buffers are passed without an extra reference. The plugin is + * expected to add its own references to the buffers. + */ + void (*OnDeviceInfo)(PP_Instance instance, + PP_Resource video_capture, + const struct PP_VideoCaptureDeviceInfo_Dev* info, + uint32_t buffer_count, + const PP_Resource* buffers); + + /** + * Signals status changes on the VideoCapture. |status| is a + * one of the values from PP_VideoCaptureStatus_Dev; + */ + void (*OnStatus)(PP_Instance instance, + PP_Resource video_capture, + uint32_t status); + + /** + * Signals an error from the video capture system. + * + * Errors that can be generated: + * - PP_ERROR_NOMEMORY: not enough memory was available to allocate buffers. + * - PP_ERROR_FAILED: video capture could not start. + */ + void (*OnError)(PP_Instance instance, + PP_Resource video_capture, + uint32_t error_code); + + /** + * Signals that a buffer is available for consumption by the plugin. + * + * |buffer| is the index of the buffer, in the array returned by OnDeviceInfo. + */ + void (*OnBufferReady)(PP_Instance, + PP_Resource video_capture, + uint32_t buffer); +}; + +#endif /* PPAPI_C_DEV_PPP_VIDEO_CAPTURE_DEV_H_ */ + |