HarmonyOS API:头文件

joytrian
发布于 2023-4-14 17:02
浏览
0收藏

版本:v3.1 Beta

native_avcodec_audioencoder.h

更新时间: 2023-02-17 09:19

概述

声明用于音频编码的Native API。


起始版本:


9


相关模块:


​AudioEncoder​

汇总

函数

名称

描述

​OH_AudioEncoder_CreateByMime​​ (const char *mime)

通过mime类型创建一个音频编码器实例,大多数情况下推荐使用该接口。

​OH_AudioEncoder_CreateByName​​ (const char *name)

通过音频编码器名称创建一个音频编码器实例,使用这个接口的前提是必须清楚编码器准确的名称。

​OH_AudioEncoder_Destroy​​ (OH_AVCodec *codec)

清空编码器内部资源,并销毁编码器实例。

​OH_AudioEncoder_SetCallback​​​ (OH_AVCodec *codec, ​​OH_AVCodecAsyncCallback​​ callback, void *userData)

设置异步回调函数,使得你的应用能够响应音频编码器产生的事件,该接口被调用必须是在Prepare被调用前。

​OH_AudioEncoder_Configure​​ (OH_AVCodec *codec, OH_AVFormat *format)

配置音频编码器,典型地,需要配置被编码音频轨道的描述信息,该接口被调用必须是在Prepare被调用前。

​OH_AudioEncoder_Prepare​​ (OH_AVCodec *codec)

准备编码器内部资源,调用该接口前必须先调用Configure接口。

​OH_AudioEncoder_Start​​ (OH_AVCodec *codec)

启动编码器,该接口必须在已经Prepare成功后调用。 在启动成功后,编码器将开始报告​​OH_AVCodecOnNeedInputData​​事件。

​OH_AudioEncoder_Stop​​ (OH_AVCodec *codec)

停止编码器。在停止后可通过Start重新进入Started状态。

​OH_AudioEncoder_Flush​​ (OH_AVCodec *codec)

清空编码器内部缓存的输入输出数据。在该接口被调用后,所有先前通过异步回调报告的Buffer的索引都将 失效,确保不要再访问这些索引对应的Buffers。

​OH_AudioEncoder_Reset​​ (OH_AVCodec *codec)

重置编码器。如需继续编码工作,需要重新调用Configure接口以配置该编码器实例。

​OH_AudioEncoder_GetOutputDescription​​ (OH_AVCodec *codec)

获取该编码器输出数据的描述信息,需要注意的是,返回值所指向的OH_AVFormat实例需调用者手动释放。

​OH_AudioEncoder_SetParameter​​ (OH_AVCodec *codec, OH_AVFormat *format)

向编码器设置动态参数,注意:该接口仅能在编码器被启动后调用,同时错误的参数设置,可能会导致编码失败。

​OH_AudioEncoder_PushInputData​​​ (OH_AVCodec *codec, uint32_t index, ​​OH_AVCodecBufferAttr​​ attr)

将填充好数据的输入Buffer提交给音频编码器。​​OH_AVCodecOnNeedInputData​​​回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给编码器,直到再一次收到​​OH_AVCodecOnNeedInputData​​ 回调报告相同索引的Buffer可用前,该Buffer都不可以再次被访问。

​OH_AudioEncoder_FreeOutputData​​ (OH_AVCodec *codec, uint32_t index)

将处理结束的输出Buffer交还给编码器。

native_avcodec_base.h

更新时间: 2023-02-17 09:19

概述

声明运行音视频编解码通用的结构体、字符常量、枚举。


起始版本:


9


相关模块:


​CodecBase​

汇总

结构体

名称

描述

​OH_AVCodecBufferAttr​

定义OH_AVCodec的Buffer描述信息。

​OH_AVCodecAsyncCallback​

AVCodec所有的异步回调函数指针集合。注册一个该结构体实例给OH_AVCodec实例,并处理通过该回调报告 的信息,以确保AVCodec正常运转。

类型定义

名称

描述

​OH_AVCodecBufferFlags​

枚举OH_AVCodec的Buffer标记的类别。

​OH_AVCodecBufferAttr​

定义OH_AVCodec的Buffer描述信息。

(*​​OH_AVCodecOnError​​) (OH_AVCodec *codec, int32_t errorCode, void *userData)

当OH_AVCodec实例运行发生错误时,该函数指针会被调用以报告具体错误信息。

(*​​OH_AVCodecOnStreamChanged​​) (OH_AVCodec *codec, OH_AVFormat *format, void *userData)

当输出流发生变化时,该函数指针会被调用以报告新的流描述信息。 需要注意的时,OH_AVFormat指针的生命周期仅维持在该函数指针被调用时上有效,禁止在调用结束后继续访问。

