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