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 @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 Set frame size (WxH or abbreviation), needed for videos which don't
  42 contain a header with the frame size like raw YUV.
  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 Set pixel format.
  93 @item -stats
  94 Show the stream duration, the codec parameters, the current position in
  95 the stream and the audio/video synchronisation drift.
  96 @item -bug
  97 Work around bugs.
  98 @item -fast
  99 Non-spec-compliant optimizations.
 100 @item -genpts
 101 Generate pts.
 102 @item -rtp_tcp
 103 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
 104 if you are streaming with the RTSP protocol.
 105 @item -sync @var{type}
 106 Set the master clock to audio (@code{type=audio}), video
 107 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
 108 master clock is used to control audio-video synchronization. Most media
 109 players use audio as master clock, but in some cases (streaming or high
 110 quality broadcast) it is necessary to change that. This option is mainly
 111 used for debugging purposes.
 112 @item -threads @var{count}
 113 Set the thread count.
 114 @item -ast @var{audio_stream_number}
 115 Select the desired audio stream number, counting from 0. The number
 116 refers to the list of all the input audio streams. If it is greater
 117 than the number of audio streams minus one, then the last one is
 118 selected, if it is negative the audio playback is disabled.
 119 @item -vst @var{video_stream_number}
 120 Select the desired video stream number, counting from 0. The number
 121 refers to the list of all the input video streams. If it is greater
 122 than the number of video streams minus one, then the last one is
 123 selected, if it is negative the video playback is disabled.
 124 @item -sst @var{subtitle_stream_number}
 125 Select the desired subtitle stream number, counting from 0. The number
 126 refers to the list of all the input subtitle streams. If it is greater
 127 than the number of subtitle streams minus one, then the last one is
 128 selected, if it is negative the subtitle rendering is disabled.
 129 @item -autoexit
 130 Exit when video is done playing.
 131 @item -exitonkeydown
 132 Exit if any key is pressed.
 133 @item -exitonmousedown
 134 Exit if any mouse button is pressed.
 135 @end table
 136
 137 @section While playing
 138
 139 @table @key
 140 @item q, ESC
 141 Quit.
 142
 143 @item f
 144 Toggle full screen.
 145
 146 @item p, SPC
 147 Pause.
 148
 149 @item a
 150 Cycle audio channel.
 151
 152 @item v
 153 Cycle video channel.
 154
 155 @item t
 156 Cycle subtitle channel.
 157
 158 @item w
 159 Show audio waves.
 160
 161 @item left/right
 162 Seek backward/forward 10 seconds.
 163
 164 @item down/up
 165 Seek backward/forward 1 minute.
 166
 167 @item mouse click
 168 Seek to percentage in file corresponding to fraction of width.
 169
 170 @end table
 171
 172 @c man end
 173
 174 @include eval.texi
 175 @include decoders.texi
 176 @include demuxers.texi
 177 @include muxers.texi
 178 @include indevs.texi
 179 @include outdevs.texi
 180 @include protocols.texi
 181 @include filters.texi
 182
 183 @ignore
 184
 185 @setfilename ffplay
 186 @settitle FFplay media player
 187
 188 @c man begin SEEALSO
 189 ffmpeg(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
 190 @c man end
 191
 192 @c man begin AUTHORS
 193 The FFmpeg developers
 194 @c man end
 195
 196 @end ignore
 197
 198 @bye