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