diff mbox series

[FFmpeg-devel,2/2] lavf: clarify probesize/format_probesize doxy

Message ID 20210425093735.15121-2-anton@khirnov.net
State Accepted
Commit 71c0ef882e37091b22bae2175efb2d5cc4225d8d
Headers show
Series [FFmpeg-devel,1/2] doc: fix generating doxy with out-of-tree builds
Related show

Checks

Context Check Description
andriy/x86_make success Make finished
andriy/x86_make_fate success Make fate finished
andriy/PPC64_make success Make finished
andriy/PPC64_make_fate success Make fate finished

Commit Message

Anton Khirnov April 25, 2021, 9:37 a.m. UTC
probesize is not used for probing the input format, but its
documentation claims it does.
---
 libavformat/avformat.h | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)
diff mbox series

Patch

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 8600ee1bf7..00e78a4a11 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -1394,9 +1394,15 @@  typedef struct AVFormatContext {
 #define AVFMT_FLAG_AUTO_BSF   0x200000 ///< Add bitstream filters as requested by the muxer
 
     /**
-     * Maximum size of the data read from input for determining
-     * the input container format.
+     * Maximum number of bytes read from input in order to determine stream
+     * properties. Used when reading the global header and in
+     * avformat_find_stream_info().
+     *
      * Demuxing only, set by the caller before avformat_open_input().
+     *
+     * @note this is \e not  used for determining the \ref AVInputFormat
+     *       "input format"
+     * @sa format_probesize
      */
     int64_t probesize;
 
@@ -1671,9 +1677,13 @@  typedef struct AVFormatContext {
     int probe_score;
 
     /**
-     * number of bytes to read maximally to identify format.
-     * - encoding: unused
-     * - decoding: set by user
+     * Maximum number of bytes read from input in order to identify the
+     * \ref AVInputFormat "input format". Only used when the format is not set
+     * explicitly by the caller.
+     *
+     * Demuxing only, set by the caller before avformat_open_input().
+     *
+     * @sa probesize
      */
     int format_probesize;