Coverage Report

Created: 2026-09-14 08:00

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/ffmpeg/libavformat/rtpdec_vp9.c
Line
Count
Source
1
/*
2
 * RTP parser for VP9 payload format (draft version 02) - experimental
3
 * Copyright (c) 2015 Thomas Volkert <thomas@homer-conferencing.com>
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 "libavutil/intreadwrite.h"
23
24
#include "avio_internal.h"
25
#include "rtpdec_formats.h"
26
27
0
#define RTP_VP9_DESC_REQUIRED_SIZE 1
28
29
struct PayloadContext {
30
    AVIOContext *buf;
31
    uint32_t     timestamp;
32
};
33
34
static av_cold int vp9_init(AVFormatContext *ctx, int st_index,
35
                            PayloadContext *data)
36
0
{
37
0
    av_log(ctx, AV_LOG_WARNING,
38
0
           "RTP/VP9 support is still experimental\n");
39
40
0
    return 0;
41
0
}
42
43
static int vp9_handle_packet(AVFormatContext *ctx, PayloadContext *rtp_vp9_ctx,
44
                             AVStream *st, AVPacket *pkt, uint32_t *timestamp,
45
                             const uint8_t *buf, int len, uint16_t seq,
46
                             int flags)
47
0
{
48
0
    int has_pic_id, has_layer_idc, has_ref_idc, has_ss_data;
49
0
    av_unused int pic_id = 0, non_key_frame = 0, inter_picture_layer_frame;
50
0
    av_unused int layer_temporal = -1, layer_spatial = -1, layer_quality = -1;
51
0
    int ref_fields = 0, has_ref_field_ext_pic_id = 0;
52
0
    int first_fragment, last_fragment;
53
0
    int rtp_m;
54
0
    int res = 0;
55
56
    /* drop data of previous packets in case of non-continuous (lossy) packet stream */
57
0
    if (rtp_vp9_ctx->buf && rtp_vp9_ctx->timestamp != *timestamp)
58
0
        ffio_free_dyn_buf(&rtp_vp9_ctx->buf);
59
60
    /* sanity check for size of input packet: 1 byte payload at least */
61
0
    if (len < RTP_VP9_DESC_REQUIRED_SIZE + 1) {
62
0
        av_log(ctx, AV_LOG_ERROR, "Too short RTP/VP9 packet, got %d bytes\n", len);
63
0
        return AVERROR_INVALIDDATA;
64
0
    }
65
66
    /*
67
     *     decode the required VP9 payload descriptor according to section 4.2 of the spec.:
68
     *
69
     *      0 1 2 3 4 5 6 7
70
     *     +-+-+-+-+-+-+-+-+
71
     *     |I|P|L|F|B|E|V|-| (REQUIRED)
72
     *     +-+-+-+-+-+-+-+-+
73
     *
74
     *     I: PictureID present
75
     *     P: Inter-picture predicted layer frame
76
     *     L: Layer indices present
77
     *     F: Flexible mode
78
     *     B: Start of VP9 frame
79
     *     E: End of picture
80
     *     V: Scalability Structure (SS) present
81
     */
82
0
    has_pic_id     = !!(buf[0] & 0x80);
83
0
    inter_picture_layer_frame = !!(buf[0] & 0x40);
84
0
    has_layer_idc  = !!(buf[0] & 0x20);
85
0
    has_ref_idc    = !!(buf[0] & 0x10);
86
0
    first_fragment = !!(buf[0] & 0x08);
87
0
    last_fragment  = !!(buf[0] & 0x04);
88
0
    has_ss_data    = !!(buf[0] & 0x02);
89
90
0
    rtp_m = !!(flags & RTP_FLAG_MARKER);
91
92
    /* sanity check for markers: B should always be equal to the RTP M marker */
93
0
    if (last_fragment != rtp_m) {
94
0
        av_log(ctx, AV_LOG_ERROR, "Invalid combination of B and M marker (%d != %d)\n", last_fragment, rtp_m);
95
0
        return AVERROR_INVALIDDATA;
96
0
    }
97
98
    /* pass the extensions field */
99
0
    buf += RTP_VP9_DESC_REQUIRED_SIZE;
100
0
    len -= RTP_VP9_DESC_REQUIRED_SIZE;
101
102
    /*
103
     *         decode the 1-byte/2-byte picture ID:
104
     *
105
     *          0 1 2 3 4 5 6 7
106
     *         +-+-+-+-+-+-+-+-+
107
     *   I:    |M|PICTURE ID   | (RECOMMENDED)
108
     *         +-+-+-+-+-+-+-+-+
109
     *   M:    | EXTENDED PID  | (RECOMMENDED)
110
     *         +-+-+-+-+-+-+-+-+
111
     *
112
     *   M: The most significant bit of the first octet is an extension flag.
113
     *   PictureID:  8 or 16 bits including the M bit.
114
     */
