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