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

4
Protocols are configured elements in Libav which allow to access
Stefano Sabatini's avatar
Stefano Sabatini committed
5 6
resources which require the use of a particular protocol.

7
When you configure your Libav 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

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}".

17
The option "-protocols" of the av* tools will display the list of
18
supported protocols.
Stefano Sabatini's avatar
Stefano Sabatini committed
19 20 21 22 23 24 25

A description of the currently available protocols follows.

@section concat

Physical concatenation protocol.

26 27
Allow to read and seek from many resource in sequence as if they were
a unique resource.
Stefano Sabatini's avatar
Stefano Sabatini committed
28

29
A URL accepted by this protocol has the syntax:
Stefano Sabatini's avatar
Stefano Sabatini committed
30 31 32 33 34 35 36 37 38
@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},
39
@file{split2.mpeg}, @file{split3.mpeg} with @command{avplay} use the
Stefano Sabatini's avatar
Stefano Sabatini committed
40 41
command:
@example
Anton Khirnov's avatar
Anton Khirnov committed
42
avplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
Stefano Sabatini's avatar
Stefano Sabatini committed
43 44 45 46 47 48 49 50 51 52 53
@end example

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

@section file

File access protocol.

Allow to read from or read to a file.

54
For example to read from a file @file{input.mpeg} with @command{avconv}
Stefano Sabatini's avatar
Stefano Sabatini committed
55 56
use the command:
@example
57
avconv -i file:input.mpeg output.mpeg
Stefano Sabatini's avatar
Stefano Sabatini committed
58 59
@end example

60
The av* tools default to the file protocol, that is a resource
61 62
specified with the name "FILE.mpeg" is interpreted as the URL
"file:FILE.mpeg".
Stefano Sabatini's avatar
Stefano Sabatini committed
63 64 65 66 67

@section gopher

Gopher protocol.

68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
@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

83 84 85 86 87
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
88 89
@section http

90
HTTP (Hyper Text Transfer Protocol).
Stefano Sabatini's avatar
Stefano Sabatini committed
91

92 93 94
This protocol accepts the following options:

@table @option
95 96 97
@item chunked_post
If set to 1 use chunked Transfer-Encoding for posts, default is 1.

98 99 100
@item content_type
Set a specific content type for the POST messages.

101 102 103 104 105 106 107 108 109 110
@item headers
Set custom HTTP headers, can override built in default headers. The
value must be a string encoding the headers.

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

@item post_data
Set custom HTTP post data.

111 112 113 114
@item user_agent
Override the User-Agent header. If not specified a string of the form
"Lavf/<version>" will be used.

115 116 117
@item mime_type
Export the MIME type.

118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
@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 by 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. It should be
polled in regular intervals by applications interested in mid-stream metadata
updates.
133 134 135 136 137 138

@item offset
Set initial byte offset.

@item end_offset
Try to limit the request to bytes preceding this offset.
139 140
@end table

Stefano Sabatini's avatar
Stefano Sabatini committed
141 142 143 144
@section mmst

MMS (Microsoft Media Server) protocol over TCP.

145 146 147 148 149 150 151 152 153
@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
154 155 156 157
@section md5

MD5 output protocol.

158 159 160
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
161 162 163

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

167
# Write the MD5 hash of the encoded AVI file to stdout.
168
avconv -i input.flv -f avi -y md5:
Stefano Sabatini's avatar
Stefano Sabatini committed
169 170
@end example

171
Note that some formats (typically MOV) require the output protocol to
Stefano Sabatini's avatar
Stefano Sabatini committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185
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
186 187 188
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
189

190
For example to read from stdin with @command{avconv}:
Stefano Sabatini's avatar
Stefano Sabatini committed
191
@example
192
cat test.wav | avconv -i pipe:0
193
# ...this is the same as...
194
cat test.wav | avconv -i pipe:
Stefano Sabatini's avatar
Stefano Sabatini committed
195 196
@end example

