FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavcodec/osq.c
Date: 2024-07-17 14:05:47
Exec Total Coverage
Lines: 180 278 64.7%
Functions: 8 12 66.7%
Branches: 83 144 57.6%

Line Branch Exec Source
1 /*
2 * OSQ audio decoder
3 * Copyright (c) 2023 Paul B Mahol
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/internal.h"
23 #include "libavutil/intreadwrite.h"
24 #include "libavutil/mem.h"
25 #include "avcodec.h"
26 #include "codec_internal.h"
27 #include "decode.h"
28 #include "internal.h"
29 #define BITSTREAM_READER_LE
30 #include "get_bits.h"
31 #include "unary.h"
32
33 #define OFFSET 5
34
35 typedef struct OSQChannel {
36 unsigned prediction;
37 unsigned coding_mode;
38 unsigned residue_parameter;
39 unsigned residue_bits;
40 unsigned history[3];
41 unsigned pos, count;
42 double sum;
43 int32_t prev;
44 } OSQChannel;
45
46 typedef struct OSQContext {
47 GetBitContext gb;
48 OSQChannel ch[2];
49
50 uint8_t *bitstream;
51 size_t max_framesize;
52 size_t bitstream_size;
53
54 int factor;
55 int decorrelate;
56 int frame_samples;
57 uint64_t nb_samples;
58
59 int32_t *decode_buffer[2];
60
61 AVPacket *pkt;
62 int pkt_offset;
63 } OSQContext;
64
65 static void osq_flush(AVCodecContext *avctx)
66 {
67 OSQContext *s = avctx->priv_data;
68
69 s->bitstream_size = 0;
70 s->pkt_offset = 0;
71 }
72
73 2 static av_cold int osq_close(AVCodecContext *avctx)
74 {
75 2 OSQContext *s = avctx->priv_data;
76
77 2 av_freep(&s->bitstream);
78 2 s->bitstream_size = 0;
79
80
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 2 times.
6 for (int ch = 0; ch < FF_ARRAY_ELEMS(s->decode_buffer); ch++)
81 4 av_freep(&s->decode_buffer[ch]);
82
83 2 return 0;
84 }
85
86 2 static av_cold int osq_init(AVCodecContext *avctx)
87 {
88 2 OSQContext *s = avctx->priv_data;
89
90
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
2 if (avctx->extradata_size < 48)
91 return AVERROR(EINVAL);
92
93
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
2 if (avctx->extradata[0] != 1) {
94 av_log(avctx, AV_LOG_ERROR, "Unsupported version.\n");
95 return AVERROR_INVALIDDATA;
96 }
97
98 2 avctx->sample_rate = AV_RL32(avctx->extradata + 4);
99
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
2 if (avctx->sample_rate < 1)
100 return AVERROR_INVALIDDATA;
101
102 2 av_channel_layout_uninit(&avctx->ch_layout);
103 2 avctx->ch_layout.order = AV_CHANNEL_ORDER_UNSPEC;
104 2 avctx->ch_layout.nb_channels = avctx->extradata[3];
105
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
2 if (avctx->ch_layout.nb_channels < 1)
106 return AVERROR_INVALIDDATA;
107
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
2 if (avctx->ch_layout.nb_channels > FF_ARRAY_ELEMS(s->decode_buffer))
108 return AVERROR_INVALIDDATA;
109
110 2 s->factor = 1;
111
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
2 switch (avctx->extradata[2]) {
112 case 8: avctx->sample_fmt = AV_SAMPLE_FMT_U8P; break;
113 2 case 16: avctx->sample_fmt = AV_SAMPLE_FMT_S16P; break;
114 case 20:
115 case 24: s->factor = 256;
116 avctx->sample_fmt = AV_SAMPLE_FMT_S32P; break;
117 default: return AVERROR_INVALIDDATA;
118 }
119
120 2 avctx->bits_per_raw_sample = avctx->extradata[2];
121 2 s->nb_samples = AV_RL64(avctx->extradata + 16);
122 2 s->frame_samples = AV_RL16(avctx->extradata + 8);
123 2 s->max_framesize = (s->frame_samples * 16 + 1024) * avctx->ch_layout.nb_channels;
124
125 2 s->bitstream = av_calloc(s->max_framesize + AV_INPUT_BUFFER_PADDING_SIZE, sizeof(*s->bitstream));
126
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2 times.
2 if (!s->bitstream)
127 return AVERROR(ENOMEM);
128
129
2/2
✓ Branch 0 taken 4 times.
✓ Branch 1 taken 2 times.
6 for (int ch = 0; ch < avctx->ch_layout.nb_channels; ch++) {
130 4 s->decode_buffer[ch] = av_calloc(s->frame_samples + OFFSET,
131 sizeof(*s->decode_buffer[ch]));
132
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 4 times.
4 if (!s->decode_buffer[ch])
133 return AVERROR(ENOMEM);
134 }
135
136 2 s->pkt = avctx->internal->in_pkt;
137
138 2 return 0;
139 }
140
141 static void reset_stats(OSQChannel *cb)
142 {
143 memset(cb->history, 0, sizeof(cb->history));
144 cb->pos = cb->count = cb->sum = 0;
145 }
146
147 static void update_stats(OSQChannel *cb, int val)
148 {
149 cb->sum += FFABS(val) - cb->history[cb->pos];
150 cb->history[cb->pos] = FFABS(val);
151 cb->pos++;
152 cb->count++;
153 if (cb->pos >= FF_ARRAY_ELEMS(cb->history))
154 cb->pos = 0;
155 }
156
157 static int update_residue_parameter(OSQChannel *cb)
158 {
159 double sum, x;
160 int rice_k;
161
162 sum = cb->sum;
163 x = sum / cb->count;
164 rice_k = av_ceil_log2(x);
165 if (rice_k >= 30) {
166 rice_k = floor(sum / 1.4426952 + 0.5);
167 if (rice_k < 1)
168 rice_k = 1;
169 }
170
171 return rice_k;
172 }
173
174 847722 static uint32_t get_urice(GetBitContext *gb, int k)
175 {
176 uint32_t z, x, b;
177
178 847722 x = get_unary(gb, 1, 512);
179 847722 b = get_bits_long(gb, k);
180 847722 z = b | x << k;
181
182 847722 return z;
183 }
184
185 837900 static int32_t get_srice(GetBitContext *gb, int x)
186 {
187 837900 int32_t y = get_urice(gb, x);
188
2/2
✓ Branch 1 taken 416860 times.
✓ Branch 2 taken 421040 times.
837900 return get_bits1(gb) ? -y : y;
189 }
190
191 3274 static int osq_channel_parameters(AVCodecContext *avctx, int ch)
192 {
193 3274 OSQContext *s = avctx->priv_data;
194 3274 OSQChannel *cb = &s->ch[ch];
195 3274 GetBitContext *gb = &s->gb;
196
197 3274 cb->prev = 0;
198 3274 cb->prediction = get_urice(gb, 5);
199 3274 cb->coding_mode = get_urice(gb, 3);
200
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3274 times.
3274 if (cb->prediction >= 15)
201 return AVERROR_INVALIDDATA;
202
2/4
✓ Branch 0 taken 3274 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 3274 times.
✗ Branch 3 not taken.
3274 if (cb->coding_mode > 0 && cb->coding_mode < 3) {
203 3274 cb->residue_parameter = get_urice(gb, 4);
204
2/4
✓ Branch 0 taken 3274 times.
✗ Branch 1 not taken.
✗ Branch 2 not taken.
✓ Branch 3 taken 3274 times.
3274 if (!cb->residue_parameter || cb->residue_parameter >= 31)
205 return AVERROR_INVALIDDATA;
206 } else if (cb->coding_mode == 3) {
207 cb->residue_bits = get_urice(gb, 4);
208 if (!cb->residue_bits || cb->residue_bits >= 31)
209 return AVERROR_INVALIDDATA;
210 } else if (cb->coding_mode) {
211 return AVERROR_INVALIDDATA;
212 }
213
214
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3274 times.
3274 if (cb->coding_mode == 2)
215 reset_stats(cb);
216
217 3274 return 0;
218 }
219
220 #define A (-1)
221 #define B (-2)
222 #define C (-3)
223 #define D (-4)
224 #define E (-5)
225 #define P2 (((unsigned)dst[A] + dst[A]) - dst[B])
226 #define P3 (((unsigned)dst[A] - dst[B]) * 3 + dst[C])
227
228 1637 static int do_decode(AVCodecContext *avctx, AVFrame *frame, int decorrelate, int downsample)
229 {
230 1637 OSQContext *s = avctx->priv_data;
231 1637 const int nb_channels = avctx->ch_layout.nb_channels;
232 1637 const int nb_samples = frame->nb_samples;
233 1637 GetBitContext *gb = &s->gb;
234
235
2/2
✓ Branch 0 taken 418950 times.
✓ Branch 1 taken 1637 times.
420587 for (int n = 0; n < nb_samples; n++) {
236
2/2
✓ Branch 0 taken 837900 times.
✓ Branch 1 taken 418950 times.
1256850 for (int ch = 0; ch < nb_channels; ch++) {
237 837900 OSQChannel *cb = &s->ch[ch];
238 837900 int32_t *dst = s->decode_buffer[ch] + OFFSET;
239 837900 int32_t p, prev = cb->prev;
240
241
5/6
✓ Branch 0 taken 837900 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 418950 times.
✓ Branch 3 taken 418950 times.
✓ Branch 4 taken 99 times.
✓ Branch 5 taken 418851 times.
837900 if (nb_channels == 2 && ch == 1 && decorrelate != s->decorrelate) {
242
2/2
✓ Branch 0 taken 49 times.
✓ Branch 1 taken 50 times.
99 if (!decorrelate) {
243 49 s->decode_buffer[1][OFFSET+A] += s->decode_buffer[0][OFFSET+B];
244 49 s->decode_buffer[1][OFFSET+B] += s->decode_buffer[0][OFFSET+C];
245 49 s->decode_buffer[1][OFFSET+C] += s->decode_buffer[0][OFFSET+D];
246 49 s->decode_buffer[1][OFFSET+D] += s->decode_buffer[0][OFFSET+E];
247 } else {
248 50 s->decode_buffer[1][OFFSET+A] -= s->decode_buffer[0][OFFSET+B];
249 50 s->decode_buffer[1][OFFSET+B] -= s->decode_buffer[0][OFFSET+C];
250 50 s->decode_buffer[1][OFFSET+C] -= s->decode_buffer[0][OFFSET+D];
251 50 s->decode_buffer[1][OFFSET+D] -= s->decode_buffer[0][OFFSET+E];
252 }
253 99 s->decorrelate = decorrelate;
254 }
255
256
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 837900 times.
837900 if (!cb->coding_mode) {
257 dst[n] = 0;
258
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 837900 times.
837900 } else if (cb->coding_mode == 3) {
259 dst[n] = get_sbits_long(gb, cb->residue_bits);
260 } else {
261 837900 dst[n] = get_srice(gb, cb->residue_parameter);
262 }
263
264
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 837900 times.
837900 if (get_bits_left(gb) < 0) {
265 av_log(avctx, AV_LOG_ERROR, "overread!\n");
266 return AVERROR_INVALIDDATA;
267 }
268
269 837900 p = prev / 2;
270 837900 prev = dst[n];
271
272
12/16
✓ Branch 0 taken 13056 times.
✓ Branch 1 taken 49920 times.
✓ Branch 2 taken 159232 times.
✓ Branch 3 taken 35462 times.
✓ Branch 4 taken 29184 times.
✗ Branch 5 not taken.
✗ Branch 6 not taken.
✓ Branch 7 taken 14592 times.
✓ Branch 8 taken 23296 times.
✓ Branch 9 taken 29440 times.
✓ Branch 10 taken 11264 times.
✓ Branch 11 taken 38656 times.
✗ Branch 12 not taken.
✓ Branch 13 taken 13568 times.
✓ Branch 14 taken 420230 times.
✗ Branch 15 not taken.
837900 switch (cb->prediction) {
273 13056 case 0:
274 13056 break;
275 49920 case 1:
276 49920 dst[n] += (unsigned)dst[A];
277 49920 break;
278 159232 case 2:
279 159232 dst[n] += (unsigned)dst[A] + p;
280 159232 break;
281 35462 case 3:
282 35462 dst[n] += P2;
283 35462 break;
284 29184 case 4:
285 29184 dst[n] += P2 + p;
286 29184 break;
287 case 5:
288 dst[n] += P3;
289 break;
290 case 6:
291 dst[n] += P3 + p;
292 break;
293 14592 case 7:
294 14592 dst[n] += (int)(P2 + P3) / 2 + (unsigned)p;
295 14592 break;
296 23296 case 8:
297 23296 dst[n] += (int)(P2 + P3) / 2;
298 23296 break;
299 29440 case 9:
300 29440 dst[n] += (int)(P2 * 2 + P3) / 3 + (unsigned)p;
301 29440 break;
302 11264 case 10:
303 11264 dst[n] += (int)(P2 + P3 * 2) / 3 + (unsigned)p;
304 11264 break;
305 38656 case 11:
306 38656 dst[n] += (int)((unsigned)dst[A] + dst[B]) / 2;
307 38656 break;
308 case 12:
309 dst[n] += (unsigned)dst[B];
310 break;
311 13568 case 13:
312 13568 dst[n] += (int)(unsigned)(dst[D] + dst[B]) / 2;
313 13568 break;
314 420230 case 14:
315 420230 dst[n] += (int)((unsigned)P2 + dst[A]) / 2 + (unsigned)p;
316 420230 break;
317 default:
318 return AVERROR_INVALIDDATA;
319 }
320
321 837900 cb->prev = prev;
322
323
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 837900 times.
837900 if (downsample)
324 dst[n] *= 256U;
325
326 837900 dst[E] = dst[D];
327 837900 dst[D] = dst[C];
328 837900 dst[C] = dst[B];
329 837900 dst[B] = dst[A];
330 837900 dst[A] = dst[n];
331
332
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 837900 times.
837900 if (cb->coding_mode == 2) {
333 update_stats(cb, dst[n]);
334 cb->residue_parameter = update_residue_parameter(cb);
335 }
336
337
3/4
✓ Branch 0 taken 837900 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 418950 times.
✓ Branch 3 taken 418950 times.
837900 if (nb_channels == 2 && ch == 1) {
338
2/2
✓ Branch 0 taken 390022 times.
✓ Branch 1 taken 28928 times.
418950 if (decorrelate)
339 390022 dst[n] += s->decode_buffer[0][OFFSET+n];
340 }
341
342
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 837900 times.
837900 if (downsample)
343 dst[A] /= 256;
344 }
345 }
346
347 1637 return 0;
348 }
349
350 1637 static int osq_decode_block(AVCodecContext *avctx, AVFrame *frame)
351 {
352 1637 const int nb_channels = avctx->ch_layout.nb_channels;
353 1637 const int nb_samples = frame->nb_samples;
354 1637 OSQContext *s = avctx->priv_data;
355 1637 const int factor = s->factor;
356 int ret, decorrelate, downsample;
357 1637 GetBitContext *gb = &s->gb;
358
359 1637 skip_bits1(gb);
360 1637 decorrelate = get_bits1(gb);
361 1637 downsample = get_bits1(gb);
362
363
2/2
✓ Branch 0 taken 3274 times.
✓ Branch 1 taken 1637 times.
4911 for (int ch = 0; ch < nb_channels; ch++) {
364
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 3274 times.
3274 if ((ret = osq_channel_parameters(avctx, ch)) < 0) {
365 av_log(avctx, AV_LOG_ERROR, "invalid channel parameters\n");
366 return ret;
367 }
368 }
369
370
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1637 times.
1637 if ((ret = do_decode(avctx, frame, decorrelate, downsample)) < 0)
371 return ret;
372
373 1637 align_get_bits(gb);
374
375
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 1637 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
1637 switch (avctx->sample_fmt) {
376 case AV_SAMPLE_FMT_U8P:
377 for (int ch = 0; ch < nb_channels; ch++) {
378 uint8_t *dst = (uint8_t *)frame->extended_data[ch];
379 int32_t *src = s->decode_buffer[ch] + OFFSET;
380
381 for (int n = 0; n < nb_samples; n++)
382 dst[n] = av_clip_uint8(src[n] + 0x80);
383 }
384 break;
385 1637 case AV_SAMPLE_FMT_S16P:
386
2/2
✓ Branch 0 taken 3274 times.
✓ Branch 1 taken 1637 times.
4911 for (int ch = 0; ch < nb_channels; ch++) {
387 3274 int16_t *dst = (int16_t *)frame->extended_data[ch];
388 3274 int32_t *src = s->decode_buffer[ch] + OFFSET;
389
390
2/2
✓ Branch 0 taken 837900 times.
✓ Branch 1 taken 3274 times.
841174 for (int n = 0; n < nb_samples; n++)
391 837900 dst[n] = (int16_t)src[n];
392 }
393 1637 break;
394 case AV_SAMPLE_FMT_S32P:
395 for (int ch = 0; ch < nb_channels; ch++) {
396 int32_t *dst = (int32_t *)frame->extended_data[ch];
397 int32_t *src = s->decode_buffer[ch] + OFFSET;
398
399 for (int n = 0; n < nb_samples; n++)
400 dst[n] = src[n] * factor;
401 }
402 break;
403 default:
404 return AVERROR_BUG;
405 }
406
407 1637 return 0;
408 }
409
410 2674 static int osq_receive_frame(AVCodecContext *avctx, AVFrame *frame)
411 {
412 2674 OSQContext *s = avctx->priv_data;
413 2674 GetBitContext *gb = &s->gb;
414 int ret, n;
415
416
2/2
✓ Branch 0 taken 3698 times.
✓ Branch 1 taken 1620 times.
7992 while (s->bitstream_size < s->max_framesize) {
417 int size;
418
419
2/2
✓ Branch 0 taken 2080 times.
✓ Branch 1 taken 1618 times.
3698 if (!s->pkt->data) {
420 2080 ret = ff_decode_get_packet(avctx, s->pkt);
421
4/4
✓ Branch 0 taken 18 times.
✓ Branch 1 taken 2062 times.
✓ Branch 2 taken 17 times.
✓ Branch 3 taken 1 times.
2080 if (ret == AVERROR_EOF && s->bitstream_size > 0)
422 17 break;
423
4/4
✓ Branch 0 taken 2062 times.
✓ Branch 1 taken 1 times.
✓ Branch 2 taken 1036 times.
✓ Branch 3 taken 1026 times.
2063 if (ret == AVERROR_EOF || ret == AVERROR(EAGAIN))
424 1037 return ret;
425
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1026 times.
1026 if (ret < 0)
426 goto fail;
427 }
428
429 2644 size = FFMIN(s->pkt->size - s->pkt_offset, s->max_framesize - s->bitstream_size);
430 2644 memcpy(s->bitstream + s->bitstream_size, s->pkt->data + s->pkt_offset, size);
431 2644 s->bitstream_size += size;
432 2644 s->pkt_offset += size;
433
434
2/2
✓ Branch 0 taken 1618 times.
✓ Branch 1 taken 1026 times.
2644 if (s->pkt_offset == s->pkt->size) {
435 1026 av_packet_unref(s->pkt);
436 1026 s->pkt_offset = 0;
437 }
438 }
439
440 1637 frame->nb_samples = FFMIN(s->frame_samples, s->nb_samples);
441
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1637 times.
1637 if (frame->nb_samples <= 0)
442 return AVERROR_EOF;
443
444
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1637 times.
1637 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
445 goto fail;
446
447
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1637 times.
1637 if ((ret = init_get_bits8(gb, s->bitstream, s->bitstream_size)) < 0)
448 goto fail;
449
450
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1637 times.
1637 if ((ret = osq_decode_block(avctx, frame)) < 0)
451 goto fail;
452
453 1637 s->nb_samples -= frame->nb_samples;
454
455 1637 n = get_bits_count(gb) / 8;
456
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1637 times.
1637 if (n > s->bitstream_size) {
457 ret = AVERROR_INVALIDDATA;
458 goto fail;
459 }
460
461 1637 memmove(s->bitstream, &s->bitstream[n], s->bitstream_size - n);
462 1637 s->bitstream_size -= n;
463
464 1637 return 0;
465
466 fail:
467 s->bitstream_size = 0;
468 s->pkt_offset = 0;
469 av_packet_unref(s->pkt);
470
471 return ret;
472 }
473
474 const FFCodec ff_osq_decoder = {
475 .p.name = "osq",
476 CODEC_LONG_NAME("OSQ (Original Sound Quality)"),
477 .p.type = AVMEDIA_TYPE_AUDIO,
478 .p.id = AV_CODEC_ID_OSQ,
479 .priv_data_size = sizeof(OSQContext),
480 .init = osq_init,
481 FF_CODEC_RECEIVE_FRAME_CB(osq_receive_frame),
482 .close = osq_close,
483 .p.capabilities = AV_CODEC_CAP_CHANNEL_CONF |
484 AV_CODEC_CAP_DR1,
485 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
486 .p.sample_fmts = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_U8P,
487 AV_SAMPLE_FMT_S16P,
488 AV_SAMPLE_FMT_S32P,
489 AV_SAMPLE_FMT_NONE },
490 .flush = osq_flush,
491 };
492