Coverage Report

Created: 2025-08-28 07:12

/src/ffmpeg/libavcodec/dstdec.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Direct Stream Transfer (DST) decoder
3
 * Copyright (c) 2014 Peter Ross <pross@xvid.org>
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
/**
23
 * @file
24
 * Direct Stream Transfer (DST) decoder
25
 * ISO/IEC 14496-3 Part 3 Subpart 10: Technical description of lossless coding of oversampled audio
26
 */
27
28
#include "libavutil/intreadwrite.h"
29
#include "libavutil/mem_internal.h"
30
#include "libavutil/reverse.h"
31
#include "codec_internal.h"
32
#include "decode.h"
33
#include "get_bits.h"
34
#include "avcodec.h"
35
#include "golomb.h"
36
#include "dsd.h"
37
38
13.9k
#define DST_MAX_CHANNELS 6
39
5.98k
#define DST_MAX_ELEMENTS (2 * DST_MAX_CHANNELS)
40
41
116k
#define DSD_FS44(sample_rate) (sample_rate * 8LL / 44100)
42
43
116k
#define DST_SAMPLES_PER_FRAME(sample_rate) (588 * DSD_FS44(sample_rate))
44
45
static const int8_t fsets_code_pred_coeff[3][3] = {
46
    {  -8 },
47
    { -16,  8 },
48
    {  -9, -5, 6 },
49
};
50
51
static const int8_t probs_code_pred_coeff[3][3] = {
52
    {  -8 },
53
    { -16,  8 },
54
    { -24, 24, -8 },
55
};
56
57
typedef struct ArithCoder {
58
    unsigned int a;
59
    unsigned int c;
60
} ArithCoder;
61
62
typedef struct Table {
63
    unsigned int elements;
64
    unsigned int length[DST_MAX_ELEMENTS];
65
    int coeff[DST_MAX_ELEMENTS][128];
66
} Table;
67
68
typedef struct DSTContext {
69
    AVClass *class;
70
71
    GetBitContext gb;
72
    ArithCoder ac;
73
    Table fsets, probs;
74
    DECLARE_ALIGNED(16, uint8_t, status)[DST_MAX_CHANNELS][16];
75
    DECLARE_ALIGNED(16, int16_t, filter)[DST_MAX_ELEMENTS][16][256];
76
    DSDContext dsdctx[DST_MAX_CHANNELS];
77
} DSTContext;
78
79
static av_cold int decode_init(AVCodecContext *avctx)
80
994
{
81
994
    DSTContext *s = avctx->priv_data;
82
994
    int i;
83
84
994
    if (avctx->ch_layout.nb_channels > DST_MAX_CHANNELS) {
85
49
        avpriv_request_sample(avctx, "Channel count %d", avctx->ch_layout.nb_channels);
86
49
        return AVERROR_PATCHWELCOME;
87
49
    }
88
89
    // the sample rate is only allowed to be 64,128,256 * 44100 by ISO/IEC 14496-3:2005(E)
90
    // We are a bit more tolerant here, but this check is needed to bound the size and duration
91
945
    if (avctx->sample_rate > 512 * 44100)
92
13
        return AVERROR_INVALIDDATA;
93
94
95
932
    if (DST_SAMPLES_PER_FRAME(avctx->sample_rate) & 7) {
96
14
        return AVERROR_PATCHWELCOME;
97
14
    }
98
99
918
    avctx->sample_fmt = AV_SAMPLE_FMT_FLT;
100
101
2.94k
    for (i = 0; i < avctx->ch_layout.nb_channels; i++)
102
2.02k
        memset(s->dsdctx[i].buf, 0x69, sizeof(s->dsdctx[i].buf));
103
104
918
    ff_init_dsd_data();
105
106
918
    return 0;
107
932
}
108
109
static int read_map(GetBitContext *gb, Table *t, unsigned int map[DST_MAX_CHANNELS], int channels)
110
12.2k
{
111
12.2k
    int ch;
112
12.2k
    t->elements = 1;
113
12.2k
    map[0] = 0;
114
12.2k
    if (!get_bits1(gb)) {
115
22.2k
        for (ch = 1; ch < channels; ch++) {
116
17.4k
            int bits = av_log2(t->elements) + 1;
117
17.4k
            map[ch] = get_bits(gb, bits);
118
17.4k
            if (map[ch] == t->elements) {
119
5.98k
                t->elements++;
120
5.98k
                if (t->elements >= DST_MAX_ELEMENTS)
121
0
                    return AVERROR_INVALIDDATA;
122
11.4k
            } else if (map[ch] > t->elements) {
123
492
                return AVERROR_INVALIDDATA;
124
492
            }
125
17.4k
        }
126
6.95k
    } else {
127
6.95k
        memset(map, 0, sizeof(*map) * DST_MAX_CHANNELS);
128
6.95k
    }
129
11.7k
    return 0;
130
12.2k
}
131
132
static av_always_inline int get_sr_golomb_dst(GetBitContext *gb, unsigned int k)
133
310k
{
134
310k
    int v = get_ur_golomb_jpegls(gb, k, get_bits_left(gb), 0);
135
310k
    if (v && get_bits1(gb))
136
33.4k
        v = -v;
137
310k
    return v;
138
310k
}
139
140
static void read_uncoded_coeff(GetBitContext *gb, int *dst, unsigned int elements,
141
                               int coeff_bits, int is_signed, int offset)
