protocols.texi 40.4 KB
Newer Older
1 2 3 4 5 6 7
@chapter Protocol Options
@c man begin PROTOCOL OPTIONS

The libavformat library provides some generic global options, which
can be set on all the protocols. In addition each protocol may support
so-called private options, which are specific for that component.

8 9 10 11 12
Options may be set by specifying -@var{option} @var{value} in the
FFmpeg tools, or by setting the value explicitly in the
@code{AVFormatContext} options or using the @file{libavutil/opt.h} API
for programmatic use.

13 14 15 16 17 18 19 20 21 22 23 24
The list of supported options follows:

@table @option
@item protocol_whitelist @var{list} (@emph{input})
Set a ","-separated list of allowed protocols. "ALL" matches all protocols. Protocols
prefixed by "-" are disabled.
All protocols are allowed by default but protocols used by an another
protocol (nested protocols) are restricted to a per protocol subset.
@end table

@c man end PROTOCOL OPTIONS

Stefano Sabatini's avatar
Stefano Sabatini committed
25 26 27
@chapter Protocols
@c man begin PROTOCOLS

28 29
Protocols are configured elements in FFmpeg that enable access to
resources that require specific protocols.
Stefano Sabatini's avatar
Stefano Sabatini committed
30

31
When you configure your FFmpeg build, all the supported protocols are
32 33
enabled by default. You can list all available ones using the
configure option "--list-protocols".
Stefano Sabatini's avatar
Stefano Sabatini committed
34 35 36 37 38 39 40 41

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
42
supported protocols.
Stefano Sabatini's avatar
Stefano Sabatini committed
43

44 45 46 47 48 49 50 51
All protocols accept the following options:

@table @option
@item rw_timeout
Maximum time to wait for (network) read/write operations to complete,
in microseconds.
@end table

Stefano Sabatini's avatar
Stefano Sabatini committed
52 53
A description of the currently available protocols follows.

54 55 56 57 58 59 60 61 62 63 64 65
@section async

Asynchronous data filling wrapper for input stream.

Fill data in a background thread, to decouple I/O operation from demux thread.

@example
async:@var{URL}
async:http://host/resource
async:cache:http://host/resource
@end example

Petri Hintukainen's avatar
Petri Hintukainen committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
@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
96 97 98 99
@section cache

Caching wrapper for input stream.

100
Cache the input stream to temporary file. It brings seeking capability to live streams.
Andrey Utkin's avatar
Andrey Utkin committed
101 102 103 104 105

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

Stefano Sabatini's avatar
Stefano Sabatini committed
106 107 108 109
@section concat

Physical concatenation protocol.

110
Read and seek from many resources in sequence as if they were
111
a unique resource.
Stefano Sabatini's avatar
Stefano Sabatini committed
112

113
A URL accepted by this protocol has the syntax:
Stefano Sabatini's avatar
Stefano Sabatini committed
114 115 116 117 118 119 120 121 122
@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},
123
@file{split2.mpeg}, @file{split3.mpeg} with @command{ffplay} use the
Stefano Sabatini's avatar
Stefano Sabatini committed
124 125 126 127 128 129 130 131
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.

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
@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

151 152 153 154 155 156 157 158 159
@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
160 161 162 163
@section file

File access protocol.

164
Read from or write to a file.
Stefano Sabatini's avatar
Stefano Sabatini committed
165

166 167 168 169 170 171 172 173 174 175 176 177
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).

178
For example to read from a file @file{input.mpeg} with @command{ffmpeg}
Stefano Sabatini's avatar
Stefano Sabatini committed
179 180 181 182 183
use the command:
@example
ffmpeg -i file:input.mpeg output.mpeg
@end example

184 185 186 187 188 189 190 191 192 193 194 195 196 197
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
198 199
@section ftp

200
FTP (File Transfer Protocol).
Lukasz Marek's avatar
Lukasz Marek committed
201

202
Read from or write to remote resources using FTP protocol.
Lukasz Marek's avatar
Lukasz Marek committed
203 204 205 206 207 208 209 210 211 212

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
213
Set timeout in microseconds of socket I/O operations used by the underlying low level
Lukasz Marek's avatar
Lukasz Marek committed
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
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.

