doc: add libavformat.texi and ffmpeg-formats.texi files
[ffmpeg.git] / doc / ffmpeg-formats.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle FFmpeg Formats Documentation
4 @titlepage
5 @center @titlefont{FFmpeg Formats Documentation}
6 @end titlepage
7
8 @top
9
10 @contents
11
12 @chapter Description
13 @c man begin DESCRIPTION
14
15 This document describes the supported formats (muxers and demuxers)
16 provided by the libavformat library.
17
18 @c man end DESCRIPTION
19
20 @chapter Format Options
21 @c man begin FORMAT OPTIONS
22
23 The libavformat library provides some generic global options, which
24 can be set on all the muxers and demuxers. In addition each muxer or
25 demuxer may support so-called private options, which are specific for
26 that component.
27
28 Options may be set by specifying -@var{option} @var{value} in the
29 FFmpeg tools, or by setting the value explicitly in the
30 @code{AVFormatContext} options or using the @file{libavutil/opt.h} API
31 for programmatic use.
32
33 The list of supported options follows:
34
35 @table @option
36 @item avioflags @var{flags} (@emph{input/output})
37 Possible values:
38 @table @samp
39 @item direct
40 Reduce buffering.
41 @end table
42
43 @item probesize @var{integer} (@emph{input})
44 Set probing size.
45
46 @item packetsize @var{integer} (@emph{output})
47 Set packet size.
48
49 @item fflags @var{flags} (@emph{input/output})
50 Set format flags.
51
52 Possible values:
53 @table @samp
54 @item ignidx
55 Ignore index.
56 @item genpts
57 Generate PTS.
58 @item nofillin
59 Do not fill in missing values that can be exactly calculated.
60 @item noparse
61 Disable AVParsers, this needs @code{+nofillin} too.
62 @item igndts
63 Ignore DTS.
64 @item discardcorrupt
65 Discard corrupted frames.
66 @item sortdts
67 Try to interleave output packets by DTS.
68 @item keepside
69 Do not merge side data.
70 @item latm
71 Enable RTP MP4A-LATM payload.
72 @item nobuffer
73 Reduce the latency introduced by optional buffering
74 @end table
75
76 @item analyzeduration @var{integer} (@emph{input})
77 Specify how many microseconds are analyzed to estimate duration.
78
79 @item cryptokey @var{hexadecimal string} (@emph{input})
80 Set decryption key.
81
82 @item indexmem @var{integer} (@emph{input})
83 Set max memory used for timestamp index (per stream).
84
85 @item rtbufsize @var{integer} (@emph{input})
86 Set max memory used for buffering real-time frames.
87
88 @item fdebug @var{flags} (@emph{input/output})
89 Print specific debug info.
90
91 Possible values:
92 @table @samp
93 @item ts
94 @end table
95
96 @item max_delay @var{integer} (@emph{input/output})
97 Set maximum muxing or demuxing delay in microseconds.
98
99 @item fpsprobesize @var{integer} (@emph{input})
100 Set number of frames used to probe fps.
101
102 @item audio_preload @var{integer} (@emph{output})
103 Set microseconds by which audio packets should be interleaved earlier.
104
105 @item chunk_duration @var{integer} (@emph{output})
106 Set microseconds for each chunk.
107
108 @item chunk_size @var{integer} (@emph{output})
109 Set size in bytes for each chunk.
110
111 @item err_detect, f_err_detect @var{flags} (@emph{input})
112 Set error detection flags. @code{f_err_detect} is deprecated and
113 should be used only via the @command{ffmpeg} tool.
114
115 Possible values:
116 @table @samp
117 @item crccheck
118 Verify embedded CRCs.
119 @item bitstream
120 Detect bitstream specification deviations.
121 @item buffer
122 Detect improper bitstream length.
123 @item explode
124 Abort decoding on minor error detection.
125 @item careful
126 Consider things that violate the spec and have not been seen in the
127 wild as errors.
128 @item compliant
129 Consider all spec non compliancies as errors.
130 @item aggressive
131 Consider things that a sane encoder should not do as an error.
132 @end table
133
134 @item use_wallclock_as_timestamps @var{integer} (@emph{input})
135 Use wallclock as timestamps.
136
137 @item avoid_negative_ts @var{integer} (@emph{output})
138 Avoid negative timestamps.
139 @end table
140
141 @c man end FORMAT OPTIONS
142
143 @include demuxers.texi
144 @include muxers.texi
145
146 @ignore
147
148 @setfilename ffmpeg-formats
149 @settitle FFmpeg formats
150
151 @c man begin SEEALSO
152 ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
153 @c man end
154
155 @c man begin AUTHORS
156 See Git history (git://source.ffmpeg.org/ffmpeg)
157 @c man end
158
159 @end ignore
160
161 @bye