142
23.1k
{
143
23.1k
    int i;
144
145
175k
    for (i = 0; i < elements; i++) {
146
152k
        dst[i] = (is_signed ? get_sbits(gb, coeff_bits) : get_bits(gb, coeff_bits)) + offset;
147
152k
    }
148
23.1k
}
149
150
static int read_table(GetBitContext *gb, Table *t, const int8_t code_pred_coeff[3][3],
151
                      int length_bits, int coeff_bits, int is_signed, int offset)
152
18.2k
{
153
18.2k
    unsigned int i, j, k;
154
40.3k
    for (i = 0; i < t->elements; i++) {
155
23.6k
        t->length[i] = get_bits(gb, length_bits) + 1;
156
23.6k
        if (!get_bits1(gb)) {
157
14.6k
            read_uncoded_coeff(gb, t->coeff[i], t->length[i], coeff_bits, is_signed, offset);
158
14.6k
        } else {
159
9.01k
            int method = get_bits(gb, 2), lsb_size;
160
9.01k
            if (method == 3)
161
583
                return AVERROR_INVALIDDATA;
162
163
8.43k
            read_uncoded_coeff(gb, t->coeff[i], method + 1, coeff_bits, is_signed, offset);
164
165
8.43k
            lsb_size  = get_bits(gb, 3);
166
318k
            for (j = method + 1; j < t->length[i]; j++) {
167
310k
                int c, x = 0;
168
840k
                for (k = 0; k < method + 1; k++)
169
530k
                    x += code_pred_coeff[method][k] * (unsigned)t->coeff[i][j - k - 1];
170
310k
                c = get_sr_golomb_dst(gb, lsb_size);
171
310k
                if (x >= 0)
172
190k
                    c -= (x + 4) / 8;
173
120k
                else
174
120k
                    c += (-x + 3) / 8;
175
310k
                if (!is_signed) {
176
4.54k
                    if (c < offset || c >= offset + (1<<coeff_bits))
177
1.00k
                        return AVERROR_INVALIDDATA;
178
4.54k
                }
179
309k
                t->coeff[i][j] = c;
180
309k
            }
181
8.43k
        }
182
23.6k
    }
183
16.6k
    return 0;
184
18.2k
}
185
186
static void ac_init(ArithCoder *ac, GetBitContext *gb)
187
7.40k
{
188
7.40k
    ac->a = 4095;
189
7.40k
    ac->c = get_bits(gb, 12);
190
7.40k
}
191
192
static av_always_inline void ac_get(ArithCoder *ac, GetBitContext *gb, int p, int *e)
193
72.4M
{
194
72.4M
    unsigned int k = (ac->a >> 8) | ((ac->a >> 7) & 1);
195
72.4M
    unsigned int q = k * p;
196
72.4M
    unsigned int a_q = ac->a - q;
197
198
72.4M
    *e = ac->c < a_q;
199
72.4M
    if (*e) {
200
68.9M
        ac->a  = a_q;
201
68.9M
    } else {
202
3.48M
        ac->a  = q;
203
3.48M
        ac->c -= a_q;
204
3.48M
    }
205
206
72.4M
    if (ac->a < 2048) {
207
7.72M
        int n = 11 - av_log2(ac->a);
208
7.72M
        ac->a <<= n;
209
7.72M
        ac->c = (ac->c << n) | get_bits(gb, n);
210
7.72M
    }
211
72.4M
}
212
213
static uint8_t prob_dst_x_bit(int c)
214
6.48k
{
215
6.48k
    return (ff_reverse[c & 127] >> 1) + 1;
216
6.48k
}
217
218
static int build_filter(int16_t table[DST_MAX_ELEMENTS][16][256], const Table *fsets)
219
7.40k
{
220
7.40k
    int i, j, k, l;
221
222
16.2k
    for (i = 0; i < fsets->elements; i++) {
223
9.78k
        int length = fsets->length[i];
224
225
155k
        for (j = 0; j < 16; j++) {
226
146k
            int total = av_clip(length - j * 8, 0, 8);
227
228
37.3M
            for (k = 0; k < 256; k++) {
229
37.1M
                int64_t v = 0;
230
231
123M
                for (l = 0; l < total; l++)
232
86.7M
                    v += (((k >> l) & 1) * 2 - 1) * fsets->coeff[i][j * 8 + l];
233
37.1M
                if ((int16_t)v != v)
234
923
                    return AVERROR_INVALIDDATA;
235
37.1M
                table[i][j][k] = v;
236
37.1M
            }
237
146k
        }
238
9.78k
    }
239
6.48k
    return 0;
240
7.40k
}
241
242
static int decode_frame(AVCodecContext *avctx, AVFrame *frame,
243
                        int *got_frame_ptr, AVPacket *avpkt)
