使用AudioRenderer开发音频播放功能

2024-02-16 13:53 更新

AudioRenderer是音频渲染器,用于播放PCM(Pulse Code Modulation)音频数据,相比AVPlayer而言,可以在输入前添加数据预处理,更适合有音频开发经验的开发者,以实现更灵活的播放功能。

开发指导

使用AudioRenderer播放音频涉及到AudioRenderer实例的创建、音频渲染参数的配置、渲染的开始与停止、资源的释放等。本开发指导将以一次渲染音频数据的过程为例,向开发者讲解如何使用AudioRenderer进行音频渲染,建议搭配AudioRenderer的API说明阅读。

下图展示了AudioRenderer的状态变化,在创建实例后,调用对应的方法可以进入指定的状态实现对应的行为。需要注意的是在确定的状态执行不合适的方法可能导致AudioRenderer发生错误,建议开发者在调用状态转换的方法前进行状态检查,避免程序运行产生预期以外的结果。

为保证UI线程不被阻塞,大部分AudioRenderer调用都是异步的。对于每个API均提供了callback函数和Promise函数,以下示例均采用callback函数。

图1 AudioRenderer状态变化示意图

在进行应用开发的过程中,建议开发者通过on('stateChange')方法订阅AudioRenderer的状态变更。因为针对AudioRenderer的某些操作,仅在音频播放器在固定状态时才能执行。如果应用在音频播放器处于错误状态时执行操作,系统可能会抛出异常或生成其他未定义的行为。

  • prepared状态: 通过调用createAudioRenderer()方法进入到该状态。
  • running状态: 正在进行音频数据播放,可以在prepared状态通过调用start()方法进入此状态,也可以在paused状态和stopped状态通过调用start()方法进入此状态。
  • paused状态: 在running状态可以通过调用pause()方法暂停音频数据的播放并进入paused状态,暂停播放之后可以通过调用start()方法继续音频数据播放。
  • stopped状态: 在paused/running状态可以通过stop()方法停止音频数据的播放。
  • released状态: 在prepared、paused、stopped等状态,用户均可通过release()方法释放掉所有占用的硬件和软件资源,并且不会再进入到其他的任何一种状态了。

开发步骤及注意事项

  1. 配置音频渲染参数并创建AudioRenderer实例,音频渲染参数的详细信息可以查看AudioRendererOptions
    1. import audio from '@ohos.multimedia.audio';
    2. let audioStreamInfo = {
    3. samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
    4. channels: audio.AudioChannel.CHANNEL_1,
    5. sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE,
    6. encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW
    7. };
    8. let audioRendererInfo = {
    9. content: audio.ContentType.CONTENT_TYPE_SPEECH,
    10. usage: audio.StreamUsage.STREAM_USAGE_VOICE_COMMUNICATION,
    11. rendererFlags: 0
    12. };
    13. let audioRendererOptions = {
    14. streamInfo: audioStreamInfo,
    15. rendererInfo: audioRendererInfo
    16. };
    17. audio.createAudioRenderer(audioRendererOptions, (err, data) => {
    18. if (err) {
    19. console.error(`Invoke createAudioRenderer failed, code is ${err.code}, message is ${err.message}`);
    20. return;
    21. } else {
    22. console.info('Invoke createAudioRenderer succeeded.');
    23. let audioRenderer = data;
    24. }
    25. });
  2. 调用start()方法进入running状态,开始渲染音频。
    1. audioRenderer.start((err) => {
    2. if (err) {
    3. console.error(`Renderer start failed, code is ${err.code}, message is ${err.message}`);
    4. } else {
    5. console.info('Renderer start success.');
    6. }
    7. });
  3. 指定待渲染文件地址,打开文件调用write()方法向缓冲区持续写入音频数据进行渲染播放。如果需要对音频数据进行处理以实现个性化的播放,在写入之前操作即可。
    1. const bufferSize = await audioRenderer.getBufferSize();
    2. let file = fs.openSync(filePath, fs.OpenMode.READ_ONLY);
    3. let buf = new ArrayBuffer(bufferSize);
    4. let readsize = await fs.read(file.fd, buf);
    5. let writeSize = await new Promise((resolve, reject) => {
    6. audioRenderer.write(buf, (err, writeSize) => {
    7. if (err) {
    8. reject(err);
    9. } else {
    10. resolve(writeSize);
    11. }
    12. });
    13. });
  4. 调用stop()方法停止渲染。
    1. audioRenderer.stop((err) => {
    2. if (err) {
    3. console.error(`Renderer stop failed, code is ${err.code}, message is ${err.message}`);
    4. } else {
    5. console.info('Renderer stopped.');
    6. }
    7. });
  5. 调用release()方法销毁实例,释放资源。
    1. audioRenderer.release((err) => {
    2. if (err) {
    3. console.error(`Renderer release failed, code is ${err.code}, message is ${err.message}`);
    4. } else {
    5. console.info('Renderer released.');
    6. }
    7. });

完整示例

