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