FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavcodec/osq.c
Date: 2024-07-26 21:54:09
Exec Total Coverage
Lines: 180 281 64.1%
Functions: 8 12 66.7%
Branches: 83 146 56.8%

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 = ceil(log2(x));
165 if (rice_k >= 30) {
166 double f = floor(sum / 1.4426952 + 0.5);
167 if (f <= 1) {
168 rice_k = 1;
169 } else if (f >= 31) {
170 rice_k = 31;
171 } else
172 rice_k = f;
173 }
174
175 return rice_k;
176 }
177
178 847722 static uint32_t get_urice(GetBitContext *gb, int k)
179 {
180 uint32_t z, x, b;
181
182 847722 x = get_unary(gb, 1, 512);
183 847722 b = get_bits_long(gb, k);
184 847722 z = b | x << k;
185
186 847722 return z;
187 }
188
189 837900 static int32_t get_srice(GetBitContext *gb, int x)
190 {
191 837900 int32_t y = get_urice(gb, x);
192
2/2
✓ Branch 1 taken 416860 times.
✓ Branch 2 taken 421040 times.
837900 return get_bits1(gb) ? -y : y;
193 }
194
195 3274 static int osq_channel_parameters(AVCodecContext *avctx, int ch)
196 {
197 3274 OSQContext *s = avctx->priv_data;
198 3274 OSQChannel *cb = &s->ch[ch];
199 3274 GetBitContext *gb = &s->gb;
200
201 3274 cb->prev = 0;
202 3274 cb->prediction = get_urice(gb, 5);
203 3274 cb->coding_mode = get_urice(gb, 3);
204
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3274 times.
3274 if (cb->prediction >= 15)
205 return AVERROR_INVALIDDATA;
206
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) {
207 3274 cb->residue_parameter = get_urice(gb, 4);
208
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)
209 return AVERROR_INVALIDDATA;
210 } else if (cb->coding_mode == 3) {
211 cb->residue_bits = get_urice(gb, 4);
212 if (!cb->residue_bits || cb->residue_bits >= 31)
213 return AVERROR_INVALIDDATA;
214 } else if (cb->coding_mode) {
215 return AVERROR_INVALIDDATA;
216 }
217
218
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 3274 times.
3274 if (cb->coding_mode == 2)
219 reset_stats(cb);
220
221 3274 return 0;
222 }
223
224 #define A (-1)
225 #define B (-2)
226 #define C (-3)
227 #define D (-4)
228 #define E (-5)
229 #define P2 (((unsigned)dst[A] + dst[A]) - dst[B])
230 #define P3 (((unsigned)dst[A] - dst[B]) * 3 + dst[C])
231
232 1637 static int do_decode(AVCodecContext *avctx, AVFrame *frame, int decorrelate, int downsample)
233 {
234 1637 OSQContext *s = avctx->priv_data;
235 1637 const int nb_channels = avctx->ch_layout.nb_channels;
236 1637 const int nb_samples = frame->nb_samples;
237 1637 GetBitContext *gb = &s->gb;
238
239
2/2
✓ Branch 0 taken 418950 times.
✓ Branch 1 taken 1637 times.
420587 for (int n = 0; n < nb_samples; n++) {
240
2/2
✓ Branch 0 taken 837900 times.
✓ Branch 1 taken 418950 times.
1256850 for (int ch = 0; ch < nb_channels; ch++) {
241 837900 OSQChannel *cb = &s->ch[ch];
242 837900 int32_t *dst = s->decode_buffer[ch] + OFFSET;
243 837900 int32_t p, prev = cb->prev;
244
245
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) {
246
2/2
✓ Branch 0 taken 49 times.
✓ Branch 1 taken 50 times.
99 if (!decorrelate) {
247 49 s->decode_buffer[1][OFFSET+A] += s->decode_buffer[0][OFFSET+B];
248 49 s->decode_buffer[1][OFFSET+B] += s->decode_buffer[0][OFFSET+C];
249 49 s->decode_buffer[1][OFFSET+C] += s->decode_buffer[0][OFFSET+D];
250 49 s->decode_buffer[1][OFFSET+D] += s->decode_buffer[0][OFFSET+E];
251 } else {
252 50 s->decode_buffer[1][OFFSET+A] -= s->decode_buffer[0][OFFSET+B];
253 50 s->decode_buffer[1][OFFSET+B] -= s->decode_buffer[0][OFFSET+C];
254 50 s->decode_buffer[1][OFFSET+C] -= s->decode_buffer[0][OFFSET+D];
255 50 s->decode_buffer[1][OFFSET+D] -= s->decode_buffer[0][OFFSET+E];
256 }
257 99 s->decorrelate = decorrelate;
258 }
259
260
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 837900 times.
837900 if (!cb->coding_mode) {
261 dst[n] = 0;
262
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 837900 times.
837900 } else if (cb->coding_mode == 3) {
263 dst[n] = get_sbits_long(gb, cb->residue_bits);
264 } else {
265 837900 dst[n] = get_srice(gb, cb->residue_parameter);
266 }
267
268
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 837900 times.
837900 if (get_bits_left(gb) < 0) {
269 av_log(avctx, AV_LOG_ERROR, "overread!\n");
270 return AVERROR_INVALIDDATA;
271 }
272
273 837900 p = prev / 2;
274 837900 prev = dst[n];
275
276
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) {
277 13056 case 0:
278 13056 break;
279 49920 case 1:
280 49920 dst[n] += (unsigned)dst[A];
281 49920 break;
282 159232 case 2:
283 159232 dst[n] += (unsigned)dst[A] + p;
284 159232 break;
285 35462 case 3:
286 35462 dst[n] += P2;
287 35462 break;
288 29184 case 4:
289 29184 dst[n] += P2 + p;
290 29184 break;
291 case 5:
292 dst[n] += P3;
293 break;
294 case 6:
295 dst[n] += P3 + p;
296 break;
297 14592 case 7:
298 14592 dst[n] += (int)(P2 + P3) / 2 + (unsigned)p;
299 14592 break;
300 23296 case 8:
301 23296 dst[n] += (int)(P2 + P3) / 2;
302 23296 break;
303 29440 case 9:
304 29440 dst[n] += (int)(P2 * 2 + P3) / 3 + (unsigned)p;
305 29440 break;
306 11264 case 10:
307 11264 dst[n] += (int)(P2 + P3 * 2) / 3 + (unsigned)p;
308 11264 break;
309 38656 case 11:
310 38656 dst[n] += (int)((unsigned)dst[A] + dst[B]) / 2;
311 38656 break;
312 case 12:
313 dst[n] += (unsigned)dst[B];
314 break;
315 13568 case 13:
316 13568 dst[n] += (int)(unsigned)(dst[D] + dst[B]) / 2;
317 13568 break;
318 420230 case 14:
319 420230 dst[n] += (int)((unsigned)P2 + dst[A]) / 2 + (unsigned)p;
320 420230 break;
321 default:
322 return AVERROR_INVALIDDATA;
323 }
324
325 837900 cb->prev = prev;
326
327
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 837900 times.
837900 if (downsample)
328 dst[n] *= 256U;
329
330 837900 dst[E] = dst[D];
331 837900 dst[D] = dst[C];
332 837900 dst[C] = dst[B];
333 837900 dst[B] = dst[A];
334 837900 dst[A] = dst[n];
335
336
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 837900 times.
837900 if (cb->coding_mode == 2) {
337 update_stats(cb, dst[n]);
338 cb->residue_parameter = update_residue_parameter(cb);
339 }
340
341
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) {
342
2/2
✓ Branch 0 taken 390022 times.
✓ Branch 1 taken 28928 times.
418950 if (decorrelate)
343 390022 dst[n] += s->decode_buffer[0][OFFSET+n];
344 }
345
346
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 837900 times.
837900 if (downsample)
347 dst[A] /= 256;
348 }
349 }
350
351 1637 return 0;
352 }
353
354 1637 static int osq_decode_block(AVCodecContext *avctx, AVFrame *frame)
355 {
356 1637 const int nb_channels = avctx->ch_layout.nb_channels;
357 1637 const int nb_samples = frame->nb_samples;
358 1637 OSQContext *s = avctx->priv_data;
359 1637 const unsigned factor = s->factor;
360 int ret, decorrelate, downsample;
361 1637 GetBitContext *gb = &s->gb;
362
363 1637 skip_bits1(gb);
364 1637 decorrelate = get_bits1(gb);
365 1637 downsample = get_bits1(gb);
366
367
2/2
✓ Branch 0 taken 3274 times.
✓ Branch 1 taken 1637 times.
4911 for (int ch = 0; ch < nb_channels; ch++) {
368
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 3274 times.
3274 if ((ret = osq_channel_parameters(avctx, ch)) < 0) {
369 av_log(avctx, AV_LOG_ERROR, "invalid channel parameters\n");
370 return ret;
371 }
372 }
373
374
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1637 times.
1637 if ((ret = do_decode(avctx, frame, decorrelate, downsample)) < 0)
375 return ret;
376
377 1637 align_get_bits(gb);
378
379
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 1637 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
1637 switch (avctx->sample_fmt) {
380 case AV_SAMPLE_FMT_U8P:
381 for (int ch = 0; ch < nb_channels; ch++) {
382 uint8_t *dst = (uint8_t *)frame->extended_data[ch];
383 int32_t *src = s->decode_buffer[ch] + OFFSET;
384
385 for (int n = 0; n < nb_samples; n++)
386 dst[n] = av_clip_uint8(src[n] + 0x80);
387 }
388 break;
389 1637 case AV_SAMPLE_FMT_S16P:
390
2/2
✓ Branch 0 taken 3274 times.
✓ Branch 1 taken 1637 times.
4911 for (int ch = 0; ch < nb_channels; ch++) {
391 3274 int16_t *dst = (int16_t *)frame->extended_data[ch];
392 3274 int32_t *src = s->decode_buffer[ch] + OFFSET;
393
394
2/2
✓ Branch 0 taken 837900 times.
✓ Branch 1 taken 3274 times.
841174 for (int n = 0; n < nb_samples; n++)
395 837900 dst[n] = (int16_t)src[n];
396 }
397 1637 break;
398 case AV_SAMPLE_FMT_S32P:
399 for (int ch = 0; ch < nb_channels; ch++) {
400 int32_t *dst = (int32_t *)frame->extended_data[ch];
401 int32_t *src = s->decode_buffer[ch] + OFFSET;
402
403 for (int n = 0; n < nb_samples; n++)
404 dst[n] = src[n] * factor;
405 }
406 break;
407 default:
408 return AVERROR_BUG;
409 }
410
411 1637 return 0;
412 }
413
414 2674 static int osq_receive_frame(AVCodecContext *avctx, AVFrame *frame)
415 {
416 2674 OSQContext *s = avctx->priv_data;
417 2674 GetBitContext *gb = &s->gb;
418 int ret, n;
419
420
2/2
✓ Branch 0 taken 3698 times.
✓ Branch 1 taken 1620 times.
7992 while (s->bitstream_size < s->max_framesize) {
421 int size;
422
423
2/2
✓ Branch 0 taken 2080 times.
✓ Branch 1 taken 1618 times.
3698 if (!s->pkt->data) {
424 2080 ret = ff_decode_get_packet(avctx, s->pkt);
425
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)
426 17 break;
427
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))
428 1037 return ret;
429
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1026 times.
1026 if (ret < 0)
430 goto fail;
431 }
432
433 2644 size = FFMIN(s->pkt->size - s->pkt_offset, s->max_framesize - s->bitstream_size);
434 2644 memcpy(s->bitstream + s->bitstream_size, s->pkt->data + s->pkt_offset, size);
435 2644 s->bitstream_size += size;
436 2644 s->pkt_offset += size;
437
438
2/2
✓ Branch 0 taken 1618 times.
✓ Branch 1 taken 1026 times.
2644 if (s->pkt_offset == s->pkt->size) {
439 1026 av_packet_unref(s->pkt);
440 1026 s->pkt_offset = 0;
441 }
442 }
443
444 1637 frame->nb_samples = FFMIN(s->frame_samples, s->nb_samples);
445
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1637 times.
1637 if (frame->nb_samples <= 0)
446 return AVERROR_EOF;
447
448
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1637 times.
1637 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
449 goto fail;
450
451
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1637 times.
1637 if ((ret = init_get_bits8(gb, s->bitstream, s->bitstream_size)) < 0)
452 goto fail;
453
454
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 1637 times.
1637 if ((ret = osq_decode_block(avctx, frame)) < 0)
455 goto fail;
456
457 1637 s->nb_samples -= frame->nb_samples;
458
459 1637 n = get_bits_count(gb) / 8;
460
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 1637 times.
1637 if (n > s->bitstream_size) {
461 ret = AVERROR_INVALIDDATA;
462 goto fail;
463 }
464
465 1637 memmove(s->bitstream, &s->bitstream[n], s->bitstream_size - n);
466 1637 s->bitstream_size -= n;
467
468 1637 return 0;
469
470 fail:
471 s->bitstream_size = 0;
472 s->pkt_offset = 0;
473 av_packet_unref(s->pkt);
474
475 return ret;
476 }
477
478 const FFCodec ff_osq_decoder = {
479 .p.name = "osq",
480 CODEC_LONG_NAME("OSQ (Original Sound Quality)"),
481 .p.type = AVMEDIA_TYPE_AUDIO,
482 .p.id = AV_CODEC_ID_OSQ,
483 .priv_data_size = sizeof(OSQContext),
484 .init = osq_init,
485 FF_CODEC_RECEIVE_FRAME_CB(osq_receive_frame),
486 .close = osq_close,
487 .p.capabilities = AV_CODEC_CAP_CHANNEL_CONF |
488 AV_CODEC_CAP_DR1,
489 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
490 .p.sample_fmts = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_U8P,
491 AV_SAMPLE_FMT_S16P,
492 AV_SAMPLE_FMT_S32P,
493 AV_SAMPLE_FMT_NONE },
494 .flush = osq_flush,
495 };
496