Added framework for Sound_Seek() support.

icculus · Apr 21, 2002 · 2a666d8 · 2a666d8
1 parent 01b7350
commit 2a666d8
Show file tree

Hide file tree

Showing 17 changed files with 205 additions and 24 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -3,7 +3,9 @@
  */
 
 04212002 - Initial work to add a Sound_Seek() API. Removed the NEEDSEEK
-           sample flag (replaced it with CANSEEK).
+           sample flag (replaced it with CANSEEK). Hack to change the internal
+           Sound_SetError() function to __Sound_SetError(). Added internal
+           function __Sound_convertMsToBytePos().
 04082002 - Cleaned up the archive support in playsound a little bit, and 
            fixed a PhysicsFS bug in the process.
 03252002 - Win32 patches and fixes from Tyler Montbriand: handled "inline"

diff --git a/SDL_sound.c b/SDL_sound.c
@@ -346,7 +346,7 @@ void Sound_ClearError(void)
 /*
  * This is declared in the internal header.
  */
-void Sound_SetError(const char *str)
+void __Sound_SetError(const char *str)
 {
     ErrMsg *err;
 
@@ -378,7 +378,17 @@ void Sound_SetError(const char *str)
     err->error_available = 1;
     strncpy(err->error_string, str, sizeof (err->error_string));
     err->error_string[sizeof (err->error_string) - 1] = '\0';
-} /* Sound_SetError */
+} /* __Sound_SetError */
+
+
+Uint32 __Sound_convertMsToBytePos(Sound_AudioInfo *info, Uint32 ms)
+{
+    /* "frames" == "sample frames" */
+    float frames_per_ms = ((float) info->rate) / 1000.0;
+    Uint32 frame_offset = (Uint32) (frames_per_ms * ((float) ms));
+    Uint32 frame_size = (Uint32) ((info->format & 0xFF) / 8) * info->channels;
+    return(frame_offset * frame_size);
+} /* __Sound_convertMsToBytePos */
 
 
 /*
@@ -846,6 +856,26 @@ int Sound_Rewind(Sound_Sample *sample)
     sample->flags &= !SOUND_SAMPLEFLAG_EAGAIN;
     sample->flags &= !SOUND_SAMPLEFLAG_ERROR;
     sample->flags &= !SOUND_SAMPLEFLAG_EOF;
+
+    return(1);
+} /* Sound_Rewind */
+
+
+int Sound_Seek(Sound_Sample *sample, Uint32 ms)
+{
+    Sound_SampleInternal *internal;
+
+    BAIL_IF_MACRO(!initialized, ERR_NOT_INITIALIZED, 0);
+    if (!(sample->flags & SOUND_SAMPLEFLAG_CANSEEK))
+        BAIL_MACRO(ERR_CANNOT_SEEK, 0);
+
+    internal = (Sound_SampleInternal *) sample->opaque;
+    BAIL_IF_MACRO(!internal->funcs->seek(sample, ms), NULL, 0);
+
+    sample->flags &= !SOUND_SAMPLEFLAG_EAGAIN;
+    sample->flags &= !SOUND_SAMPLEFLAG_ERROR;
+    sample->flags &= !SOUND_SAMPLEFLAG_EOF;
+
     return(1);
 } /* Sound_Rewind */
 

diff --git a/SDL_sound_internal.h b/SDL_sound_internal.h
@@ -177,6 +177,22 @@ typedef struct __SOUND_DECODERFUNCTIONS__
          *  this method should ever fail!
          */
     int (*rewind)(Sound_Sample *sample);
+
+        /*
+         * Reposition the decoding to an arbitrary point. Nonzero on
+         *  success, zero on failure.
+         *  
+         * The purpose of this method is to allow for higher efficiency than
+         *  an application could get by just rewinding the sample and 
+         *  decoding to a given point.
+         *
+         * The decoder is responsible for calling seek() on the associated
+         *  SDL_RWops.
+         *
+         * If there is an error, try to recover so that the next read will
+         *  continue as if nothing happened.
+         */
+    int (*seek)(Sound_Sample *sample, Uint32 ms);
 } Sound_DecoderFunctions;
 
 
@@ -225,6 +241,7 @@ typedef struct __SOUND_SAMPLEINTERNAL__
 #define ERR_COMPRESSION          "(De)compression error"
 #define ERR_PREV_ERROR           "Previous decoding already caused an error"
 #define ERR_PREV_EOF             "Previous decoding already triggered EOF"
