doc/ffplay,ffmpeg: mention the corresponding negated option for -stats
[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 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 Create the filter graph specified by @var{filter_graph} and use it to
78 filter the video stream.
79
80 @var{filter_graph} is a description of the filter graph to apply to
81 the stream, and must have a single video input and a single video
82 output. In the filter graph, 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 -i @var{input_file}
88 Read @var{input_file}.
89 @end table
90
91 @section Advanced options
92 @table @option
93 @item -pix_fmt @var{format}
94 Set pixel format.
95 This option has been deprecated in favor of private options, try -pixel_format.
96
97 @item -stats
98 Print several playback statistics, in particular show the stream
99 duration, the codec parameters, the current position in the stream and
100 the audio/video synchronisation drift. It is on by default, to
101 explicitly disable it you need to specify @code{-nostats}.
102
103 @item -bug
104 Work around bugs.
105 @item -fast
106 Non-spec-compliant optimizations.
107 @item -genpts
108 Generate pts.
109 @item -rtp_tcp
110 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
111 if you are streaming with the RTSP protocol.
112 @item -sync @var{type}
113 Set the master clock to audio (@code{type=audio}), video
114 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
115 master clock is used to control audio-video synchronization. Most media
116 players use audio as master clock, but in some cases (streaming or high
117 quality broadcast) it is necessary to change that. This option is mainly
118 used for debugging purposes.
119 @item -threads @var{count}
120 Set the thread count.
121 @item -ast @var{audio_stream_number}
122 Select the desired audio stream number, counting from 0. The number
123 refers to the list of all the input audio streams. If it is greater
124 than the number of audio streams minus one, then the last one is
125 selected, if it is negative the audio playback is disabled.
126 @item -vst @var{video_stream_number}
127 Select the desired video stream number, counting from 0. The number
128 refers to the list of all the input video streams. If it is greater
129 than the number of video streams minus one, then the last one is
130 selected, if it is negative the video playback is disabled.
131 @item -sst @var{subtitle_stream_number}
132 Select the desired subtitle stream number, counting from 0. The number
133 refers to the list of all the input subtitle streams. If it is greater
134 than the number of subtitle streams minus one, then the last one is
135 selected, if it is negative the subtitle rendering is disabled.
136 @item -autoexit
137 Exit when video is done playing.
138 @item -exitonkeydown
139 Exit if any key is pressed.
140 @item -exitonmousedown
141 Exit if any mouse button is pressed.
142
143 @item -codec:@var{media_specifier} @var{codec_name}
144 Force a specific decoder implementation for the stream identified by
145 @var{media_specifier}, which can assume the values @code{a} (audio),
146 @code{v} (video), and @code{s} subtitle.
147
148 @item -acodec @var{codec_name}
149 Force a specific audio decoder.
150
151 @item -vcodec @var{codec_name}
152 Force a specific video decoder.
153
154 @item -scodec @var{codec_name}
155 Force a specific subtitle decoder.
156 @end table
157
158 @section While playing
159
160 @table @key
161 @item q, ESC
162 Quit.
163
164 @item f
165 Toggle full screen.
166
167 @item p, SPC
168 Pause.
169
170 @item a
171 Cycle audio channel.
172
173 @item v
174 Cycle video channel.
175
176 @item t
177 Cycle subtitle channel.
178
179 @item w
180 Show audio waves.
181
182 @item left/right
183 Seek backward/forward 10 seconds.
184
185 @item down/up
186 Seek backward/forward 1 minute.
187
188 @item page down/page up
189 Seek backward/forward 10 minutes.
190
191 @item mouse click
192 Seek to percentage in file corresponding to fraction of width.
193
194 @end table
195
196 @c man end
197
198 @chapter See Also
199
200 @ifhtml
201 @url{ffmpeg.html,ffmpeg}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
202 @url{ffmpeg-utils.html,ffmpeg-utils},
203 @url{ffmpeg-scaler.html,ffmpeg-scaler},
204 @url{ffmpeg-resampler.html,ffmpeg-resampler},
205 @url{ffmpeg-codecs.html,ffmpeg-codecs},
206 @url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters},
207 @url{ffmpeg-formats.html,ffmpeg-formats},
208 @url{ffmpeg-devices.html,ffmpeg-devices},
209 @url{ffmpeg-protocols.html,ffmpeg-protocols},
210 @url{ffmpeg-filters.html,ffmpeg-filters}
211 @end ifhtml
212
213 @ifnothtml
214 ffmpeg(1), ffprobe(1), ffserver(1),
215 ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
216 ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
217 ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
218 @end ifnothtml
219
220 @include authors.texi
221
222 @ignore
223
224 @setfilename ffplay
225 @settitle FFplay media player
226
227 @end ignore
228
229 @bye