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