(*​​OH_AVCodecOnNeedInputData​​) (OH_AVCodec *codec, uint32_t index, OH_AVMemory *data, void *userData)

当AVCodec运行过程中需要新的输入数据时,该函数指针会被调用,并携带一块可用的Buffer以供填入新的输入数据。

(*​​OH_AVCodecOnNewOutputData​​​) (OH_AVCodec *codec, uint32_t index, OH_AVMemory *data, ​​OH_AVCodecBufferAttr​​ *attr, void *userData)

当AVCodec运行过程中产生了新的输出数据时,该函数指针会被调用,并携带一块包含新输出数据的Buffer, 需要注意的是,OH_AVCodecBufferAttr指针的生命周期仅维持在该函数指针被调用时有效,禁止调用结束后继续访问。

​OH_AVCodecAsyncCallback​

AVCodec所有的异步回调函数指针集合。注册一个该结构体实例给OH_AVCodec实例,并处理通过该回调报告 的信息,以确保AVCodec正常运转。

​OH_MediaType​

媒体类型。

​OH_AVCProfile​

AVC Profile枚举。

​OH_AACProfile​

AAC Profile枚举。

枚举

名称

描述

​OH_AVCodecBufferFlags​​ {

AVCODEC_BUFFER_FLAGS_NONE = 0, AVCODEC_BUFFER_FLAGS_EOS = 1 << 0, AVCODEC_BUFFER_FLAGS_SYNC_FRAME = 1 << 1, AVCODEC_BUFFER_FLAGS_INCOMPLETE_FRAME = 1 << 2,

AVCODEC_BUFFER_FLAGS_CODEC_DATA = 1 << 3

}

枚举OH_AVCodec的Buffer标记的类别。

​OH_MediaType​​ { MEDIA_TYPE_AUD = 0, MEDIA_TYPE_VID = 1 }

媒体类型。

​OH_AVCProfile​​ { AVC_PROFILE_BASELINE = 0, AVC_PROFILE_HIGH = 4, AVC_PROFILE_MAIN = 8 }

AVC Profile枚举。

​OH_AACProfile​​ { AAC_PROFILE_LC = 0 }

AAC Profile枚举。

变量

名称

描述

​OH_AVCODEC_MIMETYPE_VIDEO_AVC​

AVC视频编解码器的MIME类型。

​OH_AVCODEC_MIMETYPE_AUDIO_AAC​

AAC音频编解码器的MIME类型。

​OH_ED_KEY_TIME_STAMP​

surface附属数据中时间戳的字符描述符,值类型为int64。

​OH_ED_KEY_EOS​

surface附属数据中结束流的字符描述符,值类型为bool。

​OH_MD_KEY_TRACK_TYPE​

轨道类型的字符描述符,值类型为uint8_t,具体见​​OH_MediaType​​。

​OH_MD_KEY_CODEC_MIME​

mime类型的字符描述符,值类型为string。

​OH_MD_KEY_DURATION​

duration的字符描述符,值类型为int64_t。

​OH_MD_KEY_BITRATE​

比特率的字符描述符,值类型为uint32_t。

​OH_MD_KEY_MAX_INPUT_SIZE​

最大输入尺寸的字符描述符,值类型为uint32_t。

​OH_MD_KEY_WIDTH​

视频宽度的字符描述符,值类型为uint32_t。

​OH_MD_KEY_HEIGHT​

视频高度的字符描述符,值类型为uint32_t。

​OH_MD_KEY_PIXEL_FORMAT​

视频像素格式的字符描述符,值类型为int32_t,具体见​​OH_AVPixelFormat​​。

​OH_MD_KEY_AUDIO_SAMPLE_FORMAT​

音频采样格式的字符描述符,值类型为uint32_t。

​OH_MD_KEY_FRAME_RATE​

视频帧率的字符描述符,值类型为double。

​OH_MD_KEY_VIDEO_ENCODE_BITRATE_MODE​

视频编码比特率模式的字符描述符,值类型为int32_t,具体见​​OH_VideoEncodeBitrateMode​​。

​OH_MD_KEY_PROFILE​

音视频编码能力的字符描述符,值类型为int32_t,具体见​​OH_AVCProfile​​​或​​OH_AACProfile​​。

​OH_MD_KEY_AUD_CHANNEL_COUNT​

音频声道数的字符描述符,值类型为uint32_t。

​OH_MD_KEY_AUD_SAMPLE_RATE​

音频采样率的字符描述符,值类型为uint32_t。

​OH_MD_KEY_I_FRAME_INTERVAL​

I帧间隔时长的字符描述符,值类型为int32_t,单位是毫秒。

