changeset 6475:2da74be1a3d8 libavformat

Clarify what av_read_frame() returns.
author michael
date Tue, 14 Sep 2010 22:20:46 +0000
parents 3ec611be7d7a
children f06908662125
files avformat.h
diffstat 1 files changed, 5 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- 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