diff --git a/zh-cn/device_api/hdi/codec/codec_callback_if.h b/zh-cn/device_api/hdi/codec/codec_callback_if.h index b05d07ff56194f678eab534c5d2f3a0b99f991b5..52c236ff9f7f75bf81536f5d13b24286c57dfc4b 100644 --- a/zh-cn/device_api/hdi/codec/codec_callback_if.h +++ b/zh-cn/device_api/hdi/codec/codec_callback_if.h @@ -51,27 +51,32 @@ extern "C" { * @brief Codec回调接口定义。 * * 提供了以下3种回调函数: - * 1.组件错误事件、命令完成事件、端口设置等事件回调,详见{@link EventHandler}; - * 2.输入端口处理完buffer回调,详见{@link EmptyBufferDone}; - * 3.输出端口填充完buffer回调,详见{@link FillBufferDone}; + * - 组件错误事件、命令完成事件、端口设置等事件回调,详见{@link EventHandler}。 + * - 输入端口处理完buffer回调,详见{@link EmptyBufferDone}。 + * - 输出端口填充完buffer回调,详见{@link FillBufferDone}。 * 通过以下两种方式注册回调: - * 1.创建组件时,通过{@link CreateComponent}方法; - * 2.当组件处于OMX_StateLoaded状态时,通过{@link SetCallbacks}方法注册回调。 + * - 创建组件时,通过{@link CreateComponent}方法。 + * - 当组件处于OMX_StateLoaded状态时,通过{@link SetCallbacks}方法注册回调。 */ struct CodecCallbackType { + /** + * @brief 指向HdfRemoteService的指针。 + * + * @since 3.1 + */ struct HdfRemoteService *remote; /** * @brief 事件上报。 * * 组件运行过程中向上报告错误事件、命令完成事件、端口设置更改事件等。 - * 当eEvent为OMX_EventCmdComplete,eventData为NULL,data1 数据为OMX_COMMANDTYPE, - * 此时,当data1为OMX_CommandStateSet,data2表示状态,其它情况下,data2表示端口; - * 当event为OMX_EventError时,data1表示错误码,data2和eventData都为0; - * 当event为OMX_EventMark时,data1和data2都为0,eventData指向mark指针; - * 当event为OMX_EventPortSettingsChanged时,data1表示端口,data2和eventData为0; - * 当event为OMX_EventBufferFlag时,data1表示端口,data2表示flag,eventData为0; - * 当event为OMX_EventResourcesAcquired或OMX_EventDynamicResourcesAvailable时,data1、data2和eventData都为0。 + * - 当eEvent为OMX_EventCmdComplete,eventData为NULL,data1 数据为OMX_COMMANDTYPE, + * 此时,当data1为OMX_CommandStateSet,data2表示状态,其它情况下,data2表示端口。 + * - 当event为OMX_EventError时,data1表示错误码,data2和eventData都为0。 + * - 当event为OMX_EventMark时,data1和data2都为0,eventData指向mark指针。 + * - 当event为OMX_EventPortSettingsChanged时,data1表示端口,data2和eventData为0。 + * - 当event为OMX_EventBufferFlag时,data1表示端口,data2表示flag,eventData为0。 + * - 当event为OMX_EventResourcesAcquired或OMX_EventDynamicResourcesAvailable时,data1、data2和eventData都为0。 * * @param self 输入参数,指向要操作的callback指针。 * @param event 输入参数,要通知的事件类型,详见{@link OMX_EVENTTYPE}。 diff --git a/zh-cn/device_api/hdi/codec/codec_common_type.h b/zh-cn/device_api/hdi/codec/codec_common_type.h index bd57af1f235b33455ff435ffe2e5ac59ca1f7f0a..0d9b6b911cb1e9038ccc29eb7d2145e1bc41721e 100644 --- a/zh-cn/device_api/hdi/codec/codec_common_type.h +++ b/zh-cn/device_api/hdi/codec/codec_common_type.h @@ -59,7 +59,7 @@ typedef enum { } CodecType; /** - * @brief 枚举Codec规格. + * @brief 枚举Codec规格 */ typedef enum { INVALID_PROFILE = 0, /**< 无效的规格 */ @@ -95,7 +95,7 @@ typedef enum { } AudioSampleRate; /** -* @brief 对齐结构定义,包含宽高的对齐 +* @brief 对齐结构定义,包含宽高的对齐值 */ typedef struct { int32_t widthAlignment; /**< 宽的对齐值 */ diff --git a/zh-cn/device_api/hdi/codec/codec_component_if.h b/zh-cn/device_api/hdi/codec/codec_component_if.h index 9803e4efebad4faa5a54d7161577f48b8c1f9854..a4a1766d49abf32383ebacadd98d9cf9b24b5381 100644 --- a/zh-cn/device_api/hdi/codec/codec_component_if.h +++ b/zh-cn/device_api/hdi/codec/codec_component_if.h @@ -83,8 +83,8 @@ struct CodecComponentType { * @param self 输入参数,指向要操作的Codec组件指针。 * @param cmd 输入参数,组件要执行的命令,详见{@link OMX_COMMANDTYPE}。 * @param param 输入参数,组件要执行的命令携带的参数。 - * 当cmd为OMX_CommandStateSet时,param的值详见{@link OMX_STATETYPE}。 - * 当cmd为OMX_CommandFlush、OMX_CommandPortDisable、OMX_CommandPortEnable、OMX_CommandMarkBuffer时,param为目标端口。 + * - 当cmd为OMX_CommandStateSet时,param的值详见{@link OMX_STATETYPE}。 + * - 当cmd为OMX_CommandFlush、OMX_CommandPortDisable、OMX_CommandPortEnable、OMX_CommandMarkBuffer时,param为目标端口。 * @param cmdData 输入参数,当cmd为OMX_CommandMarkBuffer时,指向OMX_MARKTYPE结构体指针。 * @param cmdDataLen 输入参数,上层传递的cmdData字节数。 * @@ -197,7 +197,7 @@ struct CodecComponentType { /** * @brief 获取组件的当前状态。 * - * 用户可调用此接口获取组件的当前状态, 组件状态详见{@link OMX_STATETYPE}。 + * 用户可调用此接口获取组件的当前状态,组件状态详见{@link OMX_STATETYPE}。 * * @param self 输入参数,指向要操作的Codec组件指针。 * @param state 输出参数,指向获取到的状态指针,组件状态详见{@link OMX_STATETYPE}。 @@ -214,7 +214,7 @@ struct CodecComponentType { /** * @brief 设置组件采用Tunnel方式通信。 * - * 当组件处于OMX_StateLoaded 状态时,用户通过调用此接口确定组件是否可以进行Tunnel传输, 如果可以则设置组件的Tunnel传输。 + * 当组件处于OMX_StateLoaded 状态时,用户通过调用此接口确定组件是否可以进行Tunnel传输,如果可以则设置组件的Tunnel传输。 * * @param self 输入参数,指向要操作的Codec组件指针。 * @param port 输入参数,组件设置的端口。 @@ -236,9 +236,9 @@ struct CodecComponentType { * @brief 指定组件端口的buffer。 * * 此接口在以下情况下使用: - * 当组件处于OMX_StateLoaded状态, 并且用户已经向组件发送OMX_StateIdle状态转换请求; - * 当组件处于OMX_StateWaitForResources状态, 所需的资源可用, 并且组件已准备好进入OMX_StateIdle状态; - * 在去使能端口上, 组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。 + * - 当组件处于OMX_StateLoaded状态,并且用户已经向组件发送OMX_StateIdle状态转换请求。 + * - 当组件处于OMX_StateWaitForResources状态,所需的资源可用,并且组件已准备好进入OMX_StateIdle状态。 + * - 在去使能端口上,组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。 * * @param self 输入参数,指向要操作的Codec组件指针。 * @param portIndex 输入参数,指定的组件端口。 @@ -256,10 +256,10 @@ struct CodecComponentType { /** * @brief 向组件申请端口buffer。 * - * 向组件申请分配新的buffer, 此接口在以下情况下使用: - * 当组件处于OMX_StateLoaded状态, 并且用户已经向组件发送OMX_StateIdle状态转换请求; - * 当组件处于OMX_StateWaitForResources状态, 所需的资源可用, 并且组件已准备好进入OMX_StateIdle状态; - * 在去使能端口上, 组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。 + * 向组件申请分配新的buffer,此接口在以下情况下使用: + * - 当组件处于OMX_StateLoaded状态,并且用户已经向组件发送OMX_StateIdle状态转换请求。 + * - 当组件处于OMX_StateWaitForResources状态,所需的资源可用,并且组件已准备好进入OMX_StateIdle状态。 + * - 在去使能端口上,组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。 * * @param self 输入参数,指向要操作的Codec组件指针。 * @param portIndex 输入参数,指定的组件端口。 @@ -278,9 +278,9 @@ struct CodecComponentType { * @brief 释放buffer。 * * 此接口在以下情况下使用: - * 当组件处于OMX_StateIdle状态, 并且已经向组件发送OMX_StateLoaded状态转换请求; - * 在去使能端口上, 组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle时调用; - * 此接口调用可随时进行, 但是如果未在上述情况下执行, 可能会导致组件上报OMX_ErrorPortUnpopulated事件。 + * - 当组件处于OMX_StateIdle状态,并且已经向组件发送OMX_StateLoaded状态转换请求。 + * - 在去使能端口上,组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle时调用。 + * - 此接口调用可随时进行,但是如果未在上述情况下执行,可能会导致组件上报OMX_ErrorPortUnpopulated事件。 * * @param self 输入参数,指向要操作的Codec组件指针。 * @param portIndex 输入参数,指定的组件端口。 @@ -369,9 +369,9 @@ struct CodecComponentType { * @brief 使用已在EGL中申请的空间。 * * 此接口在以下情况下使用: - * 当组件处于OMX_StateLoaded状态, 并且已经向组件发送OMX_StateIdle状态转换请求; - * 当组件处于OMX_StateWaitForResources状态, 所需的资源可用, 并且组件已准备好进入OMX_StateIdle状态; - * 在去使能端口上, 组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。 + * - 当组件处于OMX_StateLoaded状态,并且已经向组件发送OMX_StateIdle状态转换请求。 + * - 当组件处于OMX_StateWaitForResources状态,所需的资源可用,并且组件已准备好进入OMX_StateIdle状态。 + * - 在去使能端口上,组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。 * * @param self 输入参数,指向要操作的Codec组件指针。 * @param buffer 输入输出参数,指向{@link OmxCodecBuffer}结构体的指针。 diff --git a/zh-cn/device_api/hdi/codec/codec_component_manager.h b/zh-cn/device_api/hdi/codec/codec_component_manager.h index 170f033b6ae3d607709e8992f012cc6bf8b28a76..ddf40378b07007bf9decd7b037a38a01add87440 100644 --- a/zh-cn/device_api/hdi/codec/codec_component_manager.h +++ b/zh-cn/device_api/hdi/codec/codec_component_manager.h @@ -51,14 +51,14 @@ extern "C" { * @brief Codec组件管理类接口定义。 * * 主要提供以下功能: - * 获取Codec编解码组件数量以及编解码能力集表; - * 创建/销毁Codec组件。 + * - 获取Codec编解码组件数量以及编解码能力集表。 + * - 创建/销毁Codec组件。 */ struct CodecComponentManager { /** * @brief 获取Codec编解码组件数量。 * - * 通过此接口获取Codec编解码组件数量, 用来获取全部编解码能力集。 + * 通过此接口获取Codec编解码组件数量,用来获取全部编解码能力集。 * * @return Codec编解码组件数量。 * @@ -69,15 +69,15 @@ struct CodecComponentManager { /** * @brief 获取编解码能力集表。 * - * 用户可通过此接口了解Codec模块提供了哪些编解码能力, 对应的能力体现在{@link CodecCompCapability}结构体。 + * 用户可通过此接口了解Codec模块提供了哪些编解码能力,对应的能力体现在{@link CodecCompCapability}结构体。 * - * @param capList 输出参数, 返回全部组件的能力集表{@link CodecCompCapability}。 - * @param count 输入参数, 编解码组件数量, 由{@link GetComponentNum}获得。 + * @param capList 输出参数,返回全部组件的能力集表{@link CodecCompCapability}。 + * @param count 输入参数,编解码组件数量,由{@link GetComponentNum}获得。 * * @return HDF_SUCCESS 表示获取能力集表成功。 - * @return HDF_ERR_INVALID_PARAM 表示参数无效, 获取能力集表失败。 - * @return HDF_ERR_INVALID_OBJECT 表示对象无效, 获取能力集表失败。 - * @return HDF_ERR_MALLOC_FAIL 表示申请内存失败, 获取能力集表失败。 + * @return HDF_ERR_INVALID_PARAM 表示参数无效,获取能力集表失败。 + * @return HDF_ERR_INVALID_OBJECT 表示对象无效,获取能力集表失败。 + * @return HDF_ERR_MALLOC_FAIL 表示申请内存失败,获取能力集表失败。 * * @since 3.1 */ @@ -88,16 +88,16 @@ struct CodecComponentManager { * * 根据组件名称创建Codec组件实例。 * - * @param component 输出参数, 指向Codec组件的指针。 - * @param compName 输入参数, 组件名称。 - * @param appData 输入参数, 指向应用程序定义的值的指针, 该值将在回调期间返回。 - * @param appDataSize 输入参数, appData字节数。 - * @param callbacks 输入参数, 回调接口, 指向OMX_CALLBACKTYPE结构的指针, 详见{@link CodecCallbackType}。 + * @param component 输出参数,指向Codec组件的指针。 + * @param compName 输入参数,组件名称。 + * @param appData 输入参数,指向应用程序定义的值的指针,该值将在回调期间返回。 + * @param appDataSize 输入参数,appData字节数。 + * @param callbacks 输入参数,回调接口,指向OMX_CALLBACKTYPE结构的指针,详见{@link CodecCallbackType}。 * * @return HDF_SUCCESS 表示创建组件成功。 - * @return HDF_ERR_INVALID_PARAM 表示参数无效, 创建组件失败。 - * @return HDF_ERR_INVALID_OBJECT 表示对象无效, 创建组件失败。 - * @return HDF_ERR_MALLOC_FAIL 表示申请内存失败, 创建组件失败。 + * @return HDF_ERR_INVALID_PARAM 表示参数无效,创建组件失败。 + * @return HDF_ERR_INVALID_OBJECT 表示对象无效,创建组件失败。 + * @return HDF_ERR_MALLOC_FAIL 表示申请内存失败,创建组件失败。 * * @since 3.1 */ @@ -109,12 +109,12 @@ struct CodecComponentManager { * * 销毁指定的Codec组件。 * - * @param component 输入参数, 需要销毁的Codec组件。 + * @param component 输入参数,需要销毁的Codec组件。 * * @return HDF_SUCCESS 表示销毁组件成功。 - * @return HDF_ERR_INVALID_PARAM 表示参数无效, 销毁组件失败。 - * @return HDF_ERR_INVALID_OBJECT 表示对象无效, 销毁组件失败。 - * @return HDF_ERR_MALLOC_FAIL 表示申请内存失败, 销毁组件失败。 + * @return HDF_ERR_INVALID_PARAM 表示参数无效,销毁组件失败。 + * @return HDF_ERR_INVALID_OBJECT 表示对象无效,销毁组件失败。 + * @return HDF_ERR_MALLOC_FAIL 表示申请内存失败,销毁组件失败。 * * @since 3.1 */