rtpdec_vp8.c 9.76 KB
Newer Older
1 2 3
/*
 * RTP VP8 Depacketizer
 * Copyright (c) 2010 Josh Allmann
4
 * Copyright (c) 2012 Martin Storsjo
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * 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
 */

/**
 * @file
 * @brief RTP support for the VP8 payload
 * @author Josh Allmann <joshua.allmann@gmail.com>
27
 * @see http://tools.ietf.org/html/draft-ietf-payload-vp8-05
28 29 30 31
 */

#include "libavcodec/bytestream.h"

32
#include "avio_internal.h"
33 34 35
#include "rtpdec_formats.h"

struct PayloadContext {
36
    AVIOContext *data;
37
    uint32_t     timestamp;
38
    int          is_keyframe;
39 40 41 42
    /* If sequence_ok is set, we keep returning data (even if we might have
     * lost some data, but we haven't lost any too critical data that would
     * cause the decoder to desynchronize and output random garbage).
     */
43 44 45 46 47
    int          sequence_ok;
    int          first_part_size;
    uint16_t     prev_seq;
    int          prev_pictureid;
    int          broken_frame;
48
    /* If sequence_dirty is set, we have lost some data (critical or
49
     * non-critical) and decoding will have some sort of artifacts, and
50 51 52 53
     * we thus should request a new keyframe.
     */
    int          sequence_dirty;
    int          got_keyframe;
54 55
};

56 57 58 59 60
static int vp8_broken_sequence(AVFormatContext *ctx, PayloadContext *vp8,
                               const char *msg)
{
    vp8->sequence_ok = 0;
    av_log(ctx, AV_LOG_WARNING, "%s", msg);
61
    ffio_free_dyn_buf(&vp8->data);
62 63 64
    return AVERROR(EAGAIN);
}

65 66 67 68
static int vp8_handle_packet(AVFormatContext *ctx, PayloadContext *vp8,
                             AVStream *st, AVPacket *pkt, uint32_t *timestamp,
                             const uint8_t *buf, int len, uint16_t seq,
                             int flags)
