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}.
323 ffmpeg -f decklink -list_devices 1 -i dummy
327 List supported formats:
329 ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
333 Capture video clip at 1080i50:
335 ffmpeg -format_code Hi50 -f decklink -i 'Intensity Pro' -acodec copy -vcodec copy output.avi
339 Capture video clip at 1080i50 10 bit:
341 ffmpeg -bm_v210 1 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -acodec copy -vcodec copy output.avi
345 Capture video clip at 1080i50 with 16 audio channels:
347 ffmpeg -channels 16 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -acodec copy -vcodec copy output.avi
354 KMS video input device.
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.
359 Requires either DRM master or CAP_SYS_ADMIN to run.
361 If you don't understand what all of that means, you probably don't want this. Look at
362 @option{x11grab} instead.
369 DRM device to capture on. Defaults to @option{/dev/dri/card0}.
372 Pixel format of the framebuffer. Defaults to @option{bgr0}.
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.
379 KMS CRTC ID to define the capture source. The first active plane on the given CRTC
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.
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}.
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.
403 ffmpeg -f kmsgrab -i - -vf 'hwdownload,format=bgr0' output.mp4
407 Capture from CRTC ID 42 at 60fps, map the result to VAAPI, convert to NV12 and encode as H.264.
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
414 @section libndi_newtek
416 The libndi_newtek input device provides capture capabilities for using NDI (Network
417 Device Interface, standard created by NewTek).
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.
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}.
431 If set to @option{true}, print a list of found/available NDI sources and exit.
432 Defaults to @option{false}.
435 Override time to wait until the number of online sources have changed.
436 Defaults to @option{0.5}.
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}.
451 ffmpeg -f libndi_newtek -find_sources 1 -i dummy
457 ffmpeg -f libndi_newtek -i "DEV-5.INTERNAL.M1STEREO.TV (NDI_SOURCE_NAME_1)" -f libndi_newtek -y NDI_SOURCE_NAME_2
464 Windows DirectShow input device.
466 DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
467 Currently only audio and video devices are supported.
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.
472 The input name should be in the format:
475 @var{TYPE}=@var{NAME}[:@var{TYPE}=@var{NAME}]
478 where @var{TYPE} can be either @var{audio} or @var{video},
479 and @var{NAME} is the device's name or alternative name..
483 If no options are specified, the device's defaults are used.
484 If the device does not support the requested options, it will
490 Set the video size in the captured video.
493 Set the frame rate in the captured video.
496 Set the sample rate (in Hz) of the captured audio.
499 Set the sample size (in bits) of the captured audio.
502 Set the number of channels in the captured audio.
505 If set to @option{true}, print a list of devices and exit.
508 If set to @option{true}, print a list of selected device's options
511 @item video_device_number
512 Set video device number for devices with the same name (starts at 0,
515 @item audio_device_number
516 Set audio device number for devices with the same name (starts at 0,
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.
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.
530 @url{http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx}
533 Select video capture pin to use by name or alternative name.
536 Select audio capture pin to use by name or alternative name.
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.
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.
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.
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.
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.
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.
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.
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).
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.
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.
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.
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.
618 Print the list of DirectShow supported devices and exit:
620 $ ffmpeg -list_devices true -f dshow -i dummy
624 Open video device @var{Camera}:
626 $ ffmpeg -f dshow -i video="Camera"
630 Open second video device with name @var{Camera}:
632 $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
636 Open video device @var{Camera} and audio device @var{Microphone}:
638 $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
642 Print the list of supported options in selected device and exit:
644 $ ffmpeg -list_options true -f dshow -i video="Camera"
648 Specify pin names to capture by name or alternative name, specify alternative device name:
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"
654 Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup:
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"
664 Linux framebuffer input device.
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
671 For more detailed information read the file
672 Documentation/fb/framebuffer.txt included in the Linux source tree.
674 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
676 To record from the framebuffer device @file{/dev/fb0} with
679 ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
682 You can take a single screenshot image with the command:
684 ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
692 Set the frame rate. Default is 25.
698 Win32 GDI-based screen capture device.
700 This device allows you to capture a region of the display on Windows.
702 There are two options for the input filename:
708 title=@var{window_title}
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.
715 For example, to grab the entire desktop using @command{ffmpeg}:
717 ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
720 Grab a 640x480 region at position @code{10,20}:
722 ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
725 Grab the contents of the window named "Calculator"
727 ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
734 Specify whether to draw the mouse pointer. Use the value @code{0} to
735 not draw the pointer. Default value is @code{1}.
738 Set the grabbing frame rate. Default value is @code{ntsc},
739 corresponding to a frame rate of @code{30000/1001}.
742 Show grabbed region on screen.
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.
748 Note that @var{show_region} is incompatible with grabbing the contents
753 ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
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.
760 When capturing a region with @var{video_size}, set the distance from the left edge of the screen or desktop.
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.
765 When capturing a region with @var{video_size}, set the distance from the top edge of the screen or desktop.
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.
773 FireWire DV/HDV input device using libiec61883.
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.
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.
784 Specify the FireWire port to be used as input file, or "auto"
785 to choose the first port connected.
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.
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.
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.
817 Grab and show the input of a FireWire DV/HDV device.
819 ffplay -f iec61883 -i auto
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.
826 ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
835 To enable this input device during configuration you need libjack
836 installed on your system.
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
845 Once you have created one or more JACK readable clients, you need to
846 connect them to one or more JACK writable clients.
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}.
852 To list the JACK clients and their properties you can invoke the command
855 Follows an example which shows how to capture a JACK readable client
856 with @command{ffmpeg}.
858 # Create a JACK writable client with name "ffmpeg".
859 $ ffmpeg -f jack -i ffmpeg -y out.wav
861 # Start the sample jack_metro readable client.
862 $ jack_metro -b 120 -d 0.2 -f 4000
864 # List the current JACK clients.
873 # Connect metro to the ffmpeg writable client.
874 $ jack_connect metro:120_bpm ffmpeg:input_1
877 For more information read:
878 @url{http://jackaudio.org/}
885 Set the number of channels. Default is 2.
891 Libavfilter input virtual device.
893 This input device reads data from the open output pads of a libavfilter
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}.
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.
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.
921 If not specified defaults to the filename specified for the input
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}.
930 Dump graph to stderr.
938 Create a color video stream and play it back with @command{ffplay}:
940 ffplay -f lavfi -graph "color=c=pink [out0]" dummy
944 As the previous example, but use filename for specifying the graph
945 description, and omit the "out0" label:
947 ffplay -f lavfi color=c=pink
951 Create three different video test filtered sources and play them:
953 ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
957 Read an audio stream from a file using the amovie source and play it
958 back with @command{ffplay}:
960 ffplay -f lavfi "amovie=test.wav"
964 Read an audio stream and a video stream and play it back with
967 ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
971 Dump decoded frames to images and closed captions to a file (experimental):
973 ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
980 Audio-CD input device based on libcdio.
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}.
986 This device allows playing and grabbing from an Audio-CD.
988 For example to copy with @command{ffmpeg} the entire Audio-CD in @file{/dev/sr0},
989 you may run the command:
991 ffmpeg -f libcdio -i /dev/sr0 cd.wav
997 Set drive reading speed. Default value is 0.
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
1005 Set paranoia recovery mode flags. It accepts one of the following values:
1015 Default value is @samp{disable}.
1017 For more information about the available recovery modes, consult the
1018 paranoia project documentation.
1023 IIDC1394 input device, based on libdc1394 and libraw1394.
1025 Requires the configure option @code{--enable-libdc1394}.
1029 The OpenAL input device provides audio capture on all systems with a
1030 working OpenAL 1.1 implementation.
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}.
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.
1042 An incomplete list of OpenAL implementations follows:
1046 The official Windows implementation, providing hardware acceleration
1047 with supported devices and software fallback.
1048 See @url{http://openal.org/}.
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}.
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}
1059 This device allows one to capture from an audio input device handled
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}.
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}.
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
1082 Set the sample rate (in Hz) of the captured audio.
1083 Defaults to @option{44.1k}.
1086 If set to @option{true}, print a list of devices and exit.
1087 Defaults to @option{false}.
1091 @subsection Examples
1093 Print the list of OpenAL supported devices and exit:
1095 $ ffmpeg -list_devices true -f openal -i dummy out.ogg
1098 Capture from the OpenAL device @file{DR-BT101 via PulseAudio}:
1100 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
1103 Capture from the default device (note the empty string '' as filename):
1105 $ ffmpeg -f openal -i '' out.ogg
1108 Capture from two devices simultaneously, writing to two different files,
1109 within the same @command{ffmpeg} command:
1111 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
1113 Note: not all OpenAL implementations support multiple simultaneous capture -
1114 try the latest OpenAL Soft if the above does not work.
1118 Open Sound System input device.
1120 The filename to provide to the input device is the device node
1121 representing the OSS input device, and is usually set to
1124 For example to grab from @file{/dev/dsp} using @command{ffmpeg} use the
1127 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
1130 For more information about OSS see:
1131 @url{http://manuals.opensound.com/usersguide/dsp.html}
1138 Set the sample rate in Hz. Default is 48000.
1141 Set the number of channels. Default is 2.
1148 PulseAudio input device.
1150 To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
1152 The filename to provide to the input device is a source device or the
1155 To list the PulseAudio source devices and their properties you can invoke
1156 the command @command{pactl list sources}.
1158 More information about PulseAudio can be found on @url{http://www.pulseaudio.org}.
1163 Connect to a specific PulseAudio server, specified by an IP address.
1164 Default server is used when not provided.
1167 Specify the application name PulseAudio will use when showing active clients,
1168 by default it is the @code{LIBAVFORMAT_IDENT} string.
1171 Specify the stream name PulseAudio will use when showing active streams,
1172 by default it is "record".
1175 Specify the samplerate in Hz, by default 48kHz is used.
1178 Specify the channels in use, by default 2 (stereo) is set.
1181 Specify the number of bytes per frame, by default it is set to 1024.
1184 Specify the minimal buffering fragment in PulseAudio, it will affect the
1185 audio latency. By default it is unset.
1188 Set the initial PTS using the current time. Default is 1.
1192 @subsection Examples
1193 Record a stream from default device:
1195 ffmpeg -f pulse -i default /tmp/pulse.wav
1202 To enable this input device during configuration you need libsndio
1203 installed on your system.
1205 The filename to provide to the input device is the device node
1206 representing the sndio input device, and is usually set to
1209 For example to grab from @file{/dev/audio0} using @command{ffmpeg} use the
1212 ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
1220 Set the sample rate in Hz. Default is 48000.
1223 Set the number of channels. Default is 2.
1227 @section video4linux2, v4l2
1229 Video4Linux2 input video device.
1231 "v4l2" can be used as alias for "video4linux2".
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.
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
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}.
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.
1256 Some usage examples of the video4linux2 device with @command{ffmpeg}
1257 and @command{ffplay}:
1260 List supported formats for a video4linux2 device:
1262 ffplay -f video4linux2 -list_formats all /dev/video0
1266 Grab and show the input of a video4linux2 device:
1268 ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
1272 Grab and record the input of a video4linux2 device, leave the
1273 frame rate and size as previously set:
1275 ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
1279 For more information about Video4Linux, check @url{http://linuxtv.org/}.
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}
1290 Set the input channel number. Default to -1, which means using the
1291 previously selected channel.
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.
1298 Select the pixel format (only valid for raw video input).
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
1306 Set the preferred video frame rate.
1309 List available formats (supported pixel formats, codecs, and frame
1312 Available values are:
1315 Show all available (compressed and non-compressed) formats.
1318 Show only raw video (non-compressed) formats.
1321 Show only compressed formats.
1324 @item list_standards
1325 List supported standards and exit.
1327 Available values are:
1330 Show all supported standards.
1333 @item timestamps, ts
1334 Set type of timestamps for grabbed frames.
1336 Available values are:
1339 Use timestamps from the kernel.
1342 Use absolute timestamps (wall clock).
1345 Force conversion from monotonic to absolute timestamps.
1348 Default value is @code{default}.
1351 Use libv4l2 (v4l-utils) conversion functions. Default is 0.
1357 VfW (Video for Windows) capture input device.
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.
1368 Set the video frame size.
1371 Set the grabbing frame rate. Default value is @code{ntsc},
1372 corresponding to a frame rate of @code{30000/1001}.
1378 X11 video input device.
1380 To enable this input device during configuration you need libxcb
1381 installed on your system. It will be automatically detected during
1384 This device allows one to capture a region of an X11 display.
1386 The filename passed as input has the syntax:
1388 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
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.
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
1400 Check the X11 documentation (e.g. @command{man X}) for more detailed
1403 Use the @command{xdpyinfo} program for getting basic information about
1404 the properties of your X11 display (e.g. grep for "name" or
1407 For example to grab from @file{:0.0} using @command{ffmpeg}:
1409 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
1412 Grab at position @code{10,20}:
1414 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
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}.
1425 Make the grabbed area follow the mouse. The argument can be
1426 @code{centered} or a number of pixels @var{PIXELS}.
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.
1435 ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
1438 To follow only when the mouse pointer reaches within 100 pixels to edge:
1440 ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
1444 Set the grabbing frame rate. Default value is @code{ntsc},
1445 corresponding to a frame rate of @code{30000/1001}.
1448 Show grabbed region on screen.
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.
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).
1460 ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1463 With @var{follow_mouse}:
1465 ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
1469 Set the video frame size. Default value is @code{vga}.
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.
1479 @c man end INPUT DEVICES