232 233 234 235 236 237 238 239 240 241 242
This protocol accepts the following options:

@table @option
@item follow
If set to 1, the protocol will retry reading at the end of the file, allowing
reading files that still are being written. In order for this to terminate,
you either need to use the rw_timeout option, or use the interrupt callback
(for API users).

@end table

Stefano Sabatini's avatar
Stefano Sabatini committed
243 244 245 246
@section gopher

Gopher protocol.

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
@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

262 263 264 265 266
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
267 268
@section http

269
HTTP (Hyper Text Transfer Protocol).
Stefano Sabatini's avatar
Stefano Sabatini committed
270

271
This protocol accepts the following options:
272 273 274 275 276

@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,
277 278
if set to -1 it will try to autodetect if it is seekable. Default
value is -1.
279 280

@item chunked_post
281
If set to 1 use chunked Transfer-Encoding for posts, default is 1.
282

283
@item content_type
284
Set a specific content type for the POST messages or for listen mode.
285

286 287 288
@item http_proxy
set HTTP proxy to tunnel through e.g. http://example.com:1234

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

293 294 295 296 297 298
@item multiple_requests
Use persistent connections if set to 1, default is 0.

@item post_data
Set custom HTTP post data.

299
@item user_agent
300 301
Override the User-Agent header. If not specified the protocol will use a
string describing the libavformat build. ("Lavf/<version>")
302

303 304 305
@item user-agent
This is a deprecated option, you can use user_agent instead it.

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

311
@item reconnect_at_eof
312
If set then eof is treated like an error and causes reconnection, this is useful
313 314 315 316 317
for live / endless streams.

@item reconnect_streamed
If set then even streamed/non seekable streams will be reconnected on errors.

318 319 320
@item reconnect_delay_max
Sets the maximum delay in seconds after which to give up reconnecting

321
@item mime_type
322
Export the MIME type.
323

324 325 326 327
@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.
328
The default is 1.
329 330

@item icy_metadata_headers
331 332
If the server supports ICY metadata, this contains the ICY-specific HTTP reply
headers, separated by newline characters.
333 334 335

@item icy_metadata_packet
If the server supports ICY metadata, and @option{icy} was set to 1, this
336 337 338
contains the last non-empty metadata packet sent by the server. It should be
polled in regular intervals by applications interested in mid-stream metadata
updates.
339

340 341 342 343
@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.
344

345 346 347 348 349
@item offset
Set initial byte offset.

@item end_offset
Try to limit the request to bytes preceding this offset.
350

351 352 353 354 355 356 357 358 359 360
@item method
When used as a client option it sets the HTTP method for the request.

When used as a server option it sets the HTTP method that is going to be
expected from the client(s).
If the expected and the received HTTP method do not match the client will
be given a Bad Request response.
When unset the HTTP method is not checked for now. This will be replaced by
autodetection in the future.

361
@item listen
362 363 364
If set to 1 enables experimental HTTP server. This can be used to send data when
used as an output option, or read data from a client with HTTP POST when used as
an input option.
365
If set to 2 enables experimental multi-client HTTP server. This is not yet implemented
366
in ffmpeg.c or ffserver.c and thus must not be used as a command line option.
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
@example
# Server side (sending):
ffmpeg -i somefile.ogg -c copy -listen 1 -f ogg http://@var{server}:@var{port}

# Client side (receiving):
ffmpeg -i http://@var{server}:@var{port} -c copy somefile.ogg

# Client can also be done with wget:
wget http://@var{server}:@var{port} -O somefile.ogg

# Server side (receiving):
ffmpeg -listen 1 -i http://@var{server}:@var{port} -c copy somefile.ogg

# Client side (sending):
ffmpeg -i somefile.ogg -chunked_post 0 -c copy -f ogg http://@var{server}:@var{port}

# Client can also be done with wget:
wget --post-file=somefile.ogg http://@var{server}:@var{port}
@end example

387 388
@end table

389 390 391 392 393 394 395 396 397 398 399 400 401 402
@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

403 404
@section Icecast

