axmol/CocosDenshion/android/opensl/OpenSLEngine.cpp

#include "OpenSLEngine.h"

#define LOGD(...) __android_log_print(ANDROID_LOG_DEBUG,"OPENSL_ENGINE.CPP", __VA_ARGS__)

using namespace std;


OpenSLEngine::OpenSLEngine()
 :m_musicVolume(0),
  m_effectVolume(0)
{}

OpenSLEngine::~OpenSLEngine()
{
	closeEngine();
}

/**********************************************************************************
 *   jni
 **********************************************************************************/
#define  CLASS_NAME "org/cocos2dx/lib/Cocos2dxActivity"

typedef struct JniMethodInfo_
{
	JNIEnv *    env;
	jclass      classID;
	jmethodID   methodID;
} JniMethodInfo;

extern "C" {
	static JNIEnv* getJNIEnv(void)
	{

		JavaVM* jvm = cocos2d::JniHelper::getJavaVM();
		if (NULL == jvm) {
			LOGD("Failed to get JNIEnv. JniHelper::getJavaVM() is NULL");
			return NULL;
		}

		JNIEnv *env = NULL;
		// get jni environment
		jint ret = jvm->GetEnv((void**)&env, JNI_VERSION_1_4);

		switch (ret) {
		case JNI_OK :
			// Success!
			return env;

		case JNI_EDETACHED :
			// Thread not attached

			// TODO : If calling AttachCurrentThread() on a native thread
			// must call DetachCurrentThread() in future.
			// see: http://developer.android.com/guide/practices/design/jni.html

			if (jvm->AttachCurrentThread(&env, NULL) < 0)
			{
				LOGD("Failed to get the environment using AttachCurrentThread()");
				return NULL;
			} else {
				// Success : Attached and obtained JNIEnv!
				return env;
			}

		case JNI_EVERSION :
			// Cannot recover from this error
			LOGD("JNI interface version 1.4 not supported");
		default :
			LOGD("Failed to get the environment using GetEnv()");
			return NULL;
		}
	}

	static jclass getClassID(JNIEnv *pEnv)
	{
		jclass ret = pEnv->FindClass(CLASS_NAME);
		if (! ret)
		{
			LOGD("Failed to find class of %s", CLASS_NAME);
		}

		return ret;
	}

	static bool getStaticMethodInfo(JniMethodInfo &methodinfo, const char *methodName, const char *paramCode)
	{
		jmethodID methodID = 0;
		JNIEnv *pEnv = 0;
		bool bRet = false;

		do 
		{
			pEnv = getJNIEnv();
			if (! pEnv)
			{
				break;
			}

			jclass classID = getClassID(pEnv);

			methodID = pEnv->GetStaticMethodID(classID, methodName, paramCode);
			if (! methodID)
			{
				LOGD("Failed to find static method id of %s", methodName);
				break;
			}

			methodinfo.classID = classID;
			methodinfo.env = pEnv;
			methodinfo.methodID = methodID;

			bRet = true;
		} while (0);

		return bRet;
	}
};


/*********************************************************************************
 *   helper
 ********************************************************************************/
#define FILE_NOT_FOUND -1
#define ASSET_MANAGER_GETTER "getAssetManager"

struct AudioPlayer
{
	AAsset* Asset;
	SLDataSource audioSrc;
	SLObjectItf fdPlayerObject;
	SLPlayItf fdPlayerPlay;
	SLSeekItf fdPlayerSeek;
	SLVolumeItf fdPlayerVolume;
} musicPlayer; /* for background music */

typedef map<unsigned int, AudioPlayer *> EffectList;
typedef pair<unsigned int, AudioPlayer *> Effect;

static EffectList& sharedList()
{
	static EffectList s_List;
	return s_List;
}

unsigned int _Hash(const char *key)
{
	unsigned int len = strlen(key);
	const char *end=key+len;
	unsigned int hash;

	for (hash = 0; key < end; key++)
	{
		hash *= 16777619;
		hash ^= (unsigned int) (unsigned char) toupper(*key);
	}
	return (hash);
}

