2 Copyright (C) 2003-2005 Mathieu Olivier
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to:
18 Free Software Foundation, Inc.
19 59 Temple Place - Suite 330
20 Boston, MA 02111-1307, USA
27 #include "snd_modplug.h"
29 #ifdef SND_MODPLUG_STATIC
31 #include <libmodplug/modplug.h>
32 qboolean ModPlug_OpenLibrary (void)
34 return true; // statically linked
36 void ModPlug_CloseLibrary (void)
42 // BEGIN SECTION FROM modplug.h
45 * This source code is public domain.
47 * Authors: Kenton Varda <temporal@gauge3d.org> (C interface wrapper)
52 MODPLUG_ENABLE_OVERSAMPLING = 1 << 0, /* Enable oversampling (*highly* recommended) */
53 MODPLUG_ENABLE_NOISE_REDUCTION = 1 << 1, /* Enable noise reduction */
54 MODPLUG_ENABLE_REVERB = 1 << 2, /* Enable reverb */
55 MODPLUG_ENABLE_MEGABASS = 1 << 3, /* Enable megabass */
56 MODPLUG_ENABLE_SURROUND = 1 << 4 /* Enable surround sound. */
59 enum _ModPlug_ResamplingMode
61 MODPLUG_RESAMPLE_NEAREST = 0, /* No interpolation (very fast, extremely bad sound quality) */
62 MODPLUG_RESAMPLE_LINEAR = 1, /* Linear interpolation (fast, good quality) */
63 MODPLUG_RESAMPLE_SPLINE = 2, /* Cubic spline interpolation (high quality) */
64 MODPLUG_RESAMPLE_FIR = 3 /* 8-tap fir filter (extremely high quality) */
67 typedef struct _ModPlug_Settings
69 int mFlags; /* One or more of the MODPLUG_ENABLE_* flags above, bitwise-OR'ed */
71 /* Note that ModPlug always decodes sound at 44100kHz, 32 bit, stereo and then
72 * down-mixes to the settings you choose. */
73 int mChannels; /* Number of channels - 1 for mono or 2 for stereo */
74 int mBits; /* Bits per sample - 8, 16, or 32 */
75 int mFrequency; /* Sampling rate - 11025, 22050, or 44100 */
76 int mResamplingMode; /* One of MODPLUG_RESAMPLE_*, above */
78 int mReverbDepth; /* Reverb level 0(quiet)-100(loud) */
79 int mReverbDelay; /* Reverb delay in ms, usually 40-200ms */
80 int mBassAmount; /* XBass level 0(quiet)-100(loud) */
81 int mBassRange; /* XBass cutoff in Hz 10-100 */
82 int mSurroundDepth; /* Surround level 0(quiet)-100(heavy) */
83 int mSurroundDelay; /* Surround delay in ms, usually 5-40ms */
84 int mLoopCount; /* Number of times to loop. Zero prevents looping.
89 typedef struct _ModPlugFile ModPlugFile;
91 // END SECTION FROM modplug.h
93 static ModPlugFile* (*ModPlug_Load) (const void* data, int size);
94 static void (*ModPlug_Unload) (ModPlugFile* file);
95 static int (*ModPlug_Read) (ModPlugFile* file, void* buffer, int size);
96 static void (*ModPlug_Seek) (ModPlugFile* file, int millisecond);
97 static void (*ModPlug_GetSettings) (ModPlug_Settings* settings);
98 static void (*ModPlug_SetSettings) (const ModPlug_Settings* settings);
99 static void (*ModPlug_SetMasterVolume) (ModPlugFile* file,unsigned int cvol) ;
102 static dllfunction_t modplugfuncs[] =
104 {"ModPlug_Load", (void **) &ModPlug_Load},
105 {"ModPlug_Unload", (void **) &ModPlug_Unload},
106 {"ModPlug_Read", (void **) &ModPlug_Read},
107 {"ModPlug_Seek", (void **) &ModPlug_Seek},
108 {"ModPlug_GetSettings", (void **) &ModPlug_GetSettings},
109 {"ModPlug_SetSettings", (void **) &ModPlug_SetSettings},
113 // Handles for the modplug and modplugfile DLLs
114 static dllhandle_t modplug_dll = NULL;
117 =================================================================
121 =================================================================
128 Try to load the modplugFile DLL
131 qboolean ModPlug_OpenLibrary (void)
133 const char* dllnames_modplug [] =
140 #elif defined(MACOSX)
153 // COMMANDLINEOPTION: Sound: -nomodplug disables modplug sound support
154 if (COM_CheckParm("-nomodplug"))
158 // We need to load both by hand because some OSes seem to not load
159 // the modplug DLL automatically when loading the modplugFile DLL
160 if(Sys_LoadLibrary (dllnames_modplug, &modplug_dll, modplugfuncs))
162 ModPlug_SetMasterVolume = Sys_GetProcAddress(modplug_dll, "ModPlug_SetMasterVolume");
163 if(!ModPlug_SetMasterVolume)
164 Con_Print("Warning: modplug volume control not supported. Try getting a newer version of libmodplug.\n");
176 Unload the modplugFile DLL
179 void ModPlug_CloseLibrary (void)
181 Sys_UnloadLibrary (&modplug_dll);
187 =================================================================
191 =================================================================
194 #define STREAM_BUFFER_DURATION 1.5f // 1.5 sec
195 #define STREAM_BUFFER_SIZE(format_ptr) ((int)(ceil (STREAM_BUFFER_DURATION * ((format_ptr)->speed * (format_ptr)->width * (format_ptr)->channels))))
196 // We work with 1 sec sequences, so this buffer must be able to contain
197 // 1 sec of sound of the highest quality (48 KHz, 16 bit samples, stereo)
198 static unsigned char resampling_buffer [48000 * 2 * 2];
201 // Per-sfx data structure
207 unsigned int total_length;
210 } modplug_stream_persfx_t;
212 // Per-channel data structure
216 unsigned int sb_offset;
218 snd_buffer_t sb; // must be at the end due to its dynamically allocated size
219 } modplug_stream_perchannel_t;
227 static const snd_buffer_t* ModPlug_FetchSound (void *sfxfetcher, void **chfetcherpointer, unsigned int *start, unsigned int nbsampleframes)
229 modplug_stream_perchannel_t* per_ch = (modplug_stream_perchannel_t *)*chfetcherpointer;
230 modplug_stream_persfx_t* per_sfx = (modplug_stream_persfx_t *)sfxfetcher;
232 int newlength, done, ret;
233 unsigned int real_start;
236 // If there's no fetcher structure attached to the channel yet
239 size_t buff_len, memsize;
240 snd_format_t sb_format;
242 sb_format.speed = snd_renderbuffer->format.speed;
243 sb_format.width = per_sfx->format.width;
244 sb_format.channels = per_sfx->format.channels;
246 buff_len = STREAM_BUFFER_SIZE(&sb_format);
247 memsize = sizeof (*per_ch) - sizeof (per_ch->sb.samples) + buff_len;
248 per_ch = (modplug_stream_perchannel_t *)Mem_Alloc (snd_mempool, memsize);
250 // Open it with the modplugFile API
251 per_ch->mf = ModPlug_Load(per_sfx->file, per_sfx->filesize);
254 Con_Printf("error while reading ModPlug stream \"%s\"\n", per_sfx->name);
259 #ifndef SND_MODPLUG_STATIC
260 if(ModPlug_SetMasterVolume)
262 ModPlug_SetMasterVolume(per_ch->mf, 512); // max volume, DP scales down!
266 per_ch->sb_offset = 0;
267 per_ch->sb.format = sb_format;
268 per_ch->sb.nbframes = 0;
269 per_ch->sb.maxframes = buff_len / (per_ch->sb.format.channels * per_ch->sb.format.width);
271 *chfetcherpointer = per_ch;
277 factor = per_sfx->format.width * per_sfx->format.channels;
279 // If the stream buffer can't contain that much samples anyway
280 if (nbsampleframes > sb->maxframes)
282 Con_Printf ("ModPlug_FetchSound: stream buffer too small (%u sample frames required)\n", nbsampleframes);
286 // If the data we need has already been decompressed in the sfxbuffer, just return it
287 if (per_ch->sb_offset <= real_start && per_ch->sb_offset + sb->nbframes >= real_start + nbsampleframes)
289 *start = per_ch->sb_offset;
293 newlength = (int)(per_ch->sb_offset + sb->nbframes) - real_start;
295 // If we need to skip some data before decompressing the rest, or if the stream has looped
296 if (newlength < 0 || per_ch->sb_offset > real_start)
298 unsigned int time_start;
299 unsigned int modplug_start;
302 MODs loop on their own, so any position is valid!
303 if (real_start > (unsigned int)per_sfx->total_length)
305 Con_Printf ("ModPlug_FetchSound: asked for a start position after the end of the sfx! (%u > %u)\n",
306 real_start, per_sfx->total_length);
311 // We work with 200ms (1/5 sec) steps to avoid rounding errors
312 time_start = real_start * 5 / snd_renderbuffer->format.speed;
313 modplug_start = time_start * (1000 / 5);
315 Con_DPrintf("warning: mod file needed to seek (to %d)\n", modplug_start);
317 ModPlug_Seek(per_ch->mf, modplug_start);
320 real_start = (float)modplug_start / 1000 * snd_renderbuffer->format.speed;
321 if (*start - real_start + nbsampleframes > sb->maxframes)
323 Con_Printf ("ModPlug_FetchSound: stream buffer too small after seek (%u sample frames required)\n",
324 *start - real_start + nbsampleframes);
325 per_ch->sb_offset = real_start;
329 // Else, move forward the samples we need to keep in the sound buffer
332 memmove (sb->samples, sb->samples + (real_start - per_ch->sb_offset) * factor, newlength * factor);
333 sb->nbframes = newlength;
336 per_ch->sb_offset = real_start;
338 // We add exactly 1 sec of sound to the buffer:
339 // 1- to ensure we won't lose any sample during the resampling process
340 // 2- to force one call to ModPlug_FetchSound per second to regulate the workload
341 if (sb->format.speed + sb->nbframes > sb->maxframes)
343 Con_Printf ("ModPlug_FetchSound: stream buffer overflow (%u sample frames / %u)\n",
344 sb->format.speed + sb->nbframes, sb->maxframes);
347 newlength = per_sfx->format.speed * factor; // -> 1 sec of sound before resampling
348 if(newlength > (int)sizeof(resampling_buffer))
349 newlength = sizeof(resampling_buffer);
351 // Decompress in the resampling_buffer
353 while ((ret = ModPlug_Read (per_ch->mf, (char *)&resampling_buffer[done], (int)(newlength - done))) > 0)
357 // Argh. We didn't get as many samples as we wanted. Probably
358 // libmodplug forgot what mLoopCount==-1 means... basically, this means
359 // we can't loop like this. Try to let DP fix it later...
360 per_sfx->sfx->total_length = (real_start + ((size_t)done / (size_t)factor));
361 per_sfx->sfx->loopstart = 0;
363 if(newlength != done)
364 Con_DPrintf("ModPlug_Fetch: wanted: %d, got: %d\n", newlength, done);
367 Snd_AppendToSndBuffer (sb, resampling_buffer, (size_t)done / (size_t)factor, &per_sfx->format);
369 *start = per_ch->sb_offset;
379 static void ModPlug_FetchEnd (void *chfetcherdata)
381 modplug_stream_perchannel_t* per_ch = (modplug_stream_perchannel_t *)chfetcherdata;
385 // Free the modplug decoder
386 ModPlug_Unload (per_ch->mf);
398 static void ModPlug_FreeSfx (void *sfxfetcherdata)
400 modplug_stream_persfx_t* per_sfx = (modplug_stream_persfx_t *)sfxfetcherdata;
402 // Free the modplug file
403 Mem_Free(per_sfx->file);
405 // Free the stream structure
415 static const snd_format_t* ModPlug_GetFormat (sfx_t* sfx)
417 modplug_stream_persfx_t* per_sfx = (modplug_stream_persfx_t *)sfx->fetcher_data;
418 return &per_sfx->format;
421 static const snd_fetcher_t modplug_fetcher = { ModPlug_FetchSound, ModPlug_FetchEnd, ModPlug_FreeSfx, ModPlug_GetFormat };
426 ModPlug_LoadmodplugFile
428 Load an modplug file into memory
431 qboolean ModPlug_LoadModPlugFile (const char *filename, sfx_t *sfx)
434 fs_offset_t filesize;
436 modplug_stream_persfx_t* per_sfx;
443 if (sfx->fetcher != NULL)
447 data = FS_LoadFile (filename, snd_mempool, false, &filesize);
451 if (developer_loading.integer >= 2)
452 Con_Printf ("Loading ModPlug file \"%s\"\n", filename);
454 ModPlug_GetSettings(&s);
455 s.mFlags = MODPLUG_ENABLE_OVERSAMPLING | MODPLUG_ENABLE_NOISE_REDUCTION | MODPLUG_ENABLE_REVERB;
458 s.mFrequency = 44100;
459 s.mResamplingMode = MODPLUG_RESAMPLE_SPLINE;
461 ModPlug_SetSettings(&s);
463 // Open it with the modplugFile API
464 if (!(mf = ModPlug_Load (data, filesize)))
466 Con_Printf ("error while opening ModPlug file \"%s\"\n", filename);
471 #ifndef SND_MODPLUG_STATIC
472 if(ModPlug_SetMasterVolume)
474 ModPlug_SetMasterVolume(mf, 512); // max volume, DP scales down!
476 if (developer_loading.integer >= 2)
477 Con_Printf ("\"%s\" will be streamed\n", filename);
478 per_sfx = (modplug_stream_persfx_t *)Mem_Alloc (snd_mempool, sizeof (*per_sfx));
479 strlcpy(per_sfx->name, sfx->name, sizeof(per_sfx->name));
480 sfx->memsize += sizeof (*per_sfx);
481 per_sfx->file = data;
482 per_sfx->filesize = filesize;
483 sfx->memsize += filesize;
485 per_sfx->format.speed = 44100; // modplug always works at that rate
486 per_sfx->format.width = 2; // We always work with 16 bits samples
487 per_sfx->format.channels = 2; // stereo rulez ;) (MAYBE default to mono because Amiga MODs sound better then?)
490 sfx->fetcher_data = per_sfx;
491 sfx->fetcher = &modplug_fetcher;
492 sfx->flags |= SFXFLAG_STREAMED;
493 sfx->total_length = 2147384647; // they always loop
494 sfx->loopstart = sfx->total_length; // modplug does it