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             ffurl_read_complete(h, &t, 1); //marker
155             size++;
156             if (t != (0xC0 + channel_id))
157                 return -1;
158         }
159     }
160     return size;
161 }
162
163 int ff_rtmp_packet_write(URLContext *h, RTMPPacket *pkt,
164                          int chunk_size, RTMPPacket *prev_pkt)
165 {
166     uint8_t pkt_hdr[16], *p = pkt_hdr;
167     int mode = RTMP_PS_TWELVEBYTES;
168     int off = 0;
169     int size = 0;
170
171     pkt->ts_delta = pkt->timestamp - prev_pkt[pkt->channel_id].timestamp;
172
173     //if channel_id = 0, this is first presentation of prev_pkt, send full hdr.
174     if (prev_pkt[pkt->channel_id].channel_id &&
175         pkt->extra == prev_pkt[pkt->channel_id].extra) {
176         if (pkt->type == prev_pkt[pkt->channel_id].type &&
177             pkt->data_size == prev_pkt[pkt->channel_id].data_size) {
178             mode = RTMP_PS_FOURBYTES;
179             if (pkt->ts_delta == prev_pkt[pkt->channel_id].ts_delta)
180                 mode = RTMP_PS_ONEBYTE;
181         } else {
182             mode = RTMP_PS_EIGHTBYTES;
183         }
184     }
185
186     if (pkt->channel_id < 64) {
187         bytestream_put_byte(&p, pkt->channel_id | (mode << 6));
188     } else if (pkt->channel_id < 64 + 256) {
189         bytestream_put_byte(&p, 0               | (mode << 6));
190         bytestream_put_byte(&p, pkt->channel_id - 64);
191     } else {
192         bytestream_put_byte(&p, 1               | (mode << 6));
193         bytestream_put_le16(&p, pkt->channel_id - 64);
194     }
195     if (mode != RTMP_PS_ONEBYTE) {
196         uint32_t timestamp = pkt->timestamp;
197         if (mode != RTMP_PS_TWELVEBYTES)
198             timestamp = pkt->ts_delta;
199         bytestream_put_be24(&p, timestamp >= 0xFFFFFF ? 0xFFFFFF : timestamp);
200         if (mode != RTMP_PS_FOURBYTES) {
201             bytestream_put_be24(&p, pkt->data_size);
202             bytestream_put_byte(&p, pkt->type);
203             if (mode == RTMP_PS_TWELVEBYTES)
204                 bytestream_put_le32(&p, pkt->extra);
205         }
206         if (timestamp >= 0xFFFFFF)
207             bytestream_put_be32(&p, timestamp);
208     }
209     // save history
210     prev_pkt[pkt->channel_id].channel_id = pkt->channel_id;
211     prev_pkt[pkt->channel_id].type       = pkt->type;
212     prev_pkt[pkt->channel_id].data_size  = pkt->data_size;
213     prev_pkt[pkt->channel_id].timestamp  = pkt->timestamp;
214     if (mode != RTMP_PS_TWELVEBYTES) {
215         prev_pkt[pkt->channel_id].ts_delta   = pkt->ts_delta;
216     } else {
217         prev_pkt[pkt->channel_id].ts_delta   = pkt->timestamp;
218     }
219     prev_pkt[pkt->channel_id].extra      = pkt->extra;
220
221     ffurl_write(h, pkt_hdr, p-pkt_hdr);
222     size = p - pkt_hdr + pkt->data_size;
223     while (off < pkt->data_size) {
224         int towrite = FFMIN(chunk_size, pkt->data_size - off);
225         ffurl_write(h, pkt->data + off, towrite);
226         off += towrite;
227         if (off < pkt->data_size) {
228             uint8_t marker = 0xC0 | pkt->channel_id;
229             ffurl_write(h, &marker, 1);
230             size++;
231         }
232     }
233     return size;
234 }
235
236 int ff_rtmp_packet_create(RTMPPacket *pkt, int channel_id, RTMPPacketType type,
237                           int timestamp, int size)
238 {
239     if (size) {
240         pkt->data = av_malloc(size);
241         if (!pkt->data)
242             return AVERROR(ENOMEM);
243     }
244     pkt->data_size  = size;
245     pkt->channel_id = channel_id;
246     pkt->type       = type;
247     pkt->timestamp  = timestamp;
248     pkt->extra      = 0;
249     pkt->ts_delta   = 0;
250
251     return 0;
252 }
253
254 void ff_rtmp_packet_destroy(RTMPPacket *pkt)
255 {
256     if (!pkt)
257         return;
258     av_freep(&pkt->data);
259     pkt->data_size = 0;
260 }
261
262 int ff_amf_tag_size(const uint8_t *data, const uint8_t *data_end)
263 {
264     const uint8_t *base = data;
265
266     if (data >= data_end)
267         return -1;
268     switch (*data++) {
269     case AMF_DATA_TYPE_NUMBER:      return 9;
270     case AMF_DATA_TYPE_BOOL:        return 2;
271     case AMF_DATA_TYPE_STRING:      return 3 + AV_RB16(data);
272     case AMF_DATA_TYPE_LONG_STRING: return 5 + AV_RB32(data);
273     case AMF_DATA_TYPE_NULL:        return 1;
274     case AMF_DATA_TYPE_ARRAY:
275         data += 4;
276     case AMF_DATA_TYPE_OBJECT:
277         for (;;) {
278             int size = bytestream_get_be16(&data);
279             int t;
280             if (!size) {
281                 data++;
282                 break;
283             }
284             if (data + size >= data_end || data + size < data)
285                 return -1;
286             data += size;
287             t = ff_amf_tag_size(data, data_end);
288             if (t < 0 || data + t >= data_end)
289                 return -1;
290             data += t;
291         }
292         return data - base;
293     case AMF_DATA_TYPE_OBJECT_END:  return 1;
294     default:                        return -1;
295     }
296 }
297
298 int ff_amf_get_field_value(const uint8_t *data, const uint8_t *data_end,
299                            const uint8_t *name, uint8_t *dst, int dst_size)
300 {
301     int namelen = strlen(name);
302     int len;
303
304     while (*data != AMF_DATA_TYPE_OBJECT && data < data_end) {
305         len = ff_amf_tag_size(data, data_end);
306         if (len < 0)
307             len = data_end - data;
308         data += len;
309     }
310     if (data_end - data < 3)
311         return -1;
312     data++;
313     for (;;) {
314         int size = bytestream_get_be16(&data);
315         if (!size)
316             break;
317         if (data + size >= data_end || data + size < data)
318             return -1;
319         data += size;
320         if (size == namelen && !memcmp(data-size, name, namelen)) {
321             switch (*data++) {
322             case AMF_DATA_TYPE_NUMBER:
323                 snprintf(dst, dst_size, "%g", av_int2double(AV_RB64(data)));
324                 break;
325             case AMF_DATA_TYPE_BOOL:
326                 snprintf(dst, dst_size, "%s", *data ? "true" : "false");
327                 break;
328             case AMF_DATA_TYPE_STRING:
329                 len = bytestream_get_be16(&data);
330                 av_strlcpy(dst, data, FFMIN(len+1, dst_size));
331                 break;
332             default:
333                 return -1;
334             }
335             return 0;
336         }
337         len = ff_amf_tag_size(data, data_end);
338         if (len < 0 || data + len >= data_end || data + len < data)
339             return -1;
340         data += len;
341     }
342     return -1;
343 }
344
345 static const char* rtmp_packet_type(int type)
346 {
347     switch (type) {
348     case RTMP_PT_CHUNK_SIZE:     return "chunk size";
349     case RTMP_PT_BYTES_READ:     return "bytes read";
350     case RTMP_PT_PING:           return "ping";
351     case RTMP_PT_SERVER_BW:      return "server bandwidth";
352     case RTMP_PT_CLIENT_BW:      return "client bandwidth";
353     case RTMP_PT_AUDIO:          return "audio packet";
354     case RTMP_PT_VIDEO:          return "video packet";
355     case RTMP_PT_FLEX_STREAM:    return "Flex shared stream";
356     case RTMP_PT_FLEX_OBJECT:    return "Flex shared object";
357     case RTMP_PT_FLEX_MESSAGE:   return "Flex shared message";
358     case RTMP_PT_NOTIFY:         return "notification";
359     case RTMP_PT_SHARED_OBJ:     return "shared object";
360     case RTMP_PT_INVOKE:         return "invoke";
361     case RTMP_PT_METADATA:       return "metadata";
362     default:                     return "unknown";
363     }
364 }
365
366 static void ff_amf_tag_contents(void *ctx, const uint8_t *data, const uint8_t *data_end)
367 {
368     int size;
369     char buf[1024];
370
371     if (data >= data_end)
372         return;
373     switch (*data++) {
374     case AMF_DATA_TYPE_NUMBER:
375         av_log(ctx, AV_LOG_DEBUG, " number %g\n", av_int2double(AV_RB64(data)));
376         return;
377     case AMF_DATA_TYPE_BOOL:
378         av_log(ctx, AV_LOG_DEBUG, " bool %d\n", *data);
379         return;
380     case AMF_DATA_TYPE_STRING:
381     case AMF_DATA_TYPE_LONG_STRING:
382         if (data[-1] == AMF_DATA_TYPE_STRING) {
383             size = bytestream_get_be16(&data);
384         } else {
385             size = bytestream_get_be32(&data);
386         }
387         size = FFMIN(size, 1023);
388         memcpy(buf, data, size);
389         buf[size] = 0;
390         av_log(ctx, AV_LOG_DEBUG, " string '%s'\n", buf);
391         return;
392     case AMF_DATA_TYPE_NULL:
393         av_log(ctx, AV_LOG_DEBUG, " NULL\n");
394         return;
395     case AMF_DATA_TYPE_ARRAY:
396         data += 4;
397     case AMF_DATA_TYPE_OBJECT:
398         av_log(ctx, AV_LOG_DEBUG, " {\n");
399         for (;;) {
400             int size = bytestream_get_be16(&data);
401             int t;
402             memcpy(buf, data, size);
403             buf[size] = 0;
404             if (!size) {
405                 av_log(ctx, AV_LOG_DEBUG, " }\n");
406                 data++;
407                 break;
408             }
409             if (data + size >= data_end || data + size < data)
410                 return;
411             data += size;
412             av_log(ctx, AV_LOG_DEBUG, "  %s: ", buf);
413             ff_amf_tag_contents(ctx, data, data_end);
414             t = ff_amf_tag_size(data, data_end);
415             if (t < 0 || data + t >= data_end)
416                 return;
417             data += t;
418         }
419         return;
420     case AMF_DATA_TYPE_OBJECT_END:
421         av_log(ctx, AV_LOG_DEBUG, " }\n");
422         return;
423     default:
424         return;
425     }
426 }
427
428 void ff_rtmp_packet_dump(void *ctx, RTMPPacket *p)
429 {
430     av_log(ctx, AV_LOG_DEBUG, "RTMP packet type '%s'(%d) for channel %d, timestamp %d, extra field %d size %d\n",
431            rtmp_packet_type(p->type), p->type, p->channel_id, p->timestamp, p->extra, p->data_size);
432     if (p->type == RTMP_PT_INVOKE || p->type == RTMP_PT_NOTIFY) {
433         uint8_t *src = p->data, *src_end = p->data + p->data_size;
434         while (src < src_end) {
435             int sz;
436             ff_amf_tag_contents(ctx, src, src_end);
437             sz = ff_amf_tag_size(src, src_end);
438             if (sz < 0)
439                 break;
440             src += sz;
441         }
442     } else if (p->type == RTMP_PT_SERVER_BW){
443         av_log(ctx, AV_LOG_DEBUG, "Server BW = %d\n", AV_RB32(p->data));
444     } else if (p->type == RTMP_PT_CLIENT_BW){
445         av_log(ctx, AV_LOG_DEBUG, "Client BW = %d\n", AV_RB32(p->data));
446     } else if (p->type != RTMP_PT_AUDIO && p->type != RTMP_PT_VIDEO && p->type != RTMP_PT_METADATA) {
447         int i;
448         for (i = 0; i < p->data_size; i++)
449             av_log(ctx, AV_LOG_DEBUG, " %02X", p->data[i]);
450         av_log(ctx, AV_LOG_DEBUG, "\n");
451     }
452 }