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)
302 dllname = "vorbisfile.dll";
304 dllname = "libvorbisfile.so";
308 if (! Sys_LoadLibrary (dllname, &vf_dll, oggvorbisfuncs))
310 Con_Printf ("Ogg Vorbis support disabled\n");
314 Con_Printf ("Ogg Vorbis support enabled\n");
323 Unload the VorbisFile DLL
326 void OGG_CloseLibrary (void)
328 Sys_UnloadLibrary (&vf_dll);
333 =================================================================
337 =================================================================
340 #define STREAM_BUFFER_DURATION 1.5f // 1.5 sec
342 // We work with 1 sec sequences, so this buffer must be able to contain
343 // 1 sec of sound of the highest quality (48 KHz, 16 bit samples, stereo)
344 static qbyte resampling_buffer [48000 * 2 * 2];
347 // Per-sfx data structure
352 } ogg_stream_persfx_t;
354 // Per-channel data structure
358 ov_decode_t ov_decode;
361 sfxbuffer_t sb; // must be at the end due to its dynamically allocated size
362 } ogg_stream_perchannel_t;
365 static const ov_callbacks callbacks = {ovcb_read, ovcb_seek, ovcb_close, ovcb_tell};
372 static const sfxbuffer_t* OGG_FetchSound (channel_t* ch, unsigned int start, unsigned int nbsamples)
374 ogg_stream_perchannel_t* per_ch;
377 int newlength, done, ret, bigendian;
381 per_ch = ch->fetcher_data;
383 buff_len = ceil (STREAM_BUFFER_DURATION * (sfx->format.speed * sfx->format.width * sfx->format.channels));
385 // If there's no fetcher structure attached to the channel yet
389 ogg_stream_persfx_t* per_sfx;
391 per_ch = Mem_Alloc (sfx->mempool, sizeof (*per_ch) - sizeof (per_ch->sb.data) + buff_len);
392 per_sfx = sfx->fetcher_data;
394 // Open it with the VorbisFile API
395 per_ch->ov_decode.buffer = per_sfx->file;
396 per_ch->ov_decode.ind = 0;
397 per_ch->ov_decode.buffsize = per_sfx->filesize;
398 if (qov_open_callbacks (&per_ch->ov_decode, &per_ch->vf, NULL, 0, callbacks) < 0)
400 Con_Printf("error while reading Ogg Vorbis stream \"%s\"\n", sfx->name);
405 // Get the stream information
406 vi = qov_info (&per_ch->vf, -1);
407 per_ch->format.speed = vi->rate;
408 per_ch->format.width = sfx->format.width;
409 per_ch->format.channels = sfx->format.channels;
411 per_ch->sb.offset = 0;
412 per_ch->sb.length = 0;
415 ch->fetcher_data = per_ch;
419 factor = per_ch->format.width * per_ch->format.channels;
421 // If the stream buffer can't contain that much samples anyway
422 if (nbsamples * factor > buff_len)
424 Con_Printf ("OGG_FetchSound: stream buffer too small (%u bytes required)\n", nbsamples * factor);
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)
432 newlength = sb->offset + sb->length - start;
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)
437 if (qov_pcm_seek (&per_ch->vf, (ogg_int64_t)start) != 0)
444 // Else, move forward the samples we need to keep in the sfxbuffer
447 memmove (sb->data, sb->data + (start - sb->offset) * factor, newlength * factor);
449 sb->length = newlength;
452 // We add exactly "per_ch->format.speed" samples per channel to the buffer (i.e. 1 sec of sound):
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 newlength = per_ch->format.speed * factor;
456 if (newlength + sb->length * factor > buff_len)
458 Con_Printf ("OGG_FetchSound: stream buffer overflow (%u bytes / %u)\n",
459 newlength + sb->length * factor, buff_len);
463 // Decompress in the resampling_buffer
464 #if BYTE_ORDER == LITTLE_ENDIAN
470 while ((ret = qov_read (&per_ch->vf, &resampling_buffer[done], (int)(newlength - done), bigendian, 2, 1, &per_ch->bs)) > 0)
473 // Resample in the sfxbuffer
474 newlength = ResampleSfx (resampling_buffer, (size_t)done / factor, &per_ch->format, sb->data + sb->length * factor, sfx->name);
475 sb->length += newlength;
486 static void OGG_FetchEnd (channel_t* ch)
488 ogg_stream_perchannel_t* per_ch;
490 per_ch = ch->fetcher_data;
493 // Free the ogg vorbis decoder
494 qov_clear (&per_ch->vf);
497 ch->fetcher_data = NULL;
501 static const snd_fetcher_t ogg_fetcher = { OGG_FetchSound, OGG_FetchEnd };
508 Load an Ogg Vorbis file into memory
511 qboolean OGG_LoadVorbisFile (const char *filename, sfx_t *s)
514 ov_decode_t ov_decode;
517 ogg_int64_t len, buff_len;
522 Mem_FreePool (&s->mempool);
523 s->mempool = Mem_AllocPool (s->name);
526 data = FS_LoadFile (filename, s->mempool, false);
529 Mem_FreePool (&s->mempool);
533 Con_DPrintf ("Loading Ogg Vorbis file \"%s\"\n", filename);
535 // Open it with the VorbisFile API
536 ov_decode.buffer = data;
538 ov_decode.buffsize = fs_filesize;
539 if (qov_open_callbacks (&ov_decode, &vf, NULL, 0, callbacks) < 0)
541 Con_Printf ("error while opening Ogg Vorbis file \"%s\"\n", filename);
542 Mem_FreePool (&s->mempool);
546 // Get the stream information
547 vi = qov_info (&vf, -1);
548 if (vi->channels < 1 || vi->channels > 2)
550 Con_Printf("%s has an unsupported number of channels (%i)\n",
551 s->name, vi->channels);
553 Mem_FreePool (&s->mempool);
557 len = qov_pcm_total (&vf, -1) * vi->channels * 2; // 16 bits => "* 2"
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)
563 ogg_stream_persfx_t* per_sfx;
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 s->fetcher_data = per_sfx;
570 s->fetcher = &ogg_fetcher;
571 s->format.speed = shm->format.speed;
572 s->format.width = 2; // We always work with 16 bits samples
573 s->format.channels = vi->channels;
575 s->flags |= SFXFLAG_STREAMED;
576 s->total_length = (size_t)len / (vi->channels * 2) * ((float)shm->format.speed / vi->rate);
586 Con_DPrintf ("\"%s\" will be streamed\n", filename);
589 buff = Mem_Alloc (s->mempool, (int)len);
592 #if BYTE_ORDER == LITTLE_ENDIAN
597 while ((ret = qov_read (&vf, &buff[done], (int)(len - done), bigendian, 2, 1, &bs)) > 0)
600 // Calculate resampled length
601 len = (double)done * (double)shm->format.speed / (double)vi->rate;
604 sb = Mem_Alloc (s->mempool, (size_t)len + sizeof (*sb) - sizeof (sb->data));
605 s->fetcher_data = sb;
606 s->fetcher = &wav_fetcher;
607 s->format.speed = vi->rate;
608 s->format.width = 2; // We always work with 16 bits samples
609 s->format.channels = vi->channels;
611 s->flags &= ~SFXFLAG_STREAMED;
613 sb->length = ResampleSfx (buff, (size_t)done / (vi->channels * 2), &s->format, sb->data, s->name);
614 s->format.speed = shm->format.speed;
615 s->total_length = sb->length;