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
31 =================================================================
33 Minimal set of definitions from the Ogg Vorbis lib
34 (C) COPYRIGHT 1994-2001 by the XIPHOPHORUS Company
37 WARNING: for a matter of simplicity, several pointer types are
38 casted to "void*", and most enumerated values are not included
40 =================================================================
44 typedef __int64 ogg_int64_t;
46 typedef long long ogg_int64_t;
51 size_t (*read_func) (void *ptr, size_t size, size_t nmemb, void *datasource);
52 int (*seek_func) (void *datasource, ogg_int64_t offset, int whence);
53 int (*close_func) (void *datasource);
54 long (*tell_func) (void *datasource);
82 unsigned char *body_data;
87 ogg_int64_t *granule_vals;
92 unsigned char header[282];
99 ogg_int64_t granulepos;
117 ogg_int64_t granulepos;
118 ogg_int64_t sequence;
119 ogg_int64_t glue_bits;
120 ogg_int64_t time_bits;
121 ogg_int64_t floor_bits;
122 ogg_int64_t res_bits;
130 unsigned char *buffer;
145 ogg_int64_t granulepos;
146 ogg_int64_t sequence;
147 vorbis_dsp_state *vd;
152 void *reap; // VOIDED POINTER
168 ogg_int64_t *offsets;
169 ogg_int64_t *dataoffsets;
171 ogg_int64_t *pcmlengths;
173 void *vc; // VOIDED POINTER
174 ogg_int64_t pcm_offset;
176 long current_serialno;
183 ov_callbacks callbacks;
188 =================================================================
190 DarkPlaces definitions
192 =================================================================
195 // Functions exported from the vorbisfile library
196 static int (*qov_clear) (OggVorbis_File *vf);
197 static vorbis_info* (*qov_info) (OggVorbis_File *vf,int link);
198 static int (*qov_open_callbacks) (void *datasource, OggVorbis_File *vf,
199 char *initial, long ibytes,
200 ov_callbacks callbacks);
201 static int (*qov_pcm_seek) (OggVorbis_File *vf,ogg_int64_t pos);
202 static ogg_int64_t (*qov_pcm_total) (OggVorbis_File *vf,int i);
203 static long (*qov_read) (OggVorbis_File *vf,char *buffer,int length,
204 int bigendianp,int word,int sgned,int *bitstream);
206 static dllfunction_t oggvorbisfuncs[] =
208 {"ov_clear", (void **) &qov_clear},
209 {"ov_info", (void **) &qov_info},
210 {"ov_open_callbacks", (void **) &qov_open_callbacks},
211 {"ov_pcm_seek", (void **) &qov_pcm_seek},
212 {"ov_pcm_total", (void **) &qov_pcm_total},
213 {"ov_read", (void **) &qov_read},
217 // Handle for the Vorbisfile DLL
218 static dllhandle_t vf_dll = NULL;
223 ogg_int64_t ind, buffsize;
227 static size_t ovcb_read (void *ptr, size_t size, size_t nb, void *datasource)
229 ov_decode_t *ov_decode = (ov_decode_t*)datasource;
232 remain = ov_decode->buffsize - ov_decode->ind;
235 len = remain - remain % size;
237 memcpy (ptr, ov_decode->buffer + ov_decode->ind, len);
238 ov_decode->ind += len;
243 static int ovcb_seek (void *datasource, ogg_int64_t offset, int whence)
245 ov_decode_t *ov_decode = (ov_decode_t*)datasource;
252 offset += ov_decode->ind;
255 offset += ov_decode->buffsize;
260 if (offset < 0 || offset > ov_decode->buffsize)
263 ov_decode->ind = offset;
267 static int ovcb_close (void *ov_decode)
272 static long ovcb_tell (void *ov_decode)
274 return ((ov_decode_t*)ov_decode)->ind;
279 =================================================================
283 =================================================================
290 Try to load the VorbisFile DLL
293 qboolean OGG_OpenLibrary (void)
301 if (COM_CheckParm("-novorbis"))
305 dllname = "vorbisfile.dll";
307 dllname = "libvorbisfile.so";
311 if (! Sys_LoadLibrary (dllname, &vf_dll, oggvorbisfuncs))
313 Con_Printf ("Ogg Vorbis support disabled\n");
317 Con_Printf ("Ogg Vorbis support enabled\n");
326 Unload the VorbisFile DLL
329 void OGG_CloseLibrary (void)
331 Sys_UnloadLibrary (&vf_dll);
336 =================================================================
340 =================================================================
343 #define STREAM_BUFFER_DURATION 1.5f // 1.5 sec
345 // We work with 1 sec sequences, so this buffer must be able to contain
346 // 1 sec of sound of the highest quality (48 KHz, 16 bit samples, stereo)
347 static qbyte resampling_buffer [48000 * 2 * 2];
350 // Per-sfx data structure
356 } ogg_stream_persfx_t;
358 // Per-channel data structure
362 ov_decode_t ov_decode;
364 sfxbuffer_t sb; // must be at the end due to its dynamically allocated size
365 } ogg_stream_perchannel_t;
368 static const ov_callbacks callbacks = {ovcb_read, ovcb_seek, ovcb_close, ovcb_tell};
375 static const sfxbuffer_t* OGG_FetchSound (channel_t* ch, unsigned int start, unsigned int nbsamples)
377 ogg_stream_perchannel_t* per_ch;
380 ogg_stream_persfx_t* per_sfx;
381 int newlength, done, ret, bigendian;
385 per_ch = ch->fetcher_data;
387 per_sfx = sfx->fetcher_data;
388 buff_len = ceil (STREAM_BUFFER_DURATION * (sfx->format.speed * sfx->format.width * sfx->format.channels));
390 // If there's no fetcher structure attached to the channel yet
393 ogg_stream_persfx_t* per_sfx;
395 per_ch = Mem_Alloc (sfx->mempool, sizeof (*per_ch) - sizeof (per_ch->sb.data) + buff_len);
396 per_sfx = sfx->fetcher_data;
398 // Open it with the VorbisFile API
399 per_ch->ov_decode.buffer = per_sfx->file;
400 per_ch->ov_decode.ind = 0;
401 per_ch->ov_decode.buffsize = per_sfx->filesize;
402 if (qov_open_callbacks (&per_ch->ov_decode, &per_ch->vf, NULL, 0, callbacks) < 0)
404 Con_Printf("error while reading Ogg Vorbis stream \"%s\"\n", sfx->name);
409 per_ch->sb.offset = 0;
410 per_ch->sb.length = 0;
413 ch->fetcher_data = per_ch;
417 factor = per_sfx->format.width * per_sfx->format.channels;
419 // If the stream buffer can't contain that much samples anyway
420 if (nbsamples * factor > buff_len)
422 Con_Printf ("OGG_FetchSound: stream buffer too small (%u bytes required)\n", nbsamples * factor);
426 // If the data we need has already been decompressed in the sfxbuffer, just return it
427 if (sb->offset <= start && sb->offset + sb->length >= start + nbsamples)
430 newlength = sb->offset + sb->length - start;
432 // If we need to skip some data before decompressing the rest, or if the stream has looped
433 if (newlength < 0 || sb->offset > start)
435 if (qov_pcm_seek (&per_ch->vf, (ogg_int64_t)start) != 0)
442 // Else, move forward the samples we need to keep in the sfxbuffer
445 memmove (sb->data, sb->data + (start - sb->offset) * factor, newlength * factor);
447 sb->length = newlength;
450 // We add exactly 1 sec of sound to the buffer:
451 // 1- to ensure we won't lose any sample during the resampling process
452 // 2- to force one call to OGG_FetchSound per second to regulate the workload
453 if ((sfx->format.speed + sb->length) * factor > buff_len)
455 Con_Printf ("OGG_FetchSound: stream buffer overflow (%u bytes / %u)\n",
456 (sfx->format.speed + sb->length) * factor, buff_len);
459 newlength = per_sfx->format.speed * factor; // 1 sec of sound before resampling
461 // Decompress in the resampling_buffer
462 #if BYTE_ORDER == LITTLE_ENDIAN
468 while ((ret = qov_read (&per_ch->vf, &resampling_buffer[done], (int)(newlength - done), bigendian, 2, 1, &per_ch->bs)) > 0)
471 // Resample in the sfxbuffer
472 newlength = ResampleSfx (resampling_buffer, (size_t)done / factor, &per_sfx->format, sb->data + sb->length * factor, sfx->name);
473 sb->length += newlength;
484 static void OGG_FetchEnd (channel_t* ch)
486 ogg_stream_perchannel_t* per_ch;
488 per_ch = ch->fetcher_data;
491 // Free the ogg vorbis decoder
492 qov_clear (&per_ch->vf);
495 ch->fetcher_data = NULL;
499 static const snd_fetcher_t ogg_fetcher = { OGG_FetchSound, OGG_FetchEnd };
506 Load an Ogg Vorbis file into memory
509 qboolean OGG_LoadVorbisFile (const char *filename, sfx_t *s)
512 ov_decode_t ov_decode;
515 ogg_int64_t len, buff_len;
520 Mem_FreePool (&s->mempool);
521 s->mempool = Mem_AllocPool (s->name, 0, NULL);
524 data = FS_LoadFile (filename, s->mempool, false);
527 Mem_FreePool (&s->mempool);
531 Con_DPrintf ("Loading Ogg Vorbis file \"%s\"\n", filename);
533 // Open it with the VorbisFile API
534 ov_decode.buffer = data;
536 ov_decode.buffsize = fs_filesize;
537 if (qov_open_callbacks (&ov_decode, &vf, NULL, 0, callbacks) < 0)
539 Con_Printf ("error while opening Ogg Vorbis file \"%s\"\n", filename);
540 Mem_FreePool (&s->mempool);
544 // Get the stream information
545 vi = qov_info (&vf, -1);
546 if (vi->channels < 1 || vi->channels > 2)
548 Con_Printf("%s has an unsupported number of channels (%i)\n",
549 s->name, vi->channels);
551 Mem_FreePool (&s->mempool);
555 len = qov_pcm_total (&vf, -1) * vi->channels * 2; // 16 bits => "* 2"
557 // Decide if we go for a stream or a simple PCM cache
558 buff_len = ceil (STREAM_BUFFER_DURATION * (shm->format.speed * 2 * vi->channels));
559 if (snd_streaming.integer && len > fs_filesize + 3 * buff_len)
561 ogg_stream_persfx_t* per_sfx;
563 Con_DPrintf ("\"%s\" will be streamed\n", filename);
564 per_sfx = Mem_Alloc (s->mempool, sizeof (*per_sfx));
565 per_sfx->file = data;
566 per_sfx->filesize = fs_filesize;
568 per_sfx->format.speed = vi->rate;
569 per_sfx->format.width = 2; // We always work with 16 bits samples
570 per_sfx->format.channels = vi->channels;
571 s->format.speed = shm->format.speed;
572 s->format.width = per_sfx->format.width;
573 s->format.channels = per_sfx->format.channels;
575 s->fetcher_data = per_sfx;
576 s->fetcher = &ogg_fetcher;
578 s->flags |= SFXFLAG_STREAMED;
579 s->total_length = (size_t)len / per_sfx->format.channels / 2 * ((float)s->format.speed / per_sfx->format.speed);
589 Con_DPrintf ("\"%s\" will be streamed\n", filename);
592 buff = Mem_Alloc (s->mempool, (int)len);
595 #if BYTE_ORDER == LITTLE_ENDIAN
600 while ((ret = qov_read (&vf, &buff[done], (int)(len - done), bigendian, 2, 1, &bs)) > 0)
603 // Calculate resampled length
604 len = (double)done * (double)shm->format.speed / (double)vi->rate;
607 sb = Mem_Alloc (s->mempool, (size_t)len + sizeof (*sb) - sizeof (sb->data));
608 s->fetcher_data = sb;
609 s->fetcher = &wav_fetcher;
610 s->format.speed = vi->rate;
611 s->format.width = 2; // We always work with 16 bits samples
612 s->format.channels = vi->channels;
614 s->flags &= ~SFXFLAG_STREAMED;
616 sb->length = ResampleSfx (buff, (size_t)done / (vi->channels * 2), &s->format, sb->data, s->name);
617 s->format.speed = shm->format.speed;
618 s->total_length = sb->length;