Lots of minor fixes and improvements to the sound engine, plus a few more important...
[divverent/darkplaces.git] / 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 // Handle for the Vorbisfile DLL
219 static dllhandle_t vf_dll = NULL;
220
221 typedef struct
222 {
223         qbyte *buffer;
224         ogg_int64_t ind, buffsize;
225 } ov_decode_t;
226
227
228 static size_t ovcb_read (void *ptr, size_t size, size_t nb, void *datasource)
229 {
230         ov_decode_t *ov_decode = (ov_decode_t*)datasource;
231         size_t remain, len;
232
233         remain = ov_decode->buffsize - ov_decode->ind;
234         len = size * nb;
235         if (remain < len)
236                 len = remain - remain % size;
237
238         memcpy (ptr, ov_decode->buffer + ov_decode->ind, len);
239         ov_decode->ind += len;
240
241         return len / size;
242 }
243
244 static int ovcb_seek (void *datasource, ogg_int64_t offset, int whence)
245 {
246         ov_decode_t *ov_decode = (ov_decode_t*)datasource;
247
248         switch (whence)
249         {
250                 case SEEK_SET:
251                         break;
252                 case SEEK_CUR:
253                         offset += ov_decode->ind;
254                         break;
255                 case SEEK_END:
256                         offset += ov_decode->buffsize;
257                         break;
258                 default:
259                         return -1;
260         }
261         if (offset < 0 || offset > ov_decode->buffsize)
262                 return -1;
263
264         ov_decode->ind = offset;
265         return 0;
266 }
267
268 static int ovcb_close (void *ov_decode)
269 {
270         return 0;
271 }
272
273 static long ovcb_tell (void *ov_decode)
274 {
275         return ((ov_decode_t*)ov_decode)->ind;
276 }
277
278
279 /*
280 =================================================================
281
282   DLL load & unload
283
284 =================================================================
285 */
286
287 /*
288 ====================
289 OGG_OpenLibrary
290
291 Try to load the VorbisFile DLL
292 ====================
293 */
294 qboolean OGG_OpenLibrary (void)
295 {
296         const char* dllname;
297
298         // Already loaded?
299         if (vf_dll)
300                 return true;
301
302 // COMMANDLINEOPTION: Sound: -novorbis disables ogg vorbis sound support
303         if (COM_CheckParm("-novorbis"))
304                 return false;
305
306 #ifdef WIN32
307         dllname = "vorbisfile.dll";
308 #else
309         dllname = "libvorbisfile.so";
310 #endif
311
312         // Load the DLL
313         if (! Sys_LoadLibrary (dllname, &vf_dll, oggvorbisfuncs))
314         {
315                 Con_Printf ("Ogg Vorbis support disabled\n");
316                 return false;
317         }
318
319         Con_Printf ("Ogg Vorbis support enabled\n");
320         return true;
321 }
322
323
324 /*
325 ====================
326 OGG_CloseLibrary
327
328 Unload the VorbisFile DLL
329 ====================
330 */
331 void OGG_CloseLibrary (void)
332 {
333         Sys_UnloadLibrary (&vf_dll);
334 }
335
336
337 /*
338 =================================================================
339
340         Ogg Vorbis decoding
341
342 =================================================================
343 */
344
345 #define STREAM_BUFFER_DURATION 1.5f     // 1.5 sec
346
347 // We work with 1 sec sequences, so this buffer must be able to contain
348 // 1 sec of sound of the highest quality (48 KHz, 16 bit samples, stereo)
349 static qbyte resampling_buffer [48000 * 2 * 2];
350
351
352 // Per-sfx data structure
353 typedef struct
354 {
355         qbyte                   *file;
356         size_t                  filesize;
357         snd_format_t    format;
358 } ogg_stream_persfx_t;
359
360 // Per-channel data structure
361 typedef struct
362 {
363         OggVorbis_File  vf;
364         ov_decode_t             ov_decode;
365         int                             bs;
366         sfxbuffer_t             sb;             // must be at the end due to its dynamically allocated size
367 } ogg_stream_perchannel_t;
368
369
370 static const ov_callbacks callbacks = {ovcb_read, ovcb_seek, ovcb_close, ovcb_tell};
371
372 /*
373 ====================
374 OGG_FetchSound
375 ====================
376 */
377 static const sfxbuffer_t* OGG_FetchSound (channel_t* ch, unsigned int start, unsigned int nbsamples)
378 {
379         ogg_stream_perchannel_t* per_ch;
380         sfxbuffer_t* sb;
381         sfx_t* sfx;
382         ogg_stream_persfx_t* per_sfx;
383         int newlength, done, ret, bigendian;
384         unsigned int factor;
385         size_t buff_len;
386
387         per_ch = ch->fetcher_data;
388         sfx = ch->sfx;
389         per_sfx = sfx->fetcher_data;
390         buff_len = ceil (STREAM_BUFFER_DURATION * (sfx->format.speed * sfx->format.width * sfx->format.channels));
391
392         // If there's no fetcher structure attached to the channel yet
393         if (per_ch == NULL)
394         {
395                 ogg_stream_persfx_t* per_sfx;
396
397                 per_ch = Mem_Alloc (sfx->mempool, sizeof (*per_ch) - sizeof (per_ch->sb.data) + buff_len);
398                 per_sfx = sfx->fetcher_data;
399
400                 // Open it with the VorbisFile API
401                 per_ch->ov_decode.buffer = per_sfx->file;
402                 per_ch->ov_decode.ind = 0;
403                 per_ch->ov_decode.buffsize = per_sfx->filesize;
404                 if (qov_open_callbacks (&per_ch->ov_decode, &per_ch->vf, NULL, 0, callbacks) < 0)
405                 {
406                         Con_Printf("error while reading Ogg Vorbis stream \"%s\"\n", sfx->name);
407                         Mem_Free (per_ch);
408                         return NULL;
409                 }
410
411                 per_ch->sb.offset = 0;
412                 per_ch->sb.length = 0;
413                 per_ch->bs = 0;
414
415                 ch->fetcher_data = per_ch;
416         }
417
418         sb = &per_ch->sb;
419         factor = per_sfx->format.width * per_sfx->format.channels;
420
421         // If the stream buffer can't contain that much samples anyway
422         if (nbsamples * factor > buff_len)
423         {
424                 Con_Printf ("OGG_FetchSound: stream buffer too small (%u bytes required)\n", nbsamples * factor);
425                 return NULL;
426         }
427
428         // If the data we need has already been decompressed in the sfxbuffer, just return it
429         if (sb->offset <= start && sb->offset + sb->length >= start + nbsamples)
430                 return sb;
431
432         newlength = sb->offset + sb->length - start;
433
434         // If we need to skip some data before decompressing the rest, or if the stream has looped
435         if (newlength < 0 || sb->offset > start)
436         {
437                 if (qov_pcm_seek (&per_ch->vf, (ogg_int64_t)start) != 0)
438                         return NULL;
439
440                 sb->offset = start;
441                 sb->length = 0;
442                 newlength = 0;
443         }
444         // Else, move forward the samples we need to keep in the sfxbuffer
445         else
446         {
447                 memmove (sb->data, sb->data + (start - sb->offset) * factor, newlength * factor);
448                 sb->offset = start;
449                 sb->length = newlength;
450         }
451
452         // We add exactly 1 sec of sound to the buffer:
453         // 1- to ensure we won't lose any sample during the resampling process
454         // 2- to force one call to OGG_FetchSound per second to regulate the workload
455         if ((sfx->format.speed + sb->length) * factor > buff_len)
456         {
457                 Con_Printf ("OGG_FetchSound: stream buffer overflow (%u bytes / %u)\n",
458                                         (sfx->format.speed + sb->length) * factor, buff_len);
459                 return NULL;
460         }
461         newlength = per_sfx->format.speed * factor;  // 1 sec of sound before resampling
462
463         // Decompress in the resampling_buffer
464 #if BYTE_ORDER == LITTLE_ENDIAN
465         bigendian = 0;
466 #else
467         bigendian = 1;
468 #endif
469         done = 0;
470         while ((ret = qov_read (&per_ch->vf, &resampling_buffer[done], (int)(newlength - done), bigendian, 2, 1, &per_ch->bs)) > 0)
471                 done += ret;
472
473         // Resample in the sfxbuffer
474         newlength = ResampleSfx (resampling_buffer, (size_t)done / factor, &per_sfx->format, sb->data + sb->length * factor, sfx->name);
475         sb->length += newlength;
476
477         return sb;
478 }
479
480
481 /*
482 ====================
483 OGG_FetchEnd
484 ====================
485 */
486 static void OGG_FetchEnd (channel_t* ch)
487 {
488         ogg_stream_perchannel_t* per_ch;
489
490         per_ch = ch->fetcher_data;
491         if (per_ch != NULL)
492         {
493                 // Free the ogg vorbis decoder
494                 qov_clear (&per_ch->vf);
495
496                 Mem_Free (per_ch);
497                 ch->fetcher_data = NULL;
498         }
499 }
500
501 static const snd_fetcher_t ogg_fetcher = { OGG_FetchSound, OGG_FetchEnd };
502
503
504 /*
505 ====================
506 OGG_LoadVorbisFile
507
508 Load an Ogg Vorbis file into memory
509 ====================
510 */
511 qboolean OGG_LoadVorbisFile (const char *filename, sfx_t *s)
512 {
513         qbyte *data;
514         ov_decode_t ov_decode;
515         OggVorbis_File vf;
516         vorbis_info *vi;
517         ogg_int64_t len, buff_len;
518
519         if (!vf_dll)
520                 return false;
521
522         Mem_FreePool (&s->mempool);
523         s->mempool = Mem_AllocPool (s->name, 0, NULL);
524
525         // Load the file
526         data = FS_LoadFile (filename, s->mempool, false);
527         if (data == NULL)
528         {
529                 Mem_FreePool (&s->mempool);
530                 return false;
531         }
532
533         Con_DPrintf ("Loading Ogg Vorbis file \"%s\"\n", filename);
534
535         // Open it with the VorbisFile API
536         ov_decode.buffer = data;
537         ov_decode.ind = 0;
538         ov_decode.buffsize = fs_filesize;
539         if (qov_open_callbacks (&ov_decode, &vf, NULL, 0, callbacks) < 0)
540         {
541                 Con_Printf ("error while opening Ogg Vorbis file \"%s\"\n", filename);
542                 Mem_FreePool (&s->mempool);
543                 return false;
544         }
545
546         // Get the stream information
547         vi = qov_info (&vf, -1);
548         if (vi->channels < 1 || vi->channels > 2)
549         {
550                 Con_Printf("%s has an unsupported number of channels (%i)\n",
551                                         s->name, vi->channels);
552                 qov_clear (&vf);
553                 Mem_FreePool (&s->mempool);
554                 return false;
555         }
556
557         len = qov_pcm_total (&vf, -1) * vi->channels * 2;  // 16 bits => "* 2"
558
559         // Decide if we go for a stream or a simple PCM cache
560         buff_len = ceil (STREAM_BUFFER_DURATION * (shm->format.speed * 2 * vi->channels));
561         if (snd_streaming.integer && len > fs_filesize + 3 * buff_len)
562         {
563                 ogg_stream_persfx_t* per_sfx;
564
565                 Con_DPrintf ("\"%s\" will be streamed\n", filename);
566                 per_sfx = Mem_Alloc (s->mempool, sizeof (*per_sfx));
567                 per_sfx->file = data;
568                 per_sfx->filesize = fs_filesize;
569
570                 per_sfx->format.speed = vi->rate;
571                 per_sfx->format.width = 2;  // We always work with 16 bits samples
572                 per_sfx->format.channels = vi->channels;
573                 s->format.speed = shm->format.speed;
574                 s->format.width = per_sfx->format.width;
575                 s->format.channels = per_sfx->format.channels;
576
577                 s->fetcher_data = per_sfx;
578                 s->fetcher = &ogg_fetcher;
579                 s->loopstart = -1;
580                 s->flags |= SFXFLAG_STREAMED;
581                 s->total_length = (size_t)len / per_sfx->format.channels / 2 * ((float)s->format.speed / per_sfx->format.speed);
582         }
583         else
584         {
585                 char *buff;
586                 ogg_int64_t done;
587                 int bs, bigendian;
588                 long ret;
589                 sfxbuffer_t *sb;
590
591                 Con_DPrintf ("\"%s\" will be cached\n", filename);
592
593                 // Decode it
594                 buff = Mem_Alloc (s->mempool, (int)len);
595                 done = 0;
596                 bs = 0;
597 #if BYTE_ORDER == LITTLE_ENDIAN
598                 bigendian = 0;
599 #else
600                 bigendian = 1;
601 #endif
602                 while ((ret = qov_read (&vf, &buff[done], (int)(len - done), bigendian, 2, 1, &bs)) > 0)
603                         done += ret;
604
605                 // Calculate resampled length
606                 len = (double)done * (double)shm->format.speed / (double)vi->rate;
607
608                 // Resample it
609                 sb = Mem_Alloc (s->mempool, (size_t)len + sizeof (*sb) - sizeof (sb->data));
610                 s->fetcher_data = sb;
611                 s->fetcher = &wav_fetcher;
612                 s->format.speed = vi->rate;
613                 s->format.width = 2;  // We always work with 16 bits samples
614                 s->format.channels = vi->channels;
615                 s->loopstart = -1;
616                 s->flags &= ~SFXFLAG_STREAMED;
617
618                 sb->length = ResampleSfx (buff, (size_t)done / (vi->channels * 2), &s->format, sb->data, s->name);
619                 s->format.speed = shm->format.speed;
620                 s->total_length = sb->length;
621                 sb->offset = 0;
622
623                 qov_clear (&vf);
624                 Mem_Free (data);
625                 Mem_Free (buff);
626         }
627
628         return true;
629 }