3 * Copyright (c) 2009 Konstantin Shishkov
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
22 #include "libavcodec/bytestream.h"
23 #include "libavutil/avstring.h"
24 #include "libavutil/intfloat.h"
31 void ff_amf_write_bool(uint8_t **dst, int val)
33 bytestream_put_byte(dst, AMF_DATA_TYPE_BOOL);
34 bytestream_put_byte(dst, val);
37 void ff_amf_write_number(uint8_t **dst, double val)
39 bytestream_put_byte(dst, AMF_DATA_TYPE_NUMBER);
40 bytestream_put_be64(dst, av_double2int(val));
43 void ff_amf_write_array_start(uint8_t **dst, uint32_t length)
45 bytestream_put_byte(dst, AMF_DATA_TYPE_ARRAY);
46 bytestream_put_be32(dst, length);
49 void ff_amf_write_string(uint8_t **dst, const char *str)
51 bytestream_put_byte(dst, AMF_DATA_TYPE_STRING);
52 bytestream_put_be16(dst, strlen(str));
53 bytestream_put_buffer(dst, str, strlen(str));
56 void ff_amf_write_string2(uint8_t **dst, const char *str1, const char *str2)
58 int len1 = 0, len2 = 0;
63 bytestream_put_byte(dst, AMF_DATA_TYPE_STRING);
64 bytestream_put_be16(dst, len1 + len2);
65 bytestream_put_buffer(dst, str1, len1);
66 bytestream_put_buffer(dst, str2, len2);
69 void ff_amf_write_null(uint8_t **dst)
71 bytestream_put_byte(dst, AMF_DATA_TYPE_NULL);
74 void ff_amf_write_object_start(uint8_t **dst)
76 bytestream_put_byte(dst, AMF_DATA_TYPE_OBJECT);
79 void ff_amf_write_field_name(uint8_t **dst, const char *str)
81 bytestream_put_be16(dst, strlen(str));
82 bytestream_put_buffer(dst, str, strlen(str));
85 void ff_amf_write_object_end(uint8_t **dst)
87 /* first two bytes are field name length = 0,
88 * AMF object should end with it and end marker
90 bytestream_put_be24(dst, AMF_DATA_TYPE_OBJECT_END);
93 int ff_amf_read_number(GetByteContext *bc, double *val)
96 if (bytestream2_get_byte(bc) != AMF_DATA_TYPE_NUMBER)
97 return AVERROR_INVALIDDATA;
98 read = bytestream2_get_be64(bc);
99 *val = av_int2double(read);
103 int ff_amf_get_string(GetByteContext *bc, uint8_t *str,
104 int strsize, int *length)
108 stringlen = bytestream2_get_be16(bc);
109 if (stringlen + 1 > strsize)
110 return AVERROR(EINVAL);
111 readsize = bytestream2_get_buffer(bc, str, stringlen);
112 if (readsize != stringlen) {
113 av_log(NULL, AV_LOG_WARNING,
114 "Unable to read as many bytes as AMF string signaled\n");
116 str[readsize] = '\0';
117 *length = FFMIN(stringlen, readsize);
121 int ff_amf_read_string(GetByteContext *bc, uint8_t *str,
122 int strsize, int *length)
124 if (bytestream2_get_byte(bc) != AMF_DATA_TYPE_STRING)
125 return AVERROR_INVALIDDATA;
126 return ff_amf_get_string(bc, str, strsize, length);
129 int ff_amf_read_null(GetByteContext *bc)
131 if (bytestream2_get_byte(bc) != AMF_DATA_TYPE_NULL)
132 return AVERROR_INVALIDDATA;
136 int ff_rtmp_check_alloc_array(RTMPPacket **prev_pkt, int *nb_prev_pkt,
141 if (channel < *nb_prev_pkt)
144 nb_alloc = channel + 16;
145 // This can't use the av_reallocp family of functions, since we
146 // would need to free each element in the array before the array
148 ptr = av_realloc_array(*prev_pkt, nb_alloc, sizeof(**prev_pkt));
150 return AVERROR(ENOMEM);
151 memset(ptr + *nb_prev_pkt, 0, (nb_alloc - *nb_prev_pkt) * sizeof(*ptr));
153 *nb_prev_pkt = nb_alloc;
157 int ff_rtmp_packet_read(URLContext *h, RTMPPacket *p,
158 int chunk_size, RTMPPacket **prev_pkt, int *nb_prev_pkt)
162 if (ffurl_read(h, &hdr, 1) != 1)
165 return ff_rtmp_packet_read_internal(h, p, chunk_size, prev_pkt,
169 static int rtmp_packet_read_one_chunk(URLContext *h, RTMPPacket *p,
170 int chunk_size, RTMPPacket **prev_pkt_ptr,
171 int *nb_prev_pkt, uint8_t hdr)
175 int channel_id, timestamp, size;
176 uint32_t ts_field; // non-extended timestamp or delta field
178 enum RTMPPacketType type;
181 RTMPPacket *prev_pkt;
184 channel_id = hdr & 0x3F;
186 if (channel_id < 2) { //special case for channel number >= 64
188 if (ffurl_read_complete(h, buf, channel_id + 1) != channel_id + 1)
190 written += channel_id + 1;
191 channel_id = AV_RL16(buf) + 64;
193 if ((ret = ff_rtmp_check_alloc_array(prev_pkt_ptr, nb_prev_pkt,
196 prev_pkt = *prev_pkt_ptr;
197 size = prev_pkt[channel_id].size;
198 type = prev_pkt[channel_id].type;
199 extra = prev_pkt[channel_id].extra;
201 hdr >>= 6; // header size indicator
202 if (hdr == RTMP_PS_ONEBYTE) {
203 ts_field = prev_pkt[channel_id].ts_field;
205 if (ffurl_read_complete(h, buf, 3) != 3)
208 ts_field = AV_RB24(buf);
209 if (hdr != RTMP_PS_FOURBYTES) {
210 if (ffurl_read_complete(h, buf, 3) != 3)
214 if (ffurl_read_complete(h, buf, 1) != 1)
218 if (hdr == RTMP_PS_TWELVEBYTES) {
219 if (ffurl_read_complete(h, buf, 4) != 4)
222 extra = AV_RL32(buf);
226 if (ts_field == 0xFFFFFF) {
227 if (ffurl_read_complete(h, buf, 4) != 4)
229 timestamp = AV_RB32(buf);
231 timestamp = ts_field;
233 if (hdr != RTMP_PS_TWELVEBYTES)
234 timestamp += prev_pkt[channel_id].timestamp;
236 if (prev_pkt[channel_id].read && size != prev_pkt[channel_id].size) {
237 av_log(h, AV_LOG_ERROR, "RTMP packet size mismatch %d != %d\n",
238 size, prev_pkt[channel_id].size);
239 ff_rtmp_packet_destroy(&prev_pkt[channel_id]);
240 prev_pkt[channel_id].read = 0;
241 return AVERROR_INVALIDDATA;
244 if (!prev_pkt[channel_id].read) {
245 if ((ret = ff_rtmp_packet_create(p, channel_id, type, timestamp,
250 prev_pkt[channel_id].ts_field = ts_field;
251 prev_pkt[channel_id].timestamp = timestamp;
253 // previous packet in this channel hasn't completed reading
254 RTMPPacket *prev = &prev_pkt[channel_id];
255 p->data = prev->data;
256 p->size = prev->size;
257 p->channel_id = prev->channel_id;
258 p->type = prev->type;
259 p->ts_field = prev->ts_field;
260 p->extra = prev->extra;
261 p->offset = prev->offset;
262 p->read = prev->read + written;
263 p->timestamp = prev->timestamp;
268 prev_pkt[channel_id].channel_id = channel_id;
269 prev_pkt[channel_id].type = type;
270 prev_pkt[channel_id].size = size;
271 prev_pkt[channel_id].extra = extra;
272 size = size - p->offset;
274 toread = FFMIN(size, chunk_size);
275 if (ffurl_read_complete(h, p->data + p->offset, toread) != toread) {
276 ff_rtmp_packet_destroy(p);
284 RTMPPacket *prev = &prev_pkt[channel_id];
285 prev->data = p->data;
286 prev->read = p->read;
287 prev->offset = p->offset;
289 return AVERROR(EAGAIN);
292 prev_pkt[channel_id].read = 0; // read complete; reset if needed
296 int ff_rtmp_packet_read_internal(URLContext *h, RTMPPacket *p, int chunk_size,
297 RTMPPacket **prev_pkt, int *nb_prev_pkt,
301 int ret = rtmp_packet_read_one_chunk(h, p, chunk_size, prev_pkt,
303 if (ret > 0 || ret != AVERROR(EAGAIN))
306 if (ffurl_read(h, &hdr, 1) != 1)
311 int ff_rtmp_packet_write(URLContext *h, RTMPPacket *pkt,
312 int chunk_size, RTMPPacket **prev_pkt_ptr,
315 uint8_t pkt_hdr[16], *p = pkt_hdr;
316 int mode = RTMP_PS_TWELVEBYTES;
320 RTMPPacket *prev_pkt;
321 int use_delta; // flag if using timestamp delta, not RTMP_PS_TWELVEBYTES
322 uint32_t timestamp; // full 32-bit timestamp or delta value
324 if ((ret = ff_rtmp_check_alloc_array(prev_pkt_ptr, nb_prev_pkt,
325 pkt->channel_id)) < 0)
327 prev_pkt = *prev_pkt_ptr;
329 //if channel_id = 0, this is first presentation of prev_pkt, send full hdr.
330 use_delta = prev_pkt[pkt->channel_id].channel_id &&
331 pkt->extra == prev_pkt[pkt->channel_id].extra &&
332 pkt->timestamp >= prev_pkt[pkt->channel_id].timestamp;
334 timestamp = pkt->timestamp;
336 timestamp -= prev_pkt[pkt->channel_id].timestamp;
338 if (timestamp >= 0xFFFFFF) {
339 pkt->ts_field = 0xFFFFFF;
341 pkt->ts_field = timestamp;
345 if (pkt->type == prev_pkt[pkt->channel_id].type &&
346 pkt->size == prev_pkt[pkt->channel_id].size) {
347 mode = RTMP_PS_FOURBYTES;
348 if (pkt->ts_field == prev_pkt[pkt->channel_id].ts_field)
349 mode = RTMP_PS_ONEBYTE;
351 mode = RTMP_PS_EIGHTBYTES;
355 if (pkt->channel_id < 64) {
356 bytestream_put_byte(&p, pkt->channel_id | (mode << 6));
357 } else if (pkt->channel_id < 64 + 256) {
358 bytestream_put_byte(&p, 0 | (mode << 6));
359 bytestream_put_byte(&p, pkt->channel_id - 64);
361 bytestream_put_byte(&p, 1 | (mode << 6));
362 bytestream_put_le16(&p, pkt->channel_id - 64);
364 if (mode != RTMP_PS_ONEBYTE) {
365 bytestream_put_be24(&p, pkt->ts_field);
366 if (mode != RTMP_PS_FOURBYTES) {
367 bytestream_put_be24(&p, pkt->size);
368 bytestream_put_byte(&p, pkt->type);
369 if (mode == RTMP_PS_TWELVEBYTES)
370 bytestream_put_le32(&p, pkt->extra);
373 if (pkt->ts_field == 0xFFFFFF)
374 bytestream_put_be32(&p, timestamp);
376 prev_pkt[pkt->channel_id].channel_id = pkt->channel_id;
377 prev_pkt[pkt->channel_id].type = pkt->type;
378 prev_pkt[pkt->channel_id].size = pkt->size;
379 prev_pkt[pkt->channel_id].timestamp = pkt->timestamp;
380 prev_pkt[pkt->channel_id].ts_field = pkt->ts_field;
381 prev_pkt[pkt->channel_id].extra = pkt->extra;
384 // Writing packets is currently not optimized to minimize system calls.
385 // Since system calls flush on exit which we cannot change in a system-independant way.
386 // We should fix this behavior and by writing packets in a single or in as few as possible system calls.
387 // Protocols like TCP and RTMP should benefit from this when enabling TCP_NODELAY.
389 if ((ret = ffurl_write(h, pkt_hdr, p - pkt_hdr)) < 0)
391 written = p - pkt_hdr + pkt->size;
392 while (off < pkt->size) {
393 int towrite = FFMIN(chunk_size, pkt->size - off);
394 if ((ret = ffurl_write(h, pkt->data + off, towrite)) < 0)
397 if (off < pkt->size) {
398 uint8_t marker = 0xC0 | pkt->channel_id;
399 if ((ret = ffurl_write(h, &marker, 1)) < 0)
402 if (pkt->ts_field == 0xFFFFFF) {
403 uint8_t ts_header[4];
404 AV_WB32(ts_header, timestamp);
405 if ((ret = ffurl_write(h, ts_header, 4)) < 0)
414 int ff_rtmp_packet_create(RTMPPacket *pkt, int channel_id, RTMPPacketType type,
415 int timestamp, int size)
418 pkt->data = av_realloc(NULL, size);
420 return AVERROR(ENOMEM);
423 pkt->channel_id = channel_id;
425 pkt->timestamp = timestamp;
432 void ff_rtmp_packet_destroy(RTMPPacket *pkt)
436 av_freep(&pkt->data);
440 static int amf_tag_skip(GetByteContext *gb)
446 if (bytestream2_get_bytes_left(gb) < 1)
449 type = bytestream2_get_byte(gb);
451 case AMF_DATA_TYPE_NUMBER:
452 bytestream2_get_be64(gb);
454 case AMF_DATA_TYPE_BOOL:
455 bytestream2_get_byte(gb);
457 case AMF_DATA_TYPE_STRING:
458 bytestream2_skip(gb, bytestream2_get_be16(gb));
460 case AMF_DATA_TYPE_LONG_STRING:
461 bytestream2_skip(gb, bytestream2_get_be32(gb));
463 case AMF_DATA_TYPE_NULL:
465 case AMF_DATA_TYPE_DATE:
466 bytestream2_skip(gb, 10);
468 case AMF_DATA_TYPE_ARRAY:
470 case AMF_DATA_TYPE_MIXEDARRAY:
471 nb = bytestream2_get_be32(gb);
472 case AMF_DATA_TYPE_OBJECT:
473 while (nb-- > 0 || type != AMF_DATA_TYPE_ARRAY) {
476 int size = bytestream2_get_be16(gb);
478 bytestream2_get_byte(gb);
481 if (size < 0 || size >= bytestream2_get_bytes_left(gb))
483 bytestream2_skip(gb, size);
485 t = amf_tag_skip(gb);
486 if (t < 0 || bytestream2_get_bytes_left(gb) <= 0)
490 case AMF_DATA_TYPE_OBJECT_END: return 0;
495 int ff_amf_tag_size(const uint8_t *data, const uint8_t *data_end)
500 if (data >= data_end)
503 bytestream2_init(&gb, data, data_end - data);
505 ret = amf_tag_skip(&gb);
506 if (ret < 0 || bytestream2_get_bytes_left(&gb) <= 0)
508 av_assert0(bytestream2_tell(&gb) >= 0 && bytestream2_tell(&gb) <= data_end - data);
509 return bytestream2_tell(&gb);
512 static int amf_get_field_value2(GetByteContext *gb,
513 const uint8_t *name, uint8_t *dst, int dst_size)
515 int namelen = strlen(name);
518 while (bytestream2_peek_byte(gb) != AMF_DATA_TYPE_OBJECT && bytestream2_get_bytes_left(gb) > 0) {
519 int ret = amf_tag_skip(gb);
523 if (bytestream2_get_bytes_left(gb) < 3)
525 bytestream2_get_byte(gb);
528 int size = bytestream2_get_be16(gb);
531 if (size < 0 || size >= bytestream2_get_bytes_left(gb))
533 bytestream2_skip(gb, size);
534 if (size == namelen && !memcmp(gb->buffer-size, name, namelen)) {
535 switch (bytestream2_get_byte(gb)) {
536 case AMF_DATA_TYPE_NUMBER:
537 snprintf(dst, dst_size, "%g", av_int2double(bytestream2_get_be64(gb)));
539 case AMF_DATA_TYPE_BOOL:
540 snprintf(dst, dst_size, "%s", bytestream2_get_byte(gb) ? "true" : "false");
542 case AMF_DATA_TYPE_STRING:
543 len = bytestream2_get_be16(gb);
546 if (dst_size < len + 1)
548 bytestream2_get_buffer(gb, dst, len);
556 len = amf_tag_skip(gb);
557 if (len < 0 || bytestream2_get_bytes_left(gb) <= 0)
563 int ff_amf_get_field_value(const uint8_t *data, const uint8_t *data_end,
564 const uint8_t *name, uint8_t *dst, int dst_size)
568 if (data >= data_end)
571 bytestream2_init(&gb, data, data_end - data);
573 return amf_get_field_value2(&gb, name, dst, dst_size);
577 static const char* rtmp_packet_type(int type)
580 case RTMP_PT_CHUNK_SIZE: return "chunk size";
581 case RTMP_PT_BYTES_READ: return "bytes read";
582 case RTMP_PT_USER_CONTROL: return "user control";
583 case RTMP_PT_WINDOW_ACK_SIZE: return "window acknowledgement size";
584 case RTMP_PT_SET_PEER_BW: return "set peer bandwidth";
585 case RTMP_PT_AUDIO: return "audio packet";
586 case RTMP_PT_VIDEO: return "video packet";
587 case RTMP_PT_FLEX_STREAM: return "Flex shared stream";
588 case RTMP_PT_FLEX_OBJECT: return "Flex shared object";
589 case RTMP_PT_FLEX_MESSAGE: return "Flex shared message";
590 case RTMP_PT_NOTIFY: return "notification";
591 case RTMP_PT_SHARED_OBJ: return "shared object";
592 case RTMP_PT_INVOKE: return "invoke";
593 case RTMP_PT_METADATA: return "metadata";
594 default: return "unknown";
598 static void amf_tag_contents(void *ctx, const uint8_t *data,
599 const uint8_t *data_end)
601 unsigned int size, nb = -1;
606 if (data >= data_end)
608 switch ((type = *data++)) {
609 case AMF_DATA_TYPE_NUMBER:
610 av_log(ctx, AV_LOG_DEBUG, " number %g\n", av_int2double(AV_RB64(data)));
612 case AMF_DATA_TYPE_BOOL:
613 av_log(ctx, AV_LOG_DEBUG, " bool %d\n", *data);
615 case AMF_DATA_TYPE_STRING:
616 case AMF_DATA_TYPE_LONG_STRING:
617 if (type == AMF_DATA_TYPE_STRING) {
618 size = bytestream_get_be16(&data);
620 size = bytestream_get_be32(&data);
622 size = FFMIN(size, sizeof(buf) - 1);
623 memcpy(buf, data, size);
625 av_log(ctx, AV_LOG_DEBUG, " string '%s'\n", buf);
627 case AMF_DATA_TYPE_NULL:
628 av_log(ctx, AV_LOG_DEBUG, " NULL\n");
630 case AMF_DATA_TYPE_ARRAY:
632 case AMF_DATA_TYPE_MIXEDARRAY:
633 nb = bytestream_get_be32(&data);
634 case AMF_DATA_TYPE_OBJECT:
635 av_log(ctx, AV_LOG_DEBUG, " {\n");
636 while (nb-- > 0 || type != AMF_DATA_TYPE_ARRAY) {
639 size = bytestream_get_be16(&data);
640 size = FFMIN(size, sizeof(buf) - 1);
642 av_log(ctx, AV_LOG_DEBUG, " }\n");
646 memcpy(buf, data, size);
648 if (size >= data_end - data)
651 av_log(ctx, AV_LOG_DEBUG, " %s: ", buf);
653 amf_tag_contents(ctx, data, data_end);
654 t = ff_amf_tag_size(data, data_end);
655 if (t < 0 || t >= data_end - data)
660 case AMF_DATA_TYPE_OBJECT_END:
661 av_log(ctx, AV_LOG_DEBUG, " }\n");
668 void ff_rtmp_packet_dump(void *ctx, RTMPPacket *p)
670 av_log(ctx, AV_LOG_DEBUG, "RTMP packet type '%s'(%d) for channel %d, timestamp %d, extra field %d size %d\n",
671 rtmp_packet_type(p->type), p->type, p->channel_id, p->timestamp, p->extra, p->size);
672 if (p->type == RTMP_PT_INVOKE || p->type == RTMP_PT_NOTIFY) {
673 uint8_t *src = p->data, *src_end = p->data + p->size;
674 while (src < src_end) {
676 amf_tag_contents(ctx, src, src_end);
677 sz = ff_amf_tag_size(src, src_end);
682 } else if (p->type == RTMP_PT_WINDOW_ACK_SIZE) {
683 av_log(ctx, AV_LOG_DEBUG, "Window acknowledgement size = %d\n", AV_RB32(p->data));
684 } else if (p->type == RTMP_PT_SET_PEER_BW) {
685 av_log(ctx, AV_LOG_DEBUG, "Set Peer BW = %d\n", AV_RB32(p->data));
686 } else if (p->type != RTMP_PT_AUDIO && p->type != RTMP_PT_VIDEO && p->type != RTMP_PT_METADATA) {
688 for (i = 0; i < p->size; i++)
689 av_log(ctx, AV_LOG_DEBUG, " %02X", p->data[i]);
690 av_log(ctx, AV_LOG_DEBUG, "\n");
695 int ff_amf_match_string(const uint8_t *data, int size, const char *str)
697 int len = strlen(str);
705 if (type != AMF_DATA_TYPE_LONG_STRING &&
706 type != AMF_DATA_TYPE_STRING)
709 if (type == AMF_DATA_TYPE_LONG_STRING) {
710 if ((size -= 4 + 1) < 0)
712 amf_len = bytestream_get_be32(&data);
714 if ((size -= 2 + 1) < 0)
716 amf_len = bytestream_get_be16(&data);
725 return !memcmp(data, str, len);