Coverage Report

Created: 2025-08-28 07:12

/src/ffmpeg/libavcodec/cbs_vp8.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * This file is part of FFmpeg.
3
 *
4
 * FFmpeg is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
6
 * License as published by the Free Software Foundation; either
7
 * version 2.1 of the License, or (at your option) any later version.
8
 *
9
 * FFmpeg is distributed in the hope that it will be useful,
10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15
 * License along with FFmpeg; if not, write to the Free Software
16
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
 */
18
19
#include "libavutil/avassert.h"
20
21
#include "cbs.h"
22
#include "cbs_internal.h"
23
#include "cbs_vp8.h"
24
25
#include <stdbool.h>
26
27
#define DEFAULT_PROB 0x80
28
29
// The probability table is defined in 'vp8data.c'.
30
extern const uint8_t ff_vp8_token_update_probs[4][8][3][11];
31
32
// Implements VP8 boolean decoder using GetBitContext to read the bitstream.
33
typedef struct CBSVP8BoolDecoder {
34
    GetBitContext *gbc;
35
36
    uint8_t value;
37
    uint8_t range;
38
39
    uint8_t count; // Store the number of bits in the `value` buffer.
40
41
} CBSVP8BoolDecoder;
42
43
static int cbs_vp8_bool_decoder_init(CBSVP8BoolDecoder *decoder, GetBitContext *gbc)
44
90.1k
{
45
90.1k
    av_assert0(decoder);
46
90.1k
    av_assert0(gbc);
47
48
90.1k
    decoder->gbc = gbc;
49
90.1k
    decoder->value = 0;
50
90.1k
    decoder->range = 255;
51
52
90.1k
    decoder->count = 0;
53
54
90.1k
    return 0;
55
90.1k
}
56
57
static bool cbs_vp8_bool_decoder_fill_value(CBSVP8BoolDecoder *decoder)
58
76.9M
{
59
76.9M
    int bits = 8 - decoder->count;
60
61
76.9M
    av_assert0(decoder->count <= 8);
62
76.9M
    if (decoder->count == 8) {
63
59.5M
      return true;
64
59.5M
    }
65
66
17.4M
    if (get_bits_left(decoder->gbc) >= bits) {
67
17.3M
        decoder->value |= get_bits(decoder->gbc, bits);
68
17.3M
        decoder->count += bits;
69
17.3M
    }
70
71
17.4M
    return (decoder->count == 8);
72
76.9M
}
73
74
static int cbs_vp8_bool_decoder_read_bool(CBSVP8BoolDecoder *decoder,
75
                                          const uint8_t prob, uint8_t *output)
76
76.9M
{
77
76.9M
    uint8_t split = 1 + (((decoder->range - 1) * prob) >> 8);
78
79
76.9M
    if (!cbs_vp8_bool_decoder_fill_value(decoder)) {
80
58.0k
        return AVERROR_INVALIDDATA;
81
58.0k
    }
82
83
76.9M
    av_assert0(decoder->count == 8);
84
76.9M
    if (decoder->value >= split) {
85
7.84M
        *output = 1;
86
7.84M
        decoder->range -= split;
87
7.84M
        decoder->value -= split;
88
69.0M
    } else {
89
69.0M
        *output = 0;
90
69.0M
        decoder->range = split;
91
69.0M
    }
92
93
95.9M
    while (decoder->range < 128) {
94
18.9M
        decoder->value <<= 1;
95
18.9M
        decoder->range <<= 1;
96
18.9M
        --decoder->count;
97
18.9M
    }
98
99
76.9M
    return 0;
100
76.9M
}
101
102
static int cbs_vp8_bool_decoder_read_literal(CBSVP8BoolDecoder *decoder,
103
                                             const uint8_t prob,
104
                                             uint32_t num_bits,
105
                                             uint32_t *output)
