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