ffplay: add documentation for "s" key
[ffmpeg.git] / 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 fftools-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{filtergraph}
77 Create the filtergraph specified by @var{filtergraph} and use it to
78 filter the video stream.
79
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 @code{in}, and the output to the label @code{out}. See the
84 ffmpeg-filters manual for more information about the filtergraph
85 syntax.
86
87 @item -af @var{filtergraph}
88 @var{filtergraph} is a description of the filtergraph to apply to
89 the input audio.
90 Use the option "-filters" to show all the available filters (including
91 sources and sinks).
92
93 @item -i @var{input_file}
94 Read @var{input_file}.
95 @end table
96
97 @section Advanced options
98 @table @option
99 @item -pix_fmt @var{format}
100 Set pixel format.
101 This option has been deprecated in favor of private options, try -pixel_format.
102
103 @item -stats
104 Print several playback statistics, in particular show the stream
105 duration, the codec parameters, the current position in the stream and
106 the audio/video synchronisation drift. It is on by default, to
107 explicitly disable it you need to specify @code{-nostats}.
108
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
116 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
117 if you are streaming with the RTSP protocol.
118 @item -sync @var{type}
119 Set the master clock to audio (@code{type=audio}), video
120 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
121 master clock is used to control audio-video synchronization. Most media
122 players use audio as master clock, but in some cases (streaming or high
123 quality broadcast) it is necessary to change that. This option is mainly
124 used for debugging purposes.
125 @item -threads @var{count}
126 Set the thread count.
127 @item -ast @var{audio_stream_number}
128 Select the desired audio stream number, counting from 0. The number
129 refers to the list of all the input audio streams. If it is greater
130 than the number of audio streams minus one, then the last one is
131 selected, if it is negative the audio playback is disabled.
132 @item -vst @var{video_stream_number}
133 Select the desired video stream number, counting from 0. The number
134 refers to the list of all the input video streams. If it is greater
135 than the number of video streams minus one, then the last one is
136 selected, if it is negative the video playback is disabled.
137 @item -sst @var{subtitle_stream_number}
138 Select the desired subtitle stream number, counting from 0. The number
139 refers to the list of all the input subtitle streams. If it is greater
140 than the number of subtitle streams minus one, then the last one is
141 selected, if it is negative the subtitle rendering is disabled.
142 @item -autoexit
143 Exit when video is done playing.
144 @item -exitonkeydown
145 Exit if any key is pressed.
146 @item -exitonmousedown
147 Exit if any mouse button is pressed.
148
149 @item -codec:@var{media_specifier} @var{codec_name}
150 Force a specific decoder implementation for the stream identified by
151 @var{media_specifier}, which can assume the values @code{a} (audio),
152 @code{v} (video), and @code{s} subtitle.
153
154 @item -acodec @var{codec_name}
155 Force a specific audio decoder.
156
157 @item -vcodec @var{codec_name}
158 Force a specific video decoder.
159
160 @item -scodec @var{codec_name}
161 Force a specific subtitle decoder.
162 @end table
163
164 @section While playing
165
166 @table @key
167 @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 Cycle subtitle channel in the current program.
184
185 @item c
186 Cycle program.
187
188 @item w
189 Show audio waves.
190
191 @item s
192 Step to the next frame.
193
194 Pause if the stream is not already paused, step to the next video
195 frame, and pause.
196
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 Seek backward/forward 10 minutes.
205
206 @item mouse click
207 Seek to percentage in file corresponding to fraction of width.
208
209 @end table
210
211 @c man end
212
213 @include config.texi
214 @ifset config-all
215 @ifset config-avutil
216 @include utils.texi
217 @end ifset
218 @ifset config-avcodec
219 @include codecs.texi
220 @include bitstream_filters.texi
221 @end ifset
222 @ifset config-avformat
223 @include formats.texi
224 @include protocols.texi
225 @end ifset
226 @ifset config-avdevice
227 @include devices.texi
228 @end ifset
229 @ifset config-swresample
230 @include resampler.texi
231 @end ifset
232 @ifset config-swscale
233 @include scaler.texi
234 @end ifset
235 @ifset config-avfilter
236 @include filters.texi
237 @end ifset
238 @end ifset
239
240 @chapter See Also
241
242 @ifhtml
243 @ifset config-all
244 @url{ffplay.html,ffplay},
245 @end ifset
246 @ifset config-not-all
247 @url{ffplay-all.html,ffmpeg-all},
248 @end ifset
249 @url{ffmpeg.html,ffmpeg}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
250 @url{ffmpeg-utils.html,ffmpeg-utils},
251 @url{ffmpeg-scaler.html,ffmpeg-scaler},
252 @url{ffmpeg-resampler.html,ffmpeg-resampler},
253 @url{ffmpeg-codecs.html,ffmpeg-codecs},
254 @url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters},
255 @url{ffmpeg-formats.html,ffmpeg-formats},
256 @url{ffmpeg-devices.html,ffmpeg-devices},
257 @url{ffmpeg-protocols.html,ffmpeg-protocols},
258 @url{ffmpeg-filters.html,ffmpeg-filters}
259 @end ifhtml
260
261 @ifnothtml
262 @ifset config-all
263 ffplay(1),
264 @end ifset
265 @ifset config-not-all
266 ffplay-all(1),
267 @end ifset
268 ffmpeg(1), ffprobe(1), ffserver(1),
269 ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
270 ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
271 ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
272 @end ifnothtml
273
274 @include authors.texi
275
276 @ignore
277
278 @setfilename ffplay
279 @settitle FFplay media player
280
281 @end ignore
282
283 @bye