Coverage Report

Created: 2026-02-14 06:59

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/ffmpeg/libavcodec/bsf/extract_extradata.c
Line
Count
Source
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 <stdint.h>
20
21
#include "libavutil/log.h"
22
#include "libavutil/mem.h"
23
#include "libavutil/opt.h"
24
25
#include "av1.h"
26
#include "av1_parse.h"
27
#include "bsf.h"
28
#include "bsf_internal.h"
29
#include "bytestream.h"
30
#include "h2645_parse.h"
31
#include "h264.h"
32
#include "startcode.h"
33
#include "vc1_common.h"
34
#include "vvc.h"
35
36
#include "hevc/hevc.h"
37
38
typedef struct ExtractExtradataContext {
39
    const AVClass *class;
40
41
    int (*extract)(AVBSFContext *ctx, AVPacket *pkt,
42
                   uint8_t **data, int *size);
43
44
    /* AV1 specific fields */
45
    AV1Packet av1_pkt;
46
47
    /* H264/HEVC specific fields */
48
    H2645Packet h2645_pkt;
49
50
    /* AVOptions */
51
    int remove;
52
} ExtractExtradataContext;
53
54
static int val_in_array(const int *arr, size_t len, int val)
55
7.49M
{
56
23.1M
    for (size_t i = 0; i < len; i++)
57
15.8M
        if (arr[i] == val)
58
234k
            return 1;
59
7.26M
    return 0;
60
7.49M
}
61
62
static int metadata_is_global(const AV1OBU *obu)
63
3.28k
{
64
3.28k
    static const int metadata_obu_types[] = {
65
3.28k
        AV1_METADATA_TYPE_HDR_CLL, AV1_METADATA_TYPE_HDR_MDCV,
66
3.28k
    };
67
3.28k
    GetBitContext gb;
68
3.28k
    int metadata_type;
69
70
3.28k
    if (init_get_bits(&gb, obu->data, obu->size_bits) < 0)
71
0
        return 0;
72
73
3.28k
    metadata_type = get_leb(&gb);
74
75
3.28k
    return val_in_array(metadata_obu_types, FF_ARRAY_ELEMS(metadata_obu_types),
76
3.28k
                        metadata_type);
77
3.28k
}
78
79
static int obu_is_global(const AV1OBU *obu)
80
3.08M
{
81
3.08M
    static const int extradata_obu_types[] = {
82
3.08M
        AV1_OBU_SEQUENCE_HEADER, AV1_OBU_METADATA,
83
3.08M
    };
84
85
3.08M
    if (!val_in_array(extradata_obu_types, FF_ARRAY_ELEMS(extradata_obu_types),
86
3.08M
                      obu->type))
87
3.07M
        return 0;
88
9.72k
    if (obu->type != AV1_OBU_METADATA)
89
6.44k
        return 1;
90
91
3.28k
    return metadata_is_global(obu);
92
9.72k
}
93
94
static int extract_extradata_av1(AVBSFContext *ctx, AVPacket *pkt,
95
                                 uint8_t **data, int *size)
