ffplay.texi 5.73 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 avtools-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 78 79 80 81
@item -vf @var{filter_graph}
@var{filter_graph} is a description of the filter graph to apply to
the input video.
Use the option "-filters" to show all the available filters (including
also sources and sinks).

82 83
@item -i @var{input_file}
Read @var{input_file}.
84
@end table
85 86 87

@section Advanced options
@table @option
88
@item -pix_fmt @var{format}
89 90
Set pixel format.
This option has been deprecated in favor of private options, try -pixel_format.
91
@item -stats
Diego Biurrun's avatar
Diego Biurrun committed
92 93
Show the stream duration, the codec parameters, the current position in
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
Diego Biurrun's avatar
Diego Biurrun committed
101 102
Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
if you are streaming with the RTSP protocol.
103
@item -sync @var{type}
Diego Biurrun's avatar
Diego Biurrun committed
104
Set the master clock to audio (@code{type=audio}), video
105 106 107 108 109
(@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.
110
@item -threads @var{count}
111
Set the thread count.
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
@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.
127 128
@item -autoexit
Exit when video is done playing.
129 130 131 132
@item -exitonkeydown
Exit if any key is pressed.
@item -exitonmousedown
Exit if any mouse button is pressed.
133 134 135 136 137 138 139 140 141 142 143 144 145 146

@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.
147 148 149 150 151 152
@end table

@section While playing

@table @key
@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 168 169
@item t
Cycle subtitle channel.

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 180 181
@item page down/page up
Seek backward/forward 10 minutes.

182
@item mouse click
183
Seek to percentage in file corresponding to fraction of width.
184

185 186 187 188
@end table

@c man end

189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
@chapter See Also

@ifhtml
@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},
@url{ffmpeg-bitstream-filters,ffmpeg-bitstream-filters},
@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
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

211 212
@include authors.texi

213 214 215 216 217 218 219 220
@ignore

@setfilename ffplay
@settitle FFplay media player

@end ignore

@bye