[Scummvm-cvs-logs] scummvm master -> b6a9901e0a40ac838822fc2bc959801a6f2d62fa

clone2727 clone2727 at gmail.com
Tue Jun 7 16:12:12 CEST 2011


This automated email contains information about 2 new commits which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .

Summary:
41e332a80d AUDIO: Clarify makeAACStream() usage
b6a9901e0a AUDIO: Remove tabs from comment spacing


Commit: 41e332a80df0195050db773a87d35ac80ec0fec3
    https://github.com/scummvm/scummvm/commit/41e332a80df0195050db773a87d35ac80ec0fec3
Author: Matthew Hoops (clone2727 at gmail.com)
Date: 2011-06-07T06:52:42-07:00

Commit Message:
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.

Changed paths:
    audio/decoders/aac.h



diff --git a/audio/decoders/aac.h b/audio/decoders/aac.h
index f14fa94..efcbcc6 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,


Commit: b6a9901e0a40ac838822fc2bc959801a6f2d62fa
    https://github.com/scummvm/scummvm/commit/b6a9901e0a40ac838822fc2bc959801a6f2d62fa
Author: Matthew Hoops (clone2727 at gmail.com)
Date: 2011-06-07T07:09:16-07:00

Commit Message:
AUDIO: Remove tabs from comment spacing

Changed paths:
    audio/decoders/quicktime.h



diff --git a/audio/decoders/quicktime.h b/audio/decoders/quicktime.h
index ff81ec9..413f527 100644
--- a/audio/decoders/quicktime.h
+++ b/audio/decoders/quicktime.h
@@ -50,8 +50,8 @@ class SeekableAudioStream;
  * Try to load a QuickTime sound file from the given file name and create a SeekableAudioStream
  * from that data.
  *
- * @param filename			the filename of the file from which to read the data
- * @return	a new SeekableAudioStream, or NULL, if an error occurred
+ * @param filename          the filename of the file from which to read the data
+ * @return  a new SeekableAudioStream, or NULL, if an error occurred
  */
 SeekableAudioStream *makeQuickTimeStream(const Common::String &filename);
 
@@ -59,9 +59,9 @@ SeekableAudioStream *makeQuickTimeStream(const Common::String &filename);
  * Try to load a QuickTime sound file from the given seekable stream and create a SeekableAudioStream
  * from that data.
  *
- * @param stream			the SeekableReadStream from which to read the data
- * @param disposeAfterUse	whether to delete the stream after use
- * @return	a new SeekableAudioStream, or NULL, if an error occurred
+ * @param stream            the SeekableReadStream from which to read the data
+ * @param disposeAfterUse   whether to delete the stream after use
+ * @return  a new SeekableAudioStream, or NULL, if an error occurred
  */
 SeekableAudioStream *makeQuickTimeStream(Common::SeekableReadStream *stream, DisposeAfterUse::Flag disposeAfterUse = DisposeAfterUse::YES);
 






More information about the Scummvm-git-logs mailing list