lavd/decklink_dec: add option to disable drawing bars on signal loss
[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 enable accessing
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 @subsection Options
55
56 @table @option
57
58 @item sample_rate
59 Set the sample rate in Hz. Default is 48000.
60
61 @item channels
62 Set the number of channels. Default is 2.
63
64 @end table
65
66 @section avfoundation
67
68 AVFoundation input device.
69
70 AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >= 10.7 as well as on iOS.
71 The older QTKit framework has been marked deprecated since OSX version 10.7.
72
73 The input filename has to be given in the following syntax:
74 @example
75 -i "[[VIDEO]:[AUDIO]]"
76 @end example
77 The first entry selects the video input while the latter selects the audio input.
78 The stream has to be specified by the device name or the device index as shown by the device list.
79 Alternatively, the video and/or audio input device can be chosen by index using the
80 @option{
81     -video_device_index <INDEX>
82 }
83 and/or
84 @option{
85     -audio_device_index <INDEX>
86 }
87 , overriding any
88 device name or index given in the input filename.
89
90 All available devices can be enumerated by using @option{-list_devices true}, listing
91 all device names and corresponding indices.
92
93 There are two device name aliases:
94 @table @code
95
96 @item default
97 Select the AVFoundation default device of the corresponding type.
98
99 @item none
100 Do not record the corresponding media type.
101 This is equivalent to specifying an empty device name or index.
102
103 @end table
104
105 @subsection Options
106
107 AVFoundation supports the following options:
108
109 @table @option
110
111 @item -list_devices <TRUE|FALSE>
112 If set to true, a list of all available input devices is given showing all
113 device names and indices.
114
115 @item -video_device_index <INDEX>
116 Specify the video device by its index. Overrides anything given in the input filename.
117
118 @item -audio_device_index <INDEX>
119 Specify the audio device by its index. Overrides anything given in the input filename.
120
121 @item -pixel_format <FORMAT>
122 Request the video device to use a specific pixel format.
123 If the specified format is not supported, a list of available formats is given
124 and the first one in this list is used instead. Available pixel formats are:
125 @code{monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0,
126  bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10,
127  yuv420p, nv12, yuyv422, gray}
128
129 @item -framerate
130 Set the grabbing frame rate. Default is @code{ntsc}, corresponding to a
131 frame rate of @code{30000/1001}.
132
133 @item -video_size
134 Set the video frame size.
135
136 @item -capture_cursor
137 Capture the mouse pointer. Default is 0.
138
139 @item -capture_mouse_clicks
140 Capture the screen mouse clicks. Default is 0.
141
142 @end table
143
144 @subsection Examples
145
146 @itemize
147
148 @item
149 Print the list of AVFoundation supported devices and exit:
150 @example
151 $ ffmpeg -f avfoundation -list_devices true -i ""
152 @end example
153
154 @item
155 Record video from video device 0 and audio from audio device 0 into out.avi:
156 @example
157 $ ffmpeg -f avfoundation -i "0:0" out.avi
158 @end example
159
160 @item
161 Record video from video device 2 and audio from audio device 1 into out.avi:
162 @example
163 $ ffmpeg -f avfoundation -video_device_index 2 -i ":1" out.avi
164 @end example
165
166 @item
167 Record video from the system default video device using the pixel format bgr0 and do not record any audio into out.avi:
168 @example
169 $ ffmpeg -f avfoundation -pixel_format bgr0 -i "default:none" out.avi
170 @end example
171
172 @end itemize
173
174 @section bktr
175
176 BSD video input device.
177
178 @subsection Options
179
180 @table @option
181
182 @item framerate
183 Set the frame rate.
184
185 @item video_size
186 Set the video frame size. Default is @code{vga}.
187
188 @item standard
189
190 Available values are:
191 @table @samp
192 @item pal
193
194 @item ntsc
195
196 @item secam
197
198 @item paln
199
200 @item palm
201
202 @item ntscj
203
204 @end table
205
206 @end table
207
208 @section decklink
209
210 The decklink input device provides capture capabilities for Blackmagic
211 DeckLink devices.
212
213 To enable this input device, you need the Blackmagic DeckLink SDK and you
214 need to configure with the appropriate @code{--extra-cflags}
215 and @code{--extra-ldflags}.
216 On Windows, you need to run the IDL files through @command{widl}.
217
218 DeckLink is very picky about the formats it supports. Pixel format is
219 uyvy422 or v210, framerate and video size must be determined for your device with
220 @command{-list_formats 1}. Audio sample rate is always 48 kHz and the number
221 of channels can be 2, 8 or 16. Note that all audio channels are bundled in one single
222 audio track.
223
224 @subsection Options
225
226 @table @option
227
228 @item list_devices
229 If set to @option{true}, print a list of devices and exit.
230 Defaults to @option{false}.
231
232 @item list_formats
233 If set to @option{true}, print a list of supported formats and exit.
234 Defaults to @option{false}.
235
236 @item bm_v210
237 If set to @samp{1}, video is captured in 10 bit v210 instead
238 of uyvy422. Not all Blackmagic devices support this option.
239
240 @item teletext_lines
241 If set to nonzero, an additional teletext stream will be captured from the
242 vertical ancillary data. This option is a bitmask of the VBI lines checked,
243 specifically lines 6 to 22, and lines 318 to 335. Line 6 is the LSB in the mask.
244 Selected lines which do not contain teletext information will be ignored. You
245 can use the special @option{all} constant to select all possible lines, or
246 @option{standard} to skip lines 6, 318 and 319, which are not compatible with all
247 receivers. Capturing teletext only works for SD PAL sources in 8 bit mode.
248 To use this option, ffmpeg needs to be compiled with @code{--enable-libzvbi}.
249
250 @item channels
251 Defines number of audio channels to capture. Must be @samp{2}, @samp{8} or @samp{16}.
252 Defaults to @samp{2}.
253
254 @item duplex_mode
255 Sets the decklink device duplex mode. Must be @samp{unset}, @samp{half} or @samp{full}.
256 Defaults to @samp{unset}.
257
258 @item video_input
259 Sets the video input source. Must be @samp{unset}, @samp{sdi}, @samp{hdmi},
260 @samp{optical_sdi}, @samp{component}, @samp{composite} or @samp{s_video}.
261 Defaults to @samp{unset}.
262
263 @item audio_input
264 Sets the audio input source. Must be @samp{unset}, @samp{embedded},
265 @samp{aes_ebu}, @samp{analog}, @samp{analog_xlr}, @samp{analog_rca} or
266 @samp{microphone}. Defaults to @samp{unset}.
267
268 @item video_pts
269 Sets the video packet timestamp source. Must be @samp{video}, @samp{audio},
270 @samp{reference} or @samp{wallclock}. Defaults to @samp{video}.
271
272 @item audio_pts
273 Sets the audio packet timestamp source. Must be @samp{video}, @samp{audio},
274 @samp{reference} or @samp{wallclock}. Defaults to @samp{audio}.
275
276 @item draw_bars
277 If set to @samp{true}, color bars are drawn in the event of a signal loss.
278 Defaults to @samp{true}.
279
280 @end table
281
282 @subsection Examples
283
284 @itemize
285
286 @item
287 List input devices:
288 @example
289 ffmpeg -f decklink -list_devices 1 -i dummy
290 @end example
291
292 @item
293 List supported formats:
294 @example
295 ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
296 @end example
297
298 @item
299 Capture video clip at 1080i50 (format 11):
300 @example
301 ffmpeg -f decklink -i 'Intensity Pro@@11' -acodec copy -vcodec copy output.avi
302 @end example
303
304 @item
305 Capture video clip at 1080i50 10 bit:
306 @example
307 ffmpeg -bm_v210 1 -f decklink -i 'UltraStudio Mini Recorder@@11' -acodec copy -vcodec copy output.avi
308 @end example
309
310 @item
311 Capture video clip at 1080i50 with 16 audio channels:
312 @example
313 ffmpeg -channels 16 -f decklink -i 'UltraStudio Mini Recorder@@11' -acodec copy -vcodec copy output.avi
314 @end example
315
316 @end itemize
317
318 @section dshow
319
320 Windows DirectShow input device.
321
322 DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
323 Currently only audio and video devices are supported.
324
325 Multiple devices may be opened as separate inputs, but they may also be
326 opened on the same input, which should improve synchronism between them.
327
328 The input name should be in the format:
329
330 @example
331 @var{TYPE}=@var{NAME}[:@var{TYPE}=@var{NAME}]
332 @end example
333
334 where @var{TYPE} can be either @var{audio} or @var{video},
335 and @var{NAME} is the device's name or alternative name..
336
337 @subsection Options
338
339 If no options are specified, the device's defaults are used.
340 If the device does not support the requested options, it will
341 fail to open.
342
343 @table @option
344
345 @item video_size
346 Set the video size in the captured video.
347
348 @item framerate
349 Set the frame rate in the captured video.
350
351 @item sample_rate
352 Set the sample rate (in Hz) of the captured audio.
353
354 @item sample_size
355 Set the sample size (in bits) of the captured audio.
356
357 @item channels
358 Set the number of channels in the captured audio.
359
360 @item list_devices
361 If set to @option{true}, print a list of devices and exit.
362
363 @item list_options
364 If set to @option{true}, print a list of selected device's options
365 and exit.
366
367 @item video_device_number
368 Set video device number for devices with the same name (starts at 0,
369 defaults to 0).
370
371 @item audio_device_number
372 Set audio device number for devices with the same name (starts at 0,
373 defaults to 0).
374
375 @item pixel_format
376 Select pixel format to be used by DirectShow. This may only be set when
377 the video codec is not set or set to rawvideo.
378
379 @item audio_buffer_size
380 Set audio device buffer size in milliseconds (which can directly
381 impact latency, depending on the device).
382 Defaults to using the audio device's
383 default buffer size (typically some multiple of 500ms).
384 Setting this value too low can degrade performance.
385 See also
386 @url{http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx}
387
388 @item video_pin_name
389 Select video capture pin to use by name or alternative name.
390
391 @item audio_pin_name
392 Select audio capture pin to use by name or alternative name.
393
394 @item crossbar_video_input_pin_number
395 Select video input pin number for crossbar device. This will be
396 routed to the crossbar device's Video Decoder output pin.
397 Note that changing this value can affect future invocations
398 (sets a new default) until system reboot occurs.
399
400 @item crossbar_audio_input_pin_number
401 Select audio input pin number for crossbar device. This will be
402 routed to the crossbar device's Audio Decoder output pin.
403 Note that changing this value can affect future invocations
404 (sets a new default) until system reboot occurs.
405
406 @item show_video_device_dialog
407 If set to @option{true}, before capture starts, popup a display dialog
408 to the end user, allowing them to change video filter properties
409 and configurations manually.
410 Note that for crossbar devices, adjusting values in this dialog
411 may be needed at times to toggle between PAL (25 fps) and NTSC (29.97)
412 input frame rates, sizes, interlacing, etc.  Changing these values can
413 enable different scan rates/frame rates and avoiding green bars at
414 the bottom, flickering scan lines, etc.
415 Note that with some devices, changing these properties can also affect future
416 invocations (sets new defaults) until system reboot occurs.
417
418 @item show_audio_device_dialog
419 If set to @option{true}, before capture starts, popup a display dialog
420 to the end user, allowing them to change audio filter properties
421 and configurations manually.
422
423 @item show_video_crossbar_connection_dialog
424 If set to @option{true}, before capture starts, popup a display
425 dialog to the end user, allowing them to manually
426 modify crossbar pin routings, when it opens a video device.
427
428 @item show_audio_crossbar_connection_dialog
429 If set to @option{true}, before capture starts, popup a display
430 dialog to the end user, allowing them to manually
431 modify crossbar pin routings, when it opens an audio device.
432
433 @item show_analog_tv_tuner_dialog
434 If set to @option{true}, before capture starts, popup a display
435 dialog to the end user, allowing them to manually
436 modify TV channels and frequencies.
437
438 @item show_analog_tv_tuner_audio_dialog
439 If set to @option{true}, before capture starts, popup a display
440 dialog to the end user, allowing them to manually
441 modify TV audio (like mono vs. stereo, Language A,B or C).
442
443 @item audio_device_load
444 Load an audio capture filter device from file instead of searching
445 it by name. It may load additional parameters too, if the filter
446 supports the serialization of its properties to.
447 To use this an audio capture source has to be specified, but it can
448 be anything even fake one.
449
450 @item audio_device_save
451 Save the currently used audio capture filter device and its
452 parameters (if the filter supports it) to a file.
453 If a file with the same name exists it will be overwritten.
454
455 @item video_device_load
456 Load a video capture filter device from file instead of searching
457 it by name. It may load additional parameters too, if the filter
458 supports the serialization of its properties to.
459 To use this a video capture source has to be specified, but it can
460 be anything even fake one.
461
462 @item video_device_save
463 Save the currently used video capture filter device and its
464 parameters (if the filter supports it) to a file.
465 If a file with the same name exists it will be overwritten.
466
467 @end table
468
469 @subsection Examples
470
471 @itemize
472
473 @item
474 Print the list of DirectShow supported devices and exit:
475 @example
476 $ ffmpeg -list_devices true -f dshow -i dummy
477 @end example
478
479 @item
480 Open video device @var{Camera}:
481 @example
482 $ ffmpeg -f dshow -i video="Camera"
483 @end example
484
485 @item
486 Open second video device with name @var{Camera}:
487 @example
488 $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
489 @end example
490
491 @item
492 Open video device @var{Camera} and audio device @var{Microphone}:
493 @example
494 $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
495 @end example
496
497 @item
498 Print the list of supported options in selected device and exit:
499 @example
500 $ ffmpeg -list_options true -f dshow -i video="Camera"
501 @end example
502
503 @item
504 Specify pin names to capture by name or alternative name, specify alternative device name:
505 @example
506 $ 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"
507 @end example
508
509 @item
510 Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup:
511 @example
512 $ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_number 0
513      -crossbar_audio_input_pin_number 3 -i video="AVerMedia BDA Analog Capture":audio="AVerMedia BDA Analog Capture"
514 @end example
515
516 @end itemize
517
518 @section dv1394
519
520 Linux DV 1394 input device.
521
522 @subsection Options
523
524 @table @option
525
526 @item framerate
527 Set the frame rate. Default is 25.
528
529 @item standard
530
531 Available values are:
532 @table @samp
533 @item pal
534
535 @item ntsc
536
537 @end table
538
539 Default value is @code{ntsc}.
540
541 @end table
542
543 @section fbdev
544
545 Linux framebuffer input device.
546
547 The Linux framebuffer is a graphic hardware-independent abstraction
548 layer to show graphics on a computer monitor, typically on the
549 console. It is accessed through a file device node, usually
550 @file{/dev/fb0}.
551
552 For more detailed information read the file
553 Documentation/fb/framebuffer.txt included in the Linux source tree.
554
555 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
556
557 To record from the framebuffer device @file{/dev/fb0} with
558 @command{ffmpeg}:
559 @example
560 ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
561 @end example
562
563 You can take a single screenshot image with the command:
564 @example
565 ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
566 @end example
567
568 @subsection Options
569
570 @table @option
571
572 @item framerate
573 Set the frame rate. Default is 25.
574
575 @end table
576
577 @section gdigrab
578
579 Win32 GDI-based screen capture device.
580
581 This device allows you to capture a region of the display on Windows.
582
583 There are two options for the input filename:
584 @example
585 desktop
586 @end example
587 or
588 @example
589 title=@var{window_title}
590 @end example
591
592 The first option will capture the entire desktop, or a fixed region of the
593 desktop. The second option will instead capture the contents of a single
594 window, regardless of its position on the screen.
595
596 For example, to grab the entire desktop using @command{ffmpeg}:
597 @example
598 ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
599 @end example
600
601 Grab a 640x480 region at position @code{10,20}:
602 @example
603 ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
604 @end example
605
606 Grab the contents of the window named "Calculator"
607 @example
608 ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
609 @end example
610
611 @subsection Options
612
613 @table @option
614 @item draw_mouse
615 Specify whether to draw the mouse pointer. Use the value @code{0} to
616 not draw the pointer. Default value is @code{1}.
617
618 @item framerate
619 Set the grabbing frame rate. Default value is @code{ntsc},
620 corresponding to a frame rate of @code{30000/1001}.
621
622 @item show_region
623 Show grabbed region on screen.
624
625 If @var{show_region} is specified with @code{1}, then the grabbing
626 region will be indicated on screen. With this option, it is easy to
627 know what is being grabbed if only a portion of the screen is grabbed.
628
629 Note that @var{show_region} is incompatible with grabbing the contents
630 of a single window.
631
632 For example:
633 @example
634 ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
635 @end example
636
637 @item video_size
638 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.
639
640 @item offset_x
641 When capturing a region with @var{video_size}, set the distance from the left edge of the screen or desktop.
642
643 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.
644
645 @item offset_y
646 When capturing a region with @var{video_size}, set the distance from the top edge of the screen or desktop.
647
648 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.
649
650 @end table
651
652 @section iec61883
653
654 FireWire DV/HDV input device using libiec61883.
655
656 To enable this input device, you need libiec61883, libraw1394 and
657 libavc1394 installed on your system. Use the configure option
658 @code{--enable-libiec61883} to compile with the device enabled.
659
660 The iec61883 capture device supports capturing from a video device
661 connected via IEEE1394 (FireWire), using libiec61883 and the new Linux
662 FireWire stack (juju). This is the default DV/HDV input method in Linux
663 Kernel 2.6.37 and later, since the old FireWire stack was removed.
664
665 Specify the FireWire port to be used as input file, or "auto"
666 to choose the first port connected.
667
668 @subsection Options
669
670 @table @option
671
672 @item dvtype
673 Override autodetection of DV/HDV. This should only be used if auto
674 detection does not work, or if usage of a different device type
675 should be prohibited. Treating a DV device as HDV (or vice versa) will
676 not work and result in undefined behavior.
677 The values @option{auto}, @option{dv} and @option{hdv} are supported.
678
679 @item dvbuffer
680 Set maximum size of buffer for incoming data, in frames. For DV, this
681 is an exact value. For HDV, it is not frame exact, since HDV does
682 not have a fixed frame size.
683
684 @item dvguid
685 Select the capture device by specifying its GUID. Capturing will only
686 be performed from the specified device and fails if no device with the
687 given GUID is found. This is useful to select the input if multiple
688 devices are connected at the same time.
689 Look at /sys/bus/firewire/devices to find out the GUIDs.
690
691 @end table
692
693 @subsection Examples
694
695 @itemize
696
697 @item
698 Grab and show the input of a FireWire DV/HDV device.
699 @example
700 ffplay -f iec61883 -i auto
701 @end example
702
703 @item
704 Grab and record the input of a FireWire DV/HDV device,
705 using a packet buffer of 100000 packets if the source is HDV.
706 @example
707 ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
708 @end example
709
710 @end itemize
711
712 @section jack
713
714 JACK input device.
715
716 To enable this input device during configuration you need libjack
717 installed on your system.
718
719 A JACK input device creates one or more JACK writable clients, one for
720 each audio channel, with name @var{client_name}:input_@var{N}, where
721 @var{client_name} is the name provided by the application, and @var{N}
722 is a number which identifies the channel.
723 Each writable client will send the acquired data to the FFmpeg input
724 device.
725
726 Once you have created one or more JACK readable clients, you need to
727 connect them to one or more JACK writable clients.
728
729 To connect or disconnect JACK clients you can use the @command{jack_connect}
730 and @command{jack_disconnect} programs, or do it through a graphical interface,
731 for example with @command{qjackctl}.
732
733 To list the JACK clients and their properties you can invoke the command
734 @command{jack_lsp}.
735
736 Follows an example which shows how to capture a JACK readable client
737 with @command{ffmpeg}.
738 @example
739 # Create a JACK writable client with name "ffmpeg".
740 $ ffmpeg -f jack -i ffmpeg -y out.wav
741
742 # Start the sample jack_metro readable client.
743 $ jack_metro -b 120 -d 0.2 -f 4000
744
745 # List the current JACK clients.
746 $ jack_lsp -c
747 system:capture_1
748 system:capture_2
749 system:playback_1
750 system:playback_2
751 ffmpeg:input_1
752 metro:120_bpm
753
754 # Connect metro to the ffmpeg writable client.
755 $ jack_connect metro:120_bpm ffmpeg:input_1
756 @end example
757
758 For more information read:
759 @url{http://jackaudio.org/}
760
761 @subsection Options
762
763 @table @option
764
765 @item channels
766 Set the number of channels. Default is 2.
767
768 @end table
769
770 @section lavfi
771
772 Libavfilter input virtual device.
773
774 This input device reads data from the open output pads of a libavfilter
775 filtergraph.
776
777 For each filtergraph open output, the input device will create a
778 corresponding stream which is mapped to the generated output. Currently
779 only video data is supported. The filtergraph is specified through the
780 option @option{graph}.
781
782 @subsection Options
783
784 @table @option
785
786 @item graph
787 Specify the filtergraph to use as input. Each video open output must be
788 labelled by a unique string of the form "out@var{N}", where @var{N} is a
789 number starting from 0 corresponding to the mapped input stream
790 generated by the device.
791 The first unlabelled output is automatically assigned to the "out0"
792 label, but all the others need to be specified explicitly.
793
794 The suffix "+subcc" can be appended to the output label to create an extra
795 stream with the closed captions packets attached to that output
796 (experimental; only for EIA-608 / CEA-708 for now).
797 The subcc streams are created after all the normal streams, in the order of
798 the corresponding stream.
799 For example, if there is "out19+subcc", "out7+subcc" and up to "out42", the
800 stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19.
801
802 If not specified defaults to the filename specified for the input
803 device.
804
805 @item graph_file
806 Set the filename of the filtergraph to be read and sent to the other
807 filters. Syntax of the filtergraph is the same as the one specified by
808 the option @var{graph}.
809
810 @item dumpgraph
811 Dump graph to stderr.
812
813 @end table
814
815 @subsection Examples
816
817 @itemize
818 @item
819 Create a color video stream and play it back with @command{ffplay}:
820 @example
821 ffplay -f lavfi -graph "color=c=pink [out0]" dummy
822 @end example
823
824 @item
825 As the previous example, but use filename for specifying the graph
826 description, and omit the "out0" label:
827 @example
828 ffplay -f lavfi color=c=pink
829 @end example
830
831 @item
832 Create three different video test filtered sources and play them:
833 @example
834 ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
835 @end example
836
837 @item
838 Read an audio stream from a file using the amovie source and play it
839 back with @command{ffplay}:
840 @example
841 ffplay -f lavfi "amovie=test.wav"
842 @end example
843
844 @item
845 Read an audio stream and a video stream and play it back with
846 @command{ffplay}:
847 @example
848 ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
849 @end example
850
851 @item
852 Dump decoded frames to images and closed captions to a file (experimental):
853 @example
854 ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
855 @end example
856
857 @end itemize
858
859 @section libcdio
860
861 Audio-CD input device based on libcdio.
862
863 To enable this input device during configuration you need libcdio
864 installed on your system. It requires the configure option
865 @code{--enable-libcdio}.
866
867 This device allows playing and grabbing from an Audio-CD.
868
869 For example to copy with @command{ffmpeg} the entire Audio-CD in @file{/dev/sr0},
870 you may run the command:
871 @example
872 ffmpeg -f libcdio -i /dev/sr0 cd.wav
873 @end example
874
875 @subsection Options
876 @table @option
877 @item speed
878 Set drive reading speed. Default value is 0.
879
880 The speed is specified CD-ROM speed units. The speed is set through
881 the libcdio @code{cdio_cddap_speed_set} function. On many CD-ROM
882 drives, specifying a value too large will result in using the fastest
883 speed.
884
885 @item paranoia_mode
886 Set paranoia recovery mode flags. It accepts one of the following values:
887
888 @table @samp
889 @item disable
890 @item verify
891 @item overlap
892 @item neverskip
893 @item full
894 @end table
895
896 Default value is @samp{disable}.
897
898 For more information about the available recovery modes, consult the
899 paranoia project documentation.
900 @end table
901
902 @section libdc1394
903
904 IIDC1394 input device, based on libdc1394 and libraw1394.
905
906 Requires the configure option @code{--enable-libdc1394}.
907
908 @section openal
909
910 The OpenAL input device provides audio capture on all systems with a
911 working OpenAL 1.1 implementation.
912
913 To enable this input device during configuration, you need OpenAL
914 headers and libraries installed on your system, and need to configure
915 FFmpeg with @code{--enable-openal}.
916
917 OpenAL headers and libraries should be provided as part of your OpenAL
918 implementation, or as an additional download (an SDK). Depending on your
919 installation you may need to specify additional flags via the
920 @code{--extra-cflags} and @code{--extra-ldflags} for allowing the build
921 system to locate the OpenAL headers and libraries.
922
923 An incomplete list of OpenAL implementations follows:
924
925 @table @strong
926 @item Creative
927 The official Windows implementation, providing hardware acceleration
928 with supported devices and software fallback.
929 See @url{http://openal.org/}.
930 @item OpenAL Soft
931 Portable, open source (LGPL) software implementation. Includes
932 backends for the most common sound APIs on the Windows, Linux,
933 Solaris, and BSD operating systems.
934 See @url{http://kcat.strangesoft.net/openal.html}.
935 @item Apple
936 OpenAL is part of Core Audio, the official Mac OS X Audio interface.
937 See @url{http://developer.apple.com/technologies/mac/audio-and-video.html}
938 @end table
939
940 This device allows one to capture from an audio input device handled
941 through OpenAL.
942
943 You need to specify the name of the device to capture in the provided
944 filename. If the empty string is provided, the device will
945 automatically select the default device. You can get the list of the
946 supported devices by using the option @var{list_devices}.
947
948 @subsection Options
949
950 @table @option
951
952 @item channels
953 Set the number of channels in the captured audio. Only the values
954 @option{1} (monaural) and @option{2} (stereo) are currently supported.
955 Defaults to @option{2}.
956
957 @item sample_size
958 Set the sample size (in bits) of the captured audio. Only the values
959 @option{8} and @option{16} are currently supported. Defaults to
960 @option{16}.
961
962 @item sample_rate
963 Set the sample rate (in Hz) of the captured audio.
964 Defaults to @option{44.1k}.
965
966 @item list_devices
967 If set to @option{true}, print a list of devices and exit.
968 Defaults to @option{false}.
969
970 @end table
971
972 @subsection Examples
973
974 Print the list of OpenAL supported devices and exit:
975 @example
976 $ ffmpeg -list_devices true -f openal -i dummy out.ogg
977 @end example
978
979 Capture from the OpenAL device @file{DR-BT101 via PulseAudio}:
980 @example
981 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
982 @end example
983
984 Capture from the default device (note the empty string '' as filename):
985 @example
986 $ ffmpeg -f openal -i '' out.ogg
987 @end example
988
989 Capture from two devices simultaneously, writing to two different files,
990 within the same @command{ffmpeg} command:
991 @example
992 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
993 @end example
994 Note: not all OpenAL implementations support multiple simultaneous capture -
995 try the latest OpenAL Soft if the above does not work.
996
997 @section oss
998
999 Open Sound System input device.
1000
1001 The filename to provide to the input device is the device node
1002 representing the OSS input device, and is usually set to
1003 @file{/dev/dsp}.
1004
1005 For example to grab from @file{/dev/dsp} using @command{ffmpeg} use the
1006 command:
1007 @example
1008 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
1009 @end example
1010
1011 For more information about OSS see:
1012 @url{http://manuals.opensound.com/usersguide/dsp.html}
1013
1014 @subsection Options
1015
1016 @table @option
1017
1018 @item sample_rate
1019 Set the sample rate in Hz. Default is 48000.
1020
1021 @item channels
1022 Set the number of channels. Default is 2.
1023
1024 @end table
1025
1026
1027 @section pulse
1028
1029 PulseAudio input device.
1030
1031 To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
1032
1033 The filename to provide to the input device is a source device or the
1034 string "default"
1035
1036 To list the PulseAudio source devices and their properties you can invoke
1037 the command @command{pactl list sources}.
1038
1039 More information about PulseAudio can be found on @url{http://www.pulseaudio.org}.
1040
1041 @subsection Options
1042 @table @option
1043 @item server
1044 Connect to a specific PulseAudio server, specified by an IP address.
1045 Default server is used when not provided.
1046
1047 @item name
1048 Specify the application name PulseAudio will use when showing active clients,
1049 by default it is the @code{LIBAVFORMAT_IDENT} string.
1050
1051 @item stream_name
1052 Specify the stream name PulseAudio will use when showing active streams,
1053 by default it is "record".
1054
1055 @item sample_rate
1056 Specify the samplerate in Hz, by default 48kHz is used.
1057
1058 @item channels
1059 Specify the channels in use, by default 2 (stereo) is set.
1060
1061 @item frame_size
1062 Specify the number of bytes per frame, by default it is set to 1024.
1063
1064 @item fragment_size
1065 Specify the minimal buffering fragment in PulseAudio, it will affect the
1066 audio latency. By default it is unset.
1067
1068 @item wallclock
1069 Set the initial PTS using the current time. Default is 1.
1070
1071 @end table
1072
1073 @subsection Examples
1074 Record a stream from default device:
1075 @example
1076 ffmpeg -f pulse -i default /tmp/pulse.wav
1077 @end example
1078
1079 @section qtkit
1080
1081 QTKit input device.
1082
1083 The filename passed as input is parsed to contain either a device name or index.
1084 The device index can also be given by using -video_device_index.
1085 A given device index will override any given device name.
1086 If the desired device consists of numbers only, use -video_device_index to identify it.
1087 The default device will be chosen if an empty string  or the device name "default" is given.
1088 The available devices can be enumerated by using -list_devices.
1089
1090 @example
1091 ffmpeg -f qtkit -i "0" out.mpg
1092 @end example
1093
1094 @example
1095 ffmpeg -f qtkit -video_device_index 0 -i "" out.mpg
1096 @end example
1097
1098 @example
1099 ffmpeg -f qtkit -i "default" out.mpg
1100 @end example
1101
1102 @example
1103 ffmpeg -f qtkit -list_devices true -i ""
1104 @end example
1105
1106 @subsection Options
1107
1108 @table @option
1109
1110 @item frame_rate
1111 Set frame rate. Default is 30.
1112
1113 @item list_devices
1114 If set to @code{true}, print a list of devices and exit. Default is
1115 @code{false}.
1116
1117 @item video_device_index
1118 Select the video device by index for devices with the same name (starts at 0).
1119
1120 @end table
1121
1122 @section sndio
1123
1124 sndio input device.
1125
1126 To enable this input device during configuration you need libsndio
1127 installed on your system.
1128
1129 The filename to provide to the input device is the device node
1130 representing the sndio input device, and is usually set to
1131 @file{/dev/audio0}.
1132
1133 For example to grab from @file{/dev/audio0} using @command{ffmpeg} use the
1134 command:
1135 @example
1136 ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
1137 @end example
1138
1139 @subsection Options
1140
1141 @table @option
1142
1143 @item sample_rate
1144 Set the sample rate in Hz. Default is 48000.
1145
1146 @item channels
1147 Set the number of channels. Default is 2.
1148
1149 @end table
1150
1151 @section video4linux2, v4l2
1152
1153 Video4Linux2 input video device.
1154
1155 "v4l2" can be used as alias for "video4linux2".
1156
1157 If FFmpeg is built with v4l-utils support (by using the
1158 @code{--enable-libv4l2} configure option), it is possible to use it with the
1159 @code{-use_libv4l2} input device option.
1160
1161 The name of the device to grab is a file device node, usually Linux
1162 systems tend to automatically create such nodes when the device
1163 (e.g. an USB webcam) is plugged into the system, and has a name of the
1164 kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
1165 the device.
1166
1167 Video4Linux2 devices usually support a limited set of
1168 @var{width}x@var{height} sizes and frame rates. You can check which are
1169 supported using @command{-list_formats all} for Video4Linux2 devices.
1170 Some devices, like TV cards, support one or more standards. It is possible
1171 to list all the supported standards using @command{-list_standards all}.
1172
1173 The time base for the timestamps is 1 microsecond. Depending on the kernel
1174 version and configuration, the timestamps may be derived from the real time
1175 clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
1176 boot time, unaffected by NTP or manual changes to the clock). The
1177 @option{-timestamps abs} or @option{-ts abs} option can be used to force
1178 conversion into the real time clock.
1179
1180 Some usage examples of the video4linux2 device with @command{ffmpeg}
1181 and @command{ffplay}:
1182 @itemize
1183 @item
1184 List supported formats for a video4linux2 device:
1185 @example
1186 ffplay -f video4linux2 -list_formats all /dev/video0
1187 @end example
1188
1189 @item
1190 Grab and show the input of a video4linux2 device:
1191 @example
1192 ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
1193 @end example
1194
1195 @item
1196 Grab and record the input of a video4linux2 device, leave the
1197 frame rate and size as previously set:
1198 @example
1199 ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
1200 @end example
1201 @end itemize
1202
1203 For more information about Video4Linux, check @url{http://linuxtv.org/}.
1204
1205 @subsection Options
1206
1207 @table @option
1208 @item standard
1209 Set the standard. Must be the name of a supported standard. To get a
1210 list of the supported standards, use the @option{list_standards}
1211 option.
1212
1213 @item channel
1214 Set the input channel number. Default to -1, which means using the
1215 previously selected channel.
1216
1217 @item video_size
1218 Set the video frame size. The argument must be a string in the form
1219 @var{WIDTH}x@var{HEIGHT} or a valid size abbreviation.
1220
1221 @item pixel_format
1222 Select the pixel format (only valid for raw video input).
1223
1224 @item input_format
1225 Set the preferred pixel format (for raw video) or a codec name.
1226 This option allows one to select the input format, when several are
1227 available.
1228
1229 @item framerate
1230 Set the preferred video frame rate.
1231
1232 @item list_formats
1233 List available formats (supported pixel formats, codecs, and frame
1234 sizes) and exit.
1235
1236 Available values are:
1237 @table @samp
1238 @item all
1239 Show all available (compressed and non-compressed) formats.
1240
1241 @item raw
1242 Show only raw video (non-compressed) formats.
1243
1244 @item compressed
1245 Show only compressed formats.
1246 @end table
1247
1248 @item list_standards
1249 List supported standards and exit.
1250
1251 Available values are:
1252 @table @samp
1253 @item all
1254 Show all supported standards.
1255 @end table
1256
1257 @item timestamps, ts
1258 Set type of timestamps for grabbed frames.
1259
1260 Available values are:
1261 @table @samp
1262 @item default
1263 Use timestamps from the kernel.
1264
1265 @item abs
1266 Use absolute timestamps (wall clock).
1267
1268 @item mono2abs
1269 Force conversion from monotonic to absolute timestamps.
1270 @end table
1271
1272 Default value is @code{default}.
1273
1274 @item use_libv4l2
1275 Use libv4l2 (v4l-utils) conversion functions. Default is 0.
1276
1277 @end table
1278
1279 @section vfwcap
1280
1281 VfW (Video for Windows) capture input device.
1282
1283 The filename passed as input is the capture driver number, ranging from
1284 0 to 9. You may use "list" as filename to print a list of drivers. Any
1285 other filename will be interpreted as device number 0.
1286
1287 @subsection Options
1288
1289 @table @option
1290
1291 @item video_size
1292 Set the video frame size.
1293
1294 @item framerate
1295 Set the grabbing frame rate. Default value is @code{ntsc},
1296 corresponding to a frame rate of @code{30000/1001}.
1297
1298 @end table
1299
1300 @section x11grab
1301
1302 X11 video input device.
1303
1304 To enable this input device during configuration you need libxcb
1305 installed on your system. It will be automatically detected during
1306 configuration.
1307
1308 Alternatively, the configure option @option{--enable-x11grab} exists
1309 for legacy Xlib users.
1310
1311 This device allows one to capture a region of an X11 display.
1312
1313 The filename passed as input has the syntax:
1314 @example
1315 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
1316 @end example
1317
1318 @var{hostname}:@var{display_number}.@var{screen_number} specifies the
1319 X11 display name of the screen to grab from. @var{hostname} can be
1320 omitted, and defaults to "localhost". The environment variable
1321 @env{DISPLAY} contains the default display name.
1322
1323 @var{x_offset} and @var{y_offset} specify the offsets of the grabbed
1324 area with respect to the top-left border of the X11 screen. They
1325 default to 0.
1326
1327 Check the X11 documentation (e.g. @command{man X}) for more detailed
1328 information.
1329
1330 Use the @command{xdpyinfo} program for getting basic information about
1331 the properties of your X11 display (e.g. grep for "name" or
1332 "dimensions").
1333
1334 For example to grab from @file{:0.0} using @command{ffmpeg}:
1335 @example
1336 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
1337 @end example
1338
1339 Grab at position @code{10,20}:
1340 @example
1341 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1342 @end example
1343
1344 @subsection Options
1345
1346 @table @option
1347 @item draw_mouse
1348 Specify whether to draw the mouse pointer. A value of @code{0} specifies
1349 not to draw the pointer. Default value is @code{1}.
1350
1351 @item follow_mouse
1352 Make the grabbed area follow the mouse. The argument can be
1353 @code{centered} or a number of pixels @var{PIXELS}.
1354
1355 When it is specified with "centered", the grabbing region follows the mouse
1356 pointer and keeps the pointer at the center of region; otherwise, the region
1357 follows only when the mouse pointer reaches within @var{PIXELS} (greater than
1358 zero) to the edge of region.
1359
1360 For example:
1361 @example
1362 ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
1363 @end example
1364
1365 To follow only when the mouse pointer reaches within 100 pixels to edge:
1366 @example
1367 ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
1368 @end example
1369
1370 @item framerate
1371 Set the grabbing frame rate. Default value is @code{ntsc},
1372 corresponding to a frame rate of @code{30000/1001}.
1373
1374 @item show_region
1375 Show grabbed region on screen.
1376
1377 If @var{show_region} is specified with @code{1}, then the grabbing
1378 region will be indicated on screen. With this option, it is easy to
1379 know what is being grabbed if only a portion of the screen is grabbed.
1380
1381 @item region_border
1382 Set the region border thickness if @option{-show_region 1} is used.
1383 Range is 1 to 128 and default is 3 (XCB-based x11grab only).
1384
1385 For example:
1386 @example
1387 ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1388 @end example
1389
1390 With @var{follow_mouse}:
1391 @example
1392 ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
1393 @end example
1394
1395 @item video_size
1396 Set the video frame size. Default value is @code{vga}.
1397
1398 @item use_shm
1399 Use the MIT-SHM extension for shared memory. Default value is @code{1}.
1400 It may be necessary to disable it for remote displays (legacy x11grab
1401 only).
1402
1403 @item grab_x
1404 @item grab_y
1405 Set the grabbing region coordinates. They are expressed as offset from
1406 the top left corner of the X11 window and correspond to the
1407 @var{x_offset} and @var{y_offset} parameters in the device name. The
1408 default value for both options is 0.
1409 @end table
1410
1411 @c man end INPUT DEVICES