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
163 char **user_comments;
164 int *comment_lengths;
177 ogg_int64_t *offsets;
178 ogg_int64_t *dataoffsets;
180 ogg_int64_t *pcmlengths;
183 ogg_int64_t pcm_offset;
185 long current_serialno;
192 ov_callbacks callbacks;
197 =================================================================
199 DarkPlaces definitions
201 =================================================================
204 // Functions exported from the vorbisfile library
205 static int (*qov_clear) (OggVorbis_File *vf);
206 static vorbis_info* (*qov_info) (OggVorbis_File *vf,int link);
207 static vorbis_comment* (*qov_comment) (OggVorbis_File *vf,int link);
208 static char * (*qvorbis_comment_query) (vorbis_comment *vc, char *tag, int count);
209 static int (*qov_open_callbacks) (void *datasource, OggVorbis_File *vf,
210 char *initial, long ibytes,
211 ov_callbacks callbacks);
212 static int (*qov_pcm_seek) (OggVorbis_File *vf,ogg_int64_t pos);
213 static ogg_int64_t (*qov_pcm_total) (OggVorbis_File *vf,int i);
214 static long (*qov_read) (OggVorbis_File *vf,char *buffer,int length,
215 int bigendianp,int word,int sgned,int *bitstream);
217 static dllfunction_t oggvorbisfuncs[] =
219 {"ov_clear", (void **) &qov_clear},
220 {"ov_info", (void **) &qov_info},
221 {"ov_comment", (void **) &qov_comment},
222 {"vorbis_comment_query", (void **) &qvorbis_comment_query},
223 {"ov_open_callbacks", (void **) &qov_open_callbacks},
224 {"ov_pcm_seek", (void **) &qov_pcm_seek},
225 {"ov_pcm_total", (void **) &qov_pcm_total},
226 {"ov_read", (void **) &qov_read},
230 // Handles for the Vorbis and Vorbisfile DLLs
231 static dllhandle_t vo_dll = NULL;
232 static dllhandle_t vf_dll = NULL;
236 unsigned char *buffer;
237 ogg_int64_t ind, buffsize;
241 static size_t ovcb_read (void *ptr, size_t size, size_t nb, void *datasource)
243 ov_decode_t *ov_decode = (ov_decode_t*)datasource;
246 remain = ov_decode->buffsize - ov_decode->ind;
249 len = remain - remain % size;
251 memcpy (ptr, ov_decode->buffer + ov_decode->ind, len);
252 ov_decode->ind += len;
257 static int ovcb_seek (void *datasource, ogg_int64_t offset, int whence)
259 ov_decode_t *ov_decode = (ov_decode_t*)datasource;
266 offset += ov_decode->ind;
269 offset += ov_decode->buffsize;
274 if (offset < 0 || offset > ov_decode->buffsize)
277 ov_decode->ind = offset;
281 static int ovcb_close (void *ov_decode)
286 static long ovcb_tell (void *ov_decode)
288 return ((ov_decode_t*)ov_decode)->ind;
293 =================================================================
297 =================================================================
304 Try to load the VorbisFile DLL
307 qboolean OGG_OpenLibrary (void)
309 const char* dllnames_vo [] =
316 #elif defined(MACOSX)
324 const char* dllnames_vf [] =
327 "libvorbisfile64.dll",
331 #elif defined(MACOSX)
332 "libvorbisfile.dylib",
334 "libvorbisfile.so.3",
344 // COMMANDLINEOPTION: Sound: -novorbis disables ogg vorbis sound support
345 if (COM_CheckParm("-novorbis"))
349 // We need to load both by hand because some OSes seem to not load
350 // the vorbis DLL automatically when loading the VorbisFile DLL
351 if (! Sys_LoadLibrary (dllnames_vo, &vo_dll, NULL) ||
352 ! Sys_LoadLibrary (dllnames_vf, &vf_dll, oggvorbisfuncs))
354 Sys_UnloadLibrary (&vo_dll);
355 Con_Printf ("Ogg Vorbis support disabled\n");
359 Con_Printf ("Ogg Vorbis support enabled\n");
368 Unload the VorbisFile DLL
371 void OGG_CloseLibrary (void)
373 Sys_UnloadLibrary (&vf_dll);
374 Sys_UnloadLibrary (&vo_dll);
379 =================================================================
383 =================================================================
386 #define STREAM_BUFFER_DURATION 1.5f // 1.5 sec
387 #define STREAM_BUFFER_SIZE(format_ptr) ((int)(ceil (STREAM_BUFFER_DURATION * ((format_ptr)->speed * (format_ptr)->width * (format_ptr)->channels))))
389 // We work with 1 sec sequences, so this buffer must be able to contain
390 // 1 sec of sound of the highest quality (48 KHz, 16 bit samples, stereo)
391 static unsigned char resampling_buffer [48000 * 2 * 2];
394 // Per-sfx data structure
400 } ogg_stream_persfx_t;
402 // Per-channel data structure
406 ov_decode_t ov_decode;
407 unsigned int sb_offset;
409 snd_buffer_t sb; // must be at the end due to its dynamically allocated size
410 } ogg_stream_perchannel_t;
413 static const ov_callbacks callbacks = {ovcb_read, ovcb_seek, ovcb_close, ovcb_tell};
420 static const snd_buffer_t* OGG_FetchSound (channel_t* ch, unsigned int* start, unsigned int nbsampleframes)
422 ogg_stream_perchannel_t* per_ch;
424 ogg_stream_persfx_t* per_sfx;
426 int newlength, done, ret, bigendian;
427 unsigned int real_start;
430 per_ch = (ogg_stream_perchannel_t *)ch->fetcher_data;
432 per_sfx = (ogg_stream_persfx_t *)sfx->fetcher_data;
434 // If there's no fetcher structure attached to the channel yet
437 size_t buff_len, memsize;
438 snd_format_t sb_format;
440 sb_format.speed = snd_renderbuffer->format.speed;
441 sb_format.width = per_sfx->format.width;
442 sb_format.channels = per_sfx->format.channels;
444 buff_len = STREAM_BUFFER_SIZE(&sb_format);
445 memsize = sizeof (*per_ch) - sizeof (per_ch->sb.samples) + buff_len;
446 per_ch = (ogg_stream_perchannel_t *)Mem_Alloc (snd_mempool, memsize);
447 sfx->memsize += memsize;
449 // Open it with the VorbisFile API
450 per_ch->ov_decode.buffer = per_sfx->file;
451 per_ch->ov_decode.ind = 0;
452 per_ch->ov_decode.buffsize = per_sfx->filesize;
453 if (qov_open_callbacks (&per_ch->ov_decode, &per_ch->vf, NULL, 0, callbacks) < 0)
455 Con_Printf("error while reading Ogg Vorbis stream \"%s\"\n", sfx->name);
461 per_ch->sb_offset = 0;
462 per_ch->sb.format = sb_format;
463 per_ch->sb.nbframes = 0;
464 per_ch->sb.maxframes = buff_len / (per_ch->sb.format.channels * per_ch->sb.format.width);
466 ch->fetcher_data = per_ch;
472 factor = per_sfx->format.width * per_sfx->format.channels;
474 // If the stream buffer can't contain that much samples anyway
475 if (nbsampleframes > sb->maxframes)
477 Con_Printf ("OGG_FetchSound: stream buffer too small (%u sample frames required)\n", nbsampleframes);
481 // If the data we need has already been decompressed in the sfxbuffer, just return it
482 if (per_ch->sb_offset <= real_start && per_ch->sb_offset + sb->nbframes >= real_start + nbsampleframes)
484 *start = per_ch->sb_offset;
488 newlength = (int)(per_ch->sb_offset + sb->nbframes) - real_start;
490 // If we need to skip some data before decompressing the rest, or if the stream has looped
491 if (newlength < 0 || per_ch->sb_offset > real_start)
493 unsigned int time_start;
494 ogg_int64_t ogg_start;
497 if (real_start > (unsigned int)sfx->total_length)
499 Con_Printf ("OGG_FetchSound: asked for a start position after the end of the sfx! (%u > %u)\n",
500 real_start, sfx->total_length);
504 // We work with 200ms (1/5 sec) steps to avoid rounding errors
505 time_start = real_start * 5 / snd_renderbuffer->format.speed;
506 ogg_start = time_start * (per_sfx->format.speed / 5);
507 err = qov_pcm_seek (&per_ch->vf, ogg_start);
510 Con_Printf ("OGG_FetchSound: qov_pcm_seek(..., %d) returned %d\n",
516 real_start = (float)ogg_start / per_sfx->format.speed * snd_renderbuffer->format.speed;
517 if (*start - real_start + nbsampleframes > sb->maxframes)
519 Con_Printf ("OGG_FetchSound: stream buffer too small after seek (%u sample frames required)\n",
520 *start - real_start + nbsampleframes);
521 per_ch->sb_offset = real_start;
525 // Else, move forward the samples we need to keep in the sound buffer
528 memmove (sb->samples, sb->samples + (real_start - per_ch->sb_offset) * factor, newlength * factor);
529 sb->nbframes = newlength;
532 per_ch->sb_offset = real_start;
534 // We add exactly 1 sec of sound to the buffer:
535 // 1- to ensure we won't lose any sample during the resampling process
536 // 2- to force one call to OGG_FetchSound per second to regulate the workload
537 if (sb->format.speed + sb->nbframes > sb->maxframes)
539 Con_Printf ("OGG_FetchSound: stream buffer overflow (%u sample frames / %u)\n",
540 sb->format.speed + sb->nbframes, sb->maxframes);
543 newlength = per_sfx->format.speed * factor; // -> 1 sec of sound before resampling
545 // Decompress in the resampling_buffer
546 #if BYTE_ORDER == BIG_ENDIAN
552 while ((ret = qov_read (&per_ch->vf, (char *)&resampling_buffer[done], (int)(newlength - done), bigendian, 2, 1, &per_ch->bs)) > 0)
555 Snd_AppendToSndBuffer (sb, resampling_buffer, (size_t)done / (size_t)factor, &per_sfx->format);
557 *start = per_ch->sb_offset;
567 static void OGG_FetchEnd (channel_t* ch)
569 ogg_stream_perchannel_t* per_ch;
571 per_ch = (ogg_stream_perchannel_t *)ch->fetcher_data;
576 // Free the ogg vorbis decoder
577 qov_clear (&per_ch->vf);
579 buff_len = per_ch->sb.maxframes * per_ch->sb.format.channels * per_ch->sb.format.width;
580 ch->sfx->memsize -= sizeof (*per_ch) - sizeof (per_ch->sb.samples) + buff_len;
583 ch->fetcher_data = NULL;
593 static void OGG_FreeSfx (sfx_t* sfx)
595 ogg_stream_persfx_t* per_sfx = (ogg_stream_persfx_t *)sfx->fetcher_data;
597 // Free the Ogg Vorbis file
598 Mem_Free(per_sfx->file);
599 sfx->memsize -= per_sfx->filesize;
601 // Free the stream structure
603 sfx->memsize -= sizeof (*per_sfx);
605 sfx->fetcher_data = NULL;
615 static const snd_format_t* OGG_GetFormat (sfx_t* sfx)
617 ogg_stream_persfx_t* per_sfx = (ogg_stream_persfx_t *)sfx->fetcher_data;
618 return &per_sfx->format;
621 static const snd_fetcher_t ogg_fetcher = { OGG_FetchSound, OGG_FetchEnd, OGG_FreeSfx, OGG_GetFormat };
628 Load an Ogg Vorbis file into memory
631 qboolean OGG_LoadVorbisFile (const char *filename, sfx_t *sfx)
634 const char *loopcomment;
635 fs_offset_t filesize;
636 ov_decode_t ov_decode;
640 ogg_int64_t len, buff_len;
646 if (sfx->fetcher != NULL)
650 data = FS_LoadFile (filename, snd_mempool, false, &filesize);
654 Con_DPrintf ("Loading Ogg Vorbis file \"%s\"\n", filename);
656 // Open it with the VorbisFile API
657 ov_decode.buffer = data;
659 ov_decode.buffsize = filesize;
660 if (qov_open_callbacks (&ov_decode, &vf, NULL, 0, callbacks) < 0)
662 Con_Printf ("error while opening Ogg Vorbis file \"%s\"\n", filename);
667 // Get the stream information
668 vi = qov_info (&vf, -1);
669 if (vi->channels < 1 || vi->channels > 2)
671 Con_Printf("%s has an unsupported number of channels (%i)\n",
672 sfx->name, vi->channels);
678 len = qov_pcm_total (&vf, -1) * vi->channels * 2; // 16 bits => "* 2"
680 // Decide if we go for a stream or a simple PCM cache
681 buff_len = (int)ceil (STREAM_BUFFER_DURATION * (snd_renderbuffer->format.speed * 2 * vi->channels));
682 if (snd_streaming.integer && len > (ogg_int64_t)filesize + 3 * buff_len)
684 ogg_stream_persfx_t* per_sfx;
686 Con_DPrintf ("\"%s\" will be streamed\n", filename);
687 per_sfx = (ogg_stream_persfx_t *)Mem_Alloc (snd_mempool, sizeof (*per_sfx));
688 sfx->memsize += sizeof (*per_sfx);
689 per_sfx->file = data;
690 per_sfx->filesize = filesize;
691 sfx->memsize += filesize;
693 per_sfx->format.speed = vi->rate;
694 per_sfx->format.width = 2; // We always work with 16 bits samples
695 per_sfx->format.channels = vi->channels;
697 sfx->fetcher_data = per_sfx;
698 sfx->fetcher = &ogg_fetcher;
699 sfx->flags |= SFXFLAG_STREAMED;
700 sfx->total_length = (int)((size_t)len / (per_sfx->format.channels * 2) * ((double)snd_renderbuffer->format.speed / per_sfx->format.speed));
701 sfx->loopstart = sfx->total_length;
702 vc = qov_comment(&vf, -1);
705 loopcomment = qvorbis_comment_query(vc, "LOOP_START", 0);
707 sfx->loopstart = bound(0, (unsigned int) (atof(loopcomment) * (double)snd_renderbuffer->format.speed / (double)per_sfx->format.speed), sfx->total_length);
717 snd_format_t ogg_format;
719 Con_DPrintf ("\"%s\" will be cached\n", filename);
722 buff = (char *)Mem_Alloc (snd_mempool, (int)len);
725 #if BYTE_ORDER == BIG_ENDIAN
730 while ((ret = qov_read (&vf, &buff[done], (int)(len - done), bigendian, 2, 1, &bs)) > 0)
733 // Build the sound buffer
734 ogg_format.speed = vi->rate;
735 ogg_format.channels = vi->channels;
736 ogg_format.width = 2; // We always work with 16 bits samples
737 sb = Snd_CreateSndBuffer ((unsigned char *)buff, (size_t)done / (vi->channels * 2), &ogg_format, snd_renderbuffer->format.speed);
746 sfx->fetcher = &wav_fetcher;
747 sfx->fetcher_data = sb;
749 sfx->total_length = sb->nbframes;
750 sfx->memsize += sb->maxframes * sb->format.channels * sb->format.width + sizeof (*sb) - sizeof (sb->samples);
752 sfx->loopstart = sfx->total_length;
753 sfx->flags &= ~SFXFLAG_STREAMED;
754 vc = qov_comment(&vf, -1);
757 loopcomment = qvorbis_comment_query(vc, "LOOP_START", 0);
759 sfx->loopstart = bound(0, (unsigned int) (atoi(loopcomment) * (double)snd_renderbuffer->format.speed / (double)sb->format.speed), sfx->total_length);