merge rizzo's codec module rework (very similar to the format module rework)
[asterisk/asterisk.git] / codecs / codec_gsm.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * The GSM code is from TOAST.  Copyright information for that package is available
5  * in the GSM directory.
6  *
7  * Copyright (C) 1999 - 2005, Digium, Inc.
8  *
9  * Mark Spencer <markster@digium.com>
10  *
11  * See http://www.asterisk.org for more information about
12  * the Asterisk project. Please do not directly contact
13  * any of the maintainers of this project for assistance;
14  * the project provides a web site, mailing lists and IRC
15  * channels for your use.
16  *
17  * This program is free software, distributed under the terms of
18  * the GNU General Public License Version 2. See the LICENSE file
19  * at the top of the source tree.
20  */
21
22 /*! \file
23  *
24  * \brief Translate between signed linear and Global System for Mobile Communications (GSM)
25  *
26  * \ingroup codecs
27  */
28
29 #include <fcntl.h>
30 #include <stdlib.h>
31 #include <unistd.h>
32 #include <netinet/in.h>
33 #include <string.h>
34 #include <stdio.h>
35
36 #include "asterisk.h"
37
38 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
39
40 #include "asterisk/lock.h"
41 #include "asterisk/translate.h"
42 #include "asterisk/config.h"
43 #include "asterisk/options.h"
44 #include "asterisk/module.h"
45 #include "asterisk/logger.h"
46 #include "asterisk/channel.h"
47 #include "asterisk/utils.h"
48
49 #ifdef USE_EXTERNAL_GSM_LIB
50 #include <gsm/gsm.h>
51 #else
52 #include "gsm/inc/gsm.h"
53 #endif
54
55 #include "../formats/msgsm.h"
56
57 /* Sample frame data */
58 #include "slin_gsm_ex.h"
59 #include "gsm_slin_ex.h"
60
61 #define BUFFER_SAMPLES  8000
62 #define GSM_SAMPLES     160
63 #define GSM_FRAME_LEN   33
64 #define MSGSM_FRAME_LEN 65
65
66 struct gsm_translator_pvt {     /* both gsm2lin and lin2gsm */
67         gsm gsm;
68         int16_t buf[BUFFER_SAMPLES];    /* lin2gsm, temporary storage */
69 };
70
71 static void *gsm_new(struct ast_trans_pvt *pvt)
72 {
73         struct gsm_translator_pvt *tmp = pvt->pvt;
74         
75         if (!(tmp->gsm = gsm_create()))
76                 return NULL;
77         return tmp;
78 }
79
80 static struct ast_frame *lintogsm_sample(void)
81 {
82         static struct ast_frame f;
83         f.frametype = AST_FRAME_VOICE;
84         f.subclass = AST_FORMAT_SLINEAR;
85         f.datalen = sizeof(slin_gsm_ex);
86         /* Assume 8000 Hz */
87         f.samples = sizeof(slin_gsm_ex)/2;
88         f.mallocd = 0;
89         f.offset = 0;
90         f.src = __PRETTY_FUNCTION__;
91         f.data = slin_gsm_ex;
92         return &f;
93 }
94
95 static struct ast_frame *gsmtolin_sample(void)
96 {
97         static struct ast_frame f;
98         f.frametype = AST_FRAME_VOICE;
99         f.subclass = AST_FORMAT_GSM;
100         f.datalen = sizeof(gsm_slin_ex);
101         /* All frames are 20 ms long */
102         f.samples = GSM_SAMPLES;
103         f.mallocd = 0;
104         f.offset = 0;
105         f.src = __PRETTY_FUNCTION__;
106         f.data = gsm_slin_ex;
107         return &f;
108 }
109
110 /*! \brief decode and store in outbuf. */
111 static int gsmtolin_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
112 {
113         struct gsm_translator_pvt *tmp = pvt->pvt;
114         int x;
115         int16_t *dst = (int16_t *)pvt->outbuf;
116         /* guess format from frame len. 65 for MSGSM, 33 for regular GSM */
117         int flen = (f->datalen % MSGSM_FRAME_LEN == 0) ?
118                 MSGSM_FRAME_LEN : GSM_FRAME_LEN;
119
120         for (x=0; x < f->datalen; x += flen) {
121                 unsigned char data[2 * GSM_FRAME_LEN];
122                 char *src;
123                 int len;
124                 if (flen == MSGSM_FRAME_LEN) {
125                         len = 2*GSM_SAMPLES;
126                         src = data;
127                         /* Translate MSGSM format to Real GSM format before feeding in */
128                         /* XXX what's the point here! we should just work
129                          * on the full format.
130                          */
131                         conv65(f->data + x, data);
132                 } else {
133                         len = GSM_SAMPLES;
134                         src = f->data + x;
135                 }
136                 /* XXX maybe we don't need to check */
137                 if (pvt->samples + len > BUFFER_SAMPLES) {      
138                         ast_log(LOG_WARNING, "Out of buffer space\n");
139                         return -1;
140                 }
141                 if (gsm_decode(tmp->gsm, src, dst + pvt->samples)) {
142                         ast_log(LOG_WARNING, "Invalid GSM data (1)\n");
143                         return -1;
144                 }
145                 pvt->samples += GSM_SAMPLES;
146                 pvt->datalen += 2 * GSM_SAMPLES;
147                 if (flen == MSGSM_FRAME_LEN) {
148                         if (gsm_decode(tmp->gsm, data + GSM_FRAME_LEN, dst + pvt->samples)) {
149                                 ast_log(LOG_WARNING, "Invalid GSM data (2)\n");
150                                 return -1;
151                         }
152                         pvt->samples += GSM_SAMPLES;
153                         pvt->datalen += 2 * GSM_SAMPLES;
154                 }
155         }
156         return 0;
157 }
158
159 /*! \brief store samples into working buffer for later decode */
160 static int lintogsm_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
161 {
162         struct gsm_translator_pvt *tmp = pvt->pvt;
163
164         /* XXX We should look at how old the rest of our stream is, and if it
165            is too old, then we should overwrite it entirely, otherwise we can
166            get artifacts of earlier talk that do not belong */
167         if (pvt->samples + f->samples > BUFFER_SAMPLES) {
168                 ast_log(LOG_WARNING, "Out of buffer space\n");
169                 return -1;
170         }
171         memcpy(tmp->buf + pvt->samples, f->data, f->datalen);
172         pvt->samples += f->samples;
173         return 0;
174 }
175
176 /*! \brief encode and produce a frame */
177 static struct ast_frame *lintogsm_frameout(struct ast_trans_pvt *pvt)
178 {
179         struct gsm_translator_pvt *tmp = pvt->pvt;
180         int datalen = 0;
181         int samples = 0;
182
183         /* We can't work on anything less than a frame in size */
184         if (pvt->samples < GSM_SAMPLES)
185                 return NULL;
186         while (pvt->samples >= GSM_SAMPLES) {
187                 /* Encode a frame of data */
188                 gsm_encode(tmp->gsm, tmp->buf, (gsm_byte *)pvt->outbuf + datalen);
189                 datalen += GSM_FRAME_LEN;
190                 samples += GSM_SAMPLES;
191                 pvt->samples -= GSM_SAMPLES;
192                 /* Move the data at the end of the buffer to the front */
193                 if (pvt->samples)
194                         memmove(tmp->buf, tmp->buf + GSM_SAMPLES, pvt->samples * 2);
195         }
196         return ast_trans_frameout(pvt, datalen, samples);
197 }
198
199 static void gsm_destroy_stuff(struct ast_trans_pvt *pvt)
200 {
201         struct gsm_translator_pvt *tmp = pvt->pvt;
202         if (tmp->gsm)
203                 gsm_destroy(tmp->gsm);
204 }
205
206 static struct ast_module_lock me = { .usecnt = -1 };
207
208 static struct ast_translator gsmtolin = {
209         .name = "gsmtolin", 
210         .srcfmt = AST_FORMAT_GSM,
211         .dstfmt = AST_FORMAT_SLINEAR,
212         .newpvt = gsm_new,
213         .framein = gsmtolin_framein,
214         .destroy = gsm_destroy_stuff,
215         .sample = gsmtolin_sample,
216         .lockp = &me,
217         .buffer_samples = BUFFER_SAMPLES,
218         .buf_size = BUFFER_SAMPLES * 2,
219         .desc_size = sizeof (struct gsm_translator_pvt ),
220         .plc_samples = GSM_SAMPLES,
221 };
222
223 static struct ast_translator lintogsm = {
224         .name = "lintogsm", 
225         .srcfmt = AST_FORMAT_SLINEAR,
226         .dstfmt = AST_FORMAT_GSM,
227         .newpvt = gsm_new,
228         .framein = lintogsm_framein,
229         .frameout = lintogsm_frameout,
230         .destroy = gsm_destroy_stuff,
231         .sample = lintogsm_sample,
232         .lockp = &me,
233         .desc_size = sizeof (struct gsm_translator_pvt ),
234         .buf_size = (BUFFER_SAMPLES * GSM_FRAME_LEN + GSM_SAMPLES - 1)/GSM_SAMPLES,
235 };
236
237
238 static void parse_config(void)
239 {
240         struct ast_variable *var;
241         struct ast_config *cfg = ast_config_load("codecs.conf");
242         if (!cfg)
243                 return;
244         for (var = ast_variable_browse(cfg, "plc"); var; var = var->next) {
245                if (!strcasecmp(var->name, "genericplc")) {
246                        gsmtolin.useplc = ast_true(var->value) ? 1 : 0;
247                        if (option_verbose > 2)
248                                ast_verbose(VERBOSE_PREFIX_3 "codec_gsm: %susing generic PLC\n", gsmtolin.useplc ? "" : "not ");
249                }
250         }
251         ast_config_destroy(cfg);
252 }
253
254 /*! \brief standard module glue */
255 int reload(void)
256 {
257         parse_config();
258         return 0;
259 }
260
261 int unload_module(void)
262 {
263         int res;
264         ast_mutex_lock(&me.lock);
265         res = ast_unregister_translator(&lintogsm);
266         if (!res)
267                 res = ast_unregister_translator(&gsmtolin);
268         if (me.usecnt)
269                 res = -1;
270         ast_mutex_unlock(&me.lock);
271         return res;
272 }
273
274 int load_module(void)
275 {
276         int res;
277         parse_config();
278         res=ast_register_translator(&gsmtolin);
279         if (!res) 
280                 res=ast_register_translator(&lintogsm);
281         else
282                 ast_unregister_translator(&gsmtolin);
283         return res;
284 }
285
286 char *description(void)
287 {
288         return "GSM/PCM16 (signed linear) Codec Translator";
289 }
290
291 int usecount(void)
292 {
293         return me.usecnt;
294 }
295
296 char *key()
297 {
298         return ASTERISK_GPL_KEY;
299 }