RTMP protocol support (as a client)

Originally committed as revision 19556 to svn://svn.ffmpeg.org/ffmpeg/trunk

Changelog

@@ -29,6 +29,7 @@ version <next>:
 - nonfree libamr support for AMR-NB/WB decoding/encoding removed
 - Experimental AAC encoder
 - RTP depacketization of ASF and RTSP from WMS servers
+- RTMP support in libavformat
 
 
 

doc/general.texi

@@ -195,6 +195,7 @@ library:
 @item RL2                       @tab   @tab X
     @tab Audio and video format used in some games by Entertainment Software Partners.
 @item RPL/ARMovie               @tab   @tab X
+@item RTMP                      @tab   @tab X
 @item RTP                       @tab   @tab X
 @item RTSP                      @tab   @tab X
 @item SDP                       @tab   @tab X

libavformat/Makefile

@@ -237,6 +237,7 @@ OBJS-$(CONFIG_FILE_PROTOCOL)             += file.o
 OBJS-$(CONFIG_GOPHER_PROTOCOL)           += gopher.o
 OBJS-$(CONFIG_HTTP_PROTOCOL)             += http.o
 OBJS-$(CONFIG_PIPE_PROTOCOL)             += file.o
+OBJS-$(CONFIG_RTMP_PROTOCOL)             += rtmpproto.o rtmppkt.o
 OBJS-$(CONFIG_RTP_PROTOCOL)              += rtpproto.o
 OBJS-$(CONFIG_TCP_PROTOCOL)              += tcp.o
 OBJS-$(CONFIG_UDP_PROTOCOL)              += udp.o

libavformat/allformats.c

@@ -209,6 +209,7 @@ void av_register_all(void)
     REGISTER_PROTOCOL (GOPHER, gopher);
     REGISTER_PROTOCOL (HTTP, http);
     REGISTER_PROTOCOL (PIPE, pipe);
+    REGISTER_PROTOCOL (RTMP, rtmp);
     REGISTER_PROTOCOL (RTP, rtp);
     REGISTER_PROTOCOL (TCP, tcp);
     REGISTER_PROTOCOL (UDP, udp);

libavformat/avformat.h

@@ -22,7 +22,7 @@
 #define AVFORMAT_AVFORMAT_H
 
 #define LIBAVFORMAT_VERSION_MAJOR 52
-#define LIBAVFORMAT_VERSION_MINOR 36
+#define LIBAVFORMAT_VERSION_MINOR 37
 #define LIBAVFORMAT_VERSION_MICRO  0
 
 #define LIBAVFORMAT_VERSION_INT AV_VERSION_INT(LIBAVFORMAT_VERSION_MAJOR, \

libavformat/rtmp.h

+/*
+ * RTMP definitions
+ * Copyright (c) 2009 Kostya Shishkov
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef AVFORMAT_RTMP_H
+#define AVFORMAT_RTMP_H
+
+#include "avformat.h"
+
+#define RTMP_DEFAULT_PORT 1935
+
+#define RTMP_HANDSHAKE_PACKET_SIZE 1536
+
+/**
+ * emulated Flash client version - 9.0.124.2 on Linux
+ * @{
+ */
+#define RTMP_CLIENT_PLATFORM "LNX"
+#define RTMP_CLIENT_VER1    9
+#define RTMP_CLIENT_VER2    0
+#define RTMP_CLIENT_VER3  124
+#define RTMP_CLIENT_VER4    2
+/** @} */ //version defines
+
+#endif /* AVFORMAT_RTMP_H */

libavformat/rtmppkt.c

