The file declares the video processing functions.
It provides video processing capabilities, including color space conversion, metadata generation, and video scaling.
File to include: <multimedia/video_processing_engine/video_processing.h>
Library: libvideo_processing.so
System capability: SystemCapability.Multimedia.VideoProcessingEngine
Since: 12
Related module: VideoProcessing
VideoProcessing_ErrorCode OH_VideoProcessing_InitializeEnvironment(void)
Description
Initializes the global video processing environment.
This function is optional.
It is called only once when the main process is started to initialize the global video processing environment. This reduces the duration for running OH_VideoProcessing_Create.
The global video processing environment must be released by calling OH_VideoProcessing_DeinitializeEnvironment.
For details about how and when to release the environment, see OH_VideoProcessing_DeinitializeEnvironment.
Since: 12
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The initialization is successful. VIDEO_PROCESSING_ERROR_INITIALIZE_FAILED: The initialization fails. If the operation fails, check whether the GPU works properly. |
VideoProcessing_ErrorCode OH_VideoProcessing_DeinitializeEnvironment(void)
Description
Releases the global video processing environment.
Before calling this API, you must call OH_VideoProcessing_InitializeEnvironment to initialize the environment.
Generally, this function is called when the main process is about to exit.
Do not call this function when a video processing instance is running.
Since: 12
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The processing is successful. VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED: A video processing instance is not destroyed or OH_VideoProcessing_InitializeEnvironment is not called to initialize the environment. |
bool OH_VideoProcessing_IsColorSpaceConversionSupported(const VideoProcessing_ColorSpaceInfo* sourceVideoInfo,const VideoProcessing_ColorSpaceInfo* destinationVideoInfo)
Description
Checks whether color space conversion is supported during video processing.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| const VideoProcessing_ColorSpaceInfo* sourceVideoInfo | Pointer to the color space information of the input video. |
| const VideoProcessing_ColorSpaceInfo* destinationVideoInfo | Pointer to the color space information of the output video. |
Returns
| Type | Description |
|---|---|
| bool | Check result for the support of color space conversion. true if supported, false otherwise. |
bool OH_VideoProcessing_IsMetadataGenerationSupported(const VideoProcessing_ColorSpaceInfo* sourceVideoInfo)
Description
Checks whether metadata generation is supported during video processing.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| const VideoProcessing_ColorSpaceInfo* sourceVideoInfo | Pointer to the color space information of the input video. |
Returns
| Type | Description |
|---|---|
| bool | Check result for the support of metadata generation. true if supported, false otherwise. |
VideoProcessing_ErrorCode OH_VideoProcessing_Create(OH_VideoProcessing** videoProcessor, int type)
Description
Creates a video processing instance.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| OH_VideoProcessing** videoProcessor | Double pointer to the video processing instance created. Before any input, *videoProcessor must be nullptr. |
| int type | Video processing type specified by the video processing instance constant. The processing type of an instance cannot be changed. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The video processing instance is created successfully. VIDEO_PROCESSING_ERROR_UNSUPPORTED_PROCESSING: The processing type is not supported. For example, metadata generation is not supported. VIDEO_PROCESSING_ERROR_CREATE_FAILED: The video processing instance fails to be created. VIDEO_PROCESSING_ERROR_INVALID_INSTANCE: The instance is null or the pointer to the instance is not null. VIDEO_PROCESSING_ERROR_INVALID_PARAMETER: The video processing type is invalid. |
VideoProcessing_ErrorCode OH_VideoProcessing_Destroy(OH_VideoProcessing* videoProcessor)
Description
Destroys a video processing instance.
Before destroying the instance, call OH_VideoProcessing_Stop to stop it.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| OH_VideoProcessing* videoProcessor | Pointer to the video processing instance. You are advised to set the pointer to nullptr after the instance is destroyed. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The instance is destroyed. VIDEO_PROCESSING_ERROR_INVALID_INSTANCE: The instance is null or is not a video processing instance. VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED: The instance is still running. |
VideoProcessing_ErrorCode OH_VideoProcessing_RegisterCallback(OH_VideoProcessing* videoProcessor,const VideoProcessing_Callback* callback, void* userData)
Description
Registers a callback for video processing.
The callback function should be registered before video processing starts. During video processing, it cannot be registered.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| OH_VideoProcessing* videoProcessor | Pointer to the video processing instance. |
| const VideoProcessing_Callback* callback | Pointer to the callback function. |
| void* userData | Pointer to user-defined data, such as this pointer. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The callback function is registered. VIDEO_PROCESSING_ERROR_INVALID_INSTANCE: The instance is null or is not a video processing instance. VIDEO_PROCESSING_ERROR_INVALID_PARAMETER: The callback function pointer is null. VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED: The instance is still running. |
VideoProcessing_ErrorCode OH_VideoProcessing_SetSurface(OH_VideoProcessing* videoProcessor,const OHNativeWindow* window)
Description
Sets an output surface for video processing.
An output surface must be set before video processing starts.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| OH_VideoProcessing* videoProcessor | Pointer to the video processing instance. |
| const OHNativeWindow* window | Pointer to the output surface. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The output surface is successfully set. VIDEO_PROCESSING_ERROR_INVALID_INSTANCE: The instance is null or is not a video processing instance. VIDEO_PROCESSING_ERROR_INVALID_PARAMETER: The window is nullptr. |
VideoProcessing_ErrorCode OH_VideoProcessing_GetSurface(OH_VideoProcessing* videoProcessor, OHNativeWindow** window)
Description
Obtains a surface for video processing.
An input surface must be created before video processing starts, and it must be destroyed by calling OH_NativeWindow_DestroyNativeWindow when it is no longer needed.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| OH_VideoProcessing* videoProcessor | Pointer to the video processing instance. |
| OHNativeWindow** window | Double pointer to the input surface. For example, the input surface pointer can point to an output surface of the video decoder. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The processing is successful. VIDEO_PROCESSING_ERROR_INVALID_INSTANCE: The instance is null or is not a video processing instance. VIDEO_PROCESSING_ERROR_INVALID_PARAMETER: The window is nullptr or the pointer to the window is null. VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED: The surface fails to be created, an input surface has been created, or the video processing instance is running. |
VideoProcessing_ErrorCode OH_VideoProcessing_SetParameter(OH_VideoProcessing* videoProcessor,const OH_AVFormat* parameter)
Description
Sets video processing parameters.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| OH_VideoProcessing* videoProcessor | Pointer to the video processing instance. |
| const OH_AVFormat* parameter | Pointer to the video processing parameter instance, which is used to pass the video processing parameters to be set, such as the video width, height, pixel format, and codec format. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The parameters are successfully set. VIDEO_PROCESSING_ERROR_INVALID_INSTANCE: The instance is null or is not a video processing instance. VIDEO_PROCESSING_ERROR_INVALID_PARAMETER: The parameter is empty. VIDEO_PROCESSING_ERROR_INVALID_VALUE: Some properties of a parameter are invalid, for example, unsupported parameter value. VIDEO_PROCESSING_ERROR_NO_MEMORY: Memory allocation fails. |
VideoProcessing_ErrorCode OH_VideoProcessing_GetParameter(OH_VideoProcessing* videoProcessor, OH_AVFormat* parameter)
Description
Obtains video processing parameters.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| OH_VideoProcessing* videoProcessor | Pointer to the video processing instance. |
| OH_AVFormat* parameter | Pointer to the video processing parameter instance, which is used to obtain the current video processing parameters, such as the video width, height, pixel format, and codec format. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The parameters are obtained. VIDEO_PROCESSING_ERROR_INVALID_INSTANCE: The instance is null or is not a video processing instance. VIDEO_PROCESSING_ERROR_INVALID_PARAMETER: The parameter is empty. |
VideoProcessing_ErrorCode OH_VideoProcessing_Start(OH_VideoProcessing* videoProcessor)
Description
Starts video processing.
After video processing starts, the callback OH_VideoProcessingCallback_OnState reports the VideoProcessing_State.VIDEO_PROCESSING_STATE_RUNNING state.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| OH_VideoProcessing* videoProcessor | Pointer to the video processing instance. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The processing is successful. VIDEO_PROCESSING_ERROR_INVALID_INSTANCE: The instance is null or is not a video processing instance. VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED: No output surface is set, no input surface is created, or the instance is running. |
VideoProcessing_ErrorCode OH_VideoProcessing_Stop(OH_VideoProcessing* videoProcessor)
Description
Stops video processing.
After video processing stops, the callback OH_VideoProcessingCallback_OnState reports the VideoProcessing_State.VIDEO_PROCESSING_STATE_STOPPED state.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| OH_VideoProcessing* videoProcessor | Pointer to the video processing instance. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The processing is successful. VIDEO_PROCESSING_ERROR_INVALID_INSTANCE: The instance is null or is not a video processing instance. VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED: The instance is stopped. |
VideoProcessing_ErrorCode OH_VideoProcessing_RenderOutputBuffer(OH_VideoProcessing* videoProcessor, uint32_t index)
Description
Renders and processes the buffer, and then outputs it.
If the callback function OH_VideoProcessingCallback_OnNewOutputBuffer is set, the buffer index is returned through the callback function after the output buffer is ready.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| OH_VideoProcessing* videoProcessor | Pointer to the video processing instance. |
| uint32_t index | Index of the output buffer. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The processing is successful. VIDEO_PROCESSING_ERROR_INVALID_INSTANCE: The instance is null or is not a video processing instance. VIDEO_PROCESSING_ERROR_INVALID_PARAMETER: The index is invalid. VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED: The callback function OH_VideoProcessingCallback_OnNewOutputBuffer is not set or the instance is stopped. |
VideoProcessing_ErrorCode OH_VideoProcessingCallback_Create(VideoProcessing_Callback** callback)
Description
Creates a video processing callback object.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| VideoProcessing_Callback** callback | Double pointer to the video processing callback object. Before creating a callback object, *callback must be nullptr. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The callback object is created. VIDEO_PROCESSING_ERROR_INVALID_PARAMETER: callback is null. VIDEO_PROCESSING_ERROR_NO_MEMORY: The memory is insufficient. |
VideoProcessing_ErrorCode OH_VideoProcessingCallback_Destroy(VideoProcessing_Callback* callback)
Description
Destroys a video processing callback object. The video processing callback object can be destroyed after the callback function is registered.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| VideoProcessing_Callback* callback | Pointer to the callback object. You are advised to set the pointer to nullptr after the callback object is destroyed. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The callback object is destroyed. VIDEO_PROCESSING_ERROR_INVALID_PARAMETER: callback is null. |
VideoProcessing_ErrorCode OH_VideoProcessingCallback_BindOnError(VideoProcessing_Callback* callback,OH_VideoProcessingCallback_OnError onError)
Description
Binds the callback function OH_VideoProcessingCallback_OnError to a video processing callback object. After the binding is complete, call OH_VideoProcessing_RegisterCallback to register the callback object with the video processing instance for the callback to take effect.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| VideoProcessing_Callback* callback | Pointer to the callback object. |
| OH_VideoProcessingCallback_OnError onError | Callback function to bind. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The binding is successful. VIDEO_PROCESSING_ERROR_INVALID_PARAMETER: callback or onError is null. |
VideoProcessing_ErrorCode OH_VideoProcessingCallback_BindOnState(VideoProcessing_Callback* callback,OH_VideoProcessingCallback_OnState onState)
Description
Binds the callback function OH_VideoProcessingCallback_OnState to a video processing callback object. After the binding is complete, call OH_VideoProcessing_RegisterCallback to register the callback object with the video processing instance for the callback to take effect.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| VideoProcessing_Callback* callback | Pointer to the callback object. |
| OH_VideoProcessingCallback_OnState onState | Callback function to bind. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The binding is successful. VIDEO_PROCESSING_ERROR_INVALID_PARAMETER: callback or onState is null. |
VideoProcessing_ErrorCode OH_VideoProcessingCallback_BindOnNewOutputBuffer(VideoProcessing_Callback* callback,OH_VideoProcessingCallback_OnNewOutputBuffer onNewOutputBuffer)
Description
Binds the callback function OH_VideoProcessingCallback_OnNewOutputBuffer to a video processing callback object. After the binding is complete, call OH_VideoProcessing_RegisterCallback to register the callback object with the video processing instance for the callback to take effect.
Since: 12
Parameters
| Parameter | Description |
|---|---|
| VideoProcessing_Callback* callback | Pointer to the callback object. |
| OH_VideoProcessingCallback_OnNewOutputBuffer onNewOutputBuffer | Callback function to bind. |
Returns
| Type | Description |
|---|---|
| VideoProcessing_ErrorCode | VIDEO_PROCESSING_SUCCESS: The binding is successful. VIDEO_PROCESSING_ERROR_INVALID_PARAMETER: callback is null. |