res_parking: Misc fixes.
[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 /*** MODULEINFO
30         <depend>gsm</depend>
31         <support_level>core</support_level>
32  ***/
33
34 #include "asterisk.h"
35
36 ASTERISK_REGISTER_FILE()
37
38 #include "asterisk/translate.h"
39 #include "asterisk/config.h"
40 #include "asterisk/module.h"
41 #include "asterisk/utils.h"
42 #include "asterisk/linkedlists.h"
43
44 #ifdef HAVE_GSM_HEADER
45 #include "gsm.h"
46 #elif defined(HAVE_GSM_GSM_HEADER)
47 #include <gsm/gsm.h>
48 #endif
49
50 #include "../formats/msgsm.h"
51
52 #define BUFFER_SAMPLES  8000
53 #define GSM_SAMPLES     160
54 #define GSM_FRAME_LEN   33
55 #define MSGSM_FRAME_LEN 65
56
57 /* Sample frame data */
58 #include "asterisk/slin.h"
59 #include "ex_gsm.h"
60
61 struct gsm_translator_pvt {     /* both gsm2lin and lin2gsm */
62         gsm gsm;
63         int16_t buf[BUFFER_SAMPLES];    /* lin2gsm, temporary storage */
64 };
65
66 static int gsm_new(struct ast_trans_pvt *pvt)
67 {
68         struct gsm_translator_pvt *tmp = pvt->pvt;
69         
70         return (tmp->gsm = gsm_create()) ? 0 : -1;
71 }
72
73 /*! \brief decode and store in outbuf. */
74 static int gsmtolin_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
75 {
76         struct gsm_translator_pvt *tmp = pvt->pvt;
77         int x;
78         int16_t *dst = pvt->outbuf.i16;
79         /* guess format from frame len. 65 for MSGSM, 33 for regular GSM */
80         int flen = (f->datalen % MSGSM_FRAME_LEN == 0) ?
81                 MSGSM_FRAME_LEN : GSM_FRAME_LEN;
82
83         for (x=0; x < f->datalen; x += flen) {
84                 unsigned char data[2 * GSM_FRAME_LEN];
85                 unsigned char *src;
86                 int len;
87                 if (flen == MSGSM_FRAME_LEN) {
88                         len = 2*GSM_SAMPLES;
89                         src = data;
90                         /* Translate MSGSM format to Real GSM format before feeding in */
91                         /* XXX what's the point here! we should just work
92                          * on the full format.
93                          */
94                         conv65(f->data.ptr + x, data);
95                 } else {
96                         len = GSM_SAMPLES;
97                         src = f->data.ptr + x;
98                 }
99                 /* XXX maybe we don't need to check */
100                 if (pvt->samples + len > BUFFER_SAMPLES) {      
101                         ast_log(LOG_WARNING, "Out of buffer space\n");
102                         return -1;
103                 }
104                 if (gsm_decode(tmp->gsm, src, dst + pvt->samples)) {
105                         ast_log(LOG_WARNING, "Invalid GSM data (1)\n");
106                         return -1;
107                 }
108                 pvt->samples += GSM_SAMPLES;
109                 pvt->datalen += 2 * GSM_SAMPLES;
110                 if (flen == MSGSM_FRAME_LEN) {
111                         if (gsm_decode(tmp->gsm, data + GSM_FRAME_LEN, dst + pvt->samples)) {
112                                 ast_log(LOG_WARNING, "Invalid GSM data (2)\n");
113                                 return -1;
114                         }
115                         pvt->samples += GSM_SAMPLES;
116                         pvt->datalen += 2 * GSM_SAMPLES;
117                 }
118         }
119         return 0;
120 }
121
122 /*! \brief store samples into working buffer for later decode */
123 static int lintogsm_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
124 {
125         struct gsm_translator_pvt *tmp = pvt->pvt;
126
127         /* XXX We should look at how old the rest of our stream is, and if it
128            is too old, then we should overwrite it entirely, otherwise we can
129            get artifacts of earlier talk that do not belong */
130         if (pvt->samples + f->samples > BUFFER_SAMPLES) {
131                 ast_log(LOG_WARNING, "Out of buffer space\n");
132                 return -1;
133         }
134         memcpy(tmp->buf + pvt->samples, f->data.ptr, f->datalen);
135         pvt->samples += f->samples;
136         return 0;
137 }
138
139 /*! \brief encode and produce a frame */
140 static struct ast_frame *lintogsm_frameout(struct ast_trans_pvt *pvt)
141 {
142         struct gsm_translator_pvt *tmp = pvt->pvt;
143         struct ast_frame *result = NULL;
144         struct ast_frame *last = NULL;
145         int samples = 0; /* output samples */
146
147         while (pvt->samples >= GSM_SAMPLES) {
148                 struct ast_frame *current;
149
150                 /* Encode a frame of data */
151                 gsm_encode(tmp->gsm, tmp->buf + samples, (gsm_byte *) pvt->outbuf.c);
152                 samples += GSM_SAMPLES;
153                 pvt->samples -= GSM_SAMPLES;
154
155                 current = ast_trans_frameout(pvt, GSM_FRAME_LEN, GSM_SAMPLES);
156                 if (!current) {
157                         continue;
158                 } else if (last) {
159                         AST_LIST_NEXT(last, frame_list) = current;
160                 } else {
161                         result = current;
162                 }
163                 last = current;
164         }
165
166         /* Move the data at the end of the buffer to the front */
167         if (samples) {
168                 memmove(tmp->buf, tmp->buf + samples, pvt->samples * 2);
169         }
170
171         return result;
172 }
173
174 static void gsm_destroy_stuff(struct ast_trans_pvt *pvt)
175 {
176         struct gsm_translator_pvt *tmp = pvt->pvt;
177         if (tmp->gsm)
178                 gsm_destroy(tmp->gsm);
179 }
180
181 static struct ast_translator gsmtolin = {
182         .name = "gsmtolin",
183         .src_codec = {
184                 .name = "gsm",
185                 .type = AST_MEDIA_TYPE_AUDIO,
186                 .sample_rate = 8000,
187         },
188         .dst_codec = {
189                 .name = "slin",
190                 .type = AST_MEDIA_TYPE_AUDIO,
191                 .sample_rate = 8000,
192         },
193         .format = "slin",
194         .newpvt = gsm_new,
195         .framein = gsmtolin_framein,
196         .destroy = gsm_destroy_stuff,
197         .sample = gsm_sample,
198         .buffer_samples = BUFFER_SAMPLES,
199         .buf_size = BUFFER_SAMPLES * 2,
200         .desc_size = sizeof (struct gsm_translator_pvt ),
201 };
202
203 static struct ast_translator lintogsm = {
204         .name = "lintogsm",
205         .src_codec = {
206                 .name = "slin",
207                 .type = AST_MEDIA_TYPE_AUDIO,
208                 .sample_rate = 8000,
209         },
210         .dst_codec = {
211                 .name = "gsm",
212                 .type = AST_MEDIA_TYPE_AUDIO,
213                 .sample_rate = 8000,
214         },
215         .format = "gsm",
216         .newpvt = gsm_new,
217         .framein = lintogsm_framein,
218         .frameout = lintogsm_frameout,
219         .destroy = gsm_destroy_stuff,
220         .sample = slin8_sample,
221         .desc_size = sizeof (struct gsm_translator_pvt ),
222         .buf_size = (BUFFER_SAMPLES * GSM_FRAME_LEN + GSM_SAMPLES - 1)/GSM_SAMPLES,
223 };
224
225 static int unload_module(void)
226 {
227         int res;
228
229         res = ast_unregister_translator(&lintogsm);
230         res |= ast_unregister_translator(&gsmtolin);
231
232         return res;
233 }
234
235 static int load_module(void)
236 {
237         int res;
238
239         res = ast_register_translator(&gsmtolin);
240         res |= ast_register_translator(&lintogsm);
241
242         if (res) {
243                 unload_module();
244                 return AST_MODULE_LOAD_FAILURE;
245         }
246
247         return AST_MODULE_LOAD_SUCCESS;
248 }
249
250 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "GSM Coder/Decoder",
251         .support_level = AST_MODULE_SUPPORT_CORE,
252         .load = load_module,
253         .unload = unload_module,
254 );