int getFileDescriptor(AudioPlayer * player, const char * filename, off_t & start, off_t & length)
{
	JniMethodInfo methodInfo;
	if (! getStaticMethodInfo(methodInfo, ASSET_MANAGER_GETTER, "()Landroid/content/res/AssetManager;"))
	{
		return FILE_NOT_FOUND;
	}
	jobject assetManager = methodInfo.env->CallStaticObjectMethod(methodInfo.classID, methodInfo.methodID);
	methodInfo.env->DeleteLocalRef(methodInfo.classID);

	AAssetManager* mgr = AAssetManager_fromJava(methodInfo.env, assetManager);
	assert(NULL != mgr);
	player->Asset = AAssetManager_open(mgr, filename, AASSET_MODE_UNKNOWN);

	if (player->Asset == NULL)
	{
		LOGD("file not found! Stop preload file: %s", filename);
		return FILE_NOT_FOUND;
	}

	// open asset as file descriptor
	int fd = AAsset_openFileDescriptor(player->Asset, &start, &length);
	assert(0 <= fd);
	AAsset_close(player->Asset);

	return fd;
}


/**********************************************************************************
 *   engine
 **********************************************************************************/
static SLObjectItf engineObject = NULL;
static SLEngineItf engineEngine;
static SLObjectItf outputMixObject = NULL;

bool initAudioPlayer(AudioPlayer* player, const char* filename) 
{
	// configure audio sink
	SLDataLocator_OutputMix loc_outmix = {SL_DATALOCATOR_OUTPUTMIX, outputMixObject};
	SLDataSink audioSnk = {&loc_outmix, NULL};

	// configure audio source
	off_t start, length;
	int fd = getFileDescriptor(player, filename, start, length);
	if (FILE_NOT_FOUND == fd)
	{
		return false;
	}
	SLDataLocator_AndroidFD loc_fd = {SL_DATALOCATOR_ANDROIDFD, fd, start, length};
	SLDataFormat_MIME format_mime = {SL_DATAFORMAT_MIME, NULL, SL_CONTAINERTYPE_UNSPECIFIED};
	(player->audioSrc) = {&loc_fd, &format_mime};

	// create audio player
	const SLInterfaceID ids[3] = {SL_IID_SEEK, SL_IID_MUTESOLO, SL_IID_VOLUME};
	const SLboolean req[3] = {SL_BOOLEAN_TRUE, SL_BOOLEAN_TRUE, SL_BOOLEAN_TRUE};
	
	SLresult result = (*engineEngine)->CreateAudioPlayer(engineEngine, &(player->fdPlayerObject), &(player->audioSrc), &audioSnk, 3, ids, req);
	assert(SL_RESULT_SUCCESS == result);

	// realize the player
	result = (*(player->fdPlayerObject))->Realize(player->fdPlayerObject, SL_BOOLEAN_FALSE);
	assert(SL_RESULT_SUCCESS == result);

	// get the play interface
	result = (*(player->fdPlayerObject))->GetInterface(player->fdPlayerObject, SL_IID_PLAY, &(player->fdPlayerPlay));
	assert(SL_RESULT_SUCCESS == result);

	// get the volume interface
	result = (*(player->fdPlayerObject))->GetInterface(player->fdPlayerObject, SL_IID_VOLUME, &(player->fdPlayerVolume));
	assert(SL_RESULT_SUCCESS == result);

	// get the volume interface
	result = (*(player->fdPlayerObject))->GetInterface(player->fdPlayerObject, SL_IID_SEEK, &(player->fdPlayerSeek));
	assert(SL_RESULT_SUCCESS == result);

	return true;
}

void destroyAudioPlayer(AudioPlayer * player)
{
	if (player->fdPlayerObject != NULL){
		(*(player->fdPlayerObject))->Destroy(player->fdPlayerObject);
		player->fdPlayerObject = NULL;
		player->fdPlayerPlay = NULL;
		player->fdPlayerSeek = NULL;
		player->fdPlayerVolume = NULL;
	}
}

