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