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