Revert "replace FFmpeg with Libav in doc/"
[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 fftools-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 don't
42 contain a header with the frame size like raw YUV.
43 @item -an
44 Disable audio.
45 @item -vn
46 Disable video.
47 @item -ss @var{pos}
48 Seek to a given position in seconds.
49 @item -t @var{duration}
50 play <duration> seconds of audio/video
51 @item -bytes
52 Seek by bytes.
53 @item -nodisp
54 Disable graphical display.
55 @item -f @var{fmt}
56 Force format.
57 @item -window_title @var{title}
58 Set window title (default is the input filename).
59 @item -loop @var{number}
60 Loops movie playback <number> times. 0 means forever.
61 @item -vf @var{filter_graph}
62 @var{filter_graph} is a description of the filter graph to apply to
63 the input video.
64 Use the option "-filters" to show all the available filters (including
65 also sources and sinks).
66
67 @end table
68
69 @section Advanced options
70 @table @option
71 @item -pix_fmt @var{format}
72 Set pixel format.
73 @item -stats
74 Show the stream duration, the codec parameters, the current position in
75 the stream and the audio/video synchronisation drift.
76 @item -debug
77 Print specific debug info.
78 @item -bug
79 Work around bugs.
80 @item -vismv
81 Visualize motion vectors.
82 @item -fast
83 Non-spec-compliant optimizations.
84 @item -genpts
85 Generate pts.
86 @item -rtp_tcp
87 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
88 if you are streaming with the RTSP protocol.
89 @item -sync @var{type}
90 Set the master clock to audio (@code{type=audio}), video
91 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
92 master clock is used to control audio-video synchronization. Most media
93 players use audio as master clock, but in some cases (streaming or high
94 quality broadcast) it is necessary to change that. This option is mainly
95 used for debugging purposes.
96 @item -threads @var{count}
97 Set the thread count.
98 @item -ast @var{audio_stream_number}
99 Select the desired audio stream number, counting from 0. The number
100 refers to the list of all the input audio streams. If it is greater
101 than the number of audio streams minus one, then the last one is
102 selected, if it is negative the audio playback is disabled.
103 @item -vst @var{video_stream_number}
104 Select the desired video stream number, counting from 0. The number
105 refers to the list of all the input video streams. If it is greater
106 than the number of video streams minus one, then the last one is
107 selected, if it is negative the video playback is disabled.
108 @item -sst @var{subtitle_stream_number}
109 Select the desired subtitle stream number, counting from 0. The number
110 refers to the list of all the input subtitle streams. If it is greater
111 than the number of subtitle streams minus one, then the last one is
112 selected, if it is negative the subtitle rendering is disabled.
113 @item -autoexit
114 Exit when video is done playing.
115 @item -exitonkeydown
116 Exit if any key is pressed.
117 @item -exitonmousedown
118 Exit if any mouse button is pressed.
119 @end table
120
121 @section While playing
122
123 @table @key
124 @item q, ESC
125 Quit.
126
127 @item f
128 Toggle full screen.
129
130 @item p, SPC
131 Pause.
132
133 @item a
134 Cycle audio channel.
135
136 @item v
137 Cycle video channel.
138
139 @item t
140 Cycle subtitle channel.
141
142 @item w
143 Show audio waves.
144
145 @item left/right
146 Seek backward/forward 10 seconds.
147
148 @item down/up
149 Seek backward/forward 1 minute.
150
151 @item mouse click
152 Seek to percentage in file corresponding to fraction of width.
153
154 @end table
155
156 @c man end
157
158 @include eval.texi
159 @include demuxers.texi
160 @include muxers.texi
161 @include indevs.texi
162 @include outdevs.texi
163 @include protocols.texi
164 @include filters.texi
165
166 @ignore
167
168 @setfilename ffplay
169 @settitle FFplay media player
170
171 @c man begin SEEALSO
172 ffmpeg(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
173 @c man end
174
175 @c man begin AUTHORS
176 The FFmpeg developers
177 @c man end
178
179 @end ignore
180
181 @bye