# Codec
## **汇总**
### 文件
| 文件 | 描述 |
| -------- | -------- |
| [codec_callback_if.h](codec__callback__if_8h.md) | 主要包括回调函数接口定义。 |
| [codec_common_type.h](codec__common__type_8h.md) | Codec模块接口定义中使用的自定义数据类型。 |
| [codec_component_if.h](codec__component__if_8h.md) | 主要包括Codec组件接口定义。 |
| [codec_component_manager.h](codec__component__manager_8h.md) | 主要包括Codec组件管理类接口。 |
| [codec_component_type.h](codec__component__type_8h.md) | Codec模块接口定义中使用的自定义数据类型。 |
### 类
| 类 | 描述 |
| -------- | -------- |
| [CodecCallbackType](_codec_callback_type.md) | Codec回调接口定义。 [更多...](_codec_callback_type.md) |
| [Alignment](_alignment.md) | 对齐结构定义，包含宽高的对齐值。 [更多...](_alignment.md) |
| [Rect](_rect.md) | 矩形的定义。 [更多...](_rect.md) |
| [RangeValue](_range_value.md) | 取值范围的定义。 [更多...](_range_value.md) |
| [CodecComponentType](_codec_component_type.md) | Codec组件接口定义。 [更多...](_codec_component_type.md) |
| [CodecComponentManager](_codec_component_manager.md) | Codec组件管理类接口定义。 [更多...](_codec_component_manager.md) |
| [VideoPortCap](_video_port_cap.md) | 定义视频编解码能力。 [更多...](_video_port_cap.md) |
| [AudioPortCap](_audio_port_cap.md) | 定义音频编解码能力。 [更多...](_audio_port_cap.md) |
| [PortCap](union_port_cap.md) | 定义音视频编解码能力。 [更多...](union_port_cap.md) |
| [CodecCompCapability](_codec_comp_capability.md) | 定义Codec编解码能力。 [更多...](_codec_comp_capability.md) |
| [OmxCodecBuffer](_omx_codec_buffer.md) | Codec buffer信息的定义。 [更多...](_omx_codec_buffer.md) |
| [CompVerInfo](_comp_ver_info.md) | 定义组件版本信息。 [更多...](_comp_ver_info.md) |
| [EventInfo](_event_info.md) | 定义事件上报信息。 [更多...](_event_info.md) |
| [SupportBufferType](_support_buffer_type.md) | SupportBuffer类型定义。 [更多...](_support_buffer_type.md) |
| [UseBufferType](_use_buffer_type.md) | UseBuffer类型定义。 [更多...](_use_buffer_type.md) |
| [GetBufferHandleUsageParams](_get_buffer_handle_usage_params.md) | BufferHandleUsage类型定义。 [更多...](_get_buffer_handle_usage_params.md) |
### 宏定义
| 宏定义 | 描述 |
| -------- | -------- |
| SAMPLE_FMT_NUM 32 | 采样格式最大值。 |
| UUID_LENGTH 128 | 定义UUID长度。 |
| PIX_FORMAT_NUM 16 | 支持的像素格式数组大小。 |
| SAMPLE_FORMAT_NUM 12 | 支持的音频采样格式数组大小。 |
| SAMPLE_RATE_NUM 16 | 支持的音频采样率数组大小。 |
| CHANNEL_NUM 16 | 支持的音频通道数组大小。 |
| NAME_LENGTH 32 | 组件名称大小。 |
| PROFILE_NUM 256 | 支持的profile数组大小。 |
### 枚举
| 枚举 | 描述 |
| -------- | -------- |
| [CodecType](#codectype) { VIDEO_DECODER, VIDEO_ENCODER, AUDIO_DECODER, AUDIO_ENCODER, INVALID_TYPE } | 枚举编解码的类型。 [更多...](#codectype) |
| [Profile](#profile) { INVALID_PROFILE = 0, AAC_LC_PROFILE = 0x1000, AAC_MAIN_PROFILE, AAC_HE_V1_PROFILE, AAC_HE_V2_PROFILE, AAC_LD_PROFILE, AAC_ELD_PROFILE, AVC_BASELINE_PROFILE = 0x2000, AVC_MAIN_PROFILE, AVC_HIGH_PROFILE, HEVC_MAIN_PROFILE = 0x3000, HEVC_MAIN_10_PROFILE } | 枚举Codec规格。 [更多...](#profile) |
| [AudioSampleRate](#audiosamplerate) { AUD_SAMPLE_RATE_8000 = 8000, AUD_SAMPLE_RATE_12000 = 12000, AUD_SAMPLE_RATE_11025 = 11025, AUD_SAMPLE_RATE_16000 = 16000, AUD_SAMPLE_RATE_22050 = 22050, AUD_SAMPLE_RATE_24000 = 24000, AUD_SAMPLE_RATE_32000 = 32000, AUD_SAMPLE_RATE_44100 = 44100, AUD_SAMPLE_RATE_48000 = 48000, AUD_SAMPLE_RATE_64000 = 64000, AUD_SAMPLE_RATE_96000 = 96000, AUD_SAMPLE_RATE_INVALID } | 枚举音频采样率。 [更多...](#audiosamplerate) |
| [CodecCapsMask](#codeccapsmask) { CODEC_CAP_ADAPTIVE_PLAYBACK = 0x1, CODEC_CAP_SECURE_PLAYBACK = 0x2, CODEC_CAP_TUNNEL_PLAYBACK = 0x4, CODEC_CAP_MULTI_PLANE = 0x10000 } | 枚举播放能力。 [更多...](#codeccapsmask) |
| [CodecProcessMode](#codecprocessmode) { PROCESS_BLOCKING_INPUT_BUFFER = 0X1, PROCESS_BLOCKING_OUTPUT_BUFFER = 0X2, PROCESS_BLOCKING_CONTROL_FLOW = 0X4, PROCESS_NONBLOCKING_INPUT_BUFFER = 0X100, PROCESS_NONBLOCKING_OUTPUT_BUFFER = 0X200, PROCESS_NONBLOCKING_CONTROL_FLOW = 0X400 } | 枚举编解码处理模式。 [更多...](#codecprocessmode) |
| [AvCodecRole](#avcodecrole) { MEDIA_ROLETYPE_IMAGE_JPEG = 0, MEDIA_ROLETYPE_VIDEO_AVC, MEDIA_ROLETYPE_VIDEO_HEVC, MEDIA_ROLETYPE_AUDIO_FIRST = 0x10000, MEDIA_ROLETYPE_AUDIO_AAC = 0x10000, MEDIA_ROLETYPE_AUDIO_G711A, MEDIA_ROLETYPE_AUDIO_G711U, MEDIA_ROLETYPE_AUDIO_G726, MEDIA_ROLETYPE_AUDIO_PCM, MEDIA_ROLETYPE_AUDIO_MP3, MEDIA_ROLETYPE_INVALID } | 枚举音视频编解码组件类型。 [更多...](#avcodecrole) |
| [AudioSampleFormat](#audiosampleformat) { AUDIO_SAMPLE_FORMAT_S8, AUDIO_SAMPLE_FORMAT_S8P, AUDIO_SAMPLE_FORMAT_U8, AUDIO_SAMPLE_FORMAT_U8P, AUDIO_SAMPLE_FORMAT_S16, AUDIO_SAMPLE_FORMAT_S16P, AUDIO_SAMPLE_FORMAT_U16, AUDIO_SAMPLE_FORMAT_U16P, AUDIO_SAMPLE_FORMAT_S24, AUDIO_SAMPLE_FORMAT_S24P, AUDIO_SAMPLE_FORMAT_U24, AUDIO_SAMPLE_FORMAT_U24P, AUDIO_SAMPLE_FORMAT_S32, AUDIO_SAMPLE_FORMAT_S32P, AUDIO_SAMPLE_FORMAT_U32, AUDIO_SAMPLE_FORMAT_U32P, AUDIO_SAMPLE_FORMAT_S64, AUDIO_SAMPLE_FORMAT_S64P, AUDIO_SAMPLE_FORMAT_U64, AUDIO_SAMPLE_FORMAT_U64P, AUDIO_SAMPLE_FORMAT_F32, AUDIO_SAMPLE_FORMAT_F32P, AUDIO_SAMPLE_FORMAT_F64, AUDIO_SAMPLE_FORMAT_F64P, AUDIO_SAMPLE_FMT_U8, AUDIO_SAMPLE_FMT_S16, AUDIO_SAMPLE_FMT_S32, AUDIO_SAMPLE_FMT_FLOAT, AUDIO_SAMPLE_FMT_DOUBLE, AUDIO_SAMPLE_FMT_U8P, AUDIO_SAMPLE_FMT_S16P, AUDIO_SAMPLE_FMT_S32P, AUDIO_SAMPLE_FMT_FLOATP, AUDIO_SAMPLE_FMT_DOUBLEP, AUDIO_SAMPLE_FMT_INVALID } | 枚举音频采样格式。 [更多...](#audiosampleformat) |
| [CodecBufferType](#codecbuffertype) { CODEC_BUFFER_TYPE_INVALID = 0, CODEC_BUFFER_TYPE_VIRTUAL_ADDR = 0x1, CODEC_BUFFER_TYPE_AVSHARE_MEM_FD = 0x2, CODEC_BUFFER_TYPE_HANDLE = 0x4, CODEC_BUFFER_TYPE_DYNAMIC_HANDLE = 0x8 } | 定义buffer类型。 [更多...](#codecbuffertype) |
| [ShareMemTypes](#sharememtypes) { READ_WRITE_TYPE = 0x1, READ_ONLY_TYPE = 0x2 } | 枚举共享内存类型。 [更多...](#sharememtypes) |
| [OmxIndexCodecExType](#omxindexcodecextype) { OMX_IndexExtBufferTypeStartUnused = OMX_IndexKhronosExtensions + 0x00a00000, OMX_IndexParamSupportBufferType, OMX_IndexParamUseBufferType, OMX_IndexParamGetBufferHandleUsage } | 枚举Codec扩展index。 [更多...](#omxindexcodecextype) |
| [OmxVideoExType](#omxvideoextype) { OMX_VIDEO_CodingHEVC = 11 } | 枚举Codec扩展编码类型。 [更多...](#omxvideoextype) |
### 函数
| 函数 | 描述 |
| -------- | -------- |
| [CodecCallbackTypeGet](#codeccallbacktypeget) (struct HdfRemoteService \*remote) | 实例化CodecCallbackType对象。 [更多...](#codeccallbacktypeget) |
| [CodecCallbackTypeRelease](#codeccallbacktyperelease) (struct [CodecCallbackType](_codec_callback_type.md) \*instance) | 释放CodecCallbackType对象。 [更多...](#codeccallbacktyperelease) |
| [CodecComponentTypeGet](#codeccomponenttypeget) (struct HdfRemoteService \*remote) | 实例化CodecComponentType对象。 [更多...](#codeccomponenttypeget) |
| [CodecComponentTypeRelease](#codeccomponenttyperelease) (struct [CodecComponentType](_codec_component_type.md) \*instance) | 释放CodecComponentType对象。 [更多...](#codeccomponenttyperelease) |
| [GetCodecComponentManager](#getcodeccomponentmanager) (void) | 实例化CodecComponentManager对象。 [更多...](#getcodeccomponentmanager) |
| [CodecComponentManagerRelease](#codeccomponentmanagerrelease) (void) | 释放CodecComponentManager对象。 [更多...](#codeccomponentmanagerrelease) |
### 变量
| 变量 | 描述 |
| -------- | -------- |
| [CodecCallbackType::remote](#remote) | 指向HdfRemoteService的指针。 [更多...](#remote) |
| ( [CodecCallbackType::EventHandler](#eventhandler) )(struct [CodecCallbackType](_codec_callback_type.md) \*self, enum OMX_EVENTTYPE event, struct [EventInfo](_event_info.md) \*info) | 事件上报。 [更多...](#eventhandler) |
| ( [CodecCallbackType::EmptyBufferDone](#emptybufferdone) )(struct [CodecCallbackType](_codec_callback_type.md) \*self, int8_t \*appData, uint32_t appDataLen, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 上报输入buffer编码或者解码处理完毕。 [更多...](#emptybufferdone) |
| ( [CodecCallbackType::FillBufferDone](#fillbufferdone) )(struct [CodecCallbackType](_codec_callback_type.md) \*self, int8_t \*appData, uint32_t appDataLen, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 上报输出buffer填充完毕。 [更多...](#fillbufferdone) |
| ( [CodecComponentType::GetComponentVersion](#getcomponentversion) )(struct [CodecComponentType](_codec_component_type.md) \*self, struct [CompVerInfo](_comp_ver_info.md) \*verInfo) | 获取Codec组件版本号。 [更多...](#getcomponentversion) |
| ( [CodecComponentType::SendCommand](#sendcommand) )(struct [CodecComponentType](_codec_component_type.md) \*self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t \*cmdData, uint32_t cmdDataLen) | 发送命令给组件。 [更多...](#sendcommand) |
| ( [CodecComponentType::GetParameter](#getparameter) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t paramIndex, int8_t \*paramStruct, uint32_t paramStructLen) | 获取组件参数设置。 [更多...](#getparameter) |
| ( [CodecComponentType::SetParameter](#setparameter) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t index, int8_t \*paramStruct, uint32_t paramStructLen) | 设置组件需要的参数。 [更多...](#setparameter) |
| ( [CodecComponentType::GetConfig](#getconfig) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 获取组件的配置结构。 [更多...](#getconfig) |
| ( [CodecComponentType::SetConfig](#setconfig) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 设置组件的配置。 [更多...](#setconfig) |
| ( [CodecComponentType::GetExtensionIndex](#getextensionindex) )(struct [CodecComponentType](_codec_component_type.md) \*self, const char \*paramName, uint32_t \*indexType) | 根据字符串获取组件的扩展索引。 [更多...](#getextensionindex) |
| ( [CodecComponentType::GetState](#getstate) )(struct [CodecComponentType](_codec_component_type.md) \*self, enum OMX_STATETYPE \*state) | 获取组件的当前状态。 [更多...](#getstate) |
| ( [CodecComponentType::ComponentTunnelRequest](#componenttunnelrequest) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE \*tunnelSetup) | 设置组件采用Tunnel方式通信。 [更多...](#componenttunnelrequest) |
| ( [CodecComponentType::UseBuffer](#usebuffer) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t portIndex, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 指定组件端口的buffer。 [更多...](#usebuffer) |
| ( [CodecComponentType::AllocateBuffer](#allocatebuffer) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t portIndex, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 向组件申请端口buffer。 [更多...](#allocatebuffer) |
| ( [CodecComponentType::FreeBuffer](#freebuffer) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint32_t portIndex, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 释放buffer。 [更多...](#freebuffer) |
| ( [CodecComponentType::EmptyThisBuffer](#emptythisbuffer) )(struct [CodecComponentType](_codec_component_type.md) \*self, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 编解码输入待处理buffer。 [更多...](#emptythisbuffer) |
| ( [CodecComponentType::FillThisBuffer](#fillthisbuffer) )(struct [CodecComponentType](_codec_component_type.md) \*self, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 编解码输出填充buffer。 [更多...](#fillthisbuffer) |
| ( [CodecComponentType::SetCallbacks](#setcallbacks) )(struct [CodecComponentType](_codec_component_type.md) \*self, struct [CodecCallbackType](_codec_callback_type.md) \*callback, int8_t \*appData, uint32_t appDataLen) | 设置Codec组件的回调函数。 [更多...](#setcallbacks) |
| ( [CodecComponentType::ComponentDeInit](#componentdeinit) )(struct [CodecComponentType](_codec_component_type.md) \*self) | 组件去初始化。 [更多...](#componentdeinit) |
| ( [CodecComponentType::UseEglImage](#useeglimage) )(struct [CodecComponentType](_codec_component_type.md) \*self, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer, uint32_t portIndex, int8_t \*eglImage, uint32_t eglImageLen) | 使用已在EGL中申请的空间。 [更多...](#useeglimage) |
| ( [CodecComponentType::ComponentRoleEnum](#componentroleenum) )(struct [CodecComponentType](_codec_component_type.md) \*self, uint8_t \*role, uint32_t roleLen, uint32_t index) | 获取组件角色。 [更多...](#componentroleenum) |
## **详细描述**
Codec模块接口定义。
Codec模块涉及自定义类型、音视频编解码组件初始化、参数设置、数据的轮转和控制等。
**Since：**
3.1
**Version：**
2.0
## **枚举类型说明**
### AudioSampleFormat
```
enum AudioSampleFormat
```
**描述：**
枚举音频采样格式。
- 对于planar的采样格式，每个声道的数据是独立存储在data中。
- 对于packed的采样格式，只使用第一个data，每个声道的数据是交错存储的。
| 枚举值 | 描述 |
| -------- | -------- |
| AUDIO_SAMPLE_FORMAT_S8 | 8bit位宽有符号交织样本。 |
| AUDIO_SAMPLE_FORMAT_S8P | 8bit位宽有符号非交织样本。 |
| AUDIO_SAMPLE_FORMAT_U8 | 8bit位宽无符号交织样本。 |
| AUDIO_SAMPLE_FORMAT_U8P | 8bit位宽无符号非交织样本。 |
| AUDIO_SAMPLE_FORMAT_S16 | 16bit位宽有符号交织样本。 |
| AUDIO_SAMPLE_FORMAT_S16P | 16bit位宽有符号非交织样本。 |
| AUDIO_SAMPLE_FORMAT_U16 | 16bit位宽无符号交织样本。 |
| AUDIO_SAMPLE_FORMAT_U16P | 16bit位宽无符号非交织样本。 |
| AUDIO_SAMPLE_FORMAT_S24 | 24bit位宽有符号交织样本。 |
| AUDIO_SAMPLE_FORMAT_S24P | 24bit位宽有符号非交织样本。 |
| AUDIO_SAMPLE_FORMAT_U24 | 24bit位宽无符号交织样本。 |
| AUDIO_SAMPLE_FORMAT_U24P | 24bit位宽无符号非交织样本。 |
| AUDIO_SAMPLE_FORMAT_S32 | 32bit位宽有符号交织样本。 |
| AUDIO_SAMPLE_FORMAT_S32P | 32bit位宽有符号非交织样本。 |
| AUDIO_SAMPLE_FORMAT_U32 | 32bit位宽无符号交织样本。 |
| AUDIO_SAMPLE_FORMAT_U32P | 32bit位宽无符号非交织样本。 |
| AUDIO_SAMPLE_FORMAT_S64 | 64bit位宽有符号交织样本。 |
| AUDIO_SAMPLE_FORMAT_S64P | 64bit位宽有符号非交织样本。 |
| AUDIO_SAMPLE_FORMAT_U64 | 64bit位宽无符号交织样本。 |
| AUDIO_SAMPLE_FORMAT_U64P | 64bit位宽无符号非交织样本。 |
| AUDIO_SAMPLE_FORMAT_F32 | 32bit位宽浮点型交织样本。 |
| AUDIO_SAMPLE_FORMAT_F32P | 64bit位宽浮点型非交织样本。 |
| AUDIO_SAMPLE_FORMAT_F64 | 64bit位宽双精度浮点型交织样本。 |
| AUDIO_SAMPLE_FORMAT_F64P | 64bit位宽双精度浮点型非交织样本。 |
| AUDIO_SAMPLE_FMT_U8 | 无符号8位整型，打包格式。 |
| AUDIO_SAMPLE_FMT_S16 | 带符号16位整型，打包格式。 |
| AUDIO_SAMPLE_FMT_S32 | 带符号32位整型，打包格式。 |
| AUDIO_SAMPLE_FMT_FLOAT | 浮点型，打包格式。 |
| AUDIO_SAMPLE_FMT_DOUBLE | 双精度浮点型，打包格式。 |
| AUDIO_SAMPLE_FMT_U8P | 无符号8位整型，平面格式。 |
| AUDIO_SAMPLE_FMT_S16P | 带符号16位整型，平面格式。 |
| AUDIO_SAMPLE_FMT_S32P | 带符号32位整型，平面格式。 |
| AUDIO_SAMPLE_FMT_FLOATP | 浮点型，平面格式。 |
| AUDIO_SAMPLE_FMT_DOUBLEP | 双精度浮点型，平面格式。 |
| AUDIO_SAMPLE_FMT_INVALID | 无效采样格式。 |
### AudioSampleRate
```
enum AudioSampleRate
```
**描述：**
枚举音频采样率
| 枚举值 | 描述 |
| -------- | -------- |
| AUD_SAMPLE_RATE_8000 | 8K采样率 |
| AUD_SAMPLE_RATE_12000 | 12K采样率 |
| AUD_SAMPLE_RATE_11025 | 11.025K采样率 |
| AUD_SAMPLE_RATE_16000 | 16K采样率 |
| AUD_SAMPLE_RATE_22050 | 22.050K采样率 |
| AUD_SAMPLE_RATE_24000 | 24K采样率 |
| AUD_SAMPLE_RATE_32000 | 32K采样率 |
| AUD_SAMPLE_RATE_44100 | 44.1K采样率 |
| AUD_SAMPLE_RATE_48000 | 48K采样率 |
| AUD_SAMPLE_RATE_64000 | 64K采样率 |
| AUD_SAMPLE_RATE_96000 | 96K采样率 |
| AUD_SAMPLE_RATE_INVALID | 无效采样率 |
### AvCodecRole
```
enum AvCodecRole
```
**描述：**
枚举音视频编解码组件类型。
| 枚举值 | 描述 |
| -------- | -------- |
| MEDIA_ROLETYPE_IMAGE_JPEG | 图像JPEG媒体类型 |
| MEDIA_ROLETYPE_VIDEO_AVC | 视频H.264媒体类型 |
| MEDIA_ROLETYPE_VIDEO_HEVC | 视频H.265媒体类型 |
| MEDIA_ROLETYPE_AUDIO_FIRST | 音频编解码器类型 |
| MEDIA_ROLETYPE_AUDIO_AAC | 音频AAC媒体类型 |
| MEDIA_ROLETYPE_AUDIO_G711A | 音频G711A媒体类型 |
| MEDIA_ROLETYPE_AUDIO_G711U | 音频G711U媒体类型 |
| MEDIA_ROLETYPE_AUDIO_G726 | 音频G726媒体类型 |
| MEDIA_ROLETYPE_AUDIO_PCM | 音频PCM媒体类型 |
| MEDIA_ROLETYPE_AUDIO_MP3 | 音频MP3媒体类型 |
| MEDIA_ROLETYPE_INVALID | 无效媒体类型 |
### CodecBufferType
```
enum CodecBufferType
```
**描述：**
定义buffer类型。
| 枚举值 | 描述 |
| -------- | -------- |
| CODEC_BUFFER_TYPE_INVALID | 无效buffer类型 |
| CODEC_BUFFER_TYPE_VIRTUAL_ADDR | 虚拟地址类型 |
| CODEC_BUFFER_TYPE_AVSHARE_MEM_FD | 共享内存类型 |
| CODEC_BUFFER_TYPE_HANDLE | handle类型 |
| CODEC_BUFFER_TYPE_DYNAMIC_HANDLE | 动态handle类型 |
### CodecCapsMask
```
enum CodecCapsMask
```
**描述：**
枚举播放能力。
| 枚举值 | 描述 |
| -------- | -------- |
| CODEC_CAP_ADAPTIVE_PLAYBACK | 自适应播放能力 |
| CODEC_CAP_SECURE_PLAYBACK | 安全播放能力 |
| CODEC_CAP_TUNNEL_PLAYBACK | 通道播放能力 |
| CODEC_CAP_MULTI_PLANE | 视频图像平面/音频通道平面能力 |
### CodecProcessMode
```
enum CodecProcessMode
```
**描述：**
枚举编解码处理模式。
| 枚举值 | 描述 |
| -------- | -------- |
| PROCESS_BLOCKING_INPUT_BUFFER | 同步模式输入buffer |
| PROCESS_BLOCKING_OUTPUT_BUFFER | 同步模式输出buffer |
| PROCESS_BLOCKING_CONTROL_FLOW | 同步模式控制流 |
| PROCESS_NONBLOCKING_INPUT_BUFFER | 异步模式输入buffer |
| PROCESS_NONBLOCKING_OUTPUT_BUFFER | 异步模式输出buffer |
| PROCESS_NONBLOCKING_CONTROL_FLOW | 异步模式控制流 |
### CodecType
```
enum CodecType
```
**描述：**
枚举编解码的类型。
| 枚举值 | 描述 |
| -------- | -------- |
| VIDEO_DECODER | 视频解码类型 |
| VIDEO_ENCODER | 视频编码类型 |
| AUDIO_DECODER | 音频解码类型 |
| AUDIO_ENCODER | 音频编码类型 |
| INVALID_TYPE | 无效类型 |
### OmxIndexCodecExType
```
enum OmxIndexCodecExType
```
**描述：**
枚举Codec扩展index。
| 枚举值 | 描述 |
| -------- | -------- |
| OMX_IndexExtBufferTypeStartUnused | BufferType 扩展index |
| OMX_IndexParamSupportBufferType | SupportBuffer类型 |
| OMX_IndexParamUseBufferType | UseBuffer类型 |
| OMX_IndexParamGetBufferHandleUsage | GetBufferHandleUsage类型 |
### OmxVideoExType
```
enum OmxVideoExType
```
**描述：**
枚举Codec扩展编码类型。
| 枚举值 | 描述 |
| -------- | -------- |
| OMX_VIDEO_CodingHEVC | HEVC编码类型 |
### Profile
```
enum Profile
```
**描述：**
枚举Codec规格。
| 枚举值 | 描述 |
| -------- | -------- |
| INVALID_PROFILE | 无效的规格。 |
| AAC_LC_PROFILE | AAC低复杂度规格。 |
| AAC_MAIN_PROFILE | AAC主规格。 |
| AAC_HE_V1_PROFILE | AAC高效率和频带重现规格，又称为HEAAC，AAC+，或者AACPlusV1。 |
| AAC_HE_V2_PROFILE | AAC高效率和频带重现以及变量立体声规格，又称为AAC++或者AACPlusV2。 |
| AAC_LD_PROFILE | AAC低延迟规格。 |
| AAC_ELD_PROFILE | AAC增强型低延迟规格。 |
| AVC_BASELINE_PROFILE | H.264低规格。 |
| AVC_MAIN_PROFILE | H.264主规格。 |
| AVC_HIGH_PROFILE | H.264高规格。 |
| HEVC_MAIN_PROFILE | H.265主规格。 |
| HEVC_MAIN_10_PROFILE | H.265 10比特主规格。 |
### ShareMemTypes
```
enum ShareMemTypes
```
**描述：**
枚举共享内存类型。
| 枚举值 | 描述 |
| -------- | -------- |
| READ_WRITE_TYPE | 可读可写的共享内存类型 |
| READ_ONLY_TYPE | 可读的共享内存类型 |
## **函数说明**
### CodecCallbackTypeGet()
```
struct CodecCallbackType* CodecCallbackTypeGet (struct HdfRemoteService * remote)
```
**描述：**
实例化CodecCallbackType对象。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| remote | 输入参数，指向HdfRemoteService的指针。 |
**返回：**
实例化CodecCallbackType对象。
**Since：**
3.1
### CodecCallbackTypeRelease()
```
void CodecCallbackTypeRelease (struct CodecCallbackType * instance)
```
**描述：**
释放CodecCallbackType对象。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| instance | 输入参数，指向CodecCallbackType实例的指针。 |
**Since：**
3.1
### CodecComponentManagerRelease()
```
void CodecComponentManagerRelease (void )
```
**描述：**
释放CodecComponentManager对象。
**Since：**
3.1
### CodecComponentTypeGet()
```
struct CodecComponentType* CodecComponentTypeGet (struct HdfRemoteService * remote)
```
**描述：**
实例化CodecComponentType对象。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| remote | 输入参数，指向RemoteService的指针。 |
**返回：**
实例化的CodecComponentType对象。
**Since：**
3.1
### CodecComponentTypeRelease()
```
void CodecComponentTypeRelease (struct CodecComponentType * instance)
```
**描述：**
释放CodecComponentType对象。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| instance | 输入参数，指向CodecComponentType实例的指针。 |
**Since：**
3.1
### GetCodecComponentManager()
```
struct CodecComponentManager* GetCodecComponentManager (void )
```
**描述：**
实例化CodecComponentManager对象。
**返回：**
实例化的CodecComponentManager对象。
**Since：**
3.1
## **变量说明**
### AllocateBuffer
```
int32_t(* CodecComponentType::AllocateBuffer) (struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer)
```
**描述：**
向组件申请端口buffer。
向组件申请分配新的buffer，此接口在以下情况下使用：
- 当组件处于OMX_StateLoaded状态，并且用户已经向组件发送OMX_StateIdle状态转换请求。
- 当组件处于OMX_StateWaitForResources状态，所需的资源可用，并且组件已准备好进入OMX_StateIdle状态。
- 在去使能端口上，组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| portIndex | 输入参数，指定的组件端口。 |
| buffer | 输入输出参数，指向要申请的buffer结构体[OmxCodecBuffer](_omx_codec_buffer.md)指针。 |
**返回：**
HDF_SUCCESS 表示申请buffer成功。
HDF_ERR_INVALID_PARAM 表示参数无效，申请buffer失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，申请buffer失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，申请buffer失败。
**Since：**
3.1
### ComponentDeInit
```
int32_t(* CodecComponentType::ComponentDeInit) (struct CodecComponentType *self)
```
**描述：**
组件去初始化。
调用此接口使组件去初始化，当组件处于OMX_StateLoaded状态时，将直接关闭组件。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
**返回：**
HDF_SUCCESS 表示去初始化成功。
HDF_ERR_INVALID_PARAM 表示参数无效，去初始化失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，去初始化失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，去初始化失败。
**Since：**
3.1
### ComponentRoleEnum
```
int32_t(* CodecComponentType::ComponentRoleEnum) (struct CodecComponentType *self, uint8_t *role, uint32_t roleLen, uint32_t index)
```
**描述：**
获取组件角色。
根据组件角色索引获取对应组件角色。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| role | 输出参数，角色名称。 |
| roleLen | 输入参数，role字节数。 |
| index | 输入参数，角色的索引，一个组件可能支持多种角色。 |
**返回：**
HDF_SUCCESS 表示获取角色成功。
HDF_ERR_INVALID_PARAM 表示参数无效，获取角色失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，获取角色失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取角色失败。
**Since：**
3.1
### ComponentTunnelRequest
```
int32_t(* CodecComponentType::ComponentTunnelRequest) (struct CodecComponentType *self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE *tunnelSetup)
```
**描述：**
设置组件采用Tunnel方式通信。
当组件处于OMX_StateLoaded 状态时，用户通过调用此接口确定组件是否可以进行Tunnel传输，如果可以则设置组件的Tunnel传输。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| port | 输入参数，组件设置的端口。 |
| tunneledComp | 输入参数，组件的tunnel handle。 |
| tunneledPort | 输入参数，组件用来Tunnel通信的端口。 |
| tunnelSetup | 输入输出参数，指向Tunnel设置的结构体**OMX_TUNNELSETUPTYPE**指针。 |
**返回：**
HDF_SUCCESS 表示设置成功。
HDF_ERR_INVALID_PARAM 表示参数无效，设置失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，设置失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，设置失败。
**Since：**
3.1
### EmptyBufferDone
```
int32_t(* CodecCallbackType::EmptyBufferDone) (struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, const struct OmxCodecBuffer *buffer)
```
**描述：**
上报输入buffer编码或者解码处理完毕。
组件运行过程中向上报告输入buffer已经使用完毕。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的callback指针。 |
| appData | 输入参数，上层数据，通常是设置回调时给入的上层实例。 |
| appDataLen | 输入参数，appData字节数。 |
| buffer | 输入参数，已经处理完毕的输入buffer信息[OmxCodecBuffer](_omx_codec_buffer.md)。 |
**返回：**
HDF_SUCCESS 表示上报成功。
HDF_ERR_INVALID_PARAM 表示参数无效，上报失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，上报失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，上报失败。
**Since：**
3.1
### EmptyThisBuffer
```
int32_t(* CodecComponentType::EmptyThisBuffer) (struct CodecComponentType *self, const struct OmxCodecBuffer *buffer)
```
**描述：**
编解码输入待处理buffer。
此接口在组件处于OMX_StateExecuting或者OMX_StatePause状态时调用。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| buffer | 输入参数，指向[OmxCodecBuffer](_omx_codec_buffer.md)结构体的指针。 |
**返回：**
HDF_SUCCESS 表示输入buffer成功。
HDF_ERR_INVALID_PARAM 表示参数无效，输入buffer失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，输入buffer失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，输入buffer失败。
**Since：**
3.1
### EventHandler
```
int32_t(* CodecCallbackType::EventHandler) (struct CodecCallbackType *self, enum OMX_EVENTTYPE event, struct EventInfo *info)
```
**描述：**
事件上报。
组件运行过程中向上报告错误事件、命令完成事件、端口设置更改事件等。
- 当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。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的callback指针。 |
| event | 输入参数，要通知的事件类型，详见**OMX_EVENTTYPE**。 |
| info | 输入参数，指向事件上报携带的信息指针，详见[EventInfo](_event_info.md)。 |
**返回：**
HDF_SUCCESS 表示事件上报成功。
HDF_ERR_INVALID_PARAM 表示参数无效，事件上报失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，事件上报失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，事件上报失败。
**Since：**
3.1
### FillBufferDone
```
int32_t(* CodecCallbackType::FillBufferDone) (struct CodecCallbackType *self, int8_t *appData, uint32_t appDataLen, struct OmxCodecBuffer *buffer)
```
**描述：**
上报输出buffer填充完毕。
组件运行过程中向上报告输出buffer已经填充完毕。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的callback指针。 |
| appData | 输入参数，上层数据，通常是设置回调时给入的上层实例。 |
| appDataLen | 输入参数，appData字节数。 |
| buffer | 输入参数，已经填充完毕的buffer信息[OmxCodecBuffer](_omx_codec_buffer.md)。 |
**返回：**
HDF_SUCCESS 表示上报成功。
HDF_ERR_INVALID_PARAM 表示参数无效，上报失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，上报失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，上报失败。
**Since：**
3.1
### FillThisBuffer
```
int32_t(* CodecComponentType::FillThisBuffer) (struct CodecComponentType *self, const struct OmxCodecBuffer *buffer)
```
**描述：**
编解码输出填充buffer。
此接口在组件处于OMX_StateExecuting或者OMX_StatePause状态时调用。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| buffer | 输入参数，指向[OmxCodecBuffer](_omx_codec_buffer.md)结构体的指针。 |
**返回：**
HDF_SUCCESS 表示填充buffer成功。
HDF_ERR_INVALID_PARAM 表示参数无效，填充buffer失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，填充buffer失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，填充buffer失败。
**Since：**
3.1
### FreeBuffer
```
int32_t(* CodecComponentType::FreeBuffer) (struct CodecComponentType *self, uint32_t portIndex, const struct OmxCodecBuffer *buffer)
```
**描述：**
释放buffer。
此接口在以下情况下使用：
- 当组件处于OMX_StateIdle状态，并且已经向组件发送OMX_StateLoaded状态转换请求。
- 在去使能端口上，组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle时调用。
- 此接口调用可随时进行，但是如果未在上述情况下执行，可能会导致组件上报OMX_ErrorPortUnpopulated事件。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| portIndex | 输入参数，指定的组件端口。 |
| buffer | 输入参数，指向[OmxCodecBuffer](_omx_codec_buffer.md)结构体的指针。 |
**返回：**
HDF_SUCCESS 表示释放buffer成功。
HDF_ERR_INVALID_PARAM 表示参数无效，释放buffer失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，释放buffer失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，释放buffer失败。
**Since：**
3.1
### GetComponentVersion
```
int32_t(* CodecComponentType::GetComponentVersion) (struct CodecComponentType *self, struct CompVerInfo *verInfo)
```
**描述：**
获取Codec组件版本号。
通过查询组件，返回组件版本信息。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| verInfo | 输出参数，指向组件版本信息的指针，详见[CompVerInfo](_comp_ver_info.md)。 |
**返回：**
HDF_SUCCESS 表示获取版本号成功。
HDF_ERR_INVALID_PARAM 表示参数无效，获取版本号失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，获取版本号失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取版本号失败。
**Since：**
3.1
### GetConfig
```
int32_t(* CodecComponentType::GetConfig) (struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen)
```
**描述：**
获取组件的配置结构。
加载组件后可以随时调用此接口获取组件的配置。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| index | 输入参数，待填充结构的索引，详见**OMX_INDEXTYPE**。 |
| cfgStruct | 输入输出参数，指向由组件填充的应用程序分配的结构体指针。 |
| cfgStructLen | 输入参数，上层传入的cfgStruct字节数。 |
**返回：**
HDF_SUCCESS 表示获取配置成功。
HDF_ERR_INVALID_PARAM 表示参数无效，获取配置失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，获取配置失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取配置失败。
**Since：**
3.1
### GetExtensionIndex
```
int32_t(* CodecComponentType::GetExtensionIndex) (struct CodecComponentType *self, const char *paramName, uint32_t *indexType)
```
**描述：**
根据字符串获取组件的扩展索引。
将扩展字符串转换为Openmax IL结构索引。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| paramName | 输入参数，组件用来转换为配置索引的字符串。 |
| indexType | 输出参数，由paramName转换的配置索引，详见**OMX_INDEXTYPE**。 |
**返回：**
HDF_SUCCESS 表示获取扩展索引成功。
HDF_ERR_INVALID_PARAM 表示参数无效，获取扩展索引失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，获取扩展索引失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取扩展索引失败。
**Since：**
3.1
### GetParameter
```
int32_t(* CodecComponentType::GetParameter) (struct CodecComponentType *self, uint32_t paramIndex, int8_t *paramStruct, uint32_t paramStructLen)
```
**描述：**
获取组件参数设置。
当组件处于除了OMX_StateInvalid（组件状态异常）之外的其他状态，用户可通过此接口获取组件参数。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| paramIndex | 输入参数，待填充结构的索引，详见**OMX_INDEXTYPE**。 |
| paramStruct | 输入输出参数，指向由组件填充的应用程序分配的结构体指针。 |
| paramStructLen | 输入参数，paramStruct字节数。 |
**返回：**
HDF_SUCCESS 表示获取参数成功。
HDF_ERR_INVALID_PARAM 表示参数无效，获取参数失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，获取参数失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取参数失败。
**Since：**
3.1
### GetState
```
int32_t(* CodecComponentType::GetState) (struct CodecComponentType *self, enum OMX_STATETYPE *state)
```
**描述：**
获取组件的当前状态。
用户可调用此接口获取组件的当前状态，组件状态详见**OMX_STATETYPE**。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| state | 输出参数，指向获取到的状态指针，组件状态详见**OMX_STATETYPE**。 |
**返回：**
HDF_SUCCESS 表示获取状态成功。
HDF_ERR_INVALID_PARAM 表示参数无效，获取状态失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，获取状态失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，获取状态失败。
**Since：**
3.1
### remote
```
struct HdfRemoteService* CodecCallbackType::remote
```
**描述：**
指向HdfRemoteService的指针。
**Since：**
3.1
### SendCommand
```
int32_t(* CodecComponentType::SendCommand) (struct CodecComponentType *self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t *cmdData, uint32_t cmdDataLen)
```
**描述：**
发送命令给组件。
发送命令给组件，当命令为设置状态时，会有事件回调通知结果给上层，其他命令则没有事件上报。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| cmd | 输入参数，组件要执行的命令，详见**OMX_COMMANDTYPE**。 |
| param | 输入参数，组件要执行的命令携带的参数。
- 当cmd为OMX_CommandStateSet时，param的值详见**OMX_STATETYPE**。
- 当cmd为OMX_CommandFlush、OMX_CommandPortDisable、OMX_CommandPortEnable、OMX_CommandMarkBuffer时，param为目标端口。 |
| cmdData | 输入参数，当cmd为OMX_CommandMarkBuffer时，指向OMX_MARKTYPE结构体指针。 |
| cmdDataLen | 输入参数，上层传递的cmdData字节数。 |
**返回：**
HDF_SUCCESS 表示发送命令成功。
HDF_ERR_INVALID_PARAM 表示参数无效，发送命令失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，发送命令失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，发送命令失败。
**Since：**
3.1
### SetCallbacks
```
int32_t(* CodecComponentType::SetCallbacks) (struct CodecComponentType *self, struct CodecCallbackType *callback, int8_t *appData, uint32_t appDataLen)
```
**描述：**
设置Codec组件的回调函数。
当组件处于OMX_StateLoaded状态时，使用此回调函数向上通知事件以及上报可用的输入输出信息。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| callback | 输入参数，指向回调函数[CodecCallbackType](_codec_callback_type.md)对象指针。 |
| appData | 输入参数，指向应用程序定义的值的指针，该值将在回调期间返回。 |
| appDataLen | 输入参数，上层传递的appData字节数。 |
**返回：**
HDF_SUCCESS 表示设置回调成功。
HDF_ERR_INVALID_PARAM 表示参数无效，设置回调失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，设置回调失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，设置回调失败。
**Since：**
3.1
### SetConfig
```
int32_t(* CodecComponentType::SetConfig) (struct CodecComponentType *self, uint32_t index, int8_t *cfgStruct, uint32_t cfgStructLen)
```
**描述：**
设置组件的配置。
加载组件后可以随时调用此接口设置组件的配置。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| index | 输入参数，要设置的结构索引，详见**OMX_INDEXTYPE**。 |
| cfgStruct | 输入参数，指向组件用于初始化的应用程序分配结构的指针。 |
| cfgStructLen | 输入参数，cfgStruct字节数。 |
**返回：**
HDF_SUCCESS 表示设置配置成功。
HDF_ERR_INVALID_PARAM 表示参数无效，设置失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，设置失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，设置失败。
**Since：**
3.1
### SetParameter
```
int32_t(* CodecComponentType::SetParameter) (struct CodecComponentType *self, uint32_t index, int8_t *paramStruct, uint32_t paramStructLen)
```
**描述：**
设置组件需要的参数。
当组件处于OMX_StateLoaded、OMX_StateWaitForResources状态或者端口是去使能状态，用户可通过此接口设置组件参数。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| index | 输入参数，要设置的结构索引，详见**OMX_INDEXTYPE**。 |
| paramStruct | 输入参数，指向组件用于初始化的应用程序分配结构的指针。 |
| paramStructLen | 输入参数，paramStruct字节数。 |
**返回：**
HDF_SUCCESS 表示设置参数成功。
HDF_ERR_INVALID_PARAM 表示参数无效，设置参数失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，设置参数失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，设置参数失败。
**Since：**
3.1
### UseBuffer
```
int32_t(* CodecComponentType::UseBuffer) (struct CodecComponentType *self, uint32_t portIndex, struct OmxCodecBuffer *buffer)
```
**描述：**
指定组件端口的buffer。
此接口在以下情况下使用：
- 当组件处于OMX_StateLoaded状态，并且用户已经向组件发送OMX_StateIdle状态转换请求。
- 当组件处于OMX_StateWaitForResources状态，所需的资源可用，并且组件已准备好进入OMX_StateIdle状态。
- 在去使能端口上，组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| portIndex | 输入参数，指定的组件端口。 |
| buffer | 输入输出参数，指向要使用的buffer结构体[OmxCodecBuffer](_omx_codec_buffer.md)指针。 |
**返回：**
HDF_SUCCESS 表示指定成功。
HDF_ERR_INVALID_PARAM 表示参数无效，指定失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，指定失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，指定失败。
**Since：**
3.1
### UseEglImage
```
int32_t(* CodecComponentType::UseEglImage) (struct CodecComponentType *self, struct OmxCodecBuffer *buffer, uint32_t portIndex, int8_t *eglImage, uint32_t eglImageLen)
```
**描述：**
使用已在EGL中申请的空间。
此接口在以下情况下使用：
- 当组件处于OMX_StateLoaded状态，并且已经向组件发送OMX_StateIdle状态转换请求。
- 当组件处于OMX_StateWaitForResources状态，所需的资源可用，并且组件已准备好进入OMX_StateIdle状态。
- 在去使能端口上，组件处于OMX_StateExecuting、OMX_StatePause或OMX_StateIdle状态。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| self | 输入参数，指向要操作的Codec组件指针。 |
| buffer | 输入输出参数，指向[OmxCodecBuffer](_omx_codec_buffer.md)结构体的指针。 |
| portIndex | 输入参数，指定的组件端口。 |
| eglImage | 输入参数，EGL申请的图像指针。 |
| eglImageLen | 输入参数，eglImage字节数。 |
**返回：**
HDF_SUCCESS 表示使用成功。
HDF_ERR_INVALID_PARAM 表示参数无效，使用失败。
HDF_ERR_INVALID_OBJECT 表示对象无效，使用失败。
HDF_ERR_MALLOC_FAIL 表示申请内存失败，使用失败。
**Since：**
3.1