使用OpenSL ES开发音频播放功能

OpenSL ES全称为Open Sound Library for Embedded Systems,是一个嵌入式、跨平台、免费的音频处理库。为嵌入式移动多媒体设备上的应用开发者提供标准化、高性能、低延迟的API。OpenHarmony的Native API基于Khronos Group开发的OpenSL ES 1.0.1 API 规范实现,开发者可以通过<OpenSLES.h>和<OpenSLES_OpenHarmony.h>在OpenHarmony上使用相关API。

OpenHarmony上的OpenSL ES

OpenSL ES中提供了以下的接口,OpenHarmony当前仅实现了部分接口,可以实现音频播放的基础功能。

调用未实现接口后会返回**SL_RESULT_FEATURE_UNSUPPORTED,**当前没有相关扩展可以使用。

以下列表列举了OpenHarmony上已实现的OpenSL ES的接口,具体说明请参考OpenSL ES规范:

  • OpenHarmony上支持的Engine接口:

    • SLresult (*CreateAudioPlayer) (SLEngineItf self, SLObjectItf * pPlayer, SLDataSource *pAudioSrc, SLDataSink *pAudioSnk, SLuint32 numInterfaces, const SLInterfaceID * pInterfaceIds, const SLboolean * pInterfaceRequired)
    • SLresult (*CreateAudioRecorder) (SLEngineItf self, SLObjectItf * pRecorder, SLDataSource *pAudioSrc, SLDataSink *pAudioSnk, SLuint32 numInterfaces, const SLInterfaceID * pInterfaceIds, const SLboolean * pInterfaceRequired)
    • SLresult (*CreateOutputMix) (SLEngineItf self, SLObjectItf * pMix, SLuint32 numInterfaces, const SLInterfaceID * pInterfaceIds, const SLboolean * pInterfaceRequired)
  • OpenHarmony上支持的Object接口:

    • SLresult (*Realize) (SLObjectItf self, SLboolean async)
    • SLresult (*GetState) (SLObjectItf self, SLuint32 * pState)
    • SLresult (*GetInterface) (SLObjectItf self, const SLInterfaceID iid, void * pInterface)
    • void (*Destroy) (SLObjectItf self)
  • OpenHarmony上支持的Playback接口:

    • SLresult (*SetPlayState) (SLPlayItf self, SLuint32 state)
    • SLresult (*GetPlayState) (SLPlayItf self, SLuint32 *pState)
  • OpenHarmony上支持的Volume控制接口

    • SLresult (*SetVolumeLevel) (SLVolumeItf self, SLmillibel level)
    • SLresult (*GetVolumeLevel) (SLVolumeItf self, SLmillibel *pLevel)
    • SLresult (*GetMaxVolumeLevel) (SLVolumeItf self, SLmillibel *pMaxLevel)
  • OpenHarmony上支持的BufferQueue接口

    以下接口需引入<OpenSLES_OpenHarmony.h>使用。

接口 说明
SLresult (*Enqueue) (SLOHBufferQueueItf self, const void *buffer, SLuint32 size) 根据情况将buffer加到相应队列中。
如果是播放操作,则将带有音频数据的buffer插入到filledBufferQ_队列中;如果是录音操作,则将录音使用后的空闲buffer插入到freeBufferQ_队列中。
self:表示调用该函数的BufferQueue接口对象。
buffer:播放时表示带有音频数据的buffer,录音时表示已存储完录音数据后的空闲buffer。
size:表示buffer的大小。
SLresult (*Clear) (SLOHBufferQueueItf self) 释放BufferQueue接口对象。
self:表示调用该函数的BufferQueue接口对象将被释放。
SLresult (*GetState) (SLOHBufferQueueItf self, SLOHBufferQueueState *state) 获取BufferQueue接口对象状态。
self:表示调用该函数的BufferQueue接口对象。
state:BufferQueue的当前状态。
SLresult (*RegisterCallback) (SLOHBufferQueueItf self, SlOHBufferQueueCallback callback, void* pContext) 注册回调函数。
self:表示调用该函数的BufferQueue接口对象。
callback:播放/录音时注册的回调函数。
pContext:播放时传入待播放音频文件,录音时传入将要录制的音频文件。
SLresult (*GetBuffer) (SLOHBufferQueueItf self, SLuint8** buffer, SLuint32* size) 根据情况获取相应的buffer。
如果是播放操作,则从freeBufferQ_队列中获取空闲buffer;如果是录音操作,则从filledBufferQ_队列中获取携带录音数据的buffer。
self:表示调用该函数的BufferQueue接口对象。
buffer:播放时表示空闲的buffer,录音时表示携带录音数据的buffer。
size:表示buffer的大小。

