g726: don't pass index to g726_reset()
[ffmpeg.git] / libavcodec / g726.c
1 /*
2  * G.726 ADPCM audio codec
3  * Copyright (c) 2004 Roman Shaposhnik
4  *
5  * This is a very straightforward rendition of the G.726
6  * Section 4 "Computational Details".
7  *
8  * This file is part of Libav.
9  *
10  * Libav is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * Libav is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with Libav; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  */
24 #include <limits.h>
25 #include "libavutil/avassert.h"
26 #include "libavutil/opt.h"
27 #include "avcodec.h"
28 #include "internal.h"
29 #include "get_bits.h"
30 #include "put_bits.h"
31
32 /**
33  * G.726 11bit float.
34  * G.726 Standard uses rather odd 11bit floating point arithmentic for
35  * numerous occasions. It's a mistery to me why they did it this way
36  * instead of simply using 32bit integer arithmetic.
37  */
38 typedef struct Float11 {
39     uint8_t sign;   /**< 1bit sign */
40     uint8_t exp;    /**< 4bit exponent */
41     uint8_t mant;   /**< 6bit mantissa */
42 } Float11;
43
44 static inline Float11* i2f(int i, Float11* f)
45 {
46     f->sign = (i < 0);
47     if (f->sign)
48         i = -i;
49     f->exp = av_log2_16bit(i) + !!i;
50     f->mant = i? (i<<6) >> f->exp : 1<<5;
51     return f;
52 }
53
54 static inline int16_t mult(Float11* f1, Float11* f2)
55 {
56         int res, exp;
57
58         exp = f1->exp + f2->exp;
59         res = (((f1->mant * f2->mant) + 0x30) >> 4);
60         res = exp > 19 ? res << (exp - 19) : res >> (19 - exp);
61         return (f1->sign ^ f2->sign) ? -res : res;
62 }
63
64 static inline int sgn(int value)
65 {
66     return (value < 0) ? -1 : 1;
67 }
68
69 typedef struct G726Tables {
70     const int* quant;         /**< quantization table */
71     const int16_t* iquant;    /**< inverse quantization table */
72     const int16_t* W;         /**< special table #1 ;-) */
73     const uint8_t* F;         /**< special table #2 */
74 } G726Tables;
75
76 typedef struct G726Context {
77     AVClass *class;
78     G726Tables tbls;    /**< static tables needed for computation */
79
80     Float11 sr[2];      /**< prev. reconstructed samples */
81     Float11 dq[6];      /**< prev. difference */
82     int a[2];           /**< second order predictor coeffs */
83     int b[6];           /**< sixth order predictor coeffs */
84     int pk[2];          /**< signs of prev. 2 sez + dq */
85
86     int ap;             /**< scale factor control */
87     int yu;             /**< fast scale factor */
88     int yl;             /**< slow scale factor */
89     int dms;            /**< short average magnitude of F[i] */
90     int dml;            /**< long average magnitude of F[i] */
91     int td;             /**< tone detect */
92
93     int se;             /**< estimated signal for the next iteration */
94     int sez;            /**< estimated second order prediction */
95     int y;              /**< quantizer scaling factor for the next iteration */
96     int code_size;
97 } G726Context;
98
99 static const int quant_tbl16[] =                  /**< 16kbit/s 2bits per sample */
100            { 260, INT_MAX };
101 static const int16_t iquant_tbl16[] =
102            { 116, 365, 365, 116 };
103 static const int16_t W_tbl16[] =
104            { -22, 439, 439, -22 };
105 static const uint8_t F_tbl16[] =
106            { 0, 7, 7, 0 };
107
108 static const int quant_tbl24[] =                  /**< 24kbit/s 3bits per sample */
109            {  7, 217, 330, INT_MAX };
110 static const int16_t iquant_tbl24[] =
111            { INT16_MIN, 135, 273, 373, 373, 273, 135, INT16_MIN };
112 static const int16_t W_tbl24[] =
113            { -4,  30, 137, 582, 582, 137,  30, -4 };
114 static const uint8_t F_tbl24[] =
115            { 0, 1, 2, 7, 7, 2, 1, 0 };
116
117 static const int quant_tbl32[] =                  /**< 32kbit/s 4bits per sample */
118            { -125,  79, 177, 245, 299, 348, 399, INT_MAX };
119 static const int16_t iquant_tbl32[] =
120          { INT16_MIN,   4, 135, 213, 273, 323, 373, 425,
121                  425, 373, 323, 273, 213, 135,   4, INT16_MIN };
122 static const int16_t W_tbl32[] =
123            { -12,  18,  41,  64, 112, 198, 355, 1122,
124             1122, 355, 198, 112,  64,  41,  18, -12};
125 static const uint8_t F_tbl32[] =
126            { 0, 0, 0, 1, 1, 1, 3, 7, 7, 3, 1, 1, 1, 0, 0, 0 };
127
128 static const int quant_tbl40[] =                  /**< 40kbit/s 5bits per sample */
129            { -122, -16,  67, 138, 197, 249, 297, 338,
130               377, 412, 444, 474, 501, 527, 552, INT_MAX };
131 static const int16_t iquant_tbl40[] =
132          { INT16_MIN, -66,  28, 104, 169, 224, 274, 318,
133                  358, 395, 429, 459, 488, 514, 539, 566,
134                  566, 539, 514, 488, 459, 429, 395, 358,
135                  318, 274, 224, 169, 104,  28, -66, INT16_MIN };
136 static const int16_t W_tbl40[] =
137            {   14,  14,  24,  39,  40,  41,   58,  100,
138               141, 179, 219, 280, 358, 440,  529,  696,
139               696, 529, 440, 358, 280, 219,  179,  141,
140               100,  58,  41,  40,  39,  24,   14,   14 };
141 static const uint8_t F_tbl40[] =
142            { 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 2, 3, 4, 5, 6, 6,
143              6, 6, 5, 4, 3, 2, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0 };
144
145 static const G726Tables G726Tables_pool[] =
146            {{ quant_tbl16, iquant_tbl16, W_tbl16, F_tbl16 },
147             { quant_tbl24, iquant_tbl24, W_tbl24, F_tbl24 },
148             { quant_tbl32, iquant_tbl32, W_tbl32, F_tbl32 },
149             { quant_tbl40, iquant_tbl40, W_tbl40, F_tbl40 }};
150
151
152 /**
153  * Para 4.2.2 page 18: Adaptive quantizer.
154  */
155 static inline uint8_t quant(G726Context* c, int d)
156 {
157     int sign, exp, i, dln;
158
159     sign = i = 0;
160     if (d < 0) {
161         sign = 1;
162         d = -d;
163     }
164     exp = av_log2_16bit(d);
165     dln = ((exp<<7) + (((d<<7)>>exp)&0x7f)) - (c->y>>2);
166
167     while (c->tbls.quant[i] < INT_MAX && c->tbls.quant[i] < dln)
168         ++i;
169
170     if (sign)
171         i = ~i;
172     if (c->code_size != 2 && i == 0) /* I'm not sure this is a good idea */
173         i = 0xff;
174
175     return i;
176 }
177
178 /**
179  * Para 4.2.3 page 22: Inverse adaptive quantizer.
180  */
181 static inline int16_t inverse_quant(G726Context* c, int i)
182 {
183     int dql, dex, dqt;
184
185     dql = c->tbls.iquant[i] + (c->y >> 2);
186     dex = (dql>>7) & 0xf;        /* 4bit exponent */
187     dqt = (1<<7) + (dql & 0x7f); /* log2 -> linear */
188     return (dql < 0) ? 0 : ((dqt<<dex) >> 7);
189 }
190
191 static int16_t g726_decode(G726Context* c, int I)
192 {
193     int dq, re_signal, pk0, fa1, i, tr, ylint, ylfrac, thr2, al, dq0;
194     Float11 f;
195     int I_sig= I >> (c->code_size - 1);
196
197     dq = inverse_quant(c, I);
198
199     /* Transition detect */
200     ylint = (c->yl >> 15);
201     ylfrac = (c->yl >> 10) & 0x1f;
202     thr2 = (ylint > 9) ? 0x1f << 10 : (0x20 + ylfrac) << ylint;
203     tr= (c->td == 1 && dq > ((3*thr2)>>2));
204
205     if (I_sig)  /* get the sign */
206         dq = -dq;
207     re_signal = c->se + dq;
208
209     /* Update second order predictor coefficient A2 and A1 */
210     pk0 = (c->sez + dq) ? sgn(c->sez + dq) : 0;
211     dq0 = dq ? sgn(dq) : 0;
212     if (tr) {
213         c->a[0] = 0;
214         c->a[1] = 0;
215         for (i=0; i<6; i++)
216             c->b[i] = 0;
217     } else {
218         /* This is a bit crazy, but it really is +255 not +256 */
219         fa1 = av_clip((-c->a[0]*c->pk[0]*pk0)>>5, -256, 255);
220
221         c->a[1] += 128*pk0*c->pk[1] + fa1 - (c->a[1]>>7);
222         c->a[1] = av_clip(c->a[1], -12288, 12288);
223         c->a[0] += 64*3*pk0*c->pk[0] - (c->a[0] >> 8);
224         c->a[0] = av_clip(c->a[0], -(15360 - c->a[1]), 15360 - c->a[1]);
225
226         for (i=0; i<6; i++)
227             c->b[i] += 128*dq0*sgn(-c->dq[i].sign) - (c->b[i]>>8);
228     }
229
230     /* Update Dq and Sr and Pk */
231     c->pk[1] = c->pk[0];
232     c->pk[0] = pk0 ? pk0 : 1;
233     c->sr[1] = c->sr[0];
234     i2f(re_signal, &c->sr[0]);
235     for (i=5; i>0; i--)
236         c->dq[i] = c->dq[i-1];
237     i2f(dq, &c->dq[0]);
238     c->dq[0].sign = I_sig; /* Isn't it crazy ?!?! */
239
240     c->td = c->a[1] < -11776;
241
242     /* Update Ap */
243     c->dms += (c->tbls.F[I]<<4) + ((- c->dms) >> 5);
244     c->dml += (c->tbls.F[I]<<4) + ((- c->dml) >> 7);
245     if (tr)
246         c->ap = 256;
247     else {
248         c->ap += (-c->ap) >> 4;
249         if (c->y <= 1535 || c->td || abs((c->dms << 2) - c->dml) >= (c->dml >> 3))
250             c->ap += 0x20;
251     }
252
253     /* Update Yu and Yl */
254     c->yu = av_clip(c->y + c->tbls.W[I] + ((-c->y)>>5), 544, 5120);
255     c->yl += c->yu + ((-c->yl)>>6);
256
257     /* Next iteration for Y */
258     al = (c->ap >= 256) ? 1<<6 : c->ap >> 2;
259     c->y = (c->yl + (c->yu - (c->yl>>6))*al) >> 6;
260
261     /* Next iteration for SE and SEZ */
262     c->se = 0;
263     for (i=0; i<6; i++)
264         c->se += mult(i2f(c->b[i] >> 2, &f), &c->dq[i]);
265     c->sez = c->se >> 1;
266     for (i=0; i<2; i++)
267         c->se += mult(i2f(c->a[i] >> 2, &f), &c->sr[i]);
268     c->se >>= 1;
269
270     return av_clip(re_signal << 2, -0xffff, 0xffff);
271 }
272
273 static av_cold int g726_reset(G726Context *c)
274 {
275     int i;
276
277     c->tbls = G726Tables_pool[c->code_size - 2];
278     for (i=0; i<2; i++) {
279         c->sr[i].mant = 1<<5;
280         c->pk[i] = 1;
281     }
282     for (i=0; i<6; i++) {
283         c->dq[i].mant = 1<<5;
284     }
285     c->yu = 544;
286     c->yl = 34816;
287
288     c->y = 544;
289
290     return 0;
291 }
292
293 #if CONFIG_ADPCM_G726_ENCODER
294 static int16_t g726_encode(G726Context* c, int16_t sig)
295 {
296     uint8_t i;
297
298     i = quant(c, sig/4 - c->se) & ((1<<c->code_size) - 1);
299     g726_decode(c, i);
300     return i;
301 }
302
303 /* Interfacing to the libavcodec */
304
305 static av_cold int g726_encode_init(AVCodecContext *avctx)
306 {
307     G726Context* c = avctx->priv_data;
308
309     if (avctx->strict_std_compliance > FF_COMPLIANCE_UNOFFICIAL &&
310         avctx->sample_rate != 8000) {
311         av_log(avctx, AV_LOG_ERROR, "Sample rates other than 8kHz are not "
312                "allowed when the compliance level is higher than unofficial. "
313                "Resample or reduce the compliance level.\n");
314         return AVERROR(EINVAL);
315     }
316     av_assert0(avctx->sample_rate > 0);
317
318     if(avctx->channels != 1){
319         av_log(avctx, AV_LOG_ERROR, "Only mono is supported\n");
320         return AVERROR(EINVAL);
321     }
322
323     if (avctx->bit_rate)
324         c->code_size = (avctx->bit_rate + avctx->sample_rate/2) / avctx->sample_rate;
325
326     c->code_size = av_clip(c->code_size, 2, 5);
327     avctx->bit_rate = c->code_size * avctx->sample_rate;
328     avctx->bits_per_coded_sample = c->code_size;
329
330     g726_reset(c);
331
332     avctx->coded_frame = avcodec_alloc_frame();
333     if (!avctx->coded_frame)
334         return AVERROR(ENOMEM);
335     avctx->coded_frame->key_frame = 1;
336
337     /* select a frame size that will end on a byte boundary and have a size of
338        approximately 1024 bytes */
339     avctx->frame_size = ((int[]){ 4096, 2736, 2048, 1640 })[c->code_size - 2];
340
341     return 0;
342 }
343
344 static av_cold int g726_encode_close(AVCodecContext *avctx)
345 {
346     av_freep(&avctx->coded_frame);
347     return 0;
348 }
349
350 static int g726_encode_frame(AVCodecContext *avctx,
351                             uint8_t *dst, int buf_size, void *data)
352 {
353     G726Context *c = avctx->priv_data;
354     const int16_t *samples = data;
355     PutBitContext pb;
356     int i;
357
358     init_put_bits(&pb, dst, 1024*1024);
359
360     for (i = 0; i < avctx->frame_size; i++)
361         put_bits(&pb, c->code_size, g726_encode(c, *samples++));
362
363     flush_put_bits(&pb);
364
365     return put_bits_count(&pb)>>3;
366 }
367
368 #define OFFSET(x) offsetof(G726Context, x)
369 #define AE AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
370 static const AVOption options[] = {
371     { "code_size", "Bits per code", OFFSET(code_size), AV_OPT_TYPE_INT, { 4 }, 2, 5, AE },
372     { NULL },
373 };
374
375 static const AVClass class = {
376     .class_name = "g726",
377     .item_name  = av_default_item_name,
378     .option     = options,
379     .version    = LIBAVUTIL_VERSION_INT,
380 };
381
382 static const AVCodecDefault defaults[] = {
383     { "b", "0" },
384     { NULL },
385 };
386
387 AVCodec ff_adpcm_g726_encoder = {
388     .name           = "g726",
389     .type           = AVMEDIA_TYPE_AUDIO,
390     .id             = CODEC_ID_ADPCM_G726,
391     .priv_data_size = sizeof(G726Context),
392     .init           = g726_encode_init,
393     .encode         = g726_encode_frame,
394     .close          = g726_encode_close,
395     .capabilities = CODEC_CAP_SMALL_LAST_FRAME,
396     .sample_fmts = (const enum AVSampleFormat[]){AV_SAMPLE_FMT_S16,AV_SAMPLE_FMT_NONE},
397     .long_name = NULL_IF_CONFIG_SMALL("G.726 ADPCM"),
398     .priv_class     = &class,
399     .defaults       = defaults,
400 };
401 #endif
402
403 #if CONFIG_ADPCM_G726_DECODER
404 static av_cold int g726_decode_init(AVCodecContext *avctx)
405 {
406     G726Context* c = avctx->priv_data;
407
408     if (avctx->strict_std_compliance >= FF_COMPLIANCE_STRICT &&
409         avctx->sample_rate != 8000) {
410         av_log(avctx, AV_LOG_ERROR, "Only 8kHz sample rate is allowed when "
411                "the compliance level is strict. Reduce the compliance level "
412                "if you wish to decode the stream anyway.\n");
413         return AVERROR(EINVAL);
414     }
415
416     if(avctx->channels != 1){
417         av_log(avctx, AV_LOG_ERROR, "Only mono is supported\n");
418         return AVERROR(EINVAL);
419     }
420
421     c->code_size = avctx->bits_per_coded_sample;
422     if (c->code_size < 2 || c->code_size > 5) {
423         av_log(avctx, AV_LOG_ERROR, "Invalid number of bits %d\n", c->code_size);
424         return AVERROR(EINVAL);
425     }
426     g726_reset(c);
427
428     avctx->sample_fmt = AV_SAMPLE_FMT_S16;
429
430     return 0;
431 }
432
433 static int g726_decode_frame(AVCodecContext *avctx,
434                              void *data, int *data_size,
435                              AVPacket *avpkt)
436 {
437     const uint8_t *buf = avpkt->data;
438     int buf_size = avpkt->size;
439     G726Context *c = avctx->priv_data;
440     int16_t *samples = data;
441     GetBitContext gb;
442     int out_samples, out_size;
443
444     out_samples = buf_size * 8 / c->code_size;
445     out_size    = out_samples * av_get_bytes_per_sample(avctx->sample_fmt);
446     if (*data_size < out_size) {
447         av_log(avctx, AV_LOG_ERROR, "Output buffer is too small\n");
448         return AVERROR(EINVAL);
449     }
450
451     init_get_bits(&gb, buf, buf_size * 8);
452
453     while (out_samples--)
454         *samples++ = g726_decode(c, get_bits(&gb, c->code_size));
455
456     if (get_bits_left(&gb) > 0)
457         av_log(avctx, AV_LOG_ERROR, "Frame invalidly split, missing parser?\n");
458
459     *data_size = out_size;
460     return buf_size;
461 }
462
463 AVCodec ff_adpcm_g726_decoder = {
464     .name           = "g726",
465     .type           = AVMEDIA_TYPE_AUDIO,
466     .id             = CODEC_ID_ADPCM_G726,
467     .priv_data_size = sizeof(G726Context),
468     .init           = g726_decode_init,
469     .decode         = g726_decode_frame,
470     .long_name = NULL_IF_CONFIG_SMALL("G.726 ADPCM"),
471 };
472 #endif