protocols.texi 32.7 KB
Newer Older
Stefano Sabatini's avatar
Stefano Sabatini committed
1 2 3
@chapter Protocols
@c man begin PROTOCOLS

4 5
Protocols are configured elements in FFmpeg that enable access to
resources that require specific protocols.
Stefano Sabatini's avatar
Stefano Sabatini committed
6

7
When you configure your FFmpeg build, all the supported protocols are
8 9
enabled by default. You can list all available ones using the
configure option "--list-protocols".
Stefano Sabatini's avatar
Stefano Sabatini committed
10 11 12 13 14 15 16 17

You can disable all the protocols using the configure option
"--disable-protocols", and selectively enable a protocol using the
option "--enable-protocol=@var{PROTOCOL}", or you can disable a
particular protocol using the option
"--disable-protocol=@var{PROTOCOL}".

The option "-protocols" of the ff* tools will display the list of
18
supported protocols.
Stefano Sabatini's avatar
Stefano Sabatini committed
19 20 21

A description of the currently available protocols follows.

Petri Hintukainen's avatar
Petri Hintukainen committed
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
@section bluray

Read BluRay playlist.

The accepted options are:
@table @option

@item angle
BluRay angle

@item chapter
Start chapter (1...N)

@item playlist
Playlist to read (BDMV/PLAYLIST/?????.mpls)

@end table

Examples:

Read longest playlist from BluRay mounted to /mnt/bluray:
@example
bluray:/mnt/bluray
@end example

Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2:
@example
-playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray
@end example

Andrey Utkin's avatar
Andrey Utkin committed
52 53 54 55
@section cache

Caching wrapper for input stream.

56
Cache the input stream to temporary file. It brings seeking capability to live streams.
Andrey Utkin's avatar
Andrey Utkin committed
57 58 59 60 61

@example
cache:@var{URL}
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
62 63 64 65
@section concat

Physical concatenation protocol.

66 67
Allow to read and seek from many resource in sequence as if they were
a unique resource.
Stefano Sabatini's avatar
Stefano Sabatini committed
68

69
A URL accepted by this protocol has the syntax:
Stefano Sabatini's avatar
Stefano Sabatini committed
70 71 72 73 74 75 76 77 78
@example
concat:@var{URL1}|@var{URL2}|...|@var{URLN}
@end example

where @var{URL1}, @var{URL2}, ..., @var{URLN} are the urls of the
resource to be concatenated, each one possibly specifying a distinct
protocol.

For example to read a sequence of files @file{split1.mpeg},
79
@file{split2.mpeg}, @file{split3.mpeg} with @command{ffplay} use the
Stefano Sabatini's avatar
Stefano Sabatini committed
80 81 82 83 84 85 86 87
command:
@example
ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
@end example

Note that you may need to escape the character "|" which is special for
many shells.

88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
@section crypto

AES-encrypted stream reading protocol.

The accepted options are:
@table @option
@item key
Set the AES decryption key binary block from given hexadecimal representation.

@item iv
Set the AES decryption initialization vector binary block from given hexadecimal representation.
@end table

Accepted URL formats:
@example
crypto:@var{URL}
crypto+@var{URL}
@end example

107 108 109 110 111 112 113 114 115
@section data

