yading@11: /*
yading@11:  * QDesign Music 2 (QDM2) payload for RTP
yading@11:  * Copyright (c) 2010 Ronald S. Bultje
yading@11:  *
yading@11:  * This file is part of FFmpeg.
yading@11:  *
yading@11:  * FFmpeg is free software; you can redistribute it and/or
yading@11:  * modify it under the terms of the GNU Lesser General Public
yading@11:  * License as published by the Free Software Foundation; either
yading@11:  * version 2.1 of the License, or (at your option) any later version.
yading@11:  *
yading@11:  * FFmpeg is distributed in the hope that it will be useful,
yading@11:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@11:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@11:  * Lesser General Public License for more details.
yading@11:  *
yading@11:  * You should have received a copy of the GNU Lesser General Public
yading@11:  * License along with FFmpeg; if not, write to the Free Software
yading@11:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@11:  */
yading@11: 
yading@11: /**
yading@11:  * @file
yading@11:  * @brief RTP support for the QDM2 payload (todo: wiki)
yading@11:  * @author Ronald S. Bultje <rbultje@ronald.bitfreak.net>
yading@11:  */
yading@11: 
yading@11: #include <string.h>
yading@11: #include "libavutil/avassert.h"
yading@11: #include "libavutil/intreadwrite.h"
yading@11: #include "libavcodec/avcodec.h"
yading@11: #include "rtp.h"
yading@11: #include "rtpdec.h"
yading@11: #include "rtpdec_formats.h"
yading@11: 
yading@11: struct PayloadContext {
yading@11:     /** values read from the config header, used as packet headers */
yading@11:     //@{
yading@11:     int block_type;            ///< superblock type, value 2 .. 8
yading@11:     int block_size;            ///< from extradata, used as pkt length
yading@11:     int subpkts_per_block;     ///< max. nr. of subpackets to add per output buffer
yading@11:     //@}
yading@11: 
yading@11:     /** Temporary storage for superblock restoring, per packet ID (0x80 total) */
yading@11:     //@{
yading@11:     uint16_t len[0x80];        ///< how much the temporary buffer is filled
yading@11:     uint8_t  buf[0x80][0x800]; ///< the temporary storage buffer
yading@11: 
yading@11:     unsigned int cache;        ///< number of data packets that we have cached right now
yading@11:     unsigned int n_pkts;       ///< number of RTP packets received since last packet output / config
yading@11:     uint32_t timestamp;        ///< timestamp of next-to-be-returned packet
yading@11:     //@}
yading@11: };
yading@11: 
yading@11: /**
yading@11:  * Parse configuration (basically the codec-specific extradata) from
yading@11:  * an RTP config subpacket (starts with 0xff).
yading@11:  *
yading@11:  * Layout of the config subpacket (in bytes):
yading@11:  * 1: 0xFF          <- config ID
yading@11:  * then an array {
yading@11:  *     1: size      <- of the current item
yading@11:  *     1: item type <- 0 .. 4
yading@11:  *     size-2: data <- data depends on the item type
yading@11:  * }
yading@11:  *
yading@11:  * Item 0 implies the end of the config subpacket, and has no data.
yading@11:  * Item 1 implies a stream configuration without extradata.
yading@11:  * Item 2 max. nr. of subpackets per superblock
yading@11:  * Item 3 superblock type for the stream
yading@11:  * Item 4 implies a stream configuration with extradata (size >= 0x1c).
yading@11:  *
yading@11:  * @return <0 on error, otherwise the number of bytes parsed from the
yading@11:  *         input buffer.
yading@11:  */
yading@11: static int qdm2_parse_config(PayloadContext *qdm, AVStream *st,
yading@11:                              const uint8_t *buf, const uint8_t *end)
yading@11: {
yading@11:     const uint8_t *p = buf;
yading@11: 
yading@11:     while (end - p >= 2) {
yading@11:         unsigned int item_len = p[0], config_item = p[1];
yading@11: 
yading@11:         if (item_len < 2 || end - p < item_len || config_item > 4)
yading@11:             return AVERROR_INVALIDDATA;
yading@11: 
yading@11:         switch (config_item) {
yading@11:             case 0: /* end of config block */
yading@11:                 return p - buf + item_len;
yading@11:             case 1: /* stream without extradata */
yading@11:                 /* FIXME: set default qdm->block_size */
yading@11:                 break;
yading@11:             case 2: /**< subpackets per block */
yading@11:                 if (item_len < 3)
yading@11:                     return AVERROR_INVALIDDATA;
yading@11:                 qdm->subpkts_per_block = p[2];
yading@11:                 break;
yading@11:             case 3: /* superblock type */
yading@11:                 if (item_len < 4)
yading@11:                     return AVERROR_INVALIDDATA;
yading@11:                 qdm->block_type = AV_RB16(p + 2);
yading@11:                 break;
yading@11:             case 4: /* stream with extradata */
yading@11:                 if (item_len < 30)
yading@11:                     return AVERROR_INVALIDDATA;
yading@11:                 av_freep(&st->codec->extradata);
yading@11:                 st->codec->extradata_size = 26 + item_len;
yading@11:                 if (!(st->codec->extradata = av_mallocz(st->codec->extradata_size + FF_INPUT_BUFFER_PADDING_SIZE))) {
yading@11:                     st->codec->extradata_size = 0;
yading@11:                     return AVERROR(ENOMEM);
yading@11:                 }
yading@11:                 AV_WB32(st->codec->extradata, 12);
yading@11:                 memcpy(st->codec->extradata + 4, "frma", 4);
yading@11:                 memcpy(st->codec->extradata + 8, "QDM2", 4);
yading@11:                 AV_WB32(st->codec->extradata + 12, 6 + item_len);
yading@11:                 memcpy(st->codec->extradata + 16, "QDCA", 4);
yading@11:                 memcpy(st->codec->extradata + 20, p + 2, item_len - 2);
yading@11:                 AV_WB32(st->codec->extradata + 18 + item_len, 8);
yading@11:                 AV_WB32(st->codec->extradata + 22 + item_len, 0);
yading@11: 
yading@11:                 qdm->block_size = AV_RB32(p + 26);
yading@11:                 break;
yading@11:         }
yading@11: 
yading@11:         p += item_len;
yading@11:     }
yading@11: 
yading@11:     return AVERROR(EAGAIN); /* not enough data */
yading@11: }
yading@11: 
yading@11: /**
yading@11:  * Parse a single subpacket. We store this subpacket in an intermediate
yading@11:  * buffer (position depends on the ID (byte[0]). When called, at least
yading@11:  * 4 bytes are available for reading (see qdm2_parse_packet()).
yading@11:  *
yading@11:  * Layout of a single subpacket (RTP packets commonly contain multiple
yading@11:  * such subpackets) - length in bytes:
yading@11:  * 1:    ordering ID        <- 0 .. 0x7F
yading@11:  * 1:    subpacket type     <- 0 .. 0x7F; value & 0x80 means subpacket length = 2 bytes, else 1 byte
yading@11:  * 1/2:  subpacket length   <- length of the data following the flags/length fields
yading@11:  * if (subpacket type & 0x7F) == 0x7F
yading@11:  *   1:  subpacket type, higher bits
yading@11:  * size: subpacket data
yading@11:  *
yading@11:  * The subpackets come in randomly, and should be encapsulated into 1
yading@11:  * or more superblocks (containing qdm->subpkts_per_block subpackets
yading@11:  * each) per RTP packet, in order of ascending "ordering ID", see
yading@11:  * qdm2_restore_block().
yading@11:  *
yading@11:  * @return <0 on error, otherwise the number of bytes parsed from the
yading@11:  *         input buffer.
yading@11:  */
yading@11: static int qdm2_parse_subpacket(PayloadContext *qdm, AVStream *st,
yading@11:                                 const uint8_t *buf, const uint8_t *end)
yading@11: {
yading@11:     const uint8_t *p = buf;
yading@11:     unsigned int id, len, type, to_copy;
yading@11: 
yading@11:     /* parse header so we know the size of the header/data */
yading@11:     id       = *p++;
yading@11:     type     = *p++;
yading@11:     if (type & 0x80) {
yading@11:         len   = AV_RB16(p);
yading@11:         p    += 2;
yading@11:         type &= 0x7F;
yading@11:     } else
yading@11:         len = *p++;
yading@11: 
yading@11:     if (end - p < len + (type == 0x7F) || id >= 0x80)
yading@11:         return AVERROR_INVALIDDATA;
yading@11:     if (type == 0x7F)
yading@11:         type |= *p++ << 8;
yading@11: 
yading@11:     /* copy data into a temporary buffer */
yading@11:     to_copy = FFMIN(len + (p - &buf[1]), 0x800 - qdm->len[id]);
yading@11:     memcpy(&qdm->buf[id][qdm->len[id]], buf + 1, to_copy);
yading@11:     qdm->len[id] += to_copy;
yading@11: 
yading@11:     return p + len - buf;
yading@11: }
yading@11: 
yading@11: /**
yading@11:  * Add a superblock header around a set of subpackets.
yading@11:  *
yading@11:  * @return <0 on error, else 0.
yading@11:  */
yading@11: static int qdm2_restore_block(PayloadContext *qdm, AVStream *st, AVPacket *pkt)
yading@11: {
yading@11:     int to_copy, n, res, include_csum;
yading@11:     uint8_t *p, *csum_pos = NULL;
yading@11: 
yading@11:     /* create packet to hold subpkts into a superblock */
yading@11:     assert(qdm->cache > 0);
yading@11:     for (n = 0; n < 0x80; n++)
yading@11:         if (qdm->len[n] > 0)
yading@11:             break;
yading@11:     av_assert0(n < 0x80);
yading@11: 
yading@11:     if ((res = av_new_packet(pkt, qdm->block_size)) < 0)
yading@11:         return res;
yading@11:     memset(pkt->data, 0, pkt->size);
yading@11:     pkt->stream_index  = st->index;
yading@11:     p                  = pkt->data;
yading@11: 
yading@11:     /* superblock header */
yading@11:     if (qdm->len[n] > 0xff) {
yading@11:         *p++ = qdm->block_type | 0x80;
yading@11:         AV_WB16(p, qdm->len[n]);
yading@11:         p   += 2;
yading@11:     } else {
yading@11:         *p++ = qdm->block_type;
yading@11:         *p++ = qdm->len[n];
yading@11:     }
yading@11:     if ((include_csum = (qdm->block_type == 2 || qdm->block_type == 4))) {
yading@11:         csum_pos = p;
yading@11:         p       += 2;
yading@11:     }
yading@11: 
yading@11:     /* subpacket data */
yading@11:     to_copy = FFMIN(qdm->len[n], pkt->size - (p - pkt->data));
yading@11:     memcpy(p, qdm->buf[n], to_copy);
yading@11:     qdm->len[n] = 0;
yading@11: 
yading@11:     /* checksum header */
yading@11:     if (include_csum) {
yading@11:         unsigned int total = 0;
yading@11:         uint8_t *q;
yading@11: 
yading@11:         for (q = pkt->data; q < &pkt->data[qdm->block_size]; q++)
yading@11:             total += *q;
yading@11:         AV_WB16(csum_pos, (uint16_t) total);
yading@11:     }
yading@11: 
yading@11:     return 0;
yading@11: }
yading@11: 
yading@11: /** return 0 on packet, no more left, 1 on packet, -1 on partial packet... */
yading@11: static int qdm2_parse_packet(AVFormatContext *s, PayloadContext *qdm,
yading@11:                              AVStream *st, AVPacket *pkt,
yading@11:                              uint32_t *timestamp,
yading@11:                              const uint8_t *buf, int len, uint16_t seq,
yading@11:                              int flags)
yading@11: {
yading@11:     int res = AVERROR_INVALIDDATA, n;
yading@11:     const uint8_t *end = buf + len, *p = buf;
yading@11: 
yading@11:     if (len > 0) {
yading@11:         if (len < 2)
yading@11:             return AVERROR_INVALIDDATA;
yading@11: 
yading@11:         /* configuration block */
yading@11:         if (*p == 0xff) {
yading@11:             if (qdm->n_pkts > 0) {
yading@11:                 av_log(s, AV_LOG_WARNING,
yading@11:                        "Out of sequence config - dropping queue\n");
yading@11:                 qdm->n_pkts = 0;
yading@11:                 memset(qdm->len, 0, sizeof(qdm->len));
yading@11:             }
yading@11: 
yading@11:             if ((res = qdm2_parse_config(qdm, st, ++p, end)) < 0)
yading@11:                 return res;
yading@11:             p += res;
yading@11: 
yading@11:             /* We set codec_id to AV_CODEC_ID_NONE initially to
yading@11:              * delay decoder initialization since extradata is
yading@11:              * carried within the RTP stream, not SDP. Here,
yading@11:              * by setting codec_id to AV_CODEC_ID_QDM2, we are signalling
yading@11:              * to the decoder that it is OK to initialize. */
yading@11:             st->codec->codec_id = AV_CODEC_ID_QDM2;
yading@11:         }
yading@11:         if (st->codec->codec_id == AV_CODEC_ID_NONE)
yading@11:             return AVERROR(EAGAIN);
yading@11: 
yading@11:         /* subpackets */
yading@11:         while (end - p >= 4) {
yading@11:             if ((res = qdm2_parse_subpacket(qdm, st, p, end)) < 0)
yading@11:                 return res;
yading@11:             p += res;
yading@11:         }
yading@11: 
yading@11:         qdm->timestamp = *timestamp;
yading@11:         if (++qdm->n_pkts < qdm->subpkts_per_block)
yading@11:             return AVERROR(EAGAIN);
yading@11:         qdm->cache = 0;
yading@11:         for (n = 0; n < 0x80; n++)
yading@11:             if (qdm->len[n] > 0)
yading@11:                 qdm->cache++;
yading@11:     }
yading@11: 
yading@11:     /* output the subpackets into freshly created superblock structures */
yading@11:     if (!qdm->cache || (res = qdm2_restore_block(qdm, st, pkt)) < 0)
yading@11:         return res;
yading@11:     if (--qdm->cache == 0)
yading@11:         qdm->n_pkts = 0;
yading@11: 
yading@11:     *timestamp = qdm->timestamp;
yading@11:     qdm->timestamp = RTP_NOTS_VALUE;
yading@11: 
yading@11:     return (qdm->cache > 0) ? 1 : 0;
yading@11: }
yading@11: 
yading@11: static PayloadContext *qdm2_extradata_new(void)
yading@11: {
yading@11:     return av_mallocz(sizeof(PayloadContext));
yading@11: }
yading@11: 
yading@11: static void qdm2_extradata_free(PayloadContext *qdm)
yading@11: {
yading@11:     av_free(qdm);
yading@11: }
yading@11: 
yading@11: RTPDynamicProtocolHandler ff_qdm2_dynamic_handler = {
yading@11:     .enc_name         = "X-QDM",
yading@11:     .codec_type       = AVMEDIA_TYPE_AUDIO,
yading@11:     .codec_id         = AV_CODEC_ID_NONE,
yading@11:     .alloc            = qdm2_extradata_new,
yading@11:     .free             = qdm2_extradata_free,
yading@11:     .parse_packet     = qdm2_parse_packet,
yading@11: };