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).
241 Default behavior is autodetection of the input video format, if the hardware
245 This is a deprecated option, you can use @option{raw_format} instead.
246 If set to @samp{1}, video is captured in 10 bit v210 instead
247 of uyvy422. Not all Blackmagic devices support this option.
250 Set the pixel format of the captured video.
251 Available values are:
266 If set to nonzero, an additional teletext stream will be captured from the
267 vertical ancillary data. Both SD PAL (576i) and HD (1080i or 1080p)
268 sources are supported. In case of HD sources, OP47 packets are decoded.
270 This option is a bitmask of the SD PAL VBI lines captured, specifically lines 6
271 to 22, and lines 318 to 335. Line 6 is the LSB in the mask. Selected lines
272 which do not contain teletext information will be ignored. You can use the
273 special @option{all} constant to select all possible lines, or
274 @option{standard} to skip lines 6, 318 and 319, which are not compatible with
277 For SD sources, ffmpeg needs to be compiled with @code{--enable-libzvbi}. For
278 HD sources, on older (pre-4K) DeckLink card models you have to capture in 10
282 Defines number of audio channels to capture. Must be @samp{2}, @samp{8} or @samp{16}.
283 Defaults to @samp{2}.
286 Sets the decklink device duplex mode. Must be @samp{unset}, @samp{half} or @samp{full}.
287 Defaults to @samp{unset}.
290 Sets the video input source. Must be @samp{unset}, @samp{sdi}, @samp{hdmi},
291 @samp{optical_sdi}, @samp{component}, @samp{composite} or @samp{s_video}.
292 Defaults to @samp{unset}.
295 Sets the audio input source. Must be @samp{unset}, @samp{embedded},
296 @samp{aes_ebu}, @samp{analog}, @samp{analog_xlr}, @samp{analog_rca} or
297 @samp{microphone}. Defaults to @samp{unset}.
300 Sets the video packet timestamp source. Must be @samp{video}, @samp{audio},
301 @samp{reference}, @samp{wallclock} or @samp{abs_wallclock}.
302 Defaults to @samp{video}.
305 Sets the audio packet timestamp source. Must be @samp{video}, @samp{audio},
306 @samp{reference}, @samp{wallclock} or @samp{abs_wallclock}.
307 Defaults to @samp{audio}.
310 If set to @samp{true}, color bars are drawn in the event of a signal loss.
311 Defaults to @samp{true}.
314 Sets maximum input buffer size in bytes. If the buffering reaches this value,
315 incoming frames will be dropped.
316 Defaults to @samp{1073741824}.
319 Sets the audio sample bit depth. Must be @samp{16} or @samp{32}.
320 Defaults to @samp{16}.
322 @item decklink_copyts
323 If set to @option{true}, timestamps are forwarded as they are without removing
325 Defaults to @option{false}.
336 ffmpeg -f decklink -list_devices 1 -i dummy
340 List supported formats:
342 ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
346 Capture video clip at 1080i50:
348 ffmpeg -format_code Hi50 -f decklink -i 'Intensity Pro' -c:a copy -c:v copy output.avi
352 Capture video clip at 1080i50 10 bit:
354 ffmpeg -bm_v210 1 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
358 Capture video clip at 1080i50 with 16 audio channels:
360 ffmpeg -channels 16 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi
367 KMS video input device.
369 Captures the KMS scanout framebuffer associated with a specified CRTC or plane as a
370 DRM object that can be passed to other hardware functions.
372 Requires either DRM master or CAP_SYS_ADMIN to run.
374 If you don't understand what all of that means, you probably don't want this. Look at
375 @option{x11grab} instead.
382 DRM device to capture on. Defaults to @option{/dev/dri/card0}.
385 Pixel format of the framebuffer. Defaults to @option{bgr0}.
387 @item format_modifier
388 Format modifier to signal on output frames. This is necessary to import correctly into
389 some APIs, but can't be autodetected. See the libdrm documentation for possible values.
392 KMS CRTC ID to define the capture source. The first active plane on the given CRTC
396 KMS plane ID to define the capture source. Defaults to the first active plane found if
397 neither @option{crtc_id} nor @option{plane_id} are specified.
400 Framerate to capture at. This is not synchronised to any page flipping or framebuffer
401 changes - it just defines the interval at which the framebuffer is sampled. Sampling
402 faster than the framebuffer update rate will generate independent frames with the same
403 content. Defaults to @code{30}.
412 Capture from the first active plane, download the result to normal frames and encode.
413 This will only work if the framebuffer is both linear and mappable - if not, the result
414 may be scrambled or fail to download.
416 ffmpeg -f kmsgrab -i - -vf 'hwdownload,format=bgr0' output.mp4
420 Capture from CRTC ID 42 at 60fps, map the result to VAAPI, convert to NV12 and encode as H.264.
422 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
427 @section libndi_newtek
429 The libndi_newtek input device provides capture capabilities for using NDI (Network
430 Device Interface, standard created by NewTek).
432 Input filename is a NDI source name that could be found by sending -find_sources 1
433 to command line - it has no specific syntax but human-readable formatted.
435 To enable this input device, you need the NDI SDK and you
436 need to configure with the appropriate @code{--extra-cflags}
437 and @code{--extra-ldflags}.
444 If set to @option{true}, print a list of found/available NDI sources and exit.
445 Defaults to @option{false}.
448 Override time to wait until the number of online sources have changed.
449 Defaults to @option{0.5}.
451 @item allow_video_fields
452 When this flag is @option{false}, all video that you receive will be progressive.
453 Defaults to @option{true}.
464 ffmpeg -f libndi_newtek -find_sources 1 -i dummy
470 ffmpeg -f libndi_newtek -i "DEV-5.INTERNAL.M1STEREO.TV (NDI_SOURCE_NAME_1)" -f libndi_newtek -y NDI_SOURCE_NAME_2
477 Windows DirectShow input device.
479 DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
480 Currently only audio and video devices are supported.
482 Multiple devices may be opened as separate inputs, but they may also be
483 opened on the same input, which should improve synchronism between them.
485 The input name should be in the format:
488 @var{TYPE}=@var{NAME}[:@var{TYPE}=@var{NAME}]
491 where @var{TYPE} can be either @var{audio} or @var{video},
492 and @var{NAME} is the device's name or alternative name..
496 If no options are specified, the device's defaults are used.
497 If the device does not support the requested options, it will
503 Set the video size in the captured video.
506 Set the frame rate in the captured video.
509 Set the sample rate (in Hz) of the captured audio.
512 Set the sample size (in bits) of the captured audio.
515 Set the number of channels in the captured audio.
518 If set to @option{true}, print a list of devices and exit.
521 If set to @option{true}, print a list of selected device's options
524 @item video_device_number
525 Set video device number for devices with the same name (starts at 0,
528 @item audio_device_number
529 Set audio device number for devices with the same name (starts at 0,
533 Select pixel format to be used by DirectShow. This may only be set when
534 the video codec is not set or set to rawvideo.
536 @item audio_buffer_size
537 Set audio device buffer size in milliseconds (which can directly
538 impact latency, depending on the device).
539 Defaults to using the audio device's
540 default buffer size (typically some multiple of 500ms).
541 Setting this value too low can degrade performance.
543 @url{http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx}
546 Select video capture pin to use by name or alternative name.
549 Select audio capture pin to use by name or alternative name.
551 @item crossbar_video_input_pin_number
552 Select video input pin number for crossbar device. This will be
553 routed to the crossbar device's Video Decoder output pin.
554 Note that changing this value can affect future invocations
555 (sets a new default) until system reboot occurs.
557 @item crossbar_audio_input_pin_number
558 Select audio input pin number for crossbar device. This will be
559 routed to the crossbar device's Audio Decoder output pin.
560 Note that changing this value can affect future invocations
561 (sets a new default) until system reboot occurs.
563 @item show_video_device_dialog
564 If set to @option{true}, before capture starts, popup a display dialog
565 to the end user, allowing them to change video filter properties
566 and configurations manually.
567 Note that for crossbar devices, adjusting values in this dialog
568 may be needed at times to toggle between PAL (25 fps) and NTSC (29.97)
569 input frame rates, sizes, interlacing, etc. Changing these values can
570 enable different scan rates/frame rates and avoiding green bars at
571 the bottom, flickering scan lines, etc.
572 Note that with some devices, changing these properties can also affect future
573 invocations (sets new defaults) until system reboot occurs.
575 @item show_audio_device_dialog
576 If set to @option{true}, before capture starts, popup a display dialog
577 to the end user, allowing them to change audio filter properties
578 and configurations manually.
580 @item show_video_crossbar_connection_dialog
581 If set to @option{true}, before capture starts, popup a display
582 dialog to the end user, allowing them to manually
583 modify crossbar pin routings, when it opens a video device.
585 @item show_audio_crossbar_connection_dialog
586 If set to @option{true}, before capture starts, popup a display
587 dialog to the end user, allowing them to manually
588 modify crossbar pin routings, when it opens an audio device.
590 @item show_analog_tv_tuner_dialog
591 If set to @option{true}, before capture starts, popup a display
592 dialog to the end user, allowing them to manually
593 modify TV channels and frequencies.
595 @item show_analog_tv_tuner_audio_dialog
596 If set to @option{true}, before capture starts, popup a display
597 dialog to the end user, allowing them to manually
598 modify TV audio (like mono vs. stereo, Language A,B or C).
600 @item audio_device_load
601 Load an audio capture filter device from file instead of searching
602 it by name. It may load additional parameters too, if the filter
603 supports the serialization of its properties to.
604 To use this an audio capture source has to be specified, but it can
605 be anything even fake one.
607 @item audio_device_save
608 Save the currently used audio capture filter device and its
609 parameters (if the filter supports it) to a file.
610 If a file with the same name exists it will be overwritten.
612 @item video_device_load
613 Load a video capture filter device from file instead of searching
614 it by name. It may load additional parameters too, if the filter
615 supports the serialization of its properties to.
616 To use this a video capture source has to be specified, but it can
617 be anything even fake one.
619 @item video_device_save
620 Save the currently used video capture filter device and its
621 parameters (if the filter supports it) to a file.
622 If a file with the same name exists it will be overwritten.
631 Print the list of DirectShow supported devices and exit:
633 $ ffmpeg -list_devices true -f dshow -i dummy
637 Open video device @var{Camera}:
639 $ ffmpeg -f dshow -i video="Camera"
643 Open second video device with name @var{Camera}:
645 $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
649 Open video device @var{Camera} and audio device @var{Microphone}:
651 $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
655 Print the list of supported options in selected device and exit:
657 $ ffmpeg -list_options true -f dshow -i video="Camera"
661 Specify pin names to capture by name or alternative name, specify alternative device name:
663 $ 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"
667 Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup:
669 $ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_number 0
670 -crossbar_audio_input_pin_number 3 -i video="AVerMedia BDA Analog Capture":audio="AVerMedia BDA Analog Capture"
677 Linux framebuffer input device.
679 The Linux framebuffer is a graphic hardware-independent abstraction
680 layer to show graphics on a computer monitor, typically on the
681 console. It is accessed through a file device node, usually
684 For more detailed information read the file
685 Documentation/fb/framebuffer.txt included in the Linux source tree.
687 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
689 To record from the framebuffer device @file{/dev/fb0} with
692 ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
695 You can take a single screenshot image with the command:
697 ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
705 Set the frame rate. Default is 25.
711 Win32 GDI-based screen capture device.
713 This device allows you to capture a region of the display on Windows.
715 There are two options for the input filename:
721 title=@var{window_title}
724 The first option will capture the entire desktop, or a fixed region of the
725 desktop. The second option will instead capture the contents of a single
726 window, regardless of its position on the screen.
728 For example, to grab the entire desktop using @command{ffmpeg}:
730 ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
733 Grab a 640x480 region at position @code{10,20}:
735 ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
738 Grab the contents of the window named "Calculator"
740 ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
747 Specify whether to draw the mouse pointer. Use the value @code{0} to
748 not draw the pointer. Default value is @code{1}.
751 Set the grabbing frame rate. Default value is @code{ntsc},
752 corresponding to a frame rate of @code{30000/1001}.
755 Show grabbed region on screen.
757 If @var{show_region} is specified with @code{1}, then the grabbing
758 region will be indicated on screen. With this option, it is easy to
759 know what is being grabbed if only a portion of the screen is grabbed.
761 Note that @var{show_region} is incompatible with grabbing the contents
766 ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
770 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.
773 When capturing a region with @var{video_size}, set the distance from the left edge of the screen or desktop.
775 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.
778 When capturing a region with @var{video_size}, set the distance from the top edge of the screen or desktop.
780 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.
786 FireWire DV/HDV input device using libiec61883.
788 To enable this input device, you need libiec61883, libraw1394 and
789 libavc1394 installed on your system. Use the configure option
790 @code{--enable-libiec61883} to compile with the device enabled.
792 The iec61883 capture device supports capturing from a video device
793 connected via IEEE1394 (FireWire), using libiec61883 and the new Linux
794 FireWire stack (juju). This is the default DV/HDV input method in Linux
795 Kernel 2.6.37 and later, since the old FireWire stack was removed.
797 Specify the FireWire port to be used as input file, or "auto"
798 to choose the first port connected.
805 Override autodetection of DV/HDV. This should only be used if auto
806 detection does not work, or if usage of a different device type
807 should be prohibited. Treating a DV device as HDV (or vice versa) will
808 not work and result in undefined behavior.
809 The values @option{auto}, @option{dv} and @option{hdv} are supported.
812 Set maximum size of buffer for incoming data, in frames. For DV, this
813 is an exact value. For HDV, it is not frame exact, since HDV does
814 not have a fixed frame size.
817 Select the capture device by specifying its GUID. Capturing will only
818 be performed from the specified device and fails if no device with the
819 given GUID is found. This is useful to select the input if multiple
820 devices are connected at the same time.
821 Look at /sys/bus/firewire/devices to find out the GUIDs.
830 Grab and show the input of a FireWire DV/HDV device.
832 ffplay -f iec61883 -i auto
836 Grab and record the input of a FireWire DV/HDV device,
837 using a packet buffer of 100000 packets if the source is HDV.
839 ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
848 To enable this input device during configuration you need libjack
849 installed on your system.
851 A JACK input device creates one or more JACK writable clients, one for
852 each audio channel, with name @var{client_name}:input_@var{N}, where
853 @var{client_name} is the name provided by the application, and @var{N}
854 is a number which identifies the channel.
855 Each writable client will send the acquired data to the FFmpeg input
858 Once you have created one or more JACK readable clients, you need to
859 connect them to one or more JACK writable clients.
861 To connect or disconnect JACK clients you can use the @command{jack_connect}
862 and @command{jack_disconnect} programs, or do it through a graphical interface,
863 for example with @command{qjackctl}.
865 To list the JACK clients and their properties you can invoke the command
868 Follows an example which shows how to capture a JACK readable client
869 with @command{ffmpeg}.
871 # Create a JACK writable client with name "ffmpeg".
872 $ ffmpeg -f jack -i ffmpeg -y out.wav
874 # Start the sample jack_metro readable client.
875 $ jack_metro -b 120 -d 0.2 -f 4000
877 # List the current JACK clients.
886 # Connect metro to the ffmpeg writable client.
887 $ jack_connect metro:120_bpm ffmpeg:input_1
890 For more information read:
891 @url{http://jackaudio.org/}
898 Set the number of channels. Default is 2.
904 Libavfilter input virtual device.
906 This input device reads data from the open output pads of a libavfilter
909 For each filtergraph open output, the input device will create a
910 corresponding stream which is mapped to the generated output. Currently
911 only video data is supported. The filtergraph is specified through the
912 option @option{graph}.
919 Specify the filtergraph to use as input. Each video open output must be
920 labelled by a unique string of the form "out@var{N}", where @var{N} is a
921 number starting from 0 corresponding to the mapped input stream
922 generated by the device.
923 The first unlabelled output is automatically assigned to the "out0"
924 label, but all the others need to be specified explicitly.
926 The suffix "+subcc" can be appended to the output label to create an extra
927 stream with the closed captions packets attached to that output
928 (experimental; only for EIA-608 / CEA-708 for now).
929 The subcc streams are created after all the normal streams, in the order of
930 the corresponding stream.
931 For example, if there is "out19+subcc", "out7+subcc" and up to "out42", the
932 stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19.
934 If not specified defaults to the filename specified for the input
938 Set the filename of the filtergraph to be read and sent to the other
939 filters. Syntax of the filtergraph is the same as the one specified by
940 the option @var{graph}.
943 Dump graph to stderr.
951 Create a color video stream and play it back with @command{ffplay}:
953 ffplay -f lavfi -graph "color=c=pink [out0]" dummy
957 As the previous example, but use filename for specifying the graph
958 description, and omit the "out0" label:
960 ffplay -f lavfi color=c=pink
964 Create three different video test filtered sources and play them:
966 ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
970 Read an audio stream from a file using the amovie source and play it
971 back with @command{ffplay}:
973 ffplay -f lavfi "amovie=test.wav"
977 Read an audio stream and a video stream and play it back with
980 ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
984 Dump decoded frames to images and closed captions to a file (experimental):
986 ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
993 Audio-CD input device based on libcdio.
995 To enable this input device during configuration you need libcdio
996 installed on your system. It requires the configure option
997 @code{--enable-libcdio}.
999 This device allows playing and grabbing from an Audio-CD.
1001 For example to copy with @command{ffmpeg} the entire Audio-CD in @file{/dev/sr0},
1002 you may run the command:
1004 ffmpeg -f libcdio -i /dev/sr0 cd.wav
1010 Set drive reading speed. Default value is 0.
1012 The speed is specified CD-ROM speed units. The speed is set through
1013 the libcdio @code{cdio_cddap_speed_set} function. On many CD-ROM
1014 drives, specifying a value too large will result in using the fastest
1018 Set paranoia recovery mode flags. It accepts one of the following values:
1028 Default value is @samp{disable}.
1030 For more information about the available recovery modes, consult the
1031 paranoia project documentation.
1036 IIDC1394 input device, based on libdc1394 and libraw1394.
1038 Requires the configure option @code{--enable-libdc1394}.
1042 The OpenAL input device provides audio capture on all systems with a
1043 working OpenAL 1.1 implementation.
1045 To enable this input device during configuration, you need OpenAL
1046 headers and libraries installed on your system, and need to configure
1047 FFmpeg with @code{--enable-openal}.
1049 OpenAL headers and libraries should be provided as part of your OpenAL
1050 implementation, or as an additional download (an SDK). Depending on your
1051 installation you may need to specify additional flags via the
1052 @code{--extra-cflags} and @code{--extra-ldflags} for allowing the build
1053 system to locate the OpenAL headers and libraries.
1055 An incomplete list of OpenAL implementations follows:
1059 The official Windows implementation, providing hardware acceleration
1060 with supported devices and software fallback.
1061 See @url{http://openal.org/}.
1063 Portable, open source (LGPL) software implementation. Includes
1064 backends for the most common sound APIs on the Windows, Linux,
1065 Solaris, and BSD operating systems.
1066 See @url{http://kcat.strangesoft.net/openal.html}.
1068 OpenAL is part of Core Audio, the official Mac OS X Audio interface.
1069 See @url{http://developer.apple.com/technologies/mac/audio-and-video.html}
1072 This device allows one to capture from an audio input device handled
1075 You need to specify the name of the device to capture in the provided
1076 filename. If the empty string is provided, the device will
1077 automatically select the default device. You can get the list of the
1078 supported devices by using the option @var{list_devices}.
1085 Set the number of channels in the captured audio. Only the values
1086 @option{1} (monaural) and @option{2} (stereo) are currently supported.
1087 Defaults to @option{2}.
1090 Set the sample size (in bits) of the captured audio. Only the values
1091 @option{8} and @option{16} are currently supported. Defaults to
1095 Set the sample rate (in Hz) of the captured audio.
1096 Defaults to @option{44.1k}.
1099 If set to @option{true}, print a list of devices and exit.
1100 Defaults to @option{false}.
1104 @subsection Examples
1106 Print the list of OpenAL supported devices and exit:
1108 $ ffmpeg -list_devices true -f openal -i dummy out.ogg
1111 Capture from the OpenAL device @file{DR-BT101 via PulseAudio}:
1113 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
1116 Capture from the default device (note the empty string '' as filename):
1118 $ ffmpeg -f openal -i '' out.ogg
1121 Capture from two devices simultaneously, writing to two different files,
1122 within the same @command{ffmpeg} command:
1124 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
1126 Note: not all OpenAL implementations support multiple simultaneous capture -
1127 try the latest OpenAL Soft if the above does not work.
1131 Open Sound System input device.
1133 The filename to provide to the input device is the device node
1134 representing the OSS input device, and is usually set to
1137 For example to grab from @file{/dev/dsp} using @command{ffmpeg} use the
1140 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
1143 For more information about OSS see:
1144 @url{http://manuals.opensound.com/usersguide/dsp.html}
1151 Set the sample rate in Hz. Default is 48000.
1154 Set the number of channels. Default is 2.
1161 PulseAudio input device.
1163 To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
1165 The filename to provide to the input device is a source device or the
1168 To list the PulseAudio source devices and their properties you can invoke
1169 the command @command{pactl list sources}.
1171 More information about PulseAudio can be found on @url{http://www.pulseaudio.org}.
1176 Connect to a specific PulseAudio server, specified by an IP address.
1177 Default server is used when not provided.
1180 Specify the application name PulseAudio will use when showing active clients,
1181 by default it is the @code{LIBAVFORMAT_IDENT} string.
1184 Specify the stream name PulseAudio will use when showing active streams,
1185 by default it is "record".
1188 Specify the samplerate in Hz, by default 48kHz is used.
1191 Specify the channels in use, by default 2 (stereo) is set.
1194 Specify the number of bytes per frame, by default it is set to 1024.
1197 Specify the minimal buffering fragment in PulseAudio, it will affect the
1198 audio latency. By default it is unset.
1201 Set the initial PTS using the current time. Default is 1.
1205 @subsection Examples
1206 Record a stream from default device:
1208 ffmpeg -f pulse -i default /tmp/pulse.wav
1215 To enable this input device during configuration you need libsndio
1216 installed on your system.
1218 The filename to provide to the input device is the device node
1219 representing the sndio input device, and is usually set to
1222 For example to grab from @file{/dev/audio0} using @command{ffmpeg} use the
1225 ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
1233 Set the sample rate in Hz. Default is 48000.
1236 Set the number of channels. Default is 2.
1240 @section video4linux2, v4l2
1242 Video4Linux2 input video device.
1244 "v4l2" can be used as alias for "video4linux2".
1246 If FFmpeg is built with v4l-utils support (by using the
1247 @code{--enable-libv4l2} configure option), it is possible to use it with the
1248 @code{-use_libv4l2} input device option.
1250 The name of the device to grab is a file device node, usually Linux
1251 systems tend to automatically create such nodes when the device
1252 (e.g. an USB webcam) is plugged into the system, and has a name of the
1253 kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
1256 Video4Linux2 devices usually support a limited set of
1257 @var{width}x@var{height} sizes and frame rates. You can check which are
1258 supported using @command{-list_formats all} for Video4Linux2 devices.
1259 Some devices, like TV cards, support one or more standards. It is possible
1260 to list all the supported standards using @command{-list_standards all}.
1262 The time base for the timestamps is 1 microsecond. Depending on the kernel
1263 version and configuration, the timestamps may be derived from the real time
1264 clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
1265 boot time, unaffected by NTP or manual changes to the clock). The
1266 @option{-timestamps abs} or @option{-ts abs} option can be used to force
1267 conversion into the real time clock.
1269 Some usage examples of the video4linux2 device with @command{ffmpeg}
1270 and @command{ffplay}:
1273 List supported formats for a video4linux2 device:
1275 ffplay -f video4linux2 -list_formats all /dev/video0
1279 Grab and show the input of a video4linux2 device:
1281 ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
1285 Grab and record the input of a video4linux2 device, leave the
1286 frame rate and size as previously set:
1288 ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
1292 For more information about Video4Linux, check @url{http://linuxtv.org/}.
1298 Set the standard. Must be the name of a supported standard. To get a
1299 list of the supported standards, use the @option{list_standards}
1303 Set the input channel number. Default to -1, which means using the
1304 previously selected channel.
1307 Set the video frame size. The argument must be a string in the form
1308 @var{WIDTH}x@var{HEIGHT} or a valid size abbreviation.
1311 Select the pixel format (only valid for raw video input).
1314 Set the preferred pixel format (for raw video) or a codec name.
1315 This option allows one to select the input format, when several are
1319 Set the preferred video frame rate.
1322 List available formats (supported pixel formats, codecs, and frame
1325 Available values are:
1328 Show all available (compressed and non-compressed) formats.
1331 Show only raw video (non-compressed) formats.
1334 Show only compressed formats.
1337 @item list_standards
1338 List supported standards and exit.
1340 Available values are:
1343 Show all supported standards.
1346 @item timestamps, ts
1347 Set type of timestamps for grabbed frames.
1349 Available values are:
1352 Use timestamps from the kernel.
1355 Use absolute timestamps (wall clock).
1358 Force conversion from monotonic to absolute timestamps.
1361 Default value is @code{default}.
1364 Use libv4l2 (v4l-utils) conversion functions. Default is 0.
1370 VfW (Video for Windows) capture input device.
1372 The filename passed as input is the capture driver number, ranging from
1373 0 to 9. You may use "list" as filename to print a list of drivers. Any
1374 other filename will be interpreted as device number 0.
1381 Set the video frame size.
1384 Set the grabbing frame rate. Default value is @code{ntsc},
1385 corresponding to a frame rate of @code{30000/1001}.
1391 X11 video input device.
1393 To enable this input device during configuration you need libxcb
1394 installed on your system. It will be automatically detected during
1397 This device allows one to capture a region of an X11 display.
1399 The filename passed as input has the syntax:
1401 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
1404 @var{hostname}:@var{display_number}.@var{screen_number} specifies the
1405 X11 display name of the screen to grab from. @var{hostname} can be
1406 omitted, and defaults to "localhost". The environment variable
1407 @env{DISPLAY} contains the default display name.
1409 @var{x_offset} and @var{y_offset} specify the offsets of the grabbed
1410 area with respect to the top-left border of the X11 screen. They
1413 Check the X11 documentation (e.g. @command{man X}) for more detailed
1416 Use the @command{xdpyinfo} program for getting basic information about
1417 the properties of your X11 display (e.g. grep for "name" or
1420 For example to grab from @file{:0.0} using @command{ffmpeg}:
1422 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
1425 Grab at position @code{10,20}:
1427 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1434 Specify whether to draw the mouse pointer. A value of @code{0} specifies
1435 not to draw the pointer. Default value is @code{1}.
1438 Make the grabbed area follow the mouse. The argument can be
1439 @code{centered} or a number of pixels @var{PIXELS}.
1441 When it is specified with "centered", the grabbing region follows the mouse
1442 pointer and keeps the pointer at the center of region; otherwise, the region
1443 follows only when the mouse pointer reaches within @var{PIXELS} (greater than
1444 zero) to the edge of region.
1448 ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
1451 To follow only when the mouse pointer reaches within 100 pixels to edge:
1453 ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
1457 Set the grabbing frame rate. Default value is @code{ntsc},
1458 corresponding to a frame rate of @code{30000/1001}.
1461 Show grabbed region on screen.
1463 If @var{show_region} is specified with @code{1}, then the grabbing
1464 region will be indicated on screen. With this option, it is easy to
1465 know what is being grabbed if only a portion of the screen is grabbed.
1468 Set the region border thickness if @option{-show_region 1} is used.
1469 Range is 1 to 128 and default is 3 (XCB-based x11grab only).
1473 ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1476 With @var{follow_mouse}:
1478 ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
1482 Set the video frame size. Default value is @code{vga}.
1486 Set the grabbing region coordinates. They are expressed as offset from
1487 the top left corner of the X11 window and correspond to the
1488 @var{x_offset} and @var{y_offset} parameters in the device name. The
1489 default value for both options is 0.
1492 @c man end INPUT DEVICES