Merge commit '605387582bd35920b83a26dabbe1c0601f425621'
[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 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{server}[:@var{port}][/@var{app}][/@var{instance}][/@var{playpath}]
365 @end example
366
367 The accepted parameters are:
368 @table @option
369
370 @item server
371 The address of the RTMP server.
372
373 @item port
374 The number of the TCP port to use (by default is 1935).
375
376 @item app
377 It is the name of the application to access. It usually corresponds to
378 the path where the application is installed on the RTMP server
379 (e.g. @file{/ondemand/}, @file{/flash/live/}, etc.). You can override
380 the value parsed from the URI through the @code{rtmp_app} option, too.
381
382 @item playpath
383 It is the path or name of the resource to play with reference to the
384 application specified in @var{app}, may be prefixed by "mp4:". You
385 can override the value parsed from the URI through the @code{rtmp_playpath}
386 option, too.
387
388 @item listen
389 Act as a server, listening for an incoming connection.
390
391 @item timeout
392 Maximum time to wait for the incoming connection. Implies listen.
393 @end table
394
395 Additionally, the following parameters can be set via command line options
396 (or in code via @code{AVOption}s):
397 @table @option
398
399 @item rtmp_app
400 Name of application to connect on the RTMP server. This option
401 overrides the parameter specified in the URI.
402
403 @item rtmp_buffer
404 Set the client buffer time in milliseconds. The default is 3000.
405
406 @item rtmp_conn
407 Extra arbitrary AMF connection parameters, parsed from a string,
408 e.g. like @code{B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0}.
409 Each value is prefixed by a single character denoting the type,
410 B for Boolean, N for number, S for string, O for object, or Z for null,
411 followed by a colon. For Booleans the data must be either 0 or 1 for
412 FALSE or TRUE, respectively.  Likewise for Objects the data must be 0 or
413 1 to end or begin an object, respectively. Data items in subobjects may
414 be named, by prefixing the type with 'N' and specifying the name before
415 the value (i.e. @code{NB:myFlag:1}). This option may be used multiple
416 times to construct arbitrary AMF sequences.
417
418 @item rtmp_flashver
419 Version of the Flash plugin used to run the SWF player. The default
420 is LNX 9,0,124,2.
421
422 @item rtmp_flush_interval
423 Number of packets flushed in the same request (RTMPT only). The default
424 is 10.
425
426 @item rtmp_live
427 Specify that the media is a live stream. No resuming or seeking in
428 live streams is possible. The default value is @code{any}, which means the
429 subscriber first tries to play the live stream specified in the
430 playpath. If a live stream of that name is not found, it plays the
431 recorded stream. The other possible values are @code{live} and
432 @code{recorded}.
433
434 @item rtmp_pageurl
435 URL of the web page in which the media was embedded. By default no
436 value will be sent.
437
438 @item rtmp_playpath
439 Stream identifier to play or to publish. This option overrides the
440 parameter specified in the URI.
441
442 @item rtmp_subscribe
443 Name of live stream to subscribe to. By default no value will be sent.
444 It is only sent if the option is specified or if rtmp_live
445 is set to live.
446
447 @item rtmp_swfhash
448 SHA256 hash of the decompressed SWF file (32 bytes).
449
450 @item rtmp_swfsize
451 Size of the decompressed SWF file, required for SWFVerification.
452
453 @item rtmp_swfurl
454 URL of the SWF player for the media. By default no value will be sent.
455
456 @item rtmp_swfverify
457 URL to player swf file, compute hash/size automatically.
458
459 @item rtmp_tcurl
460 URL of the target stream. Defaults to proto://host[:port]/app.
461
462 @end table
463
464 For example to read with @command{ffplay} a multimedia resource named
465 "sample" from the application "vod" from an RTMP server "myserver":
466 @example
467 ffplay rtmp://myserver/vod/sample
468 @end example
469
470 @section rtmpe
471
472 Encrypted Real-Time Messaging Protocol.
473
474 The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
475 streaming multimedia content within standard cryptographic primitives,
476 consisting of Diffie-Hellman key exchange and HMACSHA256, generating
477 a pair of RC4 keys.
478
479 @section rtmps
480
481 Real-Time Messaging Protocol over a secure SSL connection.
482
483 The Real-Time Messaging Protocol (RTMPS) is used for streaming
484 multimedia content across an encrypted connection.
485
486 @section rtmpt
487
488 Real-Time Messaging Protocol tunneled through HTTP.
489
490 The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
491 for streaming multimedia content within HTTP requests to traverse
492 firewalls.
493
494 @section rtmpte
495
496 Encrypted Real-Time Messaging Protocol tunneled through HTTP.
497
498 The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
499 is used for streaming multimedia content within HTTP requests to traverse
500 firewalls.
501
502 @section rtmpts
503
504 Real-Time Messaging Protocol tunneled through HTTPS.
505
506 The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
507 for streaming multimedia content within HTTPS requests to traverse
508 firewalls.
509
510 @section rtmp, rtmpe, rtmps, rtmpt, rtmpte
511
512 Real-Time Messaging Protocol and its variants supported through
513 librtmp.
514
515 Requires the presence of the librtmp headers and library during
516 configuration. You need to explicitly configure the build with
517 "--enable-librtmp". If enabled this will replace the native RTMP
518 protocol.
519
520 This protocol provides most client functions and a few server
521 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
522 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
523 variants of these encrypted types (RTMPTE, RTMPTS).
524
525 The required syntax is:
526 @example
527 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
528 @end example
529
530 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
531 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
532 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
533 meaning as specified for the RTMP native protocol.
534 @var{options} contains a list of space-separated options of the form
535 @var{key}=@var{val}.
536
537 See the librtmp manual page (man 3 librtmp) for more information.
538
539 For example, to stream a file in real-time to an RTMP server using
540 @command{ffmpeg}:
541 @example
542 ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
543 @end example
544
545 To play the same stream using @command{ffplay}:
546 @example
547 ffplay "rtmp://myserver/live/mystream live=1"
548 @end example
549
550 @section rtp
551
552 Real-Time Protocol.
553
554 @section rtsp
555
556 RTSP is not technically a protocol handler in libavformat, it is a demuxer
557 and muxer. The demuxer supports both normal RTSP (with data transferred
558 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
559 data transferred over RDT).
560
561 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
562 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
563 @uref{http://github.com/revmischa/rtsp-server, RTSP server}).
564
565 The required syntax for a RTSP url is:
566 @example
567 rtsp://@var{hostname}[:@var{port}]/@var{path}
568 @end example
569
570 The following options (set on the @command{ffmpeg}/@command{ffplay} command
571 line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
572 are supported:
573
574 Flags for @code{rtsp_transport}:
575
576 @table @option
577
578 @item udp
579 Use UDP as lower transport protocol.
580
581 @item tcp
582 Use TCP (interleaving within the RTSP control channel) as lower
583 transport protocol.
584
585 @item udp_multicast
586 Use UDP multicast as lower transport protocol.
587
588 @item http
589 Use HTTP tunneling as lower transport protocol, which is useful for
590 passing proxies.
591 @end table
592
593 Multiple lower transport protocols may be specified, in that case they are
594 tried one at a time (if the setup of one fails, the next one is tried).
595 For the muxer, only the @code{tcp} and @code{udp} options are supported.
596
597 Flags for @code{rtsp_flags}:
598
599 @table @option
600 @item filter_src
601 Accept packets only from negotiated peer address and port.
602 @item listen
603 Act as a server, listening for an incoming connection.
604 @end table
605
606 When receiving data over UDP, the demuxer tries to reorder received packets
607 (since they may arrive out of order, or packets may get lost totally). This
608 can be disabled by setting the maximum demuxing delay to zero (via
609 the @code{max_delay} field of AVFormatContext).
610
611 When watching multi-bitrate Real-RTSP streams with @command{ffplay}, the
612 streams to display can be chosen with @code{-vst} @var{n} and
613 @code{-ast} @var{n} for video and audio respectively, and can be switched
614 on the fly by pressing @code{v} and @code{a}.
615
616 Example command lines:
617
618 To watch a stream over UDP, with a max reordering delay of 0.5 seconds:
619
620 @example
621 ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
622 @end example
623
624 To watch a stream tunneled over HTTP:
625
626 @example
627 ffplay -rtsp_transport http rtsp://server/video.mp4
628 @end example
629
630 To send a stream in realtime to a RTSP server, for others to watch:
631
632 @example
633 ffmpeg -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
634 @end example
635
636 To receive a stream in realtime:
637
638 @example
639 ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
640 @end example
641
642 @table @option
643 @item stimeout
644 Socket IO timeout in micro seconds.
645 @end table
646
647 @section sap
648
649 Session Announcement Protocol (RFC 2974). This is not technically a
650 protocol handler in libavformat, it is a muxer and demuxer.
651 It is used for signalling of RTP streams, by announcing the SDP for the
652 streams regularly on a separate port.
653
654 @subsection Muxer
655
656 The syntax for a SAP url given to the muxer is:
657 @example
658 sap://@var{destination}[:@var{port}][?@var{options}]
659 @end example
660
661 The RTP packets are sent to @var{destination} on port @var{port},
662 or to port 5004 if no port is specified.
663 @var{options} is a @code{&}-separated list. The following options
664 are supported:
665
666 @table @option
667
668 @item announce_addr=@var{address}
669 Specify the destination IP address for sending the announcements to.
670 If omitted, the announcements are sent to the commonly used SAP
671 announcement multicast address 224.2.127.254 (sap.mcast.net), or
672 ff0e::2:7ffe if @var{destination} is an IPv6 address.
673
674 @item announce_port=@var{port}
675 Specify the port to send the announcements on, defaults to
676 9875 if not specified.
677
678 @item ttl=@var{ttl}
679 Specify the time to live value for the announcements and RTP packets,
680 defaults to 255.
681
682 @item same_port=@var{0|1}
683 If set to 1, send all RTP streams on the same port pair. If zero (the
684 default), all streams are sent on unique ports, with each stream on a
685 port 2 numbers higher than the previous.
686 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
687 The RTP stack in libavformat for receiving requires all streams to be sent
688 on unique ports.
689 @end table
690
691 Example command lines follow.
692
693 To broadcast a stream on the local subnet, for watching in VLC:
694
695 @example
696 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
697 @end example
698
699 Similarly, for watching in @command{ffplay}:
700
701 @example
702 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255
703 @end example
704
705 And for watching in @command{ffplay}, over IPv6:
706
707 @example
708 ffmpeg -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
709 @end example
710
711 @subsection Demuxer
712
713 The syntax for a SAP url given to the demuxer is:
714 @example
715 sap://[@var{address}][:@var{port}]
716 @end example
717
718 @var{address} is the multicast address to listen for announcements on,
719 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
720 is the port that is listened on, 9875 if omitted.
721
722 The demuxers listens for announcements on the given address and port.
723 Once an announcement is received, it tries to receive that particular stream.
724
725 Example command lines follow.
726
727 To play back the first stream announced on the normal SAP multicast address:
728
729 @example
730 ffplay sap://
731 @end example
732
733 To play back the first stream announced on one the default IPv6 SAP multicast address:
734
735 @example
736 ffplay sap://[ff0e::2:7ffe]
737 @end example
738
739 @section sctp
740
741 Stream Control Transmission Protocol.
742
743 The accepted URL syntax is:
744 @example
745 sctp://@var{host}:@var{port}[?@var{options}]
746 @end example
747
748 The protocol accepts the following options:
749 @table @option
750 @item listen
751 If set to any value, listen for an incoming connection. Outgoing connection is done by default.
752
753 @item max_streams
754 Set the maximum number of streams. By default no limit is set.
755 @end table
756
757 @section srtp
758
759 Secure Real-time Transport Protocol.
760
761 The accepted options are:
762 @table @option
763 @item srtp_in_suite
764 @item srtp_out_suite
765 Select input and output encoding suites.
766
767 Supported values:
768 @table @samp
769 @item AES_CM_128_HMAC_SHA1_80
770 @item SRTP_AES128_CM_HMAC_SHA1_80
771 @item AES_CM_128_HMAC_SHA1_32
772 @item SRTP_AES128_CM_HMAC_SHA1_32
773 @end table
774
775 @item srtp_in_params
776 @item srtp_out_params
777 Set input and output encoding parameters, which are expressed by a
778 base64-encoded representation of a binary block. The first 16 bytes of
779 this binary block are used as master key, the following 14 bytes are
780 used as master salt.
781 @end table
782
783 @section tcp
784
785 Trasmission Control Protocol.
786
787 The required syntax for a TCP url is:
788 @example
789 tcp://@var{hostname}:@var{port}[?@var{options}]
790 @end example
791
792 @table @option
793
794 @item listen
795 Listen for an incoming connection
796
797 @item timeout=@var{microseconds}
798 In read mode: if no data arrived in more than this time interval, raise error.
799 In write mode: if socket cannot be written in more than this time interval, raise error.
800 This also sets timeout on TCP connection establishing.
801
802 @example
803 ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
804 ffplay tcp://@var{hostname}:@var{port}
805 @end example
806
807 @end table
808
809 @section tls
810
811 Transport Layer Security/Secure Sockets Layer
812
813 The required syntax for a TLS/SSL url is:
814 @example
815 tls://@var{hostname}:@var{port}[?@var{options}]
816 @end example
817
818 @table @option
819
820 @item listen
821 Act as a server, listening for an incoming connection.
822
823 @item cafile=@var{filename}
824 Certificate authority file. The file must be in OpenSSL PEM format.
825
826 @item cert=@var{filename}
827 Certificate file. The file must be in OpenSSL PEM format.
828
829 @item key=@var{filename}
830 Private key file.
831
832 @item verify=@var{0|1}
833 Verify the peer's certificate.
834
835 @end table
836
837 Example command lines:
838
839 To create a TLS/SSL server that serves an input stream.
840
841 @example
842 ffmpeg -i @var{input} -f @var{format} tls://@var{hostname}:@var{port}?listen&cert=@var{server.crt}&key=@var{server.key}
843 @end example
844
845 To play back a stream from the TLS/SSL server using @command{ffplay}:
846
847 @example
848 ffplay tls://@var{hostname}:@var{port}
849 @end example
850
851 @section udp
852
853 User Datagram Protocol.
854
855 The required syntax for a UDP url is:
856 @example
857 udp://@var{hostname}:@var{port}[?@var{options}]
858 @end example
859
860 @var{options} contains a list of &-separated options of the form @var{key}=@var{val}.
861
862 In case threading is enabled on the system, a circular buffer is used
863 to store the incoming data, which allows to reduce loss of data due to
864 UDP socket buffer overruns. The @var{fifo_size} and
865 @var{overrun_nonfatal} options are related to this buffer.
866
867 The list of supported options follows.
868
869 @table @option
870
871 @item buffer_size=@var{size}
872 Set the UDP socket buffer size in bytes. This is used both for the
873 receiving and the sending buffer size.
874
875 @item localport=@var{port}
876 Override the local UDP port to bind with.
877
878 @item localaddr=@var{addr}
879 Choose the local IP address. This is useful e.g. if sending multicast
880 and the host has multiple interfaces, where the user can choose
881 which interface to send on by specifying the IP address of that interface.
882
883 @item pkt_size=@var{size}
884 Set the size in bytes of UDP packets.
885
886 @item reuse=@var{1|0}
887 Explicitly allow or disallow reusing UDP sockets.
888
889 @item ttl=@var{ttl}
890 Set the time to live value (for multicast only).
891
892 @item connect=@var{1|0}
893 Initialize the UDP socket with @code{connect()}. In this case, the
894 destination address can't be changed with ff_udp_set_remote_url later.
895 If the destination address isn't known at the start, this option can
896 be specified in ff_udp_set_remote_url, too.
897 This allows finding out the source address for the packets with getsockname,
898 and makes writes return with AVERROR(ECONNREFUSED) if "destination
899 unreachable" is received.
900 For receiving, this gives the benefit of only receiving packets from
901 the specified peer address/port.
902
903 @item sources=@var{address}[,@var{address}]
904 Only receive packets sent to the multicast group from one of the
905 specified sender IP addresses.
906
907 @item block=@var{address}[,@var{address}]
908 Ignore packets sent to the multicast group from the specified
909 sender IP addresses.
910
911 @item fifo_size=@var{units}
912 Set the UDP receiving circular buffer size, expressed as a number of
913 packets with size of 188 bytes. If not specified defaults to 7*4096.
914
915 @item overrun_nonfatal=@var{1|0}
916 Survive in case of UDP receiving circular buffer overrun. Default
917 value is 0.
918
919 @item timeout=@var{microseconds}
920 In read mode: if no data arrived in more than this time interval, raise error.
921 @end table
922
923 Some usage examples of the UDP protocol with @command{ffmpeg} follow.
924
925 To stream over UDP to a remote endpoint:
926 @example
927 ffmpeg -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
928 @end example
929
930 To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer:
931 @example
932 ffmpeg -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
933 @end example
934
935 To receive over UDP from a remote endpoint:
936 @example
937 ffmpeg -i udp://[@var{multicast-address}]:@var{port}
938 @end example
939
940 @section unix
941
942 Unix local socket
943
944 The required syntax for a Unix socket URL is:
945
946 @example
947 unix://@var{filepath}
948 @end example
949
950 The following parameters can be set via command line options
951 (or in code via @code{AVOption}s):
952
953 @table @option
954 @item timeout
955 Timeout in ms.
956 @item listen
957 Create the Unix socket in listening mode.
958 @end table
959
960 @c man end PROTOCOLS