197
For writing to stdout with @command{avconv}:
Stefano Sabatini's avatar
Stefano Sabatini committed
198
@example
199
avconv -i test.wav -f avi pipe:1 | cat > test.avi
200
# ...this is the same as...
201
avconv -i test.wav -f avi pipe: | cat > test.avi
Stefano Sabatini's avatar
Stefano Sabatini committed
202 203
@end example

204
Note that some formats (typically MOV), require the output protocol to
Stefano Sabatini's avatar
Stefano Sabatini committed
205 206 207 208 209 210
be seekable, so they will fail with the pipe output protocol.

@section rtmp

Real-Time Messaging Protocol.

211 212
The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
content across a TCP/IP network.
Stefano Sabatini's avatar
Stefano Sabatini committed
213 214 215

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

219
The accepted parameters are:
Stefano Sabatini's avatar
Stefano Sabatini committed
220 221
@table @option

222 223 224 225 226 227
@item username
An optional username (mostly for publishing).

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

Stefano Sabatini's avatar
Stefano Sabatini committed
228
@item server
229
The address of the RTMP server.
Stefano Sabatini's avatar
Stefano Sabatini committed
230 231

@item port
232
The number of the TCP port to use (by default is 1935).
Stefano Sabatini's avatar
Stefano Sabatini committed
233 234

@item app
235 236
It is the name of the application to access. It usually corresponds to
the path where the application is installed on the RTMP server
237 238
(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
239 240 241

@item playpath
It is the path or name of the resource to play with reference to the
242 243 244 245
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.

246 247 248 249 250
@item listen
Act as a server, listening for an incoming connection.

@item timeout
Maximum time to wait for the incoming connection. Implies listen.
251 252 253 254 255 256 257 258 259 260
@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.

261 262 263
@item rtmp_buffer
Set the client buffer time in milliseconds. The default is 3000.

264 265 266 267 268 269 270 271 272 273 274 275
@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.

276 277
@item rtmp_flashver
Version of the Flash plugin used to run the SWF player. The default
278 279
is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible;
<libavformat version>).)
280

281 282 283 284
@item rtmp_flush_interval
Number of packets flushed in the same request (RTMPT only). The default
is 10.

285 286 287 288 289 290 291 292
@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}.

293 294 295 296
@item rtmp_pageurl
URL of the web page in which the media was embedded. By default no
value will be sent.

297 298 299 300
@item rtmp_playpath
Stream identifier to play or to publish. This option overrides the
parameter specified in the URI.

301 302 303 304 305
@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.

306 307 308 309 310 311
@item rtmp_swfhash
SHA256 hash of the decompressed SWF file (32 bytes).

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

312 313 314
@item rtmp_swfurl
URL of the SWF player for the media. By default no value will be sent.

315 316 317
@item rtmp_swfverify
URL to player swf file, compute hash/size automatically.

318
@item rtmp_tcurl
319
URL of the target stream. Defaults to proto://host[:port]/app.
Stefano Sabatini's avatar
Stefano Sabatini committed
320 321 322

@end table

323
For example to read with @command{avplay} a multimedia resource named
Stefano Sabatini's avatar
Stefano Sabatini committed
324 325
"sample" from the application "vod" from an RTMP server "myserver":
@example
Anton Khirnov's avatar
Anton Khirnov committed
326
avplay rtmp://myserver/vod/sample
Stefano Sabatini's avatar
Stefano Sabatini committed
327 328
@end example

329 330 331 332 333 334
To publish to a password protected server, passing the playpath and
app names separately:
@example
avconv -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@@myserver/
@end example

Samuel Pitoiset's avatar
Samuel Pitoiset committed
335 336 337 338 339 340 341 342 343
@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
344 345 346 347 348 349 350
@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
351 352 353 354 355 356 357 358
@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.

359 360 361 362 363 364 365 366
@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.

367 368 369 370 371 372 373 374
@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.

