Fix spelling errors in texi files: accomodate -> accommodate allows to -> allows...
[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 @subsection Examples
26
27 @itemize
28 @item
29 Play a file on default ALSA device:
30 @example
31 ffmpeg -i INPUT -f alsa default
32 @end example
33
34 @item
35 Play a file on soundcard 1, audio device 7:
36 @example
37 ffmpeg -i INPUT -f alsa hw:1,7
38 @end example
39 @end itemize
40
41 @section caca
42
43 CACA output device.
44
45 This output device allows one to show a video stream in CACA window.
46 Only one CACA window is allowed per application, so you can
47 have only one instance of this output device in an application.
48
49 To enable this output device you need to configure FFmpeg with
50 @code{--enable-libcaca}.
51 libcaca is a graphics library that outputs text instead of pixels.
52
53 For more information about libcaca, check:
54 @url{http://caca.zoy.org/wiki/libcaca}
55
56 @subsection Options
57
58 @table @option
59
60 @item window_title
61 Set the CACA window title, if not specified default to the filename
62 specified for the output device.
63
64 @item window_size
65 Set the CACA window size, can be a string of the form
66 @var{width}x@var{height} or a video size abbreviation.
67 If not specified it defaults to the size of the input video.
68
69 @item driver
70 Set display driver.
71
72 @item algorithm
73 Set dithering algorithm. Dithering is necessary
74 because the picture being rendered has usually far more colours than
75 the available palette.
76 The accepted values are listed with @code{-list_dither algorithms}.
77
78 @item antialias
79 Set antialias method. Antialiasing smoothens the rendered
80 image and avoids the commonly seen staircase effect.
81 The accepted values are listed with @code{-list_dither antialiases}.
82
83 @item charset
84 Set which characters are going to be used when rendering text.
85 The accepted values are listed with @code{-list_dither charsets}.
86
87 @item color
88 Set color to be used when rendering text.
89 The accepted values are listed with @code{-list_dither colors}.
90
91 @item list_drivers
92 If set to @option{true}, print a list of available drivers and exit.
93
94 @item list_dither
95 List available dither options related to the argument.
96 The argument must be one of @code{algorithms}, @code{antialiases},
97 @code{charsets}, @code{colors}.
98 @end table
99
100 @subsection Examples
101
102 @itemize
103 @item
104 The following command shows the @command{ffmpeg} output is an
105 CACA window, forcing its size to 80x25:
106 @example
107 ffmpeg -i INPUT -vcodec rawvideo -pix_fmt rgb24 -window_size 80x25 -f caca -
108 @end example
109
110 @item
111 Show the list of available drivers and exit:
112 @example
113 ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_drivers true -
114 @end example
115
116 @item
117 Show the list of available dither colors and exit:
118 @example
119 ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_dither colors -
120 @end example
121 @end itemize
122
123 @section decklink
124
125 The decklink output device provides playback capabilities for Blackmagic
126 DeckLink devices.
127
128 To enable this output device, you need the Blackmagic DeckLink SDK and you
129 need to configure with the appropriate @code{--extra-cflags}
130 and @code{--extra-ldflags}.
131 On Windows, you need to run the IDL files through @command{widl}.
132
133 DeckLink is very picky about the formats it supports. Pixel format is always
134 uyvy422, framerate and video size must be determined for your device with
135 @command{-list_formats 1}. Audio sample rate is always 48 kHz.
136
137 @subsection Options
138
139 @table @option
140
141 @item list_devices
142 If set to @option{true}, print a list of devices and exit.
143 Defaults to @option{false}.
144
145 @item list_formats
146 If set to @option{true}, print a list of supported formats and exit.
147 Defaults to @option{false}.
148
149 @item preroll
150 Amount of time to preroll video in seconds.
151 Defaults to @option{0.5}.
152
153 @end table
154
155 @subsection Examples
156
157 @itemize
158
159 @item
160 List output devices:
161 @example
162 ffmpeg -i test.avi -f decklink -list_devices 1 dummy
163 @end example
164
165 @item
166 List supported formats:
167 @example
168 ffmpeg -i test.avi -f decklink -list_formats 1 'DeckLink Mini Monitor'
169 @end example
170
171 @item
172 Play video clip:
173 @example
174 ffmpeg -i test.avi -f decklink -pix_fmt uyvy422 'DeckLink Mini Monitor'
175 @end example
176
177 @item
178 Play video clip with non-standard framerate or video size:
179 @example
180 ffmpeg -i test.avi -f decklink -pix_fmt uyvy422 -s 720x486 -r 24000/1001 'DeckLink Mini Monitor'
181 @end example
182
183 @end itemize
184
185 @section fbdev
186
187 Linux framebuffer output device.
188
189 The Linux framebuffer is a graphic hardware-independent abstraction
190 layer to show graphics on a computer monitor, typically on the
191 console. It is accessed through a file device node, usually
192 @file{/dev/fb0}.
193
194 For more detailed information read the file
195 @file{Documentation/fb/framebuffer.txt} included in the Linux source tree.
196
197 @subsection Options
198 @table @option
199
200 @item xoffset
201 @item yoffset
202 Set x/y coordinate of top left corner. Default is 0.
203 @end table
204
205 @subsection Examples
206 Play a file on framebuffer device @file{/dev/fb0}.
207 Required pixel format depends on current framebuffer settings.
208 @example
209 ffmpeg -re -i INPUT -vcodec rawvideo -pix_fmt bgra -f fbdev /dev/fb0
210 @end example
211
212 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
213
214 @section opengl
215 OpenGL output device.
216
217 To enable this output device you need to configure FFmpeg with @code{--enable-opengl}.
218
219 Device allows to render to OpenGL context.
220 Context may be provided by application or default SDL window is created.
221
222 When device renders to external context, application must implement handlers for following messages:
223 @code{AV_CTL_MESSAGE_CREATE_WINDOW_BUFFER} - create OpenGL context on current thread.
224 @code{AV_CTL_MESSAGE_PREPARE_WINDOW_BUFFER} - make OpenGL context current.
225 @code{AV_CTL_MESSAGE_DISPLAY_WINDOW_BUFFER} - swap buffers.
226 @code{AV_CTL_MESSAGE_DESTROY_WINDOW_BUFFER} - destroy OpenGL context.
227 Application is also required to inform a device about current resolution by sending @code{AV_DEVICE_WINDOW_RESIZED} message.
228
229 @subsection Options
230 @table @option
231
232 @item background
233 Set background color. Black is a default.
234 @item no_window
235 Disables default SDL window when set to non-zero value.
236 Application must provide OpenGL context and both @code{window_size_cb} and @code{window_swap_buffers_cb} callbacks when set.
237 @item window_title
238 Set the SDL window title, if not specified default to the filename specified for the output device.
239 Ignored when @option{no_window} is set.
240
241 @end table
242
243 @subsection Examples
244 Play a file on SDL window using OpenGL rendering:
245 @example
246 ffmpeg  -i INPUT -f opengl "window title"
247 @end example
248
249 @section oss
250
251 OSS (Open Sound System) output device.
252
253 @section pulse
254
255 PulseAudio output device.
256
257 To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
258
259 More information about PulseAudio can be found on @url{http://www.pulseaudio.org}
260
261 @subsection Options
262 @table @option
263
264 @item server
265 Connect to a specific PulseAudio server, specified by an IP address.
266 Default server is used when not provided.
267
268 @item name
269 Specify the application name PulseAudio will use when showing active clients,
270 by default it is the @code{LIBAVFORMAT_IDENT} string.
271
272 @item stream_name
273 Specify the stream name PulseAudio will use when showing active streams,
274 by default it is set to the specified output name.
275
276 @item device
277 Specify the device to use. Default device is used when not provided.
278 List of output devices can be obtained with command @command{pactl list sinks}.
279
280 @item buffer_size
281 @item buffer_duration
282 Control the size and duration of the PulseAudio buffer. A small buffer
283 gives more control, but requires more frequent updates.
284
285 @option{buffer_size} specifies size in bytes while
286 @option{buffer_duration} specifies duration in milliseconds.
287
288 When both options are provided then the highest value is used
289 (duration is recalculated to bytes using stream parameters). If they
290 are set to 0 (which is default), the device will use the default
291 PulseAudio duration value. By default PulseAudio set buffer duration
292 to around 2 seconds.
293 @end table
294
295 @subsection Examples
296 Play a file on default device on default server:
297 @example
298 ffmpeg  -i INPUT -f pulse "stream name"
299 @end example
300
301 @section sdl
302
303 SDL (Simple DirectMedia Layer) output device.
304
305 This output device allows one to show a video stream in an SDL
306 window. Only one SDL window is allowed per application, so you can
307 have only one instance of this output device in an application.
308
309 To enable this output device you need libsdl installed on your system
310 when configuring your build.
311
312 For more information about SDL, check:
313 @url{http://www.libsdl.org/}
314
315 @subsection Options
316
317 @table @option
318
319 @item window_title
320 Set the SDL window title, if not specified default to the filename
321 specified for the output device.
322
323 @item icon_title
324 Set the name of the iconified SDL window, if not specified it is set
325 to the same value of @var{window_title}.
326
327 @item window_size
328 Set the SDL window size, can be a string of the form
329 @var{width}x@var{height} or a video size abbreviation.
330 If not specified it defaults to the size of the input video,
331 downscaled according to the aspect ratio.
332
333 @item window_fullscreen
334 Set fullscreen mode when non-zero value is provided.
335 Default value is zero.
336 @end table
337
338 @subsection Interactive commands
339
340 The window created by the device can be controlled through the
341 following interactive commands.
342
343 @table @key
344 @item q, ESC
345 Quit the device immediately.
346 @end table
347
348 @subsection Examples
349
350 The following command shows the @command{ffmpeg} output is an
351 SDL window, forcing its size to the qcif format:
352 @example
353 ffmpeg -i INPUT -vcodec rawvideo -pix_fmt yuv420p -window_size qcif -f sdl "SDL output"
354 @end example
355
356 @section sndio
357
358 sndio audio output device.
359
360 @section xv
361
362 XV (XVideo) output device.
363
364 This output device allows one to show a video stream in a X Window System
365 window.
366
367 @subsection Options
368
369 @table @option
370 @item display_name
371 Specify the hardware display name, which determines the display and
372 communications domain to be used.
373
374 The display name or DISPLAY environment variable can be a string in
375 the format @var{hostname}[:@var{number}[.@var{screen_number}]].
376
377 @var{hostname} specifies the name of the host machine on which the
378 display is physically attached. @var{number} specifies the number of
379 the display server on that host machine. @var{screen_number} specifies
380 the screen to be used on that server.
381
382 If unspecified, it defaults to the value of the DISPLAY environment
383 variable.
384
385 For example, @code{dual-headed:0.1} would specify screen 1 of display
386 0 on the machine named ``dual-headed''.
387
388 Check the X11 specification for more detailed information about the
389 display name format.
390
391 @item window_size
392 Set the created window size, can be a string of the form
393 @var{width}x@var{height} or a video size abbreviation. If not
394 specified it defaults to the size of the input video.
395
396 @item window_x
397 @item window_y
398 Set the X and Y window offsets for the created window. They are both
399 set to 0 by default. The values may be ignored by the window manager.
400
401 @item window_title
402 Set the window title, if not specified default to the filename
403 specified for the output device.
404 @end table
405
406 For more information about XVideo see @url{http://www.x.org/}.
407
408 @subsection Examples
409
410 @itemize
411 @item
412 Decode, display and encode video input with @command{ffmpeg} at the
413 same time:
414 @example
415 ffmpeg -i INPUT OUTPUT -f xv display
416 @end example
417
418 @item
419 Decode and display the input video to multiple X11 windows:
420 @example
421 ffmpeg -i INPUT -f xv normal -vf negate -f xv negated
422 @end example
423 @end itemize
424
425 @c man end OUTPUT DEVICES