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