375
@section librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte
Stefano Sabatini's avatar
Stefano Sabatini committed
376 377 378 379

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

380
Requires the presence of the librtmp headers and library during
381
configuration. You need to explicitly configure the build with
Stefano Sabatini's avatar
Stefano Sabatini committed
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
"--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
398
meaning as specified for the RTMP native protocol.
Stefano Sabatini's avatar
Stefano Sabatini committed
399 400 401
@var{options} contains a list of space-separated options of the form
@var{key}=@var{val}.

402
See the librtmp manual page (man 3 librtmp) for more information.
Stefano Sabatini's avatar
Stefano Sabatini committed
403 404

For example, to stream a file in real-time to an RTMP server using
405
@command{avconv}:
Stefano Sabatini's avatar
Stefano Sabatini committed
406
@example
407
avconv -re -i myfile -f flv rtmp://myserver/live/mystream
Stefano Sabatini's avatar
Stefano Sabatini committed
408 409
@end example

410
To play the same stream using @command{avplay}:
Stefano Sabatini's avatar
Stefano Sabatini committed
411
@example
Anton Khirnov's avatar
Anton Khirnov committed
412
avplay "rtmp://myserver/live/mystream live=1"
Stefano Sabatini's avatar
Stefano Sabatini committed
413 414 415 416 417 418
@end example

@section rtp

Real-Time Protocol.

419 420 421 422 423 424 425 426 427
@section rtsp

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
428
@uref{http://github.com/revmischa/rtsp-server, RTSP server}).
429 430 431

The required syntax for a RTSP url is:
@example
432
rtsp://@var{hostname}[:@var{port}]/@var{path}
433 434
@end example

435
The following options (set on the @command{avconv}/@command{avplay} command
436
line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
437 438
are supported:

439 440
Flags for @code{rtsp_transport}:

441 442 443 444 445 446 447 448 449
@table @option

@item udp
Use UDP as lower transport protocol.

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

450
@item udp_multicast
451 452 453 454 455 456 457 458 459 460 461
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).
For the muxer, only the @code{tcp} and @code{udp} options are supported.

462 463 464 465 466
Flags for @code{rtsp_flags}:

@table @option
@item filter_src
Accept packets only from negotiated peer address and port.
Jordi Ortiz's avatar
Jordi Ortiz committed
467 468
@item listen
Act as a server, listening for an incoming connection.
469 470
@end table

471
When receiving data over UDP, the demuxer tries to reorder received packets
472 473 474
(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).
475

476
When watching multi-bitrate Real-RTSP streams with @command{avplay}, the
477 478 479 480 481 482 483 484 485
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}.

Example command lines:

To watch a stream over UDP, with a max reordering delay of 0.5 seconds:

@example
486
avplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
487 488 489 490 491
@end example

To watch a stream tunneled over HTTP:

@example
492
avplay -rtsp_transport http rtsp://server/video.mp4
493 494 495 496 497
@end example

To send a stream in realtime to a RTSP server, for others to watch:

@example
498
avconv -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
499 500
@end example

Jordi Ortiz's avatar
Jordi Ortiz committed
501 502 503 504 505 506
To receive a stream in realtime:

@example
avconv -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
@end example

Martin Storsjö's avatar
Martin Storsjö committed
507 508 509
@section sap

Session Announcement Protocol (RFC 2974). This is not technically a
Martin Storsjö's avatar
Martin Storsjö committed
510
protocol handler in libavformat, it is a muxer and demuxer.
Martin Storsjö's avatar
Martin Storsjö committed
511 512 513
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
514 515
@subsection Muxer

Martin Storsjö's avatar
Martin Storsjö committed
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
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
547 548
The RTP stack in libavformat for receiving requires all streams to be sent
on unique ports.
Martin Storsjö's avatar
Martin Storsjö committed
549 550 551 552 553 554 555
@end table

Example command lines follow.

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

@example
556
avconv -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
Martin Storsjö's avatar
Martin Storsjö committed
557 558
@end example

