libavutil: add a merge sort.
[ffmpeg.git] / doc / protocols.texi
1 @chapter Protocols
2 @c man begin PROTOCOLS
3
4 Protocols are configured elements in FFmpeg which allow to access
5 resources which require the use of a particular protocol.
6
7 When you configure your FFmpeg 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 bluray
23
24 Read BluRay playlist.
25
26 The accepted options are:
27 @table @option
28
29 @item angle
30 BluRay angle
31
32 @item chapter
33 Start chapter (1...N)
34
35 @item playlist
36 Playlist to read (BDMV/PLAYLIST/?????.mpls)
37
38 @end table
39
40 Examples:
41
42 Read longest playlist from BluRay mounted to /mnt/bluray:
43 @example
44 bluray:/mnt/bluray
45 @end example
46
47 Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapter 2:
48 @example
49 -playlist 4 -angle 2 -chapter 2 bluray:/mnt/bluray
50 @end example
51
52 @section concat
53
54 Physical concatenation protocol.
55
56 Allow to read and seek from many resource in sequence as if they were
57 a unique resource.
58
59 A URL accepted by this protocol has the syntax:
60 @example
61 concat:@var{URL1}|@var{URL2}|...|@var{URLN}
62 @end example
63
64 where @var{URL1}, @var{URL2}, ..., @var{URLN} are the urls of the
65 resource to be concatenated, each one possibly specifying a distinct
66 protocol.
67
68 For example to read a sequence of files @file{split1.mpeg},
69 @file{split2.mpeg}, @file{split3.mpeg} with @command{ffplay} use the
70 command:
71 @example
72 ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg
73 @end example
74
75 Note that you may need to escape the character "|" which is special for
76 many shells.
77
78 @section file
79
80 File access protocol.
81
82 Allow to read from or read to a file.
83
84 For example to read from a file @file{input.mpeg} with @command{ffmpeg}
85 use the command:
86 @example
87 ffmpeg -i file:input.mpeg output.mpeg
88 @end example
89
90 The ff* tools default to the file protocol, that is a resource
91 specified with the name "FILE.mpeg" is interpreted as the URL
92 "file:FILE.mpeg".
93
94 @section gopher
95
96 Gopher protocol.
97
98 @section hls
99
100 Read Apple HTTP Live Streaming compliant segmented stream as
101 a uniform one. The M3U8 playlists describing the segments can be
102 remote HTTP resources or local files, accessed using the standard
103 file protocol.
104 The nested protocol is declared by specifying
105 "+@var{proto}" after the hls URI scheme name, where @var{proto}
106 is either "file" or "http".
107
108 @example
109 hls+http://host/path/to/remote/resource.m3u8
110 hls+file://path/to/local/resource.m3u8
111 @end example
112
113 Using this protocol is discouraged - the hls demuxer should work
114 just as well (if not, please report the issues) and is more complete.
115 To use the hls demuxer instead, simply use the direct URLs to the
116 m3u8 files.
117
118 @section http
119
120 HTTP (Hyper Text Transfer Protocol).
121
122 @section mmst
123
124 MMS (Microsoft Media Server) protocol over TCP.
125
126 @section mmsh
127
128 MMS (Microsoft Media Server) protocol over HTTP.
129
130 The required syntax is:
131 @example
132 mmsh://@var{server}[:@var{port}][/@var{app}][/@var{playpath}]
133 @end example
134
135 @section md5
136
137 MD5 output protocol.
138
139 Computes the MD5 hash of the data to be written, and on close writes
140 this to the designated output or stdout if none is specified. It can
141 be used to test muxers without writing an actual file.
142
143 Some examples follow.
144 @example
145 # Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
146 ffmpeg -i input.flv -f avi -y md5:output.avi.md5
147
148 # Write the MD5 hash of the encoded AVI file to stdout.
149 ffmpeg -i input.flv -f avi -y md5:
150 @end example
151
152 Note that some formats (typically MOV) require the output protocol to
153 be seekable, so they will fail with the MD5 output protocol.
154
155 @section pipe
156
157 UNIX pipe access protocol.
158
159 Allow to read and write from UNIX pipes.
160
161 The accepted syntax is:
162 @example
163 pipe:[@var{number}]
164 @end example
165
166 @var{number} is the number corresponding to the file descriptor of the
167 pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).  If @var{number}
168 is not specified, by default the stdout file descriptor will be used
169 for writing, stdin for reading.
170
171 For example to read from stdin with @command{ffmpeg}:
172 @example
173 cat test.wav | ffmpeg -i pipe:0
174 # ...this is the same as...
175 cat test.wav | ffmpeg -i pipe:
176 @end example
177
178 For writing to stdout with @command{ffmpeg}:
179 @example
180 ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
181 # ...this is the same as...
182 ffmpeg -i test.wav -f avi pipe: | cat > test.avi
183 @end example
184
185 Note that some formats (typically MOV), require the output protocol to
186 be seekable, so they will fail with the pipe output protocol.
187
188 @section rtmp
189
190 Real-Time Messaging Protocol.
191
192 The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
193 content across a TCP/IP network.
194
195 The required syntax is:
196 @example
197 rtmp://@var{server}[:@var{port}][/@var{app}][/@var{instance}][/@var{playpath}]
198 @end example
199
200 The accepted parameters are:
201 @table @option
202
203 @item server
204 The address of the RTMP server.
205
206 @item port
207 The number of the TCP port to use (by default is 1935).
208
209 @item app
210 It is the name of the application to access. It usually corresponds to
211 the path where the application is installed on the RTMP server
212 (e.g. @file{/ondemand/}, @file{/flash/live/}, etc.). You can override
213 the value parsed from the URI through the @code{rtmp_app} option, too.
214
215 @item playpath
216 It is the path or name of the resource to play with reference to the
217 application specified in @var{app}, may be prefixed by "mp4:". You
218 can override the value parsed from the URI through the @code{rtmp_playpath}
219 option, too.
220
221 @end table
222
223 Additionally, the following parameters can be set via command line options
224 (or in code via @code{AVOption}s):
225 @table @option
226
227 @item rtmp_app
228 Name of application to connect on the RTMP server. This option
229 overrides the parameter specified in the URI.
230
231 @item rtmp_buffer
232 Set the client buffer time in milliseconds. The default is 3000.
233
234 @item rtmp_conn
235 Extra arbitrary AMF connection parameters, parsed from a string,
236 e.g. like @code{B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0}.
237 Each value is prefixed by a single character denoting the type,
238 B for Boolean, N for number, S for string, O for object, or Z for null,
239 followed by a colon. For Booleans the data must be either 0 or 1 for
240 FALSE or TRUE, respectively.  Likewise for Objects the data must be 0 or
241 1 to end or begin an object, respectively. Data items in subobjects may
242 be named, by prefixing the type with 'N' and specifying the name before
243 the value (i.e. @code{NB:myFlag:1}). This option may be used multiple
244 times to construct arbitrary AMF sequences.
245
246 @item rtmp_flashver
247 Version of the Flash plugin used to run the SWF player. The default
248 is LNX 9,0,124,2.
249
250 @item rtmp_live
251 Specify that the media is a live stream. No resuming or seeking in
252 live streams is possible. The default value is @code{any}, which means the
253 subscriber first tries to play the live stream specified in the
254 playpath. If a live stream of that name is not found, it plays the
255 recorded stream. The other possible values are @code{live} and
256 @code{recorded}.
257
258 @item rtmp_playpath
259 Stream identifier to play or to publish. This option overrides the
260 parameter specified in the URI.
261
262 @item rtmp_swfurl
263 URL of the SWF player for the media. By default no value will be sent.
264
265 @item rtmp_tcurl
266 URL of the target stream.
267
268 @end table
269
270 For example to read with @command{ffplay} a multimedia resource named
271 "sample" from the application "vod" from an RTMP server "myserver":
272 @example
273 ffplay rtmp://myserver/vod/sample
274 @end example
275
276 @section rtmp, rtmpe, rtmps, rtmpt, rtmpte
277
278 Real-Time Messaging Protocol and its variants supported through
279 librtmp.
280
281 Requires the presence of the librtmp headers and library during
282 configuration. You need to explicitly configure the build with
283 "--enable-librtmp". If enabled this will replace the native RTMP
284 protocol.
285
286 This protocol provides most client functions and a few server
287 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
288 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
289 variants of these encrypted types (RTMPTE, RTMPTS).
290
291 The required syntax is:
292 @example
293 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
294 @end example
295
296 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
297 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
298 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
299 meaning as specified for the RTMP native protocol.
300 @var{options} contains a list of space-separated options of the form
301 @var{key}=@var{val}.
302
303 See the librtmp manual page (man 3 librtmp) for more information.
304
305 For example, to stream a file in real-time to an RTMP server using
306 @command{ffmpeg}:
307 @example
308 ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
309 @end example
310
311 To play the same stream using @command{ffplay}:
312 @example
313 ffplay "rtmp://myserver/live/mystream live=1"
314 @end example
315
316 @section rtp
317
318 Real-Time Protocol.
319
320 @section rtsp
321
322 RTSP is not technically a protocol handler in libavformat, it is a demuxer
323 and muxer. The demuxer supports both normal RTSP (with data transferred
324 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
325 data transferred over RDT).
326
327 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
328 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
329 @uref{http://github.com/revmischa/rtsp-server, RTSP server}).
330
331 The required syntax for a RTSP url is:
332 @example
333 rtsp://@var{hostname}[:@var{port}]/@var{path}
334 @end example
335
336 The following options (set on the @command{ffmpeg}/@command{ffplay} command
337 line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
338 are supported:
339
340 Flags for @code{rtsp_transport}:
341
342 @table @option
343
344 @item udp
345 Use UDP as lower transport protocol.
346
347 @item tcp
348 Use TCP (interleaving within the RTSP control channel) as lower
349 transport protocol.
350
351 @item udp_multicast
352 Use UDP multicast as lower transport protocol.
353
354 @item http
355 Use HTTP tunneling as lower transport protocol, which is useful for
356 passing proxies.
357 @end table
358
359 Multiple lower transport protocols may be specified, in that case they are
360 tried one at a time (if the setup of one fails, the next one is tried).
361 For the muxer, only the @code{tcp} and @code{udp} options are supported.
362
363 Flags for @code{rtsp_flags}:
364
365 @table @option
366 @item filter_src
367 Accept packets only from negotiated peer address and port.
368 @end table
369
370 When receiving data over UDP, the demuxer tries to reorder received packets
371 (since they may arrive out of order, or packets may get lost totally). This
372 can be disabled by setting the maximum demuxing delay to zero (via
373 the @code{max_delay} field of AVFormatContext).
374
375 When watching multi-bitrate Real-RTSP streams with @command{ffplay}, the
376 streams to display can be chosen with @code{-vst} @var{n} and
377 @code{-ast} @var{n} for video and audio respectively, and can be switched
378 on the fly by pressing @code{v} and @code{a}.
379
380 Example command lines:
381
382 To watch a stream over UDP, with a max reordering delay of 0.5 seconds:
383
384 @example
385 ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
386 @end example
387
388 To watch a stream tunneled over HTTP:
389
390 @example
391 ffplay -rtsp_transport http rtsp://server/video.mp4
392 @end example
393
394 To send a stream in realtime to a RTSP server, for others to watch:
395
396 @example
397 ffmpeg -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
398 @end example
399
400 @section sap
401
402 Session Announcement Protocol (RFC 2974). This is not technically a
403 protocol handler in libavformat, it is a muxer and demuxer.
404 It is used for signalling of RTP streams, by announcing the SDP for the
405 streams regularly on a separate port.
406
407 @subsection Muxer
408
409 The syntax for a SAP url given to the muxer is:
410 @example
411 sap://@var{destination}[:@var{port}][?@var{options}]
412 @end example
413
414 The RTP packets are sent to @var{destination} on port @var{port},
415 or to port 5004 if no port is specified.
416 @var{options} is a @code{&}-separated list. The following options
417 are supported:
418
419 @table @option
420
421 @item announce_addr=@var{address}
422 Specify the destination IP address for sending the announcements to.
423 If omitted, the announcements are sent to the commonly used SAP
424 announcement multicast address 224.2.127.254 (sap.mcast.net), or
425 ff0e::2:7ffe if @var{destination} is an IPv6 address.
426
427 @item announce_port=@var{port}
428 Specify the port to send the announcements on, defaults to
429 9875 if not specified.
430
431 @item ttl=@var{ttl}
432 Specify the time to live value for the announcements and RTP packets,
433 defaults to 255.
434
435 @item same_port=@var{0|1}
436 If set to 1, send all RTP streams on the same port pair. If zero (the
437 default), all streams are sent on unique ports, with each stream on a
438 port 2 numbers higher than the previous.
439 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
440 The RTP stack in libavformat for receiving requires all streams to be sent
441 on unique ports.
442 @end table
443
444 Example command lines follow.
445
446 To broadcast a stream on the local subnet, for watching in VLC:
447
448 @example
449 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
450 @end example
451
452 Similarly, for watching in @command{ffplay}:
453
454 @example
455 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255
456 @end example
457
458 And for watching in @command{ffplay}, over IPv6:
459
460 @example
461 ffmpeg -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
462 @end example
463
464 @subsection Demuxer
465
466 The syntax for a SAP url given to the demuxer is:
467 @example
468 sap://[@var{address}][:@var{port}]
469 @end example
470
471 @var{address} is the multicast address to listen for announcements on,
472 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
473 is the port that is listened on, 9875 if omitted.
474
475 The demuxers listens for announcements on the given address and port.
476 Once an announcement is received, it tries to receive that particular stream.
477
478 Example command lines follow.
479
480 To play back the first stream announced on the normal SAP multicast address:
481
482 @example
483 ffplay sap://
484 @end example
485
486 To play back the first stream announced on one the default IPv6 SAP multicast address:
487
488 @example
489 ffplay sap://[ff0e::2:7ffe]
490 @end example
491
492 @section tcp
493
494 Trasmission Control Protocol.
495
496 The required syntax for a TCP url is:
497 @example
498 tcp://@var{hostname}:@var{port}[?@var{options}]
499 @end example
500
501 @table @option
502
503 @item listen
504 Listen for an incoming connection
505
506 @example
507 ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
508 ffplay tcp://@var{hostname}:@var{port}
509 @end example
510
511 @end table
512
513 @section udp
514
515 User Datagram Protocol.
516
517 The required syntax for a UDP url is:
518 @example
519 udp://@var{hostname}:@var{port}[?@var{options}]
520 @end example
521
522 @var{options} contains a list of &-seperated options of the form @var{key}=@var{val}.
523 Follow the list of supported options.
524
525 @table @option
526
527 @item buffer_size=@var{size}
528 set the UDP buffer size in bytes
529
530 @item localport=@var{port}
531 override the local UDP port to bind with
532
533 @item localaddr=@var{addr}
534 Choose the local IP address. This is useful e.g. if sending multicast
535 and the host has multiple interfaces, where the user can choose
536 which interface to send on by specifying the IP address of that interface.
537
538 @item pkt_size=@var{size}
539 set the size in bytes of UDP packets
540
541 @item reuse=@var{1|0}
542 explicitly allow or disallow reusing UDP sockets
543
544 @item ttl=@var{ttl}
545 set the time to live value (for multicast only)
546
547 @item connect=@var{1|0}
548 Initialize the UDP socket with @code{connect()}. In this case, the
549 destination address can't be changed with ff_udp_set_remote_url later.
550 If the destination address isn't known at the start, this option can
551 be specified in ff_udp_set_remote_url, too.
552 This allows finding out the source address for the packets with getsockname,
553 and makes writes return with AVERROR(ECONNREFUSED) if "destination
554 unreachable" is received.
555 For receiving, this gives the benefit of only receiving packets from
556 the specified peer address/port.
557 @end table
558
559 Some usage examples of the udp protocol with @command{ffmpeg} follow.
560
561 To stream over UDP to a remote endpoint:
562 @example
563 ffmpeg -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
564 @end example
565
566 To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer:
567 @example
568 ffmpeg -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
569 @end example
570
571 To receive over UDP from a remote endpoint:
572 @example
573 ffmpeg -i udp://[@var{multicast-address}]:@var{port}
574 @end example
575
576 @c man end PROTOCOLS