2 * RTMP HTTP network protocol
3 * Copyright (c) 2012 Samuel Pitoiset
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27 #include "libavutil/avstring.h"
28 #include "libavutil/intfloat.h"
29 #include "libavutil/opt.h"
30 #include "libavutil/time.h"
34 #define RTMPT_DEFAULT_PORT 80
36 /* protocol handler context */
37 typedef struct RTMP_HTTPContext {
38 URLContext *stream; ///< HTTP stream
39 char host[256]; ///< hostname of the server
40 int port; ///< port to connect (default is 80)
41 char client_id[64]; ///< client ID used for all requests except the first one
42 int seq; ///< sequence ID used for all requests
43 uint8_t *out_data; ///< output buffer
44 int out_size; ///< current output buffer size
45 int out_capacity; ///< current output buffer capacity
46 int initialized; ///< flag indicating when the http context is initialized
47 int finishing; ///< flag indicating when the client closes the connection
48 int nb_bytes_read; ///< number of bytes read since the last request
51 static int rtmp_http_send_cmd(URLContext *h, const char *cmd)
53 RTMP_HTTPContext *rt = h->priv_data;
58 ff_url_join(uri, sizeof(uri), "http", NULL, rt->host, rt->port,
59 "/%s/%s/%d", cmd, rt->client_id, rt->seq++);
61 av_opt_set_bin(rt->stream->priv_data, "post_data", rt->out_data,
64 /* send a new request to the server */
65 if ((ret = ff_http_do_new_request(rt->stream, uri)) < 0)
68 /* re-init output buffer */
71 /* read the first byte which contains the polling interval */
72 if ((ret = ffurl_read(rt->stream, &c, 1)) < 0)
75 /* re-init the number of bytes read */
76 rt->nb_bytes_read = 0;
81 static int rtmp_http_write(URLContext *h, const uint8_t *buf, int size)
83 RTMP_HTTPContext *rt = h->priv_data;
86 if (rt->out_size + size > rt->out_capacity) {
87 rt->out_capacity = (rt->out_size + size) * 2;
88 ptr = av_realloc(rt->out_data, rt->out_capacity);
90 return AVERROR(ENOMEM);
94 memcpy(rt->out_data + rt->out_size, buf, size);
100 static int rtmp_http_read(URLContext *h, uint8_t *buf, int size)
102 RTMP_HTTPContext *rt = h->priv_data;
105 /* try to read at least 1 byte of data */
107 ret = ffurl_read(rt->stream, buf + off, size);
108 if (ret < 0 && ret != AVERROR_EOF)
111 if (ret == AVERROR_EOF) {
113 /* Do not send new requests when the client wants to
114 * close the connection. */
115 return AVERROR(EAGAIN);
118 /* When the client has reached end of file for the last request,
119 * we have to send a new request if we have buffered data.
120 * Otherwise, we have to send an idle POST. */
121 if (rt->out_size > 0) {
122 if ((ret = rtmp_http_send_cmd(h, "send")) < 0)
125 if (rt->nb_bytes_read == 0) {
126 /* Wait 50ms before retrying to read a server reply in
127 * order to reduce the number of idle requets. */
131 if ((ret = rtmp_http_write(h, "", 1)) < 0)
134 if ((ret = rtmp_http_send_cmd(h, "idle")) < 0)
138 if (h->flags & AVIO_FLAG_NONBLOCK) {
139 /* no incoming data to handle in nonblocking mode */
140 return AVERROR(EAGAIN);
145 rt->nb_bytes_read += ret;
152 static int rtmp_http_close(URLContext *h)
154 RTMP_HTTPContext *rt = h->priv_data;
155 uint8_t tmp_buf[2048];
158 if (rt->initialized) {
159 /* client wants to close the connection */
163 ret = rtmp_http_read(h, tmp_buf, sizeof(tmp_buf));
166 /* re-init output buffer before sending the close command */
169 if ((ret = rtmp_http_write(h, "", 1)) == 1)
170 ret = rtmp_http_send_cmd(h, "close");
173 av_freep(&rt->out_data);
174 ffurl_close(rt->stream);
179 static int rtmp_http_open(URLContext *h, const char *uri, int flags)
181 RTMP_HTTPContext *rt = h->priv_data;
182 char headers[1024], url[1024];
185 av_url_split(NULL, 0, NULL, 0, rt->host, sizeof(rt->host), &rt->port,
189 rt->port = RTMPT_DEFAULT_PORT;
191 /* This is the first request that is sent to the server in order to
192 * register a client on the server and start a new session. The server
193 * replies with a unique id (usually a number) that is used by the client
194 * for all future requests.
195 * Note: the reply doesn't contain a value for the polling interval.
196 * A successful connect resets the consecutive index that is used
198 ff_url_join(url, sizeof(url), "http", NULL, rt->host, rt->port, "/open/1");
200 /* alloc the http context */
201 if ((ret = ffurl_alloc(&rt->stream, url, AVIO_FLAG_READ_WRITE, NULL)) < 0)
205 snprintf(headers, sizeof(headers),
206 "Cache-Control: no-cache\r\n"
207 "Content-type: application/x-fcs\r\n"
208 "User-Agent: Shockwave Flash\r\n");
209 av_opt_set(rt->stream->priv_data, "headers", headers, 0);
210 av_opt_set(rt->stream->priv_data, "multiple_requests", "1", 0);
211 av_opt_set_bin(rt->stream->priv_data, "post_data", "", 1, 0);
213 /* open the http context */
214 if ((ret = ffurl_connect(rt->stream, NULL)) < 0)
217 /* read the server reply which contains a unique ID */
219 ret = ffurl_read(rt->stream, rt->client_id + off, sizeof(rt->client_id) - off);
220 if (ret == AVERROR_EOF)
225 if (off == sizeof(rt->client_id)) {
230 while (off > 0 && isspace(rt->client_id[off - 1]))
232 rt->client_id[off] = '\0';
234 /* http context is now initialized */
243 URLProtocol ff_rtmphttp_protocol = {
245 .url_open = rtmp_http_open,
246 .url_read = rtmp_http_read,
247 .url_write = rtmp_http_write,
248 .url_close = rtmp_http_close,
249 .priv_data_size = sizeof(RTMP_HTTPContext),
250 .flags = URL_PROTOCOL_FLAG_NETWORK,