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