69
{
70
    int start_partition, end_packet;
71
    int extended_bits, part_id;
72 73
    int pictureid_present = 0, tl0picidx_present = 0, tid_present = 0,
        keyidx_present = 0;
74
    int pictureid = -1, pictureid_mask = 0;
75
    int returned_old_frame = 0;
76
    uint32_t old_timestamp = 0;
77 78 79 80 81 82

    if (!buf) {
        if (vp8->data) {
            int ret = ff_rtp_finalize_packet(pkt, &vp8->data, st->index);
            if (ret < 0)
                return ret;
83
            *timestamp = vp8->timestamp;
84 85
            if (vp8->sequence_dirty)
                pkt->flags |= AV_PKT_FLAG_CORRUPT;
86 87 88 89
            return 0;
        }
        return AVERROR(EAGAIN);
    }
90 91 92 93 94 95 96 97 98 99 100 101

    if (len < 1)
        return AVERROR_INVALIDDATA;

    extended_bits   = buf[0] & 0x80;
    start_partition = buf[0] & 0x10;
    part_id         = buf[0] & 0x0f;
    end_packet      = flags & RTP_FLAG_MARKER;
    buf++;
    len--;
    if (extended_bits) {
        if (len < 1)
102
            return AVERROR_INVALIDDATA;
103 104 105 106 107 108 109 110 111 112
        pictureid_present = buf[0] & 0x80;
        tl0picidx_present = buf[0] & 0x40;
        tid_present       = buf[0] & 0x20;
        keyidx_present    = buf[0] & 0x10;
        buf++;
        len--;
    }
    if (pictureid_present) {
        if (len < 1)
            return AVERROR_INVALIDDATA;
113 114 115 116 117 118 119 120 121 122 123 124 125
        if (buf[0] & 0x80) {
            if (len < 2)
                return AVERROR_INVALIDDATA;
            pictureid = AV_RB16(buf) & 0x7fff;
            pictureid_mask = 0x7fff;
            buf += 2;
            len -= 2;
        } else {
            pictureid = buf[0] & 0x7f;
            pictureid_mask = 0x7f;
            buf++;
            len--;
        }
126
    }
127 128 129 130 131 132
    if (tl0picidx_present) {
        // Ignoring temporal level zero index
        buf++;
        len--;
    }
    if (tid_present || keyidx_present) {
133
        // Ignoring temporal layer index, layer sync bit and keyframe index
134 135 136 137 138
        buf++;
        len--;
    }
    if (len < 1)
        return AVERROR_INVALIDDATA;
139

140
    if (start_partition && part_id == 0 && len >= 3) {
141
        int res;
142 143
        int non_key = buf[0] & 0x01;
        if (!non_key) {
144
            ffio_free_dyn_buf(&vp8->data);
145 146
            // Keyframe, decoding ok again
            vp8->sequence_ok = 1;
147 148
            vp8->sequence_dirty = 0;
            vp8->got_keyframe = 1;
149 150 151 152 153
        } else {
            int can_continue = vp8->data && !vp8->is_keyframe &&
                               avio_tell(vp8->data) >= vp8->first_part_size;
            if (!vp8->sequence_ok)
                return AVERROR(EAGAIN);
154 155
            if (!vp8->got_keyframe)
                return vp8_broken_sequence(ctx, vp8, "Keyframe missing\n");
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
            if (pictureid >= 0) {
                if (pictureid != ((vp8->prev_pictureid + 1) & pictureid_mask)) {
                    return vp8_broken_sequence(ctx, vp8,
                                               "Missed a picture, sequence broken\n");
                } else {
                    if (vp8->data && !can_continue)
                        return vp8_broken_sequence(ctx, vp8,
                                                   "Missed a picture, sequence broken\n");
                }
            } else {
                uint16_t expected_seq = vp8->prev_seq + 1;
                int16_t diff = seq - expected_seq;
                if (vp8->data) {
                    // No picture id, so we can't know if missed packets
                    // contained any new frames. If diff == 0, we did get
                    // later packets from the same frame (matching timestamp),
                    // so we know we didn't miss any frame. If diff == 1 and
                    // we still have data (not flushed by the end of frame
                    // marker), the single missed packet must have been part
                    // of the same frame.
                    if ((diff == 0 || diff == 1) && can_continue) {
                        // Proceed with what we have
                    } else {
                        return vp8_broken_sequence(ctx, vp8,
                                                   "Missed too much, sequence broken\n");
                    }
                } else {
                    if (diff != 0)
                        return vp8_broken_sequence(ctx, vp8,
                                                   "Missed unknown data, sequence broken\n");
                }
            }
            if (vp8->data) {
189
                vp8->sequence_dirty = 1;
190 191 192 193
                if (avio_tell(vp8->data) >= vp8->first_part_size) {
                    int ret = ff_rtp_finalize_packet(pkt, &vp8->data, st->index);
                    if (ret < 0)
                        return ret;
194
                    pkt->flags |= AV_PKT_FLAG_CORRUPT;
195 196 197 198
                    returned_old_frame = 1;
                    old_timestamp = vp8->timestamp;
                } else {
                    // Shouldn't happen
199
                    ffio_free_dyn_buf(&vp8->data);
200 201
                }
            }
202
        }
203
        vp8->first_part_size = (AV_RL16(&buf[1]) << 3 | buf[0] >> 5) + 3;
204
        if ((res = avio_open_dyn_buf(&vp8->data)) < 0)
205
            return res;
206
        vp8->timestamp = *timestamp;
207 208 209 210 211
        vp8->broken_frame = 0;
        vp8->prev_pictureid = pictureid;
        vp8->is_keyframe = !non_key;
    } else {
        uint16_t expected_seq = vp8->prev_seq + 1;
212

213 214 215 216 217
        if (!vp8->sequence_ok)
            return AVERROR(EAGAIN);

        if (vp8->timestamp != *timestamp) {
            // Missed the start of the new frame, sequence broken
218 219
            return vp8_broken_sequence(ctx, vp8,
                                       "Received no start marker; dropping frame\n");
220 221 222 223 224 225 226 227
        }

        if (seq != expected_seq) {
            if (vp8->is_keyframe) {
                return vp8_broken_sequence(ctx, vp8,
                                           "Missed part of a keyframe, sequence broken\n");
            } else if (vp8->data && avio_tell(vp8->data) >= vp8->first_part_size) {
                vp8->broken_frame = 1;
228
                vp8->sequence_dirty = 1;
229 230 231 232 233
            } else {
                return vp8_broken_sequence(ctx, vp8,
                                           "Missed part of the first partition, sequence broken\n");
            }
        }
234 235
    }

236 237 238 239
    if (!vp8->data)
        return vp8_broken_sequence(ctx, vp8, "Received no start marker\n");

    vp8->prev_seq = seq;
240 241
    if (!vp8->broken_frame)
        avio_write(vp8->data, buf, len);
242

243 244 245 246 247
    if (returned_old_frame) {
        *timestamp = old_timestamp;
        return end_packet ? 1 : 0;
    }

248
    if (end_packet) {
249 250
        int ret;
        ret = ff_rtp_finalize_packet(pkt, &vp8->data, st->index);
251 252
        if (ret < 0)
            return ret;
253 254
        if (vp8->sequence_dirty)
            pkt->flags |= AV_PKT_FLAG_CORRUPT;
255 256
        if (vp8->is_keyframe)
            pkt->flags |= AV_PKT_FLAG_KEY;
257 258 259 260 261 262
        return 0;
    }

    return AVERROR(EAGAIN);
}

263
static av_cold int vp8_init(AVFormatContext *s, int st_index, PayloadContext *vp8)
264
{
265
    vp8->sequence_ok = 1;
266
    return 0;
267 268
}

269
static void vp8_close_context(PayloadContext *vp8)
270
{
271
    ffio_free_dyn_buf(&vp8->data);
272 273
}

274 275 276 277 278
static int vp8_need_keyframe(PayloadContext *vp8)
{
    return vp8->sequence_dirty || !vp8->sequence_ok;
}

279 280 281
RTPDynamicProtocolHandler ff_vp8_dynamic_handler = {
    .enc_name       = "VP8",
    .codec_type     = AVMEDIA_TYPE_VIDEO,
282
    .codec_id       = AV_CODEC_ID_VP8,
283 284
    .priv_data_size = sizeof(PayloadContext),
    .init           = vp8_init,
285
    .close          = vp8_close_context,
286
    .parse_packet   = vp8_handle_packet,
287
    .need_keyframe  = vp8_need_keyframe,
288
};