+/*
+ * RTMP input format
+ * Copyright (c) 2009 Kostya Shishkov
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#include "libavcodec/bytestream.h"
+#include "libavutil/avstring.h"
+#include "avformat.h"
+
+#include "rtmppkt.h"
+#include "flv.h"
+
+void ff_amf_write_bool(uint8_t **dst, int val)
+{
+    bytestream_put_byte(dst, AMF_DATA_TYPE_BOOL);
+    bytestream_put_byte(dst, val);
+}
+
+void ff_amf_write_number(uint8_t **dst, double val)
+{
+    bytestream_put_byte(dst, AMF_DATA_TYPE_NUMBER);
+    bytestream_put_be64(dst, av_dbl2int(val));
+}
+
+void ff_amf_write_string(uint8_t **dst, const char *str)
+{
+    bytestream_put_byte(dst, AMF_DATA_TYPE_STRING);
+    bytestream_put_be16(dst, strlen(str));
+    bytestream_put_buffer(dst, str, strlen(str));
+}
+
+void ff_amf_write_null(uint8_t **dst)
+{
+    bytestream_put_byte(dst, AMF_DATA_TYPE_NULL);
+}
+
+void ff_amf_write_object_start(uint8_t **dst)
+{
+    bytestream_put_byte(dst, AMF_DATA_TYPE_OBJECT);
+}
+
+void ff_amf_write_field_name(uint8_t **dst, const char *str)
+{
+    bytestream_put_be16(dst, strlen(str));
+    bytestream_put_buffer(dst, str, strlen(str));
+}
+
+void ff_amf_write_object_end(uint8_t **dst)
+{
+    /* first two bytes are field name length = 0,
+     * AMF object should end with it and end marker
+     */
+    bytestream_put_be24(dst, AMF_DATA_TYPE_OBJECT_END);
+}
+
+int ff_rtmp_packet_read(URLContext *h, RTMPPacket *p,
+                        int chunk_size, RTMPPacket *prev_pkt)
+{
+    uint8_t hdr, t, buf[16];
+    int channel_id, timestamp, data_size, offset = 0;
+    uint32_t extra = 0;
+    uint8_t type;
+
+    if (url_read(h, &hdr, 1) != 1)
+        return AVERROR(EIO);
+    channel_id = hdr & 0x3F;
+
+    data_size = prev_pkt[channel_id].data_size;
+    type      = prev_pkt[channel_id].type;
+    extra     = prev_pkt[channel_id].extra;
+
+    hdr >>= 6;
+    if (hdr == RTMP_PS_ONEBYTE) {
+        //todo
+        return -1;
+    } else {
+        if (url_read_complete(h, buf, 3) != 3)
+            return AVERROR(EIO);
+        timestamp = AV_RB24(buf);
+        if (hdr != RTMP_PS_FOURBYTES) {
+            if (url_read_complete(h, buf, 3) != 3)
+                return AVERROR(EIO);
+            data_size = AV_RB24(buf);
+            if (url_read_complete(h, &type, 1) != 1)
+                return AVERROR(EIO);
+            if (hdr == RTMP_PS_TWELVEBYTES) {
+                if (url_read_complete(h, buf, 4) != 4)
+                    return AVERROR(EIO);
+                extra = AV_RL32(buf);
+            }
+        }
+    }
+    if (ff_rtmp_packet_create(p, channel_id, type, timestamp, data_size))
+        return -1;
+    p->extra = extra;
+    // save history
+    prev_pkt[channel_id].channel_id = channel_id;
+    prev_pkt[channel_id].type       = type;
+    prev_pkt[channel_id].data_size  = data_size;
+    prev_pkt[channel_id].timestamp  = timestamp;
+    prev_pkt[channel_id].extra      = extra;
+    while (data_size > 0) {
+        int toread = FFMIN(data_size, chunk_size);
+        if (url_read_complete(h, p->data + offset, toread) != toread) {
+            ff_rtmp_packet_destroy(p);
+            return AVERROR(EIO);
+        }
+        data_size -= chunk_size;
+        offset    += chunk_size;
+        if (data_size > 0) {
+            url_read_complete(h, &t, 1); //marker
+            if (t != (0xC0 + channel_id))
+                return -1;
+        }
+    }
+    return 0;
+}
+
+int ff_rtmp_packet_write(URLContext *h, RTMPPacket *pkt,
+                         int chunk_size, RTMPPacket *prev_pkt)
+{
+    uint8_t pkt_hdr[16], *p = pkt_hdr;
+    int mode = RTMP_PS_TWELVEBYTES;
+    int off = 0;
+
+    //TODO: header compression
+    bytestream_put_byte(&p, pkt->channel_id | (mode << 6));
+    if (mode != RTMP_PS_ONEBYTE) {
+        bytestream_put_be24(&p, pkt->timestamp);
+        if (mode != RTMP_PS_FOURBYTES) {
+            bytestream_put_be24(&p, pkt->data_size);
+            bytestream_put_byte(&p, pkt->type);
+            if (mode == RTMP_PS_TWELVEBYTES)
+                bytestream_put_le32(&p, pkt->extra);
+        }
+    }
+    url_write(h, pkt_hdr, p-pkt_hdr);
+    while (off < pkt->data_size) {
+        int towrite = FFMIN(chunk_size, pkt->data_size - off);
+        url_write(h, pkt->data + off, towrite);
+        off += towrite;
+        if (off < pkt->data_size) {
+            uint8_t marker = 0xC0 | pkt->channel_id;
+            url_write(h, &marker, 1);
+        }
+    }
+    return 0;
+}
+
+int ff_rtmp_packet_create(RTMPPacket *pkt, int channel_id, RTMPPacketType type,
+                          int timestamp, int size)
+{
+    pkt->data = av_malloc(size);
+    if (!pkt->data)
+        return AVERROR(ENOMEM);
+    pkt->data_size  = size;
+    pkt->channel_id = channel_id;
+    pkt->type       = type;
+    pkt->timestamp  = timestamp;
+    pkt->extra      = 0;
+
+    return 0;
+}
+
+void ff_rtmp_packet_destroy(RTMPPacket *pkt)
+{
+    if (!pkt)
+        return;
+    av_freep(&pkt->data);
+    pkt->data_size = 0;
+}
+
+int ff_amf_tag_size(const uint8_t *data, const uint8_t *data_end)
+{
+    const uint8_t *base = data;
+
+    if (data >= data_end)
+        return -1;
+    switch (*data++) {
+    case AMF_DATA_TYPE_NUMBER:      return 9;
+    case AMF_DATA_TYPE_BOOL:        return 2;
+    case AMF_DATA_TYPE_STRING:      return 3 + AV_RB16(data);
+    case AMF_DATA_TYPE_LONG_STRING: return 5 + AV_RB32(data);
+    case AMF_DATA_TYPE_NULL:        return 1;
+    case AMF_DATA_TYPE_ARRAY:
+        data += 4;
+    case AMF_DATA_TYPE_OBJECT:
+        for (;;) {
+            int size = bytestream_get_be16(&data);
+            int t;
+            if (!size) {
+                data++;
+                break;
+            }
+            if (data + size >= data_end || data + size < data)
+                return -1;
+            data += size;
+            t = ff_amf_tag_size(data, data_end);
+            if (t < 0 || data + t >= data_end)
+                return -1;
+            data += t;
+        }
+        return data - base;
+    case AMF_DATA_TYPE_OBJECT_END:  return 1;
+    default:                        return -1;
+    }
+}
+
+int ff_amf_get_field_value(const uint8_t *data, const uint8_t *data_end,
+                           const uint8_t *name, uint8_t *dst, int dst_size)
+{
+    int namelen = strlen(name);
+    int len;
+
+    if (data_end - data < 3)
+        return -1;
+    if (*data++ != AMF_DATA_TYPE_OBJECT)
+        return -1;
+    for (;;) {
+        int size = bytestream_get_be16(&data);
+        if (!size)
+            break;
+        if (data + size >= data_end || data + size < data)
+            return -1;
+        data += size;
+        if (size == namelen && !memcmp(data-size, name, namelen)) {
+            switch (*data++) {
+            case AMF_DATA_TYPE_NUMBER:
+                snprintf(dst, dst_size, "%g", av_int2dbl(AV_RB64(data)));
+                break;
+            case AMF_DATA_TYPE_BOOL:
+                snprintf(dst, dst_size, "%s", *data ? "true" : "false");
+                break;
+            case AMF_DATA_TYPE_STRING:
+                len = bytestream_get_be16(&data);
+                av_strlcpy(dst, data, FFMIN(len+1, dst_size));
+                break;
+            default:
+                return -1;
+            }
+            return 0;
+        }
+        len = ff_amf_tag_size(data, data_end);
+        if (len < 0 || data + len >= data_end || data + len < data)
+            return -1;
+        data += len;
+    }
+    return -1;
+}

