diff options
| author | Max Horn | 2005-09-18 14:49:54 +0000 |
|---|---|---|
| committer | Max Horn | 2005-09-18 14:49:54 +0000 |
| commit | 7aa398a9d058c3dd4c5aec66f19d996f2e32fd5c (patch) | |
| tree | 1cde3541c0b5e3c1f2c04d1fc9c8965ab89d6c44 | |
| parent | 6a420f524eaf145c2402d38660235a1093aad547 (diff) | |
| download | scummvm-rg350-7aa398a9d058c3dd4c5aec66f19d996f2e32fd5c.tar.gz scummvm-rg350-7aa398a9d058c3dd4c5aec66f19d996f2e32fd5c.tar.bz2 scummvm-rg350-7aa398a9d058c3dd4c5aec66f19d996f2e32fd5c.zip | |
Clarify the AudioStream::readSample requirements
svn-id: r18844
| -rw-r--r-- | sound/audiostream.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/sound/audiostream.h b/sound/audiostream.h index 798c77e6c7..7096a8ec61 100644 --- a/sound/audiostream.h +++ b/sound/audiostream.h @@ -40,8 +40,13 @@ public: * 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; |