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