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