Data in-line in the URI. See @url{http://en.wikipedia.org/wiki/Data_URI_scheme}.

For example, to convert a GIF file given inline with @command{ffmpeg}:
@example
ffmpeg -i "data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=" smiley.png
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
116 117 118 119
@section file

File access protocol.

120
Allow to read from or write to a file.
Stefano Sabatini's avatar
Stefano Sabatini committed
121

122 123 124 125 126 127 128 129 130 131 132 133
A file URL can have the form:
@example
file:@var{filename}
@end example

where @var{filename} is the path of the file to read.

An URL that does not have a protocol prefix will be assumed to be a
file URL. Depending on the build, an URL that looks like a Windows
path with the drive letter at the beginning will also be assumed to be
a file URL (usually not the case in builds for unix-like systems).

134
For example to read from a file @file{input.mpeg} with @command{ffmpeg}
Stefano Sabatini's avatar
Stefano Sabatini committed
135 136 137 138 139
use the command:
@example
ffmpeg -i file:input.mpeg output.mpeg
@end example

140 141 142 143 144 145 146 147 148 149 150 151 152 153
This protocol accepts the following options:

@table @option
@item truncate
Truncate existing files on write, if set to 1. A value of 0 prevents
truncating. Default value is 1.

@item blocksize
Set I/O operation maximum block size, in bytes. Default value is
@code{INT_MAX}, which results in not limiting the requested block size.
Setting this value reasonably low improves user termination request reaction
time, which is valuable for files on slow medium.
@end table

Lukasz Marek's avatar
Lukasz Marek committed
154 155
@section ftp

156
FTP (File Transfer Protocol).
Lukasz Marek's avatar
Lukasz Marek committed
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187

Allow to read from or write to remote resources using FTP protocol.

Following syntax is required.
@example
ftp://[user[:password]@@]server[:port]/path/to/remote/resource.mpeg
@end example

This protocol accepts the following options.

@table @option
@item timeout
Set timeout of socket I/O operations used by the underlying low level
operation. By default it is set to -1, which means that the timeout is
not specified.

@item ftp-anonymous-password
Password used when login as anonymous user. Typically an e-mail address
should be used.

@item ftp-write-seekable
Control seekability of connection during encoding. If set to 1 the
resource is supposed to be seekable, if set to 0 it is assumed not
to be seekable. Default value is 0.
@end table

NOTE: Protocol can be used as output, but it is recommended to not do
it, unless special care is taken (tests, customized server configuration
etc.). Different FTP servers behave in different way during seek
operation. ff* tools may produce incomplete content due to server limitations.

Stefano Sabatini's avatar
Stefano Sabatini committed
188 189 190 191
@section gopher

Gopher protocol.

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
@section hls

Read Apple HTTP Live Streaming compliant segmented stream as
a uniform one. The M3U8 playlists describing the segments can be
remote HTTP resources or local files, accessed using the standard
file protocol.
The nested protocol is declared by specifying
"+@var{proto}" after the hls URI scheme name, where @var{proto}
is either "file" or "http".

@example
hls+http://host/path/to/remote/resource.m3u8
hls+file://path/to/local/resource.m3u8
@end example

207 208 209 210 211
Using this protocol is discouraged - the hls demuxer should work
just as well (if not, please report the issues) and is more complete.
To use the hls demuxer instead, simply use the direct URLs to the
m3u8 files.

Stefano Sabatini's avatar
Stefano Sabatini committed
212 213
@section http

214
HTTP (Hyper Text Transfer Protocol).
Stefano Sabatini's avatar
Stefano Sabatini committed
215

216 217 218 219 220 221
This protocol accepts the following options.

@table @option
@item seekable
Control seekability of connection. If set to 1 the resource is
supposed to be seekable, if set to 0 it is assumed not to be seekable,
222 223
if set to -1 it will try to autodetect if it is seekable. Default
value is -1.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251

@item chunked_post
If set to 1 use chunked transfer-encoding for posts, default is 1.

@item headers
Set custom HTTP headers, can override built in default headers. The
value must be a string encoding the headers.

@item content_type
Force a content type.

@item user-agent
Override User-Agent header. If not specified the protocol will use a
string describing the libavformat build.

@item multiple_requests
Use persistent connections if set to 1. By default it is 0.

@item post_data
Set custom HTTP post data.

@item timeout
Set timeout of socket I/O operations used by the underlying low level
operation. By default it is set to -1, which means that the timeout is
not specified.

@item mime_type
Set MIME type.
252

253 254 255 256 257 258 259 260 261 262 263 264 265 266
@item icy
If set to 1 request ICY (SHOUTcast) metadata from the server. If the server
supports this, the metadata has to be retrieved by the application by reading
the @option{icy_metadata_headers} and @option{icy_metadata_packet} options.
The default is 0.

@item icy_metadata_headers
If the server supports ICY metadata, this contains the ICY specific HTTP reply
headers, separated with newline characters.

@item icy_metadata_packet
If the server supports ICY metadata, and @option{icy} was set to 1, this
contains the last non-empty metadata packet sent by the server.

267 268 269 270
@item cookies
Set the cookies to be sent in future requests. The format of each cookie is the
same as the value of a Set-Cookie HTTP response field. Multiple cookies can be
delimited by a newline character.
271 272
@end table

273 274 275 276 277 278 279 280 281 282 283 284 285 286
@subsection HTTP Cookies

Some HTTP requests will be denied unless cookie values are passed in with the
request. The @option{cookies} option allows these cookies to be specified. At
the very least, each cookie must specify a value along with a path and domain.
HTTP requests that match both the domain and path will automatically include the
cookie value in the HTTP Cookie header field. Multiple cookies can be delimited
by a newline.

The required syntax to play a stream specifying a cookie is:
@example
ffplay -cookies "nlqptid=nltid=tsn; path=/; domain=somedomain.com;" http://somedomain.com/somestream.m3u8
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
287 288 289 290
@section mmst

MMS (Microsoft Media Server) protocol over TCP.

291 292 293 294 295 296 297 298 299
@section mmsh

MMS (Microsoft Media Server) protocol over HTTP.

The required syntax is:
@example
mmsh://@var{server}[:@var{port}][/@var{app}][/@var{playpath}]
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
300 301 302 303
@section md5

MD5 output protocol.

304 305 306
Computes the MD5 hash of the data to be written, and on close writes
this to the designated output or stdout if none is specified. It can
be used to test muxers without writing an actual file.
Stefano Sabatini's avatar
Stefano Sabatini committed
307 308 309

Some examples follow.
@example
310
# Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
Stefano Sabatini's avatar
Stefano Sabatini committed
311 312
ffmpeg -i input.flv -f avi -y md5:output.avi.md5

313
# Write the MD5 hash of the encoded AVI file to stdout.
Stefano Sabatini's avatar
Stefano Sabatini committed
314 315 316
ffmpeg -i input.flv -f avi -y md5:
@end example

317
Note that some formats (typically MOV) require the output protocol to
Stefano Sabatini's avatar
Stefano Sabatini committed
318 319 320 321 322 323 324 325 326 327 328 329 330 331
be seekable, so they will fail with the MD5 output protocol.

@section pipe

UNIX pipe access protocol.

Allow to read and write from UNIX pipes.

The accepted syntax is:
@example
pipe:[@var{number}]
@end example

@var{number} is the number corresponding to the file descriptor of the
332 333 334
pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).  If @var{number}
is not specified, by default the stdout file descriptor will be used
for writing, stdin for reading.
Stefano Sabatini's avatar
Stefano Sabatini committed
335

