Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavformat / rtmppkt.c
1 /*
2  * RTMP input format
3  * Copyright (c) 2009 Kostya Shishkov
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #include "libavcodec/bytestream.h"
23 #include "libavutil/avstring.h"
24 #include "libavutil/intfloat.h"
25 #include "avformat.h"
26
27 #include "rtmppkt.h"
28 #include "flv.h"
29 #include "url.h"
30
31 void ff_amf_write_bool(uint8_t **dst, int val)
32 {
33     bytestream_put_byte(dst, AMF_DATA_TYPE_BOOL);
34     bytestream_put_byte(dst, val);
35 }
36
37 void ff_amf_write_number(uint8_t **dst, double val)
38 {
39     bytestream_put_byte(dst, AMF_DATA_TYPE_NUMBER);
40     bytestream_put_be64(dst, av_double2int(val));
41 }
42
43 void ff_amf_write_string(uint8_t **dst, const char *str)
44 {
45     bytestream_put_byte(dst, AMF_DATA_TYPE_STRING);
46     bytestream_put_be16(dst, strlen(str));
47     bytestream_put_buffer(dst, str, strlen(str));
48 }
49
50 void ff_amf_write_null(uint8_t **dst)
51 {
52     bytestream_put_byte(dst, AMF_DATA_TYPE_NULL);
53 }
54
55 void ff_amf_write_object_start(uint8_t **dst)
56 {
57     bytestream_put_byte(dst, AMF_DATA_TYPE_OBJECT);
58 }
59
60 void ff_amf_write_field_name(uint8_t **dst, const char *str)
61 {
62     bytestream_put_be16(dst, strlen(str));
63     bytestream_put_buffer(dst, str, strlen(str));
64 }
65
66 void ff_amf_write_object_end(uint8_t **dst)
67 {
68     /* first two bytes are field name length = 0,
69      * AMF object should end with it and end marker
70      */
71     bytestream_put_be24(dst, AMF_DATA_TYPE_OBJECT_END);
72 }
73
74 int ff_rtmp_packet_read(URLContext *h, RTMPPacket *p,
75                         int chunk_size, RTMPPacket *prev_pkt)
76 {
77     uint8_t hdr, t, buf[16];
78     int channel_id, timestamp, data_size, offset = 0;
79     uint32_t extra = 0;
80     enum RTMPPacketType type;
81     int size = 0;
82     int ret;
83
84     if (ffurl_read(h, &hdr, 1) != 1)
85         return AVERROR(EIO);
86     size++;
87     channel_id = hdr & 0x3F;
88
89     if (channel_id < 2) { //special case for channel number >= 64
90         buf[1] = 0;
91         if (ffurl_read_complete(h, buf, channel_id + 1) != channel_id + 1)
92             return AVERROR(EIO);
93         size += channel_id + 1;
94         channel_id = AV_RL16(buf) + 64;
95     }
96     data_size = prev_pkt[channel_id].data_size;
97     type      = prev_pkt[channel_id].type;
98     extra     = prev_pkt[channel_id].extra;
99
100     hdr >>= 6;
101     if (hdr == RTMP_PS_ONEBYTE) {
102         timestamp = prev_pkt[channel_id].ts_delta;
103     } else {
104         if (ffurl_read_complete(h, buf, 3) != 3)
105             return AVERROR(EIO);
106         size += 3;
107         timestamp = AV_RB24(buf);
108         if (hdr != RTMP_PS_FOURBYTES) {
109             if (ffurl_read_complete(h, buf, 3) != 3)
110                 return AVERROR(EIO);
111             size += 3;
112             data_size = AV_RB24(buf);
113             if (ffurl_read_complete(h, buf, 1) != 1)
114                 return AVERROR(EIO);
115             size++;
116             type = buf[0];
117             if (hdr == RTMP_PS_TWELVEBYTES) {
118                 if (ffurl_read_complete(h, buf, 4) != 4)
119                     return AVERROR(EIO);
120                 size += 4;
121                 extra = AV_RL32(buf);
122             }
123         }
124         if (timestamp == 0xFFFFFF) {
125             if (ffurl_read_complete(h, buf, 4) != 4)
126                 return AVERROR(EIO);
127             timestamp = AV_RB32(buf);
128         }
129     }
130     if (hdr != RTMP_PS_TWELVEBYTES)
131         timestamp += prev_pkt[channel_id].timestamp;
132
133     if ((ret = ff_rtmp_packet_create(p, channel_id, type, timestamp,
134                                      data_size)) < 0)
135         return ret;
136     p->extra = extra;
137     // save history
138     prev_pkt[channel_id].channel_id = channel_id;
139     prev_pkt[channel_id].type       = type;
140     prev_pkt[channel_id].data_size  = data_size;
141     prev_pkt[channel_id].ts_delta   = timestamp - prev_pkt[channel_id].timestamp;
142     prev_pkt[channel_id].timestamp  = timestamp;
143     prev_pkt[channel_id].extra      = extra;
144     while (data_size > 0) {
145         int toread = FFMIN(data_size, chunk_size);
146         if (ffurl_read_complete(h, p->data + offset, toread) != toread) {
147             ff_rtmp_packet_destroy(p);
148             return AVERROR(EIO);
149         }
150         data_size -= chunk_size;
151         offset    += chunk_size;
152         size      += chunk_size;
153         if (data_size > 0) {
154             if ((ret = ffurl_read_complete(h, &t, 1)) < 0) { // marker
155                 ff_rtmp_packet_destroy(p);
156                 return ret;
157             }
158             size++;
159             if (t != (0xC0 + channel_id))
160                 return -1;
161         }
162     }
163     return size;
164 }
165
166 int ff_rtmp_packet_write(URLContext *h, RTMPPacket *pkt,
167                          int chunk_size, RTMPPacket *prev_pkt)
168 {
169     uint8_t pkt_hdr[16], *p = pkt_hdr;
170     int mode = RTMP_PS_TWELVEBYTES;
171     int off = 0;
172     int size = 0;
173     int ret;
174
175     pkt->ts_delta = pkt->timestamp - prev_pkt[pkt->channel_id].timestamp;
176
177     //if channel_id = 0, this is first presentation of prev_pkt, send full hdr.
178     if (prev_pkt[pkt->channel_id].channel_id &&
179         pkt->extra == prev_pkt[pkt->channel_id].extra) {
180         if (pkt->type == prev_pkt[pkt->channel_id].type &&
181             pkt->data_size == prev_pkt[pkt->channel_id].data_size) {
182             mode = RTMP_PS_FOURBYTES;
183             if (pkt->ts_delta == prev_pkt[pkt->channel_id].ts_delta)
184                 mode = RTMP_PS_ONEBYTE;
185         } else {
186             mode = RTMP_PS_EIGHTBYTES;
187         }
188     }
189
190     if (pkt->channel_id < 64) {
191         bytestream_put_byte(&p, pkt->channel_id | (mode << 6));
192     } else if (pkt->channel_id < 64 + 256) {
193         bytestream_put_byte(&p, 0               | (mode << 6));
194         bytestream_put_byte(&p, pkt->channel_id - 64);
195     } else {
196         bytestream_put_byte(&p, 1               | (mode << 6));
197         bytestream_put_le16(&p, pkt->channel_id - 64);
198     }
199     if (mode != RTMP_PS_ONEBYTE) {
200         uint32_t timestamp = pkt->timestamp;
201         if (mode != RTMP_PS_TWELVEBYTES)
202             timestamp = pkt->ts_delta;
203         bytestream_put_be24(&p, timestamp >= 0xFFFFFF ? 0xFFFFFF : timestamp);
204         if (mode != RTMP_PS_FOURBYTES) {
205             bytestream_put_be24(&p, pkt->data_size);
206             bytestream_put_byte(&p, pkt->type);
207             if (mode == RTMP_PS_TWELVEBYTES)
208                 bytestream_put_le32(&p, pkt->extra);
209         }
210         if (timestamp >= 0xFFFFFF)
211             bytestream_put_be32(&p, timestamp);
212     }
213     // save history
214     prev_pkt[pkt->channel_id].channel_id = pkt->channel_id;
215     prev_pkt[pkt->channel_id].type       = pkt->type;
216     prev_pkt[pkt->channel_id].data_size  = pkt->data_size;
217     prev_pkt[pkt->channel_id].timestamp  = pkt->timestamp;
218     if (mode != RTMP_PS_TWELVEBYTES) {
219         prev_pkt[pkt->channel_id].ts_delta   = pkt->ts_delta;
220     } else {
221         prev_pkt[pkt->channel_id].ts_delta   = pkt->timestamp;
222     }
223     prev_pkt[pkt->channel_id].extra      = pkt->extra;
224
225     if ((ret = ffurl_write(h, pkt_hdr, p - pkt_hdr)) < 0)
226         return ret;
227     size = p - pkt_hdr + pkt->data_size;
228     while (off < pkt->data_size) {
229         int towrite = FFMIN(chunk_size, pkt->data_size - off);
230         if ((ret = ffurl_write(h, pkt->data + off, towrite)) < 0)
231             return ret;
232         off += towrite;
233         if (off < pkt->data_size) {
234             uint8_t marker = 0xC0 | pkt->channel_id;
235             if ((ret = ffurl_write(h, &marker, 1)) < 0)
236                 return ret;
237             size++;
238         }
239     }
240     return size;
241 }
242
243 int ff_rtmp_packet_create(RTMPPacket *pkt, int channel_id, RTMPPacketType type,
244                           int timestamp, int size)
245 {
246     if (size) {
247         pkt->data = av_malloc(size);
248         if (!pkt->data)
249             return AVERROR(ENOMEM);
250     }
251     pkt->data_size  = size;
252     pkt->channel_id = channel_id;
253     pkt->type       = type;
254     pkt->timestamp  = timestamp;
255     pkt->extra      = 0;
256     pkt->ts_delta   = 0;
257
258     return 0;
259 }
260
261 void ff_rtmp_packet_destroy(RTMPPacket *pkt)
262 {
263     if (!pkt)
264         return;
265     av_freep(&pkt->data);
266     pkt->data_size = 0;
267 }
268
269 int ff_amf_tag_size(const uint8_t *data, const uint8_t *data_end)
270 {
271     const uint8_t *base = data;
272
273     if (data >= data_end)
274         return -1;
275     switch (*data++) {
276     case AMF_DATA_TYPE_NUMBER:      return 9;
277     case AMF_DATA_TYPE_BOOL:        return 2;
278     case AMF_DATA_TYPE_STRING:      return 3 + AV_RB16(data);
279     case AMF_DATA_TYPE_LONG_STRING: return 5 + AV_RB32(data);
280     case AMF_DATA_TYPE_NULL:        return 1;
281     case AMF_DATA_TYPE_ARRAY:
282         data += 4;
283     case AMF_DATA_TYPE_OBJECT:
284         for (;;) {
285             int size = bytestream_get_be16(&data);
286             int t;
287             if (!size) {
288                 data++;
289                 break;
290             }
291             if (data + size >= data_end || data + size < data)
292                 return -1;
293             data += size;
294             t = ff_amf_tag_size(data, data_end);
295             if (t < 0 || data + t >= data_end)
296                 return -1;
297             data += t;
298         }
299         return data - base;
300     case AMF_DATA_TYPE_OBJECT_END:  return 1;
301     default:                        return -1;
302     }
303 }
304
305 int ff_amf_get_field_value(const uint8_t *data, const uint8_t *data_end,
306                            const uint8_t *name, uint8_t *dst, int dst_size)
307 {
308     int namelen = strlen(name);
309     int len;
310
311     while (*data != AMF_DATA_TYPE_OBJECT && data < data_end) {
312         len = ff_amf_tag_size(data, data_end);
313         if (len < 0)
314             len = data_end - data;
315         data += len;
316     }
317     if (data_end - data < 3)
318         return -1;
319     data++;
320     for (;;) {
321         int size = bytestream_get_be16(&data);
322         if (!size)
323             break;
324         if (data + size >= data_end || data + size < data)
325             return -1;
326         data += size;
327         if (size == namelen && !memcmp(data-size, name, namelen)) {
328             switch (*data++) {
329             case AMF_DATA_TYPE_NUMBER:
330                 snprintf(dst, dst_size, "%g", av_int2double(AV_RB64(data)));
331                 break;
332             case AMF_DATA_TYPE_BOOL:
333                 snprintf(dst, dst_size, "%s", *data ? "true" : "false");
334                 break;
335             case AMF_DATA_TYPE_STRING:
336                 len = bytestream_get_be16(&data);
337                 av_strlcpy(dst, data, FFMIN(len+1, dst_size));
338                 break;
339             default:
340                 return -1;
341             }
342             return 0;
343         }
344         len = ff_amf_tag_size(data, data_end);
345         if (len < 0 || data + len >= data_end || data + len < data)
346             return -1;
347         data += len;
348     }
349     return -1;
350 }
351
352 static const char* rtmp_packet_type(int type)
353 {
354     switch (type) {
355     case RTMP_PT_CHUNK_SIZE:     return "chunk size";
356     case RTMP_PT_BYTES_READ:     return "bytes read";
357     case RTMP_PT_PING:           return "ping";
358     case RTMP_PT_SERVER_BW:      return "server bandwidth";
359     case RTMP_PT_CLIENT_BW:      return "client bandwidth";
360     case RTMP_PT_AUDIO:          return "audio packet";
361     case RTMP_PT_VIDEO:          return "video packet";
362     case RTMP_PT_FLEX_STREAM:    return "Flex shared stream";
363     case RTMP_PT_FLEX_OBJECT:    return "Flex shared object";
364     case RTMP_PT_FLEX_MESSAGE:   return "Flex shared message";
365     case RTMP_PT_NOTIFY:         return "notification";
366     case RTMP_PT_SHARED_OBJ:     return "shared object";
367     case RTMP_PT_INVOKE:         return "invoke";
368     case RTMP_PT_METADATA:       return "metadata";
369     default:                     return "unknown";
370     }
371 }
372
373 static void ff_amf_tag_contents(void *ctx, const uint8_t *data, const uint8_t *data_end)
374 {
375     int size;
376     char buf[1024];
377
378     if (data >= data_end)
379         return;
380     switch (*data++) {
381     case AMF_DATA_TYPE_NUMBER:
382         av_log(ctx, AV_LOG_DEBUG, " number %g\n", av_int2double(AV_RB64(data)));
383         return;
384     case AMF_DATA_TYPE_BOOL:
385         av_log(ctx, AV_LOG_DEBUG, " bool %d\n", *data);
386         return;
387     case AMF_DATA_TYPE_STRING:
388     case AMF_DATA_TYPE_LONG_STRING:
389         if (data[-1] == AMF_DATA_TYPE_STRING) {
390             size = bytestream_get_be16(&data);
391         } else {
392             size = bytestream_get_be32(&data);
393         }
394         size = FFMIN(size, 1023);
395         memcpy(buf, data, size);
396         buf[size] = 0;
397         av_log(ctx, AV_LOG_DEBUG, " string '%s'\n", buf);
398         return;
399     case AMF_DATA_TYPE_NULL:
400         av_log(ctx, AV_LOG_DEBUG, " NULL\n");
401         return;
402     case AMF_DATA_TYPE_ARRAY:
403         data += 4;
404     case AMF_DATA_TYPE_OBJECT:
405         av_log(ctx, AV_LOG_DEBUG, " {\n");
406         for (;;) {
407             int size = bytestream_get_be16(&data);
408             int t;
409             memcpy(buf, data, size);
410             buf[size] = 0;
411             if (!size) {
412                 av_log(ctx, AV_LOG_DEBUG, " }\n");
413                 data++;
414                 break;
415             }
416             if (data + size >= data_end || data + size < data)
417                 return;
418             data += size;
419             av_log(ctx, AV_LOG_DEBUG, "  %s: ", buf);
420             ff_amf_tag_contents(ctx, data, data_end);
421             t = ff_amf_tag_size(data, data_end);
422             if (t < 0 || data + t >= data_end)
423                 return;
424             data += t;
425         }
426         return;
427     case AMF_DATA_TYPE_OBJECT_END:
428         av_log(ctx, AV_LOG_DEBUG, " }\n");
429         return;
430     default:
431         return;
432     }
433 }
434
435 void ff_rtmp_packet_dump(void *ctx, RTMPPacket *p)
436 {
437     av_log(ctx, AV_LOG_DEBUG, "RTMP packet type '%s'(%d) for channel %d, timestamp %d, extra field %d size %d\n",
438            rtmp_packet_type(p->type), p->type, p->channel_id, p->timestamp, p->extra, p->data_size);
439     if (p->type == RTMP_PT_INVOKE || p->type == RTMP_PT_NOTIFY) {
440         uint8_t *src = p->data, *src_end = p->data + p->data_size;
441         while (src < src_end) {
442             int sz;
443             ff_amf_tag_contents(ctx, src, src_end);
444             sz = ff_amf_tag_size(src, src_end);
445             if (sz < 0)
446                 break;
447             src += sz;
448         }
449     } else if (p->type == RTMP_PT_SERVER_BW){
450         av_log(ctx, AV_LOG_DEBUG, "Server BW = %d\n", AV_RB32(p->data));
451     } else if (p->type == RTMP_PT_CLIENT_BW){
452         av_log(ctx, AV_LOG_DEBUG, "Client BW = %d\n", AV_RB32(p->data));
453     } else if (p->type != RTMP_PT_AUDIO && p->type != RTMP_PT_VIDEO && p->type != RTMP_PT_METADATA) {
454         int i;
455         for (i = 0; i < p->data_size; i++)
456             av_log(ctx, AV_LOG_DEBUG, " %02X", p->data[i]);
457         av_log(ctx, AV_LOG_DEBUG, "\n");
458     }
459 }