下面展示了使用AudioRenderer渲染音频文件的示例代码。
  1. import audio from '@ohos.multimedia.audio';
  2. import fs from '@ohos.file.fs';
  3. const TAG = 'AudioRendererDemo';
  4. export default class AudioRendererDemo {
  5. private renderModel = undefined;
  6. private audioStreamInfo = {
  7. samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_48000, // 采样率
  8. channels: audio.AudioChannel.CHANNEL_2, // 通道
  9. sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE, // 采样格式
  10. encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW // 编码格式
  11. }
  12. private audioRendererInfo = {
  13. content: audio.ContentType.CONTENT_TYPE_MUSIC, // 媒体类型
  14. usage: audio.StreamUsage.STREAM_USAGE_MEDIA, // 音频流使用类型
  15. rendererFlags: 0 // 音频渲染器标志
  16. }
  17. private audioRendererOptions = {
  18. streamInfo: this.audioStreamInfo,
  19. rendererInfo: this.audioRendererInfo
  20. }
  21. // 初始化,创建实例,设置监听事件
  22. init() {
  23. audio.createAudioRenderer(this.audioRendererOptions, (err, renderer) => { // 创建AudioRenderer实例
  24. if (!err) {
  25. console.info(`${TAG}: creating AudioRenderer success`);
  26. this.renderModel = renderer;
  27. this.renderModel.on('stateChange', (state) => { // 设置监听事件,当转换到指定的状态时触发回调
  28. if (state == 2) {
  29. console.info('audio renderer state is: STATE_RUNNING');
  30. }
  31. });
  32. this.renderModel.on('markReach', 1000, (position) => { // 订阅markReach事件,当渲染的帧数达到1000帧时触发回调
  33. if (position == 1000) {
  34. console.info('ON Triggered successfully');
  35. }
  36. });
  37. } else {
  38. console.info(`${TAG}: creating AudioRenderer failed, error: ${err.message}`);
  39. }
  40. });
  41. }
  42. // 开始一次音频渲染
  43. async start() {
  44. let stateGroup = [audio.AudioState.STATE_PREPARED, audio.AudioState.STATE_PAUSED, audio.AudioState.STATE_STOPPED];
  45. if (stateGroup.indexOf(this.renderModel.state) === -1) { // 当且仅当状态为prepared、paused和stopped之一时才能启动渲染
  46. console.error(TAG + 'start failed');
  47. return;
  48. }
  49. await this.renderModel.start(); // 启动渲染
  50. const bufferSize = await this.renderModel.getBufferSize();
  51. let context = getContext(this);
  52. let path = context.filesDir;
  53. const filePath = path + '/test.wav'; // 使用沙箱路径获取文件,实际路径为/data/storage/el2/base/haps/entry/files/test.wav
  54. let file = fs.openSync(filePath, fs.OpenMode.READ_ONLY);
  55. let stat = await fs.stat(filePath);
  56. let buf = new ArrayBuffer(bufferSize);
  57. let len = stat.size % bufferSize === 0 ? Math.floor(stat.size / bufferSize) : Math.floor(stat.size / bufferSize + 1);
  58. for (let i = 0; i < len; i++) {
  59. let options = {
  60. offset: i * bufferSize,
  61. length: bufferSize
  62. };
  63. let readsize = await fs.read(file.fd, buf, options);
  64. // buf是要写入缓冲区的音频数据,在调用AudioRenderer.write()方法前可以进行音频数据的预处理,实现个性化的音频播放功能,AudioRenderer会读出写入缓冲区的音频数据进行渲染
  65. let writeSize = await new Promise((resolve, reject) => {
  66. this.renderModel.write(buf, (err, writeSize) => {
  67. if (err) {
  68. reject(err);
  69. } else {
  70. resolve(writeSize);
  71. }
  72. });
  73. });
  74. if (this.renderModel.state === audio.AudioState.STATE_RELEASED) { // 如果渲染器状态为released,停止渲染
  75. fs.close(file);
  76. await this.renderModel.stop();
  77. }
  78. if (this.renderModel.state === audio.AudioState.STATE_RUNNING) {
  79. if (i === len - 1) { // 如果音频文件已经被读取完,停止渲染
  80. fs.close(file);
  81. await this.renderModel.stop();
  82. }
  83. }
  84. }
  85. }
  86. // 暂停渲染
  87. async pause() {
  88. // 只有渲染器状态为running的时候才能暂停
  89. if (this.renderModel.state !== audio.AudioState.STATE_RUNNING) {
  90. console.info('Renderer is not running');
  91. return;
  92. }
  93. await this.renderModel.pause(); // 暂停渲染
  94. if (this.renderModel.state === audio.AudioState.STATE_PAUSED) {
  95. console.info('Renderer is paused.');
  96. } else {
  97. console.error('Pausing renderer failed.');
  98. }
  99. }
  100. // 停止渲染
  101. async stop() {
  102. // 只有渲染器状态为running或paused的时候才可以停止
  103. if (this.renderModel.state !== audio.AudioState.STATE_RUNNING && this.renderModel.state !== audio.AudioState.STATE_PAUSED) {
  104. console.info('Renderer is not running or paused.');
  105. return;
  106. }
  107. await this.renderModel.stop(); // 停止渲染
  108. if (this.renderModel.state === audio.AudioState.STATE_STOPPED) {
  109. console.info('Renderer stopped.');
  110. } else {
  111. console.error('Stopping renderer failed.');
  112. }
  113. }
  114. // 销毁实例,释放资源
  115. async release() {
  116. // 渲染器状态不是released状态,才能release
  117. if (this.renderModel.state === audio.AudioState.STATE_RELEASED) {
  118. console.info('Renderer already released');
  119. return;
  120. }
  121. await this.renderModel.release(); // 释放资源
  122. if (this.renderModel.state === audio.AudioState.STATE_RELEASED) {
  123. console.info('Renderer released');
  124. } else {
  125. console.error('Renderer release failed.');
  126. }
  127. }
  128. }

当同优先级或高优先级音频流要使用输出设备时,当前音频流会被中断,应用可以自行响应中断事件并做出处理。具体的音频并发处理方式可参考多音频播放的并发策略

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号