doc/ffplay-doc.texi

   1 \input texinfo @c -*- texinfo -*-
   2
   3 @settitle FFplay Documentation
   4 @titlepage
   5 @sp 7
   6 @center @titlefont{FFplay Documentation}
   7 @sp 3
   8 @end titlepage
   9
  10
  11 @chapter Introduction
  12
  13 @c man begin DESCRIPTION
  14 FFplay is a very simple and portable media player using the FFmpeg
  15 libraries and the SDL library. It is mostly used as a testbed for the
  16 various FFmpeg APIs.
  17 @c man end
  18
  19 @chapter Invocation
  20
  21 @section Syntax
  22 @example
  23 @c man begin SYNOPSIS
  24 ffplay [options] @file{input_file}
  25 @c man end
  26 @end example
  27
  28 @c man begin OPTIONS
  29 @section Main options
  30
  31 @table @option
  32 @item -h
  33 Show help.
  34 @item -version
  35 Show version.
  36 @item -L
  37 Show license.
  38 @item -formats
  39 Show available formats.
  40 @item -codecs
  41 Show available codecs.
  42 @item -bsfs
  43 Show available bitstream filters.
  44 @item -protocols
  45 Show available protocols.
  46 @item -filters
  47 Show available libavfilter filters.
  48 @item -x @var{width}
  49 Force displayed width.
  50 @item -y @var{height}
  51 Force displayed height.
  52 @item -s @var{size}
  53 Set frame size (WxH or abbreviation), needed for videos which don't
  54 contain a header with the frame size like raw YUV.
  55 @item -an
  56 Disable audio.
  57 @item -vn
  58 Disable video.
  59 @item -ss @var{pos}
  60 Seek to a given position in seconds.
  61 @item -bytes
  62 Seek by bytes.
  63 @item -nodisp
  64 Disable graphical display.
  65 @item -f @var{fmt}
  66 Force format.
  67 @item -loglevel @var{loglevel}
  68 Set the logging level used by the library.
  69 @var{loglevel} is a number or a string containing one of the following values:
  70 @table @samp
  71 @item quiet
  72 @item panic
  73 @item fatal
  74 @item error
  75 @item warning
  76 @item info
  77 @item verbose
  78 @item debug
  79 @end table
  80 @end table
  81
  82 @section Advanced options
  83 @table @option
  84 @item -pix_fmt @var{format}
  85 Set pixel format.
  86 @item -stats
  87 Show the stream duration, the codec parameters, the current position in
  88 the stream and the audio/video synchronisation drift.
  89 @item -debug
  90 Print specific debug info.
  91 @item -bug
  92 Work around bugs.
  93 @item -vismv
  94 Visualize motion vectors.
  95 @item -fast
  96 Non-spec-compliant optimizations.
  97 @item -genpts
  98 Generate pts.
  99 @item -rtp_tcp
 100 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
 101 if you are streaming with the RTSP protocol.
 102 @item -sync @var{type}
 103 Set the master clock to audio (@code{type=audio}), video
 104 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
 105 master clock is used to control audio-video synchronization. Most media
 106 players use audio as master clock, but in some cases (streaming or high
 107 quality broadcast) it is necessary to change that. This option is mainly
 108 used for debugging purposes.
 109 @item -threads @var{count}
 110 Set the thread count.
 111 @item -ast @var{audio_stream_number}
 112 Select the desired audio stream number, counting from 0. The number
 113 refers to the list of all the input audio streams. If it is greater
 114 than the number of audio streams minus one, then the last one is
 115 selected, if it is negative the audio playback is disabled.
 116 @item -vst @var{video_stream_number}
 117 Select the desired video stream number, counting from 0. The number
 118 refers to the list of all the input video streams. If it is greater
 119 than the number of video streams minus one, then the last one is
 120 selected, if it is negative the video playback is disabled.
 121 @item -sst @var{subtitle_stream_number}
 122 Select the desired subtitle stream number, counting from 0. The number
 123 refers to the list of all the input subtitle streams. If it is greater
 124 than the number of subtitle streams minus one, then the last one is
 125 selected, if it is negative the subtitle rendering is disabled.
 126 @end table
 127
 128 @section While playing
 129
 130 @table @key
 131 @item q, ESC
 132 Quit.
 133
 134 @item f
 135 Toggle full screen.
 136
 137 @item p, SPC
 138 Pause.
 139
 140 @item a
 141 Cycle audio channel.
 142
 143 @item v
 144 Cycle video channel.
 145
 146 @item t
 147 Cycle subtitle channel.
 148
 149 @item w
 150 Show audio waves.
 151
 152 @item left/right
 153 Seek backward/forward 10 seconds.
 154
 155 @item down/up
 156 Seek backward/forward 1 minute.
 157
 158 @item mouse click
 159 Seek to percentage in file corresponding to fraction of width.
 160
 161 @end table
 162
 163 @c man end
 164
 165 @ignore
 166
 167 @setfilename ffplay
 168 @settitle FFplay media player
 169
 170 @c man begin SEEALSO
 171 ffmpeg(1), ffserver(1) and the HTML documentation of @file{ffmpeg}.
 172 @c man end
 173
 174 @c man begin AUTHOR
 175 Fabrice Bellard
 176 @c man end
 177
 178 @end ignore
 179
 180 @bye