doc: Add documentation for the newly added rtmp_* options
[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_flashver
202 Version of the Flash plugin used to run the SWF player. The default
203 is LNX 9,0,124,2.
204
205 @item rtmp_live
206 Specify that the media is a live stream. No resuming or seeking in
207 live streams is possible. The default value is @code{any}, which means the
208 subscriber first tries to play the live stream specified in the
209 playpath. If a live stream of that name is not found, it plays the
210 recorded stream. The other possible values are @code{live} and
211 @code{recorded}.
212
213 @item rtmp_playpath
214 Stream identifier to play or to publish. This option overrides the
215 parameter specified in the URI.
216
217 @item rtmp_swfurl
218 URL of the SWF player for the media. By default no value will be sent.
219
220 @item rtmp_tcurl
221 URL of the target stream.
222
223 @end table
224
225 For example to read with @command{avplay} a multimedia resource named
226 "sample" from the application "vod" from an RTMP server "myserver":
227 @example
228 avplay rtmp://myserver/vod/sample
229 @end example
230
231 @section rtmp, rtmpe, rtmps, rtmpt, rtmpte
232
233 Real-Time Messaging Protocol and its variants supported through
234 librtmp.
235
236 Requires the presence of the librtmp headers and library during
237 configuration. You need to explicitly configure the build with
238 "--enable-librtmp". If enabled this will replace the native RTMP
239 protocol.
240
241 This protocol provides most client functions and a few server
242 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
243 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
244 variants of these encrypted types (RTMPTE, RTMPTS).
245
246 The required syntax is:
247 @example
248 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
249 @end example
250
251 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
252 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
253 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
254 meaning as specified for the RTMP native protocol.
255 @var{options} contains a list of space-separated options of the form
256 @var{key}=@var{val}.
257
258 See the librtmp manual page (man 3 librtmp) for more information.
259
260 For example, to stream a file in real-time to an RTMP server using
261 @command{avconv}:
262 @example
263 avconv -re -i myfile -f flv rtmp://myserver/live/mystream
264 @end example
265
266 To play the same stream using @command{avplay}:
267 @example
268 avplay "rtmp://myserver/live/mystream live=1"
269 @end example
270
271 @section rtp
272
273 Real-Time Protocol.
274
275 @section rtsp
276
277 RTSP is not technically a protocol handler in libavformat, it is a demuxer
278 and muxer. The demuxer supports both normal RTSP (with data transferred
279 over RTP; this is used by e.g. Apple and Microsoft) and Real-RTSP (with
280 data transferred over RDT).
281
282 The muxer can be used to send a stream using RTSP ANNOUNCE to a server
283 supporting it (currently Darwin Streaming Server and Mischa Spiegelmock's
284 @uref{http://github.com/revmischa/rtsp-server, RTSP server}).
285
286 The required syntax for a RTSP url is:
287 @example
288 rtsp://@var{hostname}[:@var{port}]/@var{path}
289 @end example
290
291 The following options (set on the @command{avconv}/@command{avplay} command
292 line, or set in code via @code{AVOption}s or in @code{avformat_open_input}),
293 are supported:
294
295 Flags for @code{rtsp_transport}:
296
297 @table @option
298
299 @item udp
300 Use UDP as lower transport protocol.
301
302 @item tcp
303 Use TCP (interleaving within the RTSP control channel) as lower
304 transport protocol.
305
306 @item udp_multicast
307 Use UDP multicast as lower transport protocol.
308
309 @item http
310 Use HTTP tunneling as lower transport protocol, which is useful for
311 passing proxies.
312 @end table
313
314 Multiple lower transport protocols may be specified, in that case they are
315 tried one at a time (if the setup of one fails, the next one is tried).
316 For the muxer, only the @code{tcp} and @code{udp} options are supported.
317
318 Flags for @code{rtsp_flags}:
319
320 @table @option
321 @item filter_src
322 Accept packets only from negotiated peer address and port.
323 @end table
324
325 When receiving data over UDP, the demuxer tries to reorder received packets
326 (since they may arrive out of order, or packets may get lost totally). This
327 can be disabled by setting the maximum demuxing delay to zero (via
328 the @code{max_delay} field of AVFormatContext).
329
330 When watching multi-bitrate Real-RTSP streams with @command{avplay}, the
331 streams to display can be chosen with @code{-vst} @var{n} and
332 @code{-ast} @var{n} for video and audio respectively, and can be switched
333 on the fly by pressing @code{v} and @code{a}.
334
335 Example command lines:
336
337 To watch a stream over UDP, with a max reordering delay of 0.5 seconds:
338
339 @example
340 avplay -max_delay 500000 -rtsp_transport udp rtsp://server/video.mp4
341 @end example
342
343 To watch a stream tunneled over HTTP:
344
345 @example
346 avplay -rtsp_transport http rtsp://server/video.mp4
347 @end example
348
349 To send a stream in realtime to a RTSP server, for others to watch:
350
351 @example
352 avconv -re -i @var{input} -f rtsp -muxdelay 0.1 rtsp://server/live.sdp
353 @end example
354
355 @section sap
356
357 Session Announcement Protocol (RFC 2974). This is not technically a
358 protocol handler in libavformat, it is a muxer and demuxer.
359 It is used for signalling of RTP streams, by announcing the SDP for the
360 streams regularly on a separate port.
361
362 @subsection Muxer
363
364 The syntax for a SAP url given to the muxer is:
365 @example
366 sap://@var{destination}[:@var{port}][?@var{options}]
367 @end example
368
369 The RTP packets are sent to @var{destination} on port @var{port},
370 or to port 5004 if no port is specified.
371 @var{options} is a @code{&}-separated list. The following options
372 are supported:
373
374 @table @option
375
376 @item announce_addr=@var{address}
377 Specify the destination IP address for sending the announcements to.
378 If omitted, the announcements are sent to the commonly used SAP
379 announcement multicast address 224.2.127.254 (sap.mcast.net), or
380 ff0e::2:7ffe if @var{destination} is an IPv6 address.
381
382 @item announce_port=@var{port}
383 Specify the port to send the announcements on, defaults to
384 9875 if not specified.
385
386 @item ttl=@var{ttl}
387 Specify the time to live value for the announcements and RTP packets,
388 defaults to 255.
389
390 @item same_port=@var{0|1}
391 If set to 1, send all RTP streams on the same port pair. If zero (the
392 default), all streams are sent on unique ports, with each stream on a
393 port 2 numbers higher than the previous.
394 VLC/Live555 requires this to be set to 1, to be able to receive the stream.
395 The RTP stack in libavformat for receiving requires all streams to be sent
396 on unique ports.
397 @end table
398
399 Example command lines follow.
400
401 To broadcast a stream on the local subnet, for watching in VLC:
402
403 @example
404 avconv -re -i @var{input} -f sap sap://224.0.0.255?same_port=1
405 @end example
406
407 Similarly, for watching in avplay:
408
409 @example
410 avconv -re -i @var{input} -f sap sap://224.0.0.255
411 @end example
412
413 And for watching in avplay, over IPv6:
414
415 @example
416 avconv -re -i @var{input} -f sap sap://[ff0e::1:2:3:4]
417 @end example
418
419 @subsection Demuxer
420
421 The syntax for a SAP url given to the demuxer is:
422 @example
423 sap://[@var{address}][:@var{port}]
424 @end example
425
426 @var{address} is the multicast address to listen for announcements on,
427 if omitted, the default 224.2.127.254 (sap.mcast.net) is used. @var{port}
428 is the port that is listened on, 9875 if omitted.
429
430 The demuxers listens for announcements on the given address and port.
431 Once an announcement is received, it tries to receive that particular stream.
432
433 Example command lines follow.
434
435 To play back the first stream announced on the normal SAP multicast address:
436
437 @example
438 avplay sap://
439 @end example
440
441 To play back the first stream announced on one the default IPv6 SAP multicast address:
442
443 @example
444 avplay sap://[ff0e::2:7ffe]
445 @end example
446
447 @section tcp
448
449 Trasmission Control Protocol.
450
451 The required syntax for a TCP url is:
452 @example
453 tcp://@var{hostname}:@var{port}[?@var{options}]
454 @end example
455
456 @table @option
457
458 @item listen
459 Listen for an incoming connection
460
461 @example
462 avconv -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
463 avplay tcp://@var{hostname}:@var{port}
464 @end example
465
466 @end table
467
468 @section udp
469
470 User Datagram Protocol.
471
472 The required syntax for a UDP url is:
473 @example
474 udp://@var{hostname}:@var{port}[?@var{options}]
475 @end example
476
477 @var{options} contains a list of &-seperated options of the form @var{key}=@var{val}.
478 Follow the list of supported options.
479
480 @table @option
481
482 @item buffer_size=@var{size}
483 set the UDP buffer size in bytes
484
485 @item localport=@var{port}
486 override the local UDP port to bind with
487
488 @item localaddr=@var{addr}
489 Choose the local IP address. This is useful e.g. if sending multicast
490 and the host has multiple interfaces, where the user can choose
491 which interface to send on by specifying the IP address of that interface.
492
493 @item pkt_size=@var{size}
494 set the size in bytes of UDP packets
495
496 @item reuse=@var{1|0}
497 explicitly allow or disallow reusing UDP sockets
498
499 @item ttl=@var{ttl}
500 set the time to live value (for multicast only)
501
502 @item connect=@var{1|0}
503 Initialize the UDP socket with @code{connect()}. In this case, the
504 destination address can't be changed with ff_udp_set_remote_url later.
505 If the destination address isn't known at the start, this option can
506 be specified in ff_udp_set_remote_url, too.
507 This allows finding out the source address for the packets with getsockname,
508 and makes writes return with AVERROR(ECONNREFUSED) if "destination
509 unreachable" is received.
510 For receiving, this gives the benefit of only receiving packets from
511 the specified peer address/port.
512 @end table
513
514 Some usage examples of the udp protocol with @command{avconv} follow.
515
516 To stream over UDP to a remote endpoint:
517 @example
518 avconv -i @var{input} -f @var{format} udp://@var{hostname}:@var{port}
519 @end example
520
521 To stream in mpegts format over UDP using 188 sized UDP packets, using a large input buffer:
522 @example
523 avconv -i @var{input} -f mpegts udp://@var{hostname}:@var{port}?pkt_size=188&buffer_size=65535
524 @end example
525
526 To receive over UDP from a remote endpoint:
527 @example
528 avconv -i udp://[@var{multicast-address}]:@var{port}
529 @end example
530
531 @c man end PROTOCOLS