SDL_sound_CoreAudio: SDL_sound.h comparison

Updated Sound_DecodeAll()'s comments.

author	Ryan C. Gordon <icculus@icculus.org>
date	Mon, 26 Nov 2001 04:41:33 +0000
parents	1df5c106504e
children	47cc2de2ae36

comparison

equal deleted inserted replaced

-:a1255c02bab1
+:e91fb8d5bd62
 *  that a streaming source (for example, from a SDL_RWops that is getting
 *  fed from an Internet radio feed that doesn't end) may fill all available
 *  memory before giving up...be sure to use this on finite sound sources
 *  only!
 *
+* When decoding the sample in its entirety, the work is done one buffer at a
+*  time. That is, sound is decoded in sample->buffer_size blocks, and
+*  appended to a continually-growing buffer until the decoding completes.
+*  That means that this function will need enough RAM to hold approximately
+*  sample->buffer_size bytes plus the complete decoded sample at most. The
+*  larger your buffer size, the less overhead this function needs, but beware
+*  the possibility of paging to disk. Best to make this user-configurable if
+*  the sample isn't specific and small.
+*
 *    @param sample Do all decoding for this Sound_Sample.
-*   @return number of bytes decoded into sample->buffer. If it is less than
+*   @return number of bytes decoded into sample->buffer. You should check
-*           sample->buffer_size, then you should check sample->flags to see
+*           sample->flags to see what the current state of the sample is
-*           what the current state of the sample is (EOF, error, read again).
+*           (EOF, error, read again).
 */
 extern DECLSPEC Uint32 Sound_DecodeAll(Sound_Sample *sample);
 #ifdef __cplusplus
 }

Mercurial > SDL_sound_CoreAudio