git.sesse.net Git - ffmpeg/blob - doc/ffprobe.texi

   1 \input texinfo @c -*- texinfo -*-
   2
   3 @settitle ffprobe Documentation
   4 @titlepage
   5 @center @titlefont{ffprobe Documentation}
   6 @end titlepage
   7
   8 @top
   9
  10 @contents
  11
  12 @chapter Synopsis
  13
  14 The generic syntax is:
  15
  16 @example
  17 @c man begin SYNOPSIS
  18 ffprobe [options] [@file{input_file}]
  19 @c man end
  20 @end example
  21
  22 @chapter Description
  23 @c man begin DESCRIPTION
  24
  25 ffprobe gathers information from multimedia streams and prints it in
  26 human- and machine-readable fashion.
  27
  28 For example it can be used to check the format of the container used
  29 by a multimedia stream and the format and type of each media stream
  30 contained in it.
  31
  32 If a filename is specified in input, ffprobe will try to open and
  33 probe the file content. If the file cannot be opened or recognized as
  34 a multimedia file, a positive exit code is returned.
  35
  36 ffprobe may be employed both as a standalone application or in
  37 combination with a textual filter, which may perform more
  38 sophisticated processing, e.g. statistical processing or plotting.
  39
  40 Options are used to list some of the formats supported by ffprobe or
  41 for specifying which information to display, and for setting how
  42 ffprobe will show it.
  43
  44 ffprobe output is designed to be easily parsable by a textual filter,
  45 and consists of one or more sections of a form defined by the selected
  46 writer, which is specified by the @option{print_format} option.
  47
  48 Metadata tags stored in the container or in the streams are recognized
  49 and printed in the corresponding "FORMAT" or "STREAM" section.
  50
  51 @c man end
  52
  53 @chapter Options
  54 @c man begin OPTIONS
  55
  56 @include avtools-common-opts.texi
  57
  58 @section Main options
  59
  60 @table @option
  61
  62 @item -f @var{format}
  63 Force format to use.
  64
  65 @item -unit
  66 Show the unit of the displayed values.
  67
  68 @item -prefix
  69 Use SI prefixes for the displayed values.
  70 Unless the "-byte_binary_prefix" option is used all the prefixes
  71 are decimal.
  72
  73 @item -byte_binary_prefix
  74 Force the use of binary prefixes for byte values.
  75
  76 @item -sexagesimal
  77 Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
  78
  79 @item -pretty
  80 Prettify the format of the displayed values, it corresponds to the
  81 options "-unit -prefix -byte_binary_prefix -sexagesimal".
  82
  83 @item -print_format @var{writer_name}[=@var{writer_options}]
  84 Set the output printing format.
  85
  86 @var{writer_name} specifies the name of the writer, and
  87 @var{writer_options} specifies the options to be passed to the writer.
  88
  89 For example for printing the output in JSON format, specify:
  90 @example
  91 -print_format json
  92 @end example
  93
  94 For more details on the available output printing formats, see the
  95 Writers section below.
  96
  97 @item -show_format
  98 Show information about the container format of the input multimedia
  99 stream.
 100
 101 All the container format information is printed within a section with
 102 name "FORMAT".
 103
 104 @item -show_packets
 105 Show information about each packet contained in the input multimedia
 106 stream.
 107
 108 The information for each single packet is printed within a dedicated
 109 section with name "PACKET".
 110
 111 @item -show_streams
 112 Show information about each media stream contained in the input
 113 multimedia stream.
 114
 115 Each media stream information is printed within a dedicated section
 116 with name "STREAM".
 117
 118 @item -i @var{input_file}
 119 Read @var{input_file}.
 120
 121 @end table
 122 @c man end
 123
 124 @chapter Writers
 125 @c man begin WRITERS
 126
 127 A writer defines the output format adopted by @file{ffprobe}, and will be
 128 used for printing all the parts of the output.
 129
 130 A writer may accept one or more arguments, which specify the options to
 131 adopt.
 132
 133 A description of the currently available writers follows.
 134
 135 @section default
 136 Default format.
 137
 138 Print each section in the form:
 139 @example
 140 [SECTION]
 141 key1=val1
 142 ...
 143 keyN=valN
 144 [/SECTION]
 145 @end example
 146
 147 Metadata tags are printed as a line in the corresponding FORMAT or
 148 STREAM section, and are prefixed by the string "TAG:".
 149
 150 @section json
 151 JSON based format.
 152
 153 Each section is printed using JSON notation.
 154
 155 For more information about JSON, see @url{http://www.json.org/}.
 156
 157 @c man end WRITERS
 158
 159 @include decoders.texi
 160 @include demuxers.texi
 161 @include protocols.texi
 162 @include indevs.texi
 163
 164 @ignore
 165
 166 @setfilename ffprobe
 167 @settitle ffprobe media prober
 168
 169 @c man begin SEEALSO
 170 ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
 171 @c man end
 172
 173 @c man begin AUTHORS
 174 The FFmpeg developers
 175 @c man end
 176
 177 @end ignore
 178
 179 @bye