Document new 'blocksize' option of 'pipe' protocol
[ffmpeg.git] / doc / protocols.texi
1 @chapter Protocols
2 @c man begin PROTOCOLS
3
4 Protocols are configured elements in FFmpeg which allow to access
5 resources which require the use of a particular protocol.
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 @section ftp
133
134 FTP (File Transfer Protocol).
135
136 Allow to read from or write to remote resources using FTP protocol.
137
138 Following syntax is required.
139 @example
140 ftp://[user[:password]@@]server[:port]/path/to/remote/resource.mpeg
141 @end example
142
143 This protocol accepts the following options.
144
145 @table @option
146 @item timeout
147 Set timeout of socket I/O operations used by the underlying low level
148 operation. By default it is set to -1, which means that the timeout is
149 not specified.
150
151 @item ftp-anonymous-password
152 Password used when login as anonymous user. Typically an e-mail address
153 should be used.
154
155 @item ftp-write-seekable
156 Control seekability of connection during encoding. If set to 1 the
157 resource is supposed to be seekable, if set to 0 it is assumed not
158 to be seekable. Default value is 0.
159 @end table
160
161 NOTE: Protocol can be used as output, but it is recommended to not do
162 it, unless special care is taken (tests, customized server configuration
163 etc.). Different FTP servers behave in different way during seek
164 operation. ff* tools may produce incomplete content due to server limitations.
165
166 @section gopher
167
168 Gopher protocol.
169
170 @section hls
171
172 Read Apple HTTP Live Streaming compliant segmented stream as
173 a uniform one. The M3U8 playlists describing the segments can be
174 remote HTTP resources or local files, accessed using the standard
175 file protocol.
176 The nested protocol is declared by specifying
177 "+@var{proto}" after the hls URI scheme name, where @var{proto}
178 is either "file" or "http".
179
180 @example
181 hls+http://host/path/to/remote/resource.m3u8
182 hls+file://path/to/local/resource.m3u8
183 @end example
184
185 Using this protocol is discouraged - the hls demuxer should work
186 just as well (if not, please report the issues) and is more complete.
187 To use the hls demuxer instead, simply use the direct URLs to the
188 m3u8 files.
189
190 @section http
191
192 HTTP (Hyper Text Transfer Protocol).
193
194 This protocol accepts the following options.
195
196 @table @option
197 @item seekable
198 Control seekability of connection. If set to 1 the resource is
199 supposed to be seekable, if set to 0 it is assumed not to be seekable,
200 if set to -1 it will try to autodetect if it is seekable. Default
201 value is -1.
202
203 @item chunked_post
204 If set to 1 use chunked transfer-encoding for posts, default is 1.
205
206 @item headers
207 Set custom HTTP headers, can override built in default headers. The
208 value must be a string encoding the headers.
209
210 @item content_type
211 Force a content type.
212
213 @item user-agent
214 Override User-Agent header. If not specified the protocol will use a
215 string describing the libavformat build.
216
217 @item multiple_requests
218 Use persistent connections if set to 1. By default it is 0.
219
220 @item post_data
221 Set custom HTTP post data.
222
223 @item timeout
224 Set timeout of socket I/O operations used by the underlying low level
225 operation. By default it is set to -1, which means that the timeout is
226 not specified.
227
228 @item mime_type
229 Set MIME type.
230
231 @item icy
232 If set to 1 request ICY (SHOUTcast) metadata from the server. If the server
233 supports this, the metadata has to be retrieved by the application by reading
234 the @option{icy_metadata_headers} and @option{icy_metadata_packet} options.
235 The default is 0.
236
237 @item icy_metadata_headers
238 If the server supports ICY metadata, this contains the ICY specific HTTP reply
239 headers, separated with newline characters.
240
241 @item icy_metadata_packet
242 If the server supports ICY metadata, and @option{icy} was set to 1, this
243 contains the last non-empty metadata packet sent by the server.
244
245 @item cookies
246 Set the cookies to be sent in future requests. The format of each cookie is the
247 same as the value of a Set-Cookie HTTP response field. Multiple cookies can be
248 delimited by a newline character.
249 @end table
250
251 @subsection HTTP Cookies
252
253 Some HTTP requests will be denied unless cookie values are passed in with the
254 request. The @option{cookies} option allows these cookies to be specified. At
255 the very least, each cookie must specify a value along with a path and domain.
256 HTTP requests that match both the domain and path will automatically include the
257 cookie value in the HTTP Cookie header field. Multiple cookies can be delimited
258 by a newline.
259
260 The required syntax to play a stream specifying a cookie is:
261 @example
262 ffplay -cookies "nlqptid=nltid=tsn; path=/; domain=somedomain.com;" http://somedomain.com/somestream.m3u8
263 @end example
264
265 @section mmst
266
267 MMS (Microsoft Media Server) protocol over TCP.
268
269 @section mmsh
270
271 MMS (Microsoft Media Server) protocol over HTTP.
272
273 The required syntax is:
274 @example
275 mmsh://@var{server}[:@var{port}][/@var{app}][/@var{playpath}]
276 @end example
277
278 @section md5
279
280 MD5 output protocol.
281
282 Computes the MD5 hash of the data to be written, and on close writes
283 this to the designated output or stdout if none is specified. It can
284 be used to test muxers without writing an actual file.
285
286 Some examples follow.
287 @example
288 # Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
289 ffmpeg -i input.flv -f avi -y md5:output.avi.md5
290
291 # Write the MD5 hash of the encoded AVI file to stdout.
292 ffmpeg -i input.flv -f avi -y md5:
293 @end example
294
295 Note that some formats (typically MOV) require the output protocol to
296 be seekable, so they will fail with the MD5 output protocol.
297
298 @section pipe
299
300 UNIX pipe access protocol.
301
302 Allow to read and write from UNIX pipes.
303
304 The accepted syntax is:
305 @example
306 pipe:[@var{number}]
307 @end example
308
309 @var{number} is the number corresponding to the file descriptor of the
310 pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).  If @var{number}
311 is not specified, by default the stdout file descriptor will be used
312 for writing, stdin for reading.
313
314 For example to read from stdin with @command{ffmpeg}:
315 @example
316 cat test.wav | ffmpeg -i pipe:0
317 # ...this is the same as...
318 cat test.wav | ffmpeg -i pipe:
319 @end example
320
321 For writing to stdout with @command{ffmpeg}:
322 @example
323 ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
324 # ...this is the same as...
325 ffmpeg -i test.wav -f avi pipe: | cat > test.avi
326 @end example
327
328 This protocol accepts the following options:
329
330 @table @option
331 @item blocksize
332 Set I/O operation maximum block size, in bytes. Default value is
333 @code{INT_MAX}, which results in not limiting the requested block size.
334 Setting this value reasonably low improves user termination request reaction
335 time, which is valuable if data transmission is slow.
336 @end table
337
338 Note that some formats (typically MOV), require the output protocol to
339 be seekable, so they will fail with the pipe output protocol.
340
341 @section rtmp
342
343 Real-Time Messaging Protocol.
344
345 The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
346 content across a TCP/IP network.
347
348 The required syntax is:
349 @example
350 rtmp://@var{server}[:@var{port}][/@var{app}][/@var{instance}][/@var{playpath}]
351 @end example
352
353 The accepted parameters are:
354 @table @option
355
356 @item server
357 The address of the RTMP server.
358
359 @item port
360 The number of the TCP port to use (by default is 1935).
361
362 @item app
363 It is the name of the application to access. It usually corresponds to
364 the path where the application is installed on the RTMP server
365 (e.g. @file{/ondemand/}, @file{/flash/live/}, etc.). You can override
366 the value parsed from the URI through the @code{rtmp_app} option, too.
367
368 @item playpath
369 It is the path or name of the resource to play with reference to the
370 application specified in @var{app}, may be prefixed by "mp4:". You
371 can override the value parsed from the URI through the @code{rtmp_playpath}
372 option, too.
373
374 @item listen
375 Act as a server, listening for an incoming connection.
376
377 @item timeout
378 Maximum time to wait for the incoming connection. Implies listen.
379 @end table
380
381 Additionally, the following parameters can be set via command line options
382 (or in code via @code{AVOption}s):
383 @table @option
384
385 @item rtmp_app
386 Name of application to connect on the RTMP server. This option
387 overrides the parameter specified in the URI.
388
389 @item rtmp_buffer
390 Set the client buffer time in milliseconds. The default is 3000.
391
392 @item rtmp_conn
393 Extra arbitrary AMF connection parameters, parsed from a string,
394 e.g. like @code{B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0}.
395 Each value is prefixed by a single character denoting the type,
396 B for Boolean, N for number, S for string, O for object, or Z for null,
397 followed by a colon. For Booleans the data must be either 0 or 1 for
398 FALSE or TRUE, respectively.  Likewise for Objects the data must be 0 or
399 1 to end or begin an object, respectively. Data items in subobjects may
400 be named, by prefixing the type with 'N' and specifying the name before
401 the value (i.e. @code{NB:myFlag:1}). This option may be used multiple
402 times to construct arbitrary AMF sequences.
403
404 @item rtmp_flashver
405 Version of the Flash plugin used to run the SWF player. The default
406 is LNX 9,0,124,2.
407
408 @item rtmp_flush_interval
409 Number of packets flushed in the same request (RTMPT only). The default
410 is 10.
411
412 @item rtmp_live
413 Specify that the media is a live stream. No resuming or seeking in
414 live streams is possible. The default value is @code{any}, which means the
415 subscriber first tries to play the live stream specified in the
416 playpath. If a live stream of that name is not found, it plays the
417 recorded stream. The other possible values are @code{live} and
418 @code{recorded}.
419
420 @item rtmp_pageurl
421 URL of the web page in which the media was embedded. By default no
422 value will be sent.
423
424 @item rtmp_playpath
425 Stream identifier to play or to publish. This option overrides the
426 parameter specified in the URI.
427
428 @item rtmp_subscribe
429 Name of live stream to subscribe to. By default no value will be sent.
430 It is only sent if the option is specified or if rtmp_live
431 is set to live.
432
433 @item rtmp_swfhash
434 SHA256 hash of the decompressed SWF file (32 bytes).
435
436 @item rtmp_swfsize
437 Size of the decompressed SWF file, required for SWFVerification.
438
439 @item rtmp_swfurl
440 URL of the SWF player for the media. By default no value will be sent.
441
442 @item rtmp_swfverify
443 URL to player swf file, compute hash/size automatically.
444
445 @item rtmp_tcurl
446 URL of the target stream. Defaults to proto://host[:port]/app.
447
448 @end table
449
450 For example to read with @command{ffplay} a multimedia resource named
451 "sample" from the application "vod" from an RTMP server "myserver":
452 @example
453 ffplay rtmp://myserver/vod/sample
454 @end example
455
456 @section rtmpe
457
458 Encrypted Real-Time Messaging Protocol.
459
460 The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
461 streaming multimedia content within standard cryptographic primitives,
462 consisting of Diffie-Hellman key exchange and HMACSHA256, generating
463 a pair of RC4 keys.
464
465 @section rtmps
466
467 Real-Time Messaging Protocol over a secure SSL connection.
468
469 The Real-Time Messaging Protocol (RTMPS) is used for streaming
470 multimedia content across an encrypted connection.
471
472 @section rtmpt
473
474 Real-Time Messaging Protocol tunneled through HTTP.
475
476 The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
477 for streaming multimedia content within HTTP requests to traverse
478 firewalls.
479
480 @section rtmpte
481
482 Encrypted Real-Time Messaging Protocol tunneled through HTTP.
483
484 The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
485 is used for streaming multimedia content within HTTP requests to traverse
486 firewalls.
487
488 @section rtmpts
489
490 Real-Time Messaging Protocol tunneled through HTTPS.
491
492 The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
493 for streaming multimedia content within HTTPS requests to traverse
494 firewalls.
495
496 @section rtmp, rtmpe, rtmps, rtmpt, rtmpte
497
498 Real-Time Messaging Protocol and its variants supported through
499 librtmp.
500
501 Requires the presence of the librtmp headers and library during
502 configuration. You need to explicitly configure the build with
503 "--enable-librtmp". If enabled this will replace the native RTMP
504 protocol.
505
506 This protocol provides most client functions and a few server
507 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
508 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
509 variants of these encrypted types (RTMPTE, RTMPTS).
510
511 The required syntax is:
512 @example
513 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
514 @end example
515
516 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
517 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
518 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
519 meaning as specified for the RTMP native protocol.
520 @var{options} contains a list of space-separated options of the form
521 @var{key}=@var{val}.
522
523 See the librtmp manual page (man 3 librtmp) for more information.
524
525 For example, to stream a file in real-time to an RTMP server using
526 @command{ffmpeg}:
527 @example
528 ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
529 @end example
530
531 To play the same stream using @command{ffplay}:
532 @example
533 ffplay "rtmp://myserver/live/mystream live=1"
534 @end example
535
536 @section rtp
537
538 Real-Time Protocol.
539
540 @section rtsp
541
542 RTSP is not technically a protocol handler in libavformat, it is a demuxer
543 and muxer. The demuxer supports both normal RTSP (with data transferred
544 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
545 data transferred over RDT).
546
547 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
548 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
549 @uref{http://github.com/revmischa/rtsp-server, RTSP server}).
550
551 The required syntax for a RTSP url is:
552 @example
553 rtsp://@var{hostname}[:@var{port}]/@var{path}
554 @end example
555
556 The following options (set on the @command{ffmpeg}/@command{ffplay} command
557 line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
558 are supported:
559
560 Flags for @code{rtsp_transport}:
561
562 @table @option
563
564 @item udp
565 Use UDP as lower transport protocol.
566
567 @item tcp
568 Use TCP (interleaving within the RTSP control channel) as lower
569 transport protocol.
570
571 @item udp_multicast
572 Use UDP multicast as lower transport protocol.
573
574 @item http
575 Use HTTP tunneling as lower transport protocol, which is useful for
576 passing proxies.
577 @end table
578
579 Multiple lower transport protocols may be specified, in that case they are
580 tried one at a time (if the setup of one fails, the next one is tried).
581 For the muxer, only the @code{tcp} and @code{udp} options are supported.
582
583 Flags for @code{rtsp_flags}:
584
585 @table @option
586 @item filter_src
587 Accept packets only from negotiated peer address and port.
588 @item listen
589 Act as a server, listening for an incoming connection.
590 @end table
591
592 When receiving data over UDP, the demuxer tries to reorder received packets
593 (since they may arrive out of order, or packets may get lost totally). This
594 can be disabled by setting the maximum demuxing delay to zero (via
595 the @code{max_delay} field of AVFormatContext).
596
597 When watching multi-bitrate Real-RTSP streams with @command{ffplay}, the
598 streams to display can be chosen with @code{-vst} @var{n} and
599 @code{-ast} @var{n} for video and audio respectively, and can be switched
600 on the fly by pressing @code{v} and @code{a}.
601
602 Example command lines:
603
604 To watch a stream over UDP, with a max reordering delay of 0.5 seconds:
605
606 @example
607 ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
608 @end example
609
610 To watch a stream tunneled over HTTP:
611
612 @example
613 ffplay -rtsp_transport http rtsp://server/video.mp4
614 @end example
615
616 To send a stream in realtime to a RTSP server, for others to watch:
617
618 @example
619 ffmpeg -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
620 @end example
621
622 To receive a stream in realtime:
623
624 @example
625 ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
626 @end example
627
628 @table @option
629 @item stimeout
630 Socket IO timeout in micro seconds.
631 @end table
632
633 @section sap
634
635 Session Announcement Protocol (RFC 2974). This is not technically a
636 protocol handler in libavformat, it is a muxer and demuxer.
637 It is used for signalling of RTP streams, by announcing the SDP for the
638 streams regularly on a separate port.
639
640 @subsection Muxer
641
642 The syntax for a SAP url given to the muxer is:
643 @example
644 sap://@var{destination}[:@var{port}][?@var{options}]
645 @end example
646
647 The RTP packets are sent to @var{destination} on port @var{port},
648 or to port 5004 if no port is specified.
649 @var{options} is a @code{&}-separated list. The following options
650 are supported:
651
652 @table @option
653
654 @item announce_addr=@var{address}
655 Specify the destination IP address for sending the announcements to.
656 If omitted, the announcements are sent to the commonly used SAP
657 announcement multicast address 224.2.127.254 (sap.mcast.net), or
658 ff0e::2:7ffe if @var{destination} is an IPv6 address.
659
660 @item announce_port=@var{port}
661 Specify the port to send the announcements on, defaults to
662 9875 if not specified.
663
664 @item ttl=@var{ttl}
665 Specify the time to live value for the announcements and RTP packets,
666 defaults to 255.
667
668 @item same_port=@var{0|1}
669 If set to 1, send all RTP streams on the same port pair. If zero (the
670 default), all streams are sent on unique ports, with each stream on a
671 port 2 numbers higher than the previous.
672 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
673 The RTP stack in libavformat for receiving requires all streams to be sent
674 on unique ports.
675 @end table
676
677 Example command lines follow.
678
679 To broadcast a stream on the local subnet, for watching in VLC:
680
681 @example
682 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
683 @end example
684
685 Similarly, for watching in @command{ffplay}:
686
687 @example
688 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255
689 @end example
690
691 And for watching in @command{ffplay}, over IPv6:
692
693 @example
694 ffmpeg -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
695 @end example
696
697 @subsection Demuxer
698
699 The syntax for a SAP url given to the demuxer is:
700 @example
701 sap://[@var{address}][:@var{port}]
702 @end example
703
704 @var{address} is the multicast address to listen for announcements on,
705 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
706 is the port that is listened on, 9875 if omitted.
707
708 The demuxers listens for announcements on the given address and port.
709 Once an announcement is received, it tries to receive that particular stream.
710
711 Example command lines follow.
712
713 To play back the first stream announced on the normal SAP multicast address:
714
715 @example
716 ffplay sap://
717 @end example
718
719 To play back the first stream announced on one the default IPv6 SAP multicast address:
720
721 @example
722 ffplay sap://[ff0e::2:7ffe]
723 @end example
724
725 @section sctp
726
727 Stream Control Transmission Protocol.
728
729 The accepted URL syntax is:
730 @example
731 sctp://@var{host}:@var{port}[?@var{options}]
732 @end example
733
734 The protocol accepts the following options:
735 @table @option
736 @item listen
737 If set to any value, listen for an incoming connection. Outgoing connection is done by default.
738
739 @item max_streams
740 Set the maximum number of streams. By default no limit is set.
741 @end table
742
743 @section srtp
744
745 Secure Real-time Transport Protocol.
746
747 The accepted options are:
748 @table @option
749 @item srtp_in_suite
750 @item srtp_out_suite
751 Select input and output encoding suites.
752
753 Supported values:
754 @table @samp
755 @item AES_CM_128_HMAC_SHA1_80
756 @item SRTP_AES128_CM_HMAC_SHA1_80
757 @item AES_CM_128_HMAC_SHA1_32
758 @item SRTP_AES128_CM_HMAC_SHA1_32
759 @end table
760
761 @item srtp_in_params
762 @item srtp_out_params
763 Set input and output encoding parameters, which are expressed by a
764 base64-encoded representation of a binary block. The first 16 bytes of
765 this binary block are used as master key, the following 14 bytes are
766 used as master salt.
767 @end table
768
769 @section tcp
770
771 Trasmission Control Protocol.
772
773 The required syntax for a TCP url is:
774 @example
775 tcp://@var{hostname}:@var{port}[?@var{options}]
776 @end example
777
778 @table @option
779
780 @item listen
781 Listen for an incoming connection
782
783 @item timeout=@var{microseconds}
784 In read mode: if no data arrived in more than this time interval, raise error.
785 In write mode: if socket cannot be written in more than this time interval, raise error.
786 This also sets timeout on TCP connection establishing.
787
788 @example
789 ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
790 ffplay tcp://@var{hostname}:@var{port}
791 @end example
792
793 @end table
794
795 @section tls
796
797 Transport Layer Security/Secure Sockets Layer
798
799 The required syntax for a TLS/SSL url is:
800 @example
801 tls://@var{hostname}:@var{port}[?@var{options}]
802 @end example
803
804 @table @option
805
806 @item listen
807 Act as a server, listening for an incoming connection.
808
809 @item cafile=@var{filename}
810 Certificate authority file. The file must be in OpenSSL PEM format.
811
812 @item cert=@var{filename}
813 Certificate file. The file must be in OpenSSL PEM format.
814
815 @item key=@var{filename}
816 Private key file.
817
818 @item verify=@var{0|1}
819 Verify the peer's certificate.
820
821 @end table
822
823 Example command lines:
824
825 To create a TLS/SSL server that serves an input stream.
826
827 @example
828 ffmpeg -i @var{input} -f @var{format} tls://@var{hostname}:@var{port}?listen&cert=@var{server.crt}&key=@var{server.key}
829 @end example
830
831 To play back a stream from the TLS/SSL server using @command{ffplay}:
832
833 @example
834 ffplay tls://@var{hostname}:@var{port}
835 @end example
836
837 @section udp
838
839 User Datagram Protocol.
840
841 The required syntax for a UDP url is:
842 @example
843 udp://@var{hostname}:@var{port}[?@var{options}]
844 @end example
845
846 @var{options} contains a list of &-separated options of the form @var{key}=@var{val}.
847
848 In case threading is enabled on the system, a circular buffer is used
849 to store the incoming data, which allows to reduce loss of data due to
850 UDP socket buffer overruns. The @var{fifo_size} and
851 @var{overrun_nonfatal} options are related to this buffer.
852
853 The list of supported options follows.
854
855 @table @option
856
857 @item buffer_size=@var{size}
858 Set the UDP socket buffer size in bytes. This is used both for the
859 receiving and the sending buffer size.
860
861 @item localport=@var{port}
862 Override the local UDP port to bind with.
863
864 @item localaddr=@var{addr}
865 Choose the local IP address. This is useful e.g. if sending multicast
866 and the host has multiple interfaces, where the user can choose
867 which interface to send on by specifying the IP address of that interface.
868
869 @item pkt_size=@var{size}
870 Set the size in bytes of UDP packets.
871
872 @item reuse=@var{1|0}
873 Explicitly allow or disallow reusing UDP sockets.
874
875 @item ttl=@var{ttl}
876 Set the time to live value (for multicast only).
877
878 @item connect=@var{1|0}
879 Initialize the UDP socket with @code{connect()}. In this case, the
880 destination address can't be changed with ff_udp_set_remote_url later.
881 If the destination address isn't known at the start, this option can
882 be specified in ff_udp_set_remote_url, too.
883 This allows finding out the source address for the packets with getsockname,
884 and makes writes return with AVERROR(ECONNREFUSED) if "destination
885 unreachable" is received.
886 For receiving, this gives the benefit of only receiving packets from
887 the specified peer address/port.
888
889 @item sources=@var{address}[,@var{address}]
890 Only receive packets sent to the multicast group from one of the
891 specified sender IP addresses.
892
893 @item block=@var{address}[,@var{address}]
894 Ignore packets sent to the multicast group from the specified
895 sender IP addresses.
896
897 @item fifo_size=@var{units}
898 Set the UDP receiving circular buffer size, expressed as a number of
899 packets with size of 188 bytes. If not specified defaults to 7*4096.
900
901 @item overrun_nonfatal=@var{1|0}
902 Survive in case of UDP receiving circular buffer overrun. Default
903 value is 0.
904
905 @item timeout=@var{microseconds}
906 In read mode: if no data arrived in more than this time interval, raise error.
907 @end table
908
909 Some usage examples of the UDP protocol with @command{ffmpeg} follow.
910
911 To stream over UDP to a remote endpoint:
912 @example
913 ffmpeg -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
914 @end example
915
916 To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer:
917 @example
918 ffmpeg -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
919 @end example
920
921 To receive over UDP from a remote endpoint:
922 @example
923 ffmpeg -i udp://[@var{multicast-address}]:@var{port}
924 @end example
925
926 @c man end PROTOCOLS