Anton Khirnov's avatar
Anton Khirnov committed
559
Similarly, for watching in avplay:
Martin Storsjö's avatar
Martin Storsjö committed
560 561

@example
562
avconv -re -i @var{input} -f sap sap://224.0.0.255
Martin Storsjö's avatar
Martin Storsjö committed
563 564
@end example

Anton Khirnov's avatar
Anton Khirnov committed
565
And for watching in avplay, over IPv6:
Martin Storsjö's avatar
Martin Storsjö committed
566 567

@example
568
avconv -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
Martin Storsjö's avatar
Martin Storsjö committed
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
@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
Anton Khirnov's avatar
Anton Khirnov committed
590
avplay sap://
Martin Storsjö's avatar
Martin Storsjö committed
591 592 593 594 595
@end example

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

@example
Anton Khirnov's avatar
Anton Khirnov committed
596
avplay sap://[ff0e::2:7ffe]
Martin Storsjö's avatar
Martin Storsjö committed
597 598
@end example

Stefano Sabatini's avatar
Stefano Sabatini committed
599 600 601 602
@section tcp

Trasmission Control Protocol.

603 604 605 606 607 608 609 610 611 612 613
The required syntax for a TCP url is:
@example
tcp://@var{hostname}:@var{port}[?@var{options}]
@end example

@table @option

@item listen
Listen for an incoming connection

@example
614
avconv -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
Anton Khirnov's avatar
Anton Khirnov committed
615
avplay tcp://@var{hostname}:@var{port}
616 617 618 619
@end example

@end table

620 621 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 649 650
@section tls

Transport Layer Security (TLS) / Secure Sockets Layer (SSL)

The required syntax for a TLS url is:
@example
tls://@var{hostname}:@var{port}
@end example

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

@table @option

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

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

651 652 653 654 655 656 657 658 659 660 661 662 663
@item cert_file
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.)

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

664 665
@end table

Stefano Sabatini's avatar
Stefano Sabatini committed
666 667 668 669
@section udp

User Datagram Protocol.

670 671 672 673 674
The required syntax for a UDP url is:
@example
udp://@var{hostname}:@var{port}[?@var{options}]
@end example

Diego Biurrun's avatar
Diego Biurrun committed
675
@var{options} contains a list of &-separated options of the form @var{key}=@var{val}.
676 677 678 679 680 681 682 683 684 685
Follow the list of supported options.

@table @option

@item buffer_size=@var{size}
set the UDP buffer size in bytes

@item localport=@var{port}
override the local UDP port to bind with

686 687 688 689 690
@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.

691 692 693 694 695 696 697 698
@item pkt_size=@var{size}
set the size in bytes of UDP packets

@item reuse=@var{1|0}
explicitly allow or disallow reusing UDP sockets

@item ttl=@var{ttl}
set the time to live value (for multicast only)
699 700 701

@item connect=@var{1|0}
Initialize the UDP socket with @code{connect()}. In this case, the
702
destination address can't be changed with ff_udp_set_remote_url later.
703
If the destination address isn't known at the start, this option can
704
be specified in ff_udp_set_remote_url, too.
705 706 707
This allows finding out the source address for the packets with getsockname,
and makes writes return with AVERROR(ECONNREFUSED) if "destination
unreachable" is received.
708 709
For receiving, this gives the benefit of only receiving packets from
the specified peer address/port.
710 711 712 713 714 715 716 717

@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.
718 719
@end table

720
Some usage examples of the udp protocol with @command{avconv} follow.
721 722 723

To stream over UDP to a remote endpoint:
@example
724
avconv -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
725 726 727 728
@end example

To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer:
@example
729
avconv -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
730 731 732 733
@end example

To receive over UDP from a remote endpoint:
@example
734
avconv -i udp://[@var{multicast-address}]:@var{port}
735 736
@end example

737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
@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
757
@c man end PROTOCOLS