doc/ffplay.texi

   1 \input texinfo @c -*- texinfo -*-
   2
   3 @settitle ffplay Documentation
   4 @titlepage
   5 @center @titlefont{ffplay Documentation}
   6 @end titlepage
   7
   8 @top
   9
  10 @contents
  11
  12 @chapter Synopsis
  13
  14 @example
  15 @c man begin SYNOPSIS
  16 ffplay [options] [@file{input_file}]
  17 @c man end
  18 @end example
  19
  20 @chapter Description
  21 @c man begin DESCRIPTION
  22
  23 FFplay is a very simple and portable media player using the FFmpeg
  24 libraries and the SDL library. It is mostly used as a testbed for the
  25 various FFmpeg APIs.
  26 @c man end
  27
  28 @chapter Options
  29 @c man begin OPTIONS
  30
  31 @include fftools-common-opts.texi
  32
  33 @section Main options
  34
  35 @table @option
  36 @item -x @var{width}
  37 Force displayed width.
  38 @item -y @var{height}
  39 Force displayed height.
  40 @item -s @var{size}
  41 This option has been removed. Use private format options for specifying the
  42 input video size.
  43 @item -an
  44 Disable audio.
  45 @item -vn
  46 Disable video.
  47 @item -ss @var{pos}
  48 Seek to a given position in seconds.
  49 @item -t @var{duration}
  50 play <duration> seconds of audio/video
  51 @item -bytes
  52 Seek by bytes.
  53 @item -nodisp
  54 Disable graphical display.
  55 @item -f @var{fmt}
  56 Force format.
  57 @item -window_title @var{title}
  58 Set window title (default is the input filename).
  59 @item -loop @var{number}
  60 Loops movie playback <number> times. 0 means forever.
  61 @item -showmode @var{mode}
  62 Set the show mode to use.
  63 Available values for @var{mode} are:
  64 @table @samp
  65 @item 0, video
  66 show video
  67 @item 1, waves
  68 show audio waves
  69 @item 2, rdft
  70 show audio frequency band using RDFT ((Inverse) Real Discrete Fourier Transform)
  71 @end table
  72
  73 Default value is "video", if video is not present or cannot be played
  74 "rdft" is automatically selected.
  75
  76 You can interactively cycle through the available show modes by
  77 pressing the key @key{w}.
  78
  79 @item -vf @var{filter_graph}
  80 @var{filter_graph} is a description of the filter graph to apply to
  81 the input video.
  82 Use the option "-filters" to show all the available filters (including
  83 also sources and sinks).
  84
  85 @item -i @var{input_file}
  86 Read @var{input_file}.
  87 @end table
  88
  89 @section Advanced options
  90 @table @option
  91 @item -pix_fmt @var{format}
  92 This option has been removed. Use private options for specifying the
  93 input pixel format.
  94 @item -stats
  95 Show the stream duration, the codec parameters, the current position in
  96 the stream and the audio/video synchronisation drift.
  97 @item -bug
  98 Work around bugs.
  99 @item -fast
 100 Non-spec-compliant optimizations.
 101 @item -genpts
 102 Generate pts.
 103 @item -rtp_tcp
 104 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
 105 if you are streaming with the RTSP protocol.
 106 @item -sync @var{type}
 107 Set the master clock to audio (@code{type=audio}), video
 108 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
 109 master clock is used to control audio-video synchronization. Most media
 110 players use audio as master clock, but in some cases (streaming or high
 111 quality broadcast) it is necessary to change that. This option is mainly
 112 used for debugging purposes.
 113 @item -threads @var{count}
 114 Set the thread count.
 115 @item -ast @var{audio_stream_number}
 116 Select the desired audio stream number, counting from 0. The number
 117 refers to the list of all the input audio streams. If it is greater
 118 than the number of audio streams minus one, then the last one is
 119 selected, if it is negative the audio playback is disabled.
 120 @item -vst @var{video_stream_number}
 121 Select the desired video stream number, counting from 0. The number
 122 refers to the list of all the input video streams. If it is greater
 123 than the number of video streams minus one, then the last one is
 124 selected, if it is negative the video playback is disabled.
 125 @item -sst @var{subtitle_stream_number}
 126 Select the desired subtitle stream number, counting from 0. The number
 127 refers to the list of all the input subtitle streams. If it is greater
 128 than the number of subtitle streams minus one, then the last one is
 129 selected, if it is negative the subtitle rendering is disabled.
 130 @item -autoexit
 131 Exit when video is done playing.
 132 @item -exitonkeydown
 133 Exit if any key is pressed.
 134 @item -exitonmousedown
 135 Exit if any mouse button is pressed.
 136 @end table
 137
 138 @section While playing
 139
 140 @table @key
 141 @item q, ESC
 142 Quit.
 143
 144 @item f
 145 Toggle full screen.
 146
 147 @item p, SPC
 148 Pause.
 149
 150 @item a
 151 Cycle audio channel.
 152
 153 @item v
 154 Cycle video channel.
 155
 156 @item t
 157 Cycle subtitle channel.
 158
 159 @item w
 160 Show audio waves.
 161
 162 @item left/right
 163 Seek backward/forward 10 seconds.
 164
 165 @item down/up
 166 Seek backward/forward 1 minute.
 167
 168 @item mouse click
 169 Seek to percentage in file corresponding to fraction of width.
 170
 171 @end table
 172
 173 @c man end
 174
 175 @include eval.texi
 176 @include decoders.texi
 177 @include demuxers.texi
 178 @include muxers.texi
 179 @include indevs.texi
 180 @include outdevs.texi
 181 @include protocols.texi
 182 @include filters.texi
 183
 184 @ignore
 185
 186 @setfilename ffplay
 187 @settitle FFplay media player
 188
 189 @c man begin SEEALSO
 190 ffmpeg(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
 191 @c man end
 192
 193 @c man begin AUTHORS
 194 The FFmpeg developers
 195 @c man end
 196
 197 @end ignore
 198
 199 @bye