void OpenSLEngine::createEngine()
{
	SLresult result;
	LOGD("createEngine");

	// create engine
	if (engineObject == NULL)
	{
		result = slCreateEngine(&engineObject, 0, NULL, 0, NULL, NULL);
		assert(SL_RESULT_SUCCESS == result);

		// realize the engine
		result = (*engineObject)->Realize(engineObject, SL_BOOLEAN_FALSE);
		assert(SL_RESULT_SUCCESS == result);

		// get the engine interface, which is needed in order to create other objects
		result = (*engineObject)->GetInterface(engineObject, SL_IID_ENGINE, &engineEngine);
		assert(SL_RESULT_SUCCESS == result);

		// create output mix
		const SLInterfaceID ids[1] = {SL_IID_ENVIRONMENTALREVERB};
		const SLboolean req[1] = {SL_BOOLEAN_FALSE};
		result = (*engineEngine)->CreateOutputMix(engineEngine, &outputMixObject, 1, ids, req);
		assert(SL_RESULT_SUCCESS == result);
	}

	// realize the output mix
	result = (*outputMixObject)->Realize(outputMixObject, SL_BOOLEAN_FALSE);
	assert(SL_RESULT_SUCCESS == result);
}

void OpenSLEngine::closeEngine()
{
	// destroy background players
	destroyAudioPlayer(&musicPlayer);

	// destroy effect players
	EffectList::iterator p = sharedList().begin();
	while (p != sharedList().end())
	{
		destroyAudioPlayer(p->second);
		p++;
	}   
	sharedList().clear();

	// destroy output mix interface
	if (outputMixObject != NULL) {
		(*outputMixObject)->Destroy(outputMixObject);
		outputMixObject = NULL;
	}

	// destroy opensl engine
	if (engineObject != NULL) {
		(*engineObject)->Destroy(engineObject);
		engineObject = NULL;
		engineEngine = NULL;
	}
}


/**********************************************************************************
 *   background music
 **********************************************************************************/
bool OpenSLEngine::preloadBackgroundMusic(const char * filename)
{
	if (musicPlayer.Asset != NULL)
	{
		if (musicPlayer.fdPlayerPlay != NULL)
		{
			SLresult result = (*(musicPlayer.fdPlayerPlay))->SetPlayState(musicPlayer.fdPlayerPlay, SL_PLAYSTATE_STOPPED);
			assert(SL_RESULT_SUCCESS == result);
		}
		free(musicPlayer.Asset);
		musicPlayer.Asset = NULL;
	}

	return initAudioPlayer(&musicPlayer, filename);
}

void OpenSLEngine::setBackgroundMusicState(int state)
{
	SLresult result;
	if (NULL != musicPlayer.fdPlayerPlay) {
		result = (*(musicPlayer.fdPlayerPlay))->SetPlayState(musicPlayer.fdPlayerPlay, state);
		assert(SL_RESULT_SUCCESS == result);
	}
}

int OpenSLEngine::getBackgroundMusicState()
{
	SLresult result;
	SLuint32 state;
	if (musicPlayer.fdPlayerPlay != NULL)
	{
		result = (*(musicPlayer.fdPlayerPlay))->GetPlayState(musicPlayer.fdPlayerPlay, &state);
		assert(result == SL_RESULT_SUCCESS);
	}

	return (int)state;
}

void OpenSLEngine::rewindBackgroundMusic()
{
	SLresult result;

	result = (*(musicPlayer.fdPlayerSeek))->SetPosition(musicPlayer.fdPlayerSeek, 0, SL_SEEKMODE_FAST);
	assert(SL_RESULT_SUCCESS == result);

	result = (*(musicPlayer.fdPlayerPlay))->SetPlayState(musicPlayer.fdPlayerPlay, SL_PLAYSTATE_PLAYING);
	assert(SL_RESULT_SUCCESS == result);
}

void OpenSLEngine::setBackgroundMusicLooping(bool isLooping)
{
    SLresult result;
    if (NULL != musicPlayer.fdPlayerSeek) 
	{
        result = (*(musicPlayer.fdPlayerSeek))->SetLoop(musicPlayer.fdPlayerSeek, (SLboolean) isLooping, 0, SL_TIME_UNKNOWN);
        assert(SL_RESULT_SUCCESS == result);
    }
}

void OpenSLEngine::setBackgroundVolume(int volume)
{
	m_musicVolume = volume;

    SLresult result;
    if (NULL != musicPlayer.fdPlayerVolume) {
        result = (*(musicPlayer.fdPlayerVolume))->SetVolumeLevel(musicPlayer.fdPlayerVolume, m_musicVolume);
        assert(SL_RESULT_SUCCESS == result);
    }
}