+#define ERR_CANNOT_SEEK          "Sample is not seekable"
 
 /*
  * Call this to set the message returned by Sound_GetError().
@@ -233,8 +250,16 @@ typedef struct __SOUND_SAMPLEINTERNAL__
  *
  * Calling this with a NULL argument is a safe no-op.
  */
-void Sound_SetError(const char *err);
+void __Sound_SetError(const char *err);
 
+/* !!! FIXME: Clean up elsewhere and get rid of this. */
+#define Sound_SetError __Sound_SetError
+
+/*
+ * Call this to convert milliseconds to an actual byte position, based on
+ *  audio data characteristics.
+ */
+Uint32 __Sound_convertMsToBytePos(Sound_AudioInfo *info, Uint32 ms);
 
 /*
  * Use this if you need a cross-platform stricmp().
@@ -243,8 +268,8 @@ int __Sound_strcasecmp(const char *x, const char *y);
 
 
 /* These get used all over for lessening code clutter. */
-#define BAIL_MACRO(e, r) { Sound_SetError(e); return r; }
-#define BAIL_IF_MACRO(c, e, r) if (c) { Sound_SetError(e); return r; }
+#define BAIL_MACRO(e, r) { __Sound_SetError(e); return r; }
+#define BAIL_IF_MACRO(c, e, r) if (c) { __Sound_SetError(e); return r; }
 
 
 

diff --git a/decoders/aiff.c b/decoders/aiff.c
@@ -66,6 +66,7 @@ static int AIFF_open(Sound_Sample *sample, const char *ext);
 static void AIFF_close(Sound_Sample *sample);
 static Uint32 AIFF_read(Sound_Sample *sample);
 static int AIFF_rewind(Sound_Sample *sample);
+static int AIFF_seek(Sound_Sample *sample, Uint32 ms);
 
 static const char *extensions_aiff[] = { "AIFF", NULL };
 const Sound_DecoderFunctions __Sound_DecoderFunctions_AIFF =
@@ -82,7 +83,8 @@ const Sound_DecoderFunctions __Sound_DecoderFunctions_AIFF =
     AIFF_open,      /*   open() method */
     AIFF_close,     /*  close() method */
     AIFF_read,      /*   read() method */
-    AIFF_rewind     /* rewind() method */
+    AIFF_rewind,    /* rewind() method */
+    AIFF_seek       /*   seek() method */
 };
 
 
@@ -520,7 +522,7 @@ static void AIFF_close(Sound_Sample *sample)
     aiff_t *a = (aiff_t *) internal->decoder_private;
     a->fmt.free(&(a->fmt));
     free(a);
-} /* WAV_close */
+} /* AIFF_close */
 
 
 static Uint32 AIFF_read(Sound_Sample *sample)
@@ -542,6 +544,12 @@ static int AIFF_rewind(Sound_Sample *sample)
     return(fmt->rewind_sample(sample));
 } /* AIFF_rewind */
 
+
+static int AIFF_seek(Sound_Sample *sample, Uint32 ms)
+{
+    BAIL_MACRO("!!! FIXME: Not implemented", 0);
+} /* AIFF_seek */
+
 #endif /* SOUND_SUPPORTS_AIFF */
 
 /* end of aiff.c ... */

diff --git a/decoders/au.c b/decoders/au.c
@@ -49,6 +49,7 @@ static int AU_open(Sound_Sample *sample, const char *ext);
 static void AU_close(Sound_Sample *sample);
 static Uint32 AU_read(Sound_Sample *sample);
 static int AU_rewind(Sound_Sample *sample);
+static int AU_seek(Sound_Sample *sample, Uint32 ms);
 
 /*
  * Sometimes the extension ".snd" is used for these files (mostly on the NeXT),
@@ -70,7 +71,8 @@ const Sound_DecoderFunctions __Sound_DecoderFunctions_AU =
     AU_open,        /*   open() method */
     AU_close,       /*  close() method */
     AU_read,        /*   read() method */
-    AU_rewind       /* rewind() method */
+    AU_rewind,      /* rewind() method */
+    AU_seek         /*   seek() method */
 };
 
 /* no init/deinit needed */
@@ -316,5 +318,11 @@ static int AU_rewind(Sound_Sample *sample)
     return(1);
 } /* AU_rewind */
 
+
+static int AU_seek(Sound_Sample *sample, Uint32 ms)
+{
+    BAIL_MACRO("!!! FIXME: Not implemented", 0);
+} /* AU_seek */
+
 #endif /* SOUND_SUPPORTS_AU */
 
