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