Cocos2dx 学习笔记27 SimpleAudioEngine

在Cocos2dx中，声音播放由SimpleAudioEngine类来处理。

在游戏中，我们把声音分为两类。第一类是音乐，这种类型的声音通常长度较长，适合作为环境音乐（例如游戏的背景音乐）。由于它的长度较长，同一时刻通常只能播放一首音乐。第二类是音效，它的特点是长度很短，但是可以同时播放多个音效，拥有很强的表现力。

在游戏开发中，我们可以十分方便地启用CocosDenshion音效引擎库。CocosDenshion位于Cocos2d-x目录下的"CocosDenshion"目录中。通常，Cocos2d-x项目已经包含了CocosDenshion库，当我们需要使用音效引擎时，把引擎头文件引进来即可。
CocosDenshion实现了简单易用的SimpleAudioEngine类。为了使用音效引擎，我们只要引入它的头文件即可：

[cpp]  view plain copy

1. #include "SimpleAudioEngine.h"  

CocosDenshion移植自Cocos2d-iPhone中的同名库。实际上，Cocos2d-iPhone中的CocosDenshion实现了3个音效引擎，由底层到高级分别是CDSoundEngine、CDAudioManager和SimpleAudioEngine，其中前两个较为底层的引擎用于高级音频的开发，例如实现3D混音等。然而，对于普通开发者而言，SimpleAudioEngine已经足以满足大部分游戏开发的需求了。底层的音效引擎封装自OpenAL音频接口，从而实现了十分灵活、高效的音频回放引擎。然而，OpenAL只能被OS X（包括iOS）平台支持，其他平台下是没有类似接口的，因此Cocos2d-x不得不舍弃CDSoundEngine和CDAudioManager这两个底层引擎，只保留了最常用的SimpleAudioEngine。

CocosDenshion引擎库实际上是对系统音频API的封装，因此它支持的音频文件格式与平台有关。

支持平台与格式

CocosDesion支持的音乐格式如下：

平台	支持的常见文件格式	备注
Android	mp3, mid, oggg, wav	可以播放android.media.MediaPlayer所支持的所有格式
iOS	aac, caf, mp3, m4a, wav	可以播放AVAudioPlayer所支持的所有格式
Windows	mid, mp3, wav	无

CocosDesion支持的音效格式如下：

平台	支持的常见文件格式	备注
Android	oggg, wav	对wav的支持不完美
iOS	caf, m4a	可以播放Cocos2d-iPhone CocosDesion所支持的所有格式
Windows	mid, wav	无

在官方提供的TestCpp的声音例子CocosDenshionTest中我们可以看到。可以预先定义一些宏来管理声音资源：

// android effect only support ogg
#if (CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID)
    #define EFFECT_FILE        "effect2.ogg"
#elif( CC_TARGET_PLATFORM == CC_PLATFORM_MARMALADE)
    #define EFFECT_FILE        "effect1.raw"
#else
    #define EFFECT_FILE        "effect1.wav"
#endif // CC_PLATFORM_ANDROID

#if (CC_TARGET_PLATFORM == CC_PLATFORM_WIN32)
    #define MUSIC_FILE        "music.mid"
#elif (CC_TARGET_PLATFORM == CC_PLATFORM_BLACKBERRY || CC_TARGET_PLATFORM == CC_PLATFORM_LINUX )
    #define MUSIC_FILE        "background.ogg"
#elif (CC_TARGET_PLATFORM == CC_PLATFORM_WP8)
    #define MUSIC_FILE        "background.wav"
#else
    #define MUSIC_FILE        "background.mp3"
#endif // CC_PLATFORM_WIN32

其次SimpleAudioEngine被设计成了单例类，所以我们只需要在播放音乐的地方调用相关函数即可，提供了如下函数供我们使用：

预加载

加载音乐和音效通常是个耗时间的过程，因此为了防止由加载产生的延时导致实际播放与游戏播放不协调的现象。在播放音效和音乐前，需要预加载音乐文件。

通常我们会在进入场景前调用以下两个方法来预加载文件：

void SimpleAudioEngine::preloadBackgroundMusic(const char* pszFilePath);

void SimpleAudioEngine::preloadEffect(const char* pszFilePath);

因为SimpleAudioEngine与许多Cocos2d-x的部件一样，是一个单例类。所以当我们使用以上两个接口时，可以使用以下代码访问其实例：

SimpleAudioEngine::getInstance()->preloadBackgroundMusic( MUSIC_FILE );

SimpleAudioEngine::getInstance()->preloadEffect( EFFECT_FILE );

播放与停止

音频引擎提供了播放与停止的接口，以下介绍相应接口和使用方法：

virtual void playBackgroundMusic(const char* pszFilePath, bool bLoop = false); //播放背景音乐，bLoop表示是否要循环播放
virtual unsigned int playEffect(const char* pszFilePath, bool bLoop = false,
                                    float pitch = 1.0f, float pan = 0.0f, float gain = 1.0f); //播放音效，bLoop表示是否要循环播放
virtual void stopBackgroundMusic(bool bReleaseData = false); //停止背景音乐
virtual void stopEffect(unsigned int nSoundId); //停止指定音效，nSoundId为音效编号
virtual void stopAllEffects(); //停止所有音效

