FFmpeg
misc4.c
Go to the documentation of this file.
1 /*
2  * Micronas SC-4 audio decoder
3  * Copyright (c) 2022 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 "avcodec.h"
25 #include "codec_internal.h"
26 #include "decode.h"
27 #include "bytestream.h"
28 #include "mathops.h"
29 
30 static const int16_t steps[16] = {
31  4084, 18, 41, 64, 112, 198, 355, 1122,
32  1122, 355, 198, 112, 64, 41, 18, 4084,
33 };
34 
35 static const int16_t diffs[16] = {
36  2048, 4, 135, 213, 273, 323, 373, 425,
37  425, 373, 323, 273, 213, 135, 4, 2048,
38 };
39 
40 typedef struct ChannelContext {
41  unsigned last_step;
47 
48 typedef struct MISC4Context {
50 
51  uint32_t marker;
52 
54 } MISC4Context;
55 
56 static av_cold int misc4_init(AVCodecContext *avctx)
57 {
58  MISC4Context *s = avctx->priv_data;
59 
60  if (avctx->sample_rate <= 0)
61  return AVERROR_INVALIDDATA;
62 
63  if (avctx->ch_layout.nb_channels != 1 && avctx->ch_layout.nb_channels != 2)
64  return AVERROR_INVALIDDATA;
65 
67  switch (avctx->sample_rate) {
68  case 8000:
69  case 11025:
70  s->marker = 0x11b;
71  break;
72  case 16000:
73  case 32000:
74  s->marker = 0x2b2;
75  break;
76  }
77 
78  return 0;
79 }
80 
81 #define FRACBITS 12
82 #define WEIGHTSBITS 26
83 
85 {
86  const int isign = FFDIFFSIGN(delta, 0);
87  int64_t dotpr = 0;
88 
89  c->new_pred = delta * (1LL << FRACBITS) + c->pred;
90 
91  for (int i = 0; i < 6; i++) {
92  const int sign = FFSIGN(c->diffs_tab[i]);
93  c->weights_tab[i] = (c->weights_tab[i] * 255LL) / 256;
94  c->weights_tab[i] += (1LL << (WEIGHTSBITS + 1)) * sign * isign;
95  }
96 
97  memmove(&c->diffs_tab[1], &c->diffs_tab[0], 5 * sizeof(int32_t));
98 
99  c->diffs_tab[0] = -delta * (1 << (FRACBITS-8));
100  c->pred = c->new_pred;
101 
102  dotpr = 0;
103  for (int i = 0; i < 6; i++)
104  dotpr += ((int64_t)c->diffs_tab[i] * c->weights_tab[i]) >> WEIGHTSBITS;
105 
106  c->pred += dotpr;
107  c->pred = av_clip64(c->pred, -16383 * (1 << FRACBITS), 16383 * (1 << FRACBITS));
108  c->pred = c->pred * 9 / 10;
109 
110  return c->new_pred;
111 }
112 
113 static int16_t decode(ChannelContext *c, unsigned nibble)
114 {
115  int diff, diff_sign, adiff = 0, delta;
116  uint32_t step, newstep;
117  int64_t pred;
118 
119  diff_sign = nibble >> 3;
120  diff = diffs[nibble];
121  step = diff + (c->last_step >> 2);
122  newstep = step & 0xfff;
123  if (newstep >> 11 == 0)
124  adiff = (((step & 0x7f) + 0x80) * 128) >>
125  (14 - (newstep >> 7));
126  delta = diff_sign ? -adiff : adiff;
127  delta = av_clip_intp2(delta, 15);
128  pred = prediction(delta, c);
129  nibble = steps[nibble];
130  newstep = nibble * 32 - c->last_step & 0x1ffff;
131  newstep = ((newstep >> 5) + (newstep & 0x10000 ? 0x1000 : 0) + c->last_step) & 0x1fff;
132  c->last_step = av_clip(newstep, 544, 5120);
133 
134  return av_clip_int16(pred >> (FRACBITS - 3));
135 }
136 
138  int *got_frame_ptr, AVPacket *pkt)
139 {
140  MISC4Context *s = avctx->priv_data;
141  GetByteContext *gb = &s->gb;
142  uint32_t hdr;
143  int ret;
144 
145  bytestream2_init(gb, pkt->data, pkt->size);
146 
147  frame->nb_samples = 29 * (1 + (avctx->ch_layout.nb_channels == 1));
148  if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
149  return ret;
150 
151  hdr = bytestream2_peek_be32(gb);
152  if (hdr == s->marker) {
153  bytestream2_skip(gb, 5);
154  } else if ((hdr >> 16) == s->marker) {
155  bytestream2_skip(gb, 3);
156  }
157 
158  {
159  int16_t *samples = (int16_t *)frame->data[0];
160  const int st = avctx->ch_layout.nb_channels == 2;
161  int n;
162 
163  for (n = 0; n < 29; n++) {
164  int nibble = bytestream2_get_byte(gb);
165  samples[2*n+0] = decode(&s->ch[0 ], nibble >> 4);
166  samples[2*n+1] = decode(&s->ch[st], nibble & 15);
167  if (bytestream2_get_bytes_left(gb) <= 0)
168  break;
169  }
170 
171  if (n == 29 && bytestream2_get_byte(gb) != 0x55)
172  return AVERROR_INVALIDDATA;
173  }
174 
175  *got_frame_ptr = 1;
176 
177  return bytestream2_tell(gb);
178 }
179 
181  .p.name = "misc4",
182  CODEC_LONG_NAME("Micronas SC-4 Audio"),
183  .p.type = AVMEDIA_TYPE_AUDIO,
184  .p.id = AV_CODEC_ID_MISC4,
185  .priv_data_size = sizeof(MISC4Context),
186  .init = misc4_init,
188  .p.capabilities = AV_CODEC_CAP_DR1 |
190 };
av_clip
#define av_clip
Definition: common.h:100
bytestream2_get_bytes_left
static av_always_inline int bytestream2_get_bytes_left(const GetByteContext *g)
Definition: bytestream.h:158
AVCodecContext::sample_rate
int sample_rate
samples per second
Definition: avcodec.h:1040
GetByteContext
Definition: bytestream.h:33
bytestream2_tell
static av_always_inline int bytestream2_tell(const GetByteContext *g)
Definition: bytestream.h:192
av_cold
#define av_cold
Definition: attributes.h:119
int64_t
long long int64_t
Definition: coverity.c:34
diffs
static const int16_t diffs[16]
Definition: misc4.c:35
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:466
step
trying all byte sequences megabyte in length and selecting the best looking sequence will yield cases to try But a word about which is also called distortion Distortion can be quantified by almost any quality measurement one chooses the sum of squared differences is used but more complex methods that consider psychovisual effects can be used as well It makes no difference in this discussion First step
Definition: rate_distortion.txt:58
AVPacket::data
uint8_t * data
Definition: packet.h:603
AV_CODEC_ID_MISC4
@ AV_CODEC_ID_MISC4
Definition: codec_id.h:559
MISC4Context::ch
ChannelContext ch[2]
Definition: misc4.c:53
WEIGHTSBITS
#define WEIGHTSBITS
Definition: misc4.c:82
ChannelContext::diffs_tab
int32_t diffs_tab[6]
Definition: misc4.c:45
FFCodec
Definition: codec_internal.h:127
AVChannelLayout::nb_channels
int nb_channels
Number of channels in this layout.
Definition: channel_layout.h:329
bytestream2_skip
static av_always_inline void bytestream2_skip(GetByteContext *g, unsigned int size)
Definition: bytestream.h:168
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:131
AVCodecContext::ch_layout
AVChannelLayout ch_layout
Audio channel layout.
Definition: avcodec.h:1055
FFSIGN
#define FFSIGN(a)
Definition: common.h:75
ChannelContext::pred
int64_t pred
Definition: misc4.c:43
av_clip64
#define av_clip64
Definition: common.h:103
FFDIFFSIGN
#define FFDIFFSIGN(x, y)
Comparator.
Definition: macros.h:45
FF_CODEC_DECODE_CB
#define FF_CODEC_DECODE_CB(func)
Definition: codec_internal.h:347
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:198
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:201
decode.h
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:332
FRACBITS
#define FRACBITS
Definition: misc4.c:81
ChannelContext::weights_tab
int64_t weights_tab[6]
Definition: misc4.c:44
av_clip_int16
#define av_clip_int16
Definition: common.h:115
av_clip_intp2
#define av_clip_intp2
Definition: common.h:121
MISC4Context::marker
uint32_t marker
Definition: misc4.c:51
mathops.h
decode
static int16_t decode(ChannelContext *c, unsigned nibble)
Definition: misc4.c:113
c
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated Undefined Behavior must not occur in a C it is not safe even if the output of undefined operations is unused The unsafety may seem nit picking but Optimizing compilers have in fact optimized code on the assumption that no undefined Behavior occurs Optimizing code based on wrong assumptions can and has in some cases lead to effects beyond the output of computations The signed integer overflow problem in speed critical code Code which is highly optimized and works with signed integers sometimes has the problem that often the output of the computation does not c
Definition: undefined.txt:32
AV_CODEC_CAP_CHANNEL_CONF
#define AV_CODEC_CAP_CHANNEL_CONF
Codec should fill in channel configuration and samplerate instead of container.
Definition: codec.h:91
ff_get_buffer
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1769
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts.c:579
AV_CODEC_CAP_DR1
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() or get_encode_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:52
ff_misc4_decoder
const FFCodec ff_misc4_decoder
Definition: misc4.c:180
AVPacket::size
int size
Definition: packet.h:604
codec_internal.h
i
#define i(width, name, range_min, range_max)
Definition: cbs_h264.c:63
for
for(k=2;k<=8;++k)
Definition: h264pred_template.c:424
AVCodecContext::sample_fmt
enum AVSampleFormat sample_fmt
audio sample format
Definition: avcodec.h:1047
prediction
static int64_t prediction(int delta, ChannelContext *c)
Definition: misc4.c:84
ChannelContext::last_step
unsigned last_step
Definition: misc4.c:41
diff
static av_always_inline int diff(const struct color_info *a, const struct color_info *b, const int trans_thresh)
Definition: vf_paletteuse.c:166
internal.h
delta
float delta
Definition: vorbis_enc_data.h:430
AV_SAMPLE_FMT_S16
@ AV_SAMPLE_FMT_S16
signed 16 bits
Definition: samplefmt.h:58
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:179
avcodec.h
ret
ret
Definition: filter_design.txt:187
pred
static const float pred[4]
Definition: siprdata.h:259
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:265
steps
static const int16_t steps[16]
Definition: misc4.c:30
AVCodecContext
main external API structure.
Definition: avcodec.h:443
MISC4Context
Definition: misc4.c:48
samples
Filter the word “frame” indicates either a video frame or a group of audio samples
Definition: filter_design.txt:8
ChannelContext::new_pred
int64_t new_pred
Definition: misc4.c:42
ChannelContext
Definition: hcadec.c:35
AVPacket
This structure stores compressed data.
Definition: packet.h:580
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:470
MISC4Context::gb
GetByteContext gb
Definition: misc4.c:49
misc4_init
static av_cold int misc4_init(AVCodecContext *avctx)
Definition: misc4.c:56
int32_t
int32_t
Definition: audioconvert.c:56
bytestream.h
misc4_decode
static int misc4_decode(AVCodecContext *avctx, AVFrame *frame, int *got_frame_ptr, AVPacket *pkt)
Definition: misc4.c:137
bytestream2_init
static av_always_inline void bytestream2_init(GetByteContext *g, const uint8_t *buf, int buf_size)
Definition: bytestream.h:137
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
pkt
static AVPacket * pkt
Definition: demux_decode.c:55