Android SoundPool音频池

1. 简介

SoundPool是Android 提供的一个API类，用来播放简短的音频，使用简单但功能相对强大。处于”android.media.SoundPool”包下，适合短促且对反应速度比较高的情况（游戏音效或按键声等）。支持从程序的资源或文件系统加载，通过资源ID来管理。

SoundPool可以加载多个音频资源到内存，进行管理与播放，比如控制同时播放流的最大数目，另外还可以调节左右声道的音量值、调整播放的语速、声音的品质、设置播放的优先级以及播放的次数等等。

相较于在Android中播放音频文件经常会用到的MediaPlayer，后者存在一些不足的地方，如：

  • 资源占用量较高
  • 加载延迟时间较长
  • 不支持多个音频同时播放等。

这些缺点决定了MediaPlayer在某些需要密集使用不同音频的情况不会理想，例如游戏开发。

2. 创建SoundPool

SoundPool 的创建方式在不同版本中会有所不同,为了更好的兼容性,应该对api版本进行判断( API level 21),

1
if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.LOLLIPOP)

再对应的进行创建. 在 5.0 以前 ，直接使用它的构造方法即可，而在这之后，则需要使用Builder模式来创建。

2.1 Andoroid 5.0之前

接通过SoundPool的构造方法来创建,有三个参数:

1
2
3
4
public SoundPool(int maxStream, int streamType, int srcQuality) 
 * maxStream —— 同时播放的流的最大数量，当播放的流的数目大于此值，则会选择性停止优先级较低的流
 * streamType —— 声音的类型，一般为AudioManager.STREAM_MUSIC(具体在AudioManager类中列出)
 * srcQuality —— 采样率转化质量，当前无效果，使用0作为默认值

初始化一个实例,创建了一个最多支持5个流同时播放的，类型标记为音乐的SoundPool：

1
SoundPool soundPool = new SoundPool(5, AudioManager.STREAM_MUSIC, 0);

2.2 Android 5.0（含）之后

使用Builder模式进行构造。

1
public SoundPool.Builder().***.build()

1
Constructs a new Builder with the defaults format values. If not provided, the maximum number of streams is 1 (see setMaxStreams(int) to change it), and the audio attributes have a usage value of AudioAttributes.USAGE_MEDIA (see setAudioAttributes(AudioAttributes) to change them).

示例如下

1
2
3
4
5
6
7
8
9
10
AudioAttributes audioAttributes = null;
audioAttributes = new AudioAttributes.Builder()
	                  .setUsage(AudioAttributes.USAGE_MEDIA)
	                  .setContentType(AudioAttributes.CONTENT_TYPE_MUSIC)
	                  .build();
                      
mSoundPool = new SoundPool.Builder()
	                  .setMaxStreams(16)
	                  .setAudioAttributes(audioAttributes)
	                  .build();

Builder可以设置多个参数

1
2
1. setMaxStreams和之前maxStreams参数相同.
2. setAudioAttributes用来设置audio 属性，此值要么不设，要么设置不为null的值，否则会导致异常产生

AudioAttributes也是使用Builder模式来构造的

1
2
1. setUsage用来设置用途(比如是游戏还是媒体还是响铃等)
2. setContentType用来设置内容类型(比如是视频还是音乐)

3. 设置监听函数

创建完 SoundPool 后,通过SoundPool的一个装载完成的监听事件SoundPool.setOnLoadCompleteListener来保证装载完成在播放声音。这主要是为了播放做准备.通过名字可猜测到, 当音频资源加载完成后,会回调设置的监听的onLoadComplete方法, 在这个方法里, 可以进行播放音频

1
mSoundPool.setOnLoadCompleteListener(this);

SoundPool.setOnLoadCompleteListener()需要实现一个SoundPool.OnLoadCompleteListener接口，其中需要实现onLoadComplete()方法，
以下是onLoadComplete()方法的完整声明：

1
2
3
4
onLoadComplete(SoundPool soundPool, int sampleId, int status)
 * soundPool：当前触发事件的声音池。
 * sampleId：当前装载完成的音频资源在音频池中的ID。
 * status：状态码，展示没有意义，为预留参数，会传递0。

4. 加载音频资源

可以通过四种途径来记载一个音频资源：

  1. 通过一个AssetFileDescriptorassert文件描述符

    1
    int load(AssetFileDescriptor afd, int priority)

  2. 通过一个资源ID

    1
    int load(Context context, int resId, int priority)

  3. 通过指定的路径加载

    1
    int load(String path, int priority)

  4. 通过FileDescriptor文件描述符加载

    1
    int load(FileDescriptor fd, long offset, long length, int priority)

加载 fd 所对应的文件的offset开始、长度为length的声音

