snd_modplug.c

   1 /*
   2         Copyright (C) 2003-2005  Mathieu Olivier
   3
   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.
   8
   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.
  12
  13         See the GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with this program; if not, write to:
  17
  18                 Free Software Foundation, Inc.
  19                 59 Temple Place - Suite 330
  20                 Boston, MA  02111-1307, USA
  21
  22 */
  23
  24
  25 #include "quakedef.h"
  26 #include "snd_main.h"
  27 #include "snd_modplug.h"
  28
  29 #ifdef SND_MODPLUG_STATIC
  30
  31 #include <libmodplug/modplug.h>
  32 qboolean ModPlug_OpenLibrary (void)
  33 {
  34         return true; // statically linked
  35 }
  36 void ModPlug_CloseLibrary (void)
  37 {
  38 }
  39 #define modplug_dll 1
  40
  41 #else
  42 // BEGIN SECTION FROM modplug.h
  43
  44         /*
  45          * This source code is public domain.
  46          *
  47          * Authors: Kenton Varda <temporal@gauge3d.org> (C interface wrapper)
  48          */
  49
  50         enum _ModPlug_Flags
  51         {
  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. */
  57         };
  58
  59         enum _ModPlug_ResamplingMode
  60         {
  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) */
  65         };
  66
  67         typedef struct _ModPlug_Settings
  68         {
  69                         int mFlags;  /* One or more of the MODPLUG_ENABLE_* flags above, bitwise-OR'ed */
  70
  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 */
  77
  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.
  85                                                                         -1 loops forever. */
  86         } ModPlug_Settings;
  87
  88         struct _ModPlugFile;
  89         typedef struct _ModPlugFile ModPlugFile;
  90
  91 // END SECTION FROM modplug.h
  92
  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
 100 static dllfunction_t modplugfuncs[] =
 101 {
 102         {"ModPlug_Load",                        (void **) &ModPlug_Load},
 103         {"ModPlug_Unload",                      (void **) &ModPlug_Unload},
 104         {"ModPlug_Read",                        (void **) &ModPlug_Read},
 105         {"ModPlug_Seek",                        (void **) &ModPlug_Seek},
 106         {"ModPlug_GetSettings",         (void **) &ModPlug_GetSettings},
 107         {"ModPlug_SetSettings",         (void **) &ModPlug_SetSettings},
 108         {NULL, NULL}
 109 };
 110
 111 // Handles for the modplug and modplugfile DLLs
 112 static dllhandle_t modplug_dll = NULL;
 113
 114 /*
 115 =================================================================
 116
 117   DLL load & unload
 118
 119 =================================================================
 120 */
 121
 122 /*
 123 ====================
 124 ModPlug_OpenLibrary
 125
 126 Try to load the modplugFile DLL
 127 ====================
 128 */
 129 qboolean ModPlug_OpenLibrary (void)
 130 {
 131         const char* dllnames_modplug [] =
 132         {
 133 #if defined(WIN64)
 134                 "libmodplug64.dll",
 135 #elif defined(WIN32)
 136                 "libmodplug-0.dll",
 137                 "modplug.dll",
 138 #elif defined(MACOSX)
 139                 "libmodplug.dylib",
 140 #else
 141                 "libmodplug.so.0",
 142                 "libmodplug.so",
 143 #endif
 144                 NULL
 145         };
 146
 147         // Already loaded?
 148         if (modplug_dll)
 149                 return true;
 150
 151 // COMMANDLINEOPTION: Sound: -nomodplug disables modplug sound support
 152         if (COM_CheckParm("-nomodplug"))
 153                 return false;
 154
 155         // Load the DLLs
 156         // We need to load both by hand because some OSes seem to not load
 157         // the modplug DLL automatically when loading the modplugFile DLL
 158         if (! Sys_LoadLibrary (dllnames_modplug, &modplug_dll, modplugfuncs))
 159         {
 160                 Sys_UnloadLibrary (&modplug_dll);
 161                 Con_Printf ("ModPlug support disabled\n");
 162                 return false;
 163         }
 164
 165         Con_Printf ("ModPlug support enabled\n");
 166         return true;
 167 }
 168
 169
 170 /*
 171 ====================
 172 ModPlug_CloseLibrary
 173
 174 Unload the modplugFile DLL
 175 ====================
 176 */
 177 void ModPlug_CloseLibrary (void)
 178 {
 179         Sys_UnloadLibrary (&modplug_dll);
 180 }
 181 #endif
 182
 183
 184 /*
 185 =================================================================
 186
 187         modplug decoding
 188
 189 =================================================================
 190 */
 191
 192 #define STREAM_BUFFER_DURATION 1.5f     // 1.5 sec
 193 #define STREAM_BUFFER_SIZE(format_ptr) ((int)(ceil (STREAM_BUFFER_DURATION * ((format_ptr)->speed * (format_ptr)->width * (format_ptr)->channels))))
 194 // We work with 1 sec sequences, so this buffer must be able to contain
 195 // 1 sec of sound of the highest quality (48 KHz, 16 bit samples, stereo)
 196 static unsigned char resampling_buffer [48000 * 2 * 2];
 197
 198
 199 // Per-sfx data structure
 200 typedef struct
 201 {
 202         unsigned char   *file;
 203         size_t                  filesize;
 204         snd_format_t    format;
 205         unsigned int    total_length;
 206         char                    name[128];
 207         sfx_t           *sfx;
 208 } modplug_stream_persfx_t;
 209
 210 // Per-channel data structure
 211 typedef struct
 212 {
 213         ModPlugFile     *mf;
 214         unsigned int    sb_offset;
 215         int                             bs;
 216         snd_buffer_t    sb;             // must be at the end due to its dynamically allocated size
 217 } modplug_stream_perchannel_t;
 218
 219
 220 /*
 221 ====================
 222 ModPlug_FetchSound
 223 ====================
 224 */
 225 static const snd_buffer_t* ModPlug_FetchSound (void *sfxfetcher, void **chfetcherpointer, unsigned int *start, unsigned int nbsampleframes)
 226 {
 227         modplug_stream_perchannel_t* per_ch = (modplug_stream_perchannel_t *)*chfetcherpointer;
 228         modplug_stream_persfx_t* per_sfx = (modplug_stream_persfx_t *)sfxfetcher;
 229         snd_buffer_t* sb;
 230         int newlength, done, ret;
 231         unsigned int real_start;
 232         unsigned int factor;
 233
 234         // If there's no fetcher structure attached to the channel yet
 235         if (per_ch == NULL)
 236         {
 237                 size_t buff_len, memsize;
 238                 snd_format_t sb_format;
 239
 240                 sb_format.speed = snd_renderbuffer->format.speed;
 241                 sb_format.width = per_sfx->format.width;
 242                 sb_format.channels = per_sfx->format.channels;
 243
 244                 buff_len = STREAM_BUFFER_SIZE(&sb_format);
 245                 memsize = sizeof (*per_ch) - sizeof (per_ch->sb.samples) + buff_len;
 246                 per_ch = (modplug_stream_perchannel_t *)Mem_Alloc (snd_mempool, memsize);
 247
 248                 // Open it with the modplugFile API
 249                 per_ch->mf = ModPlug_Load(per_sfx->file, per_sfx->filesize);
 250                 if (!per_ch->mf)
 251                 {
 252                         Con_Printf("error while reading ModPlug stream \"%s\"\n", per_sfx->name);
 253                         Mem_Free (per_ch);
 254                         return NULL;
 255                 }
 256                 per_ch->bs = 0;
 257
 258                 per_ch->sb_offset = 0;
 259                 per_ch->sb.format = sb_format;
 260                 per_ch->sb.nbframes = 0;
 261                 per_ch->sb.maxframes = buff_len / (per_ch->sb.format.channels * per_ch->sb.format.width);
 262
 263                 *chfetcherpointer = per_ch;
 264         }
 265
 266         real_start = *start;
 267
 268         sb = &per_ch->sb;
 269         factor = per_sfx->format.width * per_sfx->format.channels;
 270
 271         // If the stream buffer can't contain that much samples anyway
 272         if (nbsampleframes > sb->maxframes)
 273         {
 274                 Con_Printf ("ModPlug_FetchSound: stream buffer too small (%u sample frames required)\n", nbsampleframes);
 275                 return NULL;
 276         }
 277
 278         // If the data we need has already been decompressed in the sfxbuffer, just return it
 279         if (per_ch->sb_offset <= real_start && per_ch->sb_offset + sb->nbframes >= real_start + nbsampleframes)
 280         {
 281                 *start = per_ch->sb_offset;
 282                 return sb;
 283         }
 284
 285         newlength = (int)(per_ch->sb_offset + sb->nbframes) - real_start;
 286
 287         // If we need to skip some data before decompressing the rest, or if the stream has looped
 288         if (newlength < 0 || per_ch->sb_offset > real_start)
 289         {
 290                 unsigned int time_start;
 291                 unsigned int modplug_start;
 292
 293                 /*
 294                 MODs loop on their own, so any position is valid!
 295                 if (real_start > (unsigned int)per_sfx->total_length)
 296                 {
 297                         Con_Printf ("ModPlug_FetchSound: asked for a start position after the end of the sfx! (%u > %u)\n",
 298                                                 real_start, per_sfx->total_length);
 299                         return NULL;
 300                 }
 301                 */
 302
 303                 // We work with 200ms (1/5 sec) steps to avoid rounding errors
 304                 time_start = real_start * 5 / snd_renderbuffer->format.speed;
 305                 modplug_start = time_start * (1000 / 5);
 306
 307                 Con_DPrintf("warning: mod file needed to seek (to %d)\n", modplug_start);
 308
 309                 ModPlug_Seek(per_ch->mf, modplug_start);
 310                 sb->nbframes = 0;
 311
 312                 real_start = (float)modplug_start / 1000 * snd_renderbuffer->format.speed;
 313                 if (*start - real_start + nbsampleframes > sb->maxframes)
 314                 {
 315                         Con_Printf ("ModPlug_FetchSound: stream buffer too small after seek (%u sample frames required)\n",
 316                                                 *start - real_start + nbsampleframes);
 317                         per_ch->sb_offset = real_start;
 318                         return NULL;
 319                 }
 320         }
 321         // Else, move forward the samples we need to keep in the sound buffer
 322         else
 323         {
 324                 memmove (sb->samples, sb->samples + (real_start - per_ch->sb_offset) * factor, newlength * factor);
 325                 sb->nbframes = newlength;
 326         }
 327
 328         per_ch->sb_offset = real_start;
 329
 330         // We add exactly 1 sec of sound to the buffer:
 331         // 1- to ensure we won't lose any sample during the resampling process
 332         // 2- to force one call to ModPlug_FetchSound per second to regulate the workload
 333         if (sb->format.speed + sb->nbframes > sb->maxframes)
 334         {
 335                 Con_Printf ("ModPlug_FetchSound: stream buffer overflow (%u sample frames / %u)\n",
 336                                         sb->format.speed + sb->nbframes, sb->maxframes);
 337                 return NULL;
 338         }
 339         newlength = per_sfx->format.speed * factor;  // -> 1 sec of sound before resampling
 340         if(newlength > (int)sizeof(resampling_buffer))
 341                 newlength = sizeof(resampling_buffer);
 342
 343         // Decompress in the resampling_buffer
 344         done = 0;
 345         while ((ret = ModPlug_Read (per_ch->mf, (char *)&resampling_buffer[done], (int)(newlength - done))) > 0)
 346                 done += ret;
 347         if(done < newlength)
 348         {
 349                 // Argh. We didn't get as many samples as we wanted. Probably
 350                 // libmodplug forgot what mLoopCount==-1 means... basically, this means
 351                 // we can't loop like this. Try to let DP fix it later...
 352                 per_sfx->sfx->total_length = (real_start + ((size_t)done / (size_t)factor));
 353                 per_sfx->sfx->loopstart = 0;
 354
 355                 if(newlength != done)
 356                         Con_DPrintf("ModPlug_Fetch: wanted: %d, got: %d\n", newlength, done);
 357         }
 358
 359         Snd_AppendToSndBuffer (sb, resampling_buffer, (size_t)done / (size_t)factor, &per_sfx->format);
 360
 361         *start = per_ch->sb_offset;
 362         return sb;
 363 }
 364
 365
 366 /*
 367 ====================
 368 ModPlug_FetchEnd
 369 ====================
 370 */
 371 static void ModPlug_FetchEnd (void *chfetcherdata)
 372 {
 373         modplug_stream_perchannel_t* per_ch = (modplug_stream_perchannel_t *)chfetcherdata;
 374
 375         if (per_ch != NULL)
 376         {
 377                 // Free the modplug decoder
 378                 ModPlug_Unload (per_ch->mf);
 379
 380                 Mem_Free (per_ch);
 381         }
 382 }
 383
 384
 385 /*
 386 ====================
 387 ModPlug_FreeSfx
 388 ====================
 389 */
 390 static void ModPlug_FreeSfx (void *sfxfetcherdata)
 391 {
 392         modplug_stream_persfx_t* per_sfx = (modplug_stream_persfx_t *)sfxfetcherdata;
 393
 394         // Free the modplug file
 395         Mem_Free(per_sfx->file);
 396
 397         // Free the stream structure
 398         Mem_Free(per_sfx);
 399 }
 400
 401
 402 /*
 403 ====================
 404 ModPlug_GetFormat
 405 ====================
 406 */
 407 static const snd_format_t* ModPlug_GetFormat (sfx_t* sfx)
 408 {
 409         modplug_stream_persfx_t* per_sfx = (modplug_stream_persfx_t *)sfx->fetcher_data;
 410         return &per_sfx->format;
 411 }
 412
 413 static const snd_fetcher_t modplug_fetcher = { ModPlug_FetchSound, ModPlug_FetchEnd, ModPlug_FreeSfx, ModPlug_GetFormat };
 414
 415
 416 /*
 417 ====================
 418 ModPlug_LoadmodplugFile
 419
 420 Load an modplug file into memory
 421 ====================
 422 */
 423 qboolean ModPlug_LoadModPlugFile (const char *filename, sfx_t *sfx)
 424 {
 425         unsigned char *data;
 426         fs_offset_t filesize;
 427         ModPlugFile *mf;
 428         modplug_stream_persfx_t* per_sfx;
 429         ModPlug_Settings s;
 430
 431         if (!modplug_dll)
 432                 return false;
 433
 434         // Already loaded?
 435         if (sfx->fetcher != NULL)
 436                 return true;
 437
 438         // Load the file
 439         data = FS_LoadFile (filename, snd_mempool, false, &filesize);
 440         if (data == NULL)
 441                 return false;
 442
 443         Con_DPrintf ("Loading ModPlug file \"%s\"\n", filename);
 444
 445         ModPlug_GetSettings(&s);
 446         s.mFlags = MODPLUG_ENABLE_OVERSAMPLING | MODPLUG_ENABLE_NOISE_REDUCTION | MODPLUG_ENABLE_REVERB;
 447         s.mChannels = 2;
 448         s.mBits = 16;
 449         s.mFrequency = 44100;
 450         s.mResamplingMode = MODPLUG_RESAMPLE_SPLINE;
 451         s.mLoopCount = -1;
 452         ModPlug_SetSettings(&s);
 453
 454         // Open it with the modplugFile API
 455         if (!(mf = ModPlug_Load (data, filesize)))
 456         {
 457                 Con_Printf ("error while opening ModPlug file \"%s\"\n", filename);
 458                 Mem_Free(data);
 459                 return false;
 460         }
 461
 462         Con_DPrintf ("\"%s\" will be streamed\n", filename);
 463         per_sfx = (modplug_stream_persfx_t *)Mem_Alloc (snd_mempool, sizeof (*per_sfx));
 464         strlcpy(per_sfx->name, sfx->name, sizeof(per_sfx->name));
 465         sfx->memsize += sizeof (*per_sfx);
 466         per_sfx->file = data;
 467         per_sfx->filesize = filesize;
 468         sfx->memsize += filesize;
 469
 470         per_sfx->format.speed = 44100; // modplug always works at that rate
 471         per_sfx->format.width = 2;  // We always work with 16 bits samples
 472         per_sfx->format.channels = 2; // stereo rulez ;) (MAYBE default to mono because Amiga MODs sound better then?)
 473         per_sfx->sfx = sfx;
 474
 475         sfx->fetcher_data = per_sfx;
 476         sfx->fetcher = &modplug_fetcher;
 477         sfx->flags |= SFXFLAG_STREAMED;
 478         sfx->total_length = 2147384647; // they always loop
 479         sfx->loopstart = sfx->total_length; // modplug does it
 480
 481         return true;
 482 }