You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

122 lines
2.7KB

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