244
115k
{
245
115k
    unsigned samples_per_frame = DST_SAMPLES_PER_FRAME(avctx->sample_rate);
246
115k
    unsigned map_ch_to_felem[DST_MAX_CHANNELS];
247
115k
    unsigned map_ch_to_pelem[DST_MAX_CHANNELS];
248
115k
    unsigned i, ch, same_map, dst_x_bit;
249
115k
    unsigned half_prob[DST_MAX_CHANNELS];
250
115k
    const int channels = avctx->ch_layout.nb_channels;
251
115k
    DSTContext *s = avctx->priv_data;
252
115k
    GetBitContext *gb = &s->gb;
253
115k
    ArithCoder *ac = &s->ac;
254
115k
    uint8_t *dsd;
255
115k
    float *pcm;
256
115k
    int ret;
257
258
115k
    if (avpkt->size <= 1)
259
86.7k
        return AVERROR_INVALIDDATA;
260
261
29.0k
    frame->nb_samples = samples_per_frame / 8;
262
29.0k
    if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
263
11.0k
        return ret;
264
17.9k
    dsd = frame->data[0];
265
17.9k
    pcm = (float *)frame->data[0];
266
267
17.9k
    if ((ret = init_get_bits8(gb, avpkt->data, avpkt->size)) < 0)
268
0
        return ret;
269
270
17.9k
    if (!get_bits1(gb)) {
271
6.77k
        skip_bits1(gb);
272
6.77k
        if (get_bits(gb, 6))
273
5.80k
            return AVERROR_INVALIDDATA;
274
965
        memcpy(frame->data[0], avpkt->data + 1, FFMIN(avpkt->size - 1, frame->nb_samples * channels));
275
965
        goto dsd;
276
6.77k
    }
277
278
    /* Segmentation (10.4, 10.5, 10.6) */
279
280
11.2k
    if (!get_bits1(gb)) {
281
629
        avpriv_request_sample(avctx, "Not Same Segmentation");
282
629
        return AVERROR_PATCHWELCOME;
283
629
    }
284
285
10.5k
    if (!get_bits1(gb)) {
286
267
        avpriv_request_sample(avctx, "Not Same Segmentation For All Channels");
287
267
        return AVERROR_PATCHWELCOME;
288
267
    }
289
290
10.3k
    if (!get_bits1(gb)) {
291
485
        avpriv_request_sample(avctx, "Not End Of Channel Segmentation");
292
485
        return AVERROR_PATCHWELCOME;
293
485
    }
294
295
    /* Mapping (10.7, 10.8, 10.9) */
296
297
9.84k
    same_map = get_bits1(gb);
298
299
9.84k
    if ((ret = read_map(gb, &s->fsets, map_ch_to_felem, channels)) < 0)
300
232
        return ret;
301
302
9.61k
    if (same_map) {
303
7.18k
        s->probs.elements = s->fsets.elements;
304
7.18k
        memcpy(map_ch_to_pelem, map_ch_to_felem, sizeof(map_ch_to_felem));
305
7.18k
    } else {
306
2.42k
        avpriv_request_sample(avctx, "Not Same Mapping");
307
2.42k
        if ((ret = read_map(gb, &s->probs, map_ch_to_pelem, channels)) < 0)
308
260
            return ret;
309
2.42k
    }
310
311
    /* Half Probability (10.10) */
312
313
36.6k
    for (ch = 0; ch < channels; ch++)
314
27.3k
        half_prob[ch] = get_bits1(gb);
315
316
    /* Filter Coef Sets (10.12) */
317
318
9.35k
    ret = read_table(gb, &s->fsets, fsets_code_pred_coeff, 7, 9, 1, 0);
319
9.35k
    if (ret < 0)
320
458
        return ret;
321
322
    /* Probability Tables (10.13) */
323
324
8.89k
    ret = read_table(gb, &s->probs, probs_code_pred_coeff, 6, 7, 0, 1);
325
8.89k
    if (ret < 0)
326
1.12k
        return ret;
327
328
    /* Arithmetic Coded Data (10.11) */
329
330
7.76k
    if (get_bits1(gb))
331
362
        return AVERROR_INVALIDDATA;
332
7.40k
    ac_init(ac, gb);
333
334
7.40k
    ret = build_filter(s->filter, &s->fsets);
335
7.40k
    if (ret < 0)
336
923
        return ret;
337
338
6.48k
    memset(s->status, 0xAA, sizeof(s->status));
339
6.48k
    memset(dsd, 0, frame->nb_samples * 4 * channels);
340
341
6.48k
    ac_get(ac, gb, prob_dst_x_bit(s->fsets.coeff[0][0]), &dst_x_bit);
342
343
31.9M
    for (i = 0; i < samples_per_frame; i++) {
344
104M
        for (ch = 0; ch < channels; ch++) {
345
72.4M
            const unsigned felem = map_ch_to_felem[ch];
346
72.4M
            int16_t (*filter)[256] = s->filter[felem];
347
72.4M
            uint8_t *status = s->status[ch];
348
72.4M
            int prob, residual, v;
349
350
1.15G
#define F(x) filter[(x)][status[(x)]]
351
72.4M
            const int16_t predict = F( 0) + F( 1) + F( 2) + F( 3) +
352
72.4M
                                    F( 4) + F( 5) + F( 6) + F( 7) +
353
72.4M
                                    F( 8) + F( 9) + F(10) + F(11) +
354
72.4M
                                    F(12) + F(13) + F(14) + F(15);
355
72.4M
#undef F
356
357
72.4M
            if (!half_prob[ch] || i >= s->fsets.length[felem]) {
358
72.0M
                unsigned pelem = map_ch_to_pelem[ch];
359
72.0M
                unsigned index = FFABS(predict) >> 3;
360
72.0M
                prob = s->probs.coeff[pelem][FFMIN(index, s->probs.length[pelem] - 1)];
361
72.0M
            } else {
362
446k
                prob = 128;
363
446k
            }
364
365
72.4M
            ac_get(ac, gb, prob, &residual);
366
72.4M
            v = ((predict >> 15) ^ residual) & 1;
367
72.4M
            dsd[((i >> 3) * channels + ch) << 2] |= v << (7 - (i & 0x7 ));
368
369
72.4M
            AV_WL64A(status + 8, (AV_RL64A(status + 8) << 1) | ((AV_RL64A(status) >> 63) & 1));
370
72.4M
            AV_WL64A(status, (AV_RL64A(status) << 1) | v);
371
72.4M
        }
372
31.9M
    }
373
374
7.44k
dsd:
375
29.3k
    for (i = 0; i < channels; i++) {
376
21.9k
        ff_dsd2pcm_translate(&s->dsdctx[i], frame->nb_samples, 0,
377
21.9k
                             frame->data[0] + i * 4,
378
21.9k
                             channels * 4, pcm + i, channels);
379
21.9k
    }
380
381
7.44k
    *got_frame_ptr = 1;
382
383
7.44k
    return avpkt->size;
384
6.48k
}
385
386
const FFCodec ff_dst_decoder = {
387
    .p.name         = "dst",
388
    CODEC_LONG_NAME("DST (Digital Stream Transfer)"),
389
    .p.type         = AVMEDIA_TYPE_AUDIO,
390
    .p.id           = AV_CODEC_ID_DST,
391
    .priv_data_size = sizeof(DSTContext),
392
    .init           = decode_init,
393
    FF_CODEC_DECODE_CB(decode_frame),
394
    .p.capabilities = AV_CODEC_CAP_DR1,
395
    CODEC_SAMPLEFMTS(AV_SAMPLE_FMT_FLT),
396
};