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 is
218 uyvy422 or v210, framerate and video size must be determined for your device with
219 @command{-list_formats 1}. Audio sample rate is always 48 kHz and the number
220 of channels can be 2, 8 or 16. Note that all audio channels are bundled in one single
228 If set to @option{true}, print a list of devices and exit.
229 Defaults to @option{false}.
232 If set to @option{true}, print a list of supported formats and exit.
233 Defaults to @option{false}.
235 @item format_code <FourCC>
236 This sets the input video format to the format given by the FourCC. To see
237 the supported values of your device(s) use @option{list_formats}.
238 Note that there is a FourCC @option{'pal '} that can also be used
239 as @option{pal} (3 letters).
242 If set to @samp{1}, video is captured in 10 bit v210 instead
243 of uyvy422. Not all Blackmagic devices support this option.
246 If set to nonzero, an additional teletext stream will be captured from the
247 vertical ancillary data. Both SD PAL (576i) and HD (1080i or 1080p)
248 sources are supported. In case of HD sources, OP47 packets are decoded.
250 This option is a bitmask of the SD PAL VBI lines captured, specifically lines 6
251 to 22, and lines 318 to 335. Line 6 is the LSB in the mask. Selected lines
252 which do not contain teletext information will be ignored. You can use the
253 special @option{all} constant to select all possible lines, or
254 @option{standard} to skip lines 6, 318 and 319, which are not compatible with
257 For SD sources, ffmpeg needs to be compiled with @code{--enable-libzvbi}. For
258 HD sources, on older (pre-4K) DeckLink card models you have to capture in 10
262 Defines number of audio channels to capture. Must be @samp{2}, @samp{8} or @samp{16}.
263 Defaults to @samp{2}.
266 Sets the decklink device duplex mode. Must be @samp{unset}, @samp{half} or @samp{full}.
267 Defaults to @samp{unset}.
270 Sets the video input source. Must be @samp{unset}, @samp{sdi}, @samp{hdmi},
271 @samp{optical_sdi}, @samp{component}, @samp{composite} or @samp{s_video}.
272 Defaults to @samp{unset}.
275 Sets the audio input source. Must be @samp{unset}, @samp{embedded},
276 @samp{aes_ebu}, @samp{analog}, @samp{analog_xlr}, @samp{analog_rca} or
277 @samp{microphone}. Defaults to @samp{unset}.
280 Sets the video packet timestamp source. Must be @samp{video}, @samp{audio},
281 @samp{reference} or @samp{wallclock}. Defaults to @samp{video}.
284 Sets the audio packet timestamp source. Must be @samp{video}, @samp{audio},
285 @samp{reference} or @samp{wallclock}. Defaults to @samp{audio}.
288 If set to @samp{true}, color bars are drawn in the event of a signal loss.
289 Defaults to @samp{true}.
292 Sets maximum input buffer size in bytes. If the buffering reaches this value,
293 incoming frames will be dropped.
294 Defaults to @samp{1073741824}.
305 ffmpeg -f decklink -list_devices 1 -i dummy
309 List supported formats:
311 ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
315 Capture video clip at 1080i50:
317 ffmpeg -format_code Hi50 -f decklink -i 'Intensity Pro' -acodec copy -vcodec copy output.avi
321 Capture video clip at 1080i50 10 bit:
323 ffmpeg -bm_v210 1 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -acodec copy -vcodec copy output.avi
327 Capture video clip at 1080i50 with 16 audio channels:
329 ffmpeg -channels 16 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -acodec copy -vcodec copy output.avi
336 KMS video input device.
338 Captures the KMS scanout framebuffer associated with a specified CRTC or plane as a
339 DRM object that can be passed to other hardware functions.
341 Requires either DRM master or CAP_SYS_ADMIN to run.
343 If you don't understand what all of that means, you probably don't want this. Look at
344 @option{x11grab} instead.
351 DRM device to capture on. Defaults to @option{/dev/dri/card0}.
354 Pixel format of the framebuffer. Defaults to @option{bgr0}.
356 @item format_modifier
357 Format modifier to signal on output frames. This is necessary to import correctly into
358 some APIs, but can't be autodetected. See the libdrm documentation for possible values.
361 KMS CRTC ID to define the capture source. The first active plane on the given CRTC
365 KMS plane ID to define the capture source. Defaults to the first active plane found if
366 neither @option{crtc_id} nor @option{plane_id} are specified.
369 Framerate to capture at. This is not synchronised to any page flipping or framebuffer
370 changes - it just defines the interval at which the framebuffer is sampled. Sampling
371 faster than the framebuffer update rate will generate independent frames with the same
372 content. Defaults to @code{30}.
381 Capture from the first active plane, download the result to normal frames and encode.
382 This will only work if the framebuffer is both linear and mappable - if not, the result
383 may be scrambled or fail to download.
385 ffmpeg -f kmsgrab -i - -vf 'hwdownload,format=bgr0' output.mp4
389 Capture from CRTC ID 42 at 60fps, map the result to VAAPI, convert to NV12 and encode as H.264.
391 ffmpeg -crtc_id 42 -framerate 60 -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,scale_vaapi=w=1920:h=1080:format=nv12' -c:v h264_vaapi output.mp4
396 @section libndi_newtek
398 The libndi_newtek input device provides capture capabilities for using NDI (Network
399 Device Interface, standard created by NewTek).
401 Input filename is a NDI source name that could be found by sending -find_sources 1
402 to command line - it has no specific syntax but human-readable formatted.
404 To enable this input device, you need the NDI SDK and you
405 need to configure with the appropriate @code{--extra-cflags}
406 and @code{--extra-ldflags}.
413 If set to @option{true}, print a list of found/available NDI sources and exit.
414 Defaults to @option{false}.
417 Override time to wait until the number of online sources have changed.
418 Defaults to @option{0.5}.
420 @item allow_video_fields
421 When this flag is @option{false}, all video that you receive will be progressive.
422 Defaults to @option{true}.
433 ffmpeg -f libndi_newtek -find_sources 1 -i dummy
439 ffmpeg -f libndi_newtek -i "DEV-5.INTERNAL.M1STEREO.TV (NDI_SOURCE_NAME_1)" -f libndi_newtek -y NDI_SOURCE_NAME_2
446 Windows DirectShow input device.
448 DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
449 Currently only audio and video devices are supported.
451 Multiple devices may be opened as separate inputs, but they may also be
452 opened on the same input, which should improve synchronism between them.
454 The input name should be in the format:
457 @var{TYPE}=@var{NAME}[:@var{TYPE}=@var{NAME}]
460 where @var{TYPE} can be either @var{audio} or @var{video},
461 and @var{NAME} is the device's name or alternative name..
465 If no options are specified, the device's defaults are used.
466 If the device does not support the requested options, it will
472 Set the video size in the captured video.
475 Set the frame rate in the captured video.
478 Set the sample rate (in Hz) of the captured audio.
481 Set the sample size (in bits) of the captured audio.
484 Set the number of channels in the captured audio.
487 If set to @option{true}, print a list of devices and exit.
490 If set to @option{true}, print a list of selected device's options
493 @item video_device_number
494 Set video device number for devices with the same name (starts at 0,
497 @item audio_device_number
498 Set audio device number for devices with the same name (starts at 0,
502 Select pixel format to be used by DirectShow. This may only be set when
503 the video codec is not set or set to rawvideo.
505 @item audio_buffer_size
506 Set audio device buffer size in milliseconds (which can directly
507 impact latency, depending on the device).
508 Defaults to using the audio device's
509 default buffer size (typically some multiple of 500ms).
510 Setting this value too low can degrade performance.
512 @url{http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx}
515 Select video capture pin to use by name or alternative name.
518 Select audio capture pin to use by name or alternative name.
520 @item crossbar_video_input_pin_number
521 Select video input pin number for crossbar device. This will be
522 routed to the crossbar device's Video Decoder output pin.
523 Note that changing this value can affect future invocations
524 (sets a new default) until system reboot occurs.
526 @item crossbar_audio_input_pin_number
527 Select audio input pin number for crossbar device. This will be
528 routed to the crossbar device's Audio Decoder output pin.
529 Note that changing this value can affect future invocations
530 (sets a new default) until system reboot occurs.
532 @item show_video_device_dialog
533 If set to @option{true}, before capture starts, popup a display dialog
534 to the end user, allowing them to change video filter properties
535 and configurations manually.
536 Note that for crossbar devices, adjusting values in this dialog
537 may be needed at times to toggle between PAL (25 fps) and NTSC (29.97)
538 input frame rates, sizes, interlacing, etc. Changing these values can
539 enable different scan rates/frame rates and avoiding green bars at
540 the bottom, flickering scan lines, etc.
541 Note that with some devices, changing these properties can also affect future
542 invocations (sets new defaults) until system reboot occurs.
544 @item show_audio_device_dialog
545 If set to @option{true}, before capture starts, popup a display dialog
546 to the end user, allowing them to change audio filter properties
547 and configurations manually.
549 @item show_video_crossbar_connection_dialog
550 If set to @option{true}, before capture starts, popup a display
551 dialog to the end user, allowing them to manually
552 modify crossbar pin routings, when it opens a video device.
554 @item show_audio_crossbar_connection_dialog
555 If set to @option{true}, before capture starts, popup a display
556 dialog to the end user, allowing them to manually
557 modify crossbar pin routings, when it opens an audio device.
559 @item show_analog_tv_tuner_dialog
560 If set to @option{true}, before capture starts, popup a display
561 dialog to the end user, allowing them to manually
562 modify TV channels and frequencies.
564 @item show_analog_tv_tuner_audio_dialog
565 If set to @option{true}, before capture starts, popup a display
566 dialog to the end user, allowing them to manually
567 modify TV audio (like mono vs. stereo, Language A,B or C).
569 @item audio_device_load
570 Load an audio capture filter device from file instead of searching
571 it by name. It may load additional parameters too, if the filter
572 supports the serialization of its properties to.
573 To use this an audio capture source has to be specified, but it can
574 be anything even fake one.
576 @item audio_device_save
577 Save the currently used audio capture filter device and its
578 parameters (if the filter supports it) to a file.
579 If a file with the same name exists it will be overwritten.
581 @item video_device_load
582 Load a video capture filter device from file instead of searching
583 it by name. It may load additional parameters too, if the filter
584 supports the serialization of its properties to.
585 To use this a video capture source has to be specified, but it can
586 be anything even fake one.
588 @item video_device_save
589 Save the currently used video capture filter device and its
590 parameters (if the filter supports it) to a file.
591 If a file with the same name exists it will be overwritten.
600 Print the list of DirectShow supported devices and exit:
602 $ ffmpeg -list_devices true -f dshow -i dummy
606 Open video device @var{Camera}:
608 $ ffmpeg -f dshow -i video="Camera"
612 Open second video device with name @var{Camera}:
614 $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
618 Open video device @var{Camera} and audio device @var{Microphone}:
620 $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
624 Print the list of supported options in selected device and exit:
626 $ ffmpeg -list_options true -f dshow -i video="Camera"
630 Specify pin names to capture by name or alternative name, specify alternative device name:
632 $ ffmpeg -f dshow -audio_pin_name "Audio Out" -video_pin_name 2 -i video=video="@@device_pnp_\\?\pci#ven_1a0a&dev_6200&subsys_62021461&rev_01#4&e2c7dd6&0&00e1#@{65e8773d-8f56-11d0-a3b9-00a0c9223196@}\@{ca465100-deb0-4d59-818f-8c477184adf6@}":audio="Microphone"
636 Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup:
638 $ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_number 0
639 -crossbar_audio_input_pin_number 3 -i video="AVerMedia BDA Analog Capture":audio="AVerMedia BDA Analog Capture"
646 Linux DV 1394 input device.
653 Set the frame rate. Default is 25.
657 Available values are:
665 Default value is @code{ntsc}.
671 Linux framebuffer input device.
673 The Linux framebuffer is a graphic hardware-independent abstraction
674 layer to show graphics on a computer monitor, typically on the
675 console. It is accessed through a file device node, usually
678 For more detailed information read the file
679 Documentation/fb/framebuffer.txt included in the Linux source tree.
681 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
683 To record from the framebuffer device @file{/dev/fb0} with
686 ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
689 You can take a single screenshot image with the command:
691 ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
699 Set the frame rate. Default is 25.
705 Win32 GDI-based screen capture device.
707 This device allows you to capture a region of the display on Windows.
709 There are two options for the input filename:
715 title=@var{window_title}
718 The first option will capture the entire desktop, or a fixed region of the
719 desktop. The second option will instead capture the contents of a single
720 window, regardless of its position on the screen.
722 For example, to grab the entire desktop using @command{ffmpeg}:
724 ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
727 Grab a 640x480 region at position @code{10,20}:
729 ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
732 Grab the contents of the window named "Calculator"
734 ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
741 Specify whether to draw the mouse pointer. Use the value @code{0} to
742 not draw the pointer. Default value is @code{1}.
745 Set the grabbing frame rate. Default value is @code{ntsc},
746 corresponding to a frame rate of @code{30000/1001}.
749 Show grabbed region on screen.
751 If @var{show_region} is specified with @code{1}, then the grabbing
752 region will be indicated on screen. With this option, it is easy to
753 know what is being grabbed if only a portion of the screen is grabbed.
755 Note that @var{show_region} is incompatible with grabbing the contents
760 ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
764 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.
767 When capturing a region with @var{video_size}, set the distance from the left edge of the screen or desktop.
769 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.
772 When capturing a region with @var{video_size}, set the distance from the top edge of the screen or desktop.
774 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.
780 FireWire DV/HDV input device using libiec61883.
782 To enable this input device, you need libiec61883, libraw1394 and
783 libavc1394 installed on your system. Use the configure option
784 @code{--enable-libiec61883} to compile with the device enabled.
786 The iec61883 capture device supports capturing from a video device
787 connected via IEEE1394 (FireWire), using libiec61883 and the new Linux
788 FireWire stack (juju). This is the default DV/HDV input method in Linux
789 Kernel 2.6.37 and later, since the old FireWire stack was removed.
791 Specify the FireWire port to be used as input file, or "auto"
792 to choose the first port connected.
799 Override autodetection of DV/HDV. This should only be used if auto
800 detection does not work, or if usage of a different device type
801 should be prohibited. Treating a DV device as HDV (or vice versa) will
802 not work and result in undefined behavior.
803 The values @option{auto}, @option{dv} and @option{hdv} are supported.
806 Set maximum size of buffer for incoming data, in frames. For DV, this
807 is an exact value. For HDV, it is not frame exact, since HDV does
808 not have a fixed frame size.
811 Select the capture device by specifying its GUID. Capturing will only
812 be performed from the specified device and fails if no device with the
813 given GUID is found. This is useful to select the input if multiple
814 devices are connected at the same time.
815 Look at /sys/bus/firewire/devices to find out the GUIDs.
824 Grab and show the input of a FireWire DV/HDV device.
826 ffplay -f iec61883 -i auto
830 Grab and record the input of a FireWire DV/HDV device,
831 using a packet buffer of 100000 packets if the source is HDV.
833 ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
842 To enable this input device during configuration you need libjack
843 installed on your system.
845 A JACK input device creates one or more JACK writable clients, one for
846 each audio channel, with name @var{client_name}:input_@var{N}, where
847 @var{client_name} is the name provided by the application, and @var{N}
848 is a number which identifies the channel.
849 Each writable client will send the acquired data to the FFmpeg input
852 Once you have created one or more JACK readable clients, you need to
853 connect them to one or more JACK writable clients.
855 To connect or disconnect JACK clients you can use the @command{jack_connect}
856 and @command{jack_disconnect} programs, or do it through a graphical interface,
857 for example with @command{qjackctl}.
859 To list the JACK clients and their properties you can invoke the command
862 Follows an example which shows how to capture a JACK readable client
863 with @command{ffmpeg}.
865 # Create a JACK writable client with name "ffmpeg".
866 $ ffmpeg -f jack -i ffmpeg -y out.wav
868 # Start the sample jack_metro readable client.
869 $ jack_metro -b 120 -d 0.2 -f 4000
871 # List the current JACK clients.
880 # Connect metro to the ffmpeg writable client.
881 $ jack_connect metro:120_bpm ffmpeg:input_1
884 For more information read:
885 @url{http://jackaudio.org/}
892 Set the number of channels. Default is 2.
898 Libavfilter input virtual device.
900 This input device reads data from the open output pads of a libavfilter
903 For each filtergraph open output, the input device will create a
904 corresponding stream which is mapped to the generated output. Currently
905 only video data is supported. The filtergraph is specified through the
906 option @option{graph}.
913 Specify the filtergraph to use as input. Each video open output must be
914 labelled by a unique string of the form "out@var{N}", where @var{N} is a
915 number starting from 0 corresponding to the mapped input stream
916 generated by the device.
917 The first unlabelled output is automatically assigned to the "out0"
918 label, but all the others need to be specified explicitly.
920 The suffix "+subcc" can be appended to the output label to create an extra
921 stream with the closed captions packets attached to that output
922 (experimental; only for EIA-608 / CEA-708 for now).
923 The subcc streams are created after all the normal streams, in the order of
924 the corresponding stream.
925 For example, if there is "out19+subcc", "out7+subcc" and up to "out42", the
926 stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19.
928 If not specified defaults to the filename specified for the input
932 Set the filename of the filtergraph to be read and sent to the other
933 filters. Syntax of the filtergraph is the same as the one specified by
934 the option @var{graph}.
937 Dump graph to stderr.
945 Create a color video stream and play it back with @command{ffplay}:
947 ffplay -f lavfi -graph "color=c=pink [out0]" dummy
951 As the previous example, but use filename for specifying the graph
952 description, and omit the "out0" label:
954 ffplay -f lavfi color=c=pink
958 Create three different video test filtered sources and play them:
960 ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
964 Read an audio stream from a file using the amovie source and play it
965 back with @command{ffplay}:
967 ffplay -f lavfi "amovie=test.wav"
971 Read an audio stream and a video stream and play it back with
974 ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
978 Dump decoded frames to images and closed captions to a file (experimental):
980 ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
987 Audio-CD input device based on libcdio.
989 To enable this input device during configuration you need libcdio
990 installed on your system. It requires the configure option
991 @code{--enable-libcdio}.
993 This device allows playing and grabbing from an Audio-CD.
995 For example to copy with @command{ffmpeg} the entire Audio-CD in @file{/dev/sr0},
996 you may run the command:
998 ffmpeg -f libcdio -i /dev/sr0 cd.wav
1004 Set drive reading speed. Default value is 0.
1006 The speed is specified CD-ROM speed units. The speed is set through
1007 the libcdio @code{cdio_cddap_speed_set} function. On many CD-ROM
1008 drives, specifying a value too large will result in using the fastest
1012 Set paranoia recovery mode flags. It accepts one of the following values:
1022 Default value is @samp{disable}.
1024 For more information about the available recovery modes, consult the
1025 paranoia project documentation.
1030 IIDC1394 input device, based on libdc1394 and libraw1394.
1032 Requires the configure option @code{--enable-libdc1394}.
1036 The OpenAL input device provides audio capture on all systems with a
1037 working OpenAL 1.1 implementation.
1039 To enable this input device during configuration, you need OpenAL
1040 headers and libraries installed on your system, and need to configure
1041 FFmpeg with @code{--enable-openal}.
1043 OpenAL headers and libraries should be provided as part of your OpenAL
1044 implementation, or as an additional download (an SDK). Depending on your
1045 installation you may need to specify additional flags via the
1046 @code{--extra-cflags} and @code{--extra-ldflags} for allowing the build
1047 system to locate the OpenAL headers and libraries.
1049 An incomplete list of OpenAL implementations follows:
1053 The official Windows implementation, providing hardware acceleration
1054 with supported devices and software fallback.
1055 See @url{http://openal.org/}.
1057 Portable, open source (LGPL) software implementation. Includes
1058 backends for the most common sound APIs on the Windows, Linux,
1059 Solaris, and BSD operating systems.
1060 See @url{http://kcat.strangesoft.net/openal.html}.
1062 OpenAL is part of Core Audio, the official Mac OS X Audio interface.
1063 See @url{http://developer.apple.com/technologies/mac/audio-and-video.html}
1066 This device allows one to capture from an audio input device handled
1069 You need to specify the name of the device to capture in the provided
1070 filename. If the empty string is provided, the device will
1071 automatically select the default device. You can get the list of the
1072 supported devices by using the option @var{list_devices}.
1079 Set the number of channels in the captured audio. Only the values
1080 @option{1} (monaural) and @option{2} (stereo) are currently supported.
1081 Defaults to @option{2}.
1084 Set the sample size (in bits) of the captured audio. Only the values
1085 @option{8} and @option{16} are currently supported. Defaults to
1089 Set the sample rate (in Hz) of the captured audio.
1090 Defaults to @option{44.1k}.
1093 If set to @option{true}, print a list of devices and exit.
1094 Defaults to @option{false}.
1098 @subsection Examples
1100 Print the list of OpenAL supported devices and exit:
1102 $ ffmpeg -list_devices true -f openal -i dummy out.ogg
1105 Capture from the OpenAL device @file{DR-BT101 via PulseAudio}:
1107 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
1110 Capture from the default device (note the empty string '' as filename):
1112 $ ffmpeg -f openal -i '' out.ogg
1115 Capture from two devices simultaneously, writing to two different files,
1116 within the same @command{ffmpeg} command:
1118 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
1120 Note: not all OpenAL implementations support multiple simultaneous capture -
1121 try the latest OpenAL Soft if the above does not work.
1125 Open Sound System input device.
1127 The filename to provide to the input device is the device node
1128 representing the OSS input device, and is usually set to
1131 For example to grab from @file{/dev/dsp} using @command{ffmpeg} use the
1134 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
1137 For more information about OSS see:
1138 @url{http://manuals.opensound.com/usersguide/dsp.html}
1145 Set the sample rate in Hz. Default is 48000.
1148 Set the number of channels. Default is 2.
1155 PulseAudio input device.
1157 To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
1159 The filename to provide to the input device is a source device or the
1162 To list the PulseAudio source devices and their properties you can invoke
1163 the command @command{pactl list sources}.
1165 More information about PulseAudio can be found on @url{http://www.pulseaudio.org}.
1170 Connect to a specific PulseAudio server, specified by an IP address.
1171 Default server is used when not provided.
1174 Specify the application name PulseAudio will use when showing active clients,
1175 by default it is the @code{LIBAVFORMAT_IDENT} string.
1178 Specify the stream name PulseAudio will use when showing active streams,
1179 by default it is "record".
1182 Specify the samplerate in Hz, by default 48kHz is used.
1185 Specify the channels in use, by default 2 (stereo) is set.
1188 Specify the number of bytes per frame, by default it is set to 1024.
1191 Specify the minimal buffering fragment in PulseAudio, it will affect the
1192 audio latency. By default it is unset.
1195 Set the initial PTS using the current time. Default is 1.
1199 @subsection Examples
1200 Record a stream from default device:
1202 ffmpeg -f pulse -i default /tmp/pulse.wav
1209 To enable this input device during configuration you need libsndio
1210 installed on your system.
1212 The filename to provide to the input device is the device node
1213 representing the sndio input device, and is usually set to
1216 For example to grab from @file{/dev/audio0} using @command{ffmpeg} use the
1219 ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
1227 Set the sample rate in Hz. Default is 48000.
1230 Set the number of channels. Default is 2.
1234 @section video4linux2, v4l2
1236 Video4Linux2 input video device.
1238 "v4l2" can be used as alias for "video4linux2".
1240 If FFmpeg is built with v4l-utils support (by using the
1241 @code{--enable-libv4l2} configure option), it is possible to use it with the
1242 @code{-use_libv4l2} input device option.
1244 The name of the device to grab is a file device node, usually Linux
1245 systems tend to automatically create such nodes when the device
1246 (e.g. an USB webcam) is plugged into the system, and has a name of the
1247 kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
1250 Video4Linux2 devices usually support a limited set of
1251 @var{width}x@var{height} sizes and frame rates. You can check which are
1252 supported using @command{-list_formats all} for Video4Linux2 devices.
1253 Some devices, like TV cards, support one or more standards. It is possible
1254 to list all the supported standards using @command{-list_standards all}.
1256 The time base for the timestamps is 1 microsecond. Depending on the kernel
1257 version and configuration, the timestamps may be derived from the real time
1258 clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
1259 boot time, unaffected by NTP or manual changes to the clock). The
1260 @option{-timestamps abs} or @option{-ts abs} option can be used to force
1261 conversion into the real time clock.
1263 Some usage examples of the video4linux2 device with @command{ffmpeg}
1264 and @command{ffplay}:
1267 List supported formats for a video4linux2 device:
1269 ffplay -f video4linux2 -list_formats all /dev/video0
1273 Grab and show the input of a video4linux2 device:
1275 ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
1279 Grab and record the input of a video4linux2 device, leave the
1280 frame rate and size as previously set:
1282 ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
1286 For more information about Video4Linux, check @url{http://linuxtv.org/}.
1292 Set the standard. Must be the name of a supported standard. To get a
1293 list of the supported standards, use the @option{list_standards}
1297 Set the input channel number. Default to -1, which means using the
1298 previously selected channel.
1301 Set the video frame size. The argument must be a string in the form
1302 @var{WIDTH}x@var{HEIGHT} or a valid size abbreviation.
1305 Select the pixel format (only valid for raw video input).
1308 Set the preferred pixel format (for raw video) or a codec name.
1309 This option allows one to select the input format, when several are
1313 Set the preferred video frame rate.
1316 List available formats (supported pixel formats, codecs, and frame
1319 Available values are:
1322 Show all available (compressed and non-compressed) formats.
1325 Show only raw video (non-compressed) formats.
1328 Show only compressed formats.
1331 @item list_standards
1332 List supported standards and exit.
1334 Available values are:
1337 Show all supported standards.
1340 @item timestamps, ts
1341 Set type of timestamps for grabbed frames.
1343 Available values are:
1346 Use timestamps from the kernel.
1349 Use absolute timestamps (wall clock).
1352 Force conversion from monotonic to absolute timestamps.
1355 Default value is @code{default}.
1358 Use libv4l2 (v4l-utils) conversion functions. Default is 0.
1364 VfW (Video for Windows) capture input device.
1366 The filename passed as input is the capture driver number, ranging from
1367 0 to 9. You may use "list" as filename to print a list of drivers. Any
1368 other filename will be interpreted as device number 0.
1375 Set the video frame size.
1378 Set the grabbing frame rate. Default value is @code{ntsc},
1379 corresponding to a frame rate of @code{30000/1001}.
1385 X11 video input device.
1387 To enable this input device during configuration you need libxcb
1388 installed on your system. It will be automatically detected during
1391 This device allows one to capture a region of an X11 display.
1393 The filename passed as input has the syntax:
1395 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
1398 @var{hostname}:@var{display_number}.@var{screen_number} specifies the
1399 X11 display name of the screen to grab from. @var{hostname} can be
1400 omitted, and defaults to "localhost". The environment variable
1401 @env{DISPLAY} contains the default display name.
1403 @var{x_offset} and @var{y_offset} specify the offsets of the grabbed
1404 area with respect to the top-left border of the X11 screen. They
1407 Check the X11 documentation (e.g. @command{man X}) for more detailed
1410 Use the @command{xdpyinfo} program for getting basic information about
1411 the properties of your X11 display (e.g. grep for "name" or
1414 For example to grab from @file{:0.0} using @command{ffmpeg}:
1416 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
1419 Grab at position @code{10,20}:
1421 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1428 Specify whether to draw the mouse pointer. A value of @code{0} specifies
1429 not to draw the pointer. Default value is @code{1}.
1432 Make the grabbed area follow the mouse. The argument can be
1433 @code{centered} or a number of pixels @var{PIXELS}.
1435 When it is specified with "centered", the grabbing region follows the mouse
1436 pointer and keeps the pointer at the center of region; otherwise, the region
1437 follows only when the mouse pointer reaches within @var{PIXELS} (greater than
1438 zero) to the edge of region.
1442 ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
1445 To follow only when the mouse pointer reaches within 100 pixels to edge:
1447 ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
1451 Set the grabbing frame rate. Default value is @code{ntsc},
1452 corresponding to a frame rate of @code{30000/1001}.
1455 Show grabbed region on screen.
1457 If @var{show_region} is specified with @code{1}, then the grabbing
1458 region will be indicated on screen. With this option, it is easy to
1459 know what is being grabbed if only a portion of the screen is grabbed.
1462 Set the region border thickness if @option{-show_region 1} is used.
1463 Range is 1 to 128 and default is 3 (XCB-based x11grab only).
1467 ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1470 With @var{follow_mouse}:
1472 ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
1476 Set the video frame size. Default value is @code{vga}.
1480 Set the grabbing region coordinates. They are expressed as offset from
1481 the top left corner of the X11 window and correspond to the
1482 @var{x_offset} and @var{y_offset} parameters in the device name. The
1483 default value for both options is 0.
1486 @c man end INPUT DEVICES