libretro/scummvm
1
0
Fork 0
mirror of https://github.com/libretro/scummvm.git synced 2024-12-04 08:17:40 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

AUDIO: Clarify makeAACStream() usage

Browse Source 
So we don't have anyone calling the function or attempting to make the AAC code seekable or anything crazy like that.
This commit is contained in:
Matthew Hoops 2011-06-07 09:52:42 -04:00
parent ae4f63a256
commit 41e332a80d
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
audio/decoders/aac.h
View File

@ -46,13 +46,16 @@ namespace Audio {
class AudioStream;
/**
* Create a new AudioStream from the AAC data in the given stream.
* Create a new AudioStream from the AAC data of an MPEG-4 file in the given stream.
*
* @param stream the SeekableReadStream from which to read the AAC data
* @note This should *only* be called by our QuickTime/MPEG-4 decoder since it relies
* on the MPEG-4 extra data. If you want to decode a file using AAC, go use
* makeQuickTimeStream() instead!
* @param stream the SeekableReadStream from which to read the AAC data
* @param disposeStream whether to delete the stream after use
* @param extraData the SeekableReadStream from which to read the AAC extra data
* @param disposeExtraData whether to delete the extra data stream after use
* @return a new AudioStream, or NULL, if an error occurred
* @return a new AudioStream, or NULL, if an error occurred
*/
AudioStream *makeAACStream(
Common::SeekableReadStream *stream,