ad1a652f90390d03d4acd06349cc7b651a2fe6a8
[ffmpeg.git] / doc / ffplay-doc.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle FFplay Documentation
4 @titlepage
5 @sp 7
6 @center @titlefont{FFplay Documentation}
7 @sp 3
8 @end titlepage
9
10 @chapter Synopsis
11
12 @example
13 @c man begin SYNOPSIS
14 ffplay [options] @file{input_file}
15 @c man end
16 @end example
17
18 @chapter Description
19 @c man begin DESCRIPTION
20
21 FFplay is a very simple and portable media player using the FFmpeg
22 libraries and the SDL library. It is mostly used as a testbed for the
23 various FFmpeg APIs.
24 @c man end
25
26 @chapter Options
27 @c man begin OPTIONS
28
29 @include fftools-common-opts.texi
30
31 @section Main options
32
33 @table @option
34 @item -x @var{width}
35 Force displayed width.
36 @item -y @var{height}
37 Force displayed height.
38 @item -s @var{size}
39 Set frame size (WxH or abbreviation), needed for videos which don't
40 contain a header with the frame size like raw YUV.
41 @item -an
42 Disable audio.
43 @item -vn
44 Disable video.
45 @item -ss @var{pos}
46 Seek to a given position in seconds.
47 @item -t @var{duration}
48 play <duration> seconds of audio/video
49 @item -bytes
50 Seek by bytes.
51 @item -nodisp
52 Disable graphical display.
53 @item -f @var{fmt}
54 Force format.
55 @item -window_title @var{title}
56 Set window title (default is the input filename).
57 @item -loop @var{number}
58 Loops movie playback <number> times. 0 means forever.
59 @item -vf @var{filter_graph}
60 @var{filter_graph} is a description of the filter graph to apply to
61 the input video.
62 Use the option "-filters" to show all the available filters (including
63 also sources and sinks).
64
65 @end table
66
67 @section Advanced options
68 @table @option
69 @item -pix_fmt @var{format}
70 Set pixel format.
71 @item -stats
72 Show the stream duration, the codec parameters, the current position in
73 the stream and the audio/video synchronisation drift.
74 @item -debug
75 Print specific debug info.
76 @item -bug
77 Work around bugs.
78 @item -vismv
79 Visualize motion vectors.
80 @item -fast
81 Non-spec-compliant optimizations.
82 @item -genpts
83 Generate pts.
84 @item -rtp_tcp
85 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
86 if you are streaming with the RTSP protocol.
87 @item -sync @var{type}
88 Set the master clock to audio (@code{type=audio}), video
89 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
90 master clock is used to control audio-video synchronization. Most media
91 players use audio as master clock, but in some cases (streaming or high
92 quality broadcast) it is necessary to change that. This option is mainly
93 used for debugging purposes.
94 @item -threads @var{count}
95 Set the thread count.
96 @item -ast @var{audio_stream_number}
97 Select the desired audio stream number, counting from 0. The number
98 refers to the list of all the input audio streams. If it is greater
99 than the number of audio streams minus one, then the last one is
100 selected, if it is negative the audio playback is disabled.
101 @item -vst @var{video_stream_number}
102 Select the desired video stream number, counting from 0. The number
103 refers to the list of all the input video streams. If it is greater
104 than the number of video streams minus one, then the last one is
105 selected, if it is negative the video playback is disabled.
106 @item -sst @var{subtitle_stream_number}
107 Select the desired subtitle stream number, counting from 0. The number
108 refers to the list of all the input subtitle streams. If it is greater
109 than the number of subtitle streams minus one, then the last one is
110 selected, if it is negative the subtitle rendering is disabled.
111 @item -exitonkeydown
112 Exit if any key is pressed.
113 @item -exitonmousedown
114 Exit if any mouse button is pressed.
115 @end table
116
117 @section While playing
118
119 @table @key
120 @item q, ESC
121 Quit.
122
123 @item f
124 Toggle full screen.
125
126 @item p, SPC
127 Pause.
128
129 @item a
130 Cycle audio channel.
131
132 @item v
133 Cycle video channel.
134
135 @item t
136 Cycle subtitle channel.
137
138 @item w
139 Show audio waves.
140
141 @item left/right
142 Seek backward/forward 10 seconds.
143
144 @item down/up
145 Seek backward/forward 1 minute.
146
147 @item mouse click
148 Seek to percentage in file corresponding to fraction of width.
149
150 @end table
151
152 @c man end
153
154 @include filters.texi
155
156 @ignore
157
158 @setfilename ffplay
159 @settitle FFplay media player
160
161 @c man begin SEEALSO
162 ffmpeg(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
163 @c man end
164
165 @c man begin AUTHORS
166 The FFmpeg developers
167 @c man end
168
169 @end ignore
170
171 @bye