avformat/http: add reconnect_delay_max option
[ffmpeg.git] / doc / protocols.texi
1 @chapter Protocols
2 @c man begin PROTOCOLS
3
4 Protocols are configured elements in FFmpeg that enable access to
5 resources that require specific protocols.
6
7 When you configure your FFmpeg build, all the supported protocols are
8 enabled by default. You can list all available ones using the
9 configure option "--list-protocols".
10
11 You can disable all the protocols using the configure option
12 "--disable-protocols", and selectively enable a protocol using the
13 option "--enable-protocol=@var{PROTOCOL}", or you can disable a
14 particular protocol using the option
15 "--disable-protocol=@var{PROTOCOL}".
16
17 The option "-protocols" of the ff* tools will display the list of
18 supported protocols.
19
20 A description of the currently available protocols follows.
21
22 @section async
23
24 Asynchronous data filling wrapper for input stream.
25
26 Fill data in a background thread, to decouple I/O operation from demux thread.
27
28 @example
29 async:@var{URL}
30 async:http://host/resource
31 async:cache:http://host/resource
32 @end example
33
34 @section bluray
35
36 Read BluRay playlist.
37
38 The accepted options are:
39 @table @option
40
41 @item angle
42 BluRay angle
43
44 @item chapter
45 Start chapter (1...N)
46
47 @item playlist
48 Playlist to read (BDMV/PLAYLIST/?????.mpls)
49
50 @end table
51
52 Examples:
53
54 Read longest playlist from BluRay mounted to /mnt/bluray:
55 @example
56 bluray:/mnt/bluray
57 @end example
58
59 Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2:
60 @example
61 -playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray
62 @end example
63
64 @section cache
65
66 Caching wrapper for input stream.
67
68 Cache the input stream to temporary file. It brings seeking capability to live streams.
69
70 @example
71 cache:@var{URL}
72 @end example
73
74 @section concat
75
76 Physical concatenation protocol.
77
78 Read and seek from many resources in sequence as if they were
79 a unique resource.
80
81 A URL accepted by this protocol has the syntax:
82 @example
83 concat:@var{URL1}|@var{URL2}|...|@var{URLN}
84 @end example
85
86 where @var{URL1}, @var{URL2}, ..., @var{URLN} are the urls of the
87 resource to be concatenated, each one possibly specifying a distinct
88 protocol.
89
90 For example to read a sequence of files @file{split1.mpeg},
91 @file{split2.mpeg}, @file{split3.mpeg} with @command{ffplay} use the
92 command:
93 @example
94 ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
95 @end example
96
97 Note that you may need to escape the character "|" which is special for
98 many shells.
99
100 @section crypto
101
102 AES-encrypted stream reading protocol.
103
104 The accepted options are:
105 @table @option
106 @item key
107 Set the AES decryption key binary block from given hexadecimal representation.
108
109 @item iv
110 Set the AES decryption initialization vector binary block from given hexadecimal representation.
111 @end table
112
113 Accepted URL formats:
114 @example
115 crypto:@var{URL}
116 crypto+@var{URL}
117 @end example
118
119 @section data
120
121 Data in-line in the URI. See @url{http://en.wikipedia.org/wiki/Data_URI_scheme}.
122
123 For example, to convert a GIF file given inline with @command{ffmpeg}:
124 @example
125 ffmpeg -i "data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=" smiley.png
126 @end example
127
128 @section file
129
130 File access protocol.
131
132 Read from or write to a file.
133
134 A file URL can have the form:
135 @example
136 file:@var{filename}
137 @end example
138
139 where @var{filename} is the path of the file to read.
140
141 An URL that does not have a protocol prefix will be assumed to be a
142 file URL. Depending on the build, an URL that looks like a Windows
143 path with the drive letter at the beginning will also be assumed to be
144 a file URL (usually not the case in builds for unix-like systems).
145
146 For example to read from a file @file{input.mpeg} with @command{ffmpeg}
147 use the command:
148 @example
149 ffmpeg -i file:input.mpeg output.mpeg
150 @end example
151
152 This protocol accepts the following options:
153
154 @table @option
155 @item truncate
156 Truncate existing files on write, if set to 1. A value of 0 prevents
157 truncating. Default value is 1.
158
159 @item blocksize
160 Set I/O operation maximum block size, in bytes. Default value is
161 @code{INT_MAX}, which results in not limiting the requested block size.
162 Setting this value reasonably low improves user termination request reaction
163 time, which is valuable for files on slow medium.
164 @end table
165
166 @section ftp
167
168 FTP (File Transfer Protocol).
169
170 Read from or write to remote resources using FTP protocol.
171
172 Following syntax is required.
173 @example
174 ftp://[user[:password]@@]server[:port]/path/to/remote/resource.mpeg
175 @end example
176
177 This protocol accepts the following options.
178
179 @table @option
180 @item timeout
181 Set timeout in microseconds of socket I/O operations used by the underlying low level
182 operation. By default it is set to -1, which means that the timeout is
183 not specified.
184
185 @item ftp-anonymous-password
186 Password used when login as anonymous user. Typically an e-mail address
187 should be used.
188
189 @item ftp-write-seekable
190 Control seekability of connection during encoding. If set to 1 the
191 resource is supposed to be seekable, if set to 0 it is assumed not
192 to be seekable. Default value is 0.
193 @end table
194
195 NOTE: Protocol can be used as output, but it is recommended to not do
196 it, unless special care is taken (tests, customized server configuration
197 etc.). Different FTP servers behave in different way during seek
198 operation. ff* tools may produce incomplete content due to server limitations.
199
200 @section gopher
201
202 Gopher protocol.
203
204 @section hls
205
206 Read Apple HTTP Live Streaming compliant segmented stream as
207 a uniform one. The M3U8 playlists describing the segments can be
208 remote HTTP resources or local files, accessed using the standard
209 file protocol.
210 The nested protocol is declared by specifying
211 "+@var{proto}" after the hls URI scheme name, where @var{proto}
212 is either "file" or "http".
213
214 @example
215 hls+http://host/path/to/remote/resource.m3u8
216 hls+file://path/to/local/resource.m3u8
217 @end example
218
219 Using this protocol is discouraged - the hls demuxer should work
220 just as well (if not, please report the issues) and is more complete.
221 To use the hls demuxer instead, simply use the direct URLs to the
222 m3u8 files.
223
224 @section http
225
226 HTTP (Hyper Text Transfer Protocol).
227
228 This protocol accepts the following options:
229
230 @table @option
231 @item seekable
232 Control seekability of connection. If set to 1 the resource is
233 supposed to be seekable, if set to 0 it is assumed not to be seekable,
234 if set to -1 it will try to autodetect if it is seekable. Default
235 value is -1.
236
237 @item chunked_post
238 If set to 1 use chunked Transfer-Encoding for posts, default is 1.
239
240 @item content_type
241 Set a specific content type for the POST messages.
242
243 @item headers
244 Set custom HTTP headers, can override built in default headers. The
245 value must be a string encoding the headers.
246
247 @item multiple_requests
248 Use persistent connections if set to 1, default is 0.
249
250 @item post_data
251 Set custom HTTP post data.
252
253 @item user-agent
254 @item user_agent
255 Override the User-Agent header. If not specified the protocol will use a
256 string describing the libavformat build. ("Lavf/<version>")
257
258 @item timeout
259 Set timeout in microseconds of socket I/O operations used by the underlying low level
260 operation. By default it is set to -1, which means that the timeout is
261 not specified.
262
263 @item reconnect_at_eof
264 If set then eof is treated like an error and causes reconnection, this is useful
265 for live / endless streams.
266
267 @item reconnect_streamed
268 If set then even streamed/non seekable streams will be reconnected on errors.
269
270 @item reconnect_delay_max
271 Sets the maximum delay in seconds after which to give up reconnecting
272
273 @item mime_type
274 Export the MIME type.
275
276 @item icy
277 If set to 1 request ICY (SHOUTcast) metadata from the server. If the server
278 supports this, the metadata has to be retrieved by the application by reading
279 the @option{icy_metadata_headers} and @option{icy_metadata_packet} options.
280 The default is 1.
281
282 @item icy_metadata_headers
283 If the server supports ICY metadata, this contains the ICY-specific HTTP reply
284 headers, separated by newline characters.
285
286 @item icy_metadata_packet
287 If the server supports ICY metadata, and @option{icy} was set to 1, this
288 contains the last non-empty metadata packet sent by the server. It should be
289 polled in regular intervals by applications interested in mid-stream metadata
290 updates.
291
292 @item cookies
293 Set the cookies to be sent in future requests. The format of each cookie is the
294 same as the value of a Set-Cookie HTTP response field. Multiple cookies can be
295 delimited by a newline character.
296
297 @item offset
298 Set initial byte offset.
299
300 @item end_offset
301 Try to limit the request to bytes preceding this offset.
302
303 @item method
304 When used as a client option it sets the HTTP method for the request.
305
306 When used as a server option it sets the HTTP method that is going to be
307 expected from the client(s).
308 If the expected and the received HTTP method do not match the client will
309 be given a Bad Request response.
310 When unset the HTTP method is not checked for now. This will be replaced by
311 autodetection in the future.
312
313 @item listen
314 If set to 1 enables experimental HTTP server. This can be used to send data when
315 used as an output option, or read data from a client with HTTP POST when used as
316 an input option.
317 If set to 2 enables experimental mutli-client HTTP server. This is not yet implemented
318 in ffmpeg.c or ffserver.c and thus must not be used as a command line option.
319 @example
320 # Server side (sending):
321 ffmpeg -i somefile.ogg -c copy -listen 1 -f ogg http://@var{server}:@var{port}
322
323 # Client side (receiving):
324 ffmpeg -i http://@var{server}:@var{port} -c copy somefile.ogg
325
326 # Client can also be done with wget:
327 wget http://@var{server}:@var{port} -O somefile.ogg
328
329 # Server side (receiving):
330 ffmpeg -listen 1 -i http://@var{server}:@var{port} -c copy somefile.ogg
331
332 # Client side (sending):
333 ffmpeg -i somefile.ogg -chunked_post 0 -c copy -f ogg http://@var{server}:@var{port}
334
335 # Client can also be done with wget:
336 wget --post-file=somefile.ogg http://@var{server}:@var{port}
337 @end example
338
339 @end table
340
341 @subsection HTTP Cookies
342
343 Some HTTP requests will be denied unless cookie values are passed in with the
344 request. The @option{cookies} option allows these cookies to be specified. At
345 the very least, each cookie must specify a value along with a path and domain.
346 HTTP requests that match both the domain and path will automatically include the
347 cookie value in the HTTP Cookie header field. Multiple cookies can be delimited
348 by a newline.
349
350 The required syntax to play a stream specifying a cookie is:
351 @example
352 ffplay -cookies "nlqptid=nltid=tsn; path=/; domain=somedomain.com;" http://somedomain.com/somestream.m3u8
353 @end example
354
355 @section Icecast
356
357 Icecast protocol (stream to Icecast servers)
358
359 This protocol accepts the following options:
360
361 @table @option
362 @item ice_genre
363 Set the stream genre.
364
365 @item ice_name
366 Set the stream name.
367
368 @item ice_description
369 Set the stream description.
370
371 @item ice_url
372 Set the stream website URL.
373
374 @item ice_public
375 Set if the stream should be public.
376 The default is 0 (not public).
377
378 @item user_agent
379 Override the User-Agent header. If not specified a string of the form
380 "Lavf/<version>" will be used.
381
382 @item password
383 Set the Icecast mountpoint password.
384
385 @item content_type
386 Set the stream content type. This must be set if it is different from
387 audio/mpeg.
388
389 @item legacy_icecast
390 This enables support for Icecast versions < 2.4.0, that do not support the
391 HTTP PUT method but the SOURCE method.
392
393 @end table
394
395 @example
396 icecast://[@var{username}[:@var{password}]@@]@var{server}:@var{port}/@var{mountpoint}
397 @end example
398
399 @section mmst
400
401 MMS (Microsoft Media Server) protocol over TCP.
402
403 @section mmsh
404
405 MMS (Microsoft Media Server) protocol over HTTP.
406
407 The required syntax is:
408 @example
409 mmsh://@var{server}[:@var{port}][/@var{app}][/@var{playpath}]
410 @end example
411
412 @section md5
413
414 MD5 output protocol.
415
416 Computes the MD5 hash of the data to be written, and on close writes
417 this to the designated output or stdout if none is specified. It can
418 be used to test muxers without writing an actual file.
419
420 Some examples follow.
421 @example
422 # Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
423 ffmpeg -i input.flv -f avi -y md5:output.avi.md5
424
425 # Write the MD5 hash of the encoded AVI file to stdout.
426 ffmpeg -i input.flv -f avi -y md5:
427 @end example
428
429 Note that some formats (typically MOV) require the output protocol to
430 be seekable, so they will fail with the MD5 output protocol.
431
432 @section pipe
433
434 UNIX pipe access protocol.
435
436 Read and write from UNIX pipes.
437
438 The accepted syntax is:
439 @example
440 pipe:[@var{number}]
441 @end example
442
443 @var{number} is the number corresponding to the file descriptor of the
444 pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).  If @var{number}
445 is not specified, by default the stdout file descriptor will be used
446 for writing, stdin for reading.
447
448 For example to read from stdin with @command{ffmpeg}:
449 @example
450 cat test.wav | ffmpeg -i pipe:0
451 # ...this is the same as...
452 cat test.wav | ffmpeg -i pipe:
453 @end example
454
455 For writing to stdout with @command{ffmpeg}:
456 @example
457 ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
458 # ...this is the same as...
459 ffmpeg -i test.wav -f avi pipe: | cat > test.avi
460 @end example
461
462 This protocol accepts the following options:
463
464 @table @option
465 @item blocksize
466 Set I/O operation maximum block size, in bytes. Default value is
467 @code{INT_MAX}, which results in not limiting the requested block size.
468 Setting this value reasonably low improves user termination request reaction
469 time, which is valuable if data transmission is slow.
470 @end table
471
472 Note that some formats (typically MOV), require the output protocol to
473 be seekable, so they will fail with the pipe output protocol.
474
475 @section rtmp
476
477 Real-Time Messaging Protocol.
478
479 The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
480 content across a TCP/IP network.
481
482 The required syntax is:
483 @example
484 rtmp://[@var{username}:@var{password}@@]@var{server}[:@var{port}][/@var{app}][/@var{instance}][/@var{playpath}]
485 @end example
486
487 The accepted parameters are:
488 @table @option
489
490 @item username
491 An optional username (mostly for publishing).
492
493 @item password
494 An optional password (mostly for publishing).
495
496 @item server
497 The address of the RTMP server.
498
499 @item port
500 The number of the TCP port to use (by default is 1935).
501
502 @item app
503 It is the name of the application to access. It usually corresponds to
504 the path where the application is installed on the RTMP server
505 (e.g. @file{/ondemand/}, @file{/flash/live/}, etc.). You can override
506 the value parsed from the URI through the @code{rtmp_app} option, too.
507
508 @item playpath
509 It is the path or name of the resource to play with reference to the
510 application specified in @var{app}, may be prefixed by "mp4:". You
511 can override the value parsed from the URI through the @code{rtmp_playpath}
512 option, too.
513
514 @item listen
515 Act as a server, listening for an incoming connection.
516
517 @item timeout
518 Maximum time to wait for the incoming connection. Implies listen.
519 @end table
520
521 Additionally, the following parameters can be set via command line options
522 (or in code via @code{AVOption}s):
523 @table @option
524
525 @item rtmp_app
526 Name of application to connect on the RTMP server. This option
527 overrides the parameter specified in the URI.
528
529 @item rtmp_buffer
530 Set the client buffer time in milliseconds. The default is 3000.
531
532 @item rtmp_conn
533 Extra arbitrary AMF connection parameters, parsed from a string,
534 e.g. like @code{B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0}.
535 Each value is prefixed by a single character denoting the type,
536 B for Boolean, N for number, S for string, O for object, or Z for null,
537 followed by a colon. For Booleans the data must be either 0 or 1 for
538 FALSE or TRUE, respectively.  Likewise for Objects the data must be 0 or
539 1 to end or begin an object, respectively. Data items in subobjects may
540 be named, by prefixing the type with 'N' and specifying the name before
541 the value (i.e. @code{NB:myFlag:1}). This option may be used multiple
542 times to construct arbitrary AMF sequences.
543
544 @item rtmp_flashver
545 Version of the Flash plugin used to run the SWF player. The default
546 is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible;
547 <libavformat version>).)
548
549 @item rtmp_flush_interval
550 Number of packets flushed in the same request (RTMPT only). The default
551 is 10.
552
553 @item rtmp_live
554 Specify that the media is a live stream. No resuming or seeking in
555 live streams is possible. The default value is @code{any}, which means the
556 subscriber first tries to play the live stream specified in the
557 playpath. If a live stream of that name is not found, it plays the
558 recorded stream. The other possible values are @code{live} and
559 @code{recorded}.
560
561 @item rtmp_pageurl
562 URL of the web page in which the media was embedded. By default no
563 value will be sent.
564
565 @item rtmp_playpath
566 Stream identifier to play or to publish. This option overrides the
567 parameter specified in the URI.
568
569 @item rtmp_subscribe
570 Name of live stream to subscribe to. By default no value will be sent.
571 It is only sent if the option is specified or if rtmp_live
572 is set to live.
573
574 @item rtmp_swfhash
575 SHA256 hash of the decompressed SWF file (32 bytes).
576
577 @item rtmp_swfsize
578 Size of the decompressed SWF file, required for SWFVerification.
579
580 @item rtmp_swfurl
581 URL of the SWF player for the media. By default no value will be sent.
582
583 @item rtmp_swfverify
584 URL to player swf file, compute hash/size automatically.
585
586 @item rtmp_tcurl
587 URL of the target stream. Defaults to proto://host[:port]/app.
588
589 @end table
590
591 For example to read with @command{ffplay} a multimedia resource named
592 "sample" from the application "vod" from an RTMP server "myserver":
593 @example
594 ffplay rtmp://myserver/vod/sample
595 @end example
596
597 To publish to a password protected server, passing the playpath and
598 app names separately:
599 @example
600 ffmpeg -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@@myserver/
601 @end example
602
603 @section rtmpe
604
605 Encrypted Real-Time Messaging Protocol.
606
607 The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
608 streaming multimedia content within standard cryptographic primitives,
609 consisting of Diffie-Hellman key exchange and HMACSHA256, generating
610 a pair of RC4 keys.
611
612 @section rtmps
613
614 Real-Time Messaging Protocol over a secure SSL connection.
615
616 The Real-Time Messaging Protocol (RTMPS) is used for streaming
617 multimedia content across an encrypted connection.
618
619 @section rtmpt
620
621 Real-Time Messaging Protocol tunneled through HTTP.
622
623 The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
624 for streaming multimedia content within HTTP requests to traverse
625 firewalls.
626
627 @section rtmpte
628
629 Encrypted Real-Time Messaging Protocol tunneled through HTTP.
630
631 The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
632 is used for streaming multimedia content within HTTP requests to traverse
633 firewalls.
634
635 @section rtmpts
636
637 Real-Time Messaging Protocol tunneled through HTTPS.
638
639 The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
640 for streaming multimedia content within HTTPS requests to traverse
641 firewalls.
642
643 @section libsmbclient
644
645 libsmbclient permits one to manipulate CIFS/SMB network resources.
646
647 Following syntax is required.
648
649 @example
650 smb://[[domain:]user[:password@@]]server[/share[/path[/file]]]
651 @end example
652
653 This protocol accepts the following options.
654
655 @table @option
656 @item timeout
657 Set timeout in miliseconds of socket I/O operations used by the underlying
658 low level operation. By default it is set to -1, which means that the timeout
659 is not specified.
660
661 @item truncate
662 Truncate existing files on write, if set to 1. A value of 0 prevents
663 truncating. Default value is 1.
664
665 @item workgroup
666 Set the workgroup used for making connections. By default workgroup is not specified.
667
668 @end table
669
670 For more information see: @url{http://www.samba.org/}.
671
672 @section libssh
673
674 Secure File Transfer Protocol via libssh
675
676 Read from or write to remote resources using SFTP protocol.
677
678 Following syntax is required.
679
680 @example
681 sftp://[user[:password]@@]server[:port]/path/to/remote/resource.mpeg
682 @end example
683
684 This protocol accepts the following options.
685
686 @table @option
687 @item timeout
688 Set timeout of socket I/O operations used by the underlying low level
689 operation. By default it is set to -1, which means that the timeout
690 is not specified.
691
692 @item truncate
693 Truncate existing files on write, if set to 1. A value of 0 prevents
694 truncating. Default value is 1.
695
696 @item private_key
697 Specify the path of the file containing private key to use during authorization.
698 By default libssh searches for keys in the @file{~/.ssh/} directory.
699
700 @end table
701
702 Example: Play a file stored on remote server.
703
704 @example
705 ffplay sftp://user:password@@server_address:22/home/user/resource.mpeg
706 @end example
707
708 @section librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte
709
710 Real-Time Messaging Protocol and its variants supported through
711 librtmp.
712
713 Requires the presence of the librtmp headers and library during
714 configuration. You need to explicitly configure the build with
715 "--enable-librtmp". If enabled this will replace the native RTMP
716 protocol.
717
718 This protocol provides most client functions and a few server
719 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
720 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
721 variants of these encrypted types (RTMPTE, RTMPTS).
722
723 The required syntax is:
724 @example
725 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
726 @end example
727
728 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
729 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
730 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
731 meaning as specified for the RTMP native protocol.
732 @var{options} contains a list of space-separated options of the form
733 @var{key}=@var{val}.
734
735 See the librtmp manual page (man 3 librtmp) for more information.
736
737 For example, to stream a file in real-time to an RTMP server using
738 @command{ffmpeg}:
739 @example
740 ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
741 @end example
742
743 To play the same stream using @command{ffplay}:
744 @example
745 ffplay "rtmp://myserver/live/mystream live=1"
746 @end example
747
748 @section rtp
749
750 Real-time Transport Protocol.
751
752 The required syntax for an RTP URL is:
753 rtp://@var{hostname}[:@var{port}][?@var{option}=@var{val}...]
754
755 @var{port} specifies the RTP port to use.
756
757 The following URL options are supported:
758
759 @table @option
760
761 @item ttl=@var{n}
762 Set the TTL (Time-To-Live) value (for multicast only).
763
764 @item rtcpport=@var{n}
765 Set the remote RTCP port to @var{n}.
766
767 @item localrtpport=@var{n}
768 Set the local RTP port to @var{n}.
769
770 @item localrtcpport=@var{n}'
771 Set the local RTCP port to @var{n}.
772
773 @item pkt_size=@var{n}
774 Set max packet size (in bytes) to @var{n}.
775
776 @item connect=0|1
777 Do a @code{connect()} on the UDP socket (if set to 1) or not (if set
778 to 0).
779
780 @item sources=@var{ip}[,@var{ip}]
781 List allowed source IP addresses.
782
783 @item block=@var{ip}[,@var{ip}]
784 List disallowed (blocked) source IP addresses.
785
786 @item write_to_source=0|1
787 Send packets to the source address of the latest received packet (if
788 set to 1) or to a default remote address (if set to 0).
789
790 @item localport=@var{n}
791 Set the local RTP port to @var{n}.
792
793 This is a deprecated option. Instead, @option{localrtpport} should be
794 used.
795
796 @end table
797
798 Important notes:
799
800 @enumerate
801
802 @item
803 If @option{rtcpport} is not set the RTCP port will be set to the RTP
804 port value plus 1.
805
806 @item
807 If @option{localrtpport} (the local RTP port) is not set any available
808 port will be used for the local RTP and RTCP ports.
809
810 @item
811 If @option{localrtcpport} (the local RTCP port) is not set it will be
812 set to the local RTP port value plus 1.
813 @end enumerate
814
815 @section rtsp
816
817 Real-Time Streaming Protocol.
818
819 RTSP is not technically a protocol handler in libavformat, it is a demuxer
820 and muxer. The demuxer supports both normal RTSP (with data transferred
821 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
822 data transferred over RDT).
823
824 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
825 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
826 @uref{https://github.com/revmischa/rtsp-server, RTSP server}).
827
828 The required syntax for a RTSP url is:
829 @example
830 rtsp://@var{hostname}[:@var{port}]/@var{path}
831 @end example
832
833 Options can be set on the @command{ffmpeg}/@command{ffplay} command
834 line, or set in code via @code{AVOption}s or in
835 @code{avformat_open_input}.
836
837 The following options are supported.
838
839 @table @option
840 @item initial_pause
841 Do not start playing the stream immediately if set to 1. Default value
842 is 0.
843
844 @item rtsp_transport
845 Set RTSP transport protocols.
846
847 It accepts the following values:
848 @table @samp
849 @item udp
850 Use UDP as lower transport protocol.
851
852 @item tcp
853 Use TCP (interleaving within the RTSP control channel) as lower
854 transport protocol.
855
856 @item udp_multicast
857 Use UDP multicast as lower transport protocol.
858
859 @item http
860 Use HTTP tunneling as lower transport protocol, which is useful for
861 passing proxies.
862 @end table
863
864 Multiple lower transport protocols may be specified, in that case they are
865 tried one at a time (if the setup of one fails, the next one is tried).
866 For the muxer, only the @samp{tcp} and @samp{udp} options are supported.
867
868 @item rtsp_flags
869 Set RTSP flags.
870
871 The following values are accepted:
872 @table @samp
873 @item filter_src
874 Accept packets only from negotiated peer address and port.
875 @item listen
876 Act as a server, listening for an incoming connection.
877 @item prefer_tcp
878 Try TCP for RTP transport first, if TCP is available as RTSP RTP transport.
879 @end table
880
881 Default value is @samp{none}.
882
883 @item allowed_media_types
884 Set media types to accept from the server.
885
886 The following flags are accepted:
887 @table @samp
888 @item video
889 @item audio
890 @item data
891 @end table
892
893 By default it accepts all media types.
894
895 @item min_port
896 Set minimum local UDP port. Default value is 5000.
897
898 @item max_port
899 Set maximum local UDP port. Default value is 65000.
900
901 @item timeout
902 Set maximum timeout (in seconds) to wait for incoming connections.
903
904 A value of -1 means infinite (default). This option implies the
905 @option{rtsp_flags} set to @samp{listen}.
906
907 @item reorder_queue_size
908 Set number of packets to buffer for handling of reordered packets.
909
910 @item stimeout
911 Set socket TCP I/O timeout in microseconds.
912
913 @item user-agent
914 Override User-Agent header. If not specified, it defaults to the
915 libavformat identifier string.
916 @end table
917
918 When receiving data over UDP, the demuxer tries to reorder received packets
919 (since they may arrive out of order, or packets may get lost totally). This
920 can be disabled by setting the maximum demuxing delay to zero (via
921 the @code{max_delay} field of AVFormatContext).
922
923 When watching multi-bitrate Real-RTSP streams with @command{ffplay}, the
924 streams to display can be chosen with @code{-vst} @var{n} and
925 @code{-ast} @var{n} for video and audio respectively, and can be switched
926 on the fly by pressing @code{v} and @code{a}.
927
928 @subsection Examples
929
930 The following examples all make use of the @command{ffplay} and
931 @command{ffmpeg} tools.
932
933 @itemize
934 @item
935 Watch a stream over UDP, with a max reordering delay of 0.5 seconds:
936 @example
937 ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
938 @end example
939
940 @item
941 Watch a stream tunneled over HTTP:
942 @example
943 ffplay -rtsp_transport http rtsp://server/video.mp4
944 @end example
945
946 @item
947 Send a stream in realtime to a RTSP server, for others to watch:
948 @example
949 ffmpeg -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
950 @end example
951
952 @item
953 Receive a stream in realtime:
954 @example
955 ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
956 @end example
957 @end itemize
958
959 @section sap
960
961 Session Announcement Protocol (RFC 2974). This is not technically a
962 protocol handler in libavformat, it is a muxer and demuxer.
963 It is used for signalling of RTP streams, by announcing the SDP for the
964 streams regularly on a separate port.
965
966 @subsection Muxer
967
968 The syntax for a SAP url given to the muxer is:
969 @example
970 sap://@var{destination}[:@var{port}][?@var{options}]
971 @end example
972
973 The RTP packets are sent to @var{destination} on port @var{port},
974 or to port 5004 if no port is specified.
975 @var{options} is a @code{&}-separated list. The following options
976 are supported:
977
978 @table @option
979
980 @item announce_addr=@var{address}
981 Specify the destination IP address for sending the announcements to.
982 If omitted, the announcements are sent to the commonly used SAP
983 announcement multicast address 224.2.127.254 (sap.mcast.net), or
984 ff0e::2:7ffe if @var{destination} is an IPv6 address.
985
986 @item announce_port=@var{port}
987 Specify the port to send the announcements on, defaults to
988 9875 if not specified.
989
990 @item ttl=@var{ttl}
991 Specify the time to live value for the announcements and RTP packets,
992 defaults to 255.
993
994 @item same_port=@var{0|1}
995 If set to 1, send all RTP streams on the same port pair. If zero (the
996 default), all streams are sent on unique ports, with each stream on a
997 port 2 numbers higher than the previous.
998 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
999 The RTP stack in libavformat for receiving requires all streams to be sent
1000 on unique ports.
1001 @end table
1002
1003 Example command lines follow.
1004
1005 To broadcast a stream on the local subnet, for watching in VLC:
1006
1007 @example
1008 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
1009 @end example
1010
1011 Similarly, for watching in @command{ffplay}:
1012
1013 @example
1014 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255
1015 @end example
1016
1017 And for watching in @command{ffplay}, over IPv6:
1018
1019 @example
1020 ffmpeg -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
1021 @end example
1022
1023 @subsection Demuxer
1024
1025 The syntax for a SAP url given to the demuxer is:
1026 @example
1027 sap://[@var{address}][:@var{port}]
1028 @end example
1029
1030 @var{address} is the multicast address to listen for announcements on,
1031 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
1032 is the port that is listened on, 9875 if omitted.
1033
1034 The demuxers listens for announcements on the given address and port.
1035 Once an announcement is received, it tries to receive that particular stream.
1036
1037 Example command lines follow.
1038
1039 To play back the first stream announced on the normal SAP multicast address:
1040
1041 @example
1042 ffplay sap://
1043 @end example
1044
1045 To play back the first stream announced on one the default IPv6 SAP multicast address:
1046
1047 @example
1048 ffplay sap://[ff0e::2:7ffe]
1049 @end example
1050
1051 @section sctp
1052
1053 Stream Control Transmission Protocol.
1054
1055 The accepted URL syntax is:
1056 @example
1057 sctp://@var{host}:@var{port}[?@var{options}]
1058 @end example
1059
1060 The protocol accepts the following options:
1061 @table @option
1062 @item listen
1063 If set to any value, listen for an incoming connection. Outgoing connection is done by default.
1064
1065 @item max_streams
1066 Set the maximum number of streams. By default no limit is set.
1067 @end table
1068
1069 @section srtp
1070
1071 Secure Real-time Transport Protocol.
1072
1073 The accepted options are:
1074 @table @option
1075 @item srtp_in_suite
1076 @item srtp_out_suite
1077 Select input and output encoding suites.
1078
1079 Supported values:
1080 @table @samp
1081 @item AES_CM_128_HMAC_SHA1_80
1082 @item SRTP_AES128_CM_HMAC_SHA1_80
1083 @item AES_CM_128_HMAC_SHA1_32
1084 @item SRTP_AES128_CM_HMAC_SHA1_32
1085 @end table
1086
1087 @item srtp_in_params
1088 @item srtp_out_params
1089 Set input and output encoding parameters, which are expressed by a
1090 base64-encoded representation of a binary block. The first 16 bytes of
1091 this binary block are used as master key, the following 14 bytes are
1092 used as master salt.
1093 @end table
1094
1095 @section subfile
1096
1097 Virtually extract a segment of a file or another stream.
1098 The underlying stream must be seekable.
1099
1100 Accepted options:
1101 @table @option
1102 @item start
1103 Start offset of the extracted segment, in bytes.
1104 @item end
1105 End offset of the extracted segment, in bytes.
1106 @end table
1107
1108 Examples:
1109
1110 Extract a chapter from a DVD VOB file (start and end sectors obtained
1111 externally and multiplied by 2048):
1112 @example
1113 subfile,,start,153391104,end,268142592,,:/media/dvd/VIDEO_TS/VTS_08_1.VOB
1114 @end example
1115
1116 Play an AVI file directly from a TAR archive:
1117 @example
1118 subfile,,start,183241728,end,366490624,,:archive.tar
1119 @end example
1120
1121 @section tcp
1122
1123 Transmission Control Protocol.
1124
1125 The required syntax for a TCP url is:
1126 @example
1127 tcp://@var{hostname}:@var{port}[?@var{options}]
1128 @end example
1129
1130 @var{options} contains a list of &-separated options of the form
1131 @var{key}=@var{val}.
1132
1133 The list of supported options follows.
1134
1135 @table @option
1136 @item listen=@var{1|0}
1137 Listen for an incoming connection. Default value is 0.
1138
1139 @item timeout=@var{microseconds}
1140 Set raise error timeout, expressed in microseconds.
1141
1142 This option is only relevant in read mode: if no data arrived in more
1143 than this time interval, raise error.
1144
1145 @item listen_timeout=@var{milliseconds}
1146 Set listen timeout, expressed in milliseconds.
1147 @end table
1148
1149 The following example shows how to setup a listening TCP connection
1150 with @command{ffmpeg}, which is then accessed with @command{ffplay}:
1151 @example
1152 ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
1153 ffplay tcp://@var{hostname}:@var{port}
1154 @end example
1155
1156 @section tls
1157
1158 Transport Layer Security (TLS) / Secure Sockets Layer (SSL)
1159
1160 The required syntax for a TLS/SSL url is:
1161 @example
1162 tls://@var{hostname}:@var{port}[?@var{options}]
1163 @end example
1164
1165 The following parameters can be set via command line options
1166 (or in code via @code{AVOption}s):
1167
1168 @table @option
1169
1170 @item ca_file, cafile=@var{filename}
1171 A file containing certificate authority (CA) root certificates to treat
1172 as trusted. If the linked TLS library contains a default this might not
1173 need to be specified for verification to work, but not all libraries and
1174 setups have defaults built in.
1175 The file must be in OpenSSL PEM format.
1176
1177 @item tls_verify=@var{1|0}
1178 If enabled, try to verify the peer that we are communicating with.
1179 Note, if using OpenSSL, this currently only makes sure that the
1180 peer certificate is signed by one of the root certificates in the CA
1181 database, but it does not validate that the certificate actually
1182 matches the host name we are trying to connect to. (With GnuTLS,
1183 the host name is validated as well.)
1184
1185 This is disabled by default since it requires a CA database to be
1186 provided by the caller in many cases.
1187
1188 @item cert_file, cert=@var{filename}
1189 A file containing a certificate to use in the handshake with the peer.
1190 (When operating as server, in listen mode, this is more often required
1191 by the peer, while client certificates only are mandated in certain
1192 setups.)
1193
1194 @item key_file, key=@var{filename}
1195 A file containing the private key for the certificate.
1196
1197 @item listen=@var{1|0}
1198 If enabled, listen for connections on the provided port, and assume
1199 the server role in the handshake instead of the client role.
1200
1201 @end table
1202
1203 Example command lines:
1204
1205 To create a TLS/SSL server that serves an input stream.
1206
1207 @example
1208 ffmpeg -i @var{input} -f @var{format} tls://@var{hostname}:@var{port}?listen&cert=@var{server.crt}&key=@var{server.key}
1209 @end example
1210
1211 To play back a stream from the TLS/SSL server using @command{ffplay}:
1212
1213 @example
1214 ffplay tls://@var{hostname}:@var{port}
1215 @end example
1216
1217 @section udp
1218
1219 User Datagram Protocol.
1220
1221 The required syntax for an UDP URL is:
1222 @example
1223 udp://@var{hostname}:@var{port}[?@var{options}]
1224 @end example
1225
1226 @var{options} contains a list of &-separated options of the form @var{key}=@var{val}.
1227
1228 In case threading is enabled on the system, a circular buffer is used
1229 to store the incoming data, which allows one to reduce loss of data due to
1230 UDP socket buffer overruns. The @var{fifo_size} and
1231 @var{overrun_nonfatal} options are related to this buffer.
1232
1233 The list of supported options follows.
1234
1235 @table @option
1236 @item buffer_size=@var{size}
1237 Set the UDP maximum socket buffer size in bytes. This is used to set either
1238 the receive or send buffer size, depending on what the socket is used for.
1239 Default is 64KB.  See also @var{fifo_size}.
1240
1241 @item localport=@var{port}
1242 Override the local UDP port to bind with.
1243
1244 @item localaddr=@var{addr}
1245 Choose the local IP address. This is useful e.g. if sending multicast
1246 and the host has multiple interfaces, where the user can choose
1247 which interface to send on by specifying the IP address of that interface.
1248
1249 @item pkt_size=@var{size}
1250 Set the size in bytes of UDP packets.
1251
1252 @item reuse=@var{1|0}
1253 Explicitly allow or disallow reusing UDP sockets.
1254
1255 @item ttl=@var{ttl}
1256 Set the time to live value (for multicast only).
1257
1258 @item connect=@var{1|0}
1259 Initialize the UDP socket with @code{connect()}. In this case, the
1260 destination address can't be changed with ff_udp_set_remote_url later.
1261 If the destination address isn't known at the start, this option can
1262 be specified in ff_udp_set_remote_url, too.
1263 This allows finding out the source address for the packets with getsockname,
1264 and makes writes return with AVERROR(ECONNREFUSED) if "destination
1265 unreachable" is received.
1266 For receiving, this gives the benefit of only receiving packets from
1267 the specified peer address/port.
1268
1269 @item sources=@var{address}[,@var{address}]
1270 Only receive packets sent to the multicast group from one of the
1271 specified sender IP addresses.
1272
1273 @item block=@var{address}[,@var{address}]
1274 Ignore packets sent to the multicast group from the specified
1275 sender IP addresses.
1276
1277 @item fifo_size=@var{units}
1278 Set the UDP receiving circular buffer size, expressed as a number of
1279 packets with size of 188 bytes. If not specified defaults to 7*4096.
1280
1281 @item overrun_nonfatal=@var{1|0}
1282 Survive in case of UDP receiving circular buffer overrun. Default
1283 value is 0.
1284
1285 @item timeout=@var{microseconds}
1286 Set raise error timeout, expressed in microseconds.
1287
1288 This option is only relevant in read mode: if no data arrived in more
1289 than this time interval, raise error.
1290
1291 @item broadcast=@var{1|0}
1292 Explicitly allow or disallow UDP broadcasting.
1293
1294 Note that broadcasting may not work properly on networks having
1295 a broadcast storm protection.
1296 @end table
1297
1298 @subsection Examples
1299
1300 @itemize
1301 @item
1302 Use @command{ffmpeg} to stream over UDP to a remote endpoint:
1303 @example
1304 ffmpeg -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
1305 @end example
1306
1307 @item
1308 Use @command{ffmpeg} to stream in mpegts format over UDP using 188
1309 sized UDP packets, using a large input buffer:
1310 @example
1311 ffmpeg -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
1312 @end example
1313
1314 @item
1315 Use @command{ffmpeg} to receive over UDP from a remote endpoint:
1316 @example
1317 ffmpeg -i udp://[@var{multicast-address}]:@var{port} ...
1318 @end example
1319 @end itemize
1320
1321 @section unix
1322
1323 Unix local socket
1324
1325 The required syntax for a Unix socket URL is:
1326
1327 @example
1328 unix://@var{filepath}
1329 @end example
1330
1331 The following parameters can be set via command line options
1332 (or in code via @code{AVOption}s):
1333
1334 @table @option
1335 @item timeout
1336 Timeout in ms.
1337 @item listen
1338 Create the Unix socket in listening mode.
1339 @end table
1340
1341 @c man end PROTOCOLS