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