doc/avprobe.texi

   1 \input texinfo @c -*- texinfo -*-
   2
   3 @settitle avprobe Documentation
   4 @titlepage
   5 @center @titlefont{avprobe 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 avprobe [options] [@file{input_file}]
  19 @c man end
  20 @end example
  21
  22 @chapter Description
  23 @c man begin DESCRIPTION
  24
  25 avprobe 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, avprobe 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 avprobe 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 avprobe or
  41 for specifying which information to display, and for setting how
  42 avprobe will show it.
  43
  44 avprobe output is designed to be easily parsable by a textual filter,
  45 and consists of one or more sections of the form:
  46 @example
  47 [SECTION]
  48 key1=val1
  49 ...
  50 keyN=valN
  51 [/SECTION]
  52 @end example
  53
  54 Metadata tags stored in the container or in the streams are recognized
  55 and printed in the corresponding "FORMAT" or "STREAM" section, and
  56 are prefixed by the string "TAG:".
  57
  58 @c man end
  59
  60 @chapter Options
  61 @c man begin OPTIONS
  62
  63 @include avtools-common-opts.texi
  64
  65 @section Main options
  66
  67 @table @option
  68
  69 @item -f @var{format}
  70 Force format to use.
  71
  72 @item -unit
  73 Show the unit of the displayed values.
  74
  75 @item -prefix
  76 Use SI prefixes for the displayed values.
  77 Unless the "-byte_binary_prefix" option is used all the prefixes
  78 are decimal.
  79
  80 @item -byte_binary_prefix
  81 Force the use of binary prefixes for byte values.
  82
  83 @item -sexagesimal
  84 Use sexagesimal format HH:MM:SS.MICROSECONDS for time values.
  85
  86 @item -pretty
  87 Prettify the format of the displayed values, it corresponds to the
  88 options "-unit -prefix -byte_binary_prefix -sexagesimal".
  89
  90 @item -show_format
  91 Show information about the container format of the input multimedia
  92 stream.
  93
  94 All the container format information is printed within a section with
  95 name "FORMAT".
  96
  97 @item -show_format_entry @var{name}
  98 Like @option{-show_format}, but only prints the specified entry of the
  99 container format information, rather than all. This option may be given more
 100 than once, then all specified entries will be shown.
 101
 102 @item -show_packets
 103 Show information about each packet contained in the input multimedia
 104 stream.
 105
 106 The information for each single packet is printed within a dedicated
 107 section with name "PACKET".
 108
 109 @item -show_streams
 110 Show information about each media stream contained in the input
 111 multimedia stream.
 112
 113 Each media stream information is printed within a dedicated section
 114 with name "STREAM".
 115
 116 @end table
 117 @c man end
 118
 119 @include demuxers.texi
 120 @include muxers.texi
 121 @include protocols.texi
 122 @include indevs.texi
 123
 124 @ignore
 125
 126 @setfilename avprobe
 127 @settitle avprobe media prober
 128
 129 @c man begin SEEALSO
 130 avconv(1), avplay(1) and the Libav HTML documentation
 131 @c man end
 132
 133 @c man begin AUTHORS
 134 The Libav developers
 135 @c man end
 136
 137 @end ignore
 138
 139 @bye