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