doc/outdevs: add sdl window_fullscreen option
[ffmpeg.git] / doc / outdevs.texi
1 @chapter Output Devices
2 @c man begin OUTPUT DEVICES
3
4 Output devices are configured elements in FFmpeg that can write
5 multimedia data to an output device attached to your system.
6
7 When you configure your FFmpeg build, all the supported output devices
8 are enabled by default. You can list all available ones using the
9 configure option "--list-outdevs".
10
11 You can disable all the output devices using the configure option
12 "--disable-outdevs", and selectively enable an output device using the
13 option "--enable-outdev=@var{OUTDEV}", or you can disable a particular
14 input device using the option "--disable-outdev=@var{OUTDEV}".
15
16 The option "-formats" of the ff* tools will display the list of
17 enabled output devices (amongst the muxers).
18
19 A description of the currently available output devices follows.
20
21 @section alsa
22
23 ALSA (Advanced Linux Sound Architecture) output device.
24
25 @section caca
26
27 CACA output device.
28
29 This output device allows to show a video stream in CACA window.
30 Only one CACA window is allowed per application, so you can
31 have only one instance of this output device in an application.
32
33 To enable this output device you need to configure FFmpeg with
34 @code{--enable-libcaca}.
35 libcaca is a graphics library that outputs text instead of pixels.
36
37 For more information about libcaca, check:
38 @url{http://caca.zoy.org/wiki/libcaca}
39
40 @subsection Options
41
42 @table @option
43
44 @item window_title
45 Set the CACA window title, if not specified default to the filename
46 specified for the output device.
47
48 @item window_size
49 Set the CACA window size, can be a string of the form
50 @var{width}x@var{height} or a video size abbreviation.
51 If not specified it defaults to the size of the input video.
52
53 @item driver
54 Set display driver.
55
56 @item algorithm
57 Set dithering algorithm. Dithering is necessary
58 because the picture being rendered has usually far more colours than
59 the available palette.
60 The accepted values are listed with @code{-list_dither algorithms}.
61
62 @item antialias
63 Set antialias method. Antialiasing smoothens the rendered
64 image and avoids the commonly seen staircase effect.
65 The accepted values are listed with @code{-list_dither antialiases}.
66
67 @item charset
68 Set which characters are going to be used when rendering text.
69 The accepted values are listed with @code{-list_dither charsets}.
70
71 @item color
72 Set color to be used when rendering text.
73 The accepted values are listed with @code{-list_dither colors}.
74
75 @item list_drivers
76 If set to @option{true}, print a list of available drivers and exit.
77
78 @item list_dither
79 List available dither options related to the argument.
80 The argument must be one of @code{algorithms}, @code{antialiases},
81 @code{charsets}, @code{colors}.
82 @end table
83
84 @subsection Examples
85
86 @itemize
87 @item
88 The following command shows the @command{ffmpeg} output is an
89 CACA window, forcing its size to 80x25:
90 @example
91 ffmpeg -i INPUT -vcodec rawvideo -pix_fmt rgb24 -window_size 80x25 -f caca -
92 @end example
93
94 @item
95 Show the list of available drivers and exit:
96 @example
97 ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_drivers true -
98 @end example
99
100 @item
101 Show the list of available dither colors and exit:
102 @example
103 ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_dither colors -
104 @end example
105 @end itemize
106
107 @section oss
108
109 OSS (Open Sound System) output device.
110
111 @section sdl
112
113 SDL (Simple DirectMedia Layer) output device.
114
115 This output device allows to show a video stream in an SDL
116 window. Only one SDL window is allowed per application, so you can
117 have only one instance of this output device in an application.
118
119 To enable this output device you need libsdl installed on your system
120 when configuring your build.
121
122 For more information about SDL, check:
123 @url{http://www.libsdl.org/}
124
125 @subsection Options
126
127 @table @option
128
129 @item window_title
130 Set the SDL window title, if not specified default to the filename
131 specified for the output device.
132
133 @item icon_title
134 Set the name of the iconified SDL window, if not specified it is set
135 to the same value of @var{window_title}.
136
137 @item window_size
138 Set the SDL window size, can be a string of the form
139 @var{width}x@var{height} or a video size abbreviation.
140 If not specified it defaults to the size of the input video,
141 downscaled according to the aspect ratio.
142
143 @item window_fullscreen
144 Set fullscreen mode when non-zero value is provided.
145 Zero is a default.
146 @end table
147
148 @subsection Examples
149
150 The following command shows the @command{ffmpeg} output is an
151 SDL window, forcing its size to the qcif format:
152 @example
153 ffmpeg -i INPUT -vcodec rawvideo -pix_fmt yuv420p -window_size qcif -f sdl "SDL output"
154 @end example
155
156 @section sndio
157
158 sndio audio output device.
159
160 @section xv
161
162 XV (XVideo) output device.
163
164 This output device allows to show a video stream in a X Window System
165 window.
166
167 @subsection Options
168
169 @table @option
170 @item display_name
171 Specify the hardware display name, which determines the display and
172 communications domain to be used.
173
174 The display name or DISPLAY environment variable can be a string in
175 the format @var{hostname}[:@var{number}[.@var{screen_number}]].
176
177 @var{hostname} specifies the name of the host machine on which the
178 display is physically attached. @var{number} specifies the number of
179 the display server on that host machine. @var{screen_number} specifies
180 the screen to be used on that server.
181
182 If unspecified, it defaults to the value of the DISPLAY environment
183 variable.
184
185 For example, @code{dual-headed:0.1} would specify screen 1 of display
186 0 on the machine named ``dual-headed''.
187
188 Check the X11 specification for more detailed information about the
189 display name format.
190
191 @item window_size
192 Set the created window size, can be a string of the form
193 @var{width}x@var{height} or a video size abbreviation. If not
194 specified it defaults to the size of the input video.
195
196 @item window_x
197 @item window_y
198 Set the X and Y window offsets for the created window. They are both
199 set to 0 by default. The values may be ignored by the window manager.
200
201 @item window_title
202 Set the window title, if not specified default to the filename
203 specified for the output device.
204 @end table
205
206 For more information about XVideo see @url{http://www.x.org/}.
207
208 @subsection Examples
209
210 @itemize
211 @item
212 Decode, display and encode video input with @command{ffmpeg} at the
213 same time:
214 @example
215 ffmpeg -i INPUT OUTPUT -f xv display
216 @end example
217
218 @item
219 Decode and display the input video to multiple X11 windows:
220 @example
221 ffmpeg -i INPUT -f xv normal -vf negate -f xv negated
222 @end example
223 @end itemize
224
225 @c man end OUTPUT DEVICES