完整示例

参考以下示例代码,播放一个音频文件。

  1. 添加头文件。

    #include <OpenSLES.h>
    #include <OpenSLES_OpenHarmony.h>
    #include <OpenSLES_Platform.h>
    
  2. 使用slCreateEngine接口和获取engine实例。

    SLObjectItf engineObject = nullptr;
    slCreateEngine(&engineObject, 0, nullptr, 0, nullptr, nullptr);
    (*engineObject)->Realize(engineObject, SL_BOOLEAN_FALSE);
    
  3. 获取接口SL_IID_ENGINE的engineEngine实例。

    SLEngineItf engineEngine = nullptr;
    (*engineObject)->GetInterface(engineObject, SL_IID_ENGINE, &engineEngine);
    
  4. 配置播放器信息,创建AudioPlayer。

    SLDataLocator_BufferQueue slBufferQueue = {
        SL_DATALOCATOR_BUFFERQUEUE,
        0
    };
    
    // 具体参数需要根据音频文件格式进行适配
    SLDataFormat_PCM pcmFormat = {
        SL_DATAFORMAT_PCM,
        2,                           // 通道数
        SL_SAMPLINGRATE_48,          // 采样率
        SL_PCMSAMPLEFORMAT_FIXED_16, // 音频采样格式
        0,
        0,
        0
    };
    SLDataSource slSource = {&slBufferQueue, &pcmFormat};
    SLObjectItf pcmPlayerObject = nullptr;
    (*engineEngine)->CreateAudioPlayer(engineEngine, &pcmPlayerObject, &slSource, null, 0, nullptr, nullptr);
    (*pcmPlayerObject)->Realize(pcmPlayerObject, SL_BOOLEAN_FALSE);
    
  5. 获取接口SL_IID_OH_BUFFERQUEUE的bufferQueueItf实例。

    SLOHBufferQueueItf bufferQueueItf;
    (*pcmPlayerObject)->GetInterface(pcmPlayerObject, SL_IID_OH_BUFFERQUEUE, &bufferQueueItf);
    
  6. 打开音频文件,注册BufferQueueCallback回调。

    static void BufferQueueCallback (SLOHBufferQueueItf bufferQueueItf, void *pContext, SLuint32 size)
    {
        SLuint8 *buffer = nullptr;
        SLuint32 pSize;
        (*bufferQueueItf)->GetBuffer(bufferQueueItf, &buffer, &pSize);
        // 将待播放音频数据写入buffer
        (*bufferQueueItf)->Enqueue(bufferQueueItf, buffer, size);
    }
    void *pContext; // 可传入自定义的上下文信息,会在Callback内收到
    (*bufferQueueItf)->RegisterCallback(bufferQueueItf, BufferQueueCallback, pContext);
    
  7. 获取接口SL_PLAYSTATE_PLAYING的playItf实例,开始播放。

    SLPlayItf playItf = nullptr;
    (*pcmPlayerObject)->GetInterface(pcmPlayerObject, SL_IID_PLAY, &playItf);
    (*playItf)->SetPlayState(playItf, SL_PLAYSTATE_PLAYING);
    
  8. 结束音频播放。

    (*playItf)->SetPlayState(playItf, SL_PLAYSTATE_STOPPED);
    (*pcmPlayerObject)->Destroy(pcmPlayerObject);
    (*engineObject)->Destroy(engineObject);