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