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