Merge remote-tracking branch 'qatar/master'
[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 dshow
59
60 Windows DirectShow input device.
61
62 DirectShow support is enabled when FFmpeg is built with mingw-w64.
63 Currently only audio and video devices are supported.
64
65 Multiple devices may be opened as separate inputs, but they may also be
66 opened on the same input, which should improve synchronism between them.
67
68 The input name should be in the format:
69
70 @example
71 @var{TYPE}=@var{NAME}[:@var{TYPE}=@var{NAME}]
72 @end example
73
74 where @var{TYPE} can be either @var{audio} or @var{video},
75 and @var{NAME} is the device's name.
76
77 @subsection Options
78
79 If no options are specified, the device's defaults are used.
80 If the device does not support the requested options, it will
81 fail to open.
82
83 @table @option
84
85 @item video_size
86 Set the video size in the captured video.
87
88 @item framerate
89 Set the framerate in the captured video.
90
91 @item sample_rate
92 Set the sample rate (in Hz) of the captured audio.
93
94 @item sample_size
95 Set the sample size (in bits) of the captured audio.
96
97 @item channels
98 Set the number of channels in the captured audio.
99
100 @item list_devices
101 If set to @option{true}, print a list of devices and exit.
102
103 @item list_options
104 If set to @option{true}, print a list of selected device's options
105 and exit.
106
107 @end table
108
109 @subsection Examples
110
111 @itemize
112
113 @item
114 Print the list of DirectShow supported devices and exit:
115 @example
116 $ ffmpeg -list_devices true -f dshow -i dummy
117 @end example
118
119 @item
120 Open video device @var{Camera}:
121 @example
122 $ ffmpeg -f dshow -i video="Camera"
123 @end example
124
125 @item
126 Open video device @var{Camera} and audio device @var{Microphone}:
127 @example
128 $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
129 @end example
130
131 @item
132 Print the list of supported options in selected device and exit:
133 @example
134 $ ffmpeg -list_options true -f dshow -i video="Camera"
135 @end example
136
137 @end itemize
138
139 @section dv1394
140
141 Linux DV 1394 input device.
142
143 @section fbdev
144
145 Linux framebuffer input device.
146
147 The Linux framebuffer is a graphic hardware-independent abstraction
148 layer to show graphics on a computer monitor, typically on the
149 console. It is accessed through a file device node, usually
150 @file{/dev/fb0}.
151
152 For more detailed information read the file
153 Documentation/fb/framebuffer.txt included in the Linux source tree.
154
155 To record from the framebuffer device @file{/dev/fb0} with
156 @file{ffmpeg}:
157 @example
158 ffmpeg -f fbdev -r 10 -i /dev/fb0 out.avi
159 @end example
160
161 You can take a single screenshot image with the command:
162 @example
163 ffmpeg -f fbdev -vframes 1 -r 1 -i /dev/fb0 screenshot.jpeg
164 @end example
165
166 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
167
168 @section jack
169
170 JACK input device.
171
172 To enable this input device during configuration you need libjack
173 installed on your system.
174
175 A JACK input device creates one or more JACK writable clients, one for
176 each audio channel, with name @var{client_name}:input_@var{N}, where
177 @var{client_name} is the name provided by the application, and @var{N}
178 is a number which identifies the channel.
179 Each writable client will send the acquired data to the FFmpeg input
180 device.
181
182 Once you have created one or more JACK readable clients, you need to
183 connect them to one or more JACK writable clients.
184
185 To connect or disconnect JACK clients you can use the
186 @file{jack_connect} and @file{jack_disconnect} programs, or do it
187 through a graphical interface, for example with @file{qjackctl}.
188
189 To list the JACK clients and their properties you can invoke the command
190 @file{jack_lsp}.
191
192 Follows an example which shows how to capture a JACK readable client
193 with @file{ffmpeg}.
194 @example
195 # Create a JACK writable client with name "ffmpeg".
196 $ ffmpeg -f jack -i ffmpeg -y out.wav
197
198 # Start the sample jack_metro readable client.
199 $ jack_metro -b 120 -d 0.2 -f 4000
200
201 # List the current JACK clients.
202 $ jack_lsp -c
203 system:capture_1
204 system:capture_2
205 system:playback_1
206 system:playback_2
207 ffmpeg:input_1
208 metro:120_bpm
209
210 # Connect metro to the ffmpeg writable client.
211 $ jack_connect metro:120_bpm ffmpeg:input_1
212 @end example
213
214 For more information read:
215 @url{http://jackaudio.org/}
216
217 @section lavfi
218
219 Libavfilter input virtual device.
220
221 This input device reads data from the open output pads of a libavfilter
222 filtergraph.
223
224 For each filtergraph open output, the input device will create a
225 corresponding stream which is mapped to the generated output. Currently
226 only video data is supported. The filtergraph is specified through the
227 option @option{graph}.
228
229 @subsection Options
230
231 @table @option
232
233 @item graph
234 Specify the filtergraph to use as input. Each video open output must be
235 labelled by a unique string of the form "out@var{N}", where @var{N} is a
236 number starting from 0 corresponding to the mapped input stream
237 generated by the device.
238 The first unlabelled output is automatically assigned to the "out0"
239 label, but all the others need to be specified explicitely.
240
241 If not specified defaults to the filename specified for the input
242 device.
243 @end table
244
245 @subsection Examples
246
247 @itemize
248 @item
249 Create a color video stream and play it back with @file{ffplay}:
250 @example
251 ffplay -f lavfi -graph "color=pink [out0]" dummy
252 @end example
253
254 @item
255 As the previous example, but use filename for specifying the graph
256 description, and omit the "out0" label:
257 @example
258 ffplay -f lavfi color=pink
259 @end example
260
261 @item
262 Create three different video test filtered sources and play them:
263 @example
264 ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
265 @end example
266
267 @item
268 Read an audio stream from a file using the amovie source and play it
269 back with @file{ffplay}:
270 @example
271 ffplay -f lavfi "amovie=test.wav"
272 @end example
273
274 @item
275 Read an audio stream and a video stream and play it back with
276 @file{ffplay}:
277 @example
278 ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
279 @end example
280
281 @end itemize
282
283 @section libdc1394
284
285 IIDC1394 input device, based on libdc1394 and libraw1394.
286
287 @section openal
288
289 The OpenAL input device provides audio capture on all systems with a
290 working OpenAL 1.1 implementation.
291
292 To enable this input device during configuration, you need OpenAL
293 headers and libraries installed on your system, and need to configure
294 FFmpeg with @code{--enable-openal}.
295
296 OpenAL headers and libraries should be provided as part of your OpenAL
297 implementation, or as an additional download (an SDK). Depending on your
298 installation you may need to specify additional flags via the
299 @code{--extra-cflags} and @code{--extra-ldflags} for allowing the build
300 system to locate the OpenAL headers and libraries.
301
302 An incomplete list of OpenAL implementations follows:
303
304 @table @strong
305 @item Creative
306 The official Windows implementation, providing hardware acceleration
307 with supported devices and software fallback.
308 See @url{http://openal.org/}.
309 @item OpenAL Soft
310 Portable, open source (LGPL) software implementation. Includes
311 backends for the most common sound APIs on the Windows, Linux,
312 Solaris, and BSD operating systems.
313 See @url{http://kcat.strangesoft.net/openal.html}.
314 @item Apple
315 OpenAL is part of Core Audio, the official Mac OS X Audio interface.
316 See @url{http://developer.apple.com/technologies/mac/audio-and-video.html}
317 @end table
318
319 This device allows to capture from an audio input device handled
320 through OpenAL.
321
322 You need to specify the name of the device to capture in the provided
323 filename. If the empty string is provided, the device will
324 automatically select the default device. You can get the list of the
325 supported devices by using the option @var{list_devices}.
326
327 @subsection Options
328
329 @table @option
330
331 @item channels
332 Set the number of channels in the captured audio. Only the values
333 @option{1} (monaural) and @option{2} (stereo) are currently supported.
334 Defaults to @option{2}.
335
336 @item sample_size
337 Set the sample size (in bits) of the captured audio. Only the values
338 @option{8} and @option{16} are currently supported. Defaults to
339 @option{16}.
340
341 @item sample_rate
342 Set the sample rate (in Hz) of the captured audio.
343 Defaults to @option{44.1k}.
344
345 @item list_devices
346 If set to @option{true}, print a list of devices and exit.
347 Defaults to @option{false}.
348
349 @end table
350
351 @subsection Examples
352
353 Print the list of OpenAL supported devices and exit:
354 @example
355 $ ffmpeg -list_devices true -f openal -i dummy out.ogg
356 @end example
357
358 Capture from the OpenAL device @file{DR-BT101 via PulseAudio}:
359 @example
360 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
361 @end example
362
363 Capture from the default device (note the empty string '' as filename):
364 @example
365 $ ffmpeg -f openal -i '' out.ogg
366 @end example
367
368 Capture from two devices simultaneously, writing to two different files,
369 within the same @file{ffmpeg} command:
370 @example
371 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
372 @end example
373 Note: not all OpenAL implementations support multiple simultaneous capture -
374 try the latest OpenAL Soft if the above does not work.
375
376 @section oss
377
378 Open Sound System input device.
379
380 The filename to provide to the input device is the device node
381 representing the OSS input device, and is usually set to
382 @file{/dev/dsp}.
383
384 For example to grab from @file{/dev/dsp} using @file{ffmpeg} use the
385 command:
386 @example
387 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
388 @end example
389
390 For more information about OSS see:
391 @url{http://manuals.opensound.com/usersguide/dsp.html}
392
393 @section pulse
394
395 pulseaudio input device.
396
397 To enable this input device during configuration you need libpulse-simple
398 installed in your system.
399
400 The filename to provide to the input device is a source device or the
401 string "default"
402
403 To list the pulse source devices and their properties you can invoke
404 the command @file{pactl list sources}.
405
406 @example
407 avconv -f pulse -i default /tmp/pulse.wav
408 @end example
409
410 @subsection @var{server} AVOption
411
412 The syntax is:
413 @example
414 -server @var{server name}
415 @end example
416
417 Connects to a specific server.
418
419 @subsection @var{name} AVOption
420
421 The syntax is:
422 @example
423 -name @var{application name}
424 @end example
425
426 Specify the application name pulse will use when showing active clients,
427 by default it is "libav"
428
429 @subsection @var{stream_name} AVOption
430
431 The syntax is:
432 @example
433 -stream_name @var{stream name}
434 @end example
435
436 Specify the stream name pulse will use when showing active streams,
437 by default it is "record"
438
439 @subsection @var{sample_rate} AVOption
440
441 The syntax is:
442 @example
443 -sample_rate @var{samplerate}
444 @end example
445
446 Specify the samplerate in Hz, by default 48kHz is used.
447
448 @subsection @var{channels} AVOption
449
450 The syntax is:
451 @example
452 -channels @var{N}
453 @end example
454
455 Specify the channels in use, by default 2 (stereo) is set.
456
457 @subsection @var{frame_size} AVOption
458
459 The syntax is:
460 @example
461 -frame_size @var{bytes}
462 @end example
463
464 Specify the number of byte per frame, by default it is set to 1024.
465
466 @subsection @var{fragment_size} AVOption
467
468 The syntax is:
469 @example
470 -fragment_size @var{bytes}
471 @end example
472
473 Specify the minimal buffering fragment in pulseaudio, it will affect the
474 audio latency. By default it is unset.
475
476 @section sndio
477
478 sndio input device.
479
480 To enable this input device during configuration you need libsndio
481 installed on your system.
482
483 The filename to provide to the input device is the device node
484 representing the sndio input device, and is usually set to
485 @file{/dev/audio0}.
486
487 For example to grab from @file{/dev/audio0} using @file{ffmpeg} use the
488 command:
489 @example
490 ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
491 @end example
492
493 @section video4linux and video4linux2
494
495 Video4Linux and Video4Linux2 input video devices.
496
497 The name of the device to grab is a file device node, usually Linux
498 systems tend to automatically create such nodes when the device
499 (e.g. an USB webcam) is plugged into the system, and has a name of the
500 kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
501 the device.
502
503 Video4Linux and Video4Linux2 devices only support a limited set of
504 @var{width}x@var{height} sizes and framerates. You can check which are
505 supported for example with the command @file{dov4l} for Video4Linux
506 devices and the command @file{v4l-info} for Video4Linux2 devices.
507
508 If the size for the device is set to 0x0, the input device will
509 try to autodetect the size to use.
510 Only for the video4linux2 device, if the frame rate is set to 0/0 the
511 input device will use the frame rate value already set in the driver.
512
513 Video4Linux support is deprecated since Linux 2.6.30, and will be
514 dropped in later versions.
515
516 Follow some usage examples of the video4linux devices with the ff*
517 tools.
518 @example
519 # Grab and show the input of a video4linux device, frame rate is set
520 # to the default of 25/1.
521 ffplay -s 320x240 -f video4linux /dev/video0
522
523 # Grab and show the input of a video4linux2 device, autoadjust size.
524 ffplay -f video4linux2 /dev/video0
525
526 # Grab and record the input of a video4linux2 device, autoadjust size,
527 # frame rate value defaults to 0/0 so it is read from the video4linux2
528 # driver.
529 ffmpeg -f video4linux2 -i /dev/video0 out.mpeg
530 @end example
531
532 @section vfwcap
533
534 VfW (Video for Windows) capture input device.
535
536 The filename passed as input is the capture driver number, ranging from
537 0 to 9. You may use "list" as filename to print a list of drivers. Any
538 other filename will be interpreted as device number 0.
539
540 @section x11grab
541
542 X11 video input device.
543
544 This device allows to capture a region of an X11 display.
545
546 The filename passed as input has the syntax:
547 @example
548 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
549 @end example
550
551 @var{hostname}:@var{display_number}.@var{screen_number} specifies the
552 X11 display name of the screen to grab from. @var{hostname} can be
553 ommitted, and defaults to "localhost". The environment variable
554 @env{DISPLAY} contains the default display name.
555
556 @var{x_offset} and @var{y_offset} specify the offsets of the grabbed
557 area with respect to the top-left border of the X11 screen. They
558 default to 0.
559
560 Check the X11 documentation (e.g. man X) for more detailed information.
561
562 Use the @file{dpyinfo} program for getting basic information about the
563 properties of your X11 display (e.g. grep for "name" or "dimensions").
564
565 For example to grab from @file{:0.0} using @file{ffmpeg}:
566 @example
567 ffmpeg -f x11grab -r 25 -s cif -i :0.0 out.mpg
568
569 # Grab at position 10,20.
570 ffmpeg -f x11grab -r 25 -s cif -i :0.0+10,20 out.mpg
571 @end example
572
573 @subsection @var{follow_mouse} AVOption
574
575 The syntax is:
576 @example
577 -follow_mouse centered|@var{PIXELS}
578 @end example
579
580 When it is specified with "centered", the grabbing region follows the mouse
581 pointer and keeps the pointer at the center of region; otherwise, the region
582 follows only when the mouse pointer reaches within @var{PIXELS} (greater than
583 zero) to the edge of region.
584
585 For example:
586 @example
587 ffmpeg -f x11grab -follow_mouse centered -r 25 -s cif -i :0.0 out.mpg
588
589 # Follows only when the mouse pointer reaches within 100 pixels to edge
590 ffmpeg -f x11grab -follow_mouse 100 -r 25 -s cif -i :0.0 out.mpg
591 @end example
592
593 @subsection @var{show_region} AVOption
594
595 The syntax is:
596 @example
597 -show_region 1
598 @end example
599
600 If @var{show_region} AVOption is specified with @var{1}, then the grabbing
601 region will be indicated on screen. With this option, it's easy to know what is
602 being grabbed if only a portion of the screen is grabbed.
603
604 For example:
605 @example
606 ffmpeg -f x11grab -show_region 1 -r 25 -s cif -i :0.0+10,20 out.mpg
607
608 # With follow_mouse
609 ffmpeg -f x11grab -follow_mouse centered -show_region 1  -r 25 -s cif -i :0.0 out.mpg
610 @end example
611
612 @c man end INPUT DEVICES