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