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