X-Git-Url: http://git.xonotic.org/?a=blobdiff_plain;f=snd_ogg.c;h=09d20c8e307c0e2d9c9c93397c5cf8577957dff4;hb=bbb80fb5e4edbd1a226bdc0e15d6f45efa11c67b;hp=8acedc7c3d0362ede540b6fc821caf3b6f509136;hpb=355bc09086e3ff04769e90565df100e510f852da;p=xonotic%2Fdarkplaces.git diff --git a/snd_ogg.c b/snd_ogg.c index 8acedc7c..09d20c8e 100644 --- a/snd_ogg.c +++ b/snd_ogg.c @@ -1,5 +1,5 @@ /* - Copyright (C) 2003 Mathieu Olivier + Copyright (C) 2003-2005 Mathieu Olivier This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License @@ -22,12 +22,29 @@ */ -#include "quakedef.h" +#include "darkplaces.h" +#include "snd_main.h" #include "snd_ogg.h" - - -extern void ResampleSfx (sfxcache_t *sc, qbyte *data, char *name); - +#include "snd_wav.h" +#include "sound.h" + +#ifdef LINK_TO_LIBVORBIS +#define OV_EXCLUDE_STATIC_CALLBACKS +#include +#include + +#define qov_clear ov_clear +#define qov_info ov_info +#define qov_comment ov_comment +#define qov_open_callbacks ov_open_callbacks +#define qov_pcm_seek ov_pcm_seek +#define qov_pcm_total ov_pcm_total +#define qov_read ov_read +#define qvorbis_comment_query vorbis_comment_query + +qbool OGG_OpenLibrary (void) {return true;} +void OGG_CloseLibrary (void) {} +#else /* ================================================================= @@ -42,16 +59,10 @@ extern void ResampleSfx (sfxcache_t *sc, qbyte *data, char *name); ================================================================= */ -#ifdef _MSC_VER -typedef __int64 ogg_int64_t; -#else -typedef long long ogg_int64_t; -#endif - typedef struct { size_t (*read_func) (void *ptr, size_t size, size_t nmemb, void *datasource); - int (*seek_func) (void *datasource, ogg_int64_t offset, int whence); + int (*seek_func) (void *datasource, int64_t offset, int whence); int (*close_func) (void *datasource); long (*tell_func) (void *datasource); } ov_callbacks; @@ -86,7 +97,7 @@ typedef struct long body_fill; long body_returned; int *lacing_vals; - ogg_int64_t *granule_vals; + int64_t *granule_vals; long lacing_storage; long lacing_fill; long lacing_packet; @@ -97,8 +108,8 @@ typedef struct int b_o_s; long serialno; long pageno; - ogg_int64_t packetno; - ogg_int64_t granulepos; + int64_t packetno; + int64_t granulepos; } ogg_stream_state; typedef struct @@ -116,12 +127,12 @@ typedef struct long W; long nW; long centerW; - ogg_int64_t granulepos; - ogg_int64_t sequence; - ogg_int64_t glue_bits; - ogg_int64_t time_bits; - ogg_int64_t floor_bits; - ogg_int64_t res_bits; + int64_t granulepos; + int64_t sequence; + int64_t glue_bits; + int64_t time_bits; + int64_t floor_bits; + int64_t res_bits; void *backend_state; } vorbis_dsp_state; @@ -144,8 +155,8 @@ typedef struct int pcmend; int mode; int eofflag; - ogg_int64_t granulepos; - ogg_int64_t sequence; + int64_t granulepos; + int64_t sequence; vorbis_dsp_state *vd; void *localstore; long localtop; @@ -159,21 +170,29 @@ typedef struct void *internal; } vorbis_block; +typedef struct +{ + char **user_comments; + int *comment_lengths; + int comments; + char *vendor; +} vorbis_comment; + typedef struct { void *datasource; int seekable; - ogg_int64_t offset; - ogg_int64_t end; + int64_t offset; + int64_t end; ogg_sync_state oy; int links; - ogg_int64_t *offsets; - ogg_int64_t *dataoffsets; + int64_t *offsets; + int64_t *dataoffsets; long *serialnos; - ogg_int64_t *pcmlengths; + int64_t *pcmlengths; vorbis_info *vi; - void *vc; // VOIDED POINTER - ogg_int64_t pcm_offset; + vorbis_comment *vc; + int64_t pcm_offset; int ready_state; long current_serialno; int current_link; @@ -197,33 +216,129 @@ typedef struct // Functions exported from the vorbisfile library static int (*qov_clear) (OggVorbis_File *vf); static vorbis_info* (*qov_info) (OggVorbis_File *vf,int link); +static vorbis_comment* (*qov_comment) (OggVorbis_File *vf,int link); +static char * (*qvorbis_comment_query) (vorbis_comment *vc, const char *tag, int count); static int (*qov_open_callbacks) (void *datasource, OggVorbis_File *vf, char *initial, long ibytes, ov_callbacks callbacks); -static ogg_int64_t (*qov_pcm_total) (OggVorbis_File *vf,int i); +static int (*qov_pcm_seek) (OggVorbis_File *vf,int64_t pos); +static int64_t (*qov_pcm_total) (OggVorbis_File *vf,int i); static long (*qov_read) (OggVorbis_File *vf,char *buffer,int length, int bigendianp,int word,int sgned,int *bitstream); -static dllfunction_t oggvorbisfuncs[] = +static dllfunction_t vorbisfilefuncs[] = { - {"ov_clear", (void **) &qov_clear}, - {"ov_info", (void **) &qov_info}, - {"ov_open_callbacks", (void **) &qov_open_callbacks}, - {"ov_pcm_total", (void **) &qov_pcm_total}, - {"ov_read", (void **) &qov_read}, + {"ov_clear", (void **) &qov_clear}, + {"ov_info", (void **) &qov_info}, + {"ov_comment", (void **) &qov_comment}, + {"ov_open_callbacks", (void **) &qov_open_callbacks}, + {"ov_pcm_seek", (void **) &qov_pcm_seek}, + {"ov_pcm_total", (void **) &qov_pcm_total}, + {"ov_read", (void **) &qov_read}, {NULL, NULL} }; -// Handle for the Vorbisfile DLL +static dllfunction_t vorbisfuncs[] = +{ + {"vorbis_comment_query", (void **) &qvorbis_comment_query}, + {NULL, NULL} +}; + +// Handles for the Vorbis and Vorbisfile DLLs +static dllhandle_t vo_dll = NULL; static dllhandle_t vf_dll = NULL; + +/* +================================================================= + + DLL load & unload + +================================================================= +*/ + +/* +==================== +OGG_OpenLibrary + +Try to load the VorbisFile DLL +==================== +*/ +qbool OGG_OpenLibrary (void) +{ + const char* dllnames_vo [] = + { +#if defined(WIN32) + "libvorbis-0.dll", + "libvorbis.dll", + "vorbis.dll", +#elif defined(MACOSX) + "libvorbis.dylib", +#else + "libvorbis.so.0", + "libvorbis.so", +#endif + NULL + }; + const char* dllnames_vf [] = + { +#if defined(WIN32) + "libvorbisfile-3.dll", + "libvorbisfile.dll", + "vorbisfile.dll", +#elif defined(MACOSX) + "libvorbisfile.dylib", +#else + "libvorbisfile.so.3", + "libvorbisfile.so", +#endif + NULL + }; + + // Already loaded? + if (vf_dll) + return true; + +// COMMANDLINEOPTION: Sound: -novorbis disables ogg vorbis sound support + if (Sys_CheckParm("-novorbis")) + return false; + + // Load the DLLs + // We need to load both by hand because some OSes seem to not load + // the vorbis DLL automatically when loading the VorbisFile DLL + return Sys_LoadDependency (dllnames_vo, &vo_dll, vorbisfuncs) && Sys_LoadDependency (dllnames_vf, &vf_dll, vorbisfilefuncs); +} + + +/* +==================== +OGG_CloseLibrary + +Unload the VorbisFile DLL +==================== +*/ +void OGG_CloseLibrary (void) +{ + Sys_FreeLibrary (&vf_dll); + Sys_FreeLibrary (&vo_dll); +} + +#endif + +/* +================================================================= + + Ogg Vorbis decoding + +================================================================= +*/ + typedef struct { - qbyte *buffer; - ogg_int64_t ind, buffsize; + unsigned char *buffer; + int64_t ind, buffsize; } ov_decode_t; - static size_t ovcb_read (void *ptr, size_t size, size_t nb, void *datasource) { ov_decode_t *ov_decode = (ov_decode_t*)datasource; @@ -240,7 +355,7 @@ static size_t ovcb_read (void *ptr, size_t size, size_t nb, void *datasource) return len / size; } -static int ovcb_seek (void *datasource, ogg_int64_t offset, int whence) +static int ovcb_seek (void *datasource, int64_t offset, int whence) { ov_decode_t *ov_decode = (ov_decode_t*)datasource; @@ -274,177 +389,325 @@ static long ovcb_tell (void *ov_decode) return ((ov_decode_t*)ov_decode)->ind; } +// Per-sfx data structure +typedef struct +{ + unsigned char *file; + size_t filesize; +} ogg_stream_persfx_t; -/* -================================================================= +// Per-channel data structure +typedef struct +{ + OggVorbis_File vf; + ov_decode_t ov_decode; + int bs; + int buffer_firstframe; + int buffer_numframes; + unsigned char buffer[STREAM_BUFFERSIZE*4]; +} ogg_stream_perchannel_t; - DLL load & unload -================================================================= -*/ +static const ov_callbacks callbacks = {ovcb_read, ovcb_seek, ovcb_close, ovcb_tell}; /* ==================== -OGG_OpenLibrary - -Try to load the VorbisFile DLL +OGG_GetSamplesFloat ==================== */ -qboolean OGG_OpenLibrary (void) +static void OGG_GetSamplesFloat (channel_t *ch, sfx_t *sfx, int firstsampleframe, int numsampleframes, float *outsamplesfloat) { - const char* dllname; - const dllfunction_t *func; - - // Already loaded? - if (vf_dll) - return true; - -#ifdef WIN32 - dllname = "vorbisfile.dll"; -#else - dllname = "libvorbisfile.so"; -#endif - - // Initializations - for (func = oggvorbisfuncs; func && func->name != NULL; func++) - *func->funcvariable = NULL; + ogg_stream_perchannel_t *per_ch = (ogg_stream_perchannel_t *)ch->fetcher_data; + ogg_stream_persfx_t *per_sfx = (ogg_stream_persfx_t *)sfx->fetcher_data; + int f = sfx->format.width * sfx->format.channels; // bytes per frame in the buffer + short *buf; + int i, len; + int newlength, done, ret; + + // if this channel does not yet have a channel fetcher, make one + if (per_ch == NULL) + { + // allocate a struct to keep track of our file position and buffer + per_ch = (ogg_stream_perchannel_t *)Mem_Alloc(snd_mempool, sizeof(*per_ch)); + // begin decoding the file + per_ch->ov_decode.buffer = per_sfx->file; + per_ch->ov_decode.ind = 0; + per_ch->ov_decode.buffsize = per_sfx->filesize; + if (qov_open_callbacks(&per_ch->ov_decode, &per_ch->vf, NULL, 0, callbacks) < 0) + { + // this never happens - this function succeeded earlier on the same data + Mem_Free(per_ch); + return; + } + per_ch->bs = 0; + per_ch->buffer_firstframe = 0; + per_ch->buffer_numframes = 0; + // attach the struct to our channel + ch->fetcher_data = (void *)per_ch; + } - // Load the DLL - if (! (vf_dll = Sys_LoadLibrary (dllname))) + // if the request is too large for our buffer, loop... + while (numsampleframes * f > (int)sizeof(per_ch->buffer)) { - Con_DPrintf("Can't find %s. Ogg Vorbis support disabled\n", dllname); - return false; + done = sizeof(per_ch->buffer) / f; + OGG_GetSamplesFloat(ch, sfx, firstsampleframe, done, outsamplesfloat); + firstsampleframe += done; + numsampleframes -= done; + outsamplesfloat += done * sfx->format.channels; } - // Get the function adresses - for (func = oggvorbisfuncs; func && func->name != NULL; func++) - if (!(*func->funcvariable = (void *) Sys_GetProcAddress (vf_dll, func->name))) + // seek if the request is before the current buffer (loop back) + // seek if the request starts beyond the current buffer by at least one frame (channel was zero volume for a while) + // do not seek if the request overlaps the buffer end at all (expected behavior) + if (per_ch->buffer_firstframe > firstsampleframe || per_ch->buffer_firstframe + per_ch->buffer_numframes < firstsampleframe) + { + // we expect to decode forward from here so this will be our new buffer start + per_ch->buffer_firstframe = firstsampleframe; + per_ch->buffer_numframes = 0; + ret = qov_pcm_seek(&per_ch->vf, (int64_t)firstsampleframe); + if (ret != 0) { - Con_Printf("missing function \"%s\" - broken Ogg Vorbis library!\n", func->name); - OGG_CloseLibrary (); - return false; + // LadyHavoc: we can't Con_Printf here, not thread safe... + //Con_Printf("OGG_FetchSound: qov_pcm_seek(..., %d) returned %d\n", firstsampleframe, ret); + return; } + } - Con_DPrintf("%s loaded. Ogg Vorbis support enabled\n", dllname); - return true; + // decompress the file as needed + if (firstsampleframe + numsampleframes > per_ch->buffer_firstframe + per_ch->buffer_numframes) + { + // first slide the buffer back, discarding any data preceding the range we care about + int offset = firstsampleframe - per_ch->buffer_firstframe; + int keeplength = per_ch->buffer_numframes - offset; + if (keeplength > 0) + memmove(per_ch->buffer, per_ch->buffer + offset * sfx->format.width * sfx->format.channels, keeplength * sfx->format.width * sfx->format.channels); + per_ch->buffer_firstframe = firstsampleframe; + per_ch->buffer_numframes -= offset; + // decompress as much as we can fit in the buffer + newlength = sizeof(per_ch->buffer) - per_ch->buffer_numframes * f; + done = 0; + while (newlength > done && (ret = qov_read(&per_ch->vf, (char *)per_ch->buffer + per_ch->buffer_numframes * f + done, (int)(newlength - done), mem_bigendian, 2, 1, &per_ch->bs)) > 0) + done += ret; + // clear the missing space if any + if (done < newlength) + memset(per_ch->buffer + done, 0, newlength - done); + // we now have more data in the buffer + per_ch->buffer_numframes += done / f; + } + + // convert the sample format for the caller + buf = (short *)((char *)per_ch->buffer + (firstsampleframe - per_ch->buffer_firstframe) * f); + len = numsampleframes * sfx->format.channels; + for (i = 0;i < len;i++) + outsamplesfloat[i] = buf[i] * (1.0f / 32768.0f); } /* ==================== -OGG_CloseLibrary - -Unload the VorbisFile DLL +OGG_StopChannel ==================== */ -void OGG_CloseLibrary (void) +static void OGG_StopChannel(channel_t *ch) { - if (!vf_dll) - return; - - Sys_UnloadLibrary (vf_dll); - vf_dll = NULL; + ogg_stream_perchannel_t *per_ch = (ogg_stream_perchannel_t *)ch->fetcher_data; + if (per_ch != NULL) + { + // release the vorbis decompressor + qov_clear(&per_ch->vf); + Mem_Free(per_ch); + } } /* -================================================================= +==================== +OGG_FreeSfx +==================== +*/ +static void OGG_FreeSfx(sfx_t *sfx) +{ + ogg_stream_persfx_t *per_sfx = (ogg_stream_persfx_t *)sfx->fetcher_data; + // free the complete file we were keeping around + Mem_Free(per_sfx->file); + // free the file information structure + Mem_Free(per_sfx); +} - Ogg Vorbis decoding -================================================================= -*/ +static const snd_fetcher_t ogg_fetcher = {OGG_GetSamplesFloat, OGG_StopChannel, OGG_FreeSfx}; + +static void OGG_DecodeTags(vorbis_comment *vc, unsigned int *start, unsigned int *length, unsigned int numsamples, double *peak, double *gaindb) +{ + const char *startcomment = NULL, *lengthcomment = NULL, *endcomment = NULL, *thiscomment = NULL; + + *start = numsamples; + *length = numsamples; + *peak = 0.0; + *gaindb = 0.0; + + if(!vc) + return; + + thiscomment = qvorbis_comment_query(vc, "REPLAYGAIN_TRACK_PEAK", 0); + if(thiscomment) + *peak = atof(thiscomment); + thiscomment = qvorbis_comment_query(vc, "REPLAYGAIN_TRACK_GAIN", 0); + if(thiscomment) + *gaindb = atof(thiscomment); + + startcomment = qvorbis_comment_query(vc, "LOOP_START", 0); // DarkPlaces, and some Japanese app + if(startcomment) + { + endcomment = qvorbis_comment_query(vc, "LOOP_END", 0); + if(!endcomment) + lengthcomment = qvorbis_comment_query(vc, "LOOP_LENGTH", 0); + } + else + { + startcomment = qvorbis_comment_query(vc, "LOOPSTART", 0); // RPG Maker VX + if(startcomment) + { + lengthcomment = qvorbis_comment_query(vc, "LOOPLENGTH", 0); + if(!lengthcomment) + endcomment = qvorbis_comment_query(vc, "LOOPEND", 0); + } + else + { + startcomment = qvorbis_comment_query(vc, "LOOPPOINT", 0); // Sonic Robo Blast 2 + } + } + + if(startcomment) + { + *start = (unsigned int) bound(0, atof(startcomment), numsamples); + if(endcomment) + *length = (unsigned int) bound(0, atof(endcomment), numsamples); + else if(lengthcomment) + *length = (unsigned int) bound(0, *start + atof(lengthcomment), numsamples); + } +} /* ==================== OGG_LoadVorbisFile -Load an Ogg Vorbis file into a sfxcache_t +Load an Ogg Vorbis file into memory ==================== */ -sfxcache_t *OGG_LoadVorbisFile (const char *filename, sfx_t *s) +qbool OGG_LoadVorbisFile(const char *filename, sfx_t *sfx) { - qbyte *data; + unsigned char *data; + fs_offset_t filesize; ov_decode_t ov_decode; OggVorbis_File vf; - ov_callbacks callbacks = {ovcb_read, ovcb_seek, ovcb_close, ovcb_tell}; vorbis_info *vi; - ogg_int64_t len; - char *buff; - ogg_int64_t done; - int bs, bigendian; - long ret; - sfxcache_t *sc; + vorbis_comment *vc; + double peak, gaindb; +#ifndef LINK_TO_LIBVORBIS if (!vf_dll) - return NULL; + return false; +#endif - // Load the file - data = FS_LoadFile (filename, false); + // Return if already loaded + if (sfx->fetcher != NULL) + return true; + + // Load the file completely + data = FS_LoadFile(filename, snd_mempool, false, &filesize); if (data == NULL) - return NULL; + return false; + + if (developer_loading.integer >= 2) + Con_Printf("Loading Ogg Vorbis file \"%s\"\n", filename); // Open it with the VorbisFile API ov_decode.buffer = data; ov_decode.ind = 0; - ov_decode.buffsize = fs_filesize; - if (qov_open_callbacks (&ov_decode, &vf, NULL, 0, callbacks) < 0) + ov_decode.buffsize = filesize; + if (qov_open_callbacks(&ov_decode, &vf, NULL, 0, callbacks) < 0) { Con_Printf("error while opening Ogg Vorbis file \"%s\"\n", filename); - Mem_Free (data); - return NULL; + Mem_Free(data); + return false; } // Get the stream information - vi = qov_info (&vf, -1); + vi = qov_info(&vf, -1); if (vi->channels < 1 || vi->channels > 2) { Con_Printf("%s has an unsupported number of channels (%i)\n", - s->name, vi->channels); + sfx->name, vi->channels); qov_clear (&vf); - Mem_Free (data); - return NULL; + Mem_Free(data); + return false; } - // Decode it - len = qov_pcm_total (&vf, -1) * vi->channels * 2; // 16 bits => "* 2" - buff = Mem_Alloc (tempmempool, (int)len); - done = 0; - bs = 0; -#if BYTE_ORDER == LITTLE_ENDIAN - bigendian = 0; -#else - bigendian = 1; -#endif - while ((ret = qov_read (&vf, &buff[done], (int)(len - done), bigendian, 2, 1, &bs)) > 0) - done += ret; + sfx->format.speed = vi->rate; + sfx->format.channels = vi->channels; + sfx->format.width = 2; // We always work with 16 bits samples - // Calculate resampled length - len = (double)done * (double)shm->speed / (double)vi->rate; + sfx->total_length = qov_pcm_total(&vf, -1); - // Resample it - Mem_FreePool (&s->mempool); - s->mempool = Mem_AllocPool (s->name); - sc = s->sfxcache = Mem_Alloc (s->mempool, (int)len + sizeof (sfxcache_t)); - if (sc != NULL) + if (snd_streaming.integer && (snd_streaming.integer >= 2 || sfx->total_length > max(sizeof(ogg_stream_perchannel_t), snd_streaming_length.value * sfx->format.speed))) { - sc->length = (int)done / (vi->channels * 2); - sc->loopstart = -1; - sc->speed = vi->rate; - sc->width = 2; // We always work with 16 bits samples - sc->stereo = (vi->channels == 2); - - ResampleSfx (sc, buff, s->name); + // large sounds use the OGG fetcher to decode the file on demand (but the entire file is held in memory) + ogg_stream_persfx_t* per_sfx; + if (developer_loading.integer >= 2) + Con_Printf("Ogg sound file \"%s\" will be streamed\n", filename); + per_sfx = (ogg_stream_persfx_t *)Mem_Alloc(snd_mempool, sizeof(*per_sfx)); + sfx->memsize += sizeof (*per_sfx); + per_sfx->file = data; + per_sfx->filesize = filesize; + sfx->memsize += filesize; + sfx->fetcher_data = per_sfx; + sfx->fetcher = &ogg_fetcher; + sfx->flags |= SFXFLAG_STREAMED; + vc = qov_comment(&vf, -1); + OGG_DecodeTags(vc, &sfx->loopstart, &sfx->total_length, sfx->total_length, &peak, &gaindb); + qov_clear(&vf); } else { - Con_Printf("failed to allocate memory for sound \"%s\"\n", s->name); - Mem_FreePool (&s->mempool); + // small sounds are entirely loaded and use the PCM fetcher + char *buff; + int64_t len; + int64_t done; + int bs; + long ret; + if (developer_loading.integer >= 2) + Con_Printf ("Ogg sound file \"%s\" will be cached\n", filename); + len = sfx->total_length * sfx->format.channels * sfx->format.width; + sfx->flags &= ~SFXFLAG_STREAMED; + sfx->memsize += len; + sfx->fetcher = &wav_fetcher; + sfx->fetcher_data = Mem_Alloc(snd_mempool, (size_t)len); + buff = (char *)sfx->fetcher_data; + done = 0; + bs = 0; + while ((ret = qov_read(&vf, &buff[done], (int)(len - done), mem_bigendian, 2, 1, &bs)) > 0) + done += ret; + vc = qov_comment(&vf, -1); + OGG_DecodeTags(vc, &sfx->loopstart, &sfx->total_length, sfx->total_length, &peak, &gaindb); + qov_clear(&vf); + Mem_Free(data); } - qov_clear (&vf); - Mem_Free (buff); - Mem_Free (data); + if(peak) + { + sfx->volume_mult = min(1.0f / peak, exp(gaindb * 0.05f * log(10.0f))); + sfx->volume_peak = peak; + if (developer_loading.integer >= 2) + Con_Printf ("Ogg sound file \"%s\" uses ReplayGain (gain %f, peak %f)\n", filename, sfx->volume_mult, sfx->volume_peak); + } + else if(gaindb != 0) + { + sfx->volume_mult = min(1.0f / peak, exp(gaindb * 0.05f * log(10.0f))); + sfx->volume_peak = 1.0; // if peak is not defined, we won't trust it + if (developer_loading.integer >= 2) + Con_Printf ("Ogg sound file \"%s\" uses ReplayGain (gain %f, peak not defined and assumed to be %f)\n", filename, sfx->volume_mult, sfx->volume_peak); + } - return sc; + return true; }