405
Icecast protocol (stream to Icecast servers)
Marvin Scholz's avatar
Marvin Scholz committed
406 407

This protocol accepts the following options:
408 409 410

@table @option
@item ice_genre
Marvin Scholz's avatar
Marvin Scholz committed
411
Set the stream genre.
412 413

@item ice_name
Marvin Scholz's avatar
Marvin Scholz committed
414
Set the stream name.
415 416

@item ice_description
Marvin Scholz's avatar
Marvin Scholz committed
417
Set the stream description.
418 419

@item ice_url
Marvin Scholz's avatar
Marvin Scholz committed
420
Set the stream website URL.
421 422 423

@item ice_public
Set if the stream should be public.
Marvin Scholz's avatar
Marvin Scholz committed
424
The default is 0 (not public).
425

Marvin Scholz's avatar
Marvin Scholz committed
426 427 428
@item user_agent
Override the User-Agent header. If not specified a string of the form
"Lavf/<version>" will be used.
429

Marvin Scholz's avatar
Marvin Scholz committed
430 431
@item password
Set the Icecast mountpoint password.
432 433

@item content_type
Marvin Scholz's avatar
Marvin Scholz committed
434 435
Set the stream content type. This must be set if it is different from
audio/mpeg.
436

Marvin Scholz's avatar
Marvin Scholz committed
437 438 439
@item legacy_icecast
This enables support for Icecast versions < 2.4.0, that do not support the
HTTP PUT method but the SOURCE method.
440 441 442 443 444 445 446

@end table

@example
icecast://[@var{username}[:@var{password}]@@]@var{server}:@var{port}/@var{mountpoint}
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
447 448 449 450
@section mmst

MMS (Microsoft Media Server) protocol over TCP.

451 452 453 454 455 456 457 458 459
@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
460 461 462 463
@section md5

MD5 output protocol.

464 465 466
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
467 468 469

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

473
# Write the MD5 hash of the encoded AVI file to stdout.
Stefano Sabatini's avatar
Stefano Sabatini committed
474 475 476
ffmpeg -i input.flv -f avi -y md5:
@end example

477
Note that some formats (typically MOV) require the output protocol to
Stefano Sabatini's avatar
Stefano Sabatini committed
478 479 480 481 482 483
be seekable, so they will fail with the MD5 output protocol.

@section pipe

UNIX pipe access protocol.

484
Read and write from UNIX pipes.
Stefano Sabatini's avatar
Stefano Sabatini committed
485 486 487 488 489 490 491

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

@var{number} is the number corresponding to the file descriptor of the
492 493 494
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
495

496
For example to read from stdin with @command{ffmpeg}:
Stefano Sabatini's avatar
Stefano Sabatini committed
497 498
@example
cat test.wav | ffmpeg -i pipe:0
499
# ...this is the same as...
Stefano Sabatini's avatar
Stefano Sabatini committed
500 501 502
cat test.wav | ffmpeg -i pipe:
@end example

503
For writing to stdout with @command{ffmpeg}:
Stefano Sabatini's avatar
Stefano Sabatini committed
504 505
@example
ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
506
# ...this is the same as...
Stefano Sabatini's avatar
Stefano Sabatini committed
507 508 509
ffmpeg -i test.wav -f avi pipe: | cat > test.avi
@end example

510 511 512 513 514 515 516 517 518 519
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

520
Note that some formats (typically MOV), require the output protocol to
Stefano Sabatini's avatar
Stefano Sabatini committed
521 522
be seekable, so they will fail with the pipe output protocol.

523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
@section prompeg

Pro-MPEG Code of Practice #3 Release 2 FEC protocol.

The Pro-MPEG CoP#3 FEC is a 2D parity-check forward error correction mechanism
for MPEG-2 Transport Streams sent over RTP.

This protocol must be used in conjunction with the @code{rtp_mpegts} muxer and
the @code{rtp} protocol.

The required syntax is:
@example
-f rtp_mpegts -fec prompeg=@var{option}=@var{val}... rtp://@var{hostname}:@var{port}
@end example

The destination UDP ports are @code{port + 2} for the column FEC stream
and @code{port + 4} for the row FEC stream.

