2 @c man begin INPUT DEVICES
4 Input devices are configured elements in FFmpeg which allow to access
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}
56 AVFoundation input device.
58 AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >= 10.7 as well as on iOS.
59 The older QTKit framework has been marked deprecated since OSX version 10.7.
61 The filename passed as input is parsed to contain either a device name or index.
62 The device index can also be given by using -video_device_index.
63 A given device index will override any given device name.
64 If the desired device consists of numbers only, use -video_device_index to identify it.
65 The default device will be chosen if an empty string or the device name "default" is given.
66 The available devices can be enumerated by using -list_devices.
67 The pixel format can be set using -pixel_format.
69 monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0,
70 bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10,
71 yuv420p, nv12, yuyv422, gray
74 ffmpeg -f avfoundation -i "0" out.mpg
78 ffmpeg -f avfoundation -video_device_index 0 -i "" out.mpg
82 ffmpeg -f avfoundation -pixel_format bgr0 -i "default" out.mpg
86 ffmpeg -f avfoundation -list_devices true -i ""
91 BSD video input device.
95 Windows DirectShow input device.
97 DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
98 Currently only audio and video devices are supported.
100 Multiple devices may be opened as separate inputs, but they may also be
101 opened on the same input, which should improve synchronism between them.
103 The input name should be in the format:
106 @var{TYPE}=@var{NAME}[:@var{TYPE}=@var{NAME}]
109 where @var{TYPE} can be either @var{audio} or @var{video},
110 and @var{NAME} is the device's name.
114 If no options are specified, the device's defaults are used.
115 If the device does not support the requested options, it will
121 Set the video size in the captured video.
124 Set the frame rate in the captured video.
127 Set the sample rate (in Hz) of the captured audio.
130 Set the sample size (in bits) of the captured audio.
133 Set the number of channels in the captured audio.
136 If set to @option{true}, print a list of devices and exit.
139 If set to @option{true}, print a list of selected device's options
142 @item video_device_number
143 Set video device number for devices with same name (starts at 0,
146 @item audio_device_number
147 Set audio device number for devices with same name (starts at 0,
151 Select pixel format to be used by DirectShow. This may only be set when
152 the video codec is not set or set to rawvideo.
154 @item audio_buffer_size
155 Set audio device buffer size in milliseconds (which can directly
156 impact latency, depending on the device).
157 Defaults to using the audio device's
158 default buffer size (typically some multiple of 500ms).
159 Setting this value too low can degrade performance.
161 @url{http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx}
170 Print the list of DirectShow supported devices and exit:
172 $ ffmpeg -list_devices true -f dshow -i dummy
176 Open video device @var{Camera}:
178 $ ffmpeg -f dshow -i video="Camera"
182 Open second video device with name @var{Camera}:
184 $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
188 Open video device @var{Camera} and audio device @var{Microphone}:
190 $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
194 Print the list of supported options in selected device and exit:
196 $ ffmpeg -list_options true -f dshow -i video="Camera"
203 Linux DV 1394 input device.
207 Linux framebuffer input device.
209 The Linux framebuffer is a graphic hardware-independent abstraction
210 layer to show graphics on a computer monitor, typically on the
211 console. It is accessed through a file device node, usually
214 For more detailed information read the file
215 Documentation/fb/framebuffer.txt included in the Linux source tree.
217 To record from the framebuffer device @file{/dev/fb0} with
220 ffmpeg -f fbdev -r 10 -i /dev/fb0 out.avi
223 You can take a single screenshot image with the command:
225 ffmpeg -f fbdev -frames:v 1 -r 1 -i /dev/fb0 screenshot.jpeg
228 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
232 Win32 GDI-based screen capture device.
234 This device allows you to capture a region of the display on Windows.
236 There are two options for the input filename:
242 title=@var{window_title}
245 The first option will capture the entire desktop, or a fixed region of the
246 desktop. The second option will instead capture the contents of a single
247 window, regardless of its position on the screen.
249 For example, to grab the entire desktop using @command{ffmpeg}:
251 ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
254 Grab a 640x480 region at position @code{10,20}:
256 ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
259 Grab the contents of the window named "Calculator"
261 ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
268 Specify whether to draw the mouse pointer. Use the value @code{0} to
269 not draw the pointer. Default value is @code{1}.
272 Set the grabbing frame rate. Default value is @code{ntsc},
273 corresponding to a frame rate of @code{30000/1001}.
276 Show grabbed region on screen.
278 If @var{show_region} is specified with @code{1}, then the grabbing
279 region will be indicated on screen. With this option, it is easy to
280 know what is being grabbed if only a portion of the screen is grabbed.
282 Note that @var{show_region} is incompatible with grabbing the contents
287 ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
291 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.
294 When capturing a region with @var{video_size}, set the distance from the left edge of the screen or desktop.
296 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.
299 When capturing a region with @var{video_size}, set the distance from the top edge of the screen or desktop.
301 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.
307 FireWire DV/HDV input device using libiec61883.
309 To enable this input device, you need libiec61883, libraw1394 and
310 libavc1394 installed on your system. Use the configure option
311 @code{--enable-libiec61883} to compile with the device enabled.
313 The iec61883 capture device supports capturing from a video device
314 connected via IEEE1394 (FireWire), using libiec61883 and the new Linux
315 FireWire stack (juju). This is the default DV/HDV input method in Linux
316 Kernel 2.6.37 and later, since the old FireWire stack was removed.
318 Specify the FireWire port to be used as input file, or "auto"
319 to choose the first port connected.
326 Override autodetection of DV/HDV. This should only be used if auto
327 detection does not work, or if usage of a different device type
328 should be prohibited. Treating a DV device as HDV (or vice versa) will
329 not work and result in undefined behavior.
330 The values @option{auto}, @option{dv} and @option{hdv} are supported.
333 Set maxiumum size of buffer for incoming data, in frames. For DV, this
334 is an exact value. For HDV, it is not frame exact, since HDV does
335 not have a fixed frame size.
338 Select the capture device by specifying it's GUID. Capturing will only
339 be performed from the specified device and fails if no device with the
340 given GUID is found. This is useful to select the input if multiple
341 devices are connected at the same time.
342 Look at /sys/bus/firewire/devices to find out the GUIDs.
351 Grab and show the input of a FireWire DV/HDV device.
353 ffplay -f iec61883 -i auto
357 Grab and record the input of a FireWire DV/HDV device,
358 using a packet buffer of 100000 packets if the source is HDV.
360 ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
369 To enable this input device during configuration you need libjack
370 installed on your system.
372 A JACK input device creates one or more JACK writable clients, one for
373 each audio channel, with name @var{client_name}:input_@var{N}, where
374 @var{client_name} is the name provided by the application, and @var{N}
375 is a number which identifies the channel.
376 Each writable client will send the acquired data to the FFmpeg input
379 Once you have created one or more JACK readable clients, you need to
380 connect them to one or more JACK writable clients.
382 To connect or disconnect JACK clients you can use the @command{jack_connect}
383 and @command{jack_disconnect} programs, or do it through a graphical interface,
384 for example with @command{qjackctl}.
386 To list the JACK clients and their properties you can invoke the command
389 Follows an example which shows how to capture a JACK readable client
390 with @command{ffmpeg}.
392 # Create a JACK writable client with name "ffmpeg".
393 $ ffmpeg -f jack -i ffmpeg -y out.wav
395 # Start the sample jack_metro readable client.
396 $ jack_metro -b 120 -d 0.2 -f 4000
398 # List the current JACK clients.
407 # Connect metro to the ffmpeg writable client.
408 $ jack_connect metro:120_bpm ffmpeg:input_1
411 For more information read:
412 @url{http://jackaudio.org/}
416 Libavfilter input virtual device.
418 This input device reads data from the open output pads of a libavfilter
421 For each filtergraph open output, the input device will create a
422 corresponding stream which is mapped to the generated output. Currently
423 only video data is supported. The filtergraph is specified through the
424 option @option{graph}.
431 Specify the filtergraph to use as input. Each video open output must be
432 labelled by a unique string of the form "out@var{N}", where @var{N} is a
433 number starting from 0 corresponding to the mapped input stream
434 generated by the device.
435 The first unlabelled output is automatically assigned to the "out0"
436 label, but all the others need to be specified explicitly.
438 If not specified defaults to the filename specified for the input
442 Set the filename of the filtergraph to be read and sent to the other
443 filters. Syntax of the filtergraph is the same as the one specified by
444 the option @var{graph}.
452 Create a color video stream and play it back with @command{ffplay}:
454 ffplay -f lavfi -graph "color=c=pink [out0]" dummy
458 As the previous example, but use filename for specifying the graph
459 description, and omit the "out0" label:
461 ffplay -f lavfi color=c=pink
465 Create three different video test filtered sources and play them:
467 ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
471 Read an audio stream from a file using the amovie source and play it
472 back with @command{ffplay}:
474 ffplay -f lavfi "amovie=test.wav"
478 Read an audio stream and a video stream and play it back with
481 ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
488 IIDC1394 input device, based on libdc1394 and libraw1394.
492 The OpenAL input device provides audio capture on all systems with a
493 working OpenAL 1.1 implementation.
495 To enable this input device during configuration, you need OpenAL
496 headers and libraries installed on your system, and need to configure
497 FFmpeg with @code{--enable-openal}.
499 OpenAL headers and libraries should be provided as part of your OpenAL
500 implementation, or as an additional download (an SDK). Depending on your
501 installation you may need to specify additional flags via the
502 @code{--extra-cflags} and @code{--extra-ldflags} for allowing the build
503 system to locate the OpenAL headers and libraries.
505 An incomplete list of OpenAL implementations follows:
509 The official Windows implementation, providing hardware acceleration
510 with supported devices and software fallback.
511 See @url{http://openal.org/}.
513 Portable, open source (LGPL) software implementation. Includes
514 backends for the most common sound APIs on the Windows, Linux,
515 Solaris, and BSD operating systems.
516 See @url{http://kcat.strangesoft.net/openal.html}.
518 OpenAL is part of Core Audio, the official Mac OS X Audio interface.
519 See @url{http://developer.apple.com/technologies/mac/audio-and-video.html}
522 This device allows one to capture from an audio input device handled
525 You need to specify the name of the device to capture in the provided
526 filename. If the empty string is provided, the device will
527 automatically select the default device. You can get the list of the
528 supported devices by using the option @var{list_devices}.
535 Set the number of channels in the captured audio. Only the values
536 @option{1} (monaural) and @option{2} (stereo) are currently supported.
537 Defaults to @option{2}.
540 Set the sample size (in bits) of the captured audio. Only the values
541 @option{8} and @option{16} are currently supported. Defaults to
545 Set the sample rate (in Hz) of the captured audio.
546 Defaults to @option{44.1k}.
549 If set to @option{true}, print a list of devices and exit.
550 Defaults to @option{false}.
556 Print the list of OpenAL supported devices and exit:
558 $ ffmpeg -list_devices true -f openal -i dummy out.ogg
561 Capture from the OpenAL device @file{DR-BT101 via PulseAudio}:
563 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
566 Capture from the default device (note the empty string '' as filename):
568 $ ffmpeg -f openal -i '' out.ogg
571 Capture from two devices simultaneously, writing to two different files,
572 within the same @command{ffmpeg} command:
574 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
576 Note: not all OpenAL implementations support multiple simultaneous capture -
577 try the latest OpenAL Soft if the above does not work.
581 Open Sound System input device.
583 The filename to provide to the input device is the device node
584 representing the OSS input device, and is usually set to
587 For example to grab from @file{/dev/dsp} using @command{ffmpeg} use the
590 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
593 For more information about OSS see:
594 @url{http://manuals.opensound.com/usersguide/dsp.html}
598 PulseAudio input device.
600 To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
602 The filename to provide to the input device is a source device or the
605 To list the PulseAudio source devices and their properties you can invoke
606 the command @command{pactl list sources}.
608 More information about PulseAudio can be found on @url{http://www.pulseaudio.org}.
613 Connect to a specific PulseAudio server, specified by an IP address.
614 Default server is used when not provided.
617 Specify the application name PulseAudio will use when showing active clients,
618 by default it is the @code{LIBAVFORMAT_IDENT} string.
621 Specify the stream name PulseAudio will use when showing active streams,
622 by default it is "record".
625 Specify the samplerate in Hz, by default 48kHz is used.
628 Specify the channels in use, by default 2 (stereo) is set.
631 Specify the number of bytes per frame, by default it is set to 1024.
634 Specify the minimal buffering fragment in PulseAudio, it will affect the
635 audio latency. By default it is unset.
639 Record a stream from default device:
641 ffmpeg -f pulse -i default /tmp/pulse.wav
648 The filename passed as input is parsed to contain either a device name or index.
649 The device index can also be given by using -video_device_index.
650 A given device index will override any given device name.
651 If the desired device consists of numbers only, use -video_device_index to identify it.
652 The default device will be chosen if an empty string or the device name "default" is given.
653 The available devices can be enumerated by using -list_devices.
656 ffmpeg -f qtkit -i "0" out.mpg
660 ffmpeg -f qtkit -video_device_index 0 -i "" out.mpg
664 ffmpeg -f qtkit -i "default" out.mpg
668 ffmpeg -f qtkit -list_devices true -i ""
675 To enable this input device during configuration you need libsndio
676 installed on your system.
678 The filename to provide to the input device is the device node
679 representing the sndio input device, and is usually set to
682 For example to grab from @file{/dev/audio0} using @command{ffmpeg} use the
685 ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
688 @section video4linux2, v4l2
690 Video4Linux2 input video device.
692 "v4l2" can be used as alias for "video4linux2".
694 If FFmpeg is built with v4l-utils support (by using the
695 @code{--enable-libv4l2} configure option), it is possible to use it with the
696 @code{-use_libv4l2} input device option.
698 The name of the device to grab is a file device node, usually Linux
699 systems tend to automatically create such nodes when the device
700 (e.g. an USB webcam) is plugged into the system, and has a name of the
701 kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
704 Video4Linux2 devices usually support a limited set of
705 @var{width}x@var{height} sizes and frame rates. You can check which are
706 supported using @command{-list_formats all} for Video4Linux2 devices.
707 Some devices, like TV cards, support one or more standards. It is possible
708 to list all the supported standards using @command{-list_standards all}.
710 The time base for the timestamps is 1 microsecond. Depending on the kernel
711 version and configuration, the timestamps may be derived from the real time
712 clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
713 boot time, unaffected by NTP or manual changes to the clock). The
714 @option{-timestamps abs} or @option{-ts abs} option can be used to force
715 conversion into the real time clock.
717 Some usage examples of the video4linux2 device with @command{ffmpeg}
718 and @command{ffplay}:
721 Grab and show the input of a video4linux2 device:
723 ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
727 Grab and record the input of a video4linux2 device, leave the
728 frame rate and size as previously set:
730 ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
734 For more information about Video4Linux, check @url{http://linuxtv.org/}.
740 Set the standard. Must be the name of a supported standard. To get a
741 list of the supported standards, use the @option{list_standards}
745 Set the input channel number. Default to -1, which means using the
746 previously selected channel.
749 Set the video frame size. The argument must be a string in the form
750 @var{WIDTH}x@var{HEIGHT} or a valid size abbreviation.
753 Select the pixel format (only valid for raw video input).
756 Set the preferred pixel format (for raw video) or a codec name.
757 This option allows one to select the input format, when several are
761 Set the preferred video frame rate.
764 List available formats (supported pixel formats, codecs, and frame
767 Available values are:
770 Show all available (compressed and non-compressed) formats.
773 Show only raw video (non-compressed) formats.
776 Show only compressed formats.
780 List supported standards and exit.
782 Available values are:
785 Show all supported standards.
789 Set type of timestamps for grabbed frames.
791 Available values are:
794 Use timestamps from the kernel.
797 Use absolute timestamps (wall clock).
800 Force conversion from monotonic to absolute timestamps.
803 Default value is @code{default}.
808 VfW (Video for Windows) capture input device.
810 The filename passed as input is the capture driver number, ranging from
811 0 to 9. You may use "list" as filename to print a list of drivers. Any
812 other filename will be interpreted as device number 0.
816 X11 video input device.
818 This device allows one to capture a region of an X11 display.
820 The filename passed as input has the syntax:
822 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
825 @var{hostname}:@var{display_number}.@var{screen_number} specifies the
826 X11 display name of the screen to grab from. @var{hostname} can be
827 omitted, and defaults to "localhost". The environment variable
828 @env{DISPLAY} contains the default display name.
830 @var{x_offset} and @var{y_offset} specify the offsets of the grabbed
831 area with respect to the top-left border of the X11 screen. They
834 Check the X11 documentation (e.g. man X) for more detailed information.
836 Use the @command{dpyinfo} program for getting basic information about the
837 properties of your X11 display (e.g. grep for "name" or "dimensions").
839 For example to grab from @file{:0.0} using @command{ffmpeg}:
841 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
844 Grab at position @code{10,20}:
846 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
853 Specify whether to draw the mouse pointer. A value of @code{0} specify
854 not to draw the pointer. Default value is @code{1}.
857 Make the grabbed area follow the mouse. The argument can be
858 @code{centered} or a number of pixels @var{PIXELS}.
860 When it is specified with "centered", the grabbing region follows the mouse
861 pointer and keeps the pointer at the center of region; otherwise, the region
862 follows only when the mouse pointer reaches within @var{PIXELS} (greater than
863 zero) to the edge of region.
867 ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
870 To follow only when the mouse pointer reaches within 100 pixels to edge:
872 ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
876 Set the grabbing frame rate. Default value is @code{ntsc},
877 corresponding to a frame rate of @code{30000/1001}.
880 Show grabbed region on screen.
882 If @var{show_region} is specified with @code{1}, then the grabbing
883 region will be indicated on screen. With this option, it is easy to
884 know what is being grabbed if only a portion of the screen is grabbed.
888 ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
891 With @var{follow_mouse}:
893 ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
897 Set the video frame size. Default value is @code{vga}.
900 @c man end INPUT DEVICES