[FFmpeg-cvslog] lavf: document request_probe properly

[Michael Niedermayer]

ffmpeg | branch: master | Michael Niedermayer <michaelni at gmx.at> | Sun Sep 23 01:07:15 2012 +0200| [a9f522d1b73f3726cc25c7daffcfccac94eee297] | committer: Michael Niedermayer

lavf: document request_probe properly

Signed-off-by: Michael Niedermayer <michaelni at gmx.at>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=a9f522d1b73f3726cc25c7daffcfccac94eee297
---

 libavformat/avformat.h |    5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index b635ae7..166fdbb 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -809,7 +809,10 @@ typedef struct AVStream {
     unsigned int index_entries_allocated_size;
 
     /**
-     * flag to indicate that probing is requested
+     * stream probing state
+     * -1   -> probing finished
+     *  0   -> no probing requested
+     * rest -> perform probing with request_probe being the minimum score to accept.
      * NOT PART OF PUBLIC API
      */
     int request_probe;