diff --git a/decoders/flac.c b/decoders/flac.c
@@ -60,6 +60,7 @@ static int FLAC_open(Sound_Sample *sample, const char *ext);
 static void FLAC_close(Sound_Sample *sample);
 static Uint32 FLAC_read(Sound_Sample *sample);
 static int FLAC_rewind(Sound_Sample *sample);
+static int FLAC_seek(Sound_Sample *sample, Uint32 ms);
 
 static const char *extensions_flac[] = { "FLAC", "FLA", NULL };
 
@@ -77,7 +78,8 @@ const Sound_DecoderFunctions __Sound_DecoderFunctions_FLAC =
     FLAC_open,       /*   open() method */
     FLAC_close,      /*  close() method */
     FLAC_read,       /*   read() method */
-    FLAC_rewind      /* rewind() method */
+    FLAC_rewind,     /* rewind() method */
+    FLAC_seek        /*   seek() method */
 };
 
     /* This is what we store in our internal->decoder_private field. */
@@ -390,6 +392,13 @@ static int FLAC_rewind(Sound_Sample *sample)
     return(1);
 } /* FLAC_rewind */
 
+
+static int FLAC_seek(Sound_Sample *sample, Uint32 ms)
+{
+    BAIL_MACRO("!!! FIXME: Not implemented", 0);
+} /* FLAC_seek */
+
+
 #endif /* SOUND_SUPPORTS_FLAC */
 
 

diff --git a/decoders/midi.c b/decoders/midi.c
@@ -53,6 +53,7 @@ static int MIDI_open(Sound_Sample *sample, const char *ext);
 static void MIDI_close(Sound_Sample *sample);
 static Uint32 MIDI_read(Sound_Sample *sample);
 static int MIDI_rewind(Sound_Sample *sample);
+static int MIDI_seek(Sound_Sample *sample, Uint32 ms);
 
 static const char *extensions_midi[] = { "MIDI", "MID", NULL };
 const Sound_DecoderFunctions __Sound_DecoderFunctions_MIDI =
@@ -69,7 +70,8 @@ const Sound_DecoderFunctions __Sound_DecoderFunctions_MIDI =
     MIDI_open,       /*   open() method */
     MIDI_close,      /*  close() method */
     MIDI_read,       /*   read() method */
-    MIDI_rewind      /* rewind() method */
+    MIDI_rewind,     /* rewind() method */
+    MIDI_seek        /*   seek() method */
 };
 
 
@@ -157,6 +159,12 @@ static int MIDI_rewind(Sound_Sample *sample)
     return(1);
 } /* MIDI_rewind */
 
+
+static int MIDI_seek(Sound_Sample *sample, Uint32 ms)
+{
+    BAIL_MACRO("!!! FIXME: Not implemented", 0);
+} /* MIDI_seek */
+
 #endif /* SOUND_SUPPORTS_MIDI */
 
 

diff --git a/decoders/mikmod.c b/decoders/mikmod.c
@@ -51,6 +51,7 @@ static int MIKMOD_open(Sound_Sample *sample, const char *ext);
 static void MIKMOD_close(Sound_Sample *sample);
 static Uint32 MIKMOD_read(Sound_Sample *sample);
 static int MIKMOD_rewind(Sound_Sample *sample);
+static int MIKMOD_seek(Sound_Sample *sample, Uint32 ms);
 
 static const char *extensions_mikmod[] =
 {
@@ -89,7 +90,8 @@ const Sound_DecoderFunctions __Sound_DecoderFunctions_MIKMOD =
     MIKMOD_open,       /*   open() method */
     MIKMOD_close,      /*  close() method */
     MIKMOD_read,       /*   read() method */
-    MIKMOD_rewind      /* rewind() method */
+    MIKMOD_rewind,     /* rewind() method */
+    MIKMOD_seek        /*   seek() method */
 };
 
 
@@ -295,6 +297,10 @@ static int MIKMOD_rewind(Sound_Sample *sample)
 } /* MIKMOD_rewind */
 
 
+static int MIKMOD_seek(Sound_Sample *sample, Uint32 ms)
+{
+    BAIL_MACRO("!!! FIXME: Not implemented", 0);
+} /* MIKMOD_seek */
 
 #endif /* SOUND_SUPPORTS_MIKMOD */
 

diff --git a/decoders/modplug.c b/decoders/modplug.c
@@ -50,6 +50,7 @@ static int MODPLUG_open(Sound_Sample *sample, const char *ext);
 static void MODPLUG_close(Sound_Sample *sample);
 static Uint32 MODPLUG_read(Sound_Sample *sample);
 static int MODPLUG_rewind(Sound_Sample *sample);
