c63544b77385422177fbb8ed118e46259fa62f62
[asterisk/asterisk.git] / codecs / codec_adpcm.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Based on frompcm.c and topcm.c from the Emiliano MIPL browser/
5  * interpreter.  See http://www.bsdtelephony.com.mx
6  *
7  * Copyright (c) 2001 - 2005 Digium, Inc.
8  * All rights reserved.
9  *
10  * Karl Sackett <krs@linux-support.net>, 2001-03-21
11  *
12  * See http://www.asterisk.org for more information about
13  * the Asterisk project. Please do not directly contact
14  * any of the maintainers of this project for assistance;
15  * the project provides a web site, mailing lists and IRC
16  * channels for your use.
17  *
18  * This program is free software, distributed under the terms of
19  * the GNU General Public License Version 2. See the LICENSE file
20  * at the top of the source tree.
21  */
22
23 /*! \file
24  *
25  * \brief codec_adpcm.c - translate between signed linear and Dialogic ADPCM
26  * 
27  * \ingroup codecs
28  */
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include <fcntl.h>
35 #include <netinet/in.h>
36
37 #include "asterisk/lock.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/linkedlists.h"
40 #include "asterisk/module.h"
41 #include "asterisk/config.h"
42 #include "asterisk/options.h"
43 #include "asterisk/translate.h"
44 #include "asterisk/channel.h"
45 #include "asterisk/utils.h"
46
47 /* define NOT_BLI to use a faster but not bit-level identical version */
48 /* #define NOT_BLI */
49
50 #define BUFFER_SAMPLES   8096   /* size for the translation buffers */
51
52 /* Sample frame data */
53
54 #include "slin_adpcm_ex.h"
55 #include "adpcm_slin_ex.h"
56
57 /*
58  * Step size index shift table 
59  */
60
61 static int indsft[8] = { -1, -1, -1, -1, 2, 4, 6, 8 };
62
63 /*
64  * Step size table, where stpsz[i]=floor[16*(11/10)^i]
65  */
66
67 static int stpsz[49] = {
68   16, 17, 19, 21, 23, 25, 28, 31, 34, 37, 41, 45, 50, 55, 60, 66, 73,
69   80, 88, 97, 107, 118, 130, 143, 157, 173, 190, 209, 230, 253, 279,
70   307, 337, 371, 408, 449, 494, 544, 598, 658, 724, 796, 876, 963,
71   1060, 1166, 1282, 1411, 1552
72 };
73
74 /*
75  * Decoder/Encoder state
76  *   States for both encoder and decoder are synchronized
77  */
78 struct adpcm_state {
79         int ssindex;
80         int signal;
81         int zero_count;
82         int next_flag;
83 };
84
85 /*
86  * Decode(encoded)
87  *  Decodes the encoded nibble from the adpcm file.
88  *
89  * Results:
90  *  Returns the encoded difference.
91  *
92  * Side effects:
93  *  Sets the index to the step size table for the next encode.
94  */
95
96 static inline short decode(int encoded, struct adpcm_state *state)
97 {
98         int diff;
99         int step;
100         int sign;
101
102         step = stpsz[state->ssindex];
103
104         sign = encoded & 0x08;
105         encoded &= 0x07;
106 #ifdef NOT_BLI
107         diff = (((encoded << 1) + 1) * step) >> 3;
108 #else /* BLI code */
109         diff = step >> 3;
110         if (encoded & 4)
111                 diff += step;
112         if (encoded & 2)
113                 diff += step >> 1;
114         if (encoded & 1)
115                 diff += step >> 2;
116         if ((encoded >> 1) & step & 0x1)
117                 diff++;
118 #endif
119         if (sign)
120                 diff = -diff;
121
122         if (state->next_flag & 0x1)
123                 state->signal -= 8;
124         else if (state->next_flag & 0x2)
125                 state->signal += 8;
126
127         state->signal += diff;
128
129         if (state->signal > 2047)
130                 state->signal = 2047;
131         else if (state->signal < -2047)
132                 state->signal = -2047;
133
134         state->next_flag = 0;
135
136 #ifdef AUTO_RETURN
137         if (encoded)
138                 state->zero_count = 0;
139         else if (++(state->zero_count) == 24) {
140                 state->zero_count = 0;
141                 if (state->signal > 0)
142                         state->next_flag = 0x1;
143                 else if (state->signal < 0)
144                         state->next_flag = 0x2;
145         }
146 #endif
147
148         state->ssindex += indsft[encoded];
149         if (state->ssindex < 0)
150                 state->ssindex = 0;
151         else if (state->ssindex > 48)
152                 state->ssindex = 48;
153
154         return state->signal << 4;
155 }
156
157 /*
158  * Adpcm
159  *  Takes a signed linear signal and encodes it as ADPCM
160  *  For more information see http://support.dialogic.com/appnotes/adpcm.pdf
161  *
162  * Results:
163  *  Foo.
164  *
165  * Side effects:
166  *  signal gets updated with each pass.
167  */
168
169 static inline int adpcm(short csig, struct adpcm_state *state)
170 {
171         int diff;
172         int step;
173         int encoded;
174
175         /* 
176          * Clip csig if too large or too small
177          */
178         csig >>= 4;
179
180         step = stpsz[state->ssindex];
181         diff = csig - state->signal;
182
183 #ifdef NOT_BLI
184         if (diff < 0) {
185                 encoded = (-diff << 2) / step;
186                 if (encoded > 7)
187                         encoded = 7;
188                 encoded |= 0x08;
189         } else {
190                 encoded = (diff << 2) / step;
191                 if (encoded > 7)
192                         encoded = 7;
193         }
194 #else /* BLI code */
195         if (diff < 0) {
196                 encoded = 8;
197                 diff = -diff;
198         } else
199                 encoded = 0;
200         if (diff >= step) {
201                 encoded |= 4;
202                 diff -= step;
203         }
204         step >>= 1;
205         if (diff >= step) {
206                 encoded |= 2;
207                 diff -= step;
208         }
209         step >>= 1;
210         if (diff >= step)
211                 encoded |= 1;
212 #endif /* NOT_BLI */
213
214         /* feedback to state */
215         decode(encoded, state);
216         
217         return encoded;
218 }
219
220 /*----------------- Asterisk-codec glue ------------*/
221
222 /*! \brief Workspace for translating signed linear signals to ADPCM. */
223 struct adpcm_encoder_pvt {
224         struct adpcm_state state;
225         int16_t inbuf[BUFFER_SAMPLES];  /* Unencoded signed linear values */
226 };
227
228 /*! \brief Workspace for translating ADPCM signals to signed linear. */
229 struct adpcm_decoder_pvt {
230         struct adpcm_state state;
231 };
232
233 /*! \brief decode 4-bit adpcm frame data and store in output buffer */
234 static int adpcmtolin_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
235 {
236         struct adpcm_decoder_pvt *tmp = pvt->pvt;
237         int x = f->datalen;
238         unsigned char *src = f->data;
239         int16_t *dst = (int16_t *)pvt->outbuf + pvt->samples;
240
241         while (x--) {
242                 *dst++ = decode((*src >> 4) & 0xf, &tmp->state);
243                 *dst++ = decode(*src++ & 0x0f, &tmp->state);
244         }
245         pvt->samples += f->samples;
246         pvt->datalen += 2*f->samples;
247         return 0;
248 }
249
250 /*! \brief fill input buffer with 16-bit signed linear PCM values. */
251 static int lintoadpcm_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
252 {
253         struct adpcm_encoder_pvt *tmp = pvt->pvt;
254
255         memcpy(&tmp->inbuf[pvt->samples], f->data, f->datalen);
256         pvt->samples += f->samples;
257         return 0;
258 }
259
260 /*! \brief convert inbuf and store into frame */
261 static struct ast_frame *lintoadpcm_frameout(struct ast_trans_pvt *pvt)
262 {
263         struct adpcm_encoder_pvt *tmp = pvt->pvt;
264         struct ast_frame *f;
265         int i;
266         int samples = pvt->samples;     /* save original number */
267   
268         if (samples < 2)
269                 return NULL;
270
271         pvt->samples &= ~1; /* atomic size is 2 samples */
272
273         for (i = 0; i < pvt->samples; i += 2) {
274                 pvt->outbuf[i/2] =
275                         (adpcm(tmp->inbuf[i  ], &tmp->state) << 4) |
276                         (adpcm(tmp->inbuf[i+1], &tmp->state)     );
277         };
278
279         f = ast_trans_frameout(pvt, pvt->samples/2, 0);
280
281         /*
282          * If there is a left over sample, move it to the beginning
283          * of the input buffer.
284          */
285
286         if (samples & 1) {      /* move the leftover sample at beginning */
287                 tmp->inbuf[0] = tmp->inbuf[samples - 1];
288                 pvt->samples = 1;
289         }
290         return f;
291 }
292
293
294 /*! \brief AdpcmToLin_Sample */
295 static struct ast_frame *adpcmtolin_sample(void)
296 {
297         static struct ast_frame f;
298         f.frametype = AST_FRAME_VOICE;
299         f.subclass = AST_FORMAT_ADPCM;
300         f.datalen = sizeof(adpcm_slin_ex);
301         f.samples = sizeof(adpcm_slin_ex) * 2;
302         f.mallocd = 0;
303         f.offset = 0;
304         f.src = __PRETTY_FUNCTION__;
305         f.data = adpcm_slin_ex;
306         return &f;
307 }
308
309 /*! \brief LinToAdpcm_Sample */
310 static struct ast_frame *lintoadpcm_sample(void)
311 {
312         static struct ast_frame f;
313         f.frametype = AST_FRAME_VOICE;
314         f.subclass = AST_FORMAT_SLINEAR;
315         f.datalen = sizeof(slin_adpcm_ex);
316         /* Assume 8000 Hz */
317         f.samples = sizeof(slin_adpcm_ex) / 2;
318         f.mallocd = 0;
319         f.offset = 0;
320         f.src = __PRETTY_FUNCTION__;
321         f.data = slin_adpcm_ex;
322         return &f;
323 }
324
325 static struct ast_translator adpcmtolin = {
326         .name = "adpcmtolin",
327         .srcfmt = AST_FORMAT_ADPCM,
328         .dstfmt = AST_FORMAT_SLINEAR,
329         .framein = adpcmtolin_framein,
330         .sample = adpcmtolin_sample,
331         .desc_size = sizeof(struct adpcm_decoder_pvt),
332         .buffer_samples = BUFFER_SAMPLES,
333         .buf_size = BUFFER_SAMPLES * 2,
334         .plc_samples = 160,
335 };
336
337 static struct ast_translator lintoadpcm = {
338         .name = "lintoadpcm",
339         .srcfmt = AST_FORMAT_SLINEAR,
340         .dstfmt = AST_FORMAT_ADPCM,
341         .framein = lintoadpcm_framein,
342         .frameout = lintoadpcm_frameout,
343         .sample = lintoadpcm_sample,
344         .desc_size = sizeof (struct adpcm_encoder_pvt),
345         .buffer_samples = BUFFER_SAMPLES,
346         .buf_size = BUFFER_SAMPLES/ 2,  /* 2 samples per byte */
347 };
348
349 static int parse_config(int reload)
350 {
351         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
352         struct ast_config *cfg = ast_config_load("codecs.conf", config_flags);
353         struct ast_variable *var;
354         if (cfg == NULL)
355                 return -1;
356         if (cfg == CONFIG_STATUS_FILEUNCHANGED)
357                 return 0;
358         for (var = ast_variable_browse(cfg, "plc"); var ; var = var->next) {
359                 if (!strcasecmp(var->name, "genericplc")) {
360                         adpcmtolin.useplc = ast_true(var->value) ? 1 : 0;
361                         ast_verb(3, "codec_adpcm: %susing generic PLC\n", adpcmtolin.useplc ? "" : "not ");
362                 }
363         }
364         ast_config_destroy(cfg);
365         return 0;
366 }
367
368 /*! \brief standard module glue */
369 static int reload(void)
370 {
371         if (parse_config(1))
372                 return AST_MODULE_LOAD_DECLINE;
373         return AST_MODULE_LOAD_SUCCESS;
374 }
375
376 static int unload_module(void)
377 {
378         int res;
379
380         res = ast_unregister_translator(&lintoadpcm);
381         res |= ast_unregister_translator(&adpcmtolin);
382
383         return res;
384 }
385
386 static int load_module(void)
387 {
388         int res;
389
390         if (parse_config(0))
391                 return AST_MODULE_LOAD_DECLINE;
392         res = ast_register_translator(&adpcmtolin);
393         if (!res)
394                 res = ast_register_translator(&lintoadpcm);
395         else
396                 ast_unregister_translator(&adpcmtolin);
397         if (res)
398                 return AST_MODULE_LOAD_FAILURE;
399         return AST_MODULE_LOAD_SUCCESS;
400 }
401
402 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Adaptive Differential PCM Coder/Decoder",
403                 .load = load_module,
404                 .unload = unload_module,
405                 .reload = reload,
406                );