]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - snd_ogg.c
due to performance issues with streaming ogg decoding of all sounds, the
[xonotic/darkplaces.git] / snd_ogg.c
index 0a6f7fdd8d98b89628841e93358db6f0c38194cd..ad4abadbd779f3eb61b031b8f2b363e6a55a8a28 100644 (file)
--- a/snd_ogg.c
+++ b/snd_ogg.c
@@ -158,6 +158,14 @@ typedef struct
        void                            *internal;
 } vorbis_block;
 
+typedef struct
+{
+       char **user_comments;
+       int   *comment_lengths;
+       int    comments;
+       char  *vendor;
+} vorbis_comment;
+
 typedef struct
 {
        void                            *datasource;
@@ -171,7 +179,7 @@ typedef struct
        long                            *serialnos;
        ogg_int64_t                     *pcmlengths;
        vorbis_info                     *vi;
-       void                            *vc;  // VOIDED POINTER
+       vorbis_comment          *vc;
        ogg_int64_t                     pcm_offset;
        int                                     ready_state;
        long                            current_serialno;
@@ -196,6 +204,8 @@ 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, char *tag, int count);
 static int (*qov_open_callbacks) (void *datasource, OggVorbis_File *vf,
                                                                  char *initial, long ibytes,
                                                                  ov_callbacks callbacks);
