1e925ea261e5711b2ec88b0d945e56d905e92fbc
[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 @section rtmpe
281
282 Encrypted Real-Time Messaging Protocol.
283
284 The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
285 streaming multimedia content within standard cryptographic primitives,
286 consisting of Diffie-Hellman key exchange and HMACSHA256, generating
287 a pair of RC4 keys.
288
289 @section rtmps
290
291 Real-Time Messaging Protocol over a secure SSL connection.
292
293 The Real-Time Messaging Protocol (RTMPS) is used for streaming
294 multimedia content across an encrypted connection.
295
296 @section rtmpt
297
298 Real-Time Messaging Protocol tunneled through HTTP.
299
300 The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
301 for streaming multimedia content within HTTP requests to traverse
302 firewalls.
303
304 @section rtmpte
305
306 Encrypted Real-Time Messaging Protocol tunneled through HTTP.
307
308 The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
309 is used for streaming multimedia content within HTTP requests to traverse
310 firewalls.
311
312 @section rtmpts
313
314 Real-Time Messaging Protocol tunneled through HTTPS.
315
316 The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
317 for streaming multimedia content within HTTPS requests to traverse
318 firewalls.
319
320 @section librtmp rtmp, rtmpe, rtmps, rtmpt, rtmpte
321
322 Real-Time Messaging Protocol and its variants supported through
323 librtmp.
324
325 Requires the presence of the librtmp headers and library during
326 configuration. You need to explicitly configure the build with
327 "--enable-librtmp". If enabled this will replace the native RTMP
328 protocol.
329
330 This protocol provides most client functions and a few server
331 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
332 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
333 variants of these encrypted types (RTMPTE, RTMPTS).
334
335 The required syntax is:
336 @example
337 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
338 @end example
339
340 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
341 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
342 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
343 meaning as specified for the RTMP native protocol.
344 @var{options} contains a list of space-separated options of the form
345 @var{key}=@var{val}.
346
347 See the librtmp manual page (man 3 librtmp) for more information.
348
349 For example, to stream a file in real-time to an RTMP server using
350 @command{avconv}:
351 @example
352 avconv -re -i myfile -f flv rtmp://myserver/live/mystream
353 @end example
354
355 To play the same stream using @command{avplay}:
356 @example
357 avplay "rtmp://myserver/live/mystream live=1"
358 @end example
359
360 @section rtp
361
362 Real-Time Protocol.
363
364 @section rtsp
365
366 RTSP is not technically a protocol handler in libavformat, it is a demuxer
367 and muxer. The demuxer supports both normal RTSP (with data transferred
368 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
369 data transferred over RDT).
370
371 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
372 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
373 @uref{http://github.com/revmischa/rtsp-server, RTSP server}).
374
375 The required syntax for a RTSP url is:
376 @example
377 rtsp://@var{hostname}[:@var{port}]/@var{path}
378 @end example
379
380 The following options (set on the @command{avconv}/@command{avplay} command
381 line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
382 are supported:
383
384 Flags for @code{rtsp_transport}:
385
386 @table @option
387
388 @item udp
389 Use UDP as lower transport protocol.
390
391 @item tcp
392 Use TCP (interleaving within the RTSP control channel) as lower
393 transport protocol.
394
395 @item udp_multicast
396 Use UDP multicast as lower transport protocol.
397
398 @item http
399 Use HTTP tunneling as lower transport protocol, which is useful for
400 passing proxies.
401 @end table
402
403 Multiple lower transport protocols may be specified, in that case they are
404 tried one at a time (if the setup of one fails, the next one is tried).
405 For the muxer, only the @code{tcp} and @code{udp} options are supported.
406
407 Flags for @code{rtsp_flags}:
408
409 @table @option
410 @item filter_src
411 Accept packets only from negotiated peer address and port.
412 @item listen
413 Act as a server, listening for an incoming connection.
414 @end table
415
416 When receiving data over UDP, the demuxer tries to reorder received packets
417 (since they may arrive out of order, or packets may get lost totally). This
418 can be disabled by setting the maximum demuxing delay to zero (via
419 the @code{max_delay} field of AVFormatContext).
420
421 When watching multi-bitrate Real-RTSP streams with @command{avplay}, the
422 streams to display can be chosen with @code{-vst} @var{n} and
423 @code{-ast} @var{n} for video and audio respectively, and can be switched
424 on the fly by pressing @code{v} and @code{a}.
425
426 Example command lines:
427
428 To watch a stream over UDP, with a max reordering delay of 0.5 seconds:
429
430 @example
431 avplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
432 @end example
433
434 To watch a stream tunneled over HTTP:
435
436 @example
437 avplay -rtsp_transport http rtsp://server/video.mp4
438 @end example
439
440 To send a stream in realtime to a RTSP server, for others to watch:
441
442 @example
443 avconv -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
444 @end example
445
446 To receive a stream in realtime:
447
448 @example
449 avconv -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
450 @end example
451
452 @section sap
453
454 Session Announcement Protocol (RFC 2974). This is not technically a
455 protocol handler in libavformat, it is a muxer and demuxer.
456 It is used for signalling of RTP streams, by announcing the SDP for the
457 streams regularly on a separate port.
458
459 @subsection Muxer
460
461 The syntax for a SAP url given to the muxer is:
462 @example
463 sap://@var{destination}[:@var{port}][?@var{options}]
464 @end example
465
466 The RTP packets are sent to @var{destination} on port @var{port},
467 or to port 5004 if no port is specified.
468 @var{options} is a @code{&}-separated list. The following options
469 are supported:
470
471 @table @option
472
473 @item announce_addr=@var{address}
474 Specify the destination IP address for sending the announcements to.
475 If omitted, the announcements are sent to the commonly used SAP
476 announcement multicast address 224.2.127.254 (sap.mcast.net), or
477 ff0e::2:7ffe if @var{destination} is an IPv6 address.
478
479 @item announce_port=@var{port}
480 Specify the port to send the announcements on, defaults to
481 9875 if not specified.
482
483 @item ttl=@var{ttl}
484 Specify the time to live value for the announcements and RTP packets,
485 defaults to 255.
486
487 @item same_port=@var{0|1}
488 If set to 1, send all RTP streams on the same port pair. If zero (the
489 default), all streams are sent on unique ports, with each stream on a
490 port 2 numbers higher than the previous.
491 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
492 The RTP stack in libavformat for receiving requires all streams to be sent
493 on unique ports.
494 @end table
495
496 Example command lines follow.
497
498 To broadcast a stream on the local subnet, for watching in VLC:
499
500 @example
501 avconv -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
502 @end example
503
504 Similarly, for watching in avplay:
505
506 @example
507 avconv -re -i @var{input} -f sap sap://224.0.0.255
508 @end example
509
510 And for watching in avplay, over IPv6:
511
512 @example
513 avconv -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
514 @end example
515
516 @subsection Demuxer
517
518 The syntax for a SAP url given to the demuxer is:
519 @example
520 sap://[@var{address}][:@var{port}]
521 @end example
522
523 @var{address} is the multicast address to listen for announcements on,
524 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
525 is the port that is listened on, 9875 if omitted.
526
527 The demuxers listens for announcements on the given address and port.
528 Once an announcement is received, it tries to receive that particular stream.
529
530 Example command lines follow.
531
532 To play back the first stream announced on the normal SAP multicast address:
533
534 @example
535 avplay sap://
536 @end example
537
538 To play back the first stream announced on one the default IPv6 SAP multicast address:
539
540 @example
541 avplay sap://[ff0e::2:7ffe]
542 @end example
543
544 @section tcp
545
546 Trasmission Control Protocol.
547
548 The required syntax for a TCP url is:
549 @example
550 tcp://@var{hostname}:@var{port}[?@var{options}]
551 @end example
552
553 @table @option
554
555 @item listen
556 Listen for an incoming connection
557
558 @example
559 avconv -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
560 avplay tcp://@var{hostname}:@var{port}
561 @end example
562
563 @end table
564
565 @section udp
566
567 User Datagram Protocol.
568
569 The required syntax for a UDP url is:
570 @example
571 udp://@var{hostname}:@var{port}[?@var{options}]
572 @end example
573
574 @var{options} contains a list of &-separated options of the form @var{key}=@var{val}.
575 Follow the list of supported options.
576
577 @table @option
578
579 @item buffer_size=@var{size}
580 set the UDP buffer size in bytes
581
582 @item localport=@var{port}
583 override the local UDP port to bind with
584
585 @item localaddr=@var{addr}
586 Choose the local IP address. This is useful e.g. if sending multicast
587 and the host has multiple interfaces, where the user can choose
588 which interface to send on by specifying the IP address of that interface.
589
590 @item pkt_size=@var{size}
591 set the size in bytes of UDP packets
592
593 @item reuse=@var{1|0}
594 explicitly allow or disallow reusing UDP sockets
595
596 @item ttl=@var{ttl}
597 set the time to live value (for multicast only)
598
599 @item connect=@var{1|0}
600 Initialize the UDP socket with @code{connect()}. In this case, the
601 destination address can't be changed with ff_udp_set_remote_url later.
602 If the destination address isn't known at the start, this option can
603 be specified in ff_udp_set_remote_url, too.
604 This allows finding out the source address for the packets with getsockname,
605 and makes writes return with AVERROR(ECONNREFUSED) if "destination
606 unreachable" is received.
607 For receiving, this gives the benefit of only receiving packets from
608 the specified peer address/port.
609
610 @item sources=@var{address}[,@var{address}]
611 Only receive packets sent to the multicast group from one of the
612 specified sender IP addresses.
613
614 @item block=@var{address}[,@var{address}]
615 Ignore packets sent to the multicast group from the specified
616 sender IP addresses.
617 @end table
618
619 Some usage examples of the udp protocol with @command{avconv} follow.
620
621 To stream over UDP to a remote endpoint:
622 @example
623 avconv -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
624 @end example
625
626 To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer:
627 @example
628 avconv -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
629 @end example
630
631 To receive over UDP from a remote endpoint:
632 @example
633 avconv -i udp://[@var{multicast-address}]:@var{port}
634 @end example
635
636 @section unix
637
638 Unix local socket
639
640 The required syntax for a Unix socket URL is:
641
642 @example
643 unix://@var{filepath}
644 @end example
645
646 The following parameters can be set via command line options
647 (or in code via @code{AVOption}s):
648
649 @table @option
650 @item timeout
651 Timeout in ms.
652 @item listen
653 Create the Unix socket in listening mode.
654 @end table
655
656 @c man end PROTOCOLS