This protocol accepts the following options:
@table @option

@item l=@var{n}
The number of columns (4-20, LxD <= 100)

@item d=@var{n}
The number of rows (4-20, LxD <= 100)

@end table

Example usage:

@example
-f rtp_mpegts -fec prompeg=l=8:d=4 rtp://@var{hostname}:@var{port}
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
558 559 560 561
@section rtmp

Real-Time Messaging Protocol.

562 563
The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
content across a TCP/IP network.
Stefano Sabatini's avatar
Stefano Sabatini committed
564 565 566

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

570
The accepted parameters are:
Stefano Sabatini's avatar
Stefano Sabatini committed
571 572
@table @option

573 574 575 576 577 578
@item username
An optional username (mostly for publishing).

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

Stefano Sabatini's avatar
Stefano Sabatini committed
579
@item server
580
The address of the RTMP server.
Stefano Sabatini's avatar
Stefano Sabatini committed
581 582

@item port
583
The number of the TCP port to use (by default is 1935).
Stefano Sabatini's avatar
Stefano Sabatini committed
584 585

@item app
586 587
It is the name of the application to access. It usually corresponds to
the path where the application is installed on the RTMP server
588 589
(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
590 591 592

@item playpath
It is the path or name of the resource to play with reference to the
593 594 595 596
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.

597 598 599 600 601
@item listen
Act as a server, listening for an incoming connection.

@item timeout
Maximum time to wait for the incoming connection. Implies listen.
602 603 604 605 606 607 608 609 610 611
@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.

612 613 614
@item rtmp_buffer
Set the client buffer time in milliseconds. The default is 3000.

615 616 617 618 619 620 621 622 623 624 625 626
@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.

627 628
@item rtmp_flashver
Version of the Flash plugin used to run the SWF player. The default
629 630
is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible;
<libavformat version>).)
631

632 633 634 635
@item rtmp_flush_interval
Number of packets flushed in the same request (RTMPT only). The default
is 10.

636 637 638 639 640 641 642 643
@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}.

644 645 646 647
@item rtmp_pageurl
URL of the web page in which the media was embedded. By default no
value will be sent.

648 649 650 651
@item rtmp_playpath
Stream identifier to play or to publish. This option overrides the
parameter specified in the URI.

652 653 654 655 656
@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.

657 658 659 660 661 662
@item rtmp_swfhash
SHA256 hash of the decompressed SWF file (32 bytes).

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

663 664 665
@item rtmp_swfurl
URL of the SWF player for the media. By default no value will be sent.

666 667 668
@item rtmp_swfverify
URL to player swf file, compute hash/size automatically.

669
@item rtmp_tcurl
670
URL of the target stream. Defaults to proto://host[:port]/app.
Stefano Sabatini's avatar
Stefano Sabatini committed
671 672 673

@end table

674
For example to read with @command{ffplay} a multimedia resource named
Stefano Sabatini's avatar
Stefano Sabatini committed
675 676 677 678 679
"sample" from the application "vod" from an RTMP server "myserver":
@example
ffplay rtmp://myserver/vod/sample
@end example

680 681 682
To publish to a password protected server, passing the playpath and
app names separately:
@example
683
ffmpeg -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@@myserver/
684 685
@end example

Samuel Pitoiset's avatar
Samuel Pitoiset committed
686 687 688 689 690 691 692 693 694
@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
695 696 697 698 699 700 701
@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
702 703 704 705 706 707 708 709
@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.

710 711 712 713 714 715 716 717
@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.

718 719 720 721 722 723 724 725
@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.

726 727
@section libsmbclient

728
libsmbclient permits one to manipulate CIFS/SMB network resources.
729 730 731 732 733 734 735 736 737 738 739

Following syntax is required.

@example
smb://[[domain:]user[:password@@]]server[/share[/path[/file]]]
@end example

This protocol accepts the following options.

@table @option
@item timeout
740
Set timeout in milliseconds of socket I/O operations used by the underlying
741 742 743 744 745 746 747 748 749 750 751 752 753 754
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.

@item workgroup
Set the workgroup used for making connections. By default workgroup is not specified.

