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