115
0
    if (has_pic_id) {
116
        /* check for 1-byte or 2-byte picture index */
117
0
        if (buf[0] & 0x80) {
118
0
            if (len < 2) {
119
0
                av_log(ctx, AV_LOG_ERROR, "Too short RTP/VP9 packet\n");
120
0
                return AVERROR_INVALIDDATA;
121
0
            }
122
0
            pic_id = AV_RB16(buf) & 0x7fff;
123
0
            buf += 2;
124
0
            len -= 2;
125
0
        } else {
126
0
            pic_id = buf[0] & 0x7f;
127
0
            buf++;
128
0
            len--;
129
0
        }
130
0
    }
131
132
    /*
133
     *         decode layer indices
134
     *
135
     *          0 1 2 3 4 5 6 7
136
     *         +-+-+-+-+-+-+-+-+
137
     *   L:    | T | S | Q | R | (CONDITIONALLY RECOMMENDED)
138
     *         +-+-+-+-+-+-+-+-+
139
     *
140
     *   T, S and Q are 2-bit indices for temporal, spatial, and quality layers.
141
     *   If "F" is set in the initial octet, R is 2 bits representing the number
142
     *   of reference fields this frame refers to.
143
     */
144
0
    if (has_layer_idc) {
145
0
        if (len < 1) {
146
0
            av_log(ctx, AV_LOG_ERROR, "Too short RTP/VP9 packet\n");
147
0
            return AVERROR_INVALIDDATA;
148
0
        }
149
0
        layer_temporal = buf[0] & 0xC0;
150
0
        layer_spatial  = buf[0] & 0x30;
151
0
        layer_quality  = buf[0] & 0x0C;
152
0
        if (has_ref_idc) {
153
0
            ref_fields = buf[0] & 0x03;
154
0
            if (ref_fields)
155
0
                non_key_frame = 1;
156
0
        }
157
0
        buf++;
158
0
        len--;
159
0
    }
160
161
    /*
162
     *         decode the reference fields
163
     *
164
     *          0 1 2 3 4 5 6 7
165
     *         +-+-+-+-+-+-+-+-+              -\
166
     *   F:    | PID |X| RS| RQ| (OPTIONAL)    .
167
     *         +-+-+-+-+-+-+-+-+               . - R times
168
     *   X:    | EXTENDED PID  | (OPTIONAL)    .
169
     *         +-+-+-+-+-+-+-+-+              -/
170
     *
171
     *   PID:  The relative Picture ID referred to by this frame.
172
     *   RS and RQ:  The spatial and quality layer IDs.
173
     *   X: 1 if this layer index has an extended relative Picture ID.
174
     */
175
0
    if (has_ref_idc) {
176
0
        while (ref_fields) {
177
0
            if (len < 1) {
178
0
                av_log(ctx, AV_LOG_ERROR, "Too short RTP/VP9 packet\n");
179
0
                return AVERROR_INVALIDDATA;
180
0
            }
181
182
0
            has_ref_field_ext_pic_id = buf[0] & 0x10;
183
184
            /* pass ref. field */
185
0
            if (has_ref_field_ext_pic_id) {
186
0
                if (len < 2) {
187
0
                    av_log(ctx, AV_LOG_ERROR, "Too short RTP/VP9 packet\n");
188
0
                    return AVERROR_INVALIDDATA;
189
0
                }
190
191
                /* ignore ref. data */
192
193
0
                buf += 2;
194
0
                len -= 2;
195
0
            } else {
196
197
                /* ignore ref. data */
198
199
0
                buf++;
200
0
                len--;
201
0
            }
202
0
            ref_fields--;
203
0
        }
204
0
    }
205
206
    /*
207
     *         decode the scalability structure (SS)
208
     *
209
     *          0 1 2 3 4 5 6 7
210
     *         +-+-+-+-+-+-+-+-+
211
     *   V:    | PATTERN LENGTH|
212
     *         +-+-+-+-+-+-+-+-+                           -\
213
     *         | T | S | Q | R | (OPTIONAL)                 .
214
     *         +-+-+-+-+-+-+-+-+              -\            .
215
     *         | PID |X| RS| RQ| (OPTIONAL)    .            . - PAT. LEN. times
216
     *         +-+-+-+-+-+-+-+-+               . - R times  .
217
     *   X:    | EXTENDED PID  | (OPTIONAL)    .            .
218
     *         +-+-+-+-+-+-+-+-+              -/           -/
219
     *
220
     *   PID:  The relative Picture ID referred to by this frame.
221
     *   RS and RQ:  The spatial and quality layer IDs.
222
     *   X: 1 if this layer index has an extended relative Picture ID.
223
     */