libavformat/rtmppkt.h

+/*
+ * RTMP packet utilities
+ * Copyright (c) 2009 Kostya Shishkov
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef AVFORMAT_RTMPPKT_H
+#define AVFORMAT_RTMPPKT_H
+
+#include "avformat.h"
+
+/** maximum possible number of different RTMP channels */
+#define RTMP_CHANNELS 64
+
+/**
+ * channels used to for RTMP packets with different purposes (i.e. data, network
+ * control, remote procedure calls, etc.)
+ */
+enum RTMPChannel {
+    RTMP_NETWORK_CHANNEL = 2,   ///< channel for network-related messages (bandwidth report, ping, etc)
+    RTMP_SYSTEM_CHANNEL,        ///< channel for sending server control messages
+    RTMP_VIDEO_CHANNEL = 8,     ///< channel for video data
+    RTMP_AUDIO_CHANNEL,         ///< channel for audio data
+};
+
+/**
+ * known RTMP packet types
+ */
+typedef enum RTMPPacketType {
+    RTMP_PT_CHUNK_SIZE   =  1,  ///< chunk size change
+    RTMP_PT_BYTES_READ   =  3,  ///< number of bytes read
+    RTMP_PT_PING,               ///< ping
+    RTMP_PT_SERVER_BW,          ///< server bandwidth
+    RTMP_PT_CLIENT_BW,          ///< client bandwidth
+    RTMP_PT_AUDIO        =  8,  ///< audio packet
+    RTMP_PT_VIDEO,              ///< video packet
+    RTMP_PT_FLEX_STREAM  = 15,  ///< Flex shared stream
+    RTMP_PT_FLEX_OBJECT,        ///< Flex shared object
+    RTMP_PT_FLEX_MESSAGE,       ///< Flex shared message
+    RTMP_PT_NOTIFY,             ///< some notification
+    RTMP_PT_SHARED_OBJ,         ///< shared object
+    RTMP_PT_INVOKE,             ///< invoke some stream action
+    RTMP_PT_METADATA     = 22,  ///< FLV metadata
+} RTMPPacketType;
+
+/**
+ * possible RTMP packet header sizes
+ */
+enum RTMPPacketSize {
+    RTMP_PS_TWELVEBYTES = 0, ///< packet has 12-byte header
+    RTMP_PS_EIGHTBYTES,      ///< packet has 8-byte header
+    RTMP_PS_FOURBYTES,       ///< packet has 4-byte header
+    RTMP_PS_ONEBYTE          ///< packet is really a next chunk of a packet
+};
+
+/**
+ * structure for holding RTMP packets
+ */
+typedef struct RTMPPacket {
+    uint8_t        channel_id; ///< RTMP channel ID (nothing to do with audio/video channels though)
+    RTMPPacketType type;       ///< packet payload type
+    uint32_t       timestamp;  ///< packet full timestamp or timestamp increment to the previous one in milliseconds (latter only for media packets)
+    uint32_t       extra;      ///< probably an additional channel ID used during streaming data
+    uint8_t        *data;      ///< packet payload
+    int            data_size;  ///< packet payload size
+} RTMPPacket;
+
+/**
+ * Creates new RTMP packet with given attributes.
+ *
+ * @param pkt        packet
+ * @param channel_id packet channel ID
+ * @param type       packet type
+ * @param timestamp  packet timestamp
+ * @param size       packet size
+ * @return zero on success, negative value otherwise
+ */
+int ff_rtmp_packet_create(RTMPPacket *pkt, int channel_id, RTMPPacketType type,
+                          int timestamp, int size);
+
+/**
+ * Frees RTMP packet.
+ *
+ * @param pkt packet
+ */
+void ff_rtmp_packet_destroy(RTMPPacket *pkt);
+
+/**
+ * Reads RTMP packet sent by the server.
+ *
+ * @param h          reader context
+ * @param p          packet
+ * @param chunk_size current chunk size
+ * @param prev_pkt   previously read packet headers for all channels
+ *                   (may be needed for restoring incomplete packet header)
+ * @return zero on success, negative value otherwise
+ */
+int ff_rtmp_packet_read(URLContext *h, RTMPPacket *p,
+                        int chunk_size, RTMPPacket *prev_pkt);
+
+/**
+ * Sends RTMP packet to the server.
+ *
+ * @param h          reader context
+ * @param p          packet to send
+ * @param chunk_size current chunk size
+ * @param prev_pkt   previously sent packet headers for all channels
+ *                   (may be used for packet header compressing)
+ * @return zero on success, negative value otherwise
+ */
+int ff_rtmp_packet_write(URLContext *h, RTMPPacket *p,
+                         int chunk_size, RTMPPacket *prev_pkt);
+
+/**
+ * @defgroup amffuncs functions used to work with AMF format (which is also used in .flv)
+ * @see amf_* funcs in libavformat/flvdec.c
+ * @{
+ */
+
+/**
+ * Calculates number of bytes taken by first AMF entry in data.
+ *
+ * @param data input data
+ * @param data_end input buffer end
+ * @return number of bytes used by first AMF entry
+ */
+int ff_amf_tag_size(const uint8_t *data, const uint8_t *data_end);
+
+/**
+ * Retrieves value of given AMF object field in string form.
+ *
+ * @param data     AMF object data
+ * @param data_end input buffer end
+ * @param name     name of field to retrieve
+ * @param dst      buffer for storing result
+ * @param dst_size output buffer size
+ * @return 0 if search and retrieval succeeded, negative value otherwise
+ */
+int ff_amf_get_field_value(const uint8_t *data, const uint8_t *data_end,
+                           const uint8_t *name, uint8_t *dst, int dst_size);
+
+/**
+ * Writes boolean value in AMF format to buffer.
+ *
+ * @param dst pointer to the input buffer (will be modified)
+ * @param val value to write
+ */
+void ff_amf_write_bool(uint8_t **dst, int val);
+
+/**
+ * Writes number in AMF format to buffer.
+ *
+ * @param dst pointer to the input buffer (will be modified)
+ * @param num value to write
+ */
+void ff_amf_write_number(uint8_t **dst, double num);
+
+/**
+ * Writes string in AMF format to buffer.
+ *
+ * @param dst pointer to the input buffer (will be modified)
+ * @param str string to write
+ */
+void ff_amf_write_string(uint8_t **dst, const char *str);
+
+/**
+ * Writes AMF NULL value to buffer.
+ *
+ * @param dst pointer to the input buffer (will be modified)
+ */
+void ff_amf_write_null(uint8_t **dst);
+
+/**
+ * Writes marker for AMF object to buffer.
+ *
+ * @param dst pointer to the input buffer (will be modified)
+ */
+void ff_amf_write_object_start(uint8_t **dst);
+
+/**
+ * Writes string used as field name in AMF object to buffer.
+ *
+ * @param dst pointer to the input buffer (will be modified)
+ * @param str string to write
+ */
+void ff_amf_write_field_name(uint8_t **dst, const char *str);
+
+/**
+ * Writes marker for end of AMF object to buffer.
+ *
+ * @param dst pointer to the input buffer (will be modified)
+ */
+void ff_amf_write_object_end(uint8_t **dst);
+
+/** @} */ // AMF funcs
+
+#endif /* AVFORMAT_RTMPPKT_H */