@end table

For more information see: @url{http://www.samba.org/}.

755 756 757 758
@section libssh

Secure File Transfer Protocol via libssh

759
Read from or write to remote resources using SFTP protocol.
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778

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.

779 780 781 782
@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.

783 784 785 786 787 788 789 790
@end table

Example: Play a file stored on remote server.

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

791
@section librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte
Stefano Sabatini's avatar
Stefano Sabatini committed
792 793 794 795

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

796
Requires the presence of the librtmp headers and library during
797
configuration. You need to explicitly configure the build with
Stefano Sabatini's avatar
Stefano Sabatini committed
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
"--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
814
meaning as specified for the RTMP native protocol.
Stefano Sabatini's avatar
Stefano Sabatini committed
815 816 817
@var{options} contains a list of space-separated options of the form
@var{key}=@var{val}.

818
See the librtmp manual page (man 3 librtmp) for more information.
Stefano Sabatini's avatar
Stefano Sabatini committed
819 820

For example, to stream a file in real-time to an RTMP server using
821
@command{ffmpeg}:
Stefano Sabatini's avatar
Stefano Sabatini committed
822 823 824 825
@example
ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
@end example

826
To play the same stream using @command{ffplay}:
Stefano Sabatini's avatar
Stefano Sabatini committed
827 828 829 830 831 832
@example
ffplay "rtmp://myserver/live/mystream live=1"
@end example

@section rtp

833
Real-time Transport Protocol.
Stefano Sabatini's avatar
Stefano Sabatini committed
834

835 836 837 838 839 840 841 842 843 844
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}
845
Set the TTL (Time-To-Live) value (for multicast only).
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872

@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).

873 874 875 876 877
@item localport=@var{n}
Set the local RTP port to @var{n}.

This is a deprecated option. Instead, @option{localrtpport} should be
used.
878 879 880 881 882 883 884 885

@end table

Important notes:

@enumerate

@item
886
If @option{rtcpport} is not set the RTCP port will be set to the RTP
887 888 889
port value plus 1.

@item
890
If @option{localrtpport} (the local RTP port) is not set any available
891 892 893 894
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
895
set to the local RTP port value plus 1.
896 897
@end enumerate

898 899
@section rtsp

900 901
Real-Time Streaming Protocol.

902 903 904 905 906 907 908
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
909
@uref{https://github.com/revmischa/rtsp-server, RTSP server}).
910 911 912

The required syntax for a RTSP url is:
@example
913
rtsp://@var{hostname}[:@var{port}]/@var{path}
914 915
@end example

916 917 918
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}.
919

920
The following options are supported.
921

922
@table @option
923 924 925
@item initial_pause
Do not start playing the stream immediately if set to 1. Default value
is 0.
926

927
@item rtsp_transport
Moritz Barsnick's avatar
Moritz Barsnick committed
928
Set RTSP transport protocols.
929 930 931

It accepts the following values:
@table @samp
932 933 934 935 936 937 938
@item udp
Use UDP as lower transport protocol.

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

939
@item udp_multicast
940 941 942 943 944 945 946 947 948
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).
949
For the muxer, only the @samp{tcp} and @samp{udp} options are supported.
950

951 952
@item rtsp_flags
Set RTSP flags.
953

954 955
The following values are accepted:
@table @samp
956 957
@item filter_src
Accept packets only from negotiated peer address and port.
Jordi Ortiz's avatar
Jordi Ortiz committed
958 959
@item listen
Act as a server, listening for an incoming connection.
960 961
@item prefer_tcp
Try TCP for RTP transport first, if TCP is available as RTSP RTP transport.
962 963
@end table

964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
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.

Moritz Barsnick's avatar
Moritz Barsnick committed
987
A value of -1 means infinite (default). This option implies the
988 989 990 991 992 993
@option{rtsp_flags} set to @samp{listen}.

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

@item stimeout
Moritz Barsnick's avatar
Moritz Barsnick committed
994
Set socket TCP I/O timeout in microseconds.
995 996

@item user-agent
Moritz Barsnick's avatar
Moritz Barsnick committed
997
Override User-Agent header. If not specified, it defaults to the
998 999 1000
libavformat identifier string.
@end table

