Fri Aug 24 02:22:14 2007

Asterisk developer's documentation


codec_gsm.c

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * The GSM code is from TOAST.  Copyright information for that package is available
00005  * in the GSM directory.
00006  *
00007  * Copyright (C) 1999 - 2005, Digium, Inc.
00008  *
00009  * Mark Spencer <markster@digium.com>
00010  *
00011  * See http://www.asterisk.org for more information about
00012  * the Asterisk project. Please do not directly contact
00013  * any of the maintainers of this project for assistance;
00014  * the project provides a web site, mailing lists and IRC
00015  * channels for your use.
00016  *
00017  * This program is free software, distributed under the terms of
00018  * the GNU General Public License Version 2. See the LICENSE file
00019  * at the top of the source tree.
00020  */
00021 
00022 /*! \file
00023  *
00024  * \brief Translate between signed linear and Global System for Mobile Communications (GSM)
00025  *
00026  * \ingroup codecs
00027  */
00028 
00029 /*** MODULEINFO
00030    <depend>gsm</depend>
00031  ***/
00032 
00033 #include "asterisk.h"
00034 
00035 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
00036 
00037 #include <fcntl.h>
00038 #include <stdlib.h>
00039 #include <unistd.h>
00040 #include <netinet/in.h>
00041 #include <string.h>
00042 #include <stdio.h>
00043 
00044 #include "asterisk/lock.h"
00045 #include "asterisk/translate.h"
00046 #include "asterisk/config.h"
00047 #include "asterisk/options.h"
00048 #include "asterisk/module.h"
00049 #include "asterisk/logger.h"
00050 #include "asterisk/channel.h"
00051 #include "asterisk/utils.h"
00052 
00053 #ifdef HAVE_GSM_HEADER
00054 #include "gsm.h"
00055 #elif defined(HAVE_GSM_GSM_HEADER)
00056 #include <gsm/gsm.h>
00057 #endif
00058 
00059 #include "../formats/msgsm.h"
00060 
00061 /* Sample frame data */
00062 #include "slin_gsm_ex.h"
00063 #include "gsm_slin_ex.h"
00064 
00065 #define BUFFER_SAMPLES  8000
00066 #define GSM_SAMPLES  160
00067 #define  GSM_FRAME_LEN  33
00068 #define  MSGSM_FRAME_LEN   65
00069 
00070 struct gsm_translator_pvt {   /* both gsm2lin and lin2gsm */
00071    gsm gsm;
00072    int16_t buf[BUFFER_SAMPLES];  /* lin2gsm, temporary storage */
00073 };
00074 
00075 static int gsm_new(struct ast_trans_pvt *pvt)
00076 {
00077    struct gsm_translator_pvt *tmp = pvt->pvt;
00078    
00079    return (tmp->gsm = gsm_create()) ? 0 : -1;
00080 }
00081 
00082 static struct ast_frame *lintogsm_sample(void)
00083 {
00084    static struct ast_frame f;
00085    f.frametype = AST_FRAME_VOICE;
00086    f.subclass = AST_FORMAT_SLINEAR;
00087    f.datalen = sizeof(slin_gsm_ex);
00088    /* Assume 8000 Hz */
00089    f.samples = sizeof(slin_gsm_ex)/2;
00090    f.mallocd = 0;
00091    f.offset = 0;
00092    f.src = __PRETTY_FUNCTION__;
00093    f.data = slin_gsm_ex;
00094    return &f;
00095 }
00096 
00097 static struct ast_frame *gsmtolin_sample(void)
00098 {
00099    static struct ast_frame f;
00100    f.frametype = AST_FRAME_VOICE;
00101    f.subclass = AST_FORMAT_GSM;
00102    f.datalen = sizeof(gsm_slin_ex);
00103    /* All frames are 20 ms long */
00104    f.samples = GSM_SAMPLES;
00105    f.mallocd = 0;
00106    f.offset = 0;
00107    f.src = __PRETTY_FUNCTION__;
00108    f.data = gsm_slin_ex;
00109    return &f;
00110 }
00111 
00112 /*! \brief decode and store in outbuf. */
00113 static int gsmtolin_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
00114 {
00115    struct gsm_translator_pvt *tmp = pvt->pvt;
00116    int x;
00117    int16_t *dst = (int16_t *)pvt->outbuf;
00118    /* guess format from frame len. 65 for MSGSM, 33 for regular GSM */
00119    int flen = (f->datalen % MSGSM_FRAME_LEN == 0) ?
00120       MSGSM_FRAME_LEN : GSM_FRAME_LEN;
00121 
00122    for (x=0; x < f->datalen; x += flen) {
00123       unsigned char data[2 * GSM_FRAME_LEN];
00124       unsigned char *src;
00125       int len;
00126       if (flen == MSGSM_FRAME_LEN) {
00127          len = 2*GSM_SAMPLES;
00128          src = data;
00129          /* Translate MSGSM format to Real GSM format before feeding in */
00130          /* XXX what's the point here! we should just work
00131           * on the full format.
00132           */
00133          conv65(f->data + x, data);
00134       } else {
00135          len = GSM_SAMPLES;
00136          src = f->data + x;
00137       }
00138       /* XXX maybe we don't need to check */
00139       if (pvt->samples + len > BUFFER_SAMPLES) {   
00140          ast_log(LOG_WARNING, "Out of buffer space\n");
00141          return -1;
00142       }
00143       if (gsm_decode(tmp->gsm, src, dst + pvt->samples)) {
00144          ast_log(LOG_WARNING, "Invalid GSM data (1)\n");
00145          return -1;
00146       }
00147       pvt->samples += GSM_SAMPLES;
00148       pvt->datalen += 2 * GSM_SAMPLES;
00149       if (flen == MSGSM_FRAME_LEN) {
00150          if (gsm_decode(tmp->gsm, data + GSM_FRAME_LEN, dst + pvt->samples)) {
00151             ast_log(LOG_WARNING, "Invalid GSM data (2)\n");
00152             return -1;
00153          }
00154          pvt->samples += GSM_SAMPLES;
00155          pvt->datalen += 2 * GSM_SAMPLES;
00156       }
00157    }
00158    return 0;
00159 }
00160 
00161 /*! \brief store samples into working buffer for later decode */
00162 static int lintogsm_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
00163 {
00164    struct gsm_translator_pvt *tmp = pvt->pvt;
00165 
00166    /* XXX We should look at how old the rest of our stream is, and if it
00167       is too old, then we should overwrite it entirely, otherwise we can
00168       get artifacts of earlier talk that do not belong */
00169    if (pvt->samples + f->samples > BUFFER_SAMPLES) {
00170       ast_log(LOG_WARNING, "Out of buffer space\n");
00171       return -1;
00172    }
00173    memcpy(tmp->buf + pvt->samples, f->data, f->datalen);
00174    pvt->samples += f->samples;
00175    return 0;
00176 }
00177 
00178 /*! \brief encode and produce a frame */
00179 static struct ast_frame *lintogsm_frameout(struct ast_trans_pvt *pvt)
00180 {
00181    struct gsm_translator_pvt *tmp = pvt->pvt;
00182    int datalen = 0;
00183    int samples = 0;
00184 
00185    /* We can't work on anything less than a frame in size */
00186    if (pvt->samples < GSM_SAMPLES)
00187       return NULL;
00188    while (pvt->samples >= GSM_SAMPLES) {
00189       /* Encode a frame of data */
00190       gsm_encode(tmp->gsm, tmp->buf + samples, (gsm_byte *) pvt->outbuf + datalen);
00191       datalen += GSM_FRAME_LEN;
00192       samples += GSM_SAMPLES;
00193       pvt->samples -= GSM_SAMPLES;
00194    }
00195 
00196    /* Move the data at the end of the buffer to the front */
00197    if (pvt->samples)
00198       memmove(tmp->buf, tmp->buf + samples, pvt->samples * 2);
00199 
00200    return ast_trans_frameout(pvt, datalen, samples);
00201 }
00202 
00203 static void gsm_destroy_stuff(struct ast_trans_pvt *pvt)
00204 {
00205    struct gsm_translator_pvt *tmp = pvt->pvt;
00206    if (tmp->gsm)
00207       gsm_destroy(tmp->gsm);
00208 }
00209 
00210 static struct ast_translator gsmtolin = {
00211    .name = "gsmtolin", 
00212    .srcfmt = AST_FORMAT_GSM,
00213    .dstfmt = AST_FORMAT_SLINEAR,
00214    .newpvt = gsm_new,
00215    .framein = gsmtolin_framein,
00216    .destroy = gsm_destroy_stuff,
00217    .sample = gsmtolin_sample,
00218    .buffer_samples = BUFFER_SAMPLES,
00219    .buf_size = BUFFER_SAMPLES * 2,
00220    .desc_size = sizeof (struct gsm_translator_pvt ),
00221    .plc_samples = GSM_SAMPLES,
00222 };
00223 
00224 static struct ast_translator lintogsm = {
00225    .name = "lintogsm", 
00226    .srcfmt = AST_FORMAT_SLINEAR,
00227    .dstfmt = AST_FORMAT_GSM,
00228    .newpvt = gsm_new,
00229    .framein = lintogsm_framein,
00230    .frameout = lintogsm_frameout,
00231    .destroy = gsm_destroy_stuff,
00232    .sample = lintogsm_sample,
00233    .desc_size = sizeof (struct gsm_translator_pvt ),
00234    .buf_size = (BUFFER_SAMPLES * GSM_FRAME_LEN + GSM_SAMPLES - 1)/GSM_SAMPLES,
00235 };
00236 
00237 
00238 static void parse_config(void)
00239 {
00240    struct ast_variable *var;
00241    struct ast_config *cfg = ast_config_load("codecs.conf");
00242    if (!cfg)
00243       return;
00244    for (var = ast_variable_browse(cfg, "plc"); var; var = var->next) {
00245           if (!strcasecmp(var->name, "genericplc")) {
00246              gsmtolin.useplc = ast_true(var->value) ? 1 : 0;
00247              if (option_verbose > 2)
00248                 ast_verbose(VERBOSE_PREFIX_3 "codec_gsm: %susing generic PLC\n", gsmtolin.useplc ? "" : "not ");
00249           }
00250    }
00251    ast_config_destroy(cfg);
00252 }
00253 
00254 /*! \brief standard module glue */
00255 static int reload(void)
00256 {
00257    parse_config();
00258    return 0;
00259 }
00260 
00261 static int unload_module(void)
00262 {
00263    int res;
00264 
00265    res = ast_unregister_translator(&lintogsm);
00266    if (!res)
00267       res = ast_unregister_translator(&gsmtolin);
00268 
00269    return res;
00270 }
00271 
00272 static int load_module(void)
00273 {
00274    int res;
00275 
00276    parse_config();
00277    res = ast_register_translator(&gsmtolin);
00278    if (!res) 
00279       res=ast_register_translator(&lintogsm);
00280    else
00281       ast_unregister_translator(&gsmtolin);
00282 
00283    return res;
00284 }
00285 
00286 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "GSM Coder/Decoder",
00287       .load = load_module,
00288       .unload = unload_module,
00289       .reload = reload,
00290           );

Generated on Fri Aug 24 02:22:14 2007 for Asterisk - the Open Source PBX by  doxygen 1.5.1