​OH_MD_KEY_ROTATION​

surface旋转角度的字符描述符,值类型为int32_t,限于{0, 90, 180, 270},默认值为0。

native_avcodec_videodecoder.h

更新时间: 2023-02-17 09:19

概述

声明用于视频解码的Native API。


起始版本:


9


相关模块:


​VideoDecoder​

汇总

函数

名称

描述

​OH_VideoDecoder_CreateByMime​​ (const char *mime)

通过mime类型创建一个视频解码器实例,大多数情况下推荐使用该接口。

​OH_VideoDecoder_CreateByName​​ (const char *name)

通过视频解码器名称创建一个视频解码器实例,使用这个接口的前提是必须清楚解码器准确的名称。

​OH_VideoDecoder_Destroy​​ (OH_AVCodec *codec)

清空解码器内部资源,并销毁解码器实例。

​OH_VideoDecoder_SetCallback​​​ (OH_AVCodec *codec, ​​OH_AVCodecAsyncCallback​​ callback, void *userData)

设置异步回调函数,使得你的应用能够响应视频解码器产生的事件,该接口被调用必须是在Prepare被调用前。

​OH_VideoDecoder_SetSurface​​ (OH_AVCodec *codec, OHNativeWindow *window)

指定输出Surface,以提供视频解码输出,该接口被调用必须是在Prepare被调用前。

​OH_VideoDecoder_Configure​​ (OH_AVCodec *codec, OH_AVFormat *format)

配置视频解码器,典型地,需要配置被解码视频轨道的描述信息,这些信息能够从容器中提取出来, 该接口被调用必须是在Prepare被调用前。

​OH_VideoDecoder_Prepare​​ (OH_AVCodec *codec)

准备解码器内部资源,调用该接口前必须先调用Configure接口。

​OH_VideoDecoder_Start​​ (OH_AVCodec *codec)

启动解码器,该接口必须在已经Prepare成功后调用。 在启动成功后,解码器将开始报告​​OH_AVCodecOnNeedInputData​​事件。

​OH_VideoDecoder_Stop​​ (OH_AVCodec *codec)

停止解码器。在停止后可通过Start重新进入Started状态,但需要注意的是,若先前给解码器输入过 Codec-Specific-Data,则需要重新输入。

​OH_VideoDecoder_Flush​​ (OH_AVCodec *codec)

清空解码器内部缓存的输入输出数据。在该接口被调用后,所有先前通过异步回调报告的Buffer的索引都将 失效,确保不要再访问这些索引对应的Buffers。

​OH_VideoDecoder_Reset​​ (OH_AVCodec *codec)

重置解码器。如需继续解码工作,需要重新调用Configure接口以配置该解码器实例。

​OH_VideoDecoder_GetOutputDescription​​ (OH_AVCodec *codec)

获取该解码器输出数据的描述信息,需要注意的是,返回值所指向的OH_AVFormat实例的生命周期 将会再下一次调用该接口时或者该OH_AVCodec实例被销毁时失效。

​OH_VideoDecoder_SetParameter​​ (OH_AVCodec *codec, OH_AVFormat *format)

向解码器设置动态参数,注意:该接口仅能在解码器被启动后调用,同时错误的参数设置,可能会导致解码失败。

​OH_VideoDecoder_PushInputData​​​ (OH_AVCodec *codec, uint32_t index, ​​OH_AVCodecBufferAttr​​ attr)

将填充好数据的输入Buffer提交给视频解码器。​​OH_AVCodecOnNeedInputData​​​回调会报告可用的输入 Buffer及对应的索引值。一旦指定索引的Buffer被提交给解码器,直到再一次收到​​OH_AVCodecOnNeedInputData​​ 回调报告相同索引的Buffer可用前,该Buffer都不可以再次被访问。另外,对于部分解码器,要求在最开始给解码器输入 Codec-Specific-Data,用以初始化解码器的解码过程,例如H264格式的PPS/SPS数据。

​OH_VideoDecoder_RenderOutputData​​ (OH_AVCodec *codec, uint32_t index)

将处理结束的输出Buffer交还给解码器,并通知解码器完成将该Buffer内包含的解码后的数据在输出Surface上渲染。 如果先前未配置输出Surface,调用该接口仅仅将指定索引对应的输出Buffer交还给解码器。

​OH_VideoDecoder_FreeOutputData​​ (OH_AVCodec *codec, uint32_t index)

将处理结束的输出Buffer交还给解码器。


文章转载自:​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/native__avcodec__videodecoder_8h-0000001497210917-V3?catalogVersion=V3​

已于2023-4-14 17:02:14修改
收藏
回复
举报
回复