1001
When receiving data over UDP, the demuxer tries to reorder received packets
1002 1003 1004
(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).
1005

1006
When watching multi-bitrate Real-RTSP streams with @command{ffplay}, the
1007 1008 1009 1010
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}.

1011
@subsection Examples
1012

1013 1014
The following examples all make use of the @command{ffplay} and
@command{ffmpeg} tools.
1015

1016 1017 1018
@itemize
@item
Watch a stream over UDP, with a max reordering delay of 0.5 seconds:
1019
@example
1020
ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
1021 1022
@end example

1023 1024
@item
Watch a stream tunneled over HTTP:
1025
@example
1026
ffplay -rtsp_transport http rtsp://server/video.mp4
1027 1028
@end example

1029 1030
@item
Send a stream in realtime to a RTSP server, for others to watch:
1031 1032 1033 1034
@example
ffmpeg -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
@end example

1035 1036
@item
Receive a stream in realtime:
Jordi Ortiz's avatar
Jordi Ortiz committed
1037
@example
1038
ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
Jordi Ortiz's avatar
Jordi Ortiz committed
1039
@end example
1040
@end itemize
1041

Martin Storsjö's avatar
Martin Storsjö committed
1042 1043 1044
@section sap

Session Announcement Protocol (RFC 2974). This is not technically a
Martin Storsjö's avatar
Martin Storsjö committed
1045
protocol handler in libavformat, it is a muxer and demuxer.
Martin Storsjö's avatar
Martin Storsjö committed
1046 1047 1048
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
1049 1050
@subsection Muxer

Martin Storsjö's avatar
Martin Storsjö committed
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
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
1082 1083
The RTP stack in libavformat for receiving requires all streams to be sent
on unique ports.
Martin Storsjö's avatar
Martin Storsjö committed
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
@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

1094
Similarly, for watching in @command{ffplay}:
Martin Storsjö's avatar
Martin Storsjö committed
1095 1096 1097 1098 1099

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

1100
And for watching in @command{ffplay}, over IPv6:
Martin Storsjö's avatar
Martin Storsjö committed
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133

@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
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
@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

1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
@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

1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
@section subfile

Virtually extract a segment of a file or another stream.
The underlying stream must be seekable.

Accepted options:
@table @option
@item start
Start offset of the extracted segment, in bytes.
@item end
End offset of the extracted segment, in bytes.
@end table

Examples:

Extract a chapter from a DVD VOB file (start and end sectors obtained
externally and multiplied by 2048):
@example
subfile,,start,153391104,end,268142592,,:/media/dvd/VIDEO_TS/VTS_08_1.VOB
@end example

Play an AVI file directly from a TAR archive:
1200
@example
1201
subfile,,start,183241728,end,366490624,,:archive.tar
1202
@end example
1203

1204 1205
@section tee

1206
Writes the output to multiple protocols. The individual outputs are separated
1207 1208 1209 1210 1211 1212
by |

@example
tee:file://path/to/local/this.avi|file://path/to/local/that.avi
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
1213 1214
@section tcp

1215
Transmission Control Protocol.
Stefano Sabatini's avatar
Stefano Sabatini committed
1216

1217 1218 1219 1220 1221
The required syntax for a TCP url is:
@example
tcp://@var{hostname}:@var{port}[?@var{options}]
@end example

1222 1223
@var{options} contains a list of &-separated options of the form
@var{key}=@var{val}.
1224

1225 1226 1227 1228 1229
The list of supported options follows.

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

1231
@item timeout=@var{microseconds}
1232
Set raise error timeout, expressed in microseconds.
1233

1234 1235 1236
This option is only relevant in read mode: if no data arrived in more
than this time interval, raise error.

1237 1238
@item listen_timeout=@var{milliseconds}
Set listen timeout, expressed in milliseconds.
1239 1240 1241 1242 1243 1244

@item recv_buffer_size=@var{bytes}
Set receive buffer size, expressed bytes.

@item send_buffer_size=@var{bytes}
Set send buffer size, expressed bytes.
1245 1246 1247 1248
@end table

