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