ffplay.texi 7.25 KB
Newer Older
1 2
\input texinfo @c -*- texinfo -*-

3
@settitle ffplay Documentation
4
@titlepage
5
@center @titlefont{ffplay Documentation}
6 7
@end titlepage

8 9 10 11
@top

@contents

12 13
@chapter Synopsis

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
Diego Biurrun's avatar
Diego Biurrun committed
20
libraries and the SDL library. It is mostly used as a testbed for the
21
various FFmpeg APIs.
22 23
@c man end

24
@chapter Options
25
@c man begin OPTIONS
26

27
@include fftools-common-opts.texi
28

29 30 31
@section Main options

@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 38 39
Set frame size (WxH or abbreviation), needed for videos which do
not contain a header with the frame size like raw YUV.  This option
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 47
@item -t @var{duration}
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 55
@item -window_title @var{title}
Set window title (default is the input filename).
56 57
@item -loop @var{number}
Loops movie playback <number> times. 0 means forever.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
@item -showmode @var{mode}
Set the show mode to use.
Available values for @var{mode} are:
@table @samp
@item 0, video
show video
@item 1, waves
show audio waves
@item 2, rdft
show audio frequency band using RDFT ((Inverse) Real Discrete Fourier Transform)
@end table

Default value is "video", if video is not present or cannot be played
"rdft" is automatically selected.

You can interactively cycle through the available show modes by
pressing the key @key{w}.

76 77
@item -vf @var{filtergraph}
Create the filtergraph specified by @var{filtergraph} and use it to
78 79
filter the video stream.

80
@var{filtergraph} is a description of the filtergraph to apply to
81
the stream, and must have a single video input and a single video
82
output. In the filtergraph, the input is associated to the label
83 84 85
@code{in}, and the output to the label @code{out}. See the
ffmpeg-filters manual for more information about the filtergraph
syntax.
86

87 88
@item -af @var{filtergraph}
@var{filtergraph} is a description of the filtergraph to apply to
Marton Balint's avatar
Marton Balint committed
89 90 91 92
the input audio.
Use the option "-filters" to show all the available filters (including
sources and sinks).

93 94
@item -i @var{input_file}
Read @var{input_file}.
95
@end table
96 97 98

@section Advanced options
@table @option
99
@item -pix_fmt @var{format}
100 101
Set pixel format.
This option has been deprecated in favor of private options, try -pixel_format.
102

103
@item -stats
104 105 106 107 108
Print several playback statistics, in particular show the stream
duration, the codec parameters, the current position in the stream and
the audio/video synchronisation drift. It is on by default, to
explicitly disable it you need to specify @code{-nostats}.

109
@item -bug
110
Work around bugs.
111
@item -fast
112
Non-spec-compliant optimizations.
113
@item -genpts
114
Generate pts.
115
@item -rtp_tcp
Diego Biurrun's avatar
Diego Biurrun committed
116 117
Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
if you are streaming with the RTSP protocol.
118
@item -sync @var{type}
Diego Biurrun's avatar
Diego Biurrun committed
119
Set the master clock to audio (@code{type=audio}), video
120 121 122 123 124
(@code{type=video}) or external (@code{type=ext}). Default is audio. The
master clock is used to control audio-video synchronization. Most media
players use audio as master clock, but in some cases (streaming or high
quality broadcast) it is necessary to change that. This option is mainly
used for debugging purposes.
125
@item -threads @var{count}
126
Set the thread count.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
@item -ast @var{audio_stream_number}
Select the desired audio stream number, counting from 0. The number
refers to the list of all the input audio streams. If it is greater
than the number of audio streams minus one, then the last one is
selected, if it is negative the audio playback is disabled.
@item -vst @var{video_stream_number}
Select the desired video stream number, counting from 0. The number
refers to the list of all the input video streams. If it is greater
than the number of video streams minus one, then the last one is
selected, if it is negative the video playback is disabled.
@item -sst @var{subtitle_stream_number}
Select the desired subtitle stream number, counting from 0. The number
refers to the list of all the input subtitle streams. If it is greater
than the number of subtitle streams minus one, then the last one is
selected, if it is negative the subtitle rendering is disabled.
142 143
@item -autoexit
Exit when video is done playing.
144 145 146 147
@item -exitonkeydown
Exit if any key is pressed.
@item -exitonmousedown
Exit if any mouse button is pressed.
148 149 150 151 152 153 154 155 156 157 158 159 160 161

