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