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 #ifdef DEBUG_TRANSCODE
 112         int totalms;
 113         int lasttotalms;
 114 #endif
 115         struct zt_transcode_header *hdr;
 116         struct ast_frame f;
 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 (hdr->srclen + f->datalen > sizeof(hdr->srcdata)) {
 150                 ast_log(LOG_WARNING, "Out of space for codec translation!\n");
 151                 return -1;
 152         }
 153
 154         if (hdr->srclen + f->datalen + hdr->srcoffset > sizeof(hdr->srcdata)) {
 155                 /* Very unlikely */
 156                 memmove(hdr->srcdata, hdr->srcdata + hdr->srcoffset, hdr->srclen);
 157                 hdr->srcoffset = 0;
 158         }
 159
 160         memcpy(hdr->srcdata + hdr->srcoffset + hdr->srclen, f->data, f->datalen);
 161         hdr->srclen += f->datalen;
 162         pvt->samples += f->samples;
 163
 164         return -1;
 165 }
 166
 167 static struct ast_frame *zap_frameout(struct ast_trans_pvt *pvt)
 168 {
 169         struct pvt *ztp = pvt->pvt;
 170         struct zt_transcode_header *hdr = ztp->hdr;
 171         unsigned int x;
 172
 173         if (ztp->fake == 2) {
 174                 ztp->fake = 1;
 175                 ztp->f.frametype = AST_FRAME_VOICE;
 176                 ztp->f.subclass = 0;
 177                 ztp->f.samples = 160;
 178                 ztp->f.data = NULL;
 179                 ztp->f.offset = 0;
 180                 ztp->f.datalen = 0;
 181                 ztp->f.mallocd = 0;
 182                 pvt->samples = 0;
 183         } else if (ztp->fake == 1) {
 184                 return NULL;
 185         } else {
 186                 if (hdr->dstlen) {
 187 #ifdef DEBUG_TRANSCODE
 188                         ztp->totalms += hdr->dstsamples;
 189                         if ((ztp->totalms - ztp->lasttotalms) > 8000) {
 190                                 printf("Whee %p, %d (%d to %d)\n", ztp, hdr->dstlen, ztp->lasttotalms, ztp->totalms);
 191                                 ztp->lasttotalms = ztp->totalms;
 192                         }
 193 #endif
 194                         ztp->f.frametype = AST_FRAME_VOICE;
 195                         ztp->f.subclass = hdr->dstfmt;
 196                         ztp->f.samples = hdr->dstsamples;
 197                         ztp->f.data = hdr->dstdata + hdr->dstoffset;
 198                         ztp->f.offset = hdr->dstoffset;
 199                         ztp->f.datalen = hdr->dstlen;
 200                         ztp->f.mallocd = 0;
 201                         pvt->samples -= ztp->f.samples;
 202                         hdr->dstlen = 0;
 203
 204                 } else {
 205                         if (hdr->srclen) {
 206                                 hdr->dstoffset = AST_FRIENDLY_OFFSET;
 207                                 x = ZT_TCOP_TRANSCODE;
 208                                 if (ioctl(ztp->fd, ZT_TRANSCODE_OP, &x))
 209                                         ast_log(LOG_WARNING, "Failed to transcode: %s\n", strerror(errno));
 210                         }
 211                         return NULL;
 212                 }
 213         }
 214
 215         return &ztp->f;
 216 }
 217
 218 static void zap_destroy(struct ast_trans_pvt *pvt)
 219 {
 220         struct pvt *ztp = pvt->pvt;
 221
 222         ast_atomic_fetchadd_int(&channels.total, -1);
 223         switch (ztp->hdr->dstfmt) {
 224         case AST_FORMAT_G729A:
 225         case AST_FORMAT_G723_1:
 226                 ast_atomic_fetchadd_int(&channels.encoders, -1);
 227                 break;
 228         default:
 229                 ast_atomic_fetchadd_int(&channels.decoders, -1);
 230                 break;
 231         }
 232
 233         munmap(ztp->hdr, sizeof(*ztp->hdr));
 234         close(ztp->fd);
 235 }
 236
 237 static int zap_translate(struct ast_trans_pvt *pvt, int dest, int source)
 238 {
 239         /* Request translation through zap if possible */
 240         int fd;
 241         unsigned int x = ZT_TCOP_ALLOCATE;
 242         struct pvt *ztp = pvt->pvt;
 243         struct zt_transcode_header *hdr;
 244         int flags;
 245
 246         if ((fd = open("/dev/zap/transcode", O_RDWR)) < 0)
 247                 return -1;
 248         flags = fcntl(fd, F_GETFL);
 249         if (flags > - 1) {
 250                 if (fcntl(fd, F_SETFL, flags | O_NONBLOCK))
 251                         ast_log(LOG_WARNING, "Could not set non-block mode!\n");
 252         }
 253
 254
 255         if ((hdr = mmap(NULL, sizeof(*hdr), PROT_READ|PROT_WRITE, MAP_SHARED, fd, 0)) == MAP_FAILED) {
 256                 ast_log(LOG_ERROR, "Memory Map failed for transcoding (%s)\n", strerror(errno));
 257                 close(fd);
 258
 259                 return -1;
 260         }
 261
 262         if (hdr->magic != ZT_TRANSCODE_MAGIC) {
 263                 ast_log(LOG_ERROR, "Transcoder header (%08x) wasn't magic.  Abandoning\n", hdr->magic);
 264                 munmap(hdr, sizeof(*hdr));
 265                 close(fd);
 266
 267                 return -1;
 268         }
 269
 270         hdr->srcfmt = (1 << source);
 271         hdr->dstfmt = (1 << dest);
 272         if (ioctl(fd, ZT_TRANSCODE_OP, &x)) {
 273                 ast_log(LOG_ERROR, "Unable to attach transcoder: %s\n", strerror(errno));
 274                 munmap(hdr, sizeof(*hdr));
 275                 close(fd);
 276
 277                 return -1;
 278         }
 279
 280         ztp = pvt->pvt;
 281         ztp->fd = fd;
 282         ztp->hdr = hdr;
 283
 284         ast_atomic_fetchadd_int(&channels.total, +1);
 285         switch (hdr->dstfmt) {
 286         case AST_FORMAT_G729A:
 287         case AST_FORMAT_G723_1:
 288                 ast_atomic_fetchadd_int(&channels.encoders, +1);
 289                 break;
 290         default:
 291                 ast_atomic_fetchadd_int(&channels.decoders, +1);
 292                 break;
 293         }
 294
 295         return 0;
 296 }
 297
 298 static int zap_new(struct ast_trans_pvt *pvt)
 299 {
 300         return zap_translate(pvt, pvt->t->dstfmt, pvt->t->srcfmt);
 301 }
 302
 303 static struct ast_frame *fakesrc_sample(void)
 304 {
 305         /* Don't bother really trying to test hardware ones. */
 306         static struct ast_frame f = {
 307                 .frametype = AST_FRAME_VOICE,
 308                 .samples = 160,
 309                 .src = __PRETTY_FUNCTION__
 310         };
 311
 312         return &f;
 313 }
 314
 315 static int register_translator(int dst, int src)
 316 {
 317         struct translator *zt;
 318         int res;
 319
 320         if (!(zt = ast_calloc(1, sizeof(*zt))))
 321                 return -1;
 322
 323         snprintf((char *) (zt->t.name), sizeof(zt->t.name), "zap%sto%s",
 324                  ast_getformatname((1 << src)), ast_getformatname((1 << dst)));
 325         zt->t.srcfmt = (1 << src);
 326         zt->t.dstfmt = (1 << dst);
 327         zt->t.newpvt = zap_new;
 328         zt->t.framein = zap_framein;
 329         zt->t.frameout = zap_frameout;
 330         zt->t.destroy = zap_destroy;
 331         zt->t.sample = fakesrc_sample;
 332         zt->t.useplc = global_useplc;
 333         zt->t.buf_size = BUFFER_SAMPLES * 2;
 334         zt->t.desc_size = sizeof(struct pvt);
 335         if ((res = ast_register_translator(&zt->t))) {
 336                 free(zt);
 337                 return -1;
 338         }
 339
 340         AST_LIST_LOCK(&translators);
 341         AST_LIST_INSERT_HEAD(&translators, zt, entry);
 342         AST_LIST_UNLOCK(&translators);
 343
 344         global_format_map.map[dst][src] = 1;
 345
 346         return res;
 347 }
 348
 349 static void drop_translator(int dst, int src)
 350 {
 351         struct translator *cur;
 352
 353         AST_LIST_LOCK(&translators);
 354         AST_LIST_TRAVERSE_SAFE_BEGIN(&translators, cur, entry) {
 355                 if (cur->t.srcfmt != src)
 356                         continue;
 357
 358                 if (cur->t.dstfmt != dst)
 359                         continue;
 360
 361                 AST_LIST_REMOVE_CURRENT(&translators, entry);
 362                 ast_unregister_translator(&cur->t);
 363                 free(cur);
 364                 global_format_map.map[dst][src] = 0;
 365                 break;
 366         }
 367         AST_LIST_TRAVERSE_SAFE_END;
 368         AST_LIST_UNLOCK(&translators);
 369 }
 370
 371 static void unregister_translators(void)
 372 {
 373         struct translator *cur;
 374
 375         AST_LIST_LOCK(&translators);
 376         while ((cur = AST_LIST_REMOVE_HEAD(&translators, entry))) {
 377                 ast_unregister_translator(&cur->t);
 378                 free(cur);
 379         }
 380         AST_LIST_UNLOCK(&translators);
 381 }
 382
 383 static void parse_config(void)
 384 {
 385         struct ast_variable *var;
 386         struct ast_config *cfg = ast_config_load("codecs.conf");
 387
 388         if (!cfg)
 389                 return;
 390
 391         for (var = ast_variable_browse(cfg, "plc"); var; var = var->next) {
 392                if (!strcasecmp(var->name, "genericplc")) {
 393                        global_useplc = ast_true(var->value);
 394                        if (option_verbose > 2)
 395                                ast_verbose(VERBOSE_PREFIX_3 "codec_zap: %susing generic PLC\n",
 396                                            global_useplc ? "" : "not ");
 397                }
 398         }
 399
 400         ast_config_destroy(cfg);
 401 }
 402
 403 static void build_translators(struct format_map *map, unsigned int dstfmts, unsigned int srcfmts)
 404 {
 405         unsigned int src, dst;
 406
 407         for (src = 0; src < 32; src++) {
 408                 for (dst = 0; dst < 32; dst++) {
 409                         if (!(srcfmts & (1 << src)))
 410                                 continue;
 411
 412                         if (!(dstfmts & (1 << dst)))
 413                                 continue;
 414
 415                         if (global_format_map.map[dst][src])
 416                                 continue;
 417
 418                         if (!register_translator(dst, src))
 419                                 map->map[dst][src] = 1;
 420                 }
 421         }
 422 }
 423
 424 static int find_transcoders(void)
 425 {
 426         struct zt_transcode_info info = { 0, };
 427         struct format_map map = { { { 0 } } };
 428         int fd, res;
 429         unsigned int x, y;
 430
 431         info.op = ZT_TCOP_GETINFO;
 432         if ((fd = open("/dev/zap/transcode", O_RDWR)) < 0) {
 433                 ast_log(LOG_DEBUG, "No Zaptel transcoder support!\n");
 434                 return 0;
 435         }
 436         for (info.tcnum = 0; !(res = ioctl(fd, ZT_TRANSCODE_OP, &info)); info.tcnum++) {
 437                 if (option_verbose > 1)
 438                         ast_verbose(VERBOSE_PREFIX_2 "Found transcoder '%s'.\n", info.name);
 439                 build_translators(&map, info.dstfmts, info.srcfmts);
 440         }
 441         close(fd);
 442
 443         if (!info.tcnum && (option_verbose > 1))
 444                 ast_verbose(VERBOSE_PREFIX_2 "No hardware transcoders found.\n");
 445
 446         for (x = 0; x < 32; x++) {
 447                 for (y = 0; y < 32; y++) {
 448                         if (!map.map[x][y] && global_format_map.map[x][y])
 449                                 drop_translator(x, y);
 450                 }
 451         }
 452
 453         return 0;
 454 }
 455
 456 static int reload(void)
 457 {
 458         struct translator *cur;
 459
 460         parse_config();
 461
 462         AST_LIST_LOCK(&translators);
 463         AST_LIST_TRAVERSE(&translators, cur, entry)
 464                 cur->t.useplc = global_useplc;
 465         AST_LIST_UNLOCK(&translators);
 466
 467         return 0;
 468 }
 469
 470 static int unload_module(void)
 471 {
 472         ast_cli_unregister_multiple(cli, sizeof(cli) / sizeof(cli[0]));
 473         unregister_translators();
 474
 475         return 0;
 476 }
 477
 478 static int load_module(void)
 479 {
 480         parse_config();
 481         find_transcoders();
 482         ast_cli_register_multiple(cli, sizeof(cli) / sizeof(cli[0]));
 483
 484         return 0;
 485 }
 486
 487 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Generic Zaptel Transcoder Codec Translator",
 488                 .load = load_module,
 489                 .unload = unload_module,
 490                 .reload = reload,
 491                );