ffprobe.1 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224
  1. .\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
  2. .\"
  3. .\" Standard preamble:
  4. .\" ========================================================================
  5. .de Sp \" Vertical space (when we can't use .PP)
  6. .if t .sp .5v
  7. .if n .sp
  8. ..
  9. .de Vb \" Begin verbatim text
  10. .ft CW
  11. .nf
  12. .ne \\$1
  13. ..
  14. .de Ve \" End verbatim text
  15. .ft R
  16. .fi
  17. ..
  18. .\" Set up some character translations and predefined strings. \*(-- will
  19. .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20. .\" double quote, and \*(R" will give a right double quote. \*(C+ will
  21. .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
  22. .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
  23. .\" nothing in troff, for use with C<>.
  24. .tr \(*W-
  25. .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26. .ie n \{\
  27. . ds -- \(*W-
  28. . ds PI pi
  29. . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30. . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  31. . ds L" ""
  32. . ds R" ""
  33. . ds C` ""
  34. . ds C' ""
  35. 'br\}
  36. .el\{\
  37. . ds -- \|\(em\|
  38. . ds PI \(*p
  39. . ds L" ``
  40. . ds R" ''
  41. . ds C`
  42. . ds C'
  43. 'br\}
  44. .\"
  45. .\" Escape single quotes in literal strings from groff's Unicode transform.
  46. .ie \n(.g .ds Aq \(aq
  47. .el .ds Aq '
  48. .\"
  49. .\" If the F register is >0, we'll generate index entries on stderr for
  50. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51. .\" entries marked with X<> in POD. Of course, you'll have to process the
  52. .\" output yourself in some meaningful fashion.
  53. .\"
  54. .\" Avoid warning from groff about undefined register 'F'.
  55. .de IX
  56. ..
  57. .nr rF 0
  58. .if \n(.g .if rF .nr rF 1
  59. .if (\n(rF:(\n(.g==0)) \{\
  60. . if \nF \{\
  61. . de IX
  62. . tm Index:\\$1\t\\n%\t"\\$2"
  63. ..
  64. . if !\nF==2 \{\
  65. . nr % 0
  66. . nr F 2
  67. . \}
  68. . \}
  69. .\}
  70. .rr rF
  71. .\"
  72. .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73. .\" Fear. Run. Save yourself. No user-serviceable parts.
  74. . \" fudge factors for nroff and troff
  75. .if n \{\
  76. . ds #H 0
  77. . ds #V .8m
  78. . ds #F .3m
  79. . ds #[ \f1
  80. . ds #] \fP
  81. .\}
  82. .if t \{\
  83. . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84. . ds #V .6m
  85. . ds #F 0
  86. . ds #[ \&
  87. . ds #] \&
  88. .\}
  89. . \" simple accents for nroff and troff
  90. .if n \{\
  91. . ds ' \&
  92. . ds ` \&
  93. . ds ^ \&
  94. . ds , \&
  95. . ds ~ ~
  96. . ds /
  97. .\}
  98. .if t \{\
  99. . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  100. . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  101. . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  102. . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  103. . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  104. . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  105. .\}
  106. . \" troff and (daisy-wheel) nroff accents
  107. .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  108. .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  109. .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
  110. .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
  111. .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
  112. .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
  113. .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
  114. .ds ae a\h'-(\w'a'u*4/10)'e
  115. .ds Ae A\h'-(\w'A'u*4/10)'E
  116. . \" corrections for vroff
  117. .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
  118. .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
  119. . \" for low resolution devices (crt and lpr)
  120. .if \n(.H>23 .if \n(.V>19 \
  121. \{\
  122. . ds : e
  123. . ds 8 ss
  124. . ds o a
  125. . ds d- d\h'-1'\(ga
  126. . ds D- D\h'-1'\(hy
  127. . ds th \o'bp'
  128. . ds Th \o'LP'
  129. . ds ae ae
  130. . ds Ae AE
  131. .\}
  132. .rm #[ #] #H #V #F C
  133. .\" ========================================================================
  134. .\"
  135. .IX Title "FFPROBE 1"
  136. .TH FFPROBE 1 " " " " " "
  137. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  138. .\" way too many mistakes in technical documents.
  139. .if n .ad l
  140. .nh
  141. .SH "NAME"
  142. ffprobe \- ffprobe media prober
  143. .SH "SYNOPSIS"
  144. .IX Header "SYNOPSIS"
  145. ffprobe [\fIoptions\fR] [\fIinput_url\fR]
  146. .SH "DESCRIPTION"
  147. .IX Header "DESCRIPTION"
  148. ffprobe gathers information from multimedia streams and prints it in
  149. human\- and machine-readable fashion.
  150. .PP
  151. For example it can be used to check the format of the container used
  152. by a multimedia stream and the format and type of each media stream
  153. contained in it.
  154. .PP
  155. If a url is specified in input, ffprobe will try to open and
  156. probe the url content. If the url cannot be opened or recognized as
  157. a multimedia file, a positive exit code is returned.
  158. .PP
  159. ffprobe may be employed both as a standalone application or in
  160. combination with a textual filter, which may perform more
  161. sophisticated processing, e.g. statistical processing or plotting.
  162. .PP
  163. Options are used to list some of the formats supported by ffprobe or
  164. for specifying which information to display, and for setting how
  165. ffprobe will show it.
  166. .PP
  167. ffprobe output is designed to be easily parsable by a textual filter,
  168. and consists of one or more sections of a form defined by the selected
  169. writer, which is specified by the \fBprint_format\fR option.
  170. .PP
  171. Sections may contain other nested sections, and are identified by a
  172. name (which may be shared by other sections), and an unique
  173. name. See the output of \fBsections\fR.
  174. .PP
  175. Metadata tags stored in the container or in the streams are recognized
  176. and printed in the corresponding \*(L"\s-1FORMAT\*(R", \*(L"STREAM\*(R"\s0 or \*(L"\s-1PROGRAM_STREAM\*(R"\s0
  177. section.
  178. .SH "OPTIONS"
  179. .IX Header "OPTIONS"
  180. All the numerical options, if not specified otherwise, accept a string
  181. representing a number as input, which may be followed by one of the \s-1SI\s0
  182. unit prefixes, for example: 'K', 'M', or 'G'.
  183. .PP
  184. If 'i' is appended to the \s-1SI\s0 unit prefix, the complete prefix will be
  185. interpreted as a unit prefix for binary multiples, which are based on
  186. powers of 1024 instead of powers of 1000. Appending 'B' to the \s-1SI\s0 unit
  187. prefix multiplies the value by 8. This allows using, for example:
  188. \&'\s-1KB\s0', 'MiB', 'G' and 'B' as number suffixes.
  189. .PP
  190. Options which do not take arguments are boolean options, and set the
  191. corresponding value to true. They can be set to false by prefixing
  192. the option name with \*(L"no\*(R". For example using \*(L"\-nofoo\*(R"
  193. will set the boolean option with name \*(L"foo\*(R" to false.
  194. .SS "Stream specifiers"
  195. .IX Subsection "Stream specifiers"
  196. Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers
  197. are used to precisely specify which stream(s) a given option belongs to.
  198. .PP
  199. A stream specifier is a string generally appended to the option name and
  200. separated from it by a colon. E.g. \f(CW\*(C`\-codec:a:1 ac3\*(C'\fR contains the
  201. \&\f(CW\*(C`a:1\*(C'\fR stream specifier, which matches the second audio stream. Therefore, it
  202. would select the ac3 codec for the second audio stream.
  203. .PP
  204. A stream specifier can match several streams, so that the option is applied to all
  205. of them. E.g. the stream specifier in \f(CW\*(C`\-b:a 128k\*(C'\fR matches all audio
  206. streams.
  207. .PP
  208. An empty stream specifier matches all streams. For example, \f(CW\*(C`\-codec copy\*(C'\fR
  209. or \f(CW\*(C`\-codec: copy\*(C'\fR would copy all the streams without reencoding.
  210. .PP
  211. Possible forms of stream specifiers are:
  212. .IP "\fIstream_index\fR" 4
  213. .IX Item "stream_index"
  214. Matches the stream with this index. E.g. \f(CW\*(C`\-threads:1 4\*(C'\fR would set the
  215. thread count for the second stream to 4. If \fIstream_index\fR is used as an
  216. additional stream specifier (see below), then it selects stream number
  217. \&\fIstream_index\fR from the matching streams. Stream numbering is based on the
  218. order of the streams as detected by libavformat except when a program \s-1ID\s0 is
  219. also specified. In this case it is based on the ordering of the streams in the
  220. program.
  221. .IP "\fIstream_type\fR\fB[:\fR\fIadditional_stream_specifier\fR\fB]\fR" 4
  222. .IX Item "stream_type[:additional_stream_specifier]"
  223. \&\fIstream_type\fR is one of following: 'v' or 'V' for video, 'a' for audio, 's'
  224. for subtitle, 'd' for data, and 't' for attachments. 'v' matches all video
  225. streams, 'V' only matches video streams which are not attached pictures, video
  226. thumbnails or cover arts. If \fIadditional_stream_specifier\fR is used, then
  227. it matches streams which both have this type and match the
  228. \&\fIadditional_stream_specifier\fR. Otherwise, it matches all streams of the
  229. specified type.
  230. .IP "\fBp:\fR\fIprogram_id\fR\fB[:\fR\fIadditional_stream_specifier\fR\fB]\fR" 4
  231. .IX Item "p:program_id[:additional_stream_specifier]"
  232. Matches streams which are in the program with the id \fIprogram_id\fR. If
  233. \&\fIadditional_stream_specifier\fR is used, then it matches streams which both
  234. are part of the program and match the \fIadditional_stream_specifier\fR.
  235. .IP "\fB#\fR\fIstream_id\fR \fBor i:\fR\fIstream_id\fR" 4
  236. .IX Item "#stream_id or i:stream_id"
  237. Match the stream by stream id (e.g. \s-1PID\s0 in MPEG-TS container).
  238. .IP "\fBm:\fR\fIkey\fR\fB[:\fR\fIvalue\fR\fB]\fR" 4
  239. .IX Item "m:key[:value]"
  240. Matches streams with the metadata tag \fIkey\fR having the specified value. If
  241. \&\fIvalue\fR is not given, matches streams that contain the given tag with any
  242. value.
  243. .IP "\fBu\fR" 4
  244. .IX Item "u"
  245. Matches streams with usable configuration, the codec must be defined and the
  246. essential information such as video dimension or audio sample rate must be present.
  247. .Sp
  248. Note that in \fBffmpeg\fR, matching by metadata will only work properly for
  249. input files.
  250. .SS "Generic options"
  251. .IX Subsection "Generic options"
  252. These options are shared amongst the ff* tools.
  253. .IP "\fB\-L\fR" 4
  254. .IX Item "-L"
  255. Show license.
  256. .IP "\fB\-h, \-?, \-help, \-\-help [\fR\fIarg\fR\fB]\fR" 4
  257. .IX Item "-h, -?, -help, --help [arg]"
  258. Show help. An optional parameter may be specified to print help about a specific
  259. item. If no argument is specified, only basic (non advanced) tool
  260. options are shown.
  261. .Sp
  262. Possible values of \fIarg\fR are:
  263. .RS 4
  264. .IP "\fBlong\fR" 4
  265. .IX Item "long"
  266. Print advanced tool options in addition to the basic tool options.
  267. .IP "\fBfull\fR" 4
  268. .IX Item "full"
  269. Print complete list of options, including shared and private options
  270. for encoders, decoders, demuxers, muxers, filters, etc.
  271. .IP "\fBdecoder=\fR\fIdecoder_name\fR" 4
  272. .IX Item "decoder=decoder_name"
  273. Print detailed information about the decoder named \fIdecoder_name\fR. Use the
  274. \&\fB\-decoders\fR option to get a list of all decoders.
  275. .IP "\fBencoder=\fR\fIencoder_name\fR" 4
  276. .IX Item "encoder=encoder_name"
  277. Print detailed information about the encoder named \fIencoder_name\fR. Use the
  278. \&\fB\-encoders\fR option to get a list of all encoders.
  279. .IP "\fBdemuxer=\fR\fIdemuxer_name\fR" 4
  280. .IX Item "demuxer=demuxer_name"
  281. Print detailed information about the demuxer named \fIdemuxer_name\fR. Use the
  282. \&\fB\-formats\fR option to get a list of all demuxers and muxers.
  283. .IP "\fBmuxer=\fR\fImuxer_name\fR" 4
  284. .IX Item "muxer=muxer_name"
  285. Print detailed information about the muxer named \fImuxer_name\fR. Use the
  286. \&\fB\-formats\fR option to get a list of all muxers and demuxers.
  287. .IP "\fBfilter=\fR\fIfilter_name\fR" 4
  288. .IX Item "filter=filter_name"
  289. Print detailed information about the filter named \fIfilter_name\fR. Use the
  290. \&\fB\-filters\fR option to get a list of all filters.
  291. .IP "\fBbsf=\fR\fIbitstream_filter_name\fR" 4
  292. .IX Item "bsf=bitstream_filter_name"
  293. Print detailed information about the bitstream filter named \fIbitstream_filter_name\fR.
  294. Use the \fB\-bsfs\fR option to get a list of all bitstream filters.
  295. .IP "\fBprotocol=\fR\fIprotocol_name\fR" 4
  296. .IX Item "protocol=protocol_name"
  297. Print detailed information about the protocol named \fIprotocol_name\fR.
  298. Use the \fB\-protocols\fR option to get a list of all protocols.
  299. .RE
  300. .RS 4
  301. .RE
  302. .IP "\fB\-version\fR" 4
  303. .IX Item "-version"
  304. Show version.
  305. .IP "\fB\-buildconf\fR" 4
  306. .IX Item "-buildconf"
  307. Show the build configuration, one option per line.
  308. .IP "\fB\-formats\fR" 4
  309. .IX Item "-formats"
  310. Show available formats (including devices).
  311. .IP "\fB\-demuxers\fR" 4
  312. .IX Item "-demuxers"
  313. Show available demuxers.
  314. .IP "\fB\-muxers\fR" 4
  315. .IX Item "-muxers"
  316. Show available muxers.
  317. .IP "\fB\-devices\fR" 4
  318. .IX Item "-devices"
  319. Show available devices.
  320. .IP "\fB\-codecs\fR" 4
  321. .IX Item "-codecs"
  322. Show all codecs known to libavcodec.
  323. .Sp
  324. Note that the term 'codec' is used throughout this documentation as a shortcut
  325. for what is more correctly called a media bitstream format.
  326. .IP "\fB\-decoders\fR" 4
  327. .IX Item "-decoders"
  328. Show available decoders.
  329. .IP "\fB\-encoders\fR" 4
  330. .IX Item "-encoders"
  331. Show all available encoders.
  332. .IP "\fB\-bsfs\fR" 4
  333. .IX Item "-bsfs"
  334. Show available bitstream filters.
  335. .IP "\fB\-protocols\fR" 4
  336. .IX Item "-protocols"
  337. Show available protocols.
  338. .IP "\fB\-filters\fR" 4
  339. .IX Item "-filters"
  340. Show available libavfilter filters.
  341. .IP "\fB\-pix_fmts\fR" 4
  342. .IX Item "-pix_fmts"
  343. Show available pixel formats.
  344. .IP "\fB\-sample_fmts\fR" 4
  345. .IX Item "-sample_fmts"
  346. Show available sample formats.
  347. .IP "\fB\-layouts\fR" 4
  348. .IX Item "-layouts"
  349. Show channel names and standard channel layouts.
  350. .IP "\fB\-colors\fR" 4
  351. .IX Item "-colors"
  352. Show recognized color names.
  353. .IP "\fB\-sources\fR \fIdevice\fR\fB[,\fR\fIopt1\fR\fB=\fR\fIval1\fR\fB[,\fR\fIopt2\fR\fB=\fR\fIval2\fR\fB]...]\fR" 4
  354. .IX Item "-sources device[,opt1=val1[,opt2=val2]...]"
  355. Show autodetected sources of the input device.
  356. Some devices may provide system-dependent source names that cannot be autodetected.
  357. The returned list cannot be assumed to be always complete.
  358. .Sp
  359. .Vb 1
  360. \& ffmpeg \-sources pulse,server=192.168.0.4
  361. .Ve
  362. .IP "\fB\-sinks\fR \fIdevice\fR\fB[,\fR\fIopt1\fR\fB=\fR\fIval1\fR\fB[,\fR\fIopt2\fR\fB=\fR\fIval2\fR\fB]...]\fR" 4
  363. .IX Item "-sinks device[,opt1=val1[,opt2=val2]...]"
  364. Show autodetected sinks of the output device.
  365. Some devices may provide system-dependent sink names that cannot be autodetected.
  366. The returned list cannot be assumed to be always complete.
  367. .Sp
  368. .Vb 1
  369. \& ffmpeg \-sinks pulse,server=192.168.0.4
  370. .Ve
  371. .IP "\fB\-loglevel [\fR\fIflags\fR\fB+]\fR\fIloglevel\fR \fB| \-v [\fR\fIflags\fR\fB+]\fR\fIloglevel\fR" 4
  372. .IX Item "-loglevel [flags+]loglevel | -v [flags+]loglevel"
  373. Set logging level and flags used by the library.
  374. .Sp
  375. The optional \fIflags\fR prefix can consist of the following values:
  376. .RS 4
  377. .IP "\fBrepeat\fR" 4
  378. .IX Item "repeat"
  379. Indicates that repeated log output should not be compressed to the first line
  380. and the \*(L"Last message repeated n times\*(R" line will be omitted.
  381. .IP "\fBlevel\fR" 4
  382. .IX Item "level"
  383. Indicates that log output should add a \f(CW\*(C`[level]\*(C'\fR prefix to each message
  384. line. This can be used as an alternative to log coloring, e.g. when dumping the
  385. log to file.
  386. .RE
  387. .RS 4
  388. .Sp
  389. Flags can also be used alone by adding a '+'/'\-' prefix to set/reset a single
  390. flag without affecting other \fIflags\fR or changing \fIloglevel\fR. When
  391. setting both \fIflags\fR and \fIloglevel\fR, a '+' separator is expected
  392. between the last \fIflags\fR value and before \fIloglevel\fR.
  393. .Sp
  394. \&\fIloglevel\fR is a string or a number containing one of the following values:
  395. .IP "\fBquiet, \-8\fR" 4
  396. .IX Item "quiet, -8"
  397. Show nothing at all; be silent.
  398. .IP "\fBpanic, 0\fR" 4
  399. .IX Item "panic, 0"
  400. Only show fatal errors which could lead the process to crash, such as
  401. an assertion failure. This is not currently used for anything.
  402. .IP "\fBfatal, 8\fR" 4
  403. .IX Item "fatal, 8"
  404. Only show fatal errors. These are errors after which the process absolutely
  405. cannot continue.
  406. .IP "\fBerror, 16\fR" 4
  407. .IX Item "error, 16"
  408. Show all errors, including ones which can be recovered from.
  409. .IP "\fBwarning, 24\fR" 4
  410. .IX Item "warning, 24"
  411. Show all warnings and errors. Any message related to possibly
  412. incorrect or unexpected events will be shown.
  413. .IP "\fBinfo, 32\fR" 4
  414. .IX Item "info, 32"
  415. Show informative messages during processing. This is in addition to
  416. warnings and errors. This is the default value.
  417. .IP "\fBverbose, 40\fR" 4
  418. .IX Item "verbose, 40"
  419. Same as \f(CW\*(C`info\*(C'\fR, except more verbose.
  420. .IP "\fBdebug, 48\fR" 4
  421. .IX Item "debug, 48"
  422. Show everything, including debugging information.
  423. .IP "\fBtrace, 56\fR" 4
  424. .IX Item "trace, 56"
  425. .RE
  426. .RS 4
  427. .Sp
  428. For example to enable repeated log output, add the \f(CW\*(C`level\*(C'\fR prefix, and set
  429. \&\fIloglevel\fR to \f(CW\*(C`verbose\*(C'\fR:
  430. .Sp
  431. .Vb 1
  432. \& ffmpeg \-loglevel repeat+level+verbose \-i input output
  433. .Ve
  434. .Sp
  435. Another example that enables repeated log output without affecting current
  436. state of \f(CW\*(C`level\*(C'\fR prefix flag or \fIloglevel\fR:
  437. .Sp
  438. .Vb 1
  439. \& ffmpeg [...] \-loglevel +repeat
  440. .Ve
  441. .Sp
  442. By default the program logs to stderr. If coloring is supported by the
  443. terminal, colors are used to mark errors and warnings. Log coloring
  444. can be disabled setting the environment variable
  445. \&\fB\s-1AV_LOG_FORCE_NOCOLOR\s0\fR, or can be forced setting
  446. the environment variable \fB\s-1AV_LOG_FORCE_COLOR\s0\fR.
  447. .RE
  448. .IP "\fB\-report\fR" 4
  449. .IX Item "-report"
  450. Dump full command line and log output to a file named
  451. \&\f(CW\*(C`\f(CIprogram\f(CW\-\f(CIYYYYMMDD\f(CW\-\f(CIHHMMSS\f(CW.log\*(C'\fR in the current
  452. directory.
  453. This file can be useful for bug reports.
  454. It also implies \f(CW\*(C`\-loglevel debug\*(C'\fR.
  455. .Sp
  456. Setting the environment variable \fB\s-1FFREPORT\s0\fR to any value has the
  457. same effect. If the value is a ':'\-separated key=value sequence, these
  458. options will affect the report; option values must be escaped if they
  459. contain special characters or the options delimiter ':' (see the
  460. ``Quoting and escaping'' section in the ffmpeg-utils manual).
  461. .Sp
  462. The following options are recognized:
  463. .RS 4
  464. .IP "\fBfile\fR" 4
  465. .IX Item "file"
  466. set the file name to use for the report; \f(CW%p\fR is expanded to the name
  467. of the program, \f(CW%t\fR is expanded to a timestamp, \f(CW\*(C`%%\*(C'\fR is expanded
  468. to a plain \f(CW\*(C`%\*(C'\fR
  469. .IP "\fBlevel\fR" 4
  470. .IX Item "level"
  471. set the log verbosity level using a numerical value (see \f(CW\*(C`\-loglevel\*(C'\fR).
  472. .RE
  473. .RS 4
  474. .Sp
  475. For example, to output a report to a file named \fIffreport.log\fR
  476. using a log level of \f(CW32\fR (alias for log level \f(CW\*(C`info\*(C'\fR):
  477. .Sp
  478. .Vb 1
  479. \& FFREPORT=file=ffreport.log:level=32 ffmpeg \-i input output
  480. .Ve
  481. .Sp
  482. Errors in parsing the environment variable are not fatal, and will not
  483. appear in the report.
  484. .RE
  485. .IP "\fB\-hide_banner\fR" 4
  486. .IX Item "-hide_banner"
  487. Suppress printing banner.
  488. .Sp
  489. All FFmpeg tools will normally show a copyright notice, build options
  490. and library versions. This option can be used to suppress printing
  491. this information.
  492. .IP "\fB\-cpuflags flags (\fR\fIglobal\fR\fB)\fR" 4
  493. .IX Item "-cpuflags flags (global)"
  494. Allows setting and clearing cpu flags. This option is intended
  495. for testing. Do not use it unless you know what you're doing.
  496. .Sp
  497. .Vb 3
  498. \& ffmpeg \-cpuflags \-sse+mmx ...
  499. \& ffmpeg \-cpuflags mmx ...
  500. \& ffmpeg \-cpuflags 0 ...
  501. .Ve
  502. .Sp
  503. Possible flags for this option are:
  504. .RS 4
  505. .IP "\fBx86\fR" 4
  506. .IX Item "x86"
  507. .RS 4
  508. .PD 0
  509. .IP "\fBmmx\fR" 4
  510. .IX Item "mmx"
  511. .IP "\fBmmxext\fR" 4
  512. .IX Item "mmxext"
  513. .IP "\fBsse\fR" 4
  514. .IX Item "sse"
  515. .IP "\fBsse2\fR" 4
  516. .IX Item "sse2"
  517. .IP "\fBsse2slow\fR" 4
  518. .IX Item "sse2slow"
  519. .IP "\fBsse3\fR" 4
  520. .IX Item "sse3"
  521. .IP "\fBsse3slow\fR" 4
  522. .IX Item "sse3slow"
  523. .IP "\fBssse3\fR" 4
  524. .IX Item "ssse3"
  525. .IP "\fBatom\fR" 4
  526. .IX Item "atom"
  527. .IP "\fBsse4.1\fR" 4
  528. .IX Item "sse4.1"
  529. .IP "\fBsse4.2\fR" 4
  530. .IX Item "sse4.2"
  531. .IP "\fBavx\fR" 4
  532. .IX Item "avx"
  533. .IP "\fBavx2\fR" 4
  534. .IX Item "avx2"
  535. .IP "\fBxop\fR" 4
  536. .IX Item "xop"
  537. .IP "\fBfma3\fR" 4
  538. .IX Item "fma3"
  539. .IP "\fBfma4\fR" 4
  540. .IX Item "fma4"
  541. .IP "\fB3dnow\fR" 4
  542. .IX Item "3dnow"
  543. .IP "\fB3dnowext\fR" 4
  544. .IX Item "3dnowext"
  545. .IP "\fBbmi1\fR" 4
  546. .IX Item "bmi1"
  547. .IP "\fBbmi2\fR" 4
  548. .IX Item "bmi2"
  549. .IP "\fBcmov\fR" 4
  550. .IX Item "cmov"
  551. .RE
  552. .RS 4
  553. .RE
  554. .IP "\fB\s-1ARM\s0\fR" 4
  555. .IX Item "ARM"
  556. .RS 4
  557. .IP "\fBarmv5te\fR" 4
  558. .IX Item "armv5te"
  559. .IP "\fBarmv6\fR" 4
  560. .IX Item "armv6"
  561. .IP "\fBarmv6t2\fR" 4
  562. .IX Item "armv6t2"
  563. .IP "\fBvfp\fR" 4
  564. .IX Item "vfp"
  565. .IP "\fBvfpv3\fR" 4
  566. .IX Item "vfpv3"
  567. .IP "\fBneon\fR" 4
  568. .IX Item "neon"
  569. .IP "\fBsetend\fR" 4
  570. .IX Item "setend"
  571. .RE
  572. .RS 4
  573. .RE
  574. .IP "\fBAArch64\fR" 4
  575. .IX Item "AArch64"
  576. .RS 4
  577. .IP "\fBarmv8\fR" 4
  578. .IX Item "armv8"
  579. .IP "\fBvfp\fR" 4
  580. .IX Item "vfp"
  581. .IP "\fBneon\fR" 4
  582. .IX Item "neon"
  583. .RE
  584. .RS 4
  585. .RE
  586. .IP "\fBPowerPC\fR" 4
  587. .IX Item "PowerPC"
  588. .RS 4
  589. .IP "\fBaltivec\fR" 4
  590. .IX Item "altivec"
  591. .RE
  592. .RS 4
  593. .RE
  594. .IP "\fBSpecific Processors\fR" 4
  595. .IX Item "Specific Processors"
  596. .RS 4
  597. .IP "\fBpentium2\fR" 4
  598. .IX Item "pentium2"
  599. .IP "\fBpentium3\fR" 4
  600. .IX Item "pentium3"
  601. .IP "\fBpentium4\fR" 4
  602. .IX Item "pentium4"
  603. .IP "\fBk6\fR" 4
  604. .IX Item "k6"
  605. .IP "\fBk62\fR" 4
  606. .IX Item "k62"
  607. .IP "\fBathlon\fR" 4
  608. .IX Item "athlon"
  609. .IP "\fBathlonxp\fR" 4
  610. .IX Item "athlonxp"
  611. .IP "\fBk8\fR" 4
  612. .IX Item "k8"
  613. .RE
  614. .RS 4
  615. .RE
  616. .RE
  617. .RS 4
  618. .RE
  619. .IP "\fB\-max_alloc\fR \fIbytes\fR" 4
  620. .IX Item "-max_alloc bytes"
  621. .PD
  622. Set the maximum size limit for allocating a block on the heap by ffmpeg's
  623. family of malloc functions. Exercise \fBextreme caution\fR when using
  624. this option. Don't use if you do not understand the full consequence of doing so.
  625. Default is \s-1INT_MAX.\s0
  626. .SS "AVOptions"
  627. .IX Subsection "AVOptions"
  628. These options are provided directly by the libavformat, libavdevice and
  629. libavcodec libraries. To see the list of available AVOptions, use the
  630. \&\fB\-help\fR option. They are separated into two categories:
  631. .IP "\fBgeneric\fR" 4
  632. .IX Item "generic"
  633. These options can be set for any container, codec or device. Generic options
  634. are listed under AVFormatContext options for containers/devices and under
  635. AVCodecContext options for codecs.
  636. .IP "\fBprivate\fR" 4
  637. .IX Item "private"
  638. These options are specific to the given container, device or codec. Private
  639. options are listed under their corresponding containers/devices/codecs.
  640. .PP
  641. For example to write an ID3v2.3 header instead of a default ID3v2.4 to
  642. an \s-1MP3\s0 file, use the \fBid3v2_version\fR private option of the \s-1MP3\s0
  643. muxer:
  644. .PP
  645. .Vb 1
  646. \& ffmpeg \-i input.flac \-id3v2_version 3 out.mp3
  647. .Ve
  648. .PP
  649. All codec AVOptions are per-stream, and thus a stream specifier
  650. should be attached to them:
  651. .PP
  652. .Vb 1
  653. \& ffmpeg \-i multichannel.mxf \-map 0:v:0 \-map 0:a:0 \-map 0:a:0 \-c:a:0 ac3 \-b:a:0 640k \-ac:a:1 2 \-c:a:1 aac \-b:2 128k out.mp4
  654. .Ve
  655. .PP
  656. In the above example, a multichannel audio stream is mapped twice for output.
  657. The first instance is encoded with codec ac3 and bitrate 640k.
  658. The second instance is downmixed to 2 channels and encoded with codec aac. A bitrate of 128k is specified for it using
  659. absolute index of the output stream.
  660. .PP
  661. Note: the \fB\-nooption\fR syntax cannot be used for boolean
  662. AVOptions, use \fB\-option 0\fR/\fB\-option 1\fR.
  663. .PP
  664. Note: the old undocumented way of specifying per-stream AVOptions by
  665. prepending v/a/s to the options name is now obsolete and will be
  666. removed soon.
  667. .SS "Main options"
  668. .IX Subsection "Main options"
  669. .IP "\fB\-f\fR \fIformat\fR" 4
  670. .IX Item "-f format"
  671. Force format to use.
  672. .IP "\fB\-unit\fR" 4
  673. .IX Item "-unit"
  674. Show the unit of the displayed values.
  675. .IP "\fB\-prefix\fR" 4
  676. .IX Item "-prefix"
  677. Use \s-1SI\s0 prefixes for the displayed values.
  678. Unless the \*(L"\-byte_binary_prefix\*(R" option is used all the prefixes
  679. are decimal.
  680. .IP "\fB\-byte_binary_prefix\fR" 4
  681. .IX Item "-byte_binary_prefix"
  682. Force the use of binary prefixes for byte values.
  683. .IP "\fB\-sexagesimal\fR" 4
  684. .IX Item "-sexagesimal"
  685. Use sexagesimal format \s-1HH:MM:SS.MICROSECONDS\s0 for time values.
  686. .IP "\fB\-pretty\fR" 4
  687. .IX Item "-pretty"
  688. Prettify the format of the displayed values, it corresponds to the
  689. options \*(L"\-unit \-prefix \-byte_binary_prefix \-sexagesimal\*(R".
  690. .IP "\fB\-of, \-print_format\fR \fIwriter_name\fR\fB[=\fR\fIwriter_options\fR\fB]\fR" 4
  691. .IX Item "-of, -print_format writer_name[=writer_options]"
  692. Set the output printing format.
  693. .Sp
  694. \&\fIwriter_name\fR specifies the name of the writer, and
  695. \&\fIwriter_options\fR specifies the options to be passed to the writer.
  696. .Sp
  697. For example for printing the output in \s-1JSON\s0 format, specify:
  698. .Sp
  699. .Vb 1
  700. \& \-print_format json
  701. .Ve
  702. .Sp
  703. For more details on the available output printing formats, see the
  704. Writers section below.
  705. .IP "\fB\-sections\fR" 4
  706. .IX Item "-sections"
  707. Print sections structure and section information, and exit. The output
  708. is not meant to be parsed by a machine.
  709. .IP "\fB\-select_streams\fR \fIstream_specifier\fR" 4
  710. .IX Item "-select_streams stream_specifier"
  711. Select only the streams specified by \fIstream_specifier\fR. This
  712. option affects only the options related to streams
  713. (e.g. \f(CW\*(C`show_streams\*(C'\fR, \f(CW\*(C`show_packets\*(C'\fR, etc.).
  714. .Sp
  715. For example to show only audio streams, you can use the command:
  716. .Sp
  717. .Vb 1
  718. \& ffprobe \-show_streams \-select_streams a INPUT
  719. .Ve
  720. .Sp
  721. To show only video packets belonging to the video stream with index 1:
  722. .Sp
  723. .Vb 1
  724. \& ffprobe \-show_packets \-select_streams v:1 INPUT
  725. .Ve
  726. .IP "\fB\-show_data\fR" 4
  727. .IX Item "-show_data"
  728. Show payload data, as a hexadecimal and \s-1ASCII\s0 dump. Coupled with
  729. \&\fB\-show_packets\fR, it will dump the packets' data. Coupled with
  730. \&\fB\-show_streams\fR, it will dump the codec extradata.
  731. .Sp
  732. The dump is printed as the \*(L"data\*(R" field. It may contain newlines.
  733. .IP "\fB\-show_data_hash\fR \fIalgorithm\fR" 4
  734. .IX Item "-show_data_hash algorithm"
  735. Show a hash of payload data, for packets with \fB\-show_packets\fR and for
  736. codec extradata with \fB\-show_streams\fR.
  737. .IP "\fB\-show_error\fR" 4
  738. .IX Item "-show_error"
  739. Show information about the error found when trying to probe the input.
  740. .Sp
  741. The error information is printed within a section with name \*(L"\s-1ERROR\*(R".\s0
  742. .IP "\fB\-show_format\fR" 4
  743. .IX Item "-show_format"
  744. Show information about the container format of the input multimedia
  745. stream.
  746. .Sp
  747. All the container format information is printed within a section with
  748. name \*(L"\s-1FORMAT\*(R".\s0
  749. .IP "\fB\-show_format_entry\fR \fIname\fR" 4
  750. .IX Item "-show_format_entry name"
  751. Like \fB\-show_format\fR, but only prints the specified entry of the
  752. container format information, rather than all. This option may be given more
  753. than once, then all specified entries will be shown.
  754. .Sp
  755. This option is deprecated, use \f(CW\*(C`show_entries\*(C'\fR instead.
  756. .IP "\fB\-show_entries\fR \fIsection_entries\fR" 4
  757. .IX Item "-show_entries section_entries"
  758. Set list of entries to show.
  759. .Sp
  760. Entries are specified according to the following
  761. syntax. \fIsection_entries\fR contains a list of section entries
  762. separated by \f(CW\*(C`:\*(C'\fR. Each section entry is composed by a section
  763. name (or unique name), optionally followed by a list of entries local
  764. to that section, separated by \f(CW\*(C`,\*(C'\fR.
  765. .Sp
  766. If section name is specified but is followed by no \f(CW\*(C`=\*(C'\fR, all
  767. entries are printed to output, together with all the contained
  768. sections. Otherwise only the entries specified in the local section
  769. entries list are printed. In particular, if \f(CW\*(C`=\*(C'\fR is specified but
  770. the list of local entries is empty, then no entries will be shown for
  771. that section.
  772. .Sp
  773. Note that the order of specification of the local section entries is
  774. not honored in the output, and the usual display order will be
  775. retained.
  776. .Sp
  777. The formal syntax is given by:
  778. .Sp
  779. .Vb 3
  780. \& <LOCAL_SECTION_ENTRIES> ::= <SECTION_ENTRY_NAME>[,<LOCAL_SECTION_ENTRIES>]
  781. \& <SECTION_ENTRY> ::= <SECTION_NAME>[=[<LOCAL_SECTION_ENTRIES>]]
  782. \& <SECTION_ENTRIES> ::= <SECTION_ENTRY>[:<SECTION_ENTRIES>]
  783. .Ve
  784. .Sp
  785. For example, to show only the index and type of each stream, and the \s-1PTS\s0
  786. time, duration time, and stream index of the packets, you can specify
  787. the argument:
  788. .Sp
  789. .Vb 1
  790. \& packet=pts_time,duration_time,stream_index : stream=index,codec_type
  791. .Ve
  792. .Sp
  793. To show all the entries in the section \*(L"format\*(R", but only the codec
  794. type in the section \*(L"stream\*(R", specify the argument:
  795. .Sp
  796. .Vb 1
  797. \& format : stream=codec_type
  798. .Ve
  799. .Sp
  800. To show all the tags in the stream and format sections:
  801. .Sp
  802. .Vb 1
  803. \& stream_tags : format_tags
  804. .Ve
  805. .Sp
  806. To show only the \f(CW\*(C`title\*(C'\fR tag (if available) in the stream
  807. sections:
  808. .Sp
  809. .Vb 1
  810. \& stream_tags=title
  811. .Ve
  812. .IP "\fB\-show_packets\fR" 4
  813. .IX Item "-show_packets"
  814. Show information about each packet contained in the input multimedia
  815. stream.
  816. .Sp
  817. The information for each single packet is printed within a dedicated
  818. section with name \*(L"\s-1PACKET\*(R".\s0
  819. .IP "\fB\-show_frames\fR" 4
  820. .IX Item "-show_frames"
  821. Show information about each frame and subtitle contained in the input
  822. multimedia stream.
  823. .Sp
  824. The information for each single frame is printed within a dedicated
  825. section with name \*(L"\s-1FRAME\*(R"\s0 or \*(L"\s-1SUBTITLE\*(R".\s0
  826. .IP "\fB\-show_log\fR \fIloglevel\fR" 4
  827. .IX Item "-show_log loglevel"
  828. Show logging information from the decoder about each frame according to
  829. the value set in \fIloglevel\fR, (see \f(CW\*(C`\-loglevel\*(C'\fR). This option requires \f(CW\*(C`\-show_frames\*(C'\fR.
  830. .Sp
  831. The information for each log message is printed within a dedicated
  832. section with name \*(L"\s-1LOG\*(R".\s0
  833. .IP "\fB\-show_streams\fR" 4
  834. .IX Item "-show_streams"
  835. Show information about each media stream contained in the input
  836. multimedia stream.
  837. .Sp
  838. Each media stream information is printed within a dedicated section
  839. with name \*(L"\s-1STREAM\*(R".\s0
  840. .IP "\fB\-show_programs\fR" 4
  841. .IX Item "-show_programs"
  842. Show information about programs and their streams contained in the input
  843. multimedia stream.
  844. .Sp
  845. Each media stream information is printed within a dedicated section
  846. with name \*(L"\s-1PROGRAM_STREAM\*(R".\s0
  847. .IP "\fB\-show_chapters\fR" 4
  848. .IX Item "-show_chapters"
  849. Show information about chapters stored in the format.
  850. .Sp
  851. Each chapter is printed within a dedicated section with name \*(L"\s-1CHAPTER\*(R".\s0
  852. .IP "\fB\-count_frames\fR" 4
  853. .IX Item "-count_frames"
  854. Count the number of frames per stream and report it in the
  855. corresponding stream section.
  856. .IP "\fB\-count_packets\fR" 4
  857. .IX Item "-count_packets"
  858. Count the number of packets per stream and report it in the
  859. corresponding stream section.
  860. .IP "\fB\-read_intervals\fR \fIread_intervals\fR" 4
  861. .IX Item "-read_intervals read_intervals"
  862. Read only the specified intervals. \fIread_intervals\fR must be a
  863. sequence of interval specifications separated by \*(L",\*(R".
  864. \&\fBffprobe\fR will seek to the interval starting point, and will
  865. continue reading from that.
  866. .Sp
  867. Each interval is specified by two optional parts, separated by \*(L"%\*(R".
  868. .Sp
  869. The first part specifies the interval start position. It is
  870. interpreted as an absolute position, or as a relative offset from the
  871. current position if it is preceded by the \*(L"+\*(R" character. If this first
  872. part is not specified, no seeking will be performed when reading this
  873. interval.
  874. .Sp
  875. The second part specifies the interval end position. It is interpreted
  876. as an absolute position, or as a relative offset from the current
  877. position if it is preceded by the \*(L"+\*(R" character. If the offset
  878. specification starts with \*(L"#\*(R", it is interpreted as the number of
  879. packets to read (not including the flushing packets) from the interval
  880. start. If no second part is specified, the program will read until the
  881. end of the input.
  882. .Sp
  883. Note that seeking is not accurate, thus the actual interval start
  884. point may be different from the specified position. Also, when an
  885. interval duration is specified, the absolute end time will be computed
  886. by adding the duration to the interval start point found by seeking
  887. the file, rather than to the specified start value.
  888. .Sp
  889. The formal syntax is given by:
  890. .Sp
  891. .Vb 2
  892. \& <INTERVAL> ::= [<START>|+<START_OFFSET>][%[<END>|+<END_OFFSET>]]
  893. \& <INTERVALS> ::= <INTERVAL>[,<INTERVALS>]
  894. .Ve
  895. .Sp
  896. A few examples follow.
  897. .RS 4
  898. .IP "\(bu" 4
  899. Seek to time 10, read packets until 20 seconds after the found seek
  900. point, then seek to position \f(CW\*(C`01:30\*(C'\fR (1 minute and thirty
  901. seconds) and read packets until position \f(CW\*(C`01:45\*(C'\fR.
  902. .Sp
  903. .Vb 1
  904. \& 10%+20,01:30%01:45
  905. .Ve
  906. .IP "\(bu" 4
  907. Read only 42 packets after seeking to position \f(CW\*(C`01:23\*(C'\fR:
  908. .Sp
  909. .Vb 1
  910. \& 01:23%+#42
  911. .Ve
  912. .IP "\(bu" 4
  913. Read only the first 20 seconds from the start:
  914. .Sp
  915. .Vb 1
  916. \& %+20
  917. .Ve
  918. .IP "\(bu" 4
  919. Read from the start until position \f(CW\*(C`02:30\*(C'\fR:
  920. .Sp
  921. .Vb 1
  922. \& %02:30
  923. .Ve
  924. .RE
  925. .RS 4
  926. .RE
  927. .IP "\fB\-show_private_data, \-private\fR" 4
  928. .IX Item "-show_private_data, -private"
  929. Show private data, that is data depending on the format of the
  930. particular shown element.
  931. This option is enabled by default, but you may need to disable it
  932. for specific uses, for example when creating XSD-compliant \s-1XML\s0 output.
  933. .IP "\fB\-show_program_version\fR" 4
  934. .IX Item "-show_program_version"
  935. Show information related to program version.
  936. .Sp
  937. Version information is printed within a section with name
  938. \&\*(L"\s-1PROGRAM_VERSION\*(R".\s0
  939. .IP "\fB\-show_library_versions\fR" 4
  940. .IX Item "-show_library_versions"
  941. Show information related to library versions.
  942. .Sp
  943. Version information for each library is printed within a section with
  944. name \*(L"\s-1LIBRARY_VERSION\*(R".\s0
  945. .IP "\fB\-show_versions\fR" 4
  946. .IX Item "-show_versions"
  947. Show information related to program and library versions. This is the
  948. equivalent of setting both \fB\-show_program_version\fR and
  949. \&\fB\-show_library_versions\fR options.
  950. .IP "\fB\-show_pixel_formats\fR" 4
  951. .IX Item "-show_pixel_formats"
  952. Show information about all pixel formats supported by FFmpeg.
  953. .Sp
  954. Pixel format information for each format is printed within a section
  955. with name \*(L"\s-1PIXEL_FORMAT\*(R".\s0
  956. .IP "\fB\-bitexact\fR" 4
  957. .IX Item "-bitexact"
  958. Force bitexact output, useful to produce output which is not dependent
  959. on the specific build.
  960. .IP "\fB\-i\fR \fIinput_url\fR" 4
  961. .IX Item "-i input_url"
  962. Read \fIinput_url\fR.
  963. .SH "WRITERS"
  964. .IX Header "WRITERS"
  965. A writer defines the output format adopted by \fBffprobe\fR, and will be
  966. used for printing all the parts of the output.
  967. .PP
  968. A writer may accept one or more arguments, which specify the options
  969. to adopt. The options are specified as a list of \fIkey\fR=\fIvalue\fR
  970. pairs, separated by \*(L":\*(R".
  971. .PP
  972. All writers support the following options:
  973. .IP "\fBstring_validation, sv\fR" 4
  974. .IX Item "string_validation, sv"
  975. Set string validation mode.
  976. .Sp
  977. The following values are accepted.
  978. .RS 4
  979. .IP "\fBfail\fR" 4
  980. .IX Item "fail"
  981. The writer will fail immediately in case an invalid string (\s-1UTF\-8\s0)
  982. sequence or code point is found in the input. This is especially
  983. useful to validate input metadata.
  984. .IP "\fBignore\fR" 4
  985. .IX Item "ignore"
  986. Any validation error will be ignored. This will result in possibly
  987. broken output, especially with the json or xml writer.
  988. .IP "\fBreplace\fR" 4
  989. .IX Item "replace"
  990. The writer will substitute invalid \s-1UTF\-8\s0 sequences or code points with
  991. the string specified with the \fBstring_validation_replacement\fR.
  992. .RE
  993. .RS 4
  994. .Sp
  995. Default value is \fBreplace\fR.
  996. .RE
  997. .IP "\fBstring_validation_replacement, svr\fR" 4
  998. .IX Item "string_validation_replacement, svr"
  999. Set replacement string to use in case \fBstring_validation\fR is
  1000. set to \fBreplace\fR.
  1001. .Sp
  1002. In case the option is not specified, the writer will assume the empty
  1003. string, that is it will remove the invalid sequences from the input
  1004. strings.
  1005. .PP
  1006. A description of the currently available writers follows.
  1007. .SS "default"
  1008. .IX Subsection "default"
  1009. Default format.
  1010. .PP
  1011. Print each section in the form:
  1012. .PP
  1013. .Vb 5
  1014. \& [SECTION]
  1015. \& key1=val1
  1016. \& ...
  1017. \& keyN=valN
  1018. \& [/SECTION]
  1019. .Ve
  1020. .PP
  1021. Metadata tags are printed as a line in the corresponding \s-1FORMAT, STREAM\s0 or
  1022. \&\s-1PROGRAM_STREAM\s0 section, and are prefixed by the string \*(L"\s-1TAG:\*(R".\s0
  1023. .PP
  1024. A description of the accepted options follows.
  1025. .IP "\fBnokey, nk\fR" 4
  1026. .IX Item "nokey, nk"
  1027. If set to 1 specify not to print the key of each field. Default value
  1028. is 0.
  1029. .IP "\fBnoprint_wrappers, nw\fR" 4
  1030. .IX Item "noprint_wrappers, nw"
  1031. If set to 1 specify not to print the section header and footer.
  1032. Default value is 0.
  1033. .SS "compact, csv"
  1034. .IX Subsection "compact, csv"
  1035. Compact and \s-1CSV\s0 format.
  1036. .PP
  1037. The \f(CW\*(C`csv\*(C'\fR writer is equivalent to \f(CW\*(C`compact\*(C'\fR, but supports
  1038. different defaults.
  1039. .PP
  1040. Each section is printed on a single line.
  1041. If no option is specified, the output has the form:
  1042. .PP
  1043. .Vb 1
  1044. \& section|key1=val1| ... |keyN=valN
  1045. .Ve
  1046. .PP
  1047. Metadata tags are printed in the corresponding \*(L"format\*(R" or \*(L"stream\*(R"
  1048. section. A metadata tag key, if printed, is prefixed by the string
  1049. \&\*(L"tag:\*(R".
  1050. .PP
  1051. The description of the accepted options follows.
  1052. .IP "\fBitem_sep, s\fR" 4
  1053. .IX Item "item_sep, s"
  1054. Specify the character to use for separating fields in the output line.
  1055. It must be a single printable character, it is \*(L"|\*(R" by default (\*(L",\*(R" for
  1056. the \f(CW\*(C`csv\*(C'\fR writer).
  1057. .IP "\fBnokey, nk\fR" 4
  1058. .IX Item "nokey, nk"
  1059. If set to 1 specify not to print the key of each field. Its default
  1060. value is 0 (1 for the \f(CW\*(C`csv\*(C'\fR writer).
  1061. .IP "\fBescape, e\fR" 4
  1062. .IX Item "escape, e"
  1063. Set the escape mode to use, default to \*(L"c\*(R" (\*(L"csv\*(R" for the \f(CW\*(C`csv\*(C'\fR
  1064. writer).
  1065. .Sp
  1066. It can assume one of the following values:
  1067. .RS 4
  1068. .IP "\fBc\fR" 4
  1069. .IX Item "c"
  1070. Perform C\-like escaping. Strings containing a newline (\fB\en\fR), carriage
  1071. return (\fB\er\fR), a tab (\fB\et\fR), a form feed (\fB\ef\fR), the escaping
  1072. character (\fB\e\fR) or the item separator character \fI\s-1SEP\s0\fR are escaped
  1073. using C\-like fashioned escaping, so that a newline is converted to the
  1074. sequence \fB\en\fR, a carriage return to \fB\er\fR, \fB\e\fR to \fB\e\e\fR and
  1075. the separator \fI\s-1SEP\s0\fR is converted to \fB\e\fR\fI\s-1SEP\s0\fR.
  1076. .IP "\fBcsv\fR" 4
  1077. .IX Item "csv"
  1078. Perform CSV-like escaping, as described in \s-1RFC4180.\s0 Strings
  1079. containing a newline (\fB\en\fR), a carriage return (\fB\er\fR), a double quote
  1080. (\fB"\fR), or \fI\s-1SEP\s0\fR are enclosed in double-quotes.
  1081. .IP "\fBnone\fR" 4
  1082. .IX Item "none"
  1083. Perform no escaping.
  1084. .RE
  1085. .RS 4
  1086. .RE
  1087. .IP "\fBprint_section, p\fR" 4
  1088. .IX Item "print_section, p"
  1089. Print the section name at the beginning of each line if the value is
  1090. \&\f(CW1\fR, disable it with value set to \f(CW0\fR. Default value is
  1091. \&\f(CW1\fR.
  1092. .SS "flat"
  1093. .IX Subsection "flat"
  1094. Flat format.
  1095. .PP
  1096. A free-form output where each line contains an explicit key=value, such as
  1097. \&\*(L"streams.stream.3.tags.foo=bar\*(R". The output is shell escaped, so it can be
  1098. directly embedded in sh scripts as long as the separator character is an
  1099. alphanumeric character or an underscore (see \fIsep_char\fR option).
  1100. .PP
  1101. The description of the accepted options follows.
  1102. .IP "\fBsep_char, s\fR" 4
  1103. .IX Item "sep_char, s"
  1104. Separator character used to separate the chapter, the section name, IDs and
  1105. potential tags in the printed field key.
  1106. .Sp
  1107. Default value is \fB.\fR.
  1108. .IP "\fBhierarchical, h\fR" 4
  1109. .IX Item "hierarchical, h"
  1110. Specify if the section name specification should be hierarchical. If
  1111. set to 1, and if there is more than one section in the current
  1112. chapter, the section name will be prefixed by the name of the
  1113. chapter. A value of 0 will disable this behavior.
  1114. .Sp
  1115. Default value is 1.
  1116. .SS "ini"
  1117. .IX Subsection "ini"
  1118. \&\s-1INI\s0 format output.
  1119. .PP
  1120. Print output in an \s-1INI\s0 based format.
  1121. .PP
  1122. The following conventions are adopted:
  1123. .IP "\(bu" 4
  1124. all key and values are \s-1UTF\-8\s0
  1125. .IP "\(bu" 4
  1126. \&\fB.\fR is the subgroup separator
  1127. .IP "\(bu" 4
  1128. newline, \fB\et\fR, \fB\ef\fR, \fB\eb\fR and the following characters are
  1129. escaped
  1130. .IP "\(bu" 4
  1131. \&\fB\e\fR is the escape character
  1132. .IP "\(bu" 4
  1133. \&\fB#\fR is the comment indicator
  1134. .IP "\(bu" 4
  1135. \&\fB=\fR is the key/value separator
  1136. .IP "\(bu" 4
  1137. \&\fB:\fR is not used but usually parsed as key/value separator
  1138. .PP
  1139. This writer accepts options as a list of \fIkey\fR=\fIvalue\fR pairs,
  1140. separated by \fB:\fR.
  1141. .PP
  1142. The description of the accepted options follows.
  1143. .IP "\fBhierarchical, h\fR" 4
  1144. .IX Item "hierarchical, h"
  1145. Specify if the section name specification should be hierarchical. If
  1146. set to 1, and if there is more than one section in the current
  1147. chapter, the section name will be prefixed by the name of the
  1148. chapter. A value of 0 will disable this behavior.
  1149. .Sp
  1150. Default value is 1.
  1151. .SS "json"
  1152. .IX Subsection "json"
  1153. \&\s-1JSON\s0 based format.
  1154. .PP
  1155. Each section is printed using \s-1JSON\s0 notation.
  1156. .PP
  1157. The description of the accepted options follows.
  1158. .IP "\fBcompact, c\fR" 4
  1159. .IX Item "compact, c"
  1160. If set to 1 enable compact output, that is each section will be
  1161. printed on a single line. Default value is 0.
  1162. .PP
  1163. For more information about \s-1JSON,\s0 see <\fBhttp://www.json.org/\fR>.
  1164. .SS "xml"
  1165. .IX Subsection "xml"
  1166. \&\s-1XML\s0 based format.
  1167. .PP
  1168. The \s-1XML\s0 output is described in the \s-1XML\s0 schema description file
  1169. \&\fIffprobe.xsd\fR installed in the FFmpeg datadir.
  1170. .PP
  1171. An updated version of the schema can be retrieved at the url
  1172. <\fBhttp://www.ffmpeg.org/schema/ffprobe.xsd\fR>, which redirects to the
  1173. latest schema committed into the FFmpeg development source code tree.
  1174. .PP
  1175. Note that the output issued will be compliant to the
  1176. \&\fIffprobe.xsd\fR schema only when no special global output options
  1177. (\fBunit\fR, \fBprefix\fR, \fBbyte_binary_prefix\fR,
  1178. \&\fBsexagesimal\fR etc.) are specified.
  1179. .PP
  1180. The description of the accepted options follows.
  1181. .IP "\fBfully_qualified, q\fR" 4
  1182. .IX Item "fully_qualified, q"
  1183. If set to 1 specify if the output should be fully qualified. Default
  1184. value is 0.
  1185. This is required for generating an \s-1XML\s0 file which can be validated
  1186. through an \s-1XSD\s0 file.
  1187. .IP "\fBxsd_strict, x\fR" 4
  1188. .IX Item "xsd_strict, x"
  1189. If set to 1 perform more checks for ensuring that the output is \s-1XSD\s0
  1190. compliant. Default value is 0.
  1191. This option automatically sets \fBfully_qualified\fR to 1.
  1192. .PP
  1193. For more information about the \s-1XML\s0 format, see
  1194. <\fBhttps://www.w3.org/XML/\fR>.
  1195. .SH "TIMECODE"
  1196. .IX Header "TIMECODE"
  1197. \&\fBffprobe\fR supports Timecode extraction:
  1198. .IP "\(bu" 4
  1199. \&\s-1MPEG1/2\s0 timecode is extracted from the \s-1GOP,\s0 and is available in the video
  1200. stream details (\fB\-show_streams\fR, see \fItimecode\fR).
  1201. .IP "\(bu" 4
  1202. \&\s-1MOV\s0 timecode is extracted from tmcd track, so is available in the tmcd
  1203. stream metadata (\fB\-show_streams\fR, see \fITAG:timecode\fR).
  1204. .IP "\(bu" 4
  1205. \&\s-1DV, GXF\s0 and \s-1AVI\s0 timecodes are available in format metadata
  1206. (\fB\-show_format\fR, see \fITAG:timecode\fR).
  1207. .SH "SEE ALSO"
  1208. .IX Header "SEE ALSO"
  1209. \&\fBffprobe\-all\fR\|(1),
  1210. \&\fBffmpeg\fR\|(1), \fBffplay\fR\|(1),
  1211. \&\fBffmpeg\-utils\fR\|(1), \fBffmpeg\-scaler\fR\|(1), \fBffmpeg\-resampler\fR\|(1),
  1212. \&\fBffmpeg\-codecs\fR\|(1), \fBffmpeg\-bitstream\-filters\fR\|(1), \fBffmpeg\-formats\fR\|(1),
  1213. \&\fBffmpeg\-devices\fR\|(1), \fBffmpeg\-protocols\fR\|(1), \fBffmpeg\-filters\fR\|(1)
  1214. .SH "AUTHORS"
  1215. .IX Header "AUTHORS"
  1216. The FFmpeg developers.
  1217. .PP
  1218. For details about the authorship, see the Git history of the project
  1219. (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
  1220. \&\fBgit log\fR in the FFmpeg source directory, or browsing the
  1221. online repository at <\fBhttps://git.ffmpeg.org/ffmpeg\fR>.
  1222. .PP
  1223. Maintainers for the specific components are listed in the file
  1224. \&\fI\s-1MAINTAINERS\s0\fR in the source code tree.