aboutsummaryrefslogtreecommitdiff
path: root/backends/mixer/sdl/sdl-mixer.cpp
blob: 490489718d6c173b85aac5f1fe1a599238e1bd48 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * $URL$
 * $Id$
 *
 */

#if defined(WIN32) || defined(UNIX) || defined(MACOSX)

#include "backends/mixer/sdl/sdl-mixer.h"

#include "common/config-manager.h"

//#define SAMPLES_PER_SEC 11025
#define SAMPLES_PER_SEC 22050
//#define SAMPLES_PER_SEC 44100

SdlMixerImpl::SdlMixerImpl(OSystem *system)
	:
#if MIXER_DOUBLE_BUFFERING
	_soundMutex(0), _soundCond(0), _soundThread(0),
	_soundThreadIsRunning(false), _soundThreadShouldQuit(false),
#endif
	MixerImpl(system, getSamplesPerSec()) {
	if (_openAudio) {
		setReady(true);

#if MIXER_DOUBLE_BUFFERING
		initThreadedMixer(_obtainedRate.samples * 4);
#endif

		// start the sound system
		SDL_PauseAudio(0);
	}
	else {
		setReady(false);
	}
}

SdlMixerImpl::~SdlMixerImpl() {
	setReady(false);

	SDL_CloseAudio();

#if MIXER_DOUBLE_BUFFERING
	deinitThreadedMixer();
#endif
}

uint SdlMixerImpl::getSamplesPerSec() {
	SDL_AudioSpec desired;

	// Determine the desired output sampling frequency.
	uint32 samplesPerSec = 0;
	if (ConfMan.hasKey("output_rate"))
		samplesPerSec = ConfMan.getInt("output_rate");
	if (samplesPerSec <= 0)
		samplesPerSec = SAMPLES_PER_SEC;

	// Determine the sample buffer size. We want it to store enough data for
	// at least 1/16th of a second (though at most 8192 samples). Note
	// that it must be a power of two. So e.g. at 22050 Hz, we request a
	// sample buffer size of 2048.
	uint32 samples = 8192;
	while (samples * 16 > samplesPerSec * 2)
		samples >>= 1;

	memset(&desired, 0, sizeof(desired));
	desired.freq = samplesPerSec;
	desired.format = AUDIO_S16SYS;
	desired.channels = 2;
	desired.samples = (uint16)samples;
	desired.callback = mixSdlCallback;
	desired.userdata = this;

	if (SDL_OpenAudio(&desired, &_obtainedRate) != 0) {
		warning("Could not open audio device: %s", SDL_GetError());
		_openAudio = false;
	} else {
		// Note: This should be the obtained output rate, but it seems that at
		// least on some platforms SDL will lie and claim it did get the rate
		// even if it didn't. Probably only happens for "weird" rates, though.
		samplesPerSec = _obtainedRate.freq;
		debug(1, "Output sample rate: %d Hz", samplesPerSec);
		_openAudio = true;
	}
	return samplesPerSec;
}

#if MIXER_DOUBLE_BUFFERING

void SdlMixerImpl::mixerProducerThread() {
	byte nextSoundBuffer;

	SDL_LockMutex(_soundMutex);
	while (true) {
		// Wait till we are allowed to produce data
		SDL_CondWait(_soundCond, _soundMutex);

		if (_soundThreadShouldQuit)
			break;

		// Generate samples and put them into the next buffer
		nextSoundBuffer = _activeSoundBuf ^ 1;
		mixCallback(_soundBuffers[nextSoundBuffer], _soundBufSize);

		// Swap buffers
		_activeSoundBuf = nextSoundBuffer;
	}
	SDL_UnlockMutex(_soundMutex);
}

int SDLCALL SdlMixerImpl::mixerProducerThreadEntry(void *arg) {
	SdlMixerImpl *mixer = (SdlMixerImpl *)arg;
	assert(mixer);
	mixer->mixerProducerThread();
	return 0;
}


void SdlMixerImpl::initThreadedMixer(uint bufSize) {
	_soundThreadIsRunning = false;
	_soundThreadShouldQuit = false;

	// Create mutex and condition variable
	_soundMutex = SDL_CreateMutex();
	_soundCond = SDL_CreateCond();

	// Create two sound buffers
	_activeSoundBuf = 0;
	_soundBufSize = bufSize;
	_soundBuffers[0] = (byte *)calloc(1, bufSize);
	_soundBuffers[1] = (byte *)calloc(1, bufSize);

	_soundThreadIsRunning = true;

	// Finally start the thread
	_soundThread = SDL_CreateThread(mixerProducerThreadEntry, this);
}

void SdlMixerImpl::deinitThreadedMixer() {
	// Kill thread?? _soundThread

	if (_soundThreadIsRunning) {
		// Signal the producer thread to end, and wait for it to actually finish.
		_soundThreadShouldQuit = true;
		SDL_CondBroadcast(_soundCond);
		SDL_WaitThread(_soundThread, NULL);

		// Kill the mutex & cond variables.
		// Attention: AT this point, the mixer callback must not be running
		// anymore, else we will crash!
		SDL_DestroyMutex(_soundMutex);
		SDL_DestroyCond(_soundCond);

		_soundThreadIsRunning = false;

		free(_soundBuffers[0]);
		free(_soundBuffers[1]);
	}
}


void SdlMixerImpl::mixSdlCallback(void *arg, byte *samples, int len) {
	SdlMixerImpl *mixer = (SdlMixerImpl *)arg;
	assert(mixer);

	assert((int)mixer->getSoundBufSize() == len);

	// Lock mutex, to ensure our data is not overwritten by the producer thread
	g_system->lockMutex((OSystem::MutexRef)mixer->getSoundMutex());

	// Copy data from the current sound buffer
	memcpy(samples, mixer->getActiveSoundBuf(), len);

	// Unlock mutex and wake up the produced thread
	g_system->unlockMutex((OSystem::MutexRef)mixer->getSoundMutex());
	SDL_CondSignal(mixer->getSoundCond());
}

#else

void SdlMixerImpl::mixSdlCallback(void *sys, byte *samples, int len) {
	Audio::MixerImpl *mixer = (Audio::MixerImpl *)sys;
	assert(mixer);
	mixer->mixCallback(samples, len);
}

#endif

#endif