# HG changeset patch
# User michael
# Date 1284502846 0
# Node ID 2da74be1a3d83312d2bf7bc770269afa2baca04a
# Parent  3ec611be7d7a0cb7a0e41fd656a43c202e967114
Clarify what av_read_frame() returns.

diff -r 3ec611be7d7a -r 2da74be1a3d8 avformat.h
--- a/avformat.h	Mon Sep 13 22:08:51 2010 +0000
+++ b/avformat.h	Tue Sep 14 22:20:46 2010 +0000
@@ -1088,6 +1088,11 @@
 
 /**
  * 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