1# 音频编码
2
3开发者可以调用本模块的Native API接口,完成音频编码,即将音频PCM编码压缩成不同的格式。
4
5接口不限制PCM数据的来源,开发者可以调用麦克风录制获取、也可以导入编辑后的PCM数据,通过音频编码,输出对应格式的码流,最后封装为目标格式文件。
6
7当前支持的编码能力请参考[AVCodec支持的格式](avcodec-support-formats.md#音频编码)。
8
9**适用场景**
10
11- 音频录制
12
13  通过录制传入PCM,然后编码出对应格式的码流,最后封装成想要的格式。
14- 音频编辑
15
16  编辑PCM后导出音频文件的场景,需要编码成对应音频格式后再封装成文件。
17> **说明:**
18>
19> AAC编码器默认采用的VBR可变码率模式,与配置的预期参数可能存在偏差。
20
21## 开发指导
22
23详细的API说明请参考[API文档](../../reference/apis-avcodec-kit/_audio_codec.md)。
24
25参考以下示例代码,完成音频编码的全流程,包括:创建编码器、设置编码参数(采样率/码率/声道数等)、开始、刷新、重置、销毁资源。
26
27在应用开发过程中,开发者应按一定顺序调用方法,执行对应操作,否则系统可能会抛出异常或生成其他未定义的行为。具体顺序可参考下列开发步骤及对应说明。
28
29如下为音频编码调用关系图:
30
31- 虚线表示可选。
32
33- 实线表示必选。
34
35![Invoking relationship of audio encode stream](figures/audio-codec.png)
36
37### 在 CMake 脚本中链接动态库
38
39```cmake
40target_link_libraries(sample PUBLIC libnative_media_codecbase.so)
41target_link_libraries(sample PUBLIC libnative_media_core.so)
42target_link_libraries(sample PUBLIC libnative_media_acodec.so)
43```
44
45### 开发步骤
46
471. 添加头文件。
48
49    ```cpp
50    #include <multimedia/player_framework/native_avcodec_audiocodec.h>
51    #include <multimedia/native_audio_channel_layout.h>
52    #include <multimedia/player_framework/native_avcapability.h>
53    #include <multimedia/player_framework/native_avcodec_base.h>
54    #include <multimedia/player_framework/native_avformat.h>
55    #include <multimedia/player_framework/native_avbuffer.h>
56    ```
57
582. 创建编码器实例对象,OH_AVCodec *为编码器实例指针。
59
60   应用可以通过名称或媒体类型创建编码器。
61
62    ```cpp
63    // c++标准库命名空间
64    using namespace std;
65    // 通过 codecname 创建编码器
66    OH_AVCapability *capability = OH_AVCodec_GetCapability(OH_AVCODEC_MIMETYPE_AUDIO_AAC, true);
67    const char *name = OH_AVCapability_GetName(capability);
68    OH_AVCodec *audioEnc_ = OH_AudioCodec_CreateByName(name);
69    ```
70
71    ```cpp
72    // 设置判定是否为编码;设置true表示当前是编码。
73    bool isEncoder = true;
74    // 通过媒体类型创建编码器
75    OH_AVCodec *audioEnc_ = OH_AudioCodec_CreateByMime(OH_AVCODEC_MIMETYPE_AUDIO_AAC, isEncoder);
76    ```
77
78    ```cpp
79    // 初始化队列
80    class AEncBufferSignal {
81    public:
82        std::mutex inMutex_;
83        std::mutex outMutex_;
84        std::mutex startMutex_;
85        std::condition_variable inCond_;
86        std::condition_variable outCond_;
87        std::condition_variable startCond_;
88        std::queue<uint32_t> inQueue_;
89        std::queue<uint32_t> outQueue_;
90        std::queue<OH_AVBuffer *> inBufferQueue_;
91        std::queue<OH_AVBuffer *> outBufferQueue_;
92    };
93    AEncBufferSignal *signal_;
94    ```
95
963. 调用OH_AudioCodec_RegisterCallback()注册回调函数。
97   注册回调函数指针集合OH_AVCodecCallback,包括:
98
99   - OH_AVCodecOnError:编码器运行错误。
100   - OH_AVCodecOnStreamChanged:码流信息变化,如声道变化等。
101   - OH_AVCodecOnNeedInputBuffer:运行过程中需要新的输入数据,即编码器已准备好,可以输入PCM数据。
102   - OH_AVCodecOnNewOutputBuffer:运行过程中产生了新的输出数据,即编码完成。
103
104   开发者可以通过处理该回调报告的信息,确保编码器正常运转。
105
106    ```cpp
107    // OH_AVCodecOnError回调函数的实现
108    static void OnError(OH_AVCodec *codec, int32_t errorCode, void *userData)
109    {
110        (void)codec;
111        (void)errorCode;
112        (void)userData;
113    }
114    // OH_AVCodecOnStreamChanged回调函数的实现
115    static void OnOutputFormatChanged(OH_AVCodec *codec, OH_AVFormat *format, void *userData)
116    {
117        (void)codec;
118        (void)format;
119        (void)userData;
120    }
121    // OH_AVCodecOnNeedInputBuffer回调函数的实现
122    static void OnInputBufferAvailable(OH_AVCodec *codec, uint32_t index, OH_AVBuffer *data, void *userData)
123    {
124        (void)codec;
125        // 编码输入码流送入InputBuffer队列
126        AEncBufferSignal *signal = static_cast<AEncBufferSignal *>(userData);
127        unique_lock<mutex> lock(signal->inMutex_);
128        signal->inQueue_.push(index);
129        signal->inBufferQueue_.push(data);
130        signal->inCond_.notify_all();
131    }
132    // OH_AVCodecOnNewOutputBuffer回调函数的实现
133    static void OnOutputBufferAvailable(OH_AVCodec *codec, uint32_t index, OH_AVBuffer *data, void *userData)
134    {
135        (void)codec;
136        // 将对应输出buffer的index送入OutputQueue_队列
137        // 将对应编码完成的数据data送入outBuffer队列
138        AEncBufferSignal *signal = static_cast<AEncBufferSignal *>(userData);
139        unique_lock<mutex> lock(signal->outMutex_);
140        signal->outQueue_.push(index);
141        signal->outBufferQueue_.push(data);
142    }
143    signal_ = new AEncBufferSignal();
144    OH_AVCodecCallback cb_ = {&OnError, &OnOutputFormatChanged, &OnInputBufferAvailable, &OnOutputBufferAvailable};
145    // 配置异步回调
146    int32_t ret = OH_AudioCodec_RegisterCallback(audioEnc_, cb_, signal_);
147    if (ret != AV_ERR_OK) {
148        // 异常处理
149    }
150    ```
151
1524. 调用OH_AudioCodec_Configure设置编码器。
153
154   设置必选项:采样率,码率,以及声道数,声道类型、位深。
155
156   可选项:最大输入长度。
157
158   flac编码: 需要额外标识兼容性级别(Compliance Level)和采样精度。
159
160   各音频编码类型参数范围说明:
161   | 音频编码类型 | 采样率(Hz)                                                                       |       声道数       |
162   | ----------- | ------------------------------------------------------------------------------- | :----------------: |
163   | AAC         | 8000、11025、12000、16000、22050、24000、32000、44100、48000、64000、88200、96000 | 1、2、3、4、5、6、8 |
164   | Flac        | 8000、11025、12000、16000、22050、24000、32000、44100、48000、64000、88200、96000 |        1~8         |
165   | MP3         | 8000、11025、12000、16000、22050、24000、32000、44100、48000                     |        1~2         |
166   | G711mu      | 8000                                                                            |         1          |
167   <!--RP3--><!--RP3End-->
168
169   对于44100Hz采样率、2声道立体声、SAMPLE_S16LE采样格式的PCM音频,以32000bps的码率进行AAC编码的调用流程如下:
170    <!--RP4-->
171    ```cpp
172    int32_t ret;
173    // 配置音频采样率(必须)
174    constexpr uint32_t DEFAULT_SAMPLERATE = 44100;
175    // 配置音频码率(必须)
176    constexpr uint64_t DEFAULT_BITRATE = 32000;
177    // 配置音频声道数(必须)
178    constexpr uint32_t DEFAULT_CHANNEL_COUNT = 2;
179    // 配置音频声道类型(必须)
180    constexpr OH_AudioChannelLayout CHANNEL_LAYOUT = OH_AudioChannelLayout::CH_LAYOUT_STEREO;
181    // 配置音频位深(必须)
182    constexpr OH_BitsPerSample SAMPLE_FORMAT = OH_BitsPerSample::SAMPLE_S16LE;
183    // 每20ms一帧音频数据
184    constexpr float TIME_PER_FRAME = 0.02;
185    // 配置最大输入长度, 每帧音频数据的大小(可选)
186    constexpr uint32_t DEFAULT_MAX_INPUT_SIZE = DEFAULT_SAMPLERATE * TIME_PER_FRAME * DEFAULT_CHANNEL_COUNT * sizeof(short); // aac
187    OH_AVFormat *format = OH_AVFormat_Create();
188    // 写入format
189    OH_AVFormat_SetIntValue(format,OH_MD_KEY_AUD_CHANNEL_COUNT, DEFAULT_CHANNEL_COUNT);
190    OH_AVFormat_SetIntValue(format,OH_MD_KEY_AUD_SAMPLE_RATE, DEFAULT_SAMPLERATE);
191    OH_AVFormat_SetLongValue(format,OH_MD_KEY_BITRATE, DEFAULT_BITRATE);
192    OH_AVFormat_SetIntValue(format, OH_MD_KEY_AUDIO_SAMPLE_FORMAT, SAMPLE_FORMAT);
193    OH_AVFormat_SetLongValue(format,OH_MD_KEY_CHANNEL_LAYOUT, CHANNEL_LAYOUT);
194    OH_AVFormat_SetIntValue(format,OH_MD_KEY_MAX_INPUT_SIZE, DEFAULT_MAX_INPUT_SIZE);
195    // 配置编码器
196    ret = OH_AudioCodec_Configure(audioEnc_, format);
197    if (ret != AV_ERR_OK) {
198        // 异常处理
199    }
200    ```
201    <!--RP4End-->
202    例FLAC调用流程:
203
204    ```cpp
205    int32_t ret;
206    // 配置音频采样率(必须)
207    constexpr uint32_t DEFAULT_SAMPLERATE = 44100;
208    // 配置音频码率(必须)
209    constexpr uint64_t DEFAULT_BITRATE = 261000;
210    // 配置音频声道数(必须)
211    constexpr uint32_t DEFAULT_CHANNEL_COUNT = 2;
212    // 配置音频声道类型(必须)
213    constexpr OH_AudioChannelLayout CHANNEL_LAYOUT = OH_AudioChannelLayout::CH_LAYOUT_STEREO;
214    // 配置音频位深(必须) flac 只有SAMPLE_S16LE和SAMPLE_S32LE
215    constexpr OH_BitsPerSample SAMPLE_FORMAT = OH_BitsPerSample::SAMPLE_S32LE;
216    // 配置音频compliance level (默认值0,取值范围-2~2)
217    constexpr int32_t COMPLIANCE_LEVEL = 0;
218    // 配置音频精度(必须) SAMPLE_S16LE和SAMPLE_S24LE和SAMPLE_S32LE
219    constexpr OH_BitsPerSample BITS_PER_CODED_SAMPLE = OH_BitsPerSample::SAMPLE_S24LE;
220    OH_AVFormat *format = OH_AVFormat_Create();
221    // 写入format
222    OH_AVFormat_SetIntValue(format, OH_MD_KEY_AUD_CHANNEL_COUNT, DEFAULT_CHANNEL_COUNT);
223    OH_AVFormat_SetIntValue(format, OH_MD_KEY_AUD_SAMPLE_RATE, DEFAULT_SAMPLERATE);
224    OH_AVFormat_SetLongValue(format, OH_MD_KEY_BITRATE, DEFAULT_BITRATE);
225    OH_AVFormat_SetIntValue(format, OH_MD_KEY_BITS_PER_CODED_SAMPLE, BITS_PER_CODED_SAMPLE);
226    OH_AVFormat_SetIntValue(format, OH_MD_KEY_AUDIO_SAMPLE_FORMAT, SAMPLE_FORMAT);
227    OH_AVFormat_SetLongValue(format, OH_MD_KEY_CHANNEL_LAYOUT, CHANNEL_LAYOUT);
228    OH_AVFormat_SetLongValue(format, OH_MD_KEY_COMPLIANCE_LEVEL, COMPLIANCE_LEVEL);
229    // 配置编码器
230    ret = OH_AudioCodec_Configure(audioEnc_, format);
231    if (ret != AV_ERR_OK) {
232        // 异常处理
233    }
234    ```
235
236    <!--RP2--><!--RP2End-->
237
2385. 调用OH_AudioCodec_Prepare(),编码器就绪。
239
240    ```cpp
241    ret = OH_AudioCodec_Prepare(audioEnc_);
242    if (ret != AV_ERR_OK) {
243        // 异常处理
244    }
245    ```
246
2476. 调用OH_AudioCodec_Start()启动编码器,进入运行态。
248
249    ```c++
250    unique_ptr<ifstream> inputFile_ = make_unique<ifstream>();
251    unique_ptr<ofstream> outFile_ = make_unique<ofstream>();
252    // 打开待编码二进制文件路径(此处以输入为PCM文件为例)
253    inputFile_->open(inputFilePath.data(), ios::in | ios::binary);
254    // 配置编码文件输出路径(此处以输出为编码码流文件为例)
255    outFile_->open(outputFilePath.data(), ios::out | ios::binary);
256    // 开始编码
257    ret = OH_AudioCodec_Start(audioEnc_);
258    if (ret != AV_ERR_OK) {
259        // 异常处理
260    }
261    ```
262
2637. 调用OH_AudioCodec_PushInputBuffer(),写入待编码器的数据。
264
265   aac: 每帧样点数(SAMPLES_PER_FRAME)建议使用20ms的PCM样点数,即采样率*0.02。
266
267   flac: 每帧样点数(SAMPLES_PER_FRAME)比较特殊需要,根据如下表格进行设置。
268
269   | 采样率 | 样点数 |
270   | :----: | :----: |
271   |  8000  |  576  |
272   | 16000 |  1152  |
273   | 22050 |  2304  |
274   | 24000 |  2304  |
275   | 32000 |  2304  |
276   | 44100 |  4608  |
277   | 48000 |  4608  |
278   | 88200 |  8192  |
279   | 96000 |  8192  |
280
281   > **说明:**
282   > aac编码的每帧样点数建议使用20ms的PCM样点数,即采样率*0.02。flac编码的样点数建议根据采样率按照表格传入,大于这个值也会返回错误码,如果小于有可能出现编码文件损坏问题。
283
284   ```c++
285    // 每帧样点数
286    constexpr int32_t SAMPLES_PER_FRAME = DEFAULT_SAMPLERATE * TIME_PER_FRAME;
287    // 声道数,对于amr编码声道数只支持单声道的音频输入
288    constexpr int32_t DEFAULT_CHANNEL_COUNT = 2;
289    // 每帧输入数据的长度,声道数 * 每帧样点数 * 每个样点的字节数(以采样格式SAMPLE_S16LE为例)
290    constexpr int32_t INPUT_FRAME_BYTES = DEFAULT_CHANNEL_COUNT * SAMPLES_PER_FRAME * sizeof(short);
291    uint32_t index = signal_->inQueue_.front();
292    auto buffer = signal_->inBufferQueue_.front();
293    OH_AVCodecBufferAttr attr = {0};
294    if (!inputFile_->eof()) {
295        inputFile_->read((char *)OH_AVBuffer_GetAddr(buffer), INPUT_FRAME_BYTES);
296        attr.size = INPUT_FRAME_BYTES;
297        attr.flags = AVCODEC_BUFFER_FLAGS_NONE;
298    } else {
299        attr.size = 0;
300        attr.flags = AVCODEC_BUFFER_FLAGS_EOS;
301    }
302    OH_AVBuffer_SetBufferAttr(buffer, &attr);
303    // 送入编码输入队列进行编码, index为对应队列下标
304    ret = OH_AudioCodec_PushInputBuffer(audioEnc_, index);
305    if (ret != AV_ERR_OK) {
306        // 异常处理
307    }
308    ```
309   在上方案例中,attr.flags代表缓冲区标记的类别。
310   如果是结束,需要将flags标识成AVCODEC_BUFFER_FLAGS_EOS。
311   | 枚举值 | 描述 |
312   | -------- | -------- |
313   | AVCODEC_BUFFER_FLAGS_NONE | 表示为普通帧。 |
314   | AVCODEC_BUFFER_FLAGS_EOS | 表示缓冲区是流结束帧。 |
315   | AVCODEC_BUFFER_FLAGS_CODEC_DATA | 表示缓冲区包含编解码特定数据。 |
316
3178. 调用OH_AudioCodec_FreeOutputBuffer(),输出编码格式码流。
318
319    ```c++
320    uint32_t index = signal_->outQueue_.front();
321    OH_AVBuffer *avBuffer = signal_->outBufferQueue_.front();
322    // 获取buffer attributes
323    OH_AVCodecBufferAttr attr = {0};
324    ret = OH_AVBuffer_GetBufferAttr(avBuffer, &attr);
325    if (ret != AV_ERR_OK) {
326        // 异常处理
327    }
328    // 将编码完成数据data写入到对应输出文件中
329    outputFile_->write(reinterpret_cast<char *>(OH_AVBuffer_GetAddr(avBuffer)), attr.size);
330    // 释放已完成写入的数据
331    ret = OH_AudioCodec_FreeOutputBuffer(audioEnc_, index);
332    if (ret != AV_ERR_OK) {
333        // 异常处理
334    }
335    if (attr.flags == AVCODEC_BUFFER_FLAGS_EOS) {
336        // 结束
337    }
338    ```
339
3409. (可选)调用OH_AudioCodec_Flush()刷新编码器。
341   调用OH_AudioCodec_Flush()后,编码器处于Flush状态,会将当前编码队列清空。
342   此时需要调用OH_AudioCodec_Start()重新开始编码。
343   使用情况:
344
345   * 在文件EOS之后,需要调用刷新
346   * 在执行过程中遇到可继续执行的错误时(即OH_AudioCodec_IsValid 为true)可以调用,然后重新调用OH_AudioCodec_Start
347
348    ```c++
349    // 刷新编码器 audioEnc_
350    ret = OH_AudioCodec_Flush(audioEnc_);
351    if (ret != AV_ERR_OK) {
352        // 异常处理
353    }
354    // 重新开始编码
355    ret = OH_AudioCodec_Start(audioEnc_);
356    if (ret != AV_ERR_OK) {
357        // 异常处理
358    }
359    ```
360
36110. (可选)调用OH_AudioCodec_Reset()重置编码器。
362    调用OH_AudioCodec_Reset()后,编码器回到初始化的状态,需要调用OH_AudioCodec_Configure()重新配置,然后调用OH_AudioCodec_Start()重新开始编码。
363
364    ```c++
365    // 重置编码器 audioEnc_
366    ret = OH_AudioCodec_Reset(audioEnc_);
367    if (ret != AV_ERR_OK) {
368        // 异常处理
369    }
370    // 重新配置编码器参数
371    ret = OH_AudioCodec_Configure(audioEnc_, format);
372    if (ret != AV_ERR_OK) {
373        // 异常处理
374    }
375    ```
376
37711. 调用OH_AudioCodec_Stop()停止编码器。
378
379    ```c++
380    // 终止编码器 audioEnc_
381    ret = OH_AudioCodec_Stop(audioEnc_);
382    if (ret != AV_ERR_OK) {
383        // 异常处理
384    }
385    ```
386
38712. 调用OH_AudioCodec_Destroy()销毁编码器实例,释放资源。
388
389    > **说明:**
390    > 资源不能重复销毁
391
392    ```c++
393    // 调用OH_AudioCodec_Destroy, 注销编码器
394    ret = OH_AudioCodec_Destroy(audioEnc_);
395    if (ret != AV_ERR_OK) {
396        // 异常处理
397    } else {
398        audioEnc_ = NULL; // 不可重复destroy
399    }
400    ```
401
402## 相关实例
403
404针对音频编码,有以下相关实例可供参考:
405
406- [音频编码](https://gitee.com/openharmony/multimedia_av_codec/blob/master/test/nativedemo/audio_demo/avcodec_audio_avbuffer_aac_encoder_demo.cpp)
407