lavfi/kerndeint: remove unused pixel_step.
[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 data
79
80 Data in-line in the URI. See @url{http://en.wikipedia.org/wiki/Data_URI_scheme}.
81
82 For example, to convert a GIF file given inline with @command{ffmpeg}:
83 @example
84 ffmpeg -i "data:image/gif;base64,R0lGODdhCAAIAMIEAAAAAAAA//8AAP//AP///////////////ywAAAAACAAIAAADF0gEDLojDgdGiJdJqUX02iB4E8Q9jUMkADs=" smiley.png
85 @end example
86
87 @section file
88
89 File access protocol.
90
91 Allow to read from or read to a file.
92
93 For example to read from a file @file{input.mpeg} with @command{ffmpeg}
94 use the command:
95 @example
96 ffmpeg -i file:input.mpeg output.mpeg
97 @end example
98
99 The ff* tools default to the file protocol, that is a resource
100 specified with the name "FILE.mpeg" is interpreted as the URL
101 "file:FILE.mpeg".
102
103 @section gopher
104
105 Gopher protocol.
106
107 @section hls
108
109 Read Apple HTTP Live Streaming compliant segmented stream as
110 a uniform one. The M3U8 playlists describing the segments can be
111 remote HTTP resources or local files, accessed using the standard
112 file protocol.
113 The nested protocol is declared by specifying
114 "+@var{proto}" after the hls URI scheme name, where @var{proto}
115 is either "file" or "http".
116
117 @example
118 hls+http://host/path/to/remote/resource.m3u8
119 hls+file://path/to/local/resource.m3u8
120 @end example
121
122 Using this protocol is discouraged - the hls demuxer should work
123 just as well (if not, please report the issues) and is more complete.
124 To use the hls demuxer instead, simply use the direct URLs to the
125 m3u8 files.
126
127 @section http
128
129 HTTP (Hyper Text Transfer Protocol).
130
131 @section mmst
132
133 MMS (Microsoft Media Server) protocol over TCP.
134
135 @section mmsh
136
137 MMS (Microsoft Media Server) protocol over HTTP.
138
139 The required syntax is:
140 @example
141 mmsh://@var{server}[:@var{port}][/@var{app}][/@var{playpath}]
142 @end example
143
144 @section md5
145
146 MD5 output protocol.
147
148 Computes the MD5 hash of the data to be written, and on close writes
149 this to the designated output or stdout if none is specified. It can
150 be used to test muxers without writing an actual file.
151
152 Some examples follow.
153 @example
154 # Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
155 ffmpeg -i input.flv -f avi -y md5:output.avi.md5
156
157 # Write the MD5 hash of the encoded AVI file to stdout.
158 ffmpeg -i input.flv -f avi -y md5:
159 @end example
160
161 Note that some formats (typically MOV) require the output protocol to
162 be seekable, so they will fail with the MD5 output protocol.
163
164 @section pipe
165
166 UNIX pipe access protocol.
167
168 Allow to read and write from UNIX pipes.
169
170 The accepted syntax is:
171 @example
172 pipe:[@var{number}]
173 @end example
174
175 @var{number} is the number corresponding to the file descriptor of the
176 pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).  If @var{number}
177 is not specified, by default the stdout file descriptor will be used
178 for writing, stdin for reading.
179
180 For example to read from stdin with @command{ffmpeg}:
181 @example
182 cat test.wav | ffmpeg -i pipe:0
183 # ...this is the same as...
184 cat test.wav | ffmpeg -i pipe:
185 @end example
186
187 For writing to stdout with @command{ffmpeg}:
188 @example
189 ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
190 # ...this is the same as...
191 ffmpeg -i test.wav -f avi pipe: | cat > test.avi
192 @end example
193
194 Note that some formats (typically MOV), require the output protocol to
195 be seekable, so they will fail with the pipe output protocol.
196
197 @section rtmp
198
199 Real-Time Messaging Protocol.
200
201 The Real-Time Messaging Protocol (RTMP) is used for streaming multimedia
202 content across a TCP/IP network.
203
204 The required syntax is:
205 @example
206 rtmp://@var{server}[:@var{port}][/@var{app}][/@var{instance}][/@var{playpath}]
207 @end example
208
209 The accepted parameters are:
210 @table @option
211
212 @item server
213 The address of the RTMP server.
214
215 @item port
216 The number of the TCP port to use (by default is 1935).
217
218 @item app
219 It is the name of the application to access. It usually corresponds to
220 the path where the application is installed on the RTMP server
221 (e.g. @file{/ondemand/}, @file{/flash/live/}, etc.). You can override
222 the value parsed from the URI through the @code{rtmp_app} option, too.
223
224 @item playpath
225 It is the path or name of the resource to play with reference to the
226 application specified in @var{app}, may be prefixed by "mp4:". You
227 can override the value parsed from the URI through the @code{rtmp_playpath}
228 option, too.
229
230 @item listen
231 Act as a server, listening for an incoming connection.
232
233 @item timeout
234 Maximum time to wait for the incoming connection. Implies listen.
235 @end table
236
237 Additionally, the following parameters can be set via command line options
238 (or in code via @code{AVOption}s):
239 @table @option
240
241 @item rtmp_app
242 Name of application to connect on the RTMP server. This option
243 overrides the parameter specified in the URI.
244
245 @item rtmp_buffer
246 Set the client buffer time in milliseconds. The default is 3000.
247
248 @item rtmp_conn
249 Extra arbitrary AMF connection parameters, parsed from a string,
250 e.g. like @code{B:1 S:authMe O:1 NN:code:1.23 NS:flag:ok O:0}.
251 Each value is prefixed by a single character denoting the type,
252 B for Boolean, N for number, S for string, O for object, or Z for null,
253 followed by a colon. For Booleans the data must be either 0 or 1 for
254 FALSE or TRUE, respectively.  Likewise for Objects the data must be 0 or
255 1 to end or begin an object, respectively. Data items in subobjects may
256 be named, by prefixing the type with 'N' and specifying the name before
257 the value (i.e. @code{NB:myFlag:1}). This option may be used multiple
258 times to construct arbitrary AMF sequences.
259
260 @item rtmp_flashver
261 Version of the Flash plugin used to run the SWF player. The default
262 is LNX 9,0,124,2.
263
264 @item rtmp_flush_interval
265 Number of packets flushed in the same request (RTMPT only). The default
266 is 10.
267
268 @item rtmp_live
269 Specify that the media is a live stream. No resuming or seeking in
270 live streams is possible. The default value is @code{any}, which means the
271 subscriber first tries to play the live stream specified in the
272 playpath. If a live stream of that name is not found, it plays the
273 recorded stream. The other possible values are @code{live} and
274 @code{recorded}.
275
276 @item rtmp_pageurl
277 URL of the web page in which the media was embedded. By default no
278 value will be sent.
279
280 @item rtmp_playpath
281 Stream identifier to play or to publish. This option overrides the
282 parameter specified in the URI.
283
284 @item rtmp_subscribe
285 Name of live stream to subscribe to. By default no value will be sent.
286 It is only sent if the option is specified or if rtmp_live
287 is set to live.
288
289 @item rtmp_swfhash
290 SHA256 hash of the decompressed SWF file (32 bytes).
291
292 @item rtmp_swfsize
293 Size of the decompressed SWF file, required for SWFVerification.
294
295 @item rtmp_swfurl
296 URL of the SWF player for the media. By default no value will be sent.
297
298 @item rtmp_swfverify
299 URL to player swf file, compute hash/size automatically.
300
301 @item rtmp_tcurl
302 URL of the target stream. Defaults to proto://host[:port]/app.
303
304 @end table
305
306 For example to read with @command{ffplay} a multimedia resource named
307 "sample" from the application "vod" from an RTMP server "myserver":
308 @example
309 ffplay rtmp://myserver/vod/sample
310 @end example
311
312 @section rtmpe
313
314 Encrypted Real-Time Messaging Protocol.
315
316 The Encrypted Real-Time Messaging Protocol (RTMPE) is used for
317 streaming multimedia content within standard cryptographic primitives,
318 consisting of Diffie-Hellman key exchange and HMACSHA256, generating
319 a pair of RC4 keys.
320
321 @section rtmps
322
323 Real-Time Messaging Protocol over a secure SSL connection.
324
325 The Real-Time Messaging Protocol (RTMPS) is used for streaming
326 multimedia content across an encrypted connection.
327
328 @section rtmpt
329
330 Real-Time Messaging Protocol tunneled through HTTP.
331
332 The Real-Time Messaging Protocol tunneled through HTTP (RTMPT) is used
333 for streaming multimedia content within HTTP requests to traverse
334 firewalls.
335
336 @section rtmpte
337
338 Encrypted Real-Time Messaging Protocol tunneled through HTTP.
339
340 The Encrypted Real-Time Messaging Protocol tunneled through HTTP (RTMPTE)
341 is used for streaming multimedia content within HTTP requests to traverse
342 firewalls.
343
344 @section rtmpts
345
346 Real-Time Messaging Protocol tunneled through HTTPS.
347
348 The Real-Time Messaging Protocol tunneled through HTTPS (RTMPTS) is used
349 for streaming multimedia content within HTTPS requests to traverse
350 firewalls.
351
352 @section rtmp, rtmpe, rtmps, rtmpt, rtmpte
353
354 Real-Time Messaging Protocol and its variants supported through
355 librtmp.
356
357 Requires the presence of the librtmp headers and library during
358 configuration. You need to explicitly configure the build with
359 "--enable-librtmp". If enabled this will replace the native RTMP
360 protocol.
361
362 This protocol provides most client functions and a few server
363 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
364 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
365 variants of these encrypted types (RTMPTE, RTMPTS).
366
367 The required syntax is:
368 @example
369 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
370 @end example
371
372 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
373 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
374 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
375 meaning as specified for the RTMP native protocol.
376 @var{options} contains a list of space-separated options of the form
377 @var{key}=@var{val}.
378
379 See the librtmp manual page (man 3 librtmp) for more information.
380
381 For example, to stream a file in real-time to an RTMP server using
382 @command{ffmpeg}:
383 @example
384 ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
385 @end example
386
387 To play the same stream using @command{ffplay}:
388 @example
389 ffplay "rtmp://myserver/live/mystream live=1"
390 @end example
391
392 @section rtp
393
394 Real-Time Protocol.
395
396 @section rtsp
397
398 RTSP is not technically a protocol handler in libavformat, it is a demuxer
399 and muxer. The demuxer supports both normal RTSP (with data transferred
400 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
401 data transferred over RDT).
402
403 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
404 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
405 @uref{http://github.com/revmischa/rtsp-server, RTSP server}).
406
407 The required syntax for a RTSP url is:
408 @example
409 rtsp://@var{hostname}[:@var{port}]/@var{path}
410 @end example
411
412 The following options (set on the @command{ffmpeg}/@command{ffplay} command
413 line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
414 are supported:
415
416 Flags for @code{rtsp_transport}:
417
418 @table @option
419
420 @item udp
421 Use UDP as lower transport protocol.
422
423 @item tcp
424 Use TCP (interleaving within the RTSP control channel) as lower
425 transport protocol.
426
427 @item udp_multicast
428 Use UDP multicast as lower transport protocol.
429
430 @item http
431 Use HTTP tunneling as lower transport protocol, which is useful for
432 passing proxies.
433 @end table
434
435 Multiple lower transport protocols may be specified, in that case they are
436 tried one at a time (if the setup of one fails, the next one is tried).
437 For the muxer, only the @code{tcp} and @code{udp} options are supported.
438
439 Flags for @code{rtsp_flags}:
440
441 @table @option
442 @item filter_src
443 Accept packets only from negotiated peer address and port.
444 @item listen
445 Act as a server, listening for an incoming connection.
446 @end table
447
448 When receiving data over UDP, the demuxer tries to reorder received packets
449 (since they may arrive out of order, or packets may get lost totally). This
450 can be disabled by setting the maximum demuxing delay to zero (via
451 the @code{max_delay} field of AVFormatContext).
452
453 When watching multi-bitrate Real-RTSP streams with @command{ffplay}, the
454 streams to display can be chosen with @code{-vst} @var{n} and
455 @code{-ast} @var{n} for video and audio respectively, and can be switched
456 on the fly by pressing @code{v} and @code{a}.
457
458 Example command lines:
459
460 To watch a stream over UDP, with a max reordering delay of 0.5 seconds:
461
462 @example
463 ffplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
464 @end example
465
466 To watch a stream tunneled over HTTP:
467
468 @example
469 ffplay -rtsp_transport http rtsp://server/video.mp4
470 @end example
471
472 To send a stream in realtime to a RTSP server, for others to watch:
473
474 @example
475 ffmpeg -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
476 @end example
477
478 To receive a stream in realtime:
479
480 @example
481 ffmpeg -rtsp_flags listen -i rtsp://ownaddress/live.sdp @var{output}
482 @end example
483
484 @section sap
485
486 Session Announcement Protocol (RFC 2974). This is not technically a
487 protocol handler in libavformat, it is a muxer and demuxer.
488 It is used for signalling of RTP streams, by announcing the SDP for the
489 streams regularly on a separate port.
490
491 @subsection Muxer
492
493 The syntax for a SAP url given to the muxer is:
494 @example
495 sap://@var{destination}[:@var{port}][?@var{options}]
496 @end example
497
498 The RTP packets are sent to @var{destination} on port @var{port},
499 or to port 5004 if no port is specified.
500 @var{options} is a @code{&}-separated list. The following options
501 are supported:
502
503 @table @option
504
505 @item announce_addr=@var{address}
506 Specify the destination IP address for sending the announcements to.
507 If omitted, the announcements are sent to the commonly used SAP
508 announcement multicast address 224.2.127.254 (sap.mcast.net), or
509 ff0e::2:7ffe if @var{destination} is an IPv6 address.
510
511 @item announce_port=@var{port}
512 Specify the port to send the announcements on, defaults to
513 9875 if not specified.
514
515 @item ttl=@var{ttl}
516 Specify the time to live value for the announcements and RTP packets,
517 defaults to 255.
518
519 @item same_port=@var{0|1}
520 If set to 1, send all RTP streams on the same port pair. If zero (the
521 default), all streams are sent on unique ports, with each stream on a
522 port 2 numbers higher than the previous.
523 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
524 The RTP stack in libavformat for receiving requires all streams to be sent
525 on unique ports.
526 @end table
527
528 Example command lines follow.
529
530 To broadcast a stream on the local subnet, for watching in VLC:
531
532 @example
533 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
534 @end example
535
536 Similarly, for watching in @command{ffplay}:
537
538 @example
539 ffmpeg -re -i @var{input} -f sap sap://224.0.0.255
540 @end example
541
542 And for watching in @command{ffplay}, over IPv6:
543
544 @example
545 ffmpeg -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
546 @end example
547
548 @subsection Demuxer
549
550 The syntax for a SAP url given to the demuxer is:
551 @example
552 sap://[@var{address}][:@var{port}]
553 @end example
554
555 @var{address} is the multicast address to listen for announcements on,
556 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
557 is the port that is listened on, 9875 if omitted.
558
559 The demuxers listens for announcements on the given address and port.
560 Once an announcement is received, it tries to receive that particular stream.
561
562 Example command lines follow.
563
564 To play back the first stream announced on the normal SAP multicast address:
565
566 @example
567 ffplay sap://
568 @end example
569
570 To play back the first stream announced on one the default IPv6 SAP multicast address:
571
572 @example
573 ffplay sap://[ff0e::2:7ffe]
574 @end example
575
576 @section tcp
577
578 Trasmission Control Protocol.
579
580 The required syntax for a TCP url is:
581 @example
582 tcp://@var{hostname}:@var{port}[?@var{options}]
583 @end example
584
585 @table @option
586
587 @item listen
588 Listen for an incoming connection
589
590 @item timeout=@var{microseconds}
591 In read mode: if no data arrived in more than this time interval, raise error.
592 In write mode: if socket cannot be written in more than this time interval, raise error.
593 This also sets timeout on TCP connection establishing.
594
595 @example
596 ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
597 ffplay tcp://@var{hostname}:@var{port}
598 @end example
599
600 @end table
601
602 @section tls
603
604 Transport Layer Security/Secure Sockets Layer
605
606 The required syntax for a TLS/SSL url is:
607 @example
608 tls://@var{hostname}:@var{port}[?@var{options}]
609 @end example
610
611 @table @option
612
613 @item listen
614 Act as a server, listening for an incoming connection.
615
616 @item cafile=@var{filename}
617 Certificate authority file. The file must be in OpenSSL PEM format.
618
619 @item cert=@var{filename}
620 Certificate file. The file must be in OpenSSL PEM format.
621
622 @item key=@var{filename}
623 Private key file.
624
625 @item verify=@var{0|1}
626 Verify the peer's certificate.
627
628 @end table
629
630 Example command lines:
631
632 To create a TLS/SSL server that serves an input stream.
633
634 @example
635 ffmpeg -i @var{input} -f @var{format} tls://@var{hostname}:@var{port}?listen&cert=@var{server.crt}&key=@var{server.key}
636 @end example
637
638 To play back a stream from the TLS/SSL server using @command{ffplay}:
639
640 @example
641 ffplay tls://@var{hostname}:@var{port}
642 @end example
643
644 @section udp
645
646 User Datagram Protocol.
647
648 The required syntax for a UDP url is:
649 @example
650 udp://@var{hostname}:@var{port}[?@var{options}]
651 @end example
652
653 @var{options} contains a list of &-separated options of the form @var{key}=@var{val}.
654
655 In case threading is enabled on the system, a circular buffer is used
656 to store the incoming data, which allows to reduce loss of data due to
657 UDP socket buffer overruns. The @var{fifo_size} and
658 @var{overrun_nonfatal} options are related to this buffer.
659
660 The list of supported options follows.
661
662 @table @option
663
664 @item buffer_size=@var{size}
665 Set the UDP socket buffer size in bytes. This is used both for the
666 receiving and the sending buffer size.
667
668 @item localport=@var{port}
669 Override the local UDP port to bind with.
670
671 @item localaddr=@var{addr}
672 Choose the local IP address. This is useful e.g. if sending multicast
673 and the host has multiple interfaces, where the user can choose
674 which interface to send on by specifying the IP address of that interface.
675
676 @item pkt_size=@var{size}
677 Set the size in bytes of UDP packets.
678
679 @item reuse=@var{1|0}
680 Explicitly allow or disallow reusing UDP sockets.
681
682 @item ttl=@var{ttl}
683 Set the time to live value (for multicast only).
684
685 @item connect=@var{1|0}
686 Initialize the UDP socket with @code{connect()}. In this case, the
687 destination address can't be changed with ff_udp_set_remote_url later.
688 If the destination address isn't known at the start, this option can
689 be specified in ff_udp_set_remote_url, too.
690 This allows finding out the source address for the packets with getsockname,
691 and makes writes return with AVERROR(ECONNREFUSED) if "destination
692 unreachable" is received.
693 For receiving, this gives the benefit of only receiving packets from
694 the specified peer address/port.
695
696 @item sources=@var{address}[,@var{address}]
697 Only receive packets sent to the multicast group from one of the
698 specified sender IP addresses.
699
700 @item block=@var{address}[,@var{address}]
701 Ignore packets sent to the multicast group from the specified
702 sender IP addresses.
703
704 @item fifo_size=@var{units}
705 Set the UDP receiving circular buffer size, expressed as a number of
706 packets with size of 188 bytes. If not specified defaults to 7*4096.
707
708 @item overrun_nonfatal=@var{1|0}
709 Survive in case of UDP receiving circular buffer overrun. Default
710 value is 0.
711
712 @item timeout=@var{microseconds}
713 In read mode: if no data arrived in more than this time interval, raise error.
714 @end table
715
716 Some usage examples of the UDP protocol with @command{ffmpeg} follow.
717
718 To stream over UDP to a remote endpoint:
719 @example
720 ffmpeg -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
721 @end example
722
723 To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer:
724 @example
725 ffmpeg -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
726 @end example
727
728 To receive over UDP from a remote endpoint:
729 @example
730 ffmpeg -i udp://[@var{multicast-address}]:@var{port}
731 @end example
732
733 @c man end PROTOCOLS