tls: Add support for listen mode
[ffmpeg.git] / doc / protocols.texi
1 @chapter Protocols
2 @c man begin PROTOCOLS
3
4 Protocols are configured elements in Libav which allow to access
5 resources which require the use of a particular protocol.
6
7 When you configure your Libav 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 av* tools will display the list of
18 supported protocols.
19
20 A description of the currently available protocols follows.
21
22 @section concat
23
24 Physical concatenation protocol.
25
26 Allow to read and seek from many resource in sequence as if they were
27 a unique resource.
28
29 A URL accepted by this protocol has the syntax:
30 @example
31 concat:@var{URL1}|@var{URL2}|...|@var{URLN}
32 @end example
33
34 where @var{URL1}, @var{URL2}, ..., @var{URLN} are the urls of the
35 resource to be concatenated, each one possibly specifying a distinct
36 protocol.
37
38 For example to read a sequence of files @file{split1.mpeg},
39 @file{split2.mpeg}, @file{split3.mpeg} with @command{avplay} use the
40 command:
41 @example
42 avplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
43 @end example
44
45 Note that you may need to escape the character "|" which is special for
46 many shells.
47
48 @section file
49
50 File access protocol.
51
52 Allow to read from or read to a file.
53
54 For example to read from a file @file{input.mpeg} with @command{avconv}
55 use the command:
56 @example
57 avconv -i file:input.mpeg output.mpeg
58 @end example
59
60 The av* tools default to the file protocol, that is a resource
61 specified with the name "FILE.mpeg" is interpreted as the URL
62 "file:FILE.mpeg".
63
64 @section gopher
65
66 Gopher protocol.
67
68 @section hls
69
70 Read Apple HTTP Live Streaming compliant segmented stream as
71 a uniform one. The M3U8 playlists describing the segments can be
72 remote HTTP resources or local files, accessed using the standard
73 file protocol.
74 The nested protocol is declared by specifying
75 "+@var{proto}" after the hls URI scheme name, where @var{proto}
76 is either "file" or "http".
77
78 @example
79 hls+http://host/path/to/remote/resource.m3u8
80 hls+file://path/to/local/resource.m3u8
81 @end example
82
83 Using this protocol is discouraged - the hls demuxer should work
84 just as well (if not, please report the issues) and is more complete.
85 To use the hls demuxer instead, simply use the direct URLs to the
86 m3u8 files.
87
88 @section http
89
90 HTTP (Hyper Text Transfer Protocol).
91
92 @section mmst
93
94 MMS (Microsoft Media Server) protocol over TCP.
95
96 @section mmsh
97
98 MMS (Microsoft Media Server) protocol over HTTP.
99
100 The required syntax is:
101 @example
102 mmsh://@var{server}[:@var{port}][/@var{app}][/@var{playpath}]
103 @end example
104
105 @section md5
106
107 MD5 output protocol.
108
109 Computes the MD5 hash of the data to be written, and on close writes
110 this to the designated output or stdout if none is specified. It can
111 be used to test muxers without writing an actual file.
112
113 Some examples follow.
114 @example
115 # Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
116 avconv -i input.flv -f avi -y md5:output.avi.md5
117
118 # Write the MD5 hash of the encoded AVI file to stdout.
119 avconv -i input.flv -f avi -y md5:
120 @end example
121
122 Note that some formats (typically MOV) require the output protocol to
123 be seekable, so they will fail with the MD5 output protocol.
124
125 @section pipe
126
127 UNIX pipe access protocol.
128
129 Allow to read and write from UNIX pipes.
130
131 The accepted syntax is:
132 @example
133 pipe:[@var{number}]
134 @end example
135
136 @var{number} is the number corresponding to the file descriptor of the
137 pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).  If @var{number}
138 is not specified, by default the stdout file descriptor will be used
139 for writing, stdin for reading.
140
141 For example to read from stdin with @command{avconv}:
142 @example
143 cat test.wav | avconv -i pipe:0
144 # ...this is the same as...
145 cat test.wav | avconv -i pipe:
146 @end example
147
148 For writing to stdout with @command{avconv}:
149 @example
150 avconv -i test.wav -f avi pipe:1 | cat > test.avi
151 # ...this is the same as...
152 avconv -i test.wav -f avi pipe: | cat > test.avi
153 @end example
154
155 Note that some formats (typically MOV), require the output protocol to
156 be seekable, so they will fail with the pipe output protocol.
157
158 @section rtmp
159
160 Real-Time Messaging Protocol.
161
162 The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
163 content across a TCP/IP network.
164
165 The required syntax is:
166 @example
167 rtmp://[@var{username}:@var{password}@@]@var{server}[:@var{port}][/@var{app}][/@var{instance}][/@var{playpath}]
168 @end example
169
170 The accepted parameters are:
171 @table @option
172
173 @item username
174 An optional username (mostly for publishing).
175
176 @item password
177 An optional password (mostly for publishing).
178
179 @item server
180 The address of the RTMP server.
181
182 @item port
183 The number of the TCP port to use (by default is 1935).
184
185 @item app
186 It is the name of the application to access. It usually corresponds to
187 the path where the application is installed on the RTMP server
188 (e.g. @file{/ondemand/}, @file{/flash/live/}, etc.). You can override
189 the value parsed from the URI through the @code{rtmp_app} option, too.
190
191 @item playpath
192 It is the path or name of the resource to play with reference to the
193 application specified in @var{app}, may be prefixed by "mp4:". You
194 can override the value parsed from the URI through the @code{rtmp_playpath}
195 option, too.
196
197 @item listen
198 Act as a server, listening for an incoming connection.
199
200 @item timeout
201 Maximum time to wait for the incoming connection. Implies listen.
202 @end table
203
204 Additionally, the following parameters can be set via command line options
205 (or in code via @code{AVOption}s):
206 @table @option
207
208 @item rtmp_app
209 Name of application to connect on the RTMP server. This option
210 overrides the parameter specified in the URI.
211
212 @item rtmp_buffer
213 Set the client buffer time in milliseconds. The default is 3000.
214
215 @item rtmp_conn
216 Extra arbitrary AMF connection parameters, parsed from a string,
217 e.g. like @code{B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0}.
218 Each value is prefixed by a single character denoting the type,
219 B for Boolean, N for number, S for string, O for object, or Z for null,
220 followed by a colon. For Booleans the data must be either 0 or 1 for
221 FALSE or TRUE, respectively.  Likewise for Objects the data must be 0 or
222 1 to end or begin an object, respectively. Data items in subobjects may
223 be named, by prefixing the type with 'N' and specifying the name before
224 the value (i.e. @code{NB:myFlag:1}). This option may be used multiple
225 times to construct arbitrary AMF sequences.
226
227 @item rtmp_flashver
228 Version of the Flash plugin used to run the SWF player. The default
229 is LNX 9,0,124,2. (When publishing, the default is FMLE/3.0 (compatible;
230 <libavformat version>).)
231
232 @item rtmp_flush_interval
233 Number of packets flushed in the same request (RTMPT only). The default
234 is 10.
235
236 @item rtmp_live
237 Specify that the media is a live stream. No resuming or seeking in
238 live streams is possible. The default value is @code{any}, which means the
239 subscriber first tries to play the live stream specified in the
240 playpath. If a live stream of that name is not found, it plays the
241 recorded stream. The other possible values are @code{live} and
242 @code{recorded}.
243
244 @item rtmp_pageurl
245 URL of the web page in which the media was embedded. By default no
246 value will be sent.
247
248 @item rtmp_playpath
249 Stream identifier to play or to publish. This option overrides the
250 parameter specified in the URI.
251
252 @item rtmp_subscribe
253 Name of live stream to subscribe to. By default no value will be sent.
254 It is only sent if the option is specified or if rtmp_live
255 is set to live.
256
257 @item rtmp_swfhash
258 SHA256 hash of the decompressed SWF file (32 bytes).
259
260 @item rtmp_swfsize
261 Size of the decompressed SWF file, required for SWFVerification.
262
263 @item rtmp_swfurl
264 URL of the SWF player for the media. By default no value will be sent.
265
266 @item rtmp_swfverify
267 URL to player swf file, compute hash/size automatically.
268
269 @item rtmp_tcurl
270 URL of the target stream. Defaults to proto://host[:port]/app.
271
272 @end table
273
274 For example to read with @command{avplay} a multimedia resource named
275 "sample" from the application "vod" from an RTMP server "myserver":
276 @example
277 avplay rtmp://myserver/vod/sample
278 @end example
279
280 To publish to a password protected server, passing the playpath and
281 app names separately:
282 @example
283 avconv -re -i <input> -f flv -rtmp_playpath some/long/path -rtmp_app long/app/name rtmp://username:password@@myserver/
284 @end example
285
286 @section rtmpe
287
288 Encrypted Real-Time Messaging Protocol.
289
290 The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
291 streaming multimedia content within standard cryptographic primitives,
292 consisting of Diffie-Hellman key exchange and HMACSHA256, generating
293 a pair of RC4 keys.
294
295 @section rtmps
296
297 Real-Time Messaging Protocol over a secure SSL connection.
298
299 The Real-Time Messaging Protocol (RTMPS) is used for streaming
300 multimedia content across an encrypted connection.
301
302 @section rtmpt
303
304 Real-Time Messaging Protocol tunneled through HTTP.
305
306 The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
307 for streaming multimedia content within HTTP requests to traverse
308 firewalls.
309
310 @section rtmpte
311
312 Encrypted Real-Time Messaging Protocol tunneled through HTTP.
313
314 The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
315 is used for streaming multimedia content within HTTP requests to traverse
316 firewalls.
317
318 @section rtmpts
319
320 Real-Time Messaging Protocol tunneled through HTTPS.
321
322 The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
323 for streaming multimedia content within HTTPS requests to traverse
324 firewalls.
325
326 @section librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte
327
328 Real-Time Messaging Protocol and its variants supported through
329 librtmp.
330
331 Requires the presence of the librtmp headers and library during
332 configuration. You need to explicitly configure the build with
333 "--enable-librtmp". If enabled this will replace the native RTMP
334 protocol.
335
336 This protocol provides most client functions and a few server
337 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
338 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
339 variants of these encrypted types (RTMPTE, RTMPTS).
340
341 The required syntax is:
342 @example
343 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
344 @end example
345
346 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
347 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
348 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
349 meaning as specified for the RTMP native protocol.
350 @var{options} contains a list of space-separated options of the form
351 @var{key}=@var{val}.
352
353 See the librtmp manual page (man 3 librtmp) for more information.
354
355 For example, to stream a file in real-time to an RTMP server using
356 @command{avconv}:
357 @example
358 avconv -re -i myfile -f flv rtmp://myserver/live/mystream
359 @end example
360
361 To play the same stream using @command{avplay}:
362 @example
363 avplay "rtmp://myserver/live/mystream live=1"
364 @end example
365
366 @section rtp
367
368 Real-Time Protocol.
369
370 @section rtsp
371
372 RTSP is not technically a protocol handler in libavformat, it is a demuxer
373 and muxer. The demuxer supports both normal RTSP (with data transferred
374 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
375 data transferred over RDT).
376
377 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
378 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
379 @uref{http://github.com/revmischa/rtsp-server, RTSP server}).
380
381 The required syntax for a RTSP url is:
382 @example
383 rtsp://@var{hostname}[:@var{port}]/@var{path}
384 @end example
385
386 The following options (set on the @command{avconv}/@command{avplay} command
387 line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
388 are supported:
389
390 Flags for @code{rtsp_transport}:
391
392 @table @option
393
394 @item udp
395 Use UDP as lower transport protocol.
396
397 @item tcp
398 Use TCP (interleaving within the RTSP control channel) as lower
399 transport protocol.
400
401 @item udp_multicast
402 Use UDP multicast as lower transport protocol.
403
404 @item http
405 Use HTTP tunneling as lower transport protocol, which is useful for
406 passing proxies.
407 @end table
408
409 Multiple lower transport protocols may be specified, in that case they are
410 tried one at a time (if the setup of one fails, the next one is tried).
411 For the muxer, only the @code{tcp} and @code{udp} options are supported.
412
413 Flags for @code{rtsp_flags}:
414
415 @table @option
416 @item filter_src
417 Accept packets only from negotiated peer address and port.
418 @item listen
419 Act as a server, listening for an incoming connection.
420 @end table
421
422 When receiving data over UDP, the demuxer tries to reorder received packets
423 (since they may arrive out of order, or packets may get lost totally). This
424 can be disabled by setting the maximum demuxing delay to zero (via
425 the @code{max_delay} field of AVFormatContext).
426
427 When watching multi-bitrate Real-RTSP streams with @command{avplay}, the
428 streams to display can be chosen with @code{-vst} @var{n} and
429 @code{-ast} @var{n} for video and audio respectively, and can be switched
430 on the fly by pressing @code{v} and @code{a}.
431
432 Example command lines:
433
434 To watch a stream over UDP, with a max reordering delay of 0.5 seconds:
435
436 @example
437 avplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
438 @end example
439
440 To watch a stream tunneled over HTTP:
441
442 @example
443 avplay -rtsp_transport http rtsp://server/video.mp4
444 @end example
445
446 To send a stream in realtime to a RTSP server, for others to watch:
447
448 @example
449 avconv -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
450 @end example
451
452 To receive a stream in realtime:
453
454 @example
455 avconv -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
456 @end example
457
458 @section sap
459
460 Session Announcement Protocol (RFC 2974). This is not technically a
461 protocol handler in libavformat, it is a muxer and demuxer.
462 It is used for signalling of RTP streams, by announcing the SDP for the
463 streams regularly on a separate port.
464
465 @subsection Muxer
466
467 The syntax for a SAP url given to the muxer is:
468 @example
469 sap://@var{destination}[:@var{port}][?@var{options}]
470 @end example
471
472 The RTP packets are sent to @var{destination} on port @var{port},
473 or to port 5004 if no port is specified.
474 @var{options} is a @code{&}-separated list. The following options
475 are supported:
476
477 @table @option
478
479 @item announce_addr=@var{address}
480 Specify the destination IP address for sending the announcements to.
481 If omitted, the announcements are sent to the commonly used SAP
482 announcement multicast address 224.2.127.254 (sap.mcast.net), or
483 ff0e::2:7ffe if @var{destination} is an IPv6 address.
484
485 @item announce_port=@var{port}
486 Specify the port to send the announcements on, defaults to
487 9875 if not specified.
488
489 @item ttl=@var{ttl}
490 Specify the time to live value for the announcements and RTP packets,
491 defaults to 255.
492
493 @item same_port=@var{0|1}
494 If set to 1, send all RTP streams on the same port pair. If zero (the
495 default), all streams are sent on unique ports, with each stream on a
496 port 2 numbers higher than the previous.
497 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
498 The RTP stack in libavformat for receiving requires all streams to be sent
499 on unique ports.
500 @end table
501
502 Example command lines follow.
503
504 To broadcast a stream on the local subnet, for watching in VLC:
505
506 @example
507 avconv -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
508 @end example
509
510 Similarly, for watching in avplay:
511
512 @example
513 avconv -re -i @var{input} -f sap sap://224.0.0.255
514 @end example
515
516 And for watching in avplay, over IPv6:
517
518 @example
519 avconv -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
520 @end example
521
522 @subsection Demuxer
523
524 The syntax for a SAP url given to the demuxer is:
525 @example
526 sap://[@var{address}][:@var{port}]
527 @end example
528
529 @var{address} is the multicast address to listen for announcements on,
530 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
531 is the port that is listened on, 9875 if omitted.
532
533 The demuxers listens for announcements on the given address and port.
534 Once an announcement is received, it tries to receive that particular stream.
535
536 Example command lines follow.
537
538 To play back the first stream announced on the normal SAP multicast address:
539
540 @example
541 avplay sap://
542 @end example
543
544 To play back the first stream announced on one the default IPv6 SAP multicast address:
545
546 @example
547 avplay sap://[ff0e::2:7ffe]
548 @end example
549
550 @section tcp
551
552 Trasmission Control Protocol.
553
554 The required syntax for a TCP url is:
555 @example
556 tcp://@var{hostname}:@var{port}[?@var{options}]
557 @end example
558
559 @table @option
560
561 @item listen
562 Listen for an incoming connection
563
564 @example
565 avconv -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
566 avplay tcp://@var{hostname}:@var{port}
567 @end example
568
569 @end table
570
571 @section tls
572
573 Transport Layer Security (TLS) / Secure Sockets Layer (SSL)
574
575 The required syntax for a TLS url is:
576 @example
577 tls://@var{hostname}:@var{port}
578 @end example
579
580 The following parameters can be set via command line options
581 (or in code via @code{AVOption}s):
582
583 @table @option
584
585 @item ca_file
586 A file containing certificate authority (CA) root certificates to treat
587 as trusted. If the linked TLS library contains a default this might not
588 need to be specified for verification to work, but not all libraries and
589 setups have defaults built in.
590
591 @item tls_verify=@var{1|0}
592 If enabled, try to verify the peer that we are communicating with.
593 Note, if using OpenSSL, this currently only makes sure that the
594 peer certificate is signed by one of the root certificates in the CA
595 database, but it does not validate that the certificate actually
596 matches the host name we are trying to connect to. (With GnuTLS,
597 the host name is validated as well.)
598
599 This is disabled by default since it requires a CA database to be
600 provided by the caller in many cases.
601
602 @item cert_file
603 A file containing a certificate to use in the handshake with the peer.
604 (When operating as server, in listen mode, this is more often required
605 by the peer, while client certificates only are mandated in certain
606 setups.)
607
608 @item key_file
609 A file containing the private key for the certificate.
610
611 @item listen=@var{1|0}
612 If enabled, listen for connections on the provided port, and assume
613 the server role in the handshake instead of the client role.
614
615 @end table
616
617 @section udp
618
619 User Datagram Protocol.
620
621 The required syntax for a UDP url is:
622 @example
623 udp://@var{hostname}:@var{port}[?@var{options}]
624 @end example
625
626 @var{options} contains a list of &-separated options of the form @var{key}=@var{val}.
627 Follow the list of supported options.
628
629 @table @option
630
631 @item buffer_size=@var{size}
632 set the UDP buffer size in bytes
633
634 @item localport=@var{port}
635 override the local UDP port to bind with
636
637 @item localaddr=@var{addr}
638 Choose the local IP address. This is useful e.g. if sending multicast
639 and the host has multiple interfaces, where the user can choose
640 which interface to send on by specifying the IP address of that interface.
641
642 @item pkt_size=@var{size}
643 set the size in bytes of UDP packets
644
645 @item reuse=@var{1|0}
646 explicitly allow or disallow reusing UDP sockets
647
648 @item ttl=@var{ttl}
649 set the time to live value (for multicast only)
650
651 @item connect=@var{1|0}
652 Initialize the UDP socket with @code{connect()}. In this case, the
653 destination address can't be changed with ff_udp_set_remote_url later.
654 If the destination address isn't known at the start, this option can
655 be specified in ff_udp_set_remote_url, too.
656 This allows finding out the source address for the packets with getsockname,
657 and makes writes return with AVERROR(ECONNREFUSED) if "destination
658 unreachable" is received.
659 For receiving, this gives the benefit of only receiving packets from
660 the specified peer address/port.
661
662 @item sources=@var{address}[,@var{address}]
663 Only receive packets sent to the multicast group from one of the
664 specified sender IP addresses.
665
666 @item block=@var{address}[,@var{address}]
667 Ignore packets sent to the multicast group from the specified
668 sender IP addresses.
669 @end table
670
671 Some usage examples of the udp protocol with @command{avconv} follow.
672
673 To stream over UDP to a remote endpoint:
674 @example
675 avconv -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
676 @end example
677
678 To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer:
679 @example
680 avconv -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
681 @end example
682
683 To receive over UDP from a remote endpoint:
684 @example
685 avconv -i udp://[@var{multicast-address}]:@var{port}
686 @end example
687
688 @section unix
689
690 Unix local socket
691
692 The required syntax for a Unix socket URL is:
693
694 @example
695 unix://@var{filepath}
696 @end example
697
698 The following parameters can be set via command line options
699 (or in code via @code{AVOption}s):
700
701 @table @option
702 @item timeout
703 Timeout in ms.
704 @item listen
705 Create the Unix socket in listening mode.
706 @end table
707
708 @c man end PROTOCOLS