[Scummvm-cvs-logs] SF.net SVN: scummvm: [21040] scummvm/trunk/sound

fingolfin at users.sourceforge.net fingolfin at users.sourceforge.net
Fri Mar 3 07:37:01 CET 2006


Revision: 21040
Author:   fingolfin
Date:     2006-03-03 07:36:12 -0800 (Fri, 03 Mar 2006)
ViewCVS:  http://svn.sourceforge.net/scummvm?rev=21040&view=rev

Log Message:
-----------
Explain the (admittedly strange) usage of some of our makeXXXStream factory functions

Modified Paths:
--------------
    scummvm/trunk/sound/flac.h
    scummvm/trunk/sound/mp3.h
    scummvm/trunk/sound/vorbis.h
Modified: scummvm/trunk/sound/flac.h
===================================================================
--- scummvm/trunk/sound/flac.h	2006-03-03 15:27:33 UTC (rev 21039)
+++ scummvm/trunk/sound/flac.h	2006-03-03 15:36:12 UTC (rev 21040)
@@ -36,6 +36,12 @@
 
 DigitalTrackInfo *getFlacTrack(int track);
 
+/**
+ * Create a new AudioStream from the FLAC data in the given
+ * file. If you only want to play part of that file, then seek
+ * to the start position in file before passing it to this
+ * factory function, and specify the appropriate size.
+ */
 AudioStream *makeFlacStream(Common::File *file, uint32 size);
 
 #endif // #ifdef USE_FLAC

Modified: scummvm/trunk/sound/mp3.h
===================================================================
--- scummvm/trunk/sound/mp3.h	2006-03-03 15:27:33 UTC (rev 21039)
+++ scummvm/trunk/sound/mp3.h	2006-03-03 15:36:12 UTC (rev 21040)
@@ -36,6 +36,12 @@
 
 DigitalTrackInfo *getMP3Track(int track);
 
+/**
+ * Create a new AudioStream from the MP3 data in the given
+ * file. If you only want to play part of that file, then seek
+ * to the start position in file before passing it to this
+ * factory function, and specify the appropriate size.
+ */
 AudioStream *makeMP3Stream(Common::File *file, uint32 size);
 
 #endif

Modified: scummvm/trunk/sound/vorbis.h
===================================================================
--- scummvm/trunk/sound/vorbis.h	2006-03-03 15:27:33 UTC (rev 21039)
+++ scummvm/trunk/sound/vorbis.h	2006-03-03 15:36:12 UTC (rev 21040)
@@ -36,6 +36,12 @@
 
 DigitalTrackInfo *getVorbisTrack(int track);
 
+/**
+ * Create a new AudioStream from the Vorbis data in the given
+ * file. If you only want to play part of that file, then seek
+ * to the start position in file before passing it to this
+ * factory function, and specify the appropriate size.
+ */
 AudioStream *makeVorbisStream(Common::File *file, uint32 size);
 
 #endif







More information about the Scummvm-git-logs mailing list