[Scummvm-cvs-logs] CVS: scummvm/sound audiostream.h,1.48,1.49

[Max Horn]

Update of /cvsroot/scummvm/scummvm/sound
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv23773

Modified Files:
	audiostream.h 
Log Message:
Clarify the AudioStream::readSample requirements

Index: audiostream.h
===================================================================
RCS file: /cvsroot/scummvm/scummvm/sound/audiostream.h,v
retrieving revision 1.48
retrieving revision 1.49
diff -u -d -r1.48 -r1.49
--- audiostream.h	30 Jul 2005 21:11:42 -0000	1.48
+++ audiostream.h	18 Sep 2005 14:49:54 -0000	1.49
@@ -40,8 +40,13 @@
 	 * a critical error occured (note: you *must* check if
 	 * this value is less than what you requested, this can
 	 * happen when the stream is fully used up).
+	 *
+	 * Data has to be in native endianess, 16 bit per sample, signed.
 	 * For stereo stream, buffer will be filled with interleaved
-	 * left and right channel samples.
+	 * left and right channel samples, starting with a left sample.
+	 * Furthermore, the samples in the left and right are summed up.
+	 * So if you request 4 samples from a stereo stream, you will get
+	 * a total of two left channel and two right channel samples.
 	 */
 	virtual int readBuffer(int16 *buffer, const int numSamples) = 0;