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