106
65.8M
{
107
65.8M
    int ret = 0;
108
109
65.8M
    av_assert0(num_bits <= 32);
110
111
65.8M
    *output = 0;
112
142M
    for (; num_bits > 0; --num_bits) {
113
76.7M
        uint8_t bit_output = 0;
114
76.7M
        if ((ret = cbs_vp8_bool_decoder_read_bool(decoder, prob,
115
76.7M
                                                  &bit_output)) != 0) {
116
56.8k
            return ret;
117
56.8k
        }
118
119
76.6M
        *output = (*output << 1) | bit_output;
120
76.6M
    }
121
122
65.7M
    return 0;
123
65.8M
}
124
125
static int cbs_vp8_bool_decoder_read_unsigned(
126
    CodedBitstreamContext *ctx, CBSVP8BoolDecoder *bool_decoder, int width,
127
    uint8_t prob, const char *name, const int *subscripts, uint32_t *write_to,
128
    bool trace_enable)
129
65.5M
{
130
65.5M
    int ret = 0;
131
65.5M
    GetBitContext *gbc = bool_decoder->gbc;
132
65.5M
    uint32_t value;
133
134
65.5M
    CBS_TRACE_READ_START();
135
136
65.5M
    av_assert0(width >= 0 && width <= 8);
137
138
65.5M
    ret = cbs_vp8_bool_decoder_read_literal(bool_decoder, prob, width, &value);
139
65.5M
    if (ret != 0) {
140
49.8k
        return ret;
141
49.8k
    }
142
143
65.4M
    if (trace_enable) {
144
2.49M
      CBS_TRACE_READ_END();
145
2.49M
    }
146
147
65.4M
    *write_to = value;
148
65.4M
    return 0;
149
65.4M
}
150
151
static int cbs_vp8_bool_decoder_read_signed(
152
    CodedBitstreamContext *ctx, CBSVP8BoolDecoder *bool_decoder, int width,
153
    uint8_t prob, const char *name, const int *subscripts, int32_t *write_to)
154
279k
{
155
279k
    int ret = 0;
156
279k
    GetBitContext *gbc = bool_decoder->gbc;
157
279k
    int32_t value;
158
279k
    uint8_t sign = 0;
159
160
279k
    CBS_TRACE_READ_START();
161
162
279k
    av_assert0(width >= 0 && width <= 8);
163
164
279k
    ret = cbs_vp8_bool_decoder_read_literal(bool_decoder, prob, width, &value);
165
279k
    if (ret != 0) {
166
6.91k
        return ret;
167
6.91k
    }
168
169
272k
    ret = cbs_vp8_bool_decoder_read_bool(bool_decoder, prob, &sign);
170
272k
    if (ret != 0) {
171
1.25k
        return ret;
172
1.25k
    }
173
174
271k
    if (sign) {
175
135k
        value = -value;
176
135k
    }
177
178
271k
    CBS_TRACE_READ_END();
179
180
271k
    *write_to = value;
181
271k
    return 0;
182
271k
}
183
184
static int cbs_vp8_read_unsigned_le(CodedBitstreamContext *ctx,
185
                                    GetBitContext *gbc, int width,
186
                                    const char *name, const int *subscripts,
187
                                    uint32_t *write_to, uint32_t range_min,
188
                                    uint32_t range_max)
189
1.18M
{
190
1.18M
    int32_t value;
191
192
1.18M
    CBS_TRACE_READ_START();
193
194
1.18M
    av_assert0(width > 0 && width <= 24);
195
196
1.18M
    if (get_bits_left(gbc) < width) {
197
19.7k
        av_log(ctx->log_ctx, AV_LOG_ERROR, "Invalid value: bitstream ended.\n");
198
19.7k
        return AVERROR_INVALIDDATA;
199
19.7k
    }
200
201
1.16M
    value = get_bits_le(gbc, width);
202
203
1.16M
    CBS_TRACE_READ_END();
204
205
1.16M
    if (value < range_min || value > range_max) {
206
147k
        av_log(ctx->log_ctx, AV_LOG_ERROR,
207
147k
               "%s out of range: "
208
147k
               "%" PRIu32 ", but must be in [%" PRIu32 ",%" PRIu32 "].\n",
209
147k
               name, value, range_min, range_max);
210
147k
        return AVERROR_INVALIDDATA;
211
147k
    }
212
213
1.01M
    *write_to = value;
214
1.01M
    return 0;
215
1.16M
}
216
217
#define HEADER(name) \
218
257k
    do { \
219
257k
        ff_cbs_trace_header(ctx, name); \
220
257k
    } while (0)
