[Gnash-commit] /srv/bzr/gnash/trunk r11089: Add comments about semantic of the number of samples parameter for sound_handler::fetchSamples

[Sandro Santilli]

------------------------------------------------------------
revno: 11089
committer: Sandro Santilli <address@hidden>
branch nick: trunk
timestamp: Fri 2009-06-12 12:51:04 +0200
message:
  Add comments about semantic of the number of samples parameter for 
sound_handler::fetchSamples
modified:
  libsound/sound_handler.h

=== modified file 'libsound/sound_handler.h'
--- a/libsound/sound_handler.h  2009-06-10 11:27:47 +0000
+++ b/libsound/sound_handler.h  2009-06-12 10:51:04 +0000
@@ -396,6 +396,14 @@
     ///
     /// @param nSamples
     ///     The amount of samples to fetch.
+    ///     NOTE: this number currently refers to "mono" samples
+    ///     due to some bad design decision. It is so expected
+    ///     that the user fetches 44100 * 2 samples which has to
+    ///     be interpreted as series of left,right channel couples.
+    ///     TODO: use actual number of samples so that it's expected
+    ///           to fetch 44100 per second and let expose a function
+    ///           to give interpretation of what comes back (how many
+    ///           bytes per channel, which format).
     ///
     virtual void fetchSamples(boost::int16_t* to, unsigned int nSamples);