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