snd_ogg.c

   1 /*
   2         Copyright (C) 2003-2004  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_ogg.h"
  28 #include "snd_wav.h"
  29
  30
  31 /*
  32 =================================================================
  33
  34   Minimal set of definitions from the Ogg Vorbis lib
  35   (C) COPYRIGHT 1994-2001 by the XIPHOPHORUS Company
  36   http://www.xiph.org/
  37
  38   WARNING: for a matter of simplicity, several pointer types are
  39   casted to "void*", and most enumerated values are not included
  40
  41 =================================================================
  42 */
  43
  44 #ifdef _MSC_VER
  45 typedef __int64 ogg_int64_t;
  46 #else
  47 typedef long long ogg_int64_t;
  48 #endif
  49
  50 typedef struct
  51 {
  52         size_t  (*read_func)    (void *ptr, size_t size, size_t nmemb, void *datasource);
  53         int             (*seek_func)    (void *datasource, ogg_int64_t offset, int whence);
  54         int             (*close_func)   (void *datasource);
  55         long    (*tell_func)    (void *datasource);
  56 } ov_callbacks;
  57
  58 typedef struct
  59 {
  60         unsigned char   *data;
  61         int                             storage;
  62         int                             fill;
  63         int                             returned;
  64         int                             unsynced;
  65         int                             headerbytes;
  66         int                             bodybytes;
  67 } ogg_sync_state;
  68
  69 typedef struct
  70 {
  71         int             version;
  72         int             channels;
  73         long    rate;
  74         long    bitrate_upper;
  75         long    bitrate_nominal;
  76         long    bitrate_lower;
  77         long    bitrate_window;
  78         void    *codec_setup;
  79 } vorbis_info;
  80
  81 typedef struct
  82 {
  83         unsigned char   *body_data;
  84         long                    body_storage;
  85         long                    body_fill;
  86         long                    body_returned;
  87         int                             *lacing_vals;
  88         ogg_int64_t             *granule_vals;
  89         long                    lacing_storage;
  90         long                    lacing_fill;
  91         long                    lacing_packet;
  92         long                    lacing_returned;
  93         unsigned char   header[282];
  94         int                             header_fill;
  95         int                             e_o_s;
  96         int                             b_o_s;
  97         long                    serialno;
  98         long                    pageno;
  99         ogg_int64_t             packetno;
 100         ogg_int64_t             granulepos;
 101 } ogg_stream_state;
 102
 103 typedef struct
 104 {
 105         int                     analysisp;
 106         vorbis_info     *vi;
 107         float           **pcm;
 108         float           **pcmret;
 109         int                     pcm_storage;
 110         int                     pcm_current;
 111         int                     pcm_returned;
 112         int                     preextrapolate;
 113         int                     eofflag;
 114         long            lW;
 115         long            W;
 116         long            nW;
 117         long            centerW;
 118         ogg_int64_t     granulepos;
 119         ogg_int64_t     sequence;
 120         ogg_int64_t     glue_bits;
 121         ogg_int64_t     time_bits;
 122         ogg_int64_t     floor_bits;
 123         ogg_int64_t     res_bits;
 124         void            *backend_state;
 125 } vorbis_dsp_state;
 126
 127 typedef struct
 128 {
 129         long                    endbyte;
 130         int                             endbit;
 131         unsigned char   *buffer;
 132         unsigned char   *ptr;
 133         long                    storage;
 134 } oggpack_buffer;
 135
 136 typedef struct
 137 {
 138         float                           **pcm;
 139         oggpack_buffer          opb;
 140         long                            lW;
 141         long                            W;
 142         long                            nW;
 143         int                                     pcmend;
 144         int                                     mode;
 145         int                                     eofflag;
 146         ogg_int64_t                     granulepos;
 147         ogg_int64_t                     sequence;
 148         vorbis_dsp_state        *vd;
 149         void                            *localstore;
 150         long                            localtop;
 151         long                            localalloc;
 152         long                            totaluse;
 153         void                            *reap;  // VOIDED POINTER
 154         long                            glue_bits;
 155         long                            time_bits;
 156         long                            floor_bits;
 157         long                            res_bits;
 158         void                            *internal;
 159 } vorbis_block;
 160
 161 typedef struct
 162 {
 163         void                            *datasource;
 164         int                                     seekable;
 165         ogg_int64_t                     offset;
 166         ogg_int64_t                     end;
 167         ogg_sync_state          oy;
 168         int                                     links;
 169         ogg_int64_t                     *offsets;
 170         ogg_int64_t                     *dataoffsets;
 171         long                            *serialnos;
 172         ogg_int64_t                     *pcmlengths;
 173         vorbis_info                     *vi;
 174         void                            *vc;  // VOIDED POINTER
 175         ogg_int64_t                     pcm_offset;
 176         int                                     ready_state;
 177         long                            current_serialno;
 178         int                                     current_link;
 179         double                          bittrack;
 180         double                          samptrack;
 181         ogg_stream_state        os;
 182         vorbis_dsp_state        vd;
 183         vorbis_block            vb;
 184         ov_callbacks            callbacks;
 185 } OggVorbis_File;
 186
 187
 188 /*
 189 =================================================================
 190
 191   DarkPlaces definitions
 192
 193 =================================================================
 194 */
 195
 196 // Functions exported from the vorbisfile library
 197 static int (*qov_clear) (OggVorbis_File *vf);
 198 static vorbis_info* (*qov_info) (OggVorbis_File *vf,int link);
 199 static int (*qov_open_callbacks) (void *datasource, OggVorbis_File *vf,
 200                                                                   char *initial, long ibytes,
 201                                                                   ov_callbacks callbacks);
 202 static int (*qov_pcm_seek) (OggVorbis_File *vf,ogg_int64_t pos);
 203 static ogg_int64_t (*qov_pcm_total) (OggVorbis_File *vf,int i);
 204 static long (*qov_read) (OggVorbis_File *vf,char *buffer,int length,
 205                                                  int bigendianp,int word,int sgned,int *bitstream);
 206
 207 static dllfunction_t oggvorbisfuncs[] =
 208 {
 209         {"ov_clear",                    (void **) &qov_clear},
 210         {"ov_info",                             (void **) &qov_info},
 211         {"ov_open_callbacks",   (void **) &qov_open_callbacks},
 212         {"ov_pcm_seek",                 (void **) &qov_pcm_seek},
 213         {"ov_pcm_total",                (void **) &qov_pcm_total},
 214         {"ov_read",                             (void **) &qov_read},
 215         {NULL, NULL}
 216 };
 217
 218 // Handles for the Vorbis and Vorbisfile DLLs
 219 static dllhandle_t vo_dll = NULL;
 220 static dllhandle_t vf_dll = NULL;
 221
 222 typedef struct
 223 {
 224         qbyte *buffer;
 225         ogg_int64_t ind, buffsize;
 226 } ov_decode_t;
 227
 228
 229 static size_t ovcb_read (void *ptr, size_t size, size_t nb, void *datasource)
 230 {
 231         ov_decode_t *ov_decode = (ov_decode_t*)datasource;
 232         size_t remain, len;
 233
 234         remain = ov_decode->buffsize - ov_decode->ind;
 235         len = size * nb;
 236         if (remain < len)
 237                 len = remain - remain % size;
 238
 239         memcpy (ptr, ov_decode->buffer + ov_decode->ind, len);
 240         ov_decode->ind += len;
 241
 242         return len / size;
 243 }
 244
 245 static int ovcb_seek (void *datasource, ogg_int64_t offset, int whence)
 246 {
 247         ov_decode_t *ov_decode = (ov_decode_t*)datasource;
 248
 249         switch (whence)
 250         {
 251                 case SEEK_SET:
 252                         break;
 253                 case SEEK_CUR:
 254                         offset += ov_decode->ind;
 255                         break;
 256                 case SEEK_END:
 257                         offset += ov_decode->buffsize;
 258                         break;
 259                 default:
 260                         return -1;
 261         }
 262         if (offset < 0 || offset > ov_decode->buffsize)
 263                 return -1;
 264
 265         ov_decode->ind = offset;
 266         return 0;
 267 }
 268
 269 static int ovcb_close (void *ov_decode)
 270 {
 271         return 0;
 272 }
 273
 274 static long ovcb_tell (void *ov_decode)
 275 {
 276         return ((ov_decode_t*)ov_decode)->ind;
 277 }
 278
 279
 280 /*
 281 =================================================================
 282
 283   DLL load & unload
 284
 285 =================================================================
 286 */
 287
 288 /*
 289 ====================
 290 OGG_OpenLibrary
 291
 292 Try to load the VorbisFile DLL
 293 ====================
 294 */
 295 qboolean OGG_OpenLibrary (void)
 296 {
 297         const char* dllnames_vo [] =
 298         {
 299 #if defined(WIN64)
 300                 "vorbis64.dll",
 301 #elif defined(WIN32)
 302                 "vorbis.dll",
 303 #elif defined(MACOSX)
 304                 "libvorbis.dylib",
 305 #else
 306                 "libvorbis.so.0",
 307                 "libvorbis.so",
 308 #endif
 309                 NULL
 310         };
 311         const char* dllnames_vf [] =
 312         {
 313 #if defined(WIN64)
 314                 "vorbisfile64.dll",
 315 #elif defined(WIN32)
 316                 "vorbisfile.dll",
 317 #elif defined(MACOSX)
 318                 "libvorbisfile.dylib",
 319 #else
 320                 "libvorbisfile.so.3",
 321                 "libvorbisfile.so",
 322 #endif
 323                 NULL
 324         };
 325
 326         // Already loaded?
 327         if (vf_dll)
 328                 return true;
 329
 330 // COMMANDLINEOPTION: Sound: -novorbis disables ogg vorbis sound support
 331         if (COM_CheckParm("-novorbis"))
 332                 return false;
 333
 334         // Load the DLLs
 335         // We need to load both by hand because some OSes seem to not load
 336         // the vorbis DLL automatically when loading the VorbisFile DLL
 337         if (! Sys_LoadLibrary (dllnames_vo, &vo_dll, NULL) ||
 338                 ! Sys_LoadLibrary (dllnames_vf, &vf_dll, oggvorbisfuncs))
 339         {
 340                 Sys_UnloadLibrary (&vo_dll);
 341                 Con_Printf ("Ogg Vorbis support disabled\n");
 342                 return false;
 343         }
 344
 345         Con_Printf ("Ogg Vorbis support enabled\n");
 346         return true;
 347 }
 348
 349
 350 /*
 351 ====================
 352 OGG_CloseLibrary
 353
 354 Unload the VorbisFile DLL
 355 ====================
 356 */
 357 void OGG_CloseLibrary (void)
 358 {
 359         Sys_UnloadLibrary (&vf_dll);
 360         Sys_UnloadLibrary (&vo_dll);
 361 }
 362
 363
 364 /*
 365 =================================================================
 366
 367         Ogg Vorbis decoding
 368
 369 =================================================================
 370 */
 371
 372 #define STREAM_BUFFER_DURATION 1.5f     // 1.5 sec
 373
 374 // We work with 1 sec sequences, so this buffer must be able to contain
 375 // 1 sec of sound of the highest quality (48 KHz, 16 bit samples, stereo)
 376 static qbyte resampling_buffer [48000 * 2 * 2];
 377
 378
 379 // Per-sfx data structure
 380 typedef struct
 381 {
 382         qbyte                   *file;
 383         size_t                  filesize;
 384         snd_format_t    format;
 385 } ogg_stream_persfx_t;
 386
 387 // Per-channel data structure
 388 typedef struct
 389 {
 390         OggVorbis_File  vf;
 391         ov_decode_t             ov_decode;
 392         int                             bs;
 393         sfxbuffer_t             sb;             // must be at the end due to its dynamically allocated size
 394 } ogg_stream_perchannel_t;
 395
 396
 397 static const ov_callbacks callbacks = {ovcb_read, ovcb_seek, ovcb_close, ovcb_tell};
 398
 399 /*
 400 ====================
 401 OGG_FetchSound
 402 ====================
 403 */
 404 static const sfxbuffer_t* OGG_FetchSound (channel_t* ch, unsigned int start, unsigned int nbsamples)
 405 {
 406         ogg_stream_perchannel_t* per_ch;
 407         sfxbuffer_t* sb;
 408         sfx_t* sfx;
 409         ogg_stream_persfx_t* per_sfx;
 410         int newlength, done, ret, bigendian;
 411         unsigned int factor;
 412         size_t buff_len;
 413
 414         per_ch = ch->fetcher_data;
 415         sfx = ch->sfx;
 416         per_sfx = sfx->fetcher_data;
 417         buff_len = ceil (STREAM_BUFFER_DURATION * (sfx->format.speed * sfx->format.width * sfx->format.channels));
 418
 419         // If there's no fetcher structure attached to the channel yet
 420         if (per_ch == NULL)
 421         {
 422                 ogg_stream_persfx_t* per_sfx;
 423
 424                 per_ch = Mem_Alloc (sfx->mempool, sizeof (*per_ch) - sizeof (per_ch->sb.data) + buff_len);
 425                 per_sfx = sfx->fetcher_data;
 426
 427                 // Open it with the VorbisFile API
 428                 per_ch->ov_decode.buffer = per_sfx->file;
 429                 per_ch->ov_decode.ind = 0;
 430                 per_ch->ov_decode.buffsize = per_sfx->filesize;
 431                 if (qov_open_callbacks (&per_ch->ov_decode, &per_ch->vf, NULL, 0, callbacks) < 0)
 432                 {
 433                         Con_Printf("error while reading Ogg Vorbis stream \"%s\"\n", sfx->name);
 434                         Mem_Free (per_ch);
 435                         return NULL;
 436                 }
 437
 438                 per_ch->sb.offset = 0;
 439                 per_ch->sb.length = 0;
 440                 per_ch->bs = 0;
 441
 442                 ch->fetcher_data = per_ch;
 443         }
 444
 445         sb = &per_ch->sb;
 446         factor = per_sfx->format.width * per_sfx->format.channels;
 447
 448         // If the stream buffer can't contain that much samples anyway
 449         if (nbsamples * factor > buff_len)
 450         {
 451                 Con_Printf ("OGG_FetchSound: stream buffer too small (%u bytes required)\n", nbsamples * factor);
 452                 return NULL;
 453         }
 454
 455         // If the data we need has already been decompressed in the sfxbuffer, just return it
 456         if (sb->offset <= start && sb->offset + sb->length >= start + nbsamples)
 457                 return sb;
 458
 459         newlength = (int)(sb->offset + sb->length) - start;
 460
 461         // If we need to skip some data before decompressing the rest, or if the stream has looped
 462         if (newlength < 0 || sb->offset > start)
 463         {
 464                 if (qov_pcm_seek (&per_ch->vf, (ogg_int64_t)start) != 0)
 465                         return NULL;
 466                 sb->length = 0;
 467         }
 468         // Else, move forward the samples we need to keep in the sfxbuffer
 469         else
 470         {
 471                 memmove (sb->data, sb->data + (start - sb->offset) * factor, newlength * factor);
 472                 sb->length = newlength;
 473         }
 474
 475         sb->offset = start;
 476
 477         // We add exactly 1 sec of sound to the buffer:
 478         // 1- to ensure we won't lose any sample during the resampling process
 479         // 2- to force one call to OGG_FetchSound per second to regulate the workload
 480         if ((sfx->format.speed + sb->length) * factor > buff_len)
 481         {
 482                 Con_Printf ("OGG_FetchSound: stream buffer overflow (%u bytes / %u)\n",
 483                                         (sfx->format.speed + sb->length) * factor, buff_len);
 484                 return NULL;
 485         }
 486         newlength = per_sfx->format.speed * factor;  // -> 1 sec of sound before resampling
 487
 488         // Decompress in the resampling_buffer
 489 #if BYTE_ORDER == LITTLE_ENDIAN
 490         bigendian = 0;
 491 #else
 492         bigendian = 1;
 493 #endif
 494         done = 0;
 495         while ((ret = qov_read (&per_ch->vf, &resampling_buffer[done], (int)(newlength - done), bigendian, 2, 1, &per_ch->bs)) > 0)
 496                 done += ret;
 497
 498         // Resample in the sfxbuffer
 499         newlength = (int)ResampleSfx (resampling_buffer, (size_t)done / (size_t)factor, &per_sfx->format, sb->data + sb->length * (size_t)factor, sfx->name);
 500         sb->length += newlength;
 501
 502         return sb;
 503 }
 504
 505
 506 /*
 507 ====================
 508 OGG_FetchEnd
 509 ====================
 510 */
 511 static void OGG_FetchEnd (channel_t* ch)
 512 {
 513         ogg_stream_perchannel_t* per_ch;
 514
 515         per_ch = ch->fetcher_data;
 516         if (per_ch != NULL)
 517         {
 518                 // Free the ogg vorbis decoder
 519                 qov_clear (&per_ch->vf);
 520
 521                 Mem_Free (per_ch);
 522                 ch->fetcher_data = NULL;
 523         }
 524 }
 525
 526 static const snd_fetcher_t ogg_fetcher = { OGG_FetchSound, OGG_FetchEnd };
 527
 528
 529 /*
 530 ====================
 531 OGG_LoadVorbisFile
 532
 533 Load an Ogg Vorbis file into memory
 534 ====================
 535 */
 536 qboolean OGG_LoadVorbisFile (const char *filename, sfx_t *s)
 537 {
 538         qbyte *data;
 539         ov_decode_t ov_decode;
 540         OggVorbis_File vf;
 541         vorbis_info *vi;
 542         ogg_int64_t len, buff_len;
 543
 544         if (!vf_dll)
 545                 return false;
 546
 547         Mem_FreePool (&s->mempool);
 548         s->mempool = Mem_AllocPool (s->name, 0, NULL);
 549
 550         // Load the file
 551         data = FS_LoadFile (filename, s->mempool, false);
 552         if (data == NULL)
 553         {
 554                 Mem_FreePool (&s->mempool);
 555                 return false;
 556         }
 557
 558         Con_DPrintf ("Loading Ogg Vorbis file \"%s\"\n", filename);
 559
 560         // Open it with the VorbisFile API
 561         ov_decode.buffer = data;
 562         ov_decode.ind = 0;
 563         ov_decode.buffsize = fs_filesize;
 564         if (qov_open_callbacks (&ov_decode, &vf, NULL, 0, callbacks) < 0)
 565         {
 566                 Con_Printf ("error while opening Ogg Vorbis file \"%s\"\n", filename);
 567                 Mem_FreePool (&s->mempool);
 568                 return false;
 569         }
 570
 571         // Get the stream information
 572         vi = qov_info (&vf, -1);
 573         if (vi->channels < 1 || vi->channels > 2)
 574         {
 575                 Con_Printf("%s has an unsupported number of channels (%i)\n",
 576                                         s->name, vi->channels);
 577                 qov_clear (&vf);
 578                 Mem_FreePool (&s->mempool);
 579                 return false;
 580         }
 581
 582         len = qov_pcm_total (&vf, -1) * vi->channels * 2;  // 16 bits => "* 2"
 583
 584         // Decide if we go for a stream or a simple PCM cache
 585         buff_len = ceil (STREAM_BUFFER_DURATION * (shm->format.speed * 2 * vi->channels));
 586         if (snd_streaming.integer && len > (ogg_int64_t)fs_filesize + 3 * buff_len)
 587         {
 588                 ogg_stream_persfx_t* per_sfx;
 589
 590                 Con_DPrintf ("\"%s\" will be streamed\n", filename);
 591                 per_sfx = Mem_Alloc (s->mempool, sizeof (*per_sfx));
 592                 per_sfx->file = data;
 593                 per_sfx->filesize = fs_filesize;
 594
 595                 per_sfx->format.speed = vi->rate;
 596                 per_sfx->format.width = 2;  // We always work with 16 bits samples
 597                 per_sfx->format.channels = vi->channels;
 598                 s->format.speed = shm->format.speed;
 599                 s->format.width = per_sfx->format.width;
 600                 s->format.channels = per_sfx->format.channels;
 601
 602                 s->fetcher_data = per_sfx;
 603                 s->fetcher = &ogg_fetcher;
 604                 s->loopstart = -1;
 605                 s->flags |= SFXFLAG_STREAMED;
 606                 s->total_length = (size_t)len / per_sfx->format.channels / 2 * ((float)s->format.speed / per_sfx->format.speed);
 607         }
 608         else
 609         {
 610                 char *buff;
 611                 ogg_int64_t done;
 612                 int bs, bigendian;
 613                 long ret;
 614                 sfxbuffer_t *sb;
 615
 616                 Con_DPrintf ("\"%s\" will be cached\n", filename);
 617
 618                 // Decode it
 619                 buff = Mem_Alloc (s->mempool, (int)len);
 620                 done = 0;
 621                 bs = 0;
 622 #if BYTE_ORDER == LITTLE_ENDIAN
 623                 bigendian = 0;
 624 #else
 625                 bigendian = 1;
 626 #endif
 627                 while ((ret = qov_read (&vf, &buff[done], (int)(len - done), bigendian, 2, 1, &bs)) > 0)
 628                         done += ret;
 629
 630                 // Calculate resampled length
 631                 len = (double)done * (double)shm->format.speed / (double)vi->rate;
 632
 633                 // Resample it
 634                 sb = Mem_Alloc (s->mempool, (size_t)len + sizeof (*sb) - sizeof (sb->data));
 635                 s->fetcher_data = sb;
 636                 s->fetcher = &wav_fetcher;
 637                 s->format.speed = vi->rate;
 638                 s->format.width = 2;  // We always work with 16 bits samples
 639                 s->format.channels = vi->channels;
 640                 s->loopstart = -1;
 641                 s->flags &= ~SFXFLAG_STREAMED;
 642
 643                 sb->length = (unsigned int)ResampleSfx (buff, (size_t)done / (vi->channels * 2), &s->format, sb->data, s->name);
 644                 s->format.speed = shm->format.speed;
 645                 s->total_length = sb->length;
 646                 sb->offset = 0;
 647
 648                 qov_clear (&vf);
 649                 Mem_Free (data);
 650                 Mem_Free (buff);
 651         }
 652
 653         return true;
 654 }