ffplay.texi 4.93 KB
Newer Older
1 2
\input texinfo @c -*- texinfo -*-

3
@settitle ffplay Documentation
4
@titlepage
5
@center @titlefont{ffplay Documentation}
6 7
@end titlepage

8 9 10 11
@top

@contents

12 13 14 15
@chapter Synopsis

@example
@c man begin SYNOPSIS
16
ffplay [options] [@file{input_file}]
17 18
@c man end
@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
Diego Biurrun's avatar
Diego Biurrun committed
24
libraries and the SDL library. It is mostly used as a testbed for the
25
various FFmpeg APIs.
26 27
@c man end

28
@chapter Options
29
@c man begin OPTIONS
30

31
@include avtools-common-opts.texi
32

33 34 35
@section Main options

@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 42 43
Set frame size (WxH or abbreviation), needed for videos which do
not contain a header with the frame size like raw YUV.  This option
has been deprecated in favor of private options, try -video_size.
44
@item -an
45
Disable audio.
46
@item -vn
47
Disable video.
48
@item -ss @var{pos}
49
Seek to a given position in seconds.
50 51
@item -t @var{duration}
play <duration> seconds of audio/video
52
@item -bytes
53
Seek by bytes.
54
@item -nodisp
55
Disable graphical display.
56
@item -f @var{fmt}
57
Force format.
58 59
@item -window_title @var{title}
Set window title (default is the input filename).
60 61
@item -loop @var{number}
Loops movie playback <number> times. 0 means forever.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
@item -showmode @var{mode}
Set the show mode to use.
Available values for @var{mode} are:
@table @samp
@item 0, video
show video
@item 1, waves
show audio waves
@item 2, rdft
show audio frequency band using RDFT ((Inverse) Real Discrete Fourier Transform)
@end table

Default value is "video", if video is not present or cannot be played
"rdft" is automatically selected.

You can interactively cycle through the available show modes by
pressing the key @key{w}.

80 81 82 83 84 85
@item -vf @var{filter_graph}
@var{filter_graph} is a description of the filter graph to apply to
the input video.
Use the option "-filters" to show all the available filters (including
also sources and sinks).

86 87
@item -i @var{input_file}
Read @var{input_file}.
88
@end table
89 90 91

@section Advanced options
@table @option
92
@item -pix_fmt @var{format}
93 94
Set pixel format.
This option has been deprecated in favor of private options, try -pixel_format.
95
@item -stats
Diego Biurrun's avatar
Diego Biurrun committed
96 97
Show the stream duration, the codec parameters, the current position in
the stream and the audio/video synchronisation drift.
98
@item -bug
99
Work around bugs.
100
@item -fast
101
Non-spec-compliant optimizations.
102
@item -genpts
103
Generate pts.
104
@item -rtp_tcp
Diego Biurrun's avatar
Diego Biurrun committed
105 106
Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
if you are streaming with the RTSP protocol.
107
@item -sync @var{type}
Diego Biurrun's avatar
Diego Biurrun committed
108
Set the master clock to audio (@code{type=audio}), video
109 110 111 112 113
(@code{type=video}) or external (@code{type=ext}). Default is audio. The
master clock is used to control audio-video synchronization. Most media
players use audio as master clock, but in some cases (streaming or high
quality broadcast) it is necessary to change that. This option is mainly
used for debugging purposes.
114
@item -threads @var{count}
115
Set the thread count.
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
@item -ast @var{audio_stream_number}
Select the desired audio stream number, counting from 0. The number
refers to the list of all the input audio streams. If it is greater
than the number of audio streams minus one, then the last one is
selected, if it is negative the audio playback is disabled.
@item -vst @var{video_stream_number}
Select the desired video stream number, counting from 0. The number
refers to the list of all the input video streams. If it is greater
than the number of video streams minus one, then the last one is
selected, if it is negative the video playback is disabled.
@item -sst @var{subtitle_stream_number}
Select the desired subtitle stream number, counting from 0. The number
refers to the list of all the input subtitle streams. If it is greater
than the number of subtitle streams minus one, then the last one is
selected, if it is negative the subtitle rendering is disabled.
131 132
@item -autoexit
Exit when video is done playing.
133 134 135 136
@item -exitonkeydown
Exit if any key is pressed.
@item -exitonmousedown
Exit if any mouse button is pressed.
137 138
@item -codec:@var{stream_type}
Force a specific decoder implementation
139 140 141 142 143 144
@end table

@section While playing

@table @key
@item q, ESC
145
Quit.
146 147

@item f
148
Toggle full screen.
149 150

@item p, SPC
151
Pause.
152 153

@item a
154
Cycle audio channel.
155 156

@item v
157
Cycle video channel.
158

159 160 161
@item t
Cycle subtitle channel.

162
@item w
163
Show audio waves.
164 165

@item left/right
166
Seek backward/forward 10 seconds.
167 168

@item down/up
169
Seek backward/forward 1 minute.
170 171

@item mouse click
172
Seek to percentage in file corresponding to fraction of width.
173

174 175 176 177
@end table

@c man end

Stefano Sabatini's avatar
Stefano Sabatini committed
178
@include eval.texi
179
@include decoders.texi
180
@include demuxers.texi
Stefano Sabatini's avatar
Stefano Sabatini committed
181
@include muxers.texi
182 183
@include indevs.texi
@include outdevs.texi
Stefano Sabatini's avatar
Stefano Sabatini committed
184
@include protocols.texi
185 186
@include filters.texi

187 188 189 190 191 192
@ignore

@setfilename ffplay
@settitle FFplay media player

@c man begin SEEALSO
193
ffmpeg(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
194 195
@c man end

196
@c man begin AUTHORS
197
The FFmpeg developers
198 199 200 201 202
@c man end

@end ignore

@bye