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