{ "mode": "man", "parameter": "ffplay-all", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/ffplay-all/1/json", "generated": "2026-10-24T12:09:26Z", "synopsis": "ffplay [options] [inputurl]", "sections": { "NAME": { "content": "ffplay - FFplay media player\n", "subsections": [] }, "SYNOPSIS": { "content": "ffplay [options] [inputurl]\n", "subsections": [] }, "DESCRIPTION": { "content": "FFplay is a very simple and portable media player using the FFmpeg libraries and the SDL\nlibrary. It is mostly used as a testbed for the various FFmpeg APIs.\n", "subsections": [] }, "OPTIONS": { "content": "All the numerical options, if not specified otherwise, accept a string representing a number\nas input, which may be followed by one of the SI unit prefixes, for example: 'K', 'M', or\n'G'.\n\nIf 'i' is appended to the SI unit prefix, the complete prefix will be interpreted as a unit\nprefix for binary multiples, which are based on powers of 1024 instead of powers of 1000.\nAppending 'B' to the SI unit prefix multiplies the value by 8. This allows using, for\nexample: 'KB', 'MiB', 'G' and 'B' as number suffixes.\n\nOptions which do not take arguments are boolean options, and set the corresponding value to\ntrue. They can be set to false by prefixing the option name with \"no\". For example using\n\"-nofoo\" will set the boolean option with name \"foo\" to false.\n", "subsections": [ { "name": "Stream specifiers", "content": "Some options are applied per-stream, e.g. bitrate or codec. Stream specifiers are used to\nprecisely specify which stream(s) a given option belongs to.\n\nA stream specifier is a string generally appended to the option name and separated from it by\na colon. E.g. \"-codec:a:1 ac3\" contains the \"a:1\" stream specifier, which matches the second\naudio stream. Therefore, it would select the ac3 codec for the second audio stream.\n\nA stream specifier can match several streams, so that the option is applied to all of them.\nE.g. the stream specifier in \"-b:a 128k\" matches all audio streams.\n\nAn empty stream specifier matches all streams. For example, \"-codec copy\" or \"-codec: copy\"\nwould copy all the streams without reencoding.\n\nPossible forms of stream specifiers are:\n\nstreamindex\nMatches the stream with this index. E.g. \"-threads:1 4\" would set the thread count for\nthe second stream to 4. If streamindex is used as an additional stream specifier (see\nbelow), then it selects stream number streamindex from the matching streams. Stream\nnumbering is based on the order of the streams as detected by libavformat except when a\nprogram ID is also specified. In this case it is based on the ordering of the streams in\nthe program.\n\nstreamtype[:additionalstreamspecifier]\nstreamtype is one of following: 'v' or 'V' for video, 'a' for audio, 's' for subtitle,\n'd' for data, and 't' for attachments. 'v' matches all video streams, 'V' only matches\nvideo streams which are not attached pictures, video thumbnails or cover arts. If\nadditionalstreamspecifier is used, then it matches streams which both have this type\nand match the additionalstreamspecifier. Otherwise, it matches all streams of the\nspecified type.\n\np:programid[:additionalstreamspecifier]\nMatches streams which are in the program with the id programid. If\nadditionalstreamspecifier is used, then it matches streams which both are part of the\nprogram and match the additionalstreamspecifier.\n\n#streamid or i:streamid\nMatch the stream by stream id (e.g. PID in MPEG-TS container).\n\nm:key[:value]\nMatches streams with the metadata tag key having the specified value. If value is not\ngiven, matches streams that contain the given tag with any value.\n\nu Matches streams with usable configuration, the codec must be defined and the essential\ninformation such as video dimension or audio sample rate must be present.\n\nNote that in ffmpeg, matching by metadata will only work properly for input files.\n" }, { "name": "Generic options", "content": "These options are shared amongst the ff* tools.\n" }, { "name": "-L", "content": "", "flag": "-L" }, { "name": "-h, -?, -help, --help [_", "content": "Show help. An optional parameter may be specified to print help about a specific item. If\nno argument is specified, only basic (non advanced) tool options are shown.\n\nPossible values of arg are:\n\nlong\nPrint advanced tool options in addition to the basic tool options.\n\nfull\nPrint complete list of options, including shared and private options for encoders,\ndecoders, demuxers, muxers, filters, etc.\n\ndecoder=decodername\nPrint detailed information about the decoder named decodername. Use the -decoders\noption to get a list of all decoders.\n\nencoder=encodername\nPrint detailed information about the encoder named encodername. Use the -encoders\noption to get a list of all encoders.\n\ndemuxer=demuxername\nPrint detailed information about the demuxer named demuxername. Use the -formats\noption to get a list of all demuxers and muxers.\n\nmuxer=muxername\nPrint detailed information about the muxer named muxername. Use the -formats option\nto get a list of all muxers and demuxers.\n\nfilter=filtername\nPrint detailed information about the filter named filtername. Use the -filters\noption to get a list of all filters.\n\nbsf=bitstreamfiltername\nPrint detailed information about the bitstream filter named bitstreamfiltername.\nUse the -bsfs option to get a list of all bitstream filters.\n\nprotocol=protocolname\nPrint detailed information about the protocol named protocolname. Use the\n-protocols option to get a list of all protocols.\n", "flag": "-?", "long": "--help" }, { "name": "-version", "content": "Show version.\n" }, { "name": "-buildconf", "content": "Show the build configuration, one option per line.\n" }, { "name": "-formats", "content": "Show available formats (including devices).\n" }, { "name": "-demuxers", "content": "Show available demuxers.\n" }, { "name": "-muxers", "content": "Show available muxers.\n" }, { "name": "-devices", "content": "Show available devices.\n" }, { "name": "-codecs", "content": "Show all codecs known to libavcodec.\n\nNote that the term 'codec' is used throughout this documentation as a shortcut for what\nis more correctly called a media bitstream format.\n" }, { "name": "-decoders", "content": "Show available decoders.\n" }, { "name": "-encoders", "content": "Show all available encoders.\n" }, { "name": "-bsfs", "content": "Show available bitstream filters.\n" }, { "name": "-protocols", "content": "Show available protocols.\n" }, { "name": "-filters", "content": "Show available libavfilter filters.\n" }, { "name": "-pix_fmts", "content": "Show available pixel formats.\n" }, { "name": "-sample_fmts", "content": "Show available sample formats.\n" }, { "name": "-layouts", "content": "Show channel names and standard channel layouts.\n" }, { "name": "-dispositions", "content": "Show stream dispositions.\n" }, { "name": "-colors", "content": "Show recognized color names.\n" }, { "name": "-sources _", "content": "Show autodetected sources of the input device. Some devices may provide system-dependent\nsource names that cannot be autodetected. The returned list cannot be assumed to be\nalways complete.\n\nffmpeg -sources pulse,server=192.168.0.4\n" }, { "name": "-sinks _", "content": "Show autodetected sinks of the output device. Some devices may provide system-dependent\nsink names that cannot be autodetected. The returned list cannot be assumed to be always\ncomplete.\n\nffmpeg -sinks pulse,server=192.168.0.4\n" }, { "name": "-loglevel [_", "content": "Set logging level and flags used by the library.\n\nThe optional flags prefix can consist of the following values:\n\nrepeat\nIndicates that repeated log output should not be compressed to the first line and the\n\"Last message repeated n times\" line will be omitted.\n\nlevel\nIndicates that log output should add a \"[level]\" prefix to each message line. This\ncan be used as an alternative to log coloring, e.g. when dumping the log to file.\n\nFlags can also be used alone by adding a '+'/'-' prefix to set/reset a single flag\nwithout affecting other flags or changing loglevel. When setting both flags and loglevel,\na '+' separator is expected between the last flags value and before loglevel.\n\nloglevel is a string or a number containing one of the following values:\n\nquiet, -8\nShow nothing at all; be silent.\n\npanic, 0\nOnly show fatal errors which could lead the process to crash, such as an assertion\nfailure. This is not currently used for anything.\n\nfatal, 8\nOnly show fatal errors. These are errors after which the process absolutely cannot\ncontinue.\n\nerror, 16\nShow all errors, including ones which can be recovered from.\n\nwarning, 24\nShow all warnings and errors. Any message related to possibly incorrect or unexpected\nevents will be shown.\n\ninfo, 32\nShow informative messages during processing. This is in addition to warnings and\nerrors. This is the default value.\n\nverbose, 40\nSame as \"info\", except more verbose.\n\ndebug, 48\nShow everything, including debugging information.\n\ntrace, 56\n\nFor example to enable repeated log output, add the \"level\" prefix, and set loglevel to\n\"verbose\":\n\nffmpeg -loglevel repeat+level+verbose -i input output\n\nAnother example that enables repeated log output without affecting current state of\n\"level\" prefix flag or loglevel:\n\nffmpeg [...] -loglevel +repeat\n\nBy default the program logs to stderr. If coloring is supported by the terminal, colors\nare used to mark errors and warnings. Log coloring can be disabled setting the\nenvironment variable AVLOGFORCENOCOLOR, or can be forced setting the environment\nvariable AVLOGFORCECOLOR.\n" }, { "name": "-report", "content": "Dump full command line and log output to a file named \"program-YYYYMMDD-HHMMSS.log\" in\nthe current directory. This file can be useful for bug reports. It also implies\n\"-loglevel debug\".\n\nSetting the environment variable FFREPORT to any value has the same effect. If the value\nis a ':'-separated key=value sequence, these options will affect the report; option\nvalues must be escaped if they contain special characters or the options delimiter ':'\n(see the ``Quoting and escaping'' section in the ffmpeg-utils manual).\n\nThe following options are recognized:\n\nfile\nset the file name to use for the report; %p is expanded to the name of the program,\n%t is expanded to a timestamp, \"%%\" is expanded to a plain \"%\"\n\nlevel\nset the log verbosity level using a numerical value (see \"-loglevel\").\n\nFor example, to output a report to a file named ffreport.log using a log level of 32\n(alias for log level \"info\"):\n\nFFREPORT=file=ffreport.log:level=32 ffmpeg -i input output\n\nErrors in parsing the environment variable are not fatal, and will not appear in the\nreport.\n" }, { "name": "-hide_banner", "content": "Suppress printing banner.\n\nAll FFmpeg tools will normally show a copyright notice, build options and library\nversions. This option can be used to suppress printing this information.\n" }, { "name": "-cpuflags flags (_", "content": "Allows setting and clearing cpu flags. This option is intended for testing. Do not use it\nunless you know what you're doing.\n\nffmpeg -cpuflags -sse+mmx ...\nffmpeg -cpuflags mmx ...\nffmpeg -cpuflags 0 ...\n\nPossible flags for this option are:\n\nx86\nmmx\nmmxext\nsse\nsse2\nsse2slow\nsse3\nsse3slow\nssse3\natom\nsse4.1\nsse4.2\navx\navx2\nxop\nfma3\nfma4\n3dnow\n3dnowext\nbmi1\nbmi2\ncmov\nARM\narmv5te\narmv6\narmv6t2\nvfp\nvfpv3\nneon\nsetend\nAArch64\narmv8\nvfp\nneon\nPowerPC\naltivec\nSpecific Processors\npentium2\npentium3\npentium4\nk6\nk62\nathlon\nathlonxp\nk8" }, { "name": "-cpucount _", "content": "Override detection of CPU count. This option is intended for testing. Do not use it\nunless you know what you're doing.\n\nffmpeg -cpucount 2\n" }, { "name": "-max_alloc _", "content": "Set the maximum size limit for allocating a block on the heap by ffmpeg's family of\nmalloc functions. Exercise extreme caution when using this option. Don't use if you do\nnot understand the full consequence of doing so. Default is INTMAX.\n" }, { "name": "AVOptions", "content": "These options are provided directly by the libavformat, libavdevice and libavcodec libraries.\nTo see the list of available AVOptions, use the -help option. They are separated into two\ncategories:\n" }, { "name": "generic", "content": "These options can be set for any container, codec or device. Generic options are listed\nunder AVFormatContext options for containers/devices and under AVCodecContext options for\ncodecs.\n" }, { "name": "private", "content": "These options are specific to the given container, device or codec. Private options are\nlisted under their corresponding containers/devices/codecs.\n\nFor example to write an ID3v2.3 header instead of a default ID3v2.4 to an MP3 file, use the\nid3v2version private option of the MP3 muxer:\n\nffmpeg -i input.flac -id3v2version 3 out.mp3\n\nAll codec AVOptions are per-stream, and thus a stream specifier should be attached to them:\n\nffmpeg -i multichannel.mxf -map 0:v:0 -map 0:a:0 -map 0:a:0 -c:a:0 ac3 -b:a:0 640k -ac:a:1 2 -c:a:1 aac -b:2 128k out.mp4\n\nIn the above example, a multichannel audio stream is mapped twice for output. The first\ninstance is encoded with codec ac3 and bitrate 640k. The second instance is downmixed to 2\nchannels and encoded with codec aac. A bitrate of 128k is specified for it using absolute\nindex of the output stream.\n\nNote: the -nooption syntax cannot be used for boolean AVOptions, use -option 0/-option 1.\n\nNote: the old undocumented way of specifying per-stream AVOptions by prepending v/a/s to the\noptions name is now obsolete and will be removed soon.\n" }, { "name": "Main options", "content": "" }, { "name": "-x _", "content": "Force displayed width.\n", "flag": "-x" }, { "name": "-y _", "content": "Force displayed height.\n", "flag": "-y" }, { "name": "-fs", "content": "" }, { "name": "-an", "content": "" }, { "name": "-vn", "content": "" }, { "name": "-sn", "content": "" }, { "name": "-ss _", "content": "Seek to pos. Note that in most formats it is not possible to seek exactly, so ffplay will\nseek to the nearest seek point to pos.\n\npos must be a time duration specification, see the Time duration section in the\nffmpeg-utils(1) manual.\n" }, { "name": "-t _", "content": "Play duration seconds of audio/video.\n\nduration must be a time duration specification, see the Time duration section in the\nffmpeg-utils(1) manual.\n", "flag": "-t" }, { "name": "-bytes", "content": "Seek by bytes.\n" }, { "name": "-seek_interval", "content": "Set custom interval, in seconds, for seeking using left/right keys. Default is 10\nseconds.\n" }, { "name": "-nodisp", "content": "Disable graphical display.\n" }, { "name": "-noborder", "content": "Borderless window.\n" }, { "name": "-alwaysontop", "content": "Window always on top. Available on: X11 with SDL >= 2.0.5, Windows SDL >= 2.0.6.\n" }, { "name": "-volume", "content": "Set the startup volume. 0 means silence, 100 means no volume reduction or amplification.\nNegative values are treated as 0, values above 100 are treated as 100.\n" }, { "name": "-f _", "content": "Force format.\n", "flag": "-f" }, { "name": "-window_title _", "content": "Set window title (default is the input filename).\n" }, { "name": "-left _", "content": "Set the x position for the left of the window (default is a centered window).\n" }, { "name": "-top _", "content": "Set the y position for the top of the window (default is a centered window).\n" }, { "name": "-loop _", "content": "Loops movie playback times. 0 means forever.\n" }, { "name": "-showmode _", "content": "Set the show mode to use. Available values for mode are:\n\n0, video\nshow video\n\n1, waves\nshow audio waves\n\n2, rdft\nshow audio frequency band using RDFT ((Inverse) Real Discrete Fourier Transform)\n\nDefault value is \"video\", if video is not present or cannot be played \"rdft\" is\nautomatically selected.\n\nYou can interactively cycle through the available show modes by pressing the key w.\n" }, { "name": "-vf _", "content": "Create the filtergraph specified by filtergraph and use it to filter the video stream.\n\nfiltergraph is a description of the filtergraph to apply to the stream, and must have a\nsingle video input and a single video output. In the filtergraph, the input is associated\nto the label \"in\", and the output to the label \"out\". See the ffmpeg-filters manual for\nmore information about the filtergraph syntax.\n\nYou can specify this parameter multiple times and cycle through the specified\nfiltergraphs along with the show modes by pressing the key w.\n" }, { "name": "-af _", "content": "filtergraph is a description of the filtergraph to apply to the input audio. Use the\noption \"-filters\" to show all the available filters (including sources and sinks).\n" }, { "name": "-i _", "content": "Read inputurl.\n", "flag": "-i" }, { "name": "Advanced options", "content": "" }, { "name": "-stats", "content": "Print several playback statistics, in particular show the stream duration, the codec\nparameters, the current position in the stream and the audio/video synchronisation drift.\nIt is shown by default, unless the log level is lower than \"info\". Its display can be\nforced by manually specifying this option. To disable it, you need to specify \"-nostats\".\n" }, { "name": "-fast", "content": "Non-spec-compliant optimizations.\n" }, { "name": "-genpts", "content": "Generate pts.\n" }, { "name": "-sync _", "content": "Set the master clock to audio (\"type=audio\"), video (\"type=video\") or external\n(\"type=ext\"). Default is audio. The master clock is used to control audio-video\nsynchronization. Most media players use audio as master clock, but in some cases\n(streaming or high quality broadcast) it is necessary to change that. This option is\nmainly used for debugging purposes.\n" }, { "name": "-ast _", "content": "Select the desired audio stream using the given stream specifier. The stream specifiers\nare described in the Stream specifiers chapter. If this option is not specified, the\n\"best\" audio stream is selected in the program of the already selected video stream.\n" }, { "name": "-vst _", "content": "Select the desired video stream using the given stream specifier. The stream specifiers\nare described in the Stream specifiers chapter. If this option is not specified, the\n\"best\" video stream is selected.\n" }, { "name": "-sst _", "content": "Select the desired subtitle stream using the given stream specifier. The stream\nspecifiers are described in the Stream specifiers chapter. If this option is not\nspecified, the \"best\" subtitle stream is selected in the program of the already selected\nvideo or audio stream.\n" }, { "name": "-autoexit", "content": "Exit when video is done playing.\n" }, { "name": "-exitonkeydown", "content": "Exit if any key is pressed.\n" }, { "name": "-exitonmousedown", "content": "Exit if any mouse button is pressed.\n" }, { "name": "-codec:_", "content": "Force a specific decoder implementation for the stream identified by mediaspecifier,\nwhich can assume the values \"a\" (audio), \"v\" (video), and \"s\" subtitle.\n" }, { "name": "-acodec _", "content": "Force a specific audio decoder.\n" }, { "name": "-vcodec _", "content": "Force a specific video decoder.\n" }, { "name": "-scodec _", "content": "Force a specific subtitle decoder.\n" }, { "name": "-autorotate", "content": "Automatically rotate the video according to file metadata. Enabled by default, use\n-noautorotate to disable it.\n" }, { "name": "-framedrop", "content": "Drop video frames if video is out of sync. Enabled by default if the master clock is not\nset to video. Use this option to enable frame dropping for all master clock sources, use\n-noframedrop to disable it.\n" }, { "name": "-infbuf", "content": "Do not limit the input buffer size, read as much data as possible from the input as soon\nas possible. Enabled by default for realtime streams, where data may be dropped if not\nread in time. Use this option to enable infinite buffers for all inputs, use -noinfbuf to\ndisable it.\n" }, { "name": "-filter_threads _", "content": "Defines how many threads are used to process a filter pipeline. Each pipeline will\nproduce a thread pool with this many threads available for parallel processing. The\ndefault is 0 which means that the thread count will be determined by the number of\navailable CPUs.\n" }, { "name": "While playing", "content": "" }, { "name": "q, ESC", "content": "Quit.\n\nf Toggle full screen.\n" }, { "name": "p, SPC", "content": "Pause.\n\nm Toggle mute.\n" }, { "name": "9, 0", "content": "/, *\nDecrease and increase volume respectively.\n\na Cycle audio channel in the current program.\n\nv Cycle video channel.\n\nt Cycle subtitle channel in the current program.\n\nc Cycle program.\n\nw Cycle video filters or show modes.\n\ns Step to the next frame.\n\nPause if the stream is not already paused, step to the next video frame, and pause.\n" }, { "name": "left/right", "content": "Seek backward/forward 10 seconds.\n" }, { "name": "down/up", "content": "Seek backward/forward 1 minute.\n" }, { "name": "page down/page up", "content": "Seek to the previous/next chapter. or if there are no chapters Seek backward/forward 10\nminutes.\n" }, { "name": "right mouse click", "content": "Seek to percentage in file corresponding to fraction of width.\n" }, { "name": "left mouse double-click", "content": "Toggle full screen.\n" } ] }, "SYNTAX": { "content": "This section documents the syntax and formats employed by the FFmpeg libraries and tools.\n", "subsections": [ { "name": "Quoting and escaping", "content": "FFmpeg adopts the following quoting and escaping mechanism, unless explicitly specified. The\nfollowing rules are applied:\n\n• ' and \\ are special characters (respectively used for quoting and escaping). In addition\nto them, there might be other special characters depending on the specific syntax where\nthe escaping and quoting are employed.\n\n• A special character is escaped by prefixing it with a \\.\n\n• All characters enclosed between '' are included literally in the parsed string. The quote\ncharacter ' itself cannot be quoted, so you may need to close the quote and escape it.\n\n• Leading and trailing whitespaces, unless escaped or quoted, are removed from the parsed\nstring.\n\nNote that you may need to add a second level of escaping when using the command line or a\nscript, which depends on the syntax of the adopted shell language.\n\nThe function \"avgettoken\" defined in libavutil/avstring.h can be used to parse a token\nquoted or escaped according to the rules defined above.\n\nThe tool tools/ffescape in the FFmpeg source tree can be used to automatically quote or\nescape a string in a script.\n\nExamples\n\n• Escape the string \"Crime d'Amour\" containing the \"'\" special character:\n\nCrime d\\'Amour\n\n• The string above contains a quote, so the \"'\" needs to be escaped when quoting it:\n\n'Crime d'\\''Amour'\n\n• Include leading or trailing whitespaces using quoting:\n\n' this string starts and ends with whitespaces '\n\n• Escaping and quoting can be mixed together:\n\n' The string '\\'string\\'' is a string '\n\n• To include a literal \\ you can use either escaping or quoting:\n\n'c:\\foo' can be written as c:\\\\foo\n" }, { "name": "Date", "content": "The accepted syntax is:\n\n[(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...]]])|(HHMMSS[.m...]]]))[Z]\nnow\n\nIf the value is \"now\" it takes the current time.\n\nTime is local time unless Z is appended, in which case it is interpreted as UTC. If the\nyear-month-day part is not specified it takes the current year-month-day.\n" }, { "name": "Time duration", "content": "There are two accepted syntaxes for expressing time duration.\n\n[-][:]:[....]\n\nHH expresses the number of hours, MM the number of minutes for a maximum of 2 digits, and SS\nthe number of seconds for a maximum of 2 digits. The m at the end expresses decimal value for\nSS.\n\nor\n\n[-]+[....][s|ms|us]\n\nS expresses the number of seconds, with the optional decimal part m. The optional literal\nsuffixes s, ms or us indicate to interpret the value as seconds, milliseconds or\nmicroseconds, respectively.\n\nIn both expressions, the optional - indicates negative duration.\n\nExamples\n\nThe following examples are all valid time duration:\n\n55 55 seconds\n\n0.2 0.2 seconds\n" }, { "name": "200ms", "content": "200 milliseconds, that's 0.2s\n" }, { "name": "200000us", "content": "200000 microseconds, that's 0.2s\n" }, { "name": "12:03:45", "content": "12 hours, 03 minutes and 45 seconds\n" }, { "name": "23.189", "content": "23.189 seconds\n" }, { "name": "Video size", "content": "Specify the size of the sourced video, it may be a string of the form widthxheight, or the\nname of a size abbreviation.\n\nThe following abbreviations are recognized:\n" }, { "name": "ntsc", "content": "720x480\n\npal 720x576\n" }, { "name": "qntsc", "content": "352x240\n" }, { "name": "qpal", "content": "352x288\n" }, { "name": "sntsc", "content": "640x480\n" }, { "name": "spal", "content": "768x576\n" }, { "name": "film", "content": "352x240\n" }, { "name": "ntsc-film", "content": "352x240\n" }, { "name": "sqcif", "content": "128x96\n" }, { "name": "qcif", "content": "176x144\n\ncif 352x288\n" }, { "name": "4cif", "content": "704x576\n" }, { "name": "16cif", "content": "1408x1152\n" }, { "name": "qqvga", "content": "160x120\n" }, { "name": "qvga", "content": "320x240\n\nvga 640x480\n" }, { "name": "svga", "content": "800x600\n\nxga 1024x768\n" }, { "name": "uxga", "content": "1600x1200\n" }, { "name": "qxga", "content": "2048x1536\n" }, { "name": "sxga", "content": "1280x1024\n" }, { "name": "qsxga", "content": "2560x2048\n" }, { "name": "hsxga", "content": "5120x4096\n" }, { "name": "wvga", "content": "852x480\n" }, { "name": "wxga", "content": "1366x768\n" }, { "name": "wsxga", "content": "1600x1024\n" }, { "name": "wuxga", "content": "1920x1200\n" }, { "name": "woxga", "content": "2560x1600\n" }, { "name": "wqsxga", "content": "3200x2048\n" }, { "name": "wquxga", "content": "3840x2400\n" }, { "name": "whsxga", "content": "6400x4096\n" }, { "name": "whuxga", "content": "7680x4800\n\ncga 320x200\n\nega 640x350\n" }, { "name": "hd480", "content": "852x480\n" }, { "name": "hd720", "content": "1280x720\n" }, { "name": "hd1080", "content": "1920x1080\n\n2k 2048x1080\n" }, { "name": "2kflat", "content": "1998x1080\n" }, { "name": "2kscope", "content": "2048x858\n\n4k 4096x2160\n" }, { "name": "4kflat", "content": "3996x2160\n" }, { "name": "4kscope", "content": "4096x1716\n\nnhd 640x360\n" }, { "name": "hqvga", "content": "240x160\n" }, { "name": "wqvga", "content": "400x240\n" }, { "name": "fwqvga", "content": "432x240\n" }, { "name": "hvga", "content": "480x320\n\nqhd 960x540\n" }, { "name": "2kdci", "content": "2048x1080\n" }, { "name": "4kdci", "content": "4096x2160\n" }, { "name": "uhd2160", "content": "3840x2160\n" }, { "name": "uhd4320", "content": "7680x4320\n" }, { "name": "Video rate", "content": "Specify the frame rate of a video, expressed as the number of frames generated per second. It\nhas to be a string in the format frameratenum/framerateden, an integer number, a float\nnumber or a valid video frame rate abbreviation.\n\nThe following abbreviations are recognized:\n" }, { "name": "ntsc", "content": "30000/1001\n\npal 25/1\n" }, { "name": "qntsc", "content": "30000/1001\n" }, { "name": "qpal", "content": "25/1\n" }, { "name": "sntsc", "content": "30000/1001\n" }, { "name": "spal", "content": "25/1\n" }, { "name": "film", "content": "24/1\n" }, { "name": "ntsc-film", "content": "24000/1001\n" }, { "name": "Ratio", "content": "A ratio can be expressed as an expression, or in the form numerator:denominator.\n\nNote that a ratio with infinite (1/0) or negative value is considered valid, so you should\ncheck on the returned value if you want to exclude those values.\n\nThe undefined value can be expressed using the \"0:0\" string.\n" }, { "name": "Color", "content": "It can be the name of a color as defined below (case insensitive match) or a\n\"[0x|#]RRGGBB[AA]\" sequence, possibly followed by @ and a string representing the alpha\ncomponent.\n\nThe alpha component may be a string composed by \"0x\" followed by an hexadecimal number or a\ndecimal number between 0.0 and 1.0, which represents the opacity value (0x00 or 0.0 means\ncompletely transparent, 0xff or 1.0 completely opaque). If the alpha component is not\nspecified then 0xff is assumed.\n\nThe string random will result in a random color.\n\nThe following names of colors are recognized:\n" }, { "name": "AliceBlue", "content": "0xF0F8FF\n" }, { "name": "AntiqueWhite", "content": "0xFAEBD7\n" }, { "name": "Aqua", "content": "0x00FFFF\n" }, { "name": "Aquamarine", "content": "0x7FFFD4\n" }, { "name": "Azure", "content": "0xF0FFFF\n" }, { "name": "Beige", "content": "0xF5F5DC\n" }, { "name": "Bisque", "content": "0xFFE4C4\n" }, { "name": "Black", "content": "0x000000\n" }, { "name": "BlanchedAlmond", "content": "0xFFEBCD\n" }, { "name": "Blue", "content": "0x0000FF\n" }, { "name": "BlueViolet", "content": "0x8A2BE2\n" }, { "name": "Brown", "content": "0xA52A2A\n" }, { "name": "BurlyWood", "content": "0xDEB887\n" }, { "name": "CadetBlue", "content": "0x5F9EA0\n" }, { "name": "Chartreuse", "content": "0x7FFF00\n" }, { "name": "Chocolate", "content": "0xD2691E\n" }, { "name": "Coral", "content": "0xFF7F50\n" }, { "name": "CornflowerBlue", "content": "0x6495ED\n" }, { "name": "Cornsilk", "content": "0xFFF8DC\n" }, { "name": "Crimson", "content": "0xDC143C\n" }, { "name": "Cyan", "content": "0x00FFFF\n" }, { "name": "DarkBlue", "content": "0x00008B\n" }, { "name": "DarkCyan", "content": "0x008B8B\n" }, { "name": "DarkGoldenRod", "content": "0xB8860B\n" }, { "name": "DarkGray", "content": "0xA9A9A9\n" }, { "name": "DarkGreen", "content": "0x006400\n" }, { "name": "DarkKhaki", "content": "0xBDB76B\n" }, { "name": "DarkMagenta", "content": "0x8B008B\n" }, { "name": "DarkOliveGreen", "content": "0x556B2F\n" }, { "name": "Darkorange", "content": "0xFF8C00\n" }, { "name": "DarkOrchid", "content": "0x9932CC\n" }, { "name": "DarkRed", "content": "0x8B0000\n" }, { "name": "DarkSalmon", "content": "0xE9967A\n" }, { "name": "DarkSeaGreen", "content": "0x8FBC8F\n" }, { "name": "DarkSlateBlue", "content": "0x483D8B\n" }, { "name": "DarkSlateGray", "content": "0x2F4F4F\n" }, { "name": "DarkTurquoise", "content": "0x00CED1\n" }, { "name": "DarkViolet", "content": "0x9400D3\n" }, { "name": "DeepPink", "content": "0xFF1493\n" }, { "name": "DeepSkyBlue", "content": "0x00BFFF\n" }, { "name": "DimGray", "content": "0x696969\n" }, { "name": "DodgerBlue", "content": "0x1E90FF\n" }, { "name": "FireBrick", "content": "0xB22222\n" }, { "name": "FloralWhite", "content": "0xFFFAF0\n" }, { "name": "ForestGreen", "content": "0x228B22\n" }, { "name": "Fuchsia", "content": "0xFF00FF\n" }, { "name": "Gainsboro", "content": "0xDCDCDC\n" }, { "name": "GhostWhite", "content": "0xF8F8FF\n" }, { "name": "Gold", "content": "0xFFD700\n" }, { "name": "GoldenRod", "content": "0xDAA520\n" }, { "name": "Gray", "content": "0x808080\n" }, { "name": "Green", "content": "0x008000\n" }, { "name": "GreenYellow", "content": "0xADFF2F\n" }, { "name": "HoneyDew", "content": "0xF0FFF0\n" }, { "name": "HotPink", "content": "0xFF69B4\n" }, { "name": "IndianRed", "content": "0xCD5C5C\n" }, { "name": "Indigo", "content": "0x4B0082\n" }, { "name": "Ivory", "content": "0xFFFFF0\n" }, { "name": "Khaki", "content": "0xF0E68C\n" }, { "name": "Lavender", "content": "0xE6E6FA\n" }, { "name": "LavenderBlush", "content": "0xFFF0F5\n" }, { "name": "LawnGreen", "content": "0x7CFC00\n" }, { "name": "LemonChiffon", "content": "0xFFFACD\n" }, { "name": "LightBlue", "content": "0xADD8E6\n" }, { "name": "LightCoral", "content": "0xF08080\n" }, { "name": "LightCyan", "content": "0xE0FFFF\n" }, { "name": "LightGoldenRodYellow", "content": "0xFAFAD2\n" }, { "name": "LightGreen", "content": "0x90EE90\n" }, { "name": "LightGrey", "content": "0xD3D3D3\n" }, { "name": "LightPink", "content": "0xFFB6C1\n" }, { "name": "LightSalmon", "content": "0xFFA07A\n" }, { "name": "LightSeaGreen", "content": "0x20B2AA\n" }, { "name": "LightSkyBlue", "content": "0x87CEFA\n" }, { "name": "LightSlateGray", "content": "0x778899\n" }, { "name": "LightSteelBlue", "content": "0xB0C4DE\n" }, { "name": "LightYellow", "content": "0xFFFFE0\n" }, { "name": "Lime", "content": "0x00FF00\n" }, { "name": "LimeGreen", "content": "0x32CD32\n" }, { "name": "Linen", "content": "0xFAF0E6\n" }, { "name": "Magenta", "content": "0xFF00FF\n" }, { "name": "Maroon", "content": "0x800000\n" }, { "name": "MediumAquaMarine", "content": "0x66CDAA\n" }, { "name": "MediumBlue", "content": "0x0000CD\n" }, { "name": "MediumOrchid", "content": "0xBA55D3\n" }, { "name": "MediumPurple", "content": "0x9370D8\n" }, { "name": "MediumSeaGreen", "content": "0x3CB371\n" }, { "name": "MediumSlateBlue", "content": "0x7B68EE\n" }, { "name": "MediumSpringGreen", "content": "0x00FA9A\n" }, { "name": "MediumTurquoise", "content": "0x48D1CC\n" }, { "name": "MediumVioletRed", "content": "0xC71585\n" }, { "name": "MidnightBlue", "content": "0x191970\n" }, { "name": "MintCream", "content": "0xF5FFFA\n" }, { "name": "MistyRose", "content": "0xFFE4E1\n" }, { "name": "Moccasin", "content": "0xFFE4B5\n" }, { "name": "NavajoWhite", "content": "0xFFDEAD\n" }, { "name": "Navy", "content": "0x000080\n" }, { "name": "OldLace", "content": "0xFDF5E6\n" }, { "name": "Olive", "content": "0x808000\n" }, { "name": "OliveDrab", "content": "0x6B8E23\n" }, { "name": "Orange", "content": "0xFFA500\n" }, { "name": "OrangeRed", "content": "0xFF4500\n" }, { "name": "Orchid", "content": "0xDA70D6\n" }, { "name": "PaleGoldenRod", "content": "0xEEE8AA\n" }, { "name": "PaleGreen", "content": "0x98FB98\n" }, { "name": "PaleTurquoise", "content": "0xAFEEEE\n" }, { "name": "PaleVioletRed", "content": "0xD87093\n" }, { "name": "PapayaWhip", "content": "0xFFEFD5\n" }, { "name": "PeachPuff", "content": "0xFFDAB9\n" }, { "name": "Peru", "content": "0xCD853F\n" }, { "name": "Pink", "content": "0xFFC0CB\n" }, { "name": "Plum", "content": "0xDDA0DD\n" }, { "name": "PowderBlue", "content": "0xB0E0E6\n" }, { "name": "Purple", "content": "0x800080\n\nRed 0xFF0000\n" }, { "name": "RosyBrown", "content": "0xBC8F8F\n" }, { "name": "RoyalBlue", "content": "0x4169E1\n" }, { "name": "SaddleBrown", "content": "0x8B4513\n" }, { "name": "Salmon", "content": "0xFA8072\n" }, { "name": "SandyBrown", "content": "0xF4A460\n" }, { "name": "SeaGreen", "content": "0x2E8B57\n" }, { "name": "SeaShell", "content": "0xFFF5EE\n" }, { "name": "Sienna", "content": "0xA0522D\n" }, { "name": "Silver", "content": "0xC0C0C0\n" }, { "name": "SkyBlue", "content": "0x87CEEB\n" }, { "name": "SlateBlue", "content": "0x6A5ACD\n" }, { "name": "SlateGray", "content": "0x708090\n" }, { "name": "Snow", "content": "0xFFFAFA\n" }, { "name": "SpringGreen", "content": "0x00FF7F\n" }, { "name": "SteelBlue", "content": "0x4682B4\n\nTan 0xD2B48C\n" }, { "name": "Teal", "content": "0x008080\n" }, { "name": "Thistle", "content": "0xD8BFD8\n" }, { "name": "Tomato", "content": "0xFF6347\n" }, { "name": "Turquoise", "content": "0x40E0D0\n" }, { "name": "Violet", "content": "0xEE82EE\n" }, { "name": "Wheat", "content": "0xF5DEB3\n" }, { "name": "White", "content": "0xFFFFFF\n" }, { "name": "WhiteSmoke", "content": "0xF5F5F5\n" }, { "name": "Yellow", "content": "0xFFFF00\n" }, { "name": "YellowGreen", "content": "0x9ACD32\n" }, { "name": "Channel Layout", "content": "A channel layout specifies the spatial disposition of the channels in a multi-channel audio\nstream. To specify a channel layout, FFmpeg makes use of a special syntax.\n\nIndividual channels are identified by an id, as given by the table below:\n\nFL front left\n\nFR front right\n\nFC front center\n\nLFE low frequency\n\nBL back left\n\nBR back right\n\nFLC front left-of-center\n\nFRC front right-of-center\n\nBC back center\n\nSL side left\n\nSR side right\n\nTC top center\n\nTFL top front left\n\nTFC top front center\n\nTFR top front right\n\nTBL top back left\n\nTBC top back center\n\nTBR top back right\n\nDL downmix left\n\nDR downmix right\n\nWL wide left\n\nWR wide right\n\nSDL surround direct left\n\nSDR surround direct right\n\nLFE2\nlow frequency 2\n\nStandard channel layout compositions can be specified by using the following identifiers:\n" }, { "name": "mono", "content": "FC\n" }, { "name": "stereo", "content": "FL+FR\n\n2.1 FL+FR+LFE\n\n3.0 FL+FR+FC\n" }, { "name": "3.0(back)", "content": "FL+FR+BC\n\n4.0 FL+FR+FC+BC\n" }, { "name": "quad", "content": "FL+FR+BL+BR\n" }, { "name": "quad(side)", "content": "FL+FR+SL+SR\n\n3.1 FL+FR+FC+LFE\n\n5.0 FL+FR+FC+BL+BR\n" }, { "name": "5.0(side)", "content": "FL+FR+FC+SL+SR\n\n4.1 FL+FR+FC+LFE+BC\n\n5.1 FL+FR+FC+LFE+BL+BR\n" }, { "name": "5.1(side)", "content": "FL+FR+FC+LFE+SL+SR\n\n6.0 FL+FR+FC+BC+SL+SR\n" }, { "name": "6.0(front)", "content": "FL+FR+FLC+FRC+SL+SR\n" }, { "name": "3.1.2", "content": "FL+FR+FC+LFE+TFL+TFR\n" }, { "name": "hexagonal", "content": "FL+FR+FC+BL+BR+BC\n\n6.1 FL+FR+FC+LFE+BC+SL+SR\n\n6.1 FL+FR+FC+LFE+BL+BR+BC\n" }, { "name": "6.1(front)", "content": "FL+FR+LFE+FLC+FRC+SL+SR\n\n7.0 FL+FR+FC+BL+BR+SL+SR\n" }, { "name": "7.0(front)", "content": "FL+FR+FC+FLC+FRC+SL+SR\n\n7.1 FL+FR+FC+LFE+BL+BR+SL+SR\n" }, { "name": "7.1(wide)", "content": "FL+FR+FC+LFE+BL+BR+FLC+FRC\n" }, { "name": "7.1(wide-side)", "content": "FL+FR+FC+LFE+FLC+FRC+SL+SR\n" }, { "name": "5.1.2", "content": "FL+FR+FC+LFE+BL+BR+TFL+TFR\n" }, { "name": "octagonal", "content": "FL+FR+FC+BL+BR+BC+SL+SR\n" }, { "name": "cube", "content": "FL+FR+BL+BR+TFL+TFR+TBL+TBR\n" }, { "name": "5.1.4", "content": "FL+FR+FC+LFE+BL+BR+TFL+TFR+TBL+TBR\n" }, { "name": "7.1.2", "content": "FL+FR+FC+LFE+BL+BR+SL+SR+TFL+TFR\n" }, { "name": "7.1.4", "content": "FL+FR+FC+LFE+BL+BR+SL+SR+TFL+TFR+TBL+TBR\n" }, { "name": "hexadecagonal", "content": "FL+FR+FC+BL+BR+BC+SL+SR+WL+WR+TBL+TBR+TBC+TFC+TFL+TFR\n" }, { "name": "downmix", "content": "DL+DR\n" }, { "name": "22.2", "content": "FL+FR+FC+LFE+BL+BR+FLC+FRC+BC+SL+SR+TC+TFL+TFC+TFR+TBL+TBC+TBR+LFE2+TSL+TSR+BFC+BFL+BFR\n\nA custom channel layout can be specified as a sequence of terms, separated by '+'. Each term\ncan be:\n\n• the name of a single channel (e.g. FL, FR, FC, LFE, etc.), each optionally containing a\ncustom name after a '@', (e.g. FL@Left, FR@Right, FC@Center, LFE@LowFrequency, etc.)\n\nA standard channel layout can be specified by the following:\n\n• the name of a single channel (e.g. FL, FR, FC, LFE, etc.)\n\n• the name of a standard channel layout (e.g. mono, stereo, 4.0, quad, 5.0, etc.)\n\n• a number of channels, in decimal, followed by 'c', yielding the default channel layout\nfor that number of channels (see the function \"avchannellayoutdefault\"). Note that not\nall channel counts have a default layout.\n\n• a number of channels, in decimal, followed by 'C', yielding an unknown channel layout\nwith the specified number of channels. Note that not all channel layout specification\nstrings support unknown channel layouts.\n\n• a channel layout mask, in hexadecimal starting with \"0x\" (see the \"AVCH*\" macros in\nlibavutil/channellayout.h.\n\nBefore libavutil version 53 the trailing character \"c\" to specify a number of channels was\noptional, but now it is required, while a channel layout mask can also be specified as a\ndecimal number (if and only if not followed by \"c\" or \"C\").\n\nSee also the function \"avchannellayoutfromstring\" defined in libavutil/channellayout.h.\n" } ] }, "EXPRESSION EVALUATION": { "content": "When evaluating an arithmetic expression, FFmpeg uses an internal formula evaluator,\nimplemented through the libavutil/eval.h interface.\n\nAn expression may contain unary, binary operators, constants, and functions.\n\nTwo expressions expr1 and expr2 can be combined to form another expression \"expr1;expr2\".\nexpr1 and expr2 are evaluated in turn, and the new expression evaluates to the value of\nexpr2.\n\nThe following binary operators are available: \"+\", \"-\", \"*\", \"/\", \"^\".\n\nThe following unary operators are available: \"+\", \"-\".\n\nThe following functions are available:\n", "subsections": [ { "name": "abs(x)", "content": "Compute absolute value of x.\n" }, { "name": "acos(x)", "content": "Compute arccosine of x.\n" }, { "name": "asin(x)", "content": "Compute arcsine of x.\n" }, { "name": "atan(x)", "content": "Compute arctangent of x.\n" }, { "name": "atan2(x, y)", "content": "Compute principal value of the arc tangent of y/x.\n" }, { "name": "between(x, min, max)", "content": "Return 1 if x is greater than or equal to min and lesser than or equal to max, 0\notherwise.\n" }, { "name": "bitand(x, y)", "content": "" }, { "name": "bitor(x, y)", "content": "Compute bitwise and/or operation on x and y.\n\nThe results of the evaluation of x and y are converted to integers before executing the\nbitwise operation.\n\nNote that both the conversion to integer and the conversion back to floating point can\nlose precision. Beware of unexpected results for large numbers (usually 2^53 and larger).\n" }, { "name": "ceil(expr)", "content": "Round the value of expression expr upwards to the nearest integer. For example,\n\"ceil(1.5)\" is \"2.0\".\n" }, { "name": "clip(x, min, max)", "content": "Return the value of x clipped between min and max.\n" }, { "name": "cos(x)", "content": "Compute cosine of x.\n" }, { "name": "cosh(x)", "content": "Compute hyperbolic cosine of x.\n" }, { "name": "eq(x, y)", "content": "Return 1 if x and y are equivalent, 0 otherwise.\n" }, { "name": "exp(x)", "content": "Compute exponential of x (with base \"e\", the Euler's number).\n" }, { "name": "floor(expr)", "content": "Round the value of expression expr downwards to the nearest integer. For example,\n\"floor(-1.5)\" is \"-2.0\".\n" }, { "name": "gauss(x)", "content": "Compute Gauss function of x, corresponding to \"exp(-x*x/2) / sqrt(2*PI)\".\n" }, { "name": "gcd(x, y)", "content": "Return the greatest common divisor of x and y. If both x and y are 0 or either or both\nare less than zero then behavior is undefined.\n" }, { "name": "gt(x, y)", "content": "Return 1 if x is greater than y, 0 otherwise.\n" }, { "name": "gte(x, y)", "content": "Return 1 if x is greater than or equal to y, 0 otherwise.\n" }, { "name": "hypot(x, y)", "content": "This function is similar to the C function with the same name; it returns \"sqrt(x*x +\ny*y)\", the length of the hypotenuse of a right triangle with sides of length x and y, or\nthe distance of the point (x, y) from the origin.\n" }, { "name": "if(x, y)", "content": "Evaluate x, and if the result is non-zero return the result of the evaluation of y,\nreturn 0 otherwise.\n" }, { "name": "if(x, y, z)", "content": "Evaluate x, and if the result is non-zero return the evaluation result of y, otherwise\nthe evaluation result of z.\n" }, { "name": "ifnot(x, y)", "content": "Evaluate x, and if the result is zero return the result of the evaluation of y, return 0\notherwise.\n" }, { "name": "ifnot(x, y, z)", "content": "Evaluate x, and if the result is zero return the evaluation result of y, otherwise the\nevaluation result of z.\n" }, { "name": "isinf(x)", "content": "Return 1.0 if x is +/-INFINITY, 0.0 otherwise.\n" }, { "name": "isnan(x)", "content": "Return 1.0 if x is NAN, 0.0 otherwise.\n" }, { "name": "ld(var)", "content": "Load the value of the internal variable with number var, which was previously stored with\nst(var, expr). The function returns the loaded value.\n" }, { "name": "lerp(x, y, z)", "content": "Return linear interpolation between x and y by amount of z.\n" }, { "name": "log(x)", "content": "Compute natural logarithm of x.\n" }, { "name": "lt(x, y)", "content": "Return 1 if x is lesser than y, 0 otherwise.\n" }, { "name": "lte(x, y)", "content": "Return 1 if x is lesser than or equal to y, 0 otherwise.\n" }, { "name": "max(x, y)", "content": "Return the maximum between x and y.\n" }, { "name": "min(x, y)", "content": "Return the minimum between x and y.\n" }, { "name": "mod(x, y)", "content": "Compute the remainder of division of x by y.\n" }, { "name": "not(expr)", "content": "Return 1.0 if expr is zero, 0.0 otherwise.\n" }, { "name": "pow(x, y)", "content": "Compute the power of x elevated y, it is equivalent to \"(x)^(y)\".\n" }, { "name": "print(t)", "content": "" }, { "name": "print(t, l)", "content": "Print the value of expression t with loglevel l. If l is not specified then a default log\nlevel is used. Returns the value of the expression printed.\n\nPrints t with loglevel l\n" }, { "name": "random(x)", "content": "Return a pseudo random value between 0.0 and 1.0. x is the index of the internal variable\nwhich will be used to save the seed/state.\n" }, { "name": "root(expr, max)", "content": "Find an input value for which the function represented by expr with argument ld(0) is 0\nin the interval 0..max.\n\nThe expression in expr must denote a continuous function or the result is undefined.\n\nld(0) is used to represent the function input value, which means that the given\nexpression will be evaluated multiple times with various input values that the expression\ncan access through ld(0). When the expression evaluates to 0 then the corresponding input\nvalue will be returned.\n" }, { "name": "round(expr)", "content": "Round the value of expression expr to the nearest integer. For example, \"round(1.5)\" is\n\"2.0\".\n" }, { "name": "sgn(x)", "content": "Compute sign of x.\n" }, { "name": "sin(x)", "content": "Compute sine of x.\n" }, { "name": "sinh(x)", "content": "Compute hyperbolic sine of x.\n" }, { "name": "sqrt(expr)", "content": "Compute the square root of expr. This is equivalent to \"(expr)^.5\".\n" }, { "name": "squish(x)", "content": "Compute expression \"1/(1 + exp(4*x))\".\n" }, { "name": "st(var, expr)", "content": "Store the value of the expression expr in an internal variable. var specifies the number\nof the variable where to store the value, and it is a value ranging from 0 to 9. The\nfunction returns the value stored in the internal variable. Note, Variables are\ncurrently not shared between expressions.\n" }, { "name": "tan(x)", "content": "Compute tangent of x.\n" }, { "name": "tanh(x)", "content": "Compute hyperbolic tangent of x.\n" }, { "name": "taylor(expr, x)", "content": "" }, { "name": "taylor(expr, x, id)", "content": "Evaluate a Taylor series at x, given an expression representing the ld(id)-th derivative\nof a function at 0.\n\nWhen the series does not converge the result is undefined.\n\nld(id) is used to represent the derivative order in expr, which means that the given\nexpression will be evaluated multiple times with various input values that the expression\ncan access through ld(id). If id is not specified then 0 is assumed.\n\nNote, when you have the derivatives at y instead of 0, \"taylor(expr, x-y)\" can be used.\n" }, { "name": "time(0)", "content": "Return the current (wallclock) time in seconds.\n" }, { "name": "trunc(expr)", "content": "Round the value of expression expr towards zero to the nearest integer. For example,\n\"trunc(-1.5)\" is \"-1.0\".\n" }, { "name": "while(cond, expr)", "content": "Evaluate expression expr while the expression cond is non-zero, and returns the value of\nthe last expr evaluation, or NAN if cond was always false.\n\nThe following constants are available:\n\nPI area of the unit disc, approximately 3.14\n\nE exp(1) (Euler's number), approximately 2.718\n\nPHI golden ratio (1+sqrt(5))/2, approximately 1.618\n\nAssuming that an expression is considered \"true\" if it has a non-zero value, note that:\n\n\"*\" works like AND\n\n\"+\" works like OR\n\nFor example the construct:\n\nif (A AND B) then C\n\nis equivalent to:\n\nif(A*B, C)\n\nIn your C code, you can extend the list of unary and binary functions, and define recognized\nconstants, so that they are available for your expressions.\n\nThe evaluator also recognizes the International System unit prefixes. If 'i' is appended\nafter the prefix, binary prefixes are used, which are based on powers of 1024 instead of\npowers of 1000. The 'B' postfix multiplies the value by 8, and can be appended after a unit\nprefix or used alone. This allows using for example 'KB', 'MiB', 'G' and 'B' as number\npostfix.\n\nThe list of available International System prefixes follows, with indication of the\ncorresponding powers of 10 and of 2.\n\ny 10^-24 / 2^-80\n\nz 10^-21 / 2^-70\n\na 10^-18 / 2^-60\n\nf 10^-15 / 2^-50\n\np 10^-12 / 2^-40\n\nn 10^-9 / 2^-30\n\nu 10^-6 / 2^-20\n\nm 10^-3 / 2^-10\n\nc 10^-2\n\nd 10^-1\n\nh 10^2\n\nk 10^3 / 2^10\n\nK 10^3 / 2^10\n\nM 10^6 / 2^20\n\nG 10^9 / 2^30\n\nT 10^12 / 2^40\n\nP 10^15 / 2^50\n\nE 10^18 / 2^60\n\nZ 10^21 / 2^70\n\nY 10^24 / 2^80\n" } ] }, "CODEC OPTIONS": { "content": "libavcodec provides some generic global options, which can be set on all the encoders and\ndecoders. In addition each codec may support so-called private options, which are specific\nfor a given codec.\n\nSometimes, a global option may only affect a specific kind of codec, and may be nonsensical\nor ignored by another, so you need to be aware of the meaning of the specified options. Also\nsome options are meant only for decoding or encoding.\n\nOptions may be set by specifying -option value in the FFmpeg tools, or by setting the value\nexplicitly in the \"AVCodecContext\" options or using the libavutil/opt.h API for programmatic\nuse.\n\nThe list of supported options follow:\n\nb integer (encoding,audio,video)\nSet bitrate in bits/s. Default value is 200K.\n\nab integer (encoding,audio)\nSet audio bitrate (in bits/s). Default value is 128K.\n\nbt integer (encoding,video)\nSet video bitrate tolerance (in bits/s). In 1-pass mode, bitrate tolerance specifies how\nfar ratecontrol is willing to deviate from the target average bitrate value. This is not\nrelated to min/max bitrate. Lowering tolerance too much has an adverse effect on quality.\n\nflags flags (decoding/encoding,audio,video,subtitles)\nSet generic flags.\n\nPossible values:\n\nmv4 Use four motion vector by macroblock (mpeg4).\n\nqpel\nUse 1/4 pel motion compensation.\n\nloop\nUse loop filter.\n\nqscale\nUse fixed qscale.\n\npass1\nUse internal 2pass ratecontrol in first pass mode.\n\npass2\nUse internal 2pass ratecontrol in second pass mode.\n\ngray\nOnly decode/encode grayscale.\n\npsnr\nSet error[?] variables during encoding.\n\ntruncated\nInput bitstream might be randomly truncated.\n\ndropchanged\nDon't output frames whose parameters differ from first decoded frame in stream.\nError AVERRORINPUTCHANGED is returned when a frame is dropped.\n\nildct\nUse interlaced DCT.\n\nlowdelay\nForce low delay.\n\nglobalheader\nPlace global headers in extradata instead of every keyframe.\n\nbitexact\nOnly write platform-, build- and time-independent data. (except (I)DCT). This\nensures that file and data checksums are reproducible and match between platforms.\nIts primary use is for regression testing.\n\naic Apply H263 advanced intra coding / mpeg4 ac prediction.\n\nilme\nApply interlaced motion estimation.\n\ncgop\nUse closed gop.\n\noutputcorrupt\nOutput even potentially corrupted frames.\n\ntimebase rational number\nSet codec time base.\n\nIt is the fundamental unit of time (in seconds) in terms of which frame timestamps are\nrepresented. For fixed-fps content, timebase should be \"1 / framerate\" and timestamp\nincrements should be identically 1.\n\ng integer (encoding,video)\nSet the group of picture (GOP) size. Default value is 12.\n\nar integer (decoding/encoding,audio)\nSet audio sampling rate (in Hz).\n\nac integer (decoding/encoding,audio)\nSet number of audio channels.\n\ncutoff integer (encoding,audio)\nSet cutoff bandwidth. (Supported only by selected encoders, see their respective\ndocumentation sections.)\n\nframesize integer (encoding,audio)\nSet audio frame size.\n\nEach submitted frame except the last must contain exactly framesize samples per channel.\nMay be 0 when the codec has CODECCAPVARIABLEFRAMESIZE set, in that case the frame\nsize is not restricted. It is set by some decoders to indicate constant frame size.\n\nframenumber integer\nSet the frame number.\n\ndelay integer\nqcomp float (encoding,video)\nSet video quantizer scale compression (VBR). It is used as a constant in the ratecontrol\nequation. Recommended range for default rceq: 0.0-1.0.\n\nqblur float (encoding,video)\nSet video quantizer scale blur (VBR).\n\nqmin integer (encoding,video)\nSet min video quantizer scale (VBR). Must be included between -1 and 69, default value is\n2.\n\nqmax integer (encoding,video)\nSet max video quantizer scale (VBR). Must be included between -1 and 1024, default value\nis 31.\n\nqdiff integer (encoding,video)\nSet max difference between the quantizer scale (VBR).\n\nbf integer (encoding,video)\nSet max number of B frames between non-B-frames.\n\nMust be an integer between -1 and 16. 0 means that B-frames are disabled. If a value of\n-1 is used, it will choose an automatic value depending on the encoder.\n\nDefault value is 0.\n\nbqfactor float (encoding,video)\nSet qp factor between P and B frames.\n\ncodectag integer\nbug flags (decoding,video)\nWorkaround not auto detected encoder bugs.\n\nPossible values:\n\nautodetect\nxvidilace\nXvid interlacing bug (autodetected if fourcc==XVIX)\n\nump4\n(autodetected if fourcc==UMP4)\n\nnopadding\npadding bug (autodetected)\n\namv\nqpelchroma\nstdqpel\nold standard qpel (autodetected per fourcc/version)\n\nqpelchroma2\ndirectblocksize\ndirect-qpel-blocksize bug (autodetected per fourcc/version)\n\nedge\nedge padding bug (autodetected per fourcc/version)\n\nhpelchroma\ndcclip\nms Workaround various bugs in microsoft broken decoders.\n\ntrunc\ntrancated frames\n\nstrict integer (decoding/encoding,audio,video)\nSpecify how strictly to follow the standards.\n\nPossible values:\n\nvery\nstrictly conform to an older more strict version of the spec or reference software\n\nstrict\nstrictly conform to all the things in the spec no matter what consequences\n\nnormal\nunofficial\nallow unofficial extensions\n\nexperimental\nallow non standardized experimental things, experimental (unfinished/work in\nprogress/not well tested) decoders and encoders. Note: experimental decoders can\npose a security risk, do not use this for decoding untrusted input.\n\nbqoffset float (encoding,video)\nSet QP offset between P and B frames.\n\nerrdetect flags (decoding,audio,video)\nSet error detection flags.\n\nPossible values:\n\ncrccheck\nverify embedded CRCs\n\nbitstream\ndetect bitstream specification deviations\n\nbuffer\ndetect improper bitstream length\n\nexplode\nabort decoding on minor error detection\n\nignoreerr\nignore decoding errors, and continue decoding. This is useful if you want to analyze\nthe content of a video and thus want everything to be decoded no matter what. This\noption will not result in a video that is pleasing to watch in case of errors.\n\ncareful\nconsider things that violate the spec and have not been seen in the wild as errors\n\ncompliant\nconsider all spec non compliancies as errors\n\naggressive\nconsider things that a sane encoder should not do as an error\n\nhasbframes integer\nblockalign integer\nrcoverridecount integer\nmaxrate integer (encoding,audio,video)\nSet max bitrate tolerance (in bits/s). Requires bufsize to be set.\n\nminrate integer (encoding,audio,video)\nSet min bitrate tolerance (in bits/s). Most useful in setting up a CBR encode. It is of\nlittle use elsewise.\n\nbufsize integer (encoding,audio,video)\nSet ratecontrol buffer size (in bits).\n\niqfactor float (encoding,video)\nSet QP factor between P and I frames.\n\niqoffset float (encoding,video)\nSet QP offset between P and I frames.\n\ndct integer (encoding,video)\nSet DCT algorithm.\n\nPossible values:\n\nauto\nautoselect a good one (default)\n\nfastint\nfast integer\n\nint accurate integer\n\nmmx\naltivec\nfaan\nfloating point AAN DCT\n\nlumimask float (encoding,video)\nCompress bright areas stronger than medium ones.\n\ntcplxmask float (encoding,video)\nSet temporal complexity masking.\n\nscplxmask float (encoding,video)\nSet spatial complexity masking.\n\npmask float (encoding,video)\nSet inter masking.\n\ndarkmask float (encoding,video)\nCompress dark areas stronger than medium ones.\n\nidct integer (decoding/encoding,video)\nSelect IDCT implementation.\n\nPossible values:\n\nauto\nint\nsimple\nsimplemmx\nsimpleauto\nAutomatically pick a IDCT compatible with the simple one\n\narm\naltivec\nsh4\nsimplearm\nsimplearmv5te\nsimplearmv6\nsimpleneon\nxvid\nfaani\nfloating point AAN IDCT\n\nslicecount integer\nec flags (decoding,video)\nSet error concealment strategy.\n\nPossible values:\n\nguessmvs\niterative motion vector (MV) search (slow)\n\ndeblock\nuse strong deblock filter for damaged MBs\n\nfavorinter\nfavor predicting from the previous frame instead of the current\n\nbitspercodedsample integer\naspect rational number (encoding,video)\nSet sample aspect ratio.\n\nsar rational number (encoding,video)\nSet sample aspect ratio. Alias to aspect.\n\ndebug flags (decoding/encoding,audio,video,subtitles)\nPrint specific debug info.\n\nPossible values:\n\npict\npicture info\n\nrc rate control\n\nbitstream\nmbtype\nmacroblock (MB) type\n\nqp per-block quantization parameter (QP)\n\ndctcoeff\ngreenmetadata\ndisplay complexity metadata for the upcoming frame, GoP or for a given duration.\n\nskip\nstartcode\ner error recognition\n\nmmco\nmemory management control operations (H.264)\n\nbugs\nbuffers\npicture buffer allocations\n\nthreadops\nthreading operations\n\nnomc\nskip motion compensation\n\ncmp integer (encoding,video)\nSet full pel me compare function.\n\nPossible values:\n\nsad sum of absolute differences, fast (default)\n\nsse sum of squared errors\n\nsatd\nsum of absolute Hadamard transformed differences\n\ndct sum of absolute DCT transformed differences\n\npsnr\nsum of squared quantization errors (avoid, low quality)\n\nbit number of bits needed for the block\n\nrd rate distortion optimal, slow\n\nzero\n0\n\nvsad\nsum of absolute vertical differences\n\nvsse\nsum of squared vertical differences\n\nnsse\nnoise preserving sum of squared differences\n\nw53 5/3 wavelet, only used in snow\n\nw97 9/7 wavelet, only used in snow\n\ndctmax\nchroma\nsubcmp integer (encoding,video)\nSet sub pel me compare function.\n\nPossible values:\n\nsad sum of absolute differences, fast (default)\n\nsse sum of squared errors\n\nsatd\nsum of absolute Hadamard transformed differences\n\ndct sum of absolute DCT transformed differences\n\npsnr\nsum of squared quantization errors (avoid, low quality)\n\nbit number of bits needed for the block\n\nrd rate distortion optimal, slow\n\nzero\n0\n\nvsad\nsum of absolute vertical differences\n\nvsse\nsum of squared vertical differences\n\nnsse\nnoise preserving sum of squared differences\n\nw53 5/3 wavelet, only used in snow\n\nw97 9/7 wavelet, only used in snow\n\ndctmax\nchroma\nmbcmp integer (encoding,video)\nSet macroblock compare function.\n\nPossible values:\n\nsad sum of absolute differences, fast (default)\n\nsse sum of squared errors\n\nsatd\nsum of absolute Hadamard transformed differences\n\ndct sum of absolute DCT transformed differences\n\npsnr\nsum of squared quantization errors (avoid, low quality)\n\nbit number of bits needed for the block\n\nrd rate distortion optimal, slow\n\nzero\n0\n\nvsad\nsum of absolute vertical differences\n\nvsse\nsum of squared vertical differences\n\nnsse\nnoise preserving sum of squared differences\n\nw53 5/3 wavelet, only used in snow\n\nw97 9/7 wavelet, only used in snow\n\ndctmax\nchroma\nildctcmp integer (encoding,video)\nSet interlaced dct compare function.\n\nPossible values:\n\nsad sum of absolute differences, fast (default)\n\nsse sum of squared errors\n\nsatd\nsum of absolute Hadamard transformed differences\n\ndct sum of absolute DCT transformed differences\n\npsnr\nsum of squared quantization errors (avoid, low quality)\n\nbit number of bits needed for the block\n\nrd rate distortion optimal, slow\n\nzero\n0\n\nvsad\nsum of absolute vertical differences\n\nvsse\nsum of squared vertical differences\n\nnsse\nnoise preserving sum of squared differences\n\nw53 5/3 wavelet, only used in snow\n\nw97 9/7 wavelet, only used in snow\n\ndctmax\nchroma\ndiasize integer (encoding,video)\nSet diamond type & size for motion estimation.\n\n(1024, INTMAX)\nfull motion estimation(slowest)\n\n(768, 1024]\numh motion estimation\n\n(512, 768]\nhex motion estimation\n\n(256, 512]\nl2s diamond motion estimation\n\n[2,256]\nvar diamond motion estimation\n\n(-1, 2)\nsmall diamond motion estimation\n\n-1 funny diamond motion estimation\n\n(INTMIN, -1)\nsab diamond motion estimation\n\nlastpred integer (encoding,video)\nSet amount of motion predictors from the previous frame.\n\nprecmp integer (encoding,video)\nSet pre motion estimation compare function.\n\nPossible values:\n\nsad sum of absolute differences, fast (default)\n\nsse sum of squared errors\n\nsatd\nsum of absolute Hadamard transformed differences\n\ndct sum of absolute DCT transformed differences\n\npsnr\nsum of squared quantization errors (avoid, low quality)\n\nbit number of bits needed for the block\n\nrd rate distortion optimal, slow\n\nzero\n0\n\nvsad\nsum of absolute vertical differences\n\nvsse\nsum of squared vertical differences\n\nnsse\nnoise preserving sum of squared differences\n\nw53 5/3 wavelet, only used in snow\n\nw97 9/7 wavelet, only used in snow\n\ndctmax\nchroma\nprediasize integer (encoding,video)\nSet diamond type & size for motion estimation pre-pass.\n\nsubq integer (encoding,video)\nSet sub pel motion estimation quality.\n\nmerange integer (encoding,video)\nSet limit motion vectors range (1023 for DivX player).\n\nglobalquality integer (encoding,audio,video)\nsliceflags integer\nmbd integer (encoding,video)\nSet macroblock decision algorithm (high quality mode).\n\nPossible values:\n\nsimple\nuse mbcmp (default)\n\nbits\nuse fewest bits\n\nrd use best rate distortion\n\nrcinitoccupancy integer (encoding,video)\nSet number of bits which should be loaded into the rc buffer before decoding starts.\n\nflags2 flags (decoding/encoding,audio,video,subtitles)\nPossible values:\n\nfast\nAllow non spec compliant speedup tricks.\n\nnoout\nSkip bitstream encoding.\n\nignorecrop\nIgnore cropping information from sps.\n\nlocalheader\nPlace global headers at every keyframe instead of in extradata.\n\nchunks\nFrame data might be split into multiple chunks.\n\nshowall\nShow all frames before the first keyframe.\n\nexportmvs\nExport motion vectors into frame side-data (see \"AVFRAMEDATAMOTIONVECTORS\") for\ncodecs that support it. See also doc/examples/exportmvs.c.\n\nskipmanual\nDo not skip samples and export skip information as frame side data.\n\nassroflushnoop\nDo not reset ASS ReadOrder field on flush.\n\niccprofiles\nGenerate/parse embedded ICC profiles from/to colorimetry tags.\n\nexportsidedata flags (decoding/encoding,audio,video,subtitles)\nPossible values:\n\nmvs Export motion vectors into frame side-data (see \"AVFRAMEDATAMOTIONVECTORS\") for\ncodecs that support it. See also doc/examples/exportmvs.c.\n\nprft\nExport encoder Producer Reference Time into packet side-data (see \"AVPKTDATAPRFT\")\nfor codecs that support it.\n\nvencparams\nExport video encoding parameters through frame side data (see\n\"AVFRAMEDATAVIDEOENCPARAMS\") for codecs that support it. At present, those are\nH.264 and VP9.\n\nfilmgrain\nExport film grain parameters through frame side data (see\n\"AVFRAMEDATAFILMGRAINPARAMS\"). Supported at present by AV1 decoders.\n\nthreads integer (decoding/encoding,video)\nSet the number of threads to be used, in case the selected codec implementation supports\nmulti-threading.\n\nPossible values:\n\nauto, 0\nautomatically select the number of threads to set\n\nDefault value is auto.\n\ndc integer (encoding,video)\nSet intradcprecision.\n\nnssew integer (encoding,video)\nSet nsse weight.\n\nskiptop integer (decoding,video)\nSet number of macroblock rows at the top which are skipped.\n\nskipbottom integer (decoding,video)\nSet number of macroblock rows at the bottom which are skipped.\n\nprofile integer (encoding,audio,video)\nSet encoder codec profile. Default value is unknown. Encoder specific profiles are\ndocumented in the relevant encoder documentation.\n\nlevel integer (encoding,audio,video)\nSet the encoder level. This level depends on the specific codec, and might correspond to\nthe profile level. It is set by default to unknown.\n\nPossible values:\n\nunknown\nlowres integer (decoding,audio,video)\nDecode at 1= 1/2, 2=1/4, 3=1/8 resolutions.\n\nmblmin integer (encoding,video)\nSet min macroblock lagrange factor (VBR).\n\nmblmax integer (encoding,video)\nSet max macroblock lagrange factor (VBR).\n\nskiploopfilter integer (decoding,video)\nskipidct integer (decoding,video)\nskipframe integer (decoding,video)\nMake decoder discard processing depending on the frame type selected by the option value.\n\nskiploopfilter skips frame loop filtering, skipidct skips frame IDCT/dequantization,\nskipframe skips decoding.\n\nPossible values:\n\nnone\nDiscard no frame.\n\ndefault\nDiscard useless frames like 0-sized frames.\n\nnoref\nDiscard all non-reference frames.\n\nbidir\nDiscard all bidirectional frames.\n\nnokey\nDiscard all frames excepts keyframes.\n\nnointra\nDiscard all frames except I frames.\n\nall Discard all frames.\n\nDefault value is default.\n\nbidirrefine integer (encoding,video)\nRefine the two motion vectors used in bidirectional macroblocks.\n\nkeyintmin integer (encoding,video)\nSet minimum interval between IDR-frames.\n\nrefs integer (encoding,video)\nSet reference frames to consider for motion compensation.\n\ntrellis integer (encoding,audio,video)\nSet rate-distortion optimal quantization.\n\nmv0threshold integer (encoding,video)\ncompressionlevel integer (encoding,audio,video)\nbitsperrawsample integer\nchannellayout integer (decoding/encoding,audio)\nPossible values:\n\nrequestchannellayout integer (decoding,audio)\nPossible values:\n\nrcmaxvbvuse float (encoding,video)\nrcminvbvuse float (encoding,video)\ncolorprimaries integer (decoding/encoding,video)\nPossible values:\n\nbt709\nBT.709\n\nbt470m\nBT.470 M\n\nbt470bg\nBT.470 BG\n\nsmpte170m\nSMPTE 170 M\n\nsmpte240m\nSMPTE 240 M\n\nfilm\nFilm\n\nbt2020\nBT.2020\n\nsmpte428\nsmpte4281\nSMPTE ST 428-1\n\nsmpte431\nSMPTE 431-2\n\nsmpte432\nSMPTE 432-1\n\njedec-p22\nJEDEC P22\n\ncolortrc integer (decoding/encoding,video)\nPossible values:\n\nbt709\nBT.709\n\ngamma22\nBT.470 M\n\ngamma28\nBT.470 BG\n\nsmpte170m\nSMPTE 170 M\n\nsmpte240m\nSMPTE 240 M\n\nlinear\nLinear\n\nlog\nlog100\nLog\n\nlogsqrt\nlog316\nLog square root\n\niec6196624\niec61966-2-4\nIEC 61966-2-4\n\nbt1361\nbt1361e\nBT.1361\n\niec6196621\niec61966-2-1\nIEC 61966-2-1\n\nbt202010\nbt202010bit\nBT.2020 - 10 bit\n\nbt202012\nbt202012bit\nBT.2020 - 12 bit\n\nsmpte2084\nSMPTE ST 2084\n\nsmpte428\nsmpte4281\nSMPTE ST 428-1\n\narib-std-b67\nARIB STD-B67\n\ncolorspace integer (decoding/encoding,video)\nPossible values:\n\nrgb RGB\n\nbt709\nBT.709\n\nfcc FCC\n\nbt470bg\nBT.470 BG\n\nsmpte170m\nSMPTE 170 M\n\nsmpte240m\nSMPTE 240 M\n\nycocg\nYCOCG\n\nbt2020nc\nbt2020ncl\nBT.2020 NCL\n\nbt2020c\nbt2020cl\nBT.2020 CL\n\nsmpte2085\nSMPTE 2085\n\nchroma-derived-nc\nChroma-derived NCL\n\nchroma-derived-c\nChroma-derived CL\n\nictcp\nICtCp\n\ncolorrange integer (decoding/encoding,video)\nIf used as input parameter, it serves as a hint to the decoder, which colorrange the\ninput has. Possible values:\n\ntv\nmpeg\nlimited\nMPEG (219*2^(n-8))\n\npc\njpeg\nfull\nJPEG (2^n-1)\n\nchromasamplelocation integer (decoding/encoding,video)\nPossible values:\n\nleft\ncenter\ntopleft\ntop\nbottomleft\nbottom\nlogleveloffset integer\nSet the log level offset.\n\nslices integer (encoding,video)\nNumber of slices, used in parallelized encoding.\n\nthreadtype flags (decoding/encoding,video)\nSelect which multithreading methods to use.\n\nUse of frame will increase decoding delay by one frame per thread, so clients which\ncannot provide future frames should not use it.\n\nPossible values:\n\nslice\nDecode more than one part of a single frame at once.\n\nMultithreading using slices works only when the video was encoded with slices.\n\nframe\nDecode more than one frame at once.\n\nDefault value is slice+frame.\n\naudioservicetype integer (encoding,audio)\nSet audio service type.\n\nPossible values:\n\nma Main Audio Service\n\nef Effects\n\nvi Visually Impaired\n\nhi Hearing Impaired\n\ndi Dialogue\n\nco Commentary\n\nem Emergency\n\nvo Voice Over\n\nka Karaoke\n\nrequestsamplefmt samplefmt (decoding,audio)\nSet sample format audio decoders should prefer. Default value is \"none\".\n\npkttimebase rational number\nsubcharenc encoding (decoding,subtitles)\nSet the input subtitles character encoding.\n\nfieldorder fieldorder (video)\nSet/override the field order of the video. Possible values:\n\nprogressive\nProgressive video\n\ntt Interlaced video, top field coded and displayed first\n\nbb Interlaced video, bottom field coded and displayed first\n\ntb Interlaced video, top coded first, bottom displayed first\n\nbt Interlaced video, bottom coded first, top displayed first\n\nskipalpha bool (decoding,video)\nSet to 1 to disable processing alpha (transparency). This works like the gray flag in the\nflags option which skips chroma information instead of alpha. Default is 0.\n\ncodecwhitelist list (input)\n\",\" separated list of allowed decoders. By default all are allowed.\n\ndumpseparator string (input)\nSeparator used to separate the fields printed on the command line about the Stream\nparameters. For example, to separate the fields with newlines and indentation:\n\nffprobe -dumpseparator \"\n\" -i ~/videos/matrixbenchmpeg2.mpg\n\nmaxpixels integer (decoding/encoding,video)\nMaximum number of pixels per image. This value can be used to avoid out of memory\nfailures due to large images.\n\napplycropping bool (decoding,video)\nEnable cropping if cropping parameters are multiples of the required alignment for the\nleft and top parameters. If the alignment is not met the cropping will be partially\napplied to maintain alignment. Default is 1 (enabled). Note: The required alignment\ndepends on if \"AVCODECFLAGUNALIGNED\" is set and the CPU. \"AVCODECFLAGUNALIGNED\"\ncannot be changed from the command line. Also hardware decoders will not apply left/top\nCropping.\n", "subsections": [] }, "DECODERS": { "content": "Decoders are configured elements in FFmpeg which allow the decoding of multimedia streams.\n\nWhen you configure your FFmpeg build, all the supported native decoders are enabled by\ndefault. Decoders requiring an external library must be enabled manually via the\ncorresponding \"--enable-lib\" option. You can list all available decoders using the configure\noption \"--list-decoders\".\n\nYou can disable all the decoders with the configure option \"--disable-decoders\" and\nselectively enable / disable single decoders with the options \"--enable-decoder=DECODER\" /\n\"--disable-decoder=DECODER\".\n\nThe option \"-decoders\" of the ff* tools will display the list of enabled decoders.\n", "subsections": [] }, "VIDEO DECODERS": { "content": "A description of some of the currently available video decoders follows.\n", "subsections": [ { "name": "av1", "content": "AOMedia Video 1 (AV1) decoder.\n\nOptions\n" }, { "name": "operating_point", "content": "Select an operating point of a scalable AV1 bitstream (0 - 31). Default is 0.\n" }, { "name": "rawvideo", "content": "Raw video decoder.\n\nThis decoder decodes rawvideo streams.\n\nOptions\n\ntop topfieldfirst\nSpecify the assumed field type of the input video.\n\n-1 the video is assumed to be progressive (default)\n\n0 bottom-field-first is assumed\n\n1 top-field-first is assumed\n" }, { "name": "libdav1d", "content": "dav1d AV1 decoder.\n\nlibdav1d allows libavcodec to decode the AOMedia Video 1 (AV1) codec. Requires the presence\nof the libdav1d headers and library during configuration. You need to explicitly configure\nthe build with \"--enable-libdav1d\".\n\nOptions\n\nThe following options are supported by the libdav1d wrapper.\n" }, { "name": "framethreads", "content": "Set amount of frame threads to use during decoding. The default value is 0 (autodetect).\nThis option is deprecated for libdav1d >= 1.0 and will be removed in the future. Use the\noption \"maxframedelay\" and the global option \"threads\" instead.\n" }, { "name": "tilethreads", "content": "Set amount of tile threads to use during decoding. The default value is 0 (autodetect).\nThis option is deprecated for libdav1d >= 1.0 and will be removed in the future. Use the\nglobal option \"threads\" instead.\n" }, { "name": "max_frame_delay", "content": "Set max amount of frames the decoder may buffer internally. The default value is 0\n(autodetect).\n" }, { "name": "filmgrain", "content": "Apply film grain to the decoded video if present in the bitstream. Defaults to the\ninternal default of the library. This option is deprecated and will be removed in the\nfuture. See the global option \"exportsidedata\" to export Film Grain parameters instead\nof applying it.\n" }, { "name": "oppoint", "content": "Select an operating point of a scalable AV1 bitstream (0 - 31). Defaults to the internal\ndefault of the library.\n" }, { "name": "alllayers", "content": "Output all spatial layers of a scalable AV1 bitstream. The default value is false.\n" }, { "name": "libdavs2", "content": "AVS2-P2/IEEE1857.4 video decoder wrapper.\n\nThis decoder allows libavcodec to decode AVS2 streams with davs2 library.\n" }, { "name": "libuavs3d", "content": "AVS3-P2/IEEE1857.10 video decoder.\n\nlibuavs3d allows libavcodec to decode AVS3 streams. Requires the presence of the libuavs3d\nheaders and library during configuration. You need to explicitly configure the build with\n\"--enable-libuavs3d\".\n\nOptions\n\nThe following option is supported by the libuavs3d wrapper.\n" }, { "name": "frame_threads", "content": "Set amount of frame threads to use during decoding. The default value is 0 (autodetect).\n" }, { "name": "QSV Decoders", "content": "The family of Intel QuickSync Video decoders (VC1, MPEG-2, H.264, HEVC, JPEG/MJPEG, VP8, VP9,\nAV1).\n\nCommon Options\n\nThe following options are supported by all qsv decoders.\n\nasyncdepth\nInternal parallelization depth, the higher the value the higher the latency.\n\ngpucopy\nA GPU-accelerated copy between video and system memory\n\ndefault\non\noff\n\nHEVC Options\n\nExtra options for hevcqsv.\n\nloadplugin\nA user plugin to load in an internal session\n\nnone\nhevcsw\nhevchw\nloadplugins\nA :-separate list of hexadecimal plugin UIDs to load in an internal session\n" }, { "name": "v210", "content": "Uncompressed 4:2:2 10-bit decoder.\n\nOptions\n" }, { "name": "custom_stride", "content": "Set the line size of the v210 data in bytes. The default value is 0 (autodetect). You can\nuse the special -1 value for a strideless v210 as seen in BOXX files.\n" } ] }, "AUDIO DECODERS": { "content": "A description of some of the currently available audio decoders follows.\n", "subsections": [ { "name": "ac3", "content": "AC-3 audio decoder.\n\nThis decoder implements part of ATSC A/52:2010 and ETSI TS 102 366, as well as the\nundocumented RealAudio 3 (a.k.a. dnet).\n\nAC-3 Decoder Options\n" }, { "name": "-drc_scale _", "content": "Dynamic Range Scale Factor. The factor to apply to dynamic range values from the AC-3\nstream. This factor is applied exponentially. The default value is 1. There are 3\nnotable scale factor ranges:\n\ndrcscale == 0\nDRC disabled. Produces full range audio.\n\n0 < drcscale <= 1\nDRC enabled. Applies a fraction of the stream DRC value. Audio reproduction is\nbetween full range and full compression.\n\ndrcscale > 1\nDRC enabled. Applies drcscale asymmetrically. Loud sounds are fully compressed.\nSoft sounds are enhanced.\n" }, { "name": "flac", "content": "FLAC audio decoder.\n\nThis decoder aims to implement the complete FLAC specification from Xiph.\n\nFLAC Decoder options\n" }, { "name": "-use_buggy_lpc", "content": "The lavc FLAC encoder used to produce buggy streams with high lpc values (like the\ndefault value). This option makes it possible to decode such streams correctly by using\nlavc's old buggy lpc logic for decoding.\n" }, { "name": "ffwavesynth", "content": "Internal wave synthesizer.\n\nThis decoder generates wave patterns according to predefined sequences. Its use is purely\ninternal and the format of the data it accepts is not publicly documented.\n" }, { "name": "libcelt", "content": "libcelt decoder wrapper.\n\nlibcelt allows libavcodec to decode the Xiph CELT ultra-low delay audio codec. Requires the\npresence of the libcelt headers and library during configuration. You need to explicitly\nconfigure the build with \"--enable-libcelt\".\n" }, { "name": "libgsm", "content": "libgsm decoder wrapper.\n\nlibgsm allows libavcodec to decode the GSM full rate audio codec. Requires the presence of\nthe libgsm headers and library during configuration. You need to explicitly configure the\nbuild with \"--enable-libgsm\".\n\nThis decoder supports both the ordinary GSM and the Microsoft variant.\n" }, { "name": "libilbc", "content": "libilbc decoder wrapper.\n\nlibilbc allows libavcodec to decode the Internet Low Bitrate Codec (iLBC) audio codec.\nRequires the presence of the libilbc headers and library during configuration. You need to\nexplicitly configure the build with \"--enable-libilbc\".\n\nOptions\n\nThe following option is supported by the libilbc wrapper.\n" }, { "name": "enhance", "content": "Enable the enhancement of the decoded audio when set to 1. The default value is 0\n(disabled).\n" }, { "name": "libopencore-amrnb", "content": "libopencore-amrnb decoder wrapper.\n\nlibopencore-amrnb allows libavcodec to decode the Adaptive Multi-Rate Narrowband audio codec.\nUsing it requires the presence of the libopencore-amrnb headers and library during\nconfiguration. You need to explicitly configure the build with \"--enable-libopencore-amrnb\".\n\nAn FFmpeg native decoder for AMR-NB exists, so users can decode AMR-NB without this library.\n" }, { "name": "libopencore-amrwb", "content": "libopencore-amrwb decoder wrapper.\n\nlibopencore-amrwb allows libavcodec to decode the Adaptive Multi-Rate Wideband audio codec.\nUsing it requires the presence of the libopencore-amrwb headers and library during\nconfiguration. You need to explicitly configure the build with \"--enable-libopencore-amrwb\".\n\nAn FFmpeg native decoder for AMR-WB exists, so users can decode AMR-WB without this library.\n" }, { "name": "libopus", "content": "libopus decoder wrapper.\n\nlibopus allows libavcodec to decode the Opus Interactive Audio Codec. Requires the presence\nof the libopus headers and library during configuration. You need to explicitly configure the\nbuild with \"--enable-libopus\".\n\nAn FFmpeg native decoder for Opus exists, so users can decode Opus without this library.\n" } ] }, "SUBTITLES DECODERS": { "content": "", "subsections": [ { "name": "libaribb24", "content": "ARIB STD-B24 caption decoder.\n\nImplements profiles A and C of the ARIB STD-B24 standard.\n\nlibaribb24 Decoder Options\n" }, { "name": "-aribb24-base-path _", "content": "Sets the base path for the libaribb24 library. This is utilized for reading of\nconfiguration files (for custom unicode conversions), and for dumping of non-text symbols\nas images under that location.\n\nUnset by default.\n" }, { "name": "-aribb24-skip-ruby-text _", "content": "Tells the decoder wrapper to skip text blocks that contain half-height ruby text.\n\nEnabled by default.\n" }, { "name": "libaribcaption", "content": "Yet another ARIB STD-B24 caption decoder using external libaribcaption library.\n\nImplements profiles A and C of the Japanse ARIB STD-B24 standard, Brazilian ABNT NBR 15606-1,\nand Philippines version of ISDB-T.\n\nRequires the presence of the libaribcaption headers and library\n() during configuration. You need to explicitly\nconfigure the build with \"--enable-libaribcaption\". If both libaribb24 and libaribcaption\nare enabled, libaribcaption decoder precedes.\n\nlibaribcaption Decoder Options\n" }, { "name": "-sub_type _", "content": "Specifies the format of the decoded subtitles.\n\nbitmap\nGraphical image.\n\nass ASS formatted text.\n\ntext\nSimple text based output without formatting.\n\nThe default is ass as same as libaribb24 decoder. Some present players (e.g., mpv)\nexpect ASS format for ARIB caption.\n" }, { "name": "-caption_encoding _", "content": "Specifies the encoding scheme of input subtitle text.\n\nauto\nAutomatically detect text encoding (default).\n\njis 8bit-char JIS encoding defined in ARIB STD B24. This encoding used in Japan for ISDB\ncaptions.\n\nutf8\nUTF-8 encoding defined in ARIB STD B24. This encoding is used in Philippines for\nISDB-T captions.\n\nlatin\nLatin character encoding defined in ABNT NBR 15606-1. This encoding is used in South\nAmerica for SBTVD / ISDB-Tb captions.\n" }, { "name": "-font _", "content": "Specify comma-separated list of font family names to be used for bitmap or ass type\nsubtitle rendering. Only first font name is used for ass type subtitle.\n\nIf not specified, use internaly defined default font family.\n" }, { "name": "-ass_single_rect _", "content": "ARIB STD-B24 specifies that some captions may be displayed at different positions at a\ntime (multi-rectangle subtitle). Since some players (e.g., old mpv) can't handle\nmultiple ASS rectangles in a single AVSubtitle, or multiple ASS rectangles of\nindeterminate duration with the same start timestamp, this option can change the behavior\nso that all the texts are displayed in a single ASS rectangle.\n\nThe default is false.\n\nIf your player cannot handle AVSubtitles with multiple ASS rectangles properly, set this\noption to true or define ASSSINGLERECT=1 to change default behavior at compilation.\n" }, { "name": "-force_outline_text _", "content": "Specify whether always render outline text for all characters regardless of the\nindication by charactor style.\n\nThe default is false.\n" }, { "name": "-outline_width _", "content": "Specify width for outline text, in dots (relative).\n\nThe default is 1.5.\n" }, { "name": "-ignore_background _", "content": "Specify whether to ignore background color rendering.\n\nThe default is false.\n" }, { "name": "-ignore_ruby _", "content": "Specify whether to ignore rendering for ruby-like (furigana) characters.\n\nThe default is false.\n" }, { "name": "-replace_drcs _", "content": "Specify whether to render replaced DRCS characters as Unicode characters.\n\nThe default is true.\n" }, { "name": "-replace_msz_ascii _", "content": "Specify whether to replace MSZ (Middle Size; half width) fullwidth alphanumerics with\nhalfwidth alphanumerics.\n\nThe default is true.\n" }, { "name": "-replace_msz_japanese _", "content": "Specify whether to replace some MSZ (Middle Size; half width) fullwidth japanese special\ncharacters with halfwidth ones.\n\nThe default is true.\n" }, { "name": "-replace_msz_glyph _", "content": "Specify whether to replace MSZ (Middle Size; half width) characters with halfwidth glyphs\nif the fonts supports it. This option works under FreeType or DirectWrite renderer with\nAdobe-Japan1 compliant fonts. e.g., IBM Plex Sans JP, Morisawa BIZ UDGothic, Morisawa\nBIZ UDMincho, Yu Gothic, Yu Mincho, and Meiryo.\n\nThe default is true.\n" }, { "name": "-canvas_size _", "content": "Specify the resolution of the canvas to render subtitles to; usually, this should be\nframe size of input video. This only applies when \"-subtitletype\" is set to bitmap.\n\nThe libaribcaption decoder assumes input frame size for bitmap rendering as below:\n\n1. PROFILEA : 1440 x 1080 with SAR (PAR) 4:3\n\n2. PROFILEC : 320 x 180 with SAR (PAR) 1:1\n\nIf actual frame size of input video does not match above assumption, the rendered\ncaptions may be distorted. To make the captions undistorted, add \"-canvassize\" option\nto specify actual input video size.\n\nNote that the \"-canvassize\" option is not required for video with different size but\nsame aspect ratio. In such cases, the caption will be stretched or shrunk to actual\nvideo size if \"-canvassize\" option is not specified. If \"-canvassize\" option is\nspecified with different size, the caption will be stretched or shrunk as specified size\nwith calculated SAR.\n\nlibaribcaption decoder usage examples\n\nDisplay MPEG-TS file with ARIB subtitle by \"ffplay\" tool:\n\nffplay -subtype bitmap MPEG.TS\n\nDisplay MPEG-TS file with input frame size 1920x1080 by \"ffplay\" tool:\n\nffplay -subtype bitmap -canvassize 1920x1080 MPEG.TS\n\nEmbed ARIB subtitle in transcoded video:\n\nffmpeg -subtype bitmap -i src.m2t -filtercomplex \"[0:v][0:s]overlay\" -vcodec h264 dest.mp4\n" }, { "name": "dvbsub", "content": "Options\n" }, { "name": "compute_clut", "content": "-2 Compute clut once if no matching CLUT is in the stream.\n\n-1 Compute clut if no matching CLUT is in the stream.\n\n0 Never compute CLUT\n\n1 Always compute CLUT and override the one provided in the stream.\n" }, { "name": "dvb_substream", "content": "Selects the dvb substream, or all substreams if -1 which is default.\n" }, { "name": "dvdsub", "content": "This codec decodes the bitmap subtitles used in DVDs; the same subtitles can also be found in\nVobSub file pairs and in some Matroska files.\n\nOptions\n" }, { "name": "palette", "content": "Specify the global palette used by the bitmaps. When stored in VobSub, the palette is\nnormally specified in the index file; in Matroska, the palette is stored in the codec\nextra-data in the same format as in VobSub. In DVDs, the palette is stored in the IFO\nfile, and therefore not available when reading from dumped VOB files.\n\nThe format for this option is a string containing 16 24-bits hexadecimal numbers (without\n0x prefix) separated by commas, for example \"0d00ee, ee450d, 101010, eaeaea, 0ce60b,\nec14ed, ebff0b, 0d617a, 7b7b7b, d1d1d1, 7b2a0e, 0d950c, 0f007b, cf0dec, cfa80c, 7c127b\".\n" }, { "name": "ifo_palette", "content": "Specify the IFO file from which the global palette is obtained. (experimental)\n" }, { "name": "forced_subs_only", "content": "Only decode subtitle entries marked as forced. Some titles have forced and non-forced\nsubtitles in the same track. Setting this flag to 1 will only keep the forced subtitles.\nDefault value is 0.\n" }, { "name": "libzvbi-teletext", "content": "Libzvbi allows libavcodec to decode DVB teletext pages and DVB teletext subtitles. Requires\nthe presence of the libzvbi headers and library during configuration. You need to explicitly\nconfigure the build with \"--enable-libzvbi\".\n\nOptions\n" }, { "name": "txt_page", "content": "List of teletext page numbers to decode. Pages that do not match the specified list are\ndropped. You may use the special \"*\" string to match all pages, or \"subtitle\" to match\nall subtitle pages. Default value is *.\n" }, { "name": "txt_default_region", "content": "Set default character set used for decoding, a value between 0 and 87 (see ETS 300 706,\nSection 15, Table 32). Default value is -1, which does not override the libzvbi default.\nThis option is needed for some legacy level 1.0 transmissions which cannot signal the\nproper charset.\n" }, { "name": "txt_chop_top", "content": "Discards the top teletext line. Default value is 1.\n" }, { "name": "txt_format", "content": "Specifies the format of the decoded subtitles.\n\nbitmap\nThe default format, you should use this for teletext pages, because certain graphics\nand colors cannot be expressed in simple text or even ASS.\n\ntext\nSimple text based output without formatting.\n\nass Formatted ASS output, subtitle pages and teletext pages are returned in different\nstyles, subtitle pages are stripped down to text, but an effort is made to keep the\ntext alignment and the formatting.\n" }, { "name": "txt_left", "content": "X offset of generated bitmaps, default is 0.\n" }, { "name": "txt_top", "content": "Y offset of generated bitmaps, default is 0.\n" }, { "name": "txt_chop_spaces", "content": "Chops leading and trailing spaces and removes empty lines from the generated text. This\noption is useful for teletext based subtitles where empty spaces may be present at the\nstart or at the end of the lines or empty lines may be present between the subtitle lines\nbecause of double-sized teletext characters. Default value is 1.\n" }, { "name": "txt_duration", "content": "Sets the display duration of the decoded teletext pages or subtitles in milliseconds.\nDefault value is -1 which means infinity or until the next subtitle event comes.\n" }, { "name": "txt_transparent", "content": "Force transparent background of the generated teletext bitmaps. Default value is 0 which\nmeans an opaque background.\n" }, { "name": "txt_opacity", "content": "Sets the opacity (0-255) of the teletext background. If txttransparent is not set, it\nonly affects characters between a start box and an end box, typically subtitles. Default\nvalue is 0 if txttransparent is set, 255 otherwise.\n" } ] }, "BITSTREAM FILTERS": { "content": "When you configure your FFmpeg build, all the supported bitstream filters are enabled by\ndefault. You can list all available ones using the configure option \"--list-bsfs\".\n\nYou can disable all the bitstream filters using the configure option \"--disable-bsfs\", and\nselectively enable any bitstream filter using the option \"--enable-bsf=BSF\", or you can\ndisable a particular bitstream filter using the option \"--disable-bsf=BSF\".\n\nThe option \"-bsfs\" of the ff* tools will display the list of all the supported bitstream\nfilters included in your build.\n\nThe ff* tools have a -bsf option applied per stream, taking a comma-separated list of\nfilters, whose parameters follow the filter name after a '='.\n\nffmpeg -i INPUT -c:v copy -bsf:v filter1[=opt1=str1:opt2=str2][,filter2] OUTPUT\n\nBelow is a description of the currently available bitstream filters, with their parameters,\nif any.\n", "subsections": [ { "name": "aac_adtstoasc", "content": "Convert MPEG-2/4 AAC ADTS to an MPEG-4 Audio Specific Configuration bitstream.\n\nThis filter creates an MPEG-4 AudioSpecificConfig from an MPEG-2/4 ADTS header and removes\nthe ADTS header.\n\nThis filter is required for example when copying an AAC stream from a raw ADTS AAC or an\nMPEG-TS container to MP4A-LATM, to an FLV file, or to MOV/MP4 files and related formats such\nas 3GP or M4A. Please note that it is auto-inserted for MP4A-LATM and MOV/MP4 and related\nformats.\n" }, { "name": "av1_metadata", "content": "Modify metadata embedded in an AV1 stream.\n\ntd Insert or remove temporal delimiter OBUs in all temporal units of the stream.\n\ninsert\nInsert a TD at the beginning of every TU which does not already have one.\n\nremove\nRemove the TD from the beginning of every TU which has one.\n" }, { "name": "color_primaries", "content": "" }, { "name": "transfer_characteristics", "content": "" }, { "name": "matrix_coefficients", "content": "Set the color description fields in the stream (see AV1 section 6.4.2).\n" }, { "name": "color_range", "content": "Set the color range in the stream (see AV1 section 6.4.2; note that this cannot be set\nfor streams using BT.709 primaries, sRGB transfer characteristic and identity (RGB)\nmatrix coefficients).\n\ntv Limited range.\n\npc Full range.\n" }, { "name": "chroma_sample_position", "content": "Set the chroma sample location in the stream (see AV1 section 6.4.2). This can only be\nset for 4:2:0 streams.\n\nvertical\nLeft position (matching the default in MPEG-2 and H.264).\n\ncolocated\nTop-left position.\n" }, { "name": "tick_rate", "content": "Set the tick rate (timescale / numunitsindisplaytick) in the timing info in the\nsequence header.\n" }, { "name": "num_ticks_per_picture", "content": "Set the number of ticks in each picture, to indicate that the stream has a fixed\nframerate. Ignored if tickrate is not also set.\n" }, { "name": "delete_padding", "content": "Deletes Padding OBUs.\n" }, { "name": "chomp", "content": "Remove zero padding at the end of a packet.\n" }, { "name": "dca_core", "content": "Extract the core from a DCA/DTS stream, dropping extensions such as DTS-HD.\n" }, { "name": "dump_extra", "content": "Add extradata to the beginning of the filtered packets except when said packets already\nexactly begin with the extradata that is intended to be added.\n" }, { "name": "freq", "content": "The additional argument specifies which packets should be filtered. It accepts the\nvalues:\n\nk\nkeyframe\nadd extradata to all key packets\n\ne\nall add extradata to all packets\n\nIf not specified it is assumed k.\n\nFor example the following ffmpeg command forces a global header (thus disabling individual\npacket headers) in the H.264 packets generated by the \"libx264\" encoder, but corrects them by\nadding the header stored in extradata to the key packets:\n\nffmpeg -i INPUT -map 0 -flags:v +globalheader -c:v libx264 -bsf:v dumpextra out.ts\n" }, { "name": "dv_error_marker", "content": "Blocks in DV which are marked as damaged are replaced by blocks of the specified color.\n" }, { "name": "color", "content": "The color to replace damaged blocks by\n\nsta A 16 bit mask which specifies which of the 16 possible error status values are to be\nreplaced by colored blocks. 0xFFFE is the default which replaces all non 0 error status\nvalues.\n\nok No error, no concealment\n\nerr Error, No concealment\n\nres Reserved\n\nnotok\nError or concealment\n\nnotres\nNot reserved\n\nAa, Ba, Ca, Ab, Bb, Cb, A, B, C, a, b, erri, erru\nThe specific error status code\n\nsee page 44-46 or section 5.5 of\n\n" }, { "name": "eac3_core", "content": "Extract the core from a E-AC-3 stream, dropping extra channels.\n" }, { "name": "extract_extradata", "content": "Extract the in-band extradata.\n\nCertain codecs allow the long-term headers (e.g. MPEG-2 sequence headers, or H.264/HEVC\n(VPS/)SPS/PPS) to be transmitted either \"in-band\" (i.e. as a part of the bitstream containing\nthe coded frames) or \"out of band\" (e.g. on the container level). This latter form is called\n\"extradata\" in FFmpeg terminology.\n\nThis bitstream filter detects the in-band headers and makes them available as extradata.\n" }, { "name": "remove", "content": "When this option is enabled, the long-term headers are removed from the bitstream after\nextraction.\n" }, { "name": "filter_units", "content": "Remove units with types in or not in a given set from the stream.\n" }, { "name": "pass_types", "content": "List of unit types or ranges of unit types to pass through while removing all others.\nThis is specified as a '|'-separated list of unit type values or ranges of values with\n'-'.\n" }, { "name": "remove_types", "content": "Identical to passtypes, except the units in the given set removed and all others passed\nthrough.\n\nExtradata is unchanged by this transformation, but note that if the stream contains inline\nparameter sets then the output may be unusable if they are removed.\n\nFor example, to remove all non-VCL NAL units from an H.264 stream:\n\nffmpeg -i INPUT -c:v copy -bsf:v 'filterunits=passtypes=1-5' OUTPUT\n\nTo remove all AUDs, SEI and filler from an H.265 stream:\n\nffmpeg -i INPUT -c:v copy -bsf:v 'filterunits=removetypes=35|38-40' OUTPUT\n" }, { "name": "hapqa_extract", "content": "Extract Rgb or Alpha part of an HAPQA file, without recompression, in order to create an HAPQ\nor an HAPAlphaOnly file.\n" }, { "name": "texture", "content": "Specifies the texture to keep.\n\ncolor\nalpha\n\nConvert HAPQA to HAPQ\n\nffmpeg -i hapqainputfile.mov -c copy -bsf:v hapqaextract=texture=color -tag:v HapY -metadata:s:v:0 encoder=\"HAPQ\" hapqfile.mov\n\nConvert HAPQA to HAPAlphaOnly\n\nffmpeg -i hapqainputfile.mov -c copy -bsf:v hapqaextract=texture=alpha -tag:v HapA -metadata:s:v:0 encoder=\"HAPAlpha Only\" hapalphaonlyfile.mov\n" }, { "name": "h264_metadata", "content": "Modify metadata embedded in an H.264 stream.\n\naud Insert or remove AUD NAL units in all access units of the stream.\n\npass\ninsert\nremove\n\nDefault is pass.\n" }, { "name": "sample_aspect_ratio", "content": "Set the sample aspect ratio of the stream in the VUI parameters. See H.264 table E-1.\n" }, { "name": "overscan_appropriate_flag", "content": "Set whether the stream is suitable for display using overscan or not (see H.264 section\nE.2.1).\n" }, { "name": "video_format", "content": "" }, { "name": "video_full_range_flag", "content": "Set the video format in the stream (see H.264 section E.2.1 and table E-2).\n" }, { "name": "colour_primaries", "content": "" }, { "name": "transfer_characteristics", "content": "" }, { "name": "matrix_coefficients", "content": "Set the colour description in the stream (see H.264 section E.2.1 and tables E-3, E-4 and\nE-5).\n" }, { "name": "chroma_sample_loc_type", "content": "Set the chroma sample location in the stream (see H.264 section E.2.1 and figure E-1).\n" }, { "name": "tick_rate", "content": "Set the tick rate (timescale / numunitsintick) in the VUI parameters. This is the\nsmallest time unit representable in the stream, and in many cases represents the field\nrate of the stream (double the frame rate).\n" }, { "name": "fixed_frame_rate_flag", "content": "Set whether the stream has fixed framerate - typically this indicates that the framerate\nis exactly half the tick rate, but the exact meaning is dependent on interlacing and the\npicture structure (see H.264 section E.2.1 and table E-6).\n" }, { "name": "zero_new_constraint_set_flags", "content": "Zero constraintset4flag and constraintset5flag in the SPS. These bits were reserved\nin a previous version of the H.264 spec, and thus some hardware decoders require these to\nbe zero. The result of zeroing this is still a valid bitstream.\n" }, { "name": "crop_left", "content": "" }, { "name": "crop_right", "content": "" }, { "name": "crop_top", "content": "" }, { "name": "crop_bottom", "content": "Set the frame cropping offsets in the SPS. These values will replace the current ones if\nthe stream is already cropped.\n\nThese fields are set in pixels. Note that some sizes may not be representable if the\nchroma is subsampled or the stream is interlaced (see H.264 section 7.4.2.1.1).\n" }, { "name": "sei_user_data", "content": "Insert a string as SEI unregistered user data. The argument must be of the form\nUUID+string, where the UUID is as hex digits possibly separated by hyphens, and the\nstring can be anything.\n\nFor example, 086f3693-b7b3-4f2c-9653-21492feee5b8+hello will insert the string ``hello''\nassociated with the given UUID.\n" }, { "name": "delete_filler", "content": "Deletes both filler NAL units and filler SEI messages.\n" }, { "name": "display_orientation", "content": "Insert, extract or remove Display orientation SEI messages. See H.264 section D.1.27 and\nD.2.27 for syntax and semantics.\n\npass\ninsert\nremove\nextract\n\nDefault is pass.\n\nInsert mode works in conjunction with \"rotate\" and \"flip\" options. Any pre-existing\nDisplay orientation messages will be removed in insert or remove mode. Extract mode\nattaches the display matrix to the packet as side data.\n" }, { "name": "rotate", "content": "Set rotation in display orientation SEI (anticlockwise angle in degrees). Range is -360\nto +360. Default is NaN.\n" }, { "name": "flip", "content": "Set flip in display orientation SEI.\n\nhorizontal\nvertical\n\nDefault is unset.\n" }, { "name": "level", "content": "Set the level in the SPS. Refer to H.264 section A.3 and tables A-1 to A-5.\n\nThe argument must be the name of a level (for example, 4.2), a levelidc value (for\nexample, 42), or the special name auto indicating that the filter should attempt to guess\nthe level from the input stream properties.\n" }, { "name": "h264_mp4toannexb", "content": "Convert an H.264 bitstream from length prefixed mode to start code prefixed mode (as defined\nin the Annex B of the ITU-T H.264 specification).\n\nThis is required by some streaming formats, typically the MPEG-2 transport stream format\n(muxer \"mpegts\").\n\nFor example to remux an MP4 file containing an H.264 stream to mpegts format with ffmpeg, you\ncan use the command:\n\nffmpeg -i INPUT.mp4 -codec copy -bsf:v h264mp4toannexb OUTPUT.ts\n\nPlease note that this filter is auto-inserted for MPEG-TS (muxer \"mpegts\") and raw H.264\n(muxer \"h264\") output formats.\n" }, { "name": "h264_redundant_pps", "content": "This applies a specific fixup to some Blu-ray streams which contain redundant PPSs modifying\nirrelevant parameters of the stream which confuse other transformations which require correct\nextradata.\n" }, { "name": "hevc_metadata", "content": "Modify metadata embedded in an HEVC stream.\n\naud Insert or remove AUD NAL units in all access units of the stream.\n\ninsert\nremove" }, { "name": "sample_aspect_ratio", "content": "Set the sample aspect ratio in the stream in the VUI parameters.\n" }, { "name": "video_format", "content": "" }, { "name": "video_full_range_flag", "content": "Set the video format in the stream (see H.265 section E.3.1 and table E.2).\n" }, { "name": "colour_primaries", "content": "" }, { "name": "transfer_characteristics", "content": "" }, { "name": "matrix_coefficients", "content": "Set the colour description in the stream (see H.265 section E.3.1 and tables E.3, E.4 and\nE.5).\n" }, { "name": "chroma_sample_loc_type", "content": "Set the chroma sample location in the stream (see H.265 section E.3.1 and figure E.1).\n" }, { "name": "tick_rate", "content": "Set the tick rate in the VPS and VUI parameters (timescale / numunitsintick).\nCombined with numtickspocdiffone, this can set a constant framerate in the stream.\nNote that it is likely to be overridden by container parameters when the stream is in a\ncontainer.\n" }, { "name": "num_ticks_poc_diff_one", "content": "Set pocproportionaltotimingflag in VPS and VUI and use this value to set\nnumtickspocdiffoneminus1 (see H.265 sections 7.4.3.1 and E.3.1). Ignored if\ntickrate is not also set.\n" }, { "name": "crop_left", "content": "" }, { "name": "crop_right", "content": "" }, { "name": "crop_top", "content": "" }, { "name": "crop_bottom", "content": "Set the conformance window cropping offsets in the SPS. These values will replace the\ncurrent ones if the stream is already cropped.\n\nThese fields are set in pixels. Note that some sizes may not be representable if the\nchroma is subsampled (H.265 section 7.4.3.2.1).\n" }, { "name": "level", "content": "Set the level in the VPS and SPS. See H.265 section A.4 and tables A.6 and A.7.\n\nThe argument must be the name of a level (for example, 5.1), a generallevelidc value\n(for example, 153 for level 5.1), or the special name auto indicating that the filter\nshould attempt to guess the level from the input stream properties.\n" }, { "name": "hevc_mp4toannexb", "content": "Convert an HEVC/H.265 bitstream from length prefixed mode to start code prefixed mode (as\ndefined in the Annex B of the ITU-T H.265 specification).\n\nThis is required by some streaming formats, typically the MPEG-2 transport stream format\n(muxer \"mpegts\").\n\nFor example to remux an MP4 file containing an HEVC stream to mpegts format with ffmpeg, you\ncan use the command:\n\nffmpeg -i INPUT.mp4 -codec copy -bsf:v hevcmp4toannexb OUTPUT.ts\n\nPlease note that this filter is auto-inserted for MPEG-TS (muxer \"mpegts\") and raw HEVC/H.265\n(muxer \"h265\" or \"hevc\") output formats.\n" }, { "name": "imxdump", "content": "Modifies the bitstream to fit in MOV and to be usable by the Final Cut Pro decoder. This\nfilter only applies to the mpeg2video codec, and is likely not needed for Final Cut Pro 7 and\nnewer with the appropriate -tag:v.\n\nFor example, to remux 30 MB/sec NTSC IMX to MOV:\n\nffmpeg -i input.mxf -c copy -bsf:v imxdump -tag:v mx3n output.mov\n" }, { "name": "mjpeg2jpeg", "content": "Convert MJPEG/AVI1 packets to full JPEG/JFIF packets.\n\nMJPEG is a video codec wherein each video frame is essentially a JPEG image. The individual\nframes can be extracted without loss, e.g. by\n\nffmpeg -i ../somemjpeg.avi -c:v copy frames%d.jpg\n\nUnfortunately, these chunks are incomplete JPEG images, because they lack the DHT segment\nrequired for decoding. Quoting from\n:\n\nAvery Lee, writing in the rec.video.desktop newsgroup in 2001, commented that \"MJPEG, or at\nleast the MJPEG in AVIs having the MJPG fourcc, is restricted JPEG with a fixed -- and\n*omitted* -- Huffman table. The JPEG must be YCbCr colorspace, it must be 4:2:2, and it must\nuse basic Huffman encoding, not arithmetic or progressive. . . . You can indeed extract the\nMJPEG frames and decode them with a regular JPEG decoder, but you have to prepend the DHT\nsegment to them, or else the decoder won't have any idea how to decompress the data. The\nexact table necessary is given in the OpenDML spec.\"\n\nThis bitstream filter patches the header of frames extracted from an MJPEG stream (carrying\nthe AVI1 header ID and lacking a DHT segment) to produce fully qualified JPEG images.\n\nffmpeg -i mjpeg-movie.avi -c:v copy -bsf:v mjpeg2jpeg frame%d.jpg\nexiftran -i -9 frame*.jpg\nffmpeg -i frame%d.jpg -c:v copy rotated.avi\n" }, { "name": "mjpegadump", "content": "Add an MJPEG A header to the bitstream, to enable decoding by Quicktime.\n" }, { "name": "mov2textsub", "content": "Extract a representable text file from MOV subtitles, stripping the metadata header from each\nsubtitle packet.\n\nSee also the text2movsub filter.\n" }, { "name": "mp3decomp", "content": "Decompress non-standard compressed MP3 audio headers.\n" }, { "name": "mpeg2_metadata", "content": "Modify metadata embedded in an MPEG-2 stream.\n" }, { "name": "display_aspect_ratio", "content": "Set the display aspect ratio in the stream.\n\nThe following fixed values are supported:\n\n4/3\n16/9\n221/100\n\nAny other value will result in square pixels being signalled instead (see H.262 section\n6.3.3 and table 6-3).\n" }, { "name": "frame_rate", "content": "Set the frame rate in the stream. This is constructed from a table of known values\ncombined with a small multiplier and divisor - if the supplied value is not exactly\nrepresentable, the nearest representable value will be used instead (see H.262 section\n6.3.3 and table 6-4).\n" }, { "name": "video_format", "content": "Set the video format in the stream (see H.262 section 6.3.6 and table 6-6).\n" }, { "name": "colour_primaries", "content": "" }, { "name": "transfer_characteristics", "content": "" }, { "name": "matrix_coefficients", "content": "Set the colour description in the stream (see H.262 section 6.3.6 and tables 6-7, 6-8 and\n6-9).\n" }, { "name": "mpeg4_unpack_bframes", "content": "Unpack DivX-style packed B-frames.\n\nDivX-style packed B-frames are not valid MPEG-4 and were only a workaround for the broken\nVideo for Windows subsystem. They use more space, can cause minor AV sync issues, require\nmore CPU power to decode (unless the player has some decoded picture queue to compensate the\n2,0,2,0 frame per packet style) and cause trouble if copied into a standard container like\nmp4 or mpeg-ps/ts, because MPEG-4 decoders may not be able to decode them, since they are not\nvalid MPEG-4.\n\nFor example to fix an AVI file containing an MPEG-4 stream with DivX-style packed B-frames\nusing ffmpeg, you can use the command:\n\nffmpeg -i INPUT.avi -codec copy -bsf:v mpeg4unpackbframes OUTPUT.avi\n" }, { "name": "noise", "content": "Damages the contents of packets or simply drops them without damaging the container. Can be\nused for fuzzing or testing error resilience/concealment.\n\nParameters:\n" }, { "name": "amount", "content": "Accepts an expression whose evaluation per-packet determines how often bytes in that\npacket will be modified. A value below 0 will result in a variable frequency. Default is\n0 which results in no modification. However, if neither amount nor drop is specified,\namount will be set to -1. See below for accepted variables.\n" }, { "name": "drop", "content": "Accepts an expression evaluated per-packet whose value determines whether that packet is\ndropped. Evaluation to a positive value results in the packet being dropped. Evaluation\nto a negative value results in a variable chance of it being dropped, roughly inverse in\nproportion to the magnitude of the value. Default is 0 which results in no drops. See\nbelow for accepted variables.\n" }, { "name": "dropamount", "content": "Accepts a non-negative integer, which assigns a variable chance of it being dropped,\nroughly inverse in proportion to the value. Default is 0 which results in no drops. This\noption is kept for backwards compatibility and is equivalent to setting drop to a\nnegative value with the same magnitude i.e. \"dropamount=4\" is the same as \"drop=-4\".\nIgnored if drop is also specified.\n\nBoth \"amount\" and \"drop\" accept expressions containing the following variables:\n\nn The index of the packet, starting from zero.\n\ntb The timebase for packet timestamps.\n\npts Packet presentation timestamp.\n\ndts Packet decoding timestamp.\n" }, { "name": "nopts", "content": "Constant representing AVNOPTSVALUE.\n" }, { "name": "startpts", "content": "First non-AVNOPTSVALUE PTS seen in the stream.\n" }, { "name": "startdts", "content": "First non-AVNOPTSVALUE DTS seen in the stream.\n" }, { "name": "duration", "content": "d Packet duration, in timebase units.\n\npos Packet position in input; may be -1 when unknown or not set.\n" }, { "name": "size", "content": "Packet size, in bytes.\n\nkey Whether packet is marked as a keyframe.\n" }, { "name": "state", "content": "A pseudo random integer, primarily derived from the content of packet payload.\n\nExamples\n\nApply modification to every byte but don't drop any packets.\n\nffmpeg -i INPUT -c copy -bsf noise=1 output.mkv\n\nDrop every video packet not marked as a keyframe after timestamp 30s but do not modify any of\nthe remaining packets.\n\nffmpeg -i INPUT -c copy -bsf:v noise=drop='gt(t\\,30)*not(key)' output.mkv\n\nDrop one second of audio every 10 seconds and add some random noise to the rest.\n\nffmpeg -i INPUT -c copy -bsf:a noise=amount=-1:drop='between(mod(t\\,10)\\,9\\,10)' output.mkv\n" }, { "name": "null", "content": "This bitstream filter passes the packets through unchanged.\n" }, { "name": "pcm_rechunk", "content": "Repacketize PCM audio to a fixed number of samples per packet or a fixed packet rate per\nsecond. This is similar to the asetnsamples audio filter but works on audio packets instead\nof audio frames.\n" }, { "name": "nb_out_samples, n", "content": "Set the number of samples per each output audio packet. The number is intended as the\nnumber of samples per each channel. Default value is 1024.\n" }, { "name": "pad, p", "content": "If set to 1, the filter will pad the last audio packet with silence, so that it will\ncontain the same number of samples (or roughly the same number of samples, see\nframerate) as the previous ones. Default value is 1.\n" }, { "name": "frame_rate, r", "content": "This option makes the filter output a fixed number of packets per second instead of a\nfixed number of samples per packet. If the audio sample rate is not divisible by the\nframe rate then the number of samples will not be constant but will vary slightly so that\neach packet will start as close to the frame boundary as possible. Using this option has\nprecedence over nboutsamples.\n\nYou can generate the well known 1602-1601-1602-1601-1602 pattern of 48kHz audio for NTSC\nframe rate using the framerate option.\n\nffmpeg -f lavfi -i sine=r=48000:d=1 -c pcms16le -bsf pcmrechunk=r=30000/1001 -f framecrc -\n" }, { "name": "pgs_frame_merge", "content": "Merge a sequence of PGS Subtitle segments ending with an \"end of display set\" segment into a\nsingle packet.\n\nThis is required by some containers that support PGS subtitles (muxer \"matroska\").\n" }, { "name": "prores_metadata", "content": "Modify color property metadata embedded in prores stream.\n" }, { "name": "color_primaries", "content": "Set the color primaries. Available values are:\n\nauto\nKeep the same color primaries property (default).\n\nunknown\nbt709\nbt470bg\nBT601 625\n\nsmpte170m\nBT601 525\n\nbt2020\nsmpte431\nDCI P3\n\nsmpte432\nP3 D65\n" }, { "name": "transfer_characteristics", "content": "Set the color transfer. Available values are:\n\nauto\nKeep the same transfer characteristics property (default).\n\nunknown\nbt709\nBT 601, BT 709, BT 2020\n\nsmpte2084\nSMPTE ST 2084\n\narib-std-b67\nARIB STD-B67\n" }, { "name": "matrix_coefficients", "content": "Set the matrix coefficient. Available values are:\n\nauto\nKeep the same colorspace property (default).\n\nunknown\nbt709\nsmpte170m\nBT 601\n\nbt2020nc\n\nSet Rec709 colorspace for each frame of the file\n\nffmpeg -i INPUT -c copy -bsf:v proresmetadata=colorprimaries=bt709:colortrc=bt709:colorspace=bt709 output.mov\n\nSet Hybrid Log-Gamma parameters for each frame of the file\n\nffmpeg -i INPUT -c copy -bsf:v proresmetadata=colorprimaries=bt2020:colortrc=arib-std-b67:colorspace=bt2020nc output.mov\n" }, { "name": "remove_extra", "content": "Remove extradata from packets.\n\nIt accepts the following parameter:\n" }, { "name": "freq", "content": "Set which frame types to remove extradata from.\n\nk Remove extradata from non-keyframes only.\n\nkeyframe\nRemove extradata from keyframes only.\n\ne, all\nRemove extradata from all frames.\n" }, { "name": "setts", "content": "Set PTS and DTS in packets.\n\nIt accepts the following parameters:\n\nts" }, { "name": "pts", "content": "dts Set expressions for PTS, DTS or both.\n" }, { "name": "duration", "content": "Set expression for duration.\n" }, { "name": "time_base", "content": "Set output time base.\n\nThe expressions are evaluated through the eval API and can contain the following constants:\n\nN The count of the input packet. Starting from 0.\n\nTS The demux timestamp in input in case of \"ts\" or \"dts\" option or presentation timestamp in\ncase of \"pts\" option.\n\nPOS The original position in the file of the packet, or undefined if undefined for the\ncurrent packet\n\nDTS The demux timestamp in input.\n\nPTS The presentation timestamp in input.\n\nDURATION\nThe duration in input.\n\nSTARTDTS\nThe DTS of the first packet.\n\nSTARTPTS\nThe PTS of the first packet.\n\nPREVINDTS\nThe previous input DTS.\n\nPREVINPTS\nThe previous input PTS.\n\nPREVINDURATION\nThe previous input duration.\n\nPREVOUTDTS\nThe previous output DTS.\n\nPREVOUTPTS\nThe previous output PTS.\n\nPREVOUTDURATION\nThe previous output duration.\n\nNEXTDTS\nThe next input DTS.\n\nNEXTPTS\nThe next input PTS.\n\nNEXTDURATION\nThe next input duration.\n\nTB The timebase of stream packet belongs.\n\nTBOUT\nThe output timebase.\n\nSR The sample rate of stream packet belongs.\n\nNOPTS\nThe AVNOPTSVALUE constant.\n" }, { "name": "text2movsub", "content": "Convert text subtitles to MOV subtitles (as used by the \"movtext\" codec) with metadata\nheaders.\n\nSee also the mov2textsub filter.\n" }, { "name": "trace_headers", "content": "Log trace output containing all syntax elements in the coded stream headers (everything above\nthe level of individual coded blocks). This can be useful for debugging low-level stream\nissues.\n\nSupports AV1, H.264, H.265, (M)JPEG, MPEG-2 and VP9, but depending on the build only a subset\nof these may be available.\n" }, { "name": "truehd_core", "content": "Extract the core from a TrueHD stream, dropping ATMOS data.\n" }, { "name": "vp9_metadata", "content": "Modify metadata embedded in a VP9 stream.\n" }, { "name": "color_space", "content": "Set the color space value in the frame header. Note that any frame set to RGB will be\nimplicitly set to PC range and that RGB is incompatible with profiles 0 and 2.\n\nunknown\nbt601\nbt709\nsmpte170\nsmpte240\nbt2020\nrgb" }, { "name": "color_range", "content": "Set the color range value in the frame header. Note that any value imposed by the color\nspace will take precedence over this value.\n\ntv\npc\n" }, { "name": "vp9_superframe", "content": "Merge VP9 invisible (alt-ref) frames back into VP9 superframes. This fixes merging of\nsplit/segmented VP9 streams where the alt-ref frame was split from its visible counterpart.\n" }, { "name": "vp9_superframe_split", "content": "Split VP9 superframes into single frames.\n" }, { "name": "vp9_raw_reorder", "content": "Given a VP9 stream with correct timestamps but possibly out of order, insert additional show-\nexisting-frame packets to correct the ordering.\n" } ] }, "FORMAT OPTIONS": { "content": "The libavformat library provides some generic global options, which can be set on all the\nmuxers and demuxers. In addition each muxer or demuxer may support so-called private options,\nwhich are specific for that component.\n\nOptions may be set by specifying -option value in the FFmpeg tools, or by setting the value\nexplicitly in the \"AVFormatContext\" options or using the libavutil/opt.h API for programmatic\nuse.\n\nThe list of supported options follows:\n\navioflags flags (input/output)\nPossible values:\n\ndirect\nReduce buffering.\n\nprobesize integer (input)\nSet probing size in bytes, i.e. the size of the data to analyze to get stream\ninformation. A higher value will enable detecting more information in case it is\ndispersed into the stream, but will increase latency. Must be an integer not lesser than\n32. It is 5000000 by default.\n\nmaxprobepackets integer (input)\nSet the maximum number of buffered packets when probing a codec. Default is 2500\npackets.\n\npacketsize integer (output)\nSet packet size.\n\nfflags flags\nSet format flags. Some are implemented for a limited number of formats.\n\nPossible values for input files:\n\ndiscardcorrupt\nDiscard corrupted packets.\n\nfastseek\nEnable fast, but inaccurate seeks for some formats.\n\ngenpts\nGenerate missing PTS if DTS is present.\n\nigndts\nIgnore DTS if PTS is set. Inert when nofillin is set.\n\nignidx\nIgnore index.\n\nnobuffer\nReduce the latency introduced by buffering during initial input streams analysis.\n\nnofillin\nDo not fill in missing values in packet fields that can be exactly calculated.\n\nnoparse\nDisable AVParsers, this needs \"+nofillin\" too.\n\nsortdts\nTry to interleave output packets by DTS. At present, available only for AVIs with an\nindex.\n\nPossible values for output files:\n\nautobsf\nAutomatically apply bitstream filters as required by the output format. Enabled by\ndefault.\n\nbitexact\nOnly write platform-, build- and time-independent data. This ensures that file and\ndata checksums are reproducible and match between platforms. Its primary use is for\nregression testing.\n\nflushpackets\nWrite out packets immediately.\n\nshortest\nStop muxing at the end of the shortest stream. It may be needed to increase\nmaxinterleavedelta to avoid flushing the longer streams before EOF.\n\nseek2any integer (input)\nAllow seeking to non-keyframes on demuxer level when supported if set to 1. Default is\n0.\n\nanalyzeduration integer (input)\nSpecify how many microseconds are analyzed to probe the input. A higher value will enable\ndetecting more accurate information, but will increase latency. It defaults to 5,000,000\nmicroseconds = 5 seconds.\n\ncryptokey hexadecimal string (input)\nSet decryption key.\n\nindexmem integer (input)\nSet max memory used for timestamp index (per stream).\n\nrtbufsize integer (input)\nSet max memory used for buffering real-time frames.\n\nfdebug flags (input/output)\nPrint specific debug info.\n\nPossible values:\n\nts\nmaxdelay integer (input/output)\nSet maximum muxing or demuxing delay in microseconds.\n\nfpsprobesize integer (input)\nSet number of frames used to probe fps.\n\naudiopreload integer (output)\nSet microseconds by which audio packets should be interleaved earlier.\n\nchunkduration integer (output)\nSet microseconds for each chunk.\n\nchunksize integer (output)\nSet size in bytes for each chunk.\n\nerrdetect, ferrdetect flags (input)\nSet error detection flags. \"ferrdetect\" is deprecated and should be used only via the\nffmpeg tool.\n\nPossible values:\n\ncrccheck\nVerify embedded CRCs.\n\nbitstream\nDetect bitstream specification deviations.\n\nbuffer\nDetect improper bitstream length.\n\nexplode\nAbort decoding on minor error detection.\n\ncareful\nConsider things that violate the spec and have not been seen in the wild as errors.\n\ncompliant\nConsider all spec non compliancies as errors.\n\naggressive\nConsider things that a sane encoder should not do as an error.\n\nmaxinterleavedelta integer (output)\nSet maximum buffering duration for interleaving. The duration is expressed in\nmicroseconds, and defaults to 10000000 (10 seconds).\n\nTo ensure all the streams are interleaved correctly, libavformat will wait until it has\nat least one packet for each stream before actually writing any packets to the output\nfile. When some streams are \"sparse\" (i.e. there are large gaps between successive\npackets), this can result in excessive buffering.\n\nThis field specifies the maximum difference between the timestamps of the first and the\nlast packet in the muxing queue, above which libavformat will output a packet regardless\nof whether it has queued a packet for all the streams.\n\nIf set to 0, libavformat will continue buffering packets until it has a packet for each\nstream, regardless of the maximum timestamp difference between the buffered packets.\n\nusewallclockastimestamps integer (input)\nUse wallclock as timestamps if set to 1. Default is 0.\n\navoidnegativets integer (output)\nPossible values:\n\nmakenonnegative\nShift timestamps to make them non-negative. Also note that this affects only leading\nnegative timestamps, and not non-monotonic negative timestamps.\n\nmakezero\nShift timestamps so that the first timestamp is 0.\n\nauto (default)\nEnables shifting when required by the target format.\n\ndisabled\nDisables shifting of timestamp.\n\nWhen shifting is enabled, all output timestamps are shifted by the same amount. Audio,\nvideo, and subtitles desynching and relative timestamp differences are preserved compared\nto how they would have been without shifting.\n\nskipinitialbytes integer (input)\nSet number of bytes to skip before reading header and frames if set to 1. Default is 0.\n\ncorrecttsoverflow integer (input)\nCorrect single timestamp overflows if set to 1. Default is 1.\n\nflushpackets integer (output)\nFlush the underlying I/O stream after each packet. Default is -1 (auto), which means that\nthe underlying protocol will decide, 1 enables it, and has the effect of reducing the\nlatency, 0 disables it and may increase IO throughput in some cases.\n\noutputtsoffset offset (output)\nSet the output time offset.\n\noffset must be a time duration specification, see the Time duration section in the\nffmpeg-utils(1) manual.\n\nThe offset is added by the muxer to the output timestamps.\n\nSpecifying a positive offset means that the corresponding streams are delayed bt the time\nduration specified in offset. Default value is 0 (meaning that no offset is applied).\n\nformatwhitelist list (input)\n\",\" separated list of allowed demuxers. By default all are allowed.\n\ndumpseparator string (input)\nSeparator used to separate the fields printed on the command line about the Stream\nparameters. For example, to separate the fields with newlines and indentation:\n\nffprobe -dumpseparator \"\n\" -i ~/videos/matrixbenchmpeg2.mpg\n\nmaxstreams integer (input)\nSpecifies the maximum number of streams. This can be used to reject files that would\nrequire too many resources due to a large number of streams.\n\nskipestimatedurationfrompts bool (input)\nSkip estimation of input duration when calculated using PTS. At present, applicable for\nMPEG-PS and MPEG-TS.\n\nstrict, fstrict integer (input/output)\nSpecify how strictly to follow the standards. \"fstrict\" is deprecated and should be used\nonly via the ffmpeg tool.\n\nPossible values:\n\nvery\nstrictly conform to an older more strict version of the spec or reference software\n\nstrict\nstrictly conform to all the things in the spec no matter what consequences\n\nnormal\nunofficial\nallow unofficial extensions\n\nexperimental\nallow non standardized experimental things, experimental (unfinished/work in\nprogress/not well tested) decoders and encoders. Note: experimental decoders can\npose a security risk, do not use this for decoding untrusted input.\n", "subsections": [ { "name": "Format stream specifiers", "content": "Format stream specifiers allow selection of one or more streams that match specific\nproperties.\n\nThe exact semantics of stream specifiers is defined by the avformatmatchstreamspecifier()\nfunction declared in the libavformat/avformat.h header and documented in the Stream\nspecifiers section in the ffmpeg(1) manual.\n" } ] }, "DEMUXERS": { "content": "Demuxers are configured elements in FFmpeg that can read the multimedia streams from a\nparticular type of file.\n\nWhen you configure your FFmpeg build, all the supported demuxers are enabled by default. You\ncan list all available ones using the configure option \"--list-demuxers\".\n\nYou can disable all the demuxers using the configure option \"--disable-demuxers\", and\nselectively enable a single demuxer with the option \"--enable-demuxer=DEMUXER\", or disable it\nwith the option \"--disable-demuxer=DEMUXER\".\n\nThe option \"-demuxers\" of the ff* tools will display the list of enabled demuxers. Use\n\"-formats\" to view a combined list of enabled demuxers and muxers.\n\nThe description of some of the currently available demuxers follows.\n\naa\nAudible Format 2, 3, and 4 demuxer.\n\nThis demuxer is used to demux Audible Format 2, 3, and 4 (.aa) files.\n", "subsections": [ { "name": "aac", "content": "Raw Audio Data Transport Stream AAC demuxer.\n\nThis demuxer is used to demux an ADTS input containing a single AAC stream alongwith any\nID3v1/2 or APE tags in it.\n" }, { "name": "apng", "content": "Animated Portable Network Graphics demuxer.\n\nThis demuxer is used to demux APNG files. All headers, but the PNG signature, up to (but not\nincluding) the first fcTL chunk are transmitted as extradata. Frames are then split as being\nall the chunks between two fcTL ones, or between the last fcTL and IEND chunks.\n" }, { "name": "-ignore_loop _", "content": "Ignore the loop variable in the file if set. Default is enabled.\n" }, { "name": "-max_fps _", "content": "Maximum framerate in frames per second. Default of 0 imposes no limit.\n" }, { "name": "-default_fps _", "content": "Default framerate in frames per second when none is specified in the file (0 meaning as\nfast as possible). Default is 15.\n" }, { "name": "asf", "content": "Advanced Systems Format demuxer.\n\nThis demuxer is used to demux ASF files and MMS network streams.\n" }, { "name": "-no_resync_search _", "content": "Do not try to resynchronize by looking for a certain optional start code.\n" }, { "name": "concat", "content": "Virtual concatenation script demuxer.\n\nThis demuxer reads a list of files and other directives from a text file and demuxes them one\nafter the other, as if all their packets had been muxed together.\n\nThe timestamps in the files are adjusted so that the first file starts at 0 and each next\nfile starts where the previous one finishes. Note that it is done globally and may cause gaps\nif all streams do not have exactly the same length.\n\nAll files must have the same streams (same codecs, same time base, etc.).\n\nThe duration of each file is used to adjust the timestamps of the next file: if the duration\nis incorrect (because it was computed using the bit-rate or because the file is truncated,\nfor example), it can cause artifacts. The \"duration\" directive can be used to override the\nduration stored in each file.\n\nSyntax\n\nThe script is a text file in extended-ASCII, with one directive per line. Empty lines,\nleading spaces and lines starting with '#' are ignored. The following directive is\nrecognized:\n" }, { "name": "\"file path\"", "content": "Path to a file to read; special characters and spaces must be escaped with backslash or\nsingle quotes.\n\nAll subsequent file-related directives apply to that file.\n" }, { "name": "\"ffconcat version 1.0\"", "content": "Identify the script type and version.\n\nTo make FFmpeg recognize the format automatically, this directive must appear exactly as\nis (no extra space or byte-order-mark) on the very first line of the script.\n" }, { "name": "\"duration dur\"", "content": "Duration of the file. This information can be specified from the file; specifying it here\nmay be more efficient or help if the information from the file is not available or\naccurate.\n\nIf the duration is set for all files, then it is possible to seek in the whole\nconcatenated video.\n" }, { "name": "\"inpoint timestamp\"", "content": "In point of the file. When the demuxer opens the file it instantly seeks to the specified\ntimestamp. Seeking is done so that all streams can be presented successfully at In point.\n\nThis directive works best with intra frame codecs, because for non-intra frame ones you\nwill usually get extra packets before the actual In point and the decoded content will\nmost likely contain frames before In point too.\n\nFor each file, packets before the file In point will have timestamps less than the\ncalculated start timestamp of the file (negative in case of the first file), and the\nduration of the files (if not specified by the \"duration\" directive) will be reduced\nbased on their specified In point.\n\nBecause of potential packets before the specified In point, packet timestamps may overlap\nbetween two concatenated files.\n" }, { "name": "\"outpoint timestamp\"", "content": "Out point of the file. When the demuxer reaches the specified decoding timestamp in any\nof the streams, it handles it as an end of file condition and skips the current and all\nthe remaining packets from all streams.\n\nOut point is exclusive, which means that the demuxer will not output packets with a\ndecoding timestamp greater or equal to Out point.\n\nThis directive works best with intra frame codecs and formats where all streams are\ntightly interleaved. For non-intra frame codecs you will usually get additional packets\nwith presentation timestamp after Out point therefore the decoded content will most\nlikely contain frames after Out point too. If your streams are not tightly interleaved\nyou may not get all the packets from all streams before Out point and you may only will\nbe able to decode the earliest stream until Out point.\n\nThe duration of the files (if not specified by the \"duration\" directive) will be reduced\nbased on their specified Out point.\n" }, { "name": "\"file_packet_metadata key=value\"", "content": "Metadata of the packets of the file. The specified metadata will be set for each file\npacket. You can specify this directive multiple times to add multiple metadata entries.\nThis directive is deprecated, use \"filepacketmeta\" instead.\n" }, { "name": "\"file_packet_meta key value\"", "content": "Metadata of the packets of the file. The specified metadata will be set for each file\npacket. You can specify this directive multiple times to add multiple metadata entries.\n" }, { "name": "\"option key value\"", "content": "Option to access, open and probe the file. Can be present multiple times.\n" }, { "name": "\"stream\"", "content": "Introduce a stream in the virtual file. All subsequent stream-related directives apply\nto the last introduced stream. Some streams properties must be set in order to allow\nidentifying the matching streams in the subfiles. If no streams are defined in the\nscript, the streams from the first file are copied.\n" }, { "name": "\"exact_stream_id id\"", "content": "Set the id of the stream. If this directive is given, the string with the corresponding\nid in the subfiles will be used. This is especially useful for MPEG-PS (VOB) files,\nwhere the order of the streams is not reliable.\n" }, { "name": "\"stream_meta key value\"", "content": "Metadata for the stream. Can be present multiple times.\n" }, { "name": "\"stream_codec value\"", "content": "Codec for the stream.\n" }, { "name": "\"stream_extradata hex_string\"", "content": "Extradata for the string, encoded in hexadecimal.\n" }, { "name": "\"chapter id start end\"", "content": "Add a chapter. id is an unique identifier, possibly small and consecutive.\n\nOptions\n\nThis demuxer accepts the following option:\n" }, { "name": "safe", "content": "If set to 1, reject unsafe file paths and directives. A file path is considered safe if\nit does not contain a protocol specification and is relative and all components only\ncontain characters from the portable character set (letters, digits, period, underscore\nand hyphen) and have no period at the beginning of a component.\n\nIf set to 0, any file name is accepted.\n\nThe default is 1.\n" }, { "name": "auto_convert", "content": "If set to 1, try to perform automatic conversions on packet data to make the streams\nconcatenable. The default is 1.\n\nCurrently, the only conversion is adding the h264mp4toannexb bitstream filter to H.264\nstreams in MP4 format. This is necessary in particular if there are resolution changes.\n" }, { "name": "segment_time_metadata", "content": "If set to 1, every packet will contain the lavf.concat.starttime and the\nlavf.concat.duration packet metadata values which are the starttime and the duration of\nthe respective file segments in the concatenated output expressed in microseconds. The\nduration metadata is only set if it is known based on the concat file. The default is 0.\n\nExamples\n\n• Use absolute filenames and include some comments:\n\n# my first filename\nfile /mnt/share/file-1.wav\n# my second filename including whitespace\nfile '/mnt/share/file 2.wav'\n# my third filename including whitespace plus single quote\nfile '/mnt/share/file 3'\\''.wav'\n\n• Allow for input format auto-probing, use safe filenames and set the duration of the first\nfile:\n\nffconcat version 1.0\n\nfile file-1.wav\nduration 20.0\n\nfile subdir/file-2.wav\n" }, { "name": "dash", "content": "Dynamic Adaptive Streaming over HTTP demuxer.\n\nThis demuxer presents all AVStreams found in the manifest. By setting the discard flags on\nAVStreams the caller can decide which streams to actually receive. Each stream mirrors the\n\"id\" and \"bandwidth\" properties from the \"\" as metadata keys named \"id\" and\n\"variantbitrate\" respectively.\n\nOptions\n\nThis demuxer accepts the following option:\n" }, { "name": "cenc_decryption_key", "content": "16-byte key, in hex, to decrypt files encrypted using ISO Common Encryption (CENC/AES-128\nCTR; ISO/IEC 23001-7).\n\nea\nElectronic Arts Multimedia format demuxer.\n\nThis format is used by various Electronic Arts games.\n\nOptions\n\nmergealpha bool\nNormally the VP6 alpha channel (if exists) is returned as a secondary video stream, by\nsetting this option you can make the demuxer return a single video stream which contains\nthe alpha channel in addition to the ordinary video.\n" }, { "name": "imf", "content": "Interoperable Master Format demuxer.\n\nThis demuxer presents audio and video streams found in an IMF Composition, as specified in\n.\n\nffmpeg [-assetmaps ,,...] -i ...\n\nIf \"-assetmaps\" is not specified, the demuxer looks for a file called ASSETMAP.xml in the\nsame directory as the CPL.\n" }, { "name": "flv, live_flv, kux", "content": "Adobe Flash Video Format demuxer.\n\nThis demuxer is used to demux FLV files and RTMP network streams. In case of live network\nstreams, if you force format, you may use liveflv option instead of flv to survive timestamp\ndiscontinuities. KUX is a flv variant used on the Youku platform.\n\nffmpeg -f flv -i myfile.flv ...\nffmpeg -f liveflv -i rtmp:///anything/key ....\n" }, { "name": "-flv_metadata _", "content": "Allocate the streams according to the onMetaData array content.\n" }, { "name": "-flv_ignore_prevtag _", "content": "Ignore the size of previous tag value.\n" }, { "name": "-flv_full_metadata _", "content": "Output all context of the onMetadata.\n" }, { "name": "gif", "content": "Animated GIF demuxer.\n\nIt accepts the following options:\n" }, { "name": "min_delay", "content": "Set the minimum valid delay between frames in hundredths of seconds. Range is 0 to 6000.\nDefault value is 2.\n" }, { "name": "max_gif_delay", "content": "Set the maximum valid delay between frames in hundredth of seconds. Range is 0 to 65535.\nDefault value is 65535 (nearly eleven minutes), the maximum value allowed by the\nspecification.\n" }, { "name": "default_delay", "content": "Set the default delay between frames in hundredths of seconds. Range is 0 to 6000.\nDefault value is 10.\n" }, { "name": "ignore_loop", "content": "GIF files can contain information to loop a certain number of times (or infinitely). If\nignoreloop is set to 1, then the loop setting from the input will be ignored and looping\nwill not occur. If set to 0, then looping will occur and will cycle the number of times\naccording to the GIF. Default value is 1.\n\nFor example, with the overlay filter, place an infinitely looping GIF over another video:\n\nffmpeg -i input.mp4 -ignoreloop 0 -i input.gif -filtercomplex overlay=shortest=1 out.mkv\n\nNote that in the above example the shortest option for overlay filter is used to end the\noutput video at the length of the shortest input file, which in this case is input.mp4 as the\nGIF in this example loops infinitely.\n" }, { "name": "hls", "content": "HLS demuxer\n\nApple HTTP Live Streaming demuxer.\n\nThis demuxer presents all AVStreams from all variant streams. The id field is set to the\nbitrate variant index number. By setting the discard flags on AVStreams (by pressing 'a' or\n'v' in ffplay), the caller can decide which variant streams to actually receive. The total\nbitrate of the variant that the stream belongs to is available in a metadata key named\n\"variantbitrate\".\n\nIt accepts the following options:\n" }, { "name": "live_start_index", "content": "segment index to start live streams at (negative values are from the end).\n" }, { "name": "prefer_x_start", "content": "prefer to use #EXT-X-START if it's in playlist instead of livestartindex.\n" }, { "name": "allowed_extensions", "content": "',' separated list of file extensions that hls is allowed to access.\n" }, { "name": "max_reload", "content": "Maximum number of times a insufficient list is attempted to be reloaded. Default value\nis 1000.\n" }, { "name": "m3u8_hold_counters", "content": "The maximum number of times to load m3u8 when it refreshes without new segments. Default\nvalue is 1000.\n" }, { "name": "http_persistent", "content": "Use persistent HTTP connections. Applicable only for HTTP streams. Enabled by default.\n" }, { "name": "http_multiple", "content": "Use multiple HTTP connections for downloading HTTP segments. Enabled by default for\nHTTP/1.1 servers.\n" }, { "name": "http_seekable", "content": "Use HTTP partial requests for downloading HTTP segments. 0 = disable, 1 = enable, -1 =\nauto, Default is auto.\n" }, { "name": "seg_format_options", "content": "Set options for the demuxer of media segments using a list of key=value pairs separated\nby \":\".\n" }, { "name": "seg_max_retry", "content": "Maximum number of times to reload a segment on error, useful when segment skip on network\nerror is not desired. Default value is 0.\n" }, { "name": "image2", "content": "Image file demuxer.\n\nThis demuxer reads from a list of image files specified by a pattern. The syntax and meaning\nof the pattern is specified by the option patterntype.\n\nThe pattern may contain a suffix which is used to automatically determine the format of the\nimages contained in the files.\n\nThe size, the pixel format, and the format of each image must be the same for all the files\nin the sequence.\n\nThis demuxer accepts the following options:\n" }, { "name": "framerate", "content": "Set the frame rate for the video stream. It defaults to 25.\n" }, { "name": "loop", "content": "If set to 1, loop over the input. Default value is 0.\n" }, { "name": "pattern_type", "content": "Select the pattern type used to interpret the provided filename.\n\npatterntype accepts one of the following values.\n\nnone\nDisable pattern matching, therefore the video will only contain the specified image.\nYou should use this option if you do not want to create sequences from multiple\nimages and your filenames may contain special pattern characters.\n\nsequence\nSelect a sequence pattern type, used to specify a sequence of files indexed by\nsequential numbers.\n\nA sequence pattern may contain the string \"%d\" or \"%0Nd\", which specifies the\nposition of the characters representing a sequential number in each filename matched\nby the pattern. If the form \"%d0Nd\" is used, the string representing the number in\neach filename is 0-padded and N is the total number of 0-padded digits representing\nthe number. The literal character '%' can be specified in the pattern with the string\n\"%%\".\n\nIf the sequence pattern contains \"%d\" or \"%0Nd\", the first filename of the file list\nspecified by the pattern must contain a number inclusively contained between\nstartnumber and startnumber+startnumberrange-1, and all the following numbers\nmust be sequential.\n\nFor example the pattern \"img-%03d.bmp\" will match a sequence of filenames of the form\nimg-001.bmp, img-002.bmp, ..., img-010.bmp, etc.; the pattern \"i%%m%%g-%d.jpg\" will\nmatch a sequence of filenames of the form i%m%g-1.jpg, i%m%g-2.jpg, ...,\ni%m%g-10.jpg, etc.\n\nNote that the pattern must not necessarily contain \"%d\" or \"%0Nd\", for example to\nconvert a single image file img.jpeg you can employ the command:\n\nffmpeg -i img.jpeg img.png\n\nglob\nSelect a glob wildcard pattern type.\n\nThe pattern is interpreted like a glob() pattern. This is only selectable if\nlibavformat was compiled with globbing support.\n\nglobsequence (deprecated, will be removed)\nSelect a mixed glob wildcard/sequence pattern.\n\nIf your version of libavformat was compiled with globbing support, and the provided\npattern contains at least one glob meta character among \"%*?[]{}\" that is preceded by\nan unescaped \"%\", the pattern is interpreted like a glob() pattern, otherwise it is\ninterpreted like a sequence pattern.\n\nAll glob special characters \"%*?[]{}\" must be prefixed with \"%\". To escape a literal\n\"%\" you shall use \"%%\".\n\nFor example the pattern \"foo-%*.jpeg\" will match all the filenames prefixed by \"foo-\"\nand terminating with \".jpeg\", and \"foo-%?%?%?.jpeg\" will match all the filenames\nprefixed with \"foo-\", followed by a sequence of three characters, and terminating\nwith \".jpeg\".\n\nThis pattern type is deprecated in favor of glob and sequence.\n\nDefault value is globsequence.\n" }, { "name": "pixel_format", "content": "Set the pixel format of the images to read. If not specified the pixel format is guessed\nfrom the first image file in the sequence.\n" }, { "name": "start_number", "content": "Set the index of the file matched by the image file pattern to start to read from.\nDefault value is 0.\n" }, { "name": "start_number_range", "content": "Set the index interval range to check when looking for the first image file in the\nsequence, starting from startnumber. Default value is 5.\n" }, { "name": "ts_from_file", "content": "If set to 1, will set frame timestamp to modification time of image file. Note that\nmonotonity of timestamps is not provided: images go in the same order as without this\noption. Default value is 0. If set to 2, will set frame timestamp to the modification\ntime of the image file in nanosecond precision.\n" }, { "name": "video_size", "content": "Set the video size of the images to read. If not specified the video size is guessed from\nthe first image file in the sequence.\n" }, { "name": "export_path_metadata", "content": "If set to 1, will add two extra fields to the metadata found in input, making them also\navailable for other filters (see drawtext filter for examples). Default value is 0. The\nextra fields are described below:\n\nlavf.image2dec.sourcepath\nCorresponds to the full path to the input file being read.\n\nlavf.image2dec.sourcebasename\nCorresponds to the name of the file being read.\n\nExamples\n\n• Use ffmpeg for creating a video from the images in the file sequence img-001.jpeg,\nimg-002.jpeg, ..., assuming an input frame rate of 10 frames per second:\n\nffmpeg -framerate 10 -i 'img-%03d.jpeg' out.mkv\n\n• As above, but start by reading from a file with index 100 in the sequence:\n\nffmpeg -framerate 10 -startnumber 100 -i 'img-%03d.jpeg' out.mkv\n\n• Read images matching the \"*.png\" glob pattern , that is all the files terminating with\nthe \".png\" suffix:\n\nffmpeg -framerate 10 -patterntype glob -i \"*.png\" out.mkv\n" }, { "name": "libgme", "content": "The Game Music Emu library is a collection of video game music file emulators.\n\nSee for more information.\n\nIt accepts the following options:\n" }, { "name": "track_index", "content": "Set the index of which track to demux. The demuxer can only export one track. Track\nindexes start at 0. Default is to pick the first track. Number of tracks is exported as\ntracks metadata entry.\n" }, { "name": "sample_rate", "content": "Set the sampling rate of the exported track. Range is 1000 to 999999. Default is 44100.\n" }, { "name": "max_size _(bytes)", "content": "The demuxer buffers the entire file into memory. Adjust this value to set the maximum\nbuffer size, which in turn, acts as a ceiling for the size of files that can be read.\nDefault is 50 MiB.\n" }, { "name": "libmodplug", "content": "ModPlug based module demuxer\n\nSee \n\nIt will export one 2-channel 16-bit 44.1 kHz audio stream. Optionally, a \"pal8\" 16-color\nvideo stream can be exported with or without printed metadata.\n\nIt accepts the following options:\n" }, { "name": "noise_reduction", "content": "Apply a simple low-pass filter. Can be 1 (on) or 0 (off). Default is 0.\n" }, { "name": "reverb_depth", "content": "Set amount of reverb. Range 0-100. Default is 0.\n" }, { "name": "reverb_delay", "content": "Set delay in ms, clamped to 40-250 ms. Default is 0.\n" }, { "name": "bass_amount", "content": "Apply bass expansion a.k.a. XBass or megabass. Range is 0 (quiet) to 100 (loud). Default\nis 0.\n" }, { "name": "bass_range", "content": "Set cutoff i.e. upper-bound for bass frequencies. Range is 10-100 Hz. Default is 0.\n" }, { "name": "surround_depth", "content": "Apply a Dolby Pro-Logic surround effect. Range is 0 (quiet) to 100 (heavy). Default is 0.\n" }, { "name": "surround_delay", "content": "Set surround delay in ms, clamped to 5-40 ms. Default is 0.\n" }, { "name": "max_size", "content": "The demuxer buffers the entire file into memory. Adjust this value to set the maximum\nbuffer size, which in turn, acts as a ceiling for the size of files that can be read.\nRange is 0 to 100 MiB. 0 removes buffer size limit (not recommended). Default is 5 MiB.\n" }, { "name": "video_stream_expr", "content": "String which is evaluated using the eval API to assign colors to the generated video\nstream. Variables which can be used are \"x\", \"y\", \"w\", \"h\", \"t\", \"speed\", \"tempo\",\n\"order\", \"pattern\" and \"row\".\n" }, { "name": "video_stream", "content": "Generate video stream. Can be 1 (on) or 0 (off). Default is 0.\n" }, { "name": "video_stream_w", "content": "Set video frame width in 'chars' where one char indicates 8 pixels. Range is 20-512.\nDefault is 30.\n" }, { "name": "video_stream_h", "content": "Set video frame height in 'chars' where one char indicates 8 pixels. Range is 20-512.\nDefault is 30.\n" }, { "name": "video_stream_ptxt", "content": "Print metadata on video stream. Includes \"speed\", \"tempo\", \"order\", \"pattern\", \"row\" and\n\"ts\" (time in ms). Can be 1 (on) or 0 (off). Default is 1.\n" }, { "name": "libopenmpt", "content": "libopenmpt based module demuxer\n\nSee for more information.\n\nSome files have multiple subsongs (tracks) this can be set with the subsong option.\n\nIt accepts the following options:\n" }, { "name": "subsong", "content": "Set the subsong index. This can be either 'all', 'auto', or the index of the subsong.\nSubsong indexes start at 0. The default is 'auto'.\n\nThe default value is to let libopenmpt choose.\n" }, { "name": "layout", "content": "Set the channel layout. Valid values are 1, 2, and 4 channel layouts. The default value\nis STEREO.\n" }, { "name": "sample_rate", "content": "Set the sample rate for libopenmpt to output. Range is from 1000 to INTMAX. The value\ndefault is 48000.\n" }, { "name": "mov/mp4/3gp", "content": "Demuxer for Quicktime File Format & ISO/IEC Base Media File Format (ISO/IEC 14496-12 or\nMPEG-4 Part 12, ISO/IEC 15444-12 or JPEG 2000 Part 12).\n\nRegistered extensions: mov, mp4, m4a, 3gp, 3g2, mj2, psp, m4b, ism, ismv, isma, f4v\n\nOptions\n\nThis demuxer accepts the following options:\n" }, { "name": "enable_drefs", "content": "Enable loading of external tracks, disabled by default. Enabling this can theoretically\nleak information in some use cases.\n" }, { "name": "use_absolute_path", "content": "Allows loading of external tracks via absolute paths, disabled by default. Enabling this\nposes a security risk. It should only be enabled if the source is known to be non-\nmalicious.\n" }, { "name": "seek_streams_individually", "content": "When seeking, identify the closest point in each stream individually and demux packets in\nthat stream from identified point. This can lead to a different sequence of packets\ncompared to demuxing linearly from the beginning. Default is true.\n" }, { "name": "ignore_editlist", "content": "Ignore any edit list atoms. The demuxer, by default, modifies the stream index to reflect\nthe timeline described by the edit list. Default is false.\n" }, { "name": "advanced_editlist", "content": "Modify the stream index to reflect the timeline described by the edit list.\n\"ignoreeditlist\" must be set to false for this option to be effective. If both\n\"ignoreeditlist\" and this option are set to false, then only the start of the stream\nindex is modified to reflect initial dwell time or starting timestamp described by the\nedit list. Default is true.\n" }, { "name": "ignore_chapters", "content": "Don't parse chapters. This includes GoPro 'HiLight' tags/moments. Note that chapters are\nonly parsed when input is seekable. Default is false.\n" }, { "name": "use_mfra_for", "content": "For seekable fragmented input, set fragment's starting timestamp from media fragment\nrandom access box, if present.\n\nFollowing options are available:\n\nauto\nAuto-detect whether to set mfra timestamps as PTS or DTS (default)\n\ndts Set mfra timestamps as DTS\n\npts Set mfra timestamps as PTS\n\n0 Don't use mfra box to set timestamps\n" }, { "name": "use_tfdt", "content": "For fragmented input, set fragment's starting timestamp to \"baseMediaDecodeTime\" from the\n\"tfdt\" box. Default is enabled, which will prefer to use the \"tfdt\" box to set DTS.\nDisable to use the \"earliestpresentationtime\" from the \"sidx\" box. In either case, the\ntimestamp from the \"mfra\" box will be used if it's available and \"usemfrafor\" is set to\npts or dts.\n" }, { "name": "export_all", "content": "Export unrecognized boxes within the udta box as metadata entries. The first four\ncharacters of the box type are set as the key. Default is false.\n" }, { "name": "export_xmp", "content": "Export entire contents of XMP box and uuid box as a string with key \"xmp\". Note that if\n\"exportall\" is set and this option isn't, the contents of XMP box are still exported\nbut with key \"XMP\". Default is false.\n" }, { "name": "activation_bytes", "content": "4-byte key required to decrypt Audible AAX and AAX+ files. See Audible AAX subsection\nbelow.\n" }, { "name": "audible_fixed_key", "content": "Fixed key used for handling Audible AAX/AAX+ files. It has been pre-set so should not be\nnecessary to specify.\n" }, { "name": "decryption_key", "content": "16-byte key, in hex, to decrypt files encrypted using ISO Common Encryption (CENC/AES-128\nCTR; ISO/IEC 23001-7).\n" }, { "name": "max_stts_delta", "content": "Very high sample deltas written in a trak's stts box may occasionally be intended but\nusually they are written in error or used to store a negative value for dts correction\nwhen treated as signed 32-bit integers. This option lets the user set an upper limit,\nbeyond which the delta is clamped to 1. Values greater than the limit if negative when\ncast to int32 are used to adjust onward dts.\n\nUnit is the track time scale. Range is 0 to UINTMAX. Default is \"UINTMAX - 48000*10\"\nwhich allows upto a 10 second dts correction for 48 kHz audio streams while accommodating\n99.9% of \"uint32\" range.\n" }, { "name": "interleaved_read", "content": "Interleave packets from multiple tracks at demuxer level. For badly interleaved files,\nthis prevents playback issues caused by large gaps between packets in different tracks,\nas MOV/MP4 do not have packet placement requirements. However, this can cause excessive\nseeking on very badly interleaved files, due to seeking between tracks, so disabling it\nmay prevent I/O issues, at the expense of playback.\n\nAudible AAX\n\nAudible AAX files are encrypted M4B files, and they can be decrypted by specifying a 4 byte\nactivation secret.\n\nffmpeg -activationbytes 1CEB00DA -i test.aax -vn -c:a copy output.mp4\n" }, { "name": "mpegts", "content": "MPEG-2 transport stream demuxer.\n\nThis demuxer accepts the following options:\n" }, { "name": "resync_size", "content": "Set size limit for looking up a new synchronization. Default value is 65536.\n" }, { "name": "skip_unknown_pmt", "content": "Skip PMTs for programs not defined in the PAT. Default value is 0.\n" }, { "name": "fix_teletext_pts", "content": "Override teletext packet PTS and DTS values with the timestamps calculated from the PCR\nof the first program which the teletext stream is part of and is not discarded. Default\nvalue is 1, set this option to 0 if you want your teletext packet PTS and DTS values\nuntouched.\n" }, { "name": "ts_packetsize", "content": "Output option carrying the raw packet size in bytes. Show the detected raw packet size,\ncannot be set by the user.\n" }, { "name": "scan_all_pmts", "content": "Scan and combine all PMTs. The value is an integer with value from -1 to 1 (-1 means\nautomatic setting, 1 means enabled, 0 means disabled). Default value is -1.\n" }, { "name": "merge_pmt_versions", "content": "Re-use existing streams when a PMT's version is updated and elementary streams move to\ndifferent PIDs. Default value is 0.\n" }, { "name": "max_packet_size", "content": "Set maximum size, in bytes, of packet emitted by the demuxer. Payloads above this size\nare split across multiple packets. Range is 1 to INTMAX/2. Default is 204800 bytes.\n" }, { "name": "mpjpeg", "content": "MJPEG encapsulated in multi-part MIME demuxer.\n\nThis demuxer allows reading of MJPEG, where each frame is represented as a part of\nmultipart/x-mixed-replace stream.\n" }, { "name": "strict_mime_boundary", "content": "Default implementation applies a relaxed standard to multi-part MIME boundary detection,\nto prevent regression with numerous existing endpoints not generating a proper MIME MJPEG\nstream. Turning this option on by setting it to 1 will result in a stricter check of the\nboundary value.\n" }, { "name": "rawvideo", "content": "Raw video demuxer.\n\nThis demuxer allows one to read raw video data. Since there is no header specifying the\nassumed video parameters, the user must specify them in order to be able to decode the data\ncorrectly.\n\nThis demuxer accepts the following options:\n" }, { "name": "framerate", "content": "Set input video frame rate. Default value is 25.\n" }, { "name": "pixel_format", "content": "Set the input video pixel format. Default value is \"yuv420p\".\n" }, { "name": "video_size", "content": "Set the input video size. This value must be specified explicitly.\n\nFor example to read a rawvideo file input.raw with ffplay, assuming a pixel format of\n\"rgb24\", a video size of \"320x240\", and a frame rate of 10 images per second, use the\ncommand:\n\nffplay -f rawvideo -pixelformat rgb24 -videosize 320x240 -framerate 10 input.raw\n" }, { "name": "sbg", "content": "SBaGen script demuxer.\n\nThis demuxer reads the script language used by SBaGen to generate\nbinaural beats sessions. A SBG script looks like that:\n\n-SE\na: 300-2.5/3 440+4.5/0\nb: 300-2.5/0 440+4.5/3\noff: -\nNOW == a\n+0:07:00 == b\n+0:14:00 == a\n+0:21:00 == b\n+0:30:00 off\n\nA SBG script can mix absolute and relative timestamps. If the script uses either only\nabsolute timestamps (including the script start time) or only relative ones, then its layout\nis fixed, and the conversion is straightforward. On the other hand, if the script mixes both\nkind of timestamps, then the NOW reference for relative timestamps will be taken from the\ncurrent time of day at the time the script is read, and the script layout will be frozen\naccording to that reference. That means that if the script is directly played, the actual\ntimes will match the absolute timestamps up to the sound controller's clock accuracy, but if\nthe user somehow pauses the playback or seeks, all times will be shifted accordingly.\n" }, { "name": "tedcaptions", "content": "JSON captions used for .\n\nTED does not provide links to the captions, but they can be guessed from the page. The file\ntools/bookmarklets.html from the FFmpeg source tree contains a bookmarklet to expose them.\n\nThis demuxer accepts the following option:\n" }, { "name": "start_time", "content": "Set the start time of the TED talk, in milliseconds. The default is 15000 (15s). It is\nused to sync the captions with the downloadable videos, because they include a 15s intro.\n\nExample: convert the captions to a format most players understand:\n\nffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt\n" }, { "name": "vapoursynth", "content": "Vapoursynth wrapper.\n\nDue to security concerns, Vapoursynth scripts will not be autodetected so the input format\nhas to be forced. For ff* CLI tools, add \"-f vapoursynth\" before the input \"-i\nyourscript.vpy\".\n\nThis demuxer accepts the following option:\n" }, { "name": "max_script_size", "content": "The demuxer buffers the entire script into memory. Adjust this value to set the maximum\nbuffer size, which in turn, acts as a ceiling for the size of scripts that can be read.\nDefault is 1 MiB.\n" } ] }, "METADATA": { "content": "FFmpeg is able to dump metadata from media files into a simple UTF-8-encoded INI-like text\nfile and then load it back using the metadata muxer/demuxer.\n\nThe file format is as follows:\n\n1. A file consists of a header and a number of metadata tags divided into sections, each on\nits own line.\n\n2. The header is a ;FFMETADATA string, followed by a version number (now 1).\n\n3. Metadata tags are of the form key=value\n\n4. Immediately after header follows global metadata\n\n5. After global metadata there may be sections with per-stream/per-chapter metadata.\n\n6. A section starts with the section name in uppercase (i.e. STREAM or CHAPTER) in brackets\n([, ]) and ends with next section or end of file.\n\n7. At the beginning of a chapter section there may be an optional timebase to be used for\nstart/end values. It must be in form TIMEBASE=num/den, where num and den are integers. If\nthe timebase is missing then start/end times are assumed to be in nanoseconds.\n\nNext a chapter section must contain chapter start and end times in form START=num,\nEND=num, where num is a positive integer.\n\n8. Empty lines and lines starting with ; or # are ignored.\n\n9. Metadata keys or values containing special characters (=, ;, #, \\ and a newline) must be\nescaped with a backslash \\.\n\n10. Note that whitespace in metadata (e.g. foo = bar) is considered to be a part of the tag\n(in the example above key is foo , value is\nbar).\n\nA ffmetadata file might look like this:\n\n;FFMETADATA1\ntitle=bike\\\\shed\n;this is a comment\nartist=FFmpeg troll team\n\n[CHAPTER]\nTIMEBASE=1/1000\nSTART=0\n#chapter ends at 0:01:00\nEND=60000\ntitle=chapter \\#1\n[STREAM]\ntitle=multi\\\nline\n\nBy using the ffmetadata muxer and demuxer it is possible to extract metadata from an input\nfile to an ffmetadata file, and then transcode the file into an output file with the edited\nffmetadata file.\n\nExtracting an ffmetadata file with ffmpeg goes as follows:\n\nffmpeg -i INPUT -f ffmetadata FFMETADATAFILE\n\nReinserting edited metadata information from the FFMETADATAFILE file can be done as:\n\nffmpeg -i INPUT -i FFMETADATAFILE -mapmetadata 1 -codec copy OUTPUT\n", "subsections": [] }, "PROTOCOL OPTIONS": { "content": "The libavformat library provides some generic global options, which can be set on all the\nprotocols. In addition each protocol 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 \"AVFormatContext\" options or using the libavutil/opt.h API for programmatic\nuse.\n\nThe list of supported options follows:\n\nprotocolwhitelist list (input)\nSet a \",\"-separated list of allowed protocols. \"ALL\" matches all protocols. Protocols\nprefixed by \"-\" are disabled. All protocols are allowed by default but protocols used by\nan another protocol (nested protocols) are restricted to a per protocol subset.\n", "subsections": [] }, "PROTOCOLS": { "content": "Protocols are configured elements in FFmpeg that enable access to resources that require\nspecific protocols.\n\nWhen you configure your FFmpeg build, all the supported protocols are enabled by default. You\ncan list all available ones using the configure option \"--list-protocols\".\n\nYou can disable all the protocols using the configure option \"--disable-protocols\", and\nselectively enable a protocol using the option \"--enable-protocol=PROTOCOL\", or you can\ndisable a particular protocol using the option \"--disable-protocol=PROTOCOL\".\n\nThe option \"-protocols\" of the ff* tools will display the list of supported protocols.\n\nAll protocols accept the following options:\n", "subsections": [ { "name": "rw_timeout", "content": "Maximum time to wait for (network) read/write operations to complete, in microseconds.\n\nA description of the currently available protocols follows.\n" }, { "name": "amqp", "content": "Advanced Message Queueing Protocol (AMQP) version 0-9-1 is a broker based publish-subscribe\ncommunication protocol.\n\nFFmpeg must be compiled with --enable-librabbitmq to support AMQP. A separate AMQP broker\nmust also be run. An example open-source AMQP broker is RabbitMQ.\n\nAfter starting the broker, an FFmpeg client may stream data to the broker using the command:\n\nffmpeg -re -i input -f mpegts amqp://[[user]:[password]@]hostname[:port][/vhost]\n\nWhere hostname and port (default is 5672) is the address of the broker. The client may also\nset a user/password for authentication. The default for both fields is \"guest\". Name of\nvirtual host on broker can be set with vhost. The default value is \"/\".\n\nMuliple subscribers may stream from the broker using the command:\n\nffplay amqp://[[user]:[password]@]hostname[:port][/vhost]\n\nIn RabbitMQ all data published to the broker flows through a specific exchange, and each\nsubscribing client has an assigned queue/buffer. When a packet arrives at an exchange, it may\nbe copied to a client's queue depending on the exchange and routingkey fields.\n\nThe following options are supported:\n" }, { "name": "exchange", "content": "Sets the exchange to use on the broker. RabbitMQ has several predefined exchanges:\n\"amq.direct\" is the default exchange, where the publisher and subscriber must have a\nmatching routingkey; \"amq.fanout\" is the same as a broadcast operation (i.e. the data is\nforwarded to all queues on the fanout exchange independent of the routingkey); and\n\"amq.topic\" is similar to \"amq.direct\", but allows for more complex pattern matching\n(refer to the RabbitMQ documentation).\n" }, { "name": "routing_key", "content": "Sets the routing key. The default value is \"amqp\". The routing key is used on the\n\"amq.direct\" and \"amq.topic\" exchanges to decide whether packets are written to the queue\nof a subscriber.\n" }, { "name": "pkt_size", "content": "Maximum size of each packet sent/received to the broker. Default is 131072. Minimum is\n4096 and max is any large value (representable by an int). When receiving packets, this\nsets an internal buffer size in FFmpeg. It should be equal to or greater than the size of\nthe published packets to the broker. Otherwise the received message may be truncated\ncausing decoding errors.\n" }, { "name": "connection_timeout", "content": "The timeout in seconds during the initial connection to the broker. The default value is\nrwtimeout, or 5 seconds if rwtimeout is not set.\n\ndeliverymode mode\nSets the delivery mode of each message sent to broker. The following values are\naccepted:\n\npersistent\nDelivery mode set to \"persistent\" (2). This is the default value. Messages may be\nwritten to the broker's disk depending on its setup.\n\nnon-persistent\nDelivery mode set to \"non-persistent\" (1). Messages will stay in broker's memory\nunless the broker is under memory pressure.\n" }, { "name": "async", "content": "Asynchronous data filling wrapper for input stream.\n\nFill data in a background thread, to decouple I/O operation from demux thread.\n\nasync:\nasync:http://host/resource\nasync:cache:http://host/resource\n" }, { "name": "bluray", "content": "Read BluRay playlist.\n\nThe accepted options are:\n" }, { "name": "angle", "content": "BluRay angle\n" }, { "name": "chapter", "content": "Start chapter (1...N)\n" }, { "name": "playlist", "content": "Playlist to read (BDMV/PLAYLIST/?????.mpls)\n\nExamples:\n\nRead longest playlist from BluRay mounted to /mnt/bluray:\n\nbluray:/mnt/bluray\n\nRead angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2:\n\n-playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray\n" }, { "name": "cache", "content": "Caching wrapper for input stream.\n\nCache the input stream to temporary file. It brings seeking capability to live streams.\n\nThe accepted options are:\n" }, { "name": "read_ahead_limit", "content": "Amount in bytes that may be read ahead when seeking isn't supported. Range is -1 to\nINTMAX. -1 for unlimited. Default is 65536.\n\nURL Syntax is\n\ncache:\n" }, { "name": "concat", "content": "Physical concatenation protocol.\n\nRead and seek from many resources in sequence as if they were a unique resource.\n\nA URL accepted by this protocol has the syntax:\n\nconcat:||...|\n\nwhere URL1, URL2, ..., URLN are the urls of the resource to be concatenated, each one\npossibly specifying a distinct protocol.\n\nFor example to read a sequence of files split1.mpeg, split2.mpeg, split3.mpeg with ffplay use\nthe command:\n\nffplay concat:split1.mpeg\\|split2.mpeg\\|split3.mpeg\n\nNote that you may need to escape the character \"|\" which is special for many shells.\n" }, { "name": "concatf", "content": "Physical concatenation protocol using a line break delimited list of resources.\n\nRead and seek from many resources in sequence as if they were a unique resource.\n\nA URL accepted by this protocol has the syntax:\n\nconcatf:\n\nwhere URL is the url containing a line break delimited list of resources to be concatenated,\neach one possibly specifying a distinct protocol. Special characters must be escaped with\nbackslash or single quotes. See the \"Quoting and escaping\" section in the ffmpeg-utils(1)\nmanual.\n\nFor example to read a sequence of files split1.mpeg, split2.mpeg, split3.mpeg listed in\nseparate lines within a file split.txt with ffplay use the command:\n\nffplay concatf:split.txt\n\nWhere split.txt contains the lines:\n\nsplit1.mpeg\nsplit2.mpeg\nsplit3.mpeg\n" }, { "name": "crypto", "content": "AES-encrypted stream reading protocol.\n\nThe accepted options are:\n\nkey Set the AES decryption key binary block from given hexadecimal representation.\n\niv Set the AES decryption initialization vector binary block from given hexadecimal\nrepresentation.\n\nAccepted URL formats:\n\ncrypto:\ncrypto+\n" }, { "name": "data", "content": "Data in-line in the URI. See .\n\nFor example, to convert a GIF file given inline with ffmpeg:\n\nffmpeg -i \"data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=\" smiley.png\n\nfd\nFile descriptor access protocol.\n\nThe accepted syntax is:\n\nfd: -fd \n\nIf fd is not specified, by default the stdout file descriptor will be used for writing, stdin\nfor reading. Unlike the pipe protocol, fd protocol has seek support if it corresponding to a\nregular file. fd protocol doesn't support pass file descriptor via URL for security.\n\nThis protocol accepts the following options:\n" }, { "name": "blocksize", "content": "Set I/O operation maximum block size, in bytes. Default value is \"INTMAX\", which results\nin not limiting the requested block size. Setting this value reasonably low improves\nuser termination request reaction time, which is valuable if data transmission is slow.\n\nfd Set file descriptor.\n" }, { "name": "file", "content": "File access protocol.\n\nRead from or write to a file.\n\nA file URL can have the form:\n\nfile:\n\nwhere filename is the path of the file to read.\n\nAn URL that does not have a protocol prefix will be assumed to be a file URL. Depending on\nthe build, an URL that looks like a Windows path with the drive letter at the beginning will\nalso be assumed to be a file URL (usually not the case in builds for unix-like systems).\n\nFor example to read from a file input.mpeg with ffmpeg use the command:\n\nffmpeg -i file:input.mpeg output.mpeg\n\nThis protocol accepts the following options:\n" }, { "name": "truncate", "content": "Truncate existing files on write, if set to 1. A value of 0 prevents truncating. Default\nvalue is 1.\n" }, { "name": "blocksize", "content": "Set I/O operation maximum block size, in bytes. Default value is \"INTMAX\", which results\nin not limiting the requested block size. Setting this value reasonably low improves\nuser termination request reaction time, which is valuable for files on slow medium.\n" }, { "name": "follow", "content": "If set to 1, the protocol will retry reading at the end of the file, allowing reading\nfiles that still are being written. In order for this to terminate, you either need to\nuse the rwtimeout option, or use the interrupt callback (for API users).\n" }, { "name": "seekable", "content": "Controls if seekability is advertised on the file. 0 means non-seekable, -1 means auto\n(seekable for normal files, non-seekable for named pipes).\n\nMany demuxers handle seekable and non-seekable resources differently, overriding this\nmight speed up opening certain files at the cost of losing some features (e.g. accurate\nseeking).\n" }, { "name": "ftp", "content": "FTP (File Transfer Protocol).\n\nRead from or write to remote resources using FTP protocol.\n\nFollowing syntax is required.\n\nftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg\n\nThis protocol accepts the following options.\n" }, { "name": "timeout", "content": "Set timeout in microseconds of socket I/O operations used by the underlying low level\noperation. By default it is set to -1, which means that the timeout is not specified.\n" }, { "name": "ftp-user", "content": "Set a user to be used for authenticating to the FTP server. This is overridden by the\nuser in the FTP URL.\n" }, { "name": "ftp-password", "content": "Set a password to be used for authenticating to the FTP server. This is overridden by the\npassword in the FTP URL, or by ftp-anonymous-password if no user is set.\n" }, { "name": "ftp-anonymous-password", "content": "Password used when login as anonymous user. Typically an e-mail address should be used.\n" }, { "name": "ftp-write-seekable", "content": "Control seekability of connection during encoding. If set to 1 the resource is supposed\nto be seekable, if set to 0 it is assumed not to be seekable. Default value is 0.\n\nNOTE: Protocol can be used as output, but it is recommended to not do it, unless special care\nis taken (tests, customized server configuration etc.). Different FTP servers behave in\ndifferent way during seek operation. ff* tools may produce incomplete content due to server\nlimitations.\n" }, { "name": "gopher", "content": "Gopher protocol.\n" }, { "name": "gophers", "content": "Gophers protocol.\n\nThe Gopher protocol with TLS encapsulation.\n" }, { "name": "hls", "content": "Read Apple HTTP Live Streaming compliant segmented stream as a uniform one. The M3U8\nplaylists describing the segments can be remote HTTP resources or local files, accessed using\nthe standard file protocol. The nested protocol is declared by specifying \"+proto\" after the\nhls URI scheme name, where proto is either \"file\" or \"http\".\n\nhls+http://host/path/to/remote/resource.m3u8\nhls+file://path/to/local/resource.m3u8\n\nUsing this protocol is discouraged - the hls demuxer should work just as well (if not, please\nreport the issues) and is more complete. To use the hls demuxer instead, simply use the\ndirect URLs to the m3u8 files.\n" }, { "name": "http", "content": "HTTP (Hyper Text Transfer Protocol).\n\nThis protocol accepts the following options:\n" }, { "name": "seekable", "content": "Control seekability of connection. If set to 1 the resource is supposed to be seekable,\nif set to 0 it is assumed not to be seekable, if set to -1 it will try to autodetect if\nit is seekable. Default value is -1.\n" }, { "name": "chunked_post", "content": "If set to 1 use chunked Transfer-Encoding for posts, default is 1.\n" }, { "name": "content_type", "content": "Set a specific content type for the POST messages or for listen mode.\n" }, { "name": "http_proxy", "content": "set HTTP proxy to tunnel through e.g. http://example.com:1234\n" }, { "name": "headers", "content": "Set custom HTTP headers, can override built in default headers. The value must be a\nstring encoding the headers.\n" }, { "name": "multiple_requests", "content": "Use persistent connections if set to 1, default is 0.\n" }, { "name": "post_data", "content": "Set custom HTTP post data.\n" }, { "name": "referer", "content": "Set the Referer header. Include 'Referer: URL' header in HTTP request.\n" }, { "name": "user_agent", "content": "Override the User-Agent header. If not specified the protocol will use a string\ndescribing the libavformat build. (\"Lavf/\")\n" }, { "name": "reconnect_at_eof", "content": "If set then eof is treated like an error and causes reconnection, this is useful for live\n/ endless streams.\n" }, { "name": "reconnect_streamed", "content": "If set then even streamed/non seekable streams will be reconnected on errors.\n" }, { "name": "reconnect_on_network_error", "content": "Reconnect automatically in case of TCP/TLS errors during connect.\n" }, { "name": "reconnect_on_http_error", "content": "A comma separated list of HTTP status codes to reconnect on. The list can include\nspecific status codes (e.g. '503') or the strings '4xx' / '5xx'.\n" }, { "name": "reconnect_delay_max", "content": "Sets the maximum delay in seconds after which to give up reconnecting\n" }, { "name": "mime_type", "content": "Export the MIME type.\n" }, { "name": "http_version", "content": "Exports the HTTP response version number. Usually \"1.0\" or \"1.1\".\n\nicy If set to 1 request ICY (SHOUTcast) metadata from the server. If the server supports\nthis, the metadata has to be retrieved by the application by reading the\nicymetadataheaders and icymetadatapacket options. The default is 1.\n" }, { "name": "icy_metadata_headers", "content": "If the server supports ICY metadata, this contains the ICY-specific HTTP reply headers,\nseparated by newline characters.\n" }, { "name": "icy_metadata_packet", "content": "If the server supports ICY metadata, and icy was set to 1, this contains the last non-\nempty metadata packet sent by the server. It should be polled in regular intervals by\napplications interested in mid-stream metadata updates.\n" }, { "name": "cookies", "content": "Set the cookies to be sent in future requests. The format of each cookie is the same as\nthe value of a Set-Cookie HTTP response field. Multiple cookies can be delimited by a\nnewline character.\n" }, { "name": "offset", "content": "Set initial byte offset.\n" }, { "name": "end_offset", "content": "Try to limit the request to bytes preceding this offset.\n" }, { "name": "method", "content": "When used as a client option it sets the HTTP method for the request.\n\nWhen used as a server option it sets the HTTP method that is going to be expected from\nthe client(s). If the expected and the received HTTP method do not match the client will\nbe given a Bad Request response. When unset the HTTP method is not checked for now. This\nwill be replaced by autodetection in the future.\n" }, { "name": "listen", "content": "If set to 1 enables experimental HTTP server. This can be used to send data when used as\nan output option, or read data from a client with HTTP POST when used as an input option.\nIf set to 2 enables experimental multi-client HTTP server. This is not yet implemented in\nffmpeg.c and thus must not be used as a command line option.\n\n# Server side (sending):\nffmpeg -i somefile.ogg -c copy -listen 1 -f ogg http://:\n\n# Client side (receiving):\nffmpeg -i http://: -c copy somefile.ogg\n\n# Client can also be done with wget:\nwget http://: -O somefile.ogg\n\n# Server side (receiving):\nffmpeg -listen 1 -i http://: -c copy somefile.ogg\n\n# Client side (sending):\nffmpeg -i somefile.ogg -chunkedpost 0 -c copy -f ogg http://:\n\n# Client can also be done with wget:\nwget --post-file=somefile.ogg http://:\n" }, { "name": "send_expect_100", "content": "Send an Expect: 100-continue header for POST. If set to 1 it will send, if set to 0 it\nwon't, if set to -1 it will try to send if it is applicable. Default value is -1.\n" }, { "name": "auth_type", "content": "Set HTTP authentication type. No option for Digest, since this method requires getting\nnonce parameters from the server first and can't be used straight away like Basic.\n\nnone\nChoose the HTTP authentication type automatically. This is the default.\n\nbasic\nChoose the HTTP basic authentication.\n\nBasic authentication sends a Base64-encoded string that contains a user name and\npassword for the client. Base64 is not a form of encryption and should be considered\nthe same as sending the user name and password in clear text (Base64 is a reversible\nencoding). If a resource needs to be protected, strongly consider using an\nauthentication scheme other than basic authentication. HTTPS/TLS should be used with\nbasic authentication. Without these additional security enhancements, basic\nauthentication should not be used to protect sensitive or valuable information.\n\nHTTP Cookies\n\nSome HTTP requests will be denied unless cookie values are passed in with the request. The\ncookies option allows these cookies to be specified. At the very least, each cookie must\nspecify a value along with a path and domain. HTTP requests that match both the domain and\npath will automatically include the cookie value in the HTTP Cookie header field. Multiple\ncookies can be delimited by a newline.\n\nThe required syntax to play a stream specifying a cookie is:\n\nffplay -cookies \"nlqptid=nltid=tsn; path=/; domain=somedomain.com;\" http://somedomain.com/somestream.m3u8\n" }, { "name": "Icecast", "content": "Icecast protocol (stream to Icecast servers)\n\nThis protocol accepts the following options:\n" }, { "name": "ice_genre", "content": "Set the stream genre.\n" }, { "name": "ice_name", "content": "Set the stream name.\n" }, { "name": "ice_description", "content": "Set the stream description.\n" }, { "name": "ice_url", "content": "Set the stream website URL.\n" }, { "name": "ice_public", "content": "Set if the stream should be public. The default is 0 (not public).\n" }, { "name": "user_agent", "content": "Override the User-Agent header. If not specified a string of the form \"Lavf/\"\nwill be used.\n" }, { "name": "password", "content": "Set the Icecast mountpoint password.\n" }, { "name": "content_type", "content": "Set the stream content type. This must be set if it is different from audio/mpeg.\n" }, { "name": "legacy_icecast", "content": "This enables support for Icecast versions < 2.4.0, that do not support the HTTP PUT\nmethod but the SOURCE method.\n\ntls Establish a TLS (HTTPS) connection to Icecast.\n\nicecast://[[:]@]:/\n" }, { "name": "ipfs", "content": "InterPlanetary File System (IPFS) protocol support. One can access files stored on the IPFS\nnetwork through so-called gateways. These are http(s) endpoints. This protocol wraps the\nIPFS native protocols (ipfs:// and ipns://) to be sent to such a gateway. Users can (and\nshould) host their own node which means this protocol will use one's local gateway to access\nfiles on the IPFS network.\n\nThis protocol accepts the following options:\n" }, { "name": "gateway", "content": "Defines the gateway to use. When not set, the protocol will first try locating the local\ngateway by looking at $IPFSGATEWAY, $IPFSPATH and \"$HOME/.ipfs/\", in that order.\n\nOne can use this protocol in 2 ways. Using IPFS:\n\nffplay ipfs://\n\nOr the IPNS protocol (IPNS is mutable IPFS):\n\nffplay ipns://\n" }, { "name": "mmst", "content": "MMS (Microsoft Media Server) protocol over TCP.\n" }, { "name": "mmsh", "content": "MMS (Microsoft Media Server) protocol over HTTP.\n\nThe required syntax is:\n\nmmsh://[:][/][/]\n" }, { "name": "md5", "content": "MD5 output protocol.\n\nComputes the MD5 hash of the data to be written, and on close writes this to the designated\noutput or stdout if none is specified. It can be used to test muxers without writing an\nactual file.\n\nSome examples follow.\n\n# Write the MD5 hash of the encoded AVI file to the file output.avi.md5.\nffmpeg -i input.flv -f avi -y md5:output.avi.md5\n\n# Write the MD5 hash of the encoded AVI file to stdout.\nffmpeg -i input.flv -f avi -y md5:\n\nNote that some formats (typically MOV) require the output protocol to be seekable, so they\nwill fail with the MD5 output protocol.\n" }, { "name": "pipe", "content": "UNIX pipe access protocol.\n\nRead and write from UNIX pipes.\n\nThe accepted syntax is:\n\npipe:[]\n\nIf fd isn't specified, number is the number corresponding to the file descriptor of the pipe\n(e.g. 0 for stdin, 1 for stdout, 2 for stderr). If number is not specified, by default the\nstdout file descriptor will be used for writing, stdin for reading.\n\nFor example to read from stdin with ffmpeg:\n\ncat test.wav | ffmpeg -i pipe:0\n# ...this is the same as...\ncat test.wav | ffmpeg -i pipe:\n\nFor writing to stdout with ffmpeg:\n\nffmpeg -i test.wav -f avi pipe:1 | cat > test.avi\n# ...this is the same as...\nffmpeg -i test.wav -f avi pipe: | cat > test.avi\n\nThis protocol accepts the following options:\n" }, { "name": "blocksize", "content": "Set I/O operation maximum block size, in bytes. Default value is \"INTMAX\", which results\nin not limiting the requested block size. Setting this value reasonably low improves\nuser termination request reaction time, which is valuable if data transmission is slow.\n\nfd Set file descriptor.\n\nNote that some formats (typically MOV), require the output protocol to be seekable, so they\nwill fail with the pipe output protocol.\n" }, { "name": "prompeg", "content": "Pro-MPEG Code of Practice #3 Release 2 FEC protocol.\n\nThe Pro-MPEG CoP#3 FEC is a 2D parity-check forward error correction mechanism for MPEG-2\nTransport Streams sent over RTP.\n\nThis protocol must be used in conjunction with the \"rtpmpegts\" muxer and the \"rtp\" protocol.\n\nThe required syntax is:\n\n-f rtpmpegts -fec prompeg=