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