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