mpegvideo: fix out of heap array accesses
[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 @example
15 @c man begin SYNOPSIS
16 ffplay [options] [@file{input_file}]
17 @c man end
18 @end example
19
20 @chapter Description
21 @c man begin DESCRIPTION
22
23 FFplay is a very simple and portable media player using the FFmpeg
24 libraries and the SDL library. It is mostly used as a testbed for the
25 various FFmpeg APIs.
26 @c man end
27
28 @chapter Options
29 @c man begin OPTIONS
30
31 @include avtools-common-opts.texi
32
33 @section Main options
34
35 @table @option
36 @item -x @var{width}
37 Force displayed width.
38 @item -y @var{height}
39 Force displayed height.
40 @item -s @var{size}
41 Set frame size (WxH or abbreviation), needed for videos which do
42 not contain a header with the frame size like raw YUV.  This option
43 has been deprecated in favor of private options, try -video_size.
44 @item -an
45 Disable audio.
46 @item -vn
47 Disable video.
48 @item -ss @var{pos}
49 Seek to a given position in seconds.
50 @item -t @var{duration}
51 play <duration> seconds of audio/video
52 @item -bytes
53 Seek by bytes.
54 @item -nodisp
55 Disable graphical display.
56 @item -f @var{fmt}
57 Force format.
58 @item -window_title @var{title}
59 Set window title (default is the input filename).
60 @item -loop @var{number}
61 Loops movie playback <number> times. 0 means forever.
62 @item -showmode @var{mode}
63 Set the show mode to use.
64 Available values for @var{mode} are:
65 @table @samp
66 @item 0, video
67 show video
68 @item 1, waves
69 show audio waves
70 @item 2, rdft
71 show audio frequency band using RDFT ((Inverse) Real Discrete Fourier Transform)
72 @end table
73
74 Default value is "video", if video is not present or cannot be played
75 "rdft" is automatically selected.
76
77 You can interactively cycle through the available show modes by
78 pressing the key @key{w}.
79
80 @item -vf @var{filter_graph}
81 @var{filter_graph} is a description of the filter graph to apply to
82 the input video.
83 Use the option "-filters" to show all the available filters (including
84 also sources and sinks).
85
86 @item -i @var{input_file}
87 Read @var{input_file}.
88 @end table
89
90 @section Advanced options
91 @table @option
92 @item -pix_fmt @var{format}
93 Set pixel format.
94 This option has been deprecated in favor of private options, try -pixel_format.
95 @item -stats
96 Show the stream duration, the codec parameters, the current position in
97 the stream and the audio/video synchronisation drift.
98 @item -bug
99 Work around bugs.
100 @item -fast
101 Non-spec-compliant optimizations.
102 @item -genpts
103 Generate pts.
104 @item -rtp_tcp
105 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
106 if you are streaming with the RTSP protocol.
107 @item -sync @var{type}
108 Set the master clock to audio (@code{type=audio}), video
109 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
110 master clock is used to control audio-video synchronization. Most media
111 players use audio as master clock, but in some cases (streaming or high
112 quality broadcast) it is necessary to change that. This option is mainly
113 used for debugging purposes.
114 @item -threads @var{count}
115 Set the thread count.
116 @item -ast @var{audio_stream_number}
117 Select the desired audio stream number, counting from 0. The number
118 refers to the list of all the input audio streams. If it is greater
119 than the number of audio streams minus one, then the last one is
120 selected, if it is negative the audio playback is disabled.
121 @item -vst @var{video_stream_number}
122 Select the desired video stream number, counting from 0. The number
123 refers to the list of all the input video streams. If it is greater
124 than the number of video streams minus one, then the last one is
125 selected, if it is negative the video playback is disabled.
126 @item -sst @var{subtitle_stream_number}
127 Select the desired subtitle stream number, counting from 0. The number
128 refers to the list of all the input subtitle streams. If it is greater
129 than the number of subtitle streams minus one, then the last one is
130 selected, if it is negative the subtitle rendering is disabled.
131 @item -autoexit
132 Exit when video is done playing.
133 @item -exitonkeydown
134 Exit if any key is pressed.
135 @item -exitonmousedown
136 Exit if any mouse button is pressed.
137 @item -codec:@var{stream_type}
138 Force a specific decoder implementation
139 @end table
140
141 @section While playing
142
143 @table @key
144 @item q, ESC
145 Quit.
146
147 @item f
148 Toggle full screen.
149
150 @item p, SPC
151 Pause.
152
153 @item a
154 Cycle audio channel.
155
156 @item v
157 Cycle video channel.
158
159 @item t
160 Cycle subtitle channel.
161
162 @item w
163 Show audio waves.
164
165 @item left/right
166 Seek backward/forward 10 seconds.
167
168 @item down/up
169 Seek backward/forward 1 minute.
170
171 @item page down/page up
172 Seek backward/forward 10 minutes.
173
174 @item mouse click
175 Seek to percentage in file corresponding to fraction of width.
176
177 @end table
178
179 @c man end
180
181 @include eval.texi
182 @include decoders.texi
183 @include demuxers.texi
184 @include muxers.texi
185 @include indevs.texi
186 @include outdevs.texi
187 @include protocols.texi
188 @include filters.texi
189
190 @ignore
191
192 @setfilename ffplay
193 @settitle FFplay media player
194
195 @c man begin SEEALSO
196 ffmpeg(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
197 @c man end
198
199 @c man begin AUTHORS
200 The FFmpeg developers
201 @c man end
202
203 @end ignore
204
205 @bye