diff options
| author | Michael Niedermayer <michaelni@gmx.at> | 2010-09-14 22:20:46 +0000 |
|---|---|---|
| committer | Michael Niedermayer <michaelni@gmx.at> | 2010-09-14 22:20:46 +0000 |
| commit | 4faf628f2015b7c04510d39a99a2c52f11b765f3 (patch) | |
| tree | ae9c9a831f864d753de582c9c87a9e361c828786 /libavformat/avformat.h | |
| parent | 180ec37dff1e8f59fc4e84a68714abbfe4b5ee64 (diff) | |
| download | ffmpeg-4faf628f2015b7c04510d39a99a2c52f11b765f3.tar.gz | |
Clarify what av_read_frame() returns.
Originally committed as revision 25123 to svn://svn.ffmpeg.org/ffmpeg/trunk
Diffstat (limited to 'libavformat/avformat.h')
| -rw-r--r-- | libavformat/avformat.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/libavformat/avformat.h b/libavformat/avformat.h index ed9dfb36ce..0520530323 100644 --- a/libavformat/avformat.h +++ b/libavformat/avformat.h @@ -1088,6 +1088,11 @@ int av_read_packet(AVFormatContext *s, AVPacket *pkt); /** * 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 |