HumanClientAppSoundOpenAL.cpp from FreeOrion at Krugle
Show HumanClientAppSoundOpenAL.cpp syntax highlighted
#include "HumanClientAppSoundOpenAL.h"
#include "../../util/AppInterface.h"
#include "../../util/OptionsDB.h"
#include <AL/alc.h>
#include <AL/alut.h>
namespace {
const int BUFFER_SIZE = 409600; // The size of the buffer we read music data into.
void InitOpenAL(int num_sources, ALuint *sources, ALuint *music_buffers)
{
ALCcontext *m_context;
ALCdevice *m_device;
m_device = alcOpenDevice(NULL); /* currently only select the default output device - usually a NULL-terminated
* string desctribing a device can be passed here (of type ALchar*)
*/
if (m_device == NULL) {
Logger().errorStream() << "Unable to initialise OpenAL device: " << alGetString(alGetError()) << "\n";
} else {
m_context = alcCreateContext(m_device,NULL); // instead of NULL we can pass a ALCint* pointing to a set of
alcMakeContextCurrent(m_context); // attributes (ALC_FREQUENCY, ALC_REFRESH and ALC_SYNC)
alutInitWithoutContext(NULL,NULL); // we need to init alut or we won't be able to read .wav files
alListenerf(AL_GAIN,1.0);
alGenSources(num_sources, sources);
alGenBuffers(2, music_buffers);
for (int i = 0; i < num_sources; ++i) {
alSourcei(sources[i], AL_SOURCE_RELATIVE, AL_TRUE);
}
Logger().debugStream() << "OpenAL initialized. Version "
<< alGetString(AL_VERSION)
<< "Renderer "
<< alGetString(AL_RENDERER)
<< "Vendor "
<< alGetString(AL_VENDOR)
<< "\nExtensions: "
<< alGetString(AL_EXTENSIONS)
<< "\n";
}
}
#ifdef FREEORION_WIN32
int _fseek64_wrap(FILE *f,ogg_int64_t off,int whence)
{
if (!f)
return -1;
return fseek(f,off,whence);
}
#endif
}
HumanClientAppSoundOpenAL::HumanClientAppSoundOpenAL() :
HumanClientApp()
{
InitOpenAL(NUM_SOURCES, m_sources, m_music_buffers);
}
HumanClientAppSoundOpenAL::~HumanClientAppSoundOpenAL()
{
alutExit();
}
int HumanClientAppSoundOpenAL::RefillBuffer(ALuint *bufferName)
{
ALenum m_openal_error;
int endian = 0; /// 0 for little-endian (x86), 1 for big-endian (ppc)
int bitStream,bytes,bytes_new;
char array[BUFFER_SIZE];
bytes = 0;
if (alcGetCurrentContext() != NULL)
{
/* First, let's fill up the buffer. We need the loop, as ov_read treats (BUFFER_SIZE - bytes) to read as a suggestion only */
do
{
bytes_new = ov_read(&m_ogg_file, &array[bytes],(BUFFER_SIZE - bytes), endian, 2, 1, &bitStream);
bytes += bytes_new;
if (bytes_new == 0)
{
if (m_music_loops != 0) // enter here if we need to play the same file again
{
if (m_music_loops > 0)
m_music_loops--;
ov_time_seek(&m_ogg_file,0.0); // rewind to beginning
}
else
break;
}
} while ((BUFFER_SIZE - bytes) > 4096);
if (bytes > 0)
{
alBufferData(bufferName[0], m_ogg_format, array, static_cast < ALsizei > (bytes),m_ogg_freq);
m_openal_error = alGetError();
if (m_openal_error != AL_NONE)
Logger().errorStream() << "RefillBuffer: OpenAL ERROR: " << alGetString(m_openal_error);
}
else
{
m_music_name.clear(); // m_music_name.clear() must always be called before ov_clear. Otherwise
ov_clear(&m_ogg_file); // the app might think we still have something to play.
return 1;
}
return 0;
}
return 1;
}
void HumanClientAppSoundOpenAL::PlayMusic(const boost::filesystem::path& path, int loops /* = 0*/)
{
ALenum m_openal_error;
std::string filename = path.native_file_string();
FILE *m_f = NULL;
vorbis_info *m_ogg_info;
m_music_loops = 0;
#ifdef FREEORION_WIN32
ov_callbacks callbacks = {
(size_t (*)(void *, size_t, size_t, void *)) fread,
(int (*)(void *, ogg_int64_t, int)) _fseek64_wrap,
(int (*)(void *)) fclose,
(long (*)(void *)) ftell
};
#endif
if (alcGetCurrentContext() != NULL)
{
if (m_music_name.size() > 0)
StopMusic();
if ((m_f = fopen(filename.c_str(), "rb")) != NULL) // make sure we CAN open it
{
#ifdef FREEORION_WIN32
if (!(ov_test_callbacks(m_f, &m_ogg_file, NULL, 0, callbacks))) // check if it's a proper ogg
#else
if (!(ov_test(m_f, &m_ogg_file, NULL, 0))) // check if it's a proper ogg
#endif
{
ov_test_open(&m_ogg_file); // it is, now fully open the file
/* now we need to take some info we will need later */
m_ogg_info = ov_info(&m_ogg_file, -1);
if (m_ogg_info->channels == 1)
m_ogg_format = AL_FORMAT_MONO16;
else
m_ogg_format = AL_FORMAT_STEREO16;
m_ogg_freq = m_ogg_info->rate;
m_music_loops = loops;
/* fill up the buffers and queue them up for the first time */
if (!RefillBuffer(&m_music_buffers[0]))
{
alSourceQueueBuffers(m_sources[0],1,&m_music_buffers[0]); // queue up the buffer if we manage to fill it
if (!RefillBuffer(&m_music_buffers[1]))
{
alSourceQueueBuffers(m_sources[0],1,&m_music_buffers[1]);
m_music_name = filename; // yup, we're playing something that takes up more than 2 buffers
}
alSourcePlay(m_sources[0]); // play if at least one buffer is queued
}
}
else
{
Logger().errorStream() << "PlayMusic: unable to open file " << filename.c_str() << " possibly not a .ogg vorbis file. Aborting\n";
m_music_name.clear(); //just in case
ov_clear(&m_ogg_file);
}
}
else
Logger().errorStream() << "PlayMusic: unable to open file " << filename.c_str() << " I/O Error. Aborting\n";
}
m_openal_error = alGetError();
if (m_openal_error != AL_NONE)
Logger().errorStream() << "PlayMusic: OpenAL ERROR: " << alGetString(m_openal_error);
}
void HumanClientAppSoundOpenAL::StopMusic()
{
if (alcGetCurrentContext() != NULL)
{
alSourceStop(m_sources[0]);
if (m_music_name.size() > 0)
{
m_music_name.clear(); // do this to avoid music being re-started by other functions
ov_clear(&m_ogg_file); // and unload the file for good measure. the file itself is closed now, don't re-close it again
}
alSourcei(m_sources[0], AL_BUFFER, 0);
}
}
void HumanClientAppSoundOpenAL::PlaySound(const boost::filesystem::path& path)
{
std::string filename = path.native_file_string();
ALuint m_current_buffer;
ALenum m_source_state;
int m_i;
int m_found_buffer = 1;
int m_found_source = 0;
if (alcGetCurrentContext() != NULL)
{
/* First check if the sound data of the file we want to play is already buffered somewhere */
std::map<std::string, ALuint>::iterator it = m_buffers.find(filename);
if (it != m_buffers.end())
m_current_buffer = it->second;
else
{
/* We buffer the file if it wasn't previously */
if ((m_current_buffer = alutCreateBufferFromFile(filename.c_str())) != AL_NONE)
m_buffers[filename] = m_current_buffer;
else
{
Logger().errorStream() << "PlaySound: Cannot create buffer for: " << filename.c_str() << " Reason:" << alutGetErrorString(alutGetError());
m_found_buffer = 0;
}
}
if (m_found_buffer)
{
/* Now that we have the buffer, we need to find a source to send it to */
for (m_i = 1; m_i < NUM_SOURCES; ++m_i) // as we're playing sounds we start at 1. 0 is reserved for music
{
alGetSourcei(m_sources[m_i],AL_SOURCE_STATE,&m_source_state);
if ((m_source_state != AL_PLAYING) && (m_source_state != AL_PAUSED))
{
m_found_source = 1;
alSourcei(m_sources[m_i], AL_BUFFER, m_current_buffer);
alSourcePlay(m_sources[m_i]);
break; // so that the sound won't block all the sources
}
}
if (!m_found_source)
Logger().errorStream() << "PlaySound: Could not find aviable source - playback aborted\n";
}
m_source_state = alGetError();
if (m_source_state != AL_NONE)
Logger().errorStream() << "PlaySound: OpenAL ERROR: " << alGetString(m_source_state);
/* it's important to check for errors, as some functions (mainly alut) won't work properly if
* they're called when there is a unchecked previous error. */
}
}
void HumanClientAppSoundOpenAL::FreeSound(const boost::filesystem::path& path)
{
ALenum m_openal_error;
std::string filename = path.native_file_string();
std::map<std::string, ALuint>::iterator it = m_buffers.find(filename);
if (it != m_buffers.end()) {
alDeleteBuffers(1, &(it->second));
m_openal_error = alGetError();
if (m_openal_error != AL_NONE)
Logger().errorStream() << "FreeSound: OpenAL ERROR: " << alGetString(m_openal_error);
else
m_buffers.erase(it); /* we don't erase if there was an error, as the buffer may not have been
removed - potential memory leak */
}
}
void HumanClientAppSoundOpenAL::FreeAllSounds()
{
ALenum m_openal_error;
for (std::map<std::string, ALuint>::iterator it = m_buffers.begin();
it != m_buffers.end(); ++it) {
alDeleteBuffers(1, &(it->second));
m_openal_error = alGetError();
if (m_openal_error != AL_NONE)
Logger().errorStream() << "FreeAllSounds: OpenAL ERROR: " << alGetString(m_openal_error);
else
m_buffers.erase(it); /* same as in FreeSound */
}
}
void HumanClientAppSoundOpenAL::SetMusicVolume(int vol)
{
ALenum m_openal_error;
/* normalize value, then apply to all sound sources */
vol = std::max(0, std::min(vol, 255));
GetOptionsDB().Set<int>("music-volume", vol);
if (alcGetCurrentContext() != NULL)
{
alSourcef(m_sources[0],AL_GAIN, ((ALfloat) vol)/255.0);
/* it is highly unlikely that we'll get an error here but better safe than sorry */
m_openal_error = alGetError();
if (m_openal_error != AL_NONE)
Logger().errorStream() << "PlaySound: OpenAL ERROR: " << alGetString(m_openal_error);
}
}
void HumanClientAppSoundOpenAL::SetUISoundsVolume(int vol)
{
ALenum m_openal_error;
/* normalize value, then apply to all sound sources */
vol = std::max(0, std::min(vol, 255));
GetOptionsDB().Set<int>("UI.sound.volume", vol);
if (alcGetCurrentContext() != NULL)
{
for (int it = 1; it < NUM_SOURCES; ++it)
alSourcef(m_sources[it],AL_GAIN, ((ALfloat) vol)/255.0);
/* it is highly unlikely that we'll get an error here but better safe than sorry */
m_openal_error = alGetError();
if (m_openal_error != AL_NONE)
Logger().errorStream() << "PlaySound: OpenAL ERROR: " << alGetString(m_openal_error);
}
}
void HumanClientAppSoundOpenAL::RenderBegin()
{
ALint state;
int num_buffers_processed;
if ((alcGetCurrentContext() != NULL) && (m_music_name.size() > 0))
{
alGetSourcei(m_sources[0],AL_BUFFERS_PROCESSED,&num_buffers_processed);
while (num_buffers_processed > 0)
{
ALuint buffer_name_yay;
alSourceUnqueueBuffers (m_sources[0], 1, &buffer_name_yay);
if (RefillBuffer(&buffer_name_yay))
break; /// this happens if RefillBuffer returns 1, meaning it encountered EOF and the file shouldn't be repeated
alSourceQueueBuffers(m_sources[0],1,&buffer_name_yay);
num_buffers_processed--;
}
alGetSourcei(m_sources[0], AL_SOURCE_STATE, &state);
if (state == AL_STOPPED) /// this may happen if the source plays all its buffers before we manage to refill them
alSourcePlay(m_sources[0]);
}
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT); // this is the only line in SDLGUI::RenderBegin()
}
See more files for this project here