ca2eb8ef08003644a71b3a8471f619defd9dbbba
[asterisk/asterisk.git] / codecs / codec_lpc10.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * The lpc10 code is from a library used by nautilus, modified to be a bit
9  * nicer to the compiler.
10  * See http://www.arl.wustl.edu/~jaf/ 
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 Translate between signed linear and LPC10 (Linear Predictor Code)
26  *
27  * \ingroup codecs
28  */
29
30 /*** MODULEINFO
31         <support_level>core</support_level>
32  ***/
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include "asterisk/translate.h"
39 #include "asterisk/config.h"
40 #include "asterisk/module.h"
41 #include "asterisk/utils.h"
42
43 #include "lpc10/lpc10.h"
44
45 /* Sample frame data */
46 #include "asterisk/slin.h"
47 #include "ex_lpc10.h"
48
49 /* We use a very strange format here...  I have no idea why...  The frames are 180
50    samples long, which isn't even an even number of milliseconds...  Not only that
51    but we hvae to waste two bits of each frame to keep them ending on a byte boundary
52    because the frames are 54 bits long */
53
54 #define LPC10_BYTES_IN_COMPRESSED_FRAME (LPC10_BITS_IN_COMPRESSED_FRAME + 7)/8
55
56 #define BUFFER_SAMPLES  8000
57
58 struct lpc10_coder_pvt {
59         union {
60                 struct lpc10_encoder_state *enc;
61                 struct lpc10_decoder_state *dec;
62         } lpc10;
63         /* Enough to store a full second */
64         short buf[BUFFER_SAMPLES];
65         int longer;
66 };
67
68 static int lpc10_enc_new(struct ast_trans_pvt *pvt)
69 {
70         struct lpc10_coder_pvt *tmp = pvt->pvt;
71
72         return (tmp->lpc10.enc = create_lpc10_encoder_state()) ? 0 : -1;
73 }
74
75 static int lpc10_dec_new(struct ast_trans_pvt *pvt)
76 {
77         struct lpc10_coder_pvt *tmp = pvt->pvt;
78
79         return (tmp->lpc10.dec = create_lpc10_decoder_state()) ? 0 : -1;
80 }
81
82 static void extract_bits(INT32 *bits, unsigned char *c)
83 {
84         int x;
85         for (x=0;x<LPC10_BITS_IN_COMPRESSED_FRAME;x++) {
86                 if (*c & (0x80 >> (x & 7)))
87                         bits[x] = 1;
88                 else
89                         bits[x] = 0;
90                 if ((x & 7) == 7)
91                         c++;
92         }
93 }
94
95 /* XXX note lpc10_encode() produces one bit per word in bits[] */
96 static void build_bits(unsigned char *c, INT32 *bits)
97 {
98         unsigned char mask=0x80;
99         int x;
100         *c = 0;
101         for (x=0;x<LPC10_BITS_IN_COMPRESSED_FRAME;x++) {
102                 if (bits[x])
103                         *c |= mask;
104                 mask = mask >> 1;
105                 if ((x % 8)==7) {
106                         c++;
107                         *c = 0;
108                         mask = 0x80;
109                 }
110         }
111 }
112
113 static int lpc10tolin_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
114 {
115         struct lpc10_coder_pvt *tmp = pvt->pvt;
116         int16_t *dst = pvt->outbuf.i16;
117         int len = 0;
118
119         while (len + LPC10_BYTES_IN_COMPRESSED_FRAME <= f->datalen) {
120                 int x;
121                 float tmpbuf[LPC10_SAMPLES_PER_FRAME];
122                 INT32 bits[LPC10_BITS_IN_COMPRESSED_FRAME]; /* XXX see note */
123                 if (pvt->samples + LPC10_SAMPLES_PER_FRAME > BUFFER_SAMPLES) {
124                         ast_log(LOG_WARNING, "Out of buffer space\n");
125                         return -1;
126                 }
127                 extract_bits(bits, f->data.ptr + len);
128                 if (lpc10_decode(bits, tmpbuf, tmp->lpc10.dec)) {
129                         ast_log(LOG_WARNING, "Invalid lpc10 data\n");
130                         return -1;
131                 }
132                 for (x=0;x<LPC10_SAMPLES_PER_FRAME;x++) {
133                         /* Convert to a short between -1.0 and 1.0 */
134                         dst[pvt->samples + x] = (int16_t)(32768.0 * tmpbuf[x]);
135                 }
136
137                 pvt->samples += LPC10_SAMPLES_PER_FRAME;
138                 pvt->datalen += 2*LPC10_SAMPLES_PER_FRAME;
139                 len += LPC10_BYTES_IN_COMPRESSED_FRAME;
140         }
141         if (len != f->datalen) 
142                 printf("Decoded %d, expected %d\n", len, f->datalen);
143         return 0;
144 }
145
146 static int lintolpc10_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
147 {
148         struct lpc10_coder_pvt *tmp = pvt->pvt;
149
150         /* Just add the frames to our stream */
151         if (pvt->samples + f->samples > BUFFER_SAMPLES) {
152                 ast_log(LOG_WARNING, "Out of buffer space\n");
153                 return -1;
154         }
155         memcpy(tmp->buf + pvt->samples, f->data.ptr, f->datalen);
156         pvt->samples += f->samples;
157         return 0;
158 }
159
160 static struct ast_frame *lintolpc10_frameout(struct ast_trans_pvt *pvt)
161 {
162         struct lpc10_coder_pvt *tmp = pvt->pvt;
163         int x;
164         int datalen = 0;        /* output frame */
165         int samples = 0;        /* output samples */
166         float tmpbuf[LPC10_SAMPLES_PER_FRAME];
167         INT32 bits[LPC10_BITS_IN_COMPRESSED_FRAME];     /* XXX what ??? */
168         /* We can't work on anything less than a frame in size */
169         if (pvt->samples < LPC10_SAMPLES_PER_FRAME)
170                 return NULL;
171         while (pvt->samples >=  LPC10_SAMPLES_PER_FRAME) {
172                 /* Encode a frame of data */
173                 for (x=0;x<LPC10_SAMPLES_PER_FRAME;x++)
174                         tmpbuf[x] = (float)tmp->buf[x + samples] / 32768.0;
175                 lpc10_encode(tmpbuf, bits, tmp->lpc10.enc);
176                 build_bits(pvt->outbuf.uc + datalen, bits);
177                 datalen += LPC10_BYTES_IN_COMPRESSED_FRAME;
178                 samples += LPC10_SAMPLES_PER_FRAME;
179                 pvt->samples -= LPC10_SAMPLES_PER_FRAME;
180                 /* Use one of the two left over bits to record if this is a 22 or 23 ms frame...
181                    important for IAX use */
182                 tmp->longer = 1 - tmp->longer;
183         }
184         /* Move the data at the end of the buffer to the front */
185         if (pvt->samples)
186                 memmove(tmp->buf, tmp->buf + samples, pvt->samples * 2);
187         return ast_trans_frameout(pvt, datalen, samples);
188 }
189
190
191 static void lpc10_destroy(struct ast_trans_pvt *arg)
192 {
193         struct lpc10_coder_pvt *pvt = arg->pvt;
194         /* Enc and DEC are both just allocated, so they can be freed */
195         ast_free(pvt->lpc10.enc);
196 }
197
198 static struct ast_translator lpc10tolin = {
199         .name = "lpc10tolin",
200         .src_codec = {
201                 .name = "lpc10",
202                 .type = AST_MEDIA_TYPE_AUDIO,
203                 .sample_rate = 8000,
204         },
205         .dst_codec = {
206                 .name = "slin",
207                 .type = AST_MEDIA_TYPE_AUDIO,
208                 .sample_rate = 8000,
209         },
210         .format = "slin",
211         .newpvt = lpc10_dec_new,
212         .framein = lpc10tolin_framein,
213         .destroy = lpc10_destroy,
214         .sample = lpc10_sample,
215         .desc_size = sizeof(struct lpc10_coder_pvt),
216         .buffer_samples = BUFFER_SAMPLES,
217         .buf_size = BUFFER_SAMPLES * 2,
218 };
219
220 static struct ast_translator lintolpc10 = {
221         .name = "lintolpc10",
222         .src_codec = {
223                 .name = "slin",
224                 .type = AST_MEDIA_TYPE_AUDIO,
225                 .sample_rate = 8000,
226         },
227         .dst_codec = {
228                 .name = "lpc10",
229                 .type = AST_MEDIA_TYPE_AUDIO,
230                 .sample_rate = 8000,
231         },
232         .format = "lpc10",
233         .newpvt = lpc10_enc_new,
234         .framein = lintolpc10_framein,
235         .frameout = lintolpc10_frameout,
236         .destroy = lpc10_destroy,
237         .sample = slin8_sample,
238         .desc_size = sizeof(struct lpc10_coder_pvt),
239         .buffer_samples = BUFFER_SAMPLES,
240         .buf_size = LPC10_BYTES_IN_COMPRESSED_FRAME * (1 + BUFFER_SAMPLES / LPC10_SAMPLES_PER_FRAME),
241 };
242
243 static int unload_module(void)
244 {
245         int res;
246
247         res = ast_unregister_translator(&lintolpc10);
248         res |= ast_unregister_translator(&lpc10tolin);
249
250         return res;
251 }
252
253 static int load_module(void)
254 {
255         int res;
256
257         res = ast_register_translator(&lpc10tolin);
258         res |= ast_register_translator(&lintolpc10);
259
260         if (res) {
261                 unload_module();
262                 return AST_MODULE_LOAD_FAILURE;
263         }
264
265         return AST_MODULE_LOAD_SUCCESS;
266 }
267
268 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "LPC10 2.4kbps Coder/Decoder",
269                 .support_level = AST_MODULE_SUPPORT_CORE,
270                 .load = load_module,
271                 .unload = unload_module,
272                );