ff872fcdca297499ecb8f1029b081d8ea9bb4ac7
[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 ff* 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 ff* 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{server}[:@var{port}][/@var{app}][/@var{instance}][/@var{playpath}]
168 @end example
169
170 The accepted parameters are:
171 @table @option
172
173 @item server
174 The address of the RTMP server.
175
176 @item port
177 The number of the TCP port to use (by default is 1935).
178
179 @item app
180 It is the name of the application to access. It usually corresponds to
181 the path where the application is installed on the RTMP server
182 (e.g. @file{/ondemand/}, @file{/flash/live/}, etc.). You can override
183 the value parsed from the URI through the @code{rtmp_app} option, too.
184
185 @item playpath
186 It is the path or name of the resource to play with reference to the
187 application specified in @var{app}, may be prefixed by "mp4:". You
188 can override the value parsed from the URI through the @code{rtmp_playpath}
189 option, too.
190
191 @end table
192
193 Additionally, the following parameters can be set via command line options
194 (or in code via @code{AVOption}s):
195 @table @option
196
197 @item rtmp_app
198 Name of application to connect on the RTMP server. This option
199 overrides the parameter specified in the URI.
200
201 @item rtmp_buffer
202 Set the client buffer time in milliseconds. The default is 3000.
203
204 @item rtmp_conn
205 Extra arbitrary AMF connection parameters, parsed from a string,
206 e.g. like @code{B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0}.
207 Each value is prefixed by a single character denoting the type,
208 B for Boolean, N for number, S for string, O for object, or Z for null,
209 followed by a colon. For Booleans the data must be either 0 or 1 for
210 FALSE or TRUE, respectively.  Likewise for Objects the data must be 0 or
211 1 to end or begin an object, respectively. Data items in subobjects may
212 be named, by prefixing the type with 'N' and specifying the name before
213 the value (i.e. @code{NB:myFlag:1}). This option may be used multiple
214 times to construct arbitrary AMF sequences.
215
216 @item rtmp_flashver
217 Version of the Flash plugin used to run the SWF player. The default
218 is LNX 9,0,124,2.
219
220 @item rtmp_flush_interval
221 Number of packets flushed in the same request (RTMPT only). The default
222 is 10.
223
224 @item rtmp_live
225 Specify that the media is a live stream. No resuming or seeking in
226 live streams is possible. The default value is @code{any}, which means the
227 subscriber first tries to play the live stream specified in the
228 playpath. If a live stream of that name is not found, it plays the
229 recorded stream. The other possible values are @code{live} and
230 @code{recorded}.
231
232 @item rtmp_pageurl
233 URL of the web page in which the media was embedded. By default no
234 value will be sent.
235
236 @item rtmp_playpath
237 Stream identifier to play or to publish. This option overrides the
238 parameter specified in the URI.
239
240 @item rtmp_swfurl
241 URL of the SWF player for the media. By default no value will be sent.
242
243 @item rtmp_tcurl
244 URL of the target stream. Defaults to proto://host[:port]/app.
245
246 @end table
247
248 For example to read with @command{avplay} a multimedia resource named
249 "sample" from the application "vod" from an RTMP server "myserver":
250 @example
251 avplay rtmp://myserver/vod/sample
252 @end example
253
254 @section rtmpe
255
256 Encrypted Real-Time Messaging Protocol.
257
258 The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
259 streaming multimedia content within standard cryptographic primitives,
260 consisting of Diffie-Hellman key exchange and HMACSHA256, generating
261 a pair of RC4 keys.
262
263 @section rtmps
264
265 Real-Time Messaging Protocol over a secure SSL connection.
266
267 The Real-Time Messaging Protocol (RTMPS) is used for streaming
268 multimedia content across an encrypted connection.
269
270 @section rtmpt
271
272 Real-Time Messaging Protocol tunneled through HTTP.
273
274 The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
275 for streaming multimedia content within HTTP requests to traverse
276 firewalls.
277
278 @section rtmpte
279
280 Encrypted Real-Time Messaging Protocol tunneled through HTTP.
281
282 The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
283 is used for streaming multimedia content within HTTP requests to traverse
284 firewalls.
285
286 @section rtmpts
287
288 Real-Time Messaging Protocol tunneled through HTTPS.
289
290 The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
291 for streaming multimedia content within HTTPS requests to traverse
292 firewalls.
293
294 @section rtmp, rtmpe, rtmps, rtmpt, rtmpte
295
296 Real-Time Messaging Protocol and its variants supported through
297 librtmp.
298
299 Requires the presence of the librtmp headers and library during
300 configuration. You need to explicitly configure the build with
301 "--enable-librtmp". If enabled this will replace the native RTMP
302 protocol.
303
304 This protocol provides most client functions and a few server
305 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
306 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
307 variants of these encrypted types (RTMPTE, RTMPTS).
308
309 The required syntax is:
310 @example
311 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
312 @end example
313
314 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
315 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
316 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
317 meaning as specified for the RTMP native protocol.
318 @var{options} contains a list of space-separated options of the form
319 @var{key}=@var{val}.
320
321 See the librtmp manual page (man 3 librtmp) for more information.
322
323 For example, to stream a file in real-time to an RTMP server using
324 @command{avconv}:
325 @example
326 avconv -re -i myfile -f flv rtmp://myserver/live/mystream
327 @end example
328
329 To play the same stream using @command{avplay}:
330 @example
331 avplay "rtmp://myserver/live/mystream live=1"
332 @end example
333
334 @section rtp
335
336 Real-Time Protocol.
337
338 @section rtsp
339
340 RTSP is not technically a protocol handler in libavformat, it is a demuxer
341 and muxer. The demuxer supports both normal RTSP (with data transferred
342 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
343 data transferred over RDT).
344
345 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
346 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
347 @uref{http://github.com/revmischa/rtsp-server, RTSP server}).
348
349 The required syntax for a RTSP url is:
350 @example
351 rtsp://@var{hostname}[:@var{port}]/@var{path}
352 @end example
353
354 The following options (set on the @command{avconv}/@command{avplay} command
355 line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
356 are supported:
357
358 Flags for @code{rtsp_transport}:
359
360 @table @option
361
362 @item udp
363 Use UDP as lower transport protocol.
364
365 @item tcp
366 Use TCP (interleaving within the RTSP control channel) as lower
367 transport protocol.
368
369 @item udp_multicast
370 Use UDP multicast as lower transport protocol.
371
372 @item http
373 Use HTTP tunneling as lower transport protocol, which is useful for
374 passing proxies.
375 @end table
376
377 Multiple lower transport protocols may be specified, in that case they are
378 tried one at a time (if the setup of one fails, the next one is tried).
379 For the muxer, only the @code{tcp} and @code{udp} options are supported.
380
381 Flags for @code{rtsp_flags}:
382
383 @table @option
384 @item filter_src
385 Accept packets only from negotiated peer address and port.
386 @item listen
387 Act as a server, listening for an incoming connection.
388 @end table
389
390 When receiving data over UDP, the demuxer tries to reorder received packets
391 (since they may arrive out of order, or packets may get lost totally). This
392 can be disabled by setting the maximum demuxing delay to zero (via
393 the @code{max_delay} field of AVFormatContext).
394
395 When watching multi-bitrate Real-RTSP streams with @command{avplay}, the
396 streams to display can be chosen with @code{-vst} @var{n} and
397 @code{-ast} @var{n} for video and audio respectively, and can be switched
398 on the fly by pressing @code{v} and @code{a}.
399
400 Example command lines:
401
402 To watch a stream over UDP, with a max reordering delay of 0.5 seconds:
403
404 @example
405 avplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
406 @end example
407
408 To watch a stream tunneled over HTTP:
409
410 @example
411 avplay -rtsp_transport http rtsp://server/video.mp4
412 @end example
413
414 To send a stream in realtime to a RTSP server, for others to watch:
415
416 @example
417 avconv -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
418 @end example
419
420 To receive a stream in realtime:
421
422 @example
423 avconv -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
424 @end example
425
426 @section sap
427
428 Session Announcement Protocol (RFC 2974). This is not technically a
429 protocol handler in libavformat, it is a muxer and demuxer.
430 It is used for signalling of RTP streams, by announcing the SDP for the
431 streams regularly on a separate port.
432
433 @subsection Muxer
434
435 The syntax for a SAP url given to the muxer is:
436 @example
437 sap://@var{destination}[:@var{port}][?@var{options}]
438 @end example
439
440 The RTP packets are sent to @var{destination} on port @var{port},
441 or to port 5004 if no port is specified.
442 @var{options} is a @code{&}-separated list. The following options
443 are supported:
444
445 @table @option
446
447 @item announce_addr=@var{address}
448 Specify the destination IP address for sending the announcements to.
449 If omitted, the announcements are sent to the commonly used SAP
450 announcement multicast address 224.2.127.254 (sap.mcast.net), or
451 ff0e::2:7ffe if @var{destination} is an IPv6 address.
452
453 @item announce_port=@var{port}
454 Specify the port to send the announcements on, defaults to
455 9875 if not specified.
456
457 @item ttl=@var{ttl}
458 Specify the time to live value for the announcements and RTP packets,
459 defaults to 255.
460
461 @item same_port=@var{0|1}
462 If set to 1, send all RTP streams on the same port pair. If zero (the
463 default), all streams are sent on unique ports, with each stream on a
464 port 2 numbers higher than the previous.
465 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
466 The RTP stack in libavformat for receiving requires all streams to be sent
467 on unique ports.
468 @end table
469
470 Example command lines follow.
471
472 To broadcast a stream on the local subnet, for watching in VLC:
473
474 @example
475 avconv -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
476 @end example
477
478 Similarly, for watching in avplay:
479
480 @example
481 avconv -re -i @var{input} -f sap sap://224.0.0.255
482 @end example
483
484 And for watching in avplay, over IPv6:
485
486 @example
487 avconv -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
488 @end example
489
490 @subsection Demuxer
491
492 The syntax for a SAP url given to the demuxer is:
493 @example
494 sap://[@var{address}][:@var{port}]
495 @end example
496
497 @var{address} is the multicast address to listen for announcements on,
498 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
499 is the port that is listened on, 9875 if omitted.
500
501 The demuxers listens for announcements on the given address and port.
502 Once an announcement is received, it tries to receive that particular stream.
503
504 Example command lines follow.
505
506 To play back the first stream announced on the normal SAP multicast address:
507
508 @example
509 avplay sap://
510 @end example
511
512 To play back the first stream announced on one the default IPv6 SAP multicast address:
513
514 @example
515 avplay sap://[ff0e::2:7ffe]
516 @end example
517
518 @section tcp
519
520 Trasmission Control Protocol.
521
522 The required syntax for a TCP url is:
523 @example
524 tcp://@var{hostname}:@var{port}[?@var{options}]
525 @end example
526
527 @table @option
528
529 @item listen
530 Listen for an incoming connection
531
532 @example
533 avconv -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
534 avplay tcp://@var{hostname}:@var{port}
535 @end example
536
537 @end table
538
539 @section udp
540
541 User Datagram Protocol.
542
543 The required syntax for a UDP url is:
544 @example
545 udp://@var{hostname}:@var{port}[?@var{options}]
546 @end example
547
548 @var{options} contains a list of &-seperated options of the form @var{key}=@var{val}.
549 Follow the list of supported options.
550
551 @table @option
552
553 @item buffer_size=@var{size}
554 set the UDP buffer size in bytes
555
556 @item localport=@var{port}
557 override the local UDP port to bind with
558
559 @item localaddr=@var{addr}
560 Choose the local IP address. This is useful e.g. if sending multicast
561 and the host has multiple interfaces, where the user can choose
562 which interface to send on by specifying the IP address of that interface.
563
564 @item pkt_size=@var{size}
565 set the size in bytes of UDP packets
566
567 @item reuse=@var{1|0}
568 explicitly allow or disallow reusing UDP sockets
569
570 @item ttl=@var{ttl}
571 set the time to live value (for multicast only)
572
573 @item connect=@var{1|0}
574 Initialize the UDP socket with @code{connect()}. In this case, the
575 destination address can't be changed with ff_udp_set_remote_url later.
576 If the destination address isn't known at the start, this option can
577 be specified in ff_udp_set_remote_url, too.
578 This allows finding out the source address for the packets with getsockname,
579 and makes writes return with AVERROR(ECONNREFUSED) if "destination
580 unreachable" is received.
581 For receiving, this gives the benefit of only receiving packets from
582 the specified peer address/port.
583
584 @item sources=@var{address}[,@var{address}]
585 Only receive packets sent to the multicast group from one of the
586 specified sender IP addresses.
587
588 @item block=@var{address}[,@var{address}]
589 Ignore packets sent to the multicast group from the specified
590 sender IP addresses.
591 @end table
592
593 Some usage examples of the udp protocol with @command{avconv} follow.
594
595 To stream over UDP to a remote endpoint:
596 @example
597 avconv -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
598 @end example
599
600 To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer:
601 @example
602 avconv -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
603 @end example
604
605 To receive over UDP from a remote endpoint:
606 @example
607 avconv -i udp://[@var{multicast-address}]:@var{port}
608 @end example
609
610 @c man end PROTOCOLS