336
For example to read from stdin with @command{ffmpeg}:
Stefano Sabatini's avatar
Stefano Sabatini committed
337 338
@example
cat test.wav | ffmpeg -i pipe:0
339
# ...this is the same as...
Stefano Sabatini's avatar
Stefano Sabatini committed
340 341 342
cat test.wav | ffmpeg -i pipe:
@end example

343
For writing to stdout with @command{ffmpeg}:
Stefano Sabatini's avatar
Stefano Sabatini committed
344 345
@example
ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
346
# ...this is the same as...
Stefano Sabatini's avatar
Stefano Sabatini committed
347 348 349
ffmpeg -i test.wav -f avi pipe: | cat > test.avi
@end example

350 351 352 353 354 355 356 357 358 359
This protocol accepts the following options:

@table @option
@item blocksize
Set I/O operation maximum block size, in bytes. Default value is
@code{INT_MAX}, which results in not limiting the requested block size.
Setting this value reasonably low improves user termination request reaction
time, which is valuable if data transmission is slow.
@end table

360
Note that some formats (typically MOV), require the output protocol to
Stefano Sabatini's avatar
Stefano Sabatini committed
361 362 363 364 365 366
be seekable, so they will fail with the pipe output protocol.

@section rtmp

Real-Time Messaging Protocol.

367 368
The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
content across a TCP/IP network.
Stefano Sabatini's avatar
Stefano Sabatini committed
369 370 371

The required syntax is:
@example
372
rtmp://[@var{username}:@var{password}@@]@var{server}[:@var{port}][/@var{app}][/@var{instance}][/@var{playpath}]
Stefano Sabatini's avatar
Stefano Sabatini committed
373 374
@end example

375
The accepted parameters are:
Stefano Sabatini's avatar
Stefano Sabatini committed
376 377
@table @option

378 379 380 381 382 383
@item username
An optional username (mostly for publishing).

@item password
An optional password (mostly for publishing).

Stefano Sabatini's avatar
Stefano Sabatini committed
384
@item server
385
The address of the RTMP server.
Stefano Sabatini's avatar
Stefano Sabatini committed
386 387

@item port
388
The number of the TCP port to use (by default is 1935).
Stefano Sabatini's avatar
Stefano Sabatini committed
389 390

@item app
391 392
It is the name of the application to access. It usually corresponds to
the path where the application is installed on the RTMP server
393 394
(e.g. @file{/ondemand/}, @file{/flash/live/}, etc.). You can override
the value parsed from the URI through the @code{rtmp_app} option, too.
Stefano Sabatini's avatar
Stefano Sabatini committed
395 396 397

@item playpath
It is the path or name of the resource to play with reference to the
398 399 400 401
application specified in @var{app}, may be prefixed by "mp4:". You
can override the value parsed from the URI through the @code{rtmp_playpath}
option, too.

402 403 404 405 406
@item listen
Act as a server, listening for an incoming connection.

@item timeout
Maximum time to wait for the incoming connection. Implies listen.
407 408 409 410 411 412 413 414 415 416
@end table

Additionally, the following parameters can be set via command line options
(or in code via @code{AVOption}s):
@table @option

@item rtmp_app
Name of application to connect on the RTMP server. This option
overrides the parameter specified in the URI.

417 418 419
@item rtmp_buffer
Set the client buffer time in milliseconds. The default is 3000.

