doc/protocols.texi

   1 @chapter Protocols
   2 @c man begin PROTOCOLS
   3
   4 Protocols are configured elements in FFmpeg that enable access to
   5 resources that require specific protocols.
   6
   7 When you configure your FFmpeg build, all the supported protocols are
   8 enabled by default. You can list all available ones using the
   9 configure option "--list-protocols".
  10
  11 You can disable all the protocols using the configure option
  12 "--disable-protocols", and selectively enable a protocol using the
  13 option "--enable-protocol=@var{PROTOCOL}", or you can disable a
  14 particular protocol using the option
  15 "--disable-protocol=@var{PROTOCOL}".
  16
  17 The option "-protocols" of the ff* tools will display the list of
  18 supported protocols.
  19
  20 A description of the currently available protocols follows.
  21
  22 @section bluray
  23
  24 Read BluRay playlist.
  25
  26 The accepted options are:
  27 @table @option
  28
  29 @item angle
  30 BluRay angle
  31
  32 @item chapter
  33 Start chapter (1...N)
  34
  35 @item playlist
  36 Playlist to read (BDMV/PLAYLIST/?????.mpls)
  37
  38 @end table
  39
  40 Examples:
  41
  42 Read longest playlist from BluRay mounted to /mnt/bluray:
  43 @example
  44 bluray:/mnt/bluray
  45 @end example
  46
  47 Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2:
  48 @example
  49 -playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray
  50 @end example
  51
  52 @section cache
  53
  54 Caching wrapper for input stream.
  55
  56 Cache the input stream to temporary file. It brings seeking capability to live streams.
  57
  58 @example
  59 cache:@var{URL}
  60 @end example
  61
  62 @section concat
  63
  64 Physical concatenation protocol.
  65
  66 Allow to read and seek from many resource in sequence as if they were
  67 a unique resource.
  68
  69 A URL accepted by this protocol has the syntax:
  70 @example
  71 concat:@var{URL1}|@var{URL2}|...|@var{URLN}
  72 @end example
  73
  74 where @var{URL1}, @var{URL2}, ..., @var{URLN} are the urls of the
  75 resource to be concatenated, each one possibly specifying a distinct
  76 protocol.
  77
  78 For example to read a sequence of files @file{split1.mpeg},
  79 @file{split2.mpeg}, @file{split3.mpeg} with @command{ffplay} use the
  80 command:
  81 @example
  82 ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
  83 @end example
  84
  85 Note that you may need to escape the character "|" which is special for
  86 many shells.
  87
  88 @section crypto
  89
  90 AES-encrypted stream reading protocol.
  91
  92 The accepted options are:
  93 @table @option
  94 @item key
  95 Set the AES decryption key binary block from given hexadecimal representation.
  96
  97 @item iv
  98 Set the AES decryption initialization vector binary block from given hexadecimal representation.
  99 @end table
 100
 101 Accepted URL formats:
 102 @example
 103 crypto:@var{URL}
 104 crypto+@var{URL}
 105 @end example
 106
 107 @section data
 108
 109 Data in-line in the URI. See @url{http://en.wikipedia.org/wiki/Data_URI_scheme}.
 110
 111 For example, to convert a GIF file given inline with @command{ffmpeg}:
 112 @example
 113 ffmpeg -i "data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=" smiley.png
 114 @end example
 115
 116 @section file
 117
 118 File access protocol.
 119
 120 Allow to read from or read to a file.
 121
 122 For example to read from a file @file{input.mpeg} with @command{ffmpeg}
 123 use the command:
 124 @example
 125 ffmpeg -i file:input.mpeg output.mpeg
 126 @end example
 127
 128 The ff* tools default to the file protocol, that is a resource
 129 specified with the name "FILE.mpeg" is interpreted as the URL
 130 "file:FILE.mpeg".
 131
 132 This protocol accepts the following options:
 133
 134 @table @option
 135 @item truncate
 136 Truncate existing files on write, if set to 1. A value of 0 prevents
 137 truncating. Default value is 1.
 138
 139 @item blocksize
 140 Set I/O operation maximum block size, in bytes. Default value is
 141 @code{INT_MAX}, which results in not limiting the requested block size.
 142 Setting this value reasonably low improves user termination request reaction
 143 time, which is valuable for files on slow medium.
 144 @end table
 145
 146 @section ftp
 147
 148 FTP (File Transfer Protocol).
 149
 150 Allow to read from or write to remote resources using FTP protocol.
 151
 152 Following syntax is required.
 153 @example
 154 ftp://[user[:password]@@]server[:port]/path/to/remote/resource.mpeg
 155 @end example
 156
 157 This protocol accepts the following options.
 158
 159 @table @option
 160 @item timeout
 161 Set timeout of socket I/O operations used by the underlying low level
 162 operation. By default it is set to -1, which means that the timeout is
 163 not specified.
 164
 165 @item ftp-anonymous-password
 166 Password used when login as anonymous user. Typically an e-mail address
 167 should be used.
 168
 169 @item ftp-write-seekable
 170 Control seekability of connection during encoding. If set to 1 the
 171 resource is supposed to be seekable, if set to 0 it is assumed not
 172 to be seekable. Default value is 0.
 173 @end table
 174
 175 NOTE: Protocol can be used as output, but it is recommended to not do
 176 it, unless special care is taken (tests, customized server configuration
 177 etc.). Different FTP servers behave in different way during seek
 178 operation. ff* tools may produce incomplete content due to server limitations.
 179
 180 @section gopher
 181
 182 Gopher protocol.
 183
 184 @section hls
 185
 186 Read Apple HTTP Live Streaming compliant segmented stream as
 187 a uniform one. The M3U8 playlists describing the segments can be
 188 remote HTTP resources or local files, accessed using the standard
 189 file protocol.
 190 The nested protocol is declared by specifying
 191 "+@var{proto}" after the hls URI scheme name, where @var{proto}
 192 is either "file" or "http".
 193
 194 @example
 195 hls+http://host/path/to/remote/resource.m3u8
 196 hls+file://path/to/local/resource.m3u8
 197 @end example
 198
 199 Using this protocol is discouraged - the hls demuxer should work
 200 just as well (if not, please report the issues) and is more complete.
 201 To use the hls demuxer instead, simply use the direct URLs to the
 202 m3u8 files.
 203
 204 @section http
 205
 206 HTTP (Hyper Text Transfer Protocol).
 207
 208 This protocol accepts the following options.
 209
 210 @table @option
 211 @item seekable
 212 Control seekability of connection. If set to 1 the resource is
 213 supposed to be seekable, if set to 0 it is assumed not to be seekable,
 214 if set to -1 it will try to autodetect if it is seekable. Default
 215 value is -1.
 216
 217 @item chunked_post
 218 If set to 1 use chunked transfer-encoding for posts, default is 1.
 219
 220 @item headers
 221 Set custom HTTP headers, can override built in default headers. The
 222 value must be a string encoding the headers.
 223
 224 @item content_type
 225 Force a content type.
 226
 227 @item user-agent
 228 Override User-Agent header. If not specified the protocol will use a
 229 string describing the libavformat build.
 230
 231 @item multiple_requests
 232 Use persistent connections if set to 1. By default it is 0.
 233
 234 @item post_data
 235 Set custom HTTP post data.
 236
 237 @item timeout
 238 Set timeout of socket I/O operations used by the underlying low level
 239 operation. By default it is set to -1, which means that the timeout is
 240 not specified.
 241
 242 @item mime_type
 243 Set MIME type.
 244
 245 @item icy
 246 If set to 1 request ICY (SHOUTcast) metadata from the server. If the server
 247 supports this, the metadata has to be retrieved by the application by reading
 248 the @option{icy_metadata_headers} and @option{icy_metadata_packet} options.
 249 The default is 0.
 250
 251 @item icy_metadata_headers
 252 If the server supports ICY metadata, this contains the ICY specific HTTP reply
 253 headers, separated with newline characters.
 254
 255 @item icy_metadata_packet
 256 If the server supports ICY metadata, and @option{icy} was set to 1, this
 257 contains the last non-empty metadata packet sent by the server.
 258
 259 @item cookies
 260 Set the cookies to be sent in future requests. The format of each cookie is the
 261 same as the value of a Set-Cookie HTTP response field. Multiple cookies can be
 262 delimited by a newline character.
 263 @end table
 264
 265 @subsection HTTP Cookies
 266
 267 Some HTTP requests will be denied unless cookie values are passed in with the
 268 request. The @option{cookies} option allows these cookies to be specified. At
 269 the very least, each cookie must specify a value along with a path and domain.
 270 HTTP requests that match both the domain and path will automatically include the
 271 cookie value in the HTTP Cookie header field. Multiple cookies can be delimited
 272 by a newline.
 273
 274 The required syntax to play a stream specifying a cookie is:
 275 @example
 276 ffplay -cookies "nlqptid=nltid=tsn; path=/; domain=somedomain.com;" http://somedomain.com/somestream.m3u8
 277 @end example
 278
 279 @section mmst
 280
 281 MMS (Microsoft Media Server) protocol over TCP.
 282
 283 @section mmsh
 284
 285 MMS (Microsoft Media Server) protocol over HTTP.
 286
 287 The required syntax is:
 288 @example
 289 mmsh://@var{server}[:@var{port}][/@var{app}][/@var{playpath}]
 290 @end example
 291
 292 @section md5
 293
 294 MD5 output protocol.
 295
 296 Computes the MD5 hash of the data to be written, and on close writes
 297 this to the designated output or stdout if none is specified. It can
 298 be used to test muxers without writing an actual file.
 299
 300 Some examples follow.
 301 @example
 302 # Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
 303 ffmpeg -i input.flv -f avi -y md5:output.avi.md5
 304
 305 # Write the MD5 hash of the encoded AVI file to stdout.
 306 ffmpeg -i input.flv -f avi -y md5:
 307 @end example
 308
 309 Note that some formats (typically MOV) require the output protocol to
 310 be seekable, so they will fail with the MD5 output protocol.
 311
 312 @section pipe
 313
 314 UNIX pipe access protocol.
 315
 316 Allow to read and write from UNIX pipes.
 317
 318 The accepted syntax is:
 319 @example
 320 pipe:[@var{number}]
 321 @end example
 322
 323 @var{number} is the number corresponding to the file descriptor of the
 324 pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).  If @var{number}
 325 is not specified, by default the stdout file descriptor will be used
 326 for writing, stdin for reading.
 327
 328 For example to read from stdin with @command{ffmpeg}:
 329 @example
 330 cat test.wav | ffmpeg -i pipe:0
 331 # ...this is the same as...
 332 cat test.wav | ffmpeg -i pipe:
 333 @end example
 334
 335 For writing to stdout with @command{ffmpeg}:
 336 @example
 337 ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
 338 # ...this is the same as...
 339 ffmpeg -i test.wav -f avi pipe: | cat > test.avi
 340 @end example
 341
 342 This protocol accepts the following options:
 343
 344 @table @option
 345 @item blocksize
 346 Set I/O operation maximum block size, in bytes. Default value is
 347 @code{INT_MAX}, which results in not limiting the requested block size.
 348 Setting this value reasonably low improves user termination request reaction
 349 time, which is valuable if data transmission is slow.
 350 @end table
 351
 352 Note that some formats (typically MOV), require the output protocol to
 353 be seekable, so they will fail with the pipe output protocol.
 354
 355 @section rtmp
 356
 357 Real-Time Messaging Protocol.
 358
 359 The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
 360 content across a TCP/IP network.
 361
 362 The required syntax is:
 363 @example
 364 rtmp://[@var{username}:@var{password}@@]@var{server}[:@var{port}][/@var{app}][/@var{instance}][/@var{playpath}]
 365 @end example
 366
 367 The accepted parameters are:
 368 @table @option
 369
 370 @item username
 371 An optional username (mostly for publishing).
 372
 373 @item password
 374 An optional password (mostly for publishing).
 375
 376 @item server
 377 The address of the RTMP server.
 378
 379 @item port
 380 The number of the TCP port to use (by default is 1935).
 381
 382 @item app
 383 It is the name of the application to access. It usually corresponds to
 384 the path where the application is installed on the RTMP server
 385 (e.g. @file{/ondemand/}, @file{/flash/live/}, etc.). You can override
 386 the value parsed from the URI through the @code{rtmp_app} option, too.
 387
 388 @item playpath
 389 It is the path or name of the resource to play with reference to the
 390 application specified in @var{app}, may be prefixed by "mp4:". You
 391 can override the value parsed from the URI through the @code{rtmp_playpath}
 392 option, too.
 393
 394 @item listen
 395 Act as a server, listening for an incoming connection.
 396
 397 @item timeout
 398 Maximum time to wait for the incoming connection. Implies listen.
 399 @end table
 400
 401 Additionally, the following parameters can be set via command line options
 402 (or in code via @code{AVOption}s):
 403 @table @option
 404
 405 @item rtmp_app
 406 Name of application to connect on the RTMP server. This option
 407 overrides the parameter specified in the URI.
 408
 409 @item rtmp_buffer
 410 Set the client buffer time in milliseconds. The default is 3000.
 411
 412 @item rtmp_conn
 413 Extra arbitrary AMF connection parameters, parsed from a string,
 414 e.g. like @code{B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0}.
 415 Each value is prefixed by a single character denoting the type,
 416 B for Boolean, N for number, S for string, O for object, or Z for null,
 417 followed by a colon. For Booleans the data must be either 0 or 1 for
 418 FALSE or TRUE, respectively.  Likewise for Objects the data must be 0 or
 419 1 to end or begin an object, respectively. Data items in subobjects may
 420 be named, by prefixing the type with 'N' and specifying the name before
 421 the value (i.e. @code{NB:myFlag:1}). This option may be used multiple
 422 times to construct arbitrary AMF sequences.
 423
 424 @item rtmp_flashver
 425 Version of the Flash plugin used to run the SWF player. The default
 426 is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible;
 427 <libavformat version>).)
 428
 429 @item rtmp_flush_interval
 430 Number of packets flushed in the same request (RTMPT only). The default
 431 is 10.
 432
 433 @item rtmp_live
 434 Specify that the media is a live stream. No resuming or seeking in
 435 live streams is possible. The default value is @code{any}, which means the
 436 subscriber first tries to play the live stream specified in the
 437 playpath. If a live stream of that name is not found, it plays the
 438 recorded stream. The other possible values are @code{live} and
 439 @code{recorded}.
 440
 441 @item rtmp_pageurl
 442 URL of the web page in which the media was embedded. By default no
 443 value will be sent.
 444
 445 @item rtmp_playpath
 446 Stream identifier to play or to publish. This option overrides the
 447 parameter specified in the URI.
 448
 449 @item rtmp_subscribe
 450 Name of live stream to subscribe to. By default no value will be sent.
 451 It is only sent if the option is specified or if rtmp_live
 452 is set to live.
 453
 454 @item rtmp_swfhash
 455 SHA256 hash of the decompressed SWF file (32 bytes).
 456
 457 @item rtmp_swfsize
 458 Size of the decompressed SWF file, required for SWFVerification.
 459
 460 @item rtmp_swfurl
 461 URL of the SWF player for the media. By default no value will be sent.
 462
 463 @item rtmp_swfverify
 464 URL to player swf file, compute hash/size automatically.
 465
 466 @item rtmp_tcurl
 467 URL of the target stream. Defaults to proto://host[:port]/app.
 468
 469 @end table
 470
 471 For example to read with @command{ffplay} a multimedia resource named
 472 "sample" from the application "vod" from an RTMP server "myserver":
 473 @example
 474 ffplay rtmp://myserver/vod/sample
 475 @end example
 476
 477 To publish to a password protected server, passing the playpath and
 478 app names separately:
 479 @example
 480 ffmpeg -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@@myserver/
 481 @end example
 482
 483 @section rtmpe
 484
 485 Encrypted Real-Time Messaging Protocol.
 486
 487 The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
 488 streaming multimedia content within standard cryptographic primitives,
 489 consisting of Diffie-Hellman key exchange and HMACSHA256, generating
 490 a pair of RC4 keys.
 491
 492 @section rtmps
 493
 494 Real-Time Messaging Protocol over a secure SSL connection.
 495
 496 The Real-Time Messaging Protocol (RTMPS) is used for streaming
 497 multimedia content across an encrypted connection.
 498
 499 @section rtmpt
 500
 501 Real-Time Messaging Protocol tunneled through HTTP.
 502
 503 The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
 504 for streaming multimedia content within HTTP requests to traverse
 505 firewalls.
 506
 507 @section rtmpte
 508
 509 Encrypted Real-Time Messaging Protocol tunneled through HTTP.
 510
 511 The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
 512 is used for streaming multimedia content within HTTP requests to traverse
 513 firewalls.
 514
 515 @section rtmpts
 516
 517 Real-Time Messaging Protocol tunneled through HTTPS.
 518
 519 The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
 520 for streaming multimedia content within HTTPS requests to traverse
 521 firewalls.
 522
 523 @section libssh
 524
 525 Secure File Transfer Protocol via libssh
 526
 527 Allow to read from or write to remote resources using SFTP protocol.
 528
 529 Following syntax is required.
 530
 531 @example
 532 sftp://[user[:password]@@]server[:port]/path/to/remote/resource.mpeg
 533 @end example
 534
 535 This protocol accepts the following options.
 536
 537 @table @option
 538 @item timeout
 539 Set timeout of socket I/O operations used by the underlying low level
 540 operation. By default it is set to -1, which means that the timeout
 541 is not specified.
 542
 543 @item truncate
 544 Truncate existing files on write, if set to 1. A value of 0 prevents
 545 truncating. Default value is 1.
 546
 547 @end table
 548
 549 Example: Play a file stored on remote server.
 550
 551 @example
 552 ffplay sftp://user:password@@server_address:22/home/user/resource.mpeg
 553 @end example
 554
 555 @section librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte
 556
 557 Real-Time Messaging Protocol and its variants supported through
 558 librtmp.
 559
 560 Requires the presence of the librtmp headers and library during
 561 configuration. You need to explicitly configure the build with
 562 "--enable-librtmp". If enabled this will replace the native RTMP
 563 protocol.
 564
 565 This protocol provides most client functions and a few server
 566 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
 567 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
 568 variants of these encrypted types (RTMPTE, RTMPTS).
 569
 570 The required syntax is:
 571 @example
 572 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
 573 @end example
 574
 575 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
 576 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
 577 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
 578 meaning as specified for the RTMP native protocol.
 579 @var{options} contains a list of space-separated options of the form
 580 @var{key}=@var{val}.
 581
 582 See the librtmp manual page (man 3 librtmp) for more information.
 583
 584 For example, to stream a file in real-time to an RTMP server using
 585 @command{ffmpeg}:
 586 @example
 587 ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
 588 @end example
 589
 590 To play the same stream using @command{ffplay}:
 591 @example
 592 ffplay "rtmp://myserver/live/mystream live=1"
 593 @end example
 594
 595 @section rtp
 596
 597 Real-time Transport Protocol.
 598
 599 The required syntax for an RTP URL is:
 600 rtp://@var{hostname}[:@var{port}][?@var{option}=@var{val}...]
 601
 602 @var{port} specifies the RTP port to use.
 603
 604 The following URL options are supported:
 605
 606 @table @option
 607
 608 @item ttl=@var{n}
 609 Set the TTL (Time-To-Live) value (for multicast only).
 610
 611 @item rtcpport=@var{n}
 612 Set the remote RTCP port to @var{n}.
 613
 614 @item localrtpport=@var{n}
 615 Set the local RTP port to @var{n}.
 616
 617 @item localrtcpport=@var{n}'
 618 Set the local RTCP port to @var{n}.
 619
 620 @item pkt_size=@var{n}
 621 Set max packet size (in bytes) to @var{n}.
 622
 623 @item connect=0|1
 624 Do a @code{connect()} on the UDP socket (if set to 1) or not (if set
 625 to 0).
 626
 627 @item sources=@var{ip}[,@var{ip}]
 628 List allowed source IP addresses.
 629
 630 @item block=@var{ip}[,@var{ip}]
 631 List disallowed (blocked) source IP addresses.
 632
 633 @item write_to_source=0|1
 634 Send packets to the source address of the latest received packet (if
 635 set to 1) or to a default remote address (if set to 0).
 636
 637 @item localport=@var{n}
 638 Set the local RTP port to @var{n}.
 639
 640 This is a deprecated option. Instead, @option{localrtpport} should be
 641 used.
 642
 643 @end table
 644
 645 Important notes:
 646
 647 @enumerate
 648
 649 @item
 650 If @option{rtcpport} is not set the RTCP port will be set to the RTP
 651 port value plus 1.
 652
 653 @item
 654 If @option{localrtpport} (the local RTP port) is not set any available
 655 port will be used for the local RTP and RTCP ports.
 656
 657 @item
 658 If @option{localrtcpport} (the local RTCP port) is not set it will be
 659 set to the the local RTP port value plus 1.
 660 @end enumerate
 661
 662 @section rtsp
 663
 664 RTSP is not technically a protocol handler in libavformat, it is a demuxer
 665 and muxer. The demuxer supports both normal RTSP (with data transferred
 666 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
 667 data transferred over RDT).
 668
 669 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
 670 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
 671 @uref{http://github.com/revmischa/rtsp-server, RTSP server}).
 672
 673 The required syntax for a RTSP url is:
 674 @example
 675 rtsp://@var{hostname}[:@var{port}]/@var{path}
 676 @end example
 677
 678 The following options (set on the @command{ffmpeg}/@command{ffplay} command
 679 line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
 680 are supported:
 681
 682 Flags for @code{rtsp_transport}:
 683
 684 @table @option
 685
 686 @item udp
 687 Use UDP as lower transport protocol.
 688
 689 @item tcp
 690 Use TCP (interleaving within the RTSP control channel) as lower
 691 transport protocol.
 692
 693 @item udp_multicast
 694 Use UDP multicast as lower transport protocol.
 695
 696 @item http
 697 Use HTTP tunneling as lower transport protocol, which is useful for
 698 passing proxies.
 699 @end table
 700
 701 Multiple lower transport protocols may be specified, in that case they are
 702 tried one at a time (if the setup of one fails, the next one is tried).
 703 For the muxer, only the @code{tcp} and @code{udp} options are supported.
 704
 705 Flags for @code{rtsp_flags}:
 706
 707 @table @option
 708 @item filter_src
 709 Accept packets only from negotiated peer address and port.
 710 @item listen
 711 Act as a server, listening for an incoming connection.
 712 @end table
 713
 714 When receiving data over UDP, the demuxer tries to reorder received packets
 715 (since they may arrive out of order, or packets may get lost totally). This
 716 can be disabled by setting the maximum demuxing delay to zero (via
 717 the @code{max_delay} field of AVFormatContext).
 718
 719 When watching multi-bitrate Real-RTSP streams with @command{ffplay}, the
 720 streams to display can be chosen with @code{-vst} @var{n} and
 721 @code{-ast} @var{n} for video and audio respectively, and can be switched
 722 on the fly by pressing @code{v} and @code{a}.
 723
 724 Example command lines:
 725
 726 To watch a stream over UDP, with a max reordering delay of 0.5 seconds:
 727
 728 @example
 729 ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
 730 @end example
 731
 732 To watch a stream tunneled over HTTP:
 733
 734 @example
 735 ffplay -rtsp_transport http rtsp://server/video.mp4
 736 @end example
 737
 738 To send a stream in realtime to a RTSP server, for others to watch:
 739
 740 @example
 741 ffmpeg -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
 742 @end example
 743
 744 To receive a stream in realtime:
 745
 746 @example
 747 ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
 748 @end example
 749
 750 @table @option
 751 @item stimeout
 752 Socket IO timeout in micro seconds.
 753 @end table
 754
 755 @section sap
 756
 757 Session Announcement Protocol (RFC 2974). This is not technically a
 758 protocol handler in libavformat, it is a muxer and demuxer.
 759 It is used for signalling of RTP streams, by announcing the SDP for the
 760 streams regularly on a separate port.
 761
 762 @subsection Muxer
 763
 764 The syntax for a SAP url given to the muxer is:
 765 @example
 766 sap://@var{destination}[:@var{port}][?@var{options}]
 767 @end example
 768
 769 The RTP packets are sent to @var{destination} on port @var{port},
 770 or to port 5004 if no port is specified.
 771 @var{options} is a @code{&}-separated list. The following options
 772 are supported:
 773
 774 @table @option
 775
 776 @item announce_addr=@var{address}
 777 Specify the destination IP address for sending the announcements to.
 778 If omitted, the announcements are sent to the commonly used SAP
 779 announcement multicast address 224.2.127.254 (sap.mcast.net), or
 780 ff0e::2:7ffe if @var{destination} is an IPv6 address.
 781
 782 @item announce_port=@var{port}
 783 Specify the port to send the announcements on, defaults to
 784 9875 if not specified.
 785
 786 @item ttl=@var{ttl}
 787 Specify the time to live value for the announcements and RTP packets,
 788 defaults to 255.
 789
 790 @item same_port=@var{0|1}
 791 If set to 1, send all RTP streams on the same port pair. If zero (the
 792 default), all streams are sent on unique ports, with each stream on a
 793 port 2 numbers higher than the previous.
 794 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
 795 The RTP stack in libavformat for receiving requires all streams to be sent
 796 on unique ports.
 797 @end table
 798
 799 Example command lines follow.
 800
 801 To broadcast a stream on the local subnet, for watching in VLC:
 802
 803 @example
 804 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
 805 @end example
 806
 807 Similarly, for watching in @command{ffplay}:
 808
 809 @example
 810 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255
 811 @end example
 812
 813 And for watching in @command{ffplay}, over IPv6:
 814
 815 @example
 816 ffmpeg -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
 817 @end example
 818
 819 @subsection Demuxer
 820
 821 The syntax for a SAP url given to the demuxer is:
 822 @example
 823 sap://[@var{address}][:@var{port}]
 824 @end example
 825
 826 @var{address} is the multicast address to listen for announcements on,
 827 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
 828 is the port that is listened on, 9875 if omitted.
 829
 830 The demuxers listens for announcements on the given address and port.
 831 Once an announcement is received, it tries to receive that particular stream.
 832
 833 Example command lines follow.
 834
 835 To play back the first stream announced on the normal SAP multicast address:
 836
 837 @example
 838 ffplay sap://
 839 @end example
 840
 841 To play back the first stream announced on one the default IPv6 SAP multicast address:
 842
 843 @example
 844 ffplay sap://[ff0e::2:7ffe]
 845 @end example
 846
 847 @section sctp
 848
 849 Stream Control Transmission Protocol.
 850
 851 The accepted URL syntax is:
 852 @example
 853 sctp://@var{host}:@var{port}[?@var{options}]
 854 @end example
 855
 856 The protocol accepts the following options:
 857 @table @option
 858 @item listen
 859 If set to any value, listen for an incoming connection. Outgoing connection is done by default.
 860
 861 @item max_streams
 862 Set the maximum number of streams. By default no limit is set.
 863 @end table
 864
 865 @section srtp
 866
 867 Secure Real-time Transport Protocol.
 868
 869 The accepted options are:
 870 @table @option
 871 @item srtp_in_suite
 872 @item srtp_out_suite
 873 Select input and output encoding suites.
 874
 875 Supported values:
 876 @table @samp
 877 @item AES_CM_128_HMAC_SHA1_80
 878 @item SRTP_AES128_CM_HMAC_SHA1_80
 879 @item AES_CM_128_HMAC_SHA1_32
 880 @item SRTP_AES128_CM_HMAC_SHA1_32
 881 @end table
 882
 883 @item srtp_in_params
 884 @item srtp_out_params
 885 Set input and output encoding parameters, which are expressed by a
 886 base64-encoded representation of a binary block. The first 16 bytes of
 887 this binary block are used as master key, the following 14 bytes are
 888 used as master salt.
 889 @end table
 890
 891 @section tcp
 892
 893 Trasmission Control Protocol.
 894
 895 The required syntax for a TCP url is:
 896 @example
 897 tcp://@var{hostname}:@var{port}[?@var{options}]
 898 @end example
 899
 900 @table @option
 901
 902 @item listen
 903 Listen for an incoming connection
 904
 905 @item timeout=@var{microseconds}
 906 In read mode: if no data arrived in more than this time interval, raise error.
 907 In write mode: if socket cannot be written in more than this time interval, raise error.
 908 This also sets timeout on TCP connection establishing.
 909
 910 @example
 911 ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
 912 ffplay tcp://@var{hostname}:@var{port}
 913 @end example
 914
 915 @end table
 916
 917 @section tls
 918
 919 Transport Layer Security (TLS) / Secure Sockets Layer (SSL)
 920
 921 The required syntax for a TLS/SSL url is:
 922 @example
 923 tls://@var{hostname}:@var{port}[?@var{options}]
 924 @end example
 925
 926 The following parameters can be set via command line options
 927 (or in code via @code{AVOption}s):
 928
 929 @table @option
 930
 931 @item ca_file, cafile=@var{filename}
 932 A file containing certificate authority (CA) root certificates to treat
 933 as trusted. If the linked TLS library contains a default this might not
 934 need to be specified for verification to work, but not all libraries and
 935 setups have defaults built in.
 936 The file must be in OpenSSL PEM format.
 937
 938 @item tls_verify=@var{1|0}
 939 If enabled, try to verify the peer that we are communicating with.
 940 Note, if using OpenSSL, this currently only makes sure that the
 941 peer certificate is signed by one of the root certificates in the CA
 942 database, but it does not validate that the certificate actually
 943 matches the host name we are trying to connect to. (With GnuTLS,
 944 the host name is validated as well.)
 945
 946 This is disabled by default since it requires a CA database to be
 947 provided by the caller in many cases.
 948
 949 @item cert_file, cert=@var{filename}
 950 A file containing a certificate to use in the handshake with the peer.
 951 (When operating as server, in listen mode, this is more often required
 952 by the peer, while client certificates only are mandated in certain
 953 setups.)
 954
 955 @item key_file, key=@var{filename}
 956 A file containing the private key for the certificate.
 957
 958 @item listen=@var{1|0}
 959 If enabled, listen for connections on the provided port, and assume
 960 the server role in the handshake instead of the client role.
 961
 962 @end table
 963
 964 Example command lines:
 965
 966 To create a TLS/SSL server that serves an input stream.
 967
 968 @example
 969 ffmpeg -i @var{input} -f @var{format} tls://@var{hostname}:@var{port}?listen&cert=@var{server.crt}&key=@var{server.key}
 970 @end example
 971
 972 To play back a stream from the TLS/SSL server using @command{ffplay}:
 973
 974 @example
 975 ffplay tls://@var{hostname}:@var{port}
 976 @end example
 977
 978 @section udp
 979
 980 User Datagram Protocol.
 981
 982 The required syntax for a UDP url is:
 983 @example
 984 udp://@var{hostname}:@var{port}[?@var{options}]
 985 @end example
 986
 987 @var{options} contains a list of &-separated options of the form @var{key}=@var{val}.
 988
 989 In case threading is enabled on the system, a circular buffer is used
 990 to store the incoming data, which allows to reduce loss of data due to
 991 UDP socket buffer overruns. The @var{fifo_size} and
 992 @var{overrun_nonfatal} options are related to this buffer.
 993
 994 The list of supported options follows.
 995
 996 @table @option
 997
 998 @item buffer_size=@var{size}
 999 Set the UDP socket buffer size in bytes. This is used both for the
1000 receiving and the sending buffer size.
1001
1002 @item localport=@var{port}
1003 Override the local UDP port to bind with.
1004
1005 @item localaddr=@var{addr}
1006 Choose the local IP address. This is useful e.g. if sending multicast
1007 and the host has multiple interfaces, where the user can choose
1008 which interface to send on by specifying the IP address of that interface.
1009
1010 @item pkt_size=@var{size}
1011 Set the size in bytes of UDP packets.
1012
1013 @item reuse=@var{1|0}
1014 Explicitly allow or disallow reusing UDP sockets.
1015
1016 @item ttl=@var{ttl}
1017 Set the time to live value (for multicast only).
1018
1019 @item connect=@var{1|0}
1020 Initialize the UDP socket with @code{connect()}. In this case, the
1021 destination address can't be changed with ff_udp_set_remote_url later.
1022 If the destination address isn't known at the start, this option can
1023 be specified in ff_udp_set_remote_url, too.
1024 This allows finding out the source address for the packets with getsockname,
1025 and makes writes return with AVERROR(ECONNREFUSED) if "destination
1026 unreachable" is received.
1027 For receiving, this gives the benefit of only receiving packets from
1028 the specified peer address/port.
1029
1030 @item sources=@var{address}[,@var{address}]
1031 Only receive packets sent to the multicast group from one of the
1032 specified sender IP addresses.
1033
1034 @item block=@var{address}[,@var{address}]
1035 Ignore packets sent to the multicast group from the specified
1036 sender IP addresses.
1037
1038 @item fifo_size=@var{units}
1039 Set the UDP receiving circular buffer size, expressed as a number of
1040 packets with size of 188 bytes. If not specified defaults to 7*4096.
1041
1042 @item overrun_nonfatal=@var{1|0}
1043 Survive in case of UDP receiving circular buffer overrun. Default
1044 value is 0.
1045
1046 @item timeout=@var{microseconds}
1047 In read mode: if no data arrived in more than this time interval, raise error.
1048 @end table
1049
1050 Some usage examples of the UDP protocol with @command{ffmpeg} follow.
1051
1052 To stream over UDP to a remote endpoint:
1053 @example
1054 ffmpeg -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
1055 @end example
1056
1057 To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer:
1058 @example
1059 ffmpeg -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
1060 @end example
1061
1062 To receive over UDP from a remote endpoint:
1063 @example
1064 ffmpeg -i udp://[@var{multicast-address}]:@var{port}
1065 @end example
1066
1067 @section unix
1068
1069 Unix local socket
1070
1071 The required syntax for a Unix socket URL is:
1072
1073 @example
1074 unix://@var{filepath}
1075 @end example
1076
1077 The following parameters can be set via command line options
1078 (or in code via @code{AVOption}s):
1079
1080 @table @option
1081 @item timeout
1082 Timeout in ms.
1083 @item listen
1084 Create the Unix socket in listening mode.
1085 @end table
1086
1087 @c man end PROTOCOLS