ppapi/api/ppb_image_capture.idl - Issue 391323002: Pepper: add Image Capture interfaces.

Side by Side Diff: ppapi/api/ppb_image_capture.idl

Issue 391323002: Pepper: add Image Capture interfaces. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: add PP_ImageCaptureConfig and PP_ImageCaptureCapabilities Created 6 years, 5 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

OLD	NEW
(Empty)
	1 /* Copyright 2014 The Chromium Authors. All rights reserved.

	2 * Use of this source code is governed by a BSD-style license that can be

	3 * found in the LICENSE file.

	4 */

	5

	6 /**

	7 * Defines the <code>PPB_ImageCapture</code> interface. Used for taking

	8 * a picture from the source of a MediaStream video track.

	9 */

	10

	11 [generate_thunk]

	12

	13 label Chrome {

	14 [channel=dev] M39 = 0.1

	15 };

	16

	17 [version=0.1]

	18 interface PPB_ImageCapture {

	19 /**

	20 * Creates a PPB_ImageCapture resource.

	21 *

	22 * @param[in] media_stream_video_track A <code>PP_Resource</code> identifying

	23 * one MediaStream video track.

	24 *
	Justin Chuang 2014/07/21 17:34:56 What happens if the video track is Close()-ed? What happens if the video track is Close()-ed? wuchengli 2014/07/29 03:24:49 Now I think video track and image capture should b Show quoted text On 2014/07/21 17:34:56, Justin Chuang wrote: > What happens if the video track is Close()-ed? Now I think video track and image capture should be decoupled more. We should not force the applications to have an active video track when using image capture. The constructor simply provides a way to use the same camera that video tracks associates with. So the plugin can continue to use ImageCapture object if the video track is closed. Pawel. Does V4L2 require that some settings can only be controlled when streaming is on? For example, can we control autofocus when streaming is off? Owen Lin 2014/07/29 03:34:43 I think we need stream on to take a photo. It need I think we need stream on to take a photo. It need continuously to adjust the 3A settings.
	25 * @return A <code>PP_Resource</code> corresponding to a

	26 * PPB_ImageCapture resource if successful, 0 if failed.

	27 */

	28 PP_Resource Create([in] PP_Resource media_stream_video_track);
	dmichael (off chromium) 2014/07/16 23:10:54 I'm a little unsure about this. I like that it nea I'm a little unsure about this. I like that it neatly takes care of permissions, but it's a little strange. There's not an analogous JavaScript API exactly. This is kind of a lower-level API, wanting to control stuff like AutoFocus. wuchengli 2014/07/17 14:05:47 I followed the design in Mediastream Image Capture Show quoted text On 2014/07/16 23:10:54, dmichael wrote: > I'm a little unsure about this. I like that it neatly takes care of permissions, > but it's a little strange. There's not an analogous JavaScript API exactly. This > is kind of a lower-level API, wanting to control stuff like AutoFocus. I followed the design in Mediastream Image Capture draft. The idea is MediaStreamVideoTrack is for preview and we want to use the same camera to take a picture. Or we can take a video sourceId or MediaStreamTrack.id in the constructor. http://www.w3.org/TR/image-capture/#taking-a-picture-if-red-eye-reduction-is-... wuchengli 2014/07/29 03:24:49 I've changed the constructor argument to source ID Show quoted text On 2014/07/17 14:05:47, wuchengli wrote: > On 2014/07/16 23:10:54, dmichael wrote: > > I'm a little unsure about this. I like that it neatly takes care of > permissions, > > but it's a little strange. There's not an analogous JavaScript API exactly. > This > > is kind of a lower-level API, wanting to control stuff like AutoFocus. > I followed the design in Mediastream Image Capture draft. The idea is > MediaStreamVideoTrack is for preview and we want to use the same camera to take > a picture. Or we can take a video sourceId or MediaStreamTrack.id in the > constructor. > > http://www.w3.org/TR/image-capture/#taking-a-picture-if-red-eye-reduction-is-... I've changed the constructor argument to source ID.
	29

	30 /**

	31 * Determines if a resource is an image capture resource.

	32 *

	33 * @param[in] resource The <code>PP_Resource</code> to test.

	34 *

	35 * @return A <code>PP_Bool</code> with <code>PP_TRUE</code> if the given

	36 * resource is an image capture resource or <code>PP_FALSE</code>

	37 * otherwise.

	38 */

	39 PP_Bool IsImageCapture([in] PP_Resource resource);

	40

	41 /**

	42 * Sets the configuration of the image capture.

	43 * If <code>SetConfig()</code> is not called, default settings will be used.

	44 *

	45 * @param[in] image_capture A <code>PP_Resource</code> corresponding to an

	46 * image capture resource.

	47 * @param[in] config A <code>PP_ImageCaptureConfig</code> object.

	48 * @param[in] callback <code>PP_CompletionCallback</code> to be called upon

	49 * completion of <code>SetConfig()</code>.

	50 *

	51 * @return An int32_t containing a result code from <code>pp_errors.h</code>.

	52 * Returns <code>PP_ERROR_INPROGRESS</code> if there is a pending call of

	53 * <code>SetConfig()</code> or <code>TakePhoto()</code>.

	54 * If an error is returned, all configuration will not be changed.

	55 */

	56 int32_t SetConfig([in] PP_Resource image_capture,

	57 [in] PP_Resource config,

	58 [in] PP_CompletionCallback callback);

	59

	60 /**

	61 * Gets the configuration of the image capture.

	62 *

	63 * @param[in] image_capture A <code>PP_Resource</code> corresponding to an

	64 * image capture resource.

	65 * @param[out] config A <code>PP_ImageCaptureConfig</code> for storing the

	66 * current image capture config on success. Otherwise, the values will not be

	67 * changed.

	68 * @param[in] callback <code>PP_CompletionCallback</code> to be called upon

	69 * completion of <code>GetConfig()</code>.

	70 *

	71 * @return An int32_t containing a result code from <code>pp_errors.h</code>.

	72 */

	73 int32_t GetConfig([in] PP_Resource image_capture,

	74 [out] PP_Resource config,

	75 [in] PP_CompletionCallback callback);

	76

	77 /**

	78 * Gets the image capture capabilities of the camera.

	79 *

	80 * @param[in] image_capture A <code>PP_Resource</code> corresponding to an

	81 * image capture resource.

	82 * @param[out] capabilities A <code>PP_ImageCaptureCapabilities</code> for

	83 * storing the image capture capabilities on success. Otherwise, the value

	84 * will not be changed.

	85 * @param[in] callback <code>PP_CompletionCallback</code> to be called upon

	86 * completion of <code>GetCapabilities()</code>.

	87 *

	88 * @return An int32_t containing a result code from <code>pp_errors.h</code>.

	89 */

	90 int32_t GetCapabilities([in] PP_Resource image_capture,

	91 [out] PP_Resource capabilities,

	92 [in] PP_CompletionCallback callback);

	93

	94 /**

	95 * Takes a photo from the camera.

	96 *
	Justin Chuang 2014/07/21 17:34:56 Add comments that it may mute()/unmute() the paire Add comments that it may mute()/unmute() the paired video track object? It seems important. wuchengli 2014/07/29 03:24:50 Done. Show quoted text On 2014/07/21 17:34:56, Justin Chuang wrote: > Add comments that it may mute()/unmute() the paired video track object? It seems > important. Done.
	97 * @param[in] image_capture A <code>PP_Resource</code> corresponding to an

	98 * image capture resource.

	99 * @param[out] postview_frame A <code>PP_Resource</code> corresponding to a

	100 * VideoFrame resource used to store the postview. The client can use this to

	101 * show the captured photo. The format and the size are decided by the

	102 * associated MediaStream video track.

	103 * @param[out] photo A <code>PP_Resource</code> corresponding to a VideoFrame

	104 * resource used to store the encoded picture. The default format is JPEG.
	Justin Chuang 2014/07/21 17:34:56 I suspect that we need to add a new PP_Resource. I suspect that we need to add a new PP_Resource. I'm not sure if PPB_ImageData fits here, which seems to be designed for alpha-blending immediately (only premultiplied ARGB format). I don't know if extending PPB_ImageData to support JPG will break the overall design. wuchengli 2014/07/29 03:24:49 PPB_ImageData applies to only ARGB so we should no Show quoted text On 2014/07/21 17:34:56, Justin Chuang wrote: > I suspect that we need to add a new PP_Resource. > > I'm not sure if PPB_ImageData fits here, which seems to be designed for > alpha-blending immediately (only premultiplied ARGB format). I don't know if > extending PPB_ImageData to support JPG will break the overall design. PPB_ImageData applies to only ARGB so we should not use it. It looks like we can add Jpeg to ppapi/api/ppb_video_frame.idl (not ppapi/api/private/pp_video_frame_private.idl). So I use VideoFrame PP_Resource for both postview and jpeg pictures.
	105 * @param[in] callback A <code>PP_CompletionCallback</code> to be called when

	106 * the picture has been taken and the camera can be moved without making the

	107 * picture blurry. The client can play a shutter sound if needed.

	108 * @param[in] postview_callback A <code>PP_CompletionCallback</code> to be

	109 * called to store a postview video frame in <code>postview_frame</code>

	110 * @param[in] photo_callback A <code>PP_CompletionCallback</code> to be

	111 * called upon completion of TakePhoto(). <code>photo</code> will contain the

	112 * encoded picture.
	Justin Chuang 2014/07/21 17:34:56 A general question: do we want to do something lik A general question: do we want to do something like PPB_MediaStreamVideoTrack.RecycleFrame()? I'm worried about the internal memory fragmentation, esp when the image size can go up to 10MB. I've never done real camera handling before, just a feeling that a frame ring can be also helpful when supporting burst mode in the future. wuchengli 2014/07/29 03:24:49 We may need it in the future. When I was on Androi Show quoted text On 2014/07/21 17:34:56, Justin Chuang wrote: > A general question: do we want to do something like > PPB_MediaStreamVideoTrack.RecycleFrame()? I'm worried about the internal memory > fragmentation, esp when the image size can go up to 10MB. We may need it in the future. When I was on Android, taking pictures allocated memory every time, caused lots of GC, and slowed down the image capture. But the size of Jpeg is not fixed like YUV. So the buffer size has to be provided by the driver. Let's make image capture work first and come back to optimization later. Show quoted text > > I've never done real camera handling before, just a feeling that a frame ring > can be also helpful when supporting burst mode in the future. We should only expose the minimum API that are required today. Let's worry about this in the future.
	113 *

	114 * @return An int32_t containing a result code from <code>pp_errors.h</code>.

	115 */

	116 int32_t TakePhoto([in] PP_Resource image_capture,

	117 [out] PP_Resource postview_frame,

	118 [out] PP_Resource photo,

	119 [in] PP_CompletionCallback shutter_callback,

	120 [in] PP_CompletionCallback postview_callback,

	121 [in] PP_CompletionCallback photo_callback);
	dmichael (off chromium) 2014/07/16 23:10:54 We can't use multiple completion callbacks for 1 f We can't use multiple completion callbacks for 1 function. It's supposed to be possible to pass a blocking callback. It's not clear what would happen if one callback was passed as blocking and two others weren't for instance. And the return code is sometimes an indication of whether the callback will be run. So it's unclear what PP_OK_COMPLETIONPENDING or PP_OK would mean... which callback(s) will still be run? Two alternatives: 1) Split it in to multiple calls, each with its own completion callbakc. 2) Use a PPP-style interface (See PPB_Messaging::RegisterMessageHandler and PPP_MessageHandler) 1 might be best, since it would allow you to block at each stage. Either lets you get your result on a background thread. wuchengli 2014/07/17 14:05:47 You are right. I read the documentation of complet Show quoted text On 2014/07/16 23:10:54, dmichael wrote: > We can't use multiple completion callbacks for 1 function. It's supposed to be > possible to pass a blocking callback. It's not clear what would happen if one > callback was passed as blocking and two others weren't for instance. And the > return code is sometimes an indication of whether the callback will be run. > > So it's unclear what PP_OK_COMPLETIONPENDING or PP_OK would mean... which > callback(s) will still be run? > > Two alternatives: > 1) Split it in to multiple calls, each with its own completion callbakc. > 2) Use a PPP-style interface (See PPB_Messaging::RegisterMessageHandler and > PPP_MessageHandler) > > 1 might be best, since it would allow you to block at each stage. Either lets > you get your result on a background thread. You are right. I read the documentation of completion callback and it doesn't make sense to have three of them for one function. TakePhoto should be one function call and three callbacks. Making multiple calls is not efficient. I'll try option 2. wuchengli 2014/07/29 03:24:49 I moved the callbacks to PPP_ImageCapture_Private. Show quoted text On 2014/07/17 14:05:47, wuchengli wrote: > On 2014/07/16 23:10:54, dmichael wrote: > > We can't use multiple completion callbacks for 1 function. It's supposed to be > > possible to pass a blocking callback. It's not clear what would happen if one > > callback was passed as blocking and two others weren't for instance. And the > > return code is sometimes an indication of whether the callback will be run. > > > > So it's unclear what PP_OK_COMPLETIONPENDING or PP_OK would mean... which > > callback(s) will still be run? > > > > Two alternatives: > > 1) Split it in to multiple calls, each with its own completion callbakc. > > 2) Use a PPP-style interface (See PPB_Messaging::RegisterMessageHandler and > > PPP_MessageHandler) > > > > 1 might be best, since it would allow you to block at each stage. Either lets > > you get your result on a background thread. > You are right. I read the documentation of completion callback and it doesn't > make sense to have three of them for one function. > > TakePhoto should be one function call and three callbacks. Making multiple calls > is not efficient. I'll try option 2. I moved the callbacks to PPP_ImageCapture_Private. This is how all other pepper APIs do like PPB_VideoDecoder/PPP_VideoDecoder.
	122 };

OLD	NEW

« no previous file with comments | « no previous file | ppapi/api/ppb_image_capture_capabilities.idl » ('j') | ppapi/api/ppb_image_capture_capabilities.idl » ('J')