420 421 422 423 424 425 426 427 428 429 430 431
@item rtmp_conn
Extra arbitrary AMF connection parameters, parsed from a string,
e.g. like @code{B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0}.
Each value is prefixed by a single character denoting the type,
B for Boolean, N for number, S for string, O for object, or Z for null,
followed by a colon. For Booleans the data must be either 0 or 1 for
FALSE or TRUE, respectively.  Likewise for Objects the data must be 0 or
1 to end or begin an object, respectively. Data items in subobjects may
be named, by prefixing the type with 'N' and specifying the name before
the value (i.e. @code{NB:myFlag:1}). This option may be used multiple
times to construct arbitrary AMF sequences.

432 433
@item rtmp_flashver
Version of the Flash plugin used to run the SWF player. The default
434 435
is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible;
<libavformat version>).)
436

437 438 439 440
@item rtmp_flush_interval
Number of packets flushed in the same request (RTMPT only). The default
is 10.

441 442 443 444 445 446 447 448
@item rtmp_live
Specify that the media is a live stream. No resuming or seeking in
live streams is possible. The default value is @code{any}, which means the
subscriber first tries to play the live stream specified in the
playpath. If a live stream of that name is not found, it plays the
recorded stream. The other possible values are @code{live} and
@code{recorded}.

449 450 451 452
@item rtmp_pageurl
URL of the web page in which the media was embedded. By default no
value will be sent.

453 454 455 456
@item rtmp_playpath
Stream identifier to play or to publish. This option overrides the
parameter specified in the URI.

457 458 459 460 461
@item rtmp_subscribe
Name of live stream to subscribe to. By default no value will be sent.
It is only sent if the option is specified or if rtmp_live
is set to live.

462 463 464 465 466 467
@item rtmp_swfhash
SHA256 hash of the decompressed SWF file (32 bytes).

@item rtmp_swfsize
Size of the decompressed SWF file, required for SWFVerification.

468 469 470
@item rtmp_swfurl
URL of the SWF player for the media. By default no value will be sent.

471 472 473
@item rtmp_swfverify
URL to player swf file, compute hash/size automatically.

474
@item rtmp_tcurl
475
URL of the target stream. Defaults to proto://host[:port]/app.
Stefano Sabatini's avatar
Stefano Sabatini committed
476 477 478

@end table

479
For example to read with @command{ffplay} a multimedia resource named
Stefano Sabatini's avatar
Stefano Sabatini committed
480 481 482 483 484
"sample" from the application "vod" from an RTMP server "myserver":
@example
ffplay rtmp://myserver/vod/sample
@end example

485 486 487
To publish to a password protected server, passing the playpath and
app names separately:
@example
488
ffmpeg -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@@myserver/
489 490
@end example

Samuel Pitoiset's avatar
Samuel Pitoiset committed
491 492 493 494 495 496 497 498 499
@section rtmpe

Encrypted Real-Time Messaging Protocol.

The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
streaming multimedia content within standard cryptographic primitives,
consisting of Diffie-Hellman key exchange and HMACSHA256, generating
a pair of RC4 keys.

Samuel Pitoiset's avatar
Samuel Pitoiset committed
500 501 502 503 504 505 506
@section rtmps

Real-Time Messaging Protocol over a secure SSL connection.

The Real-Time Messaging Protocol (RTMPS) is used for streaming
multimedia content across an encrypted connection.

Samuel Pitoiset's avatar
Samuel Pitoiset committed
507 508 509 510 511 512 513 514
@section rtmpt

Real-Time Messaging Protocol tunneled through HTTP.

The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
for streaming multimedia content within HTTP requests to traverse
firewalls.

515 516 517 518 519 520 521 522
@section rtmpte

Encrypted Real-Time Messaging Protocol tunneled through HTTP.

The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
is used for streaming multimedia content within HTTP requests to traverse
firewalls.

523 524 525 526 527 528 529 530
@section rtmpts

Real-Time Messaging Protocol tunneled through HTTPS.

The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
for streaming multimedia content within HTTPS requests to traverse
firewalls.

531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
@section libssh

Secure File Transfer Protocol via libssh

Allow to read from or write to remote resources using SFTP protocol.

Following syntax is required.

@example
sftp://[user[:password]@@]server[:port]/path/to/remote/resource.mpeg
@end example

This protocol accepts the following options.

@table @option
@item timeout
Set timeout of socket I/O operations used by the underlying low level
operation. By default it is set to -1, which means that the timeout
is not specified.

@item truncate
Truncate existing files on write, if set to 1. A value of 0 prevents
truncating. Default value is 1.

555 556 557 558
@item private_key
Specify the path of the file containing private key to use during authorization.
By default libssh searches for keys in the @file{~/.ssh/} directory.

559 560 561 562 563 564 565 566
@end table