221
222
#define CHECK(call) \
223
67.6M
    do { \
224
133M
        int err = (call); \
225
67.6M
        if (err < 0) \
226
67.6M
            return err; \
227
67.6M
    } while (0)
228
229
#define FUNC_NAME(rw, codec, name) cbs_##codec##_##rw##_##name
230
#define FUNC_VP8(rw, name) FUNC_NAME(rw, vp8, name)
231
#define FUNC(name) FUNC_VP8(READWRITE, name)
232
233
#define SUBSCRIPTS(subs, ...) \
234
    (subs > 0 ? ((int[subs + 1]){subs, __VA_ARGS__}) : NULL)
235
236
1.03M
#define f(width, name) xf(width, name, 0, )
237
238
// bool [de|en]coder methods.
239
1.36M
#define bc_f(width, name) bc_unsigned_subs(width, DEFAULT_PROB, true, name, 0, )
240
149k
#define bc_s(width, name) bc_signed_subs(width, DEFAULT_PROB, name, 0, )
241
#define bc_fs(width, name, subs, ...) \
242
1.17M
    bc_unsigned_subs(width, DEFAULT_PROB, true, name, subs, __VA_ARGS__)
243
#define bc_ss(width, name, subs, ...) \
244
129k
    bc_signed_subs(width, DEFAULT_PROB, name, subs, __VA_ARGS__)
245
246
// bool [de|en]coder methods for boolean value and disable tracing.
247
2.28M
#define bc_b(name) bc_unsigned_subs(1, DEFAULT_PROB, false, name, 0, )
248
60.7M
#define bc_b_prob(prob, name) bc_unsigned_subs(1, prob, false, name, 0, )
249
250
#define READ
251
#define READWRITE read
252
#define RWContext GetBitContext
253
#define CBSVP8BoolCodingRW CBSVP8BoolDecoder
254
255
#define xf(width, name, subs, ...) \
256
1.03M
    do { \
257
1.03M
        uint32_t value; \
258
1.03M
        CHECK(cbs_vp8_read_unsigned_le(ctx, rw, width, #name, \
259
1.03M
                                       SUBSCRIPTS(subs, __VA_ARGS__), &value, \
260
1.03M
                                       0, MAX_UINT_BITS(width))); \
261
1.03M
        current->name = value; \
262
1.01M
    } while (0)
263
264
#define fixed(width, name, value) \
265
152k
    do { \
266
152k
        uint32_t fixed_value; \
267
152k
        CHECK(cbs_vp8_read_unsigned_le(ctx, rw, width, #name, 0, &fixed_value, \
268
152k
                                       value, value)); \
269
152k
    } while (0)
270
271
#define bc_unsigned_subs(width, prob, enable_trace, name, subs, ...) \
272
65.5M
    do { \
273
65.5M
        uint32_t value; \
274
65.5M
        CHECK(cbs_vp8_bool_decoder_read_unsigned( \
275
65.5M
            ctx, bool_coding_rw, width, prob, #name, \
276
65.5M
            SUBSCRIPTS(subs, __VA_ARGS__), &value, enable_trace)); \
277
65.5M
        current->name = value; \
278
65.4M
    } while (0)
279
280
#define bc_signed_subs(width, prob, name, subs, ...) \
281
279k
    do { \
282
279k
        int32_t value; \
283
279k
        CHECK(cbs_vp8_bool_decoder_read_signed( \
284
279k
            ctx, bool_coding_rw, width, prob, #name, \
285
279k
            SUBSCRIPTS(subs, __VA_ARGS__), &value)); \
286
279k
        current->name = value; \
287
271k
    } while (0)
