1# 音频解码 2 3开发者可以调用本模块的Native API接口，完成音频解码，即将媒体数据解码为PCM码流。 4 5当前支持的解码能力请参考[AVCodec支持的格式](avcodec-support-formats.md#音频解码)。 6 7**适用场景** 8 9- 音频播放 10 11 在播放音频之前，需要先解码音频，再将数据输送到硬件扬声器播放。 12- 音频渲染 13 14 在对音频文件进行音效处理之前，需要先解码再由音频处理模块进行音频渲染。 15- 音频编辑 16 17 音频编辑（如调整单个声道的播放倍速等）需要基于PCM码流进行，所以需要先将音频文件解码。 18> **说明：** 19> 20> 通过MP3音频编码流程生成的码流无法直接通过MP3音频解码流程进行解码。建议通过（PCM码流->MP3音频编码->封装->解封装->MP3音频解码）流程进行。 21 22## 开发指导 23 24详细的API说明请参考[API文档](../../reference/apis-avcodec-kit/_audio_codec.md)。 25 26参考以下示例代码，完成音频解码的全流程，包括：创建解码器、设置解码参数（采样率/码率/声道数等）、开始、刷新、重置、销毁资源。 27 28在应用开发过程中，开发者应按一定顺序调用方法，执行对应操作，否则系统可能会抛出异常或生成其他未定义的行为。具体顺序可参考下列开发步骤及对应说明。 29 30如下为音频解码调用关系图： 31 32- 虚线表示可选。 33 34- 实线表示必选。 35 36 37 38### 在 CMake 脚本中链接动态库 39 40```cmake 41target_link_libraries(sample PUBLIC libnative_media_codecbase.so) 42target_link_libraries(sample PUBLIC libnative_media_core.so) 43target_link_libraries(sample PUBLIC libnative_media_acodec.so) 44``` 45 46### 开发步骤 47 481. 添加头文件。 49 50 ```cpp 51 #include <multimedia/player_framework/native_avcodec_audiocodec.h> 52 #include <multimedia/native_audio_channel_layout.h> 53 #include <multimedia/player_framework/native_avcapability.h> 54 #include <multimedia/player_framework/native_avcodec_base.h> 55 #include <multimedia/player_framework/native_avformat.h> 56 #include <multimedia/player_framework/native_avbuffer.h> 57 ``` 58 592. 创建解码器实例对象，OH_AVCodec *为解码器实例指针。 60 61 ```cpp 62 //c++标准库命名空间。 63 using namespace std; 64 // 通过 codec name 创建解码器。 65 OH_AVCapability *capability = OH_AVCodec_GetCapability(OH_AVCODEC_MIMETYPE_AUDIO_MPEG, false); 66 const char *name = OH_AVCapability_GetName(capability); 67 OH_AVCodec *audioDec_ = OH_AudioCodec_CreateByName(name); 68 ``` 69 70 ```cpp 71 // 设置判定是否为编码；设置false表示当前是解码。 72 bool isEncoder = false; 73 // 通过 Mimetype 创建解码器。 74 OH_AVCodec *audioDec_ = OH_AudioCodec_CreateByMime(OH_AVCODEC_MIMETYPE_AUDIO_MPEG, isEncoder); 75 ``` 76 77 ```cpp 78 // 初始化队列。 79 class ADecBufferSignal { 80 public: 81 std::mutex inMutex_; 82 std::mutex outMutex_; 83 std::mutex startMutex_; 84 std::condition_variable inCond_; 85 std::condition_variable outCond_; 86 std::condition_variable startCond_; 87 std::queue<uint32_t> inQueue_; 88 std::queue<uint32_t> outQueue_; 89 std::queue<OH_AVBuffer *> inBufferQueue_; 90 std::queue<OH_AVBuffer *> outBufferQueue_; 91 }; 92 ADecBufferSignal *signal_; 93 ``` 94 953. 调用OH_AudioCodec_RegisterCallback()注册回调函数。 96 97 注册回调函数指针集合OH_AVCodecCallback，包括： 98 99 - OH_AVCodecOnError：解码器运行错误。 100 - OH_AVCodecOnStreamChanged：码流信息变化回调，包括采样率变化、声道数变化、音频采样格式变化，支持检测此变化的解码格式有：<!--RP5--><!--RP5End-->AAC，FLAC，MP3，VORBIS。(API 15开始支持) 101 - OH_AVCodecOnNeedInputBuffer：运行过程中需要新的输入数据，即解码器已准备好，可以输入数据。 102 - OH_AVCodecOnNewOutputBuffer：运行过程中产生了新的输出数据，即解码完成。 103 104 开发者可以通过处理该回调报告的信息，确保解码器正常运转。 105 106 > **注意：** 107 > 回调中不建议进行耗时操作。 108 109 ```cpp 110 // OH_AVCodecOnError回调函数的实现。 111 static void OnError(OH_AVCodec *codec, int32_t errorCode, void *userData) 112 { 113 (void)codec; 114 (void)errorCode; 115 (void)userData; 116 } 117 // OH_AVCodecOnStreamChanged回调函数的实现。 118 static void OnOutputFormatChanged(OH_AVCodec *codec, OH_AVFormat *format, void *userData) 119 { 120 (void)codec; 121 (void)userData; 122 // 解码输出参数变化后的回调处理，应用根据实际情况进行处理。 123 int32_t sampleRate; 124 int32_t channelCount; 125 int32_t sampleFormat; 126 if (OH_AVFormat_GetIntValue(format, OH_MD_KEY_AUD_SAMPLE_RATE, &sampleRate)) { 127 // 判断采样率是否发生变化，进行对应处理。 128 } 129 if (OH_AVFormat_GetIntValue(format, OH_MD_KEY_AUD_CHANNEL_COUNT, &channelCount)) { 130 // 判断声道数是否发生变化，进行对应处理。 131 } 132 if (OH_AVFormat_GetIntValue(format, OH_MD_KEY_AUDIO_SAMPLE_FORMAT, &sampleFormat)) { 133 // 判断音频采样格式是否发生变化，进行对应处理。 134 } 135 } 136 // OH_AVCodecOnNeedInputBuffer回调函数的实现。 137 static void OnInputBufferAvailable(OH_AVCodec *codec, uint32_t index, OH_AVBuffer *data, void *userData) 138 { 139 (void)codec; 140 ADecBufferSignal *signal = static_cast<ADecBufferSignal *>(userData); 141 unique_lock<mutex> lock(signal->inMutex_); 142 signal->inQueue_.push(index); 143 signal->inBufferQueue_.push(data); 144 signal->inCond_.notify_all(); 145 // 解码输入码流送入inBufferQueue_队列。 146 } 147 // OH_AVCodecOnNewOutputBuffer回调函数的实现。 148 static void OnOutputBufferAvailable(OH_AVCodec *codec, uint32_t index, OH_AVBuffer *data, void *userData) 149 { 150 (void)codec; 151 ADecBufferSignal *signal = static_cast<ADecBufferSignal *>(userData); 152 unique_lock<mutex> lock(signal->outMutex_); 153 signal->outQueue_.push(index); 154 signal->outBufferQueue_.push(data); 155 signal->outCond_.notify_all(); 156 // 将对应输出buffer的 index 送入outQueue_队列。 157 // 将对应解码完成的数据data送入outBufferQueue_队列。 158 } 159 signal_ = new ADecBufferSignal(); 160 OH_AVCodecCallback cb_ = {&OnError, &OnOutputFormatChanged, &OnInputBufferAvailable, &OnOutputBufferAvailable}; 161 int32_t ret = OH_AudioCodec_RegisterCallback(audioDec_, cb_, signal_); 162 if (ret != AVCS_ERR_OK) { 163 // 异常处理。 164 } 165 ``` 166 1674. （可选）OH_AudioCodec_SetDecryptionConfig设置解密配置。 168 169 当获取到DRM信息(参考[音视频解封装](audio-video-demuxer.md)开发步骤第4步)后，通过此接口进行解密配置。 170 171 DRM相关接口详见[DRM API文档](../../reference/apis-drm-kit/_drm.md)。 172 173 此接口需在Prepare前调用。 174 175 添加头文件: 176 177 ```c++ 178 #include <multimedia/drm_framework/native_mediakeysystem.h> 179 #include <multimedia/drm_framework/native_mediakeysession.h> 180 #include <multimedia/drm_framework/native_drm_err.h> 181 #include <multimedia/drm_framework/native_drm_common.h> 182 ``` 183 在 CMake 脚本中链接动态库: 184 185 ``` cmake 186 target_link_libraries(sample PUBLIC libnative_drm.so) 187 ``` 188 189 使用示例: 190 ```c++ 191 // 根据DRM信息创建指定的DRM系统, 以创建"com.clearplay.drm"为例。 192 MediaKeySystem *system = nullptr; 193 int32_t ret = OH_MediaKeySystem_Create("com.clearplay.drm", &system); 194 if (system == nullptr) { 195 printf("create media key system failed"); 196 return; 197 } 198 199 // 创建解密会话。 200 MediaKeySession *session = nullptr; 201 DRM_ContentProtectionLevel contentProtectionLevel = CONTENT_PROTECTION_LEVEL_SW_CRYPTO; 202 ret = OH_MediaKeySystem_CreateMediaKeySession(system, &contentProtectionLevel, &session); 203 if (ret != DRM_OK) { 204 // 如创建失败，请查看DRM接口文档及日志信息。 205 printf("create media key session failed."); 206 return; 207 } 208 if (session == nullptr) { 209 printf("media key session is nullptr."); 210 return; 211 } 212 // 获取许可证请求、设置许可证响应等。 213 // 设置解密配置, 即将解密会话、安全通路标志(当前音频解密不支持安全通路，应设置为false)设置到解码器中。 214 bool secureAudio = false; 215 ret = OH_AudioCodec_SetDecryptionConfig(audioDec_, session, secureAudio); 216 ``` 217 2185. 调用OH_AudioCodec_Configure()配置解码器。 219 220 配置选项key值说明： 221 222 | key | 描述 | AAC | Flac | Vorbis | MPEG | G711mu | AMR(amrnb、amrwb) | APE | 223 | ---------------------------- | :--------------: | :--------------------------------: | :--: | :--------------------------------: | :--: | :-----------------: | :-------------------------------: | :--: | 224 | OH_MD_KEY_AUD_SAMPLE_RATE | 采样率 | 必须 | 必须 | 必须 | 必须 | 必须 | 必须 | 必须 | 225 | OH_MD_KEY_AUD_CHANNEL_COUNT | 声道数 | 必须 | 必须 | 必须 | 必须 | 必须 | 必须 | 必须 | 226 | OH_MD_KEY_MAX_INPUT_SIZE | 最大输入长度 | 可选 | 可选 | 可选 | 可选 | 可选 | 可选 | 可选 | 227 | OH_MD_KEY_AAC_IS_ADTS | 是否adts | 可选，默认1 | - | - | - | - | - | - | 228 | OH_MD_KEY_AUDIO_SAMPLE_FORMAT | 输出音频流格式 | 可选（SAMPLE_S16LE，SAMPLE_F32LE） | 可选 | 可选（SAMPLE_S16LE，SAMPLE_F32LE） | 可选 | 可选（默认SAMPLE_S16LE）| 可选（SAMPLE_S16LE，SAMPLE_F32LE）| 可选 | 229 | OH_MD_KEY_BITRATE | 码率 | 可选 | 可选 | 可选 | 可选 | 可选 | 可选 | 可选 | 230 | OH_MD_KEY_IDENTIFICATION_HEADER | ID Header | - | - | 必须（和Codec_Config二选一） | - | - | - | - | 231 | OH_MD_KEY_SETUP_HEADER | Setup Header | - | - | 必须（和Codec_Config二选一） | - | - | - | - | 232 | OH_MD_KEY_CODEC_CONFIG | 编解码器特定数据 | 可选 | - | 必须（和上述ID和Setup二选一） | - | - | - | 可选 | 233 234 各音频解码类型参数范围说明： 235 236 | 音频解码类型 | 采样率(Hz) | 声道数 | 237 | ----------- | ---------------------------------------------------------------------------------------------- | :----: | 238 | AAC | 8000、11025、12000、16000、22050、24000、32000、44100、48000、64000、88200、96000 | 1~8 | 239 | Flac | 8000、11025、12000、16000、22050、24000、32000、44100、48000、64000、88200、96000、192000 | 1~8 | 240 | Vorbis | 8000、11025、12000、16000、22050、24000、32000、44100、48000、64000、88200、96000、176400、192000 | 1~8 | 241 | MPEG(MP3) | 8000、11025、12000、16000、22050、24000、32000、44100、48000 | 1~2 | 242 | G711mu | 8000 | 1 | 243 | AMR(amrnb) | 8000 | 1 | 244 | AMR(amrwb) | 16000 | 1 | 245 | APE | 8000、11025、12000、16000、22050、24000、32000、44100、48000、64000、88200、96000、176400、192000 | 1~2 | 246 <!--RP4--> 247 <!--RP4End--> 248 249 ```cpp 250 // 设置解码分辨率。 251 int32_t ret; 252 // 配置音频采样率（必须）。 253 constexpr uint32_t DEFAULT_SAMPLERATE = 44100; 254 // 配置音频码率（可选）。 255 constexpr uint32_t DEFAULT_BITRATE = 32000; 256 // 配置音频声道数（必须）。 257 constexpr uint32_t DEFAULT_CHANNEL_COUNT = 2; 258 // 配置最大输入长度（可选）。 259 constexpr uint32_t DEFAULT_MAX_INPUT_SIZE = 1152; 260 // 配置是否为ADTS解码（aac解码时可选）。 261 constexpr uint32_t DEFAULT_AAC_TYPE = 1; 262 OH_AVFormat *format = OH_AVFormat_Create(); 263 // 写入format。 264 OH_AVFormat_SetIntValue(format, OH_MD_KEY_AUD_SAMPLE_RATE, DEFAULT_SAMPLERATE); 265 OH_AVFormat_SetIntValue(format, OH_MD_KEY_BITRATE, DEFAULT_BITRATE); 266 OH_AVFormat_SetIntValue(format, OH_MD_KEY_AUD_CHANNEL_COUNT, DEFAULT_CHANNEL_COUNT); 267 OH_AVFormat_SetIntValue(format, OH_MD_KEY_MAX_INPUT_SIZE, DEFAULT_MAX_INPUT_SIZE); 268 OH_AVFormat_SetIntValue(format, OH_MD_KEY_AAC_IS_ADTS, DEFAULT_AAC_TYPE); 269 // 配置解码器。 270 ret = OH_AudioCodec_Configure(audioDec_, format); 271 if (ret != AV_ERR_OK) { 272 // 异常处理。 273 } 274 ``` 275 2766. 调用OH_AudioCodec_Prepare()，解码器就绪。 277 278 ```cpp 279 ret = OH_AudioCodec_Prepare(audioDec_); 280 if (ret != AV_ERR_OK) { 281 // 异常处理。 282 } 283 ``` 284 2857. 调用OH_AudioCodec_Start()启动解码器，进入运行态。 286 287 ```c++ 288 unique_ptr<ifstream> inputFile_ = make_unique<ifstream>(); 289 unique_ptr<ofstream> outFile_ = make_unique<ofstream>(); 290 // 打开待解码二进制文件路径。 291 inputFile_->open(inputFilePath.data(), ios::in | ios::binary); 292 // 配置解码文件输出路径。 293 outFile_->open(outputFilePath.data(), ios::out | ios::binary); 294 // 开始解码。 295 ret = OH_AudioCodec_Start(audioDec_); 296 if (ret != AV_ERR_OK) { 297 // 异常处理。 298 } 299 ``` 300 3018. （可选）调用OH_AVCencInfo_SetAVBuffer()，设置cencInfo。 302 303 若当前播放的节目是DRM加密节目，且由上层应用做[媒体解封装](audio-video-demuxer.md#媒体数据解析)，则须调用OH_AVCencInfo_SetAVBuffer()将cencInfo设置给AVBuffer，以实现AVBuffer中媒体数据的解密。 304 305 添加头文件： 306 307 ```c++ 308 #include <multimedia/player_framework/native_cencinfo.h> 309 ``` 310 在 CMake 脚本中链接动态库： 311 312 ``` cmake 313 target_link_libraries(sample PUBLIC libnative_media_avcencinfo.so) 314 ``` 315 316 使用示例： 317 ```c++ 318 auto buffer = signal_->inBufferQueue_.front(); 319 uint32_t keyIdLen = DRM_KEY_ID_SIZE; 320 uint8_t keyId[] = { 321 0xd4, 0xb2, 0x01, 0xe4, 0x61, 0xc8, 0x98, 0x96, 322 0xcf, 0x05, 0x22, 0x39, 0x8d, 0x09, 0xe6, 0x28}; 323 uint32_t ivLen = DRM_KEY_IV_SIZE; 324 uint8_t iv[] = { 325 0xbf, 0x77, 0xed, 0x51, 0x81, 0xde, 0x36, 0x3e, 326 0x52, 0xf7, 0x20, 0x4f, 0x72, 0x14, 0xa3, 0x95}; 327 uint32_t encryptedBlockCount = 0; 328 uint32_t skippedBlockCount = 0; 329 uint32_t firstEncryptedOffset = 0; 330 uint32_t subsampleCount = 1; 331 DrmSubsample subsamples[1] = { {0x10, 0x16} }; 332 // 创建CencInfo实例。 333 OH_AVCencInfo *cencInfo = OH_AVCencInfo_Create(); 334 if (cencInfo == nullptr) { 335 // 异常处理。 336 } 337 // 设置解密算法。 338 OH_AVErrCode errNo = OH_AVCencInfo_SetAlgorithm(cencInfo, DRM_ALG_CENC_AES_CTR); 339 if (errNo != AV_ERR_OK) { 340 // 异常处理。 341 } 342 // 设置KeyId和Iv。 343 errNo = OH_AVCencInfo_SetKeyIdAndIv(cencInfo, keyId, keyIdLen, iv, ivLen); 344 if (errNo != AV_ERR_OK) { 345 // 异常处理。 346 } 347 // 设置Sample信息。 348 errNo = OH_AVCencInfo_SetSubsampleInfo(cencInfo, encryptedBlockCount, skippedBlockCount, firstEncryptedOffset, 349 subsampleCount, subsamples); 350 if (errNo != AV_ERR_OK) { 351 // 异常处理。 352 } 353 // 设置模式：KeyId、Iv和SubSamples已被设置。 354 errNo = OH_AVCencInfo_SetMode(cencInfo, DRM_CENC_INFO_KEY_IV_SUBSAMPLES_SET); 355 if (errNo != AV_ERR_OK) { 356 // 异常处理。 357 } 358 // 将CencInfo设置到AVBuffer中。 359 errNo = OH_AVCencInfo_SetAVBuffer(cencInfo, buffer); 360 if (errNo != AV_ERR_OK) { 361 // 异常处理。 362 } 363 // 销毁CencInfo实例。 364 errNo = OH_AVCencInfo_Destroy(cencInfo); 365 if (errNo != AV_ERR_OK) { 366 // 异常处理。 367 } 368 ``` 369 3709. 调用OH_AudioCodec_PushInputBuffer()，写入待解码的数据。 371 372 需开发者填充完整的输入数据后调用。 373 374 如果是结束，需要对flags标识成AVCODEC_BUFFER_FLAGS_EOS。 375 376 ```c++ 377 uint32_t index = signal_->inQueue_.front(); 378 auto buffer = signal_->inBufferQueue_.front(); 379 int64_t size; 380 int64_t pts; 381 // size是待解码数据的每帧帧长度。pts是每帧的时间戳，用于指示音频应该何时被播放。 382 // size和pts的获取来源：音视频资源文件或者待解码的数据流。 383 // 若是解码音视频资源文件，则需从解封装OH_AVDemuxer_ReadSampleBuffer的buffer中获取。 384 // 若是解码数据流，则需要从数据流的提供者获取。 385 // 此处为了介绍解码功能以测试文件中保存的size和pts为示例。 386 inputFile_.read(reinterpret_cast<char *>(&size), sizeof(size)); 387 inputFile_.read(reinterpret_cast<char *>(&pts), sizeof(pts)); 388 inputFile_.read((char *)OH_AVBuffer_GetAddr(buffer), size); 389 OH_AVCodecBufferAttr attr = {0}; 390 if (inputFile_->eof()) { 391 attr.size = 0; 392 attr.flags = AVCODEC_BUFFER_FLAGS_EOS; 393 } else { 394 attr.size = size; 395 attr.flags = AVCODEC_BUFFER_FLAGS_NONE; 396 } 397 attr.pts = pts; 398 OH_AVBuffer_SetBufferAttr(buffer, &attr); 399 int32_t ret = OH_AudioCodec_PushInputBuffer(audioDec_, index); 400 if (ret != AV_ERR_OK) { 401 // 异常处理。 402 } 403 ``` 404 40510. 调用OH_AudioCodec_FreeOutputBuffer()，释放解码后的数据。 406 407 在取走解码PCM码流后，就应及时调用OH_AudioCodec_FreeOutputBuffer()进行释放。 408 409 <!--RP3--> 410 ```c++ 411 uint32_t index = signal_->outQueue_.front(); 412 OH_AVBuffer *data = signal_->outBufferQueue_.front(); 413 // 获取buffer attributes。 414 OH_AVCodecBufferAttr attr = {0}; 415 ret = OH_AVBuffer_GetBufferAttr(data, &attr); 416 if (ret != AV_ERR_OK) { 417 // 异常处理。 418 } 419 // 将解码完成数据data写入到对应输出文件中。 420 pcmOutputFile_.write(reinterpret_cast<char *>(OH_AVBuffer_GetAddr(data)), attr.size); 421 ret = OH_AudioCodec_FreeOutputBuffer(audioDec_, index); 422 if (ret != AV_ERR_OK) { 423 // 异常处理。 424 } 425 if (attr.flags == AVCODEC_BUFFER_FLAGS_EOS) { 426 // 结束。 427 } 428 ``` 429 <!--RP3End--> 430 43111. （可选）调用OH_AudioCodec_Flush()刷新解码器。 432 433 调用OH_AudioCodec_Flush()后，解码器仍处于运行态，但会将当前队列清空，将已解码的数据释放。 434 435 此时需要调用OH_AudioCodec_Start()重新开始解码。 436 437 使用情况： 438 439 * 在文件EOS之后，需要调用刷新。 440 * 在执行过程中遇到可继续执行的错误时（即OH_AudioCodec_IsValid 为true）调用。 441 442 ```c++ 443 // 刷新解码器 audioDec_。 444 ret = OH_AudioCodec_Flush(audioDec_); 445 if (ret != AV_ERR_OK) { 446 // 异常处理。 447 } 448 // 重新开始解码。 449 ret = OH_AudioCodec_Start(audioDec_); 450 if (ret != AV_ERR_OK) { 451 // 异常处理。 452 } 453 ``` 454 45512. （可选）调用OH_AudioCodec_Reset()重置解码器。 456 457 调用OH_AudioCodec_Reset()后，解码器回到初始化的状态，需要调用OH_AudioCodec_Configure()重新配置，然后调用OH_AudioCodec_Start()重新开始解码。 458 459 ```c++ 460 // 重置解码器 audioDec_。 461 ret = OH_AudioCodec_Reset(audioDec_); 462 if (ret != AV_ERR_OK) { 463 // 异常处理。 464 } 465 // 重新配置解码器参数。 466 ret = OH_AudioCodec_Configure(audioDec_, format); 467 if (ret != AV_ERR_OK) { 468 // 异常处理。 469 } 470 ``` 471 47213. 调用OH_AudioCodec_Stop()停止解码器。 473 474 停止后，可以通过调用OH_AudioCodec_Start()重新进入已启动状态（started），但需要注意的是，如果编解码器之前已输入数据，则需要重新输入编解码器数据。 475 476 ```c++ 477 // 终止解码器 audioDec_。 478 ret = OH_AudioCodec_Stop(audioDec_); 479 if (ret != AV_ERR_OK) { 480 // 异常处理。 481 } 482 ``` 483 48414. 调用OH_AudioCodec_Destroy()销毁解码器实例，释放资源。 485 486 > **说明：** 487 >不要重复销毁解码器 488 489 ```c++ 490 // 调用OH_AudioCodec_Destroy, 注销解码器。 491 ret = OH_AudioCodec_Destroy(audioDec_); 492 if (ret != AV_ERR_OK) { 493 // 异常处理。 494 } else { 495 audioDec_ = NULL; // 不可重复destroy。 496 } 497 ``` 498 499## 相关实例 500 501针对音频解码，有以下相关实例可供参考： 502 503- [音频解码](https://gitee.com/openharmony/multimedia_av_codec/blob/master/test/nativedemo/audio_demo/avcodec_audio_avbuffer_decoder_demo.cpp)
