Fallback to "vorbis.dll" and "vorbisfile.dll" if "libvorbis.dll" and "libvorbisfile...
[divverent/darkplaces.git] / snd_ogg.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_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         unsigned char *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                 "libvorbis64.dll",
301 #elif defined(WIN32)
302                 "libvorbis.dll",
303                 "vorbis.dll",
304 #elif defined(MACOSX)
305                 "libvorbis.dylib",
306 #else
307                 "libvorbis.so.0",
308                 "libvorbis.so",
309 #endif
310                 NULL
311         };
312         const char* dllnames_vf [] =
313         {
314 #if defined(WIN64)
315                 "libvorbisfile64.dll",
316 #elif defined(WIN32)
317                 "libvorbisfile.dll",
318                 "vorbisfile.dll",
319 #elif defined(MACOSX)
320                 "libvorbisfile.dylib",
321 #else
322                 "libvorbisfile.so.3",
323                 "libvorbisfile.so",
324 #endif
325                 NULL
326         };
327
328         // Already loaded?
329         if (vf_dll)
330                 return true;
331
332 // COMMANDLINEOPTION: Sound: -novorbis disables ogg vorbis sound support
333         if (COM_CheckParm("-novorbis"))
334                 return false;
335
336         // Load the DLLs
337         // We need to load both by hand because some OSes seem to not load
338         // the vorbis DLL automatically when loading the VorbisFile DLL
339         if (! Sys_LoadLibrary (dllnames_vo, &vo_dll, NULL) ||
340                 ! Sys_LoadLibrary (dllnames_vf, &vf_dll, oggvorbisfuncs))
341         {
342                 Sys_UnloadLibrary (&vo_dll);
343                 Con_Printf ("Ogg Vorbis support disabled\n");
344                 return false;
345         }
346
347         Con_Printf ("Ogg Vorbis support enabled\n");
348         return true;
349 }
350
351
352 /*
353 ====================
354 OGG_CloseLibrary
355
356 Unload the VorbisFile DLL
357 ====================
358 */
359 void OGG_CloseLibrary (void)
360 {
361         Sys_UnloadLibrary (&vf_dll);
362         Sys_UnloadLibrary (&vo_dll);
363 }
364
365
366 /*
367 =================================================================
368
369         Ogg Vorbis decoding
370
371 =================================================================
372 */
373
374 #define STREAM_BUFFER_DURATION 1.5f     // 1.5 sec
375 #define STREAM_BUFFER_SIZE(format_ptr) (ceil (STREAM_BUFFER_DURATION * ((format_ptr)->speed * (format_ptr)->width * (format_ptr)->channels)))
376
377 // We work with 1 sec sequences, so this buffer must be able to contain
378 // 1 sec of sound of the highest quality (48 KHz, 16 bit samples, stereo)
379 static unsigned char resampling_buffer [48000 * 2 * 2];
380
381
382 // Per-sfx data structure
383 typedef struct
384 {
385         unsigned char                   *file;
386         size_t                  filesize;
387         snd_format_t    format;
388 } ogg_stream_persfx_t;
389
390 // Per-channel data structure
391 typedef struct
392 {
393         OggVorbis_File  vf;
394         ov_decode_t             ov_decode;
395         int                             bs;
396         sfxbuffer_t             sb;             // must be at the end due to its dynamically allocated size
397 } ogg_stream_perchannel_t;
398
399
400 static const ov_callbacks callbacks = {ovcb_read, ovcb_seek, ovcb_close, ovcb_tell};
401
402 /*
403 ====================
404 OGG_FetchSound
405 ====================
406 */
407 static const sfxbuffer_t* OGG_FetchSound (channel_t* ch, unsigned int start, unsigned int nbsamples)
408 {
409         ogg_stream_perchannel_t* per_ch;
410         sfxbuffer_t* sb;
411         sfx_t* sfx;
412         snd_format_t* format;
413         ogg_stream_persfx_t* per_sfx;
414         int newlength, done, ret, bigendian;
415         unsigned int factor;
416         size_t buff_len;
417
418         per_ch = (ogg_stream_perchannel_t *)ch->fetcher_data;
419         sfx = ch->sfx;
420         per_sfx = (ogg_stream_persfx_t *)sfx->fetcher_data;
421         format = &sfx->format;
422         buff_len = STREAM_BUFFER_SIZE(format);
423
424         // If there's no fetcher structure attached to the channel yet
425         if (per_ch == NULL)
426         {
427                 size_t memsize;
428                 ogg_stream_persfx_t* per_sfx;
429
430                 memsize = sizeof (*per_ch) - sizeof (per_ch->sb.data) + buff_len;
431                 per_ch = (ogg_stream_perchannel_t *)Mem_Alloc (snd_mempool, memsize);
432                 sfx->memsize += memsize;
433                 per_sfx = (ogg_stream_persfx_t *)sfx->fetcher_data;
434
435                 // Open it with the VorbisFile API
436                 per_ch->ov_decode.buffer = per_sfx->file;
437                 per_ch->ov_decode.ind = 0;
438                 per_ch->ov_decode.buffsize = per_sfx->filesize;
439                 if (qov_open_callbacks (&per_ch->ov_decode, &per_ch->vf, NULL, 0, callbacks) < 0)
440                 {
441                         Con_Printf("error while reading Ogg Vorbis stream \"%s\"\n", sfx->name);
442                         Mem_Free (per_ch);
443                         return NULL;
444                 }
445
446                 per_ch->sb.offset = 0;
447                 per_ch->sb.length = 0;
448                 per_ch->bs = 0;
449
450                 ch->fetcher_data = per_ch;
451         }
452
453         sb = &per_ch->sb;
454         factor = per_sfx->format.width * per_sfx->format.channels;
455
456         // If the stream buffer can't contain that much samples anyway
457         if (nbsamples * factor > buff_len)
458         {
459                 Con_Printf ("OGG_FetchSound: stream buffer too small (%u bytes required)\n", nbsamples * factor);
460                 return NULL;
461         }
462
463         // If the data we need has already been decompressed in the sfxbuffer, just return it
464         if (sb->offset <= start && sb->offset + sb->length >= start + nbsamples)
465                 return sb;
466
467         newlength = (int)(sb->offset + sb->length) - start;
468
469         // If we need to skip some data before decompressing the rest, or if the stream has looped
470         if (newlength < 0 || sb->offset > start)
471         {
472                 if (qov_pcm_seek (&per_ch->vf, (ogg_int64_t)start) != 0)
473                         return NULL;
474                 sb->length = 0;
475         }
476         // Else, move forward the samples we need to keep in the sfxbuffer
477         else
478         {
479                 memmove (sb->data, sb->data + (start - sb->offset) * factor, newlength * factor);
480                 sb->length = newlength;
481         }
482
483         sb->offset = start;
484
485         // We add exactly 1 sec of sound to the buffer:
486         // 1- to ensure we won't lose any sample during the resampling process
487         // 2- to force one call to OGG_FetchSound per second to regulate the workload
488         if ((sfx->format.speed + sb->length) * factor > buff_len)
489         {
490                 Con_Printf ("OGG_FetchSound: stream buffer overflow (%u bytes / %u)\n",
491                                         (sfx->format.speed + sb->length) * factor, buff_len);
492                 return NULL;
493         }
494         newlength = per_sfx->format.speed * factor;  // -> 1 sec of sound before resampling
495
496         // Decompress in the resampling_buffer
497 #if BYTE_ORDER == BIG_ENDIAN
498         bigendian = 1;
499 #else
500         bigendian = 0;
501 #endif
502         done = 0;
503         while ((ret = qov_read (&per_ch->vf, (char *)&resampling_buffer[done], (int)(newlength - done), bigendian, 2, 1, &per_ch->bs)) > 0)
504                 done += ret;
505
506         // Resample in the sfxbuffer
507         newlength = (int)ResampleSfx (resampling_buffer, (size_t)done / (size_t)factor, &per_sfx->format, sb->data + sb->length * (size_t)factor, sfx->name);
508         sb->length += newlength;
509
510         return sb;
511 }
512
513
514 /*
515 ====================
516 OGG_FetchEnd
517 ====================
518 */
519 static void OGG_FetchEnd (channel_t* ch)
520 {
521         ogg_stream_perchannel_t* per_ch;
522
523         per_ch = (ogg_stream_perchannel_t *)ch->fetcher_data;
524         if (per_ch != NULL)
525         {
526                 size_t buff_len;
527                 snd_format_t* format;
528
529                 // Free the ogg vorbis decoder
530                 qov_clear (&per_ch->vf);
531
532                 Mem_Free (per_ch);
533                 ch->fetcher_data = NULL;
534
535                 format = &ch->sfx->format;
536                 buff_len = STREAM_BUFFER_SIZE(format);
537                 ch->sfx->memsize -= sizeof (*per_ch) - sizeof (per_ch->sb.data) + buff_len;
538         }
539 }
540
541
542 /*
543 ====================
544 OGG_FreeSfx
545 ====================
546 */
547 static void OGG_FreeSfx (sfx_t* sfx)
548 {
549         ogg_stream_persfx_t* per_sfx = (ogg_stream_persfx_t *)sfx->fetcher_data;
550
551         // Free the Ogg Vorbis file
552         Mem_Free(per_sfx->file);
553         sfx->memsize -= per_sfx->filesize;
554
555         // Free the stream structure
556         Mem_Free(per_sfx);
557         sfx->memsize -= sizeof (*per_sfx);
558
559         sfx->fetcher_data = NULL;
560         sfx->fetcher = NULL;
561 }
562
563 static const snd_fetcher_t ogg_fetcher = { OGG_FetchSound, OGG_FetchEnd, OGG_FreeSfx };
564
565
566 /*
567 ====================
568 OGG_LoadVorbisFile
569
570 Load an Ogg Vorbis file into memory
571 ====================
572 */
573 qboolean OGG_LoadVorbisFile (const char *filename, sfx_t *s)
574 {
575         unsigned char *data;
576         fs_offset_t filesize;
577         ov_decode_t ov_decode;
578         OggVorbis_File vf;
579         vorbis_info *vi;
580         ogg_int64_t len, buff_len;
581
582         if (!vf_dll)
583                 return false;
584
585         // Already loaded?
586         if (s->fetcher != NULL)
587                 return true;
588
589         // Load the file
590         data = FS_LoadFile (filename, snd_mempool, false, &filesize);
591         if (data == NULL)
592                 return false;
593
594         Con_DPrintf ("Loading Ogg Vorbis file \"%s\"\n", filename);
595
596         // Open it with the VorbisFile API
597         ov_decode.buffer = data;
598         ov_decode.ind = 0;
599         ov_decode.buffsize = filesize;
600         if (qov_open_callbacks (&ov_decode, &vf, NULL, 0, callbacks) < 0)
601         {
602                 Con_Printf ("error while opening Ogg Vorbis file \"%s\"\n", filename);
603                 Mem_Free(data);
604                 return false;
605         }
606
607         // Get the stream information
608         vi = qov_info (&vf, -1);
609         if (vi->channels < 1 || vi->channels > 2)
610         {
611                 Con_Printf("%s has an unsupported number of channels (%i)\n",
612                                         s->name, vi->channels);
613                 qov_clear (&vf);
614                 Mem_Free(data);
615                 return false;
616         }
617
618         len = qov_pcm_total (&vf, -1) * vi->channels * 2;  // 16 bits => "* 2"
619
620         // Decide if we go for a stream or a simple PCM cache
621         buff_len = ceil (STREAM_BUFFER_DURATION * (shm->format.speed * 2 * vi->channels));
622         if (snd_streaming.integer && len > (ogg_int64_t)filesize + 3 * buff_len)
623         {
624                 ogg_stream_persfx_t* per_sfx;
625
626                 Con_DPrintf ("\"%s\" will be streamed\n", filename);
627                 per_sfx = (ogg_stream_persfx_t *)Mem_Alloc (snd_mempool, sizeof (*per_sfx));
628                 s->memsize += sizeof (*per_sfx);
629                 per_sfx->file = data;
630                 per_sfx->filesize = filesize;
631                 s->memsize += filesize;
632
633                 per_sfx->format.speed = vi->rate;
634                 per_sfx->format.width = 2;  // We always work with 16 bits samples
635                 per_sfx->format.channels = vi->channels;
636                 s->format.speed = shm->format.speed;
637                 s->format.width = per_sfx->format.width;
638                 s->format.channels = per_sfx->format.channels;
639
640                 s->fetcher_data = per_sfx;
641                 s->fetcher = &ogg_fetcher;
642                 s->loopstart = -1;
643                 s->flags |= SFXFLAG_STREAMED;
644                 s->total_length = (size_t)len / per_sfx->format.channels / 2 * ((float)s->format.speed / per_sfx->format.speed);
645         }
646         else
647         {
648                 char *buff;
649                 ogg_int64_t done;
650                 int bs, bigendian;
651                 long ret;
652                 sfxbuffer_t *sb;
653                 size_t memsize;
654
655                 Con_DPrintf ("\"%s\" will be cached\n", filename);
656
657                 // Decode it
658                 buff = (char *)Mem_Alloc (snd_mempool, (int)len);
659                 done = 0;
660                 bs = 0;
661 #if BYTE_ORDER == LITTLE_ENDIAN
662                 bigendian = 0;
663 #else
664                 bigendian = 1;
665 #endif
666                 while ((ret = qov_read (&vf, &buff[done], (int)(len - done), bigendian, 2, 1, &bs)) > 0)
667                         done += ret;
668
669                 // Calculate resampled length
670                 len = (double)done * (double)shm->format.speed / (double)vi->rate;
671
672                 // Resample it
673                 memsize = (size_t)len + sizeof (*sb) - sizeof (sb->data);
674                 sb = (sfxbuffer_t *)Mem_Alloc (snd_mempool, memsize);
675                 s->memsize += memsize;
676                 s->fetcher_data = sb;
677                 s->fetcher = &wav_fetcher;
678                 s->format.speed = vi->rate;
679                 s->format.width = 2;  // We always work with 16 bits samples
680                 s->format.channels = vi->channels;
681                 s->loopstart = -1;
682                 s->flags &= ~SFXFLAG_STREAMED;
683
684                 sb->length = (unsigned int)ResampleSfx ((unsigned char *)buff, (size_t)done / (vi->channels * 2), &s->format, sb->data, s->name);
685                 s->format.speed = shm->format.speed;
686                 s->total_length = sb->length;
687                 sb->offset = 0;
688
689                 qov_clear (&vf);
690                 Mem_Free (data);
691                 Mem_Free (buff);
692         }
693
694         return true;
695 }