1
2
* 上面4个方法中都有一个`priority`参数，该参数目前还没有任何作用，Android建议将该参数设为1，保持和未来的兼容性。 
* 上面4个方法加载声音之后，都会返回该声音的的ID，以后程序就可以通过该声音的ID 来播放指定声音。

一个SoundPool能同时管理多个音频，所以可以通过多次调用load函数来记载，如果记载成功将返回一个非0的soundID，用于播放时指定特定的音频。

1
2
3
4
5
6
7
8
int soundID1 = soundPool.load(this, R.raw.sound1, 1);
 if(soundID1 ==0){
     // 加载失败
}else{
    // 加载成功
}
int soundID2 = soundPool.load(this, R.raw.sound2, 1);
...

这里加载了两个流，并分别记录了返回的soundID。

流的加载过程是一个异步处理过程，真正播放要等回调函数onLoadComplete表明加载完成，之后即可播放加载的音频。

5. 播放控制

有以下几个函数可用于控制播放：

  1. 播放指定音频的音效，并返回一个streamID 。

    1
    2
    3
    4
    5
    6
    final int play(int soundID, float leftVolume, float rightVolume, int priority, int loop, float rate) 
     * soundID参数为资源ID
     * leftVolume和rightVolume个参数为左右声道的音量，从大到小取0.0f~1.0f之间的值
     * priority 流的优先级，值越大优先级高，影响当同时播放数量超出了最大支持数时SoundPool对该流的处理；
     * loop 循环播放的次数，0为值播放一次，-1为无限循环，其他值为播放loop+1次（例如，3为一共播放4次）.
     * rate 播放的速率，范围0.5-2.0(0.5为一半速率，1.0为正常速率，2.0为两倍速率)

  2. 暂停指定播放流的音效（streamID 应通过play()返回）。

    1
    final void pause(int streamID)

  3. 继续播放指定播放流的音效（streamID 应通过play()返回）。 

    1
    final void resume(int streamID)

  4. 终止指定播放流的音效（streamID 应通过play()返回）。

    1
    final void stop(int streamID)

这里需要注意的是，

  1. play()函数传递的是一个load()返回的soundID——指向一个被记载的音频资源 ，如果播放成功则返回一个非0的streamID——指向一个成功播放的流 ；同一个soundID可以通过多次调用play()而获得多个不同的streamID (只要不超出同时播放的最大数量)；
  2. pause()、resume()和stop()是针对播放流操作的，传递的是play()返回的streamID;
  3. play()中的priority参数，只在同时播放的流的数量超过了预先设定的最大数量是起作用，管理器将自动终止优先级低的播放流。如果存在多个同样优先级的流，再进一步根据其创建事件来处理，新创建的流的年龄是最小的，将被终止；
  4. 无论如何，程序退出时，手动终止播放并释放资源是必要的。

6. 更多属性设置

其实就是paly()中的一些参数的独立设置：

  1. 设置指定播放流的循环.

    1
    final void setLoop(int streamID, int loop)

  2. 设置指定播放流的音量.

    1
    final void setVolume(int streamID, float leftVolume, float rightVolume)

  3. 设置指定播放流的优先级，上面已说明priority的作用.

    1
    final void setPriority(int streamID, int priority)

  4. 设置指定播放流的速率，0.5-2.0.

    1
    final void setRate(int streamID, float rate)

7. 释放资源

可操作的函数有：

1
final boolean unload(int soundID)

卸载一个指定的音频资源.

1
final void release()

释放SoundPool中的所有音频资源.

8. SoundPool的注意事项

  1. 虽然SoundPool可以装载多个音频资源，但是最大只能申请1MB的内存空间，这就意味着只能用使用它播放一些很短的声音片段，而不是用它来播放歌曲或者做游戏背景音乐。可以修改音频码率来压缩音频大小，把 128kbps改成32kbps。
  2. SoundPool提供的pause()、resume()、stop()最好不要轻易使用，因为它有时候会使程序莫名其妙的终止，如果使用，最好做大量的测试。而且有时候也不会立即终止播放声音，而是会等缓冲区的音频数据播放完才会停止。
  3. 虽然SoundPool比MediaPlayer的效率好，但也不是绝对不存在延迟的问题，尤其在那些性能不太好的手机中，SoundPool的延迟问题会更严重，但是现在一般的手机配置，那一点的延迟还是可以接受的。
  4. 因为android系统一个设备只允许同时有32个音效文件播放，所以要你在程序中控制同时播放的音频数。并且在Activity被覆盖到下面或者锁屏时对资源进行回收，即调用Soundpool对象的Release（）方法。
  5. 每次播放一次，soundpool.play方法有个参数是控制重复播放次数的，将之设置为0，即只播放一次

参考文献

Android 音频播放之SoundPool的使用和封装
Android–SoundPool
Android SoundPool 的使用
Android音频播放之SoundPool 详解
/developer.android: SoundPool