framebuffer device demuxer
[ffmpeg.git] / doc / indevs.texi
1 @chapter Input Devices
2 @c man begin INPUT DEVICES
3
4 Input devices are configured elements in FFmpeg which allow to access
5 the data coming from a multimedia device attached to your system.
6
7 When you configure your FFmpeg build, all the supported input devices
8 are enabled by default. You can list all available ones using the
9 configure option "--list-indevs".
10
11 You can disable all the input devices using the configure option
12 "--disable-indevs", and selectively enable an input device using the
13 option "--enable-indev=@var{INDEV}", or you can disable a particular
14 input device using the option "--disable-indev=@var{INDEV}".
15
16 The option "-formats" of the ff* tools will display the list of
17 supported input devices (amongst the demuxers).
18
19 A description of the currently available input devices follows.
20
21 @section alsa
22
23 ALSA (Advanced Linux Sound Architecture) input device.
24
25 To enable this input device during configuration you need libasound
26 installed on your system.
27
28 This device allows capturing from an ALSA device. The name of the
29 device to capture has to be an ALSA card identifier.
30
31 An ALSA identifier has the syntax:
32 @example
33 hw:@var{CARD}[,@var{DEV}[,@var{SUBDEV}]]
34 @end example
35
36 where the @var{DEV} and @var{SUBDEV} components are optional.
37
38 The three arguments (in order: @var{CARD},@var{DEV},@var{SUBDEV})
39 specify card number or identifier, device number and subdevice number
40 (-1 means any).
41
42 To see the list of cards currently recognized by your system check the
43 files @file{/proc/asound/cards} and @file{/proc/asound/devices}.
44
45 For example to capture with @file{ffmpeg} from an ALSA device with
46 card id 0, you may run the command:
47 @example
48 ffmpeg -f alsa -i hw:0 alsaout.wav
49 @end example
50
51 For more information see:
52 @url{http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html}
53
54 @section bktr
55
56 BSD video input device.
57
58 @section dv1394
59
60 Linux DV 1394 input device.
61
62 @section fbdev
63
64 Linux framebuffer input device.
65
66 The Linux framebuffer is a graphic hardware-independent abstraction
67 layer to show graphics on a computer monitor, typically on the
68 console. It is accessed through a file device node, usually
69 @file{/dev/fb0}.
70
71 For more detailed information read the file
72 Documentation/fb/framebuffer.txt included in the Linux source tree.
73
74 For example, to record from the framebuffer device @file{/dev/fb0} with
75 @file{ffmpeg}:
76 @example
77 ffmpeg -f fbdev -r 10 -i /dev/fb0 out.avi
78 @end example
79
80 You can take a single screenshot image with the command:
81 @example
82 ffmpeg -f fbdev -vframes 1 -r 1 -i /dev/fb0 screenshot.jpeg
83 @end example
84
85 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
86
87 @section jack
88
89 JACK input device.
90
91 To enable this input device during configuration you need libjack
92 installed on your system.
93
94 A JACK input device creates one or more JACK writable clients, one for
95 each audio channel, with name @var{client_name}:input_@var{N}, where
96 @var{client_name} is the name provided by the application, and @var{N}
97 is a number which identifies the channel.
98 Each writable client will send the acquired data to the FFmpeg input
99 device.
100
101 Once you have created one or more JACK readable clients, you need to
102 connect them to one or more JACK writable clients.
103
104 To connect or disconnect JACK clients you can use the
105 @file{jack_connect} and @file{jack_disconnect} programs, or do it
106 through a graphical interface, for example with @file{qjackctl}.
107
108 To list the JACK clients and their properties you can invoke the command
109 @file{jack_lsp}.
110
111 Follows an example which shows how to capture a JACK readable client
112 with @file{ffmpeg}.
113 @example
114 # Create a JACK writable client with name "ffmpeg".
115 $ ffmpeg -f jack -i ffmpeg -y out.wav
116
117 # Start the sample jack_metro readable client.
118 $ jack_metro -b 120 -d 0.2 -f 4000
119
120 # List the current JACK clients.
121 $ jack_lsp -c
122 system:capture_1
123 system:capture_2
124 system:playback_1
125 system:playback_2
126 ffmpeg:input_1
127 metro:120_bpm
128
129 # Connect metro to the ffmpeg writable client.
130 $ jack_connect metro:120_bpm ffmpeg:input_1
131 @end example
132
133 For more information read:
134 @url{http://jackaudio.org/}
135
136 @section libdc1394
137
138 IIDC1394 input device, based on libdc1394 and libraw1394.
139
140 @section oss
141
142 Open Sound System input device.
143
144 The filename to provide to the input device is the device node
145 representing the OSS input device, and is usually set to
146 @file{/dev/dsp}.
147
148 For example to grab from @file{/dev/dsp} using @file{ffmpeg} use the
149 command:
150 @example
151 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
152 @end example
153
154 For more information about OSS see:
155 @url{http://manuals.opensound.com/usersguide/dsp.html}
156
157 @section video4linux and video4linux2
158
159 Video4Linux and Video4Linux2 input video devices.
160
161 The name of the device to grab is a file device node, usually Linux
162 systems tend to automatically create such nodes when the device
163 (e.g. an USB webcam) is plugged into the system, and has a name of the
164 kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
165 the device.
166
167 Video4Linux and Video4Linux2 devices only support a limited set of
168 @var{width}x@var{height} sizes and framerates. You can check which are
169 supported for example with the command @file{dov4l} for Video4Linux
170 devices and the command @file{v4l-info} for Video4Linux2 devices.
171
172 If the size for the device is set to 0x0, the input device will
173 try to autodetect the size to use.
174 Only for the video4linux2 device, if the frame rate is set to 0/0 the
175 input device will use the frame rate value already set in the driver.
176
177 Video4Linux support is deprecated since Linux 2.6.30, and will be
178 dropped in later versions.
179
180 Follow some usage examples of the video4linux devices with the ff*
181 tools.
182 @example
183 # Grab and show the input of a video4linux device, frame rate is set
184 # to the default of 25/1.
185 ffplay -s 320x240 -f video4linux /dev/video0
186
187 # Grab and show the input of a video4linux2 device, autoadjust size.
188 ffplay -f video4linux2 /dev/video0
189
190 # Grab and record the input of a video4linux2 device, autoadjust size,
191 # frame rate value defaults to 0/0 so it is read from the video4linux2
192 # driver.
193 ffmpeg -f video4linux2 -i /dev/video0 out.mpeg
194 @end example
195
196 @section vfwcap
197
198 VfW (Video for Windows) capture input device.
199
200 The filename passed as input is the capture driver number, ranging from
201 0 to 9. You may use "list" as filename to print a list of drivers. Any
202 other filename will be interpreted as device number 0.
203
204 @section x11grab
205
206 X11 video input device.
207
208 This device allows to capture a region of an X11 display.
209
210 The filename passed as input has the syntax:
211 @example
212 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
213 @end example
214
215 @var{hostname}:@var{display_number}.@var{screen_number} specifies the
216 X11 display name of the screen to grab from. @var{hostname} can be
217 ommitted, and defaults to "localhost". The environment variable
218 @env{DISPLAY} contains the default display name.
219
220 @var{x_offset} and @var{y_offset} specify the offsets of the grabbed
221 area with respect to the top-left border of the X11 screen. They
222 default to 0.
223
224 Check the X11 documentation (e.g. man X) for more detailed information.
225
226 Use the @file{dpyinfo} program for getting basic information about the
227 properties of your X11 display (e.g. grep for "name" or "dimensions").
228
229 For example to grab from @file{:0.0} using @file{ffmpeg}:
230 @example
231 ffmpeg -f x11grab -r 25 -s cif -i :0.0 out.mpg
232
233 # Grab at position 10,20.
234 ffmpeg -f x11grab -25 -s cif -i :0.0+10,20 out.mpg
235 @end example
236
237 @c man end INPUT DEVICES