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