[Cvs-annodex] commit (annodex): libfishsound/branches/1.0-stable/include/fishsound/decode.h

[giles]

Update of /var/local/lib/svn/annodex (new revision 2534)

Modified files:
   libfishsound/branches/1.0-stable/include/fishsound/decode.h

Log Message:
Clarify that a complete audio packet must be passed to 
fish_sound_decode() to maintain framing for the underlying
codec implmentation.


Modified: libfishsound/branches/1.0-stable/include/fishsound/decode.h
===================================================================
--- libfishsound/branches/1.0-stable/include/fishsound/decode.h	2006-10-22 03:37:22 UTC (rev 2533)
+++ libfishsound/branches/1.0-stable/include/fishsound/decode.h	2006-10-22 19:45:54 UTC (rev 2534)
@@ -98,10 +98,12 @@
 				      void * user_data);
 
 /**
- * Decode a block of data
+ * Decode a block of compressed data.
+ * No internal buffering is done, so a complete compressed audio packet
+ * must be passed each time.
  * \param fsound A FishSound* handle (created with mode FISH_SOUND_DECODE)
- * \param buf A buffer of data
- * \param bytes A count of bytes to decode (ie. the length of buf)
+ * \param buf A buffer containing a compressed audio packet
+ * \param bytes A count of bytes to decode (i.e. the length of buf)
  * \returns The number of bytes consumed
  * \retval FISH_SOUND_ERR_STOP_OK Decoding was stopped by a FishSoundDecode*
  * callback returning FISH_SOUND_STOP_OK before any input bytes were consumed.


-- 
giles