aboutsummaryrefslogtreecommitdiff
path: root/audio
diff options
context:
space:
mode:
authorMatthew Hoops2011-06-07 09:52:42 -0400
committerMatthew Hoops2011-06-07 09:52:42 -0400
commit41e332a80df0195050db773a87d35ac80ec0fec3 (patch)
treea2a62c855527a15a4a36612b401f4cd165e404e2 /audio
parentae4f63a256f333b87b560a1a187af7447307c0d9 (diff)
downloadscummvm-rg350-41e332a80df0195050db773a87d35ac80ec0fec3.tar.gz
scummvm-rg350-41e332a80df0195050db773a87d35ac80ec0fec3.tar.bz2
scummvm-rg350-41e332a80df0195050db773a87d35ac80ec0fec3.zip
AUDIO: Clarify makeAACStream() usage
So we don't have anyone calling the function or attempting to make the AAC code seekable or anything crazy like that.
Diffstat (limited to 'audio')
-rw-r--r--audio/decoders/aac.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/audio/decoders/aac.h b/audio/decoders/aac.h
index f14fa9488b..efcbcc6f42 100644
--- a/audio/decoders/aac.h
+++ b/audio/decoders/aac.h
@@ -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,