@item -codec:@var{media_specifier} @var{codec_name}
Force a specific decoder implementation for the stream identified by
@var{media_specifier}, which can assume the values @code{a} (audio),
@code{v} (video), and @code{s} subtitle.

@item -acodec @var{codec_name}
Force a specific audio decoder.

@item -vcodec @var{codec_name}
Force a specific video decoder.

@item -scodec @var{codec_name}
Force a specific subtitle decoder.
162 163 164 165 166 167
@end table

@section While playing

@table @key
@item q, ESC
168
Quit.
169 170

@item f
171
Toggle full screen.
172 173

@item p, SPC
174
Pause.
175 176

@item a
177
Cycle audio channel in the curret program.
178 179

@item v
180
Cycle video channel.
181

182
@item t
183 184 185 186
Cycle subtitle channel in the current program.

@item c
Cycle program.
187

188
@item w
189
Show audio waves.
190

191 192 193 194 195 196
@item s
Step to the next frame.

Pause if the stream is not already paused, step to the next video
frame, and pause.

197
@item left/right
198
Seek backward/forward 10 seconds.
199 200

@item down/up
201
Seek backward/forward 1 minute.
202

203
@item page down/page up
204 205
Seek to the previous/next chapter.
or if there are no chapters
206 207
Seek backward/forward 10 minutes.

208
@item mouse click
209
Seek to percentage in file corresponding to fraction of width.
210

211 212 213 214
@end table

@c man end

215
@include config.texi
216
@ifset config-all
217
@set config-readonly
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
@ifset config-avutil
@include utils.texi
@end ifset
@ifset config-avcodec
@include codecs.texi
@include bitstream_filters.texi
@end ifset
@ifset config-avformat
@include formats.texi
@include protocols.texi
@end ifset
@ifset config-avdevice
@include devices.texi
@end ifset
@ifset config-swresample
@include resampler.texi
@end ifset
@ifset config-swscale
@include scaler.texi
@end ifset
@ifset config-avfilter
@include filters.texi
@end ifset
241 242
@end ifset

243 244 245
@chapter See Also

@ifhtml
246 247 248 249 250 251
@ifset config-all
@url{ffplay.html,ffplay},
@end ifset
@ifset config-not-all
@url{ffplay-all.html,ffmpeg-all},
@end ifset
252 253 254 255 256
@url{ffmpeg.html,ffmpeg}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
@url{ffmpeg-utils.html,ffmpeg-utils},
@url{ffmpeg-scaler.html,ffmpeg-scaler},
@url{ffmpeg-resampler.html,ffmpeg-resampler},
@url{ffmpeg-codecs.html,ffmpeg-codecs},
257
@url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters},
258 259 260 261 262 263 264
@url{ffmpeg-formats.html,ffmpeg-formats},
@url{ffmpeg-devices.html,ffmpeg-devices},
@url{ffmpeg-protocols.html,ffmpeg-protocols},
@url{ffmpeg-filters.html,ffmpeg-filters}
@end ifhtml

@ifnothtml
265 266 267 268 269 270
@ifset config-all
ffplay(1),
@end ifset
@ifset config-not-all
ffplay-all(1),
@end ifset
271 272 273 274 275 276
ffmpeg(1), ffprobe(1), ffserver(1),
ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
@end ifnothtml

277 278
@include authors.texi

279 280 281 282 283 284 285 286
@ignore

@setfilename ffplay
@settitle FFplay media player

@end ignore

@bye