gitadmin
/
tuoheng_airport_stream_discard_20240715
Следить 1
В избранное 0
Форкнуть 0
Код Задачи 0 Pull Request'ы 0 Релизы 0 Вики Активность
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
9 коммитов
3 Ветки
Дерево: b1a300cb7c
Ветки Теги
${ item.name }
Создать ветку ${ searchTerm }
из 'b1a300cb7c'
${ noResults }
tuoheng_airport_stream_disc.../ffmpeg/doc/ffmpeg-protocols.html

2553 lines
100KB
Исходник Blame История 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

  2. <html>

  3. <!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ -->

  4.   <head>

  5.     <meta charset="utf-8">

  6.     <title>

  7.       FFmpeg Protocols Documentation

  8.     </title>

  9.     <meta name="viewport" content="width=device-width,initial-scale=1.0">

  10.     <link rel="stylesheet" type="text/css" href="bootstrap.min.css">

  11.     <link rel="stylesheet" type="text/css" href="style.min.css">

  12.   </head>

  13.   <body>

  14.     <div class="container">

  15.       <h1>

  16.       FFmpeg Protocols Documentation

  17.       </h1>

  18. <div align="center">

  19. </div>

  20. 

  21. 

  22. <a name="SEC_Top"></a>

  23. 

  24. <div class="Contents_element" id="SEC_Contents">

  25. <h2 class="contents-heading">Table of Contents</h2>

  26. 

  27. <div class="contents">

  28. 

  29. <ul class="no-bullet">

  30.   <li><a id="toc-Description" href="#Description">1 Description</a></li>

  31.   <li><a id="toc-Protocol-Options" href="#Protocol-Options">2 Protocol Options</a></li>

  32.   <li><a id="toc-Protocols" href="#Protocols">3 Protocols</a>

  33.   <ul class="no-bullet">

  34.     <li><a id="toc-amqp" href="#amqp">3.1 amqp</a></li>

  35.     <li><a id="toc-async" href="#async">3.2 async</a></li>

  36.     <li><a id="toc-bluray" href="#bluray">3.3 bluray</a></li>

  37.     <li><a id="toc-cache" href="#cache">3.4 cache</a></li>

  38.     <li><a id="toc-concat" href="#concat">3.5 concat</a></li>

  39.     <li><a id="toc-concatf" href="#concatf">3.6 concatf</a></li>

  40.     <li><a id="toc-crypto" href="#crypto">3.7 crypto</a></li>

  41.     <li><a id="toc-data" href="#data">3.8 data</a></li>

  42.     <li><a id="toc-fd" href="#fd">3.9 fd</a></li>

  43.     <li><a id="toc-file" href="#file">3.10 file</a></li>

  44.     <li><a id="toc-ftp" href="#ftp">3.11 ftp</a></li>

  45.     <li><a id="toc-gopher" href="#gopher">3.12 gopher</a></li>

  46.     <li><a id="toc-gophers" href="#gophers">3.13 gophers</a></li>

  47.     <li><a id="toc-hls" href="#hls">3.14 hls</a></li>

  48.     <li><a id="toc-http" href="#http">3.15 http</a>

  49.     <ul class="no-bullet">

  50.       <li><a id="toc-HTTP-Cookies" href="#HTTP-Cookies">3.15.1 HTTP Cookies</a></li>

  51.     </ul></li>

  52.     <li><a id="toc-Icecast" href="#Icecast">3.16 Icecast</a></li>

  53.     <li><a id="toc-ipfs" href="#ipfs">3.17 ipfs</a></li>

  54.     <li><a id="toc-mmst" href="#mmst">3.18 mmst</a></li>

  55.     <li><a id="toc-mmsh" href="#mmsh">3.19 mmsh</a></li>

  56.     <li><a id="toc-md5" href="#md5">3.20 md5</a></li>

  57.     <li><a id="toc-pipe" href="#pipe">3.21 pipe</a></li>

  58.     <li><a id="toc-prompeg" href="#prompeg">3.22 prompeg</a></li>

  59.     <li><a id="toc-rist" href="#rist">3.23 rist</a></li>

  60.     <li><a id="toc-rtmp" href="#rtmp">3.24 rtmp</a></li>

  61.     <li><a id="toc-rtmpe" href="#rtmpe">3.25 rtmpe</a></li>

  62.     <li><a id="toc-rtmps" href="#rtmps">3.26 rtmps</a></li>

  63.     <li><a id="toc-rtmpt" href="#rtmpt">3.27 rtmpt</a></li>

  64.     <li><a id="toc-rtmpte" href="#rtmpte">3.28 rtmpte</a></li>

  65.     <li><a id="toc-rtmpts" href="#rtmpts">3.29 rtmpts</a></li>

  66.     <li><a id="toc-libsmbclient" href="#libsmbclient">3.30 libsmbclient</a></li>

  67.     <li><a id="toc-libssh" href="#libssh">3.31 libssh</a></li>

  68.     <li><a id="toc-librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte" href="#librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte">3.32 librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte</a></li>

  69.     <li><a id="toc-rtp" href="#rtp">3.33 rtp</a></li>

  70.     <li><a id="toc-rtsp" href="#rtsp">3.34 rtsp</a>

  71.     <ul class="no-bullet">

  72.       <li><a id="toc-Muxer" href="#Muxer">3.34.1 Muxer</a></li>

  73.       <li><a id="toc-Demuxer" href="#Demuxer">3.34.2 Demuxer</a></li>

  74.       <li><a id="toc-Examples" href="#Examples">3.34.3 Examples</a></li>

  75.     </ul></li>

  76.     <li><a id="toc-sap" href="#sap">3.35 sap</a>

  77.     <ul class="no-bullet">

  78.       <li><a id="toc-Muxer-1" href="#Muxer-1">3.35.1 Muxer</a></li>

  79.       <li><a id="toc-Demuxer-1" href="#Demuxer-1">3.35.2 Demuxer</a></li>

  80.     </ul></li>

  81.     <li><a id="toc-sctp" href="#sctp">3.36 sctp</a></li>

  82.     <li><a id="toc-srt" href="#srt">3.37 srt</a></li>

  83.     <li><a id="toc-srtp" href="#srtp">3.38 srtp</a></li>

  84.     <li><a id="toc-subfile" href="#subfile">3.39 subfile</a></li>

  85.     <li><a id="toc-tee" href="#tee">3.40 tee</a></li>

  86.     <li><a id="toc-tcp" href="#tcp">3.41 tcp</a></li>

  87.     <li><a id="toc-tls" href="#tls">3.42 tls</a></li>

  88.     <li><a id="toc-udp" href="#udp">3.43 udp</a>

  89.     <ul class="no-bullet">

  90.       <li><a id="toc-Examples-1" href="#Examples-1">3.43.1 Examples</a></li>

  91.     </ul></li>

  92.     <li><a id="toc-unix" href="#unix">3.44 unix</a></li>

  93.     <li><a id="toc-zmq" href="#zmq">3.45 zmq</a></li>

  94.   </ul></li>

  95.   <li><a id="toc-See-Also" href="#See-Also">4 See Also</a></li>

  96.   <li><a id="toc-Authors" href="#Authors">5 Authors</a></li>

  97. </ul>

  98. </div>

  99. </div>

  100. 

  101. <a name="Description"></a>

  102. <h2 class="chapter">1 Description<span class="pull-right"><a class="anchor hidden-xs" href="#Description" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Description" aria-hidden="true">TOC</a></span></h2>

  103. 

  104. <p>This document describes the input and output protocols provided by the

  105. libavformat library.

  106. </p>

  107. 

  108. <a name="Protocol-Options"></a>

  109. <h2 class="chapter">2 Protocol Options<span class="pull-right"><a class="anchor hidden-xs" href="#Protocol-Options" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Protocol-Options" aria-hidden="true">TOC</a></span></h2>

  110. 

  111. <p>The libavformat library provides some generic global options, which

  112. can be set on all the protocols. In addition each protocol may support

  113. so-called private options, which are specific for that component.

  114. </p>

  115. <p>Options may be set by specifying -<var>option</var> <var>value</var> in the

  116. FFmpeg tools, or by setting the value explicitly in the

  117. <code>AVFormatContext</code> options or using the <samp>libavutil/opt.h</samp> API

  118. for programmatic use.

  119. </p>

  120. <p>The list of supported options follows:

  121. </p>

  122. <dl compact="compact">

  123. <dt><span><samp>protocol_whitelist <var>list</var> (<em>input</em>)</samp></span></dt>

  124. <dd><p>Set a &quot;,&quot;-separated list of allowed protocols. &quot;ALL&quot; matches all protocols. Protocols

  125. prefixed by &quot;-&quot; are disabled.

  126. All protocols are allowed by default but protocols used by an another

  127. protocol (nested protocols) are restricted to a per protocol subset.

  128. </p></dd>

  129. </dl>

  130. 

  131. 

  132. <a name="Protocols"></a>

  133. <h2 class="chapter">3 Protocols<span class="pull-right"><a class="anchor hidden-xs" href="#Protocols" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Protocols" aria-hidden="true">TOC</a></span></h2>

  134. 

  135. <p>Protocols are configured elements in FFmpeg that enable access to

  136. resources that require specific protocols.

  137. </p>

  138. <p>When you configure your FFmpeg build, all the supported protocols are

  139. enabled by default. You can list all available ones using the

  140. configure option &quot;&ndash;list-protocols&quot;.

  141. </p>

  142. <p>You can disable all the protocols using the configure option

  143. &quot;&ndash;disable-protocols&quot;, and selectively enable a protocol using the

  144. option &quot;&ndash;enable-protocol=<var>PROTOCOL</var>&quot;, or you can disable a

  145. particular protocol using the option

  146. &quot;&ndash;disable-protocol=<var>PROTOCOL</var>&quot;.

  147. </p>

  148. <p>The option &quot;-protocols&quot; of the ff* tools will display the list of

  149. supported protocols.

  150. </p>

  151. <p>All protocols accept the following options:

  152. </p>

  153. <dl compact="compact">

  154. <dt><span><samp>rw_timeout</samp></span></dt>

  155. <dd><p>Maximum time to wait for (network) read/write operations to complete,

  156. in microseconds.

  157. </p></dd>

  158. </dl>

  159. 

  160. <p>A description of the currently available protocols follows.

  161. </p>

  162. <a name="amqp"></a>

  163. <h3 class="section">3.1 amqp<span class="pull-right"><a class="anchor hidden-xs" href="#amqp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-amqp" aria-hidden="true">TOC</a></span></h3>

  164. 

  165. <p>Advanced Message Queueing Protocol (AMQP) version 0-9-1 is a broker based

  166. publish-subscribe communication protocol.

  167. </p>

  168. <p>FFmpeg must be compiled with &ndash;enable-librabbitmq to support AMQP. A separate

  169. AMQP broker must also be run. An example open-source AMQP broker is RabbitMQ.

  170. </p>

  171. <p>After starting the broker, an FFmpeg client may stream data to the broker using

  172. the command:

  173. </p>

  174. <div class="example">

  175. <pre class="example">ffmpeg -re -i input -f mpegts amqp://[[user]:[password]@]hostname[:port][/vhost]

  176. </pre></div>

  177. 

  178. <p>Where hostname and port (default is 5672) is the address of the broker. The

  179. client may also set a user/password for authentication. The default for both

  180. fields is &quot;guest&quot;. Name of virtual host on broker can be set with vhost. The

  181. default value is &quot;/&quot;.

  182. </p>

  183. <p>Muliple subscribers may stream from the broker using the command:

  184. </p><div class="example">

  185. <pre class="example">ffplay amqp://[[user]:[password]@]hostname[:port][/vhost]

  186. </pre></div>

  187. 

  188. <p>In RabbitMQ all data published to the broker flows through a specific exchange,

  189. and each subscribing client has an assigned queue/buffer. When a packet arrives

  190. at an exchange, it may be copied to a client&rsquo;s queue depending on the exchange

  191. and routing_key fields.

  192. </p>

  193. <p>The following options are supported:

  194. </p>

  195. <dl compact="compact">

  196. <dt><span><samp>exchange</samp></span></dt>

  197. <dd><p>Sets the exchange to use on the broker. RabbitMQ has several predefined

  198. exchanges: &quot;amq.direct&quot; is the default exchange, where the publisher and

  199. subscriber must have a matching routing_key; &quot;amq.fanout&quot; is the same as a

  200. broadcast operation (i.e. the data is forwarded to all queues on the fanout

  201. exchange independent of the routing_key); and &quot;amq.topic&quot; is similar to

  202. &quot;amq.direct&quot;, but allows for more complex pattern matching (refer to the RabbitMQ

  203. documentation).

  204. </p>

  205. </dd>

  206. <dt><span><samp>routing_key</samp></span></dt>

  207. <dd><p>Sets the routing key. The default value is &quot;amqp&quot;. The routing key is used on

  208. the &quot;amq.direct&quot; and &quot;amq.topic&quot; exchanges to decide whether packets are written

  209. to the queue of a subscriber.

  210. </p>

  211. </dd>

  212. <dt><span><samp>pkt_size</samp></span></dt>

  213. <dd><p>Maximum size of each packet sent/received to the broker. Default is 131072.

  214. Minimum is 4096 and max is any large value (representable by an int). When

  215. receiving packets, this sets an internal buffer size in FFmpeg. It should be

  216. equal to or greater than the size of the published packets to the broker. Otherwise

  217. the received message may be truncated causing decoding errors.

  218. </p>

  219. </dd>

  220. <dt><span><samp>connection_timeout</samp></span></dt>

  221. <dd><p>The timeout in seconds during the initial connection to the broker. The

  222. default value is rw_timeout, or 5 seconds if rw_timeout is not set.

  223. </p>

  224. </dd>

  225. <dt><span><samp>delivery_mode <var>mode</var></samp></span></dt>

  226. <dd><p>Sets the delivery mode of each message sent to broker.

  227. The following values are accepted:

  228. </p><dl compact="compact">

  229. <dt><span>&lsquo;<samp>persistent</samp>&rsquo;</span></dt>

  230. <dd><p>Delivery mode set to &quot;persistent&quot; (2). This is the default value.

  231. Messages may be written to the broker&rsquo;s disk depending on its setup.

  232. </p>

  233. </dd>

  234. <dt><span>&lsquo;<samp>non-persistent</samp>&rsquo;</span></dt>

  235. <dd><p>Delivery mode set to &quot;non-persistent&quot; (1).

  236. Messages will stay in broker&rsquo;s memory unless the broker is under memory

  237. pressure.

  238. </p>

  239. </dd>

  240. </dl>

  241. 

  242. </dd>

  243. </dl>

  244. 

  245. <a name="async"></a>

  246. <h3 class="section">3.2 async<span class="pull-right"><a class="anchor hidden-xs" href="#async" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-async" aria-hidden="true">TOC</a></span></h3>

  247. 

  248. <p>Asynchronous data filling wrapper for input stream.

  249. </p>

  250. <p>Fill data in a background thread, to decouple I/O operation from demux thread.

  251. </p>

  252. <div class="example">

  253. <pre class="example">async:<var>URL</var>

  254. async:http://host/resource

  255. async:cache:http://host/resource

  256. </pre></div>

  257. 

  258. <a name="bluray"></a>

  259. <h3 class="section">3.3 bluray<span class="pull-right"><a class="anchor hidden-xs" href="#bluray" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-bluray" aria-hidden="true">TOC</a></span></h3>

  260. 

  261. <p>Read BluRay playlist.

  262. </p>

  263. <p>The accepted options are:

  264. </p><dl compact="compact">

  265. <dt><span><samp>angle</samp></span></dt>

  266. <dd><p>BluRay angle

  267. </p>

  268. </dd>

  269. <dt><span><samp>chapter</samp></span></dt>

  270. <dd><p>Start chapter (1...N)

  271. </p>

  272. </dd>

  273. <dt><span><samp>playlist</samp></span></dt>

  274. <dd><p>Playlist to read (BDMV/PLAYLIST/?????.mpls)

  275. </p>

  276. </dd>

  277. </dl>

  278. 

  279. <p>Examples:

  280. </p>

  281. <p>Read longest playlist from BluRay mounted to /mnt/bluray:

  282. </p><div class="example">

  283. <pre class="example">bluray:/mnt/bluray

  284. </pre></div>

  285. 

  286. <p>Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2:

  287. </p><div class="example">

  288. <pre class="example">-playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray

  289. </pre></div>

  290. 

  291. <a name="cache"></a>

  292. <h3 class="section">3.4 cache<span class="pull-right"><a class="anchor hidden-xs" href="#cache" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-cache" aria-hidden="true">TOC</a></span></h3>

  293. 

  294. <p>Caching wrapper for input stream.

  295. </p>

  296. <p>Cache the input stream to temporary file. It brings seeking capability to live streams.

  297. </p>

  298. <p>The accepted options are:

  299. </p><dl compact="compact">

  300. <dt><span><samp>read_ahead_limit</samp></span></dt>

  301. <dd><p>Amount in bytes that may be read ahead when seeking isn&rsquo;t supported. Range is -1 to INT_MAX.

  302. -1 for unlimited. Default is 65536.

  303. </p>

  304. </dd>

  305. </dl>

  306. 

  307. <p>URL Syntax is

  308. </p><div class="example">

  309. <pre class="example">cache:<var>URL</var>

  310. </pre></div>

  311. 

  312. <a name="concat"></a>

  313. <h3 class="section">3.5 concat<span class="pull-right"><a class="anchor hidden-xs" href="#concat" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-concat" aria-hidden="true">TOC</a></span></h3>

  314. 

  315. <p>Physical concatenation protocol.

  316. </p>

  317. <p>Read and seek from many resources in sequence as if they were

  318. a unique resource.

  319. </p>

  320. <p>A URL accepted by this protocol has the syntax:

  321. </p><div class="example">

  322. <pre class="example">concat:<var>URL1</var>|<var>URL2</var>|...|<var>URLN</var>

  323. </pre></div>

  324. 

  325. <p>where <var>URL1</var>, <var>URL2</var>, ..., <var>URLN</var> are the urls of the

  326. resource to be concatenated, each one possibly specifying a distinct

  327. protocol.

  328. </p>

  329. <p>For example to read a sequence of files <samp>split1.mpeg</samp>,

  330. <samp>split2.mpeg</samp>, <samp>split3.mpeg</samp> with <code>ffplay</code> use the

  331. command:

  332. </p><div class="example">

  333. <pre class="example">ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg

  334. </pre></div>

  335. 

  336. <p>Note that you may need to escape the character &quot;|&quot; which is special for

  337. many shells.

  338. </p>

  339. <a name="concatf"></a>

  340. <h3 class="section">3.6 concatf<span class="pull-right"><a class="anchor hidden-xs" href="#concatf" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-concatf" aria-hidden="true">TOC</a></span></h3>

  341. 

  342. <p>Physical concatenation protocol using a line break delimited list of

  343. resources.

  344. </p>

  345. <p>Read and seek from many resources in sequence as if they were

  346. a unique resource.

  347. </p>

  348. <p>A URL accepted by this protocol has the syntax:

  349. </p><div class="example">

  350. <pre class="example">concatf:<var>URL</var>

  351. </pre></div>

  352. 

  353. <p>where <var>URL</var> is the url containing a line break delimited list of

  354. resources to be concatenated, each one possibly specifying a distinct

  355. protocol. Special characters must be escaped with backslash or single

  356. quotes. See <a data-manual="ffmpeg-utils" href="ffmpeg-utils.html#quoting_005fand_005fescaping">(ffmpeg-utils)the &quot;Quoting and escaping&quot;

  357. section in the ffmpeg-utils(1) manual</a>.

  358. </p>

  359. <p>For example to read a sequence of files <samp>split1.mpeg</samp>,

  360. <samp>split2.mpeg</samp>, <samp>split3.mpeg</samp> listed in separate lines within

  361. a file <samp>split.txt</samp> with <code>ffplay</code> use the command:

  362. </p><div class="example">

  363. <pre class="example">ffplay concatf:split.txt

  364. </pre></div>

  365. <p>Where <samp>split.txt</samp> contains the lines:

  366. </p><div class="example">

  367. <pre class="example">split1.mpeg

  368. split2.mpeg

  369. split3.mpeg

  370. </pre></div>

  371. 

  372. <a name="crypto"></a>

  373. <h3 class="section">3.7 crypto<span class="pull-right"><a class="anchor hidden-xs" href="#crypto" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-crypto" aria-hidden="true">TOC</a></span></h3>

  374. 

  375. <p>AES-encrypted stream reading protocol.

  376. </p>

  377. <p>The accepted options are:

  378. </p><dl compact="compact">

  379. <dt><span><samp>key</samp></span></dt>

  380. <dd><p>Set the AES decryption key binary block from given hexadecimal representation.

  381. </p>

  382. </dd>

  383. <dt><span><samp>iv</samp></span></dt>

  384. <dd><p>Set the AES decryption initialization vector binary block from given hexadecimal representation.

  385. </p></dd>

  386. </dl>

  387. 

  388. <p>Accepted URL formats:

  389. </p><div class="example">

  390. <pre class="example">crypto:<var>URL</var>

  391. crypto+<var>URL</var>

  392. </pre></div>

  393. 

  394. <a name="data"></a>

  395. <h3 class="section">3.8 data<span class="pull-right"><a class="anchor hidden-xs" href="#data" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-data" aria-hidden="true">TOC</a></span></h3>

  396. 

  397. <p>Data in-line in the URI. See <a href="http://en.wikipedia.org/wiki/Data_URI_scheme">http://en.wikipedia.org/wiki/Data_URI_scheme</a>.

  398. </p>

  399. <p>For example, to convert a GIF file given inline with <code>ffmpeg</code>:

  400. </p><div class="example">

  401. <pre class="example">ffmpeg -i &quot;data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=&quot; smiley.png

  402. </pre></div>

  403. 

  404. <a name="fd"></a>

  405. <h3 class="section">3.9 fd<span class="pull-right"><a class="anchor hidden-xs" href="#fd" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-fd" aria-hidden="true">TOC</a></span></h3>

  406. 

  407. <p>File descriptor access protocol.

  408. </p>

  409. <p>The accepted syntax is:

  410. </p><div class="example">

  411. <pre class="example">fd: -fd <var>file_descriptor</var>

  412. </pre></div>

  413. 

  414. <p>If <samp>fd</samp> is not specified, by default the stdout file descriptor will be

  415. used for writing, stdin for reading. Unlike the pipe protocol, fd protocol has

  416. seek support if it corresponding to a regular file. fd protocol doesn&rsquo;t support

  417. pass file descriptor via URL for security.

  418. </p>

  419. <p>This protocol accepts the following options:

  420. </p>

  421. <dl compact="compact">

  422. <dt><span><samp>blocksize</samp></span></dt>

  423. <dd><p>Set I/O operation maximum block size, in bytes. Default value is

  424. <code>INT_MAX</code>, which results in not limiting the requested block size.

  425. Setting this value reasonably low improves user termination request reaction

  426. time, which is valuable if data transmission is slow.

  427. </p>

  428. </dd>

  429. <dt><span><samp>fd</samp></span></dt>

  430. <dd><p>Set file descriptor.

  431. </p></dd>

  432. </dl>

  433. 

  434. <a name="file"></a>

  435. <h3 class="section">3.10 file<span class="pull-right"><a class="anchor hidden-xs" href="#file" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-file" aria-hidden="true">TOC</a></span></h3>

  436. 

  437. <p>File access protocol.

  438. </p>

  439. <p>Read from or write to a file.

  440. </p>

  441. <p>A file URL can have the form:

  442. </p><div class="example">

  443. <pre class="example">file:<var>filename</var>

  444. </pre></div>

  445. 

  446. <p>where <var>filename</var> is the path of the file to read.

  447. </p>

  448. <p>An URL that does not have a protocol prefix will be assumed to be a

  449. file URL. Depending on the build, an URL that looks like a Windows

  450. path with the drive letter at the beginning will also be assumed to be

  451. a file URL (usually not the case in builds for unix-like systems).

  452. </p>

  453. <p>For example to read from a file <samp>input.mpeg</samp> with <code>ffmpeg</code>

  454. use the command:

  455. </p><div class="example">

  456. <pre class="example">ffmpeg -i file:input.mpeg output.mpeg

  457. </pre></div>

  458. 

  459. <p>This protocol accepts the following options:

  460. </p>

  461. <dl compact="compact">

  462. <dt><span><samp>truncate</samp></span></dt>

  463. <dd><p>Truncate existing files on write, if set to 1. A value of 0 prevents

  464. truncating. Default value is 1.

  465. </p>

  466. </dd>

  467. <dt><span><samp>blocksize</samp></span></dt>

  468. <dd><p>Set I/O operation maximum block size, in bytes. Default value is

  469. <code>INT_MAX</code>, which results in not limiting the requested block size.

  470. Setting this value reasonably low improves user termination request reaction

  471. time, which is valuable for files on slow medium.

  472. </p>

  473. </dd>

  474. <dt><span><samp>follow</samp></span></dt>

  475. <dd><p>If set to 1, the protocol will retry reading at the end of the file, allowing

  476. reading files that still are being written. In order for this to terminate,

  477. you either need to use the rw_timeout option, or use the interrupt callback

  478. (for API users).

  479. </p>

  480. </dd>

  481. <dt><span><samp>seekable</samp></span></dt>

  482. <dd><p>Controls if seekability is advertised on the file. 0 means non-seekable, -1

  483. means auto (seekable for normal files, non-seekable for named pipes).

  484. </p>

  485. <p>Many demuxers handle seekable and non-seekable resources differently,

  486. overriding this might speed up opening certain files at the cost of losing some

  487. features (e.g. accurate seeking).

  488. </p></dd>

  489. </dl>

  490. 

  491. <a name="ftp"></a>

  492. <h3 class="section">3.11 ftp<span class="pull-right"><a class="anchor hidden-xs" href="#ftp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ftp" aria-hidden="true">TOC</a></span></h3>

  493. 

  494. <p>FTP (File Transfer Protocol).

  495. </p>

  496. <p>Read from or write to remote resources using FTP protocol.

  497. </p>

  498. <p>Following syntax is required.

  499. </p><div class="example">

  500. <pre class="example">ftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg

  501. </pre></div>

  502. 

  503. <p>This protocol accepts the following options.

  504. </p>

  505. <dl compact="compact">

  506. <dt><span><samp>timeout</samp></span></dt>

  507. <dd><p>Set timeout in microseconds of socket I/O operations used by the underlying low level

  508. operation. By default it is set to -1, which means that the timeout is

  509. not specified.

  510. </p>

  511. </dd>

  512. <dt><span><samp>ftp-user</samp></span></dt>

  513. <dd><p>Set a user to be used for authenticating to the FTP server. This is overridden by the

  514. user in the FTP URL.

  515. </p>

  516. </dd>

  517. <dt><span><samp>ftp-password</samp></span></dt>

  518. <dd><p>Set a password to be used for authenticating to the FTP server. This is overridden by

  519. the password in the FTP URL, or by <samp>ftp-anonymous-password</samp> if no user is set.

  520. </p>

  521. </dd>

  522. <dt><span><samp>ftp-anonymous-password</samp></span></dt>

  523. <dd><p>Password used when login as anonymous user. Typically an e-mail address

  524. should be used.

  525. </p>

  526. </dd>

  527. <dt><span><samp>ftp-write-seekable</samp></span></dt>

  528. <dd><p>Control seekability of connection during encoding. If set to 1 the

  529. resource is supposed to be seekable, if set to 0 it is assumed not

  530. to be seekable. Default value is 0.

  531. </p></dd>

  532. </dl>

  533. 

  534. <p>NOTE: Protocol can be used as output, but it is recommended to not do

  535. it, unless special care is taken (tests, customized server configuration

  536. etc.). Different FTP servers behave in different way during seek

  537. operation. ff* tools may produce incomplete content due to server limitations.

  538. </p>

  539. <a name="gopher"></a>

  540. <h3 class="section">3.12 gopher<span class="pull-right"><a class="anchor hidden-xs" href="#gopher" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-gopher" aria-hidden="true">TOC</a></span></h3>

  541. 

  542. <p>Gopher protocol.

  543. </p>

  544. <a name="gophers"></a>

  545. <h3 class="section">3.13 gophers<span class="pull-right"><a class="anchor hidden-xs" href="#gophers" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-gophers" aria-hidden="true">TOC</a></span></h3>

  546. 

  547. <p>Gophers protocol.

  548. </p>

  549. <p>The Gopher protocol with TLS encapsulation.

  550. </p>

  551. <a name="hls"></a>

  552. <h3 class="section">3.14 hls<span class="pull-right"><a class="anchor hidden-xs" href="#hls" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-hls" aria-hidden="true">TOC</a></span></h3>

  553. 

  554. <p>Read Apple HTTP Live Streaming compliant segmented stream as

  555. a uniform one. The M3U8 playlists describing the segments can be

  556. remote HTTP resources or local files, accessed using the standard

  557. file protocol.

  558. The nested protocol is declared by specifying

  559. &quot;+<var>proto</var>&quot; after the hls URI scheme name, where <var>proto</var>

  560. is either &quot;file&quot; or &quot;http&quot;.

  561. </p>

  562. <div class="example">

  563. <pre class="example">hls+http://host/path/to/remote/resource.m3u8

  564. hls+file://path/to/local/resource.m3u8

  565. </pre></div>

  566. 

  567. <p>Using this protocol is discouraged - the hls demuxer should work

  568. just as well (if not, please report the issues) and is more complete.

  569. To use the hls demuxer instead, simply use the direct URLs to the

  570. m3u8 files.

  571. </p>

  572. <a name="http"></a>

  573. <h3 class="section">3.15 http<span class="pull-right"><a class="anchor hidden-xs" href="#http" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-http" aria-hidden="true">TOC</a></span></h3>

  574. 

  575. <p>HTTP (Hyper Text Transfer Protocol).

  576. </p>

  577. <p>This protocol accepts the following options:

  578. </p>

  579. <dl compact="compact">

  580. <dt><span><samp>seekable</samp></span></dt>

  581. <dd><p>Control seekability of connection. If set to 1 the resource is

  582. supposed to be seekable, if set to 0 it is assumed not to be seekable,

  583. if set to -1 it will try to autodetect if it is seekable. Default

  584. value is -1.

  585. </p>

  586. </dd>

  587. <dt><span><samp>chunked_post</samp></span></dt>

  588. <dd><p>If set to 1 use chunked Transfer-Encoding for posts, default is 1.

  589. </p>

  590. </dd>

  591. <dt><span><samp>content_type</samp></span></dt>

  592. <dd><p>Set a specific content type for the POST messages or for listen mode.

  593. </p>

  594. </dd>

  595. <dt><span><samp>http_proxy</samp></span></dt>

  596. <dd><p>set HTTP proxy to tunnel through e.g. http://example.com:1234

  597. </p>

  598. </dd>

  599. <dt><span><samp>headers</samp></span></dt>

  600. <dd><p>Set custom HTTP headers, can override built in default headers. The

  601. value must be a string encoding the headers.

  602. </p>

  603. </dd>

  604. <dt><span><samp>multiple_requests</samp></span></dt>

  605. <dd><p>Use persistent connections if set to 1, default is 0.

  606. </p>

  607. </dd>

  608. <dt><span><samp>post_data</samp></span></dt>

  609. <dd><p>Set custom HTTP post data.

  610. </p>

  611. </dd>

  612. <dt><span><samp>referer</samp></span></dt>

  613. <dd><p>Set the Referer header. Include &rsquo;Referer: URL&rsquo; header in HTTP request.

  614. </p>

  615. </dd>

  616. <dt><span><samp>user_agent</samp></span></dt>

  617. <dd><p>Override the User-Agent header. If not specified the protocol will use a

  618. string describing the libavformat build. (&quot;Lavf/&lt;version&gt;&quot;)

  619. </p>

  620. </dd>

  621. <dt><span><samp>reconnect_at_eof</samp></span></dt>

  622. <dd><p>If set then eof is treated like an error and causes reconnection, this is useful

  623. for live / endless streams.

  624. </p>

  625. </dd>

  626. <dt><span><samp>reconnect_streamed</samp></span></dt>

  627. <dd><p>If set then even streamed/non seekable streams will be reconnected on errors.

  628. </p>

  629. </dd>

  630. <dt><span><samp>reconnect_on_network_error</samp></span></dt>

  631. <dd><p>Reconnect automatically in case of TCP/TLS errors during connect.

  632. </p>

  633. </dd>

  634. <dt><span><samp>reconnect_on_http_error</samp></span></dt>

  635. <dd><p>A comma separated list of HTTP status codes to reconnect on. The list can

  636. include specific status codes (e.g. &rsquo;503&rsquo;) or the strings &rsquo;4xx&rsquo; / &rsquo;5xx&rsquo;.

  637. </p>

  638. </dd>

  639. <dt><span><samp>reconnect_delay_max</samp></span></dt>

  640. <dd><p>Sets the maximum delay in seconds after which to give up reconnecting

  641. </p>

  642. </dd>

  643. <dt><span><samp>mime_type</samp></span></dt>

  644. <dd><p>Export the MIME type.

  645. </p>

  646. </dd>

  647. <dt><span><samp>http_version</samp></span></dt>

  648. <dd><p>Exports the HTTP response version number. Usually &quot;1.0&quot; or &quot;1.1&quot;.

  649. </p>

  650. </dd>

  651. <dt><span><samp>icy</samp></span></dt>

  652. <dd><p>If set to 1 request ICY (SHOUTcast) metadata from the server. If the server

  653. supports this, the metadata has to be retrieved by the application by reading

  654. the <samp>icy_metadata_headers</samp> and <samp>icy_metadata_packet</samp> options.

  655. The default is 1.

  656. </p>

  657. </dd>

  658. <dt><span><samp>icy_metadata_headers</samp></span></dt>

  659. <dd><p>If the server supports ICY metadata, this contains the ICY-specific HTTP reply

  660. headers, separated by newline characters.

  661. </p>

  662. </dd>

  663. <dt><span><samp>icy_metadata_packet</samp></span></dt>

  664. <dd><p>If the server supports ICY metadata, and <samp>icy</samp> was set to 1, this

  665. contains the last non-empty metadata packet sent by the server. It should be

  666. polled in regular intervals by applications interested in mid-stream metadata

  667. updates.

  668. </p>

  669. </dd>

  670. <dt><span><samp>cookies</samp></span></dt>

  671. <dd><p>Set the cookies to be sent in future requests. The format of each cookie is the

  672. same as the value of a Set-Cookie HTTP response field. Multiple cookies can be

  673. delimited by a newline character.

  674. </p>

  675. </dd>

  676. <dt><span><samp>offset</samp></span></dt>

  677. <dd><p>Set initial byte offset.

  678. </p>

  679. </dd>

  680. <dt><span><samp>end_offset</samp></span></dt>

  681. <dd><p>Try to limit the request to bytes preceding this offset.

  682. </p>

  683. </dd>

  684. <dt><span><samp>method</samp></span></dt>

  685. <dd><p>When used as a client option it sets the HTTP method for the request.

  686. </p>

  687. <p>When used as a server option it sets the HTTP method that is going to be

  688. expected from the client(s).

  689. If the expected and the received HTTP method do not match the client will

  690. be given a Bad Request response.

  691. When unset the HTTP method is not checked for now. This will be replaced by

  692. autodetection in the future.

  693. </p>

  694. </dd>

  695. <dt><span><samp>listen</samp></span></dt>

  696. <dd><p>If set to 1 enables experimental HTTP server. This can be used to send data when

  697. used as an output option, or read data from a client with HTTP POST when used as

  698. an input option.

  699. If set to 2 enables experimental multi-client HTTP server. This is not yet implemented

  700. in ffmpeg.c and thus must not be used as a command line option.

  701. </p><div class="example">

  702. <pre class="example"># Server side (sending):

  703. ffmpeg -i somefile.ogg -c copy -listen 1 -f ogg http://<var>server</var>:<var>port</var>

  704. 

  705. # Client side (receiving):

  706. ffmpeg -i http://<var>server</var>:<var>port</var> -c copy somefile.ogg

  707. 

  708. # Client can also be done with wget:

  709. wget http://<var>server</var>:<var>port</var> -O somefile.ogg

  710. 

  711. # Server side (receiving):

  712. ffmpeg -listen 1 -i http://<var>server</var>:<var>port</var> -c copy somefile.ogg

  713. 

  714. # Client side (sending):

  715. ffmpeg -i somefile.ogg -chunked_post 0 -c copy -f ogg http://<var>server</var>:<var>port</var>

  716. 

  717. # Client can also be done with wget:

  718. wget --post-file=somefile.ogg http://<var>server</var>:<var>port</var>

  719. </pre></div>

  720. 

  721. </dd>

  722. <dt><span><samp>send_expect_100</samp></span></dt>

  723. <dd><p>Send an Expect: 100-continue header for POST. If set to 1 it will send, if set

  724. to 0 it won&rsquo;t, if set to -1 it will try to send if it is applicable. Default

  725. value is -1.

  726. </p>

  727. </dd>

  728. <dt><span><samp>auth_type</samp></span></dt>

  729. <dd>

  730. <p>Set HTTP authentication type. No option for Digest, since this method requires

  731. getting nonce parameters from the server first and can&rsquo;t be used straight away like

  732. Basic.

  733. </p>

  734. <dl compact="compact">

  735. <dt><span><samp>none</samp></span></dt>

  736. <dd><p>Choose the HTTP authentication type automatically. This is the default.

  737. </p></dd>

  738. <dt><span><samp>basic</samp></span></dt>

  739. <dd>

  740. <p>Choose the HTTP basic authentication.

  741. </p>

  742. <p>Basic authentication sends a Base64-encoded string that contains a user name and password

  743. for the client. Base64 is not a form of encryption and should be considered the same as

  744. sending the user name and password in clear text (Base64 is a reversible encoding).

  745. If a resource needs to be protected, strongly consider using an authentication scheme

  746. other than basic authentication. HTTPS/TLS should be used with basic authentication.

  747. Without these additional security enhancements, basic authentication should not be used

  748. to protect sensitive or valuable information.

  749. </p></dd>

  750. </dl>

  751. 

  752. </dd>

  753. </dl>

  754. 

  755. <a name="HTTP-Cookies"></a>

  756. <h4 class="subsection">3.15.1 HTTP Cookies<span class="pull-right"><a class="anchor hidden-xs" href="#HTTP-Cookies" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-HTTP-Cookies" aria-hidden="true">TOC</a></span></h4>

  757. 

  758. <p>Some HTTP requests will be denied unless cookie values are passed in with the

  759. request. The <samp>cookies</samp> option allows these cookies to be specified. At

  760. the very least, each cookie must specify a value along with a path and domain.

  761. HTTP requests that match both the domain and path will automatically include the

  762. cookie value in the HTTP Cookie header field. Multiple cookies can be delimited

  763. by a newline.

  764. </p>

  765. <p>The required syntax to play a stream specifying a cookie is:

  766. </p><div class="example">

  767. <pre class="example">ffplay -cookies &quot;nlqptid=nltid=tsn; path=/; domain=somedomain.com;&quot; http://somedomain.com/somestream.m3u8

  768. </pre></div>

  769. 

  770. <a name="Icecast"></a>

  771. <h3 class="section">3.16 Icecast<span class="pull-right"><a class="anchor hidden-xs" href="#Icecast" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Icecast" aria-hidden="true">TOC</a></span></h3>

  772. 

  773. <p>Icecast protocol (stream to Icecast servers)

  774. </p>

  775. <p>This protocol accepts the following options:

  776. </p>

  777. <dl compact="compact">

  778. <dt><span><samp>ice_genre</samp></span></dt>

  779. <dd><p>Set the stream genre.

  780. </p>

  781. </dd>

  782. <dt><span><samp>ice_name</samp></span></dt>

  783. <dd><p>Set the stream name.

  784. </p>

  785. </dd>

  786. <dt><span><samp>ice_description</samp></span></dt>

  787. <dd><p>Set the stream description.

  788. </p>

  789. </dd>

  790. <dt><span><samp>ice_url</samp></span></dt>

  791. <dd><p>Set the stream website URL.

  792. </p>

  793. </dd>

  794. <dt><span><samp>ice_public</samp></span></dt>

  795. <dd><p>Set if the stream should be public.

  796. The default is 0 (not public).

  797. </p>

  798. </dd>

  799. <dt><span><samp>user_agent</samp></span></dt>

  800. <dd><p>Override the User-Agent header. If not specified a string of the form

  801. &quot;Lavf/&lt;version&gt;&quot; will be used.

  802. </p>

  803. </dd>

  804. <dt><span><samp>password</samp></span></dt>

  805. <dd><p>Set the Icecast mountpoint password.

  806. </p>

  807. </dd>

  808. <dt><span><samp>content_type</samp></span></dt>

  809. <dd><p>Set the stream content type. This must be set if it is different from

  810. audio/mpeg.

  811. </p>

  812. </dd>

  813. <dt><span><samp>legacy_icecast</samp></span></dt>

  814. <dd><p>This enables support for Icecast versions &lt; 2.4.0, that do not support the

  815. HTTP PUT method but the SOURCE method.

  816. </p>

  817. </dd>

  818. <dt><span><samp>tls</samp></span></dt>

  819. <dd><p>Establish a TLS (HTTPS) connection to Icecast.

  820. </p>

  821. </dd>

  822. </dl>

  823. 

  824. <div class="example">

  825. <pre class="example">icecast://[<var>username</var>[:<var>password</var>]@]<var>server</var>:<var>port</var>/<var>mountpoint</var>

  826. </pre></div>

  827. 

  828. <a name="ipfs"></a>

  829. <h3 class="section">3.17 ipfs<span class="pull-right"><a class="anchor hidden-xs" href="#ipfs" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-ipfs" aria-hidden="true">TOC</a></span></h3>

  830. 

  831. <p>InterPlanetary File System (IPFS) protocol support. One can access files stored

  832. on the IPFS network through so-called gateways. These are http(s) endpoints.

  833. This protocol wraps the IPFS native protocols (ipfs:// and ipns://) to be sent

  834. to such a gateway. Users can (and should) host their own node which means this

  835. protocol will use one&rsquo;s local gateway to access files on the IPFS network.

  836. </p>

  837. <p>This protocol accepts the following options:

  838. </p>

  839. <dl compact="compact">

  840. <dt><span><samp>gateway</samp></span></dt>

  841. <dd><p>Defines the gateway to use. When not set, the protocol will first try

  842. locating the local gateway by looking at <code>$IPFS_GATEWAY</code>, <code>$IPFS_PATH</code>

  843. and <code>$HOME/.ipfs/</code>, in that order.

  844. </p>

  845. </dd>

  846. </dl>

  847. 

  848. <p>One can use this protocol in 2 ways. Using IPFS:

  849. </p><div class="example">

  850. <pre class="example">ffplay ipfs://&lt;hash&gt;

  851. </pre></div>

  852. 

  853. <p>Or the IPNS protocol (IPNS is mutable IPFS):

  854. </p><div class="example">

  855. <pre class="example">ffplay ipns://&lt;hash&gt;

  856. </pre></div>

  857. 

  858. <a name="mmst"></a>

  859. <h3 class="section">3.18 mmst<span class="pull-right"><a class="anchor hidden-xs" href="#mmst" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mmst" aria-hidden="true">TOC</a></span></h3>

  860. 

  861. <p>MMS (Microsoft Media Server) protocol over TCP.

  862. </p>

  863. <a name="mmsh"></a>

  864. <h3 class="section">3.19 mmsh<span class="pull-right"><a class="anchor hidden-xs" href="#mmsh" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-mmsh" aria-hidden="true">TOC</a></span></h3>

  865. 

  866. <p>MMS (Microsoft Media Server) protocol over HTTP.

  867. </p>

  868. <p>The required syntax is:

  869. </p><div class="example">

  870. <pre class="example">mmsh://<var>server</var>[:<var>port</var>][/<var>app</var>][/<var>playpath</var>]

  871. </pre></div>

  872. 

  873. <a name="md5"></a>

  874. <h3 class="section">3.20 md5<span class="pull-right"><a class="anchor hidden-xs" href="#md5" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-md5" aria-hidden="true">TOC</a></span></h3>

  875. 

  876. <p>MD5 output protocol.

  877. </p>

  878. <p>Computes the MD5 hash of the data to be written, and on close writes

  879. this to the designated output or stdout if none is specified. It can

  880. be used to test muxers without writing an actual file.

  881. </p>

  882. <p>Some examples follow.

  883. </p><div class="example">

  884. <pre class="example"># Write the MD5 hash of the encoded AVI file to the file output.avi.md5.

  885. ffmpeg -i input.flv -f avi -y md5:output.avi.md5

  886. 

  887. # Write the MD5 hash of the encoded AVI file to stdout.

  888. ffmpeg -i input.flv -f avi -y md5:

  889. </pre></div>

  890. 

  891. <p>Note that some formats (typically MOV) require the output protocol to

  892. be seekable, so they will fail with the MD5 output protocol.

  893. </p>

  894. <a name="pipe"></a>

  895. <h3 class="section">3.21 pipe<span class="pull-right"><a class="anchor hidden-xs" href="#pipe" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-pipe" aria-hidden="true">TOC</a></span></h3>

  896. 

  897. <p>UNIX pipe access protocol.

  898. </p>

  899. <p>Read and write from UNIX pipes.

  900. </p>

  901. <p>The accepted syntax is:

  902. </p><div class="example">

  903. <pre class="example">pipe:[<var>number</var>]

  904. </pre></div>

  905. 

  906. <p>If <samp>fd</samp> isn&rsquo;t specified, <var>number</var> is the number corresponding to the file descriptor of the

  907. pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).  If <var>number</var>

  908. is not specified, by default the stdout file descriptor will be used

  909. for writing, stdin for reading.

  910. </p>

  911. <p>For example to read from stdin with <code>ffmpeg</code>:

  912. </p><div class="example">

  913. <pre class="example">cat test.wav | ffmpeg -i pipe:0

  914. # ...this is the same as...

  915. cat test.wav | ffmpeg -i pipe:

  916. </pre></div>

  917. 

  918. <p>For writing to stdout with <code>ffmpeg</code>:

  919. </p><div class="example">

  920. <pre class="example">ffmpeg -i test.wav -f avi pipe:1 | cat &gt; test.avi

  921. # ...this is the same as...

  922. ffmpeg -i test.wav -f avi pipe: | cat &gt; test.avi

  923. </pre></div>

  924. 

  925. <p>This protocol accepts the following options:

  926. </p>

  927. <dl compact="compact">

  928. <dt><span><samp>blocksize</samp></span></dt>

  929. <dd><p>Set I/O operation maximum block size, in bytes. Default value is

  930. <code>INT_MAX</code>, which results in not limiting the requested block size.

  931. Setting this value reasonably low improves user termination request reaction

  932. time, which is valuable if data transmission is slow.

  933. </p></dd>

  934. <dt><span><samp>fd</samp></span></dt>

  935. <dd><p>Set file descriptor.

  936. </p></dd>

  937. </dl>

  938. 

  939. <p>Note that some formats (typically MOV), require the output protocol to

  940. be seekable, so they will fail with the pipe output protocol.

  941. </p>

  942. <a name="prompeg"></a>

  943. <h3 class="section">3.22 prompeg<span class="pull-right"><a class="anchor hidden-xs" href="#prompeg" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-prompeg" aria-hidden="true">TOC</a></span></h3>

  944. 

  945. <p>Pro-MPEG Code of Practice #3 Release 2 FEC protocol.

  946. </p>

  947. <p>The Pro-MPEG CoP#3 FEC is a 2D parity-check forward error correction mechanism

  948. for MPEG-2 Transport Streams sent over RTP.

  949. </p>

  950. <p>This protocol must be used in conjunction with the <code>rtp_mpegts</code> muxer and

  951. the <code>rtp</code> protocol.

  952. </p>

  953. <p>The required syntax is:

  954. </p><div class="example">

  955. <pre class="example">-f rtp_mpegts -fec prompeg=<var>option</var>=<var>val</var>... rtp://<var>hostname</var>:<var>port</var>

  956. </pre></div>

  957. 

  958. <p>The destination UDP ports are <code>port + 2</code> for the column FEC stream

  959. and <code>port + 4</code> for the row FEC stream.

  960. </p>

  961. <p>This protocol accepts the following options:

  962. </p><dl compact="compact">

  963. <dt><span><samp>l=<var>n</var></samp></span></dt>

  964. <dd><p>The number of columns (4-20, LxD &lt;= 100)

  965. </p>

  966. </dd>

  967. <dt><span><samp>d=<var>n</var></samp></span></dt>

  968. <dd><p>The number of rows (4-20, LxD &lt;= 100)

  969. </p>

  970. </dd>

  971. </dl>

  972. 

  973. <p>Example usage:

  974. </p>

  975. <div class="example">

  976. <pre class="example">-f rtp_mpegts -fec prompeg=l=8:d=4 rtp://<var>hostname</var>:<var>port</var>

  977. </pre></div>

  978. 

  979. <a name="rist"></a>

  980. <h3 class="section">3.23 rist<span class="pull-right"><a class="anchor hidden-xs" href="#rist" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rist" aria-hidden="true">TOC</a></span></h3>

  981. 

  982. <p>Reliable Internet Streaming Transport protocol

  983. </p>

  984. <p>The accepted options are:

  985. </p><dl compact="compact">

  986. <dt><span><samp>rist_profile</samp></span></dt>

  987. <dd><p>Supported values:

  988. </p><dl compact="compact">

  989. <dt><span>&lsquo;<samp>simple</samp>&rsquo;</span></dt>

  990. <dt><span>&lsquo;<samp>main</samp>&rsquo;</span></dt>

  991. <dd><p>This one is default.

  992. </p></dd>

  993. <dt><span>&lsquo;<samp>advanced</samp>&rsquo;</span></dt>

  994. </dl>

  995. 

  996. </dd>

  997. <dt><span><samp>buffer_size</samp></span></dt>

  998. <dd><p>Set internal RIST buffer size in milliseconds for retransmission of data.

  999. Default value is 0 which means the librist default (1 sec). Maximum value is 30

  1000. seconds.

  1001. </p>

  1002. </dd>

  1003. <dt><span><samp>fifo_size</samp></span></dt>

  1004. <dd><p>Size of the librist receiver output fifo in number of packets. This must be a

  1005. power of 2.

  1006. Defaults to 8192 (vs the librist default of 1024).

  1007. </p>

  1008. </dd>

  1009. <dt><span><samp>overrun_nonfatal=<var>1|0</var></samp></span></dt>

  1010. <dd><p>Survive in case of librist fifo buffer overrun. Default value is 0.

  1011. </p>

  1012. </dd>

  1013. <dt><span><samp>pkt_size</samp></span></dt>

  1014. <dd><p>Set maximum packet size for sending data. 1316 by default.

  1015. </p>

  1016. </dd>

  1017. <dt><span><samp>log_level</samp></span></dt>

  1018. <dd><p>Set loglevel for RIST logging messages. You only need to set this if you

  1019. explicitly want to enable debug level messages or packet loss simulation,

  1020. otherwise the regular loglevel is respected.

  1021. </p>

  1022. </dd>

  1023. <dt><span><samp>secret</samp></span></dt>

  1024. <dd><p>Set override of encryption secret, by default is unset.

  1025. </p>

  1026. </dd>

  1027. <dt><span><samp>encryption</samp></span></dt>

  1028. <dd><p>Set encryption type, by default is disabled.

  1029. Acceptable values are 128 and 256.

  1030. </p></dd>

  1031. </dl>

  1032. 

  1033. <a name="rtmp"></a>

  1034. <h3 class="section">3.24 rtmp<span class="pull-right"><a class="anchor hidden-xs" href="#rtmp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtmp" aria-hidden="true">TOC</a></span></h3>

  1035. 

  1036. <p>Real-Time Messaging Protocol.

  1037. </p>

  1038. <p>The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia

  1039. content across a TCP/IP network.

  1040. </p>

  1041. <p>The required syntax is:

  1042. </p><div class="example">

  1043. <pre class="example">rtmp://[<var>username</var>:<var>password</var>@]<var>server</var>[:<var>port</var>][/<var>app</var>][/<var>instance</var>][/<var>playpath</var>]

  1044. </pre></div>

  1045. 

  1046. <p>The accepted parameters are:

  1047. </p><dl compact="compact">

  1048. <dt><span><samp>username</samp></span></dt>

  1049. <dd><p>An optional username (mostly for publishing).

  1050. </p>

  1051. </dd>

  1052. <dt><span><samp>password</samp></span></dt>

  1053. <dd><p>An optional password (mostly for publishing).

  1054. </p>

  1055. </dd>

  1056. <dt><span><samp>server</samp></span></dt>

  1057. <dd><p>The address of the RTMP server.

  1058. </p>

  1059. </dd>

  1060. <dt><span><samp>port</samp></span></dt>

  1061. <dd><p>The number of the TCP port to use (by default is 1935).

  1062. </p>

  1063. </dd>

  1064. <dt><span><samp>app</samp></span></dt>

  1065. <dd><p>It is the name of the application to access. It usually corresponds to

  1066. the path where the application is installed on the RTMP server

  1067. (e.g. <samp>/ondemand/</samp>, <samp>/flash/live/</samp>, etc.). You can override

  1068. the value parsed from the URI through the <code>rtmp_app</code> option, too.

  1069. </p>

  1070. </dd>

  1071. <dt><span><samp>playpath</samp></span></dt>

  1072. <dd><p>It is the path or name of the resource to play with reference to the

  1073. application specified in <var>app</var>, may be prefixed by &quot;mp4:&quot;. You

  1074. can override the value parsed from the URI through the <code>rtmp_playpath</code>

  1075. option, too.

  1076. </p>

  1077. </dd>

  1078. <dt><span><samp>listen</samp></span></dt>

  1079. <dd><p>Act as a server, listening for an incoming connection.

  1080. </p>

  1081. </dd>

  1082. <dt><span><samp>timeout</samp></span></dt>

  1083. <dd><p>Maximum time to wait for the incoming connection. Implies listen.

  1084. </p></dd>

  1085. </dl>

  1086. 

  1087. <p>Additionally, the following parameters can be set via command line options

  1088. (or in code via <code>AVOption</code>s):

  1089. </p><dl compact="compact">

  1090. <dt><span><samp>rtmp_app</samp></span></dt>

  1091. <dd><p>Name of application to connect on the RTMP server. This option

  1092. overrides the parameter specified in the URI.

  1093. </p>

  1094. </dd>

  1095. <dt><span><samp>rtmp_buffer</samp></span></dt>

  1096. <dd><p>Set the client buffer time in milliseconds. The default is 3000.

  1097. </p>

  1098. </dd>

  1099. <dt><span><samp>rtmp_conn</samp></span></dt>

  1100. <dd><p>Extra arbitrary AMF connection parameters, parsed from a string,

  1101. e.g. like <code>B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0</code>.

  1102. Each value is prefixed by a single character denoting the type,

  1103. B for Boolean, N for number, S for string, O for object, or Z for null,

  1104. followed by a colon. For Booleans the data must be either 0 or 1 for

  1105. FALSE or TRUE, respectively.  Likewise for Objects the data must be 0 or

  1106. 1 to end or begin an object, respectively. Data items in subobjects may

  1107. be named, by prefixing the type with &rsquo;N&rsquo; and specifying the name before

  1108. the value (i.e. <code>NB:myFlag:1</code>). This option may be used multiple

  1109. times to construct arbitrary AMF sequences.

  1110. </p>

  1111. </dd>

  1112. <dt><span><samp>rtmp_flashver</samp></span></dt>

  1113. <dd><p>Version of the Flash plugin used to run the SWF player. The default

  1114. is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible;

  1115. &lt;libavformat version&gt;).)

  1116. </p>

  1117. </dd>

  1118. <dt><span><samp>rtmp_flush_interval</samp></span></dt>

  1119. <dd><p>Number of packets flushed in the same request (RTMPT only). The default

  1120. is 10.

  1121. </p>

  1122. </dd>

  1123. <dt><span><samp>rtmp_live</samp></span></dt>

  1124. <dd><p>Specify that the media is a live stream. No resuming or seeking in

  1125. live streams is possible. The default value is <code>any</code>, which means the

  1126. subscriber first tries to play the live stream specified in the

  1127. playpath. If a live stream of that name is not found, it plays the

  1128. recorded stream. The other possible values are <code>live</code> and

  1129. <code>recorded</code>.

  1130. </p>

  1131. </dd>

  1132. <dt><span><samp>rtmp_pageurl</samp></span></dt>

  1133. <dd><p>URL of the web page in which the media was embedded. By default no

  1134. value will be sent.

  1135. </p>

  1136. </dd>

  1137. <dt><span><samp>rtmp_playpath</samp></span></dt>

  1138. <dd><p>Stream identifier to play or to publish. This option overrides the

  1139. parameter specified in the URI.

  1140. </p>

  1141. </dd>

  1142. <dt><span><samp>rtmp_subscribe</samp></span></dt>

  1143. <dd><p>Name of live stream to subscribe to. By default no value will be sent.

  1144. It is only sent if the option is specified or if rtmp_live

  1145. is set to live.

  1146. </p>

  1147. </dd>

  1148. <dt><span><samp>rtmp_swfhash</samp></span></dt>

  1149. <dd><p>SHA256 hash of the decompressed SWF file (32 bytes).

  1150. </p>

  1151. </dd>

  1152. <dt><span><samp>rtmp_swfsize</samp></span></dt>

  1153. <dd><p>Size of the decompressed SWF file, required for SWFVerification.

  1154. </p>

  1155. </dd>

  1156. <dt><span><samp>rtmp_swfurl</samp></span></dt>

  1157. <dd><p>URL of the SWF player for the media. By default no value will be sent.

  1158. </p>

  1159. </dd>

  1160. <dt><span><samp>rtmp_swfverify</samp></span></dt>

  1161. <dd><p>URL to player swf file, compute hash/size automatically.

  1162. </p>

  1163. </dd>

  1164. <dt><span><samp>rtmp_tcurl</samp></span></dt>

  1165. <dd><p>URL of the target stream. Defaults to proto://host[:port]/app.

  1166. </p>

  1167. </dd>

  1168. <dt><span><samp>tcp_nodelay=<var>1|0</var></samp></span></dt>

  1169. <dd><p>Set TCP_NODELAY to disable Nagle&rsquo;s algorithm. Default value is 0.

  1170. </p>

  1171. <p><em>Remark: Writing to the socket is currently not optimized to minimize system calls and reduces the efficiency / effect of TCP_NODELAY.</em>

  1172. </p>

  1173. </dd>

  1174. </dl>

  1175. 

  1176. <p>For example to read with <code>ffplay</code> a multimedia resource named

  1177. &quot;sample&quot; from the application &quot;vod&quot; from an RTMP server &quot;myserver&quot;:

  1178. </p><div class="example">

  1179. <pre class="example">ffplay rtmp://myserver/vod/sample

  1180. </pre></div>

  1181. 

  1182. <p>To publish to a password protected server, passing the playpath and

  1183. app names separately:

  1184. </p><div class="example">

  1185. <pre class="example">ffmpeg -re -i &lt;input&gt; -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@myserver/

  1186. </pre></div>

  1187. 

  1188. <a name="rtmpe"></a>

  1189. <h3 class="section">3.25 rtmpe<span class="pull-right"><a class="anchor hidden-xs" href="#rtmpe" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtmpe" aria-hidden="true">TOC</a></span></h3>

  1190. 

  1191. <p>Encrypted Real-Time Messaging Protocol.

  1192. </p>

  1193. <p>The Encrypted Real-Time Messaging Protocol (RTMPE) is used for

  1194. streaming multimedia content within standard cryptographic primitives,

  1195. consisting of Diffie-Hellman key exchange and HMACSHA256, generating

  1196. a pair of RC4 keys.

  1197. </p>

  1198. <a name="rtmps"></a>

  1199. <h3 class="section">3.26 rtmps<span class="pull-right"><a class="anchor hidden-xs" href="#rtmps" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtmps" aria-hidden="true">TOC</a></span></h3>

  1200. 

  1201. <p>Real-Time Messaging Protocol over a secure SSL connection.

  1202. </p>

  1203. <p>The Real-Time Messaging Protocol (RTMPS) is used for streaming

  1204. multimedia content across an encrypted connection.

  1205. </p>

  1206. <a name="rtmpt"></a>

  1207. <h3 class="section">3.27 rtmpt<span class="pull-right"><a class="anchor hidden-xs" href="#rtmpt" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtmpt" aria-hidden="true">TOC</a></span></h3>

  1208. 

  1209. <p>Real-Time Messaging Protocol tunneled through HTTP.

  1210. </p>

  1211. <p>The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used

  1212. for streaming multimedia content within HTTP requests to traverse

  1213. firewalls.

  1214. </p>

  1215. <a name="rtmpte"></a>

  1216. <h3 class="section">3.28 rtmpte<span class="pull-right"><a class="anchor hidden-xs" href="#rtmpte" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtmpte" aria-hidden="true">TOC</a></span></h3>

  1217. 

  1218. <p>Encrypted Real-Time Messaging Protocol tunneled through HTTP.

  1219. </p>

  1220. <p>The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)

  1221. is used for streaming multimedia content within HTTP requests to traverse

  1222. firewalls.

  1223. </p>

  1224. <a name="rtmpts"></a>

  1225. <h3 class="section">3.29 rtmpts<span class="pull-right"><a class="anchor hidden-xs" href="#rtmpts" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtmpts" aria-hidden="true">TOC</a></span></h3>

  1226. 

  1227. <p>Real-Time Messaging Protocol tunneled through HTTPS.

  1228. </p>

  1229. <p>The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used

  1230. for streaming multimedia content within HTTPS requests to traverse

  1231. firewalls.

  1232. </p>

  1233. <a name="libsmbclient"></a>

  1234. <h3 class="section">3.30 libsmbclient<span class="pull-right"><a class="anchor hidden-xs" href="#libsmbclient" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libsmbclient" aria-hidden="true">TOC</a></span></h3>

  1235. 

  1236. <p>libsmbclient permits one to manipulate CIFS/SMB network resources.

  1237. </p>

  1238. <p>Following syntax is required.

  1239. </p>

  1240. <div class="example">

  1241. <pre class="example">smb://[[domain:]user[:password@]]server[/share[/path[/file]]]

  1242. </pre></div>

  1243. 

  1244. <p>This protocol accepts the following options.

  1245. </p>

  1246. <dl compact="compact">

  1247. <dt><span><samp>timeout</samp></span></dt>

  1248. <dd><p>Set timeout in milliseconds of socket I/O operations used by the underlying

  1249. low level operation. By default it is set to -1, which means that the timeout

  1250. is not specified.

  1251. </p>

  1252. </dd>

  1253. <dt><span><samp>truncate</samp></span></dt>

  1254. <dd><p>Truncate existing files on write, if set to 1. A value of 0 prevents

  1255. truncating. Default value is 1.

  1256. </p>

  1257. </dd>

  1258. <dt><span><samp>workgroup</samp></span></dt>

  1259. <dd><p>Set the workgroup used for making connections. By default workgroup is not specified.

  1260. </p>

  1261. </dd>

  1262. </dl>

  1263. 

  1264. <p>For more information see: <a href="http://www.samba.org/">http://www.samba.org/</a>.

  1265. </p>

  1266. <a name="libssh"></a>

  1267. <h3 class="section">3.31 libssh<span class="pull-right"><a class="anchor hidden-xs" href="#libssh" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-libssh" aria-hidden="true">TOC</a></span></h3>

  1268. 

  1269. <p>Secure File Transfer Protocol via libssh

  1270. </p>

  1271. <p>Read from or write to remote resources using SFTP protocol.

  1272. </p>

  1273. <p>Following syntax is required.

  1274. </p>

  1275. <div class="example">

  1276. <pre class="example">sftp://[user[:password]@]server[:port]/path/to/remote/resource.mpeg

  1277. </pre></div>

  1278. 

  1279. <p>This protocol accepts the following options.

  1280. </p>

  1281. <dl compact="compact">

  1282. <dt><span><samp>timeout</samp></span></dt>

  1283. <dd><p>Set timeout of socket I/O operations used by the underlying low level

  1284. operation. By default it is set to -1, which means that the timeout

  1285. is not specified.

  1286. </p>

  1287. </dd>

  1288. <dt><span><samp>truncate</samp></span></dt>

  1289. <dd><p>Truncate existing files on write, if set to 1. A value of 0 prevents

  1290. truncating. Default value is 1.

  1291. </p>

  1292. </dd>

  1293. <dt><span><samp>private_key</samp></span></dt>

  1294. <dd><p>Specify the path of the file containing private key to use during authorization.

  1295. By default libssh searches for keys in the <samp>~/.ssh/</samp> directory.

  1296. </p>

  1297. </dd>

  1298. </dl>

  1299. 

  1300. <p>Example: Play a file stored on remote server.

  1301. </p>

  1302. <div class="example">

  1303. <pre class="example">ffplay sftp://user:password@server_address:22/home/user/resource.mpeg

  1304. </pre></div>

  1305. 

  1306. <a name="librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte"></a>

  1307. <h3 class="section">3.32 librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte<span class="pull-right"><a class="anchor hidden-xs" href="#librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-librtmp-rtmp_002c-rtmpe_002c-rtmps_002c-rtmpt_002c-rtmpte" aria-hidden="true">TOC</a></span></h3>

  1308. 

  1309. <p>Real-Time Messaging Protocol and its variants supported through

  1310. librtmp.

  1311. </p>

  1312. <p>Requires the presence of the librtmp headers and library during

  1313. configuration. You need to explicitly configure the build with

  1314. &quot;&ndash;enable-librtmp&quot;. If enabled this will replace the native RTMP

  1315. protocol.

  1316. </p>

  1317. <p>This protocol provides most client functions and a few server

  1318. functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),

  1319. encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled

  1320. variants of these encrypted types (RTMPTE, RTMPTS).

  1321. </p>

  1322. <p>The required syntax is:

  1323. </p><div class="example">

  1324. <pre class="example"><var>rtmp_proto</var>://<var>server</var>[:<var>port</var>][/<var>app</var>][/<var>playpath</var>] <var>options</var>

  1325. </pre></div>

  1326. 

  1327. <p>where <var>rtmp_proto</var> is one of the strings &quot;rtmp&quot;, &quot;rtmpt&quot;, &quot;rtmpe&quot;,

  1328. &quot;rtmps&quot;, &quot;rtmpte&quot;, &quot;rtmpts&quot; corresponding to each RTMP variant, and

  1329. <var>server</var>, <var>port</var>, <var>app</var> and <var>playpath</var> have the same

  1330. meaning as specified for the RTMP native protocol.

  1331. <var>options</var> contains a list of space-separated options of the form

  1332. <var>key</var>=<var>val</var>.

  1333. </p>

  1334. <p>See the librtmp manual page (man 3 librtmp) for more information.

  1335. </p>

  1336. <p>For example, to stream a file in real-time to an RTMP server using

  1337. <code>ffmpeg</code>:

  1338. </p><div class="example">

  1339. <pre class="example">ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream

  1340. </pre></div>

  1341. 

  1342. <p>To play the same stream using <code>ffplay</code>:

  1343. </p><div class="example">

  1344. <pre class="example">ffplay &quot;rtmp://myserver/live/mystream live=1&quot;

  1345. </pre></div>

  1346. 

  1347. <a name="rtp"></a>

  1348. <h3 class="section">3.33 rtp<span class="pull-right"><a class="anchor hidden-xs" href="#rtp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtp" aria-hidden="true">TOC</a></span></h3>

  1349. 

  1350. <p>Real-time Transport Protocol.

  1351. </p>

  1352. <p>The required syntax for an RTP URL is:

  1353. rtp://<var>hostname</var>[:<var>port</var>][?<var>option</var>=<var>val</var>...]

  1354. </p>

  1355. <p><var>port</var> specifies the RTP port to use.

  1356. </p>

  1357. <p>The following URL options are supported:

  1358. </p>

  1359. <dl compact="compact">

  1360. <dt><span><samp>ttl=<var>n</var></samp></span></dt>

  1361. <dd><p>Set the TTL (Time-To-Live) value (for multicast only).

  1362. </p>

  1363. </dd>

  1364. <dt><span><samp>rtcpport=<var>n</var></samp></span></dt>

  1365. <dd><p>Set the remote RTCP port to <var>n</var>.

  1366. </p>

  1367. </dd>

  1368. <dt><span><samp>localrtpport=<var>n</var></samp></span></dt>

  1369. <dd><p>Set the local RTP port to <var>n</var>.

  1370. </p>

  1371. </dd>

  1372. <dt><span><samp>localrtcpport=<var>n</var>'</samp></span></dt>

  1373. <dd><p>Set the local RTCP port to <var>n</var>.

  1374. </p>

  1375. </dd>

  1376. <dt><span><samp>pkt_size=<var>n</var></samp></span></dt>

  1377. <dd><p>Set max packet size (in bytes) to <var>n</var>.

  1378. </p>

  1379. </dd>

  1380. <dt><span><samp>buffer_size=<var>size</var></samp></span></dt>

  1381. <dd><p>Set the maximum UDP socket buffer size in bytes.

  1382. </p>

  1383. </dd>

  1384. <dt><span><samp>connect=0|1</samp></span></dt>

  1385. <dd><p>Do a <code>connect()</code> on the UDP socket (if set to 1) or not (if set

  1386. to 0).

  1387. </p>

  1388. </dd>

  1389. <dt><span><samp>sources=<var>ip</var>[,<var>ip</var>]</samp></span></dt>

  1390. <dd><p>List allowed source IP addresses.

  1391. </p>

  1392. </dd>

  1393. <dt><span><samp>block=<var>ip</var>[,<var>ip</var>]</samp></span></dt>

  1394. <dd><p>List disallowed (blocked) source IP addresses.

  1395. </p>

  1396. </dd>

  1397. <dt><span><samp>write_to_source=0|1</samp></span></dt>

  1398. <dd><p>Send packets to the source address of the latest received packet (if

  1399. set to 1) or to a default remote address (if set to 0).

  1400. </p>

  1401. </dd>

  1402. <dt><span><samp>localport=<var>n</var></samp></span></dt>

  1403. <dd><p>Set the local RTP port to <var>n</var>.

  1404. </p>

  1405. </dd>

  1406. <dt><span><samp>localaddr=<var>addr</var></samp></span></dt>

  1407. <dd><p>Local IP address of a network interface used for sending packets or joining

  1408. multicast groups.

  1409. </p>

  1410. </dd>

  1411. <dt><span><samp>timeout=<var>n</var></samp></span></dt>

  1412. <dd><p>Set timeout (in microseconds) of socket I/O operations to <var>n</var>.

  1413. </p>

  1414. <p>This is a deprecated option. Instead, <samp>localrtpport</samp> should be

  1415. used.

  1416. </p>

  1417. </dd>

  1418. </dl>

  1419. 

  1420. <p>Important notes:

  1421. </p>

  1422. <ol>

  1423. <li> If <samp>rtcpport</samp> is not set the RTCP port will be set to the RTP

  1424. port value plus 1.

  1425. 

  1426. </li><li> If <samp>localrtpport</samp> (the local RTP port) is not set any available

  1427. port will be used for the local RTP and RTCP ports.

  1428. 

  1429. </li><li> If <samp>localrtcpport</samp> (the local RTCP port) is not set it will be

  1430. set to the local RTP port value plus 1.

  1431. </li></ol>

  1432. 

  1433. <a name="rtsp"></a>

  1434. <h3 class="section">3.34 rtsp<span class="pull-right"><a class="anchor hidden-xs" href="#rtsp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-rtsp" aria-hidden="true">TOC</a></span></h3>

  1435. 

  1436. <p>Real-Time Streaming Protocol.

  1437. </p>

  1438. <p>RTSP is not technically a protocol handler in libavformat, it is a demuxer

  1439. and muxer. The demuxer supports both normal RTSP (with data transferred

  1440. over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with

  1441. data transferred over RDT).

  1442. </p>

  1443. <p>The muxer can be used to send a stream using RTSP ANNOUNCE to a server

  1444. supporting it (currently Darwin Streaming Server and Mischa Spiegelmock&rsquo;s

  1445. <a href="https://github.com/revmischa/rtsp-server">RTSP server</a>).

  1446. </p>

  1447. <p>The required syntax for a RTSP url is:

  1448. </p><div class="example">

  1449. <pre class="example">rtsp://<var>hostname</var>[:<var>port</var>]/<var>path</var>

  1450. </pre></div>

  1451. 

  1452. <p>Options can be set on the <code>ffmpeg</code>/<code>ffplay</code> command

  1453. line, or set in code via <code>AVOption</code>s or in

  1454. <code>avformat_open_input</code>.

  1455. </p>

  1456. <a name="Muxer"></a>

  1457. <h4 class="subsection">3.34.1 Muxer<span class="pull-right"><a class="anchor hidden-xs" href="#Muxer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Muxer" aria-hidden="true">TOC</a></span></h4>

  1458. <p>The following options are supported.

  1459. </p>

  1460. <dl compact="compact">

  1461. <dt><span><samp>rtsp_transport</samp></span></dt>

  1462. <dd><p>Set RTSP transport protocols.

  1463. </p>

  1464. <p>It accepts the following values:

  1465. </p><dl compact="compact">

  1466. <dt><span>&lsquo;<samp>udp</samp>&rsquo;</span></dt>

  1467. <dd><p>Use UDP as lower transport protocol.

  1468. </p>

  1469. </dd>

  1470. <dt><span>&lsquo;<samp>tcp</samp>&rsquo;</span></dt>

  1471. <dd><p>Use TCP (interleaving within the RTSP control channel) as lower

  1472. transport protocol.

  1473. </p></dd>

  1474. </dl>

  1475. 

  1476. <p>Default value is &lsquo;<samp>0</samp>&rsquo;.

  1477. </p>

  1478. </dd>

  1479. <dt><span><samp>rtsp_flags</samp></span></dt>

  1480. <dd><p>Set RTSP flags.

  1481. </p>

  1482. <p>The following values are accepted:

  1483. </p><dl compact="compact">

  1484. <dt><span>&lsquo;<samp>latm</samp>&rsquo;</span></dt>

  1485. <dd><p>Use MP4A-LATM packetization instead of MPEG4-GENERIC for AAC.

  1486. </p></dd>

  1487. <dt><span>&lsquo;<samp>rfc2190</samp>&rsquo;</span></dt>

  1488. <dd><p>Use RFC 2190 packetization instead of RFC 4629 for H.263.

  1489. </p></dd>

  1490. <dt><span>&lsquo;<samp>skip_rtcp</samp>&rsquo;</span></dt>

  1491. <dd><p>Don&rsquo;t send RTCP sender reports.

  1492. </p></dd>

  1493. <dt><span>&lsquo;<samp>h264_mode0</samp>&rsquo;</span></dt>

  1494. <dd><p>Use mode 0 for H.264 in RTP.

  1495. </p></dd>

  1496. <dt><span>&lsquo;<samp>send_bye</samp>&rsquo;</span></dt>

  1497. <dd><p>Send RTCP BYE packets when finishing.

  1498. </p></dd>

  1499. </dl>

  1500. 

  1501. <p>Default value is &lsquo;<samp>0</samp>&rsquo;.

  1502. </p>

  1503. 

  1504. </dd>

  1505. <dt><span><samp>min_port</samp></span></dt>

  1506. <dd><p>Set minimum local UDP port. Default value is 5000.

  1507. </p>

  1508. </dd>

  1509. <dt><span><samp>max_port</samp></span></dt>

  1510. <dd><p>Set maximum local UDP port. Default value is 65000.

  1511. </p>

  1512. </dd>

  1513. <dt><span><samp>buffer_size</samp></span></dt>

  1514. <dd><p>Set the maximum socket buffer size in bytes.

  1515. </p>

  1516. </dd>

  1517. <dt><span><samp>pkt_size</samp></span></dt>

  1518. <dd><p>Set max send packet size (in bytes). Default value is 1472.

  1519. </p></dd>

  1520. </dl>

  1521. 

  1522. <a name="Demuxer"></a>

  1523. <h4 class="subsection">3.34.2 Demuxer<span class="pull-right"><a class="anchor hidden-xs" href="#Demuxer" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Demuxer" aria-hidden="true">TOC</a></span></h4>

  1524. <p>The following options are supported.

  1525. </p>

  1526. <dl compact="compact">

  1527. <dt><span><samp>initial_pause</samp></span></dt>

  1528. <dd><p>Do not start playing the stream immediately if set to 1. Default value

  1529. is 0.

  1530. </p>

  1531. </dd>

  1532. <dt><span><samp>rtsp_transport</samp></span></dt>

  1533. <dd><p>Set RTSP transport protocols.

  1534. </p>

  1535. <p>It accepts the following values:

  1536. </p><dl compact="compact">

  1537. <dt><span>&lsquo;<samp>udp</samp>&rsquo;</span></dt>

  1538. <dd><p>Use UDP as lower transport protocol.

  1539. </p>

  1540. </dd>

  1541. <dt><span>&lsquo;<samp>tcp</samp>&rsquo;</span></dt>

  1542. <dd><p>Use TCP (interleaving within the RTSP control channel) as lower

  1543. transport protocol.

  1544. </p>

  1545. </dd>

  1546. <dt><span>&lsquo;<samp>udp_multicast</samp>&rsquo;</span></dt>

  1547. <dd><p>Use UDP multicast as lower transport protocol.

  1548. </p>

  1549. </dd>

  1550. <dt><span>&lsquo;<samp>http</samp>&rsquo;</span></dt>

  1551. <dd><p>Use HTTP tunneling as lower transport protocol, which is useful for

  1552. passing proxies.

  1553. </p>

  1554. </dd>

  1555. <dt><span>&lsquo;<samp>https</samp>&rsquo;</span></dt>

  1556. <dd><p>Use HTTPs tunneling as lower transport protocol, which is useful for

  1557. passing proxies and widely used for security consideration.

  1558. </p></dd>

  1559. </dl>

  1560. 

  1561. <p>Multiple lower transport protocols may be specified, in that case they are

  1562. tried one at a time (if the setup of one fails, the next one is tried).

  1563. For the muxer, only the &lsquo;<samp>tcp</samp>&rsquo; and &lsquo;<samp>udp</samp>&rsquo; options are supported.

  1564. </p>

  1565. </dd>

  1566. <dt><span><samp>rtsp_flags</samp></span></dt>

  1567. <dd><p>Set RTSP flags.

  1568. </p>

  1569. <p>The following values are accepted:

  1570. </p><dl compact="compact">

  1571. <dt><span>&lsquo;<samp>filter_src</samp>&rsquo;</span></dt>

  1572. <dd><p>Accept packets only from negotiated peer address and port.

  1573. </p></dd>

  1574. <dt><span>&lsquo;<samp>listen</samp>&rsquo;</span></dt>

  1575. <dd><p>Act as a server, listening for an incoming connection.

  1576. </p></dd>

  1577. <dt><span>&lsquo;<samp>prefer_tcp</samp>&rsquo;</span></dt>

  1578. <dd><p>Try TCP for RTP transport first, if TCP is available as RTSP RTP transport.

  1579. </p></dd>

  1580. <dt><span>&lsquo;<samp>satip_raw</samp>&rsquo;</span></dt>

  1581. <dd><p>Export raw MPEG-TS stream instead of demuxing. The flag will simply write out

  1582. the raw stream, with the original PAT/PMT/PIDs intact.

  1583. </p></dd>

  1584. </dl>

  1585. 

  1586. <p>Default value is &lsquo;<samp>none</samp>&rsquo;.

  1587. </p>

  1588. </dd>

  1589. <dt><span><samp>allowed_media_types</samp></span></dt>

  1590. <dd><p>Set media types to accept from the server.

  1591. </p>

  1592. <p>The following flags are accepted:

  1593. </p><dl compact="compact">

  1594. <dt><span>&lsquo;<samp>video</samp>&rsquo;</span></dt>

  1595. <dt><span>&lsquo;<samp>audio</samp>&rsquo;</span></dt>

  1596. <dt><span>&lsquo;<samp>data</samp>&rsquo;</span></dt>

  1597. <dt><span>&lsquo;<samp>subtitle</samp>&rsquo;</span></dt>

  1598. </dl>

  1599. 

  1600. <p>By default it accepts all media types.

  1601. </p>

  1602. </dd>

  1603. <dt><span><samp>min_port</samp></span></dt>

  1604. <dd><p>Set minimum local UDP port. Default value is 5000.

  1605. </p>

  1606. </dd>

  1607. <dt><span><samp>max_port</samp></span></dt>

  1608. <dd><p>Set maximum local UDP port. Default value is 65000.

  1609. </p>

  1610. </dd>

  1611. <dt><span><samp>listen_timeout</samp></span></dt>

  1612. <dd><p>Set maximum timeout (in seconds) to establish an initial connection. Setting

  1613. <samp>listen_timeout</samp> &gt; 0 sets <samp>rtsp_flags</samp> to &lsquo;<samp>listen</samp>&rsquo;. Default is -1

  1614. which means an infinite timeout when &lsquo;<samp>listen</samp>&rsquo; mode is set.

  1615. </p>

  1616. </dd>

  1617. <dt><span><samp>reorder_queue_size</samp></span></dt>

  1618. <dd><p>Set number of packets to buffer for handling of reordered packets.

  1619. </p>

  1620. </dd>

  1621. <dt><span><samp>timeout</samp></span></dt>

  1622. <dd><p>Set socket TCP I/O timeout in microseconds.

  1623. </p>

  1624. </dd>

  1625. <dt><span><samp>user_agent</samp></span></dt>

  1626. <dd><p>Override User-Agent header. If not specified, it defaults to the

  1627. libavformat identifier string.

  1628. </p>

  1629. </dd>

  1630. <dt><span><samp>buffer_size</samp></span></dt>

  1631. <dd><p>Set the maximum socket buffer size in bytes.

  1632. </p></dd>

  1633. </dl>

  1634. 

  1635. <p>When receiving data over UDP, the demuxer tries to reorder received packets

  1636. (since they may arrive out of order, or packets may get lost totally). This

  1637. can be disabled by setting the maximum demuxing delay to zero (via

  1638. the <code>max_delay</code> field of AVFormatContext).

  1639. </p>

  1640. <p>When watching multi-bitrate Real-RTSP streams with <code>ffplay</code>, the

  1641. streams to display can be chosen with <code>-vst</code> <var>n</var> and

  1642. <code>-ast</code> <var>n</var> for video and audio respectively, and can be switched

  1643. on the fly by pressing <code>v</code> and <code>a</code>.

  1644. </p>

  1645. <a name="Examples"></a>

  1646. <h4 class="subsection">3.34.3 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples" aria-hidden="true">TOC</a></span></h4>

  1647. 

  1648. <p>The following examples all make use of the <code>ffplay</code> and

  1649. <code>ffmpeg</code> tools.

  1650. </p>

  1651. <ul>

  1652. <li> Watch a stream over UDP, with a max reordering delay of 0.5 seconds:

  1653. <div class="example">

  1654. <pre class="example">ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4

  1655. </pre></div>

  1656. 

  1657. </li><li> Watch a stream tunneled over HTTP:

  1658. <div class="example">

  1659. <pre class="example">ffplay -rtsp_transport http rtsp://server/video.mp4

  1660. </pre></div>

  1661. 

  1662. </li><li> Send a stream in realtime to a RTSP server, for others to watch:

  1663. <div class="example">

  1664. <pre class="example">ffmpeg -re -i <var>input</var> -f rtsp -muxdelay 0.1 rtsp://server/live.sdp

  1665. </pre></div>

  1666. 

  1667. </li><li> Receive a stream in realtime:

  1668. <div class="example">

  1669. <pre class="example">ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp <var>output</var>

  1670. </pre></div>

  1671. </li></ul>

  1672. 

  1673. <a name="sap"></a>

  1674. <h3 class="section">3.35 sap<span class="pull-right"><a class="anchor hidden-xs" href="#sap" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sap" aria-hidden="true">TOC</a></span></h3>

  1675. 

  1676. <p>Session Announcement Protocol (RFC 2974). This is not technically a

  1677. protocol handler in libavformat, it is a muxer and demuxer.

  1678. It is used for signalling of RTP streams, by announcing the SDP for the

  1679. streams regularly on a separate port.

  1680. </p>

  1681. <a name="Muxer-1"></a>

  1682. <h4 class="subsection">3.35.1 Muxer<span class="pull-right"><a class="anchor hidden-xs" href="#Muxer-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Muxer-1" aria-hidden="true">TOC</a></span></h4>

  1683. 

  1684. <p>The syntax for a SAP url given to the muxer is:

  1685. </p><div class="example">

  1686. <pre class="example">sap://<var>destination</var>[:<var>port</var>][?<var>options</var>]

  1687. </pre></div>

  1688. 

  1689. <p>The RTP packets are sent to <var>destination</var> on port <var>port</var>,

  1690. or to port 5004 if no port is specified.

  1691. <var>options</var> is a <code>&amp;</code>-separated list. The following options

  1692. are supported:

  1693. </p>

  1694. <dl compact="compact">

  1695. <dt><span><samp>announce_addr=<var>address</var></samp></span></dt>

  1696. <dd><p>Specify the destination IP address for sending the announcements to.

  1697. If omitted, the announcements are sent to the commonly used SAP

  1698. announcement multicast address 224.2.127.254 (sap.mcast.net), or

  1699. ff0e::2:7ffe if <var>destination</var> is an IPv6 address.

  1700. </p>

  1701. </dd>

  1702. <dt><span><samp>announce_port=<var>port</var></samp></span></dt>

  1703. <dd><p>Specify the port to send the announcements on, defaults to

  1704. 9875 if not specified.

  1705. </p>

  1706. </dd>

  1707. <dt><span><samp>ttl=<var>ttl</var></samp></span></dt>

  1708. <dd><p>Specify the time to live value for the announcements and RTP packets,

  1709. defaults to 255.

  1710. </p>

  1711. </dd>

  1712. <dt><span><samp>same_port=<var>0|1</var></samp></span></dt>

  1713. <dd><p>If set to 1, send all RTP streams on the same port pair. If zero (the

  1714. default), all streams are sent on unique ports, with each stream on a

  1715. port 2 numbers higher than the previous.

  1716. VLC/Live555 requires this to be set to 1, to be able to receive the stream.

  1717. The RTP stack in libavformat for receiving requires all streams to be sent

  1718. on unique ports.

  1719. </p></dd>

  1720. </dl>

  1721. 

  1722. <p>Example command lines follow.

  1723. </p>

  1724. <p>To broadcast a stream on the local subnet, for watching in VLC:

  1725. </p>

  1726. <div class="example">

  1727. <pre class="example">ffmpeg -re -i <var>input</var> -f sap sap://224.0.0.255?same_port=1

  1728. </pre></div>

  1729. 

  1730. <p>Similarly, for watching in <code>ffplay</code>:

  1731. </p>

  1732. <div class="example">

  1733. <pre class="example">ffmpeg -re -i <var>input</var> -f sap sap://224.0.0.255

  1734. </pre></div>

  1735. 

  1736. <p>And for watching in <code>ffplay</code>, over IPv6:

  1737. </p>

  1738. <div class="example">

  1739. <pre class="example">ffmpeg -re -i <var>input</var> -f sap sap://[ff0e::1:2:3:4]

  1740. </pre></div>

  1741. 

  1742. <a name="Demuxer-1"></a>

  1743. <h4 class="subsection">3.35.2 Demuxer<span class="pull-right"><a class="anchor hidden-xs" href="#Demuxer-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Demuxer-1" aria-hidden="true">TOC</a></span></h4>

  1744. 

  1745. <p>The syntax for a SAP url given to the demuxer is:

  1746. </p><div class="example">

  1747. <pre class="example">sap://[<var>address</var>][:<var>port</var>]

  1748. </pre></div>

  1749. 

  1750. <p><var>address</var> is the multicast address to listen for announcements on,

  1751. if omitted, the default 224.2.127.254 (sap.mcast.net) is used. <var>port</var>

  1752. is the port that is listened on, 9875 if omitted.

  1753. </p>

  1754. <p>The demuxers listens for announcements on the given address and port.

  1755. Once an announcement is received, it tries to receive that particular stream.

  1756. </p>

  1757. <p>Example command lines follow.

  1758. </p>

  1759. <p>To play back the first stream announced on the normal SAP multicast address:

  1760. </p>

  1761. <div class="example">

  1762. <pre class="example">ffplay sap://

  1763. </pre></div>

  1764. 

  1765. <p>To play back the first stream announced on one the default IPv6 SAP multicast address:

  1766. </p>

  1767. <div class="example">

  1768. <pre class="example">ffplay sap://[ff0e::2:7ffe]

  1769. </pre></div>

  1770. 

  1771. <a name="sctp"></a>

  1772. <h3 class="section">3.36 sctp<span class="pull-right"><a class="anchor hidden-xs" href="#sctp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-sctp" aria-hidden="true">TOC</a></span></h3>

  1773. 

  1774. <p>Stream Control Transmission Protocol.

  1775. </p>

  1776. <p>The accepted URL syntax is:

  1777. </p><div class="example">

  1778. <pre class="example">sctp://<var>host</var>:<var>port</var>[?<var>options</var>]

  1779. </pre></div>

  1780. 

  1781. <p>The protocol accepts the following options:

  1782. </p><dl compact="compact">

  1783. <dt><span><samp>listen</samp></span></dt>

  1784. <dd><p>If set to any value, listen for an incoming connection. Outgoing connection is done by default.

  1785. </p>

  1786. </dd>

  1787. <dt><span><samp>max_streams</samp></span></dt>

  1788. <dd><p>Set the maximum number of streams. By default no limit is set.

  1789. </p></dd>

  1790. </dl>

  1791. 

  1792. <a name="srt"></a>

  1793. <h3 class="section">3.37 srt<span class="pull-right"><a class="anchor hidden-xs" href="#srt" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-srt" aria-hidden="true">TOC</a></span></h3>

  1794. 

  1795. <p>Haivision Secure Reliable Transport Protocol via libsrt.

  1796. </p>

  1797. <p>The supported syntax for a SRT URL is:

  1798. </p><div class="example">

  1799. <pre class="example">srt://<var>hostname</var>:<var>port</var>[?<var>options</var>]

  1800. </pre></div>

  1801. 

  1802. <p><var>options</var> contains a list of &amp;-separated options of the form

  1803. <var>key</var>=<var>val</var>.

  1804. </p>

  1805. <p>or

  1806. </p>

  1807. <div class="example">

  1808. <pre class="example"><var>options</var> srt://<var>hostname</var>:<var>port</var>

  1809. </pre></div>

  1810. 

  1811. <p><var>options</var> contains a list of &rsquo;-<var>key</var> <var>val</var>&rsquo;

  1812. options.

  1813. </p>

  1814. <p>This protocol accepts the following options.

  1815. </p>

  1816. <dl compact="compact">

  1817. <dt><span><samp>connect_timeout=<var>milliseconds</var></samp></span></dt>

  1818. <dd><p>Connection timeout; SRT cannot connect for RTT &gt; 1500 msec

  1819. (2 handshake exchanges) with the default connect timeout of

  1820. 3 seconds. This option applies to the caller and rendezvous

  1821. connection modes. The connect timeout is 10 times the value

  1822. set for the rendezvous mode (which can be used as a

  1823. workaround for this connection problem with earlier versions).

  1824. </p>

  1825. </dd>

  1826. <dt><span><samp>ffs=<var>bytes</var></samp></span></dt>

  1827. <dd><p>Flight Flag Size (Window Size), in bytes. FFS is actually an

  1828. internal parameter and you should set it to not less than

  1829. <samp>recv_buffer_size</samp> and <samp>mss</samp>. The default value

  1830. is relatively large, therefore unless you set a very large receiver buffer,

  1831. you do not need to change this option. Default value is 25600.

  1832. </p>

  1833. </dd>

  1834. <dt><span><samp>inputbw=<var>bytes/seconds</var></samp></span></dt>

  1835. <dd><p>Sender nominal input rate, in bytes per seconds. Used along with

  1836. <samp>oheadbw</samp>, when <samp>maxbw</samp> is set to relative (0), to

  1837. calculate maximum sending rate when recovery packets are sent

  1838. along with the main media stream:

  1839. <samp>inputbw</samp> * (100 + <samp>oheadbw</samp>) / 100

  1840. if <samp>inputbw</samp> is not set while <samp>maxbw</samp> is set to

  1841. relative (0), the actual input rate is evaluated inside

  1842. the library. Default value is 0.

  1843. </p>

  1844. </dd>

  1845. <dt><span><samp>iptos=<var>tos</var></samp></span></dt>

  1846. <dd><p>IP Type of Service. Applies to sender only. Default value is 0xB8.

  1847. </p>

  1848. </dd>

  1849. <dt><span><samp>ipttl=<var>ttl</var></samp></span></dt>

  1850. <dd><p>IP Time To Live. Applies to sender only. Default value is 64.

  1851. </p>

  1852. </dd>

  1853. <dt><span><samp>latency=<var>microseconds</var></samp></span></dt>

  1854. <dd><p>Timestamp-based Packet Delivery Delay.

  1855. Used to absorb bursts of missed packet retransmissions.

  1856. This flag sets both <samp>rcvlatency</samp> and <samp>peerlatency</samp>

  1857. to the same value. Note that prior to version 1.3.0

  1858. this is the only flag to set the latency, however

  1859. this is effectively equivalent to setting <samp>peerlatency</samp>,

  1860. when side is sender and <samp>rcvlatency</samp>

  1861. when side is receiver, and the bidirectional stream

  1862. sending is not supported.

  1863. </p>

  1864. </dd>

  1865. <dt><span><samp>listen_timeout=<var>microseconds</var></samp></span></dt>

  1866. <dd><p>Set socket listen timeout.

  1867. </p>

  1868. </dd>

  1869. <dt><span><samp>maxbw=<var>bytes/seconds</var></samp></span></dt>

  1870. <dd><p>Maximum sending bandwidth, in bytes per seconds.

  1871. -1 infinite (CSRTCC limit is 30mbps)

  1872. 0 relative to input rate (see <samp>inputbw</samp>)

  1873. &gt;0 absolute limit value

  1874. Default value is 0 (relative)

  1875. </p>

  1876. </dd>

  1877. <dt><span><samp>mode=<var>caller|listener|rendezvous</var></samp></span></dt>

  1878. <dd><p>Connection mode.

  1879. <samp>caller</samp> opens client connection.

  1880. <samp>listener</samp> starts server to listen for incoming connections.

  1881. <samp>rendezvous</samp> use Rendez-Vous connection mode.

  1882. Default value is caller.

  1883. </p>

  1884. </dd>

  1885. <dt><span><samp>mss=<var>bytes</var></samp></span></dt>

  1886. <dd><p>Maximum Segment Size, in bytes. Used for buffer allocation

  1887. and rate calculation using a packet counter assuming fully

  1888. filled packets. The smallest MSS between the peers is

  1889. used. This is 1500 by default in the overall internet.

  1890. This is the maximum size of the UDP packet and can be

  1891. only decreased, unless you have some unusual dedicated

  1892. network settings. Default value is 1500.

  1893. </p>

  1894. </dd>

  1895. <dt><span><samp>nakreport=<var>1|0</var></samp></span></dt>

  1896. <dd><p>If set to 1, Receiver will send &lsquo;UMSG_LOSSREPORT&lsquo; messages

  1897. periodically until a lost packet is retransmitted or

  1898. intentionally dropped. Default value is 1.

  1899. </p>

  1900. </dd>

  1901. <dt><span><samp>oheadbw=<var>percents</var></samp></span></dt>

  1902. <dd><p>Recovery bandwidth overhead above input rate, in percents.

  1903. See <samp>inputbw</samp>. Default value is 25%.

  1904. </p>

  1905. </dd>

  1906. <dt><span><samp>passphrase=<var>string</var></samp></span></dt>

  1907. <dd><p>HaiCrypt Encryption/Decryption Passphrase string, length

  1908. from 10 to 79 characters. The passphrase is the shared

  1909. secret between the sender and the receiver. It is used

  1910. to generate the Key Encrypting Key using PBKDF2

  1911. (Password-Based Key Derivation Function). It is used

  1912. only if <samp>pbkeylen</samp> is non-zero. It is used on

  1913. the receiver only if the received data is encrypted.

  1914. The configured passphrase cannot be recovered (write-only).

  1915. </p>

  1916. </dd>

  1917. <dt><span><samp>enforced_encryption=<var>1|0</var></samp></span></dt>

  1918. <dd><p>If true, both connection parties must have the same password

  1919. set (including empty, that is, with no encryption). If the

  1920. password doesn&rsquo;t match or only one side is unencrypted,

  1921. the connection is rejected. Default is true.

  1922. </p>

  1923. </dd>

  1924. <dt><span><samp>kmrefreshrate=<var>packets</var></samp></span></dt>

  1925. <dd><p>The number of packets to be transmitted after which the

  1926. encryption key is switched to a new key. Default is -1.

  1927. -1 means auto (0x1000000 in srt library). The range for

  1928. this option is integers in the 0 - <code>INT_MAX</code>.

  1929. </p>

  1930. </dd>

  1931. <dt><span><samp>kmpreannounce=<var>packets</var></samp></span></dt>

  1932. <dd><p>The interval between when a new encryption key is sent and

  1933. when switchover occurs. This value also applies to the

  1934. subsequent interval between when switchover occurs and

  1935. when the old encryption key is decommissioned. Default is -1.

  1936. -1 means auto (0x1000 in srt library). The range for

  1937. this option is integers in the 0 - <code>INT_MAX</code>.

  1938. </p>

  1939. </dd>

  1940. <dt><span><samp>snddropdelay=<var>microseconds</var></samp></span></dt>

  1941. <dd><p>The sender&rsquo;s extra delay before dropping packets. This delay is

  1942. added to the default drop delay time interval value.

  1943. </p>

  1944. <p>Special value -1: Do not drop packets on the sender at all.

  1945. </p>

  1946. </dd>

  1947. <dt><span><samp>payload_size=<var>bytes</var></samp></span></dt>

  1948. <dd><p>Sets the maximum declared size of a packet transferred

  1949. during the single call to the sending function in Live

  1950. mode. Use 0 if this value isn&rsquo;t used (which is default in

  1951. file mode).

  1952. Default is -1 (automatic), which typically means MPEG-TS;

  1953. if you are going to use SRT

  1954. to send any different kind of payload, such as, for example,

  1955. wrapping a live stream in very small frames, then you can

  1956. use a bigger maximum frame size, though not greater than

  1957. 1456 bytes.

  1958. </p>

  1959. </dd>

  1960. <dt><span><samp>pkt_size=<var>bytes</var></samp></span></dt>

  1961. <dd><p>Alias for &lsquo;<samp>payload_size</samp>&rsquo;.

  1962. </p>

  1963. </dd>

  1964. <dt><span><samp>peerlatency=<var>microseconds</var></samp></span></dt>

  1965. <dd><p>The latency value (as described in <samp>rcvlatency</samp>) that is

  1966. set by the sender side as a minimum value for the receiver.

  1967. </p>

  1968. </dd>

  1969. <dt><span><samp>pbkeylen=<var>bytes</var></samp></span></dt>

  1970. <dd><p>Sender encryption key length, in bytes.

  1971. Only can be set to 0, 16, 24 and 32.

  1972. Enable sender encryption if not 0.

  1973. Not required on receiver (set to 0),

  1974. key size obtained from sender in HaiCrypt handshake.

  1975. Default value is 0.

  1976. </p>

  1977. </dd>

  1978. <dt><span><samp>rcvlatency=<var>microseconds</var></samp></span></dt>

  1979. <dd><p>The time that should elapse since the moment when the

  1980. packet was sent and the moment when it&rsquo;s delivered to

  1981. the receiver application in the receiving function.

  1982. This time should be a buffer time large enough to cover

  1983. the time spent for sending, unexpectedly extended RTT

  1984. time, and the time needed to retransmit the lost UDP

  1985. packet. The effective latency value will be the maximum

  1986. of this options&rsquo; value and the value of <samp>peerlatency</samp>

  1987. set by the peer side. Before version 1.3.0 this option

  1988. is only available as <samp>latency</samp>.

  1989. </p>

  1990. </dd>

  1991. <dt><span><samp>recv_buffer_size=<var>bytes</var></samp></span></dt>

  1992. <dd><p>Set UDP receive buffer size, expressed in bytes.

  1993. </p>

  1994. </dd>

  1995. <dt><span><samp>send_buffer_size=<var>bytes</var></samp></span></dt>

  1996. <dd><p>Set UDP send buffer size, expressed in bytes.

  1997. </p>

  1998. </dd>

  1999. <dt><span><samp>timeout=<var>microseconds</var></samp></span></dt>

  2000. <dd><p>Set raise error timeouts for read, write and connect operations. Note that the

  2001. SRT library has internal timeouts which can be controlled separately, the

  2002. value set here is only a cap on those.

  2003. </p>

  2004. </dd>

  2005. <dt><span><samp>tlpktdrop=<var>1|0</var></samp></span></dt>

  2006. <dd><p>Too-late Packet Drop. When enabled on receiver, it skips

  2007. missing packets that have not been delivered in time and

  2008. delivers the following packets to the application when

  2009. their time-to-play has come. It also sends a fake ACK to

  2010. the sender. When enabled on sender and enabled on the

  2011. receiving peer, the sender drops the older packets that

  2012. have no chance of being delivered in time. It was

  2013. automatically enabled in the sender if the receiver

  2014. supports it.

  2015. </p>

  2016. </dd>

  2017. <dt><span><samp>sndbuf=<var>bytes</var></samp></span></dt>

  2018. <dd><p>Set send buffer size, expressed in bytes.

  2019. </p>

  2020. </dd>

  2021. <dt><span><samp>rcvbuf=<var>bytes</var></samp></span></dt>

  2022. <dd><p>Set receive buffer size, expressed in bytes.

  2023. </p>

  2024. <p>Receive buffer must not be greater than <samp>ffs</samp>.

  2025. </p>

  2026. </dd>

  2027. <dt><span><samp>lossmaxttl=<var>packets</var></samp></span></dt>

  2028. <dd><p>The value up to which the Reorder Tolerance may grow. When

  2029. Reorder Tolerance is &gt; 0, then packet loss report is delayed

  2030. until that number of packets come in. Reorder Tolerance

  2031. increases every time a &quot;belated&quot; packet has come, but it

  2032. wasn&rsquo;t due to retransmission (that is, when UDP packets tend

  2033. to come out of order), with the difference between the latest

  2034. sequence and this packet&rsquo;s sequence, and not more than the

  2035. value of this option. By default it&rsquo;s 0, which means that this

  2036. mechanism is turned off, and the loss report is always sent

  2037. immediately upon experiencing a &quot;gap&quot; in sequences.

  2038. </p>

  2039. </dd>

  2040. <dt><span><samp>minversion</samp></span></dt>

  2041. <dd><p>The minimum SRT version that is required from the peer. A connection

  2042. to a peer that does not satisfy the minimum version requirement

  2043. will be rejected.

  2044. </p>

  2045. <p>The version format in hex is 0xXXYYZZ for x.y.z in human readable

  2046. form.

  2047. </p>

  2048. </dd>

  2049. <dt><span><samp>streamid=<var>string</var></samp></span></dt>

  2050. <dd><p>A string limited to 512 characters that can be set on the socket prior

  2051. to connecting. This stream ID will be able to be retrieved by the

  2052. listener side from the socket that is returned from srt_accept and

  2053. was connected by a socket with that set stream ID. SRT does not enforce

  2054. any special interpretation of the contents of this string.

  2055. This option doesn’t make sense in Rendezvous connection; the result

  2056. might be that simply one side will override the value from the other

  2057. side and it’s the matter of luck which one would win

  2058. </p>

  2059. </dd>

  2060. <dt><span><samp>srt_streamid=<var>string</var></samp></span></dt>

  2061. <dd><p>Alias for &lsquo;<samp>streamid</samp>&rsquo; to avoid conflict with ffmpeg command line option.

  2062. </p>

  2063. </dd>

  2064. <dt><span><samp>smoother=<var>live|file</var></samp></span></dt>

  2065. <dd><p>The type of Smoother used for the transmission for that socket, which

  2066. is responsible for the transmission and congestion control. The Smoother

  2067. type must be exactly the same on both connecting parties, otherwise

  2068. the connection is rejected.

  2069. </p>

  2070. </dd>

  2071. <dt><span><samp>messageapi=<var>1|0</var></samp></span></dt>

  2072. <dd><p>When set, this socket uses the Message API, otherwise it uses Buffer

  2073. API. Note that in live mode (see <samp>transtype</samp>) there’s only

  2074. message API available. In File mode you can chose to use one of two modes:

  2075. </p>

  2076. <p>Stream API (default, when this option is false). In this mode you may

  2077. send as many data as you wish with one sending instruction, or even use

  2078. dedicated functions that read directly from a file. The internal facility

  2079. will take care of any speed and congestion control. When receiving, you

  2080. can also receive as many data as desired, the data not extracted will be

  2081. waiting for the next call. There is no boundary between data portions in

  2082. the Stream mode.

  2083. </p>

  2084. <p>Message API. In this mode your single sending instruction passes exactly

  2085. one piece of data that has boundaries (a message). Contrary to Live mode,

  2086. this message may span across multiple UDP packets and the only size

  2087. limitation is that it shall fit as a whole in the sending buffer. The

  2088. receiver shall use as large buffer as necessary to receive the message,

  2089. otherwise the message will not be given up. When the message is not

  2090. complete (not all packets received or there was a packet loss) it will

  2091. not be given up.

  2092. </p>

  2093. </dd>

  2094. <dt><span><samp>transtype=<var>live|file</var></samp></span></dt>

  2095. <dd><p>Sets the transmission type for the socket, in particular, setting this

  2096. option sets multiple other parameters to their default values as required

  2097. for a particular transmission type.

  2098. </p>

  2099. <p>live: Set options as for live transmission. In this mode, you should

  2100. send by one sending instruction only so many data that fit in one UDP packet,

  2101. and limited to the value defined first in <samp>payload_size</samp> (1316 is

  2102. default in this mode). There is no speed control in this mode, only the

  2103. bandwidth control, if configured, in order to not exceed the bandwidth with

  2104. the overhead transmission (retransmitted and control packets).

  2105. </p>

  2106. <p>file: Set options as for non-live transmission. See <samp>messageapi</samp>

  2107. for further explanations

  2108. </p>

  2109. </dd>

  2110. <dt><span><samp>linger=<var>seconds</var></samp></span></dt>

  2111. <dd><p>The number of seconds that the socket waits for unsent data when closing.

  2112. Default is -1. -1 means auto (off with 0 seconds in live mode, on with 180

  2113. seconds in file mode). The range for this option is integers in the

  2114. 0 - <code>INT_MAX</code>.

  2115. </p>

  2116. </dd>

  2117. <dt><span><samp>tsbpd=<var>1|0</var></samp></span></dt>

  2118. <dd><p>When true, use Timestamp-based Packet Delivery mode. The default behavior

  2119. depends on the transmission type: enabled in live mode, disabled in file

  2120. mode.

  2121. </p>

  2122. </dd>

  2123. </dl>

  2124. 

  2125. <p>For more information see: <a href="https://github.com/Haivision/srt">https://github.com/Haivision/srt</a>.

  2126. </p>

  2127. <a name="srtp"></a>

  2128. <h3 class="section">3.38 srtp<span class="pull-right"><a class="anchor hidden-xs" href="#srtp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-srtp" aria-hidden="true">TOC</a></span></h3>

  2129. 

  2130. <p>Secure Real-time Transport Protocol.

  2131. </p>

  2132. <p>The accepted options are:

  2133. </p><dl compact="compact">

  2134. <dt><span><samp>srtp_in_suite</samp></span></dt>

  2135. <dt><span><samp>srtp_out_suite</samp></span></dt>

  2136. <dd><p>Select input and output encoding suites.

  2137. </p>

  2138. <p>Supported values:

  2139. </p><dl compact="compact">

  2140. <dt><span>&lsquo;<samp>AES_CM_128_HMAC_SHA1_80</samp>&rsquo;</span></dt>

  2141. <dt><span>&lsquo;<samp>SRTP_AES128_CM_HMAC_SHA1_80</samp>&rsquo;</span></dt>

  2142. <dt><span>&lsquo;<samp>AES_CM_128_HMAC_SHA1_32</samp>&rsquo;</span></dt>

  2143. <dt><span>&lsquo;<samp>SRTP_AES128_CM_HMAC_SHA1_32</samp>&rsquo;</span></dt>

  2144. </dl>

  2145. 

  2146. </dd>

  2147. <dt><span><samp>srtp_in_params</samp></span></dt>

  2148. <dt><span><samp>srtp_out_params</samp></span></dt>

  2149. <dd><p>Set input and output encoding parameters, which are expressed by a

  2150. base64-encoded representation of a binary block. The first 16 bytes of

  2151. this binary block are used as master key, the following 14 bytes are

  2152. used as master salt.

  2153. </p></dd>

  2154. </dl>

  2155. 

  2156. <a name="subfile"></a>

  2157. <h3 class="section">3.39 subfile<span class="pull-right"><a class="anchor hidden-xs" href="#subfile" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-subfile" aria-hidden="true">TOC</a></span></h3>

  2158. 

  2159. <p>Virtually extract a segment of a file or another stream.

  2160. The underlying stream must be seekable.

  2161. </p>

  2162. <p>Accepted options:

  2163. </p><dl compact="compact">

  2164. <dt><span><samp>start</samp></span></dt>

  2165. <dd><p>Start offset of the extracted segment, in bytes.

  2166. </p></dd>

  2167. <dt><span><samp>end</samp></span></dt>

  2168. <dd><p>End offset of the extracted segment, in bytes.

  2169. If set to 0, extract till end of file.

  2170. </p></dd>

  2171. </dl>

  2172. 

  2173. <p>Examples:

  2174. </p>

  2175. <p>Extract a chapter from a DVD VOB file (start and end sectors obtained

  2176. externally and multiplied by 2048):

  2177. </p><div class="example">

  2178. <pre class="example">subfile,,start,153391104,end,268142592,,:/media/dvd/VIDEO_TS/VTS_08_1.VOB

  2179. </pre></div>

  2180. 

  2181. <p>Play an AVI file directly from a TAR archive:

  2182. </p><div class="example">

  2183. <pre class="example">subfile,,start,183241728,end,366490624,,:archive.tar

  2184. </pre></div>

  2185. 

  2186. <p>Play a MPEG-TS file from start offset till end:

  2187. </p><div class="example">

  2188. <pre class="example">subfile,,start,32815239,end,0,,:video.ts

  2189. </pre></div>

  2190. 

  2191. <a name="tee"></a>

  2192. <h3 class="section">3.40 tee<span class="pull-right"><a class="anchor hidden-xs" href="#tee" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tee" aria-hidden="true">TOC</a></span></h3>

  2193. 

  2194. <p>Writes the output to multiple protocols. The individual outputs are separated

  2195. by |

  2196. </p>

  2197. <div class="example">

  2198. <pre class="example">tee:file://path/to/local/this.avi|file://path/to/local/that.avi

  2199. </pre></div>

  2200. 

  2201. <a name="tcp"></a>

  2202. <h3 class="section">3.41 tcp<span class="pull-right"><a class="anchor hidden-xs" href="#tcp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tcp" aria-hidden="true">TOC</a></span></h3>

  2203. 

  2204. <p>Transmission Control Protocol.

  2205. </p>

  2206. <p>The required syntax for a TCP url is:

  2207. </p><div class="example">

  2208. <pre class="example">tcp://<var>hostname</var>:<var>port</var>[?<var>options</var>]

  2209. </pre></div>

  2210. 

  2211. <p><var>options</var> contains a list of &amp;-separated options of the form

  2212. <var>key</var>=<var>val</var>.

  2213. </p>

  2214. <p>The list of supported options follows.

  2215. </p>

  2216. <dl compact="compact">

  2217. <dt><span><samp>listen=<var>2|1|0</var></samp></span></dt>

  2218. <dd><p>Listen for an incoming connection. 0 disables listen, 1 enables listen in

  2219. single client mode, 2 enables listen in multi-client mode. Default value is 0.

  2220. </p>

  2221. </dd>

  2222. <dt><span><samp>timeout=<var>microseconds</var></samp></span></dt>

  2223. <dd><p>Set raise error timeout, expressed in microseconds.

  2224. </p>

  2225. <p>This option is only relevant in read mode: if no data arrived in more

  2226. than this time interval, raise error.

  2227. </p>

  2228. </dd>

  2229. <dt><span><samp>listen_timeout=<var>milliseconds</var></samp></span></dt>

  2230. <dd><p>Set listen timeout, expressed in milliseconds.

  2231. </p>

  2232. </dd>

  2233. <dt><span><samp>recv_buffer_size=<var>bytes</var></samp></span></dt>

  2234. <dd><p>Set receive buffer size, expressed bytes.

  2235. </p>

  2236. </dd>

  2237. <dt><span><samp>send_buffer_size=<var>bytes</var></samp></span></dt>

  2238. <dd><p>Set send buffer size, expressed bytes.

  2239. </p>

  2240. </dd>

  2241. <dt><span><samp>tcp_nodelay=<var>1|0</var></samp></span></dt>

  2242. <dd><p>Set TCP_NODELAY to disable Nagle&rsquo;s algorithm. Default value is 0.

  2243. </p>

  2244. <p><em>Remark: Writing to the socket is currently not optimized to minimize system calls and reduces the efficiency / effect of TCP_NODELAY.</em>

  2245. </p>

  2246. </dd>

  2247. <dt><span><samp>tcp_mss=<var>bytes</var></samp></span></dt>

  2248. <dd><p>Set maximum segment size for outgoing TCP packets, expressed in bytes.

  2249. </p></dd>

  2250. </dl>

  2251. 

  2252. <p>The following example shows how to setup a listening TCP connection

  2253. with <code>ffmpeg</code>, which is then accessed with <code>ffplay</code>:

  2254. </p><div class="example">

  2255. <pre class="example">ffmpeg -i <var>input</var> -f <var>format</var> tcp://<var>hostname</var>:<var>port</var>?listen

  2256. ffplay tcp://<var>hostname</var>:<var>port</var>

  2257. </pre></div>

  2258. 

  2259. <a name="tls"></a>

  2260. <h3 class="section">3.42 tls<span class="pull-right"><a class="anchor hidden-xs" href="#tls" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-tls" aria-hidden="true">TOC</a></span></h3>

  2261. 

  2262. <p>Transport Layer Security (TLS) / Secure Sockets Layer (SSL)

  2263. </p>

  2264. <p>The required syntax for a TLS/SSL url is:

  2265. </p><div class="example">

  2266. <pre class="example">tls://<var>hostname</var>:<var>port</var>[?<var>options</var>]

  2267. </pre></div>

  2268. 

  2269. <p>The following parameters can be set via command line options

  2270. (or in code via <code>AVOption</code>s):

  2271. </p>

  2272. <dl compact="compact">

  2273. <dt><span><samp>ca_file, cafile=<var>filename</var></samp></span></dt>

  2274. <dd><p>A file containing certificate authority (CA) root certificates to treat

  2275. as trusted. If the linked TLS library contains a default this might not

  2276. need to be specified for verification to work, but not all libraries and

  2277. setups have defaults built in.

  2278. The file must be in OpenSSL PEM format.

  2279. </p>

  2280. </dd>

  2281. <dt><span><samp>tls_verify=<var>1|0</var></samp></span></dt>

  2282. <dd><p>If enabled, try to verify the peer that we are communicating with.

  2283. Note, if using OpenSSL, this currently only makes sure that the

  2284. peer certificate is signed by one of the root certificates in the CA

  2285. database, but it does not validate that the certificate actually

  2286. matches the host name we are trying to connect to. (With other backends,

  2287. the host name is validated as well.)

  2288. </p>

  2289. <p>This is disabled by default since it requires a CA database to be

  2290. provided by the caller in many cases.

  2291. </p>

  2292. </dd>

  2293. <dt><span><samp>cert_file, cert=<var>filename</var></samp></span></dt>

  2294. <dd><p>A file containing a certificate to use in the handshake with the peer.

  2295. (When operating as server, in listen mode, this is more often required

  2296. by the peer, while client certificates only are mandated in certain

  2297. setups.)

  2298. </p>

  2299. </dd>

  2300. <dt><span><samp>key_file, key=<var>filename</var></samp></span></dt>

  2301. <dd><p>A file containing the private key for the certificate.

  2302. </p>

  2303. </dd>

  2304. <dt><span><samp>listen=<var>1|0</var></samp></span></dt>

  2305. <dd><p>If enabled, listen for connections on the provided port, and assume

  2306. the server role in the handshake instead of the client role.

  2307. </p>

  2308. </dd>

  2309. <dt><span><samp>http_proxy</samp></span></dt>

  2310. <dd><p>The HTTP proxy to tunnel through, e.g. <code>http://example.com:1234</code>.

  2311. The proxy must support the CONNECT method.

  2312. </p>

  2313. </dd>

  2314. </dl>

  2315. 

  2316. <p>Example command lines:

  2317. </p>

  2318. <p>To create a TLS/SSL server that serves an input stream.

  2319. </p>

  2320. <div class="example">

  2321. <pre class="example">ffmpeg -i <var>input</var> -f <var>format</var> tls://<var>hostname</var>:<var>port</var>?listen&amp;cert=<var>server.crt</var>&amp;key=<var>server.key</var>

  2322. </pre></div>

  2323. 

  2324. <p>To play back a stream from the TLS/SSL server using <code>ffplay</code>:

  2325. </p>

  2326. <div class="example">

  2327. <pre class="example">ffplay tls://<var>hostname</var>:<var>port</var>

  2328. </pre></div>

  2329. 

  2330. <a name="udp"></a>

  2331. <h3 class="section">3.43 udp<span class="pull-right"><a class="anchor hidden-xs" href="#udp" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-udp" aria-hidden="true">TOC</a></span></h3>

  2332. 

  2333. <p>User Datagram Protocol.

  2334. </p>

  2335. <p>The required syntax for an UDP URL is:

  2336. </p><div class="example">

  2337. <pre class="example">udp://<var>hostname</var>:<var>port</var>[?<var>options</var>]

  2338. </pre></div>

  2339. 

  2340. <p><var>options</var> contains a list of &amp;-separated options of the form <var>key</var>=<var>val</var>.

  2341. </p>

  2342. <p>In case threading is enabled on the system, a circular buffer is used

  2343. to store the incoming data, which allows one to reduce loss of data due to

  2344. UDP socket buffer overruns. The <var>fifo_size</var> and

  2345. <var>overrun_nonfatal</var> options are related to this buffer.

  2346. </p>

  2347. <p>The list of supported options follows.

  2348. </p>

  2349. <dl compact="compact">

  2350. <dt><span><samp>buffer_size=<var>size</var></samp></span></dt>

  2351. <dd><p>Set the UDP maximum socket buffer size in bytes. This is used to set either

  2352. the receive or send buffer size, depending on what the socket is used for.

  2353. Default is 32 KB for output, 384 KB for input.  See also <var>fifo_size</var>.

  2354. </p>

  2355. </dd>

  2356. <dt><span><samp>bitrate=<var>bitrate</var></samp></span></dt>

  2357. <dd><p>If set to nonzero, the output will have the specified constant bitrate if the

  2358. input has enough packets to sustain it.

  2359. </p>

  2360. </dd>

  2361. <dt><span><samp>burst_bits=<var>bits</var></samp></span></dt>

  2362. <dd><p>When using <var>bitrate</var> this specifies the maximum number of bits in

  2363. packet bursts.

  2364. </p>

  2365. </dd>

  2366. <dt><span><samp>localport=<var>port</var></samp></span></dt>

  2367. <dd><p>Override the local UDP port to bind with.

  2368. </p>

  2369. </dd>

  2370. <dt><span><samp>localaddr=<var>addr</var></samp></span></dt>

  2371. <dd><p>Local IP address of a network interface used for sending packets or joining

  2372. multicast groups.

  2373. </p>

  2374. </dd>

  2375. <dt><span><samp>pkt_size=<var>size</var></samp></span></dt>

  2376. <dd><p>Set the size in bytes of UDP packets.

  2377. </p>

  2378. </dd>

  2379. <dt><span><samp>reuse=<var>1|0</var></samp></span></dt>

  2380. <dd><p>Explicitly allow or disallow reusing UDP sockets.

  2381. </p>

  2382. </dd>

  2383. <dt><span><samp>ttl=<var>ttl</var></samp></span></dt>

  2384. <dd><p>Set the time to live value (for multicast only).

  2385. </p>

  2386. </dd>

  2387. <dt><span><samp>connect=<var>1|0</var></samp></span></dt>

  2388. <dd><p>Initialize the UDP socket with <code>connect()</code>. In this case, the

  2389. destination address can&rsquo;t be changed with ff_udp_set_remote_url later.

  2390. If the destination address isn&rsquo;t known at the start, this option can

  2391. be specified in ff_udp_set_remote_url, too.

  2392. This allows finding out the source address for the packets with getsockname,

  2393. and makes writes return with AVERROR(ECONNREFUSED) if &quot;destination

  2394. unreachable&quot; is received.

  2395. For receiving, this gives the benefit of only receiving packets from

  2396. the specified peer address/port.

  2397. </p>

  2398. </dd>

  2399. <dt><span><samp>sources=<var>address</var>[,<var>address</var>]</samp></span></dt>

  2400. <dd><p>Only receive packets sent from the specified addresses. In case of multicast,

  2401. also subscribe to multicast traffic coming from these addresses only.

  2402. </p>

  2403. </dd>

  2404. <dt><span><samp>block=<var>address</var>[,<var>address</var>]</samp></span></dt>

  2405. <dd><p>Ignore packets sent from the specified addresses. In case of multicast, also

  2406. exclude the source addresses in the multicast subscription.

  2407. </p>

  2408. </dd>

  2409. <dt><span><samp>fifo_size=<var>units</var></samp></span></dt>

  2410. <dd><p>Set the UDP receiving circular buffer size, expressed as a number of

  2411. packets with size of 188 bytes. If not specified defaults to 7*4096.

  2412. </p>

  2413. </dd>

  2414. <dt><span><samp>overrun_nonfatal=<var>1|0</var></samp></span></dt>

  2415. <dd><p>Survive in case of UDP receiving circular buffer overrun. Default

  2416. value is 0.

  2417. </p>

  2418. </dd>

  2419. <dt><span><samp>timeout=<var>microseconds</var></samp></span></dt>

  2420. <dd><p>Set raise error timeout, expressed in microseconds.

  2421. </p>

  2422. <p>This option is only relevant in read mode: if no data arrived in more

  2423. than this time interval, raise error.

  2424. </p>

  2425. </dd>

  2426. <dt><span><samp>broadcast=<var>1|0</var></samp></span></dt>

  2427. <dd><p>Explicitly allow or disallow UDP broadcasting.

  2428. </p>

  2429. <p>Note that broadcasting may not work properly on networks having

  2430. a broadcast storm protection.

  2431. </p></dd>

  2432. </dl>

  2433. 

  2434. <a name="Examples-1"></a>

  2435. <h4 class="subsection">3.43.1 Examples<span class="pull-right"><a class="anchor hidden-xs" href="#Examples-1" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Examples-1" aria-hidden="true">TOC</a></span></h4>

  2436. 

  2437. <ul>

  2438. <li> Use <code>ffmpeg</code> to stream over UDP to a remote endpoint:

  2439. <div class="example">

  2440. <pre class="example">ffmpeg -i <var>input</var> -f <var>format</var> udp://<var>hostname</var>:<var>port</var>

  2441. </pre></div>

  2442. 

  2443. </li><li> Use <code>ffmpeg</code> to stream in mpegts format over UDP using 188

  2444. sized UDP packets, using a large input buffer:

  2445. <div class="example">

  2446. <pre class="example">ffmpeg -i <var>input</var> -f mpegts udp://<var>hostname</var>:<var>port</var>?pkt_size=188&amp;buffer_size=65535

  2447. </pre></div>

  2448. 

  2449. </li><li> Use <code>ffmpeg</code> to receive over UDP from a remote endpoint:

  2450. <div class="example">

  2451. <pre class="example">ffmpeg -i udp://[<var>multicast-address</var>]:<var>port</var> ...

  2452. </pre></div>

  2453. </li></ul>

  2454. 

  2455. <a name="unix"></a>

  2456. <h3 class="section">3.44 unix<span class="pull-right"><a class="anchor hidden-xs" href="#unix" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-unix" aria-hidden="true">TOC</a></span></h3>

  2457. 

  2458. <p>Unix local socket

  2459. </p>

  2460. <p>The required syntax for a Unix socket URL is:

  2461. </p>

  2462. <div class="example">

  2463. <pre class="example">unix://<var>filepath</var>

  2464. </pre></div>

  2465. 

  2466. <p>The following parameters can be set via command line options

  2467. (or in code via <code>AVOption</code>s):

  2468. </p>

  2469. <dl compact="compact">

  2470. <dt><span><samp>timeout</samp></span></dt>

  2471. <dd><p>Timeout in ms.

  2472. </p></dd>

  2473. <dt><span><samp>listen</samp></span></dt>

  2474. <dd><p>Create the Unix socket in listening mode.

  2475. </p></dd>

  2476. </dl>

  2477. 

  2478. <a name="zmq"></a>

  2479. <h3 class="section">3.45 zmq<span class="pull-right"><a class="anchor hidden-xs" href="#zmq" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-zmq" aria-hidden="true">TOC</a></span></h3>

  2480. 

  2481. <p>ZeroMQ asynchronous messaging using the libzmq library.

  2482. </p>

  2483. <p>This library supports unicast streaming to multiple clients without relying on

  2484. an external server.

  2485. </p>

  2486. <p>The required syntax for streaming or connecting to a stream is:

  2487. </p><div class="example">

  2488. <pre class="example">zmq:tcp://ip-address:port

  2489. </pre></div>

  2490. 

  2491. <p>Example:

  2492. Create a localhost stream on port 5555:

  2493. </p><div class="example">

  2494. <pre class="example">ffmpeg -re -i input -f mpegts zmq:tcp://127.0.0.1:5555

  2495. </pre></div>

  2496. 

  2497. <p>Multiple clients may connect to the stream using:

  2498. </p><div class="example">

  2499. <pre class="example">ffplay zmq:tcp://127.0.0.1:5555

  2500. </pre></div>

  2501. 

  2502. <p>Streaming to multiple clients is implemented using a ZeroMQ Pub-Sub pattern.

  2503. The server side binds to a port and publishes data. Clients connect to the

  2504. server (via IP address/port) and subscribe to the stream. The order in which

  2505. the server and client start generally does not matter.

  2506. </p>

  2507. <p>ffmpeg must be compiled with the &ndash;enable-libzmq option to support

  2508. this protocol.

  2509. </p>

  2510. <p>Options can be set on the <code>ffmpeg</code>/<code>ffplay</code> command

  2511. line. The following options are supported:

  2512. </p>

  2513. <dl compact="compact">

  2514. <dt><span><samp>pkt_size</samp></span></dt>

  2515. <dd><p>Forces the maximum packet size for sending/receiving data. The default value is

  2516. 131,072 bytes. On the server side, this sets the maximum size of sent packets

  2517. via ZeroMQ. On the clients, it sets an internal buffer size for receiving

  2518. packets. Note that pkt_size on the clients should be equal to or greater than

  2519. pkt_size on the server. Otherwise the received message may be truncated causing

  2520. decoding errors.

  2521. </p>

  2522. </dd>

  2523. </dl>

  2524. 

  2525. 

  2526. <a name="See-Also"></a>

  2527. <h2 class="chapter">4 See Also<span class="pull-right"><a class="anchor hidden-xs" href="#See-Also" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-See-Also" aria-hidden="true">TOC</a></span></h2>

  2528. 

  2529. <p><a href="ffmpeg.html">ffmpeg</a>, <a href="ffplay.html">ffplay</a>, <a href="ffprobe.html">ffprobe</a>,

  2530. <a href="libavformat.html">libavformat</a>

  2531. </p>

  2532. 

  2533. <a name="Authors"></a>

  2534. <h2 class="chapter">5 Authors<span class="pull-right"><a class="anchor hidden-xs" href="#Authors" aria-hidden="true">#</a> <a class="anchor hidden-xs"href="#toc-Authors" aria-hidden="true">TOC</a></span></h2>

  2535. 

  2536. <p>The FFmpeg developers.

  2537. </p>

  2538. <p>For details about the authorship, see the Git history of the project

  2539. (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command

  2540. <code>git log</code> in the FFmpeg source directory, or browsing the

  2541. online repository at <a href="https://git.ffmpeg.org/ffmpeg">https://git.ffmpeg.org/ffmpeg</a>.

  2542. </p>

  2543. <p>Maintainers for the specific components are listed in the file

  2544. <samp>MAINTAINERS</samp> in the source code tree.

  2545. </p>

  2546. 

  2547.       <p style="font-size: small;">

  2548.         This document was generated using <a href="https://www.gnu.org/software/texinfo/"><em>makeinfo</em></a>.

  2549.       </p>

  2550.     </div>

  2551.   </body>

  2552. </html>