未验证 提交 80c39033 编写于 作者: O openharmony_ci 提交者: Gitee

!20541 IsValid 接口说明修改,新增flac编码 输入长度说明

Merge pull request !20541 from guoyao/master
......@@ -152,7 +152,7 @@ constexpr int32_t COMPLIANCE_LEVEL = 0;
// 配置音频精度(必须) SAMPLE_S16LE和SAMPLE_S24LE和SAMPLE_S32LE
constexpr BITS_PER_CODED_SAMPLE BITS_PER_CODED_SAMPLE =OH_BitsPerSample::SAMPLE_S24LE;
// 配置最大输入长度(可选)
constexpr uint32_t DEFAULT_MAX_INPUT_SIZE = 1024*2*4;//aac
constexpr uint32_t DEFAULT_MAX_INPUT_SIZE = 1024*DEFAULT_CHANNEL_COUNT *sizeof(float);//aac
OH_AVFormat *format = OH_AVFormat_Create();
// 写入format
OH_AVFormat_SetIntValue(format,MediaDescriptionKey::MD_KEY_SAMPLE_RATE.data(),DEFAULT_SMAPLERATE);
......@@ -200,8 +200,28 @@ if (ret != AV_ERR_OK) {
6. 调用OH_AudioEncoder_PushInputData(),写入待编码器的数据。
如果是结束,需要对flag标识成AVCODEC_BUFFER_FLAGS_EOS
aac: 样点数(FRAME_SIZE)固定为1024
flac: 样点数(FRAME_SIZE)比较特殊需要,根据如下表格进行设置
| 采样率 | 样点数 |
| :----: | :----: |
| 8000 | 576 |
| 16000 | 1152 |
| 22050 | 2304 |
| 24000 | 2304 |
| 32000 | 2304 |
| 44100 | 4608 |
| 48000 | 4608 |
| 88200 | 8192 |
| 96000 | 8192 |
**注意**:aac的样点数固定为1024,其他值会直接返回错误码,flac的样点数建议根据采样率按照表格传入,大于这个值也会返回错误码,如果小于有可能出现编码文件损坏问题。
```c++
constexpr int32_t INPUT_FRAME_BYTES = 2 * 1024 * 4;
constexpr int32_t FRAME_SIZE = 1024; //aac
constexpr int32_t DEFAULT_CHANNEL_COUNT =2;
constexpr int32_t INPUT_FRAME_BYTES = DEFAULT_CHANNEL_COUNT * FRAME_SIZE * sizeof(float); //aac
// 配置buffer info信息
OH_AVCodecBufferAttr info;
// 设置输入pkt尺寸、偏移量、时间戳等信息
......
# AudioEncoder
## 概述
AudioEncoder模块提供用于音频编码的函数。该模块在部分设备上可能不支持,可以通过[CanIUse](../syscap.md)接口确认。
......@@ -11,21 +10,18 @@ AudioEncoder模块提供用于音频编码的函数。该模块在部分设备
9
## 汇总
### 文件
| 名称 | 描述 |
| -------- | -------- |
| [native_avcodec_audioencoder.h](native__avcodec__audioencoder_8h.md) | 声明用于音频编码的Native API。<br>引用文件:<multimedia/player_framework/native_avcodec_audioencoder.h> |
| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| [native_avcodec_audioencoder.h](native__avcodec__audioencoder_8h.md) | 声明用于音频编码的Native API。`<br>`引用文件:<multimedia/player_framework/native_avcodec_audioencoder.h> |
### 函数
| 名称 | 描述 |
| -------- | -------- |
| --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| \*[OHOS::Media::OH_AudioEncoder_CreateByMime](#oh_audioencoder_createbymime) (const char \*mime) | 根据MIME类型创建音频编码器实例,大多数场景下建议使用此方式。 |
| \*[OHOS::Media::OH_AudioEncoder_CreateByName](#oh_audioencoder_createbyname) (const char \*name) | 通过音频编码器名称创建音频编码器实例,使用此接口的前提是知道编码器的确切名称。 |
| [OHOS::Media::OH_AudioEncoder_Destroy](#oh_audioencoder_destroy) (OH_AVCodec \*codec) | 清理编码器内部资源,销毁编码器实例。 |
......@@ -40,15 +36,12 @@ AudioEncoder模块提供用于音频编码的函数。该模块在部分设备
| [OHOS::Media::OH_AudioEncoder_SetParameter](#oh_audioencoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置编码器的动态参数。 |
| [OHOS::Media::OH_AudioEncoder_PushInputData](#oh_audioencoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, OH_AVCodecBufferAttr attr) | 将填充有数据的输入缓冲区提交给音频编码器。 |
| [OHOS::Media::OH_AudioEncoder_FreeOutputData](#oh_audioencoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回给编码器。 |
| [OHOS::Media::OH_AudioEncoder_IsValid](#oh_audioencoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前编码器实例是否有效,可用于后台故障恢复或应用程序从后台恢复时检测编码器有效状态。 |
| [OHOS::Media::OH_AudioEncoder_IsValid](#oh_audioencoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前编码器实例是否有效。 |
## 函数说明
### OH_AudioEncoder_Configure()
```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Configure (OH_AVCodec * codec, OH_AVFormat * format )
```
......@@ -64,7 +57,7 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Configure (OH_AVCodec * codec, OH_AVFo
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| ------ | --------------------------------------------------- |
| codec | 指向OH_AVCodec实例的指针。 |
| format | 指向OH_AVFormat的指针,给出要编码的音频轨道的描述。 |
......@@ -76,10 +69,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Configure (OH_AVCodec * codec, OH_AVFo
9
### OH_AudioEncoder_CreateByMime()
```
OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByMime (const char * mime)
```
......@@ -93,8 +84,8 @@ OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByMime (const char * mime)
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| mime | MIME类型描述字符串,请参阅 **AVCODEC_MIME_TYPE**。 |
| ---- | ------------------------------------------------------- |
| mime | MIME类型描述字符串,请参阅**AVCODEC_MIME_TYPE**。 |
**返回:**
......@@ -104,10 +95,8 @@ OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByMime (const char * mime)
9
### OH_AudioEncoder_CreateByName()
```
OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByName (const char * name)
```
......@@ -121,7 +110,7 @@ OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByName (const char * name)
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| ---- | ---------------- |
| name | 音频编码器名称。 |
**返回:**
......@@ -132,10 +121,8 @@ OH_AVCodec* OHOS::Media::OH_AudioEncoder_CreateByName (const char * name)
9
### OH_AudioEncoder_Destroy()
```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Destroy (OH_AVCodec * codec)
```
......@@ -149,7 +136,7 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Destroy (OH_AVCodec * codec)
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 |
**返回:**
......@@ -160,10 +147,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Destroy (OH_AVCodec * codec)
9
### OH_AudioEncoder_Flush()
```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Flush (OH_AVCodec * codec)
```
......@@ -179,7 +164,7 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Flush (OH_AVCodec * codec)
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 |
**返回:**
......@@ -190,10 +175,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Flush (OH_AVCodec * codec)
9
### OH_AudioEncoder_FreeOutputData()
```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_FreeOutputData (OH_AVCodec * codec, uint32_t index )
```
......@@ -207,7 +190,7 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_FreeOutputData (OH_AVCodec * codec, ui
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| ----- | ------------------------------ |
| codec | 指向OH_AVCodec实例的指针。 |
| index | 输出缓冲区Buffer对应的索引值。 |
......@@ -219,10 +202,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_FreeOutputData (OH_AVCodec * codec, ui
9
### OH_AudioEncoder_GetOutputDescription()
```
OH_AVFormat* OHOS::Media::OH_AudioEncoder_GetOutputDescription (OH_AVCodec * codec)
```
......@@ -238,7 +219,7 @@ OH_AVFormat* OHOS::Media::OH_AudioEncoder_GetOutputDescription (OH_AVCodec * cod
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 |
**返回:**
......@@ -249,24 +230,22 @@ OH_AVFormat* OHOS::Media::OH_AudioEncoder_GetOutputDescription (OH_AVCodec * cod
9
### OH_AudioEncoder_IsValid()
```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_IsValid (OH_AVCodec * codec, bool * isValid )
```
**描述:**
检查当前编码器实例是否有效,可用于后台故障恢复或应用程序从后台恢复时检测编码器有效状态
检查当前编码器实例是否有效。
\@syscap SystemCapability.Multimedia.Media.AudioEncoder
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| ------- | ----------------------------------------------------------------- |
| codec | 指向OH_AVCodec实例的指针。 |
| isValid | 指向布尔实例的指针,true:编码器实例有效,false:编码器实例无效。 |
......@@ -278,10 +257,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_IsValid (OH_AVCodec * codec, bool * is
10
### OH_AudioEncoder_Prepare()
```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Prepare (OH_AVCodec * codec)
```
......@@ -295,7 +272,7 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Prepare (OH_AVCodec * codec)
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 |
**返回:**
......@@ -306,10 +283,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Prepare (OH_AVCodec * codec)
9
### OH_AudioEncoder_PushInputData()
```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_PushInputData (OH_AVCodec * codec, uint32_t index, OH_AVCodecBufferAttr attr )
```
......@@ -325,7 +300,7 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_PushInputData (OH_AVCodec * codec, uin
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| ----- | ------------------------------ |
| codec | 指向OH_AVCodec实例的指针。 |
| index | 输入缓冲区Buffer对应的索引值。 |
| attr | 描述缓冲区中包含的数据的信息。 |
......@@ -338,10 +313,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_PushInputData (OH_AVCodec * codec, uin
9
### OH_AudioEncoder_Reset()
```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Reset (OH_AVCodec * codec)
```
......@@ -355,17 +328,15 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Reset (OH_AVCodec * codec)
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 |
**返回:**
如果执行成功,则返回AV_ERR_OK,否则返回特定错误代码,请参阅[OH_AVErrCode](_core.md#oh_averrcode)
### OH_AudioEncoder_SetCallback()
```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetCallback (OH_AVCodec * codec, OH_AVCodecAsyncCallback callback, void * userData )
```
......@@ -381,9 +352,9 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetCallback (OH_AVCodec * codec, OH_AV
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| -------- | ------------------------------------------------------------- |
| codec | 指向OH_AVCodec实例的指针。 |
| callback | 所有回调函数的集合,请参见 **OH_AVCodecAsyncCallback**。 |
| callback | 所有回调函数的集合,请参见**OH_AVCodecAsyncCallback**。 |
| userData | 用户特定数据。 |
**返回:**
......@@ -394,10 +365,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetCallback (OH_AVCodec * codec, OH_AV
9
### OH_AudioEncoder_SetParameter()
```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetParameter (OH_AVCodec * codec, OH_AVFormat * format )
```
......@@ -413,7 +382,7 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetParameter (OH_AVCodec * codec, OH_A
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| ------ | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 |
| format | OH_AVFormat句柄指针。 |
......@@ -425,10 +394,8 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_SetParameter (OH_AVCodec * codec, OH_A
9
### OH_AudioEncoder_Start()
```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Start (OH_AVCodec * codec)
```
......@@ -444,7 +411,7 @@ Prepare成功后调用此接口启动编码器。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 |
**返回:**
......@@ -455,10 +422,8 @@ Prepare成功后调用此接口启动编码器。
9
### OH_AudioEncoder_Stop()
```
OH_AVErrCode OHOS::Media::OH_AudioEncoder_Stop (OH_AVCodec * codec)
```
......@@ -472,7 +437,7 @@ OH_AVErrCode OHOS::Media::OH_AudioEncoder_Stop (OH_AVCodec * codec)
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| ----- | -------------------------- |
| codec | 指向OH_AVCodec实例的指针。 |
**返回:**
......
# native_avcodec_audiodecoder.h
## 概述
声明用于音频解码的Native API。
......@@ -13,14 +12,12 @@
[AudioDecoder](_audio_decoder.md)
## 汇总
### 函数
| 名称 | 描述 |
| -------- | -------- |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| \*[OHOS::Media::OH_AudioDecoder_CreateByMime](_audio_decoder.md#oh_audiodecoder_createbymime) (const char \*mime) | 根据MIME类型创建音频解码器实例,大多数场景下建议使用此方式。 |
| \*[OHOS::Media::OH_AudioDecoder_CreateByName](_audio_decoder.md#oh_audiodecoder_createbyname) (const char \*name) | 通过音频解码器名称创建音频解码器实例,使用此接口的前提是知道解码器的确切名称。 |
| [OHOS::Media::OH_AudioDecoder_Destroy](_audio_decoder.md#oh_audiodecoder_destroy) (OH_AVCodec \*codec) | 清理解码器内部资源,销毁解码器实例。 |
......@@ -35,4 +32,4 @@
| [OHOS::Media::OH_AudioDecoder_SetParameter](_audio_decoder.md#oh_audiodecoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置解码器的动态参数。注意:该接口必须在解码器启动后才能调用。另外,参数配置错误可能会导致解码失败。 |
| [OHOS::Media::OH_AudioDecoder_PushInputData](_audio_decoder.md#oh_audiodecoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, OH_AVCodecBufferAttr attr) | 将填充有数据的输入缓冲区提交给音频解码器。 |
| [OHOS::Media::OH_AudioDecoder_FreeOutputData](_audio_decoder.md#oh_audiodecoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回给解码器。 |
| [OHOS::Media::OH_AudioDecoder_IsValid](_audio_decoder.md#oh_audiodecoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前解码器实例是否有效,可用于后台故障恢复或应用程序从后台恢复时检测解码器有效状态。 |
| [OHOS::Media::OH_AudioDecoder_IsValid](_audio_decoder.md#oh_audiodecoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前解码器实例是否有效。 |
# native_avcodec_audioencoder.h
## 概述
声明用于音频编码的Native API。
......@@ -13,14 +12,12 @@
[AudioEncoder](_audio_encoder.md)
## 汇总
### 函数
| 名称 | 描述 |
| -------- | -------- |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| \*[OHOS::Media::OH_AudioEncoder_CreateByMime](_audio_encoder.md#oh_audioencoder_createbymime) (const char \*mime) | 根据MIME类型创建音频编码器实例,大多数场景下建议使用此方式。 |
| \*[OHOS::Media::OH_AudioEncoder_CreateByName](_audio_encoder.md#oh_audioencoder_createbyname) (const char \*name) | 通过音频编码器名称创建音频编码器实例,使用此接口的前提是知道编码器的确切名称。 |
| [OHOS::Media::OH_AudioEncoder_Destroy](_audio_encoder.md#oh_audioencoder_destroy) (OH_AVCodec \*codec) | 清理编码器内部资源,销毁编码器实例。 |
......@@ -35,4 +32,4 @@
| [OHOS::Media::OH_AudioEncoder_SetParameter](_audio_encoder.md#oh_audioencoder_setparameter) (OH_AVCodec \*codec, OH_AVFormat \*format) | 配置编码器的动态参数。 |
| [OHOS::Media::OH_AudioEncoder_PushInputData](_audio_encoder.md#oh_audioencoder_pushinputdata) (OH_AVCodec \*codec, uint32_t index, OH_AVCodecBufferAttr attr) | 将填充有数据的输入缓冲区提交给音频编码器。 |
| [OHOS::Media::OH_AudioEncoder_FreeOutputData](_audio_encoder.md#oh_audioencoder_freeoutputdata) (OH_AVCodec \*codec, uint32_t index) | 将处理后的输出缓冲区返回给编码器。 |
| [OHOS::Media::OH_AudioEncoder_IsValid](_audio_encoder.md#oh_audioencoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前编码器实例是否有效,可用于后台故障恢复或应用程序从后台恢复时检测编码器有效状态。 |
| [OHOS::Media::OH_AudioEncoder_IsValid](_audio_encoder.md#oh_audioencoder_isvalid) (OH_AVCodec \*codec, bool \*isValid) | 检查当前编码器实例是否有效。 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册