Merge commit '25c2a27c9ec0150210d75ee5ac8ed1bfa14c1a56'
[ffmpeg.git] / doc / protocols.texi
1 @chapter Protocol Options
2 @c man begin PROTOCOL OPTIONS
3
4 The libavformat library provides some generic global options, which
5 can be set on all the protocols. In addition each protocol may support
6 so-called private options, which are specific for that component.
7
8 Options may be set by specifying -@var{option} @var{value} in the
9 FFmpeg tools, or by setting the value explicitly in the
10 @code{AVFormatContext} options or using the @file{libavutil/opt.h} API
11 for programmatic use.
12
13 The list of supported options follows:
14
15 @table @option
16 @item protocol_whitelist @var{list} (@emph{input})
17 Set a ","-separated list of allowed protocols. "ALL" matches all protocols. Protocols
18 prefixed by "-" are disabled.
19 All protocols are allowed by default but protocols used by an another
20 protocol (nested protocols) are restricted to a per protocol subset.
21 @end table
22
23 @c man end PROTOCOL OPTIONS
24
25 @chapter Protocols
26 @c man begin PROTOCOLS
27
28 Protocols are configured elements in FFmpeg that enable access to
29 resources that require specific protocols.
30
31 When you configure your FFmpeg build, all the supported protocols are
32 enabled by default. You can list all available ones using the
33 configure option "--list-protocols".
34
35 You can disable all the protocols using the configure option
36 "--disable-protocols", and selectively enable a protocol using the
37 option "--enable-protocol=@var{PROTOCOL}", or you can disable a
38 particular protocol using the option
39 "--disable-protocol=@var{PROTOCOL}".
40
41 The option "-protocols" of the ff* tools will display the list of
42 supported protocols.
43
44 All protocols accept the following options:
45
46 @table @option
47 @item rw_timeout
48 Maximum time to wait for (network) read/write operations to complete,
49 in microseconds.
50 @end table
51
52 A description of the currently available protocols follows.
53
54 @section async
55
56 Asynchronous data filling wrapper for input stream.
57
58 Fill data in a background thread, to decouple I/O operation from demux thread.
59
60 @example
61 async:@var{URL}
62 async:http://host/resource
63 async:cache:http://host/resource
64 @end example
65
66 @section bluray
67
68 Read BluRay playlist.
69
70 The accepted options are:
71 @table @option
72
73 @item angle
74 BluRay angle
75
76 @item chapter
77 Start chapter (1...N)
78
79 @item playlist
80 Playlist to read (BDMV/PLAYLIST/?????.mpls)
81
82 @end table
83
84 Examples:
85
86 Read longest playlist from BluRay mounted to /mnt/bluray:
87 @example
88 bluray:/mnt/bluray
89 @end example
90
91 Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2:
92 @example
93 -playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray
94 @end example
95
96 @section cache
97
98 Caching wrapper for input stream.
99
100 Cache the input stream to temporary file. It brings seeking capability to live streams.
101
102 @example
103 cache:@var{URL}
104 @end example
105
106 @section concat
107
108 Physical concatenation protocol.
109
110 Read and seek from many resources in sequence as if they were
111 a unique resource.
112
113 A URL accepted by this protocol has the syntax:
114 @example
115 concat:@var{URL1}|@var{URL2}|...|@var{URLN}
116 @end example
117
118 where @var{URL1}, @var{URL2}, ..., @var{URLN} are the urls of the
119 resource to be concatenated, each one possibly specifying a distinct
120 protocol.
121
122 For example to read a sequence of files @file{split1.mpeg},
123 @file{split2.mpeg}, @file{split3.mpeg} with @command{ffplay} use the
124 command:
125 @example
126 ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
127 @end example
128
129 Note that you may need to escape the character "|" which is special for
130 many shells.
131
132 @section crypto
133
134 AES-encrypted stream reading protocol.
135
136 The accepted options are:
137 @table @option
138 @item key
139 Set the AES decryption key binary block from given hexadecimal representation.
140
141 @item iv
142 Set the AES decryption initialization vector binary block from given hexadecimal representation.
143 @end table
144
145 Accepted URL formats:
146 @example
147 crypto:@var{URL}
148 crypto+@var{URL}
149 @end example
150
151 @section data
152
153 Data in-line in the URI. See @url{http://en.wikipedia.org/wiki/Data_URI_scheme}.
154
155 For example, to convert a GIF file given inline with @command{ffmpeg}:
156 @example
157 ffmpeg -i "data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=" smiley.png
158 @end example
159
160 @section file
161
162 File access protocol.
163
164 Read from or write to a file.
165
166 A file URL can have the form:
167 @example
168 file:@var{filename}
169 @end example
170
171 where @var{filename} is the path of the file to read.
172
173 An URL that does not have a protocol prefix will be assumed to be a
174 file URL. Depending on the build, an URL that looks like a Windows
175 path with the drive letter at the beginning will also be assumed to be
176 a file URL (usually not the case in builds for unix-like systems).
177
178 For example to read from a file @file{input.mpeg} with @command{ffmpeg}
179 use the command:
180 @example
181 ffmpeg -i file:input.mpeg output.mpeg
182 @end example
183
184 This protocol accepts the following options:
185
186 @table @option
187 @item truncate
188 Truncate existing files on write, if set to 1. A value of 0 prevents
189 truncating. Default value is 1.
190
191 @item blocksize
192 Set I/O operation maximum block size, in bytes. Default value is
193 @code{INT_MAX}, which results in not limiting the requested block size.
194 Setting this value reasonably low improves user termination request reaction
195 time, which is valuable for files on slow medium.
196 @end table
197
198 @section ftp
199
200 FTP (File Transfer Protocol).
201
202 Read from or write to remote resources using FTP protocol.
203
204 Following syntax is required.
205 @example
206 ftp://[user[:password]@@]server[:port]/path/to/remote/resource.mpeg
207 @end example
208
209 This protocol accepts the following options.
210
211 @table @option
212 @item timeout
213 Set timeout in microseconds of socket I/O operations used by the underlying low level
214 operation. By default it is set to -1, which means that the timeout is
215 not specified.
216
217 @item ftp-anonymous-password
218 Password used when login as anonymous user. Typically an e-mail address
219 should be used.
220
221 @item ftp-write-seekable
222 Control seekability of connection during encoding. If set to 1 the
223 resource is supposed to be seekable, if set to 0 it is assumed not
224 to be seekable. Default value is 0.
225 @end table
226
227 NOTE: Protocol can be used as output, but it is recommended to not do
228 it, unless special care is taken (tests, customized server configuration
229 etc.). Different FTP servers behave in different way during seek
230 operation. ff* tools may produce incomplete content due to server limitations.
231
232 This protocol accepts the following options:
233
234 @table @option
235 @item follow
236 If set to 1, the protocol will retry reading at the end of the file, allowing
237 reading files that still are being written. In order for this to terminate,
238 you either need to use the rw_timeout option, or use the interrupt callback
239 (for API users).
240
241 @end table
242
243 @section gopher
244
245 Gopher protocol.
246
247 @section hls
248
249 Read Apple HTTP Live Streaming compliant segmented stream as
250 a uniform one. The M3U8 playlists describing the segments can be
251 remote HTTP resources or local files, accessed using the standard
252 file protocol.
253 The nested protocol is declared by specifying
254 "+@var{proto}" after the hls URI scheme name, where @var{proto}
255 is either "file" or "http".
256
257 @example
258 hls+http://host/path/to/remote/resource.m3u8
259 hls+file://path/to/local/resource.m3u8
260 @end example
261
262 Using this protocol is discouraged - the hls demuxer should work
263 just as well (if not, please report the issues) and is more complete.
264 To use the hls demuxer instead, simply use the direct URLs to the
265 m3u8 files.
266
267 @section http
268
269 HTTP (Hyper Text Transfer Protocol).
270
271 This protocol accepts the following options:
272
273 @table @option
274 @item seekable
275 Control seekability of connection. If set to 1 the resource is
276 supposed to be seekable, if set to 0 it is assumed not to be seekable,
277 if set to -1 it will try to autodetect if it is seekable. Default
278 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 @item http_proxy
287 set HTTP proxy to tunnel through e.g. http://example.com:1234
288
289 @item headers
290 Set custom HTTP headers, can override built in default headers. The
291 value must be a string encoding the headers.
292
293 @item multiple_requests
294 Use persistent connections if set to 1, default is 0.
295
296 @item post_data
297 Set custom HTTP post data.
298
299 @item referer
300 Set the Referer header. Include 'Referer: URL' header in HTTP request.
301
302 @item user_agent
303 Override the User-Agent header. If not specified the protocol will use a
304 string describing the libavformat build. ("Lavf/<version>")
305
306 @item user-agent
307 This is a deprecated option, you can use user_agent instead it.
308
309 @item timeout
310 Set timeout in microseconds of socket I/O operations used by the underlying low level
311 operation. By default it is set to -1, which means that the timeout is
312 not specified.
313
314 @item reconnect_at_eof
315 If set then eof is treated like an error and causes reconnection, this is useful
316 for live / endless streams.
317
318 @item reconnect_streamed
319 If set then even streamed/non seekable streams will be reconnected on errors.
320
321 @item reconnect_delay_max
322 Sets the maximum delay in seconds after which to give up reconnecting
323
324 @item mime_type
325 Export the MIME type.
326
327 @item http_version
328 Exports the HTTP response version number. Usually "1.0" or "1.1".
329
330 @item icy
331 If set to 1 request ICY (SHOUTcast) metadata from the server. If the server
332 supports this, the metadata has to be retrieved by the application by reading
333 the @option{icy_metadata_headers} and @option{icy_metadata_packet} options.
334 The default is 1.
335
336 @item icy_metadata_headers
337 If the server supports ICY metadata, this contains the ICY-specific HTTP reply
338 headers, separated by newline characters.
339
340 @item icy_metadata_packet
341 If the server supports ICY metadata, and @option{icy} was set to 1, this
342 contains the last non-empty metadata packet sent by the server. It should be
343 polled in regular intervals by applications interested in mid-stream metadata
344 updates.
345
346 @item cookies
347 Set the cookies to be sent in future requests. The format of each cookie is the
348 same as the value of a Set-Cookie HTTP response field. Multiple cookies can be
349 delimited by a newline character.
350
351 @item offset
352 Set initial byte offset.
353
354 @item end_offset
355 Try to limit the request to bytes preceding this offset.
356
357 @item method
358 When used as a client option it sets the HTTP method for the request.
359
360 When used as a server option it sets the HTTP method that is going to be
361 expected from the client(s).
362 If the expected and the received HTTP method do not match the client will
363 be given a Bad Request response.
364 When unset the HTTP method is not checked for now. This will be replaced by
365 autodetection in the future.
366
367 @item listen
368 If set to 1 enables experimental HTTP server. This can be used to send data when
369 used as an output option, or read data from a client with HTTP POST when used as
370 an input option.
371 If set to 2 enables experimental multi-client HTTP server. This is not yet implemented
372 in ffmpeg.c and thus must not be used as a command line option.
373 @example
374 # Server side (sending):
375 ffmpeg -i somefile.ogg -c copy -listen 1 -f ogg http://@var{server}:@var{port}
376
377 # Client side (receiving):
378 ffmpeg -i http://@var{server}:@var{port} -c copy somefile.ogg
379
380 # Client can also be done with wget:
381 wget http://@var{server}:@var{port} -O somefile.ogg
382
383 # Server side (receiving):
384 ffmpeg -listen 1 -i http://@var{server}:@var{port} -c copy somefile.ogg
385
386 # Client side (sending):
387 ffmpeg -i somefile.ogg -chunked_post 0 -c copy -f ogg http://@var{server}:@var{port}
388
389 # Client can also be done with wget:
390 wget --post-file=somefile.ogg http://@var{server}:@var{port}
391 @end example
392
393 @end table
394
395 @subsection HTTP Cookies
396
397 Some HTTP requests will be denied unless cookie values are passed in with the
398 request. The @option{cookies} option allows these cookies to be specified. At
399 the very least, each cookie must specify a value along with a path and domain.
400 HTTP requests that match both the domain and path will automatically include the
401 cookie value in the HTTP Cookie header field. Multiple cookies can be delimited
402 by a newline.
403
404 The required syntax to play a stream specifying a cookie is:
405 @example
406 ffplay -cookies "nlqptid=nltid=tsn; path=/; domain=somedomain.com;" http://somedomain.com/somestream.m3u8
407 @end example
408
409 @section Icecast
410
411 Icecast protocol (stream to Icecast servers)
412
413 This protocol accepts the following options:
414
415 @table @option
416 @item ice_genre
417 Set the stream genre.
418
419 @item ice_name
420 Set the stream name.
421
422 @item ice_description
423 Set the stream description.
424
425 @item ice_url
426 Set the stream website URL.
427
428 @item ice_public
429 Set if the stream should be public.
430 The default is 0 (not public).
431
432 @item user_agent
433 Override the User-Agent header. If not specified a string of the form
434 "Lavf/<version>" will be used.
435
436 @item password
437 Set the Icecast mountpoint password.
438
439 @item content_type
440 Set the stream content type. This must be set if it is different from
441 audio/mpeg.
442
443 @item legacy_icecast
444 This enables support for Icecast versions < 2.4.0, that do not support the
445 HTTP PUT method but the SOURCE method.
446
447 @end table
448
449 @example
450 icecast://[@var{username}[:@var{password}]@@]@var{server}:@var{port}/@var{mountpoint}
451 @end example
452
453 @section mmst
454
455 MMS (Microsoft Media Server) protocol over TCP.
456
457 @section mmsh
458
459 MMS (Microsoft Media Server) protocol over HTTP.
460
461 The required syntax is:
462 @example
463 mmsh://@var{server}[:@var{port}][/@var{app}][/@var{playpath}]
464 @end example
465
466 @section md5
467
468 MD5 output protocol.
469
470 Computes the MD5 hash of the data to be written, and on close writes
471 this to the designated output or stdout if none is specified. It can
472 be used to test muxers without writing an actual file.
473
474 Some examples follow.
475 @example
476 # Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
477 ffmpeg -i input.flv -f avi -y md5:output.avi.md5
478
479 # Write the MD5 hash of the encoded AVI file to stdout.
480 ffmpeg -i input.flv -f avi -y md5:
481 @end example
482
483 Note that some formats (typically MOV) require the output protocol to
484 be seekable, so they will fail with the MD5 output protocol.
485
486 @section pipe
487
488 UNIX pipe access protocol.
489
490 Read and write from UNIX pipes.
491
492 The accepted syntax is:
493 @example
494 pipe:[@var{number}]
495 @end example
496
497 @var{number} is the number corresponding to the file descriptor of the
498 pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).  If @var{number}
499 is not specified, by default the stdout file descriptor will be used
500 for writing, stdin for reading.
501
502 For example to read from stdin with @command{ffmpeg}:
503 @example
504 cat test.wav | ffmpeg -i pipe:0
505 # ...this is the same as...
506 cat test.wav | ffmpeg -i pipe:
507 @end example
508
509 For writing to stdout with @command{ffmpeg}:
510 @example
511 ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
512 # ...this is the same as...
513 ffmpeg -i test.wav -f avi pipe: | cat > test.avi
514 @end example
515
516 This protocol accepts the following options:
517
518 @table @option
519 @item blocksize
520 Set I/O operation maximum block size, in bytes. Default value is
521 @code{INT_MAX}, which results in not limiting the requested block size.
522 Setting this value reasonably low improves user termination request reaction
523 time, which is valuable if data transmission is slow.
524 @end table
525
526 Note that some formats (typically MOV), require the output protocol to
527 be seekable, so they will fail with the pipe output protocol.
528
529 @section prompeg
530
531 Pro-MPEG Code of Practice #3 Release 2 FEC protocol.
532
533 The Pro-MPEG CoP#3 FEC is a 2D parity-check forward error correction mechanism
534 for MPEG-2 Transport Streams sent over RTP.
535
536 This protocol must be used in conjunction with the @code{rtp_mpegts} muxer and
537 the @code{rtp} protocol.
538
539 The required syntax is:
540 @example
541 -f rtp_mpegts -fec prompeg=@var{option}=@var{val}... rtp://@var{hostname}:@var{port}
542 @end example
543
544 The destination UDP ports are @code{port + 2} for the column FEC stream
545 and @code{port + 4} for the row FEC stream.
546
547 This protocol accepts the following options:
548 @table @option
549
550 @item l=@var{n}
551 The number of columns (4-20, LxD <= 100)
552
553 @item d=@var{n}
554 The number of rows (4-20, LxD <= 100)
555
556 @end table
557
558 Example usage:
559
560 @example
561 -f rtp_mpegts -fec prompeg=l=8:d=4 rtp://@var{hostname}:@var{port}
562 @end example
563
564 @section rtmp
565
566 Real-Time Messaging Protocol.
567
568 The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
569 content across a TCP/IP network.
570
571 The required syntax is:
572 @example
573 rtmp://[@var{username}:@var{password}@@]@var{server}[:@var{port}][/@var{app}][/@var{instance}][/@var{playpath}]
574 @end example
575
576 The accepted parameters are:
577 @table @option
578
579 @item username
580 An optional username (mostly for publishing).
581
582 @item password
583 An optional password (mostly for publishing).
584
585 @item server
586 The address of the RTMP server.
587
588 @item port
589 The number of the TCP port to use (by default is 1935).
590
591 @item app
592 It is the name of the application to access. It usually corresponds to
593 the path where the application is installed on the RTMP server
594 (e.g. @file{/ondemand/}, @file{/flash/live/}, etc.). You can override
595 the value parsed from the URI through the @code{rtmp_app} option, too.
596
597 @item playpath
598 It is the path or name of the resource to play with reference to the
599 application specified in @var{app}, may be prefixed by "mp4:". You
600 can override the value parsed from the URI through the @code{rtmp_playpath}
601 option, too.
602
603 @item listen
604 Act as a server, listening for an incoming connection.
605
606 @item timeout
607 Maximum time to wait for the incoming connection. Implies listen.
608 @end table
609
610 Additionally, the following parameters can be set via command line options
611 (or in code via @code{AVOption}s):
612 @table @option
613
614 @item rtmp_app
615 Name of application to connect on the RTMP server. This option
616 overrides the parameter specified in the URI.
617
618 @item rtmp_buffer
619 Set the client buffer time in milliseconds. The default is 3000.
620
621 @item rtmp_conn
622 Extra arbitrary AMF connection parameters, parsed from a string,
623 e.g. like @code{B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0}.
624 Each value is prefixed by a single character denoting the type,
625 B for Boolean, N for number, S for string, O for object, or Z for null,
626 followed by a colon. For Booleans the data must be either 0 or 1 for
627 FALSE or TRUE, respectively.  Likewise for Objects the data must be 0 or
628 1 to end or begin an object, respectively. Data items in subobjects may
629 be named, by prefixing the type with 'N' and specifying the name before
630 the value (i.e. @code{NB:myFlag:1}). This option may be used multiple
631 times to construct arbitrary AMF sequences.
632
633 @item rtmp_flashver
634 Version of the Flash plugin used to run the SWF player. The default
635 is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible;
636 <libavformat version>).)
637
638 @item rtmp_flush_interval
639 Number of packets flushed in the same request (RTMPT only). The default
640 is 10.
641
642 @item rtmp_live
643 Specify that the media is a live stream. No resuming or seeking in
644 live streams is possible. The default value is @code{any}, which means the
645 subscriber first tries to play the live stream specified in the
646 playpath. If a live stream of that name is not found, it plays the
647 recorded stream. The other possible values are @code{live} and
648 @code{recorded}.
649
650 @item rtmp_pageurl
651 URL of the web page in which the media was embedded. By default no
652 value will be sent.
653
654 @item rtmp_playpath
655 Stream identifier to play or to publish. This option overrides the
656 parameter specified in the URI.
657
658 @item rtmp_subscribe
659 Name of live stream to subscribe to. By default no value will be sent.
660 It is only sent if the option is specified or if rtmp_live
661 is set to live.
662
663 @item rtmp_swfhash
664 SHA256 hash of the decompressed SWF file (32 bytes).
665
666 @item rtmp_swfsize
667 Size of the decompressed SWF file, required for SWFVerification.
668
669 @item rtmp_swfurl
670 URL of the SWF player for the media. By default no value will be sent.
671
672 @item rtmp_swfverify
673 URL to player swf file, compute hash/size automatically.
674
675 @item rtmp_tcurl
676 URL of the target stream. Defaults to proto://host[:port]/app.
677
678 @end table
679
680 For example to read with @command{ffplay} a multimedia resource named
681 "sample" from the application "vod" from an RTMP server "myserver":
682 @example
683 ffplay rtmp://myserver/vod/sample
684 @end example
685
686 To publish to a password protected server, passing the playpath and
687 app names separately:
688 @example
689 ffmpeg -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@@myserver/
690 @end example
691
692 @section rtmpe
693
694 Encrypted Real-Time Messaging Protocol.
695
696 The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
697 streaming multimedia content within standard cryptographic primitives,
698 consisting of Diffie-Hellman key exchange and HMACSHA256, generating
699 a pair of RC4 keys.
700
701 @section rtmps
702
703 Real-Time Messaging Protocol over a secure SSL connection.
704
705 The Real-Time Messaging Protocol (RTMPS) is used for streaming
706 multimedia content across an encrypted connection.
707
708 @section rtmpt
709
710 Real-Time Messaging Protocol tunneled through HTTP.
711
712 The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
713 for streaming multimedia content within HTTP requests to traverse
714 firewalls.
715
716 @section rtmpte
717
718 Encrypted Real-Time Messaging Protocol tunneled through HTTP.
719
720 The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
721 is used for streaming multimedia content within HTTP requests to traverse
722 firewalls.
723
724 @section rtmpts
725
726 Real-Time Messaging Protocol tunneled through HTTPS.
727
728 The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
729 for streaming multimedia content within HTTPS requests to traverse
730 firewalls.
731
732 @section libsmbclient
733
734 libsmbclient permits one to manipulate CIFS/SMB network resources.
735
736 Following syntax is required.
737
738 @example
739 smb://[[domain:]user[:password@@]]server[/share[/path[/file]]]
740 @end example
741
742 This protocol accepts the following options.
743
744 @table @option
745 @item timeout
746 Set timeout in milliseconds of socket I/O operations used by the underlying
747 low level operation. By default it is set to -1, which means that the timeout
748 is not specified.
749
750 @item truncate
751 Truncate existing files on write, if set to 1. A value of 0 prevents
752 truncating. Default value is 1.
753
754 @item workgroup
755 Set the workgroup used for making connections. By default workgroup is not specified.
756
757 @end table
758
759 For more information see: @url{http://www.samba.org/}.
760
761 @section libssh
762
763 Secure File Transfer Protocol via libssh
764
765 Read from or write to remote resources using SFTP protocol.
766
767 Following syntax is required.
768
769 @example
770 sftp://[user[:password]@@]server[:port]/path/to/remote/resource.mpeg
771 @end example
772
773 This protocol accepts the following options.
774
775 @table @option
776 @item timeout
777 Set timeout of socket I/O operations used by the underlying low level
778 operation. By default it is set to -1, which means that the timeout
779 is not specified.
780
781 @item truncate
782 Truncate existing files on write, if set to 1. A value of 0 prevents
783 truncating. Default value is 1.
784
785 @item private_key
786 Specify the path of the file containing private key to use during authorization.
787 By default libssh searches for keys in the @file{~/.ssh/} directory.
788
789 @end table
790
791 Example: Play a file stored on remote server.
792
793 @example
794 ffplay sftp://user:password@@server_address:22/home/user/resource.mpeg
795 @end example
796
797 @section librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte
798
799 Real-Time Messaging Protocol and its variants supported through
800 librtmp.
801
802 Requires the presence of the librtmp headers and library during
803 configuration. You need to explicitly configure the build with
804 "--enable-librtmp". If enabled this will replace the native RTMP
805 protocol.
806
807 This protocol provides most client functions and a few server
808 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
809 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
810 variants of these encrypted types (RTMPTE, RTMPTS).
811
812 The required syntax is:
813 @example
814 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
815 @end example
816
817 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
818 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
819 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
820 meaning as specified for the RTMP native protocol.
821 @var{options} contains a list of space-separated options of the form
822 @var{key}=@var{val}.
823
824 See the librtmp manual page (man 3 librtmp) for more information.
825
826 For example, to stream a file in real-time to an RTMP server using
827 @command{ffmpeg}:
828 @example
829 ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
830 @end example
831
832 To play the same stream using @command{ffplay}:
833 @example
834 ffplay "rtmp://myserver/live/mystream live=1"
835 @end example
836
837 @section rtp
838
839 Real-time Transport Protocol.
840
841 The required syntax for an RTP URL is:
842 rtp://@var{hostname}[:@var{port}][?@var{option}=@var{val}...]
843
844 @var{port} specifies the RTP port to use.
845
846 The following URL options are supported:
847
848 @table @option
849
850 @item ttl=@var{n}
851 Set the TTL (Time-To-Live) value (for multicast only).
852
853 @item rtcpport=@var{n}
854 Set the remote RTCP port to @var{n}.
855
856 @item localrtpport=@var{n}
857 Set the local RTP port to @var{n}.
858
859 @item localrtcpport=@var{n}'
860 Set the local RTCP port to @var{n}.
861
862 @item pkt_size=@var{n}
863 Set max packet size (in bytes) to @var{n}.
864
865 @item connect=0|1
866 Do a @code{connect()} on the UDP socket (if set to 1) or not (if set
867 to 0).
868
869 @item sources=@var{ip}[,@var{ip}]
870 List allowed source IP addresses.
871
872 @item block=@var{ip}[,@var{ip}]
873 List disallowed (blocked) source IP addresses.
874
875 @item write_to_source=0|1
876 Send packets to the source address of the latest received packet (if
877 set to 1) or to a default remote address (if set to 0).
878
879 @item localport=@var{n}
880 Set the local RTP port to @var{n}.
881
882 This is a deprecated option. Instead, @option{localrtpport} should be
883 used.
884
885 @end table
886
887 Important notes:
888
889 @enumerate
890
891 @item
892 If @option{rtcpport} is not set the RTCP port will be set to the RTP
893 port value plus 1.
894
895 @item
896 If @option{localrtpport} (the local RTP port) is not set any available
897 port will be used for the local RTP and RTCP ports.
898
899 @item
900 If @option{localrtcpport} (the local RTCP port) is not set it will be
901 set to the local RTP port value plus 1.
902 @end enumerate
903
904 @section rtsp
905
906 Real-Time Streaming Protocol.
907
908 RTSP is not technically a protocol handler in libavformat, it is a demuxer
909 and muxer. The demuxer supports both normal RTSP (with data transferred
910 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
911 data transferred over RDT).
912
913 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
914 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
915 @uref{https://github.com/revmischa/rtsp-server, RTSP server}).
916
917 The required syntax for a RTSP url is:
918 @example
919 rtsp://@var{hostname}[:@var{port}]/@var{path}
920 @end example
921
922 Options can be set on the @command{ffmpeg}/@command{ffplay} command
923 line, or set in code via @code{AVOption}s or in
924 @code{avformat_open_input}.
925
926 The following options are supported.
927
928 @table @option
929 @item initial_pause
930 Do not start playing the stream immediately if set to 1. Default value
931 is 0.
932
933 @item rtsp_transport
934 Set RTSP transport protocols.
935
936 It accepts the following values:
937 @table @samp
938 @item udp
939 Use UDP as lower transport protocol.
940
941 @item tcp
942 Use TCP (interleaving within the RTSP control channel) as lower
943 transport protocol.
944
945 @item udp_multicast
946 Use UDP multicast as lower transport protocol.
947
948 @item http
949 Use HTTP tunneling as lower transport protocol, which is useful for
950 passing proxies.
951 @end table
952
953 Multiple lower transport protocols may be specified, in that case they are
954 tried one at a time (if the setup of one fails, the next one is tried).
955 For the muxer, only the @samp{tcp} and @samp{udp} options are supported.
956
957 @item rtsp_flags
958 Set RTSP flags.
959
960 The following values are accepted:
961 @table @samp
962 @item filter_src
963 Accept packets only from negotiated peer address and port.
964 @item listen
965 Act as a server, listening for an incoming connection.
966 @item prefer_tcp
967 Try TCP for RTP transport first, if TCP is available as RTSP RTP transport.
968 @end table
969
970 Default value is @samp{none}.
971
972 @item allowed_media_types
973 Set media types to accept from the server.
974
975 The following flags are accepted:
976 @table @samp
977 @item video
978 @item audio
979 @item data
980 @end table
981
982 By default it accepts all media types.
983
984 @item min_port
985 Set minimum local UDP port. Default value is 5000.
986
987 @item max_port
988 Set maximum local UDP port. Default value is 65000.
989
990 @item timeout
991 Set maximum timeout (in seconds) to wait for incoming connections.
992
993 A value of -1 means infinite (default). This option implies the
994 @option{rtsp_flags} set to @samp{listen}.
995
996 @item reorder_queue_size
997 Set number of packets to buffer for handling of reordered packets.
998
999 @item stimeout
1000 Set socket TCP I/O timeout in microseconds.
1001
1002 @item user-agent
1003 Override User-Agent header. If not specified, it defaults to the
1004 libavformat identifier string.
1005 @end table
1006
1007 When receiving data over UDP, the demuxer tries to reorder received packets
1008 (since they may arrive out of order, or packets may get lost totally). This
1009 can be disabled by setting the maximum demuxing delay to zero (via
1010 the @code{max_delay} field of AVFormatContext).
1011
1012 When watching multi-bitrate Real-RTSP streams with @command{ffplay}, the
1013 streams to display can be chosen with @code{-vst} @var{n} and
1014 @code{-ast} @var{n} for video and audio respectively, and can be switched
1015 on the fly by pressing @code{v} and @code{a}.
1016
1017 @subsection Examples
1018
1019 The following examples all make use of the @command{ffplay} and
1020 @command{ffmpeg} tools.
1021
1022 @itemize
1023 @item
1024 Watch a stream over UDP, with a max reordering delay of 0.5 seconds:
1025 @example
1026 ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
1027 @end example
1028
1029 @item
1030 Watch a stream tunneled over HTTP:
1031 @example
1032 ffplay -rtsp_transport http rtsp://server/video.mp4
1033 @end example
1034
1035 @item
1036 Send a stream in realtime to a RTSP server, for others to watch:
1037 @example
1038 ffmpeg -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
1039 @end example
1040
1041 @item
1042 Receive a stream in realtime:
1043 @example
1044 ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
1045 @end example
1046 @end itemize
1047
1048 @section sap
1049
1050 Session Announcement Protocol (RFC 2974). This is not technically a
1051 protocol handler in libavformat, it is a muxer and demuxer.
1052 It is used for signalling of RTP streams, by announcing the SDP for the
1053 streams regularly on a separate port.
1054
1055 @subsection Muxer
1056
1057 The syntax for a SAP url given to the muxer is:
1058 @example
1059 sap://@var{destination}[:@var{port}][?@var{options}]
1060 @end example
1061
1062 The RTP packets are sent to @var{destination} on port @var{port},
1063 or to port 5004 if no port is specified.
1064 @var{options} is a @code{&}-separated list. The following options
1065 are supported:
1066
1067 @table @option
1068
1069 @item announce_addr=@var{address}
1070 Specify the destination IP address for sending the announcements to.
1071 If omitted, the announcements are sent to the commonly used SAP
1072 announcement multicast address 224.2.127.254 (sap.mcast.net), or
1073 ff0e::2:7ffe if @var{destination} is an IPv6 address.
1074
1075 @item announce_port=@var{port}
1076 Specify the port to send the announcements on, defaults to
1077 9875 if not specified.
1078
1079 @item ttl=@var{ttl}
1080 Specify the time to live value for the announcements and RTP packets,
1081 defaults to 255.
1082
1083 @item same_port=@var{0|1}
1084 If set to 1, send all RTP streams on the same port pair. If zero (the
1085 default), all streams are sent on unique ports, with each stream on a
1086 port 2 numbers higher than the previous.
1087 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
1088 The RTP stack in libavformat for receiving requires all streams to be sent
1089 on unique ports.
1090 @end table
1091
1092 Example command lines follow.
1093
1094 To broadcast a stream on the local subnet, for watching in VLC:
1095
1096 @example
1097 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
1098 @end example
1099
1100 Similarly, for watching in @command{ffplay}:
1101
1102 @example
1103 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255
1104 @end example
1105
1106 And for watching in @command{ffplay}, over IPv6:
1107
1108 @example
1109 ffmpeg -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
1110 @end example
1111
1112 @subsection Demuxer
1113
1114 The syntax for a SAP url given to the demuxer is:
1115 @example
1116 sap://[@var{address}][:@var{port}]
1117 @end example
1118
1119 @var{address} is the multicast address to listen for announcements on,
1120 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
1121 is the port that is listened on, 9875 if omitted.
1122
1123 The demuxers listens for announcements on the given address and port.
1124 Once an announcement is received, it tries to receive that particular stream.
1125
1126 Example command lines follow.
1127
1128 To play back the first stream announced on the normal SAP multicast address:
1129
1130 @example
1131 ffplay sap://
1132 @end example
1133
1134 To play back the first stream announced on one the default IPv6 SAP multicast address:
1135
1136 @example
1137 ffplay sap://[ff0e::2:7ffe]
1138 @end example
1139
1140 @section sctp
1141
1142 Stream Control Transmission Protocol.
1143
1144 The accepted URL syntax is:
1145 @example
1146 sctp://@var{host}:@var{port}[?@var{options}]
1147 @end example
1148
1149 The protocol accepts the following options:
1150 @table @option
1151 @item listen
1152 If set to any value, listen for an incoming connection. Outgoing connection is done by default.
1153
1154 @item max_streams
1155 Set the maximum number of streams. By default no limit is set.
1156 @end table
1157
1158 @section srt
1159
1160 Haivision Secure Reliable Transport Protocol via libsrt.
1161
1162 The supported syntax for a SRT URL is:
1163 @example
1164 srt://@var{hostname}:@var{port}[?@var{options}]
1165 @end example
1166
1167 @var{options} contains a list of &-separated options of the form
1168 @var{key}=@var{val}.
1169
1170 or
1171
1172 @example
1173 @var{options} srt://@var{hostname}:@var{port}
1174 @end example
1175
1176 @var{options} contains a list of '-@var{key} @var{val}'
1177 options.
1178
1179 This protocol accepts the following options.
1180
1181 @table @option
1182 @item connect_timeout
1183 Connection timeout; SRT cannot connect for RTT > 1500 msec
1184 (2 handshake exchanges) with the default connect timeout of
1185 3 seconds. This option applies to the caller and rendezvous
1186 connection modes. The connect timeout is 10 times the value
1187 set for the rendezvous mode (which can be used as a
1188 workaround for this connection problem with earlier versions).
1189
1190 @item ffs=@var{bytes}
1191 Flight Flag Size (Window Size), in bytes. FFS is actually an
1192 internal parameter and you should set it to not less than
1193 @option{recv_buffer_size} and @option{mss}. The default value
1194 is relatively large, therefore unless you set a very large receiver buffer,
1195 you do not need to change this option. Default value is 25600.
1196
1197 @item inputbw=@var{bytes/seconds}
1198 Sender nominal input rate, in bytes per seconds. Used along with
1199 @option{oheadbw}, when @option{maxbw} is set to relative (0), to
1200 calculate maximum sending rate when recovery packets are sent
1201 along with the main media stream:
1202 @option{inputbw} * (100 + @option{oheadbw}) / 100
1203 if @option{inputbw} is not set while @option{maxbw} is set to
1204 relative (0), the actual input rate is evaluated inside
1205 the library. Default value is 0.
1206
1207 @item iptos=@var{tos}
1208 IP Type of Service. Applies to sender only. Default value is 0xB8.
1209
1210 @item ipttl=@var{ttl}
1211 IP Time To Live. Applies to sender only. Default value is 64.
1212
1213 @item listen_timeout
1214 Set socket listen timeout.
1215
1216 @item maxbw=@var{bytes/seconds}
1217 Maximum sending bandwidth, in bytes per seconds.
1218 -1 infinite (CSRTCC limit is 30mbps)
1219 0 relative to input rate (see @option{inputbw})
1220 >0 absolute limit value
1221 Default value is 0 (relative)
1222
1223 @item mode=@var{caller|listener|rendezvous}
1224 Connection mode.
1225 @option{caller} opens client connection.
1226 @option{listener} starts server to listen for incoming connections.
1227 @option{rendezvous} use Rendez-Vous connection mode.
1228 Default value is caller.
1229
1230 @item mss=@var{bytes}
1231 Maximum Segment Size, in bytes. Used for buffer allocation
1232 and rate calculation using a packet counter assuming fully
1233 filled packets. The smallest MSS between the peers is
1234 used. This is 1500 by default in the overall internet.
1235 This is the maximum size of the UDP packet and can be
1236 only decreased, unless you have some unusual dedicated
1237 network settings. Default value is 1500.
1238
1239 @item nakreport=@var{1|0}
1240 If set to 1, Receiver will send `UMSG_LOSSREPORT` messages
1241 periodically until a lost packet is retransmitted or
1242 intentionally dropped. Default value is 1.
1243
1244 @item oheadbw=@var{percents}
1245 Recovery bandwidth overhead above input rate, in percents.
1246 See @option{inputbw}. Default value is 25%.
1247
1248 @item passphrase=@var{string}
1249 HaiCrypt Encryption/Decryption Passphrase string, length
1250 from 10 to 79 characters. The passphrase is the shared
1251 secret between the sender and the receiver. It is used
1252 to generate the Key Encrypting Key using PBKDF2
1253 (Password-Based Key Derivation Function). It is used
1254 only if @option{pbkeylen} is non-zero. It is used on
1255 the receiver only if the received data is encrypted.
1256 The configured passphrase cannot be recovered (write-only).
1257
1258 @item pbkeylen=@var{bytes}
1259 Sender encryption key length, in bytes.
1260 Only can be set to 0, 16, 24 and 32.
1261 Enable sender encryption if not 0.
1262 Not required on receiver (set to 0),
1263 key size obtained from sender in HaiCrypt handshake.
1264 Default value is 0.
1265
1266 @item pkt_size=@var{bytes}
1267 Set maximum SRT payload size, expressed in bytes. Default is -1 (automatic),
1268 which typically means 1316 as that is the libsrt default for live mode. Libsrt
1269 can also support payload sizes up to 1456 bytes. (MTU(1500) - UDP.hdr(28) -
1270 SRT.hdr(16))
1271
1272 @item recv_buffer_size=@var{bytes}
1273 Set receive buffer size, expressed in bytes.
1274
1275 @item send_buffer_size=@var{bytes}
1276 Set send buffer size, expressed in bytes.
1277
1278 @item rw_timeout
1279 Set raise error timeout for read/write optations.
1280
1281 This option is only relevant in read mode:
1282 if no data arrived in more than this time
1283 interval, raise error.
1284
1285 @item tlpktdrop=@var{1|0}
1286 Too-late Packet Drop. When enabled on receiver, it skips
1287 missing packets that have not been delivered in time and
1288 delivers the following packets to the application when
1289 their time-to-play has come. It also sends a fake ACK to
1290 the sender. When enabled on sender and enabled on the
1291 receiving peer, the sender drops the older packets that
1292 have no chance of being delivered in time. It was
1293 automatically enabled in the sender if the receiver
1294 supports it.
1295
1296 @item tsbpddelay
1297 Timestamp-based Packet Delivery Delay.
1298 Used to absorb burst of missed packet retransmission.
1299
1300 @end table
1301
1302 For more information see: @url{https://github.com/Haivision/srt}.
1303
1304 @section srtp
1305
1306 Secure Real-time Transport Protocol.
1307
1308 The accepted options are:
1309 @table @option
1310 @item srtp_in_suite
1311 @item srtp_out_suite
1312 Select input and output encoding suites.
1313
1314 Supported values:
1315 @table @samp
1316 @item AES_CM_128_HMAC_SHA1_80
1317 @item SRTP_AES128_CM_HMAC_SHA1_80
1318 @item AES_CM_128_HMAC_SHA1_32
1319 @item SRTP_AES128_CM_HMAC_SHA1_32
1320 @end table
1321
1322 @item srtp_in_params
1323 @item srtp_out_params
1324 Set input and output encoding parameters, which are expressed by a
1325 base64-encoded representation of a binary block. The first 16 bytes of
1326 this binary block are used as master key, the following 14 bytes are
1327 used as master salt.
1328 @end table
1329
1330 @section subfile
1331
1332 Virtually extract a segment of a file or another stream.
1333 The underlying stream must be seekable.
1334
1335 Accepted options:
1336 @table @option
1337 @item start
1338 Start offset of the extracted segment, in bytes.
1339 @item end
1340 End offset of the extracted segment, in bytes.
1341 If set to 0, extract till end of file.
1342 @end table
1343
1344 Examples:
1345
1346 Extract a chapter from a DVD VOB file (start and end sectors obtained
1347 externally and multiplied by 2048):
1348 @example
1349 subfile,,start,153391104,end,268142592,,:/media/dvd/VIDEO_TS/VTS_08_1.VOB
1350 @end example
1351
1352 Play an AVI file directly from a TAR archive:
1353 @example
1354 subfile,,start,183241728,end,366490624,,:archive.tar
1355 @end example
1356
1357 Play a MPEG-TS file from start offset till end:
1358 @example
1359 subfile,,start,32815239,end,0,,:video.ts
1360 @end example
1361
1362 @section tee
1363
1364 Writes the output to multiple protocols. The individual outputs are separated
1365 by |
1366
1367 @example
1368 tee:file://path/to/local/this.avi|file://path/to/local/that.avi
1369 @end example
1370
1371 @section tcp
1372
1373 Transmission Control Protocol.
1374
1375 The required syntax for a TCP url is:
1376 @example
1377 tcp://@var{hostname}:@var{port}[?@var{options}]
1378 @end example
1379
1380 @var{options} contains a list of &-separated options of the form
1381 @var{key}=@var{val}.
1382
1383 The list of supported options follows.
1384
1385 @table @option
1386 @item listen=@var{1|0}
1387 Listen for an incoming connection. Default value is 0.
1388
1389 @item timeout=@var{microseconds}
1390 Set raise error timeout, expressed in microseconds.
1391
1392 This option is only relevant in read mode: if no data arrived in more
1393 than this time interval, raise error.
1394
1395 @item listen_timeout=@var{milliseconds}
1396 Set listen timeout, expressed in milliseconds.
1397
1398 @item recv_buffer_size=@var{bytes}
1399 Set receive buffer size, expressed bytes.
1400
1401 @item send_buffer_size=@var{bytes}
1402 Set send buffer size, expressed bytes.
1403
1404 @item tcp_nodelay=@var{1|0}
1405 Set TCP_NODELAY to disable Nagle's algorithm. Default value is 0.
1406
1407 @item tcp_mss=@var{bytes}
1408 Set maximum segment size for outgoing TCP packets, expressed in bytes.
1409 @end table
1410
1411 The following example shows how to setup a listening TCP connection
1412 with @command{ffmpeg}, which is then accessed with @command{ffplay}:
1413 @example
1414 ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
1415 ffplay tcp://@var{hostname}:@var{port}
1416 @end example
1417
1418 @section tls
1419
1420 Transport Layer Security (TLS) / Secure Sockets Layer (SSL)
1421
1422 The required syntax for a TLS/SSL url is:
1423 @example
1424 tls://@var{hostname}:@var{port}[?@var{options}]
1425 @end example
1426
1427 The following parameters can be set via command line options
1428 (or in code via @code{AVOption}s):
1429
1430 @table @option
1431
1432 @item ca_file, cafile=@var{filename}
1433 A file containing certificate authority (CA) root certificates to treat
1434 as trusted. If the linked TLS library contains a default this might not
1435 need to be specified for verification to work, but not all libraries and
1436 setups have defaults built in.
1437 The file must be in OpenSSL PEM format.
1438
1439 @item tls_verify=@var{1|0}
1440 If enabled, try to verify the peer that we are communicating with.
1441 Note, if using OpenSSL, this currently only makes sure that the
1442 peer certificate is signed by one of the root certificates in the CA
1443 database, but it does not validate that the certificate actually
1444 matches the host name we are trying to connect to. (With other backends,
1445 the host name is validated as well.)
1446
1447 This is disabled by default since it requires a CA database to be
1448 provided by the caller in many cases.
1449
1450 @item cert_file, cert=@var{filename}
1451 A file containing a certificate to use in the handshake with the peer.
1452 (When operating as server, in listen mode, this is more often required
1453 by the peer, while client certificates only are mandated in certain
1454 setups.)
1455
1456 @item key_file, key=@var{filename}
1457 A file containing the private key for the certificate.
1458
1459 @item listen=@var{1|0}
1460 If enabled, listen for connections on the provided port, and assume
1461 the server role in the handshake instead of the client role.
1462
1463 @end table
1464
1465 Example command lines:
1466
1467 To create a TLS/SSL server that serves an input stream.
1468
1469 @example
1470 ffmpeg -i @var{input} -f @var{format} tls://@var{hostname}:@var{port}?listen&cert=@var{server.crt}&key=@var{server.key}
1471 @end example
1472
1473 To play back a stream from the TLS/SSL server using @command{ffplay}:
1474
1475 @example
1476 ffplay tls://@var{hostname}:@var{port}
1477 @end example
1478
1479 @section udp
1480
1481 User Datagram Protocol.
1482
1483 The required syntax for an UDP URL is:
1484 @example
1485 udp://@var{hostname}:@var{port}[?@var{options}]
1486 @end example
1487
1488 @var{options} contains a list of &-separated options of the form @var{key}=@var{val}.
1489
1490 In case threading is enabled on the system, a circular buffer is used
1491 to store the incoming data, which allows one to reduce loss of data due to
1492 UDP socket buffer overruns. The @var{fifo_size} and
1493 @var{overrun_nonfatal} options are related to this buffer.
1494
1495 The list of supported options follows.
1496
1497 @table @option
1498 @item buffer_size=@var{size}
1499 Set the UDP maximum socket buffer size in bytes. This is used to set either
1500 the receive or send buffer size, depending on what the socket is used for.
1501 Default is 64KB.  See also @var{fifo_size}.
1502
1503 @item bitrate=@var{bitrate}
1504 If set to nonzero, the output will have the specified constant bitrate if the
1505 input has enough packets to sustain it.
1506
1507 @item burst_bits=@var{bits}
1508 When using @var{bitrate} this specifies the maximum number of bits in
1509 packet bursts.
1510
1511 @item localport=@var{port}
1512 Override the local UDP port to bind with.
1513
1514 @item localaddr=@var{addr}
1515 Choose the local IP address. This is useful e.g. if sending multicast
1516 and the host has multiple interfaces, where the user can choose
1517 which interface to send on by specifying the IP address of that interface.
1518
1519 @item pkt_size=@var{size}
1520 Set the size in bytes of UDP packets.
1521
1522 @item reuse=@var{1|0}
1523 Explicitly allow or disallow reusing UDP sockets.
1524
1525 @item ttl=@var{ttl}
1526 Set the time to live value (for multicast only).
1527
1528 @item connect=@var{1|0}
1529 Initialize the UDP socket with @code{connect()}. In this case, the
1530 destination address can't be changed with ff_udp_set_remote_url later.
1531 If the destination address isn't known at the start, this option can
1532 be specified in ff_udp_set_remote_url, too.
1533 This allows finding out the source address for the packets with getsockname,
1534 and makes writes return with AVERROR(ECONNREFUSED) if "destination
1535 unreachable" is received.
1536 For receiving, this gives the benefit of only receiving packets from
1537 the specified peer address/port.
1538
1539 @item sources=@var{address}[,@var{address}]
1540 Only receive packets sent to the multicast group from one of the
1541 specified sender IP addresses.
1542
1543 @item block=@var{address}[,@var{address}]
1544 Ignore packets sent to the multicast group from the specified
1545 sender IP addresses.
1546
1547 @item fifo_size=@var{units}
1548 Set the UDP receiving circular buffer size, expressed as a number of
1549 packets with size of 188 bytes. If not specified defaults to 7*4096.
1550
1551 @item overrun_nonfatal=@var{1|0}
1552 Survive in case of UDP receiving circular buffer overrun. Default
1553 value is 0.
1554
1555 @item timeout=@var{microseconds}
1556 Set raise error timeout, expressed in microseconds.
1557
1558 This option is only relevant in read mode: if no data arrived in more
1559 than this time interval, raise error.
1560
1561 @item broadcast=@var{1|0}
1562 Explicitly allow or disallow UDP broadcasting.
1563
1564 Note that broadcasting may not work properly on networks having
1565 a broadcast storm protection.
1566 @end table
1567
1568 @subsection Examples
1569
1570 @itemize
1571 @item
1572 Use @command{ffmpeg} to stream over UDP to a remote endpoint:
1573 @example
1574 ffmpeg -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
1575 @end example
1576
1577 @item
1578 Use @command{ffmpeg} to stream in mpegts format over UDP using 188
1579 sized UDP packets, using a large input buffer:
1580 @example
1581 ffmpeg -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
1582 @end example
1583
1584 @item
1585 Use @command{ffmpeg} to receive over UDP from a remote endpoint:
1586 @example
1587 ffmpeg -i udp://[@var{multicast-address}]:@var{port} ...
1588 @end example
1589 @end itemize
1590
1591 @section unix
1592
1593 Unix local socket
1594
1595 The required syntax for a Unix socket URL is:
1596
1597 @example
1598 unix://@var{filepath}
1599 @end example
1600
1601 The following parameters can be set via command line options
1602 (or in code via @code{AVOption}s):
1603
1604 @table @option
1605 @item timeout
1606 Timeout in ms.
1607 @item listen
1608 Create the Unix socket in listening mode.
1609 @end table
1610
1611 @c man end PROTOCOLS