音频解码同步模式
========

从API version 20开始，支持音频解码同步模式。

开发者可以调用本模块的Native API接口，完成同步模式的音频解码，即将媒体数据解码为PCM码流。

具体实现可参考[示例工程](https://gitcode.com/openharmony/applications_app_samples/blob/master/code/BasicFeature/Media/AVCodec)。

支持的解码能力请参考[AVCodec支持的格式](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/avcodec-support-formats#音频解码)。

**适用场景**

通常推荐使用异步模式，详细内容请参考[音频解码](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/audio-decoding)。若需要主动请求buffer去送帧，则可以使用同步模式。

将音视频文件解码为PCM码流，通常需要以下步骤：[媒体数据解析](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/audio-video-demuxer) -> 音频解码。

本指南描述音频解码过程：输入音频帧和解码出PCM码流。

#### 开发指导

详细的API说明请参考[AudioCodec](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-native-avcodec-audiocodec-h)。

参考以下示例代码，完成音频解码的全流程，包括：创建解码器、设置解码参数（采样率/码率/声道数等）、开始/刷新/重置/销毁资源。

在应用开发过程中，开发者应按顺序调用方法，执行操作，否则系统可能会抛出异常或生成其他未定义的行为。具体顺序可参考下列开发步骤及对应说明。

音频编解码同步模式调用关系图如下所示：

*   虚线表示可选。
    
*   实线表示必选。
    

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/dc/v3/cNh1YW64T3uelweoR_fq1A/zh-cn_image_0000002625188169.png?HW-CC-KV=V1&HW-CC-Date=20260612T073508Z&HW-CC-Expire=86400&HW-CC-Sign=6835F3A635FA492666E217129E42887E1194AC2249F46AC408F5CF2091DFC130)

#### \[h2\]在 CMake 脚本中链接动态库

target\_link\_libraries(sample PUBLIC libnative\_media\_codecbase.so)
target\_link\_libraries(sample PUBLIC libnative\_media\_core.so)
target\_link\_libraries(sample PUBLIC libnative\_media\_acodec.so)

![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/a5/v3/0e99x4aMTxi2RoK134s85g/note_3.0-zh-cn.png?HW-CC-KV=V1&HW-CC-Date=20260612T073508Z&HW-CC-Expire=86400&HW-CC-Sign=03F2DB94EBFBF518E5B17AEEF52FDB36DBA41E3B450F1D04A1A9900A9E5ADFF2)

上述'sample'字样仅为示例，开发者需根据实际工程目录进行自定义。

#### \[h2\]开发步骤

1.  添加头文件和命名空间。
    
    #include <multimedia/player\_framework/native\_avcodec\_audiocodec.h>
    #include <multimedia/native\_audio\_channel\_layout.h>
    #include <multimedia/player\_framework/native\_avcapability.h>
    #include <multimedia/player\_framework/native\_avcodec\_base.h>
    #include <multimedia/player\_framework/native\_avformat.h>
    #include <multimedia/player\_framework/native\_avbuffer.h>
    
    // c++标准库命名空间。
    using namespace std;
    
2.  创建解码器实例对象，OH\_AVCodec \*为解码器实例指针。
    
    应用可以通过媒体类型或编解码器名称创建解码器。
    
    方法一：通过Mimetype创建解码器。
    
    // 通过Mimetype创建解码器，这里示例创建的是AAC编码格式，第二个入参设置false表示当前是解码。
    OH\_AVCodec \*audioDec\_ = OH\_AudioCodec\_CreateByMime(OH\_AVCODEC\_MIMETYPE\_AUDIO\_AAC, false);
    
    方法二：通过codec name创建解码器。
    
    // 通过codec name创建解码器。
    OH\_AVCapability \*capability = OH\_AVCodec\_GetCapability(OH\_AVCODEC\_MIMETYPE\_AUDIO\_AAC, false);
    const char \*name = OH\_AVCapability\_GetName(capability);
    OH\_AVCodec \*audioDec\_ = OH\_AudioCodec\_CreateByName(name);
    
3.  （可选）OH\_AudioCodec\_SetDecryptionConfig设置解密配置。
    
    当获取到DRM信息（参考[音视频解封装](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/audio-video-demuxer)开发步骤第4步）后，通过此接口进行解密配置。
    
    DRM相关接口详见[DRM](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-drm)。
    
    此接口需在Prepare前调用。
    
    添加头文件：
    
    #include <multimedia/drm\_framework/native\_mediakeysystem.h>
    #include <multimedia/drm\_framework/native\_mediakeysession.h>
    #include <multimedia/drm\_framework/native\_drm\_err.h>
    #include <multimedia/drm\_framework/native\_drm\_common.h>
    
    在CMake脚本中链接动态库：
    
    target\_link\_libraries(sample PUBLIC libnative\_drm.so)
    
    使用示例：
    
    // 根据DRM信息创建指定的DRM系统, 以创建"com.wiseplay.drm"为例。
    MediaKeySystem \*system = nullptr;
    int32\_t ret = OH\_MediaKeySystem\_Create("com.wiseplay.drm", &system);
    if (system == nullptr) {
        printf("create media key system failed");
        return;
    }
    
    // 创建解密会话。
    MediaKeySession \*session = nullptr;
    DRM\_ContentProtectionLevel contentProtectionLevel = CONTENT\_PROTECTION\_LEVEL\_SW\_CRYPTO;
    ret = OH\_MediaKeySystem\_CreateMediaKeySession(system, &contentProtectionLevel, &session);
    if (ret != DRM\_ERR\_OK) {
        // 如果创建失败，请查看DRM接口文档及日志信息。
        printf("create media key session failed.");
        return;
    }
    if (session == nullptr) {
        printf("media key session is nullptr.");
        return;
    }
    // 获取许可证请求、设置许可证响应等。
    // 设置解密信息。将解密会话设置到解码器中。当前音频解密不支持安全解码器，设置为false。
    bool secureAudio = false;
    ret = OH\_AudioCodec\_SetDecryptionConfig(audioDec\_, session, secureAudio);
    
4.  调用OH\_AudioCodec\_Configure()配置解码器。
    
    配置选项key值说明：
    
    ![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/7d/v3/JP9FPdOGTzKMIFfkhhVrog/zh-cn_image_0000002625108313.png?HW-CC-KV=V1&HW-CC-Date=20260612T073508Z&HW-CC-Expire=86400&HW-CC-Sign=EE0EB8014F087A7D26D288211884CBAC04DC58A0CFBD582FF16B7DBA23A48136)
    
    各音频解码类型参数范围说明：
    
    ![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/24/v3/dz11OJ6JSjOtcUaudh_EDw/zh-cn_image_0000002594668796.png?HW-CC-KV=V1&HW-CC-Date=20260612T073508Z&HW-CC-Expire=86400&HW-CC-Sign=D268AEBFA71B8B095093C01FB972C609EC3474343344C442D50688D51D32D94E)
    
    从API version 20开始，支持通过[OH\_AVCapability\_GetAudioSupportedSampleRateRanges](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-native-avcapability-h#oh_avcapability_getaudiosupportedsamplerateranges)接口进行采样率范围能力查询，以下几种音频解码类型支持对范围内的任意采样率进行解码：
    
    | 音频解码类型 | 采样率(Hz) |
    | :-- | :-- |
    | Flac | 8000 ~ 384000 |
    | Vorbis | 8000 ~ 192000 |
    | APE | 1 ~ 2147483647 |
    
    // 以下配置的值仅为示例值，开发者需根据实际解码能力动态设置。
    // 配置音频采样率（必须）。
    constexpr uint32\_t DEFAULT\_SAMPLERATE = 44100;
    // 配置音频声道数（必须）。
    constexpr uint32\_t DEFAULT\_CHANNEL\_COUNT = 2;
    // 配置是否为ADTS解码（aac解码时可选）。
    constexpr uint32\_t DEFAULT\_AAC\_TYPE = 1;
    OH\_AVFormat \*format = OH\_AVFormat\_Create();
    // 写入format。
    OH\_AVFormat\_SetIntValue(format, OH\_MD\_KEY\_AUD\_SAMPLE\_RATE, DEFAULT\_SAMPLERATE);
    OH\_AVFormat\_SetIntValue(format, OH\_MD\_KEY\_AUD\_CHANNEL\_COUNT, DEFAULT\_CHANNEL\_COUNT);
    OH\_AVFormat\_SetIntValue(format, OH\_MD\_KEY\_AAC\_IS\_ADTS, DEFAULT\_AAC\_TYPE);
    OH\_AVFormat\_SetIntValue(format, OH\_MD\_KEY\_ENABLE\_SYNC\_MODE, 1); // 同步模式配置。
    // 配置解码器。
    OH\_AVErrCode ret = OH\_AudioCodec\_Configure(audioDec\_, format);
    if (ret != AV\_ERR\_OK) {
        // 异常处理。
    }
    
5.  调用OH\_AudioCodec\_Prepare()，解码器就绪。
    
    OH\_AVErrCode ret = OH\_AudioCodec\_Prepare(audioDec\_);
    if (ret != AV\_ERR\_OK) {
        // 异常处理。
    }
    
6.  调用OH\_AudioCodec\_Start()启动解码器，进入运行态。
    
    添加头文件：
    
    #include <fstream>
    
    使用示例：
    
    ifstream inputFile\_;
    ofstream outFile\_;
    
    // 根据实际使用情况填写输入文件路径。为便于演示音频解码功能，此处输入文件包含音频帧及相关信息，而非可直接播放的音频文件。
    const char\* inputFilePath = "/";
    // 根据实际使用情况填写输出文件路径。本指南仅演示音频解码功能，解码后的PCM数据保存到文件中，未作进一步处理。
    const char\* outputFilePath = "/";
    // 打开待解码二进制文件路径。
    inputFile\_.open(inputFilePath, ios::in | ios::binary);
    // 配置解码文件输出路径。
    outFile\_.open(outputFilePath, ios::out | ios::binary);
    // 开始解码。
    OH\_AVErrCode ret = OH\_AudioCodec\_Start(audioDec\_);
    if (ret != AV\_ERR\_OK) {
        // 异常处理。
    }
    
7.  （可选）调用OH\_AVCencInfo\_SetAVBuffer()，设置cencInfo。
    
    如果当前播放的节目是DRM加密节目，并且由上层应用进行[媒体数据解析](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/audio-video-demuxer)，则需要调用OH\_AVCencInfo\_SetAVBuffer()将cencInfo设置给AVBuffer，以实现媒体数据的解密。
    
    添加头文件：
    
    #include <multimedia/player\_framework/native\_cencinfo.h>
    
    在CMake脚本中链接动态库：
    
    target\_link\_libraries(sample PUBLIC libnative\_media\_avcencinfo.so)
    
    使用示例：
    
    auto buffer = signal\_->inBufferQueue\_.front();
    uint32\_t keyIdLen = DRM\_KEY\_ID\_SIZE;
    uint8\_t keyId\[\] = {
        0xd4, 0xb2, 0x01, 0xe4, 0x61, 0xc8, 0x98, 0x96,
        0xcf, 0x05, 0x22, 0x39, 0x8d, 0x09, 0xe6, 0x28};
    uint32\_t ivLen = DRM\_KEY\_IV\_SIZE;
    uint8\_t iv\[\] = {
        0xbf, 0x77, 0xed, 0x51, 0x81, 0xde, 0x36, 0x3e,
        0x52, 0xf7, 0x20, 0x4f, 0x72, 0x14, 0xa3, 0x95};
    uint32\_t encryptedBlockCount = 0;
    uint32\_t skippedBlockCount = 0;
    uint32\_t firstEncryptedOffset = 0;
    uint32\_t subsampleCount = 1;
    DrmSubsample subsamples\[1\] = { {0x10, 0x16} };
    // 创建CencInfo实例。
    OH\_AVCencInfo \*cencInfo = OH\_AVCencInfo\_Create();
    if (cencInfo == nullptr) {
        // 异常处理。
    }
    // 设置解密算法。
    OH\_AVErrCode errNo = OH\_AVCencInfo\_SetAlgorithm(cencInfo, DRM\_ALG\_CENC\_AES\_CTR);
    if (errNo != AV\_ERR\_OK) {
        // 异常处理。
    }
    // 设置KeyId和Iv。
    errNo = OH\_AVCencInfo\_SetKeyIdAndIv(cencInfo, keyId, keyIdLen, iv, ivLen);
    if (errNo != AV\_ERR\_OK) {
        // 异常处理。
    }
    // 设置Sample信息。
    errNo = OH\_AVCencInfo\_SetSubsampleInfo(cencInfo, encryptedBlockCount, skippedBlockCount, firstEncryptedOffset,
        subsampleCount, subsamples);
    if (errNo != AV\_ERR\_OK) {
        // 异常处理。
    }
    // 设置模式：KeyId、Iv和SubSamples已被设置。
    errNo = OH\_AVCencInfo\_SetMode(cencInfo, DRM\_CENC\_INFO\_KEY\_IV\_SUBSAMPLES\_SET);
    if (errNo != AV\_ERR\_OK) {
        // 异常处理。
    }
    // 将CencInfo设置到AVBuffer中。
    errNo = OH\_AVCencInfo\_SetAVBuffer(cencInfo, buffer);
    if (errNo != AV\_ERR\_OK) {
        // 异常处理。
    }
    // 销毁CencInfo实例。
    errNo = OH\_AVCencInfo\_Destroy(cencInfo);
    if (errNo != AV\_ERR\_OK) {
        // 异常处理。
    }
    
8.  同步模式调用，写入待解码的数据，获取解码的输出。
    
    读取数据：
    
    // size是待解码数据的每帧帧长度。pts是每帧的时间戳，用于指示音频应该何时被播放。
    // size和pts的获取来源：音视频资源文件或者待解码的数据流。
    // 如果是解码音视频资源文件，则需要从解封装OH\_AVDemuxer\_ReadSampleBuffer的buffer中获取。
    // 如果是解码数据流，则需要从数据流的提供者获取。
    // 此处为了介绍解码功能以测试文件中保存的size和pts为示例。
    bool DecoderFillInputBuffer(OH\_AVBuffer \*buffer, ifstream &inputFile)
    {
        OH\_AVCodecBufferAttr attr;
        memset(&attr, 0, sizeof(attr));
        attr.flags = AVCODEC\_BUFFER\_FLAGS\_EOS;
        bool finished = true;
        do {
            int64\_t size;
            inputFile.read(reinterpret\_cast<char \*>(&size), sizeof(size));
            if (inputFile.eof() || inputFile.gcount() != sizeof(size)) {
                break;
            }
            inputFile.read(reinterpret\_cast<char \*>(&attr.pts), sizeof(attr.pts));
            if (inputFile.gcount() != sizeof(attr.pts)) {
                break;
            }
            attr.size = static\_cast<int32\_t>(size);
            if (attr.size > 0) {
                inputFile.read((char \*)OH\_AVBuffer\_GetAddr(buffer), attr.size);
                attr.flags = AVCODEC\_BUFFER\_FLAGS\_NONE;
                finished = false;
            }
        } while (0);
        OH\_AVBuffer\_SetBufferAttr(buffer, &attr);
        return finished;
    }
    bool InputOneFrame(OH\_AVCodec \*codec, ifstream &inputFile)
    {
        uint32\_t index = 0;
        bool finished = true;
        OH\_AVErrCode ret = OH\_AudioCodec\_QueryInputBuffer(codec, &index, 20000); // 20000us
        if (ret == AV\_ERR\_TRY\_AGAIN\_LATER) {
            // 超时，异常处理，设置的超时时间过短或输入输出buffer没有消耗/释放导致解码阻塞。
            return finished;
        }
        if (ret != AV\_ERR\_OK) {
            // 异常处理。
            return finished;
        }
        OH\_AVBuffer \*inputBuf = OH\_AudioCodec\_GetInputBuffer(codec, index);
        if (inputBuf == nullptr) {
            // 异常处理。
            return finished;
        }
        finished = DecoderFillInputBuffer(inputBuf, inputFile);
        OH\_AudioCodec\_PushInputBuffer(codec, index);
        return finished;
    }
    
    需开发者填充完整的输入数据后调用。
    
    结束时需要将flags标识为AVCODEC\_BUFFER\_FLAGS\_EOS。
    
    bool inputFinished = false;
    for (;;) {
        if (!inputFinished) {
            inputFinished = InputOneFrame(audioDec\_, inputFile\_);
        }
        uint32\_t index;
        OH\_AVErrCode ret = OH\_AudioCodec\_QueryOutputBuffer(audioDec\_, &index, 20000); // 20000us
        if (ret == AV\_ERR\_TRY\_AGAIN\_LATER) {
            // 超时，异常处理，设置的超时时间过短或输入输出buffer没有消耗/释放导致解码阻塞。
            continue;
        } else if (ret == AV\_ERR\_STREAM\_CHANGED) {
            // 解码输出参数变化后的回调处理，应用根据实际情况进行处理。
            OH\_AVFormat \*outFormat = OH\_AudioCodec\_GetOutputDescription(audioDec\_);
            int32\_t sampleRate;
            int32\_t channelCount;
            int32\_t sampleFormat;
            if (OH\_AVFormat\_GetIntValue(outFormat, OH\_MD\_KEY\_AUD\_SAMPLE\_RATE, &sampleRate)) {
                // 判断采样率是否发生变化，进行对应处理。
            }
            if (OH\_AVFormat\_GetIntValue(outFormat, OH\_MD\_KEY\_AUD\_CHANNEL\_COUNT, &channelCount)) {
                // 判断声道数是否发生变化，进行对应处理。
            }
            if (OH\_AVFormat\_GetIntValue(outFormat, OH\_MD\_KEY\_AUDIO\_SAMPLE\_FORMAT, &sampleFormat)) {
                // 判断音频采样格式是否发生变化，进行对应处理。
            }
            continue;
        }
        if (ret != AV\_ERR\_OK) {
            // 异常处理。
            break;
        }
        OH\_AVBuffer \*outputBuf = OH\_AudioCodec\_GetOutputBuffer(audioDec\_, index);
        if (outputBuf == nullptr) {
            // 异常处理。
            break;
        }
        OH\_AVCodecBufferAttr attr;
        if (OH\_AVBuffer\_GetBufferAttr(outputBuf, &attr) != AV\_ERR\_OK) {
            // 异常处理。
            break;
        }
        if (attr.flags & AVCODEC\_BUFFER\_FLAGS\_EOS) {
            OH\_AudioCodec\_FreeOutputBuffer(audioDec\_, index);
            // 解码输出结束。
            break;
        }
        outFile\_.write(reinterpret\_cast<char \*>(OH\_AVBuffer\_GetAddr(outputBuf)), attr.size);
        OH\_AudioCodec\_FreeOutputBuffer(audioDec\_, index);
    }
    
9.  （可选）调用OH\_AudioCodec\_Flush()刷新解码器。
    
    调用OH\_AudioCodec\_Flush()后，解码器仍处于运行态，但会清空当前队列，释放已解码的数据。刷新前获取到的输入/输出buffer都无法继续使用。
    
    此时需要调用OH\_AudioCodec\_Start()重新开始解码。
    
    使用情况：
    
    *   之前输入的数据不再使用的场景，例如在解封装seek之后，调用刷新。
    *   在解码输出buffer属性为AVCODEC\_BUFFER\_FLAGS\_EOS后，若想重新使用相同配置进行解码时，需要调用刷新。
    *   在执行过程中遇到可继续执行的错误时（即OH\_AudioCodec\_IsValid()为true）可以调用刷新，然后调用OH\_AudioCodec\_Start()重新开始解码。
    
    // 刷新解码器audioDec\_。
    OH\_AVErrCode ret = OH\_AudioCodec\_Flush(audioDec\_);
    if (ret != AV\_ERR\_OK) {
        // 异常处理。
    }
    // 重新开始解码。
    ret = OH\_AudioCodec\_Start(audioDec\_);
    if (ret != AV\_ERR\_OK) {
        // 异常处理。
    }
    
10.  （可选）调用OH\_AudioCodec\_Reset()重置解码器。
     
     调用OH\_AudioCodec\_Reset()后，解码器回到初始化状态，重置前获取到的输入/输出buffer都无法继续使用，需先调用OH\_AudioCodec\_Configure()重新配置，再调用OH\_AudioCodec\_Start()重新开始解码。启动后重新获取输入/输出buffer。
     
     // 重置解码器audioDec\_。
     OH\_AVErrCode ret = OH\_AudioCodec\_Reset(audioDec\_);
     if (ret != AV\_ERR\_OK) {
         // 异常处理。
     }
     // 重新配置解码器参数。
     ret = OH\_AudioCodec\_Configure(audioDec\_, format);
     if (ret != AV\_ERR\_OK) {
         // 异常处理。
     }
     
11.  调用OH\_AudioCodec\_Stop()停止解码器。
     
     停止后，可以通过调用OH\_AudioCodec\_Start()重新进入已启动状态（started）。停止前获取到的输入/输出buffer都无法继续使用，需要在启动后重新获取输入/输出buffer。
     
     // 终止解码器audioDec\_。
     OH\_AVErrCode ret = OH\_AudioCodec\_Stop(audioDec\_);
     if (ret != AV\_ERR\_OK) {
         // 异常处理。
     }
     
12.  调用OH\_AudioCodec\_Destroy()销毁解码器实例，释放资源。
     
     ![](https://contentcenter-vali-drcn.dbankcdn.cn/pvt_2/DeveloperAlliance_scene_100_1/1c/v3/Vh7KxUlAQbCmmA83u34iPw/note_3.0-zh-cn.png?HW-CC-KV=V1&HW-CC-Date=20260612T073508Z&HW-CC-Expire=86400&HW-CC-Sign=592CF701BCD80D26150EE6086547E30E71703560282EEDACAEE4AE4F2E87D53A)
     
     禁止重复销毁解码器。
     
     // 调用OH\_AudioCodec\_Destroy, 销毁解码器。
     OH\_AVErrCode ret = OH\_AudioCodec\_Destroy(audioDec\_);
     if (ret != AV\_ERR\_OK) {
         // 异常处理。
     } else {
         audioDec\_ = NULL; // 不可重复destroy。
     }