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 typedef void (ModPlug_SetMasterVolume_t) (ModPlugFile* file,unsigned int cvol) ;
 100 ModPlug_SetMasterVolume_t *ModPlug_SetMasterVolume;
 101
 102
 103 static dllfunction_t modplugfuncs[] =
 104 {
 105         {"ModPlug_Load",                        (void **) &ModPlug_Load},
 106         {"ModPlug_Unload",                      (void **) &ModPlug_Unload},
 107         {"ModPlug_Read",                        (void **) &ModPlug_Read},
 108         {"ModPlug_Seek",                        (void **) &ModPlug_Seek},
 109         {"ModPlug_GetSettings",         (void **) &ModPlug_GetSettings},
 110         {"ModPlug_SetSettings",         (void **) &ModPlug_SetSettings},
 111         {NULL, NULL}
 112 };
 113
 114 // Handles for the modplug and modplugfile DLLs
 115 static dllhandle_t modplug_dll = NULL;
 116
 117 /*
 118 =================================================================
 119
 120   DLL load & unload
 121
 122 =================================================================
 123 */
 124
 125 /*
 126 ====================
 127 ModPlug_OpenLibrary
 128
 129 Try to load the modplugFile DLL
 130 ====================
 131 */
 132 qboolean ModPlug_OpenLibrary (void)
 133 {
 134         const char* dllnames_modplug [] =
 135         {
 136 #if defined(WIN32)
 137                 "libmodplug-0.dll",
 138                 "modplug.dll",
 139 #elif defined(MACOSX)
 140                 "libmodplug.dylib",
 141 #else
 142                 "libmodplug.so.0",
 143                 "libmodplug.so",
 144 #endif
 145                 NULL
 146         };
 147
 148         // Already loaded?
 149         if (modplug_dll)
 150                 return true;
 151
 152 // COMMANDLINEOPTION: Sound: -nomodplug disables modplug sound support
 153         if (COM_CheckParm("-nomodplug"))
 154                 return false;
 155
 156         // Load the DLLs
 157         // We need to load both by hand because some OSes seem to not load
 158         // the modplug DLL automatically when loading the modplugFile DLL
 159         if(Sys_LoadLibrary (dllnames_modplug, &modplug_dll, modplugfuncs))
 160         {
 161                 ModPlug_SetMasterVolume = (ModPlug_SetMasterVolume_t *) Sys_GetProcAddress(modplug_dll, "ModPlug_SetMasterVolume");
 162                 if(!ModPlug_SetMasterVolume)
 163                         Con_Print("Warning: modplug volume control not supported. Try getting a newer version of libmodplug.\n");
 164                 return true;
 165         }
 166         else
 167                 return false;
 168 }
 169
 170
 171 /*
 172 ====================
 173 ModPlug_CloseLibrary
 174
 175 Unload the modplugFile DLL
 176 ====================
 177 */
 178 void ModPlug_CloseLibrary (void)
 179 {
 180         Sys_UnloadLibrary (&modplug_dll);
 181 }
 182 #endif
 183
 184
 185 /*
 186 =================================================================
 187
 188         modplug decoding
 189
 190 =================================================================
 191 */
 192
 193 // Per-sfx data structure
 194 typedef struct
 195 {
 196         unsigned char   *file;
 197         size_t                  filesize;
 198         snd_format_t    format;
 199         unsigned int    total_length;
 200         char                    name[128];
 201         sfx_t           *sfx;
 202 } modplug_stream_persfx_t;
 203
 204 // Per-channel data structure
 205 typedef struct
 206 {
 207         ModPlugFile     *mf;
 208         unsigned int    sb_offset;
 209         int                             bs;
 210         snd_buffer_t    sb;             // must be at the end due to its dynamically allocated size
 211 } modplug_stream_perchannel_t;
 212
 213
 214 /*
 215 ====================
 216 ModPlug_FetchSound
 217 ====================
 218 */
 219 static const snd_buffer_t* ModPlug_FetchSound (void *sfxfetcher, void **chfetcherpointer, unsigned int *start, unsigned int nbsampleframes)
 220 {
 221         modplug_stream_perchannel_t* per_ch = (modplug_stream_perchannel_t *)*chfetcherpointer;
 222         modplug_stream_persfx_t* per_sfx = (modplug_stream_persfx_t *)sfxfetcher;
 223         snd_buffer_t* sb;
 224         int newlength, done, ret;
 225         unsigned int real_start;
 226         unsigned int factor;
 227
 228         // If there's no fetcher structure attached to the channel yet
 229         if (per_ch == NULL)
 230         {
 231                 size_t buff_len, memsize;
 232                 snd_format_t sb_format;
 233
 234                 sb_format.speed = snd_renderbuffer->format.speed;
 235                 sb_format.width = per_sfx->format.width;
 236                 sb_format.channels = per_sfx->format.channels;
 237
 238                 buff_len = STREAM_BUFFER_SIZE(&sb_format);
 239                 memsize = sizeof (*per_ch) - sizeof (per_ch->sb.samples) + buff_len;
 240                 per_ch = (modplug_stream_perchannel_t *)Mem_Alloc (snd_mempool, memsize);
 241
 242                 // Open it with the modplugFile API
 243                 per_ch->mf = ModPlug_Load(per_sfx->file, per_sfx->filesize);
 244                 if (!per_ch->mf)
 245                 {
 246                         Con_Printf("error while reading ModPlug stream \"%s\"\n", per_sfx->name);
 247                         Mem_Free (per_ch);
 248                         return NULL;
 249                 }
 250
 251 #ifndef SND_MODPLUG_STATIC
 252                 if(ModPlug_SetMasterVolume)
 253 #endif
 254                         ModPlug_SetMasterVolume(per_ch->mf, 512); // max volume, DP scales down!
 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 = (unsigned int) ((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 more than one frame of sound to the buffer:
 331         // 1- to ensure we won't lose many samples during the resampling process
 332         // 2- to reduce calls to ModPlug_FetchSound to regulate workload
 333         newlength = (int)(per_sfx->format.speed*STREAM_BUFFER_FILL);
 334         if (newlength + sb->nbframes > sb->maxframes)
 335         {
 336                 Con_Printf ("ModPlug_FetchSound: stream buffer overflow (%u sample frames / %u)\n",
 337                                         sb->format.speed + sb->nbframes, sb->maxframes);
 338                 return NULL;
 339         }
 340         newlength *= factor; // convert from sample frames to bytes
 341         if(newlength > (int)sizeof(resampling_buffer))
 342                 newlength = sizeof(resampling_buffer);
 343
 344         // Decompress in the resampling_buffer
 345         done = 0;
 346         while ((ret = ModPlug_Read (per_ch->mf, (char *)&resampling_buffer[done], (int)(newlength - done))) > 0)
 347                 done += ret;
 348         if(done < newlength)
 349         {
 350                 // Argh. We didn't get as many samples as we wanted. Probably
 351                 // libmodplug forgot what mLoopCount==-1 means... basically, this means
 352                 // we can't loop like this. Try to let DP fix it later...
 353                 per_sfx->sfx->total_length = (real_start + ((size_t)done / (size_t)factor));
 354                 per_sfx->sfx->loopstart = 0;
 355
 356                 if(newlength != done)
 357                         Con_DPrintf("ModPlug_Fetch: wanted: %d, got: %d\n", newlength, done);
 358         }
 359
 360         Snd_AppendToSndBuffer (sb, resampling_buffer, (size_t)done / (size_t)factor, &per_sfx->format);
 361
 362         *start = per_ch->sb_offset;
 363         return sb;
 364 }
 365
 366
 367 /*
 368 ====================
 369 ModPlug_FetchEnd
 370 ====================
 371 */
 372 static void ModPlug_FetchEnd (void *chfetcherdata)
 373 {
 374         modplug_stream_perchannel_t* per_ch = (modplug_stream_perchannel_t *)chfetcherdata;
 375
 376         if (per_ch != NULL)
 377         {
 378                 // Free the modplug decoder
 379                 ModPlug_Unload (per_ch->mf);
 380
 381                 Mem_Free (per_ch);
 382         }
 383 }
 384
 385
 386 /*
 387 ====================
 388 ModPlug_FreeSfx
 389 ====================
 390 */
 391 static void ModPlug_FreeSfx (void *sfxfetcherdata)
 392 {
 393         modplug_stream_persfx_t* per_sfx = (modplug_stream_persfx_t *)sfxfetcherdata;
 394
 395         // Free the modplug file
 396         Mem_Free(per_sfx->file);
 397
 398         // Free the stream structure
 399         Mem_Free(per_sfx);
 400 }
 401
 402
 403 /*
 404 ====================
 405 ModPlug_GetFormat
 406 ====================
 407 */
 408 static const snd_format_t* ModPlug_GetFormat (sfx_t* sfx)
 409 {
 410         modplug_stream_persfx_t* per_sfx = (modplug_stream_persfx_t *)sfx->fetcher_data;
 411         return &per_sfx->format;
 412 }
 413
 414 static const snd_fetcher_t modplug_fetcher = { ModPlug_FetchSound, ModPlug_FetchEnd, ModPlug_FreeSfx, ModPlug_GetFormat };
 415
 416
 417 /*
 418 ====================
 419 ModPlug_LoadmodplugFile
 420
 421 Load an modplug file into memory
 422 ====================
 423 */
 424 qboolean ModPlug_LoadModPlugFile (const char *filename, sfx_t *sfx)
 425 {
 426         unsigned char *data;
 427         fs_offset_t filesize;
 428         ModPlugFile *mf;
 429         modplug_stream_persfx_t* per_sfx;
 430         ModPlug_Settings s;
 431
 432         if (!modplug_dll)
 433                 return false;
 434
 435         // Already loaded?
 436         if (sfx->fetcher != NULL)
 437                 return true;
 438
 439         // Load the file
 440         data = FS_LoadFile (filename, snd_mempool, false, &filesize);
 441         if (data == NULL)
 442                 return false;
 443
 444         if (developer_loading.integer >= 2)
 445                 Con_Printf ("Loading ModPlug file \"%s\"\n", filename);
 446
 447         ModPlug_GetSettings(&s);
 448         s.mFlags = MODPLUG_ENABLE_OVERSAMPLING | MODPLUG_ENABLE_NOISE_REDUCTION | MODPLUG_ENABLE_REVERB;
 449         s.mChannels = 2;
 450         s.mBits = 16;
 451         s.mFrequency = 44100;
 452         s.mResamplingMode = MODPLUG_RESAMPLE_SPLINE;
 453         s.mLoopCount = -1;
 454         ModPlug_SetSettings(&s);
 455
 456         // Open it with the modplugFile API
 457         if (!(mf = ModPlug_Load (data, filesize)))
 458         {
 459                 Con_Printf ("error while opening ModPlug file \"%s\"\n", filename);
 460                 Mem_Free(data);
 461                 return false;
 462         }
 463
 464 #ifndef SND_MODPLUG_STATIC
 465         if(ModPlug_SetMasterVolume)
 466 #endif
 467                 ModPlug_SetMasterVolume(mf, 512); // max volume, DP scales down!
 468
 469         if (developer_loading.integer >= 2)
 470                 Con_Printf ("\"%s\" will be streamed\n", filename);
 471         per_sfx = (modplug_stream_persfx_t *)Mem_Alloc (snd_mempool, sizeof (*per_sfx));
 472         strlcpy(per_sfx->name, sfx->name, sizeof(per_sfx->name));
 473         sfx->memsize += sizeof (*per_sfx);
 474         per_sfx->file = data;
 475         per_sfx->filesize = filesize;
 476         sfx->memsize += filesize;
 477
 478         per_sfx->format.speed = 44100; // modplug always works at that rate
 479         per_sfx->format.width = 2;  // We always work with 16 bits samples
 480         per_sfx->format.channels = 2; // stereo rulez ;) (MAYBE default to mono because Amiga MODs sound better then?)
 481         per_sfx->sfx = sfx;
 482
 483         sfx->fetcher_data = per_sfx;
 484         sfx->fetcher = &modplug_fetcher;
 485         sfx->flags |= SFXFLAG_STREAMED;
 486         sfx->total_length = 2147384647; // they always loop
 487         sfx->loopstart = sfx->total_length; // modplug does it
 488
 489         return true;
 490 }