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