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