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分配输入缓冲区。 40 41您可以使用此API为图像编解码器分配输入缓冲区。 42 43**起始版本：** 4.0 44 45**参数:** 46 47| 名称 | 描述 | 48| -------- | -------- | 49| inBuffer | 获得的图像编解码器的输入缓冲区[CodecImageBuffer](_codec_image_buffer_v20.md)。 | 50| size | 获得的输入缓冲区的大小[CodecImageBuffer](_codec_image_buffer_v20.md)。 | 51| role | 获取的输入缓冲区的图像编解码器格式[CodecImageRole](_codec_v20.md#codecimagerole)。 | 52 53**返回：** 54 55成功返回HDF_SUCCESS 56 57输入无效参数返回HDF_ERR_INVALID_PARAM 58 59失败返回HDF_FAILURE 60 61如果vendor层返回失败，则返回其他值。其他错误代码详见HDF_STATUS的定义。 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_v20.md#codecimagerole)。 | 83 84**返回：** 85 86成功返回HDF_SUCCESS 87 88成功返回HDF_SUCCESS 89 90如果vendor层返回失败，则返回其他值。其他错误代码详见HDF_STATUS的定义。 91 92 93### DoJpegDecode() 94 95``` 96ICodecImage::DoJpegDecode ([in] struct CodecImageBuffer inBuffer, [in] struct CodecImageBuffer outBuffer, [in] struct CodecJpegDecInfo decInfo ) 97``` 98 99**描述** 100 101启动jpeg图像解码。 102 103您可以使用此API启动jpeg图像解码。 104 105**起始版本：** 4.0 106 107**参数:** 108 109| 名称 | 描述 | 110| -------- | -------- | 111| inBuffer | 获得的jpeg图像解码的输入缓冲区[CodecImageBuffer](_codec_image_buffer_v20.md)。 | 112| outBuffer | 获得的jpeg图像解码的输出缓冲区[CodecImageBuffer](_codec_image_buffer_v20.md)。 | 113| decInfo | 获得的jpeg图像解码的解码信息[CodecJpegDecInfo](_codec_jpeg_dec_info_v20.md)。 | 114 115**返回：** 116 117成功返回HDF_SUCCESS 118 119输入无效参数返回HDF_ERR_INVALID_PARAM 120 121失败返回HDF_FAILURE 122 123如果vendor层返回失败，则返回其他值。其他错误代码详见HDF_STATUS的定义。 124 125 126### FreeInBuffer() 127 128``` 129ICodecImage::FreeInBuffer ([in] struct CodecImageBuffer inBuffer) 130``` 131 132**描述** 133 134释放输入缓冲区。 135 136您可以使用这个API来释放输入缓冲区用于图像解码。 137 138**起始版本：** 4.0 139 140**参数:** 141 142| 名称 | 描述 | 143| -------- | -------- | 144| buffer | 获得的图像编解码器的输入缓冲区[CodecImageBuffer](_codec_image_buffer_v20.md)。 | 145 146**返回：** 147 148成功返回HDF_SUCCESS 149 150成功返回HDF_SUCCESS 151 152如果vendor层返回失败，则返回其他值。其他错误代码详见HDF_STATUS的定义。 153 154 155### GetImageCapability() 156 157``` 158ICodecImage::GetImageCapability ([out] struct CodecImageCapability[] capList) 159``` 160 161**描述** 162 163获得图像编解码器功能。 164 165您可以使用此API来获得图像编解码器模块提供的编解码能力集。详见[CodecImageCapability](_codec_image_capability_v20.md)。 166 167**起始版本：** 4.0 168 169**参数:** 170 171| 名称 | 描述 | 172| -------- | -------- | 173| capList | 指向获得的图像编解码器能力集[CodecImageCapability](_codec_image_capability_v20.md)。 | 174 175**返回：** 176 177成功返回HDF_SUCCESS 178 179失败返回HDF_FAILURE 180 181 182### Init() 183 184``` 185ICodecImage::Init ([in] enum CodecImageRole role) 186``` 187 188**描述** 189 190图像编解码器模块初始化。 191 192您可以使用此API来初始化图像编解码器模块。 193 194**起始版本：** 4.0 195 196**参数:** 197 198| 名称 | 描述 | 199| -------- | -------- | 200| role | 指示获取的图像编解码器格式[CodecImageRole](_codec_v20.md#codecimagerole)。 | 201 202**返回：** 203 204成功返回HDF_SUCCESS 205 206成功返回HDF_SUCCESS 207 208如果vendor层返回失败，则返回其他值。其他错误代码详见HDF_STATUS的定义。 209