udp: Support IGMPv3 source specific multicast and source blocking
[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_playpath
233 Stream identifier to play or to publish. This option overrides the
234 parameter specified in the URI.
235
236 @item rtmp_swfurl
237 URL of the SWF player for the media. By default no value will be sent.
238
239 @item rtmp_tcurl
240 URL of the target stream.
241
242 @end table
243
244 For example to read with @command{avplay} a multimedia resource named
245 "sample" from the application "vod" from an RTMP server "myserver":
246 @example
247 avplay rtmp://myserver/vod/sample
248 @end example
249
250 @section rtmpt
251
252 Real-Time Messaging Protocol tunneled through HTTP.
253
254 The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
255 for streaming multimedia content within HTTP requests to traverse
256 firewalls.
257
258 @section rtmp, rtmpe, rtmps, rtmpt, rtmpte
259
260 Real-Time Messaging Protocol and its variants supported through
261 librtmp.
262
263 Requires the presence of the librtmp headers and library during
264 configuration. You need to explicitly configure the build with
265 "--enable-librtmp". If enabled this will replace the native RTMP
266 protocol.
267
268 This protocol provides most client functions and a few server
269 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
270 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
271 variants of these encrypted types (RTMPTE, RTMPTS).
272
273 The required syntax is:
274 @example
275 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
276 @end example
277
278 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
279 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
280 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
281 meaning as specified for the RTMP native protocol.
282 @var{options} contains a list of space-separated options of the form
283 @var{key}=@var{val}.
284
285 See the librtmp manual page (man 3 librtmp) for more information.
286
287 For example, to stream a file in real-time to an RTMP server using
288 @command{avconv}:
289 @example
290 avconv -re -i myfile -f flv rtmp://myserver/live/mystream
291 @end example
292
293 To play the same stream using @command{avplay}:
294 @example
295 avplay "rtmp://myserver/live/mystream live=1"
296 @end example
297
298 @section rtp
299
300 Real-Time Protocol.
301
302 @section rtsp
303
304 RTSP is not technically a protocol handler in libavformat, it is a demuxer
305 and muxer. The demuxer supports both normal RTSP (with data transferred
306 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
307 data transferred over RDT).
308
309 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
310 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
311 @uref{http://github.com/revmischa/rtsp-server, RTSP server}).
312
313 The required syntax for a RTSP url is:
314 @example
315 rtsp://@var{hostname}[:@var{port}]/@var{path}
316 @end example
317
318 The following options (set on the @command{avconv}/@command{avplay} command
319 line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
320 are supported:
321
322 Flags for @code{rtsp_transport}:
323
324 @table @option
325
326 @item udp
327 Use UDP as lower transport protocol.
328
329 @item tcp
330 Use TCP (interleaving within the RTSP control channel) as lower
331 transport protocol.
332
333 @item udp_multicast
334 Use UDP multicast as lower transport protocol.
335
336 @item http
337 Use HTTP tunneling as lower transport protocol, which is useful for
338 passing proxies.
339 @end table
340
341 Multiple lower transport protocols may be specified, in that case they are
342 tried one at a time (if the setup of one fails, the next one is tried).
343 For the muxer, only the @code{tcp} and @code{udp} options are supported.
344
345 Flags for @code{rtsp_flags}:
346
347 @table @option
348 @item filter_src
349 Accept packets only from negotiated peer address and port.
350 @end table
351
352 When receiving data over UDP, the demuxer tries to reorder received packets
353 (since they may arrive out of order, or packets may get lost totally). This
354 can be disabled by setting the maximum demuxing delay to zero (via
355 the @code{max_delay} field of AVFormatContext).
356
357 When watching multi-bitrate Real-RTSP streams with @command{avplay}, the
358 streams to display can be chosen with @code{-vst} @var{n} and
359 @code{-ast} @var{n} for video and audio respectively, and can be switched
360 on the fly by pressing @code{v} and @code{a}.
361
362 Example command lines:
363
364 To watch a stream over UDP, with a max reordering delay of 0.5 seconds:
365
366 @example
367 avplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
368 @end example
369
370 To watch a stream tunneled over HTTP:
371
372 @example
373 avplay -rtsp_transport http rtsp://server/video.mp4
374 @end example
375
376 To send a stream in realtime to a RTSP server, for others to watch:
377
378 @example
379 avconv -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
380 @end example
381
382 @section sap
383
384 Session Announcement Protocol (RFC 2974). This is not technically a
385 protocol handler in libavformat, it is a muxer and demuxer.
386 It is used for signalling of RTP streams, by announcing the SDP for the
387 streams regularly on a separate port.
388
389 @subsection Muxer
390
391 The syntax for a SAP url given to the muxer is:
392 @example
393 sap://@var{destination}[:@var{port}][?@var{options}]
394 @end example
395
396 The RTP packets are sent to @var{destination} on port @var{port},
397 or to port 5004 if no port is specified.
398 @var{options} is a @code{&}-separated list. The following options
399 are supported:
400
401 @table @option
402
403 @item announce_addr=@var{address}
404 Specify the destination IP address for sending the announcements to.
405 If omitted, the announcements are sent to the commonly used SAP
406 announcement multicast address 224.2.127.254 (sap.mcast.net), or
407 ff0e::2:7ffe if @var{destination} is an IPv6 address.
408
409 @item announce_port=@var{port}
410 Specify the port to send the announcements on, defaults to
411 9875 if not specified.
412
413 @item ttl=@var{ttl}
414 Specify the time to live value for the announcements and RTP packets,
415 defaults to 255.
416
417 @item same_port=@var{0|1}
418 If set to 1, send all RTP streams on the same port pair. If zero (the
419 default), all streams are sent on unique ports, with each stream on a
420 port 2 numbers higher than the previous.
421 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
422 The RTP stack in libavformat for receiving requires all streams to be sent
423 on unique ports.
424 @end table
425
426 Example command lines follow.
427
428 To broadcast a stream on the local subnet, for watching in VLC:
429
430 @example
431 avconv -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
432 @end example
433
434 Similarly, for watching in avplay:
435
436 @example
437 avconv -re -i @var{input} -f sap sap://224.0.0.255
438 @end example
439
440 And for watching in avplay, over IPv6:
441
442 @example
443 avconv -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
444 @end example
445
446 @subsection Demuxer
447
448 The syntax for a SAP url given to the demuxer is:
449 @example
450 sap://[@var{address}][:@var{port}]
451 @end example
452
453 @var{address} is the multicast address to listen for announcements on,
454 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
455 is the port that is listened on, 9875 if omitted.
456
457 The demuxers listens for announcements on the given address and port.
458 Once an announcement is received, it tries to receive that particular stream.
459
460 Example command lines follow.
461
462 To play back the first stream announced on the normal SAP multicast address:
463
464 @example
465 avplay sap://
466 @end example
467
468 To play back the first stream announced on one the default IPv6 SAP multicast address:
469
470 @example
471 avplay sap://[ff0e::2:7ffe]
472 @end example
473
474 @section tcp
475
476 Trasmission Control Protocol.
477
478 The required syntax for a TCP url is:
479 @example
480 tcp://@var{hostname}:@var{port}[?@var{options}]
481 @end example
482
483 @table @option
484
485 @item listen
486 Listen for an incoming connection
487
488 @example
489 avconv -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
490 avplay tcp://@var{hostname}:@var{port}
491 @end example
492
493 @end table
494
495 @section udp
496
497 User Datagram Protocol.
498
499 The required syntax for a UDP url is:
500 @example
501 udp://@var{hostname}:@var{port}[?@var{options}]
502 @end example
503
504 @var{options} contains a list of &-seperated options of the form @var{key}=@var{val}.
505 Follow the list of supported options.
506
507 @table @option
508
509 @item buffer_size=@var{size}
510 set the UDP buffer size in bytes
511
512 @item localport=@var{port}
513 override the local UDP port to bind with
514
515 @item localaddr=@var{addr}
516 Choose the local IP address. This is useful e.g. if sending multicast
517 and the host has multiple interfaces, where the user can choose
518 which interface to send on by specifying the IP address of that interface.
519
520 @item pkt_size=@var{size}
521 set the size in bytes of UDP packets
522
523 @item reuse=@var{1|0}
524 explicitly allow or disallow reusing UDP sockets
525
526 @item ttl=@var{ttl}
527 set the time to live value (for multicast only)
528
529 @item connect=@var{1|0}
530 Initialize the UDP socket with @code{connect()}. In this case, the
531 destination address can't be changed with ff_udp_set_remote_url later.
532 If the destination address isn't known at the start, this option can
533 be specified in ff_udp_set_remote_url, too.
534 This allows finding out the source address for the packets with getsockname,
535 and makes writes return with AVERROR(ECONNREFUSED) if "destination
536 unreachable" is received.
537 For receiving, this gives the benefit of only receiving packets from
538 the specified peer address/port.
539
540 @item sources=@var{address}[,@var{address}]
541 Only receive packets sent to the multicast group from one of the
542 specified sender IP addresses.
543
544 @item block=@var{address}[,@var{address}]
545 Ignore packets sent to the multicast group from the specified
546 sender IP addresses.
547 @end table
548
549 Some usage examples of the udp protocol with @command{avconv} follow.
550
551 To stream over UDP to a remote endpoint:
552 @example
553 avconv -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
554 @end example
555
556 To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer:
557 @example
558 avconv -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
559 @end example
560
561 To receive over UDP from a remote endpoint:
562 @example
563 avconv -i udp://[@var{multicast-address}]:@var{port}
564 @end example
565
566 @c man end PROTOCOLS