1# 使用OHAudio开发音频播放功能(C/C++) 2 3OHAudio是系统在API version 10中引入的一套C API，此API在设计上实现归一，同时支持普通音频通路和低时延通路。仅支持PCM格式，适用于依赖Native层实现音频输出功能的场景。 4 5OHAudio音频播放状态变化示意图： 6 7 8## 使用入门 9 10开发者要使用OHAudio提供的播放能力，需要添加对应的头文件。 11 12### 在 CMake 脚本中链接动态库 13 14``` cmake 15target_link_libraries(sample PUBLIC libohaudio.so) 16``` 17 18### 添加头文件 19 20开发者通过引入<[native_audiostreambuilder.h](../../reference/apis-audio-kit/native__audiostreambuilder_8h.md)>和<[native_audiorenderer.h](../../reference/apis-audio-kit/native__audiorenderer_8h.md)>头文件，使用音频播放相关API。 21 22```cpp 23#include <ohaudio/native_audiorenderer.h> 24#include <ohaudio/native_audiostreambuilder.h> 25``` 26 27## 音频流构造器 28 29OHAudio提供OH_AudioStreamBuilder接口，遵循构造器设计模式，用于构建音频流。开发者需要根据业务场景，指定对应的[OH_AudioStream_Type](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostream_type)。 30 31`OH_AudioStream_Type`包含两种类型： 32 33- AUDIOSTREAM_TYPE_RENDERER 34- AUDIOSTREAM_TYPE_CAPTURER 35 36使用[OH_AudioStreamBuilder_Create](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostreambuilder_create)创建构造器示例： 37 38```cpp 39OH_AudioStreamBuilder* builder; 40OH_AudioStreamBuilder_Create(&builder, streamType); 41``` 42 43在音频业务结束之后，开发者应该执行[OH_AudioStreamBuilder_Destroy](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostreambuilder_destroy)接口来销毁构造器。 44 45```cpp 46OH_AudioStreamBuilder_Destroy(builder); 47``` 48 49## 开发步骤及注意事项 50 51详细的API说明请参考[OHAudio API参考](../../reference/apis-audio-kit/_o_h_audio.md)。 52 53开发者可以通过以下几个步骤来实现一个简单的播放功能。 54 551. 创建构造器。 56 57 ```cpp 58 OH_AudioStreamBuilder* builder; 59 OH_AudioStreamBuilder_Create(&builder, AUDIOSTREAM_TYPE_RENDERER); 60 ``` 61 622. 配置音频流参数。 63 64 关于音频采样率可参考[配置合适的音频采样率](using-audiorenderer-for-playback.md#配置合适的音频采样率)。<br> 65 创建音频播放构造器后，可以设置音频流所需要的参数，可以参考下面的案例。 66 67 ```cpp 68 // 设置音频采样率。 69 OH_AudioStreamBuilder_SetSamplingRate(builder, 48000); 70 // 设置音频声道。 71 OH_AudioStreamBuilder_SetChannelCount(builder, 2); 72 // 设置音频采样格式。 73 OH_AudioStreamBuilder_SetSampleFormat(builder, AUDIOSTREAM_SAMPLE_S16LE); 74 // 设置音频流的编码类型。 75 OH_AudioStreamBuilder_SetEncodingType(builder, AUDIOSTREAM_ENCODING_TYPE_RAW); 76 // 设置输出音频流的工作场景。 77 OH_AudioStreamBuilder_SetRendererInfo(builder, AUDIOSTREAM_USAGE_MUSIC); 78 ``` 79 80 注意，播放的音频数据要通过回调接口写入，开发者要实现回调接口，使用`OH_AudioStreamBuilder_SetRendererCallback`设置回调函数。回调函数的声明请查看[OH_AudioRenderer_Callbacks](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiorenderer_callbacks)。 81 823. 设置音频回调函数。 83 84 多音频并发处理可参考文档[处理音频焦点事件](audio-playback-concurrency.md)，仅接口语言差异。 85 86 在设置音频回调函数时API version 12新增回调函数[OH_AudioRenderer_OnWriteDataCallback](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiorenderer_onwritedatacallback)用于写入音频数据。 87 88 - API version 12开始**推荐**使用[OH_AudioRenderer_OnWriteDataCallback](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiorenderer_onwritedatacallback)代替[OH_AudioRenderer_Callbacks_Struct.OH_AudioRenderer_OnWriteData](../../reference/apis-audio-kit/_o_h___audio_renderer___callbacks___struct.md#oh_audiorenderer_onwritedata)用于写入音频数据。 89 90 > **注意：** 91 > 92 > - 能填满回调所需长度数据的情况下，返回AUDIO_DATA_CALLBACK_RESULT_VALID，系统会取用完整长度的数据缓冲进行播放。请不要在未填满数据的情况下返回AUDIO_DATA_CALLBACK_RESULT_VALID，否则会导致杂音、卡顿等现象。 93 > 94 > - 在无法填满回调所需长度数据的情况下，建议开发者返回AUDIO_DATA_CALLBACK_RESULT_INVALID，系统不会处理该段音频数据，然后会再次向应用请求数据，确认数据填满后返回AUDIO_DATA_CALLBACK_RESULT_VALID。 95 > 96 > - 回调函数结束后，音频服务会把缓冲中数据放入队列里等待播放，因此请勿在回调外再次更改缓冲中的数据。对于最后一帧，如果数据不够填满缓冲长度，开发者需要使用剩余数据拼接空数据的方式，将缓冲填满，避免缓冲内的历史脏数据对播放效果产生不良的影响。 97 98 从API version 12开始可通过[OH_AudioStreamBuilder_SetFrameSizeInCallback](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostreambuilder_setframesizeincallback)设置audioDataSize的大小。 99 100 ```cpp 101 // 自定义写入数据函数。 102 static OH_AudioData_Callback_Result NewAudioRendererOnWriteData( 103 OH_AudioRenderer* renderer, 104 void* userData, 105 void* audioData, 106 int32_t audioDataSize) 107 { 108 // 将待播放的数据，按audioDataSize长度写入audioData。 109 // 如果开发者不希望播放某段audioData，返回AUDIO_DATA_CALLBACK_RESULT_INVALID即可。 110 return AUDIO_DATA_CALLBACK_RESULT_VALID; 111 } 112 // 自定义音频流事件函数。 113 int32_t MyOnStreamEvent( 114 OH_AudioRenderer* renderer, 115 void* userData, 116 OH_AudioStream_Event event) 117 { 118 // 根据event表示的音频流事件信息，更新播放器状态和界面。 119 return 0; 120 } 121 // 自定义音频中断事件函数。 122 int32_t MyOnInterruptEvent( 123 OH_AudioRenderer* renderer, 124 void* userData, 125 OH_AudioInterrupt_ForceType type, 126 OH_AudioInterrupt_Hint hint) 127 { 128 // 根据type和hint表示的音频中断信息，更新播放器状态和界面。 129 return 0; 130 } 131 // 自定义异常回调函数。 132 int32_t MyOnError( 133 OH_AudioRenderer* renderer, 134 void* userData, 135 OH_AudioStream_Result error) 136 { 137 // 根据error表示的音频异常信息，做出相应的处理。 138 return 0; 139 } 140 141 OH_AudioRenderer_Callbacks callbacks; 142 143 // 配置回调函数。 144 callbacks.OH_AudioRenderer_OnStreamEvent = MyOnStreamEvent; 145 callbacks.OH_AudioRenderer_OnInterruptEvent = MyOnInterruptEvent; 146 callbacks.OH_AudioRenderer_OnError = MyOnError; 147 callbacks.OH_AudioRenderer_OnWriteData = nullptr; 148 149 // 设置输出音频流的回调。 150 OH_AudioStreamBuilder_SetRendererCallback(builder, callbacks, nullptr); 151 152 // 配置写入音频数据回调函数。 153 OH_AudioRenderer_OnWriteDataCallback writeDataCb = NewAudioRendererOnWriteData; 154 OH_AudioStreamBuilder_SetRendererWriteDataCallback(builder, writeDataCb, nullptr); 155 ``` 156 157 - API version 11使用回调函数[OH_AudioRenderer_Callbacks_Struct.OH_AudioRenderer_OnWriteData](../../reference/apis-audio-kit/_o_h___audio_renderer___callbacks___struct.md#oh_audiorenderer_onwritedata)用于写入音频数据。 158 159 > **注意：** 160 > 161 > - 该函数不支持返回回调结果，系统默认回调中的数据均为有效数据。请确保填满回调所需长度数据，否则会导致杂音、卡顿等现象。 162 > 163 > - 在无法填满回调所需长度数据的情况下，建议开发者选择暂时停止写入数据（不暂停音频流），阻塞回调函数，等待数据充足时，再继续写入数据，确保数据填满。在阻塞回调函数后，如需调用AudioRenderer相关接口，需先解阻塞。 164 > 165 > - 开发者如果不希望播放本次回调中的音频数据，可以主动将回调中的数据块置空（置空后，也会被系统统计到已写入的数据，播放静音帧）。 166 > 167 > - 回调函数结束后，音频服务会把缓冲中数据放入队列里等待播放，因此请勿在回调外再次更改缓冲中的数据。对于最后一帧，如果数据不够填满缓冲长度，开发者需要使用剩余数据拼接空数据的方式，将缓冲填满，避免缓冲内的历史脏数据对播放效果产生不良的影响。 168 169 ```cpp 170 // 自定义写入数据函数。 171 int32_t MyOnWriteData( 172 OH_AudioRenderer* renderer, 173 void* userData, 174 void* buffer, 175 int32_t length) 176 { 177 // 将待播放的数据，按length长度写入buffer。 178 // 如果开发者不希望播放某段buffer，可在此处对buffer进行置空处理。 179 return 0; 180 } 181 // 自定义音频流事件函数。 182 int32_t MyOnStreamEvent( 183 OH_AudioRenderer* renderer, 184 void* userData, 185 OH_AudioStream_Event event) 186 { 187 // 根据event表示的音频流事件信息，更新播放器状态和界面。 188 return 0; 189 } 190 // 自定义音频中断事件函数。 191 int32_t MyOnInterruptEvent( 192 OH_AudioRenderer* renderer, 193 void* userData, 194 OH_AudioInterrupt_ForceType type, 195 OH_AudioInterrupt_Hint hint) 196 { 197 // 根据type和hint表示的音频中断信息，更新播放器状态和界面。 198 return 0; 199 } 200 // 自定义异常回调函数。 201 int32_t MyOnError( 202 OH_AudioRenderer* renderer, 203 void* userData, 204 OH_AudioStream_Result error) 205 { 206 // 根据error表示的音频异常信息，做出相应的处理。 207 return 0; 208 } 209 210 OH_AudioRenderer_Callbacks callbacks; 211 212 // 配置回调函数。 213 callbacks.OH_AudioRenderer_OnWriteData = MyOnWriteData; 214 callbacks.OH_AudioRenderer_OnStreamEvent = MyOnStreamEvent; 215 callbacks.OH_AudioRenderer_OnInterruptEvent = MyOnInterruptEvent; 216 callbacks.OH_AudioRenderer_OnError = MyOnError; 217 218 // 设置输出音频流的回调。 219 OH_AudioStreamBuilder_SetRendererCallback(builder, callbacks, nullptr); 220 ``` 221 222 为了避免不可预期的行为，在设置音频回调函数时，可以通过下面两种方式中的任意一种来设置音频回调函数： 223 224 - 请确保[OH_AudioRenderer_Callbacks](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiorenderer_callbacks)的每一个回调都被**自定义的回调方法**或**空指针**初始化。 225 226 ```cpp 227 // 自定义写入数据函数。 228 int32_t MyOnWriteData( 229 OH_AudioRenderer* renderer, 230 void* userData, 231 void* buffer, 232 int32_t length) 233 { 234 // 将待播放的数据，按length长度写入buffer。 235 return 0; 236 } 237 // 自定义音频中断事件函数。 238 int32_t MyOnInterruptEvent( 239 OH_AudioRenderer* renderer, 240 void* userData, 241 OH_AudioInterrupt_ForceType type, 242 OH_AudioInterrupt_Hint hint) 243 { 244 // 根据type和hint表示的音频中断信息，更新播放器状态和界面。 245 return 0; 246 } 247 248 OH_AudioRenderer_Callbacks callbacks; 249 250 // 配置回调函数，如果需要监听，则赋值。 251 callbacks.OH_AudioRenderer_OnWriteData = MyOnWriteData; 252 callbacks.OH_AudioRenderer_OnInterruptEvent = MyOnInterruptEvent; 253 254 // （必选）如果不需要监听，使用空指针初始化。 255 callbacks.OH_AudioRenderer_OnStreamEvent = nullptr; 256 callbacks.OH_AudioRenderer_OnError = nullptr; 257 ``` 258 259 - 使用前，初始化并清零结构体。 260 261 ```cpp 262 // 自定义写入数据函数。 263 int32_t MyOnWriteData( 264 OH_AudioRenderer* renderer, 265 void* userData, 266 void* buffer, 267 int32_t length) 268 { 269 // 将待播放的数据，按length长度写入buffer。 270 return 0; 271 } 272 // 自定义音频中断事件函数。 273 int32_t MyOnInterruptEvent( 274 OH_AudioRenderer* renderer, 275 void* userData, 276 OH_AudioInterrupt_ForceType type, 277 OH_AudioInterrupt_Hint hint) 278 { 279 // 根据type和hint表示的音频中断信息，更新播放器状态和界面。 280 return 0; 281 } 282 OH_AudioRenderer_Callbacks callbacks; 283 284 // 使用前，初始化并清零结构体。 285 memset(&callbacks, 0, sizeof(OH_AudioRenderer_Callbacks)); 286 287 // 配置需要的回调函数。 288 callbacks.OH_AudioRenderer_OnWriteData = MyOnWriteData; 289 callbacks.OH_AudioRenderer_OnInterruptEvent = MyOnInterruptEvent; 290 ``` 291 2924. 构造播放音频流。 293 294 ```cpp 295 OH_AudioRenderer* audioRenderer; 296 OH_AudioStreamBuilder_GenerateRenderer(builder, &audioRenderer); 297 ``` 298 2995. 使用音频流。 300 301 音频流包含下面接口，用来实现对音频流的控制。 302 303 | 接口 | 说明 | 304 | ------------------------------------------------------------ | ------------ | 305 | OH_AudioStream_Result OH_AudioRenderer_Start(OH_AudioRenderer* renderer) | 开始播放。 | 306 | OH_AudioStream_Result OH_AudioRenderer_Pause(OH_AudioRenderer* renderer) | 暂停播放。 | 307 | OH_AudioStream_Result OH_AudioRenderer_Stop(OH_AudioRenderer* renderer) | 停止播放。 | 308 | OH_AudioStream_Result OH_AudioRenderer_Flush(OH_AudioRenderer* renderer) | 释放缓存数据。 | 309 | OH_AudioStream_Result OH_AudioRenderer_Release(OH_AudioRenderer* renderer) | 释放播放实例。 | 310 3116. 释放构造器。 312 313 构造器不再使用时，需要释放相关资源。 314 315 ```cpp 316 OH_AudioStreamBuilder_Destroy(builder); 317 ``` 318 319## 设置音频流音量 320 321开发者可使用[OH_AudioRenderer_SetVolume](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiorenderer_setvolume)接口设置当前音频流音量值。 322 323```cpp 324// 要设置的音量值，音量值的范围是[0.0, 1.0]。 325float volume = 0.5f; 326 327// 设置当前音频流音量值。 328OH_AudioStream_Result OH_AudioRenderer_SetVolume(audioRenderer, volume); 329``` 330 331## 设置低时延模式 332 333当设备支持低时延通路且采样率设置为48000时，开发者可以使用低时延模式创建播放器，获得更高质量的音频体验。 334 335开发流程与普通播放场景一致，仅需要在创建音频流构造器时，调用[OH_AudioStreamBuilder_SetLatencyMode()](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostreambuilder_setlatencymode)设置低时延模式。 336 337> **注意：** 338> 当音频录制场景[OH_AudioStream_Usage](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostream_usage)为`AUDIOSTREAM_USAGE_VOICE_COMMUNICATION`和`AUDIOSTREAM_USAGE_VIDEO_COMMUNICATION`时，不支持主动设置低时延模式，系统会根据设备的能力，决策输出的音频通路。 339 340开发示例 341 342```cpp 343OH_AudioStreamBuilder_SetLatencyMode(builder, AUDIOSTREAM_LATENCY_MODE_FAST); 344``` 345 346## 设置音频声道布局 347 348播放音频文件时，可以通过设置音频的声道布局信息，指定渲染或播放时的扬声器摆位，使得渲染和播放效果更佳，获得更高质量的音频体验。 349 350开发流程与普通播放场景一致，仅需要在创建音频流构造器时，调用[OH_AudioStreamBuilder_SetChannelLayout()](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostreambuilder_setchannellayout)设置声道布局信息。 351 352当声道布局与声道数不匹配时，创建音频流会失败。建议在设置声道布局时，确认下发的声道布局信息是正确的。 353 354如果不知道准确的声道布局信息，或者开发者需要使用默认声道布局，可以不调用设置声道布局接口，或者下发CH_LAYOUT_UNKNOWN，以使用基于声道数的默认声道布局。 355 356对于HOA格式的音频，想要获得正确的渲染和播放效果，必须指定声道布局信息。 357 358开发示例 359 360```cpp 361OH_AudioStreamBuilder_SetChannelLayout(builder, CH_LAYOUT_STEREO); 362``` 363 364## 播放AudioVivid格式音源 365 366播放AudioVivid格式音频文件时，需要使用与普通播放不同的数据写入回调函数，该回调可以同时写入PCM数据与元数据。 367 368开发流程与普通播放场景一致，仅需要在创建音频流构造器时，调用[OH_AudioStreamBuilder_SetWriteDataWithMetadataCallback()](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostreambuilder_setwritedatawithmetadatacallback)设置PCM数据与元数据同时写入的回调函数，同时调用[OH_AudioStreamBuilder_SetEncodingType()](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostreambuilder_setencodingtype)设置编码类型为AUDIOSTREAM_ENCODING_TYPE_AUDIOVIVID。 369 370在播放AudioVivid时，帧长是固定的，不可通过[OH_AudioStreamBuilder_SetFrameSizeInCallback()](../../reference/apis-audio-kit/_o_h_audio.md#oh_audiostreambuilder_setframesizeincallback)设置回调帧长。同时，在设置播放声道数和声道布局时，需要将写入音源的声床数和对象数相加后进行设置。 371 372```cpp 373// 自定义同时写入PCM数据和元数据函数。 374int32_t MyOnWriteDataWithMetadata( 375 OH_AudioRenderer* renderer, 376 void* userData, 377 void* audioData, 378 int32_t audioDataSize, 379 void* metadata, 380 int32_t metadataSize) 381{ 382 // 将待播放的PCM数据和元数据，分别按audioDataSize和metadataSize写入buffer。 383 return 0; 384} 385 386// 设置编码类型。 387OH_AudioStreamBuilder_SetEncodingType(builder, AUDIOSTREAM_ENCODING_TYPE_AUDIOVIVID); 388// 配置回调函数。 389OH_AudioRenderer_WriteDataWithMetadataCallback metadataCallback = MyOnWriteDataWithMetadata; 390// 设置同时写入PCM数据和元数据的回调。 391OH_AudioStreamBuilder_SetWriteDataWithMetadataCallback(builder, metadataCallback, nullptr); 392``` 393 394## 相关实例 395 396针对OHAudio开发音频播放，有以下相关实例可供参考： 397 398- [OHAudio录制和播放](https://gitee.com/openharmony/applications_app_samples/tree/master/code/DocsSample/Media/Audio/OHAudio) 399 400<!--RP1--> 401<!--RP1End-->
