doc/outdevs/sdl: fix confusing text about window_fullscreen default value
[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 fbdev
108
109 Linux framebuffer output device.
110
111 The Linux framebuffer is a graphic hardware-independent abstraction
112 layer to show graphics on a computer monitor, typically on the
113 console. It is accessed through a file device node, usually
114 @file{/dev/fb0}.
115
116 For more detailed information read the file
117 @file{Documentation/fb/framebuffer.txt} included in the Linux source tree.
118
119 @subsection Options
120 @table @option
121
122 @item xoffset
123 @item yoffset
124 Set x/y coordinate of top left corner. Default is 0.
125 @end table
126
127 @subsection Examples
128 Play a file on framebuffer device @file{/dev/fb0}.
129 Required pixel format depends on current framebuffer settings.
130 @example
131 ffmpeg -re -i INPUT -vcodec rawvideo -pix_fmt bgra -f fbdev /dev/fb0
132 @end example
133
134 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
135
136 @section oss
137
138 OSS (Open Sound System) output device.
139
140 @section pulse
141
142 PulseAudio output device.
143
144 To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
145
146 More information about PulseAudio can be found on @url{http://www.pulseaudio.org}
147
148 @subsection Options
149 @table @option
150
151 @item server
152 Connect to a specific PulseAudio server, specified by an IP address.
153 Default server is used when not provided.
154
155 @item name
156 Specify the application name PulseAudio will use when showing active clients,
157 by default it is the @code{LIBAVFORMAT_IDENT} string.
158
159 @item stream_name
160 Specify the stream name PulseAudio will use when showing active streams,
161 by default it is set to the specified output name.
162
163 @item device
164 Specify the device to use. Default device is used when not provided.
165 List of output devices can be obtained with command @command{pactl list sinks}.
166
167 @end table
168
169 @subsection Examples
170 Play a file on default device on default server:
171 @example
172 ffmpeg  -i INPUT -f pulse "stream name"
173 @end example
174
175 @section sdl
176
177 SDL (Simple DirectMedia Layer) output device.
178
179 This output device allows to show a video stream in an SDL
180 window. Only one SDL window is allowed per application, so you can
181 have only one instance of this output device in an application.
182
183 To enable this output device you need libsdl installed on your system
184 when configuring your build.
185
186 For more information about SDL, check:
187 @url{http://www.libsdl.org/}
188
189 @subsection Options
190
191 @table @option
192
193 @item window_title
194 Set the SDL window title, if not specified default to the filename
195 specified for the output device.
196
197 @item icon_title
198 Set the name of the iconified SDL window, if not specified it is set
199 to the same value of @var{window_title}.
200
201 @item window_size
202 Set the SDL window size, can be a string of the form
203 @var{width}x@var{height} or a video size abbreviation.
204 If not specified it defaults to the size of the input video,
205 downscaled according to the aspect ratio.
206
207 @item window_fullscreen
208 Set fullscreen mode when non-zero value is provided.
209 Default value is zero.
210 @end table
211
212 @subsection Examples
213
214 The following command shows the @command{ffmpeg} output is an
215 SDL window, forcing its size to the qcif format:
216 @example
217 ffmpeg -i INPUT -vcodec rawvideo -pix_fmt yuv420p -window_size qcif -f sdl "SDL output"
218 @end example
219
220 @section sndio
221
222 sndio audio output device.
223
224 @section xv
225
226 XV (XVideo) output device.
227
228 This output device allows to show a video stream in a X Window System
229 window.
230
231 @subsection Options
232
233 @table @option
234 @item display_name
235 Specify the hardware display name, which determines the display and
236 communications domain to be used.
237
238 The display name or DISPLAY environment variable can be a string in
239 the format @var{hostname}[:@var{number}[.@var{screen_number}]].
240
241 @var{hostname} specifies the name of the host machine on which the
242 display is physically attached. @var{number} specifies the number of
243 the display server on that host machine. @var{screen_number} specifies
244 the screen to be used on that server.
245
246 If unspecified, it defaults to the value of the DISPLAY environment
247 variable.
248
249 For example, @code{dual-headed:0.1} would specify screen 1 of display
250 0 on the machine named ``dual-headed''.
251
252 Check the X11 specification for more detailed information about the
253 display name format.
254
255 @item window_size
256 Set the created window size, can be a string of the form
257 @var{width}x@var{height} or a video size abbreviation. If not
258 specified it defaults to the size of the input video.
259
260 @item window_x
261 @item window_y
262 Set the X and Y window offsets for the created window. They are both
263 set to 0 by default. The values may be ignored by the window manager.
264
265 @item window_title
266 Set the window title, if not specified default to the filename
267 specified for the output device.
268 @end table
269
270 For more information about XVideo see @url{http://www.x.org/}.
271
272 @subsection Examples
273
274 @itemize
275 @item
276 Decode, display and encode video input with @command{ffmpeg} at the
277 same time:
278 @example
279 ffmpeg -i INPUT OUTPUT -f xv display
280 @end example
281
282 @item
283 Decode and display the input video to multiple X11 windows:
284 @example
285 ffmpeg -i INPUT -f xv normal -vf negate -f xv negated
286 @end example
287 @end itemize
288
289 @c man end OUTPUT DEVICES