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