Traneptora/FFmpeg
1
Fork 0
forked from FFmpeg/FFmpeg
Code Pull requests Activity

lavf: clarify probesize/format_probesize doxy

Browse source 
probesize is not used for probing the input format, but its
documentation claims it does.
This commit is contained in:
Anton Khirnov 2021-04-24 14:56:10 +02:00
parent 5384ee486a
commit 71c0ef882e
1 changed files with 15 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
libavformat/avformat.h
View file

@ -1241,9 +1241,15 @@ typedef struct AVFormatContext {
#define AVFMT_FLAG_AUTO_BSF 0x200000 ///< Add bitstream filters as requested by the muxer #define AVFMT_FLAG_AUTO_BSF 0x200000 ///< Add bitstream filters as requested by the muxer
/** /**
* Maximum size of the data read from input for determining * Maximum number of bytes read from input in order to determine stream
* the input container format. * properties. Used when reading the global header and in
* avformat_find_stream_info().
*
* Demuxing only, set by the caller before avformat_open_input(). * 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; int64_t probesize;
@ -1518,9 +1524,13 @@ typedef struct AVFormatContext {
int probe_score; int probe_score;
/** /**
* number of bytes to read maximally to identify format. * Maximum number of bytes read from input in order to identify the
* - encoding: unused * \ref AVInputFormat "input format". Only used when the format is not set
* - decoding: set by user * explicitly by the caller.
*
* Demuxing only, set by the caller before avformat_open_input().
*
* @sa probesize
*/ */
int format_probesize; int format_probesize;