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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
|
// Emacs style mode select -*- C++ -*-
//-----------------------------------------------------------------------------
//
// Copyright(C) 1993-1996 Id Software, Inc.
// Copyright(C) 2005-8 Simon Howard
// Copyright(C) 2008 David Flater
//
// 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., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
// DESCRIPTION:
// System interface for sound.
//
//-----------------------------------------------------------------------------
#include "config.h"
#include <stdio.h>
#include <stdlib.h>
#include <assert.h>
#include "SDL.h"
#include "SDL_mixer.h"
#ifdef HAVE_LIBSAMPLERATE
#include <samplerate.h>
#endif
#include "deh_str.h"
#include "i_sound.h"
#include "i_system.h"
#include "m_argv.h"
#include "w_wad.h"
#include "z_zone.h"
#include "doomtype.h"
#define LOW_PASS_FILTER
#define NUM_CHANNELS 16
static boolean sound_initialised = false;
static sfxinfo_t *channels_playing[NUM_CHANNELS];
static int mixer_freq;
static Uint16 mixer_format;
static int mixer_channels;
static uint32_t (*ExpandSoundData)(byte *data, int samplerate, int length,
Mix_Chunk *destination) = NULL;
int use_libsamplerate = 0;
// The driver_data field is used to point to a Mix_Chunk structure that
// has data about the expanded version of the sound effect. These are
// allocated on demand.
static Mix_Chunk *GetSoundChunk(sfxinfo_t *sfxinfo)
{
Mix_Chunk *chunk;
// No chunk for this structure yet? Allocate it.
if (sfxinfo->driver_data == NULL)
{
chunk = Z_Malloc(sizeof(Mix_Chunk), PU_STATIC, NULL);
chunk->abuf = NULL;
chunk->allocated = 0;
sfxinfo->driver_data = chunk;
}
return sfxinfo->driver_data;
}
// When a sound stops, check if it is still playing. If it is not,
// we can mark the sound data as CACHE to be freed back for other
// means.
static void ReleaseSoundOnChannel(int channel)
{
int i;
sfxinfo_t *sfxinfo = channels_playing[channel];
Mix_Chunk *chunk;
if (sfxinfo == NULL)
{
return;
}
channels_playing[channel] = NULL;
for (i=0; i<NUM_CHANNELS; ++i)
{
// Playing on this channel? if so, don't release.
if (channels_playing[i] == sfxinfo)
return;
}
// Not used on any channel, and can be safely released
chunk = GetSoundChunk(sfxinfo);
Z_ChangeTag(chunk->abuf, PU_CACHE);
}
#ifdef HAVE_LIBSAMPLERATE
// Returns the conversion mode for libsamplerate to use.
static int SRC_ConversionMode(void)
{
switch (use_libsamplerate)
{
// 0 = disabled
default:
case 0:
return -1;
// Ascending numbers give higher quality
case 1:
return SRC_LINEAR;
case 2:
return SRC_ZERO_ORDER_HOLD;
case 3:
return SRC_SINC_FASTEST;
case 4:
return SRC_SINC_MEDIUM_QUALITY;
case 5:
return SRC_SINC_BEST_QUALITY;
}
}
// libsamplerate-based generic sound expansion function for any sample rate
// unsigned 8 bits --> signed 16 bits
// mono --> stereo
// samplerate --> mixer_freq
// Returns number of clipped samples.
// DWF 2008-02-10 with cleanups by Simon Howard.
static uint32_t ExpandSoundData_SRC(byte *data,
int samplerate,
int length,
Mix_Chunk *destination)
{
SRC_DATA src_data;
uint32_t i, abuf_index=0, clipped=0;
int retn;
int16_t *expanded;
src_data.input_frames = length;
src_data.data_in = malloc(length * sizeof(float));
src_data.src_ratio = (double)mixer_freq / samplerate;
// We include some extra space here in case of rounding-up.
src_data.output_frames = src_data.src_ratio * length + (mixer_freq / 4);
src_data.data_out = malloc(src_data.output_frames * sizeof(float));
assert(src_data.data_in != NULL && src_data.data_out != NULL);
// Convert input data to floats
for (i=0; i<length; ++i)
{
// Unclear whether 128 should be interpreted as "zero" or whether a
// symmetrical range should be assumed. The following assumes a
// symmetrical range.
src_data.data_in[i] = data[i] / 127.5 - 1;
}
// Do the sound conversion
retn = src_simple(&src_data, SRC_ConversionMode(), 1);
assert(retn == 0);
// Convert the result back into 16-bit integers.
destination->alen = src_data.output_frames_gen * 4;
destination->abuf = Z_Malloc(destination->alen, PU_STATIC,
&destination->abuf);
expanded = (int16_t *) destination->abuf;
for (i=0; i<src_data.output_frames_gen; ++i)
{
// libsamplerate does not limit itself to the -1.0 .. 1.0 range on
// output, so a multiplier less than INT16_MAX (32767) is required
// to avoid overflows or clipping. However, the smaller the
// multiplier, the quieter the sound effects get, and the more you
// have to turn down the music to keep it in balance.
// 22265 is the largest multiplier that can be used to resample all
// of the Vanilla DOOM sound effects to 48 kHz without clipping
// using SRC_SINC_BEST_QUALITY. It is close enough (only slightly
// too conservative) for SRC_SINC_MEDIUM_QUALITY and
// SRC_SINC_FASTEST. PWADs with interestingly different sound
// effects or target rates other than 48 kHz might still result in
// clipping--I don't know if there's a limit to it.
// As the number of clipped samples increases, the signal is
// gradually overtaken by noise, with the loudest parts going first.
// However, a moderate amount of clipping is often tolerated in the
// quest for the loudest possible sound overall. The results of
// using INT16_MAX as the multiplier are not all that bad, but
// artifacts are noticeable during the loudest parts.
float cvtval_f = src_data.data_out[i] * 22265;
int32_t cvtval_i = cvtval_f + (cvtval_f < 0 ? -0.5 : 0.5);
// Asymmetrical sound worries me, so we won't use -32768.
if (cvtval_i < -INT16_MAX) {
cvtval_i = -INT16_MAX;
++clipped;
} else if (cvtval_i > INT16_MAX) {
cvtval_i = INT16_MAX;
++clipped;
}
// Left and right channels
expanded[abuf_index++] = cvtval_i;
expanded[abuf_index++] = cvtval_i;
}
free(src_data.data_in);
free(src_data.data_out);
return clipped;
}
#endif
static boolean ConvertibleRatio(int freq1, int freq2)
{
int ratio;
if (freq1 > freq2)
{
return ConvertibleRatio(freq2, freq1);
}
else if ((freq2 % freq1) != 0)
{
// Not in a direct ratio
return false;
}
else
{
// Check the ratio is a power of 2
ratio = freq2 / freq1;
while ((ratio & 1) == 0)
{
ratio = ratio >> 1;
}
return ratio == 1;
}
}
// Generic sound expansion function for any sample rate.
// Returns number of clipped samples (always 0).
static uint32_t ExpandSoundData_SDL(byte *data,
int samplerate,
int length,
Mix_Chunk *destination)
{
SDL_AudioCVT convertor;
uint32_t expanded_length;
// Calculate the length of the expanded version of the sample.
expanded_length = (uint32_t) ((((uint64_t) length) * mixer_freq) / samplerate);
// Double up twice: 8 -> 16 bit and mono -> stereo
expanded_length *= 4;
destination->alen = expanded_length;
destination->abuf
= Z_Malloc(expanded_length, PU_STATIC, &destination->abuf);
// If we can, use the standard / optimised SDL conversion routines.
if (samplerate <= mixer_freq
&& ConvertibleRatio(samplerate, mixer_freq)
&& SDL_BuildAudioCVT(&convertor,
AUDIO_U8, 1, samplerate,
mixer_format, mixer_channels, mixer_freq))
{
convertor.buf = destination->abuf;
convertor.len = length;
memcpy(convertor.buf, data, length);
SDL_ConvertAudio(&convertor);
}
else
{
Sint16 *expanded = (Sint16 *) destination->abuf;
int expanded_length;
int expand_ratio;
int i;
// Generic expansion if conversion does not work:
//
// SDL's audio conversion only works for rate conversions that are
// powers of 2; if the two formats are not in a direct power of 2
// ratio, do this naive conversion instead.
// number of samples in the converted sound
expanded_length = ((uint64_t) length * mixer_freq) / samplerate;
expand_ratio = (length << 8) / expanded_length;
for (i=0; i<expanded_length; ++i)
{
Sint16 sample;
int src;
src = (i * expand_ratio) >> 8;
sample = data[src] | (data[src] << 8);
sample -= 32768;
// expand 8->16 bits, mono->stereo
expanded[i * 2] = expanded[i * 2 + 1] = sample;
}
#ifdef LOW_PASS_FILTER
// Perform a low-pass filter on the upscaled sound to filter
// out high-frequency noise from the conversion process.
{
float rc, dt, alpha;
// Low-pass filter for cutoff frequency f:
//
// For sampling rate r, dt = 1 / r
// rc = 1 / 2*pi*f
// alpha = dt / (rc + dt)
// Filter to the half sample rate of the original sound effect
// (maximum frequency, by nyquist)
dt = 1.0f / mixer_freq;
rc = 1.0f / (3.14f * samplerate);
alpha = dt / (rc + dt);
for (i=1; i<expanded_length; ++i)
{
expanded[i] = (Sint16) (alpha * expanded[i] + (1 - alpha) * expanded[i-1]);
}
}
#endif /* #ifdef LOW_PASS_FILTER */
}
return 0;
}
// Load and convert a sound effect
// Returns true if successful
static boolean CacheSFX(sfxinfo_t *sfxinfo)
{
Mix_Chunk *chunk;
int lumpnum;
unsigned int lumplen;
int samplerate;
int clipped;
unsigned int length;
byte *data;
// need to load the sound
lumpnum = sfxinfo->lumpnum;
data = W_CacheLumpNum(lumpnum, PU_STATIC);
lumplen = W_LumpLength(lumpnum);
// Check the header, and ensure this is a valid sound
if (lumplen < 8
|| data[0] != 0x03 || data[1] != 0x00)
{
// Invalid sound
return false;
}
// 16 bit sample rate field, 32 bit length field
samplerate = (data[3] << 8) | data[2];
length = (data[7] << 24) | (data[6] << 16) | (data[5] << 8) | data[4];
// If the header specifies that the length of the sound is greater than
// the length of the lump itself, this is an invalid sound lump
if (length > lumplen - 8)
{
return false;
}
// Sample rate conversion
// DWF 2008-02-10: chunk->alen and abuf are determined
// by ExpandSoundData.
chunk = GetSoundChunk(sfxinfo);
chunk->allocated = 1;
chunk->volume = MIX_MAX_VOLUME;
clipped = ExpandSoundData(data + 8, samplerate, length, chunk);
if (clipped)
{
fprintf(stderr, "Sound '%s': clipped %u samples (%0.2f %%)\n",
sfxinfo->name, clipped,
400.0 * clipped / chunk->alen);
}
// don't need the original lump any more
W_ReleaseLumpNum(lumpnum);
return true;
}
#ifdef HAVE_LIBSAMPLERATE
// Preload all the sound effects - stops nasty ingame freezes
static void I_SDL_PrecacheSounds(sfxinfo_t *sounds, int num_sounds)
{
Mix_Chunk *chunk;
char namebuf[9];
int i;
// Don't need to precache the sounds unless we are using libsamplerate.
if (use_libsamplerate == 0)
{
return;
}
printf("I_SDL_PrecacheSounds: Precaching all sound effects..");
for (i=0; i<num_sounds; ++i)
{
if ((i % 6) == 0)
{
printf(".");
fflush(stdout);
}
sprintf(namebuf, "ds%s", DEH_String(sounds[i].name));
sounds[i].lumpnum = W_CheckNumForName(namebuf);
if (sounds[i].lumpnum != -1)
{
CacheSFX(&sounds[i]);
chunk = GetSoundChunk(&sounds[i]);
if (chunk->abuf != NULL)
{
Z_ChangeTag(chunk->abuf, PU_CACHE);
}
}
}
printf("\n");
}
#else
static void I_SDL_PrecacheSounds(sfxinfo_t *sounds, int num_sounds)
{
// no-op
}
#endif
// Load a SFX chunk into memory and ensure that it is locked.
static boolean LockSound(sfxinfo_t *sfxinfo)
{
Mix_Chunk *chunk;
chunk = GetSoundChunk(sfxinfo);
if (chunk->abuf == NULL)
{
// Not yet loaded, or has been freed. Load the sound data.
if (!CacheSFX(sfxinfo))
{
return false;
}
}
else
{
// don't free the sound while it is playing!
Z_ChangeTag(chunk->abuf, PU_STATIC);
}
return true;
}
//
// Retrieve the raw data lump index
// for a given SFX name.
//
static int I_SDL_GetSfxLumpNum(sfxinfo_t* sfx)
{
char namebuf[9];
sprintf(namebuf, "ds%s", DEH_String(sfx->name));
return W_GetNumForName(namebuf);
}
static void I_SDL_UpdateSoundParams(int handle, int vol, int sep)
{
int left, right;
if (!sound_initialised)
{
return;
}
left = ((254 - sep) * vol) / 127;
right = ((sep) * vol) / 127;
Mix_SetPanning(handle, left, right);
}
//
// Starting a sound means adding it
// to the current list of active sounds
// in the internal channels.
// As the SFX info struct contains
// e.g. a pointer to the raw data,
// it is ignored.
// As our sound handling does not handle
// priority, it is ignored.
// Pitching (that is, increased speed of playback)
// is set, but currently not used by mixing.
//
static int I_SDL_StartSound(sfxinfo_t *sfxinfo, int channel, int vol, int sep)
{
Mix_Chunk *chunk;
if (!sound_initialised)
{
return -1;
}
// Release a sound effect if there is already one playing
// on this channel
ReleaseSoundOnChannel(channel);
// Get the sound data
if (!LockSound(sfxinfo))
{
return -1;
}
chunk = GetSoundChunk(sfxinfo);
// play sound
Mix_PlayChannelTimed(channel, chunk, 0, -1);
channels_playing[channel] = sfxinfo;
// set separation, etc.
I_SDL_UpdateSoundParams(channel, vol, sep);
return channel;
}
static void I_SDL_StopSound (int handle)
{
if (!sound_initialised)
{
return;
}
Mix_HaltChannel(handle);
// Sound data is no longer needed; release the
// sound data being used for this channel
ReleaseSoundOnChannel(handle);
}
static boolean I_SDL_SoundIsPlaying(int handle)
{
if (handle < 0)
{
return false;
}
return Mix_Playing(handle);
}
//
// Periodically called to update the sound system
//
static void I_SDL_UpdateSound(void)
{
int i;
// Check all channels to see if a sound has finished
for (i=0; i<NUM_CHANNELS; ++i)
{
if (channels_playing[i] && !I_SDL_SoundIsPlaying(i))
{
// Sound has finished playing on this channel,
// but sound data has not been released to cache
ReleaseSoundOnChannel(i);
}
}
}
static void I_SDL_ShutdownSound(void)
{
if (!sound_initialised)
{
return;
}
Mix_CloseAudio();
SDL_QuitSubSystem(SDL_INIT_AUDIO);
sound_initialised = false;
}
static boolean I_SDL_InitSound(void)
{
int i;
// No sounds yet
for (i=0; i<NUM_CHANNELS; ++i)
{
channels_playing[i] = NULL;
}
if (SDL_Init(SDL_INIT_AUDIO) < 0)
{
fprintf(stderr, "Unable to set up sound.\n");
return false;
}
if (Mix_OpenAudio(snd_samplerate, AUDIO_S16SYS, 2, 1024) < 0)
{
fprintf(stderr, "Error initialising SDL_mixer: %s\n", Mix_GetError());
return false;
}
ExpandSoundData = ExpandSoundData_SDL;
Mix_QuerySpec(&mixer_freq, &mixer_format, &mixer_channels);
#ifdef HAVE_LIBSAMPLERATE
if (use_libsamplerate != 0)
{
if (SRC_ConversionMode() < 0)
{
I_Error("I_SDL_InitSound: Invalid value for use_libsamplerate: %i",
use_libsamplerate);
}
ExpandSoundData = ExpandSoundData_SRC;
}
#else
if (use_libsamplerate != 0)
{
fprintf(stderr, "I_SDL_InitSound: use_libsamplerate=%i, but "
"libsamplerate support not compiled in.\n",
use_libsamplerate);
}
#endif
Mix_AllocateChannels(NUM_CHANNELS);
SDL_PauseAudio(0);
sound_initialised = true;
return true;
}
static snddevice_t sound_sdl_devices[] =
{
SNDDEVICE_SB,
SNDDEVICE_PAS,
SNDDEVICE_GUS,
SNDDEVICE_WAVEBLASTER,
SNDDEVICE_SOUNDCANVAS,
SNDDEVICE_AWE32,
};
sound_module_t sound_sdl_module =
{
sound_sdl_devices,
arrlen(sound_sdl_devices),
I_SDL_InitSound,
I_SDL_ShutdownSound,
I_SDL_GetSfxLumpNum,
I_SDL_UpdateSound,
I_SDL_UpdateSoundParams,
I_SDL_StartSound,
I_SDL_StopSound,
I_SDL_SoundIsPlaying,
I_SDL_PrecacheSounds,
};
|