{ "content": [ { "type": "text", "text": "# ffmpeg-devices (man)\n\n## NAME\n\nffmpeg-devices - FFmpeg devices\n\n## DESCRIPTION\n\nThis document describes the input and output devices provided by the libavdevice library.\n\n## Sections\n\n- **NAME**\n- **DESCRIPTION**\n- **DEVICE OPTIONS**\n- **INPUT DEVICES** (149 subsections)\n- **OUTPUT DEVICES** (57 subsections)\n- **SEE ALSO**\n- **AUTHORS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "ffmpeg-devices", "section": "", "mode": "man", "summary": "ffmpeg-devices - FFmpeg devices", "synopsis": null, "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [ { "name": "ffmpeg", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/ffmpeg/1/json" }, { "name": "ffplay", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/ffplay/1/json" }, { "name": "ffprobe", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/ffprobe/1/json" }, { "name": "libavdevice", "section": "3", "url": "https://www.chedong.com/phpMan.php/man/libavdevice/3/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 2, "subsections": [] }, { "name": "DEVICE OPTIONS", "lines": 11, "subsections": [] }, { "name": "INPUT DEVICES", "lines": 14, "subsections": [ { "name": "alsa", "lines": 28 }, { "name": "sample_rate", "lines": 2 }, { "name": "channels", "lines": 2 }, { "name": "android_camera", "lines": 15 }, { "name": "video_size", "lines": 4 }, { "name": "framerate", "lines": 3 }, { "name": "camera_index", "lines": 2 }, { "name": "input_queue_size", "lines": 2 }, { "name": "avfoundation", "lines": 37 }, { "name": "-list_devices ", "lines": 3 }, { "name": "-video_device_index ", "lines": 2 }, { "name": "-audio_device_index ", "lines": 2 }, { "name": "-pixel_format ", "lines": 7 }, { "name": "-framerate", "lines": 3 }, { "name": "-video_size", "lines": 2 }, { "name": "-capture_cursor", "lines": 2 }, { "name": "-capture_mouse_clicks", "lines": 2 }, { "name": "-capture_raw_data", "lines": 29 }, { "name": "bktr", "lines": 4 }, { "name": "framerate", "lines": 2 }, { "name": "video_size", "lines": 2 }, { "name": "standard", "lines": 9 }, { "name": "decklink", "lines": 8 }, { "name": "-list_formats 1", "lines": 4 }, { "name": "list_devices", "lines": 4 }, { "name": "list_formats", "lines": 2 }, { "name": "format_code ", "lines": 5 }, { "name": "raw_format", "lines": 21 }, { "name": "teletext_lines", "lines": 13 }, { "name": "channels", "lines": 2 }, { "name": "duplex_mode", "lines": 14 }, { "name": "timecode_format", "lines": 9 }, { "name": "video_input", "lines": 3 }, { "name": "audio_input", "lines": 3 }, { "name": "video_pts", "lines": 3 }, { "name": "audio_pts", "lines": 3 }, { "name": "draw_bars", "lines": 2 }, { "name": "queue_size", "lines": 3 }, { "name": "audio_depth", "lines": 2 }, { "name": "decklink_copyts", "lines": 3 }, { "name": "timestamp_align", "lines": 43 }, { "name": "dshow", "lines": 19 }, { "name": "video_size", "lines": 2 }, { "name": "framerate", "lines": 2 }, { "name": "sample_rate", "lines": 2 }, { "name": "sample_size", "lines": 2 }, { "name": "channels", "lines": 2 }, { "name": "list_devices", "lines": 2 }, { "name": "list_options", "lines": 2 }, { "name": "video_device_number", "lines": 2 }, { "name": "audio_device_number", "lines": 2 }, { "name": "pixel_format", "lines": 3 }, { "name": "audio_buffer_size", "lines": 5 }, { "name": "video_pin_name", "lines": 2 }, { "name": "audio_pin_name", "lines": 2 }, { "name": "crossbar_video_input_pin_number", "lines": 4 }, { "name": "crossbar_audio_input_pin_number", "lines": 4 }, { "name": "show_video_device_dialog", "lines": 9 }, { "name": "show_audio_device_dialog", "lines": 3 }, { "name": "show_video_crossbar_connection_dialog", "lines": 3 }, { "name": "show_audio_crossbar_connection_dialog", "lines": 3 }, { "name": "show_analog_tv_tuner_dialog", "lines": 3 }, { "name": "show_analog_tv_tuner_audio_dialog", "lines": 3 }, { "name": "audio_device_load", "lines": 5 }, { "name": "audio_device_save", "lines": 3 }, { "name": "video_device_load", "lines": 5 }, { "name": "video_device_save", "lines": 3 }, { "name": "use_video_device_timestamps", "lines": 37 }, { "name": "fbdev", "lines": 21 }, { "name": "framerate", "lines": 2 }, { "name": "gdigrab", "lines": 30 }, { "name": "draw_mouse", "lines": 3 }, { "name": "framerate", "lines": 3 }, { "name": "show_region", "lines": 12 }, { "name": "video_size", "lines": 3 }, { "name": "offset_x", "lines": 7 }, { "name": "offset_y", "lines": 7 }, { "name": "iec61883", "lines": 16 }, { "name": "dvtype", "lines": 5 }, { "name": "dvbuffer", "lines": 3 }, { "name": "dvguid", "lines": 16 }, { "name": "jack", "lines": 41 }, { "name": "channels", "lines": 2 }, { "name": "kmsgrab", "lines": 12 }, { "name": "device", "lines": 2 }, { "name": "format", "lines": 4 }, { "name": "format_modifier", "lines": 5 }, { "name": "crtc_id", "lines": 3 }, { "name": "plane_id", "lines": 3 }, { "name": "framerate", "lines": 24 }, { "name": "lavfi", "lines": 9 }, { "name": "graph", "lines": 15 }, { "name": "graph_file", "lines": 3 }, { "name": "dumpgraph", "lines": 29 }, { "name": "libcdio", "lines": 13 }, { "name": "speed", "lines": 6 }, { "name": "paranoia_mode", "lines": 13 }, { "name": "libdc1394", "lines": 6 }, { "name": "framerate", "lines": 2 }, { "name": "pixel_format", "lines": 2 }, { "name": "video_size", "lines": 2 }, { "name": "openal", "lines": 13 }, { "name": "Creative", "lines": 3 }, { "name": "OpenAL Soft", "lines": 4 }, { "name": "Apple", "lines": 11 }, { "name": "channels", "lines": 3 }, { "name": "sample_size", "lines": 3 }, { "name": "sample_rate", "lines": 2 }, { "name": "list_devices", "lines": 24 }, { "name": "oss", "lines": 13 }, { "name": "sample_rate", "lines": 2 }, { "name": "channels", "lines": 2 }, { "name": "pulse", "lines": 13 }, { "name": "server", "lines": 3 }, { "name": "name", "lines": 3 }, { "name": "stream_name", "lines": 3 }, { "name": "sample_rate", "lines": 2 }, { "name": "channels", "lines": 2 }, { "name": "frame_size", "lines": 2 }, { "name": "fragment_size", "lines": 3 }, { "name": "wallclock", "lines": 8 }, { "name": "sndio", "lines": 13 }, { "name": "sample_rate", "lines": 2 }, { "name": "channels", "lines": 2 }, { "name": "video4linux2, v4l2", "lines": 41 }, { "name": "standard", "lines": 3 }, { "name": "channel", "lines": 3 }, { "name": "video_size", "lines": 3 }, { "name": "pixel_format", "lines": 2 }, { "name": "input_format", "lines": 3 }, { "name": "framerate", "lines": 2 }, { "name": "list_formats", "lines": 11 }, { "name": "list_standards", "lines": 6 }, { "name": "timestamps, ts", "lines": 14 }, { "name": "use_libv4l2", "lines": 2 }, { "name": "vfwcap", "lines": 8 }, { "name": "video_size", "lines": 2 }, { "name": "framerate", "lines": 3 }, { "name": "x11grab", "lines": 33 }, { "name": "select_region", "lines": 6 }, { "name": "draw_mouse", "lines": 3 }, { "name": "follow_mouse", "lines": 15 }, { "name": "framerate", "lines": 3 }, { "name": "show_region", "lines": 6 }, { "name": "region_border", "lines": 11 }, { "name": "window_id", "lines": 12 }, { "name": "video_size", "lines": 2 }, { "name": "grab_x", "lines": 1 }, { "name": "grab_y", "lines": 4 } ] }, { "name": "OUTPUT DEVICES", "lines": 14, "subsections": [ { "name": "alsa", "lines": 12 }, { "name": "AudioToolbox", "lines": 20 }, { "name": "-audio_device_index ", "lines": 12 }, { "name": "caca", "lines": 13 }, { "name": "window_title", "lines": 3 }, { "name": "window_size", "lines": 3 }, { "name": "driver", "lines": 2 }, { "name": "algorithm", "lines": 4 }, { "name": "antialias", "lines": 3 }, { "name": "charset", "lines": 3 }, { "name": "color", "lines": 3 }, { "name": "list_drivers", "lines": 2 }, { "name": "list_dither", "lines": 18 }, { "name": "decklink", "lines": 12 }, { "name": "list_devices", "lines": 4 }, { "name": "list_formats", "lines": 2 }, { "name": "preroll", "lines": 2 }, { "name": "duplex_mode", "lines": 14 }, { "name": "timing_offset", "lines": 2 }, { "name": "link", "lines": 6 }, { "name": "level_a", "lines": 3 }, { "name": "vanc_queue_size", "lines": 21 }, { "name": "fbdev", "lines": 11 }, { "name": "xoffset", "lines": 1 }, { "name": "yoffset", "lines": 11 }, { "name": "opengl", "lines": 16 }, { "name": "background", "lines": 2 }, { "name": "no_window", "lines": 3 }, { "name": "window_title", "lines": 3 }, { "name": "window_size", "lines": 10 }, { "name": "oss", "lines": 2 }, { "name": "pulse", "lines": 8 }, { "name": "server", "lines": 3 }, { "name": "name", "lines": 3 }, { "name": "stream_name", "lines": 3 }, { "name": "device", "lines": 3 }, { "name": "buffer_size", "lines": 1 }, { "name": "buffer_duration", "lines": 11 }, { "name": "prebuf", "lines": 4 }, { "name": "minreq", "lines": 11 }, { "name": "sdl", "lines": 15 }, { "name": "window_borderless", "lines": 2 }, { "name": "window_enable_quit", "lines": 3 }, { "name": "window_fullscreen", "lines": 2 }, { "name": "window_size", "lines": 4 }, { "name": "window_title", "lines": 3 }, { "name": "window_x", "lines": 1 }, { "name": "window_y", "lines": 7 }, { "name": "q, ESC", "lines": 9 }, { "name": "sndio", "lines": 2 }, { "name": "v4l2", "lines": 9 }, { "name": "display_name", "lines": 17 }, { "name": "window_id", "lines": 4 }, { "name": "window_size", "lines": 4 }, { "name": "window_x", "lines": 1 }, { "name": "window_y", "lines": 3 }, { "name": "window_title", "lines": 15 } ] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "AUTHORS", "lines": 10, "subsections": [] } ], "sections": { "NAME": { "content": "ffmpeg-devices - FFmpeg devices\n", "subsections": [] }, "DESCRIPTION": { "content": "This document describes the input and output devices provided by the libavdevice library.\n", "subsections": [] }, "DEVICE OPTIONS": { "content": "The libavdevice library provides the same interface as libavformat. Namely, an input device\nis considered like a demuxer, and an output device like a muxer, and the interface and\ngeneric device options are the same provided by libavformat (see the ffmpeg-formats manual).\n\nIn addition each input or output device may support so-called private options, which are\nspecific for that component.\n\nOptions may be set by specifying -option value in the FFmpeg tools, or by setting the value\nexplicitly in the device \"AVFormatContext\" options or using the libavutil/opt.h API for\nprogrammatic use.\n", "subsections": [] }, "INPUT DEVICES": { "content": "Input devices are configured elements in FFmpeg which enable accessing the data coming from a\nmultimedia device attached to your system.\n\nWhen you configure your FFmpeg build, all the supported input devices are enabled by default.\nYou can list all available ones using the configure option \"--list-indevs\".\n\nYou can disable all the input devices using the configure option \"--disable-indevs\", and\nselectively enable an input device using the option \"--enable-indev=INDEV\", or you can\ndisable a particular input device using the option \"--disable-indev=INDEV\".\n\nThe option \"-devices\" of the ff* tools will display the list of supported input devices.\n\nA description of the currently available input devices follows.\n", "subsections": [ { "name": "alsa", "content": "ALSA (Advanced Linux Sound Architecture) input device.\n\nTo enable this input device during configuration you need libasound installed on your system.\n\nThis device allows capturing from an ALSA device. The name of the device to capture has to be\nan ALSA card identifier.\n\nAn ALSA identifier has the syntax:\n\nhw:[,[,]]\n\nwhere the DEV and SUBDEV components are optional.\n\nThe three arguments (in order: CARD,DEV,SUBDEV) specify card number or identifier, device\nnumber and subdevice number (-1 means any).\n\nTo see the list of cards currently recognized by your system check the files\n/proc/asound/cards and /proc/asound/devices.\n\nFor example to capture with ffmpeg from an ALSA device with card id 0, you may run the\ncommand:\n\nffmpeg -f alsa -i hw:0 alsaout.wav\n\nFor more information see: \n\nOptions\n" }, { "name": "sample_rate", "content": "Set the sample rate in Hz. Default is 48000.\n" }, { "name": "channels", "content": "Set the number of channels. Default is 2.\n" }, { "name": "android_camera", "content": "Android camera input device.\n\nThis input devices uses the Android Camera2 NDK API which is available on devices with API\nlevel 24+. The availability of androidcamera is autodetected during configuration.\n\nThis device allows capturing from all cameras on an Android device, which are integrated into\nthe Camera2 NDK API.\n\nThe available cameras are enumerated internally and can be selected with the cameraindex\nparameter. The input file string is discarded.\n\nGenerally the back facing camera has index 0 while the front facing camera has index 1.\n\nOptions\n" }, { "name": "video_size", "content": "Set the video size given as a string such as 640x480 or hd720. Falls back to the first\navailable configuration reported by Android if requested video size is not available or\nby default.\n" }, { "name": "framerate", "content": "Set the video framerate. Falls back to the first available configuration reported by\nAndroid if requested framerate is not available or by default (-1).\n" }, { "name": "camera_index", "content": "Set the index of the camera to use. Default is 0.\n" }, { "name": "input_queue_size", "content": "Set the maximum number of frames to buffer. Default is 5.\n" }, { "name": "avfoundation", "content": "AVFoundation input device.\n\nAVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >=\n10.7 as well as on iOS.\n\nThe input filename has to be given in the following syntax:\n\n-i \"[[VIDEO]:[AUDIO]]\"\n\nThe first entry selects the video input while the latter selects the audio input. The stream\nhas to be specified by the device name or the device index as shown by the device list.\nAlternatively, the video and/or audio input device can be chosen by index using the\n\nB<-videodeviceindex EINDEXE>\n\nand/or\n\nB<-audiodeviceindex EINDEXE>\n\n, overriding any device name or index given in the input filename.\n\nAll available devices can be enumerated by using -listdevices true, listing all device names\nand corresponding indices.\n\nThere are two device name aliases:\n\n\"default\"\nSelect the AVFoundation default device of the corresponding type.\n\n\"none\"\nDo not record the corresponding media type. This is equivalent to specifying an empty\ndevice name or index.\n\nOptions\n\nAVFoundation supports the following options:\n" }, { "name": "-list_devices ", "content": "If set to true, a list of all available input devices is given showing all device names\nand indices.\n" }, { "name": "-video_device_index ", "content": "Specify the video device by its index. Overrides anything given in the input filename.\n" }, { "name": "-audio_device_index ", "content": "Specify the audio device by its index. Overrides anything given in the input filename.\n" }, { "name": "-pixel_format ", "content": "Request the video device to use a specific pixel format. If the specified format is not\nsupported, a list of available formats is given and the first one in this list is used\ninstead. Available pixel formats are: \"monob, rgb555be, rgb555le, rgb565be, rgb565le,\nrgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0,\nbgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10,\nyuv420p, nv12, yuyv422, gray\"\n" }, { "name": "-framerate", "content": "Set the grabbing frame rate. Default is \"ntsc\", corresponding to a frame rate of\n\"30000/1001\".\n" }, { "name": "-video_size", "content": "Set the video frame size.\n" }, { "name": "-capture_cursor", "content": "Capture the mouse pointer. Default is 0.\n" }, { "name": "-capture_mouse_clicks", "content": "Capture the screen mouse clicks. Default is 0.\n" }, { "name": "-capture_raw_data", "content": "Capture the raw device data. Default is 0. Using this option may result in receiving the\nunderlying data delivered to the AVFoundation framework. E.g. for muxed devices that\nsends raw DV data to the framework (like tape-based camcorders), setting this option to\nfalse results in extracted video frames captured in the designated pixel format only.\nSetting this option to true results in receiving the raw DV stream untouched.\n\nExamples\n\n• Print the list of AVFoundation supported devices and exit:\n\n$ ffmpeg -f avfoundation -listdevices true -i \"\"\n\n• Record video from video device 0 and audio from audio device 0 into out.avi:\n\n$ ffmpeg -f avfoundation -i \"0:0\" out.avi\n\n• Record video from video device 2 and audio from audio device 1 into out.avi:\n\n$ ffmpeg -f avfoundation -videodeviceindex 2 -i \":1\" out.avi\n\n• Record video from the system default video device using the pixel format bgr0 and do not\nrecord any audio into out.avi:\n\n$ ffmpeg -f avfoundation -pixelformat bgr0 -i \"default:none\" out.avi\n\n• Record raw DV data from a suitable input device and write the output into out.dv:\n\n$ ffmpeg -f avfoundation -capturerawdata true -i \"zr100:none\" out.dv\n" }, { "name": "bktr", "content": "BSD video input device.\n\nOptions\n" }, { "name": "framerate", "content": "Set the frame rate.\n" }, { "name": "video_size", "content": "Set the video frame size. Default is \"vga\".\n" }, { "name": "standard", "content": "Available values are:\n\npal\nntsc\nsecam\npaln\npalm\nntscj\n" }, { "name": "decklink", "content": "The decklink input device provides capture capabilities for Blackmagic DeckLink devices.\n\nTo enable this input device, you need the Blackmagic DeckLink SDK and you need to configure\nwith the appropriate \"--extra-cflags\" and \"--extra-ldflags\". On Windows, you need to run the\nIDL files through widl.\n\nDeckLink is very picky about the formats it supports. Pixel format of the input can be set\nwith rawformat. Framerate and video size must be determined for your device with" }, { "name": "-list_formats 1", "content": "16. Note that all audio channels are bundled in one single audio track.\n\nOptions\n" }, { "name": "list_devices", "content": "If set to true, print a list of devices and exit. Defaults to false. This option is\ndeprecated, please use the \"-sources\" option of ffmpeg to list the available input\ndevices.\n" }, { "name": "list_formats", "content": "If set to true, print a list of supported formats and exit. Defaults to false.\n" }, { "name": "format_code ", "content": "This sets the input video format to the format given by the FourCC. To see the supported\nvalues of your device(s) use listformats. Note that there is a FourCC 'pal ' that can\nalso be used as pal (3 letters). Default behavior is autodetection of the input video\nformat, if the hardware supports it.\n" }, { "name": "raw_format", "content": "Set the pixel format of the captured video. Available values are:\n\nauto\nThis is the default which means 8-bit YUV 422 or 8-bit ARGB if format autodetection\nis used, 8-bit YUV 422 otherwise.\n\nuyvy422\n8-bit YUV 422.\n\nyuv422p10\n10-bit YUV 422.\n\nargb\n8-bit RGB.\n\nbgra\n8-bit RGB.\n\nrgb10\n10-bit RGB.\n" }, { "name": "teletext_lines", "content": "If set to nonzero, an additional teletext stream will be captured from the vertical\nancillary data. Both SD PAL (576i) and HD (1080i or 1080p) sources are supported. In case\nof HD sources, OP47 packets are decoded.\n\nThis option is a bitmask of the SD PAL VBI lines captured, specifically lines 6 to 22,\nand lines 318 to 335. Line 6 is the LSB in the mask. Selected lines which do not contain\nteletext information will be ignored. You can use the special all constant to select all\npossible lines, or standard to skip lines 6, 318 and 319, which are not compatible with\nall receivers.\n\nFor SD sources, ffmpeg needs to be compiled with \"--enable-libzvbi\". For HD sources, on\nolder (pre-4K) DeckLink card models you have to capture in 10 bit mode.\n" }, { "name": "channels", "content": "Defines number of audio channels to capture. Must be 2, 8 or 16. Defaults to 2.\n" }, { "name": "duplex_mode", "content": "Sets the decklink device duplex/profile mode. Must be unset, half, full,\nonesubdevicefull, onesubdevicehalf, twosubdevicefull, foursubdevicehalf\nDefaults to unset.\n\nNote: DeckLink SDK 11.0 have replaced the duplex property by a profile property. For the\nDeckLink Duo 2 and DeckLink Quad 2, a profile is shared between any 2 sub-devices that\nutilize the same connectors. For the DeckLink 8K Pro, a profile is shared between all 4\nsub-devices. So DeckLink 8K Pro support four profiles.\n\nValid profile modes for DeckLink 8K Pro(with DeckLink SDK >= 11.0): onesubdevicefull,\nonesubdevicehalf, twosubdevicefull, foursubdevicehalf\n\nValid profile modes for DeckLink Quad 2 and DeckLink Duo 2: half, full\n" }, { "name": "timecode_format", "content": "Timecode type to include in the frame and video stream metadata. Must be none, rp188vitc,\nrp188vitc2, rp188ltc, rp188hfr, rp188any, vitc, vitc2, or serial. Defaults to none (not\nincluded).\n\nIn order to properly support 50/60 fps timecodes, the ordering of the queried timecode\ntypes for rp188any is HFR, VITC1, VITC2 and LTC for >30 fps content. Note that this is\nslightly different to the ordering used by the DeckLink API, which is HFR, VITC1, LTC,\nVITC2.\n" }, { "name": "video_input", "content": "Sets the video input source. Must be unset, sdi, hdmi, opticalsdi, component, composite\nor svideo. Defaults to unset.\n" }, { "name": "audio_input", "content": "Sets the audio input source. Must be unset, embedded, aesebu, analog, analogxlr,\nanalogrca or microphone. Defaults to unset.\n" }, { "name": "video_pts", "content": "Sets the video packet timestamp source. Must be video, audio, reference, wallclock or\nabswallclock. Defaults to video.\n" }, { "name": "audio_pts", "content": "Sets the audio packet timestamp source. Must be video, audio, reference, wallclock or\nabswallclock. Defaults to audio.\n" }, { "name": "draw_bars", "content": "If set to true, color bars are drawn in the event of a signal loss. Defaults to true.\n" }, { "name": "queue_size", "content": "Sets maximum input buffer size in bytes. If the buffering reaches this value, incoming\nframes will be dropped. Defaults to 1073741824.\n" }, { "name": "audio_depth", "content": "Sets the audio sample bit depth. Must be 16 or 32. Defaults to 16.\n" }, { "name": "decklink_copyts", "content": "If set to true, timestamps are forwarded as they are without removing the initial offset.\nDefaults to false.\n" }, { "name": "timestamp_align", "content": "Capture start time alignment in seconds. If set to nonzero, input frames are dropped till\nthe system timestamp aligns with configured value. Alignment difference of up to one\nframe duration is tolerated. This is useful for maintaining input synchronization across\nN different hardware devices deployed for 'N-way' redundancy. The system time of\ndifferent hardware devices should be synchronized with protocols such as NTP or PTP,\nbefore using this option. Note that this method is not foolproof. In some border cases\ninput synchronization may not happen due to thread scheduling jitters in the OS. Either\nsync could go wrong by 1 frame or in a rarer case timestampalign seconds. Defaults to\n0.\n\nwaitfortc (bool)\nDrop frames till a frame with timecode is received. Sometimes serial timecode isn't\nreceived with the first input frame. If that happens, the stored stream timecode will be\ninaccurate. If this option is set to true, input frames are dropped till a frame with\ntimecode is received. Option timecodeformat must be specified. Defaults to false.\n\nenableklv(bool)\nIf set to true, extracts KLV data from VANC and outputs KLV packets. KLV VANC packets\nare joined based on MID and PSC fields and aggregated into one KLV packet. Defaults to\nfalse.\n\nExamples\n\n• List input devices:\n\nffmpeg -sources decklink\n\n• List supported formats:\n\nffmpeg -f decklink -listformats 1 -i 'Intensity Pro'\n\n• Capture video clip at 1080i50:\n\nffmpeg -formatcode Hi50 -f decklink -i 'Intensity Pro' -c:a copy -c:v copy output.avi\n\n• Capture video clip at 1080i50 10 bit:\n\nffmpeg -rawformat yuv422p10 -formatcode Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi\n\n• Capture video clip at 1080i50 with 16 audio channels:\n\nffmpeg -channels 16 -formatcode Hi50 -f decklink -i 'UltraStudio Mini Recorder' -c:a copy -c:v copy output.avi\n" }, { "name": "dshow", "content": "Windows DirectShow input device.\n\nDirectShow support is enabled when FFmpeg is built with the mingw-w64 project. Currently\nonly audio and video devices are supported.\n\nMultiple devices may be opened as separate inputs, but they may also be opened on the same\ninput, which should improve synchronism between them.\n\nThe input name should be in the format:\n\n=[:=]\n\nwhere TYPE can be either audio or video, and NAME is the device's name or alternative name..\n\nOptions\n\nIf no options are specified, the device's defaults are used. If the device does not support\nthe requested options, it will fail to open.\n" }, { "name": "video_size", "content": "Set the video size in the captured video.\n" }, { "name": "framerate", "content": "Set the frame rate in the captured video.\n" }, { "name": "sample_rate", "content": "Set the sample rate (in Hz) of the captured audio.\n" }, { "name": "sample_size", "content": "Set the sample size (in bits) of the captured audio.\n" }, { "name": "channels", "content": "Set the number of channels in the captured audio.\n" }, { "name": "list_devices", "content": "If set to true, print a list of devices and exit.\n" }, { "name": "list_options", "content": "If set to true, print a list of selected device's options and exit.\n" }, { "name": "video_device_number", "content": "Set video device number for devices with the same name (starts at 0, defaults to 0).\n" }, { "name": "audio_device_number", "content": "Set audio device number for devices with the same name (starts at 0, defaults to 0).\n" }, { "name": "pixel_format", "content": "Select pixel format to be used by DirectShow. This may only be set when the video codec\nis not set or set to rawvideo.\n" }, { "name": "audio_buffer_size", "content": "Set audio device buffer size in milliseconds (which can directly impact latency,\ndepending on the device). Defaults to using the audio device's default buffer size\n(typically some multiple of 500ms). Setting this value too low can degrade performance.\nSee also \n" }, { "name": "video_pin_name", "content": "Select video capture pin to use by name or alternative name.\n" }, { "name": "audio_pin_name", "content": "Select audio capture pin to use by name or alternative name.\n" }, { "name": "crossbar_video_input_pin_number", "content": "Select video input pin number for crossbar device. This will be routed to the crossbar\ndevice's Video Decoder output pin. Note that changing this value can affect future\ninvocations (sets a new default) until system reboot occurs.\n" }, { "name": "crossbar_audio_input_pin_number", "content": "Select audio input pin number for crossbar device. This will be routed to the crossbar\ndevice's Audio Decoder output pin. Note that changing this value can affect future\ninvocations (sets a new default) until system reboot occurs.\n" }, { "name": "show_video_device_dialog", "content": "If set to true, before capture starts, popup a display dialog to the end user, allowing\nthem to change video filter properties and configurations manually. Note that for\ncrossbar devices, adjusting values in this dialog may be needed at times to toggle\nbetween PAL (25 fps) and NTSC (29.97) input frame rates, sizes, interlacing, etc.\nChanging these values can enable different scan rates/frame rates and avoiding green bars\nat the bottom, flickering scan lines, etc. Note that with some devices, changing these\nproperties can also affect future invocations (sets new defaults) until system reboot\noccurs.\n" }, { "name": "show_audio_device_dialog", "content": "If set to true, before capture starts, popup a display dialog to the end user, allowing\nthem to change audio filter properties and configurations manually.\n" }, { "name": "show_video_crossbar_connection_dialog", "content": "If set to true, before capture starts, popup a display dialog to the end user, allowing\nthem to manually modify crossbar pin routings, when it opens a video device.\n" }, { "name": "show_audio_crossbar_connection_dialog", "content": "If set to true, before capture starts, popup a display dialog to the end user, allowing\nthem to manually modify crossbar pin routings, when it opens an audio device.\n" }, { "name": "show_analog_tv_tuner_dialog", "content": "If set to true, before capture starts, popup a display dialog to the end user, allowing\nthem to manually modify TV channels and frequencies.\n" }, { "name": "show_analog_tv_tuner_audio_dialog", "content": "If set to true, before capture starts, popup a display dialog to the end user, allowing\nthem to manually modify TV audio (like mono vs. stereo, Language A,B or C).\n" }, { "name": "audio_device_load", "content": "Load an audio capture filter device from file instead of searching it by name. It may\nload additional parameters too, if the filter supports the serialization of its\nproperties to. To use this an audio capture source has to be specified, but it can be\nanything even fake one.\n" }, { "name": "audio_device_save", "content": "Save the currently used audio capture filter device and its parameters (if the filter\nsupports it) to a file. If a file with the same name exists it will be overwritten.\n" }, { "name": "video_device_load", "content": "Load a video capture filter device from file instead of searching it by name. It may load\nadditional parameters too, if the filter supports the serialization of its properties to.\nTo use this a video capture source has to be specified, but it can be anything even fake\none.\n" }, { "name": "video_device_save", "content": "Save the currently used video capture filter device and its parameters (if the filter\nsupports it) to a file. If a file with the same name exists it will be overwritten.\n" }, { "name": "use_video_device_timestamps", "content": "If set to false, the timestamp for video frames will be derived from the wallclock\ninstead of the timestamp provided by the capture device. This allows working around\ndevices that provide unreliable timestamps.\n\nExamples\n\n• Print the list of DirectShow supported devices and exit:\n\n$ ffmpeg -listdevices true -f dshow -i dummy\n\n• Open video device Camera:\n\n$ ffmpeg -f dshow -i video=\"Camera\"\n\n• Open second video device with name Camera:\n\n$ ffmpeg -f dshow -videodevicenumber 1 -i video=\"Camera\"\n\n• Open video device Camera and audio device Microphone:\n\n$ ffmpeg -f dshow -i video=\"Camera\":audio=\"Microphone\"\n\n• Print the list of supported options in selected device and exit:\n\n$ ffmpeg -listoptions true -f dshow -i video=\"Camera\"\n\n• Specify pin names to capture by name or alternative name, specify alternative device\nname:\n\n$ ffmpeg -f dshow -audiopinname \"Audio Out\" -videopinname 2 -i video=video=\"@devicepnp\\\\?\\pci#ven1a0a&dev6200&subsys62021461&rev01#4&e2c7dd6&0&00e1#{65e8773d-8f56-11d0-a3b9-00a0c9223196}\\{ca465100-deb0-4d59-818f-8c477184adf6}\":audio=\"Microphone\"\n\n• Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture\nproperties at startup:\n\n$ ffmpeg -f dshow -showvideodevicedialog true -crossbarvideoinputpinnumber 0\n-crossbaraudioinputpinnumber 3 -i video=\"AVerMedia BDA Analog Capture\":audio=\"AVerMedia BDA Analog Capture\"\n" }, { "name": "fbdev", "content": "Linux framebuffer input device.\n\nThe Linux framebuffer is a graphic hardware-independent abstraction layer to show graphics on\na computer monitor, typically on the console. It is accessed through a file device node,\nusually /dev/fb0.\n\nFor more detailed information read the file Documentation/fb/framebuffer.txt included in the\nLinux source tree.\n\nSee also , and fbset(1).\n\nTo record from the framebuffer device /dev/fb0 with ffmpeg:\n\nffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi\n\nYou can take a single screenshot image with the command:\n\nffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg\n\nOptions\n" }, { "name": "framerate", "content": "Set the frame rate. Default is 25.\n" }, { "name": "gdigrab", "content": "Win32 GDI-based screen capture device.\n\nThis device allows you to capture a region of the display on Windows.\n\nThere are two options for the input filename:\n\ndesktop\n\nor\n\ntitle=\n\nThe first option will capture the entire desktop, or a fixed region of the desktop. The\nsecond option will instead capture the contents of a single window, regardless of its\nposition on the screen.\n\nFor example, to grab the entire desktop using ffmpeg:\n\nffmpeg -f gdigrab -framerate 6 -i desktop out.mpg\n\nGrab a 640x480 region at position \"10,20\":\n\nffmpeg -f gdigrab -framerate 6 -offsetx 10 -offsety 20 -videosize vga -i desktop out.mpg\n\nGrab the contents of the window named \"Calculator\"\n\nffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg\n\nOptions\n" }, { "name": "draw_mouse", "content": "Specify whether to draw the mouse pointer. Use the value 0 to not draw the pointer.\nDefault value is 1.\n" }, { "name": "framerate", "content": "Set the grabbing frame rate. Default value is \"ntsc\", corresponding to a frame rate of\n\"30000/1001\".\n" }, { "name": "show_region", "content": "Show grabbed region on screen.\n\nIf showregion is specified with 1, then the grabbing region will be indicated on screen.\nWith this option, it is easy to know what is being grabbed if only a portion of the\nscreen is grabbed.\n\nNote that showregion is incompatible with grabbing the contents of a single window.\n\nFor example:\n\nffmpeg -f gdigrab -showregion 1 -framerate 6 -videosize cif -offsetx 10 -offsety 20 -i desktop out.mpg\n" }, { "name": "video_size", "content": "Set the video frame size. The default is to capture the full screen if desktop is\nselected, or the full window size if title=windowtitle is selected.\n" }, { "name": "offset_x", "content": "When capturing a region with videosize, set the distance from the left edge of the\nscreen or desktop.\n\nNote that the offset calculation is from the top left corner of the primary monitor on\nWindows. If you have a monitor positioned to the left of your primary monitor, you will\nneed to use a negative offsetx value to move the region to that monitor.\n" }, { "name": "offset_y", "content": "When capturing a region with videosize, set the distance from the top edge of the screen\nor desktop.\n\nNote that the offset calculation is from the top left corner of the primary monitor on\nWindows. If you have a monitor positioned above your primary monitor, you will need to\nuse a negative offsety value to move the region to that monitor.\n" }, { "name": "iec61883", "content": "FireWire DV/HDV input device using libiec61883.\n\nTo enable this input device, you need libiec61883, libraw1394 and libavc1394 installed on\nyour system. Use the configure option \"--enable-libiec61883\" to compile with the device\nenabled.\n\nThe iec61883 capture device supports capturing from a video device connected via IEEE1394\n(FireWire), using libiec61883 and the new Linux FireWire stack (juju). This is the default\nDV/HDV input method in Linux Kernel 2.6.37 and later, since the old FireWire stack was\nremoved.\n\nSpecify the FireWire port to be used as input file, or \"auto\" to choose the first port\nconnected.\n\nOptions\n" }, { "name": "dvtype", "content": "Override autodetection of DV/HDV. This should only be used if auto detection does not\nwork, or if usage of a different device type should be prohibited. Treating a DV device\nas HDV (or vice versa) will not work and result in undefined behavior. The values auto,\ndv and hdv are supported.\n" }, { "name": "dvbuffer", "content": "Set maximum size of buffer for incoming data, in frames. For DV, this is an exact value.\nFor HDV, it is not frame exact, since HDV does not have a fixed frame size.\n" }, { "name": "dvguid", "content": "Select the capture device by specifying its GUID. Capturing will only be performed from\nthe specified device and fails if no device with the given GUID is found. This is useful\nto select the input if multiple devices are connected at the same time. Look at\n/sys/bus/firewire/devices to find out the GUIDs.\n\nExamples\n\n• Grab and show the input of a FireWire DV/HDV device.\n\nffplay -f iec61883 -i auto\n\n• Grab and record the input of a FireWire DV/HDV device, using a packet buffer of 100000\npackets if the source is HDV.\n\nffmpeg -f iec61883 -i auto -dvbuffer 100000 out.mpg\n" }, { "name": "jack", "content": "JACK input device.\n\nTo enable this input device during configuration you need libjack installed on your system.\n\nA JACK input device creates one or more JACK writable clients, one for each audio channel,\nwith name clientname:inputN, where clientname is the name provided by the application, and\nN is a number which identifies the channel. Each writable client will send the acquired data\nto the FFmpeg input device.\n\nOnce you have created one or more JACK readable clients, you need to connect them to one or\nmore JACK writable clients.\n\nTo connect or disconnect JACK clients you can use the jackconnect and jackdisconnect\nprograms, or do it through a graphical interface, for example with qjackctl.\n\nTo list the JACK clients and their properties you can invoke the command jacklsp.\n\nFollows an example which shows how to capture a JACK readable client with ffmpeg.\n\n# Create a JACK writable client with name \"ffmpeg\".\n$ ffmpeg -f jack -i ffmpeg -y out.wav\n\n# Start the sample jackmetro readable client.\n$ jackmetro -b 120 -d 0.2 -f 4000\n\n# List the current JACK clients.\n$ jacklsp -c\nsystem:capture1\nsystem:capture2\nsystem:playback1\nsystem:playback2\nffmpeg:input1\nmetro:120bpm\n\n# Connect metro to the ffmpeg writable client.\n$ jackconnect metro:120bpm ffmpeg:input1\n\nFor more information read: \n\nOptions\n" }, { "name": "channels", "content": "Set the number of channels. Default is 2.\n" }, { "name": "kmsgrab", "content": "KMS video input device.\n\nCaptures the KMS scanout framebuffer associated with a specified CRTC or plane as a DRM\nobject that can be passed to other hardware functions.\n\nRequires either DRM master or CAPSYSADMIN to run.\n\nIf you don't understand what all of that means, you probably don't want this. Look at\nx11grab instead.\n\nOptions\n" }, { "name": "device", "content": "DRM device to capture on. Defaults to /dev/dri/card0.\n" }, { "name": "format", "content": "Pixel format of the framebuffer. This can be autodetected if you are running Linux 5.7\nor later, but needs to be provided for earlier versions. Defaults to bgr0, which is the\nmost common format used by the Linux console and Xorg X server.\n" }, { "name": "format_modifier", "content": "Format modifier to signal on output frames. This is necessary to import correctly into\nsome APIs. It can be autodetected if you are running Linux 5.7 or later, but will need\nto be provided explicitly when needed in earlier versions. See the libdrm documentation\nfor possible values.\n" }, { "name": "crtc_id", "content": "KMS CRTC ID to define the capture source. The first active plane on the given CRTC will\nbe used.\n" }, { "name": "plane_id", "content": "KMS plane ID to define the capture source. Defaults to the first active plane found if\nneither crtcid nor planeid are specified.\n" }, { "name": "framerate", "content": "Framerate to capture at. This is not synchronised to any page flipping or framebuffer\nchanges - it just defines the interval at which the framebuffer is sampled. Sampling\nfaster than the framebuffer update rate will generate independent frames with the same\ncontent. Defaults to 30.\n\nExamples\n\n• Capture from the first active plane, download the result to normal frames and encode.\nThis will only work if the framebuffer is both linear and mappable - if not, the result\nmay be scrambled or fail to download.\n\nffmpeg -f kmsgrab -i - -vf 'hwdownload,format=bgr0' output.mp4\n\n• Capture from CRTC ID 42 at 60fps, map the result to VAAPI, convert to NV12 and encode as\nH.264.\n\nffmpeg -crtcid 42 -framerate 60 -f kmsgrab -i - -vf 'hwmap=derivedevice=vaapi,scalevaapi=w=1920:h=1080:format=nv12' -c:v h264vaapi output.mp4\n\n• To capture only part of a plane the output can be cropped - this can be used to capture a\nsingle window, as long as it has a known absolute position and size. For example, to\ncapture and encode the middle quarter of a 1920x1080 plane:\n\nffmpeg -f kmsgrab -i - -vf 'hwmap=derivedevice=vaapi,crop=960:540:480:270,scalevaapi=960:540:nv12' -c:v h264vaapi output.mp4\n" }, { "name": "lavfi", "content": "Libavfilter input virtual device.\n\nThis input device reads data from the open output pads of a libavfilter filtergraph.\n\nFor each filtergraph open output, the input device will create a corresponding stream which\nis mapped to the generated output. The filtergraph is specified through the option graph.\n\nOptions\n" }, { "name": "graph", "content": "Specify the filtergraph to use as input. Each video open output must be labelled by a\nunique string of the form \"outN\", where N is a number starting from 0 corresponding to\nthe mapped input stream generated by the device. The first unlabelled output is\nautomatically assigned to the \"out0\" label, but all the others need to be specified\nexplicitly.\n\nThe suffix \"+subcc\" can be appended to the output label to create an extra stream with\nthe closed captions packets attached to that output (experimental; only for EIA-608 /\nCEA-708 for now). The subcc streams are created after all the normal streams, in the\norder of the corresponding stream. For example, if there is \"out19+subcc\", \"out7+subcc\"\nand up to \"out42\", the stream #43 is subcc for stream #7 and stream #44 is subcc for\nstream #19.\n\nIf not specified defaults to the filename specified for the input device.\n" }, { "name": "graph_file", "content": "Set the filename of the filtergraph to be read and sent to the other filters. Syntax of\nthe filtergraph is the same as the one specified by the option graph.\n" }, { "name": "dumpgraph", "content": "Dump graph to stderr.\n\nExamples\n\n• Create a color video stream and play it back with ffplay:\n\nffplay -f lavfi -graph \"color=c=pink [out0]\" dummy\n\n• As the previous example, but use filename for specifying the graph description, and omit\nthe \"out0\" label:\n\nffplay -f lavfi color=c=pink\n\n• Create three different video test filtered sources and play them:\n\nffplay -f lavfi -graph \"testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]\" test3\n\n• Read an audio stream from a file using the amovie source and play it back with ffplay:\n\nffplay -f lavfi \"amovie=test.wav\"\n\n• Read an audio stream and a video stream and play it back with ffplay:\n\nffplay -f lavfi \"movie=test.avi[out0];amovie=test.wav[out1]\"\n\n• Dump decoded frames to images and closed captions to a file (experimental):\n\nffmpeg -f lavfi -i \"movie=test.ts[out0+subcc]\" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin\n" }, { "name": "libcdio", "content": "Audio-CD input device based on libcdio.\n\nTo enable this input device during configuration you need libcdio installed on your system.\nIt requires the configure option \"--enable-libcdio\".\n\nThis device allows playing and grabbing from an Audio-CD.\n\nFor example to copy with ffmpeg the entire Audio-CD in /dev/sr0, you may run the command:\n\nffmpeg -f libcdio -i /dev/sr0 cd.wav\n\nOptions\n" }, { "name": "speed", "content": "Set drive reading speed. Default value is 0.\n\nThe speed is specified CD-ROM speed units. The speed is set through the libcdio\n\"cdiocddapspeedset\" function. On many CD-ROM drives, specifying a value too large will\nresult in using the fastest speed.\n" }, { "name": "paranoia_mode", "content": "Set paranoia recovery mode flags. It accepts one of the following values:\n\ndisable\nverify\noverlap\nneverskip\nfull\n\nDefault value is disable.\n\nFor more information about the available recovery modes, consult the paranoia project\ndocumentation.\n" }, { "name": "libdc1394", "content": "IIDC1394 input device, based on libdc1394 and libraw1394.\n\nRequires the configure option \"--enable-libdc1394\".\n\nOptions\n" }, { "name": "framerate", "content": "Set the frame rate. Default is \"ntsc\", corresponding to a frame rate of \"30000/1001\".\n" }, { "name": "pixel_format", "content": "Select the pixel format. Default is \"uyvy422\".\n" }, { "name": "video_size", "content": "Set the video size given as a string such as \"640x480\" or \"hd720\". Default is \"qvga\".\n" }, { "name": "openal", "content": "The OpenAL input device provides audio capture on all systems with a working OpenAL 1.1\nimplementation.\n\nTo enable this input device during configuration, you need OpenAL headers and libraries\ninstalled on your system, and need to configure FFmpeg with \"--enable-openal\".\n\nOpenAL headers and libraries should be provided as part of your OpenAL implementation, or as\nan additional download (an SDK). Depending on your installation you may need to specify\nadditional flags via the \"--extra-cflags\" and \"--extra-ldflags\" for allowing the build system\nto locate the OpenAL headers and libraries.\n\nAn incomplete list of OpenAL implementations follows:\n" }, { "name": "Creative", "content": "The official Windows implementation, providing hardware acceleration with supported\ndevices and software fallback. See .\n" }, { "name": "OpenAL Soft", "content": "Portable, open source (LGPL) software implementation. Includes backends for the most\ncommon sound APIs on the Windows, Linux, Solaris, and BSD operating systems. See\n.\n" }, { "name": "Apple", "content": "OpenAL is part of Core Audio, the official Mac OS X Audio interface. See\n\n\nThis device allows one to capture from an audio input device handled through OpenAL.\n\nYou need to specify the name of the device to capture in the provided filename. If the empty\nstring is provided, the device will automatically select the default device. You can get the\nlist of the supported devices by using the option listdevices.\n\nOptions\n" }, { "name": "channels", "content": "Set the number of channels in the captured audio. Only the values 1 (monaural) and 2\n(stereo) are currently supported. Defaults to 2.\n" }, { "name": "sample_size", "content": "Set the sample size (in bits) of the captured audio. Only the values 8 and 16 are\ncurrently supported. Defaults to 16.\n" }, { "name": "sample_rate", "content": "Set the sample rate (in Hz) of the captured audio. Defaults to 44.1k.\n" }, { "name": "list_devices", "content": "If set to true, print a list of devices and exit. Defaults to false.\n\nExamples\n\nPrint the list of OpenAL supported devices and exit:\n\n$ ffmpeg -listdevices true -f openal -i dummy out.ogg\n\nCapture from the OpenAL device DR-BT101 via PulseAudio:\n\n$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg\n\nCapture from the default device (note the empty string '' as filename):\n\n$ ffmpeg -f openal -i '' out.ogg\n\nCapture from two devices simultaneously, writing to two different files, within the same\nffmpeg command:\n\n$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg\n\nNote: not all OpenAL implementations support multiple simultaneous capture - try the latest\nOpenAL Soft if the above does not work.\n" }, { "name": "oss", "content": "Open Sound System input device.\n\nThe filename to provide to the input device is the device node representing the OSS input\ndevice, and is usually set to /dev/dsp.\n\nFor example to grab from /dev/dsp using ffmpeg use the command:\n\nffmpeg -f oss -i /dev/dsp /tmp/oss.wav\n\nFor more information about OSS see: \n\nOptions\n" }, { "name": "sample_rate", "content": "Set the sample rate in Hz. Default is 48000.\n" }, { "name": "channels", "content": "Set the number of channels. Default is 2.\n" }, { "name": "pulse", "content": "PulseAudio input device.\n\nTo enable this output device you need to configure FFmpeg with \"--enable-libpulse\".\n\nThe filename to provide to the input device is a source device or the string \"default\"\n\nTo list the PulseAudio source devices and their properties you can invoke the command pactl\nlist sources.\n\nMore information about PulseAudio can be found on .\n\nOptions\n" }, { "name": "server", "content": "Connect to a specific PulseAudio server, specified by an IP address. Default server is\nused when not provided.\n" }, { "name": "name", "content": "Specify the application name PulseAudio will use when showing active clients, by default\nit is the \"LIBAVFORMATIDENT\" string.\n" }, { "name": "stream_name", "content": "Specify the stream name PulseAudio will use when showing active streams, by default it is\n\"record\".\n" }, { "name": "sample_rate", "content": "Specify the samplerate in Hz, by default 48kHz is used.\n" }, { "name": "channels", "content": "Specify the channels in use, by default 2 (stereo) is set.\n" }, { "name": "frame_size", "content": "This option does nothing and is deprecated.\n" }, { "name": "fragment_size", "content": "Specify the size in bytes of the minimal buffering fragment in PulseAudio, it will affect\nthe audio latency. By default it is set to 50 ms amount of data.\n" }, { "name": "wallclock", "content": "Set the initial PTS using the current time. Default is 1.\n\nExamples\n\nRecord a stream from default device:\n\nffmpeg -f pulse -i default /tmp/pulse.wav\n" }, { "name": "sndio", "content": "sndio input device.\n\nTo enable this input device during configuration you need libsndio installed on your system.\n\nThe filename to provide to the input device is the device node representing the sndio input\ndevice, and is usually set to /dev/audio0.\n\nFor example to grab from /dev/audio0 using ffmpeg use the command:\n\nffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav\n\nOptions\n" }, { "name": "sample_rate", "content": "Set the sample rate in Hz. Default is 48000.\n" }, { "name": "channels", "content": "Set the number of channels. Default is 2.\n" }, { "name": "video4linux2, v4l2", "content": "Video4Linux2 input video device.\n\n\"v4l2\" can be used as alias for \"video4linux2\".\n\nIf FFmpeg is built with v4l-utils support (by using the \"--enable-libv4l2\" configure option),\nit is possible to use it with the \"-uselibv4l2\" input device option.\n\nThe name of the device to grab is a file device node, usually Linux systems tend to\nautomatically create such nodes when the device (e.g. an USB webcam) is plugged into the\nsystem, and has a name of the kind /dev/videoN, where N is a number associated to the device.\n\nVideo4Linux2 devices usually support a limited set of widthxheight sizes and frame rates. You\ncan check which are supported using -listformats all for Video4Linux2 devices. Some\ndevices, like TV cards, support one or more standards. It is possible to list all the\nsupported standards using -liststandards all.\n\nThe time base for the timestamps is 1 microsecond. Depending on the kernel version and\nconfiguration, the timestamps may be derived from the real time clock (origin at the Unix\nEpoch) or the monotonic clock (origin usually at boot time, unaffected by NTP or manual\nchanges to the clock). The -timestamps abs or -ts abs option can be used to force conversion\ninto the real time clock.\n\nSome usage examples of the video4linux2 device with ffmpeg and ffplay:\n\n• List supported formats for a video4linux2 device:\n\nffplay -f video4linux2 -listformats all /dev/video0\n\n• Grab and show the input of a video4linux2 device:\n\nffplay -f video4linux2 -framerate 30 -videosize hd720 /dev/video0\n\n• Grab and record the input of a video4linux2 device, leave the frame rate and size as\npreviously set:\n\nffmpeg -f video4linux2 -inputformat mjpeg -i /dev/video0 out.mpeg\n\nFor more information about Video4Linux, check .\n\nOptions\n" }, { "name": "standard", "content": "Set the standard. Must be the name of a supported standard. To get a list of the\nsupported standards, use the liststandards option.\n" }, { "name": "channel", "content": "Set the input channel number. Default to -1, which means using the previously selected\nchannel.\n" }, { "name": "video_size", "content": "Set the video frame size. The argument must be a string in the form WIDTHxHEIGHT or a\nvalid size abbreviation.\n" }, { "name": "pixel_format", "content": "Select the pixel format (only valid for raw video input).\n" }, { "name": "input_format", "content": "Set the preferred pixel format (for raw video) or a codec name. This option allows one\nto select the input format, when several are available.\n" }, { "name": "framerate", "content": "Set the preferred video frame rate.\n" }, { "name": "list_formats", "content": "List available formats (supported pixel formats, codecs, and frame sizes) and exit.\n\nAvailable values are:\n\nall Show all available (compressed and non-compressed) formats.\n\nraw Show only raw video (non-compressed) formats.\n\ncompressed\nShow only compressed formats.\n" }, { "name": "list_standards", "content": "List supported standards and exit.\n\nAvailable values are:\n\nall Show all supported standards.\n" }, { "name": "timestamps, ts", "content": "Set type of timestamps for grabbed frames.\n\nAvailable values are:\n\ndefault\nUse timestamps from the kernel.\n\nabs Use absolute timestamps (wall clock).\n\nmono2abs\nForce conversion from monotonic to absolute timestamps.\n\nDefault value is \"default\".\n" }, { "name": "use_libv4l2", "content": "Use libv4l2 (v4l-utils) conversion functions. Default is 0.\n" }, { "name": "vfwcap", "content": "VfW (Video for Windows) capture input device.\n\nThe filename passed as input is the capture driver number, ranging from 0 to 9. You may use\n\"list\" as filename to print a list of drivers. Any other filename will be interpreted as\ndevice number 0.\n\nOptions\n" }, { "name": "video_size", "content": "Set the video frame size.\n" }, { "name": "framerate", "content": "Set the grabbing frame rate. Default value is \"ntsc\", corresponding to a frame rate of\n\"30000/1001\".\n" }, { "name": "x11grab", "content": "X11 video input device.\n\nTo enable this input device during configuration you need libxcb installed on your system. It\nwill be automatically detected during configuration.\n\nThis device allows one to capture a region of an X11 display.\n\nThe filename passed as input has the syntax:\n\n[]:.[+,]\n\nhostname:displaynumber.screennumber specifies the X11 display name of the screen to grab\nfrom. hostname can be omitted, and defaults to \"localhost\". The environment variable DISPLAY\ncontains the default display name.\n\nxoffset and yoffset specify the offsets of the grabbed area with respect to the top-left\nborder of the X11 screen. They default to 0.\n\nCheck the X11 documentation (e.g. man X) for more detailed information.\n\nUse the xdpyinfo program for getting basic information about the properties of your X11\ndisplay (e.g. grep for \"name\" or \"dimensions\").\n\nFor example to grab from :0.0 using ffmpeg:\n\nffmpeg -f x11grab -framerate 25 -videosize cif -i :0.0 out.mpg\n\nGrab at position \"10,20\":\n\nffmpeg -f x11grab -framerate 25 -videosize cif -i :0.0+10,20 out.mpg\n\nOptions\n" }, { "name": "select_region", "content": "Specify whether to select the grabbing area graphically using the pointer. A value of 1\nprompts the user to select the grabbing area graphically by clicking and dragging. A\nsingle click with no dragging will select the whole screen. A region with zero width or\nheight will also select the whole screen. This option overwrites the videosize, grabx,\nand graby options. Default value is 0.\n" }, { "name": "draw_mouse", "content": "Specify whether to draw the mouse pointer. A value of 0 specifies not to draw the\npointer. Default value is 1.\n" }, { "name": "follow_mouse", "content": "Make the grabbed area follow the mouse. The argument can be \"centered\" or a number of\npixels PIXELS.\n\nWhen it is specified with \"centered\", the grabbing region follows the mouse pointer and\nkeeps the pointer at the center of region; otherwise, the region follows only when the\nmouse pointer reaches within PIXELS (greater than zero) to the edge of region.\n\nFor example:\n\nffmpeg -f x11grab -followmouse centered -framerate 25 -videosize cif -i :0.0 out.mpg\n\nTo follow only when the mouse pointer reaches within 100 pixels to edge:\n\nffmpeg -f x11grab -followmouse 100 -framerate 25 -videosize cif -i :0.0 out.mpg\n" }, { "name": "framerate", "content": "Set the grabbing frame rate. Default value is \"ntsc\", corresponding to a frame rate of\n\"30000/1001\".\n" }, { "name": "show_region", "content": "Show grabbed region on screen.\n\nIf showregion is specified with 1, then the grabbing region will be indicated on screen.\nWith this option, it is easy to know what is being grabbed if only a portion of the\nscreen is grabbed.\n" }, { "name": "region_border", "content": "Set the region border thickness if -showregion 1 is used. Range is 1 to 128 and default\nis 3 (XCB-based x11grab only).\n\nFor example:\n\nffmpeg -f x11grab -showregion 1 -framerate 25 -videosize cif -i :0.0+10,20 out.mpg\n\nWith followmouse:\n\nffmpeg -f x11grab -followmouse centered -showregion 1 -framerate 25 -videosize cif -i :0.0 out.mpg\n" }, { "name": "window_id", "content": "Grab this window, instead of the whole screen. Default value is 0, which maps to the\nwhole screen (root window).\n\nThe id of a window can be found using the xwininfo program, possibly with options -tree\nand -root.\n\nIf the window is later enlarged, the new area is not recorded. Video ends when the window\nis closed, unmapped (i.e., iconified) or shrunk beyond the video size (which defaults to\nthe initial window size).\n\nThis option disables options followmouse and selectregion.\n" }, { "name": "video_size", "content": "Set the video frame size. Default is the full desktop or window.\n" }, { "name": "grab_x", "content": "" }, { "name": "grab_y", "content": "Set the grabbing region coordinates. They are expressed as offset from the top left\ncorner of the X11 window and correspond to the xoffset and yoffset parameters in the\ndevice name. The default value for both options is 0.\n" } ] }, "OUTPUT DEVICES": { "content": "Output devices are configured elements in FFmpeg that can write multimedia data to an output\ndevice attached to your system.\n\nWhen you configure your FFmpeg build, all the supported output devices are enabled by\ndefault. You can list all available ones using the configure option \"--list-outdevs\".\n\nYou can disable all the output devices using the configure option \"--disable-outdevs\", and\nselectively enable an output device using the option \"--enable-outdev=OUTDEV\", or you can\ndisable a particular input device using the option \"--disable-outdev=OUTDEV\".\n\nThe option \"-devices\" of the ff* tools will display the list of enabled output devices.\n\nA description of the currently available output devices follows.\n", "subsections": [ { "name": "alsa", "content": "ALSA (Advanced Linux Sound Architecture) output device.\n\nExamples\n\n• Play a file on default ALSA device:\n\nffmpeg -i INPUT -f alsa default\n\n• Play a file on soundcard 1, audio device 7:\n\nffmpeg -i INPUT -f alsa hw:1,7\n" }, { "name": "AudioToolbox", "content": "AudioToolbox output device.\n\nAllows native output to CoreAudio devices on OSX.\n\nThe output filename can be empty (or \"-\") to refer to the default system output device or a\nnumber that refers to the device index as shown using: \"-listdevices true\".\n\nAlternatively, the audio input device can be chosen by index using the\n\nB<-audiodeviceindex EINDEXE>\n\n, overriding any device name or index given in the input filename.\n\nAll available devices can be enumerated by using -listdevices true, listing all device\nnames, UIDs and corresponding indices.\n\nOptions\n\nAudioToolbox supports the following options:\n" }, { "name": "-audio_device_index ", "content": "Specify the audio device by its index. Overrides anything given in the output filename.\n\nExamples\n\n• Print the list of supported devices and output a sine wave to the default device:\n\n$ ffmpeg -f lavfi -i sine=r=44100 -f audiotoolbox -listdevices true -\n\n• Output a sine wave to the device with the index 2, overriding any output filename:\n\n$ ffmpeg -f lavfi -i sine=r=44100 -f audiotoolbox -audiodeviceindex 2 -\n" }, { "name": "caca", "content": "CACA output device.\n\nThis output device allows one to show a video stream in CACA window. Only one CACA window is\nallowed per application, so you can have only one instance of this output device in an\napplication.\n\nTo enable this output device you need to configure FFmpeg with \"--enable-libcaca\". libcaca\nis a graphics library that outputs text instead of pixels.\n\nFor more information about libcaca, check: \n\nOptions\n" }, { "name": "window_title", "content": "Set the CACA window title, if not specified default to the filename specified for the\noutput device.\n" }, { "name": "window_size", "content": "Set the CACA window size, can be a string of the form widthxheight or a video size\nabbreviation. If not specified it defaults to the size of the input video.\n" }, { "name": "driver", "content": "Set display driver.\n" }, { "name": "algorithm", "content": "Set dithering algorithm. Dithering is necessary because the picture being rendered has\nusually far more colours than the available palette. The accepted values are listed with\n\"-listdither algorithms\".\n" }, { "name": "antialias", "content": "Set antialias method. Antialiasing smoothens the rendered image and avoids the commonly\nseen staircase effect. The accepted values are listed with \"-listdither antialiases\".\n" }, { "name": "charset", "content": "Set which characters are going to be used when rendering text. The accepted values are\nlisted with \"-listdither charsets\".\n" }, { "name": "color", "content": "Set color to be used when rendering text. The accepted values are listed with\n\"-listdither colors\".\n" }, { "name": "list_drivers", "content": "If set to true, print a list of available drivers and exit.\n" }, { "name": "list_dither", "content": "List available dither options related to the argument. The argument must be one of\n\"algorithms\", \"antialiases\", \"charsets\", \"colors\".\n\nExamples\n\n• The following command shows the ffmpeg output is an CACA window, forcing its size to\n80x25:\n\nffmpeg -i INPUT -c:v rawvideo -pixfmt rgb24 -windowsize 80x25 -f caca -\n\n• Show the list of available drivers and exit:\n\nffmpeg -i INPUT -pixfmt rgb24 -f caca -listdrivers true -\n\n• Show the list of available dither colors and exit:\n\nffmpeg -i INPUT -pixfmt rgb24 -f caca -listdither colors -\n" }, { "name": "decklink", "content": "The decklink output device provides playback capabilities for Blackmagic DeckLink devices.\n\nTo enable this output device, you need the Blackmagic DeckLink SDK and you need to configure\nwith the appropriate \"--extra-cflags\" and \"--extra-ldflags\". On Windows, you need to run the\nIDL files through widl.\n\nDeckLink is very picky about the formats it supports. Pixel format is always uyvy422,\nframerate, field order and video size must be determined for your device with -listformats\n1. Audio sample rate is always 48 kHz.\n\nOptions\n" }, { "name": "list_devices", "content": "If set to true, print a list of devices and exit. Defaults to false. This option is\ndeprecated, please use the \"-sinks\" option of ffmpeg to list the available output\ndevices.\n" }, { "name": "list_formats", "content": "If set to true, print a list of supported formats and exit. Defaults to false.\n" }, { "name": "preroll", "content": "Amount of time to preroll video in seconds. Defaults to 0.5.\n" }, { "name": "duplex_mode", "content": "Sets the decklink device duplex/profile mode. Must be unset, half, full,\nonesubdevicefull, onesubdevicehalf, twosubdevicefull, foursubdevicehalf\nDefaults to unset.\n\nNote: DeckLink SDK 11.0 have replaced the duplex property by a profile property. For the\nDeckLink Duo 2 and DeckLink Quad 2, a profile is shared between any 2 sub-devices that\nutilize the same connectors. For the DeckLink 8K Pro, a profile is shared between all 4\nsub-devices. So DeckLink 8K Pro support four profiles.\n\nValid profile modes for DeckLink 8K Pro(with DeckLink SDK >= 11.0): onesubdevicefull,\nonesubdevicehalf, twosubdevicefull, foursubdevicehalf\n\nValid profile modes for DeckLink Quad 2 and DeckLink Duo 2: half, full\n" }, { "name": "timing_offset", "content": "Sets the genlock timing pixel offset on the used output. Defaults to unset.\n" }, { "name": "link", "content": "Sets the SDI video link configuration on the used output. Must be unset, single link SDI,\ndual link SDI or quad link SDI. Defaults to unset.\n\nsqd Enable Square Division Quad Split mode for Quad-link SDI output. Must be unset, true or\nfalse. Defaults to unset.\n" }, { "name": "level_a", "content": "Enable SMPTE Level A mode on the used output. Must be unset, true or false. Defaults to\nunset.\n" }, { "name": "vanc_queue_size", "content": "Sets maximum output buffer size in bytes for VANC data. If the buffering reaches this\nvalue, outgoing VANC data will be dropped. Defaults to 1048576.\n\nExamples\n\n• List output devices:\n\nffmpeg -sinks decklink\n\n• List supported formats:\n\nffmpeg -i test.avi -f decklink -listformats 1 'DeckLink Mini Monitor'\n\n• Play video clip:\n\nffmpeg -i test.avi -f decklink -pixfmt uyvy422 'DeckLink Mini Monitor'\n\n• Play video clip with non-standard framerate or video size:\n\nffmpeg -i test.avi -f decklink -pixfmt uyvy422 -s 720x486 -r 24000/1001 'DeckLink Mini Monitor'\n" }, { "name": "fbdev", "content": "Linux framebuffer output device.\n\nThe Linux framebuffer is a graphic hardware-independent abstraction layer to show graphics on\na computer monitor, typically on the console. It is accessed through a file device node,\nusually /dev/fb0.\n\nFor more detailed information read the file Documentation/fb/framebuffer.txt included in the\nLinux source tree.\n\nOptions\n" }, { "name": "xoffset", "content": "" }, { "name": "yoffset", "content": "Set x/y coordinate of top left corner. Default is 0.\n\nExamples\n\nPlay a file on framebuffer device /dev/fb0. Required pixel format depends on current\nframebuffer settings.\n\nffmpeg -re -i INPUT -c:v rawvideo -pixfmt bgra -f fbdev /dev/fb0\n\nSee also , and fbset(1).\n" }, { "name": "opengl", "content": "OpenGL output device.\n\nTo enable this output device you need to configure FFmpeg with \"--enable-opengl\".\n\nThis output device allows one to render to OpenGL context. Context may be provided by\napplication or default SDL window is created.\n\nWhen device renders to external context, application must implement handlers for following\nmessages: \"AVDEVTOAPPCREATEWINDOWBUFFER\" - create OpenGL context on current thread.\n\"AVDEVTOAPPPREPAREWINDOWBUFFER\" - make OpenGL context current.\n\"AVDEVTOAPPDISPLAYWINDOWBUFFER\" - swap buffers. \"AVDEVTOAPPDESTROYWINDOWBUFFER\"\n- destroy OpenGL context. Application is also required to inform a device about current\nresolution by sending \"AVAPPTODEVWINDOWSIZE\" message.\n\nOptions\n" }, { "name": "background", "content": "Set background color. Black is a default.\n" }, { "name": "no_window", "content": "Disables default SDL window when set to non-zero value. Application must provide OpenGL\ncontext and both \"windowsizecb\" and \"windowswapbufferscb\" callbacks when set.\n" }, { "name": "window_title", "content": "Set the SDL window title, if not specified default to the filename specified for the\noutput device. Ignored when nowindow is set.\n" }, { "name": "window_size", "content": "Set preferred window size, can be a string of the form widthxheight or a video size\nabbreviation. If not specified it defaults to the size of the input video, downscaled\naccording to the aspect ratio. Mostly usable when nowindow is not set.\n\nExamples\n\nPlay a file on SDL window using OpenGL rendering:\n\nffmpeg -i INPUT -f opengl \"window title\"\n" }, { "name": "oss", "content": "OSS (Open Sound System) output device.\n" }, { "name": "pulse", "content": "PulseAudio output device.\n\nTo enable this output device you need to configure FFmpeg with \"--enable-libpulse\".\n\nMore information about PulseAudio can be found on \n\nOptions\n" }, { "name": "server", "content": "Connect to a specific PulseAudio server, specified by an IP address. Default server is\nused when not provided.\n" }, { "name": "name", "content": "Specify the application name PulseAudio will use when showing active clients, by default\nit is the \"LIBAVFORMATIDENT\" string.\n" }, { "name": "stream_name", "content": "Specify the stream name PulseAudio will use when showing active streams, by default it is\nset to the specified output name.\n" }, { "name": "device", "content": "Specify the device to use. Default device is used when not provided. List of output\ndevices can be obtained with command pactl list sinks.\n" }, { "name": "buffer_size", "content": "" }, { "name": "buffer_duration", "content": "Control the size and duration of the PulseAudio buffer. A small buffer gives more\ncontrol, but requires more frequent updates.\n\nbuffersize specifies size in bytes while bufferduration specifies duration in\nmilliseconds.\n\nWhen both options are provided then the highest value is used (duration is recalculated\nto bytes using stream parameters). If they are set to 0 (which is default), the device\nwill use the default PulseAudio duration value. By default PulseAudio set buffer duration\nto around 2 seconds.\n" }, { "name": "prebuf", "content": "Specify pre-buffering size in bytes. The server does not start with playback before at\nleast prebuf bytes are available in the buffer. By default this option is initialized to\nthe same value as buffersize or bufferduration (whichever is bigger).\n" }, { "name": "minreq", "content": "Specify minimum request size in bytes. The server does not request less than minreq bytes\nfrom the client, instead waits until the buffer is free enough to request more bytes at\nonce. It is recommended to not set this option, which will initialize this to a value\nthat is deemed sensible by the server.\n\nExamples\n\nPlay a file on default device on default server:\n\nffmpeg -i INPUT -f pulse \"stream name\"\n" }, { "name": "sdl", "content": "SDL (Simple DirectMedia Layer) output device.\n\n\"sdl2\" can be used as alias for \"sdl\".\n\nThis output device allows one to show a video stream in an SDL window. Only one SDL window is\nallowed per application, so you can have only one instance of this output device in an\napplication.\n\nTo enable this output device you need libsdl installed on your system when configuring your\nbuild.\n\nFor more information about SDL, check: \n\nOptions\n" }, { "name": "window_borderless", "content": "Set SDL window border off. Default value is 0 (enable window border).\n" }, { "name": "window_enable_quit", "content": "Enable quit action (using window button or keyboard key) when non-zero value is provided.\nDefault value is 1 (enable quit action).\n" }, { "name": "window_fullscreen", "content": "Set fullscreen mode when non-zero value is provided. Default value is zero.\n" }, { "name": "window_size", "content": "Set the SDL window size, can be a string of the form widthxheight or a video size\nabbreviation. If not specified it defaults to the size of the input video, downscaled\naccording to the aspect ratio.\n" }, { "name": "window_title", "content": "Set the SDL window title, if not specified default to the filename specified for the\noutput device.\n" }, { "name": "window_x", "content": "" }, { "name": "window_y", "content": "Set the position of the window on the screen.\n\nInteractive commands\n\nThe window created by the device can be controlled through the following interactive\ncommands.\n" }, { "name": "q, ESC", "content": "Quit the device immediately.\n\nExamples\n\nThe following command shows the ffmpeg output is an SDL window, forcing its size to the qcif\nformat:\n\nffmpeg -i INPUT -c:v rawvideo -pixfmt yuv420p -windowsize qcif -f sdl \"SDL output\"\n" }, { "name": "sndio", "content": "sndio audio output device.\n" }, { "name": "v4l2", "content": "Video4Linux2 output device.\n\nxv\nXV (XVideo) output device.\n\nThis output device allows one to show a video stream in a X Window System window.\n\nOptions\n" }, { "name": "display_name", "content": "Specify the hardware display name, which determines the display and communications domain\nto be used.\n\nThe display name or DISPLAY environment variable can be a string in the format\nhostname[:number[.screennumber]].\n\nhostname specifies the name of the host machine on which the display is physically\nattached. number specifies the number of the display server on that host machine.\nscreennumber specifies the screen to be used on that server.\n\nIf unspecified, it defaults to the value of the DISPLAY environment variable.\n\nFor example, \"dual-headed:0.1\" would specify screen 1 of display 0 on the machine named\n``dual-headed''.\n\nCheck the X11 specification for more detailed information about the display name format.\n" }, { "name": "window_id", "content": "When set to non-zero value then device doesn't create new window, but uses existing one\nwith provided windowid. By default this options is set to zero and device creates its\nown window.\n" }, { "name": "window_size", "content": "Set the created window size, can be a string of the form widthxheight or a video size\nabbreviation. If not specified it defaults to the size of the input video. Ignored when\nwindowid is set.\n" }, { "name": "window_x", "content": "" }, { "name": "window_y", "content": "Set the X and Y window offsets for the created window. They are both set to 0 by default.\nThe values may be ignored by the window manager. Ignored when windowid is set.\n" }, { "name": "window_title", "content": "Set the window title, if not specified default to the filename specified for the output\ndevice. Ignored when windowid is set.\n\nFor more information about XVideo see .\n\nExamples\n\n• Decode, display and encode video input with ffmpeg at the same time:\n\nffmpeg -i INPUT OUTPUT -f xv display\n\n• Decode and display the input video to multiple X11 windows:\n\nffmpeg -i INPUT -f xv normal -vf negate -f xv negated\n" } ] }, "SEE ALSO": { "content": "ffmpeg(1), ffplay(1), ffprobe(1), libavdevice(3)\n", "subsections": [] }, "AUTHORS": { "content": "The FFmpeg developers.\n\nFor details about the authorship, see the Git history of the project\n(https://git.ffmpeg.org/ffmpeg), e.g. by typing the command git log in the FFmpeg source\ndirectory, or browsing the online repository at .\n\nMaintainers for the specific components are listed in the file MAINTAINERS in the source code\ntree.\n\nFFMPEG-DEVICES(1)", "subsections": [] } } } }