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