MMSH support, the most popular and widely used of all MMS variants. Written by
[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 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 @file{ffplay} use the
40 command:
41 @example
42 ffplay 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 @file{ffmpeg}
55 use the command:
56 @example
57 ffmpeg -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 http
69
70 HTTP (Hyper Text Transfer Protocol).
71
72 @section mmst
73
74 MMS (Microsoft Media Server) protocol over TCP.
75
76 @section mmsh
77
78 MMS (Microsoft Media Server) protocol over HTTP.
79
80 The required syntax is:
81 @example
82 mmsh://@var{server}[:@var{port}][/@var{app}][/@var{playpath}]
83 @end example
84
85 @section md5
86
87 MD5 output protocol.
88
89 Computes the MD5 hash of the data to be written, and on close writes
90 this to the designated output or stdout if none is specified. It can
91 be used to test muxers without writing an actual file.
92
93 Some examples follow.
94 @example
95 # Write the MD5 hash of the encoded AVI file to the file output.avi.md5.
96 ffmpeg -i input.flv -f avi -y md5:output.avi.md5
97
98 # Write the MD5 hash of the encoded AVI file to stdout.
99 ffmpeg -i input.flv -f avi -y md5:
100 @end example
101
102 Note that some formats (typically MOV) require the output protocol to
103 be seekable, so they will fail with the MD5 output protocol.
104
105 @section pipe
106
107 UNIX pipe access protocol.
108
109 Allow to read and write from UNIX pipes.
110
111 The accepted syntax is:
112 @example
113 pipe:[@var{number}]
114 @end example
115
116 @var{number} is the number corresponding to the file descriptor of the
117 pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).  If @var{number}
118 is not specified, by default the stdout file descriptor will be used
119 for writing, stdin for reading.
120
121 For example to read from stdin with @file{ffmpeg}:
122 @example
123 cat test.wav | ffmpeg -i pipe:0
124 # ...this is the same as...
125 cat test.wav | ffmpeg -i pipe:
126 @end example
127
128 For writing to stdout with @file{ffmpeg}:
129 @example
130 ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
131 # ...this is the same as...
132 ffmpeg -i test.wav -f avi pipe: | cat > test.avi
133 @end example
134
135 Note that some formats (typically MOV), require the output protocol to
136 be seekable, so they will fail with the pipe output protocol.
137
138 @section rtmp
139
140 Real-Time Messaging Protocol.
141
142 The Real-Time Messaging Protocol (RTMP) is used for streaming multimeā€
143 dia content across a TCP/IP network.
144
145 The required syntax is:
146 @example
147 rtmp://@var{server}[:@var{port}][/@var{app}][/@var{playpath}]
148 @end example
149
150 The accepted parameters are:
151 @table @option
152
153 @item server
154 The address of the RTMP server.
155
156 @item port
157 The number of the TCP port to use (by default is 1935).
158
159 @item app
160 It is the name of the application to access. It usually corresponds to
161 the path where the application is installed on the RTMP server
162 (e.g. @file{/ondemand/}, @file{/flash/live/}, etc.).
163
164 @item playpath
165 It is the path or name of the resource to play with reference to the
166 application specified in @var{app}, may be prefixed by "mp4:".
167
168 @end table
169
170 For example to read with @file{ffplay} a multimedia resource named
171 "sample" from the application "vod" from an RTMP server "myserver":
172 @example
173 ffplay rtmp://myserver/vod/sample
174 @end example
175
176 @section rtmp, rtmpe, rtmps, rtmpt, rtmpte
177
178 Real-Time Messaging Protocol and its variants supported through
179 librtmp.
180
181 Requires the presence of the librtmp headers and library during
182 configuration. You need to explicitely configure the build with
183 "--enable-librtmp". If enabled this will replace the native RTMP
184 protocol.
185
186 This protocol provides most client functions and a few server
187 functions needed to support RTMP, RTMP tunneled in HTTP (RTMPT),
188 encrypted RTMP (RTMPE), RTMP over SSL/TLS (RTMPS) and tunneled
189 variants of these encrypted types (RTMPTE, RTMPTS).
190
191 The required syntax is:
192 @example
193 @var{rtmp_proto}://@var{server}[:@var{port}][/@var{app}][/@var{playpath}] @var{options}
194 @end example
195
196 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
197 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
198 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
199 meaning as specified for the RTMP native protocol.
200 @var{options} contains a list of space-separated options of the form
201 @var{key}=@var{val}.
202
203 See the librtmp manual page (man 3 librtmp) for more information.
204
205 For example, to stream a file in real-time to an RTMP server using
206 @file{ffmpeg}:
207 @example
208 ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream
209 @end example
210
211 To play the same stream using @file{ffplay}:
212 @example
213 ffplay "rtmp://myserver/live/mystream live=1"
214 @end example
215
216 @section rtp
217
218 Real-Time Protocol.
219
220 @section tcp
221
222 Trasmission Control Protocol.
223
224 @section udp
225
226 User Datagram Protocol.
227
228 @c man end PROTOCOLS