@@ -204,14 +214,21 @@ static ogg_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_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}
+};
+
+static dllfunction_t vorbisfuncs[] =
 {
-       {"ov_clear",                    (void **) &qov_clear},
-       {"ov_info",                             (void **) &qov_info},
-       {"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},
+       {"vorbis_comment_query",        (void **) &qvorbis_comment_query},
        {NULL, NULL}
 };
 
@@ -296,9 +313,7 @@ qboolean OGG_OpenLibrary (void)
 {
        const char* dllnames_vo [] =
        {
-#if defined(WIN64)
-               "libvorbis64.dll",
-#elif defined(WIN32)
+#if defined(WIN32)
                "libvorbis.dll",
                "vorbis.dll",
 #elif defined(MACOSX)
@@ -311,9 +326,7 @@ qboolean OGG_OpenLibrary (void)
        };
        const char* dllnames_vf [] =
        {
-#if defined(WIN64)
-               "libvorbisfile64.dll",
-#elif defined(WIN32)
+#if defined(WIN32)
                "libvorbisfile.dll",
                "vorbisfile.dll",
 #elif defined(MACOSX)
@@ -336,16 +349,7 @@ qboolean OGG_OpenLibrary (void)
        // 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
-       if (! Sys_LoadLibrary (dllnames_vo, &vo_dll, NULL) ||
-               ! Sys_LoadLibrary (dllnames_vf, &vf_dll, oggvorbisfuncs))
-       {
-               Sys_UnloadLibrary (&vo_dll);
-               Con_Printf ("Ogg Vorbis support disabled\n");
-               return false;
-       }
-
-       Con_Printf ("Ogg Vorbis support enabled\n");
-       return true;
+       return Sys_LoadLibrary (dllnames_vo, &vo_dll, vorbisfuncs) && Sys_LoadLibrary (dllnames_vf, &vf_dll, vorbisfilefuncs);
 }
 
 
@@ -371,20 +375,14 @@ void OGG_CloseLibrary (void)
 =================================================================
 */
 
-#define STREAM_BUFFER_DURATION 1.5f    // 1.5 sec
-#define STREAM_BUFFER_SIZE(format_ptr) ((int)(ceil (STREAM_BUFFER_DURATION * ((format_ptr)->speed * (format_ptr)->width * (format_ptr)->channels))))
-
-// We work with 1 sec sequences, so this buffer must be able to contain
-// 1 sec of sound of the highest quality (48 KHz, 16 bit samples, stereo)
-static unsigned char resampling_buffer [48000 * 2 * 2];
-
-
 // Per-sfx data structure
 typedef struct
 {
        unsigned char   *file;
        size_t                  filesize;
        snd_format_t    format;
+       unsigned int    total_length;
+       char                    name[128];
 } ogg_stream_persfx_t;
 
 // Per-channel data structure
@@ -405,31 +403,28 @@ static const ov_callbacks callbacks = {ovcb_read, ovcb_seek, ovcb_close, ovcb_te
 OGG_FetchSound
 ====================
 */
-static const snd_buffer_t* OGG_FetchSound (channel_t* ch, unsigned int* start, unsigned int nbsampleframes)
+static const snd_buffer_t* OGG_FetchSound (void *sfxfetcher, void **chfetcherpointer, unsigned int *start, unsigned int nbsampleframes)
 {
-       ogg_stream_perchannel_t* per_ch;
-       sfx_t* sfx;
-       ogg_stream_persfx_t* per_sfx;
-       snd_format_t* ogg_format;
+       ogg_stream_perchannel_t* per_ch = (ogg_stream_perchannel_t *)*chfetcherpointer;
+       ogg_stream_persfx_t* per_sfx = (ogg_stream_persfx_t *)sfxfetcher;
        snd_buffer_t* sb;
-       int newlength, done, ret, bigendian;
+       int newlength, done, ret;
        unsigned int real_start;
        unsigned int factor;
 
-       per_ch = (ogg_stream_perchannel_t *)ch->fetcher_data;
-       sfx = ch->sfx;
-       per_sfx = (ogg_stream_persfx_t *)sfx->fetcher_data;
-       ogg_format = &per_sfx->format;
-
        // If there's no fetcher structure attached to the channel yet
        if (per_ch == NULL)
        {
                size_t buff_len, memsize;
+               snd_format_t sb_format;
+
+               sb_format.speed = snd_renderbuffer->format.speed;
+               sb_format.width = per_sfx->format.width;
+               sb_format.channels = per_sfx->format.channels;
 
-               buff_len = STREAM_BUFFER_SIZE(ogg_format);
+               buff_len = STREAM_BUFFER_SIZE(&sb_format);
                memsize = sizeof (*per_ch) - sizeof (per_ch->sb.samples) + buff_len;
                per_ch = (ogg_stream_perchannel_t *)Mem_Alloc (snd_mempool, memsize);
-               sfx->memsize += memsize;
 
                // Open it with the VorbisFile API
                per_ch->ov_decode.buffer = per_sfx->file;
@@ -437,22 +432,20 @@ static const snd_buffer_t* OGG_FetchSound (channel_t* ch, unsigned int* start, u
                per_ch->ov_decode.buffsize = per_sfx->filesize;
                if (qov_open_callbacks (&per_ch->ov_decode, &per_ch->vf, NULL, 0, callbacks) < 0)
                {
-                       Con_Printf("error while reading Ogg Vorbis stream \"%s\"\n", sfx->name);
+                       Con_Printf("error while reading Ogg Vorbis stream \"%s\"\n", per_sfx->name);
                        Mem_Free (per_ch);
                        return NULL;
                }
                per_ch->bs = 0;
 
                per_ch->sb_offset = 0;
-               per_ch->sb.format.speed = snd_renderbuffer->format.speed;
-               per_ch->sb.format.width = ogg_format->width;
-               per_ch->sb.format.channels = ogg_format->channels;
+               per_ch->sb.format = sb_format;
                per_ch->sb.nbframes = 0;
                per_ch->sb.maxframes = buff_len / (per_ch->sb.format.channels * per_ch->sb.format.width);
 
-               ch->fetcher_data = per_ch;
+               *chfetcherpointer = per_ch;
        }
-       
+
        real_start = *start;
 
        sb = &per_ch->sb;
@@ -480,11 +473,11 @@ static const snd_buffer_t* OGG_FetchSound (channel_t* ch, unsigned int* start, u
                unsigned int time_start;
                ogg_int64_t ogg_start;
                int err;
-               
-               if (real_start > sfx->total_length)
+
+               if (real_start > (unsigned int)per_sfx->total_length)
                {
                        Con_Printf ("OGG_FetchSound: asked for a start position after the end of the sfx! (%u > %u)\n",
-                                               real_start, sfx->total_length);
+                                               real_start, per_sfx->total_length);
                        return NULL;
                }
 
@@ -500,7 +493,7 @@ static const snd_buffer_t* OGG_FetchSound (channel_t* ch, unsigned int* start, u
                }
                sb->nbframes = 0;
 
-               real_start = (float)ogg_start / per_sfx->format.speed * snd_renderbuffer->format.speed;
+               real_start = (unsigned int) ((float)ogg_start / per_sfx->format.speed * snd_renderbuffer->format.speed);
                if (*start - real_start + nbsampleframes > sb->maxframes)
                {
                        Con_Printf ("OGG_FetchSound: stream buffer too small after seek (%u sample frames required)\n",
@@ -518,25 +511,23 @@ static const snd_buffer_t* OGG_FetchSound (channel_t* ch, unsigned int* start, u
 
        per_ch->sb_offset = real_start;
 
-       // We add exactly 1 sec of sound to the buffer:
-       // 1- to ensure we won't lose any sample during the resampling process
-       // 2- to force one call to OGG_FetchSound per second to regulate the workload
-       if (sb->format.speed + sb->nbframes > sb->maxframes)
+       // We add more than one frame of sound to the buffer:
+       // 1- to ensure we won't lose many samples during the resampling process
+       // 2- to reduce calls to OGG_FetchSound to regulate workload
+       newlength = (int)(per_sfx->format.speed*STREAM_BUFFER_FILL);
+       if (newlength + sb->nbframes > sb->maxframes)
        {
                Con_Printf ("OGG_FetchSound: stream buffer overflow (%u sample frames / %u)\n",
                                        sb->format.speed + sb->nbframes, sb->maxframes);
                return NULL;
        }
-       newlength = per_sfx->format.speed * factor;  // -> 1 sec of sound before resampling
+       newlength *= factor; // convert from sample frames to bytes
+       if(newlength > (int)sizeof(resampling_buffer))
+               newlength = sizeof(resampling_buffer);
 
        // Decompress in the resampling_buffer
-#if BYTE_ORDER == BIG_ENDIAN
-       bigendian = 1;
-#else
-       bigendian = 0;
-#endif
        done = 0;
-       while ((ret = qov_read (&per_ch->vf, (char *)&resampling_buffer[done], (int)(newlength - done), bigendian, 2, 1, &per_ch->bs)) > 0)
+       while ((ret = qov_read (&per_ch->vf, (char *)&resampling_buffer[done], (int)(newlength - done), mem_bigendian, 2, 1, &per_ch->bs)) > 0)
                done += ret;
 
        Snd_AppendToSndBuffer (sb, resampling_buffer, (size_t)done / (size_t)factor, &per_sfx->format);
@@ -551,23 +542,16 @@ static const snd_buffer_t* OGG_FetchSound (channel_t* ch, unsigned int* start, u
 OGG_FetchEnd
 ====================
 */
-static void OGG_FetchEnd (channel_t* ch)
+static void OGG_FetchEnd (void *chfetcherdata)
 {
-       ogg_stream_perchannel_t* per_ch;
+       ogg_stream_perchannel_t* per_ch = (ogg_stream_perchannel_t *)chfetcherdata;
 
-       per_ch = (ogg_stream_perchannel_t *)ch->fetcher_data;
        if (per_ch != NULL)
        {
-               size_t buff_len;
-
                // Free the ogg vorbis decoder
                qov_clear (&per_ch->vf);
 
-               buff_len = per_ch->sb.maxframes * per_ch->sb.format.channels * per_ch->sb.format.width;
-               ch->sfx->memsize -= sizeof (*per_ch) - sizeof (per_ch->sb.samples) + buff_len;
-
                Mem_Free (per_ch);
-               ch->fetcher_data = NULL;
        }
 }
 
@@ -577,20 +561,15 @@ static void OGG_FetchEnd (channel_t* ch)
 OGG_FreeSfx
 ====================
 */
-static void OGG_FreeSfx (sfx_t* sfx)
+static void OGG_FreeSfx (void *sfxfetcherdata)
 {
-       ogg_stream_persfx_t* per_sfx = (ogg_stream_persfx_t *)sfx->fetcher_data;
+       ogg_stream_persfx_t* per_sfx = (ogg_stream_persfx_t *)sfxfetcherdata;
 
        // Free the Ogg Vorbis file
        Mem_Free(per_sfx->file);
-       sfx->memsize -= per_sfx->filesize;
 
        // Free the stream structure
        Mem_Free(per_sfx);
-       sfx->memsize -= sizeof (*per_sfx);
-
-       sfx->fetcher_data = NULL;
-       sfx->fetcher = NULL;
 }
 
 
@@ -607,6 +586,56 @@ static const snd_format_t* OGG_GetFormat (sfx_t* sfx)
 
 static const snd_fetcher_t ogg_fetcher = { OGG_FetchSound, OGG_FetchEnd, OGG_FreeSfx, OGG_GetFormat };
 
+static void OGG_DecodeTags(vorbis_comment *vc, unsigned int *start, unsigned int *length, double samplesfactor, 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) * samplesfactor, numsamples);
+               if(endcomment)
+                       *length = (unsigned int) bound(0, atof(endcomment) * samplesfactor, numsamples);
+               else if(lengthcomment)
+                       *length = (unsigned int) bound(0, *start + atof(lengthcomment) * samplesfactor, numsamples);
+       }
+}
 
 /*
 ====================
@@ -622,7 +651,9 @@ qboolean OGG_LoadVorbisFile (const char *filename, sfx_t *sfx)
        ov_decode_t ov_decode;
        OggVorbis_File vf;
        vorbis_info *vi;
+       vorbis_comment *vc;
        ogg_int64_t len, buff_len;
+       double peak, gaindb;
 
        if (!vf_dll)
                return false;
@@ -636,7 +667,8 @@ qboolean OGG_LoadVorbisFile (const char *filename, sfx_t *sfx)
        if (data == NULL)
                return false;
 
-       Con_DPrintf ("Loading Ogg Vorbis file \"%s\"\n", filename);
+       if (developer_loading.integer >= 2)
+               Con_Printf ("Loading Ogg Vorbis file \"%s\"\n", filename);
 
        // Open it with the VorbisFile API
        ov_decode.buffer = data;
@@ -663,13 +695,15 @@ qboolean OGG_LoadVorbisFile (const char *filename, sfx_t *sfx)
        len = qov_pcm_total (&vf, -1) * vi->channels * 2;  // 16 bits => "* 2"
 
        // Decide if we go for a stream or a simple PCM cache
-       buff_len = (int)ceil (STREAM_BUFFER_DURATION * (snd_renderbuffer->format.speed * 2 * vi->channels));
-       if (snd_streaming.integer && len > (ogg_int64_t)filesize + 3 * buff_len)
+       buff_len = (int)ceil (STREAM_BUFFER_DURATION * snd_renderbuffer->format.speed) * 2 * vi->channels;
+       if (snd_streaming.integer && (len > (ogg_int64_t)filesize + 3 * buff_len || snd_streaming.integer >= 2))
        {
                ogg_stream_persfx_t* per_sfx;
 
-               Con_DPrintf ("\"%s\" will be streamed\n", filename);
+               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));
+               strlcpy(per_sfx->name, sfx->name, sizeof(per_sfx->name));
                sfx->memsize += sizeof (*per_sfx);
                per_sfx->file = data;
                per_sfx->filesize = filesize;
@@ -681,31 +715,30 @@ qboolean OGG_LoadVorbisFile (const char *filename, sfx_t *sfx)
 
                sfx->fetcher_data = per_sfx;
                sfx->fetcher = &ogg_fetcher;
-               sfx->loopstart = -1;
                sfx->flags |= SFXFLAG_STREAMED;
                sfx->total_length = (int)((size_t)len / (per_sfx->format.channels * 2) * ((double)snd_renderbuffer->format.speed / per_sfx->format.speed));
+               vc = qov_comment(&vf, -1);
+               OGG_DecodeTags(vc, &sfx->loopstart, &sfx->total_length, (double)snd_renderbuffer->format.speed / (double)per_sfx->format.speed, sfx->total_length, &peak, &gaindb);
+               per_sfx->total_length = sfx->total_length;
+               qov_clear (&vf);
        }
        else
        {
                char *buff;
                ogg_int64_t done;
-               int bs, bigendian;
+               int bs;
                long ret;
                snd_buffer_t *sb;
                snd_format_t ogg_format;
 
-               Con_DPrintf ("\"%s\" will be cached\n", filename);
+               if (developer_loading.integer >= 2)
+                       Con_Printf ("Ogg sound file \"%s\" will be cached\n", filename);
 
                // Decode it
                buff = (char *)Mem_Alloc (snd_mempool, (int)len);
                done = 0;
                bs = 0;
-#if BYTE_ORDER == BIG_ENDIAN
-               bigendian = 1;
-#else
-               bigendian = 0;
-#endif
-               while ((ret = qov_read (&vf, &buff[done], (int)(len - done), bigendian, 2, 1, &bs)) > 0)
+               while ((ret = qov_read (&vf, &buff[done], (int)(len - done), mem_bigendian, 2, 1, &bs)) > 0)
                        done += ret;
 
                // Build the sound buffer
@@ -727,13 +760,22 @@ qboolean OGG_LoadVorbisFile (const char *filename, sfx_t *sfx)
                sfx->total_length = sb->nbframes;
                sfx->memsize += sb->maxframes * sb->format.channels * sb->format.width + sizeof (*sb) - sizeof (sb->samples);
 
-               sfx->loopstart = -1;
                sfx->flags &= ~SFXFLAG_STREAMED;
-
+               vc = qov_comment(&vf, -1);
+               OGG_DecodeTags(vc, &sfx->loopstart, &sfx->total_length, (double)snd_renderbuffer->format.speed / (double)sb->format.speed, sfx->total_length, &peak, &gaindb);
+               sb->nbframes = sfx->total_length;
                qov_clear (&vf);
                Mem_Free (data);
                Mem_Free (buff);
        }
 
+       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);
+       }
+
        return true;
 }