{ "content": [ { "type": "text", "text": "# FFMPEG-PROTOCOLS (man)\n\n## NAME\n\nffmpeg-protocols - FFmpeg protocols\n\n## DESCRIPTION\n\nThis document describes the input and output protocols provided by the libavformat library.\n\n## Sections\n\n- **NAME**\n- **DESCRIPTION**\n- **PROTOCOL OPTIONS**\n- **PROTOCOLS**\n- **SEE ALSO**\n- **AUTHORS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "FFMPEG-PROTOCOLS", "section": "", "mode": "man", "summary": "ffmpeg-protocols - FFmpeg protocols", "synopsis": null, "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [ { "name": "ffmpeg", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/ffmpeg/1/json" }, { "name": "ffplay", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/ffplay/1/json" }, { "name": "ffprobe", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/ffprobe/1/json" }, { "name": "libavformat", "section": "3", "url": "https://www.chedong.com/phpMan.php/man/libavformat/3/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 2, "subsections": [] }, { "name": "PROTOCOL OPTIONS", "lines": 15, "subsections": [] }, { "name": "PROTOCOLS", "lines": 1565, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "AUTHORS", "lines": 10, "subsections": [] } ], "sections": { "NAME": { "content": "ffmpeg-protocols - FFmpeg protocols\n", "subsections": [] }, "DESCRIPTION": { "content": "This document describes the input and output protocols provided by the libavformat library.\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\nrwtimeout\nMaximum time to wait for (network) read/write operations to complete, in microseconds.\n\nA description of the currently available protocols follows.\n\namqp\nAdvanced 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\nexchange\nSets 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\nroutingkey\nSets 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\npktsize\nMaximum 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\nconnectiontimeout\nThe 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\nasync\nAsynchronous 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\nbluray\nRead BluRay playlist.\n\nThe accepted options are:\n\nangle\nBluRay angle\n\nchapter\nStart chapter (1...N)\n\nplaylist\nPlaylist 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\ncache\nCaching 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\nreadaheadlimit\nAmount 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\nconcat\nPhysical 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\ncrypto\nAES-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\ndata\nData 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\nfile\nFile 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\ntruncate\nTruncate existing files on write, if set to 1. A value of 0 prevents truncating. Default\nvalue is 1.\n\nblocksize\nSet 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\nfollow\nIf 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\nseekable\nControls 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\nftp\nFTP (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\ntimeout\nSet 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\nftp-user\nSet a user to be used for authenticating to the FTP server. This is overridden by the\nuser in the FTP URL.\n\nftp-password\nSet 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\nftp-anonymous-password\nPassword used when login as anonymous user. Typically an e-mail address should be used.\n\nftp-write-seekable\nControl 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\ngopher\nGopher protocol.\n\ngophers\nGophers protocol.\n\nThe Gopher protocol with TLS encapsulation.\n\nhls\nRead 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\nhttp\nHTTP (Hyper Text Transfer Protocol).\n\nThis protocol accepts the following options:\n\nseekable\nControl 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\nchunkedpost\nIf set to 1 use chunked Transfer-Encoding for posts, default is 1.\n\ncontenttype\nSet a specific content type for the POST messages or for listen mode.\n\nhttpproxy\nset HTTP proxy to tunnel through e.g. http://example.com:1234\n\nheaders\nSet custom HTTP headers, can override built in default headers. The value must be a\nstring encoding the headers.\n\nmultiplerequests\nUse persistent connections if set to 1, default is 0.\n\npostdata\nSet custom HTTP post data.\n\nreferer\nSet the Referer header. Include 'Referer: URL' header in HTTP request.\n\nuseragent\nOverride the User-Agent header. If not specified the protocol will use a string\ndescribing the libavformat build. (\"Lavf/\")\n\nuser-agent\nThis is a deprecated option, you can use useragent instead it.\n\nreconnectateof\nIf set then eof is treated like an error and causes reconnection, this is useful for live\n/ endless streams.\n\nreconnectstreamed\nIf set then even streamed/non seekable streams will be reconnected on errors.\n\nreconnectonnetworkerror\nReconnect automatically in case of TCP/TLS errors during connect.\n\nreconnectonhttperror\nA 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\nreconnectdelaymax\nSets the maximum delay in seconds after which to give up reconnecting\n\nmimetype\nExport the MIME type.\n\nhttpversion\nExports 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\nicymetadataheaders\nIf the server supports ICY metadata, this contains the ICY-specific HTTP reply headers,\nseparated by newline characters.\n\nicymetadatapacket\nIf 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\ncookies\nSet 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\noffset\nSet initial byte offset.\n\nendoffset\nTry to limit the request to bytes preceding this offset.\n\nmethod\nWhen 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\nlisten\nIf 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\nsendexpect100\nSend 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\nauthtype\nSet 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\nIcecast\nIcecast protocol (stream to Icecast servers)\n\nThis protocol accepts the following options:\n\nicegenre\nSet the stream genre.\n\nicename\nSet the stream name.\n\nicedescription\nSet the stream description.\n\niceurl\nSet the stream website URL.\n\nicepublic\nSet if the stream should be public. The default is 0 (not public).\n\nuseragent\nOverride the User-Agent header. If not specified a string of the form \"Lavf/\"\nwill be used.\n\npassword\nSet the Icecast mountpoint password.\n\ncontenttype\nSet the stream content type. This must be set if it is different from audio/mpeg.\n\nlegacyicecast\nThis 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\nmmst\nMMS (Microsoft Media Server) protocol over TCP.\n\nmmsh\nMMS (Microsoft Media Server) protocol over HTTP.\n\nThe required syntax is:\n\nmmsh://[:][/][/]\n\nmd5\nMD5 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\npipe\nUNIX pipe access protocol.\n\nRead and write from UNIX pipes.\n\nThe accepted syntax is:\n\npipe:[]\n\nnumber is the number corresponding to the file descriptor of the pipe (e.g. 0 for stdin, 1\nfor stdout, 2 for stderr). If number is not specified, by default the stdout file descriptor\nwill 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\nblocksize\nSet 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\nNote that some formats (typically MOV), require the output protocol to be seekable, so they\nwill fail with the pipe output protocol.\n\nprompeg\nPro-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=