FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavcodec/osq.c
Date: 2024-10-27 21:33:06
Exec Total Coverage
Lines: 180 283 63.6%
Functions: 8 12 66.7%
Branches: 83 148 56.1%

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