[FFmpeg-cvslog] r25123 - trunk/libavformat/avformat.h

[michael]

Author: michael
Date: Wed Sep 15 00:20:46 2010
New Revision: 25123

Log:
Clarify what av_read_frame() returns.

Modified:
   trunk/libavformat/avformat.h

Modified: trunk/libavformat/avformat.h
==============================================================================
--- trunk/libavformat/avformat.h	Tue Sep 14 20:55:20 2010	(r25122)
+++ trunk/libavformat/avformat.h	Wed Sep 15 00:20:46 2010	(r25123)
@@ -1088,6 +1088,11 @@ int av_read_packet(AVFormatContext *s, A
 
 /**
  * Return the next frame of a stream.
+ * This function returns what is stored in the file, and does not validate
+ * that what is there are valid frames for the decoder. It will split what is
+ * stored in the file into frames and return one for each call. It will not
+ * omit invalid data between valid frames so as to give the decoder the maximum
+ * information possible for decoding.
  *
  * The returned packet is valid
  * until the next av_read_frame() or until av_close_input_file() and