libretro/scummvm
1
0
Fork 0
mirror of https://github.com/libretro/scummvm.git synced 2024-12-05 00:36:57 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Clarify that all blocks of raw audio data are assumed to come from malloc()

Browse Source 
svn-id: r47438
This commit is contained in:
Max Horn 2010-01-22 14:14:28 +00:00
parent a8c8763da5
commit 90d503c74a
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
sound/audiostream.h
View File

@ -313,8 +313,8 @@ public:
* Queue a block of raw audio data for playback. This stream
* will play all queued buffers, in the order they were
* queued. After all data contained in them has been played,
* the buffer will be delete[]'d (so make sure to allocate them
* with new[], not with malloc).
* the buffer will be released using free(). So make sure to
* allocate them with malloc(), not with new[]).
*/
void queueBuffer(byte *data, uint32 size, DisposeAfterUse::Flag disposeAfterUse, byte flags);

5
sound/raw.h
View File

@ -68,6 +68,11 @@ enum RawFlags {
/**
* Creates a audio stream, which plays the given raw data.
*
* The data pointer is assumed to have been allocated with malloc().
* In particular, if autofreeBuffer is set to DisposeAfterUse::YES,
* then this buffer will be deallocated using free(). So do not
* use a buffer allocated with new[]!
*
* @param ptr Data
* @param len Length of the data (in bytes!)
* @param rate The sample rate of the data.