int OpenSLEngine::getBackgroundVolume()
{
	return m_musicVolume;
}


/**********************************************************************************
 *   sound effect
 **********************************************************************************/
#define  NORMAL_EFFECT_CALLBACK  1
#define  REPLAY_EFFECT_CALLBACK  2 

//typedef struct _CallbackContext
//{
//	int type;
//	AudioPlayer* player;
//} CallbackContext;
//
//void effectPlayCallback(SLPlayItf caller, void * context, SLuint32 event)
//{
//	CallbackContext* callback = (CallbackContext*)context;
//	switch(callback->type)
//	{
//	case NORMAL_EFFECT_CALLBACK :
//		// TO-DO
//		break;
//	case REPLAY_EFFECT_CALLBACK :
//		destroyAudioPlayer(callback->player);
//		break;
//	default:
//		break;
//	}
//}

void setSingleEffectState(AudioPlayer * player, int state)
{
	SLresult result;
	if (player->fdPlayerPlay != NULL){
		result = (*(player->fdPlayerPlay))->SetPlayState(player->fdPlayerPlay, state);
		assert(SL_RESULT_SUCCESS == result);
	}
}

unsigned int OpenSLEngine::preloadEffect(const char * filename)
{
	unsigned int nID = _Hash(filename);
	// if already exists
	if (sharedList().find(nID) != sharedList().end())
	{
		/*AudioPlayer* newPlayer = new AudioPlayer(sharedList()[nID]);
		CallbackContext* context = new CallbackContext();
		context->player = newPlayer;
		context->
		(newPlayer->fdPlayerPlay)->RegisterCallback(newPlayer->fdPlayerPlay, effectPlayCallback, );*/
		return nID;
	}
	
	AudioPlayer* player = new AudioPlayer();
	if (!initAudioPlayer(player, filename))
	{
		free(player);
		return FILE_NOT_FOUND;
	}

	// set the new player's volume as others'
	SLresult result;
	result = (*(player->fdPlayerVolume))->SetVolumeLevel(player->fdPlayerVolume, m_effectVolume);
	assert(result == SL_RESULT_SUCCESS);

	sharedList().insert(Effect(nID, player));
	return nID;
}

void OpenSLEngine::unloadEffect(const char * filename)
{
	unsigned int nID = _Hash(filename);

	EffectList::iterator p = sharedList().find(nID);
	if (p != sharedList().end())
	{
		destroyAudioPlayer(p->second);
		sharedList().erase(nID);

		LOGD("effect unloaded");
	}
}

void OpenSLEngine::setEffectState(unsigned int effectID, int state)
{
	EffectList::iterator p = sharedList().find(effectID);
	if (p != sharedList().end())
	{
		setSingleEffectState(p->second, state);
	}
}

void OpenSLEngine::setAllEffectState(int state)
{
	EffectList::iterator iter;
	for (iter = sharedList().begin(); iter != sharedList().end(); iter++)
	{
		setSingleEffectState(iter->second, state);
	}
}

void OpenSLEngine::setEffectLooping(unsigned int effectID, bool isLooping)
{
	SLresult result;
	AudioPlayer * player = sharedList()[effectID];
	assert(player != NULL);

	if (NULL != player->fdPlayerSeek) 
	{
		result = (*(player->fdPlayerSeek))->SetLoop(player->fdPlayerSeek, (SLboolean) isLooping, 0, SL_TIME_UNKNOWN);
		assert(SL_RESULT_SUCCESS == result);
	}
}

void OpenSLEngine::setEffectsVolume(int volume)
{
	m_effectVolume = volume;

	SLresult result;
	EffectList::iterator iter;
	AudioPlayer * player;
	for (iter = sharedList().begin() ; iter != sharedList().end() ; ++ iter)
	{
		player = iter->second;
		result = (*(player->fdPlayerVolume))->SetVolumeLevel(player->fdPlayerVolume, m_effectVolume);
		assert(SL_RESULT_SUCCESS == result);
	}
}

int OpenSLEngine::getEffectsVolume()
{
	return m_effectVolume;
}