avfilter/af_acrossover: move coefficients and state to simple arrays
[ffmpeg.git] / doc / protocols.texi
1 @chapter Protocol Options
2 @c man begin PROTOCOL OPTIONS
3
4 The libavformat library provides some generic global options, which
5 can be set on all the protocols. In addition each protocol may support
6 so-called private options, which are specific for that component.
7
8 Options may be set by specifying -@var{option} @var{value} in the
9 FFmpeg tools, or by setting the value explicitly in the
10 @code{AVFormatContext} options or using the @file{libavutil/opt.h} API
11 for programmatic use.
12
13 The list of supported options follows:
14
15 @table @option
16 @item protocol_whitelist @var{list} (@emph{input})
17 Set a ","-separated list of allowed protocols. "ALL" matches all protocols. Protocols
18 prefixed by "-" are disabled.
19 All protocols are allowed by default but protocols used by an another
20 protocol (nested protocols) are restricted to a per protocol subset.
21 @end table
22
23 @c man end PROTOCOL OPTIONS
24
25 @chapter Protocols
26 @c man begin PROTOCOLS
27
28 Protocols are configured elements in FFmpeg that enable access to
29 resources that require specific protocols.
30
31 When you configure your FFmpeg build, all the supported protocols are
32 enabled by default. You can list all available ones using the
33 configure option "--list-protocols".
34
35 You can disable all the protocols using the configure option
36 "--disable-protocols", and selectively enable a protocol using the
37 option "--enable-protocol=@var{PROTOCOL}", or you can disable a
38 particular protocol using the option
39 "--disable-protocol=@var{PROTOCOL}".
40
41 The option "-protocols" of the ff* tools will display the list of
42 supported protocols.
43
44 All protocols accept the following options:
45
46 @table @option
47 @item rw_timeout
48 Maximum time to wait for (network) read/write operations to complete,
49 in microseconds.
50 @end table
51
52 A description of the currently available protocols follows.
53
54 @section amqp
55
56 Advanced Message Queueing Protocol (AMQP) version 0-9-1 is a broker based
57 publish-subscribe communication protocol.
58
59 FFmpeg must be compiled with --enable-librabbitmq to support AMQP. A separate
60 AMQP broker must also be run. An example open-source AMQP broker is RabbitMQ.
61
62 After starting the broker, an FFmpeg client may stream data to the broker using
63 the command:
64
65 @example
66 ffmpeg -re -i input -f mpegts amqp://[[user]:[password]@@]hostname[:port]
67 @end example
68
69 Where hostname and port (default is 5672) is the address of the broker. The
70 client may also set a user/password for authentication. The default for both
71 fields is "guest".
72
73 Muliple subscribers may stream from the broker using the command:
74 @example
75 ffplay amqp://[[user]:[password]@@]hostname[:port]
76 @end example
77
78 In RabbitMQ all data published to the broker flows through a specific exchange,
79 and each subscribing client has an assigned queue/buffer. When a packet arrives
80 at an exchange, it may be copied to a client's queue depending on the exchange
81 and routing_key fields.
82
83 The following options are supported:
84
85 @table @option
86
87 @item exchange
88 Sets the exchange to use on the broker. RabbitMQ has several predefined
89 exchanges: "amq.direct" is the default exchange, where the publisher and
90 subscriber must have a matching routing_key; "amq.fanout" is the same as a
91 broadcast operation (i.e. the data is forwarded to all queues on the fanout
92 exchange independent of the routing_key); and "amq.topic" is similar to
93 "amq.direct", but allows for more complex pattern matching (refer to the RabbitMQ
94 documentation).
95
96 @item routing_key
97 Sets the routing key. The default value is "amqp". The routing key is used on
98 the "amq.direct" and "amq.topic" exchanges to decide whether packets are written
99 to the queue of a subscriber.
100
101 @item pkt_size
102 Maximum size of each packet sent/received to the broker. Default is 131072.
103 Minimum is 4096 and max is any large value (representable by an int). When
104 receiving packets, this sets an internal buffer size in FFmpeg. It should be
105 equal to or greater than the size of the published packets to the broker. Otherwise
106 the received message may be truncated causing decoding errors.
107
108 @item connection_timeout
109 The timeout in seconds during the initial connection to the broker. The
110 default value is rw_timeout, or 5 seconds if rw_timeout is not set.
111
112 @item delivery_mode @var{mode}
113 Sets the delivery mode of each message sent to broker.
114 The following values are accepted:
115 @table @samp
116 @item persistent
117 Delivery mode set to "persistent" (2). This is the default value.
118 Messages may be written to the broker's disk depending on its setup.
119
120 @item non-persistent
121 Delivery mode set to "non-persistent" (1).
122 Messages will stay in broker's memory unless the broker is under memory
123 pressure.
124
125 @end table
126
127 @end table
128
129 @section async
130
131 Asynchronous data filling wrapper for input stream.
132
133 Fill data in a background thread, to decouple I/O operation from demux thread.
134
135 @example
136 async:@var{URL}
137 async:http://host/resource
138 async:cache:http://host/resource
139 @end example
140
141 @section bluray
142
143 Read BluRay playlist.
144
145 The accepted options are:
146 @table @option
147
148 @item angle
149 BluRay angle
150
151 @item chapter
152 Start chapter (1...N)
153
154 @item playlist
155 Playlist to read (BDMV/PLAYLIST/?????.mpls)
156
157 @end table
158
159 Examples:
160
161 Read longest playlist from BluRay mounted to /mnt/bluray:
162 @example
163 bluray:/mnt/bluray
164 @end example
165
166 Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2:
167 @example
168 -playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray
169 @end example
170
171 @section cache
172
173 Caching wrapper for input stream.
174
175 Cache the input stream to temporary file. It brings seeking capability to live streams.
176
177 @example
178 cache:@var{URL}
179 @end example
180
181 @section concat
182
183 Physical concatenation protocol.
184
185 Read and seek from many resources in sequence as if they were
186 a unique resource.
187
188 A URL accepted by this protocol has the syntax:
189 @example
190 concat:@var{URL1}|@var{URL2}|...|@var{URLN}
191 @end example
192
193 where @var{URL1}, @var{URL2}, ..., @var{URLN} are the urls of the
194 resource to be concatenated, each one possibly specifying a distinct
195 protocol.
196
197 For example to read a sequence of files @file{split1.mpeg},
198 @file{split2.mpeg}, @file{split3.mpeg} with @command{ffplay} use the
199 command:
200 @example
201 ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
202 @end example
203
204 Note that you may need to escape the character "|" which is special for
205 many shells.
206
207 @section crypto
208
209 AES-encrypted stream reading protocol.
210
211 The accepted options are:
212 @table @option
213 @item key
214 Set the AES decryption key binary block from given hexadecimal representation.
215
216 @item iv
217 Set the AES decryption initialization vector binary block from given hexadecimal representation.
218 @end table
219
220 Accepted URL formats:
221 @example
222 crypto:@var{URL}
223 crypto+@var{URL}
224 @end example
225
226 @section data
227
228 Data in-line in the URI. See @url{http://en.wikipedia.org/wiki/Data_URI_scheme}.
229
230 For example, to convert a GIF file given inline with @command{ffmpeg}:
231 @example
232 ffmpeg -i "data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=" smiley.png
233 @end example
234
235 @section file
236
237 File access protocol.
238
239 Read from or write to a file.
240
241 A file URL can have the form:
242 @example
243 file:@var{filename}
244 @end example
245
246 where @var{filename} is the path of the file to read.
247
248 An URL that does not have a protocol prefix will be assumed to be a
249 file URL. Depending on the build, an URL that looks like a Windows
250 path with the drive letter at the beginning will also be assumed to be
251 a file URL (usually not the case in builds for unix-like systems).
252
253 For example to read from a file @file{input.mpeg} with @command{ffmpeg}
254 use the command:
255 @example
256 ffmpeg -i file:input.mpeg output.mpeg
257 @end example
258
259 This protocol accepts the following options:
260
261 @table @option
262 @item truncate
263 Truncate existing files on write, if set to 1. A value of 0 prevents
264 truncating. Default value is 1.
265
266 @item blocksize
267 Set I/O operation maximum block size, in bytes. Default value is
268 @code{INT_MAX}, which results in not limiting the requested block size.
269 Setting this value reasonably low improves user termination request reaction
270 time, which is valuable for files on slow medium.
271
272 @item follow
273 If set to 1, the protocol will retry reading at the end of the file, allowing
274 reading files that still are being written. In order for this to terminate,
275 you either need to use the rw_timeout option, or use the interrupt callback
276 (for API users).
277
278 @item seekable
279 Controls if seekability is advertised on the file. 0 means non-seekable, -1
280 means auto (seekable for normal files, non-seekable for named pipes).
281
282 Many demuxers handle seekable and non-seekable resources differently,
283 overriding this might speed up opening certain files at the cost of losing some
284 features (e.g. accurate seeking).
285 @end table
286
287 @section ftp
288
289 FTP (File Transfer Protocol).
290
291 Read from or write to remote resources using FTP protocol.
292
293 Following syntax is required.
294 @example
295 ftp://[user[:password]@@]server[:port]/path/to/remote/resource.mpeg
296 @end example
297
298 This protocol accepts the following options.
299
300 @table @option
301 @item timeout
302 Set timeout in microseconds of socket I/O operations used by the underlying low level
303 operation. By default it is set to -1, which means that the timeout is
304 not specified.
305
306 @item ftp-user
307 Set a user to be used for authenticating to the FTP server. This is overridden by the
308 user in the FTP URL.
309
310 @item ftp-password
311 Set a password to be used for authenticating to the FTP server. This is overridden by
312 the password in the FTP URL, or by @option{ftp-anonymous-password} if no user is set.
313
314 @item ftp-anonymous-password
315 Password used when login as anonymous user. Typically an e-mail address
316 should be used.
317
318 @item ftp-write-seekable
319 Control seekability of connection during encoding. If set to 1 the
320 resource is supposed to be seekable, if set to 0 it is assumed not
321 to be seekable. Default value is 0.
322 @end table
323
324 NOTE: Protocol can be used as output, but it is recommended to not do
325 it, unless special care is taken (tests, customized server configuration
326 etc.). Different FTP servers behave in different way during seek
327 operation. ff* tools may produce incomplete content due to server limitations.
328
329 @section gopher
330
331 Gopher protocol.
332
333 @section hls
334
335 Read Apple HTTP Live Streaming compliant segmented stream as
336 a uniform one. The M3U8 playlists describing the segments can be
337 remote HTTP resources or local files, accessed using the standard
338 file protocol.
339 The nested protocol is declared by specifying
340 "+@var{proto}" after the hls URI scheme name, where @var{proto}
341 is either "file" or "http".
342
343 @example
344 hls+http://host/path/to/remote/resource.m3u8
345 hls+file://path/to/local/resource.m3u8
346 @end example
347
348 Using this protocol is discouraged - the hls demuxer should work
349 just as well (if not, please report the issues) and is more complete.
350 To use the hls demuxer instead, simply use the direct URLs to the
351 m3u8 files.
352
353 @section http
354
355 HTTP (Hyper Text Transfer Protocol).
356
357 This protocol accepts the following options:
358
359 @table @option
360 @item seekable
361 Control seekability of connection. If set to 1 the resource is
362 supposed to be seekable, if set to 0 it is assumed not to be seekable,
363 if set to -1 it will try to autodetect if it is seekable. Default
364 value is -1.
365
366 @item chunked_post
367 If set to 1 use chunked Transfer-Encoding for posts, default is 1.
368
369 @item content_type
370 Set a specific content type for the POST messages or for listen mode.
371
372 @item http_proxy
373 set HTTP proxy to tunnel through e.g. http://example.com:1234
374
375 @item headers
376 Set custom HTTP headers, can override built in default headers. The
377 value must be a string encoding the headers.
378
379 @item multiple_requests
380 Use persistent connections if set to 1, default is 0.
381
382 @item post_data
383 Set custom HTTP post data.
384
385 @item referer
386 Set the Referer header. Include 'Referer: URL' header in HTTP request.
387
388 @item user_agent
389 Override the User-Agent header. If not specified the protocol will use a
390 string describing the libavformat build. ("Lavf/<version>")
391
392 @item user-agent
393 This is a deprecated option, you can use user_agent instead it.
394
395 @item reconnect_at_eof
396 If set then eof is treated like an error and causes reconnection, this is useful
397 for live / endless streams.
398
399 @item reconnect_streamed
400 If set then even streamed/non seekable streams will be reconnected on errors.
401
402 @item reconnect_delay_max
403 Sets the maximum delay in seconds after which to give up reconnecting
404
405 @item mime_type
406 Export the MIME type.
407
408 @item http_version
409 Exports the HTTP response version number. Usually "1.0" or "1.1".
410
411 @item icy
412 If set to 1 request ICY (SHOUTcast) metadata from the server. If the server
413 supports this, the metadata has to be retrieved by the application by reading
414 the @option{icy_metadata_headers} and @option{icy_metadata_packet} options.
415 The default is 1.
416
417 @item icy_metadata_headers
418 If the server supports ICY metadata, this contains the ICY-specific HTTP reply
419 headers, separated by newline characters.
420
421 @item icy_metadata_packet
422 If the server supports ICY metadata, and @option{icy} was set to 1, this
423 contains the last non-empty metadata packet sent by the server. It should be
424 polled in regular intervals by applications interested in mid-stream metadata
425 updates.
426
427 @item cookies
428 Set the cookies to be sent in future requests. The format of each cookie is the
429 same as the value of a Set-Cookie HTTP response field. Multiple cookies can be
430 delimited by a newline character.
431
432 @item offset
433 Set initial byte offset.
434
435 @item end_offset
436 Try to limit the request to bytes preceding this offset.
437
438 @item method
439 When used as a client option it sets the HTTP method for the request.
440
441 When used as a server option it sets the HTTP method that is going to be
442 expected from the client(s).
443 If the expected and the received HTTP method do not match the client will
444 be given a Bad Request response.
445 When unset the HTTP method is not checked for now. This will be replaced by
446 autodetection in the future.
447
448 @item listen
449 If set to 1 enables experimental HTTP server. This can be used to send data when
450 used as an output option, or read data from a client with HTTP POST when used as
451 an input option.
452 If set to 2 enables experimental multi-client HTTP server. This is not yet implemented
453 in ffmpeg.c and thus must not be used as a command line option.
454 @example
455 # Server side (sending):
456 ffmpeg -i somefile.ogg -c copy -listen 1 -f ogg http://@var{server}:@var{port}
457
458 # Client side (receiving):
459 ffmpeg -i http://@var{server}:@var{port} -c copy somefile.ogg
460
461 # Client can also be done with wget:
462 wget http://@var{server}:@var{port} -O somefile.ogg
463
464 # Server side (receiving):
465 ffmpeg -listen 1 -i http://@var{server}:@var{port} -c copy somefile.ogg
466
467 # Client side (sending):
468 ffmpeg -i somefile.ogg -chunked_post 0 -c copy -f ogg http://@var{server}:@var{port}
469
470 # Client can also be done with wget:
471 wget --post-file=somefile.ogg http://@var{server}:@var{port}
472 @end example
473
474 @item send_expect_100
475 Send an Expect: 100-continue header for POST. If set to 1 it will send, if set
476 to 0 it won't, if set to -1 it will try to send if it is applicable. Default
477 value is -1.
478
479 @item auth_type
480
481 Set HTTP authentication type. No option for Digest, since this method requires
482 getting nonce parameters from the server first and can't be used straight away like
483 Basic.
484
485 @table @option
486 @item none
487 Choose the HTTP authentication type automatically. This is the default.
488 @item basic
489
490 Choose the HTTP basic authentication.
491
492 Basic authentication sends a Base64-encoded string that contains a user name and password
493 for the client. Base64 is not a form of encryption and should be considered the same as
494 sending the user name and password in clear text (Base64 is a reversible encoding).
495 If a resource needs to be protected, strongly consider using an authentication scheme
496 other than basic authentication. HTTPS/TLS should be used with basic authentication.
497 Without these additional security enhancements, basic authentication should not be used
498 to protect sensitive or valuable information.
499 @end table
500
501 @end table
502
503 @subsection HTTP Cookies
504
505 Some HTTP requests will be denied unless cookie values are passed in with the
506 request. The @option{cookies} option allows these cookies to be specified. At
507 the very least, each cookie must specify a value along with a path and domain.
508 HTTP requests that match both the domain and path will automatically include the
509 cookie value in the HTTP Cookie header field. Multiple cookies can be delimited
510 by a newline.
511
512 The required syntax to play a stream specifying a cookie is:
513 @example
514 ffplay -cookies "nlqptid=nltid=tsn; path=/; domain=somedomain.com;" http://somedomain.com/somestream.m3u8
515 @end example
516
517 @section Icecast
518
519 Icecast protocol (stream to Icecast servers)
520
521 This protocol accepts the following options:
522
523 @table @option
524 @item ice_genre
525 Set the stream genre.
526
527 @item ice_name
528 Set the stream name.
529
530 @item ice_description
531 Set the stream description.
532
533 @item ice_url
534 Set the stream website URL.
535
536 @item ice_public
537 Set if the stream should be public.
538 The default is 0 (not public).
539
540 @item user_agent
541 Override the User-Agent header. If not specified a string of the form
542 "Lavf/<version>" will be used.
543
544 @item password
545 Set the Icecast mountpoint password.
546
547 @item content_type
548 Set the stream content type. This must be set if it is different from
549 audio/mpeg.
550
551 @item legacy_icecast
552 This enables support for Icecast versions < 2.4.0, that do not support the
553 HTTP PUT method but the SOURCE method.
554
555 @item tls
556 Establish a TLS (HTTPS) connection to Icecast.
557
558 @end table
559
560 @example
561 icecast://[@var{username}[:@var{password}]@@]@var{server}:@var{port}/@var{mountpoint}
562 @end example
563
564 @section mmst
565
566 MMS (Microsoft Media Server) protocol over TCP.
567
568 @section mmsh
569
570 MMS (Microsoft Media Server) protocol over HTTP.
571
572 The required syntax is:
573 @example
574 mmsh://@var{server}[:@var{port}][/@var{app}][/@var{playpath}]
575 @end example
576
577 @section md5
578
579 MD5 output protocol.
580
581 Computes the MD5 hash of the data to be written, and on close writes
582 this to the designated output or stdout if none is specified. It can
583 be used to test muxers without writing an actual file.
584
585 Some examples follow.
586 @example
587 # Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
588 ffmpeg -i input.flv -f avi -y md5:output.avi.md5
589
590 # Write the MD5 hash of the encoded AVI file to stdout.
591 ffmpeg -i input.flv -f avi -y md5:
592 @end example
593
594 Note that some formats (typically MOV) require the output protocol to
595 be seekable, so they will fail with the MD5 output protocol.
596
597 @section pipe
598
599 UNIX pipe access protocol.
600
601 Read and write from UNIX pipes.
602
603 The accepted syntax is:
604 @example
605 pipe:[@var{number}]
606 @end example
607
608 @var{number} is the number corresponding to the file descriptor of the
609 pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).  If @var{number}
610 is not specified, by default the stdout file descriptor will be used
611 for writing, stdin for reading.
612
613 For example to read from stdin with @command{ffmpeg}:
614 @example
615 cat test.wav | ffmpeg -i pipe:0
616 # ...this is the same as...
617 cat test.wav | ffmpeg -i pipe:
618 @end example
619
620 For writing to stdout with @command{ffmpeg}:
621 @example
622 ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
623 # ...this is the same as...
624 ffmpeg -i test.wav -f avi pipe: | cat > test.avi
625 @end example
626
627 This protocol accepts the following options:
628
629 @table @option
630 @item blocksize
631 Set I/O operation maximum block size, in bytes. Default value is
632 @code{INT_MAX}, which results in not limiting the requested block size.
633 Setting this value reasonably low improves user termination request reaction
634 time, which is valuable if data transmission is slow.
635 @end table
636
637 Note that some formats (typically MOV), require the output protocol to
638 be seekable, so they will fail with the pipe output protocol.
639
640 @section prompeg
641
642 Pro-MPEG Code of Practice #3 Release 2 FEC protocol.
643
644 The Pro-MPEG CoP#3 FEC is a 2D parity-check forward error correction mechanism
645 for MPEG-2 Transport Streams sent over RTP.
646
647 This protocol must be used in conjunction with the @code{rtp_mpegts} muxer and
648 the @code{rtp} protocol.
649
650 The required syntax is:
651 @example
652 -f rtp_mpegts -fec prompeg=@var{option}=@var{val}... rtp://@var{hostname}:@var{port}
653 @end example
654
655 The destination UDP ports are @code{port + 2} for the column FEC stream
656 and @code{port + 4} for the row FEC stream.
657
658 This protocol accepts the following options:
659 @table @option
660
661 @item l=@var{n}
662 The number of columns (4-20, LxD <= 100)
663
664 @item d=@var{n}
665 The number of rows (4-20, LxD <= 100)
666
667 @end table
668
669 Example usage:
670
671 @example
672 -f rtp_mpegts -fec prompeg=l=8:d=4 rtp://@var{hostname}:@var{port}
673 @end example
674
675 @section rtmp
676
677 Real-Time Messaging Protocol.
678
679 The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
680 content across a TCP/IP network.
681
682 The required syntax is:
683 @example
684 rtmp://[@var{username}:@var{password}@@]@var{server}[:@var{port}][/@var{app}][/@var{instance}][/@var{playpath}]
685 @end example
686
687 The accepted parameters are:
688 @table @option
689
690 @item username
691 An optional username (mostly for publishing).
692
693 @item password
694 An optional password (mostly for publishing).
695
696 @item server
697 The address of the RTMP server.
698
699 @item port
700 The number of the TCP port to use (by default is 1935).
701
702 @item app
703 It is the name of the application to access. It usually corresponds to
704 the path where the application is installed on the RTMP server
705 (e.g. @file{/ondemand/}, @file{/flash/live/}, etc.). You can override
706 the value parsed from the URI through the @code{rtmp_app} option, too.
707
708 @item playpath
709 It is the path or name of the resource to play with reference to the
710 application specified in @var{app}, may be prefixed by "mp4:". You
711 can override the value parsed from the URI through the @code{rtmp_playpath}
712 option, too.
713
714 @item listen
715 Act as a server, listening for an incoming connection.
716
717 @item timeout
718 Maximum time to wait for the incoming connection. Implies listen.
719 @end table
720
721 Additionally, the following parameters can be set via command line options
722 (or in code via @code{AVOption}s):
723 @table @option
724
725 @item rtmp_app
726 Name of application to connect on the RTMP server. This option
727 overrides the parameter specified in the URI.
728
729 @item rtmp_buffer
730 Set the client buffer time in milliseconds. The default is 3000.
731
732 @item rtmp_conn
733 Extra arbitrary AMF connection parameters, parsed from a string,
734 e.g. like @code{B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0}.
735 Each value is prefixed by a single character denoting the type,
736 B for Boolean, N for number, S for string, O for object, or Z for null,
737 followed by a colon. For Booleans the data must be either 0 or 1 for
738 FALSE or TRUE, respectively.  Likewise for Objects the data must be 0 or
739 1 to end or begin an object, respectively. Data items in subobjects may
740 be named, by prefixing the type with 'N' and specifying the name before
741 the value (i.e. @code{NB:myFlag:1}). This option may be used multiple
742 times to construct arbitrary AMF sequences.
743
744 @item rtmp_flashver
745 Version of the Flash plugin used to run the SWF player. The default
746 is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible;
747 <libavformat version>).)
748
749 @item rtmp_flush_interval
750 Number of packets flushed in the same request (RTMPT only). The default
751 is 10.
752
753 @item rtmp_live
754 Specify that the media is a live stream. No resuming or seeking in
755 live streams is possible. The default value is @code{any}, which means the
756 subscriber first tries to play the live stream specified in the
757 playpath. If a live stream of that name is not found, it plays the
758 recorded stream. The other possible values are @code{live} and
759 @code{recorded}.
760
761 @item rtmp_pageurl
762 URL of the web page in which the media was embedded. By default no
763 value will be sent.
764
765 @item rtmp_playpath
766 Stream identifier to play or to publish. This option overrides the
767 parameter specified in the URI.
768
769 @item rtmp_subscribe
770 Name of live stream to subscribe to. By default no value will be sent.
771 It is only sent if the option is specified or if rtmp_live
772 is set to live.
773
774 @item rtmp_swfhash
775 SHA256 hash of the decompressed SWF file (32 bytes).
776
777 @item rtmp_swfsize
778 Size of the decompressed SWF file, required for SWFVerification.
779
780 @item rtmp_swfurl
781 URL of the SWF player for the media. By default no value will be sent.
782
783 @item rtmp_swfverify
784 URL to player swf file, compute hash/size automatically.
785
786 @item rtmp_tcurl
787 URL of the target stream. Defaults to proto://host[:port]/app.
788
789 @end table
790
791 For example to read with @command{ffplay} a multimedia resource named
792 "sample" from the application "vod" from an RTMP server "myserver":
793 @example
794 ffplay rtmp://myserver/vod/sample
795 @end example
796
797 To publish to a password protected server, passing the playpath and
798 app names separately:
799 @example
800 ffmpeg -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@@myserver/
801 @end example
802
803 @section rtmpe
804
805 Encrypted Real-Time Messaging Protocol.
806
807 The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
808 streaming multimedia content within standard cryptographic primitives,
809 consisting of Diffie-Hellman key exchange and HMACSHA256, generating
810 a pair of RC4 keys.
811
812 @section rtmps
813
814 Real-Time Messaging Protocol over a secure SSL connection.
815
816 The Real-Time Messaging Protocol (RTMPS) is used for streaming
817 multimedia content across an encrypted connection.
818
819 @section rtmpt
820
821 Real-Time Messaging Protocol tunneled through HTTP.
822
823 The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
824 for streaming multimedia content within HTTP requests to traverse
825 firewalls.
826
827 @section rtmpte
828
829 Encrypted Real-Time Messaging Protocol tunneled through HTTP.
830
831 The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
832 is used for streaming multimedia content within HTTP requests to traverse
833 firewalls.
834
835 @section rtmpts
836
837 Real-Time Messaging Protocol tunneled through HTTPS.
838
839 The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
840 for streaming multimedia content within HTTPS requests to traverse
841 firewalls.
842
843 @section libsmbclient
844
845 libsmbclient permits one to manipulate CIFS/SMB network resources.
846
847 Following syntax is required.
848
849 @example
850 smb://[[domain:]user[:password@@]]server[/share[/path[/file]]]
851 @end example
852
853 This protocol accepts the following options.
854
855 @table @option
856 @item timeout
857 Set timeout in milliseconds of socket I/O operations used by the underlying
858 low level operation. By default it is set to -1, which means that the timeout
859 is not specified.
860
861 @item truncate
862 Truncate existing files on write, if set to 1. A value of 0 prevents
863 truncating. Default value is 1.
864
865 @item workgroup
866 Set the workgroup used for making connections. By default workgroup is not specified.
867
868 @end table
869
870 For more information see: @url{http://www.samba.org/}.
871
872 @section libssh
873
874 Secure File Transfer Protocol via libssh
875
876 Read from or write to remote resources using SFTP protocol.
877
878 Following syntax is required.
879
880 @example
881 sftp://[user[:password]@@]server[:port]/path/to/remote/resource.mpeg
882 @end example
883
884 This protocol accepts the following options.
885
886 @table @option
887 @item timeout
888 Set timeout of socket I/O operations used by the underlying low level
889 operation. By default it is set to -1, which means that the timeout
890 is not specified.
891
892 @item truncate
893 Truncate existing files on write, if set to 1. A value of 0 prevents
894 truncating. Default value is 1.
895
896 @item private_key
897 Specify the path of the file containing private key to use during authorization.
898 By default libssh searches for keys in the @file{~/.ssh/} directory.
899
900 @end table
901
902 Example: Play a file stored on remote server.
903
904 @example
905 ffplay sftp://user:password@@server_address:22/home/user/resource.mpeg
906 @end example
907
908 @section librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte
909
910 Real-Time Messaging Protocol and its variants supported through
911 librtmp.
912
913 Requires the presence of the librtmp headers and library during
914 configuration. You need to explicitly configure the build with
915 "--enable-librtmp". If enabled this will replace the native RTMP
916 protocol.
917
918 This protocol provides most client functions and a few server
919 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
920 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
921 variants of these encrypted types (RTMPTE, RTMPTS).
922
923 The required syntax is:
924 @example
925 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
926 @end example
927
928 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
929 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
930 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
931 meaning as specified for the RTMP native protocol.
932 @var{options} contains a list of space-separated options of the form
933 @var{key}=@var{val}.
934
935 See the librtmp manual page (man 3 librtmp) for more information.
936
937 For example, to stream a file in real-time to an RTMP server using
938 @command{ffmpeg}:
939 @example
940 ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
941 @end example
942
943 To play the same stream using @command{ffplay}:
944 @example
945 ffplay "rtmp://myserver/live/mystream live=1"
946 @end example
947
948 @section rtp
949
950 Real-time Transport Protocol.
951
952 The required syntax for an RTP URL is:
953 rtp://@var{hostname}[:@var{port}][?@var{option}=@var{val}...]
954
955 @var{port} specifies the RTP port to use.
956
957 The following URL options are supported:
958
959 @table @option
960
961 @item ttl=@var{n}
962 Set the TTL (Time-To-Live) value (for multicast only).
963
964 @item rtcpport=@var{n}
965 Set the remote RTCP port to @var{n}.
966
967 @item localrtpport=@var{n}
968 Set the local RTP port to @var{n}.
969
970 @item localrtcpport=@var{n}'
971 Set the local RTCP port to @var{n}.
972
973 @item pkt_size=@var{n}
974 Set max packet size (in bytes) to @var{n}.
975
976 @item connect=0|1
977 Do a @code{connect()} on the UDP socket (if set to 1) or not (if set
978 to 0).
979
980 @item sources=@var{ip}[,@var{ip}]
981 List allowed source IP addresses.
982
983 @item block=@var{ip}[,@var{ip}]
984 List disallowed (blocked) source IP addresses.
985
986 @item write_to_source=0|1
987 Send packets to the source address of the latest received packet (if
988 set to 1) or to a default remote address (if set to 0).
989
990 @item localport=@var{n}
991 Set the local RTP port to @var{n}.
992
993 @item timeout=@var{n}
994 Set timeout (in microseconds) of socket I/O operations to @var{n}.
995
996 This is a deprecated option. Instead, @option{localrtpport} should be
997 used.
998
999 @end table
1000
1001 Important notes:
1002
1003 @enumerate
1004
1005 @item
1006 If @option{rtcpport} is not set the RTCP port will be set to the RTP
1007 port value plus 1.
1008
1009 @item
1010 If @option{localrtpport} (the local RTP port) is not set any available
1011 port will be used for the local RTP and RTCP ports.
1012
1013 @item
1014 If @option{localrtcpport} (the local RTCP port) is not set it will be
1015 set to the local RTP port value plus 1.
1016 @end enumerate
1017
1018 @section rtsp
1019
1020 Real-Time Streaming Protocol.
1021
1022 RTSP is not technically a protocol handler in libavformat, it is a demuxer
1023 and muxer. The demuxer supports both normal RTSP (with data transferred
1024 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
1025 data transferred over RDT).
1026
1027 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
1028 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
1029 @uref{https://github.com/revmischa/rtsp-server, RTSP server}).
1030
1031 The required syntax for a RTSP url is:
1032 @example
1033 rtsp://@var{hostname}[:@var{port}]/@var{path}
1034 @end example
1035
1036 Options can be set on the @command{ffmpeg}/@command{ffplay} command
1037 line, or set in code via @code{AVOption}s or in
1038 @code{avformat_open_input}.
1039
1040 The following options are supported.
1041
1042 @table @option
1043 @item initial_pause
1044 Do not start playing the stream immediately if set to 1. Default value
1045 is 0.
1046
1047 @item rtsp_transport
1048 Set RTSP transport protocols.
1049
1050 It accepts the following values:
1051 @table @samp
1052 @item udp
1053 Use UDP as lower transport protocol.
1054
1055 @item tcp
1056 Use TCP (interleaving within the RTSP control channel) as lower
1057 transport protocol.
1058
1059 @item udp_multicast
1060 Use UDP multicast as lower transport protocol.
1061
1062 @item http
1063 Use HTTP tunneling as lower transport protocol, which is useful for
1064 passing proxies.
1065 @end table
1066
1067 Multiple lower transport protocols may be specified, in that case they are
1068 tried one at a time (if the setup of one fails, the next one is tried).
1069 For the muxer, only the @samp{tcp} and @samp{udp} options are supported.
1070
1071 @item rtsp_flags
1072 Set RTSP flags.
1073
1074 The following values are accepted:
1075 @table @samp
1076 @item filter_src
1077 Accept packets only from negotiated peer address and port.
1078 @item listen
1079 Act as a server, listening for an incoming connection.
1080 @item prefer_tcp
1081 Try TCP for RTP transport first, if TCP is available as RTSP RTP transport.
1082 @end table
1083
1084 Default value is @samp{none}.
1085
1086 @item allowed_media_types
1087 Set media types to accept from the server.
1088
1089 The following flags are accepted:
1090 @table @samp
1091 @item video
1092 @item audio
1093 @item data
1094 @end table
1095
1096 By default it accepts all media types.
1097
1098 @item min_port
1099 Set minimum local UDP port. Default value is 5000.
1100
1101 @item max_port
1102 Set maximum local UDP port. Default value is 65000.
1103
1104 @item timeout
1105 Set maximum timeout (in seconds) to wait for incoming connections.
1106
1107 A value of -1 means infinite (default). This option implies the
1108 @option{rtsp_flags} set to @samp{listen}.
1109
1110 @item reorder_queue_size
1111 Set number of packets to buffer for handling of reordered packets.
1112
1113 @item stimeout
1114 Set socket TCP I/O timeout in microseconds.
1115
1116 @item user-agent
1117 Override User-Agent header. If not specified, it defaults to the
1118 libavformat identifier string.
1119 @end table
1120
1121 When receiving data over UDP, the demuxer tries to reorder received packets
1122 (since they may arrive out of order, or packets may get lost totally). This
1123 can be disabled by setting the maximum demuxing delay to zero (via
1124 the @code{max_delay} field of AVFormatContext).
1125
1126 When watching multi-bitrate Real-RTSP streams with @command{ffplay}, the
1127 streams to display can be chosen with @code{-vst} @var{n} and
1128 @code{-ast} @var{n} for video and audio respectively, and can be switched
1129 on the fly by pressing @code{v} and @code{a}.
1130
1131 @subsection Examples
1132
1133 The following examples all make use of the @command{ffplay} and
1134 @command{ffmpeg} tools.
1135
1136 @itemize
1137 @item
1138 Watch a stream over UDP, with a max reordering delay of 0.5 seconds:
1139 @example
1140 ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
1141 @end example
1142
1143 @item
1144 Watch a stream tunneled over HTTP:
1145 @example
1146 ffplay -rtsp_transport http rtsp://server/video.mp4
1147 @end example
1148
1149 @item
1150 Send a stream in realtime to a RTSP server, for others to watch:
1151 @example
1152 ffmpeg -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
1153 @end example
1154
1155 @item
1156 Receive a stream in realtime:
1157 @example
1158 ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
1159 @end example
1160 @end itemize
1161
1162 @section sap
1163
1164 Session Announcement Protocol (RFC 2974). This is not technically a
1165 protocol handler in libavformat, it is a muxer and demuxer.
1166 It is used for signalling of RTP streams, by announcing the SDP for the
1167 streams regularly on a separate port.
1168
1169 @subsection Muxer
1170
1171 The syntax for a SAP url given to the muxer is:
1172 @example
1173 sap://@var{destination}[:@var{port}][?@var{options}]
1174 @end example
1175
1176 The RTP packets are sent to @var{destination} on port @var{port},
1177 or to port 5004 if no port is specified.
1178 @var{options} is a @code{&}-separated list. The following options
1179 are supported:
1180
1181 @table @option
1182
1183 @item announce_addr=@var{address}
1184 Specify the destination IP address for sending the announcements to.
1185 If omitted, the announcements are sent to the commonly used SAP
1186 announcement multicast address 224.2.127.254 (sap.mcast.net), or
1187 ff0e::2:7ffe if @var{destination} is an IPv6 address.
1188
1189 @item announce_port=@var{port}
1190 Specify the port to send the announcements on, defaults to
1191 9875 if not specified.
1192
1193 @item ttl=@var{ttl}
1194 Specify the time to live value for the announcements and RTP packets,
1195 defaults to 255.
1196
1197 @item same_port=@var{0|1}
1198 If set to 1, send all RTP streams on the same port pair. If zero (the
1199 default), all streams are sent on unique ports, with each stream on a
1200 port 2 numbers higher than the previous.
1201 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
1202 The RTP stack in libavformat for receiving requires all streams to be sent
1203 on unique ports.
1204 @end table
1205
1206 Example command lines follow.
1207
1208 To broadcast a stream on the local subnet, for watching in VLC:
1209
1210 @example
1211 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
1212 @end example
1213
1214 Similarly, for watching in @command{ffplay}:
1215
1216 @example
1217 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255
1218 @end example
1219
1220 And for watching in @command{ffplay}, over IPv6:
1221
1222 @example
1223 ffmpeg -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
1224 @end example
1225
1226 @subsection Demuxer
1227
1228 The syntax for a SAP url given to the demuxer is:
1229 @example
1230 sap://[@var{address}][:@var{port}]
1231 @end example
1232
1233 @var{address} is the multicast address to listen for announcements on,
1234 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
1235 is the port that is listened on, 9875 if omitted.
1236
1237 The demuxers listens for announcements on the given address and port.
1238 Once an announcement is received, it tries to receive that particular stream.
1239
1240 Example command lines follow.
1241
1242 To play back the first stream announced on the normal SAP multicast address:
1243
1244 @example
1245 ffplay sap://
1246 @end example
1247
1248 To play back the first stream announced on one the default IPv6 SAP multicast address:
1249
1250 @example
1251 ffplay sap://[ff0e::2:7ffe]
1252 @end example
1253
1254 @section sctp
1255
1256 Stream Control Transmission Protocol.
1257
1258 The accepted URL syntax is:
1259 @example
1260 sctp://@var{host}:@var{port}[?@var{options}]
1261 @end example
1262
1263 The protocol accepts the following options:
1264 @table @option
1265 @item listen
1266 If set to any value, listen for an incoming connection. Outgoing connection is done by default.
1267
1268 @item max_streams
1269 Set the maximum number of streams. By default no limit is set.
1270 @end table
1271
1272 @section srt
1273
1274 Haivision Secure Reliable Transport Protocol via libsrt.
1275
1276 The supported syntax for a SRT URL is:
1277 @example
1278 srt://@var{hostname}:@var{port}[?@var{options}]
1279 @end example
1280
1281 @var{options} contains a list of &-separated options of the form
1282 @var{key}=@var{val}.
1283
1284 or
1285
1286 @example
1287 @var{options} srt://@var{hostname}:@var{port}
1288 @end example
1289
1290 @var{options} contains a list of '-@var{key} @var{val}'
1291 options.
1292
1293 This protocol accepts the following options.
1294
1295 @table @option
1296 @item connect_timeout=@var{milliseconds}
1297 Connection timeout; SRT cannot connect for RTT > 1500 msec
1298 (2 handshake exchanges) with the default connect timeout of
1299 3 seconds. This option applies to the caller and rendezvous
1300 connection modes. The connect timeout is 10 times the value
1301 set for the rendezvous mode (which can be used as a
1302 workaround for this connection problem with earlier versions).
1303
1304 @item ffs=@var{bytes}
1305 Flight Flag Size (Window Size), in bytes. FFS is actually an
1306 internal parameter and you should set it to not less than
1307 @option{recv_buffer_size} and @option{mss}. The default value
1308 is relatively large, therefore unless you set a very large receiver buffer,
1309 you do not need to change this option. Default value is 25600.
1310
1311 @item inputbw=@var{bytes/seconds}
1312 Sender nominal input rate, in bytes per seconds. Used along with
1313 @option{oheadbw}, when @option{maxbw} is set to relative (0), to
1314 calculate maximum sending rate when recovery packets are sent
1315 along with the main media stream:
1316 @option{inputbw} * (100 + @option{oheadbw}) / 100
1317 if @option{inputbw} is not set while @option{maxbw} is set to
1318 relative (0), the actual input rate is evaluated inside
1319 the library. Default value is 0.
1320
1321 @item iptos=@var{tos}
1322 IP Type of Service. Applies to sender only. Default value is 0xB8.
1323
1324 @item ipttl=@var{ttl}
1325 IP Time To Live. Applies to sender only. Default value is 64.
1326
1327 @item latency=@var{microseconds}
1328 Timestamp-based Packet Delivery Delay.
1329 Used to absorb bursts of missed packet retransmissions.
1330 This flag sets both @option{rcvlatency} and @option{peerlatency}
1331 to the same value. Note that prior to version 1.3.0
1332 this is the only flag to set the latency, however
1333 this is effectively equivalent to setting @option{peerlatency},
1334 when side is sender and @option{rcvlatency}
1335 when side is receiver, and the bidirectional stream
1336 sending is not supported.
1337
1338 @item listen_timeout=@var{microseconds}
1339 Set socket listen timeout.
1340
1341 @item maxbw=@var{bytes/seconds}
1342 Maximum sending bandwidth, in bytes per seconds.
1343 -1 infinite (CSRTCC limit is 30mbps)
1344 0 relative to input rate (see @option{inputbw})
1345 >0 absolute limit value
1346 Default value is 0 (relative)
1347
1348 @item mode=@var{caller|listener|rendezvous}
1349 Connection mode.
1350 @option{caller} opens client connection.
1351 @option{listener} starts server to listen for incoming connections.
1352 @option{rendezvous} use Rendez-Vous connection mode.
1353 Default value is caller.
1354
1355 @item mss=@var{bytes}
1356 Maximum Segment Size, in bytes. Used for buffer allocation
1357 and rate calculation using a packet counter assuming fully
1358 filled packets. The smallest MSS between the peers is
1359 used. This is 1500 by default in the overall internet.
1360 This is the maximum size of the UDP packet and can be
1361 only decreased, unless you have some unusual dedicated
1362 network settings. Default value is 1500.
1363
1364 @item nakreport=@var{1|0}
1365 If set to 1, Receiver will send `UMSG_LOSSREPORT` messages
1366 periodically until a lost packet is retransmitted or
1367 intentionally dropped. Default value is 1.
1368
1369 @item oheadbw=@var{percents}
1370 Recovery bandwidth overhead above input rate, in percents.
1371 See @option{inputbw}. Default value is 25%.
1372
1373 @item passphrase=@var{string}
1374 HaiCrypt Encryption/Decryption Passphrase string, length
1375 from 10 to 79 characters. The passphrase is the shared
1376 secret between the sender and the receiver. It is used
1377 to generate the Key Encrypting Key using PBKDF2
1378 (Password-Based Key Derivation Function). It is used
1379 only if @option{pbkeylen} is non-zero. It is used on
1380 the receiver only if the received data is encrypted.
1381 The configured passphrase cannot be recovered (write-only).
1382
1383 @item enforced_encryption=@var{1|0}
1384 If true, both connection parties must have the same password
1385 set (including empty, that is, with no encryption). If the
1386 password doesn't match or only one side is unencrypted,
1387 the connection is rejected. Default is true.
1388
1389 @item kmrefreshrate=@var{packets}
1390 The number of packets to be transmitted after which the
1391 encryption key is switched to a new key. Default is -1.
1392 -1 means auto (0x1000000 in srt library). The range for
1393 this option is integers in the 0 - @code{INT_MAX}.
1394
1395 @item kmpreannounce=@var{packets}
1396 The interval between when a new encryption key is sent and
1397 when switchover occurs. This value also applies to the
1398 subsequent interval between when switchover occurs and
1399 when the old encryption key is decommissioned. Default is -1.
1400 -1 means auto (0x1000 in srt library). The range for
1401 this option is integers in the 0 - @code{INT_MAX}.
1402
1403 @item payload_size=@var{bytes}
1404 Sets the maximum declared size of a packet transferred
1405 during the single call to the sending function in Live
1406 mode. Use 0 if this value isn't used (which is default in
1407 file mode).
1408 Default is -1 (automatic), which typically means MPEG-TS;
1409 if you are going to use SRT
1410 to send any different kind of payload, such as, for example,
1411 wrapping a live stream in very small frames, then you can
1412 use a bigger maximum frame size, though not greater than
1413 1456 bytes.
1414
1415 @item pkt_size=@var{bytes}
1416 Alias for @samp{payload_size}.
1417
1418 @item peerlatency=@var{microseconds}
1419 The latency value (as described in @option{rcvlatency}) that is
1420 set by the sender side as a minimum value for the receiver.
1421
1422 @item pbkeylen=@var{bytes}
1423 Sender encryption key length, in bytes.
1424 Only can be set to 0, 16, 24 and 32.
1425 Enable sender encryption if not 0.
1426 Not required on receiver (set to 0),
1427 key size obtained from sender in HaiCrypt handshake.
1428 Default value is 0.
1429
1430 @item rcvlatency=@var{microseconds}
1431 The time that should elapse since the moment when the
1432 packet was sent and the moment when it's delivered to
1433 the receiver application in the receiving function.
1434 This time should be a buffer time large enough to cover
1435 the time spent for sending, unexpectedly extended RTT
1436 time, and the time needed to retransmit the lost UDP
1437 packet. The effective latency value will be the maximum
1438 of this options' value and the value of @option{peerlatency}
1439 set by the peer side. Before version 1.3.0 this option
1440 is only available as @option{latency}.
1441
1442 @item recv_buffer_size=@var{bytes}
1443 Set UDP receive buffer size, expressed in bytes.
1444
1445 @item send_buffer_size=@var{bytes}
1446 Set UDP send buffer size, expressed in bytes.
1447
1448 @item timeout=@var{microseconds}
1449 Set raise error timeouts for read, write and connect operations. Note that the
1450 SRT library has internal timeouts which can be controlled separately, the
1451 value set here is only a cap on those.
1452
1453 @item tlpktdrop=@var{1|0}
1454 Too-late Packet Drop. When enabled on receiver, it skips
1455 missing packets that have not been delivered in time and
1456 delivers the following packets to the application when
1457 their time-to-play has come. It also sends a fake ACK to
1458 the sender. When enabled on sender and enabled on the
1459 receiving peer, the sender drops the older packets that
1460 have no chance of being delivered in time. It was
1461 automatically enabled in the sender if the receiver
1462 supports it.
1463
1464 @item sndbuf=@var{bytes}
1465 Set send buffer size, expressed in bytes.
1466
1467 @item rcvbuf=@var{bytes}
1468 Set receive buffer size, expressed in bytes.
1469
1470 Receive buffer must not be greater than @option{ffs}.
1471
1472 @item lossmaxttl=@var{packets}
1473 The value up to which the Reorder Tolerance may grow. When
1474 Reorder Tolerance is > 0, then packet loss report is delayed
1475 until that number of packets come in. Reorder Tolerance
1476 increases every time a "belated" packet has come, but it
1477 wasn't due to retransmission (that is, when UDP packets tend
1478 to come out of order), with the difference between the latest
1479 sequence and this packet's sequence, and not more than the
1480 value of this option. By default it's 0, which means that this
1481 mechanism is turned off, and the loss report is always sent
1482 immediately upon experiencing a "gap" in sequences.
1483
1484 @item minversion
1485 The minimum SRT version that is required from the peer. A connection
1486 to a peer that does not satisfy the minimum version requirement
1487 will be rejected.
1488
1489 The version format in hex is 0xXXYYZZ for x.y.z in human readable
1490 form.
1491
1492 @item streamid=@var{string}
1493 A string limited to 512 characters that can be set on the socket prior
1494 to connecting. This stream ID will be able to be retrieved by the
1495 listener side from the socket that is returned from srt_accept and
1496 was connected by a socket with that set stream ID. SRT does not enforce
1497 any special interpretation of the contents of this string.
1498 This option doesn’t make sense in Rendezvous connection; the result
1499 might be that simply one side will override the value from the other
1500 side and it’s the matter of luck which one would win
1501
1502 @item smoother=@var{live|file}
1503 The type of Smoother used for the transmission for that socket, which
1504 is responsible for the transmission and congestion control. The Smoother
1505 type must be exactly the same on both connecting parties, otherwise
1506 the connection is rejected.
1507
1508 @item messageapi=@var{1|0}
1509 When set, this socket uses the Message API, otherwise it uses Buffer
1510 API. Note that in live mode (see @option{transtype}) there’s only
1511 message API available. In File mode you can chose to use one of two modes:
1512
1513 Stream API (default, when this option is false). In this mode you may
1514 send as many data as you wish with one sending instruction, or even use
1515 dedicated functions that read directly from a file. The internal facility
1516 will take care of any speed and congestion control. When receiving, you
1517 can also receive as many data as desired, the data not extracted will be
1518 waiting for the next call. There is no boundary between data portions in
1519 the Stream mode.
1520
1521 Message API. In this mode your single sending instruction passes exactly
1522 one piece of data that has boundaries (a message). Contrary to Live mode,
1523 this message may span across multiple UDP packets and the only size
1524 limitation is that it shall fit as a whole in the sending buffer. The
1525 receiver shall use as large buffer as necessary to receive the message,
1526 otherwise the message will not be given up. When the message is not
1527 complete (not all packets received or there was a packet loss) it will
1528 not be given up.
1529
1530 @item transtype=@var{live|file}
1531 Sets the transmission type for the socket, in particular, setting this
1532 option sets multiple other parameters to their default values as required
1533 for a particular transmission type.
1534
1535 live: Set options as for live transmission. In this mode, you should
1536 send by one sending instruction only so many data that fit in one UDP packet,
1537 and limited to the value defined first in @option{payload_size} (1316 is
1538 default in this mode). There is no speed control in this mode, only the
1539 bandwidth control, if configured, in order to not exceed the bandwidth with
1540 the overhead transmission (retransmitted and control packets).
1541
1542 file: Set options as for non-live transmission. See @option{messageapi}
1543 for further explanations
1544
1545 @item linger=@var{seconds}
1546 The number of seconds that the socket waits for unsent data when closing.
1547 Default is -1. -1 means auto (off with 0 seconds in live mode, on with 180
1548 seconds in file mode). The range for this option is integers in the
1549 0 - @code{INT_MAX}.
1550
1551 @end table
1552
1553 For more information see: @url{https://github.com/Haivision/srt}.
1554
1555 @section srtp
1556
1557 Secure Real-time Transport Protocol.
1558
1559 The accepted options are:
1560 @table @option
1561 @item srtp_in_suite
1562 @item srtp_out_suite
1563 Select input and output encoding suites.
1564
1565 Supported values:
1566 @table @samp
1567 @item AES_CM_128_HMAC_SHA1_80
1568 @item SRTP_AES128_CM_HMAC_SHA1_80
1569 @item AES_CM_128_HMAC_SHA1_32
1570 @item SRTP_AES128_CM_HMAC_SHA1_32
1571 @end table
1572
1573 @item srtp_in_params
1574 @item srtp_out_params
1575 Set input and output encoding parameters, which are expressed by a
1576 base64-encoded representation of a binary block. The first 16 bytes of
1577 this binary block are used as master key, the following 14 bytes are
1578 used as master salt.
1579 @end table
1580
1581 @section subfile
1582
1583 Virtually extract a segment of a file or another stream.
1584 The underlying stream must be seekable.
1585
1586 Accepted options:
1587 @table @option
1588 @item start
1589 Start offset of the extracted segment, in bytes.
1590 @item end
1591 End offset of the extracted segment, in bytes.
1592 If set to 0, extract till end of file.
1593 @end table
1594
1595 Examples:
1596
1597 Extract a chapter from a DVD VOB file (start and end sectors obtained
1598 externally and multiplied by 2048):
1599 @example
1600 subfile,,start,153391104,end,268142592,,:/media/dvd/VIDEO_TS/VTS_08_1.VOB
1601 @end example
1602
1603 Play an AVI file directly from a TAR archive:
1604 @example
1605 subfile,,start,183241728,end,366490624,,:archive.tar
1606 @end example
1607
1608 Play a MPEG-TS file from start offset till end:
1609 @example
1610 subfile,,start,32815239,end,0,,:video.ts
1611 @end example
1612
1613 @section tee
1614
1615 Writes the output to multiple protocols. The individual outputs are separated
1616 by |
1617
1618 @example
1619 tee:file://path/to/local/this.avi|file://path/to/local/that.avi
1620 @end example
1621
1622 @section tcp
1623
1624 Transmission Control Protocol.
1625
1626 The required syntax for a TCP url is:
1627 @example
1628 tcp://@var{hostname}:@var{port}[?@var{options}]
1629 @end example
1630
1631 @var{options} contains a list of &-separated options of the form
1632 @var{key}=@var{val}.
1633
1634 The list of supported options follows.
1635
1636 @table @option
1637 @item listen=@var{1|0}
1638 Listen for an incoming connection. Default value is 0.
1639
1640 @item timeout=@var{microseconds}
1641 Set raise error timeout, expressed in microseconds.
1642
1643 This option is only relevant in read mode: if no data arrived in more
1644 than this time interval, raise error.
1645
1646 @item listen_timeout=@var{milliseconds}
1647 Set listen timeout, expressed in milliseconds.
1648
1649 @item recv_buffer_size=@var{bytes}
1650 Set receive buffer size, expressed bytes.
1651
1652 @item send_buffer_size=@var{bytes}
1653 Set send buffer size, expressed bytes.
1654
1655 @item tcp_nodelay=@var{1|0}
1656 Set TCP_NODELAY to disable Nagle's algorithm. Default value is 0.
1657
1658 @item tcp_mss=@var{bytes}
1659 Set maximum segment size for outgoing TCP packets, expressed in bytes.
1660 @end table
1661
1662 The following example shows how to setup a listening TCP connection
1663 with @command{ffmpeg}, which is then accessed with @command{ffplay}:
1664 @example
1665 ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
1666 ffplay tcp://@var{hostname}:@var{port}
1667 @end example
1668
1669 @section tls
1670
1671 Transport Layer Security (TLS) / Secure Sockets Layer (SSL)
1672
1673 The required syntax for a TLS/SSL url is:
1674 @example
1675 tls://@var{hostname}:@var{port}[?@var{options}]
1676 @end example
1677
1678 The following parameters can be set via command line options
1679 (or in code via @code{AVOption}s):
1680
1681 @table @option
1682
1683 @item ca_file, cafile=@var{filename}
1684 A file containing certificate authority (CA) root certificates to treat
1685 as trusted. If the linked TLS library contains a default this might not
1686 need to be specified for verification to work, but not all libraries and
1687 setups have defaults built in.
1688 The file must be in OpenSSL PEM format.
1689
1690 @item tls_verify=@var{1|0}
1691 If enabled, try to verify the peer that we are communicating with.
1692 Note, if using OpenSSL, this currently only makes sure that the
1693 peer certificate is signed by one of the root certificates in the CA
1694 database, but it does not validate that the certificate actually
1695 matches the host name we are trying to connect to. (With other backends,
1696 the host name is validated as well.)
1697
1698 This is disabled by default since it requires a CA database to be
1699 provided by the caller in many cases.
1700
1701 @item cert_file, cert=@var{filename}
1702 A file containing a certificate to use in the handshake with the peer.
1703 (When operating as server, in listen mode, this is more often required
1704 by the peer, while client certificates only are mandated in certain
1705 setups.)
1706
1707 @item key_file, key=@var{filename}
1708 A file containing the private key for the certificate.
1709
1710 @item listen=@var{1|0}
1711 If enabled, listen for connections on the provided port, and assume
1712 the server role in the handshake instead of the client role.
1713
1714 @end table
1715
1716 Example command lines:
1717
1718 To create a TLS/SSL server that serves an input stream.
1719
1720 @example
1721 ffmpeg -i @var{input} -f @var{format} tls://@var{hostname}:@var{port}?listen&cert=@var{server.crt}&key=@var{server.key}
1722 @end example
1723
1724 To play back a stream from the TLS/SSL server using @command{ffplay}:
1725
1726 @example
1727 ffplay tls://@var{hostname}:@var{port}
1728 @end example
1729
1730 @section udp
1731
1732 User Datagram Protocol.
1733
1734 The required syntax for an UDP URL is:
1735 @example
1736 udp://@var{hostname}:@var{port}[?@var{options}]
1737 @end example
1738
1739 @var{options} contains a list of &-separated options of the form @var{key}=@var{val}.
1740
1741 In case threading is enabled on the system, a circular buffer is used
1742 to store the incoming data, which allows one to reduce loss of data due to
1743 UDP socket buffer overruns. The @var{fifo_size} and
1744 @var{overrun_nonfatal} options are related to this buffer.
1745
1746 The list of supported options follows.
1747
1748 @table @option
1749 @item buffer_size=@var{size}
1750 Set the UDP maximum socket buffer size in bytes. This is used to set either
1751 the receive or send buffer size, depending on what the socket is used for.
1752 Default is 32 KB for output, 384 KB for input.  See also @var{fifo_size}.
1753
1754 @item bitrate=@var{bitrate}
1755 If set to nonzero, the output will have the specified constant bitrate if the
1756 input has enough packets to sustain it.
1757
1758 @item burst_bits=@var{bits}
1759 When using @var{bitrate} this specifies the maximum number of bits in
1760 packet bursts.
1761
1762 @item localport=@var{port}
1763 Override the local UDP port to bind with.
1764
1765 @item localaddr=@var{addr}
1766 Local IP address of a network interface used for sending packets or joining
1767 multicast groups.
1768
1769 @item pkt_size=@var{size}
1770 Set the size in bytes of UDP packets.
1771
1772 @item reuse=@var{1|0}
1773 Explicitly allow or disallow reusing UDP sockets.
1774
1775 @item ttl=@var{ttl}
1776 Set the time to live value (for multicast only).
1777
1778 @item connect=@var{1|0}
1779 Initialize the UDP socket with @code{connect()}. In this case, the
1780 destination address can't be changed with ff_udp_set_remote_url later.
1781 If the destination address isn't known at the start, this option can
1782 be specified in ff_udp_set_remote_url, too.
1783 This allows finding out the source address for the packets with getsockname,
1784 and makes writes return with AVERROR(ECONNREFUSED) if "destination
1785 unreachable" is received.
1786 For receiving, this gives the benefit of only receiving packets from
1787 the specified peer address/port.
1788
1789 @item sources=@var{address}[,@var{address}]
1790 Only receive packets sent from the specified addresses. In case of multicast,
1791 also subscribe to multicast traffic coming from these addresses only.
1792
1793 @item block=@var{address}[,@var{address}]
1794 Ignore packets sent from the specified addresses. In case of multicast, also
1795 exclude the source addresses in the multicast subscription.
1796
1797 @item fifo_size=@var{units}
1798 Set the UDP receiving circular buffer size, expressed as a number of
1799 packets with size of 188 bytes. If not specified defaults to 7*4096.
1800
1801 @item overrun_nonfatal=@var{1|0}
1802 Survive in case of UDP receiving circular buffer overrun. Default
1803 value is 0.
1804
1805 @item timeout=@var{microseconds}
1806 Set raise error timeout, expressed in microseconds.
1807
1808 This option is only relevant in read mode: if no data arrived in more
1809 than this time interval, raise error.
1810
1811 @item broadcast=@var{1|0}
1812 Explicitly allow or disallow UDP broadcasting.
1813
1814 Note that broadcasting may not work properly on networks having
1815 a broadcast storm protection.
1816 @end table
1817
1818 @subsection Examples
1819
1820 @itemize
1821 @item
1822 Use @command{ffmpeg} to stream over UDP to a remote endpoint:
1823 @example
1824 ffmpeg -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
1825 @end example
1826
1827 @item
1828 Use @command{ffmpeg} to stream in mpegts format over UDP using 188
1829 sized UDP packets, using a large input buffer:
1830 @example
1831 ffmpeg -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
1832 @end example
1833
1834 @item
1835 Use @command{ffmpeg} to receive over UDP from a remote endpoint:
1836 @example
1837 ffmpeg -i udp://[@var{multicast-address}]:@var{port} ...
1838 @end example
1839 @end itemize
1840
1841 @section unix
1842
1843 Unix local socket
1844
1845 The required syntax for a Unix socket URL is:
1846
1847 @example
1848 unix://@var{filepath}
1849 @end example
1850
1851 The following parameters can be set via command line options
1852 (or in code via @code{AVOption}s):
1853
1854 @table @option
1855 @item timeout
1856 Timeout in ms.
1857 @item listen
1858 Create the Unix socket in listening mode.
1859 @end table
1860
1861 @section zmq
1862
1863 ZeroMQ asynchronous messaging using the libzmq library.
1864
1865 This library supports unicast streaming to multiple clients without relying on
1866 an external server.
1867
1868 The required syntax for streaming or connecting to a stream is:
1869 @example
1870 zmq:tcp://ip-address:port
1871 @end example
1872
1873 Example:
1874 Create a localhost stream on port 5555:
1875 @example
1876 ffmpeg -re -i input -f mpegts zmq:tcp://127.0.0.1:5555
1877 @end example
1878
1879 Multiple clients may connect to the stream using:
1880 @example
1881 ffplay zmq:tcp://127.0.0.1:5555
1882 @end example
1883
1884 Streaming to multiple clients is implemented using a ZeroMQ Pub-Sub pattern.
1885 The server side binds to a port and publishes data. Clients connect to the
1886 server (via IP address/port) and subscribe to the stream. The order in which
1887 the server and client start generally does not matter.
1888
1889 ffmpeg must be compiled with the --enable-libzmq option to support
1890 this protocol.
1891
1892 Options can be set on the @command{ffmpeg}/@command{ffplay} command
1893 line. The following options are supported:
1894
1895 @table @option
1896
1897 @item pkt_size
1898 Forces the maximum packet size for sending/receiving data. The default value is
1899 131,072 bytes. On the server side, this sets the maximum size of sent packets
1900 via ZeroMQ. On the clients, it sets an internal buffer size for receiving
1901 packets. Note that pkt_size on the clients should be equal to or greater than
1902 pkt_size on the server. Otherwise the received message may be truncated causing
1903 decoding errors.
1904
1905 @end table
1906
1907
1908 @c man end PROTOCOLS