2 Copyright (C) 2003-2004 Mathieu Olivier
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.
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.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to:
18 Free Software Foundation, Inc.
19 59 Temple Place - Suite 330
20 Boston, MA 02111-1307, USA
32 =================================================================
34 Minimal set of definitions from the Ogg Vorbis lib
35 (C) COPYRIGHT 1994-2001 by the XIPHOPHORUS Company
38 WARNING: for a matter of simplicity, several pointer types are
39 casted to "void*", and most enumerated values are not included
41 =================================================================
45 typedef __int64 ogg_int64_t;
47 typedef long long ogg_int64_t;
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);
83 unsigned char *body_data;
88 ogg_int64_t *granule_vals;
93 unsigned char header[282];
100 ogg_int64_t granulepos;
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;
131 unsigned char *buffer;
146 ogg_int64_t granulepos;
147 ogg_int64_t sequence;
148 vorbis_dsp_state *vd;
153 void *reap; // VOIDED POINTER
169 ogg_int64_t *offsets;
170 ogg_int64_t *dataoffsets;
172 ogg_int64_t *pcmlengths;
174 void *vc; // VOIDED POINTER
175 ogg_int64_t pcm_offset;
177 long current_serialno;
184 ov_callbacks callbacks;
189 =================================================================
191 DarkPlaces definitions
193 =================================================================
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);
207 static dllfunction_t oggvorbisfuncs[] =
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},
218 // Handles for the Vorbis and Vorbisfile DLLs
219 static dllhandle_t vo_dll = NULL;
220 static dllhandle_t vf_dll = NULL;
225 ogg_int64_t ind, buffsize;
229 static size_t ovcb_read (void *ptr, size_t size, size_t nb, void *datasource)
231 ov_decode_t *ov_decode = (ov_decode_t*)datasource;
234 remain = ov_decode->buffsize - ov_decode->ind;
237 len = remain - remain % size;
239 memcpy (ptr, ov_decode->buffer + ov_decode->ind, len);
240 ov_decode->ind += len;
245 static int ovcb_seek (void *datasource, ogg_int64_t offset, int whence)
247 ov_decode_t *ov_decode = (ov_decode_t*)datasource;
254 offset += ov_decode->ind;
257 offset += ov_decode->buffsize;
262 if (offset < 0 || offset > ov_decode->buffsize)
265 ov_decode->ind = offset;
269 static int ovcb_close (void *ov_decode)
274 static long ovcb_tell (void *ov_decode)
276 return ((ov_decode_t*)ov_decode)->ind;
281 =================================================================
285 =================================================================
292 Try to load the VorbisFile DLL
295 qboolean OGG_OpenLibrary (void)
297 const char *dllname_vo, *dllname_vf;
303 // COMMANDLINEOPTION: Sound: -novorbis disables ogg vorbis sound support
304 if (COM_CheckParm("-novorbis"))
308 dllname_vo = "vorbis.dll";
309 dllname_vf = "vorbisfile.dll";
310 #elif defined(MACOSX)
311 dllname_vo = "libvorbis.dylib";
312 dllname_vf = "libvorbisfile.dylib";
314 dllname_vo = "libvorbis.so";
315 dllname_vf = "libvorbisfile.so";
319 // We need to load both by hand because some OSes seem to not load
320 // the vorbis DLL automatically when loading the VorbisFile DLL
321 if (! Sys_LoadLibrary (dllname_vo, &vo_dll, NULL) ||
322 ! Sys_LoadLibrary (dllname_vf, &vf_dll, oggvorbisfuncs))
324 Sys_UnloadLibrary (&vo_dll);
325 Con_Printf ("Ogg Vorbis support disabled\n");
329 Con_Printf ("Ogg Vorbis support enabled\n");
338 Unload the VorbisFile DLL
341 void OGG_CloseLibrary (void)
343 Sys_UnloadLibrary (&vf_dll);
344 Sys_UnloadLibrary (&vo_dll);
349 =================================================================
353 =================================================================
356 #define STREAM_BUFFER_DURATION 1.5f // 1.5 sec
358 // We work with 1 sec sequences, so this buffer must be able to contain
359 // 1 sec of sound of the highest quality (48 KHz, 16 bit samples, stereo)
360 static qbyte resampling_buffer [48000 * 2 * 2];
363 // Per-sfx data structure
369 } ogg_stream_persfx_t;
371 // Per-channel data structure
375 ov_decode_t ov_decode;
377 sfxbuffer_t sb; // must be at the end due to its dynamically allocated size
378 } ogg_stream_perchannel_t;
381 static const ov_callbacks callbacks = {ovcb_read, ovcb_seek, ovcb_close, ovcb_tell};
388 static const sfxbuffer_t* OGG_FetchSound (channel_t* ch, unsigned int start, unsigned int nbsamples)
390 ogg_stream_perchannel_t* per_ch;
393 ogg_stream_persfx_t* per_sfx;
394 int newlength, done, ret, bigendian;
398 per_ch = ch->fetcher_data;
400 per_sfx = sfx->fetcher_data;
401 buff_len = ceil (STREAM_BUFFER_DURATION * (sfx->format.speed * sfx->format.width * sfx->format.channels));
403 // If there's no fetcher structure attached to the channel yet
406 ogg_stream_persfx_t* per_sfx;
408 per_ch = Mem_Alloc (sfx->mempool, sizeof (*per_ch) - sizeof (per_ch->sb.data) + buff_len);
409 per_sfx = sfx->fetcher_data;
411 // Open it with the VorbisFile API
412 per_ch->ov_decode.buffer = per_sfx->file;
413 per_ch->ov_decode.ind = 0;
414 per_ch->ov_decode.buffsize = per_sfx->filesize;
415 if (qov_open_callbacks (&per_ch->ov_decode, &per_ch->vf, NULL, 0, callbacks) < 0)
417 Con_Printf("error while reading Ogg Vorbis stream \"%s\"\n", sfx->name);
422 per_ch->sb.offset = 0;
423 per_ch->sb.length = 0;
426 ch->fetcher_data = per_ch;
430 factor = per_sfx->format.width * per_sfx->format.channels;
432 // If the stream buffer can't contain that much samples anyway
433 if (nbsamples * factor > buff_len)
435 Con_Printf ("OGG_FetchSound: stream buffer too small (%u bytes required)\n", nbsamples * factor);
439 // If the data we need has already been decompressed in the sfxbuffer, just return it
440 if (sb->offset <= start && sb->offset + sb->length >= start + nbsamples)
443 newlength = sb->offset + sb->length - start;
445 // If we need to skip some data before decompressing the rest, or if the stream has looped
446 if (newlength < 0 || sb->offset > start)
448 if (qov_pcm_seek (&per_ch->vf, (ogg_int64_t)start) != 0)
455 // Else, move forward the samples we need to keep in the sfxbuffer
458 memmove (sb->data, sb->data + (start - sb->offset) * factor, newlength * factor);
460 sb->length = newlength;
463 // We add exactly 1 sec of sound to the buffer:
464 // 1- to ensure we won't lose any sample during the resampling process
465 // 2- to force one call to OGG_FetchSound per second to regulate the workload
466 if ((sfx->format.speed + sb->length) * factor > buff_len)
468 Con_Printf ("OGG_FetchSound: stream buffer overflow (%u bytes / %u)\n",
469 (sfx->format.speed + sb->length) * factor, buff_len);
472 newlength = per_sfx->format.speed * factor; // 1 sec of sound before resampling
474 // Decompress in the resampling_buffer
475 #if BYTE_ORDER == LITTLE_ENDIAN
481 while ((ret = qov_read (&per_ch->vf, &resampling_buffer[done], (int)(newlength - done), bigendian, 2, 1, &per_ch->bs)) > 0)
484 // Resample in the sfxbuffer
485 newlength = ResampleSfx (resampling_buffer, (size_t)done / factor, &per_sfx->format, sb->data + sb->length * factor, sfx->name);
486 sb->length += newlength;
497 static void OGG_FetchEnd (channel_t* ch)
499 ogg_stream_perchannel_t* per_ch;
501 per_ch = ch->fetcher_data;
504 // Free the ogg vorbis decoder
505 qov_clear (&per_ch->vf);
508 ch->fetcher_data = NULL;
512 static const snd_fetcher_t ogg_fetcher = { OGG_FetchSound, OGG_FetchEnd };
519 Load an Ogg Vorbis file into memory
522 qboolean OGG_LoadVorbisFile (const char *filename, sfx_t *s)
525 ov_decode_t ov_decode;
528 ogg_int64_t len, buff_len;
533 Mem_FreePool (&s->mempool);
534 s->mempool = Mem_AllocPool (s->name, 0, NULL);
537 data = FS_LoadFile (filename, s->mempool, false);
540 Mem_FreePool (&s->mempool);
544 Con_DPrintf ("Loading Ogg Vorbis file \"%s\"\n", filename);
546 // Open it with the VorbisFile API
547 ov_decode.buffer = data;
549 ov_decode.buffsize = fs_filesize;
550 if (qov_open_callbacks (&ov_decode, &vf, NULL, 0, callbacks) < 0)
552 Con_Printf ("error while opening Ogg Vorbis file \"%s\"\n", filename);
553 Mem_FreePool (&s->mempool);
557 // Get the stream information
558 vi = qov_info (&vf, -1);
559 if (vi->channels < 1 || vi->channels > 2)
561 Con_Printf("%s has an unsupported number of channels (%i)\n",
562 s->name, vi->channels);
564 Mem_FreePool (&s->mempool);
568 len = qov_pcm_total (&vf, -1) * vi->channels * 2; // 16 bits => "* 2"
570 // Decide if we go for a stream or a simple PCM cache
571 buff_len = ceil (STREAM_BUFFER_DURATION * (shm->format.speed * 2 * vi->channels));
572 if (snd_streaming.integer && len > fs_filesize + 3 * buff_len)
574 ogg_stream_persfx_t* per_sfx;
576 Con_DPrintf ("\"%s\" will be streamed\n", filename);
577 per_sfx = Mem_Alloc (s->mempool, sizeof (*per_sfx));
578 per_sfx->file = data;
579 per_sfx->filesize = fs_filesize;
581 per_sfx->format.speed = vi->rate;
582 per_sfx->format.width = 2; // We always work with 16 bits samples
583 per_sfx->format.channels = vi->channels;
584 s->format.speed = shm->format.speed;
585 s->format.width = per_sfx->format.width;
586 s->format.channels = per_sfx->format.channels;
588 s->fetcher_data = per_sfx;
589 s->fetcher = &ogg_fetcher;
591 s->flags |= SFXFLAG_STREAMED;
592 s->total_length = (size_t)len / per_sfx->format.channels / 2 * ((float)s->format.speed / per_sfx->format.speed);
602 Con_DPrintf ("\"%s\" will be cached\n", filename);
605 buff = Mem_Alloc (s->mempool, (int)len);
608 #if BYTE_ORDER == LITTLE_ENDIAN
613 while ((ret = qov_read (&vf, &buff[done], (int)(len - done), bigendian, 2, 1, &bs)) > 0)
616 // Calculate resampled length
617 len = (double)done * (double)shm->format.speed / (double)vi->rate;
620 sb = Mem_Alloc (s->mempool, (size_t)len + sizeof (*sb) - sizeof (sb->data));
621 s->fetcher_data = sb;
622 s->fetcher = &wav_fetcher;
623 s->format.speed = vi->rate;
624 s->format.width = 2; // We always work with 16 bits samples
625 s->format.channels = vi->channels;
627 s->flags &= ~SFXFLAG_STREAMED;
629 sb->length = ResampleSfx (buff, (size_t)done / (vi->channels * 2), &s->format, sb->data, s->name);
630 s->format.speed = shm->format.speed;
631 s->total_length = sb->length;