The following example shows how to setup a listening TCP connection
with @command{ffmpeg}, which is then accessed with @command{ffplay}:
1249 1250 1251 1252 1253
@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
1254 1255
@section tls

1256
Transport Layer Security (TLS) / Secure Sockets Layer (SSL)
Peter Ross's avatar
Peter Ross committed
1257 1258 1259 1260 1261 1262

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

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

Peter Ross's avatar
Peter Ross committed
1266 1267
@table @option

1268
@item ca_file, cafile=@var{filename}
1269 1270 1271 1272
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.
1273
The file must be in OpenSSL PEM format.
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285

@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.

1286
@item cert_file, cert=@var{filename}
1287 1288 1289 1290 1291
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.)

1292
@item key_file, key=@var{filename}
1293 1294 1295 1296 1297
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
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314

@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
1315 1316 1317 1318
@section udp

User Datagram Protocol.

1319
The required syntax for an UDP URL is:
1320 1321 1322 1323
@example
udp://@var{hostname}:@var{port}[?@var{options}]
@end example

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

1326
In case threading is enabled on the system, a circular buffer is used
1327
to store the incoming data, which allows one to reduce loss of data due to
1328 1329 1330
UDP socket buffer overruns. The @var{fifo_size} and
@var{overrun_nonfatal} options are related to this buffer.

1331
The list of supported options follows.
1332 1333 1334

@table @option
@item buffer_size=@var{size}
1335 1336
Set the UDP maximum socket buffer size in bytes. This is used to set either
the receive or send buffer size, depending on what the socket is used for.
1337
Default is 64KB.  See also @var{fifo_size}.
1338

1339 1340 1341 1342 1343 1344 1345
@item bitrate=@var{bitrate}
If set to nonzero, the output will have the specified constant bitrate if the
input has enough packets to sustain it.

@item burst_bits=@var{bits}
When using @var{bitrate} this specifies the maximum number of bits in
packet bursts.
1346

1347
@item localport=@var{port}
1348
Override the local UDP port to bind with.
1349

1350 1351 1352 1353 1354
@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.

1355
@item pkt_size=@var{size}
1356
Set the size in bytes of UDP packets.
1357 1358

@item reuse=@var{1|0}
1359
Explicitly allow or disallow reusing UDP sockets.
1360 1361

@item ttl=@var{ttl}
1362
Set the time to live value (for multicast only).
1363 1364 1365

@item connect=@var{1|0}
Initialize the UDP socket with @code{connect()}. In this case, the
1366
destination address can't be changed with ff_udp_set_remote_url later.
1367
If the destination address isn't known at the start, this option can
1368
be specified in ff_udp_set_remote_url, too.
1369 1370 1371
This allows finding out the source address for the packets with getsockname,
and makes writes return with AVERROR(ECONNREFUSED) if "destination
unreachable" is received.
1372 1373
For receiving, this gives the benefit of only receiving packets from
the specified peer address/port.
1374 1375 1376 1377 1378 1379 1380 1381

@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.
1382 1383 1384 1385 1386 1387 1388 1389

@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.
1390 1391

@item timeout=@var{microseconds}
1392 1393 1394 1395
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.
1396 1397 1398 1399 1400 1401

@item broadcast=@var{1|0}
Explicitly allow or disallow UDP broadcasting.

Note that broadcasting may not work properly on networks having
a broadcast storm protection.
1402 1403
@end table

1404
@subsection Examples
1405

1406 1407 1408
@itemize
@item
Use @command{ffmpeg} to stream over UDP to a remote endpoint:
1409 1410 1411 1412
@example
ffmpeg -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
@end example

1413 1414 1415
@item
Use @command{ffmpeg} to stream in mpegts format over UDP using 188
sized UDP packets, using a large input buffer:
1416 1417 1418 1419
@example
ffmpeg -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
@end example

1420 1421
@item
Use @command{ffmpeg} to receive over UDP from a remote endpoint:
1422
@example
1423
ffmpeg -i udp://[@var{multicast-address}]:@var{port} ...
1424
@end example
1425
@end itemize
1426

1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446
@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
1447
@c man end PROTOCOLS