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