mlpdec: Split filter_state_buffer into [fi]irbuf and fp to [fi]ir.
[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, codecs, protocols, ...
40 @item -x @var{width}
41 Force displayed width.
42 @item -y @var{height}
43 Force displayed height.
44 @item -s @var{size}
45 Set frame size (WxH or abbreviation), needed for videos which don't
46 contain a header with the frame size like raw YUV.
47 @item -an
48 Disable audio.
49 @item -vn
50 Disable video.
51 @item -ss @var{pos}
52 Seek to a given position in seconds.
53 @item -bytes
54 Seek by bytes.
55 @item -nodisp
56 Disable graphical display.
57 @item -f @var{fmt}
58 Force format.
59 @end table
60
61 @section Advanced options
62 @table @option
63 @item -pix_fmt @var{format}
64 Set pixel format.
65 @item -stats
66 Show the stream duration, the codec parameters, the current position in
67 the stream and the audio/video synchronisation drift.
68 @item -debug
69 Print specific debug info.
70 @item -bug
71 Work around bugs.
72 @item -vismv
73 Visualize motion vectors.
74 @item -fast
75 Non-spec-compliant optimizations.
76 @item -genpts
77 Generate pts.
78 @item -rtp_tcp
79 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
80 if you are streaming with the RTSP protocol.
81 @item -sync @var{type}
82 Set the master clock to audio (@code{type=audio}), video
83 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
84 master clock is used to control audio-video synchronization. Most media
85 players use audio as master clock, but in some cases (streaming or high
86 quality broadcast) it is necessary to change that. This option is mainly
87 used for debugging purposes.
88 @item -threads @var{count}
89 Set the thread count.
90 @item -ast @var{audio_stream_number}
91 Select the desired audio stream number, counting from 0. The number
92 refers to the list of all the input audio streams. If it is greater
93 than the number of audio streams minus one, then the last one is
94 selected, if it is negative the audio playback is disabled.
95 @item -vst @var{video_stream_number}
96 Select the desired video stream number, counting from 0. The number
97 refers to the list of all the input video streams. If it is greater
98 than the number of video streams minus one, then the last one is
99 selected, if it is negative the video playback is disabled.
100 @item -sst @var{subtitle_stream_number}
101 Select the desired subtitle stream number, counting from 0. The number
102 refers to the list of all the input subtitle streams. If it is greater
103 than the number of subtitle streams minus one, then the last one is
104 selected, if it is negative the subtitle rendering is disabled.
105 @end table
106
107 @section While playing
108
109 @table @key
110 @item q, ESC
111 Quit.
112
113 @item f
114 Toggle full screen.
115
116 @item p, SPC
117 Pause.
118
119 @item a
120 Cycle audio channel.
121
122 @item v
123 Cycle video channel.
124
125 @item t
126 Cycle subtitle channel.
127
128 @item w
129 Show audio waves.
130
131 @item left/right
132 Seek backward/forward 10 seconds.
133
134 @item down/up
135 Seek backward/forward 1 minute.
136
137 @item mouse click
138 Seek to percentage in file corresponding to fraction of width.
139
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
150 ffmpeg(1), ffserver(1) and the HTML documentation of @file{ffmpeg}.
151 @c man end
152
153 @c man begin AUTHOR
154 Fabrice Bellard
155 @c man end
156
157 @end ignore
158
159 @bye