doc/ffprobe.texi

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