e6275507499ca1d7a02d136c5172e6213d4fd995
[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 <fcntl.h>
31 #include <netinet/in.h>
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include <unistd.h>
36
37 #include "asterisk.h"
38
39 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
40
41 #include "asterisk/lock.h"
42 #include "asterisk/logger.h"
43 #include "asterisk/module.h"
44 #include "asterisk/config.h"
45 #include "asterisk/options.h"
46 #include "asterisk/translate.h"
47 #include "asterisk/channel.h"
48
49 /* define NOT_BLI to use a faster but not bit-level identical version */
50 /* #define NOT_BLI */
51
52 #define BUFFER_SIZE   8096      /* size for the translation buffers */
53
54 AST_MUTEX_DEFINE_STATIC(localuser_lock);
55 static int localusecnt = 0;
56
57 static char *tdesc = "Adaptive Differential PCM Coder/Decoder";
58
59 static int useplc = 0;
60
61 /* Sample frame data */
62
63 #include "slin_adpcm_ex.h"
64 #include "adpcm_slin_ex.h"
65
66 /*
67  * Step size index shift table 
68  */
69
70 static int indsft[8] = { -1, -1, -1, -1, 2, 4, 6, 8 };
71
72 /*
73  * Step size table, where stpsz[i]=floor[16*(11/10)^i]
74  */
75
76 static int stpsz[49] = {
77   16, 17, 19, 21, 23, 25, 28, 31, 34, 37, 41, 45, 50, 55, 60, 66, 73,
78   80, 88, 97, 107, 118, 130, 143, 157, 173, 190, 209, 230, 253, 279,
79   307, 337, 371, 408, 449, 494, 544, 598, 658, 724, 796, 876, 963,
80   1060, 1166, 1282, 1411, 1552
81 };
82
83 /*
84  * Decoder/Encoder state
85  *   States for both encoder and decoder are synchronized
86  */
87 struct adpcm_state {
88         int ssindex;
89         int signal;
90         int zero_count;
91         int next_flag;
92 };
93
94 /*
95  * Decode(encoded)
96  *  Decodes the encoded nibble from the adpcm file.
97  *
98  * Results:
99  *  Returns the encoded difference.
100  *
101  * Side effects:
102  *  Sets the index to the step size table for the next encode.
103  */
104
105 static inline short decode(int encoded, struct adpcm_state *state)
106 {
107         int diff;
108         int step;
109         int sign;
110
111         step = stpsz[state->ssindex];
112
113         sign = encoded & 0x08;
114         encoded &= 0x07;
115 #ifdef NOT_BLI
116         diff = (((encoded << 1) + 1) * step) >> 3;
117 #else /* BLI code */
118         diff = step >> 3;
119         if (encoded & 4)
120                 diff += step;
121         if (encoded & 2)
122                 diff += step >> 1;
123         if (encoded & 1)
124                 diff += step >> 2;
125         if ((encoded >> 1) & step & 0x1)
126                 diff++;
127 #endif
128         if (sign)
129                 diff = -diff;
130
131         if (state->next_flag & 0x1)
132                 state->signal -= 8;
133         else if (state->next_flag & 0x2)
134                 state->signal += 8;
135
136         state->signal += diff;
137
138         if (state->signal > 2047)
139                 state->signal = 2047;
140         else if (state->signal < -2047)
141                 state->signal = -2047;
142
143         state->next_flag = 0;
144
145 #ifdef AUTO_RETURN
146         if (encoded)
147                 state->zero_count = 0;
148         else if (++(state->zero_count) == 24) {
149                 state->zero_count = 0;
150                 if (state->signal > 0)
151                         state->next_flag = 0x1;
152                 else if (state->signal < 0)
153                         state->next_flag = 0x2;
154         }
155 #endif
156
157         state->ssindex += indsft[encoded];
158         if (state->ssindex < 0)
159                 state->ssindex = 0;
160         else if (state->ssindex > 48)
161                 state->ssindex = 48;
162
163         return state->signal << 4;
164 }
165
166 /*
167  * Adpcm
168  *  Takes a signed linear signal and encodes it as ADPCM
169  *  For more information see http://support.dialogic.com/appnotes/adpcm.pdf
170  *
171  * Results:
172  *  Foo.
173  *
174  * Side effects:
175  *  signal gets updated with each pass.
176  */
177
178 static inline int adpcm(short csig, struct adpcm_state *state)
179 {
180         int diff;
181         int step;
182         int encoded;
183
184         /* 
185          * Clip csig if too large or too small
186          */
187         csig >>= 4;
188
189         step = stpsz[state->ssindex];
190         diff = csig - state->signal;
191
192 #ifdef NOT_BLI
193         if (diff < 0) {
194                 encoded = (-diff << 2) / step;
195                 if (encoded > 7)
196                         encoded = 7;
197                 encoded |= 0x08;
198         } else {
199                 encoded = (diff << 2) / step;
200                 if (encoded > 7)
201                         encoded = 7;
202         }
203 #else /* BLI code */
204         if (diff < 0) {
205                 encoded = 8;
206                 diff = -diff;
207         } else
208                 encoded = 0;
209         if (diff >= step) {
210                 encoded |= 4;
211                 diff -= step;
212         }
213         step >>= 1;
214         if (diff >= step) {
215                 encoded |= 2;
216                 diff -= step;
217         }
218         step >>= 1;
219         if (diff >= step)
220                 encoded |= 1;
221 #endif /* NOT_BLI */
222
223         /* feedback to state */
224         decode(encoded, state);
225         
226         return encoded;
227 }
228
229 /*
230  * Private workspace for translating signed linear signals to ADPCM.
231  */
232
233 struct adpcm_encoder_pvt
234 {
235         struct ast_frame f;
236         char offset[AST_FRIENDLY_OFFSET];       /* Space to build offset */
237         short inbuf[BUFFER_SIZE];               /* Unencoded signed linear values */
238         unsigned char outbuf[BUFFER_SIZE];      /* Encoded ADPCM, two nibbles to a word */
239         struct adpcm_state state;
240         int tail;
241 };
242
243 /*
244  * Private workspace for translating ADPCM signals to signed linear.
245  */
246
247 struct adpcm_decoder_pvt
248 {
249         struct ast_frame f;
250         char offset[AST_FRIENDLY_OFFSET];       /* Space to build offset */
251         short outbuf[BUFFER_SIZE];              /* Decoded signed linear values */
252         struct adpcm_state state;
253         int tail;
254         plc_state_t plc;
255 };
256
257 /*
258  * AdpcmToLin_New
259  *  Create a new instance of adpcm_decoder_pvt.
260  *
261  * Results:
262  *  Returns a pointer to the new instance.
263  *
264  * Side effects:
265  *  None.
266  */
267
268 static struct ast_translator_pvt *adpcmtolin_new(void)
269 {
270         struct adpcm_decoder_pvt *tmp;
271         tmp = malloc(sizeof(struct adpcm_decoder_pvt));
272         if (tmp) {
273                 memset(tmp, 0, sizeof(*tmp));
274                 tmp->tail = 0;
275                 plc_init(&tmp->plc);
276                 localusecnt++;
277                 ast_update_use_count();
278         }
279         return (struct ast_translator_pvt *)tmp;
280 }
281
282 /*
283  * LinToAdpcm_New
284  *  Create a new instance of adpcm_encoder_pvt.
285  *
286  * Results:
287  *  Returns a pointer to the new instance.
288  *
289  * Side effects:
290  *  None.
291  */
292
293 static struct ast_translator_pvt *lintoadpcm_new(void)
294 {
295         struct adpcm_encoder_pvt *tmp;
296         tmp = malloc(sizeof(struct adpcm_encoder_pvt));
297         if (tmp) {
298                 memset(tmp, 0, sizeof(*tmp));
299                 localusecnt++;
300                 ast_update_use_count();
301                 tmp->tail = 0;
302         }
303         return (struct ast_translator_pvt *)tmp;
304 }
305
306 /*
307  * AdpcmToLin_FrameIn
308  *  Take an input buffer with packed 4-bit ADPCM values and put decoded PCM in outbuf, 
309  *  if there is room left.
310  *
311  * Results:
312  *  Foo
313  *
314  * Side effects:
315  *  tmp->tail is the number of packed values in the buffer.
316  */
317
318 static int adpcmtolin_framein(struct ast_translator_pvt *pvt, struct ast_frame *f)
319 {
320         struct adpcm_decoder_pvt *tmp = (struct adpcm_decoder_pvt *)pvt;
321         int x;
322         unsigned char *b;
323
324         if(f->datalen == 0) { /* perform PLC with nominal framesize of 20ms/160 samples */
325                 if((tmp->tail + 160) > sizeof(tmp->outbuf) / 2) {
326                         ast_log(LOG_WARNING, "Out of buffer space\n");
327                         return -1;
328                 }
329                 if(useplc) {
330                         plc_fillin(&tmp->plc, tmp->outbuf+tmp->tail, 160);
331                         tmp->tail += 160;
332                 }
333                 return 0;
334         }
335
336         if (f->datalen * 4 + tmp->tail * 2 > sizeof(tmp->outbuf)) {
337                 ast_log(LOG_WARNING, "Out of buffer space\n");
338                 return -1;
339         }
340
341         b = f->data;
342
343         for (x=0;x<f->datalen;x++) {
344                 tmp->outbuf[tmp->tail++] = decode((b[x] >> 4) & 0xf, &tmp->state);
345                 tmp->outbuf[tmp->tail++] = decode(b[x] & 0x0f, &tmp->state);
346         }
347
348         if(useplc)
349                 plc_rx(&tmp->plc, tmp->outbuf+tmp->tail-f->datalen*2, f->datalen*2);
350
351         return 0;
352 }
353
354 /*
355  * AdpcmToLin_FrameOut
356  *  Convert 4-bit ADPCM encoded signals to 16-bit signed linear.
357  *
358  * Results:
359  *  Converted signals are placed in tmp->f.data, tmp->f.datalen
360  *  and tmp->f.samples are calculated.
361  *
362  * Side effects:
363  *  None.
364  */
365
366 static struct ast_frame *adpcmtolin_frameout(struct ast_translator_pvt *pvt)
367 {
368         struct adpcm_decoder_pvt *tmp = (struct adpcm_decoder_pvt *)pvt;
369
370         if (!tmp->tail)
371                 return NULL;
372
373         tmp->f.frametype = AST_FRAME_VOICE;
374         tmp->f.subclass = AST_FORMAT_SLINEAR;
375         tmp->f.datalen = tmp->tail * 2;
376         tmp->f.samples = tmp->tail;
377         tmp->f.mallocd = 0;
378         tmp->f.offset = AST_FRIENDLY_OFFSET;
379         tmp->f.src = __PRETTY_FUNCTION__;
380         tmp->f.data = tmp->outbuf;
381         tmp->tail = 0;
382         return &tmp->f;
383 }
384
385 /*
386  * LinToAdpcm_FrameIn
387  *  Fill an input buffer with 16-bit signed linear PCM values.
388  *
389  * Results:
390  *  None.
391  *
392  * Side effects:
393  *  tmp->tail is number of signal values in the input buffer.
394  */
395
396 static int lintoadpcm_framein(struct ast_translator_pvt *pvt, struct ast_frame *f)
397 {
398         struct adpcm_encoder_pvt *tmp = (struct adpcm_encoder_pvt *)pvt;
399
400         if ((tmp->tail + f->datalen / 2) < (sizeof(tmp->inbuf) / 2)) {
401                 memcpy(&tmp->inbuf[tmp->tail], f->data, f->datalen);
402                 tmp->tail += f->datalen / 2;
403         } else {
404                 ast_log(LOG_WARNING, "Out of buffer space\n");
405                 return -1;
406         }
407         return 0;
408 }
409
410 /*
411  * LinToAdpcm_FrameOut
412  *  Convert a buffer of raw 16-bit signed linear PCM to a buffer
413  *  of 4-bit ADPCM packed two to a byte (Big Endian).
414  *
415  * Results:
416  *  Foo
417  *
418  * Side effects:
419  *  Leftover inbuf data gets packed, tail gets updated.
420  */
421
422 static struct ast_frame *lintoadpcm_frameout(struct ast_translator_pvt *pvt)
423 {
424         struct adpcm_encoder_pvt *tmp = (struct adpcm_encoder_pvt *)pvt;
425         int i_max, i;
426   
427         if (tmp->tail < 2)
428                 return NULL;
429
430         i_max = tmp->tail & ~1; /* atomic size is 2 samples */
431
432         /* What is this, state debugging? should be #ifdef'd then
433         tmp->outbuf[0] = tmp->ssindex & 0xff;
434         tmp->outbuf[1] = (tmp->signal >> 8) & 0xff;
435         tmp->outbuf[2] = (tmp->signal & 0xff);
436         tmp->outbuf[3] = tmp->zero_count;
437         tmp->outbuf[4] = tmp->next_flag;
438         */
439         for (i = 0; i < i_max; i+=2) {
440                 tmp->outbuf[i/2] =
441                         (adpcm(tmp->inbuf[i  ], &tmp->state) << 4) |
442                         (adpcm(tmp->inbuf[i+1], &tmp->state)     );
443         };
444
445         tmp->f.frametype = AST_FRAME_VOICE;
446         tmp->f.subclass = AST_FORMAT_ADPCM;
447         tmp->f.samples = i_max;
448         tmp->f.mallocd = 0;
449         tmp->f.offset = AST_FRIENDLY_OFFSET;
450         tmp->f.src = __PRETTY_FUNCTION__;
451         tmp->f.data = tmp->outbuf;
452         tmp->f.datalen = i_max / 2;
453
454         /*
455          * If there is a signal left over (there should be no more than
456          * one) move it to the beginning of the input buffer.
457          */
458
459         if (tmp->tail == i_max)
460                 tmp->tail = 0;
461         else {
462                 tmp->inbuf[0] = tmp->inbuf[tmp->tail];
463                 tmp->tail = 1;
464         }
465         return &tmp->f;
466 }
467
468
469 /*
470  * AdpcmToLin_Sample
471  */
472
473 static struct ast_frame *adpcmtolin_sample(void)
474 {
475         static struct ast_frame f;
476         f.frametype = AST_FRAME_VOICE;
477         f.subclass = AST_FORMAT_ADPCM;
478         f.datalen = sizeof(adpcm_slin_ex);
479         f.samples = sizeof(adpcm_slin_ex) * 2;
480         f.mallocd = 0;
481         f.offset = 0;
482         f.src = __PRETTY_FUNCTION__;
483         f.data = adpcm_slin_ex;
484         return &f;
485 }
486
487 /*
488  * LinToAdpcm_Sample
489  */
490
491 static struct ast_frame *lintoadpcm_sample(void)
492 {
493         static struct ast_frame f;
494         f.frametype = AST_FRAME_VOICE;
495         f.subclass = AST_FORMAT_SLINEAR;
496         f.datalen = sizeof(slin_adpcm_ex);
497         /* Assume 8000 Hz */
498         f.samples = sizeof(slin_adpcm_ex) / 2;
499         f.mallocd = 0;
500         f.offset = 0;
501         f.src = __PRETTY_FUNCTION__;
502         f.data = slin_adpcm_ex;
503         return &f;
504 }
505
506 /*
507  * Adpcm_Destroy
508  *  Destroys a private workspace.
509  *
510  * Results:
511  *  It's gone!
512  *
513  * Side effects:
514  *  None.
515  */
516
517 static void adpcm_destroy(struct ast_translator_pvt *pvt)
518 {
519         free(pvt);
520         localusecnt--;
521         ast_update_use_count();
522 }
523
524 /*
525  * The complete translator for ADPCMToLin.
526  */
527
528 static struct ast_translator adpcmtolin = {
529         "adpcmtolin",
530         AST_FORMAT_ADPCM,
531         AST_FORMAT_SLINEAR,
532         adpcmtolin_new,
533         adpcmtolin_framein,
534         adpcmtolin_frameout,
535         adpcm_destroy,
536         /* NULL */
537         adpcmtolin_sample
538 };
539
540 /*
541  * The complete translator for LinToADPCM.
542  */
543
544 static struct ast_translator lintoadpcm = {
545         "lintoadpcm",
546         AST_FORMAT_SLINEAR,
547         AST_FORMAT_ADPCM,
548         lintoadpcm_new,
549         lintoadpcm_framein,
550         lintoadpcm_frameout,
551         adpcm_destroy,
552         /* NULL */
553         lintoadpcm_sample
554 };
555
556 static void parse_config(void)
557 {
558         struct ast_config *cfg;
559         struct ast_variable *var;
560         if ((cfg = ast_config_load("codecs.conf"))) {
561                 if ((var = ast_variable_browse(cfg, "plc"))) {
562                         while (var) {
563                                 if (!strcasecmp(var->name, "genericplc")) {
564                                         useplc = ast_true(var->value) ? 1 : 0;
565                                         if (option_verbose > 2)
566                                                 ast_verbose(VERBOSE_PREFIX_3 "codec_adpcm: %susing generic PLC\n", useplc ? "" : "not ");
567                                 }
568                                 var = var->next;
569                         }
570                 }
571                 ast_config_destroy(cfg);
572         }
573 }
574
575 int reload(void)
576 {
577         parse_config();
578         return 0;
579 }
580
581 int unload_module(void)
582 {
583         int res;
584         ast_mutex_lock(&localuser_lock);
585         res = ast_unregister_translator(&lintoadpcm);
586         if (!res)
587                 res = ast_unregister_translator(&adpcmtolin);
588         if (localusecnt)
589                 res = -1;
590         ast_mutex_unlock(&localuser_lock);
591         return res;
592 }
593
594 int load_module(void)
595 {
596         int res;
597         parse_config();
598         res = ast_register_translator(&adpcmtolin);
599         if (!res)
600                 res = ast_register_translator(&lintoadpcm);
601         else
602                 ast_unregister_translator(&adpcmtolin);
603         return res;
604 }
605
606 /*
607  * Return a description of this module.
608  */
609
610 char *description(void)
611 {
612         return tdesc;
613 }
614
615 int usecount(void)
616 {
617         int res;
618         STANDARD_USECOUNT(res);
619         return res;
620 }
621
622 char *key()
623 {
624         return ASTERISK_GPL_KEY;
625 }