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