History

lavf: clarify probesize/format_probesize doxy

probesize is not used for probing the input format, but its documentation claims it does.

Anton Khirnov committed 5 years ago

Commit 71c0ef81 parent 5384ee41 file · +15 −5Browse files

Unified · Split

libavformat/avformat.h+15−5
@@ -1241,9 +1241,15 @@ typedef struct AVFormatContext { · 1240 unmodified lines
12411241 #define AVFMT_FLAG_AUTO_BSF 0x200000 ///< Add bitstream filters as requested by the muxer
12421242
12431243 /**
1244− * Maximum size of the data read from input for determining
1245− * the input container format.
1244+ * Maximum number of bytes read from input in order to determine stream
1245+ * properties. Used when reading the global header and in
1246+ * avformat_find_stream_info().
1247+ *
12461248 * Demuxing only, set by the caller before avformat_open_input().
1249+ *
1250+ * @note this is \e not used for determining the \ref AVInputFormat
1251+ * "input format"
1252+ * @sa format_probesize
12471253 */
12481254 int64_t probesize;
12491255
@@ -1518,9 +1524,13 @@ typedef struct AVFormatContext { · 268 unmodified lines
15181524 int probe_score;
15191525
15201526 /**
1521− * number of bytes to read maximally to identify format.
1522− * - encoding: unused
1523− * - decoding: set by user
1527+ * Maximum number of bytes read from input in order to identify the
1528+ * \ref AVInputFormat "input format". Only used when the format is not set
1529+ * explicitly by the caller.
1530+ *
1531+ * Demuxing only, set by the caller before avformat_open_input().
1532+ *
1533+ * @sa probesize
15241534 */
15251535 int format_probesize;
15261536

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t