codecs: Add support for WebRTC iLBC 2.0.
[asterisk/asterisk.git] / codecs / codec_ilbc.c
index fb042cf..536d680 100644 (file)
 /*! \file
  *
  * \brief Translate between signed linear and Internet Low Bitrate Codec
- * 
+ *
  * \ingroup codecs
  */
 
-#include <fcntl.h>
-#include <stdlib.h>
-#include <unistd.h>
-#include <netinet/in.h>
-#include <string.h>
-#include <stdio.h>
+/*** MODULEINFO
+       <use>ilbc</use>
+       <support_level>core</support_level>
+ ***/
 
 #include "asterisk.h"
 
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
-
-#include "asterisk/lock.h"
-#include "asterisk/translate.h"
+#include "asterisk/codec.h"             /* for AST_MEDIA_TYPE_AUDIO */
+#include "asterisk/format.h"            /* for ast_format_get_attribute_data */
+#include "asterisk/frame.h"             /* for ast_frame, etc */
+#include "asterisk/linkedlists.h"       /* for AST_LIST_NEXT, etc */
+#include "asterisk/logger.h"            /* for ast_log, ast_debug, etc */
 #include "asterisk/module.h"
-#include "asterisk/logger.h"
-#include "asterisk/channel.h"
-#include "asterisk/utils.h"
+#include "asterisk/translate.h"         /* for ast_trans_pvt, etc */
 
+#ifdef ILBC_WEBRTC
+#include <ilbc.h>
+typedef uint16_t ilbc_bytes;
+typedef int16_t  ilbc_block;
+#define BUF_TYPE i16
+#else
 #include "ilbc/iLBC_encode.h"
 #include "ilbc/iLBC_decode.h"
+typedef unsigned char ilbc_bytes;
+typedef float         ilbc_block;
+#define BUF_TYPE uc
+#endif
 
-/* Sample frame data */
-#include "slin_ilbc_ex.h"
-#include "ilbc_slin_ex.h"
-
-#define USE_ILBC_ENHANCER      0
-#define ILBC_MS                        30
-/* #define ILBC_MS                     20 */
+#include "asterisk/ilbc.h"
 
-AST_MUTEX_DEFINE_STATIC(localuser_lock);
-static int localusecnt=0;
+#define USE_ILBC_ENHANCER 0
+#define BUFFER_SAMPLES    8000
 
-static char *tdesc = "iLBC/PCM16 (signed linear) Codec Translator";
+/* Sample frame data */
+#include "asterisk/slin.h"
+#include "ex_ilbc.h"
 
