1 @chapter Output Devices
2 @c man begin OUTPUT DEVICES
4 Output devices are configured elements in FFmpeg that can write
5 multimedia data to an output device attached to your system.
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".
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}".
16 The option "-formats" of the ff* tools will display the list of
17 enabled output devices (amongst the muxers).
19 A description of the currently available output devices follows.
23 ALSA (Advanced Linux Sound Architecture) output device.
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.
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.
37 For more information about libcaca, check:
38 @url{http://caca.zoy.org/wiki/libcaca}
45 Set the CACA window title, if not specified default to the filename
46 specified for the output device.
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.
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}.
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}.
68 Set which characters are going to be used when rendering text.
69 The accepted values are listed with @code{-list_dither charsets}.
72 Set color to be used when rendering text.
73 The accepted values are listed with @code{-list_dither colors}.
76 If set to @option{true}, print a list of available drivers and exit.
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}.
88 The following command shows the @command{ffmpeg} output is an
89 CACA window, forcing its size to 80x25:
91 ffmpeg -i INPUT -vcodec rawvideo -pix_fmt rgb24 -window_size 80x25 -f caca -
95 Show the list of available drivers and exit:
97 ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_drivers true -
101 Show the list of available dither colors and exit:
103 ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_dither colors -
109 Linux framebuffer output device.
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
116 For more detailed information read the file
117 @file{Documentation/fb/framebuffer.txt} included in the Linux source tree.
124 Set x/y coordinate of top left corner. Default is 0.
128 Play a file on framebuffer device @file{/dev/fb0}.
129 Required pixel format depends on current framebuffer settings.
131 ffmpeg -re -i INPUT -vcodec rawvideo -pix_fmt bgra -f fbdev /dev/fb0
134 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
138 OSS (Open Sound System) output device.
142 PulseAudio output device.
144 To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
146 More information about PulseAudio can be found on @url{http://www.pulseaudio.org}
152 Connect to a specific PulseAudio server, specified by an IP address.
153 Default server is used when not provided.
156 Specify the application name PulseAudio will use when showing active clients,
157 by default it is the @code{LIBAVFORMAT_IDENT} string.
160 Specify the stream name PulseAudio will use when showing active streams,
161 by default it is set to the specified output name.
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}.
170 Play a file on default device on default server:
172 ffmpeg -i INPUT -f pulse "stream name"
177 SDL (Simple DirectMedia Layer) output device.
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.
183 To enable this output device you need libsdl installed on your system
184 when configuring your build.
186 For more information about SDL, check:
187 @url{http://www.libsdl.org/}
194 Set the SDL window title, if not specified default to the filename
195 specified for the output device.
198 Set the name of the iconified SDL window, if not specified it is set
199 to the same value of @var{window_title}.
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.
207 @item window_fullscreen
208 Set fullscreen mode when non-zero value is provided.
214 The following command shows the @command{ffmpeg} output is an
215 SDL window, forcing its size to the qcif format:
217 ffmpeg -i INPUT -vcodec rawvideo -pix_fmt yuv420p -window_size qcif -f sdl "SDL output"
222 sndio audio output device.
226 XV (XVideo) output device.
228 This output device allows to show a video stream in a X Window System
235 Specify the hardware display name, which determines the display and
236 communications domain to be used.
238 The display name or DISPLAY environment variable can be a string in
239 the format @var{hostname}[:@var{number}[.@var{screen_number}]].
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.
246 If unspecified, it defaults to the value of the DISPLAY environment
249 For example, @code{dual-headed:0.1} would specify screen 1 of display
250 0 on the machine named ``dual-headed''.
252 Check the X11 specification for more detailed information about the
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.
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.
266 Set the window title, if not specified default to the filename
267 specified for the output device.
270 For more information about XVideo see @url{http://www.x.org/}.
276 Decode, display and encode video input with @command{ffmpeg} at the
279 ffmpeg -i INPUT OUTPUT -f xv display
283 Decode and display the input video to multiple X11 windows:
285 ffmpeg -i INPUT -f xv normal -vf negate -f xv negated
289 @c man end OUTPUT DEVICES