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