ffprobe.texi 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. \input texinfo @c -*- texinfo -*-
  2. @settitle ffprobe Documentation
  3. @titlepage
  4. @center @titlefont{ffprobe Documentation}
  5. @end titlepage
  6. @top
  7. @contents
  8. @chapter Synopsis
  9. The generic syntax is:
  10. @example
  11. @c man begin SYNOPSIS
  12. ffprobe [options] [@file{input_file}]
  13. @c man end
  14. @end example
  15. @chapter Description
  16. @c man begin DESCRIPTION
  17. ffprobe gathers information from multimedia streams and prints it in
  18. human- and machine-readable fashion.
  19. For example it can be used to check the format of the container used
  20. by a multimedia stream and the format and type of each media stream
  21. contained in it.
  22. If a filename is specified in input, ffprobe will try to open and
  23. probe the file content. If the file cannot be opened or recognized as
  24. a multimedia file, a positive exit code is returned.
  25. ffprobe may be employed both as a standalone application or in
  26. combination with a textual filter, which may perform more
  27. sophisticated processing, e.g. statistical processing or plotting.
  28. Options are used to list some of the formats supported by ffprobe or
  29. for specifying which information to display, and for setting how
  30. ffprobe will show it.
  31. ffprobe output is designed to be easily parsable by a textual filter,
  32. and consists of one or more sections of the form:
  33. @example
  34. [SECTION]
  35. key1=val1
  36. ...
  37. keyN=valN
  38. [/SECTION]
  39. @end example
  40. Metadata tags stored in the container or in the streams are recognized
  41. and printed in the corresponding "FORMAT" or "STREAM" section, and
  42. are prefixed by the string "TAG:".
  43. @c man end
  44. @chapter Options
  45. @c man begin OPTIONS
  46. @include fftools-common-opts.texi
  47. @section Main options
  48. @table @option
  49. @item -f @var{format}
  50. Force format to use.
  51. @item -unit
  52. Show the unit of the displayed values.
  53. @item -prefix
  54. Use SI prefixes for the displayed values.
  55. Unless the "-byte_binary_prefix" option is used all the prefixes
  56. are decimal.
  57. @item -byte_binary_prefix
  58. Force the use of binary prefixes for byte values.
  59. @item -sexagesimal
  60. Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
  61. @item -pretty
  62. Prettify the format of the displayed values, it corresponds to the
  63. options "-unit -prefix -byte_binary_prefix -sexagesimal".
  64. @item -show_format
  65. Show information about the container format of the input multimedia
  66. stream.
  67. All the container format information is printed within a section with
  68. name "FORMAT".
  69. @item -show_packets
  70. Show information about each packet contained in the input multimedia
  71. stream.
  72. The information for each single packet is printed within a dedicated
  73. section with name "PACKET".
  74. @item -show_streams
  75. Show information about each media stream contained in the input
  76. multimedia stream.
  77. Each media stream information is printed within a dedicated section
  78. with name "STREAM".
  79. @item -i @var{input_file}
  80. Read @var{input_file}.
  81. @end table
  82. @c man end
  83. @include decoders.texi
  84. @include demuxers.texi
  85. @include protocols.texi
  86. @include indevs.texi
  87. @ignore
  88. @setfilename ffprobe
  89. @settitle ffprobe media prober
  90. @c man begin SEEALSO
  91. ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
  92. @c man end
  93. @c man begin AUTHORS
  94. The FFmpeg developers
  95. @c man end
  96. @end ignore
  97. @bye