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