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