2 Copyright (C) 2003-2005 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;
224 unsigned char *buffer;
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* dllnames_vo [] =
304 #elif defined(MACOSX)
312 const char* dllnames_vf [] =
315 "libvorbisfile64.dll",
319 #elif defined(MACOSX)
320 "libvorbisfile.dylib",
322 "libvorbisfile.so.3",
332 // COMMANDLINEOPTION: Sound: -novorbis disables ogg vorbis sound support
333 if (COM_CheckParm("-novorbis"))
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))
342 Sys_UnloadLibrary (&vo_dll);
343 Con_Printf ("Ogg Vorbis support disabled\n");
347 Con_Printf ("Ogg Vorbis support enabled\n");
356 Unload the VorbisFile DLL
359 void OGG_CloseLibrary (void)
361 Sys_UnloadLibrary (&vf_dll);
362 Sys_UnloadLibrary (&vo_dll);
367 =================================================================
371 =================================================================
374 #define STREAM_BUFFER_DURATION 1.5f // 1.5 sec
375 #define STREAM_BUFFER_SIZE(format_ptr) ((int)(ceil (STREAM_BUFFER_DURATION * ((format_ptr)->speed * (format_ptr)->width * (format_ptr)->channels))))
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];
382 // Per-sfx data structure
388 } ogg_stream_persfx_t;
390 // Per-channel data structure
394 ov_decode_t ov_decode;
395 unsigned int sb_offset;
397 snd_buffer_t sb; // must be at the end due to its dynamically allocated size
398 } ogg_stream_perchannel_t;
401 static const ov_callbacks callbacks = {ovcb_read, ovcb_seek, ovcb_close, ovcb_tell};
408 static const snd_buffer_t* OGG_FetchSound (channel_t* ch, unsigned int* start, unsigned int nbsampleframes)
410 ogg_stream_perchannel_t* per_ch;
412 ogg_stream_persfx_t* per_sfx;
414 int newlength, done, ret, bigendian;
415 unsigned int real_start;
418 per_ch = (ogg_stream_perchannel_t *)ch->fetcher_data;
420 per_sfx = (ogg_stream_persfx_t *)sfx->fetcher_data;
422 // If there's no fetcher structure attached to the channel yet
425 size_t buff_len, memsize;
426 snd_format_t sb_format;
428 sb_format.speed = snd_renderbuffer->format.speed;
429 sb_format.width = per_sfx->format.width;
430 sb_format.channels = per_sfx->format.channels;
432 buff_len = STREAM_BUFFER_SIZE(&sb_format);
433 memsize = sizeof (*per_ch) - sizeof (per_ch->sb.samples) + buff_len;
434 per_ch = (ogg_stream_perchannel_t *)Mem_Alloc (snd_mempool, memsize);
435 sfx->memsize += memsize;
437 // Open it with the VorbisFile API
438 per_ch->ov_decode.buffer = per_sfx->file;
439 per_ch->ov_decode.ind = 0;
440 per_ch->ov_decode.buffsize = per_sfx->filesize;
441 if (qov_open_callbacks (&per_ch->ov_decode, &per_ch->vf, NULL, 0, callbacks) < 0)
443 Con_Printf("error while reading Ogg Vorbis stream \"%s\"\n", sfx->name);
449 per_ch->sb_offset = 0;
450 per_ch->sb.format = sb_format;
451 per_ch->sb.nbframes = 0;
452 per_ch->sb.maxframes = buff_len / (per_ch->sb.format.channels * per_ch->sb.format.width);
454 ch->fetcher_data = per_ch;
460 factor = per_sfx->format.width * per_sfx->format.channels;
462 // If the stream buffer can't contain that much samples anyway
463 if (nbsampleframes > sb->maxframes)
465 Con_Printf ("OGG_FetchSound: stream buffer too small (%u sample frames required)\n", nbsampleframes);
469 // If the data we need has already been decompressed in the sfxbuffer, just return it
470 if (per_ch->sb_offset <= real_start && per_ch->sb_offset + sb->nbframes >= real_start + nbsampleframes)
472 *start = per_ch->sb_offset;
476 newlength = (int)(per_ch->sb_offset + sb->nbframes) - real_start;
478 // If we need to skip some data before decompressing the rest, or if the stream has looped
479 if (newlength < 0 || per_ch->sb_offset > real_start)
481 unsigned int time_start;
482 ogg_int64_t ogg_start;
485 if (real_start > sfx->total_length)
487 Con_Printf ("OGG_FetchSound: asked for a start position after the end of the sfx! (%u > %u)\n",
488 real_start, sfx->total_length);
492 // We work with 200ms (1/5 sec) steps to avoid rounding errors
493 time_start = real_start * 5 / snd_renderbuffer->format.speed;
494 ogg_start = time_start * (per_sfx->format.speed / 5);
495 err = qov_pcm_seek (&per_ch->vf, ogg_start);
498 Con_Printf ("OGG_FetchSound: qov_pcm_seek(..., %d) returned %d\n",
504 real_start = (float)ogg_start / per_sfx->format.speed * snd_renderbuffer->format.speed;
505 if (*start - real_start + nbsampleframes > sb->maxframes)
507 Con_Printf ("OGG_FetchSound: stream buffer too small after seek (%u sample frames required)\n",
508 *start - real_start + nbsampleframes);
509 per_ch->sb_offset = real_start;
513 // Else, move forward the samples we need to keep in the sound buffer
516 memmove (sb->samples, sb->samples + (real_start - per_ch->sb_offset) * factor, newlength * factor);
517 sb->nbframes = newlength;
520 per_ch->sb_offset = real_start;
522 // We add exactly 1 sec of sound to the buffer:
523 // 1- to ensure we won't lose any sample during the resampling process
524 // 2- to force one call to OGG_FetchSound per second to regulate the workload
525 if (sb->format.speed + sb->nbframes > sb->maxframes)
527 Con_Printf ("OGG_FetchSound: stream buffer overflow (%u sample frames / %u)\n",
528 sb->format.speed + sb->nbframes, sb->maxframes);
531 newlength = per_sfx->format.speed * factor; // -> 1 sec of sound before resampling
533 // Decompress in the resampling_buffer
534 #if BYTE_ORDER == BIG_ENDIAN
540 while ((ret = qov_read (&per_ch->vf, (char *)&resampling_buffer[done], (int)(newlength - done), bigendian, 2, 1, &per_ch->bs)) > 0)
543 Snd_AppendToSndBuffer (sb, resampling_buffer, (size_t)done / (size_t)factor, &per_sfx->format);
545 *start = per_ch->sb_offset;
555 static void OGG_FetchEnd (channel_t* ch)
557 ogg_stream_perchannel_t* per_ch;
559 per_ch = (ogg_stream_perchannel_t *)ch->fetcher_data;
564 // Free the ogg vorbis decoder
565 qov_clear (&per_ch->vf);
567 buff_len = per_ch->sb.maxframes * per_ch->sb.format.channels * per_ch->sb.format.width;
568 ch->sfx->memsize -= sizeof (*per_ch) - sizeof (per_ch->sb.samples) + buff_len;
571 ch->fetcher_data = NULL;
581 static void OGG_FreeSfx (sfx_t* sfx)
583 ogg_stream_persfx_t* per_sfx = (ogg_stream_persfx_t *)sfx->fetcher_data;
585 // Free the Ogg Vorbis file
586 Mem_Free(per_sfx->file);
587 sfx->memsize -= per_sfx->filesize;
589 // Free the stream structure
591 sfx->memsize -= sizeof (*per_sfx);
593 sfx->fetcher_data = NULL;
603 static const snd_format_t* OGG_GetFormat (sfx_t* sfx)
605 ogg_stream_persfx_t* per_sfx = (ogg_stream_persfx_t *)sfx->fetcher_data;
606 return &per_sfx->format;
609 static const snd_fetcher_t ogg_fetcher = { OGG_FetchSound, OGG_FetchEnd, OGG_FreeSfx, OGG_GetFormat };
616 Load an Ogg Vorbis file into memory
619 qboolean OGG_LoadVorbisFile (const char *filename, sfx_t *sfx)
622 fs_offset_t filesize;
623 ov_decode_t ov_decode;
626 ogg_int64_t len, buff_len;
632 if (sfx->fetcher != NULL)
636 data = FS_LoadFile (filename, snd_mempool, false, &filesize);
640 Con_DPrintf ("Loading Ogg Vorbis file \"%s\"\n", filename);
642 // Open it with the VorbisFile API
643 ov_decode.buffer = data;
645 ov_decode.buffsize = filesize;
646 if (qov_open_callbacks (&ov_decode, &vf, NULL, 0, callbacks) < 0)
648 Con_Printf ("error while opening Ogg Vorbis file \"%s\"\n", filename);
653 // Get the stream information
654 vi = qov_info (&vf, -1);
655 if (vi->channels < 1 || vi->channels > 2)
657 Con_Printf("%s has an unsupported number of channels (%i)\n",
658 sfx->name, vi->channels);
664 len = qov_pcm_total (&vf, -1) * vi->channels * 2; // 16 bits => "* 2"
666 // Decide if we go for a stream or a simple PCM cache
667 buff_len = (int)ceil (STREAM_BUFFER_DURATION * (snd_renderbuffer->format.speed * 2 * vi->channels));
668 if (snd_streaming.integer && len > (ogg_int64_t)filesize + 3 * buff_len)
670 ogg_stream_persfx_t* per_sfx;
672 Con_DPrintf ("\"%s\" will be streamed\n", filename);
673 per_sfx = (ogg_stream_persfx_t *)Mem_Alloc (snd_mempool, sizeof (*per_sfx));
674 sfx->memsize += sizeof (*per_sfx);
675 per_sfx->file = data;
676 per_sfx->filesize = filesize;
677 sfx->memsize += filesize;
679 per_sfx->format.speed = vi->rate;
680 per_sfx->format.width = 2; // We always work with 16 bits samples
681 per_sfx->format.channels = vi->channels;
683 sfx->fetcher_data = per_sfx;
684 sfx->fetcher = &ogg_fetcher;
686 sfx->flags |= SFXFLAG_STREAMED;
687 sfx->total_length = (int)((size_t)len / (per_sfx->format.channels * 2) * ((double)snd_renderbuffer->format.speed / per_sfx->format.speed));
696 snd_format_t ogg_format;
698 Con_DPrintf ("\"%s\" will be cached\n", filename);
701 buff = (char *)Mem_Alloc (snd_mempool, (int)len);
704 #if BYTE_ORDER == BIG_ENDIAN
709 while ((ret = qov_read (&vf, &buff[done], (int)(len - done), bigendian, 2, 1, &bs)) > 0)
712 // Build the sound buffer
713 ogg_format.speed = vi->rate;
714 ogg_format.channels = vi->channels;
715 ogg_format.width = 2; // We always work with 16 bits samples
716 sb = Snd_CreateSndBuffer ((unsigned char *)buff, (size_t)done / (vi->channels * 2), &ogg_format, snd_renderbuffer->format.speed);
725 sfx->fetcher = &wav_fetcher;
726 sfx->fetcher_data = sb;
728 sfx->total_length = sb->nbframes;
729 sfx->memsize += sb->maxframes * sb->format.channels * sb->format.width + sizeof (*sb) - sizeof (sb->samples);
732 sfx->flags &= ~SFXFLAG_STREAMED;