288
289
#include "cbs_vp8_syntax_template.c"
290
291
static int cbs_vp8_split_fragment(CodedBitstreamContext *ctx,
292
                                  CodedBitstreamFragment *frag, int header)
293
258k
{
294
258k
    int err;
295
296
258k
    if (frag->data_size == 0)
297
1.16k
        return AVERROR_INVALIDDATA;
298
299
257k
    err = ff_cbs_append_unit_data(frag, 0, frag->data, frag->data_size,
300
257k
                                  frag->data_ref);
301
257k
    if (err < 0)
302
0
        return err;
303
304
257k
    return 0;
305
257k
}
306
307
static int cbs_vp8_read_unit(CodedBitstreamContext *ctx,
308
                             CodedBitstreamUnit *unit)
309
257k
{
310
257k
    VP8RawFrame *frame;
311
257k
    GetBitContext gbc;
312
257k
    CBSVP8BoolDecoder bool_decoder;
313
257k
    int err, pos;
314
315
257k
    err = ff_cbs_alloc_unit_content(ctx, unit);
316
257k
    if (err < 0)
317
0
        return err;
318
257k
    frame = unit->content;
319
320
    // Create GetBitContext for uncompressed header.
321
257k
    err = init_get_bits8_le(&gbc, unit->data, unit->data_size);
322
257k
    if (err < 0)
323
0
        return err;
324
325
257k
    err = cbs_vp8_read_uncompressed_header(ctx, &gbc, frame);
326
257k
    if (err < 0)
327
167k
        return err;
328
329
90.1k
    pos = get_bits_count(&gbc);
330
90.1k
    av_assert0(pos % 8 == 0);
331
332
    // Create boolean decoder for compressed header.
333
90.1k
    err = cbs_vp8_bool_decoder_init(&bool_decoder, &gbc);
334
90.1k
    if (err < 0)
335
0
        return err;
336
337
90.1k
    err = cbs_vp8_read_compressed_header(ctx, &bool_decoder, frame);
338
90.1k
    if (err < 0)
339
58.0k
        return err;
340
341
32.0k
    pos = get_bits_count(&gbc);
342
    // Position may not be byte-aligned after compressed header; Round up byte
343
    // count for accurate data positioning.
344
32.0k
    pos = (pos + 7) / 8;
345
32.0k
    av_assert0(pos <= unit->data_size);
346
347
32.0k
    frame->data_ref = av_buffer_ref(unit->data_ref);
348
32.0k
    if (!frame->data_ref)
349
0
        return AVERROR(ENOMEM);
350
351
32.0k
    frame->data = unit->data + pos;
352
32.0k
    frame->data_size = unit->data_size - pos;
353
354
32.0k
    return 0;
355
32.0k
}
356
357
static int cbs_vp8_write_unit(CodedBitstreamContext *ctx,
358
                              CodedBitstreamUnit *unit, PutBitContext *pbc)
359
0
{
360
0
    return AVERROR_PATCHWELCOME;
361
0
}
362
363
static int cbs_vp8_assemble_fragment(CodedBitstreamContext *ctx,
364
                                     CodedBitstreamFragment *frag)
365
0
{
366
0
    return AVERROR_PATCHWELCOME;
367
0
}
368
369
static const CodedBitstreamUnitTypeDescriptor cbs_vp8_unit_types[] = {
370
    CBS_UNIT_TYPE_INTERNAL_REF(0, VP8RawFrame, data),
371
    CBS_UNIT_TYPE_END_OF_LIST,
372
};
373
374
const CodedBitstreamType ff_cbs_type_vp8 = {
375
    .codec_id          = AV_CODEC_ID_VP8,
376
377
    .priv_data_size    = 0,
378
379
    .unit_types        = cbs_vp8_unit_types,
380
381
    .split_fragment    = &cbs_vp8_split_fragment,
382
    .read_unit         = &cbs_vp8_read_unit,
383
    .write_unit        = &cbs_vp8_write_unit,
384
385
    .assemble_fragment = &cbs_vp8_assemble_fragment,
386
};