Merge "resource_channels.c: add hangup reason "answered_elsewhere"."
[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/codec.h"             /* for AST_MEDIA_TYPE_AUDIO */
38 #include "asterisk/format.h"            /* for ast_format_get_attribute_data */
39 #include "asterisk/frame.h"             /* for ast_frame, etc */
40 #include "asterisk/linkedlists.h"       /* for AST_LIST_NEXT, etc */
41 #include "asterisk/logger.h"            /* for ast_log, ast_debug, etc */
42 #include "asterisk/module.h"
43 #include "asterisk/translate.h"         /* for ast_trans_pvt, etc */
44
45 #ifdef ILBC_WEBRTC
46 #include <ilbc.h>
47 typedef WebRtc_UWord16 ilbc_bytes;
48 typedef WebRtc_Word16  ilbc_block;
49 #define BUF_TYPE i16
50 #else
51 #include "ilbc/iLBC_encode.h"
52 #include "ilbc/iLBC_decode.h"
53 typedef unsigned char ilbc_bytes;
54 typedef float         ilbc_block;
55 #define BUF_TYPE uc
56 #endif
57
58 #include "asterisk/ilbc.h"
59
60 #define USE_ILBC_ENHANCER 0
61 #define BUFFER_SAMPLES    8000
62
63 /* Sample frame data */
64 #include "asterisk/slin.h"
65 #include "ex_ilbc.h"
66
67 struct ilbc_coder_pvt {
68         iLBC_Enc_Inst_t enc;
69         iLBC_Dec_Inst_t dec;
70         /* Enough to store a full second */
71         int16_t buf[BUFFER_SAMPLES];
72         int16_t inited;
73 };
74
75 static int lintoilbc_new(struct ast_trans_pvt *pvt)
76 {
77         struct ilbc_coder_pvt *tmp = pvt->pvt;
78         struct ilbc_attr *attr = pvt->explicit_dst ? ast_format_get_attribute_data(pvt->explicit_dst) : NULL;
79         const unsigned int mode = attr ? attr->mode : 30;
80
81         initEncode(&tmp->enc, mode);
82
83         return 0;
84 }
85
86 static int ilbctolin_new(struct ast_trans_pvt *pvt)
87 {
88         struct ilbc_coder_pvt *tmp = pvt->pvt;
89
90         tmp->inited = 0; /* we do not know the iLBC mode, yet */
91
92         return 0;
93 }
94
95 /*! \brief decode a frame and store in outbuf */
96 static int ilbctolin_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
97 {
98         struct ilbc_coder_pvt *tmp = pvt->pvt;
99         struct ilbc_attr *attr = ast_format_get_attribute_data(f->subclass.format);
100         const unsigned int mode = attr ? attr->mode : 30;
101         const unsigned int sample_rate = pvt->t->dst_codec.sample_rate;
102         const unsigned int samples_per_frame = mode * sample_rate / 1000;
103         const unsigned int octets_per_frame = (mode == 20) ? 38 : 50;
104
105         int plc_mode = 1; /* 1 = normal data, 0 = plc */
106         /* Assuming there's space left, decode into the current buffer at
107            the tail location.  Read in as many frames as there are */
108         int x,i;
109         int datalen = f->datalen;
110         int16_t *dst = pvt->outbuf.i16;
111         ilbc_block tmpf[samples_per_frame];
112
113         if (!f->data.ptr && datalen) {
114                 ast_debug(1, "issue 16070, ILIB ERROR. data = NULL datalen = %d src = %s\n", datalen, f->src ? f->src : "no src set");
115                 f->datalen = 0;
116                 datalen = 0;
117         }
118
119         if (datalen == 0) { /* native PLC, set fake datalen and clear plc_mode */
120                 datalen = octets_per_frame;
121                 f->samples = samples_per_frame;
122                 plc_mode = 0;   /* do native plc */
123                 pvt->samples += samples_per_frame;
124         }
125
126         if (datalen % octets_per_frame) {
127                 ast_log(LOG_WARNING, "Huh?  An ilbc frame that isn't a multiple of %u bytes long from %s (%d)?\n", octets_per_frame, f->src, datalen);
128                 return -1;
129         }
130
131         if (!tmp->inited) {
132                 initDecode(&tmp->dec, mode, USE_ILBC_ENHANCER);
133                 tmp->inited = 1;
134         }
135
136         for (x = 0; x < datalen; x += octets_per_frame) {
137                 if (pvt->samples + samples_per_frame > BUFFER_SAMPLES) {
138                         ast_log(LOG_WARNING, "Out of buffer space\n");
139                         return -1;
140                 }
141                 iLBC_decode(tmpf, plc_mode ? f->data.ptr + x : NULL, &tmp->dec, plc_mode);
142                 for (i = 0; i < samples_per_frame; i++)
143                         dst[pvt->samples + i] = tmpf[i];
144                 pvt->samples += samples_per_frame;
145                 pvt->datalen += samples_per_frame * 2;
146         }
147         return 0;
148 }
149
150 /*! \brief store a frame into a temporary buffer, for later decoding */
151 static int lintoilbc_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
152 {
153         struct ilbc_coder_pvt *tmp = pvt->pvt;
154
155         /* Just add the frames to our stream */
156         /* XXX We should look at how old the rest of our stream is, and if it
157            is too old, then we should overwrite it entirely, otherwise we can
158            get artifacts of earlier talk that do not belong */
159         memcpy(tmp->buf + pvt->samples, f->data.ptr, f->datalen);
160         pvt->samples += f->samples;
161         return 0;
162 }
163
164 /*! \brief encode the temporary buffer and generate a frame */
165 static struct ast_frame *lintoilbc_frameout(struct ast_trans_pvt *pvt)
166 {
167         struct ilbc_coder_pvt *tmp = pvt->pvt;
168         struct ast_frame *result = NULL;
169         struct ast_frame *last = NULL;
170         int samples = 0; /* output samples */
171
172         struct ilbc_attr *attr = ast_format_get_attribute_data(pvt->f.subclass.format);
173         const unsigned int mode = attr ? attr->mode : 30;
174         const unsigned int sample_rate = pvt->t->dst_codec.sample_rate;
175         const unsigned int samples_per_frame = mode * sample_rate / 1000;
176         const unsigned int octets_per_frame = (mode == 20) ? 38 : 50;
177
178         while (pvt->samples >= samples_per_frame) {
179                 struct ast_frame *current;
180                 ilbc_block tmpf[samples_per_frame];
181                 int i;
182
183                 /* Encode a frame of data */
184                 for (i = 0; i < samples_per_frame; i++)
185                         tmpf[i] = tmp->buf[samples + i];
186                 iLBC_encode((ilbc_bytes *) pvt->outbuf.BUF_TYPE, tmpf, &tmp->enc);
187
188                 samples += samples_per_frame;
189                 pvt->samples -= samples_per_frame;
190
191                 current = ast_trans_frameout(pvt, octets_per_frame, samples_per_frame);
192                 if (!current) {
193                         continue;
194                 } else if (last) {
195                         AST_LIST_NEXT(last, frame_list) = current;
196                 } else {
197                         result = current;
198                 }
199                 last = current;
200         }
201
202         /* Move the data at the end of the buffer to the front */
203         if (samples) {
204                 memmove(tmp->buf, tmp->buf + samples, pvt->samples * 2);
205         }
206
207         return result;
208 }
209
210 static struct ast_translator ilbctolin = {
211         .name = "ilbctolin",
212         .src_codec = {
213                 .name = "ilbc",
214                 .type = AST_MEDIA_TYPE_AUDIO,
215                 .sample_rate = 8000,
216         },
217         .dst_codec = {
218                 .name = "slin",
219                 .type = AST_MEDIA_TYPE_AUDIO,
220                 .sample_rate = 8000,
221         },
222         .format = "slin",
223         .newpvt = ilbctolin_new,
224         .framein = ilbctolin_framein,
225         .sample = ilbc_sample,
226         .desc_size = sizeof(struct ilbc_coder_pvt),
227         .buf_size = BUFFER_SAMPLES * 2,
228         .native_plc = 1,
229 };
230
231 static struct ast_translator lintoilbc = {
232         .name = "lintoilbc",
233         .src_codec = {
234                 .name = "slin",
235                 .type = AST_MEDIA_TYPE_AUDIO,
236                 .sample_rate = 8000,
237         },
238         .dst_codec = {
239                 .name = "ilbc",
240                 .type = AST_MEDIA_TYPE_AUDIO,
241                 .sample_rate = 8000,
242         },
243         .format = "ilbc",
244         .newpvt = lintoilbc_new,
245         .framein = lintoilbc_framein,
246         .frameout = lintoilbc_frameout,
247         .sample = slin8_sample,
248         .desc_size = sizeof(struct ilbc_coder_pvt),
249         /* frame len (38 bytes), frame size (160 samples), ceil (+ 160 - 1) */
250         .buf_size = (BUFFER_SAMPLES * 38 + 160 - 1) / 160,
251 };
252
253 static int unload_module(void)
254 {
255         int res;
256
257         res = ast_unregister_translator(&lintoilbc);
258         res |= ast_unregister_translator(&ilbctolin);
259
260         return res;
261 }
262
263 static int load_module(void)
264 {
265         int res;
266
267         res = ast_register_translator(&ilbctolin);
268         res |= ast_register_translator(&lintoilbc);
269
270         if (res) {
271                 unload_module();
272                 return AST_MODULE_LOAD_FAILURE;
273         }
274
275         return AST_MODULE_LOAD_SUCCESS;
276 }
277
278 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "iLBC Coder/Decoder");