2 @c man begin INPUT DEVICES
4 Input devices are configured elements in FFmpeg which enable accessing
5 the data coming from a multimedia device attached to your system.
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".
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}".
16 The option "-devices" of the ff* tools will display the list of
17 supported input devices.
19 A description of the currently available input devices follows.
23 ALSA (Advanced Linux Sound Architecture) input device.
25 To enable this input device during configuration you need libasound
26 installed on your system.
28 This device allows capturing from an ALSA device. The name of the
29 device to capture has to be an ALSA card identifier.
31 An ALSA identifier has the syntax:
33 hw:@var{CARD}[,@var{DEV}[,@var{SUBDEV}]]
36 where the @var{DEV} and @var{SUBDEV} components are optional.
38 The three arguments (in order: @var{CARD},@var{DEV},@var{SUBDEV})
39 specify card number or identifier, device number and subdevice number
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}.
45 For example to capture with @command{ffmpeg} from an ALSA device with
46 card id 0, you may run the command:
48 ffmpeg -f alsa -i hw:0 alsaout.wav
51 For more information see:
52 @url{http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html}
59 Set the sample rate in Hz. Default is 48000.
62 Set the number of channels. Default is 2.
68 AVFoundation input device.
70 AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >= 10.7 as well as on iOS.
72 The input filename has to be given in the following syntax:
74 -i "[[VIDEO]:[AUDIO]]"
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
80 -video_device_index <INDEX>
84 -audio_device_index <INDEX>
87 device name or index given in the input filename.
89 All available devices can be enumerated by using @option{-list_devices true}, listing
90 all device names and corresponding indices.
92 There are two device name aliases:
96 Select the AVFoundation default device of the corresponding type.
99 Do not record the corresponding media type.
100 This is equivalent to specifying an empty device name or index.
106 AVFoundation supports the following options:
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.
114 @item -video_device_index <INDEX>
115 Specify the video device by its index. Overrides anything given in the input filename.
117 @item -audio_device_index <INDEX>
118 Specify the audio device by its index. Overrides anything given in the input filename.
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}
129 Set the grabbing frame rate. Default is @code{ntsc}, corresponding to a
130 frame rate of @code{30000/1001}.
133 Set the video frame size.
135 @item -capture_cursor
136 Capture the mouse pointer. Default is 0.
138 @item -capture_mouse_clicks
139 Capture the screen mouse clicks. Default is 0.
148 Print the list of AVFoundation supported devices and exit:
150 $ ffmpeg -f avfoundation -list_devices true -i ""
154 Record video from video device 0 and audio from audio device 0 into out.avi:
156 $ ffmpeg -f avfoundation -i "0:0" out.avi
160 Record video from video device 2 and audio from audio device 1 into out.avi:
162 $ ffmpeg -f avfoundation -video_device_index 2 -i ":1" out.avi
166 Record video from the system default video device using the pixel format bgr0 and do not record any audio into out.avi:
168 $ ffmpeg -f avfoundation -pixel_format bgr0 -i "default:none" out.avi
175 BSD video input device.
185 Set the video frame size. Default is @code{vga}.
189 Available values are:
209 The decklink input device provides capture capabilities for Blackmagic
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}.
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
229 If set to @option{true}, print a list of devices and exit.
230 Defaults to @option{false}.
233 If set to @option{true}, print a list of supported formats and exit.
234 Defaults to @option{false}.
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).
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.
248 Set the pixel format of the captured video.
249 Available values are:
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.
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
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
280 Defines number of audio channels to capture. Must be @samp{2}, @samp{8} or @samp{16}.
281 Defaults to @samp{2}.
284 Sets the decklink device duplex mode. Must be @samp{unset}, @samp{half} or @samp{full}.
285 Defaults to @samp{unset}.
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}.
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}.
298 Sets the video packet timestamp source. Must be @samp{video}, @samp{audio},
299 @samp{reference} or @samp{wallclock}. Defaults to @samp{video}.
302 Sets the audio packet timestamp source. Must be @samp{video}, @samp{audio},
303 @samp{reference} or @samp{wallclock}. Defaults to @samp{audio}.
306 If set to @samp{true}, color bars are drawn in the event of a signal loss.
307 Defaults to @samp{true}.
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}.
315 Sets the audio sample bit depth. Must be @samp{16} or @samp{32}.
316 Defaults to @samp{16}.
327 ffmpeg -f decklink -list_devices 1 -i dummy
331 List supported formats:
333 ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
337 Capture video clip at 1080i50:
339 ffmpeg -format_code Hi50 -f decklink -i 'Intensity Pro' -c:a copy -c:v copy output.avi
343 Capture video clip at 1080i50 10 bit:
345 ffmpeg -bm_v210 1 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
349 Capture video clip at 1080i50 with 16 audio channels:
351 ffmpeg -channels 16 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
358 KMS video input device.
360 Captures the KMS scanout framebuffer associated with a specified CRTC or plane as a
361 DRM object that can be passed to other hardware functions.
363 Requires either DRM master or CAP_SYS_ADMIN to run.
365 If you don't understand what all of that means, you probably don't want this. Look at
366 @option{x11grab} instead.
373 DRM device to capture on. Defaults to @option{/dev/dri/card0}.
376 Pixel format of the framebuffer. Defaults to @option{bgr0}.
378 @item format_modifier
379 Format modifier to signal on output frames. This is necessary to import correctly into
380 some APIs, but can't be autodetected. See the libdrm documentation for possible values.
383 KMS CRTC ID to define the capture source. The first active plane on the given CRTC
387 KMS plane ID to define the capture source. Defaults to the first active plane found if
388 neither @option{crtc_id} nor @option{plane_id} are specified.
391 Framerate to capture at. This is not synchronised to any page flipping or framebuffer
392 changes - it just defines the interval at which the framebuffer is sampled. Sampling
393 faster than the framebuffer update rate will generate independent frames with the same
394 content. Defaults to @code{30}.
403 Capture from the first active plane, download the result to normal frames and encode.
404 This will only work if the framebuffer is both linear and mappable - if not, the result
405 may be scrambled or fail to download.
407 ffmpeg -f kmsgrab -i - -vf 'hwdownload,format=bgr0' output.mp4
411 Capture from CRTC ID 42 at 60fps, map the result to VAAPI, convert to NV12 and encode as H.264.
413 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
418 @section libndi_newtek
420 The libndi_newtek input device provides capture capabilities for using NDI (Network
421 Device Interface, standard created by NewTek).
423 Input filename is a NDI source name that could be found by sending -find_sources 1
424 to command line - it has no specific syntax but human-readable formatted.
426 To enable this input device, you need the NDI SDK and you
427 need to configure with the appropriate @code{--extra-cflags}
428 and @code{--extra-ldflags}.
435 If set to @option{true}, print a list of found/available NDI sources and exit.
436 Defaults to @option{false}.
439 Override time to wait until the number of online sources have changed.
440 Defaults to @option{0.5}.
442 @item allow_video_fields
443 When this flag is @option{false}, all video that you receive will be progressive.
444 Defaults to @option{true}.
455 ffmpeg -f libndi_newtek -find_sources 1 -i dummy
461 ffmpeg -f libndi_newtek -i "DEV-5.INTERNAL.M1STEREO.TV (NDI_SOURCE_NAME_1)" -f libndi_newtek -y NDI_SOURCE_NAME_2
468 Windows DirectShow input device.
470 DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
471 Currently only audio and video devices are supported.
473 Multiple devices may be opened as separate inputs, but they may also be
474 opened on the same input, which should improve synchronism between them.
476 The input name should be in the format:
479 @var{TYPE}=@var{NAME}[:@var{TYPE}=@var{NAME}]
482 where @var{TYPE} can be either @var{audio} or @var{video},
483 and @var{NAME} is the device's name or alternative name..
487 If no options are specified, the device's defaults are used.
488 If the device does not support the requested options, it will
494 Set the video size in the captured video.
497 Set the frame rate in the captured video.
500 Set the sample rate (in Hz) of the captured audio.
503 Set the sample size (in bits) of the captured audio.
506 Set the number of channels in the captured audio.
509 If set to @option{true}, print a list of devices and exit.
512 If set to @option{true}, print a list of selected device's options
515 @item video_device_number
516 Set video device number for devices with the same name (starts at 0,
519 @item audio_device_number
520 Set audio device number for devices with the same name (starts at 0,
524 Select pixel format to be used by DirectShow. This may only be set when
525 the video codec is not set or set to rawvideo.
527 @item audio_buffer_size
528 Set audio device buffer size in milliseconds (which can directly
529 impact latency, depending on the device).
530 Defaults to using the audio device's
531 default buffer size (typically some multiple of 500ms).
532 Setting this value too low can degrade performance.
534 @url{http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx}
537 Select video capture pin to use by name or alternative name.
540 Select audio capture pin to use by name or alternative name.
542 @item crossbar_video_input_pin_number
543 Select video input pin number for crossbar device. This will be
544 routed to the crossbar device's Video Decoder output pin.
545 Note that changing this value can affect future invocations
546 (sets a new default) until system reboot occurs.
548 @item crossbar_audio_input_pin_number
549 Select audio input pin number for crossbar device. This will be
550 routed to the crossbar device's Audio Decoder output pin.
551 Note that changing this value can affect future invocations
552 (sets a new default) until system reboot occurs.
554 @item show_video_device_dialog
555 If set to @option{true}, before capture starts, popup a display dialog
556 to the end user, allowing them to change video filter properties
557 and configurations manually.
558 Note that for crossbar devices, adjusting values in this dialog
559 may be needed at times to toggle between PAL (25 fps) and NTSC (29.97)
560 input frame rates, sizes, interlacing, etc. Changing these values can
561 enable different scan rates/frame rates and avoiding green bars at
562 the bottom, flickering scan lines, etc.
563 Note that with some devices, changing these properties can also affect future
564 invocations (sets new defaults) until system reboot occurs.
566 @item show_audio_device_dialog
567 If set to @option{true}, before capture starts, popup a display dialog
568 to the end user, allowing them to change audio filter properties
569 and configurations manually.
571 @item show_video_crossbar_connection_dialog
572 If set to @option{true}, before capture starts, popup a display
573 dialog to the end user, allowing them to manually
574 modify crossbar pin routings, when it opens a video device.
576 @item show_audio_crossbar_connection_dialog
577 If set to @option{true}, before capture starts, popup a display
578 dialog to the end user, allowing them to manually
579 modify crossbar pin routings, when it opens an audio device.
581 @item show_analog_tv_tuner_dialog
582 If set to @option{true}, before capture starts, popup a display
583 dialog to the end user, allowing them to manually
584 modify TV channels and frequencies.
586 @item show_analog_tv_tuner_audio_dialog
587 If set to @option{true}, before capture starts, popup a display
588 dialog to the end user, allowing them to manually
589 modify TV audio (like mono vs. stereo, Language A,B or C).
591 @item audio_device_load
592 Load an audio capture filter device from file instead of searching
593 it by name. It may load additional parameters too, if the filter
594 supports the serialization of its properties to.
595 To use this an audio capture source has to be specified, but it can
596 be anything even fake one.
598 @item audio_device_save
599 Save the currently used audio capture filter device and its
600 parameters (if the filter supports it) to a file.
601 If a file with the same name exists it will be overwritten.
603 @item video_device_load
604 Load a video capture filter device from file instead of searching
605 it by name. It may load additional parameters too, if the filter
606 supports the serialization of its properties to.
607 To use this a video capture source has to be specified, but it can
608 be anything even fake one.
610 @item video_device_save
611 Save the currently used video capture filter device and its
612 parameters (if the filter supports it) to a file.
613 If a file with the same name exists it will be overwritten.
622 Print the list of DirectShow supported devices and exit:
624 $ ffmpeg -list_devices true -f dshow -i dummy
628 Open video device @var{Camera}:
630 $ ffmpeg -f dshow -i video="Camera"
634 Open second video device with name @var{Camera}:
636 $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
640 Open video device @var{Camera} and audio device @var{Microphone}:
642 $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
646 Print the list of supported options in selected device and exit:
648 $ ffmpeg -list_options true -f dshow -i video="Camera"
652 Specify pin names to capture by name or alternative name, specify alternative device name:
654 $ 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"
658 Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup:
660 $ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_number 0
661 -crossbar_audio_input_pin_number 3 -i video="AVerMedia BDA Analog Capture":audio="AVerMedia BDA Analog Capture"
668 Linux framebuffer input device.
670 The Linux framebuffer is a graphic hardware-independent abstraction
671 layer to show graphics on a computer monitor, typically on the
672 console. It is accessed through a file device node, usually
675 For more detailed information read the file
676 Documentation/fb/framebuffer.txt included in the Linux source tree.
678 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
680 To record from the framebuffer device @file{/dev/fb0} with
683 ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
686 You can take a single screenshot image with the command:
688 ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
696 Set the frame rate. Default is 25.
702 Win32 GDI-based screen capture device.
704 This device allows you to capture a region of the display on Windows.
706 There are two options for the input filename:
712 title=@var{window_title}
715 The first option will capture the entire desktop, or a fixed region of the
716 desktop. The second option will instead capture the contents of a single
717 window, regardless of its position on the screen.
719 For example, to grab the entire desktop using @command{ffmpeg}:
721 ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
724 Grab a 640x480 region at position @code{10,20}:
726 ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
729 Grab the contents of the window named "Calculator"
731 ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
738 Specify whether to draw the mouse pointer. Use the value @code{0} to
739 not draw the pointer. Default value is @code{1}.
742 Set the grabbing frame rate. Default value is @code{ntsc},
743 corresponding to a frame rate of @code{30000/1001}.
746 Show grabbed region on screen.
748 If @var{show_region} is specified with @code{1}, then the grabbing
749 region will be indicated on screen. With this option, it is easy to
750 know what is being grabbed if only a portion of the screen is grabbed.
752 Note that @var{show_region} is incompatible with grabbing the contents
757 ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
761 Set the video frame size. The default is to capture the full screen if @file{desktop} is selected, or the full window size if @file{title=@var{window_title}} is selected.
764 When capturing a region with @var{video_size}, set the distance from the left edge of the screen or desktop.
766 Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned to the left of your primary monitor, you will need to use a negative @var{offset_x} value to move the region to that monitor.
769 When capturing a region with @var{video_size}, set the distance from the top edge of the screen or desktop.
771 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.
777 FireWire DV/HDV input device using libiec61883.
779 To enable this input device, you need libiec61883, libraw1394 and
780 libavc1394 installed on your system. Use the configure option
781 @code{--enable-libiec61883} to compile with the device enabled.
783 The iec61883 capture device supports capturing from a video device
784 connected via IEEE1394 (FireWire), using libiec61883 and the new Linux
785 FireWire stack (juju). This is the default DV/HDV input method in Linux
786 Kernel 2.6.37 and later, since the old FireWire stack was removed.
788 Specify the FireWire port to be used as input file, or "auto"
789 to choose the first port connected.
796 Override autodetection of DV/HDV. This should only be used if auto
797 detection does not work, or if usage of a different device type
798 should be prohibited. Treating a DV device as HDV (or vice versa) will
799 not work and result in undefined behavior.
800 The values @option{auto}, @option{dv} and @option{hdv} are supported.
803 Set maximum size of buffer for incoming data, in frames. For DV, this
804 is an exact value. For HDV, it is not frame exact, since HDV does
805 not have a fixed frame size.
808 Select the capture device by specifying its GUID. Capturing will only
809 be performed from the specified device and fails if no device with the
810 given GUID is found. This is useful to select the input if multiple
811 devices are connected at the same time.
812 Look at /sys/bus/firewire/devices to find out the GUIDs.
821 Grab and show the input of a FireWire DV/HDV device.
823 ffplay -f iec61883 -i auto
827 Grab and record the input of a FireWire DV/HDV device,
828 using a packet buffer of 100000 packets if the source is HDV.
830 ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
839 To enable this input device during configuration you need libjack
840 installed on your system.
842 A JACK input device creates one or more JACK writable clients, one for
843 each audio channel, with name @var{client_name}:input_@var{N}, where
844 @var{client_name} is the name provided by the application, and @var{N}
845 is a number which identifies the channel.
846 Each writable client will send the acquired data to the FFmpeg input
849 Once you have created one or more JACK readable clients, you need to
850 connect them to one or more JACK writable clients.
852 To connect or disconnect JACK clients you can use the @command{jack_connect}
853 and @command{jack_disconnect} programs, or do it through a graphical interface,
854 for example with @command{qjackctl}.
856 To list the JACK clients and their properties you can invoke the command
859 Follows an example which shows how to capture a JACK readable client
860 with @command{ffmpeg}.
862 # Create a JACK writable client with name "ffmpeg".
863 $ ffmpeg -f jack -i ffmpeg -y out.wav
865 # Start the sample jack_metro readable client.
866 $ jack_metro -b 120 -d 0.2 -f 4000
868 # List the current JACK clients.
877 # Connect metro to the ffmpeg writable client.
878 $ jack_connect metro:120_bpm ffmpeg:input_1
881 For more information read:
882 @url{http://jackaudio.org/}
889 Set the number of channels. Default is 2.
895 Libavfilter input virtual device.
897 This input device reads data from the open output pads of a libavfilter
900 For each filtergraph open output, the input device will create a
901 corresponding stream which is mapped to the generated output. Currently
902 only video data is supported. The filtergraph is specified through the
903 option @option{graph}.
910 Specify the filtergraph to use as input. Each video open output must be
911 labelled by a unique string of the form "out@var{N}", where @var{N} is a
912 number starting from 0 corresponding to the mapped input stream
913 generated by the device.
914 The first unlabelled output is automatically assigned to the "out0"
915 label, but all the others need to be specified explicitly.
917 The suffix "+subcc" can be appended to the output label to create an extra
918 stream with the closed captions packets attached to that output
919 (experimental; only for EIA-608 / CEA-708 for now).
920 The subcc streams are created after all the normal streams, in the order of
921 the corresponding stream.
922 For example, if there is "out19+subcc", "out7+subcc" and up to "out42", the
923 stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19.
925 If not specified defaults to the filename specified for the input
929 Set the filename of the filtergraph to be read and sent to the other
930 filters. Syntax of the filtergraph is the same as the one specified by
931 the option @var{graph}.
934 Dump graph to stderr.
942 Create a color video stream and play it back with @command{ffplay}:
944 ffplay -f lavfi -graph "color=c=pink [out0]" dummy
948 As the previous example, but use filename for specifying the graph
949 description, and omit the "out0" label:
951 ffplay -f lavfi color=c=pink
955 Create three different video test filtered sources and play them:
957 ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
961 Read an audio stream from a file using the amovie source and play it
962 back with @command{ffplay}:
964 ffplay -f lavfi "amovie=test.wav"
968 Read an audio stream and a video stream and play it back with
971 ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
975 Dump decoded frames to images and closed captions to a file (experimental):
977 ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
984 Audio-CD input device based on libcdio.
986 To enable this input device during configuration you need libcdio
987 installed on your system. It requires the configure option
988 @code{--enable-libcdio}.
990 This device allows playing and grabbing from an Audio-CD.
992 For example to copy with @command{ffmpeg} the entire Audio-CD in @file{/dev/sr0},
993 you may run the command:
995 ffmpeg -f libcdio -i /dev/sr0 cd.wav
1001 Set drive reading speed. Default value is 0.
1003 The speed is specified CD-ROM speed units. The speed is set through
1004 the libcdio @code{cdio_cddap_speed_set} function. On many CD-ROM
1005 drives, specifying a value too large will result in using the fastest
1009 Set paranoia recovery mode flags. It accepts one of the following values:
1019 Default value is @samp{disable}.
1021 For more information about the available recovery modes, consult the
1022 paranoia project documentation.
1027 IIDC1394 input device, based on libdc1394 and libraw1394.
1029 Requires the configure option @code{--enable-libdc1394}.
1033 The OpenAL input device provides audio capture on all systems with a
1034 working OpenAL 1.1 implementation.
1036 To enable this input device during configuration, you need OpenAL
1037 headers and libraries installed on your system, and need to configure
1038 FFmpeg with @code{--enable-openal}.
1040 OpenAL headers and libraries should be provided as part of your OpenAL
1041 implementation, or as an additional download (an SDK). Depending on your
1042 installation you may need to specify additional flags via the
1043 @code{--extra-cflags} and @code{--extra-ldflags} for allowing the build
1044 system to locate the OpenAL headers and libraries.
1046 An incomplete list of OpenAL implementations follows:
1050 The official Windows implementation, providing hardware acceleration
1051 with supported devices and software fallback.
1052 See @url{http://openal.org/}.
1054 Portable, open source (LGPL) software implementation. Includes
1055 backends for the most common sound APIs on the Windows, Linux,
1056 Solaris, and BSD operating systems.
1057 See @url{http://kcat.strangesoft.net/openal.html}.
1059 OpenAL is part of Core Audio, the official Mac OS X Audio interface.
1060 See @url{http://developer.apple.com/technologies/mac/audio-and-video.html}
1063 This device allows one to capture from an audio input device handled
1066 You need to specify the name of the device to capture in the provided
1067 filename. If the empty string is provided, the device will
1068 automatically select the default device. You can get the list of the
1069 supported devices by using the option @var{list_devices}.
1076 Set the number of channels in the captured audio. Only the values
1077 @option{1} (monaural) and @option{2} (stereo) are currently supported.
1078 Defaults to @option{2}.
1081 Set the sample size (in bits) of the captured audio. Only the values
1082 @option{8} and @option{16} are currently supported. Defaults to
1086 Set the sample rate (in Hz) of the captured audio.
1087 Defaults to @option{44.1k}.
1090 If set to @option{true}, print a list of devices and exit.
1091 Defaults to @option{false}.
1095 @subsection Examples
1097 Print the list of OpenAL supported devices and exit:
1099 $ ffmpeg -list_devices true -f openal -i dummy out.ogg
1102 Capture from the OpenAL device @file{DR-BT101 via PulseAudio}:
1104 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
1107 Capture from the default device (note the empty string '' as filename):
1109 $ ffmpeg -f openal -i '' out.ogg
1112 Capture from two devices simultaneously, writing to two different files,
1113 within the same @command{ffmpeg} command:
1115 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
1117 Note: not all OpenAL implementations support multiple simultaneous capture -
1118 try the latest OpenAL Soft if the above does not work.
1122 Open Sound System input device.
1124 The filename to provide to the input device is the device node
1125 representing the OSS input device, and is usually set to
1128 For example to grab from @file{/dev/dsp} using @command{ffmpeg} use the
1131 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
1134 For more information about OSS see:
1135 @url{http://manuals.opensound.com/usersguide/dsp.html}
1142 Set the sample rate in Hz. Default is 48000.
1145 Set the number of channels. Default is 2.
1152 PulseAudio input device.
1154 To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
1156 The filename to provide to the input device is a source device or the
1159 To list the PulseAudio source devices and their properties you can invoke
1160 the command @command{pactl list sources}.
1162 More information about PulseAudio can be found on @url{http://www.pulseaudio.org}.
1167 Connect to a specific PulseAudio server, specified by an IP address.
1168 Default server is used when not provided.
1171 Specify the application name PulseAudio will use when showing active clients,
1172 by default it is the @code{LIBAVFORMAT_IDENT} string.
1175 Specify the stream name PulseAudio will use when showing active streams,
1176 by default it is "record".
1179 Specify the samplerate in Hz, by default 48kHz is used.
1182 Specify the channels in use, by default 2 (stereo) is set.
1185 Specify the number of bytes per frame, by default it is set to 1024.
1188 Specify the minimal buffering fragment in PulseAudio, it will affect the
1189 audio latency. By default it is unset.
1192 Set the initial PTS using the current time. Default is 1.
1196 @subsection Examples
1197 Record a stream from default device:
1199 ffmpeg -f pulse -i default /tmp/pulse.wav
1206 To enable this input device during configuration you need libsndio
1207 installed on your system.
1209 The filename to provide to the input device is the device node
1210 representing the sndio input device, and is usually set to
1213 For example to grab from @file{/dev/audio0} using @command{ffmpeg} use the
1216 ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
1224 Set the sample rate in Hz. Default is 48000.
1227 Set the number of channels. Default is 2.
1231 @section video4linux2, v4l2
1233 Video4Linux2 input video device.
1235 "v4l2" can be used as alias for "video4linux2".
1237 If FFmpeg is built with v4l-utils support (by using the
1238 @code{--enable-libv4l2} configure option), it is possible to use it with the
1239 @code{-use_libv4l2} input device option.
1241 The name of the device to grab is a file device node, usually Linux
1242 systems tend to automatically create such nodes when the device
1243 (e.g. an USB webcam) is plugged into the system, and has a name of the
1244 kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
1247 Video4Linux2 devices usually support a limited set of
1248 @var{width}x@var{height} sizes and frame rates. You can check which are
1249 supported using @command{-list_formats all} for Video4Linux2 devices.
1250 Some devices, like TV cards, support one or more standards. It is possible
1251 to list all the supported standards using @command{-list_standards all}.
1253 The time base for the timestamps is 1 microsecond. Depending on the kernel
1254 version and configuration, the timestamps may be derived from the real time
1255 clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
1256 boot time, unaffected by NTP or manual changes to the clock). The
1257 @option{-timestamps abs} or @option{-ts abs} option can be used to force
1258 conversion into the real time clock.
1260 Some usage examples of the video4linux2 device with @command{ffmpeg}
1261 and @command{ffplay}:
1264 List supported formats for a video4linux2 device:
1266 ffplay -f video4linux2 -list_formats all /dev/video0
1270 Grab and show the input of a video4linux2 device:
1272 ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
1276 Grab and record the input of a video4linux2 device, leave the
1277 frame rate and size as previously set:
1279 ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
1283 For more information about Video4Linux, check @url{http://linuxtv.org/}.
1289 Set the standard. Must be the name of a supported standard. To get a
1290 list of the supported standards, use the @option{list_standards}
1294 Set the input channel number. Default to -1, which means using the
1295 previously selected channel.
1298 Set the video frame size. The argument must be a string in the form
1299 @var{WIDTH}x@var{HEIGHT} or a valid size abbreviation.
1302 Select the pixel format (only valid for raw video input).
1305 Set the preferred pixel format (for raw video) or a codec name.
1306 This option allows one to select the input format, when several are
1310 Set the preferred video frame rate.
1313 List available formats (supported pixel formats, codecs, and frame
1316 Available values are:
1319 Show all available (compressed and non-compressed) formats.
1322 Show only raw video (non-compressed) formats.
1325 Show only compressed formats.
1328 @item list_standards
1329 List supported standards and exit.
1331 Available values are:
1334 Show all supported standards.
1337 @item timestamps, ts
1338 Set type of timestamps for grabbed frames.
1340 Available values are:
1343 Use timestamps from the kernel.
1346 Use absolute timestamps (wall clock).
1349 Force conversion from monotonic to absolute timestamps.
1352 Default value is @code{default}.
1355 Use libv4l2 (v4l-utils) conversion functions. Default is 0.
1361 VfW (Video for Windows) capture input device.
1363 The filename passed as input is the capture driver number, ranging from
1364 0 to 9. You may use "list" as filename to print a list of drivers. Any
1365 other filename will be interpreted as device number 0.
1372 Set the video frame size.
1375 Set the grabbing frame rate. Default value is @code{ntsc},
1376 corresponding to a frame rate of @code{30000/1001}.
1382 X11 video input device.
1384 To enable this input device during configuration you need libxcb
1385 installed on your system. It will be automatically detected during
1388 This device allows one to capture a region of an X11 display.
1390 The filename passed as input has the syntax:
1392 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
1395 @var{hostname}:@var{display_number}.@var{screen_number} specifies the
1396 X11 display name of the screen to grab from. @var{hostname} can be
1397 omitted, and defaults to "localhost". The environment variable
1398 @env{DISPLAY} contains the default display name.
1400 @var{x_offset} and @var{y_offset} specify the offsets of the grabbed
1401 area with respect to the top-left border of the X11 screen. They
1404 Check the X11 documentation (e.g. @command{man X}) for more detailed
1407 Use the @command{xdpyinfo} program for getting basic information about
1408 the properties of your X11 display (e.g. grep for "name" or
1411 For example to grab from @file{:0.0} using @command{ffmpeg}:
1413 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
1416 Grab at position @code{10,20}:
1418 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1425 Specify whether to draw the mouse pointer. A value of @code{0} specifies
1426 not to draw the pointer. Default value is @code{1}.
1429 Make the grabbed area follow the mouse. The argument can be
1430 @code{centered} or a number of pixels @var{PIXELS}.
1432 When it is specified with "centered", the grabbing region follows the mouse
1433 pointer and keeps the pointer at the center of region; otherwise, the region
1434 follows only when the mouse pointer reaches within @var{PIXELS} (greater than
1435 zero) to the edge of region.
1439 ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
1442 To follow only when the mouse pointer reaches within 100 pixels to edge:
1444 ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
1448 Set the grabbing frame rate. Default value is @code{ntsc},
1449 corresponding to a frame rate of @code{30000/1001}.
1452 Show grabbed region on screen.
1454 If @var{show_region} is specified with @code{1}, then the grabbing
1455 region will be indicated on screen. With this option, it is easy to
1456 know what is being grabbed if only a portion of the screen is grabbed.
1459 Set the region border thickness if @option{-show_region 1} is used.
1460 Range is 1 to 128 and default is 3 (XCB-based x11grab only).
1464 ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1467 With @var{follow_mouse}:
1469 ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
1473 Set the video frame size. Default value is @code{vga}.
1477 Set the grabbing region coordinates. They are expressed as offset from
1478 the top left corner of the X11 window and correspond to the
1479 @var{x_offset} and @var{y_offset} parameters in the device name. The
1480 default value for both options is 0.
1483 @c man end INPUT DEVICES