doc/outdevs.texi
4419c8bf
 @chapter Output Devices
 @c man begin OUTPUT DEVICES
 
a6be21d3
 Output devices are configured elements in FFmpeg which allow to write
4419c8bf
 multimedia data to an output device attached to your system.
 
a6be21d3
 When you configure your FFmpeg build, all the supported output devices
2f6bc4e7
 are enabled by default. You can list all available ones using the
 configure option "--list-outdevs".
4419c8bf
 
 You can disable all the output devices using the configure option
 "--disable-outdevs", and selectively enable an output device using the
 option "--enable-outdev=@var{OUTDEV}", or you can disable a particular
 input device using the option "--disable-outdev=@var{OUTDEV}".
 
 The option "-formats" of the ff* tools will display the list of
 enabled output devices (amongst the muxers).
 
 A description of the currently available output devices follows.
 
 @section alsa
 
 ALSA (Advanced Linux Sound Architecture) output device.
 
296c1b6b
 @section caca
 
 CACA output device.
 
 This output devices allows to show a video stream in CACA window.
 Only one CACA window is allowed per application, so you can
 have only one instance of this output device in an application.
 
 To enable this output device you need to configure FFmpeg with
beef7a63
 @code{--enable-libcaca}.
296c1b6b
 libcaca is a graphics library that outputs text instead of pixels.
 
 For more information about libcaca, check:
 @url{http://caca.zoy.org/wiki/libcaca}
 
 @subsection Options
 
 @table @option
 
 @item window_title
 Set the CACA window title, if not specified default to the filename
 specified for the output device.
 
 @item window_size
 Set the CACA window size, can be a string of the form
 @var{width}x@var{height} or a video size abbreviation.
 If not specified it defaults to the size of the input video.
 
 @item driver
 Set display driver.
 
 @item algorithm
 Set dithering algorithm. Dithering is necessary
 because the picture being rendered has usually far more colours than
 the available palette.
2fd88044
 The accepted values are listed with @code{-list_dither algorithms}.
296c1b6b
 
 @item antialias
 Set antialias method. Antialiasing smoothens the rendered
 image and avoids the commonly seen staircase effect.
2fd88044
 The accepted values are listed with @code{-list_dither antialiases}.
296c1b6b
 
 @item charset
 Set which characters are going to be used when rendering text.
2fd88044
 The accepted values are listed with @code{-list_dither charsets}.
296c1b6b
 
fa71471c
 @item color
 Set color to be used when rendering text.
2fd88044
 The accepted values are listed with @code{-list_dither colors}.
296c1b6b
 
 @item list_drivers
2fd88044
 If set to @option{true}, print a list of available drivers and exit.
296c1b6b
 
 @item list_dither
2fd88044
 List available dither options related to the argument.
 The argument must be one of @code{algorithms}, @code{antialiases},
 @code{charsets}, @code{colors}.
296c1b6b
 @end table
 
 @subsection Examples
 
2fd88044
 @itemize
 @item
296c1b6b
 The following command shows the @command{ffmpeg} output is an
 CACA window, forcing its size to 80x25:
 @example
 ffmpeg -i INPUT -vcodec rawvideo -pix_fmt rgb24 -window_size 80x25 -f caca -
 @end example
 
2fd88044
 @item
 Show the list of available drivers and exit:
 @example
 ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_drivers true -
 @end example
 
 @item
 Show the list of available dither colors and exit:
 @example
 ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_dither colors -
 @end example
 @end itemize
 
4419c8bf
 @section oss
 
 OSS (Open Sound System) output device.
 
b2a6f25c
 @section sdl
 
551b9eb9
 SDL (Simple DirectMedia Layer) output device.
b2a6f25c
 
 This output devices allows to show a video stream in an SDL
 window. Only one SDL window is allowed per application, so you can
 have only one instance of this output device in an application.
 
 To enable this output device you need libsdl installed on your system
 when configuring your build.
 
 For more information about SDL, check:
 @url{http://www.libsdl.org/}
 
 @subsection Options
 
 @table @option
 
 @item window_title
0d0fdb0a
 Set the SDL window title, if not specified default to the filename
 specified for the output device.
b2a6f25c
 
 @item icon_title
 Set the name of the iconified SDL window, if not specified it is set
 to the same value of @var{window_title}.
 
 @item window_size
 Set the SDL window size, can be a string of the form
 @var{width}x@var{height} or a video size abbreviation.
4adf5dfa
 If not specified it defaults to the size of the input video,
 downscaled according to the aspect ratio.
b2a6f25c
 @end table
 
 @subsection Examples
 
dc7ad85c
 The following command shows the @command{ffmpeg} output is an
b2a6f25c
 SDL window, forcing its size to the qcif format:
 @example
0d0fdb0a
 ffmpeg -i INPUT -vcodec rawvideo -pix_fmt yuv420p -window_size qcif -f sdl "SDL output"
b2a6f25c
 @end example
 
15d59d2c
 @section sndio
 
 sndio audio output device.
 
4419c8bf
 @c man end OUTPUT DEVICES