codecs/codec_zap.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Zaptel native transcoding support
   5  *
   6  * Copyright (C) 1999 - 2006, Digium, Inc.
   7  *
   8  * Mark Spencer <markster@digium.com>
   9  * Kevin P. Fleming <kpfleming@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 various formats natively through Zaptel transcoding
  25  *
  26  * \ingroup codecs
  27  */
  28
  29 /*** MODULEINFO
  30         <depend>zaptel_transcode</depend>
  31         <depend>zaptel</depend>
  32  ***/
  33
  34 #include "asterisk.h"
  35
  36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  37
  38 #include <fcntl.h>
  39 #include <stdlib.h>
  40 #include <unistd.h>
  41 #include <netinet/in.h>
  42 #include <string.h>
  43 #include <stdio.h>
  44 #include <sys/ioctl.h>
  45 #include <errno.h>
  46 #include <sys/mman.h>
  47 #include <zaptel/zaptel.h>
  48
  49 #include "asterisk/lock.h"
  50 #include "asterisk/translate.h"
  51 #include "asterisk/config.h"
  52 #include "asterisk/options.h"
  53 #include "asterisk/module.h"
  54 #include "asterisk/logger.h"
  55 #include "asterisk/channel.h"
  56 #include "asterisk/utils.h"
  57 #include "asterisk/linkedlists.h"
  58
  59 #define BUFFER_SAMPLES  8000
  60
  61 static unsigned int global_useplc = 0;
  62
  63 struct format_map {
  64         unsigned int map[32][32];
  65 };
  66
  67 static struct format_map global_format_map = { { { 0 } } };
  68
  69 struct translator {
  70         struct ast_translator t;
  71         AST_LIST_ENTRY(translator) entry;
  72 };
  73
  74 static AST_LIST_HEAD_STATIC(translators, translator);
  75
  76 struct pvt {
  77         int fd;
  78         int fake;
  79 #ifdef DEBUG_TRANSCODE
  80         int totalms;
  81         int lasttotalms;
  82 #endif
  83         struct zt_transcode_header *hdr;
  84         struct ast_frame f;
  85 };
  86
  87 static int zap_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
  88 {
  89         struct pvt *ztp = pvt->pvt;
  90         struct zt_transcode_header *hdr = ztp->hdr;
  91
  92         if (!f->subclass) {
  93                 /* Fake a return frame for calculation purposes */
  94                 ztp->fake = 2;
  95                 pvt->samples = f->samples;
  96                 return 0;
  97         }
  98
  99         if (!hdr->srclen)
 100                 /* Copy at front of buffer */
 101                 hdr->srcoffset = 0;
 102
 103         if (hdr->srclen + f->datalen > sizeof(hdr->srcdata)) {
 104                 ast_log(LOG_WARNING, "Out of space for codec translation!\n");
 105                 return -1;
 106         }
 107
 108         if (hdr->srclen + f->datalen + hdr->srcoffset > sizeof(hdr->srcdata)) {
 109                 /* Very unlikely */
 110                 memmove(hdr->srcdata, hdr->srcdata + hdr->srcoffset, hdr->srclen);
 111                 hdr->srcoffset = 0;
 112         }
 113
 114         memcpy(hdr->srcdata + hdr->srcoffset + hdr->srclen, f->data, f->datalen);
 115         hdr->srclen += f->datalen;
 116         pvt->samples += f->samples;
 117
 118         return -1;
 119 }
 120
 121 static struct ast_frame *zap_frameout(struct ast_trans_pvt *pvt)
 122 {
 123         struct pvt *ztp = pvt->pvt;
 124         struct zt_transcode_header *hdr = ztp->hdr;
 125         unsigned int x;
 126
 127         if (ztp->fake == 2) {
 128                 ztp->fake = 1;
 129                 ztp->f.frametype = AST_FRAME_VOICE;
 130                 ztp->f.subclass = 0;
 131                 ztp->f.samples = 160;
 132                 ztp->f.data = NULL;
 133                 ztp->f.offset = 0;
 134                 ztp->f.datalen = 0;
 135                 ztp->f.mallocd = 0;
 136                 pvt->samples = 0;
 137         } else if (ztp->fake == 1) {
 138                 return NULL;
 139         } else {
 140                 if (hdr->dstlen) {
 141 #ifdef DEBUG_TRANSCODE
 142                         ztp->totalms += hdr->dstsamples;
 143                         if ((ztp->totalms - ztp->lasttotalms) > 8000) {
 144                                 printf("Whee %p, %d (%d to %d)\n", ztp, hdr->dstlen, ztp->lasttotalms, ztp->totalms);
 145                                 ztp->lasttotalms = ztp->totalms;
 146                         }
 147 #endif
 148                         ztp->f.frametype = AST_FRAME_VOICE;
 149                         ztp->f.subclass = hdr->dstfmt;
 150                         ztp->f.samples = hdr->dstsamples;
 151                         ztp->f.data = hdr->dstdata + hdr->dstoffset;
 152                         ztp->f.offset = hdr->dstoffset;
 153                         ztp->f.datalen = hdr->dstlen;
 154                         ztp->f.mallocd = 0;
 155                         pvt->samples -= ztp->f.samples;
 156                         hdr->dstlen = 0;
 157
 158                 } else {
 159                         if (hdr->srclen) {
 160                                 hdr->dstoffset = AST_FRIENDLY_OFFSET;
 161                                 x = ZT_TCOP_TRANSCODE;
 162                                 if (ioctl(ztp->fd, ZT_TRANSCODE_OP, &x))
 163                                         ast_log(LOG_WARNING, "Failed to transcode: %s\n", strerror(errno));
 164                         }
 165                         return NULL;
 166                 }
 167         }
 168
 169         return &ztp->f;
 170 }
 171
 172 static void zap_destroy(struct ast_trans_pvt *pvt)
 173 {
 174         struct pvt *ztp = pvt->pvt;
 175
 176         munmap(ztp->hdr, sizeof(*ztp->hdr));
 177         close(ztp->fd);
 178 }
 179
 180 static int zap_translate(struct ast_trans_pvt *pvt, int dest, int source)
 181 {
 182         /* Request translation through zap if possible */
 183         int fd;
 184         unsigned int x = ZT_TCOP_ALLOCATE;
 185         struct pvt *ztp = pvt->pvt;
 186         struct zt_transcode_header *hdr;
 187         int flags;
 188
 189         if ((fd = open("/dev/zap/transcode", O_RDWR)) < 0)
 190                 return -1;
 191         flags = fcntl(fd, F_GETFL);
 192         if (flags > - 1) {
 193                 if (fcntl(fd, F_SETFL, flags | O_NONBLOCK))
 194                         ast_log(LOG_WARNING, "Could not set non-block mode!\n");
 195         }
 196
 197
 198         if ((hdr = mmap(NULL, sizeof(*hdr), PROT_READ|PROT_WRITE, MAP_SHARED, fd, 0)) == MAP_FAILED) {
 199                 ast_log(LOG_ERROR, "Memory Map failed for transcoding (%s)\n", strerror(errno));
 200                 close(fd);
 201
 202                 return -1;
 203         }
 204
 205         if (hdr->magic != ZT_TRANSCODE_MAGIC) {
 206                 ast_log(LOG_ERROR, "Transcoder header (%08x) wasn't magic.  Abandoning\n", hdr->magic);
 207                 munmap(hdr, sizeof(*hdr));
 208                 close(fd);
 209
 210                 return -1;
 211         }
 212
 213         hdr->srcfmt = (1 << source);
 214         hdr->dstfmt = (1 << dest);
 215         if (ioctl(fd, ZT_TRANSCODE_OP, &x)) {
 216                 ast_log(LOG_ERROR, "Unable to attach transcoder: %s\n", strerror(errno));
 217                 munmap(hdr, sizeof(*hdr));
 218                 close(fd);
 219
 220                 return -1;
 221         }
 222
 223         ztp = pvt->pvt;
 224         ztp->fd = fd;
 225         ztp->hdr = hdr;
 226
 227         return 0;
 228 }
 229
 230 static int zap_new(struct ast_trans_pvt *pvt)
 231 {
 232         return zap_translate(pvt, pvt->t->dstfmt, pvt->t->srcfmt);
 233 }
 234
 235 static struct ast_frame *fakesrc_sample(void)
 236 {
 237         /* Don't bother really trying to test hardware ones. */
 238         static struct ast_frame f = {
 239                 .frametype = AST_FRAME_VOICE,
 240                 .samples = 160,
 241                 .src = __PRETTY_FUNCTION__
 242         };
 243
 244         return &f;
 245 }
 246
 247 static int register_translator(int dst, int src)
 248 {
 249         struct translator *zt;
 250         int res;
 251
 252         if (!(zt = ast_calloc(1, sizeof(*zt))))
 253                 return -1;
 254
 255         snprintf((char *) (zt->t.name), sizeof(zt->t.name), "zap%sto%s",
 256                  ast_getformatname((1 << src)), ast_getformatname((1 << dst)));
 257         zt->t.srcfmt = (1 << src);
 258         zt->t.dstfmt = (1 << dst);
 259         zt->t.newpvt = zap_new;
 260         zt->t.framein = zap_framein;
 261         zt->t.frameout = zap_frameout;
 262         zt->t.destroy = zap_destroy;
 263         zt->t.sample = fakesrc_sample;
 264         zt->t.useplc = global_useplc;
 265         zt->t.buf_size = BUFFER_SAMPLES * 2;
 266         zt->t.desc_size = sizeof(struct pvt);
 267         if ((res = ast_register_translator(&zt->t))) {
 268                 free(zt);
 269                 return -1;
 270         }
 271
 272         AST_LIST_LOCK(&translators);
 273         AST_LIST_INSERT_HEAD(&translators, zt, entry);
 274         AST_LIST_UNLOCK(&translators);
 275
 276         global_format_map.map[dst][src] = 1;
 277
 278         return res;
 279 }
 280
 281 static void drop_translator(int dst, int src)
 282 {
 283         struct translator *cur;
 284
 285         AST_LIST_LOCK(&translators);
 286         AST_LIST_TRAVERSE_SAFE_BEGIN(&translators, cur, entry) {
 287                 if (cur->t.srcfmt != src)
 288                         continue;
 289
 290                 if (cur->t.dstfmt != dst)
 291                         continue;
 292
 293                 AST_LIST_REMOVE_CURRENT(&translators, entry);
 294                 ast_unregister_translator(&cur->t);
 295                 free(cur);
 296                 global_format_map.map[dst][src] = 0;
 297                 break;
 298         }
 299         AST_LIST_TRAVERSE_SAFE_END;
 300         AST_LIST_UNLOCK(&translators);
 301 }
 302
 303 static void unregister_translators(void)
 304 {
 305         struct translator *cur;
 306
 307         AST_LIST_LOCK(&translators);
 308         while ((cur = AST_LIST_REMOVE_HEAD(&translators, entry))) {
 309                 ast_unregister_translator(&cur->t);
 310                 free(cur);
 311         }
 312         AST_LIST_UNLOCK(&translators);
 313 }
 314
 315 static void parse_config(void)
 316 {
 317         struct ast_variable *var;
 318         struct ast_config *cfg = ast_config_load("codecs.conf");
 319
 320         if (!cfg)
 321                 return;
 322
 323         for (var = ast_variable_browse(cfg, "plc"); var; var = var->next) {
 324                if (!strcasecmp(var->name, "genericplc")) {
 325                        global_useplc = ast_true(var->value);
 326                        if (option_verbose > 2)
 327                                ast_verbose(VERBOSE_PREFIX_3 "codec_zap: %susing generic PLC\n",
 328                                            global_useplc ? "" : "not ");
 329                }
 330         }
 331
 332         ast_config_destroy(cfg);
 333 }
 334
 335 static void build_translators(struct format_map *map, unsigned int dstfmts, unsigned int srcfmts)
 336 {
 337         unsigned int src, dst;
 338
 339         for (src = 0; src < 32; src++) {
 340                 for (dst = 0; dst < 32; dst++) {
 341                         if (!(srcfmts & (1 << src)))
 342                                 continue;
 343
 344                         if (!(dstfmts & (1 << dst)))
 345                                 continue;
 346
 347                         if (global_format_map.map[dst][src])
 348                                 continue;
 349
 350                         if (!register_translator(dst, src))
 351                                 map->map[dst][src] = 1;
 352                 }
 353         }
 354 }
 355
 356 static int find_transcoders(void)
 357 {
 358         struct zt_transcode_info info = { 0, };
 359         struct format_map map = { { { 0 } } };
 360         int fd, res;
 361         unsigned int x, y;
 362
 363         info.op = ZT_TCOP_GETINFO;
 364         if ((fd = open("/dev/zap/transcode", O_RDWR)) < 0) {
 365                 ast_log(LOG_NOTICE, "No Zaptel transcoder support!\n");
 366                 return 0;
 367         }
 368         for (info.tcnum = 0; !(res = ioctl(fd, ZT_TRANSCODE_OP, &info)); info.tcnum++) {
 369                 if (option_verbose > 1)
 370                         ast_verbose(VERBOSE_PREFIX_2 "Found transcoder '%s'.\n", info.name);
 371                 build_translators(&map, info.dstfmts, info.srcfmts);
 372         }
 373         close(fd);
 374
 375         if (!info.tcnum && (option_verbose > 1))
 376                 ast_verbose(VERBOSE_PREFIX_2 "No hardware transcoders found.\n");
 377
 378         for (x = 0; x < 32; x++) {
 379                 for (y = 0; y < 32; y++) {
 380                         if (!map.map[x][y] && global_format_map.map[x][y])
 381                                 drop_translator(x, y);
 382                 }
 383         }
 384
 385         return 0;
 386 }
 387
 388 static int reload(void)
 389 {
 390         struct translator *cur;
 391
 392         parse_config();
 393         find_transcoders();
 394
 395         AST_LIST_LOCK(&translators);
 396         AST_LIST_TRAVERSE(&translators, cur, entry)
 397                 cur->t.useplc = global_useplc;
 398         AST_LIST_UNLOCK(&translators);
 399
 400         return 0;
 401 }
 402
 403 static int unload_module(void)
 404 {
 405         unregister_translators();
 406
 407         return 0;
 408 }
 409
 410 static int load_module(void)
 411 {
 412         parse_config();
 413         find_transcoders();
 414
 415         return 0;
 416 }
 417
 418 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Generic Zaptel Transcoder Codec Translator",
 419                 .load = load_module,
 420                 .unload = unload_module,
 421                 .reload = reload,
 422                );