-struct ast_translator_pvt {
+struct ilbc_coder_pvt {
        iLBC_Enc_Inst_t enc;
        iLBC_Dec_Inst_t dec;
-       struct ast_frame f;
-       /* Space to build offset */
-       char offset[AST_FRIENDLY_OFFSET];
-       /* Buffer for our outgoing frame */
-       short outbuf[8000];
        /* Enough to store a full second */
-       short buf[8000];
-       int tail;
+       int16_t buf[BUFFER_SAMPLES];
+       int16_t inited;
 };
 
-#define ilbc_coder_pvt ast_translator_pvt
-
-static struct ast_translator_pvt *lintoilbc_new(void)
+static int lintoilbc_new(struct ast_trans_pvt *pvt)
 {
-       struct ilbc_coder_pvt *tmp;
-       if ((tmp = ast_malloc(sizeof(*tmp)))) {
-               /* Shut valgrind up */
-               memset(&tmp->enc, 0, sizeof(tmp->enc));
-               initEncode(&tmp->enc, ILBC_MS);
-               tmp->tail = 0;
-               localusecnt++;
-       }
-       return tmp;
-}
+       struct ilbc_coder_pvt *tmp = pvt->pvt;
+       struct ilbc_attr *attr = pvt->explicit_dst ? ast_format_get_attribute_data(pvt->explicit_dst) : NULL;
+       const unsigned int mode = attr ? attr->mode : 30;
 
-static struct ast_translator_pvt *ilbctolin_new(void)
-{
-       struct ilbc_coder_pvt *tmp;     
-       if ((tmp = ast_malloc(sizeof(*tmp)))) {
-               /* Shut valgrind up */
-               memset(&tmp->dec, 0, sizeof(tmp->dec));
-               initDecode(&tmp->dec, ILBC_MS, USE_ILBC_ENHANCER);
-               tmp->tail = 0;
-               localusecnt++;
-       }
-       return tmp;
-}
+       initEncode(&tmp->enc, mode);
 
-static struct ast_frame *lintoilbc_sample(void)
-{
-       static struct ast_frame f;
-       f.frametype = AST_FRAME_VOICE;
-       f.subclass = AST_FORMAT_SLINEAR;
-       f.datalen = sizeof(slin_ilbc_ex);
-       /* Assume 8000 Hz */
-       f.samples = sizeof(slin_ilbc_ex)/2;
-       f.mallocd = 0;
-       f.offset = 0;
-       f.src = __PRETTY_FUNCTION__;
-       f.data = slin_ilbc_ex;
-       return &f;
+       return 0;
 }
 
-static struct ast_frame *ilbctolin_sample(void)
+static int ilbctolin_new(struct ast_trans_pvt *pvt)
 {
-       static struct ast_frame f;
-       f.frametype = AST_FRAME_VOICE;
-       f.subclass = AST_FORMAT_ILBC;
-       f.datalen = sizeof(ilbc_slin_ex);
-       /* All frames are 30 ms long */
-       f.samples = 240;
-       f.mallocd = 0;
-       f.offset = 0;
-       f.src = __PRETTY_FUNCTION__;
-       f.data = ilbc_slin_ex;
-       return &f;
-}
+       struct ilbc_coder_pvt *tmp = pvt->pvt;
 
-static struct ast_frame *ilbctolin_frameout(struct ast_translator_pvt *tmp)
-{
-       if (!tmp->tail)
-               return NULL;
-       /* Signed linear is no particular frame size, so just send whatever
-          we have in the buffer in one lump sum */
-       tmp->f.frametype = AST_FRAME_VOICE;
-       tmp->f.subclass = AST_FORMAT_SLINEAR;
-       tmp->f.datalen = tmp->tail * 2;
-       /* Assume 8000 Hz */
-       tmp->f.samples = tmp->tail;
-       tmp->f.mallocd = 0;
-       tmp->f.offset = AST_FRIENDLY_OFFSET;
-       tmp->f.src = __PRETTY_FUNCTION__;
-       tmp->f.data = tmp->buf;
-       /* Reset tail pointer */
-       tmp->tail = 0;
-
-       return &tmp->f; 
+       tmp->inited = 0; /* we do not know the iLBC mode, yet */
+
+       return 0;
 }
 
-static int ilbctolin_framein(struct ast_translator_pvt *tmp, struct ast_frame *f)
+/*! \brief decode a frame and store in outbuf */
+static int ilbctolin_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
 {
+       struct ilbc_coder_pvt *tmp = pvt->pvt;
+       struct ilbc_attr *attr = ast_format_get_attribute_data(f->subclass.format);
+       const unsigned int mode = attr ? attr->mode : 30;
+       const unsigned int sample_rate = pvt->t->dst_codec.sample_rate;
+       const unsigned int samples_per_frame = mode * sample_rate / 1000;
+       const unsigned int octets_per_frame = (mode == 20) ? 38 : 50;
+
+       int plc_mode = 1; /* 1 = normal data, 0 = plc */
        /* Assuming there's space left, decode into the current buffer at
           the tail location.  Read in as many frames as there are */
        int x,i;
-       float tmpf[240];
-
-       if (f->datalen == 0) { /* native PLC */
-               if (tmp->tail + 240 < sizeof(tmp->buf)/2) {     
-                       iLBC_decode(tmpf, NULL, &tmp->dec, 0);
-                       for (i=0;i<240;i++)
-                               tmp->buf[tmp->tail + i] = tmpf[i];
-                       tmp->tail+=240;
-               } else {
-                       ast_log(LOG_WARNING, "Out of buffer space\n");
-                       return -1;
-               }               
+       int datalen = f->datalen;
+       int16_t *dst = pvt->outbuf.i16;
+       ilbc_block tmpf[samples_per_frame];
+
+       if (!f->data.ptr && datalen) {
+               ast_debug(1, "issue 16070, ILIB ERROR. data = NULL datalen = %d src = %s\n", datalen, f->src ? f->src : "no src set");
+               f->datalen = 0;
+               datalen = 0;
+       }
+
+       if (datalen == 0) { /* native PLC, set fake datalen and clear plc_mode */
+               datalen = octets_per_frame;
+               f->samples = samples_per_frame;
+               plc_mode = 0;   /* do native plc */
+               pvt->samples += samples_per_frame;
        }
 
-       if (f->datalen % 50) {
-               ast_log(LOG_WARNING, "Huh?  An ilbc frame that isn't a multiple of 50 bytes long from %s (%d)?\n", f->src, f->datalen);
+       if (datalen % octets_per_frame) {
+               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);
                return -1;
        }
-       
-       for (x=0;x<f->datalen;x+=50) {
-               if (tmp->tail + 240 < sizeof(tmp->buf)/2) {     
-                       iLBC_decode(tmpf, f->data + x, &tmp->dec, 1);
-                       for (i=0;i<240;i++)
-                               tmp->buf[tmp->tail + i] = tmpf[i];
-                       tmp->tail+=240;
-               } else {
+
+       if (!tmp->inited) {
+               initDecode(&tmp->dec, mode, USE_ILBC_ENHANCER);
+               tmp->inited = 1;
+       }
+
+       for (x = 0; x < datalen; x += octets_per_frame) {
+               if (pvt->samples + samples_per_frame > BUFFER_SAMPLES) {
                        ast_log(LOG_WARNING, "Out of buffer space\n");
                        return -1;
-               }               
+               }
+               iLBC_decode(tmpf, plc_mode ? f->data.ptr + x : NULL, &tmp->dec, plc_mode);
+               for (i = 0; i < samples_per_frame; i++)
+                       dst[pvt->samples + i] = tmpf[i];
+               pvt->samples += samples_per_frame;
+               pvt->datalen += samples_per_frame * 2;
        }
        return 0;
 }
 
-static int lintoilbc_framein(struct ast_translator_pvt *tmp, struct ast_frame *f)
+/*! \brief store a frame into a temporary buffer, for later decoding */
+static int lintoilbc_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
 {
+       struct ilbc_coder_pvt *tmp = pvt->pvt;
+
        /* Just add the frames to our stream */
        /* XXX We should look at how old the rest of our stream is, and if it
           is too old, then we should overwrite it entirely, otherwise we can
           get artifacts of earlier talk that do not belong */
-       if (tmp->tail + f->datalen/2 < sizeof(tmp->buf) / 2) {
-               memcpy((tmp->buf + tmp->tail), f->data, f->datalen);
-               tmp->tail += f->datalen/2;
-       } else {
-               ast_log(LOG_WARNING, "Out of buffer space\n");
-               return -1;
-       }
+       memcpy(tmp->buf + pvt->samples, f->data.ptr, f->datalen);
+       pvt->samples += f->samples;
        return 0;
 }
 
-static struct ast_frame *lintoilbc_frameout(struct ast_translator_pvt *tmp)
+/*! \brief encode the temporary buffer and generate a frame */
+static struct ast_frame *lintoilbc_frameout(struct ast_trans_pvt *pvt)
 {
-       int x=0,i;
-       float tmpf[240];
-       /* We can't work on anything less than a frame in size */
-       if (tmp->tail < 240)
-               return NULL;
-       tmp->f.frametype = AST_FRAME_VOICE;
-       tmp->f.subclass = AST_FORMAT_ILBC;
-       tmp->f.mallocd = 0;
-       tmp->f.offset = AST_FRIENDLY_OFFSET;
-       tmp->f.src = __PRETTY_FUNCTION__;
-       tmp->f.data = tmp->outbuf;
-       while(tmp->tail >= 240) {
-               if ((x+1) * 50 >= sizeof(tmp->outbuf)) {
-                       ast_log(LOG_WARNING, "Out of buffer space\n");
-                       break;
-               }
-               for (i=0;i<240;i++)
-                       tmpf[i] = tmp->buf[i];
+       struct ilbc_coder_pvt *tmp = pvt->pvt;
+       struct ast_frame *result = NULL;
+       struct ast_frame *last = NULL;
+       int samples = 0; /* output samples */
+
+       struct ilbc_attr *attr = ast_format_get_attribute_data(pvt->f.subclass.format);
+       const unsigned int mode = attr ? attr->mode : 30;
+       const unsigned int sample_rate = pvt->t->dst_codec.sample_rate;
+       const unsigned int samples_per_frame = mode * sample_rate / 1000;
+       const unsigned int octets_per_frame = (mode == 20) ? 38 : 50;
+
+       while (pvt->samples >= samples_per_frame) {
+               struct ast_frame *current;
+               ilbc_block tmpf[samples_per_frame];
+               int i;
+
                /* Encode a frame of data */
-               iLBC_encode(((unsigned char *)(tmp->outbuf)) + (x * 50), tmpf, &tmp->enc);
-               /* Assume 8000 Hz -- 20 ms */
-               tmp->tail -= 240;
-               /* Move the data at the end of the buffer to the front */
-               if (tmp->tail)
-                       memmove(tmp->buf, tmp->buf + 240, tmp->tail * 2);
-               x++;
-       }
-       tmp->f.datalen = x * 50;
-       tmp->f.samples = x * 240;
-#if 0
-       {
-               static int fd = -1;
-               if (fd == -1) {
-                       fd = open("ilbc.out", O_CREAT|O_TRUNC|O_WRONLY, 0666);
-                       write(fd, tmp->f.data, tmp->f.datalen);
-                       close(fd);
+               for (i = 0; i < samples_per_frame; i++)
+                       tmpf[i] = tmp->buf[samples + i];
+               iLBC_encode((ilbc_bytes *) pvt->outbuf.BUF_TYPE, tmpf, &tmp->enc);
+
+               samples += samples_per_frame;
+               pvt->samples -= samples_per_frame;
+
+               current = ast_trans_frameout(pvt, octets_per_frame, samples_per_frame);
+               if (!current) {
+                       continue;
+               } else if (last) {
+                       AST_LIST_NEXT(last, frame_list) = current;
+               } else {
+                       result = current;
                }
+               last = current;
        }
-#endif 
-       return &tmp->f; 
-}
 
-static void ilbc_destroy_stuff(struct ast_translator_pvt *pvt)
-{
-       free(pvt);
-       localusecnt--;
+       /* Move the data at the end of the buffer to the front */
+       if (samples) {
+               memmove(tmp->buf, tmp->buf + samples, pvt->samples * 2);
+       }
+
+       return result;
 }
 
-static struct ast_translator ilbctolin =
-       { "ilbctolin", 
-          AST_FORMAT_ILBC, AST_FORMAT_SLINEAR,
-          ilbctolin_new,
-          ilbctolin_framein,
-          ilbctolin_frameout,
-          ilbc_destroy_stuff,
-          ilbctolin_sample
-          };
-
-static struct ast_translator lintoilbc =
-       { "lintoilbc", 
-          AST_FORMAT_SLINEAR, AST_FORMAT_ILBC,
-          lintoilbc_new,
-          lintoilbc_framein,
-          lintoilbc_frameout,
-          ilbc_destroy_stuff,
-          lintoilbc_sample
-          };
-
-int unload_module(void)
+static struct ast_translator ilbctolin = {
+       .name = "ilbctolin",
+       .src_codec = {
+               .name = "ilbc",
+               .type = AST_MEDIA_TYPE_AUDIO,
+               .sample_rate = 8000,
+       },
+       .dst_codec = {
+               .name = "slin",
+               .type = AST_MEDIA_TYPE_AUDIO,
+               .sample_rate = 8000,
+       },
+       .format = "slin",
+       .newpvt = ilbctolin_new,
+       .framein = ilbctolin_framein,
+       .sample = ilbc_sample,
+       .desc_size = sizeof(struct ilbc_coder_pvt),
+       .buf_size = BUFFER_SAMPLES * 2,
+       .native_plc = 1,
+};
+
+static struct ast_translator lintoilbc = {
+       .name = "lintoilbc",
+       .src_codec = {
+               .name = "slin",
+               .type = AST_MEDIA_TYPE_AUDIO,
+               .sample_rate = 8000,
+       },
+       .dst_codec = {
+               .name = "ilbc",
+               .type = AST_MEDIA_TYPE_AUDIO,
+               .sample_rate = 8000,
+       },
+       .format = "ilbc",
+       .newpvt = lintoilbc_new,
+       .framein = lintoilbc_framein,
+       .frameout = lintoilbc_frameout,
+       .sample = slin8_sample,
+       .desc_size = sizeof(struct ilbc_coder_pvt),
+       /* frame len (38 bytes), frame size (160 samples), ceil (+ 160 - 1) */
+       .buf_size = (BUFFER_SAMPLES * 38 + 160 - 1) / 160,
+};
+
+static int unload_module(void)
 {
        int res;
-       ast_mutex_lock(&localuser_lock);
+
        res = ast_unregister_translator(&lintoilbc);
-       if (!res)
-               res = ast_unregister_translator(&ilbctolin);
-       if (localusecnt)
-               res = -1;
-       ast_mutex_unlock(&localuser_lock);
+       res |= ast_unregister_translator(&ilbctolin);
+
        return res;
 }
 
-int load_module(void)
+static int load_module(void)
 {
        int res;
-       res=ast_register_translator(&ilbctolin);
-       if (!res) 
-               res=ast_register_translator(&lintoilbc);
-       else
-               ast_unregister_translator(&ilbctolin);
-       return res;
-}
 
-char *description(void)
-{
-       return tdesc;
-}
+       res = ast_register_translator(&ilbctolin);
+       res |= ast_register_translator(&lintoilbc);
 
-int usecount(void)
-{
-       int res;
-       OLD_STANDARD_USECOUNT(res);
-       return res;
-}
+       if (res) {
+               unload_module();
+               return AST_MODULE_LOAD_DECLINE;
+       }
 
-char *key()
-{
-       return ASTERISK_GPL_KEY;
+       return AST_MODULE_LOAD_SUCCESS;
 }
+
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "iLBC Coder/Decoder");