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