1c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* Copyright (c) 2013 The Chromium Authors. All rights reserved. 2c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Use of this source code is governed by a BSD-style license that can be 3c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * found in the LICENSE file. 4c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */ 5c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 6c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* From private/ppb_video_source_private.idl, 75b892326406927b709cdaf6c384d4ababf456332Ben Murdoch * modified Mon Oct 27 16:13:24 2014. 8c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */ 9c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 10c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#ifndef PPAPI_C_PRIVATE_PPB_VIDEO_SOURCE_PRIVATE_H_ 11c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#define PPAPI_C_PRIVATE_PPB_VIDEO_SOURCE_PRIVATE_H_ 12c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 13c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "ppapi/c/pp_bool.h" 14c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "ppapi/c/pp_completion_callback.h" 15c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "ppapi/c/pp_instance.h" 16c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "ppapi/c/pp_macros.h" 17c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "ppapi/c/pp_resource.h" 18c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "ppapi/c/pp_stdint.h" 19c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "ppapi/c/pp_time.h" 20c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "ppapi/c/pp_var.h" 21c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "ppapi/c/private/pp_video_frame_private.h" 22c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 23c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#define PPB_VIDEOSOURCE_PRIVATE_INTERFACE_0_1 "PPB_VideoSource_Private;0.1" 24c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#define PPB_VIDEOSOURCE_PRIVATE_INTERFACE PPB_VIDEOSOURCE_PRIVATE_INTERFACE_0_1 25c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 26c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/** 27c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @file 28c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * This file defines the <code>PPB_VideoSource_Private</code> interface for a 29c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * video source resource, which receives video frames from a MediaStream video 30c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * track in the browser. 31c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */ 32c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 33c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 34c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/** 35c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @addtogroup Interfaces 36c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @{ 37c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */ 38c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/** 39c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * The <code>PPB_VideoSource_Private</code> interface contains pointers to 40c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * several functions for creating video source resources and using them to 41c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * receive video frames from a MediaStream video track in the browser. 42c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */ 43c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)struct PPB_VideoSource_Private_0_1 { 44c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /** 45c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Creates a video source resource. 46c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * 47c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @param[in] instance A <code>PP_Instance</code> identifying an instance of 48c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * a module. 49c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * 50c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @return A <code>PP_Resource</code> with a nonzero ID on success or zero on 51c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * failure. Failure means the instance was invalid. 52c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */ 53c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) PP_Resource (*Create)(PP_Instance instance); 54c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /** 55c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Determines if a resource is a video source resource. 56c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * 57c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @param[in] resource The <code>PP_Resource</code> to test. 58c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * 59c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @return A <code>PP_Bool</code> with <code>PP_TRUE</code> if the given 60c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * resource is a video source resource or <code>PP_FALSE</code> otherwise. 61c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */ 62c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) PP_Bool (*IsVideoSource)(PP_Resource resource); 63c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /** 64c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Opens a video source for getting frames. 65c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * 66c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @param[in] source A <code>PP_Resource</code> corresponding to a video 67c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * source resource. 68c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @param[in] stream_url A <code>PP_Var</code> string holding a URL 69c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * identifying a MediaStream. 70c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon 71c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * completion of Open(). 72c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * 73c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @return An int32_t containing a result code from <code>pp_errors.h</code>. 74c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Returns PP_ERROR_BADRESOURCE if source isn't a valid video source. 75c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Returns PP_ERROR_INPROGRESS if source is already open. 76c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Returns PP_ERROR_FAILED if the MediaStream doesn't exist or if there is 77c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * some other browser error. 78c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */ 79c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) int32_t (*Open)(PP_Resource source, 80c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) struct PP_Var stream_url, 81c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) struct PP_CompletionCallback callback); 82c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /** 835b892326406927b709cdaf6c384d4ababf456332Ben Murdoch * Gets a frame from the video source. The returned image data is only valid 845b892326406927b709cdaf6c384d4ababf456332Ben Murdoch * until the next call to GetFrame. 85c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * The image data resource inside the returned frame will have its reference 86c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * count incremented by one and must be managed by the plugin. 87c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * 88c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @param[in] source A <code>PP_Resource</code> corresponding to a video 89c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * source resource. 90c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @param[out] frame A <code>PP_VideoFrame_Private</code> to hold a video 91c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * frame from the source. 92c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon 93c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * completion of GetNextFrame(). 94c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * 95c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @return An int32_t containing a result code from <code>pp_errors.h</code>. 96c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Returns PP_ERROR_BADRESOURCE if source isn't a valid video source. 97c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Returns PP_ERROR_FAILED if the source is not open, or if some other 98c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * browser error occurs. 99c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */ 100c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) int32_t (*GetFrame)(PP_Resource source, 101c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) struct PP_VideoFrame_Private* frame, 102c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) struct PP_CompletionCallback callback); 103c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) /** 104c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Closes the video source. 105c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * 106c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @param[in] source A <code>PP_Resource</code> corresponding to a video 107c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * source resource. 108c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */ 109c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void (*Close)(PP_Resource source); 110c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)}; 111c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 112c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)typedef struct PPB_VideoSource_Private_0_1 PPB_VideoSource_Private; 113c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/** 114c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @} 115c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */ 116c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 117c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#endif /* PPAPI_C_PRIVATE_PPB_VIDEO_SOURCE_PRIVATE_H_ */ 118c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 119