doc/outdevs: fix @code{} syntax in caca device docs
[ffmpeg.git] / doc / outdevs.texi
1 @chapter Output Devices
2 @c man begin OUTPUT DEVICES
3
4 Output devices are configured elements in FFmpeg which allow to 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 devices 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
61 @item antialias
62 Set antialias method. Antialiasing smoothens the rendered
63 image and avoids the commonly seen staircase effect.
64
65 @item charset
66 Set which characters are going to be used when rendering text.
67
68 @item colors
69 Set colors to be used when rendering text.
70
71 @item list_drivers
72 List available drivers.
73
74 @item list_dither
75 List available dither options.
76 @end table
77
78 @subsection Examples
79
80 The following command shows the @command{ffmpeg} output is an
81 CACA window, forcing its size to 80x25:
82 @example
83 ffmpeg -i INPUT -vcodec rawvideo -pix_fmt rgb24 -window_size 80x25 -f caca -
84 @end example
85
86 @section oss
87
88 OSS (Open Sound System) output device.
89
90 @section sdl
91
92 SDL (Simple DirectMedia Layer) output device.
93
94 This output devices allows to show a video stream in an SDL
95 window. Only one SDL window is allowed per application, so you can
96 have only one instance of this output device in an application.
97
98 To enable this output device you need libsdl installed on your system
99 when configuring your build.
100
101 For more information about SDL, check:
102 @url{http://www.libsdl.org/}
103
104 @subsection Options
105
106 @table @option
107
108 @item window_title
109 Set the SDL window title, if not specified default to the filename
110 specified for the output device.
111
112 @item icon_title
113 Set the name of the iconified SDL window, if not specified it is set
114 to the same value of @var{window_title}.
115
116 @item window_size
117 Set the SDL window size, can be a string of the form
118 @var{width}x@var{height} or a video size abbreviation.
119 If not specified it defaults to the size of the input video,
120 downscaled according to the aspect ratio.
121 @end table
122
123 @subsection Examples
124
125 The following command shows the @command{ffmpeg} output is an
126 SDL window, forcing its size to the qcif format:
127 @example
128 ffmpeg -i INPUT -vcodec rawvideo -pix_fmt yuv420p -window_size qcif -f sdl "SDL output"
129 @end example
130
131 @section sndio
132
133 sndio audio output device.
134
135 @c man end OUTPUT DEVICES