doc: update the reference for the title
[ffmpeg.git] / doc / avplay.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle avplay Documentation
4 @titlepage
5 @center @titlefont{avplay Documentation}
6 @end titlepage
7
8 @top
9
10 @contents
11
12 @chapter Synopsis
13
14 @example
15 @c man begin SYNOPSIS
16 avplay [options] @file{input_file}
17 @c man end
18 @end example
19
20 @chapter Description
21 @c man begin DESCRIPTION
22
23 AVplay is a very simple and portable media player using the Libav
24 libraries and the SDL library. It is mostly used as a testbed for the
25 various Libav APIs.
26 @c man end
27
28 @chapter Options
29 @c man begin OPTIONS
30
31 @include avtools-common-opts.texi
32
33 @section Main options
34
35 @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 This option has been removed. Use private format options for specifying the
42 input video size.  For example with the rawvideo demuxer you need to specify the
43 option @var{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 @item -t @var{duration}
51 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 @item -window_title @var{title}
59 Set window title (default is the input filename).
60 @item -loop @var{number}
61 Loops movie playback <number> times. 0 means forever.
62 @item -vf @var{filter_graph}
63 @var{filter_graph} is a description of the filter graph to apply to
64 the input video.
65 Use the option "-filters" to show all the available filters (including
66 also sources and sinks).
67
68 @end table
69
70 @section Advanced options
71 @table @option
72 @item -pix_fmt @var{format}
73 This option has been removed. Use private options for specifying the
74 input pixel format. For example with the rawvideo demuxer you need to specify
75 the option @var{pixel_format}.
76 @item -stats
77 Show the stream duration, the codec parameters, the current position in
78 the stream and the audio/video synchronisation drift.
79 @item -debug
80 Print specific debug info.
81 @item -bug
82 Work around bugs.
83 @item -vismv
84 Visualize motion vectors.
85 @item -fast
86 Non-spec-compliant optimizations.
87 @item -genpts
88 Generate pts.
89 @item -rtp_tcp
90 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
91 if you are streaming with the RTSP protocol.
92 @item -sync @var{type}
93 Set the master clock to audio (@code{type=audio}), video
94 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
95 master clock is used to control audio-video synchronization. Most media
96 players use audio as master clock, but in some cases (streaming or high
97 quality broadcast) it is necessary to change that. This option is mainly
98 used for debugging purposes.
99 @item -threads @var{count}
100 Set the thread count.
101 @item -ast @var{audio_stream_number}
102 Select the desired audio stream number, counting from 0. The number
103 refers to the list of all the input audio streams. If it is greater
104 than the number of audio streams minus one, then the last one is
105 selected, if it is negative the audio playback is disabled.
106 @item -vst @var{video_stream_number}
107 Select the desired video stream number, counting from 0. The number
108 refers to the list of all the input video streams. If it is greater
109 than the number of video streams minus one, then the last one is
110 selected, if it is negative the video playback is disabled.
111 @item -sst @var{subtitle_stream_number}
112 Select the desired subtitle stream number, counting from 0. The number
113 refers to the list of all the input subtitle streams. If it is greater
114 than the number of subtitle streams minus one, then the last one is
115 selected, if it is negative the subtitle rendering is disabled.
116 @item -autoexit
117 Exit when video is done playing.
118 @item -exitonkeydown
119 Exit if any key is pressed.
120 @item -exitonmousedown
121 Exit if any mouse button is pressed.
122 @end table
123
124 @section While playing
125
126 @table @key
127 @item q, ESC
128 Quit.
129
130 @item f
131 Toggle full screen.
132
133 @item p, SPC
134 Pause.
135
136 @item a
137 Cycle audio channel.
138
139 @item v
140 Cycle video channel.
141
142 @item t
143 Cycle subtitle channel.
144
145 @item w
146 Show audio waves.
147
148 @item left/right
149 Seek backward/forward 10 seconds.
150
151 @item down/up
152 Seek backward/forward 1 minute.
153
154 @item mouse click
155 Seek to percentage in file corresponding to fraction of width.
156
157 @end table
158
159 @c man end
160
161 @include eval.texi
162 @include demuxers.texi
163 @include muxers.texi
164 @include indevs.texi
165 @include outdevs.texi
166 @include protocols.texi
167 @include filters.texi
168
169 @ignore
170
171 @setfilename avplay
172 @settitle AVplay media player
173
174 @c man begin SEEALSO
175 avconv(1), avprobe(1) and the Libav HTML documentation
176 @c man end
177
178 @c man begin AUTHORS
179 The Libav developers
180 @c man end
181
182 @end ignore
183
184 @bye