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