git.sesse.net Git - ffmpeg/blob - doc/ffprobe-doc.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 Introduction
  11
  12 @c man begin DESCRIPTION
  13
  14 FFprobe gathers information from multimedia streams and prints it in
  15 human- and machine-readable fashion.
  16
  17 For example it can be used to check the format of the container used
  18 by a multimedia stream and the format and type of each media stream
  19 contained in it.
  20
  21 If a filename is specified in input, ffprobe will try to open and
  22 probe the file content. If the file cannot be opened or recognized as
  23 a multimedia file, a positive exit code is returned.
  24
  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
  29 Options are used to list some of the formats supported by ffprobe or
  30 for specifying which information to display, and for setting how
  31 ffprobe will show it.
  32
  33 FFprobe output is designed to be easily parsable by a textual filter,
  34 and consists of one or more sections of the form:
  35 @example
  36 [SECTION]
  37 key1=val1
  38 ...
  39 keyN=valN
  40 [/SECTION]
  41 @end example
  42
  43 Metadata tags stored in the container or in the streams are recognized
  44 and printed in the corresponding ``FORMAT'' or ``STREAM'' section, and
  45 are prefixed by the string ``TAG:''.
  46
  47 @c man end
  48
  49 @chapter Invocation
  50
  51 @section Syntax
  52
  53 The generic syntax is:
  54
  55 @example
  56 @c man begin SYNOPSIS
  57 ffprobe [options] [@file{input_file}]
  58 @c man end
  59 @end example
  60
  61 @c man begin OPTIONS
  62
  63 @include fftools-common-opts.texi
  64
  65 @section Main options
  66
  67 @table @option
  68
  69 @item -convert_tags
  70 Convert the tag names in the format container to the generic FFmpeg tag names.
  71
  72 @item -f @var{format}
  73 Force format to use.
  74
  75 @item -unit
  76 Show the unit of the displayed values.
  77
  78 @item -prefix
  79 Show a SI prefixes of the displayed values.
  80 Unless ``-byte_binary_prefix'' option is used all the prefix
  81 are decimal.
  82
  83 @item -byte_binary_prefix
  84 Force the use of binary prefixes for byte values.
  85
  86 @item -sexagesimal
  87 Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
  88
  89 @item -pretty
  90 Prettify the format of the displayed values, it corresponds to the
  91 options ``-unit -prefix -byte_binary_prefix -sexagesimal''.
  92
  93 @item -show_format
  94 Show information about the container format of the input multimedia
  95 stream.
  96
  97 All the container format information is printed within a section with
  98 name ``FORMAT''.
  99
 100 @item -show_streams
 101 Show information about each media stream contained in the input
 102 multimedia stream.
 103
 104 Each media stream information is printed within a dedicated section
 105 with name ``STREAM''.
 106
 107 @end table
 108 @c man end
 109
 110 @ignore
 111
 112 @setfilename ffprobe
 113 @settitle FFprobe media prober
 114
 115 @c man begin SEEALSO
 116 ffmpeg(1), ffplay(1), ffserver(1)
 117 @c man end
 118
 119 @end ignore
 120
 121 @bye