dshow: allow selecting devices by an alternative name (workaround for devices with...
[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 "-devices" of the ff* tools will display the list of
17 supported input devices.
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 @command{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 avfoundation
55
56 AVFoundation input device.
57
58 AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >= 10.7 as well as on iOS.
59 The older QTKit framework has been marked deprecated since OSX version 10.7.
60
61 The input filename has to be given in the following syntax:
62 @example
63 -i "[[VIDEO]:[AUDIO]]"
64 @end example
65 The first entry selects the video input while the latter selects the audio input.
66 The stream has to be specified by the device name or the device index as shown by the device list.
67 Alternatively, the video and/or audio input device can be chosen by index using the
68 @option{
69     -video_device_index <INDEX>
70 }
71 and/or
72 @option{
73     -audio_device_index <INDEX>
74 }
75 , overriding any
76 device name or index given in the input filename.
77
78 All available devices can be enumerated by using @option{-list_devices true}, listing
79 all device names and corresponding indices.
80
81 There are two device name aliases:
82 @table @code
83
84 @item default
85 Select the AVFoundation default device of the corresponding type.
86
87 @item none
88 Do not record the corresponding media type.
89 This is equivalent to specifying an empty device name or index.
90
91 @end table
92
93 @subsection Options
94
95 AVFoundation supports the following options:
96
97 @table @option
98
99 @item -list_devices <TRUE|FALSE>
100 If set to true, a list of all available input devices is given showing all
101 device names and indices.
102
103 @item -video_device_index <INDEX>
104 Specify the video device by its index. Overrides anything given in the input filename.
105
106 @item -audio_device_index <INDEX>
107 Specify the audio device by its index. Overrides anything given in the input filename.
108
109 @item -pixel_format <FORMAT>
110 Request the video device to use a specific pixel format.
111 If the specified format is not supported, a list of available formats is given
112 und the first one in this list is used instead. Available pixel formats are:
113 @code{monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0,
114  bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10,
115  yuv420p, nv12, yuyv422, gray}
116
117 @end table
118
119 @subsection Examples
120
121 @itemize
122
123 @item
124 Print the list of AVFoundation supported devices and exit:
125 @example
126 $ ffmpeg -f avfoundation -list_devices true -i ""
127 @end example
128
129 @item
130 Record video from video device 0 and audio from audio device 0 into out.avi:
131 @example
132 $ ffmpeg -f avfoundation -i "0:0" out.avi
133 @end example
134
135 @item
136 Record video from video device 2 and audio from audio device 1 into out.avi:
137 @example
138 $ ffmpeg -f avfoundation -video_device_index 2 -i ":1" out.avi
139 @end example
140
141 @item
142 Record video from the system default video device using the pixel format bgr0 and do not record any audio into out.avi:
143 @example
144 $ ffmpeg -f avfoundation -pixel_format bgr0 -i "default:none" out.avi
145 @end example
146
147 @end itemize
148
149 @section bktr
150
151 BSD video input device.
152
153 @section dshow
154
155 Windows DirectShow input device.
156
157 DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
158 Currently only audio and video devices are supported.
159
160 Multiple devices may be opened as separate inputs, but they may also be
161 opened on the same input, which should improve synchronism between them.
162
163 The input name should be in the format:
164
165 @example
166 @var{TYPE}=@var{NAME}[:@var{TYPE}=@var{NAME}]
167 @end example
168
169 where @var{TYPE} can be either @var{audio} or @var{video},
170 and @var{NAME} is the device's name or alternative name..
171
172 @subsection Options
173
174 If no options are specified, the device's defaults are used.
175 If the device does not support the requested options, it will
176 fail to open.
177
178 @table @option
179
180 @item video_size
181 Set the video size in the captured video.
182
183 @item framerate
184 Set the frame rate in the captured video.
185
186 @item sample_rate
187 Set the sample rate (in Hz) of the captured audio.
188
189 @item sample_size
190 Set the sample size (in bits) of the captured audio.
191
192 @item channels
193 Set the number of channels in the captured audio.
194
195 @item list_devices
196 If set to @option{true}, print a list of devices and exit.
197
198 @item list_options
199 If set to @option{true}, print a list of selected device's options
200 and exit.
201
202 @item video_device_number
203 Set video device number for devices with same name (starts at 0,
204 defaults to 0).
205
206 @item audio_device_number
207 Set audio device number for devices with same name (starts at 0,
208 defaults to 0).
209
210 @item pixel_format
211 Select pixel format to be used by DirectShow. This may only be set when
212 the video codec is not set or set to rawvideo.
213
214 @item audio_buffer_size
215 Set audio device buffer size in milliseconds (which can directly
216 impact latency, depending on the device).
217 Defaults to using the audio device's
218 default buffer size (typically some multiple of 500ms).
219 Setting this value too low can degrade performance.
220 See also
221 @url{http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx}
222
223 @item video_pin_name
224 Select video capture pin to use by name or alternative name.
225
226 @item audio_pin_name
227 Select audio capture pin to use by name or alternative name.
228
229 @end table
230
231 @subsection Examples
232
233 @itemize
234
235 @item
236 Print the list of DirectShow supported devices and exit:
237 @example
238 $ ffmpeg -list_devices true -f dshow -i dummy
239 @end example
240
241 @item
242 Open video device @var{Camera}:
243 @example
244 $ ffmpeg -f dshow -i video="Camera"
245 @end example
246
247 @item
248 Open second video device with name @var{Camera}:
249 @example
250 $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
251 @end example
252
253 @item
254 Open video device @var{Camera} and audio device @var{Microphone}:
255 @example
256 $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
257 @end example
258
259 @item
260 Print the list of supported options in selected device and exit:
261 @example
262 $ ffmpeg -list_options true -f dshow -i video="Camera"
263 @end example
264
265 @item
266 Specify pin names to capture by name or alternative name, specify alternative device name:
267 @example
268 $ ffmpeg -f dshow -audio_pin_name "Audio Out" -video_pin_name 2 -i video=video="@device_pnp_\\?\pci#ven_1a0a&dev_6200&subsys_62021461&rev_01#4&e2c7dd6&0&00e1#{65e8773d-8f56-11d0-a3b9-00a0c9223196}\{ca465100-deb0-4d59-818f-8c477184adf6}":audio="Microphone"
269 @end example
270
271 @end itemize
272
273 @section dv1394
274
275 Linux DV 1394 input device.
276
277 @section fbdev
278
279 Linux framebuffer input device.
280
281 The Linux framebuffer is a graphic hardware-independent abstraction
282 layer to show graphics on a computer monitor, typically on the
283 console. It is accessed through a file device node, usually
284 @file{/dev/fb0}.
285
286 For more detailed information read the file
287 Documentation/fb/framebuffer.txt included in the Linux source tree.
288
289 To record from the framebuffer device @file{/dev/fb0} with
290 @command{ffmpeg}:
291 @example
292 ffmpeg -f fbdev -r 10 -i /dev/fb0 out.avi
293 @end example
294
295 You can take a single screenshot image with the command:
296 @example
297 ffmpeg -f fbdev -frames:v 1 -r 1 -i /dev/fb0 screenshot.jpeg
298 @end example
299
300 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
301
302 @section gdigrab
303
304 Win32 GDI-based screen capture device.
305
306 This device allows you to capture a region of the display on Windows.
307
308 There are two options for the input filename:
309 @example
310 desktop
311 @end example
312 or
313 @example
314 title=@var{window_title}
315 @end example
316
317 The first option will capture the entire desktop, or a fixed region of the
318 desktop. The second option will instead capture the contents of a single
319 window, regardless of its position on the screen.
320
321 For example, to grab the entire desktop using @command{ffmpeg}:
322 @example
323 ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
324 @end example
325
326 Grab a 640x480 region at position @code{10,20}:
327 @example
328 ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
329 @end example
330
331 Grab the contents of the window named "Calculator"
332 @example
333 ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
334 @end example
335
336 @subsection Options
337
338 @table @option
339 @item draw_mouse
340 Specify whether to draw the mouse pointer. Use the value @code{0} to
341 not draw the pointer. Default value is @code{1}.
342
343 @item framerate
344 Set the grabbing frame rate. Default value is @code{ntsc},
345 corresponding to a frame rate of @code{30000/1001}.
346
347 @item show_region
348 Show grabbed region on screen.
349
350 If @var{show_region} is specified with @code{1}, then the grabbing
351 region will be indicated on screen. With this option, it is easy to
352 know what is being grabbed if only a portion of the screen is grabbed.
353
354 Note that @var{show_region} is incompatible with grabbing the contents
355 of a single window.
356
357 For example:
358 @example
359 ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
360 @end example
361
362 @item video_size
363 Set the video frame size. The default is to capture the full screen if @file{desktop} is selected, or the full window size if @file{title=@var{window_title}} is selected.
364
365 @item offset_x
366 When capturing a region with @var{video_size}, set the distance from the left edge of the screen or desktop.
367
368 Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned to the left of your primary monitor, you will need to use a negative @var{offset_x} value to move the region to that monitor.
369
370 @item offset_y
371 When capturing a region with @var{video_size}, set the distance from the top edge of the screen or desktop.
372
373 Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned above your primary monitor, you will need to use a negative @var{offset_y} value to move the region to that monitor.
374
375 @end table
376
377 @section iec61883
378
379 FireWire DV/HDV input device using libiec61883.
380
381 To enable this input device, you need libiec61883, libraw1394 and
382 libavc1394 installed on your system. Use the configure option
383 @code{--enable-libiec61883} to compile with the device enabled.
384
385 The iec61883 capture device supports capturing from a video device
386 connected via IEEE1394 (FireWire), using libiec61883 and the new Linux
387 FireWire stack (juju). This is the default DV/HDV input method in Linux
388 Kernel 2.6.37 and later, since the old FireWire stack was removed.
389
390 Specify the FireWire port to be used as input file, or "auto"
391 to choose the first port connected.
392
393 @subsection Options
394
395 @table @option
396
397 @item dvtype
398 Override autodetection of DV/HDV. This should only be used if auto
399 detection does not work, or if usage of a different device type
400 should be prohibited. Treating a DV device as HDV (or vice versa) will
401 not work and result in undefined behavior.
402 The values @option{auto}, @option{dv} and @option{hdv} are supported.
403
404 @item dvbuffer
405 Set maximum size of buffer for incoming data, in frames. For DV, this
406 is an exact value. For HDV, it is not frame exact, since HDV does
407 not have a fixed frame size.
408
409 @item dvguid
410 Select the capture device by specifying it's GUID. Capturing will only
411 be performed from the specified device and fails if no device with the
412 given GUID is found. This is useful to select the input if multiple
413 devices are connected at the same time.
414 Look at /sys/bus/firewire/devices to find out the GUIDs.
415
416 @end table
417
418 @subsection Examples
419
420 @itemize
421
422 @item
423 Grab and show the input of a FireWire DV/HDV device.
424 @example
425 ffplay -f iec61883 -i auto
426 @end example
427
428 @item
429 Grab and record the input of a FireWire DV/HDV device,
430 using a packet buffer of 100000 packets if the source is HDV.
431 @example
432 ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
433 @end example
434
435 @end itemize
436
437 @section jack
438
439 JACK input device.
440
441 To enable this input device during configuration you need libjack
442 installed on your system.
443
444 A JACK input device creates one or more JACK writable clients, one for
445 each audio channel, with name @var{client_name}:input_@var{N}, where
446 @var{client_name} is the name provided by the application, and @var{N}
447 is a number which identifies the channel.
448 Each writable client will send the acquired data to the FFmpeg input
449 device.
450
451 Once you have created one or more JACK readable clients, you need to
452 connect them to one or more JACK writable clients.
453
454 To connect or disconnect JACK clients you can use the @command{jack_connect}
455 and @command{jack_disconnect} programs, or do it through a graphical interface,
456 for example with @command{qjackctl}.
457
458 To list the JACK clients and their properties you can invoke the command
459 @command{jack_lsp}.
460
461 Follows an example which shows how to capture a JACK readable client
462 with @command{ffmpeg}.
463 @example
464 # Create a JACK writable client with name "ffmpeg".
465 $ ffmpeg -f jack -i ffmpeg -y out.wav
466
467 # Start the sample jack_metro readable client.
468 $ jack_metro -b 120 -d 0.2 -f 4000
469
470 # List the current JACK clients.
471 $ jack_lsp -c
472 system:capture_1
473 system:capture_2
474 system:playback_1
475 system:playback_2
476 ffmpeg:input_1
477 metro:120_bpm
478
479 # Connect metro to the ffmpeg writable client.
480 $ jack_connect metro:120_bpm ffmpeg:input_1
481 @end example
482
483 For more information read:
484 @url{http://jackaudio.org/}
485
486 @section lavfi
487
488 Libavfilter input virtual device.
489
490 This input device reads data from the open output pads of a libavfilter
491 filtergraph.
492
493 For each filtergraph open output, the input device will create a
494 corresponding stream which is mapped to the generated output. Currently
495 only video data is supported. The filtergraph is specified through the
496 option @option{graph}.
497
498 @subsection Options
499
500 @table @option
501
502 @item graph
503 Specify the filtergraph to use as input. Each video open output must be
504 labelled by a unique string of the form "out@var{N}", where @var{N} is a
505 number starting from 0 corresponding to the mapped input stream
506 generated by the device.
507 The first unlabelled output is automatically assigned to the "out0"
508 label, but all the others need to be specified explicitly.
509
510 The suffix "+subcc" can be appended to the output label to create an extra
511 stream with the closed captions packets attached to that output
512 (experimental; only for EIA-608 / CEA-708 for now).
513 The subcc streams are created after all the normal streams, in the order of
514 the corresponding stream.
515 For example, if there is "out19+subcc", "out7+subcc" and up to "out42", the
516 stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19.
517
518 If not specified defaults to the filename specified for the input
519 device.
520
521 @item graph_file
522 Set the filename of the filtergraph to be read and sent to the other
523 filters. Syntax of the filtergraph is the same as the one specified by
524 the option @var{graph}.
525
526 @end table
527
528 @subsection Examples
529
530 @itemize
531 @item
532 Create a color video stream and play it back with @command{ffplay}:
533 @example
534 ffplay -f lavfi -graph "color=c=pink [out0]" dummy
535 @end example
536
537 @item
538 As the previous example, but use filename for specifying the graph
539 description, and omit the "out0" label:
540 @example
541 ffplay -f lavfi color=c=pink
542 @end example
543
544 @item
545 Create three different video test filtered sources and play them:
546 @example
547 ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
548 @end example
549
550 @item
551 Read an audio stream from a file using the amovie source and play it
552 back with @command{ffplay}:
553 @example
554 ffplay -f lavfi "amovie=test.wav"
555 @end example
556
557 @item
558 Read an audio stream and a video stream and play it back with
559 @command{ffplay}:
560 @example
561 ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
562 @end example
563
564 @item
565 Dump decoded frames to images and closed captions to a file (experimental):
566 @example
567 ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
568 @end example
569
570 @end itemize
571
572 @section libcdio
573
574 Audio-CD input device based on cdio.
575
576 To enable this input device during configuration you need libcdio
577 installed on your system. Requires the configure option
578 @code{--enable-libcdio}.
579
580 This device allows playing and grabbing from an Audio-CD.
581
582 For example to copy with @command{ffmpeg} the entire Audio-CD in /dev/sr0,
583 you may run the command:
584 @example
585 ffmpeg -f libcdio -i /dev/sr0 cd.wav
586 @end example
587
588 @section libdc1394
589
590 IIDC1394 input device, based on libdc1394 and libraw1394.
591
592 Requires the configure option @code{--enable-libdc1394}.
593
594 @section openal
595
596 The OpenAL input device provides audio capture on all systems with a
597 working OpenAL 1.1 implementation.
598
599 To enable this input device during configuration, you need OpenAL
600 headers and libraries installed on your system, and need to configure
601 FFmpeg with @code{--enable-openal}.
602
603 OpenAL headers and libraries should be provided as part of your OpenAL
604 implementation, or as an additional download (an SDK). Depending on your
605 installation you may need to specify additional flags via the
606 @code{--extra-cflags} and @code{--extra-ldflags} for allowing the build
607 system to locate the OpenAL headers and libraries.
608
609 An incomplete list of OpenAL implementations follows:
610
611 @table @strong
612 @item Creative
613 The official Windows implementation, providing hardware acceleration
614 with supported devices and software fallback.
615 See @url{http://openal.org/}.
616 @item OpenAL Soft
617 Portable, open source (LGPL) software implementation. Includes
618 backends for the most common sound APIs on the Windows, Linux,
619 Solaris, and BSD operating systems.
620 See @url{http://kcat.strangesoft.net/openal.html}.
621 @item Apple
622 OpenAL is part of Core Audio, the official Mac OS X Audio interface.
623 See @url{http://developer.apple.com/technologies/mac/audio-and-video.html}
624 @end table
625
626 This device allows one to capture from an audio input device handled
627 through OpenAL.
628
629 You need to specify the name of the device to capture in the provided
630 filename. If the empty string is provided, the device will
631 automatically select the default device. You can get the list of the
632 supported devices by using the option @var{list_devices}.
633
634 @subsection Options
635
636 @table @option
637
638 @item channels
639 Set the number of channels in the captured audio. Only the values
640 @option{1} (monaural) and @option{2} (stereo) are currently supported.
641 Defaults to @option{2}.
642
643 @item sample_size
644 Set the sample size (in bits) of the captured audio. Only the values
645 @option{8} and @option{16} are currently supported. Defaults to
646 @option{16}.
647
648 @item sample_rate
649 Set the sample rate (in Hz) of the captured audio.
650 Defaults to @option{44.1k}.
651
652 @item list_devices
653 If set to @option{true}, print a list of devices and exit.
654 Defaults to @option{false}.
655
656 @end table
657
658 @subsection Examples
659
660 Print the list of OpenAL supported devices and exit:
661 @example
662 $ ffmpeg -list_devices true -f openal -i dummy out.ogg
663 @end example
664
665 Capture from the OpenAL device @file{DR-BT101 via PulseAudio}:
666 @example
667 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
668 @end example
669
670 Capture from the default device (note the empty string '' as filename):
671 @example
672 $ ffmpeg -f openal -i '' out.ogg
673 @end example
674
675 Capture from two devices simultaneously, writing to two different files,
676 within the same @command{ffmpeg} command:
677 @example
678 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
679 @end example
680 Note: not all OpenAL implementations support multiple simultaneous capture -
681 try the latest OpenAL Soft if the above does not work.
682
683 @section oss
684
685 Open Sound System input device.
686
687 The filename to provide to the input device is the device node
688 representing the OSS input device, and is usually set to
689 @file{/dev/dsp}.
690
691 For example to grab from @file{/dev/dsp} using @command{ffmpeg} use the
692 command:
693 @example
694 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
695 @end example
696
697 For more information about OSS see:
698 @url{http://manuals.opensound.com/usersguide/dsp.html}
699
700 @section pulse
701
702 PulseAudio input device.
703
704 To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
705
706 The filename to provide to the input device is a source device or the
707 string "default"
708
709 To list the PulseAudio source devices and their properties you can invoke
710 the command @command{pactl list sources}.
711
712 More information about PulseAudio can be found on @url{http://www.pulseaudio.org}.
713
714 @subsection Options
715 @table @option
716 @item server
717 Connect to a specific PulseAudio server, specified by an IP address.
718 Default server is used when not provided.
719
720 @item name
721 Specify the application name PulseAudio will use when showing active clients,
722 by default it is the @code{LIBAVFORMAT_IDENT} string.
723
724 @item stream_name
725 Specify the stream name PulseAudio will use when showing active streams,
726 by default it is "record".
727
728 @item sample_rate
729 Specify the samplerate in Hz, by default 48kHz is used.
730
731 @item channels
732 Specify the channels in use, by default 2 (stereo) is set.
733
734 @item frame_size
735 Specify the number of bytes per frame, by default it is set to 1024.
736
737 @item fragment_size
738 Specify the minimal buffering fragment in PulseAudio, it will affect the
739 audio latency. By default it is unset.
740 @end table
741
742 @subsection Examples
743 Record a stream from default device:
744 @example
745 ffmpeg -f pulse -i default /tmp/pulse.wav
746 @end example
747
748 @section qtkit
749
750 QTKit input device.
751
752 The filename passed as input is parsed to contain either a device name or index.
753 The device index can also be given by using -video_device_index.
754 A given device index will override any given device name.
755 If the desired device consists of numbers only, use -video_device_index to identify it.
756 The default device will be chosen if an empty string  or the device name "default" is given.
757 The available devices can be enumerated by using -list_devices.
758
759 @example
760 ffmpeg -f qtkit -i "0" out.mpg
761 @end example
762
763 @example
764 ffmpeg -f qtkit -video_device_index 0 -i "" out.mpg
765 @end example
766
767 @example
768 ffmpeg -f qtkit -i "default" out.mpg
769 @end example
770
771 @example
772 ffmpeg -f qtkit -list_devices true -i ""
773 @end example
774
775 @section sndio
776
777 sndio input device.
778
779 To enable this input device during configuration you need libsndio
780 installed on your system.
781
782 The filename to provide to the input device is the device node
783 representing the sndio input device, and is usually set to
784 @file{/dev/audio0}.
785
786 For example to grab from @file{/dev/audio0} using @command{ffmpeg} use the
787 command:
788 @example
789 ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
790 @end example
791
792 @section video4linux2, v4l2
793
794 Video4Linux2 input video device.
795
796 "v4l2" can be used as alias for "video4linux2".
797
798 If FFmpeg is built with v4l-utils support (by using the
799 @code{--enable-libv4l2} configure option), it is possible to use it with the
800 @code{-use_libv4l2} input device option.
801
802 The name of the device to grab is a file device node, usually Linux
803 systems tend to automatically create such nodes when the device
804 (e.g. an USB webcam) is plugged into the system, and has a name of the
805 kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
806 the device.
807
808 Video4Linux2 devices usually support a limited set of
809 @var{width}x@var{height} sizes and frame rates. You can check which are
810 supported using @command{-list_formats all} for Video4Linux2 devices.
811 Some devices, like TV cards, support one or more standards. It is possible
812 to list all the supported standards using @command{-list_standards all}.
813
814 The time base for the timestamps is 1 microsecond. Depending on the kernel
815 version and configuration, the timestamps may be derived from the real time
816 clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
817 boot time, unaffected by NTP or manual changes to the clock). The
818 @option{-timestamps abs} or @option{-ts abs} option can be used to force
819 conversion into the real time clock.
820
821 Some usage examples of the video4linux2 device with @command{ffmpeg}
822 and @command{ffplay}:
823 @itemize
824 @item
825 Grab and show the input of a video4linux2 device:
826 @example
827 ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
828 @end example
829
830 @item
831 Grab and record the input of a video4linux2 device, leave the
832 frame rate and size as previously set:
833 @example
834 ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
835 @end example
836 @end itemize
837
838 For more information about Video4Linux, check @url{http://linuxtv.org/}.
839
840 @subsection Options
841
842 @table @option
843 @item standard
844 Set the standard. Must be the name of a supported standard. To get a
845 list of the supported standards, use the @option{list_standards}
846 option.
847
848 @item channel
849 Set the input channel number. Default to -1, which means using the
850 previously selected channel.
851
852 @item video_size
853 Set the video frame size. The argument must be a string in the form
854 @var{WIDTH}x@var{HEIGHT} or a valid size abbreviation.
855
856 @item pixel_format
857 Select the pixel format (only valid for raw video input).
858
859 @item input_format
860 Set the preferred pixel format (for raw video) or a codec name.
861 This option allows one to select the input format, when several are
862 available.
863
864 @item framerate
865 Set the preferred video frame rate.
866
867 @item list_formats
868 List available formats (supported pixel formats, codecs, and frame
869 sizes) and exit.
870
871 Available values are:
872 @table @samp
873 @item all
874 Show all available (compressed and non-compressed) formats.
875
876 @item raw
877 Show only raw video (non-compressed) formats.
878
879 @item compressed
880 Show only compressed formats.
881 @end table
882
883 @item list_standards
884 List supported standards and exit.
885
886 Available values are:
887 @table @samp
888 @item all
889 Show all supported standards.
890 @end table
891
892 @item timestamps, ts
893 Set type of timestamps for grabbed frames.
894
895 Available values are:
896 @table @samp
897 @item default
898 Use timestamps from the kernel.
899
900 @item abs
901 Use absolute timestamps (wall clock).
902
903 @item mono2abs
904 Force conversion from monotonic to absolute timestamps.
905 @end table
906
907 Default value is @code{default}.
908 @end table
909
910 @section vfwcap
911
912 VfW (Video for Windows) capture input device.
913
914 The filename passed as input is the capture driver number, ranging from
915 0 to 9. You may use "list" as filename to print a list of drivers. Any
916 other filename will be interpreted as device number 0.
917
918 @section x11grab
919
920 X11 video input device.
921
922 Depends on X11, Xext, and Xfixes. Requires the configure option
923 @code{--enable-x11grab}.
924
925 This device allows one to capture a region of an X11 display.
926
927 The filename passed as input has the syntax:
928 @example
929 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
930 @end example
931
932 @var{hostname}:@var{display_number}.@var{screen_number} specifies the
933 X11 display name of the screen to grab from. @var{hostname} can be
934 omitted, and defaults to "localhost". The environment variable
935 @env{DISPLAY} contains the default display name.
936
937 @var{x_offset} and @var{y_offset} specify the offsets of the grabbed
938 area with respect to the top-left border of the X11 screen. They
939 default to 0.
940
941 Check the X11 documentation (e.g. man X) for more detailed information.
942
943 Use the @command{dpyinfo} program for getting basic information about the
944 properties of your X11 display (e.g. grep for "name" or "dimensions").
945
946 For example to grab from @file{:0.0} using @command{ffmpeg}:
947 @example
948 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
949 @end example
950
951 Grab at position @code{10,20}:
952 @example
953 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
954 @end example
955
956 @subsection Options
957
958 @table @option
959 @item draw_mouse
960 Specify whether to draw the mouse pointer. A value of @code{0} specify
961 not to draw the pointer. Default value is @code{1}.
962
963 @item follow_mouse
964 Make the grabbed area follow the mouse. The argument can be
965 @code{centered} or a number of pixels @var{PIXELS}.
966
967 When it is specified with "centered", the grabbing region follows the mouse
968 pointer and keeps the pointer at the center of region; otherwise, the region
969 follows only when the mouse pointer reaches within @var{PIXELS} (greater than
970 zero) to the edge of region.
971
972 For example:
973 @example
974 ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
975 @end example
976
977 To follow only when the mouse pointer reaches within 100 pixels to edge:
978 @example
979 ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
980 @end example
981
982 @item framerate
983 Set the grabbing frame rate. Default value is @code{ntsc},
984 corresponding to a frame rate of @code{30000/1001}.
985
986 @item show_region
987 Show grabbed region on screen.
988
989 If @var{show_region} is specified with @code{1}, then the grabbing
990 region will be indicated on screen. With this option, it is easy to
991 know what is being grabbed if only a portion of the screen is grabbed.
992
993 For example:
994 @example
995 ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
996 @end example
997
998 With @var{follow_mouse}:
999 @example
1000 ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
1001 @end example
1002
1003 @item video_size
1004 Set the video frame size. Default value is @code{vga}.
1005
1006 @item use_shm
1007 Use the MIT-SHM extension for shared memory. Default value is @code{1}.
1008 It may be necessary to disable it for remote displays.
1009 @end table
1010
1011 @section decklink
1012
1013 The decklink input device provides capture capabilities for Blackmagic
1014 DeckLink devices.
1015
1016 To enable this input device, you need the Blackmagic DeckLink SDK and you
1017 need to configure with the appropriate @code{--extra-cflags}
1018 and @code{--extra-ldflags}.
1019 On Windows, you need to run the IDL files through @command{widl}.
1020
1021 DeckLink is very picky about the formats it supports. Pixel format is always
1022 uyvy422, framerate and video size must be determined for your device with
1023 @command{-list_formats 1}. Audio sample rate is always 48 kHz and the number
1024 of channels currently is limited to 2 (stereo).
1025
1026 @subsection Options
1027
1028 @table @option
1029
1030 @item list_devices
1031 If set to @option{true}, print a list of devices and exit.
1032 Defaults to @option{false}.
1033
1034 @item list_formats
1035 If set to @option{true}, print a list of supported formats and exit.
1036 Defaults to @option{false}.
1037
1038 @end table
1039
1040 @subsection Examples
1041
1042 @itemize
1043
1044 @item
1045 List input devices:
1046 @example
1047 ffmpeg -f decklink -list_devices 1 -i dummy
1048 @end example
1049
1050 @item
1051 List supported formats:
1052 @example
1053 ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
1054 @end example
1055
1056 @item
1057 Capture video clip at 1080i50 (format 11):
1058 @example
1059 ffmpeg -f decklink -i 'Intensity Pro@@11' -acodec copy -vcodec copy output.avi
1060 @end example
1061
1062 @end itemize
1063
1064
1065 @c man end INPUT DEVICES