Example: Play a file stored on remote server.

@example
ffplay sftp://user:password@@server_address:22/home/user/resource.mpeg
@end example

567
@section librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte
Stefano Sabatini's avatar
Stefano Sabatini committed
568 569 570 571

Real-Time Messaging Protocol and its variants supported through
librtmp.

572
Requires the presence of the librtmp headers and library during
573
configuration. You need to explicitly configure the build with
Stefano Sabatini's avatar
Stefano Sabatini committed
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
"--enable-librtmp". If enabled this will replace the native RTMP
protocol.

This protocol provides most client functions and a few server
functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
variants of these encrypted types (RTMPTE, RTMPTS).

The required syntax is:
@example
@var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
@end example

where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
"rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
@var{server}, @var{port}, @var{app} and @var{playpath} have the same
590
meaning as specified for the RTMP native protocol.
Stefano Sabatini's avatar
Stefano Sabatini committed
591 592 593
@var{options} contains a list of space-separated options of the form
@var{key}=@var{val}.

594
See the librtmp manual page (man 3 librtmp) for more information.
Stefano Sabatini's avatar
Stefano Sabatini committed
595 596

For example, to stream a file in real-time to an RTMP server using
597
@command{ffmpeg}:
Stefano Sabatini's avatar
Stefano Sabatini committed
598 599 600 601
@example
ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
@end example

602
To play the same stream using @command{ffplay}:
Stefano Sabatini's avatar
Stefano Sabatini committed
603 604 605 606 607 608
@example
ffplay "rtmp://myserver/live/mystream live=1"
@end example

@section rtp

609
Real-time Transport Protocol.
Stefano Sabatini's avatar
Stefano Sabatini committed
610

611 612 613 614 615 616 617 618 619 620
The required syntax for an RTP URL is:
rtp://@var{hostname}[:@var{port}][?@var{option}=@var{val}...]

@var{port} specifies the RTP port to use.

The following URL options are supported:

@table @option

@item ttl=@var{n}
621
Set the TTL (Time-To-Live) value (for multicast only).
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648

@item rtcpport=@var{n}
Set the remote RTCP port to @var{n}.

@item localrtpport=@var{n}
Set the local RTP port to @var{n}.

@item localrtcpport=@var{n}'
Set the local RTCP port to @var{n}.

@item pkt_size=@var{n}
Set max packet size (in bytes) to @var{n}.

@item connect=0|1
Do a @code{connect()} on the UDP socket (if set to 1) or not (if set
to 0).

@item sources=@var{ip}[,@var{ip}]
List allowed source IP addresses.

@item block=@var{ip}[,@var{ip}]
List disallowed (blocked) source IP addresses.

@item write_to_source=0|1
Send packets to the source address of the latest received packet (if
set to 1) or to a default remote address (if set to 0).

649 650 651 652 653
@item localport=@var{n}
Set the local RTP port to @var{n}.

This is a deprecated option. Instead, @option{localrtpport} should be
used.
654 655 656 657 658 659 660 661

@end table

Important notes:

@enumerate

@item
662
If @option{rtcpport} is not set the RTCP port will be set to the RTP
663 664 665
port value plus 1.

@item
666
If @option{localrtpport} (the local RTP port) is not set any available
667 668 669 670 671 672 673
port will be used for the local RTP and RTCP ports.

@item
If @option{localrtcpport} (the local RTCP port) is not set it will be
set to the the local RTP port value plus 1.
@end enumerate

674 675
@section rtsp

676 677
Real-Time Streaming Protocol.

678 679 680 681 682 683 684
RTSP is not technically a protocol handler in libavformat, it is a demuxer
and muxer. The demuxer supports both normal RTSP (with data transferred
over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
data transferred over RDT).

