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