96
9.29k
{
97
98
9.29k
    ExtractExtradataContext *s = ctx->priv_data;
99
100
9.29k
    int extradata_size = 0, filtered_size = 0;
101
9.29k
    int i, has_seq = 0, ret = 0;
102
103
9.29k
    ret = ff_av1_packet_split(&s->av1_pkt, pkt->data, pkt->size, ctx);
104
9.29k
    if (ret < 0)
105
2.31k
        return ret;
106
107
1.55M
    for (i = 0; i < s->av1_pkt.nb_obus; i++) {
108
1.54M
        AV1OBU *obu = &s->av1_pkt.obus[i];
109
1.54M
        if (obu_is_global(obu)) {
110
3.92k
            extradata_size += obu->raw_size;
111
3.92k
            if (obu->type == AV1_OBU_SEQUENCE_HEADER)
112
3.22k
                has_seq = 1;
113
1.54M
        } else if (s->remove) {
114
1.70k
            filtered_size += obu->raw_size;
115
1.70k
        }
116
1.54M
    }
117
118
6.97k
    if (extradata_size && has_seq) {
119
2.95k
        AVBufferRef *filtered_buf = NULL;
120
2.95k
        PutByteContext pb_filtered_data, pb_extradata;
121
2.95k
        uint8_t *extradata;
122
123
2.95k
        if (s->remove) {
124
587
            filtered_buf = av_buffer_alloc(filtered_size + AV_INPUT_BUFFER_PADDING_SIZE);
125
587
            if (!filtered_buf) {
126
0
                return AVERROR(ENOMEM);
127
0
            }
128
587
            memset(filtered_buf->data + filtered_size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
129
587
        }
130
131
2.95k
        extradata = av_malloc(extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
132
2.95k
        if (!extradata) {
133
0
            av_buffer_unref(&filtered_buf);
134
0
            return AVERROR(ENOMEM);
135
0
        }
136
137
2.95k
        *data = extradata;
138
2.95k
        *size = extradata_size;
139
140
2.95k
        bytestream2_init_writer(&pb_extradata, extradata, extradata_size);
141
2.95k
        if (s->remove)
142
587
            bytestream2_init_writer(&pb_filtered_data, filtered_buf->data, filtered_size);
143
144
1.53M
        for (i = 0; i < s->av1_pkt.nb_obus; i++) {
145
1.53M
            AV1OBU *obu = &s->av1_pkt.obus[i];
146
1.53M
            if (obu_is_global(obu)) {
147
3.48k
                bytestream2_put_bufferu(&pb_extradata, obu->raw_data, obu->raw_size);
148
1.53M
            } else if (s->remove) {
149
1.24k
                bytestream2_put_bufferu(&pb_filtered_data, obu->raw_data, obu->raw_size);
150
1.24k
            }
151
1.53M
        }
152
153
2.95k
        if (s->remove) {
154
587
            av_buffer_unref(&pkt->buf);
155
587
            pkt->buf  = filtered_buf;
156
587
            pkt->data = filtered_buf->data;
157
587
            pkt->size = filtered_size;
158
587
        }
159
2.95k
    }
160
161
6.97k
    return 0;
162
6.97k
}
163
164
static int extract_extradata_h2645(AVBSFContext *ctx, AVPacket *pkt,
165
                                   uint8_t **data, int *size)
166
29.4k
{
167
29.4k
    static const int extradata_nal_types_vvc[] = {
168
29.4k
        VVC_VPS_NUT, VVC_SPS_NUT, VVC_PPS_NUT,
169
29.4k
    };
170
29.4k
    static const int extradata_nal_types_hevc[] = {
171
29.4k
        HEVC_NAL_VPS, HEVC_NAL_SPS, HEVC_NAL_PPS,
172
29.4k
    };
173
29.4k
    static const int extradata_nal_types_h264[] = {
174
29.4k
        H264_NAL_SPS, H264_NAL_PPS,
175
29.4k
    };
176
177
29.4k
    ExtractExtradataContext *s = ctx->priv_data;
178
179
29.4k
    int extradata_size = 0, filtered_size = 0;
180
29.4k
    const int *extradata_nal_types;
181
29.4k
    size_t nb_extradata_nal_types;
182
29.4k
    int i, has_sps = 0, has_vps = 0, ret = 0;
183
184
29.4k
    if (ctx->par_in->codec_id == AV_CODEC_ID_VVC) {
185
6.35k
        extradata_nal_types    = extradata_nal_types_vvc;
186
6.35k
        nb_extradata_nal_types = FF_ARRAY_ELEMS(extradata_nal_types_vvc);
187
23.0k
    } else if (ctx->par_in->codec_id == AV_CODEC_ID_HEVC) {
188
12.2k
        extradata_nal_types    = extradata_nal_types_hevc;
189
12.2k
        nb_extradata_nal_types = FF_ARRAY_ELEMS(extradata_nal_types_hevc);
190
12.2k
    } else {
191
10.8k
        extradata_nal_types    = extradata_nal_types_h264;
192
10.8k
        nb_extradata_nal_types = FF_ARRAY_ELEMS(extradata_nal_types_h264);
193
10.8k
    }
194
195
29.4k
    ret = ff_h2645_packet_split(&s->h2645_pkt, pkt->data, pkt->size,
196
29.4k
                                ctx, 0, ctx->par_in->codec_id, H2645_FLAG_SMALL_PADDING);
197
29.4k
    if (ret < 0)
198
1.24k
        return ret;
199
200
2.92M
    for (i = 0; i < s->h2645_pkt.nb_nals; i++) {
201
2.89M
        H2645NAL *nal = &s->h2645_pkt.nals[i];
202
2.89M
        if (val_in_array(extradata_nal_types, nb_extradata_nal_types, nal->type)) {
203
116k
            extradata_size += nal->raw_size + 3;
204
116k
            if (ctx->par_in->codec_id == AV_CODEC_ID_VVC) {
205
7.64k
                if (nal->type == VVC_SPS_NUT) has_sps = 1;
206
7.64k
                if (nal->type == VVC_VPS_NUT) has_vps = 1;
207
109k
            } else if (ctx->par_in->codec_id == AV_CODEC_ID_HEVC) {
208
45.2k
                if (nal->type == HEVC_NAL_SPS) has_sps = 1;
209
45.2k
                if (nal->type == HEVC_NAL_VPS) has_vps = 1;
210
64.1k
            } else {
211
64.1k
                if (nal->type == H264_NAL_SPS) has_sps = 1;
212
64.1k
            }
213
2.77M
        } else if (s->remove) {
214
240k
            filtered_size += nal->raw_size + 3;
215
240k
        }
216
2.89M
    }
217
218
28.1k
    if (extradata_size &&
219
14.0k
        ((ctx->par_in->codec_id == AV_CODEC_ID_VVC  && has_sps) ||
220
12.4k
         (ctx->par_in->codec_id == AV_CODEC_ID_HEVC && has_sps && has_vps) ||
221
8.54k
         (ctx->par_in->codec_id == AV_CODEC_ID_H264 && has_sps))) {
222
8.40k
        AVBufferRef *filtered_buf = NULL;
223
8.40k
        PutByteContext pb_filtered_data, pb_extradata;
224
8.40k
        uint8_t *extradata;
225
226
8.40k
        if (s->remove) {
227
335
            filtered_buf = av_buffer_alloc(filtered_size + AV_INPUT_BUFFER_PADDING_SIZE);
228
335
            if (!filtered_buf) {
229
0
                return AVERROR(ENOMEM);
230
0
            }
231
335
            memset(filtered_buf->data + filtered_size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
232
335
        }
233
234
8.40k
        extradata = av_malloc(extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
235
8.40k
        if (!extradata) {
236
0
            av_buffer_unref(&filtered_buf);
237
0
            return AVERROR(ENOMEM);
238
0
        }
239
240
8.40k
        *data = extradata;
241
8.40k
        *size = extradata_size;
242
243
8.40k
        bytestream2_init_writer(&pb_extradata, extradata, extradata_size);
244
8.40k
        if (s->remove)
245
335
            bytestream2_init_writer(&pb_filtered_data, filtered_buf->data, filtered_size);
246
247
1.52M
        for (i = 0; i < s->h2645_pkt.nb_nals; i++) {
248
1.51M
            H2645NAL *nal = &s->h2645_pkt.nals[i];
249
1.51M
            if (val_in_array(extradata_nal_types, nb_extradata_nal_types,
250
1.51M
                             nal->type)) {
251
106k
                bytestream2_put_be24u(&pb_extradata, 1); //startcode
252
106k
                bytestream2_put_bufferu(&pb_extradata, nal->raw_data, nal->raw_size);
253
1.40M
            } else if (s->remove) {
254
237k
                bytestream2_put_be24u(&pb_filtered_data, 1); // startcode
255
237k
                bytestream2_put_bufferu(&pb_filtered_data, nal->raw_data, nal->raw_size);
256
237k
            }
257
1.51M
        }
258
259
8.40k
        if (s->remove) {
260
335
            av_buffer_unref(&pkt->buf);
261
335
            pkt->buf  = filtered_buf;
262
335
            pkt->data = filtered_buf->data;
263
335
            pkt->size = filtered_size;
264
335
        }
265
8.40k
    }
266
267
28.1k
    return 0;
268
28.1k
}
269
270
static int extract_extradata_vc1(AVBSFContext *ctx, AVPacket *pkt,
271
                                 uint8_t **data, int *size)
272
3.34k
{
273
3.34k
    ExtractExtradataContext *s = ctx->priv_data;
274
3.34k
    const uint8_t *ptr = pkt->data, *end = pkt->data + pkt->size;
275
3.34k
    uint32_t state = UINT32_MAX;
276
3.34k
    int has_extradata = 0, extradata_size = 0;
277
278
39.0k
    while (ptr < end) {
279
37.0k
        ptr = avpriv_find_start_code(ptr, end, &state);
280
37.0k
        if (state == VC1_CODE_SEQHDR || state == VC1_CODE_ENTRYPOINT) {
281
3.60k
            has_extradata = 1;
282
33.4k
        } else if (has_extradata && IS_MARKER(state)) {
283
1.37k
            extradata_size = ptr - 4 - pkt->data;
284
1.37k
            break;
285
1.37k
        }
286
37.0k
    }
287
288
3.34k
    if (extradata_size) {
289
1.37k
        *data = av_malloc(extradata_size + AV_INPUT_BUFFER_PADDING_SIZE);
290
1.37k
        if (!*data)
291
0
            return AVERROR(ENOMEM);
292
293
1.37k
        memcpy(*data, pkt->data, extradata_size);
294
1.37k
        *size = extradata_size;
295
296
1.37k
        if (s->remove) {
297
243
            pkt->data += extradata_size;
298
243
            pkt->size -= extradata_size;
299
243
        }
300
1.37k
    }
301
302
3.34k
    return 0;
303
3.34k
}
304
305
static int extract_extradata_mpeg12(AVBSFContext *ctx, AVPacket *pkt,
306
                                     uint8_t **data, int *size)
307
6.61k
{
308
6.61k
    ExtractExtradataContext *s = ctx->priv_data;
309
6.61k
    uint32_t state = UINT32_MAX;
310
6.61k
    int i, found = 0;
311
312
9.12M
    for (i = 0; i < pkt->size; i++) {
313
9.11M
        state = (state << 8) | pkt->data[i];
314
9.11M
        if (state == 0x1B3)
315
1.56k
            found = 1;
316
9.11M
        else if (found && state != 0x1B5 && state < 0x200 && state >= 0x100) {
317
1.08k
            *size = i - 3;
318
1.08k
            *data = av_malloc(*size + AV_INPUT_BUFFER_PADDING_SIZE);
319
1.08k
            if (!*data)
320
0
                return AVERROR(ENOMEM);
321
322
1.08k
            memcpy(*data, pkt->data, *size);
323
324
1.08k
            if (s->remove) {
325
223
                pkt->data += *size;
326
223
                pkt->size -= *size;
327
223
            }
328
1.08k
            break;
329
1.08k
        }
330
9.11M
    }
331
6.61k
    return 0;
332
6.61k
}
333
334
static int extract_extradata_mpeg4(AVBSFContext *ctx, AVPacket *pkt,
335
                                   uint8_t **data, int *size)
336
12.5k
{
337
12.5k
    ExtractExtradataContext *s = ctx->priv_data;
338
12.5k
    const uint8_t *ptr = pkt->data, *end = pkt->data + pkt->size;
339
12.5k
    uint32_t state = UINT32_MAX;
340
341
89.8k
    while (ptr < end) {
342
81.0k
        ptr = avpriv_find_start_code(ptr, end, &state);
343
81.0k
        if (state == 0x1B3 || state == 0x1B6) {
344
3.80k
            if (ptr - pkt->data > 4) {
345
3.15k
                *size = ptr - 4 - pkt->data;
346
3.15k
                *data = av_malloc(*size + AV_INPUT_BUFFER_PADDING_SIZE);
347
3.15k
                if (!*data)
348
0
                    return AVERROR(ENOMEM);
349
350
3.15k
                memcpy(*data, pkt->data, *size);
351
352
3.15k
                if (s->remove) {
353
218
                    pkt->data += *size;
354
218
                    pkt->size -= *size;
355
218
                }
356
3.15k
            }
357
3.80k
            break;
358
3.80k
        }
359
81.0k
    }
360
12.5k
    return 0;
361
12.5k
}
362
363
static const struct {
364
    enum AVCodecID id;
365
    int (*extract)(AVBSFContext *ctx, AVPacket *pkt,
366
                   uint8_t **data, int *size);
367
} extract_tab[] = {
368
    { AV_CODEC_ID_AV1,        extract_extradata_av1     },
369
    { AV_CODEC_ID_AVS2,       extract_extradata_mpeg4   },
370
    { AV_CODEC_ID_AVS3,       extract_extradata_mpeg4   },
371
    { AV_CODEC_ID_CAVS,       extract_extradata_mpeg4   },
372
    { AV_CODEC_ID_H264,       extract_extradata_h2645   },
373
    { AV_CODEC_ID_HEVC,       extract_extradata_h2645   },
374
    { AV_CODEC_ID_MPEG1VIDEO, extract_extradata_mpeg12  },
375
    { AV_CODEC_ID_MPEG2VIDEO, extract_extradata_mpeg12  },
376
    { AV_CODEC_ID_MPEG4,      extract_extradata_mpeg4   },
377
    { AV_CODEC_ID_VC1,        extract_extradata_vc1     },
378
    { AV_CODEC_ID_VVC,        extract_extradata_h2645   },
379
};
380
381
static int extract_extradata_init(AVBSFContext *ctx)
382
17.5k
{
383
17.5k
    ExtractExtradataContext *s = ctx->priv_data;
384
17.5k
    int i;
385
386
120k
    for (i = 0; i < FF_ARRAY_ELEMS(extract_tab); i++) {
387
120k
        if (extract_tab[i].id == ctx->par_in->codec_id) {
388
17.5k
            s->extract = extract_tab[i].extract;
389
17.5k
            break;
390
17.5k
        }
391
120k
    }
392
17.5k
    if (!s->extract)
393
0
        return AVERROR_BUG;
394
395
17.5k
    return 0;
396
17.5k
}
397
398
static int extract_extradata_filter(AVBSFContext *ctx, AVPacket *pkt)
399
107k
{
400
107k
    ExtractExtradataContext *s = ctx->priv_data;
401
107k
    uint8_t *extradata = NULL;
402
107k
    int extradata_size;
403
107k
    int ret = 0;
404
405
107k
    ret = ff_bsf_get_packet_ref(ctx, pkt);
406
107k
    if (ret < 0)
407
45.8k
        return ret;
408
409
61.2k
    ret = s->extract(ctx, pkt, &extradata, &extradata_size);
410
61.2k
    if (ret < 0)
411
3.55k
        goto fail;
412
413
57.6k
    if (extradata) {
414
16.9k
        memset(extradata + extradata_size, 0, AV_INPUT_BUFFER_PADDING_SIZE);
415
16.9k
        ret = av_packet_add_side_data(pkt, AV_PKT_DATA_NEW_EXTRADATA,
416
16.9k
                                      extradata, extradata_size);
417
16.9k
        if (ret < 0) {
418
0
            av_freep(&extradata);
419
0
            goto fail;
420
0
        }
421
16.9k
    }
422
423
57.6k
    return 0;
424
425
3.55k
fail:
426
3.55k
    av_packet_unref(pkt);
427
3.55k
    return ret;
428
57.6k
}
429
430
static void extract_extradata_close(AVBSFContext *ctx)
431
17.5k
{
432
17.5k
    ExtractExtradataContext *s = ctx->priv_data;
433
17.5k
    ff_av1_packet_uninit(&s->av1_pkt);
434
17.5k
    ff_h2645_packet_uninit(&s->h2645_pkt);
435
17.5k
}
436
437
static const enum AVCodecID codec_ids[] = {
438
    AV_CODEC_ID_AV1,
439
    AV_CODEC_ID_AVS2,
440
    AV_CODEC_ID_AVS3,
441
    AV_CODEC_ID_CAVS,
442
    AV_CODEC_ID_H264,
443
    AV_CODEC_ID_HEVC,
444
    AV_CODEC_ID_MPEG1VIDEO,
445
    AV_CODEC_ID_MPEG2VIDEO,
446
    AV_CODEC_ID_MPEG4,
447
    AV_CODEC_ID_VC1,
448
    AV_CODEC_ID_VVC,
449
    AV_CODEC_ID_NONE,
450
};
451
452
#define OFFSET(x) offsetof(ExtractExtradataContext, x)
453
#define FLAGS (AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_BSF_PARAM)
454
static const AVOption options[] = {
455
    { "remove", "remove the extradata from the bitstream", OFFSET(remove), AV_OPT_TYPE_INT,
456
        { .i64 = 0 }, 0, 1, FLAGS },
457
    { NULL },
458
};
459
460
static const AVClass extract_extradata_class = {
461
    .class_name = "extract_extradata",
462
    .item_name  = av_default_item_name,
463
    .option     = options,
464
    .version    = LIBAVUTIL_VERSION_INT,
465
};
466
467
const FFBitStreamFilter ff_extract_extradata_bsf = {
468
    .p.name         = "extract_extradata",
469
    .p.codec_ids    = codec_ids,
470
    .p.priv_class   = &extract_extradata_class,
471
    .priv_data_size = sizeof(ExtractExtradataContext),
472
    .init           = extract_extradata_init,
473
    .filter         = extract_extradata_filter,
474
    .close          = extract_extradata_close,
475
};