1# ICodecImage 2 3 4## 概述 5 6图像编解码器模块接口。 7 8**起始版本：** 4.0 9 10**相关模块：**[Codec](_codec_v10.md) 11 12 13## 汇总 14 15 16### Public 成员函数 17 18| 名称 | 描述 | 19| -------- | -------- | 20| [GetImageCapability](#getimagecapability) ([out] struct [CodecImageCapability](_codec_image_capability_v10.md)[] capList) | 获得图像编解码器功能。 | 21| [Init](#init) ([in] enum [CodecImageRole](_codec_v10.md#codecimagerole) role) | 图像编解码器模块初始化。 | 22| [DeInit](#deinit) ([in] enum [CodecImageRole](_codec_v10.md#codecimagerole) role) | 图像编解码器模块去初始化。 | 23| [DoJpegDecode](#dojpegdecode) ([in] struct [CodecImageBuffer](_codec_image_buffer_v10.md) inBuffer, [in] struct [CodecImageBuffer](_codec_image_buffer_v10.md) outBuffer, [in] struct [CodecJpegDecInfo](_codec_jpeg_dec_info_v10.md) decInfo) | 启动jpeg图像解码。 | 24| [AllocateInBuffer](#allocateinbuffer) ([out] struct [CodecImageBuffer](_codec_image_buffer_v10.md) inBuffer, [in] unsigned int size, [in] [CodecImageRole](_codec_v10.md#codecimagerole) role) | 分配输入缓冲区。 | 25| [FreeInBuffer](#freeinbuffer) ([in] struct [CodecImageBuffer](_codec_image_buffer_v10.md) inBuffer) | 释放输入缓冲区。 | 26 27 28## 成员函数说明 29 30 31### AllocateInBuffer() 32 33``` 34ICodecImage::AllocateInBuffer ([out] struct CodecImageBuffer inBuffer, [in] unsigned int size, [in] CodecImageRole role ) 35``` 36 37**描述** 38 39分配输入缓冲区。 40 41您可以使用此API为图像编解码器分配输入缓冲区。 42 43**起始版本：** 4.0 44 45**参数:** 46 47| 名称 | 描述 | 48| -------- | -------- | 49| inBuffer | 获得的图像编解码器的输入缓冲区[CodecImageBuffer](_codec_image_buffer_v10.md)。 | 50| size | 获得的输入缓冲区的大小[CodecImageBuffer](_codec_image_buffer_v10.md)。 | 51| role | 获取的输入缓冲区的图像编解码器格式[CodecImageRole](_codec_v10.md#codecimagerole)。 | 52 53**返回：** 54 55成功返回HDF_SUCCESS 56 57输入无效参数返回HDF_ERR_INVALID_PARAM 58 59失败返回HDF_FAILURE 60 61如果vendor层返回失败，则返回其他值。其他错误代码详见[HDF_STATUS](https://gitee.com/openharmony/drivers_hdf_core/blob/master/interfaces/inner_api/utils/hdf_base.h)的定义。 62 63 64### DeInit() 65 66``` 67ICodecImage::DeInit ([in] enum CodecImageRole role) 68``` 69 70**描述** 71 72图像编解码器模块去初始化。 73 74您可以使用此API对图像编解码器模块进行去初始化。 75 76**起始版本：** 4.0 77 78**参数:** 79 80| 名称 | 描述 | 81| -------- | -------- | 82| role | 指示获取的图像编解码器格式[CodecImageRole](_codec_v10.md#codecimagerole)。 | 83 84**返回：** 85 86成功返回HDF_SUCCESS 87 88如果vendor层返回失败，则返回其他值。其他错误代码详见[HDF_STATUS](https://gitee.com/openharmony/drivers_hdf_core/blob/master/interfaces/inner_api/utils/hdf_base.h)的定义。 89 90 91### DoJpegDecode() 92 93``` 94ICodecImage::DoJpegDecode ([in] struct CodecImageBuffer inBuffer, [in] struct CodecImageBuffer outBuffer, [in] struct CodecJpegDecInfo decInfo ) 95``` 96 97**描述** 98 99启动jpeg图像解码。 100 101您可以使用此API启动jpeg图像解码。 102 103**起始版本：** 4.0 104 105**参数:** 106 107| 名称 | 描述 | 108| -------- | -------- | 109| inBuffer | 获得的jpeg图像解码的输入缓冲区[CodecImageBuffer](_codec_image_buffer_v10.md)。 | 110| outBuffer | 获得的jpeg图像解码的输出缓冲区[CodecImageBuffer](_codec_image_buffer_v10.md)。 | 111| decInfo | 获得的jpeg图像解码的解码信息[CodecJpegDecInfo](_codec_jpeg_dec_info_v10.md)。 | 112 113**返回：** 114 115成功返回HDF_SUCCESS 116 117输入无效参数返回HDF_ERR_INVALID_PARAM 118 119失败返回HDF_FAILURE 120 121如果vendor层返回失败，则返回其他值。其他错误代码详见[HDF_STATUS](https://gitee.com/openharmony/drivers_hdf_core/blob/master/interfaces/inner_api/utils/hdf_base.h)的定义。 122 123 124### FreeInBuffer() 125 126``` 127ICodecImage::FreeInBuffer ([in] struct CodecImageBuffer inBuffer) 128``` 129 130**描述** 131 132释放输入缓冲区。 133 134您可以使用这个API来释放输入缓冲区用于图像解码。 135 136**起始版本：** 4.0 137 138**参数:** 139 140| 名称 | 描述 | 141| -------- | -------- | 142| buffer | 获得的图像编解码器的输入缓冲区[CodecImageBuffer](_codec_image_buffer_v10.md)。 | 143 144**返回：** 145 146成功返回HDF_SUCCESS 147 148如果vendor层返回失败，则返回其他值。其他错误代码详见[HDF_STATUS](https://gitee.com/openharmony/drivers_hdf_core/blob/master/interfaces/inner_api/utils/hdf_base.h)的定义。 149 150 151### GetImageCapability() 152 153``` 154ICodecImage::GetImageCapability ([out] struct CodecImageCapability[] capList) 155``` 156 157**描述** 158 159获得图像编解码器功能。 160 161您可以使用此API来获得图像编解码器模块提供的编解码能力集。详见[CodecImageCapability](_codec_image_capability_v10.md)。 162 163**起始版本：** 4.0 164 165**参数:** 166 167| 名称 | 描述 | 168| -------- | -------- | 169| capList | 指向获得的图像编解码器能力集[CodecImageCapability](_codec_image_capability_v10.md)。 | 170 171**返回：** 172 173成功返回HDF_SUCCESS 174 175失败返回HDF_FAILURE 176 177 178### Init() 179 180``` 181ICodecImage::Init ([in] enum CodecImageRole role) 182``` 183 184**描述** 185 186图像编解码器模块初始化。 187 188您可以使用此API来初始化图像编解码器模块。 189 190**起始版本：** 4.0 191 192**参数:** 193 194| 名称 | 描述 | 195| -------- | -------- | 196| role | 指示获取的图像编解码器格式[CodecImageRole](_codec_v10.md#codecimagerole)。 | 197 198**返回：** 199 200成功返回HDF_SUCCESS 201 202如果vendor层返回失败，则返回其他值。其他错误代码详见[HDF_STATUS](https://gitee.com/openharmony/drivers_hdf_core/blob/master/interfaces/inner_api/utils/hdf_base.h)的定义。 203