ohos_video_processing_engine_sys/video_processing/

video_processing_ffi.rs

// automatically generated by rust-bindgen 0.71.1

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
use crate::video_processing_types::{
    OH_VideoProcessing, OH_VideoProcessingCallback_OnError,
    OH_VideoProcessingCallback_OnNewOutputBuffer, OH_VideoProcessingCallback_OnState,
    VideoProcessing_Callback, VideoProcessing_ColorSpaceInfo, VideoProcessing_ErrorCode,
};
use ohos_sys_opaque_types::{OHNativeWindow, OH_AVFormat};

extern "C" {
    /// Initialize global environment for video processing.
    ///
    /// This function is optional.
    ///
    /// Typically, this function is called once when the host process is started to initialize the global environment for
    /// video processing, which can reduce the time of [`OH_VideoProcessing_Create`].
    ///
    /// To deinitialize global environment, call [`OH_VideoProcessing_DeinitializeEnvironment`].
    ///
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if initialization is successful.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INITIALIZE_FAILED`] if initialization is failed.
    ///
    /// You can check if the device GPU is working properly.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_InitializeEnvironment() -> VideoProcessing_ErrorCode;
    /// Deinitialize global environment for video processing.
    ///
    /// This function is required if [`OH_VideoProcessing_InitializeEnvironment`] is called. Typically, this
    /// function is called when the host process is about to exit to deinitialize the global environment, which is
    /// initialized by calling [`OH_VideoProcessing_InitializeEnvironment`].
    ///
    /// If there is some video processing instance existing, this function should not be called.
    ///
    /// If the [`OH_VideoProcessing_InitializeEnvironment`] is not called, this function should not be called.
    ///
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if deinitialization is successful.
    ///
    /// [`VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED`] if some video processing instance is not destroyed or
    /// [`OH_VideoProcessing_InitializeEnvironment`] is not called.
    ///
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_DeinitializeEnvironment() -> VideoProcessing_ErrorCode;
    /// Query if the video color space conversion is supported.
    ///
    /// # Arguments
    ///
    /// * `sourceVideoInfo` - Source video color space information.
    ///
    /// * `destinationVideoInfo` - Destination video color space information.
    ///
    /// # Returns
    ///
    /// * <b>true</b> if the video color space conversion is supported.
    ///
    /// <b>false</b> if the video color space conversion is not supported.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_IsColorSpaceConversionSupported(
        sourceVideoInfo: *const VideoProcessing_ColorSpaceInfo,
        destinationVideoInfo: *const VideoProcessing_ColorSpaceInfo,
    ) -> bool;
    /// Query if the video metadata generation is supported.
    ///
    /// # Arguments
    ///
    /// * `sourceVideoInfo` - Source video color space information.
    ///
    /// # Returns
    ///
    /// * <b>true</b> if the video metadata generation is supported.
    ///
    /// <b>false</b> if the video metadata generation is not supported.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_IsMetadataGenerationSupported(
        sourceVideoInfo: *const VideoProcessing_ColorSpaceInfo,
    ) -> bool;
    /// Create a video processing instance.
    ///
    /// # Arguments
    ///
    /// * `videoProcessor` - Output parameter. The *videoProcessor points to a new video processing object.
    /// The *videoProcessor must be null before passed in.
    ///
    /// * `type` - Use VIDEO_PROCESSING_TYPE_XXX to specify the processing type. The processing type of the instance can not
    /// be changed.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if creating a video processing instance successfully.
    ///
    /// [`VIDEO_PROCESSING_ERROR_UNSUPPORTED_PROCESSING`] if the type is not supported. For example, if metadata
    /// generation is not supported by vendor, it returns unsupported processing.
    ///
    /// [`VIDEO_PROCESSING_ERROR_CREATE_FAILED`] if failed to create a video processing instance.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_INSTANCE`] if instance is null or <b>*</b>instance is <b>not</b> null.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_PARAMETER`] if type is invalid.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_Create(
        videoProcessor: *mut *mut OH_VideoProcessing,
        type_: ::core::ffi::c_int,
    ) -> VideoProcessing_ErrorCode;
    /// Destroy the video processing instance.
    ///
    /// Stop the instance before destroying it. see [`OH_VideoProcessing_Stop`].
    ///
    ///
    /// # Arguments
    ///
    /// * `videoProcessor` - The video processing instance pointer to be destroyed. It is recommended setting the
    /// instance pointer to null after the instance is destroyed.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if the instance is destroyed successfully .
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_INSTANCE`] if instance is null or not a video processing instance.
    ///
    /// [`VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED`] if the instance is still running.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_Destroy(
        videoProcessor: *mut OH_VideoProcessing,
    ) -> VideoProcessing_ErrorCode;
    /// Register callback object.
    ///
    /// Register the callback object before starting video processing.
    ///
    /// # Arguments
    ///
    /// * `videoProcessor` - A video processing instance pointer.
    ///
    /// * `callback` - Callback pointer to be registered.
    ///
    /// * `userData` - User's custom data pointer.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if callback is registered successfully.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_INSTANCE`] if instance is null or not a video processing instance.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_PARAMETER`] if callback is null.
    ///
    /// [`VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED`] if video processing instance is running.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_RegisterCallback(
        videoProcessor: *mut OH_VideoProcessing,
        callback: *const VideoProcessing_Callback,
        userData: *mut ::core::ffi::c_void,
    ) -> VideoProcessing_ErrorCode;
    /// Set the output surface for video processing.
    ///
    /// Set the output surface before starting video processing.
    ///
    /// # Arguments
    ///
    /// * `videoProcessor` - A video processing instance pointer.
    ///
    /// * `window` - The output surface pointer.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if setting output surface successfully.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_INSTANCE`] if instance is null or not a video processing instance.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_PARAMETER`] if window is null.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_SetSurface(
        videoProcessor: *mut OH_VideoProcessing,
        window: *const OHNativeWindow,
    ) -> VideoProcessing_ErrorCode;
    /// Create an input surface.
    ///
    /// Create the input surface before starting video processing.
    /// Call [`OH_NativeWindow_DestroyNativeWindow`] to destroy the input surface.
    ///
    /// # Arguments
    ///
    /// * `videoProcessor` - A video processing instance pointer.
    ///
    /// * `window` - The input surface pointer. For example, it is the output surface of a video decoder.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if operation is successful.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_INSTANCE`] if instance is null or not a video processing instance.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_PARAMETER`] if window is null or <b>*</b>window is <b>not</b> null.
    ///
    /// [`VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED`] if creating surface failed, input surface is already created
    /// or video processing instance is running.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_GetSurface(
        videoProcessor: *mut OH_VideoProcessing,
        window: *mut *mut OHNativeWindow,
    ) -> VideoProcessing_ErrorCode;
    /// Set parameter for video processing.
    ///
    /// Add parameter identified by the specified parameter key.
    ///
    /// # Arguments
    ///
    /// * `videoProcessor` - An video processing instance pointer.
    ///
    /// * `parameter` - The parameter for video processing.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if setting parameter is successful.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_INSTANCE`] if instance is null or not an video processing instance.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_PARAMETER`] if the parameter is null.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_VALUE`] if some property of the parameter is invalid. For example, the parameter
    /// contains unsupported parameter key or value.
    ///
    /// [`VIDEO_PROCESSING_ERROR_NO_MEMORY`] if memory allocation failed.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_SetParameter(
        videoProcessor: *mut OH_VideoProcessing,
        parameter: *const OH_AVFormat,
    ) -> VideoProcessing_ErrorCode;
    /// Get parameter of video processing.
    ///
    /// Get parameter identified by the specified parameter key.
    ///
    /// # Arguments
    ///
    /// * `videoProcessor` - An video processing instance pointer.
    ///
    /// * `parameter` - The parameter used by the video processing instance.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if getting parameter is successful.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_INSTANCE`] if instance is null or not an video processing instance.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_PARAMETER`] if the parameter is null.
    ///
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_GetParameter(
        videoProcessor: *mut OH_VideoProcessing,
        parameter: *mut OH_AVFormat,
    ) -> VideoProcessing_ErrorCode;
    /// Start video processing instance.
    ///
    /// After successfully calling this function, the state [`VIDEO_PROCESSING_STATE_RUNNING`] is reported by callback
    /// function [`OH_VideoProcessingCallback_OnState`].
    ///
    /// # Arguments
    ///
    /// * `videoProcessor` - A video processing instance pointer.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if the operation is successful.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_INSTANCE`] if instance is null or not a video processing instance.
    ///
    /// [`VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED`] if output surface is not set, input surface is not created or
    /// instance is already running.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_Start(
        videoProcessor: *mut OH_VideoProcessing,
    ) -> VideoProcessing_ErrorCode;
    /// To stop video processing instance.
    ///
    /// After the video processing instance is stopped successfully, the state [`VIDEO_PROCESSING_STATE_STOPPED`] is
    /// reported by callback function [`OH_VideoProcessing_OnState`].
    ///
    /// # Arguments
    ///
    /// * `videoProcessor` - A video processing instance pointer.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if the operation is successful.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_INSTANCE`] if instance is null or not a video processing instance.
    ///
    /// [`VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED`] if instance is already stopped.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_Stop(
        videoProcessor: *mut OH_VideoProcessing,
    ) -> VideoProcessing_ErrorCode;
    /// Send the output buffer out.
    ///
    /// If the callback function [`OH_VideoProcessingCallback_OnNewOutputBuffer`] is set, the buffer's index is reported
    /// to user by the callback function when an output buffer is ready.
    ///
    /// # Arguments
    ///
    /// * `videoProcessor` - A video processing instance pointer.
    ///
    /// * `index` - The output buffer's index.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if the operation is successful.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_INSTANCE`] if instance is null or not a video processing instance.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_PARAMETER`] if index is invalid.
    ///
    /// [`VIDEO_PROCESSING_ERROR_OPERATION_NOT_PERMITTED`] if callback [`OH_VideoProcessing_OnNewOutputBuffer`] is
    /// not set or instance is stopped.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessing_RenderOutputBuffer(
        videoProcessor: *mut OH_VideoProcessing,
        index: u32,
    ) -> VideoProcessing_ErrorCode;
    /// Create a video processing callback object.
    ///
    /// # Arguments
    ///
    /// * `callback` - Output parameter. The *callback points to a new callback object. The *callback should be null before
    /// creating the callback object.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if callback object is created successfully.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_PARAMETER`] if callback is null or <b>*</b>callback is <b>not</b> null.
    ///
    /// [`VIDEO_PROCESSING_ERROR_NO_MEMORY`] if out of memory.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessingCallback_Create(
        callback: *mut *mut VideoProcessing_Callback,
    ) -> VideoProcessing_ErrorCode;
    /// Destroy the callback object.
    ///
    /// The callback object can be destroyed after it is registered to video processing instance.
    ///
    /// # Arguments
    ///
    /// * `callback` - The callback object pointer. It is recommended setting the callback pointer to null after the
    /// callback object is destroyed.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if callback is successfully destroyed.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_PARAMETER`] if callback is null.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessingCallback_Destroy(
        callback: *mut VideoProcessing_Callback,
    ) -> VideoProcessing_ErrorCode;
    /// Bind the [`OH_VideoProcessingCallback_OnError`] callback function to callback object.
    ///
    /// # Arguments
    ///
    /// * `callback` - A callback object pointer.
    ///
    /// * `onError` - The callback function.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if the function is bound to callback object successfully.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_PARAMETER`] if the callback is null or onError is null.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessingCallback_BindOnError(
        callback: *mut VideoProcessing_Callback,
        onError: OH_VideoProcessingCallback_OnError,
    ) -> VideoProcessing_ErrorCode;
    /// Bind the [`OH_VideoProcessingCallback_OnState`] callback function to callback object.
    ///
    /// # Arguments
    ///
    /// * `callback` - A callback object pointer.
    ///
    /// * `onState` - The callback function.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if the function is bound to callback object successfully.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_PARAMETER`] if the callback is null or onState is null.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessingCallback_BindOnState(
        callback: *mut VideoProcessing_Callback,
        onState: OH_VideoProcessingCallback_OnState,
    ) -> VideoProcessing_ErrorCode;
    /// Bind the [`OH_VideoProcessingCallback_OnNewOutputBuffer`] callback function to callback object.
    ///
    /// # Arguments
    ///
    /// * `callback` - A callback object pointer.
    ///
    /// * `onNewOutputBuffer` - The callback function.
    ///
    /// # Returns
    ///
    /// * [`VIDEO_PROCESSING_SUCCESS`] if the function is bound to callback object successfully.
    ///
    /// [`VIDEO_PROCESSING_ERROR_INVALID_PARAMETER`] if the callback is null.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_VideoProcessingCallback_BindOnNewOutputBuffer(
        callback: *mut VideoProcessing_Callback,
        onNewOutputBuffer: OH_VideoProcessingCallback_OnNewOutputBuffer,
    ) -> VideoProcessing_ErrorCode;
}