2 Copyright (C) 2003, 2010 - Wolfire Games
3 Copyright (C) 2010-2016 - Lugaru contributors (see AUTHORS file)
5 This file is part of Lugaru.
7 Lugaru is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 Lugaru is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with Lugaru. If not, see <http://www.gnu.org/licenses/>.
21 #include "Audio/openal_wrapper.hpp"
23 #include "Audio/Sounds.hpp"
25 #include "Math/XYZ.hpp"
31 extern float slomofreq;
34 // FMOD uses a Left Handed Coordinate system, OpenAL uses a Right Handed
35 // one...so we just need to flip the sign on the Z axis when appropriate.
40 OPENAL_SAMPLE* sample;
45 typedef struct OPENAL_SAMPLE
48 ALuint bid; // buffer id.
53 static size_t num_channels = 0;
54 static OPENAL_Channels* impl_channels = NULL;
55 static bool initialized = false;
56 static float listener_position[3];
58 static void set_channel_position(const int channel, const float x,
59 const float y, const float z)
61 OPENAL_Channels* chan = &impl_channels[channel];
63 chan->position[0] = x;
64 chan->position[1] = y;
65 chan->position[2] = z;
67 OPENAL_SAMPLE* sptr = chan->sample;
71 const ALuint sid = chan->sid;
72 const bool no_attenuate = sptr->is2d;
75 alSourcei(sid, AL_SOURCE_RELATIVE, AL_TRUE);
76 alSource3f(sid, AL_POSITION, 0.0f, 0.0f, 0.0f);
78 alSourcei(sid, AL_SOURCE_RELATIVE, AL_FALSE);
79 alSource3f(sid, AL_POSITION, x, y, z);
83 AL_API void OPENAL_3D_Listener_SetAttributes(const float* pos, const float*, float fx, float fy, float fz, float tx, float ty, float tz)
88 alListener3f(AL_POSITION, pos[0], pos[1], -pos[2]);
89 listener_position[0] = pos[0];
90 listener_position[1] = pos[1];
91 listener_position[2] = -pos[2];
94 ALfloat vec[6] = { fx, fy, -fz, tx, ty, -tz };
95 alListenerfv(AL_ORIENTATION, vec);
97 // we ignore velocity, since doppler's broken in the Linux AL at the moment...
99 // adjust existing positions...
100 for (unsigned i = 0; i < num_channels; i++) {
101 const float* p = impl_channels[i].position;
102 set_channel_position(i, p[0], p[1], p[2]);
106 AL_API signed char OPENAL_3D_SetAttributes(int channel, const float* pos)
110 if ((channel < 0) || (channel >= (int)num_channels))
114 set_channel_position(channel, pos[0], pos[1], -pos[2]);
116 // we ignore velocity, since doppler's broken in the Linux AL at the moment...
121 AL_API signed char OPENAL_3D_SetAttributes_(int channel, const XYZ& pos)
125 if ((channel < 0) || (channel >= (int)num_channels))
128 set_channel_position(channel, pos.x, pos.y, -pos.z);
133 AL_API signed char OPENAL_Init(int mixrate, int maxsoftwarechannels, unsigned int flags)
137 if (maxsoftwarechannels == 0)
140 if (flags != 0) // unsupported.
143 ALCdevice* dev = alcOpenDevice(NULL);
147 ALint caps[] = { ALC_FREQUENCY, mixrate, 0 };
148 ALCcontext* ctx = alcCreateContext(dev, caps);
154 alcMakeContextCurrent(ctx);
155 alcProcessContext(ctx);
157 if (commandLineOptions[OPENALINFO]) {
158 printf("AL_VENDOR: %s\n", (char*)alGetString(AL_VENDOR));
159 printf("AL_RENDERER: %s\n", (char*)alGetString(AL_RENDERER));
160 printf("AL_VERSION: %s\n", (char*)alGetString(AL_VERSION));
161 printf("AL_EXTENSIONS: %s\n", (char*)alGetString(AL_EXTENSIONS));
164 num_channels = maxsoftwarechannels;
165 impl_channels = new OPENAL_Channels[maxsoftwarechannels];
166 memset(impl_channels, '\0', sizeof(OPENAL_Channels) * num_channels);
167 for (unsigned i = 0; i < num_channels; i++)
168 alGenSources(1, &impl_channels[i].sid); // !!! FIXME: verify this didn't fail!
174 AL_API void OPENAL_Close()
179 ALCcontext* ctx = alcGetCurrentContext();
181 for (unsigned i = 0; i < num_channels; i++) {
182 alSourceStop(impl_channels[i].sid);
183 alSourcei(impl_channels[i].sid, AL_BUFFER, 0);
184 alDeleteSources(1, &impl_channels[i].sid);
186 ALCdevice* dev = alcGetContextsDevice(ctx);
187 alcMakeContextCurrent(NULL);
188 alcSuspendContext(ctx);
189 alcDestroyContext(ctx);
194 delete[] impl_channels;
195 impl_channels = NULL;
200 static OPENAL_SAMPLE* OPENAL_GetCurrentSample(int channel)
204 if ((channel < 0) || (channel >= (int)num_channels))
206 return impl_channels[channel].sample;
209 static signed char OPENAL_GetPaused(int channel)
213 if ((channel < 0) || (channel >= (int)num_channels))
215 if (impl_channels[channel].startpaused)
219 alGetSourceiv(impl_channels[channel].sid, AL_SOURCE_STATE, &state);
220 return ((state == AL_PAUSED) ? true : false);
223 static unsigned int OPENAL_GetLoopMode(int channel)
227 if ((channel < 0) || (channel >= (int)num_channels))
230 alGetSourceiv(impl_channels[channel].sid, AL_LOOPING, &loop);
232 return (OPENAL_LOOP_NORMAL);
233 return OPENAL_LOOP_OFF;
236 static signed char OPENAL_IsPlaying(int channel)
240 if ((channel < 0) || (channel >= (int)num_channels))
243 alGetSourceiv(impl_channels[channel].sid, AL_SOURCE_STATE, &state);
244 return ((state == AL_PLAYING) ? true : false);
247 static int OPENAL_PlaySoundEx(int channel, OPENAL_SAMPLE* sptr, OPENAL_DSPUNIT* dsp, signed char startpaused)
255 if (channel == OPENAL_FREE) {
256 for (unsigned i = 0; i < num_channels; i++) {
258 alGetSourceiv(impl_channels[i].sid, AL_SOURCE_STATE, &state);
259 if ((state != AL_PLAYING) && (state != AL_PAUSED)) {
266 if ((channel < 0) || (channel >= (int)num_channels))
268 alSourceStop(impl_channels[channel].sid);
269 impl_channels[channel].sample = sptr;
270 alSourcei(impl_channels[channel].sid, AL_BUFFER, sptr->bid);
271 alSourcei(impl_channels[channel].sid, AL_LOOPING, (sptr->mode == OPENAL_LOOP_OFF) ? AL_FALSE : AL_TRUE);
272 set_channel_position(channel, 0.0f, 0.0f, 0.0f);
274 impl_channels[channel].startpaused = ((startpaused) ? true : false);
276 alSourcePlay(impl_channels[channel].sid);
280 static void* decode_to_pcm(const char* _fname, ALenum& format, ALsizei& size, ALuint& freq)
283 const int bigendian = 1;
285 const int bigendian = 0;
288 // !!! FIXME: if it's not Ogg, we don't have a decoder. I'm lazy. :/
289 char* fname = (char*)alloca(strlen(_fname) + 16);
290 strcpy(fname, _fname);
291 char* ptr = strchr(fname, '.');
294 strcat(fname, ".ogg");
297 FILE* io = fopen(fname, "rb");
301 ALubyte* retval = NULL;
303 #if 0 // untested, so disable this!
304 // Can we just feed it to the AL compressed?
305 if (alIsExtensionPresent((const ALubyte *) "AL_EXT_vorbis")) {
306 format = alGetEnumValue((const ALubyte *) "AL_FORMAT_VORBIS_EXT");
308 fseek(io, 0, SEEK_END);
310 fseek(io, 0, SEEK_SET);
311 retval = (ALubyte *) malloc(size);
312 size_t rc = fread(retval, size, 1, io);
322 // Uncompress and feed to the AL.
324 memset(&vf, '\0', sizeof(vf));
325 if (ov_open(io, &vf, NULL, 0) == 0) {
327 vorbis_info* info = ov_info(&vf, -1);
329 format = (info->channels == 1) ? AL_FORMAT_MONO16 : AL_FORMAT_STEREO16;
332 if ((info->channels != 1) && (info->channels != 2)) {
339 size_t allocated = 64 * 1024;
340 retval = (ALubyte*)malloc(allocated);
341 while ((rc = ov_read(&vf, buf, sizeof(buf), bigendian, 2, 1, &bitstream)) != 0) {
344 if (size >= (int)allocated) {
346 ALubyte* tmp = (ALubyte*)realloc(retval, allocated);
354 memcpy(retval + (size - rc), buf, rc);
365 AL_API OPENAL_SAMPLE* OPENAL_Sample_Load(int index, const char* name_or_data, unsigned int mode, int offset, int length)
369 if (index != OPENAL_FREE)
370 return NULL; // this is all the game does...
372 return NULL; // this is all the game does...
374 return NULL; // this is all the game does...
375 if ((mode != OPENAL_HW3D) && (mode != OPENAL_2D))
376 return NULL; // this is all the game does...
378 OPENAL_SAMPLE* retval = NULL;
379 ALenum format = AL_NONE;
381 ALuint frequency = 0;
382 void* data = decode_to_pcm(name_or_data, format, size, frequency);
388 alGenBuffers(1, &bid);
389 if (alGetError() == AL_NO_ERROR) {
390 alBufferData(bid, format, data, size, frequency);
391 retval = new OPENAL_SAMPLE;
393 retval->mode = OPENAL_LOOP_OFF;
394 retval->is2d = (mode == OPENAL_2D);
395 retval->name = new char[strlen(name_or_data) + 1];
397 strcpy(retval->name, name_or_data);
404 AL_API void OPENAL_Sample_Free(OPENAL_SAMPLE* sptr)
409 for (unsigned i = 0; i < num_channels; i++) {
410 if (impl_channels[i].sample == sptr) {
411 alSourceStop(impl_channels[i].sid);
412 alSourcei(impl_channels[i].sid, AL_BUFFER, 0);
413 impl_channels[i].sample = NULL;
416 alDeleteBuffers(1, &sptr->bid);
422 static signed char OPENAL_Sample_SetMode(OPENAL_SAMPLE* sptr, unsigned int mode)
426 if ((mode != OPENAL_LOOP_NORMAL) && (mode != OPENAL_LOOP_OFF))
434 AL_API signed char OPENAL_SetFrequency(int channel, bool slomo)
438 if (channel == OPENAL_ALL) {
439 for (unsigned i = 0; i < num_channels; i++)
440 OPENAL_SetFrequency(i, slomo);
444 if ((channel < 0) || (channel >= (int)num_channels))
447 alSourcef(impl_channels[channel].sid, AL_PITCH, ((ALfloat)slomofreq) / 44100.0f);
449 alSourcef(impl_channels[channel].sid, AL_PITCH, 1.0f);
453 AL_API signed char OPENAL_SetVolume(int channel, int vol)
458 if (channel == OPENAL_ALL) {
459 for (unsigned i = 0; i < num_channels; i++)
460 OPENAL_SetVolume(i, vol);
464 if ((channel < 0) || (channel >= (int)num_channels))
471 ALfloat gain = ((ALfloat)vol) / 255.0f;
472 alSourcef(impl_channels[channel].sid, AL_GAIN, gain);
476 AL_API signed char OPENAL_SetPaused(int channel, signed char paused)
481 if (channel == OPENAL_ALL) {
482 for (unsigned i = 0; i < num_channels; i++)
483 OPENAL_SetPaused(i, paused);
487 if ((channel < 0) || (channel >= (int)num_channels))
491 if (impl_channels[channel].startpaused)
494 alGetSourceiv(impl_channels[channel].sid, AL_SOURCE_STATE, &state);
496 if ((paused) && (state == AL_PLAYING))
497 alSourcePause(impl_channels[channel].sid);
498 else if ((!paused) && (state == AL_PAUSED)) {
499 alSourcePlay(impl_channels[channel].sid);
500 impl_channels[channel].startpaused = false;
505 AL_API void OPENAL_SetSFXMasterVolume(int volume)
509 ALfloat gain = ((ALfloat)volume) / 255.0f;
510 alListenerf(AL_GAIN, gain);
513 AL_API signed char OPENAL_StopSound(int channel)
518 if (channel == OPENAL_ALL) {
519 for (unsigned i = 0; i < num_channels; i++)
524 if ((channel < 0) || (channel >= (int)num_channels))
526 alSourceStop(impl_channels[channel].sid);
527 impl_channels[channel].startpaused = false;
531 static OPENAL_SAMPLE* OPENAL_Stream_GetSample(OPENAL_STREAM* stream)
535 return (OPENAL_SAMPLE*)stream;
538 static int OPENAL_Stream_PlayEx(int channel, OPENAL_STREAM* stream, OPENAL_DSPUNIT* dsp, signed char startpaused)
540 return OPENAL_PlaySoundEx(channel, (OPENAL_SAMPLE*)stream, dsp, startpaused);
543 static signed char OPENAL_Stream_Stop(OPENAL_STREAM* stream)
547 for (unsigned i = 0; i < num_channels; i++) {
548 if (impl_channels[i].sample == (OPENAL_SAMPLE*)stream) {
549 alSourceStop(impl_channels[i].sid);
550 impl_channels[i].startpaused = false;
556 AL_API signed char OPENAL_Stream_SetMode(OPENAL_STREAM* stream, unsigned int mode)
558 return OPENAL_Sample_SetMode((OPENAL_SAMPLE*)stream, mode);
561 AL_API void OPENAL_Update()
565 alcProcessContext(alcGetCurrentContext());
568 extern int channels[];
570 extern "C" void PlaySoundEx(int chan, OPENAL_SAMPLE* sptr, OPENAL_DSPUNIT* dsp, signed char startpaused)
572 const OPENAL_SAMPLE* currSample = OPENAL_GetCurrentSample(channels[chan]);
573 if (currSample && currSample == samp[chan]) {
574 if (OPENAL_GetPaused(channels[chan])) {
575 OPENAL_StopSound(channels[chan]);
576 channels[chan] = OPENAL_FREE;
577 } else if (OPENAL_IsPlaying(channels[chan])) {
578 int loop_mode = OPENAL_GetLoopMode(channels[chan]);
579 if (loop_mode & OPENAL_LOOP_OFF) {
580 channels[chan] = OPENAL_FREE;
584 channels[chan] = OPENAL_FREE;
587 channels[chan] = OPENAL_PlaySoundEx(channels[chan], sptr, dsp, startpaused);
588 if (channels[chan] < 0) {
589 channels[chan] = OPENAL_PlaySoundEx(OPENAL_FREE, sptr, dsp, startpaused);
593 extern "C" void PlayStreamEx(int chan, OPENAL_STREAM* sptr, OPENAL_DSPUNIT* dsp, signed char startpaused)
595 const OPENAL_SAMPLE* currSample = OPENAL_GetCurrentSample(channels[chan]);
596 if (currSample && currSample == OPENAL_Stream_GetSample(sptr)) {
597 OPENAL_StopSound(channels[chan]);
598 OPENAL_Stream_Stop(sptr);
600 OPENAL_Stream_Stop(sptr);
601 channels[chan] = OPENAL_FREE;
604 channels[chan] = OPENAL_Stream_PlayEx(channels[chan], sptr, dsp, startpaused);
605 if (channels[chan] < 0) {
606 channels[chan] = OPENAL_Stream_PlayEx(OPENAL_FREE, sptr, dsp, startpaused);