224
0
    if (has_ss_data) {
225
0
        int n_s, y, g, i;
226
0
        if (len < 1) {
227
0
            av_log(ctx, AV_LOG_ERROR, "Too short RTP/VP9 packet\n");
228
0
            return AVERROR_INVALIDDATA;
229
0
        }
230
0
        n_s = buf[0] >> 5;
231
0
        y = !!(buf[0] & 0x10);
232
0
        g = !!(buf[0] & 0x08);
233
0
        buf++;
234
0
        len--;
235
0
        if (n_s > 0) {
236
0
            avpriv_report_missing_feature(ctx, "VP9 scalability structure with multiple layers");
237
0
            return AVERROR_PATCHWELCOME;
238
0
        }
239
0
        if (y) {
240
0
            if (len < 4 * (n_s + 1)) {
241
0
                av_log(ctx, AV_LOG_ERROR, "Too short RTP/VP9 packet\n");
242
0
                return AVERROR_INVALIDDATA;
243
0
            }
244
0
            for (i = 0; i < n_s + 1; i++) {
245
0
                av_unused int w, h;
246
0
                w = AV_RB16(buf);
247
0
                h = AV_RB16(buf + 2);
248
0
                buf += 4;
249
0
                len -= 4;
250
0
            }
251
0
        }
252
0
        if (g) {
253
0
            int n_g;
254
0
            if (len < 1) {
255
0
                av_log(ctx, AV_LOG_ERROR, "Too short RTP/VP9 packet\n");
256
0
                return AVERROR_INVALIDDATA;
257
0
            }
258
0
            n_g = buf[0];
259
0
            buf++;
260
0
            len--;
261
0
            for (i = 0; i < n_g; i++) {
262
0
                av_unused int t, u, r, j;
263
0
                if (len < 1) {
264
0
                    av_log(ctx, AV_LOG_ERROR, "Too short RTP/VP9 packet\n");
265
0
                    return AVERROR_INVALIDDATA;
266
0
                }
267
0
                t = buf[0] >> 5;
268
0
                u = !!(buf[0] & 0x10);
269
0
                r = (buf[0] >> 2) & 0x03;
270
0
                buf++;
271
0
                len--;
272
0
                if (len < r) {
273
0
                    av_log(ctx, AV_LOG_ERROR, "Too short RTP/VP9 packet\n");
274
0
                    return AVERROR_INVALIDDATA;
275
0
                }
276
0
                for (j = 0; j < r; j++) {
277
0
                    av_unused int p_diff = buf[0];
278
0
                    buf++;
279
0
                    len--;
280
0
                }
281
0
            }
282
0
        }
283
0
    }
284
285
    /*
286
     * decode the VP9 payload header
287
     *
288
     *  spec. is tbd
289
     */
290
    //XXX: implement when specified
291
292
    /* sanity check: 1 byte payload as minimum */
293
0
    if (len < 1) {
294
0
        av_log(ctx, AV_LOG_ERROR, "Too short RTP/VP9 packet\n");
295
0
        return AVERROR_INVALIDDATA;
296
0
    }
297
298
    /* start frame buffering with new dynamic buffer */
299
0
    if (!rtp_vp9_ctx->buf) {
300
        /* sanity check: a new frame should have started */
301
0
        if (first_fragment) {
302
0
            res = avio_open_dyn_buf(&rtp_vp9_ctx->buf);
303
0
            if (res < 0)
304
0
                return res;
305
            /* update the timestamp in the frame packet with the one from the RTP packet */
306
0
            rtp_vp9_ctx->timestamp = *timestamp;
307
0
        } else {
308
            /* frame not started yet, need more packets */
309
0
            return AVERROR(EAGAIN);
310
0
        }
311
0
    }
312
313
    /* write the fragment to the dyn. buffer */
314
0
    avio_write(rtp_vp9_ctx->buf, buf, len);
315
316
    /* do we need more fragments? */
317
0
    if (!last_fragment)
318
0
        return AVERROR(EAGAIN);
319
320
    /* close frame buffering and create resulting A/V packet */
321
0
    res = ff_rtp_finalize_packet(pkt, &rtp_vp9_ctx->buf, st->index);
322
0
    if (res < 0)
323
0
        return res;
324
325
0
    return 0;
326
0
}
327
328
static void vp9_close_context(PayloadContext *vp9)
329
0
{
330
0
    ffio_free_dyn_buf(&vp9->buf);
331
0
}
332
333
const RTPDynamicProtocolHandler ff_vp9_dynamic_handler = {
334
    .enc_name         = "VP9",
335
    .codec_type       = AVMEDIA_TYPE_VIDEO,
336
    .codec_id         = AV_CODEC_ID_VP9,
337
    .priv_data_size   = sizeof(PayloadContext),
338
    .init             = vp9_init,
339
    .close            = vp9_close_context,
340
    .parse_packet     = vp9_handle_packet
341
};