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