The muxer can be used to send a stream using RTSP ANNOUNCE to a server
supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
685
@uref{http://github.com/revmischa/rtsp-server, RTSP server}).
686 687 688

The required syntax for a RTSP url is:
@example
689
rtsp://@var{hostname}[:@var{port}]/@var{path}
690 691
@end example

692 693 694
Options can be set on the @command{ffmpeg}/@command{ffplay} command
line, or set in code via @code{AVOption}s or in
@code{avformat_open_input}.
695

696
The following options are supported.
697

698
@table @option
699 700 701
@item initial_pause
Do not start playing the stream immediately if set to 1. Default value
is 0.
702

703 704 705 706 707
@item rtsp_transport
Set RTSP trasport protocols.

It accepts the following values:
@table @samp
708 709 710 711 712 713 714
@item udp
Use UDP as lower transport protocol.

@item tcp
Use TCP (interleaving within the RTSP control channel) as lower
transport protocol.

715
@item udp_multicast
716 717 718 719 720 721 722 723 724
Use UDP multicast as lower transport protocol.

@item http
Use HTTP tunneling as lower transport protocol, which is useful for
passing proxies.
@end table

Multiple lower transport protocols may be specified, in that case they are
tried one at a time (if the setup of one fails, the next one is tried).
725
For the muxer, only the @samp{tcp} and @samp{udp} options are supported.
726

727 728
@item rtsp_flags
Set RTSP flags.
729

730 731
The following values are accepted:
@table @samp
732 733
@item filter_src
Accept packets only from negotiated peer address and port.
Jordi Ortiz's avatar
Jordi Ortiz committed
734 735
@item listen
Act as a server, listening for an incoming connection.
736 737
@end table

738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
Default value is @samp{none}.

@item allowed_media_types
Set media types to accept from the server.

The following flags are accepted:
@table @samp
@item video
@item audio
@item data
@end table

By default it accepts all media types.

@item min_port
Set minimum local UDP port. Default value is 5000.

@item max_port
Set maximum local UDP port. Default value is 65000.

@item timeout
Set maximum timeout (in seconds) to wait for incoming connections.

A value of -1 mean infinite (default). This option implies the
@option{rtsp_flags} set to @samp{listen}.

@item reorder_queue_size
Set number of packets to buffer for handling of reordered packets.

@item stimeout
Set socket TCP I/O timeout in micro seconds.

@item user-agent
Override User-Agent header. If not specified, it default to the
libavformat identifier string.
@end table

775
When receiving data over UDP, the demuxer tries to reorder received packets
776 777 778
(since they may arrive out of order, or packets may get lost totally). This
can be disabled by setting the maximum demuxing delay to zero (via
the @code{max_delay} field of AVFormatContext).
779

780
When watching multi-bitrate Real-RTSP streams with @command{ffplay}, the
781 782 783 784
streams to display can be chosen with @code{-vst} @var{n} and
@code{-ast} @var{n} for video and audio respectively, and can be switched
on the fly by pressing @code{v} and @code{a}.

785
@subsection Examples
786

787 788
The following examples all make use of the @command{ffplay} and
@command{ffmpeg} tools.
789

790 791 792
@itemize
@item
Watch a stream over UDP, with a max reordering delay of 0.5 seconds:
793
@example
794
ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
795 796
@end example

797 798
@item
Watch a stream tunneled over HTTP:
799
@example
800
ffplay -rtsp_transport http rtsp://server/video.mp4
801 802
@end example

803 804
@item
Send a stream in realtime to a RTSP server, for others to watch:
805 806 807 808
@example
ffmpeg -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
@end example

809 810
@item
Receive a stream in realtime:
Jordi Ortiz's avatar
Jordi Ortiz committed
811
@example
812
ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
Jordi Ortiz's avatar
Jordi Ortiz committed
813
@end example
814
@end itemize
815

Martin Storsjö's avatar
Martin Storsjö committed
816 817 818
@section sap

Session Announcement Protocol (RFC 2974). This is not technically a
Martin Storsjö's avatar
Martin Storsjö committed
819
protocol handler in libavformat, it is a muxer and demuxer.
Martin Storsjö's avatar
Martin Storsjö committed
820 821 822
It is used for signalling of RTP streams, by announcing the SDP for the
streams regularly on a separate port.

Martin Storsjö's avatar
Martin Storsjö committed
823 824
@subsection Muxer

Martin Storsjö's avatar
Martin Storsjö committed
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
The syntax for a SAP url given to the muxer is:
@example
sap://@var{destination}[:@var{port}][?@var{options}]
@end example

The RTP packets are sent to @var{destination} on port @var{port},
or to port 5004 if no port is specified.
@var{options} is a @code{&}-separated list. The following options
are supported:

@table @option

@item announce_addr=@var{address}
Specify the destination IP address for sending the announcements to.
If omitted, the announcements are sent to the commonly used SAP
announcement multicast address 224.2.127.254 (sap.mcast.net), or
ff0e::2:7ffe if @var{destination} is an IPv6 address.

@item announce_port=@var{port}
Specify the port to send the announcements on, defaults to
9875 if not specified.

@item ttl=@var{ttl}
Specify the time to live value for the announcements and RTP packets,
defaults to 255.

@item same_port=@var{0|1}
If set to 1, send all RTP streams on the same port pair. If zero (the
default), all streams are sent on unique ports, with each stream on a
port 2 numbers higher than the previous.
VLC/Live555 requires this to be set to 1, to be able to receive the stream.
Martin Storsjö's avatar
Martin Storsjö committed
856 857
The RTP stack in libavformat for receiving requires all streams to be sent
on unique ports.
Martin Storsjö's avatar
Martin Storsjö committed
858 859 860 861 862 863 864 865 866 867
@end table

Example command lines follow.

To broadcast a stream on the local subnet, for watching in VLC:

@example
ffmpeg -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
@end example

868
Similarly, for watching in @command{ffplay}:
Martin Storsjö's avatar
Martin Storsjö committed
869 870 871 872 873

@example
ffmpeg -re -i @var{input} -f sap sap://224.0.0.255
@end example

874
And for watching in @command{ffplay}, over IPv6:
Martin Storsjö's avatar
Martin Storsjö committed
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907

@example
ffmpeg -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
@end example

@subsection Demuxer

The syntax for a SAP url given to the demuxer is:
@example
sap://[@var{address}][:@var{port}]
@end example

@var{address} is the multicast address to listen for announcements on,
if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
is the port that is listened on, 9875 if omitted.

The demuxers listens for announcements on the given address and port.
Once an announcement is received, it tries to receive that particular stream.

Example command lines follow.

To play back the first stream announced on the normal SAP multicast address:

@example
ffplay sap://
@end example

To play back the first stream announced on one the default IPv6 SAP multicast address:

@example
ffplay sap://[ff0e::2:7ffe]
@end example

Andrey Utkin's avatar
Andrey Utkin committed
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925
@section sctp

Stream Control Transmission Protocol.

The accepted URL syntax is:
@example
sctp://@var{host}:@var{port}[?@var{options}]
@end example

The protocol accepts the following options:
@table @option
@item listen
If set to any value, listen for an incoming connection. Outgoing connection is done by default.

@item max_streams
Set the maximum number of streams. By default no limit is set.
@end table

926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
@section srtp

Secure Real-time Transport Protocol.

The accepted options are:
@table @option
@item srtp_in_suite
@item srtp_out_suite
Select input and output encoding suites.

Supported values:
@table @samp
@item AES_CM_128_HMAC_SHA1_80
@item SRTP_AES128_CM_HMAC_SHA1_80
@item AES_CM_128_HMAC_SHA1_32
@item SRTP_AES128_CM_HMAC_SHA1_32
@end table

@item srtp_in_params
@item srtp_out_params
Set input and output encoding parameters, which are expressed by a
base64-encoded representation of a binary block. The first 16 bytes of
this binary block are used as master key, the following 14 bytes are
used as master salt.
@end table

Stefano Sabatini's avatar
Stefano Sabatini committed
952 953 954 955
@section tcp

Trasmission Control Protocol.

956 957 958 959 960
The required syntax for a TCP url is:
@example
tcp://@var{hostname}:@var{port}[?@var{options}]
@end example

961 962
@var{options} contains a list of &-separated options of the form
@var{key}=@var{val}.
963

964 965 966 967 968
The list of supported options follows.

@table @option
@item listen=@var{1|0}
Listen for an incoming connection. Default value is 0.
969

970
@item timeout=@var{microseconds}
971
Set raise error timeout, expressed in microseconds.
972

973 974 975 976 977 978 979 980 981
This option is only relevant in read mode: if no data arrived in more
than this time interval, raise error.

@item listen_timeout=@var{microseconds}
Set listen timeout, expressed in microseconds.
@end table

The following example shows how to setup a listening TCP connection
with @command{ffmpeg}, which is then accessed with @command{ffplay}:
982 983 984 985 986
@example
ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
ffplay tcp://@var{hostname}:@var{port}
@end example

Peter Ross's avatar
Peter Ross committed
987 988
@section tls

989
Transport Layer Security (TLS) / Secure Sockets Layer (SSL)
Peter Ross's avatar
Peter Ross committed
990 991 992 993 994 995

The required syntax for a TLS/SSL url is:
@example
tls://@var{hostname}:@var{port}[?@var{options}]
@end example

996 997 998
The following parameters can be set via command line options
(or in code via @code{AVOption}s):

Peter Ross's avatar
Peter Ross committed
999 1000
@table @option

1001
@item ca_file, cafile=@var{filename}
1002 1003 1004 1005
A file containing certificate authority (CA) root certificates to treat
as trusted. If the linked TLS library contains a default this might not
need to be specified for verification to work, but not all libraries and
setups have defaults built in.
1006
The file must be in OpenSSL PEM format.
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018

@item tls_verify=@var{1|0}
If enabled, try to verify the peer that we are communicating with.
Note, if using OpenSSL, this currently only makes sure that the
peer certificate is signed by one of the root certificates in the CA
database, but it does not validate that the certificate actually
matches the host name we are trying to connect to. (With GnuTLS,
the host name is validated as well.)

This is disabled by default since it requires a CA database to be
provided by the caller in many cases.

1019
@item cert_file, cert=@var{filename}
1020 1021 1022 1023 1024
A file containing a certificate to use in the handshake with the peer.
(When operating as server, in listen mode, this is more often required
by the peer, while client certificates only are mandated in certain
setups.)

1025
@item key_file, key=@var{filename}
1026 1027 1028 1029 1030
A file containing the private key for the certificate.

@item listen=@var{1|0}
If enabled, listen for connections on the provided port, and assume
the server role in the handshake instead of the client role.
Peter Ross's avatar
Peter Ross committed
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047

@end table

Example command lines:

To create a TLS/SSL server that serves an input stream.

@example
ffmpeg -i @var{input} -f @var{format} tls://@var{hostname}:@var{port}?listen&cert=@var{server.crt}&key=@var{server.key}
@end example

To play back a stream from the TLS/SSL server using @command{ffplay}:

@example
ffplay tls://@var{hostname}:@var{port}
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
1048 1049 1050 1051
@section udp

User Datagram Protocol.

1052
The required syntax for an UDP URL is:
1053 1054 1055 1056
@example
udp://@var{hostname}:@var{port}[?@var{options}]
@end example

1057 1058
@var{options} contains a list of &-separated options of the form @var{key}=@var{val}.

1059 1060 1061 1062 1063
In case threading is enabled on the system, a circular buffer is used
to store the incoming data, which allows to reduce loss of data due to
UDP socket buffer overruns. The @var{fifo_size} and
@var{overrun_nonfatal} options are related to this buffer.

1064
The list of supported options follows.
1065 1066 1067

@table @option
@item buffer_size=@var{size}
1068 1069
Set the UDP socket buffer size in bytes. This is used both for the
receiving and the sending buffer size.
1070 1071

@item localport=@var{port}
1072
Override the local UDP port to bind with.
1073

1074 1075 1076 1077 1078
@item localaddr=@var{addr}
Choose the local IP address. This is useful e.g. if sending multicast
and the host has multiple interfaces, where the user can choose
which interface to send on by specifying the IP address of that interface.

1079
@item pkt_size=@var{size}
1080
Set the size in bytes of UDP packets.
1081 1082

@item reuse=@var{1|0}
1083
Explicitly allow or disallow reusing UDP sockets.
1084 1085

@item ttl=@var{ttl}
1086
Set the time to live value (for multicast only).
1087 1088 1089

@item connect=@var{1|0}
Initialize the UDP socket with @code{connect()}. In this case, the
1090
destination address can't be changed with ff_udp_set_remote_url later.
1091
If the destination address isn't known at the start, this option can
1092
be specified in ff_udp_set_remote_url, too.
1093 1094 1095
This allows finding out the source address for the packets with getsockname,
and makes writes return with AVERROR(ECONNREFUSED) if "destination
unreachable" is received.
1096 1097
For receiving, this gives the benefit of only receiving packets from
the specified peer address/port.
1098 1099 1100 1101 1102 1103 1104 1105

@item sources=@var{address}[,@var{address}]
Only receive packets sent to the multicast group from one of the
specified sender IP addresses.

@item block=@var{address}[,@var{address}]
Ignore packets sent to the multicast group from the specified
sender IP addresses.
1106 1107 1108 1109 1110 1111 1112 1113

@item fifo_size=@var{units}
Set the UDP receiving circular buffer size, expressed as a number of
packets with size of 188 bytes. If not specified defaults to 7*4096.

@item overrun_nonfatal=@var{1|0}
Survive in case of UDP receiving circular buffer overrun. Default
value is 0.
1114 1115

@item timeout=@var{microseconds}
1116 1117 1118 1119
Set raise error timeout, expressed in microseconds.

This option is only relevant in read mode: if no data arrived in more
than this time interval, raise error.
1120 1121
@end table

1122
@subsection Examples
1123

1124 1125 1126
@itemize
@item
Use @command{ffmpeg} to stream over UDP to a remote endpoint:
1127 1128 1129 1130
@example
ffmpeg -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
@end example

1131 1132 1133
@item
Use @command{ffmpeg} to stream in mpegts format over UDP using 188
sized UDP packets, using a large input buffer:
1134 1135 1136 1137
@example
ffmpeg -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
@end example

1138 1139
@item
Use @command{ffmpeg} to receive over UDP from a remote endpoint:
1140
@example
1141
ffmpeg -i udp://[@var{multicast-address}]:@var{port} ...
1142
@end example
1143
@end itemize
1144

1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
@section unix

Unix local socket

The required syntax for a Unix socket URL is:

@example
unix://@var{filepath}
@end example

The following parameters can be set via command line options
(or in code via @code{AVOption}s):

@table @option
@item timeout
Timeout in ms.
@item listen
Create the Unix socket in listening mode.
@end table

Stefano Sabatini's avatar
Stefano Sabatini committed
1165
@c man end PROTOCOLS