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/cli.h"
  55 #include "asterisk/logger.h"
  56 #include "asterisk/channel.h"
  57 #include "asterisk/utils.h"
  58 #include "asterisk/linkedlists.h"
  59
  60 #define BUFFER_SAMPLES  8000
  61
  62 static unsigned int global_useplc = 0;
  63
  64 static struct channel_usage {
  65         int total;
  66         int encoders;
  67         int decoders;
  68 } channels;
  69
  70 static char show_transcoder_usage[] =
  71 "Usage: show transcoder\n"
  72 "       Displays channel utilization of Zaptel transcoder(s).\n";
  73
  74 static char transcoder_show_usage[] =
  75 "Usage: transcoder show\n"
  76 "       Displays channel utilization of Zaptel transcoder(s).\n";
  77
  78 static int transcoder_show(int fd, int argc, char **argv);
  79
  80 static struct ast_cli_entry cli_deprecated[] = {
  81         { { "show", "transcoder", NULL },
  82           transcoder_show,
  83           "Display Zaptel transcoder utilization.",
  84           show_transcoder_usage}
  85 };
  86
  87 static struct ast_cli_entry cli[] = {
  88         { { "transcoder", "show", NULL },
  89           transcoder_show,
  90           "Display Zaptel transcoder utilization.",
  91           transcoder_show_usage, NULL,
  92           &cli_deprecated[0]}
  93 };
  94
  95 struct format_map {
  96         unsigned int map[32][32];
  97 };
  98
  99 static struct format_map global_format_map = { { { 0 } } };
 100
 101 struct translator {
 102         struct ast_translator t;
 103         AST_LIST_ENTRY(translator) entry;
 104 };
 105
 106 static AST_LIST_HEAD_STATIC(translators, translator);
 107
 108 struct pvt {
 109         int fd;
 110         int fake;
 111         unsigned int g729b_warning:1;
 112 #ifdef DEBUG_TRANSCODE
 113         int totalms;
 114         int lasttotalms;
 115 #endif
 116         struct zt_transcode_header *hdr;
 117 };
 118
 119 static int transcoder_show(int fd, int argc, char **argv)
 120 {
 121         struct channel_usage copy;
 122
 123         copy = channels;
 124
 125         if (copy.total == 0)
 126                 ast_cli(fd, "No Zaptel transcoders found.\n");
 127         else
 128                 ast_cli(fd, "%d/%d encoders/decoders of %d channels are in use.\n", copy.encoders, copy.decoders, copy.total);
 129
 130         return RESULT_SUCCESS;
 131 }
 132
 133 static int zap_framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
 134 {
 135         struct pvt *ztp = pvt->pvt;
 136         struct zt_transcode_header *hdr = ztp->hdr;
 137
 138         if (!f->subclass) {
 139                 /* Fake a return frame for calculation purposes */
 140                 ztp->fake = 2;
 141                 pvt->samples = f->samples;
 142                 return 0;
 143         }
 144
 145         if (!hdr->srclen)
 146                 /* Copy at front of buffer */
 147                 hdr->srcoffset = 0;
 148
 149         /* if we get handed a G.729 frame that is not a multiple of
 150            10 bytes (10 milliseconds), then it has a CNG frame and
 151            we need to avoid sending that to the transcoder
 152         */
 153         if ((f->subclass == AST_FORMAT_G729A) && ((f->datalen % 10) != 0)) {
 154                 if (!ztp->g729b_warning) {
 155                         ast_log(LOG_WARNING, "G.729B CNG frame received but is not supported; dropping.\n");
 156                         ztp->g729b_warning = 1;
 157                 }
 158                 f->datalen -= f->datalen % 10;
 159                 f->samples = f->datalen * 8;
 160         }
 161
 162         if (hdr->srclen + f->datalen > sizeof(hdr->srcdata)) {
 163                 ast_log(LOG_WARNING, "Out of space for codec translation!\n");
 164                 return -1;
 165         }
 166
 167         if (hdr->srclen + f->datalen + hdr->srcoffset > sizeof(hdr->srcdata)) {
 168                 /* Very unlikely */
 169                 memmove(hdr->srcdata, hdr->srcdata + hdr->srcoffset, hdr->srclen);
 170                 hdr->srcoffset = 0;
 171         }
 172
 173         memcpy(hdr->srcdata + hdr->srcoffset + hdr->srclen, f->data, f->datalen);
 174         hdr->srclen += f->datalen;
 175         pvt->samples += f->samples;
 176
 177         return -1;
 178 }
 179
 180 static struct ast_frame *zap_frameout(struct ast_trans_pvt *pvt)
 181 {
 182         struct pvt *ztp = pvt->pvt;
 183         struct zt_transcode_header *hdr = ztp->hdr;
 184         unsigned int x;
 185
 186         if (ztp->fake == 2) {
 187                 ztp->fake = 1;
 188                 pvt->f.frametype = AST_FRAME_VOICE;
 189                 pvt->f.subclass = 0;
 190                 pvt->f.samples = 160;
 191                 pvt->f.data = NULL;
 192                 pvt->f.offset = 0;
 193                 pvt->f.datalen = 0;
 194                 pvt->f.mallocd = 0;
 195                 ast_set_flag(&pvt->f, AST_FRFLAG_FROM_TRANSLATOR);
 196                 pvt->samples = 0;
 197         } else if (ztp->fake == 1) {
 198                 return NULL;
 199         } else {
 200                 if (hdr->dstlen) {
 201 #ifdef DEBUG_TRANSCODE
 202                         ztp->totalms += hdr->dstsamples;
 203                         if ((ztp->totalms - ztp->lasttotalms) > 8000) {
 204                                 printf("Whee %p, %d (%d to %d)\n", ztp, hdr->dstlen, ztp->lasttotalms, ztp->totalms);
 205                                 ztp->lasttotalms = ztp->totalms;
 206                         }
 207 #endif
 208                         pvt->f.frametype = AST_FRAME_VOICE;
 209                         pvt->f.subclass = hdr->dstfmt;
 210                         pvt->f.samples = hdr->dstsamples;
 211                         pvt->f.data = hdr->dstdata + hdr->dstoffset;
 212                         pvt->f.offset = hdr->dstoffset;
 213                         pvt->f.datalen = hdr->dstlen;
 214                         pvt->f.mallocd = 0;
 215                         ast_set_flag(&pvt->f, AST_FRFLAG_FROM_TRANSLATOR);
 216                         pvt->samples -= pvt->f.samples;
 217                         hdr->dstlen = 0;
 218
 219                 } else {
 220                         if (hdr->srclen) {
 221                                 hdr->dstoffset = AST_FRIENDLY_OFFSET;
 222                                 x = ZT_TCOP_TRANSCODE;
 223                                 if (ioctl(ztp->fd, ZT_TRANSCODE_OP, &x))
 224                                         ast_log(LOG_WARNING, "Failed to transcode: %s\n", strerror(errno));
 225                         }
 226                         return NULL;
 227                 }
 228         }
 229
 230         return &pvt->f;
 231 }
 232
 233 static void zap_destroy(struct ast_trans_pvt *pvt)
 234 {
 235         struct pvt *ztp = pvt->pvt;
 236         unsigned int x;
 237
 238         x = ZT_TCOP_RELEASE;
 239         if (ioctl(ztp->fd, ZT_TRANSCODE_OP, &x))
 240                 ast_log(LOG_WARNING, "Failed to release transcoder channel: %s\n", strerror(errno));
 241
 242         switch (ztp->hdr->dstfmt) {
 243         case AST_FORMAT_G729A:
 244         case AST_FORMAT_G723_1:
 245                 ast_atomic_fetchadd_int(&channels.encoders, -1);
 246                 break;
 247         default:
 248                 ast_atomic_fetchadd_int(&channels.decoders, -1);
 249                 break;
 250         }
 251
 252         munmap(ztp->hdr, sizeof(*ztp->hdr));
 253         close(ztp->fd);
 254 }
 255
 256 static int zap_translate(struct ast_trans_pvt *pvt, int dest, int source)
 257 {
 258         /* Request translation through zap if possible */
 259         int fd;
 260         unsigned int x = ZT_TCOP_ALLOCATE;
 261         struct pvt *ztp = pvt->pvt;
 262         struct zt_transcode_header *hdr;
 263         int flags;
 264
 265         if ((fd = open("/dev/zap/transcode", O_RDWR)) < 0)
 266                 return -1;
 267         flags = fcntl(fd, F_GETFL);
 268         if (flags > - 1) {
 269                 if (fcntl(fd, F_SETFL, flags | O_NONBLOCK))
 270                         ast_log(LOG_WARNING, "Could not set non-block mode!\n");
 271         }
 272
 273
 274         if ((hdr = mmap(NULL, sizeof(*hdr), PROT_READ|PROT_WRITE, MAP_SHARED, fd, 0)) == MAP_FAILED) {
 275                 ast_log(LOG_ERROR, "Memory Map failed for transcoding (%s)\n", strerror(errno));
 276                 close(fd);
 277
 278                 return -1;
 279         }
 280
 281         if (hdr->magic != ZT_TRANSCODE_MAGIC) {
 282                 ast_log(LOG_ERROR, "Transcoder header (%08x) wasn't magic.  Abandoning\n", hdr->magic);
 283                 munmap(hdr, sizeof(*hdr));
 284                 close(fd);
 285
 286                 return -1;
 287         }
 288
 289         hdr->srcfmt = (1 << source);
 290         hdr->dstfmt = (1 << dest);
 291         if (ioctl(fd, ZT_TRANSCODE_OP, &x)) {
 292                 ast_log(LOG_ERROR, "Unable to attach transcoder: %s\n", strerror(errno));
 293                 munmap(hdr, sizeof(*hdr));
 294                 close(fd);
 295
 296                 return -1;
 297         }
 298
 299         ztp = pvt->pvt;
 300         ztp->fd = fd;
 301         ztp->hdr = hdr;
 302
 303         switch (hdr->dstfmt) {
 304         case AST_FORMAT_G729A:
 305         case AST_FORMAT_G723_1:
 306                 ast_atomic_fetchadd_int(&channels.encoders, +1);
 307                 break;
 308         default:
 309                 ast_atomic_fetchadd_int(&channels.decoders, +1);
 310                 break;
 311         }
 312
 313         return 0;
 314 }
 315
 316 static int zap_new(struct ast_trans_pvt *pvt)
 317 {
 318         return zap_translate(pvt, pvt->t->dstfmt, pvt->t->srcfmt);
 319 }
 320
 321 static struct ast_frame *fakesrc_sample(void)
 322 {
 323         /* Don't bother really trying to test hardware ones. */
 324         static struct ast_frame f = {
 325                 .frametype = AST_FRAME_VOICE,
 326                 .samples = 160,
 327                 .src = __PRETTY_FUNCTION__
 328         };
 329
 330         return &f;
 331 }
 332
 333 static int register_translator(int dst, int src)
 334 {
 335         struct translator *zt;
 336         int res;
 337
 338         if (!(zt = ast_calloc(1, sizeof(*zt))))
 339                 return -1;
 340
 341         snprintf((char *) (zt->t.name), sizeof(zt->t.name), "zap%sto%s",
 342                  ast_getformatname((1 << src)), ast_getformatname((1 << dst)));
 343         zt->t.srcfmt = (1 << src);
 344         zt->t.dstfmt = (1 << dst);
 345         zt->t.newpvt = zap_new;
 346         zt->t.framein = zap_framein;
 347         zt->t.frameout = zap_frameout;
 348         zt->t.destroy = zap_destroy;
 349         zt->t.sample = fakesrc_sample;
 350         zt->t.useplc = global_useplc;
 351         zt->t.buf_size = BUFFER_SAMPLES * 2;
 352         zt->t.desc_size = sizeof(struct pvt);
 353         if ((res = ast_register_translator(&zt->t))) {
 354                 free(zt);
 355                 return -1;
 356         }
 357
 358         AST_LIST_LOCK(&translators);
 359         AST_LIST_INSERT_HEAD(&translators, zt, entry);
 360         AST_LIST_UNLOCK(&translators);
 361
 362         global_format_map.map[dst][src] = 1;
 363
 364         return res;
 365 }
 366
 367 static void drop_translator(int dst, int src)
 368 {
 369         struct translator *cur;
 370
 371         AST_LIST_LOCK(&translators);
 372         AST_LIST_TRAVERSE_SAFE_BEGIN(&translators, cur, entry) {
 373                 if (cur->t.srcfmt != src)
 374                         continue;
 375
 376                 if (cur->t.dstfmt != dst)
 377                         continue;
 378
 379                 AST_LIST_REMOVE_CURRENT(&translators, entry);
 380                 ast_unregister_translator(&cur->t);
 381                 free(cur);
 382                 global_format_map.map[dst][src] = 0;
 383                 break;
 384         }
 385         AST_LIST_TRAVERSE_SAFE_END;
 386         AST_LIST_UNLOCK(&translators);
 387 }
 388
 389 static void unregister_translators(void)
 390 {
 391         struct translator *cur;
 392
 393         AST_LIST_LOCK(&translators);
 394         while ((cur = AST_LIST_REMOVE_HEAD(&translators, entry))) {
 395                 ast_unregister_translator(&cur->t);
 396                 free(cur);
 397         }
 398         AST_LIST_UNLOCK(&translators);
 399 }
 400
 401 static void parse_config(void)
 402 {
 403         struct ast_variable *var;
 404         struct ast_config *cfg = ast_config_load("codecs.conf");
 405
 406         if (!cfg)
 407                 return;
 408
 409         for (var = ast_variable_browse(cfg, "plc"); var; var = var->next) {
 410                if (!strcasecmp(var->name, "genericplc")) {
 411                        global_useplc = ast_true(var->value);
 412                        if (option_verbose > 2)
 413                                ast_verbose(VERBOSE_PREFIX_3 "codec_zap: %susing generic PLC\n",
 414                                            global_useplc ? "" : "not ");
 415                }
 416         }
 417
 418         ast_config_destroy(cfg);
 419 }
 420
 421 static void build_translators(struct format_map *map, unsigned int dstfmts, unsigned int srcfmts)
 422 {
 423         unsigned int src, dst;
 424
 425         for (src = 0; src < 32; src++) {
 426                 for (dst = 0; dst < 32; dst++) {
 427                         if (!(srcfmts & (1 << src)))
 428                                 continue;
 429
 430                         if (!(dstfmts & (1 << dst)))
 431                                 continue;
 432
 433                         if (global_format_map.map[dst][src])
 434                                 continue;
 435
 436                         if (!register_translator(dst, src))
 437                                 map->map[dst][src] = 1;
 438                 }
 439         }
 440 }
 441
 442 static int find_transcoders(void)
 443 {
 444         struct zt_transcode_info info = { 0, };
 445         struct format_map map = { { { 0 } } };
 446         int fd, res;
 447         unsigned int x, y;
 448
 449         if ((fd = open("/dev/zap/transcode", O_RDWR)) < 0) {
 450                 ast_verbose(VERBOSE_PREFIX_2 "No hardware transcoders found.\n");
 451                 return 0;
 452         }
 453
 454         info.op = ZT_TCOP_GETINFO;
 455         for (info.tcnum = 0; !(res = ioctl(fd, ZT_TRANSCODE_OP, &info)); info.tcnum++) {
 456                 if (option_verbose > 1)
 457                         ast_verbose(VERBOSE_PREFIX_2 "Found transcoder '%s'.\n", info.name);
 458                 build_translators(&map, info.dstfmts, info.srcfmts);
 459                 ast_atomic_fetchadd_int(&channels.total, info.numchannels / 2);
 460         }
 461
 462         close(fd);
 463
 464         if (!info.tcnum && (option_verbose > 1))
 465                 ast_verbose(VERBOSE_PREFIX_2 "No hardware transcoders found.\n");
 466
 467         for (x = 0; x < 32; x++) {
 468                 for (y = 0; y < 32; y++) {
 469                         if (!map.map[x][y] && global_format_map.map[x][y])
 470                                 drop_translator(x, y);
 471                 }
 472         }
 473
 474         return 0;
 475 }
 476
 477 static int reload(void)
 478 {
 479         struct translator *cur;
 480
 481         parse_config();
 482
 483         AST_LIST_LOCK(&translators);
 484         AST_LIST_TRAVERSE(&translators, cur, entry)
 485                 cur->t.useplc = global_useplc;
 486         AST_LIST_UNLOCK(&translators);
 487
 488         return 0;
 489 }
 490
 491 static int unload_module(void)
 492 {
 493         ast_cli_unregister_multiple(cli, sizeof(cli) / sizeof(cli[0]));
 494         unregister_translators();
 495
 496         return 0;
 497 }
 498
 499 static int load_module(void)
 500 {
 501         parse_config();
 502         find_transcoders();
 503         ast_cli_register_multiple(cli, sizeof(cli) / sizeof(cli[0]));
 504
 505         return 0;
 506 }
 507
 508 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Generic Zaptel Transcoder Codec Translator",
 509                 .load = load_module,
 510                 .unload = unload_module,
 511                 .reload = reload,
 512                );