git migration: Refactor the ASTERISK_FILE_VERSION macro
[asterisk/asterisk.git] / codecs / codec_ilbc.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * The iLBC code is from The IETF code base and is copyright The Internet Society (2004)
5  *
6  * Copyright (C) 1999 - 2005, Digium, Inc.
7  *
8  * Mark Spencer <markster@digium.com>
9  *
10  * See http://www.asterisk.org for more information about
11  * the Asterisk project. Please do not directly contact
12  * any of the maintainers of this project for assistance;
13  * the project provides a web site, mailing lists and IRC
14  * channels for your use.
15  *
16  * This program is free software, distributed under the terms of
17  * the GNU General Public License Version 2. See the LICENSE file
18  * at the top of the source tree.
19  */
20
21 /*! \file
22  *
23  * \brief Translate between signed linear and Internet Low Bitrate Codec
24  *
25  * \ingroup codecs
26  */
27
28 /*** MODULEINFO
29         <use>ilbc</use>
30         <support_level>core</support_level>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_REGISTER_FILE()
36
37 #include "asterisk/translate.h"
38 #include "asterisk/module.h"
39 #include "asterisk/utils.h"
40
41 #ifdef ILBC_WEBRTC
42 #include <ilbc.h>
43 typedef WebRtc_UWord16 ilbc_bytes;
44 typedef WebRtc_Word16  ilbc_block;
45 #define BUF_TYPE i16
46 #else
47 #include "ilbc/iLBC_encode.h"
48 #include "ilbc/iLBC_decode.h"
49 typedef unsigned char ilbc_bytes;
50 typedef float         ilbc_block;
51 #define BUF_TYPE uc
52 #endif
53
54 #define USE_ILBC_ENHANCER       0
55 #define ILBC_MS                         30
56 /* #define ILBC_MS                      20 */
57
58 #define ILBC_FRAME_LEN  50      /* apparently... */
59 #define ILBC_SAMPLES    240     /* 30ms at 8000 hz */
60 #define BUFFER_SAMPLES  8000
61
62 /* Sample frame data */
63 #include "asterisk/slin.h"
64 #include "ex_ilbc.h"
65
66 struct ilbc_coder_pvt {
67         iLBC_Enc_Inst_t enc;
68         iLBC_Dec_Inst_t dec;
69         /* Enough to store a full second */
70         int16_t buf[BUFFER_SAMPLES];
71 };
72
73 static int lintoilbc_new(struct ast_trans_pvt *pvt)
74 {
75         struct ilbc_coder_pvt *tmp = pvt->pvt;
76
77         initEncode(&tmp->enc, ILBC_MS);
78
79         return 0;
80 }
81
82 static int ilbctolin_new(struct ast_trans_pvt *pvt)
83 {
84         struct ilbc_coder_pvt *tmp = pvt->pvt;
85
86         initDecode(&tmp->dec, ILBC_MS, USE_ILBC_ENHANCER);
87
88         return 0;
89 }
90
91 /*! \brief decode a frame and store in outbuf */
92 static int ilbctolin_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
93 {
94         struct ilbc_coder_pvt *tmp = pvt->pvt;
95         int plc_mode = 1; /* 1 = normal data, 0 = plc */
96         /* Assuming there's space left, decode into the current buffer at
97            the tail location.  Read in as many frames as there are */
98         int x,i;
99         int datalen = f->datalen;
100         int16_t *dst = pvt->outbuf.i16;
101         ilbc_block tmpf[ILBC_SAMPLES];
102
103         if (!f->data.ptr && datalen) {
104                 ast_debug(1, "issue 16070, ILIB ERROR. data = NULL datalen = %d src = %s\n", datalen, f->src ? f->src : "no src set");
105                 f->datalen = 0;
106                 datalen = 0;
107         }
108
109         if (datalen == 0) { /* native PLC, set fake datalen and clear plc_mode */
110                 datalen = ILBC_FRAME_LEN;
111                 f->samples = ILBC_SAMPLES;
112                 plc_mode = 0;   /* do native plc */
113                 pvt->samples += ILBC_SAMPLES;
114         }
115
116         if (datalen % ILBC_FRAME_LEN) {
117                 ast_log(LOG_WARNING, "Huh?  An ilbc frame that isn't a multiple of 50 bytes long from %s (%d)?\n", f->src, datalen);
118                 return -1;
119         }
120
121         for (x=0; x < datalen ; x += ILBC_FRAME_LEN) {
122                 if (pvt->samples + ILBC_SAMPLES > BUFFER_SAMPLES) {
123                         ast_log(LOG_WARNING, "Out of buffer space\n");
124                         return -1;
125                 }
126                 iLBC_decode(tmpf, plc_mode ? f->data.ptr + x : NULL, &tmp->dec, plc_mode);
127                 for ( i=0; i < ILBC_SAMPLES; i++)
128                         dst[pvt->samples + i] = tmpf[i];
129                 pvt->samples += ILBC_SAMPLES;
130                 pvt->datalen += 2*ILBC_SAMPLES;
131         }
132         return 0;
133 }
134
135 /*! \brief store a frame into a temporary buffer, for later decoding */
136 static int lintoilbc_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
137 {
138         struct ilbc_coder_pvt *tmp = pvt->pvt;
139
140         /* Just add the frames to our stream */
141         /* XXX We should look at how old the rest of our stream is, and if it
142            is too old, then we should overwrite it entirely, otherwise we can
143            get artifacts of earlier talk that do not belong */
144         memcpy(tmp->buf + pvt->samples, f->data.ptr, f->datalen);
145         pvt->samples += f->samples;
146         return 0;
147 }
148
149 /*! \brief encode the temporary buffer and generate a frame */
150 static struct ast_frame *lintoilbc_frameout(struct ast_trans_pvt *pvt)
151 {
152         struct ilbc_coder_pvt *tmp = pvt->pvt;
153         int datalen = 0;
154         int samples = 0;
155
156         /* We can't work on anything less than a frame in size */
157         if (pvt->samples < ILBC_SAMPLES)
158                 return NULL;
159         while (pvt->samples >= ILBC_SAMPLES) {
160                 ilbc_block tmpf[ILBC_SAMPLES];
161                 int i;
162
163                 /* Encode a frame of data */
164                 for (i = 0 ; i < ILBC_SAMPLES ; i++)
165                         tmpf[i] = tmp->buf[samples + i];
166                 iLBC_encode( (ilbc_bytes*)pvt->outbuf.BUF_TYPE + datalen, tmpf, &tmp->enc);
167
168                 datalen += ILBC_FRAME_LEN;
169                 samples += ILBC_SAMPLES;
170                 pvt->samples -= ILBC_SAMPLES;
171         }
172
173         /* Move the data at the end of the buffer to the front */
174         if (pvt->samples)
175                 memmove(tmp->buf, tmp->buf + samples, pvt->samples * 2);
176
177         return ast_trans_frameout(pvt, datalen, samples);
178 }
179
180 static struct ast_translator ilbctolin = {
181         .name = "ilbctolin",
182         .src_codec = {
183                 .name = "ilbc",
184                 .type = AST_MEDIA_TYPE_AUDIO,
185                 .sample_rate = 8000,
186         },
187         .dst_codec = {
188                 .name = "slin",
189                 .type = AST_MEDIA_TYPE_AUDIO,
190                 .sample_rate = 8000,
191         },
192         .format = "slin",
193         .newpvt = ilbctolin_new,
194         .framein = ilbctolin_framein,
195         .sample = ilbc_sample,
196         .desc_size = sizeof(struct ilbc_coder_pvt),
197         .buf_size = BUFFER_SAMPLES * 2,
198         .native_plc = 1,
199 };
200
201 static struct ast_translator lintoilbc = {
202         .name = "lintoilbc",
203         .src_codec = {
204                 .name = "slin",
205                 .type = AST_MEDIA_TYPE_AUDIO,
206                 .sample_rate = 8000,
207         },
208         .dst_codec = {
209                 .name = "ilbc",
210                 .type = AST_MEDIA_TYPE_AUDIO,
211                 .sample_rate = 8000,
212         },
213         .format = "ilbc",
214         .newpvt = lintoilbc_new,
215         .framein = lintoilbc_framein,
216         .frameout = lintoilbc_frameout,
217         .sample = slin8_sample,
218         .desc_size = sizeof(struct ilbc_coder_pvt),
219         .buf_size = (BUFFER_SAMPLES * ILBC_FRAME_LEN + ILBC_SAMPLES - 1) / ILBC_SAMPLES,
220 };
221
222 static int unload_module(void)
223 {
224         int res;
225
226         res = ast_unregister_translator(&lintoilbc);
227         res |= ast_unregister_translator(&ilbctolin);
228
229         return res;
230 }
231
232 static int load_module(void)
233 {
234         int res;
235
236         res = ast_register_translator(&ilbctolin);
237         res |= ast_register_translator(&lintoilbc);
238
239         if (res) {
240                 unload_module();
241                 return AST_MODULE_LOAD_FAILURE;
242         }
243
244         return AST_MODULE_LOAD_SUCCESS;
245 }
246
247 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "iLBC Coder/Decoder");