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