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