使用方法：

SimpleAudioEngine::getInstance()->playBackgroundMusic(MUSIC_FILE, true); //播放背景音乐
SimpleAudioEngine::getInstance()->stopBackgroundMusic(); //停止背景音乐
SimpleAudioEngine::getInstance()->stopEffect(_soundId); //停止音效

暂停和恢复

当游戏进入后台时，通常需要暂停播放音乐，当游戏恢复前台运行时，再继续播放音乐。以下介绍几个相关接口以及用法：

virtual void pauseBackgroundMusic(); //暂停背景音乐
virtual void pauseEffect(unsigned int nSoundId); //暂停指定音效，nSoundId为音效编号
virtual void pauseAllEffects(); //暂停所以音效
virtual void resumeBackgroundMusic(); //恢复背景音乐
virtual void resumeEffect(unsigned int nSoundId); //恢复指定音效，nSoundId为音效编号
virtual void resumeAllEffects(); //恢复所有音效

使用方法：

SimpleAudioEngine::getInstance()->pauseEffect(_soundId); //暂停编号为_soundId的音效
SimpleAudioEngine::getInstance()->resumeEffect(_soundId); //恢复编号为_soundId的音效
SimpleAudioEngine::getInstance()->pauseAllEffects(); //暂停所有音效
SimpleAudioEngine::getInstance()->resumeAllEffects(); //恢复所有音效

其他成员

除了以上介绍的方法外，Cocos2d-x还提供了便捷的控制方法与属性：

virtual void setBackgroundMusicVolume(float volume); //设置背景音乐音量
virtual void setEffectsVolume(float volume); //设置音效音量
virtual void rewindBackgroundMusic(); //重新播放背景音乐
virtual bool isBackgroundMusicPlaying(); //返回一个值，表示是否在播放背景音乐

预加载

加载音乐和音效通常是个耗时间的过程，因此为了防止由加载产生的延时导致实际播放与游戏播放不协调的现象。在播放音效和音乐前，需要预加载音乐文件。

通常我们会在进入场景前调用以下两个方法来预加载文件：

void SimpleAudioEngine::preloadBackgroundMusic(const char* pszFilePath);

void SimpleAudioEngine::preloadEffect(const char* pszFilePath);

因为SimpleAudioEngine与许多Cocos2d-x的部件一样，是一个单例类。所以当我们使用以上两个接口时，可以使用以下代码访问其实例：

SimpleAudioEngine::getInstance()->preloadBackgroundMusic( MUSIC_FILE );

SimpleAudioEngine::getInstance()->preloadEffect( EFFECT_FILE );

播放与停止

音频引擎提供了播放与停止的接口，以下介绍相应接口和使用方法：

virtual void playBackgroundMusic(const char* pszFilePath, bool bLoop = false); //播放背景音乐，bLoop表示是否要循环播放
virtual unsigned int playEffect(const char* pszFilePath, bool bLoop = false,
                                    float pitch = 1.0f, float pan = 0.0f, float gain = 1.0f); //播放音效，bLoop表示是否要循环播放
virtual void stopBackgroundMusic(bool bReleaseData = false); //停止背景音乐
virtual void stopEffect(unsigned int nSoundId); //停止指定音效，nSoundId为音效编号
virtual void stopAllEffects(); //停止所有音效

使用方法：

SimpleAudioEngine::getInstance()->playBackgroundMusic(MUSIC_FILE, true); //播放背景音乐
SimpleAudioEngine::getInstance()->stopBackgroundMusic(); //停止背景音乐
SimpleAudioEngine::getInstance()->stopEffect(_soundId); //停止音效

暂停和恢复

当游戏进入后台时，通常需要暂停播放音乐，当游戏恢复前台运行时，再继续播放音乐。以下介绍几个相关接口以及用法：

virtual void pauseBackgroundMusic(); //暂停背景音乐
virtual void pauseEffect(unsigned int nSoundId); //暂停指定音效，nSoundId为音效编号
virtual void pauseAllEffects(); //暂停所以音效
virtual void resumeBackgroundMusic(); //恢复背景音乐
virtual void resumeEffect(unsigned int nSoundId); //恢复指定音效，nSoundId为音效编号
virtual void resumeAllEffects(); //恢复所有音效

使用方法：

SimpleAudioEngine::getInstance()->pauseEffect(_soundId); //暂停编号为_soundId的音效
SimpleAudioEngine::getInstance()->resumeEffect(_soundId); //恢复编号为_soundId的音效
SimpleAudioEngine::getInstance()->pauseAllEffects(); //暂停所有音效
SimpleAudioEngine::getInstance()->resumeAllEffects(); //恢复所有音效

其他成员

除了以上介绍的方法外，Cocos2d-x还提供了便捷的控制方法与属性：

virtual void setBackgroundMusicVolume(float volume); //设置背景音乐音量
virtual void setEffectsVolume(float volume); //设置音效音量
virtual void rewindBackgroundMusic(); //重新播放背景音乐
virtual bool isBackgroundMusicPlaying(); //返回一个值，表示是否在播放背景音乐