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

cyx at users.sourceforge.net cyx at users.sourceforge.net
Sat Dec 8 10:20:18 CET 2007


Revision: 29759
          http://scummvm.svn.sourceforge.net/scummvm/?rev=29759&view=rev
Author:   cyx
Date:     2007-12-08 01:20:18 -0800 (Sat, 08 Dec 2007)

Log Message:
-----------
doc

Modified Paths:
--------------
    scummvm/trunk/sound/mods/rjp1.h
    scummvm/trunk/sound/mods/soundfx.h

Modified: scummvm/trunk/sound/mods/rjp1.h
===================================================================
--- scummvm/trunk/sound/mods/rjp1.h	2007-12-08 09:10:08 UTC (rev 29758)
+++ scummvm/trunk/sound/mods/rjp1.h	2007-12-08 09:20:18 UTC (rev 29759)
@@ -33,8 +33,9 @@
 class AudioStream;
 
 /*
- * FIXME: Document this function. In particular, who is responsible for
- * freeing the data passed in, resp. the AudioStream it returns?
+ * Factory function for RichardJoseph1 modules. Reads all data from the
+ * given songData and instrumentsData streams and creates an AudioStream
+ * from this. No references to these stream objects are kept.
  */
 AudioStream *makeRjp1Stream(Common::SeekableReadStream *songData, Common::SeekableReadStream *instrumentsData, int num, int rate = 44100, bool stereo = true);
 

Modified: scummvm/trunk/sound/mods/soundfx.h
===================================================================
--- scummvm/trunk/sound/mods/soundfx.h	2007-12-08 09:10:08 UTC (rev 29758)
+++ scummvm/trunk/sound/mods/soundfx.h	2007-12-08 09:20:18 UTC (rev 29759)
@@ -33,8 +33,10 @@
 typedef byte *(*LoadSoundFxInstrumentCallback)(const char *name, uint32 *size);
 
 /*
- * FIXME: Document this function. In particular, who is responsible for
- * freeing the data passed in, resp. the AudioStream it returns?
+ * Factory function for SoundFX modules. Reads all data from the
+ * given data stream and creates an AudioStream from this (no references to the
+ * stream object is kept). If loadCb is non 0, then instruments are loaded using
+ * it, buffers returned are free'd at the end of playback.
  */
 AudioStream *makeSoundFxStream(Common::SeekableReadStream *data, LoadSoundFxInstrumentCallback loadCb, int rate = 44100, bool stereo = true);
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




More information about the Scummvm-git-logs mailing list