+static int MODPLUG_seek(Sound_Sample *sample, Uint32 ms);
 
 static const char *extensions_modplug[] =
 {
@@ -97,7 +98,8 @@ const Sound_DecoderFunctions __Sound_DecoderFunctions_MODPLUG =
     MODPLUG_open,       /*   open() method */
     MODPLUG_close,      /*  close() method */
     MODPLUG_read,       /*   read() method */
-    MODPLUG_rewind      /* rewind() method */
+    MODPLUG_rewind,     /* rewind() method */
+    MODPLUG_seek        /*   seek() method */
 };
 
 
@@ -244,6 +246,12 @@ static int MODPLUG_rewind(Sound_Sample *sample)
     return(1);
 } /* MODPLUG_rewind */
 
+
+static int MODPLUG_seek(Sound_Sample *sample, Uint32 ms)
+{
+    BAIL_MACRO("!!! FIXME: Not implemented", 0);
+} /* MODPLUG_seek */
+
 #endif /* SOUND_SUPPORTS_MODPLUG */
 
 

diff --git a/decoders/mpglib.c b/decoders/mpglib.c
@@ -27,8 +27,8 @@
  *  SMPEG, and, again, doesn't need an external library. You should test both
  *  decoders and use what you find works best for you.
  *
- * mpglib is part of mpg123, which can be found in its original form at:
- *   http://www.mpg123.de/
+ * mpglib is an LGPL'd portion of mpg123, which can be found in its original
+ *  form at: http://www.mpg123.de/
  *
  * Please see the file COPYING in the source's root directory. The included
  *  source code for mpglib falls under the LGPL, which is the same license as
@@ -61,6 +61,7 @@ static int MPGLIB_open(Sound_Sample *sample, const char *ext);
 static void MPGLIB_close(Sound_Sample *sample);
 static Uint32 MPGLIB_read(Sound_Sample *sample);
 static int MPGLIB_rewind(Sound_Sample *sample);
+static int MPGLIB_seek(Sound_Sample *sample, Uint32 ms);
 
 static const char *extensions_mpglib[] = { "MP3", NULL };
 const Sound_DecoderFunctions __Sound_DecoderFunctions_MPGLIB =
@@ -77,7 +78,8 @@ const Sound_DecoderFunctions __Sound_DecoderFunctions_MPGLIB =
     MPGLIB_open,       /*   open() method */
     MPGLIB_close,      /*  close() method */
     MPGLIB_read,       /*   read() method */
-    MPGLIB_rewind      /* rewind() method */
+    MPGLIB_rewind,     /* rewind() method */
+    MPGLIB_seek        /*   seek() method */
 };
 
 
@@ -286,6 +288,11 @@ static int MPGLIB_rewind(Sound_Sample *sample)
 } /* MPGLIB_rewind */
 
 
+static int MPGLIB_seek(Sound_Sample *sample, Uint32 ms)
+{
+    BAIL_MACRO("!!! FIXME: Not implemented", 0);
+} /* MPGLIB_seek */
+
 #endif /* SOUND_SUPPORTS_MPGLIB */
 
 

diff --git a/decoders/ogg.c b/decoders/ogg.c
@@ -59,6 +59,7 @@ static int OGG_open(Sound_Sample *sample, const char *ext);
 static void OGG_close(Sound_Sample *sample);
 static Uint32 OGG_read(Sound_Sample *sample);
 static int OGG_rewind(Sound_Sample *sample);
+static int OGG_seek(Sound_Sample *sample, Uint32 ms);
 
 static const char *extensions_ogg[] = { "OGG", NULL };
 const Sound_DecoderFunctions __Sound_DecoderFunctions_OGG =
@@ -75,7 +76,8 @@ const Sound_DecoderFunctions __Sound_DecoderFunctions_OGG =
     OGG_open,       /*   open() method */
     OGG_close,      /*  close() method */
     OGG_read,       /*   read() method */
-    OGG_rewind      /* rewind() method */
+    OGG_rewind,     /* rewind() method */
+    OGG_seek        /*   seek() method */
 };
 
 
@@ -275,6 +277,12 @@ static int OGG_rewind(Sound_Sample *sample)
     return(1);
 } /* OGG_rewind */
 
+
+static int OGG_seek(Sound_Sample *sample, Uint32 ms)
+{
+    BAIL_MACRO("!!! FIXME: Not implemented", 0);
+} /* OGG_seek */
+
 #endif /* SOUND_SUPPORTS_OGG */