main/frame.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 1999 - 2005, Digium, Inc.
   5  *
   6  * Mark Spencer <markster@digium.com>
   7  *
   8  * See http://www.asterisk.org for more information about
   9  * the Asterisk project. Please do not directly contact
  10  * any of the maintainers of this project for assistance;
  11  * the project provides a web site, mailing lists and IRC
  12  * channels for your use.
  13  *
  14  * This program is free software, distributed under the terms of
  15  * the GNU General Public License Version 2. See the LICENSE file
  16  * at the top of the source tree.
  17  */
  18
  19 /*! \file
  20  *
  21  * \brief Frame and codec manipulation routines
  22  *
  23  * \author Mark Spencer <markster@digium.com>
  24  */
  25
  26 #include "asterisk.h"
  27
  28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  29
  30 #include "asterisk/_private.h"
  31 #include "asterisk/lock.h"
  32 #include "asterisk/frame.h"
  33 #include "asterisk/channel.h"
  34 #include "asterisk/cli.h"
  35 #include "asterisk/term.h"
  36 #include "asterisk/utils.h"
  37 #include "asterisk/threadstorage.h"
  38 #include "asterisk/linkedlists.h"
  39 #include "asterisk/translate.h"
  40 #include "asterisk/dsp.h"
  41 #include "asterisk/file.h"
  42
  43 #if !defined(LOW_MEMORY)
  44 static void frame_cache_cleanup(void *data);
  45
  46 /*! \brief A per-thread cache of frame headers */
  47 AST_THREADSTORAGE_CUSTOM(frame_cache, NULL, frame_cache_cleanup);
  48
  49 /*!
  50  * \brief Maximum ast_frame cache size
  51  *
  52  * In most cases where the frame header cache will be useful, the size
  53  * of the cache will stay very small.  However, it is not always the case that
  54  * the same thread that allocates the frame will be the one freeing them, so
  55  * sometimes a thread will never have any frames in its cache, or the cache
  56  * will never be pulled from.  For the latter case, we limit the maximum size.
  57  */
  58 #define FRAME_CACHE_MAX_SIZE    10
  59
  60 /*! \brief This is just so ast_frames, a list head struct for holding a list of
  61  *  ast_frame structures, is defined. */
  62 AST_LIST_HEAD_NOLOCK(ast_frames, ast_frame);
  63
  64 struct ast_frame_cache {
  65         struct ast_frames list;
  66         size_t size;
  67 };
  68 #endif
  69
  70 #define SMOOTHER_SIZE 8000
  71
  72 enum frame_type {
  73         TYPE_HIGH,     /* 0x0 */
  74         TYPE_LOW,      /* 0x1 */
  75         TYPE_SILENCE,  /* 0x2 */
  76         TYPE_DONTSEND  /* 0x3 */
  77 };
  78
  79 #define TYPE_MASK 0x3
  80
  81 struct ast_smoother {
  82         int size;
  83         format_t format;
  84         int flags;
  85         float samplesperbyte;
  86         unsigned int opt_needs_swap:1;
  87         struct ast_frame f;
  88         struct timeval delivery;
  89         char data[SMOOTHER_SIZE];
  90         char framedata[SMOOTHER_SIZE + AST_FRIENDLY_OFFSET];
  91         struct ast_frame *opt;
  92         int len;
  93 };
  94
  95 /*! \brief Definition of supported media formats (codecs) */
  96 static const struct ast_format_list AST_FORMAT_LIST[] = {
  97         { AST_FORMAT_G723_1 , "g723", 8000, "G.723.1", 20, 30, 300, 30, 30 },                                  /*!< G723.1 */
  98         { AST_FORMAT_GSM, "gsm", 8000, "GSM", 33, 20, 300, 20, 20 },                                           /*!< codec_gsm.c */
  99         { AST_FORMAT_ULAW, "ulaw", 8000, "G.711 u-law", 80, 10, 150, 10, 20 },                                 /*!< codec_ulaw.c */
 100         { AST_FORMAT_ALAW, "alaw", 8000, "G.711 A-law", 80, 10, 150, 10, 20 },                                 /*!< codec_alaw.c */
 101         { AST_FORMAT_G726, "g726", 8000, "G.726 RFC3551", 40, 10, 300, 10, 20 },                               /*!< codec_g726.c */
 102         { AST_FORMAT_ADPCM, "adpcm" , 8000, "ADPCM", 40, 10, 300, 10, 20 },                                    /*!< codec_adpcm.c */
 103         { AST_FORMAT_SLINEAR, "slin", 8000, "16 bit Signed Linear PCM", 160, 10, 70, 10, 20, AST_SMOOTHER_FLAG_BE }, /*!< Signed linear */
 104         { AST_FORMAT_LPC10, "lpc10", 8000, "LPC10", 7, 20, 20, 20, 20 },                                       /*!< codec_lpc10.c */
 105         { AST_FORMAT_G729A, "g729", 8000, "G.729A", 10, 10, 230, 10, 20, AST_SMOOTHER_FLAG_G729 },             /*!< Binary commercial distribution */
 106         { AST_FORMAT_SPEEX, "speex", 8000, "SpeeX", 10, 10, 60, 10, 20 },                                      /*!< codec_speex.c */
 107         { AST_FORMAT_ILBC, "ilbc", 8000, "iLBC", 50, 30, 30, 30, 30 },                                         /*!< codec_ilbc.c */ /* inc=30ms - workaround */
 108         { AST_FORMAT_G726_AAL2, "g726aal2", 8000, "G.726 AAL2", 40, 10, 300, 10, 20 },                         /*!< codec_g726.c */
 109         { AST_FORMAT_G722, "g722", 16000, "G722", 80, 10, 150, 10, 20 },                                       /*!< codec_g722.c */
 110         { AST_FORMAT_SLINEAR16, "slin16", 16000, "16 bit Signed Linear PCM (16kHz)", 320, 10, 70, 10, 20, AST_SMOOTHER_FLAG_BE },    /*!< Signed linear (16kHz) */
 111         { AST_FORMAT_JPEG, "jpeg", 0, "JPEG image"},                                                           /*!< See format_jpeg.c */
 112         { AST_FORMAT_PNG, "png", 0, "PNG image"},                                                              /*!< PNG Image format */
 113         { AST_FORMAT_H261, "h261", 0, "H.261 Video" },                                                         /*!< H.261 Video Passthrough */
 114         { AST_FORMAT_H263, "h263", 0, "H.263 Video" },                                                         /*!< H.263 Passthrough support, see format_h263.c */
 115         { AST_FORMAT_H263_PLUS, "h263p", 0, "H.263+ Video" },                                                  /*!< H.263plus passthrough support See format_h263.c */
 116         { AST_FORMAT_H264, "h264", 0, "H.264 Video" },                                                         /*!< Passthrough support, see format_h263.c */
 117         { AST_FORMAT_MP4_VIDEO, "mpeg4", 0, "MPEG4 Video" },                                                   /*!< Passthrough support for MPEG4 */
 118         { AST_FORMAT_T140RED, "red", 1, "T.140 Realtime Text with redundancy"},                                /*!< Redundant T.140 Realtime Text */
 119         { AST_FORMAT_T140, "t140", 0, "Passthrough T.140 Realtime Text" },                                     /*!< Passthrough support for T.140 Realtime Text */
 120         { AST_FORMAT_SIREN7, "siren7", 16000, "ITU G.722.1 (Siren7, licensed from Polycom)", 80, 20, 80, 20, 20 },                      /*!< Binary commercial distribution */
 121         { AST_FORMAT_SIREN14, "siren14", 32000, "ITU G.722.1 Annex C, (Siren14, licensed from Polycom)", 120, 20, 80, 20, 20 }, /*!< Binary commercial distribution */
 122         { AST_FORMAT_TESTLAW, "testlaw", 8000, "G.711 test-law", 80, 10, 150, 10, 20 },                                 /*!< codec_ulaw.c */
 123 };
 124
 125 struct ast_frame ast_null_frame = { AST_FRAME_NULL, };
 126
 127 static int smoother_frame_feed(struct ast_smoother *s, struct ast_frame *f, int swap)
 128 {
 129         if (s->flags & AST_SMOOTHER_FLAG_G729) {
 130                 if (s->len % 10) {
 131                         ast_log(LOG_NOTICE, "Dropping extra frame of G.729 since we already have a VAD frame at the end\n");
 132                         return 0;
 133                 }
 134         }
 135         if (swap) {
 136                 ast_swapcopy_samples(s->data + s->len, f->data.ptr, f->samples);
 137         } else {
 138                 memcpy(s->data + s->len, f->data.ptr, f->datalen);
 139         }
 140         /* If either side is empty, reset the delivery time */
 141         if (!s->len || ast_tvzero(f->delivery) || ast_tvzero(s->delivery)) {    /* XXX really ? */
 142                 s->delivery = f->delivery;
 143         }
 144         s->len += f->datalen;
 145
 146         return 0;
 147 }
 148
 149 void ast_smoother_reset(struct ast_smoother *s, int bytes)
 150 {
 151         memset(s, 0, sizeof(*s));
 152         s->size = bytes;
 153 }
 154
 155 void ast_smoother_reconfigure(struct ast_smoother *s, int bytes)
 156 {
 157         /* if there is no change, then nothing to do */
 158         if (s->size == bytes) {
 159                 return;
 160         }
 161         /* set the new desired output size */
 162         s->size = bytes;
 163         /* if there is no 'optimized' frame in the smoother,
 164          *   then there is nothing left to do
 165          */
 166         if (!s->opt) {
 167                 return;
 168         }
 169         /* there is an 'optimized' frame here at the old size,
 170          * but it must now be put into the buffer so the data
 171          * can be extracted at the new size
 172          */
 173         smoother_frame_feed(s, s->opt, s->opt_needs_swap);
 174         s->opt = NULL;
 175 }
 176
 177 struct ast_smoother *ast_smoother_new(int size)
 178 {
 179         struct ast_smoother *s;
 180         if (size < 1)
 181                 return NULL;
 182         if ((s = ast_malloc(sizeof(*s))))
 183                 ast_smoother_reset(s, size);
 184         return s;
 185 }
 186
 187 int ast_smoother_get_flags(struct ast_smoother *s)
 188 {
 189         return s->flags;
 190 }
 191
 192 void ast_smoother_set_flags(struct ast_smoother *s, int flags)
 193 {
 194         s->flags = flags;
 195 }
 196
 197 int ast_smoother_test_flag(struct ast_smoother *s, int flag)
 198 {
 199         return (s->flags & flag);
 200 }
 201
 202 int __ast_smoother_feed(struct ast_smoother *s, struct ast_frame *f, int swap)
 203 {
 204         if (f->frametype != AST_FRAME_VOICE) {
 205                 ast_log(LOG_WARNING, "Huh?  Can't smooth a non-voice frame!\n");
 206                 return -1;
 207         }
 208         if (!s->format) {
 209                 s->format = f->subclass.codec;
 210                 s->samplesperbyte = (float)f->samples / (float)f->datalen;
 211         } else if (s->format != f->subclass.codec) {
 212                 ast_log(LOG_WARNING, "Smoother was working on %s format frames, now trying to feed %s?\n",
 213                         ast_getformatname(s->format), ast_getformatname(f->subclass.codec));
 214                 return -1;
 215         }
 216         if (s->len + f->datalen > SMOOTHER_SIZE) {
 217                 ast_log(LOG_WARNING, "Out of smoother space\n");
 218                 return -1;
 219         }
 220         if (((f->datalen == s->size) ||
 221              ((f->datalen < 10) && (s->flags & AST_SMOOTHER_FLAG_G729))) &&
 222             !s->opt &&
 223             !s->len &&
 224             (f->offset >= AST_MIN_OFFSET)) {
 225                 /* Optimize by sending the frame we just got
 226                    on the next read, thus eliminating the douple
 227                    copy */
 228                 if (swap)
 229                         ast_swapcopy_samples(f->data.ptr, f->data.ptr, f->samples);
 230                 s->opt = f;
 231                 s->opt_needs_swap = swap ? 1 : 0;
 232                 return 0;
 233         }
 234
 235         return smoother_frame_feed(s, f, swap);
 236 }
 237
 238 struct ast_frame *ast_smoother_read(struct ast_smoother *s)
 239 {
 240         struct ast_frame *opt;
 241         int len;
 242
 243         /* IF we have an optimization frame, send it */
 244         if (s->opt) {
 245                 if (s->opt->offset < AST_FRIENDLY_OFFSET)
 246                         ast_log(LOG_WARNING, "Returning a frame of inappropriate offset (%d).\n",
 247                                                         s->opt->offset);
 248                 opt = s->opt;
 249                 s->opt = NULL;
 250                 return opt;
 251         }
 252
 253         /* Make sure we have enough data */
 254         if (s->len < s->size) {
 255                 /* Or, if this is a G.729 frame with VAD on it, send it immediately anyway */
 256                 if (!((s->flags & AST_SMOOTHER_FLAG_G729) && (s->len % 10)))
 257                         return NULL;
 258         }
 259         len = s->size;
 260         if (len > s->len)
 261                 len = s->len;
 262         /* Make frame */
 263         s->f.frametype = AST_FRAME_VOICE;
 264         s->f.subclass.codec = s->format;
 265         s->f.data.ptr = s->framedata + AST_FRIENDLY_OFFSET;
 266         s->f.offset = AST_FRIENDLY_OFFSET;
 267         s->f.datalen = len;
 268         /* Samples will be improper given VAD, but with VAD the concept really doesn't even exist */
 269         s->f.samples = len * s->samplesperbyte; /* XXX rounding */
 270         s->f.delivery = s->delivery;
 271         /* Fill Data */
 272         memcpy(s->f.data.ptr, s->data, len);
 273         s->len -= len;
 274         /* Move remaining data to the front if applicable */
 275         if (s->len) {
 276                 /* In principle this should all be fine because if we are sending
 277                    G.729 VAD, the next timestamp will take over anyawy */
 278                 memmove(s->data, s->data + len, s->len);
 279                 if (!ast_tvzero(s->delivery)) {
 280                         /* If we have delivery time, increment it, otherwise, leave it at 0 */
 281                         s->delivery = ast_tvadd(s->delivery, ast_samp2tv(s->f.samples, ast_format_rate(s->format)));
 282                 }
 283         }
 284         /* Return frame */
 285         return &s->f;
 286 }
 287
 288 void ast_smoother_free(struct ast_smoother *s)
 289 {
 290         ast_free(s);
 291 }
 292
 293 static struct ast_frame *ast_frame_header_new(void)
 294 {
 295         struct ast_frame *f;
 296
 297 #if !defined(LOW_MEMORY)
 298         struct ast_frame_cache *frames;
 299
 300         if ((frames = ast_threadstorage_get(&frame_cache, sizeof(*frames)))) {
 301                 if ((f = AST_LIST_REMOVE_HEAD(&frames->list, frame_list))) {
 302                         size_t mallocd_len = f->mallocd_hdr_len;
 303                         memset(f, 0, sizeof(*f));
 304                         f->mallocd_hdr_len = mallocd_len;
 305                         f->mallocd = AST_MALLOCD_HDR;
 306                         frames->size--;
 307                         return f;
 308                 }
 309         }
 310         if (!(f = ast_calloc_cache(1, sizeof(*f))))
 311                 return NULL;
 312 #else
 313         if (!(f = ast_calloc(1, sizeof(*f))))
 314                 return NULL;
 315 #endif
 316
 317         f->mallocd_hdr_len = sizeof(*f);
 318
 319         return f;
 320 }
 321
 322 #if !defined(LOW_MEMORY)
 323 static void frame_cache_cleanup(void *data)
 324 {
 325         struct ast_frame_cache *frames = data;
 326         struct ast_frame *f;
 327
 328         while ((f = AST_LIST_REMOVE_HEAD(&frames->list, frame_list)))
 329                 ast_free(f);
 330
 331         ast_free(frames);
 332 }
 333 #endif
 334
 335 static void __frame_free(struct ast_frame *fr, int cache)
 336 {
 337         if (!fr->mallocd)
 338                 return;
 339
 340 #if !defined(LOW_MEMORY)
 341         if (cache && fr->mallocd == AST_MALLOCD_HDR) {
 342                 /* Cool, only the header is malloc'd, let's just cache those for now
 343                  * to keep things simple... */
 344                 struct ast_frame_cache *frames;
 345
 346                 if ((frames = ast_threadstorage_get(&frame_cache, sizeof(*frames))) &&
 347                     (frames->size < FRAME_CACHE_MAX_SIZE)) {
 348                         AST_LIST_INSERT_HEAD(&frames->list, fr, frame_list);
 349                         frames->size++;
 350                         return;
 351                 }
 352         }
 353 #endif
 354
 355         if (fr->mallocd & AST_MALLOCD_DATA) {
 356                 if (fr->data.ptr)
 357                         ast_free(fr->data.ptr - fr->offset);
 358         }
 359         if (fr->mallocd & AST_MALLOCD_SRC) {
 360                 if (fr->src)
 361                         ast_free((void *) fr->src);
 362         }
 363         if (fr->mallocd & AST_MALLOCD_HDR) {
 364                 ast_free(fr);
 365         }
 366 }
 367
 368
 369 void ast_frame_free(struct ast_frame *frame, int cache)
 370 {
 371         struct ast_frame *next;
 372
 373         for (next = AST_LIST_NEXT(frame, frame_list);
 374              frame;
 375              frame = next, next = frame ? AST_LIST_NEXT(frame, frame_list) : NULL) {
 376                 __frame_free(frame, cache);
 377         }
 378 }
 379
 380 /*!
 381  * \brief 'isolates' a frame by duplicating non-malloc'ed components
 382  * (header, src, data).
 383  * On return all components are malloc'ed
 384  */
 385 struct ast_frame *ast_frisolate(struct ast_frame *fr)
 386 {
 387         struct ast_frame *out;
 388         void *newdata;
 389
 390         /* if none of the existing frame is malloc'd, let ast_frdup() do it
 391            since it is more efficient
 392         */
 393         if (fr->mallocd == 0) {
 394                 return ast_frdup(fr);
 395         }
 396
 397         /* if everything is already malloc'd, we are done */
 398         if ((fr->mallocd & (AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA)) ==
 399             (AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA)) {
 400                 return fr;
 401         }
 402
 403         if (!(fr->mallocd & AST_MALLOCD_HDR)) {
 404                 /* Allocate a new header if needed */
 405                 if (!(out = ast_frame_header_new())) {
 406                         return NULL;
 407                 }
 408                 out->frametype = fr->frametype;
 409                 out->subclass.codec = fr->subclass.codec;
 410                 out->datalen = fr->datalen;
 411                 out->samples = fr->samples;
 412                 out->offset = fr->offset;
 413                 /* Copy the timing data */
 414                 ast_copy_flags(out, fr, AST_FRFLAG_HAS_TIMING_INFO);
 415                 if (ast_test_flag(fr, AST_FRFLAG_HAS_TIMING_INFO)) {
 416                         out->ts = fr->ts;
 417                         out->len = fr->len;
 418                         out->seqno = fr->seqno;
 419                 }
 420         } else {
 421                 out = fr;
 422         }
 423
 424         if (!(fr->mallocd & AST_MALLOCD_SRC) && fr->src) {
 425                 if (!(out->src = ast_strdup(fr->src))) {
 426                         if (out != fr) {
 427                                 ast_free(out);
 428                         }
 429                         return NULL;
 430                 }
 431         } else {
 432                 out->src = fr->src;
 433                 fr->src = NULL;
 434                 fr->mallocd &= ~AST_MALLOCD_SRC;
 435         }
 436
 437         if (!(fr->mallocd & AST_MALLOCD_DATA))  {
 438                 if (!(newdata = ast_malloc(fr->datalen + AST_FRIENDLY_OFFSET))) {
 439                         if (out->src != fr->src) {
 440                                 ast_free((void *) out->src);
 441                         }
 442                         if (out != fr) {
 443                                 ast_free(out);
 444                         }
 445                         return NULL;
 446                 }
 447                 newdata += AST_FRIENDLY_OFFSET;
 448                 out->offset = AST_FRIENDLY_OFFSET;
 449                 out->datalen = fr->datalen;
 450                 memcpy(newdata, fr->data.ptr, fr->datalen);
 451                 out->data.ptr = newdata;
 452         } else {
 453                 out->data = fr->data;
 454                 memset(&fr->data, 0, sizeof(fr->data));
 455                 fr->mallocd &= ~AST_MALLOCD_DATA;
 456         }
 457
 458         out->mallocd = AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA;
 459
 460         return out;
 461 }
 462
 463 struct ast_frame *ast_frdup(const struct ast_frame *f)
 464 {
 465         struct ast_frame *out = NULL;
 466         int len, srclen = 0;
 467         void *buf = NULL;
 468
 469 #if !defined(LOW_MEMORY)
 470         struct ast_frame_cache *frames;
 471 #endif
 472
 473         /* Start with standard stuff */
 474         len = sizeof(*out) + AST_FRIENDLY_OFFSET + f->datalen;
 475         /* If we have a source, add space for it */
 476         /*
 477          * XXX Watch out here - if we receive a src which is not terminated
 478          * properly, we can be easily attacked. Should limit the size we deal with.
 479          */
 480         if (f->src)
 481                 srclen = strlen(f->src);
 482         if (srclen > 0)
 483                 len += srclen + 1;
 484
 485 #if !defined(LOW_MEMORY)
 486         if ((frames = ast_threadstorage_get(&frame_cache, sizeof(*frames)))) {
 487                 AST_LIST_TRAVERSE_SAFE_BEGIN(&frames->list, out, frame_list) {
 488                         if (out->mallocd_hdr_len >= len) {
 489                                 size_t mallocd_len = out->mallocd_hdr_len;
 490
 491                                 AST_LIST_REMOVE_CURRENT(frame_list);
 492                                 memset(out, 0, sizeof(*out));
 493                                 out->mallocd_hdr_len = mallocd_len;
 494                                 buf = out;
 495                                 frames->size--;
 496                                 break;
 497                         }
 498                 }
 499                 AST_LIST_TRAVERSE_SAFE_END;
 500         }
 501 #endif
 502
 503         if (!buf) {
 504                 if (!(buf = ast_calloc_cache(1, len)))
 505                         return NULL;
 506                 out = buf;
 507                 out->mallocd_hdr_len = len;
 508         }
 509
 510         out->frametype = f->frametype;
 511         out->subclass.codec = f->subclass.codec;
 512         out->datalen = f->datalen;
 513         out->samples = f->samples;
 514         out->delivery = f->delivery;
 515         /* Set us as having malloc'd header only, so it will eventually
 516            get freed. */
 517         out->mallocd = AST_MALLOCD_HDR;
 518         out->offset = AST_FRIENDLY_OFFSET;
 519         if (out->datalen) {
 520                 out->data.ptr = buf + sizeof(*out) + AST_FRIENDLY_OFFSET;
 521                 memcpy(out->data.ptr, f->data.ptr, out->datalen);
 522         } else {
 523                 out->data.uint32 = f->data.uint32;
 524         }
 525         if (srclen > 0) {
 526                 /* This may seem a little strange, but it's to avoid a gcc (4.2.4) compiler warning */
 527                 char *src;
 528                 out->src = buf + sizeof(*out) + AST_FRIENDLY_OFFSET + f->datalen;
 529                 src = (char *) out->src;
 530                 /* Must have space since we allocated for it */
 531                 strcpy(src, f->src);
 532         }
 533         ast_copy_flags(out, f, AST_FRFLAG_HAS_TIMING_INFO);
 534         out->ts = f->ts;
 535         out->len = f->len;
 536         out->seqno = f->seqno;
 537         return out;
 538 }
 539
 540 void ast_swapcopy_samples(void *dst, const void *src, int samples)
 541 {
 542         int i;
 543         unsigned short *dst_s = dst;
 544         const unsigned short *src_s = src;
 545
 546         for (i = 0; i < samples; i++)
 547                 dst_s[i] = (src_s[i]<<8) | (src_s[i]>>8);
 548 }
 549
 550
 551 const struct ast_format_list *ast_get_format_list_index(int idx)
 552 {
 553         return &AST_FORMAT_LIST[idx];
 554 }
 555
 556 const struct ast_format_list *ast_get_format_list(size_t *size)
 557 {
 558         *size = ARRAY_LEN(AST_FORMAT_LIST);
 559         return AST_FORMAT_LIST;
 560 }
 561
 562 char* ast_getformatname(format_t format)
 563 {
 564         int x;
 565         char *ret = "unknown";
 566         for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
 567                 if (AST_FORMAT_LIST[x].bits == format) {
 568                         ret = AST_FORMAT_LIST[x].name;
 569                         break;
 570                 }
 571         }
 572         return ret;
 573 }
 574
 575 char *ast_getformatname_multiple(char *buf, size_t size, format_t format)
 576 {
 577         int x;
 578         unsigned len;
 579         char *start, *end = buf;
 580
 581         if (!size)
 582                 return buf;
 583         snprintf(end, size, "0x%llx (", (unsigned long long) format);
 584         len = strlen(end);
 585         end += len;
 586         size -= len;
 587         start = end;
 588         for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
 589                 if (AST_FORMAT_LIST[x].bits & format) {
 590                         snprintf(end, size, "%s|", AST_FORMAT_LIST[x].name);
 591                         len = strlen(end);
 592                         end += len;
 593                         size -= len;
 594                 }
 595         }
 596         if (start == end)
 597                 ast_copy_string(start, "nothing)", size);
 598         else if (size > 1)
 599                 *(end - 1) = ')';
 600         return buf;
 601 }
 602
 603 static struct ast_codec_alias_table {
 604         char *alias;
 605         char *realname;
 606 } ast_codec_alias_table[] = {
 607         { "slinear", "slin"},
 608         { "slinear16", "slin16"},
 609         { "g723.1", "g723"},
 610         { "g722.1", "siren7"},
 611         { "g722.1c", "siren14"},
 612 };
 613
 614 static const char *ast_expand_codec_alias(const char *in)
 615 {
 616         int x;
 617
 618         for (x = 0; x < ARRAY_LEN(ast_codec_alias_table); x++) {
 619                 if (!strcmp(in,ast_codec_alias_table[x].alias))
 620                         return ast_codec_alias_table[x].realname;
 621         }
 622         return in;
 623 }
 624
 625 format_t ast_getformatbyname(const char *name)
 626 {
 627         int x, all;
 628         format_t format = 0;
 629
 630         all = strcasecmp(name, "all") ? 0 : 1;
 631         for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
 632                 if (all ||
 633                           !strcasecmp(AST_FORMAT_LIST[x].name,name) ||
 634                           !strcasecmp(AST_FORMAT_LIST[x].name, ast_expand_codec_alias(name))) {
 635                         format |= AST_FORMAT_LIST[x].bits;
 636                         if (!all)
 637                                 break;
 638                 }
 639         }
 640
 641         return format;
 642 }
 643
 644 char *ast_codec2str(format_t codec)
 645 {
 646         int x;
 647         char *ret = "unknown";
 648         for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
 649                 if (AST_FORMAT_LIST[x].bits == codec) {
 650                         ret = AST_FORMAT_LIST[x].desc;
 651                         break;
 652                 }
 653         }
 654         return ret;
 655 }
 656
 657 static char *show_codecs(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 658 {
 659         int i, found=0;
 660         char hex[25];
 661
 662         switch (cmd) {
 663         case CLI_INIT:
 664                 e->command = "core show codecs [audio|video|image|text]";
 665                 e->usage =
 666                         "Usage: core show codecs [audio|video|image|text]\n"
 667                         "       Displays codec mapping\n";
 668                 return NULL;
 669         case CLI_GENERATE:
 670                 return NULL;
 671         }
 672
 673         if ((a->argc < 3) || (a->argc > 4))
 674                 return CLI_SHOWUSAGE;
 675
 676         if (!ast_opt_dont_warn)
 677                 ast_cli(a->fd, "Disclaimer: this command is for informational purposes only.\n"
 678                                 "\tIt does not indicate anything about your configuration.\n");
 679
 680         ast_cli(a->fd, "%19s %9s %20s   TYPE   %8s   %s\n","INT","BINARY","HEX","NAME","DESCRIPTION");
 681         ast_cli(a->fd, "-----------------------------------------------------------------------------------\n");
 682         for (i = 0; i < 63; i++) {
 683
 684                 if (a->argc == 4) {
 685                         if (!strcasecmp(a->argv[3], "audio")) {
 686                                 if (!((1LL << i) & AST_FORMAT_AUDIO_MASK)) {
 687                                         continue;
 688                                 }
 689                         } else if (!strcasecmp(a->argv[3], "video")) {
 690                                 if (!((1LL << i) & AST_FORMAT_VIDEO_MASK)) {
 691                                         continue;
 692                                 }
 693                         } else if (!strcasecmp(a->argv[3], "image")) {
 694                                 if (i != 16 && i != 17) {
 695                                         continue;
 696                                 }
 697                         } else if (!strcasecmp(a->argv[3], "text")) {
 698                                 if (!((1LL << i) & AST_FORMAT_TEXT_MASK)) {
 699                                         continue;
 700                                 }
 701                         } else {
 702                                 continue;
 703                         }
 704                 }
 705
 706                 snprintf(hex, sizeof(hex), "(0x%Lx)", 1LL << i);
 707                 ast_cli(a->fd, "%19Lu (1 << %2d) %20s  %5s   %8s   (%s)\n", 1LL << i, i, hex,
 708                         ((1LL << i) & AST_FORMAT_AUDIO_MASK) ? "audio" :
 709                         i == 16 || i == 17 ? "image" :
 710                         ((1LL << i) & AST_FORMAT_VIDEO_MASK) ? "video" :
 711                         ((1LL << i) & AST_FORMAT_TEXT_MASK) ? "text" :
 712                         "(unk)",
 713                         ast_getformatname(1LL << i), ast_codec2str(1LL << i));
 714                 found = 1;
 715         }
 716
 717         if (!found) {
 718                 return CLI_SHOWUSAGE;
 719         } else {
 720                 return CLI_SUCCESS;
 721         }
 722 }
 723
 724 static char *show_codec_n(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 725 {
 726         format_t codec;
 727         int i, found = 0;
 728
 729         switch (cmd) {
 730         case CLI_INIT:
 731                 e->command = "core show codec";
 732                 e->usage =
 733                         "Usage: core show codec <number>\n"
 734                         "       Displays codec mapping\n";
 735                 return NULL;
 736         case CLI_GENERATE:
 737                 return NULL;
 738         }
 739
 740         if (a->argc != 4)
 741                 return CLI_SHOWUSAGE;
 742
 743         if (sscanf(a->argv[3], "%30Ld", (long long *) &codec) != 1)
 744                 return CLI_SHOWUSAGE;
 745
 746         for (i = 0; i < 63; i++)
 747                 if (codec & (1LL << i)) {
 748                         found = 1;
 749                         ast_cli(a->fd, "%11Lu (1 << %2d)  %s\n", 1LL << i, i, ast_codec2str(1LL << i));
 750                 }
 751
 752         if (!found)
 753                 ast_cli(a->fd, "Codec %Ld not found\n", (long long) codec);
 754
 755         return CLI_SUCCESS;
 756 }
 757
 758 /*! Dump a frame for debugging purposes */
 759 void ast_frame_dump(const char *name, struct ast_frame *f, char *prefix)
 760 {
 761         const char noname[] = "unknown";
 762         char ftype[40] = "Unknown Frametype";
 763         char cft[80];
 764         char subclass[40] = "Unknown Subclass";
 765         char csub[80];
 766         char moreinfo[40] = "";
 767         char cn[60];
 768         char cp[40];
 769         char cmn[40];
 770         const char *message = "Unknown";
 771
 772         if (!name)
 773                 name = noname;
 774
 775
 776         if (!f) {
 777                 ast_verbose("%s [ %s (NULL) ] [%s]\n",
 778                         term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
 779                         term_color(cft, "HANGUP", COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
 780                         term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
 781                 return;
 782         }
 783         /* XXX We should probably print one each of voice and video when the format changes XXX */
 784         if (f->frametype == AST_FRAME_VOICE)
 785                 return;
 786         if (f->frametype == AST_FRAME_VIDEO)
 787                 return;
 788         switch(f->frametype) {
 789         case AST_FRAME_DTMF_BEGIN:
 790                 strcpy(ftype, "DTMF Begin");
 791                 subclass[0] = f->subclass.integer;
 792                 subclass[1] = '\0';
 793                 break;
 794         case AST_FRAME_DTMF_END:
 795                 strcpy(ftype, "DTMF End");
 796                 subclass[0] = f->subclass.integer;
 797                 subclass[1] = '\0';
 798                 break;
 799         case AST_FRAME_CONTROL:
 800                 strcpy(ftype, "Control");
 801                 switch (f->subclass.integer) {
 802                 case AST_CONTROL_HANGUP:
 803                         strcpy(subclass, "Hangup");
 804                         break;
 805                 case AST_CONTROL_RING:
 806                         strcpy(subclass, "Ring");
 807                         break;
 808                 case AST_CONTROL_RINGING:
 809                         strcpy(subclass, "Ringing");
 810                         break;
 811                 case AST_CONTROL_ANSWER:
 812                         strcpy(subclass, "Answer");
 813                         break;
 814                 case AST_CONTROL_BUSY:
 815                         strcpy(subclass, "Busy");
 816                         break;
 817                 case AST_CONTROL_TAKEOFFHOOK:
 818                         strcpy(subclass, "Take Off Hook");
 819                         break;
 820                 case AST_CONTROL_OFFHOOK:
 821                         strcpy(subclass, "Line Off Hook");
 822                         break;
 823                 case AST_CONTROL_CONGESTION:
 824                         strcpy(subclass, "Congestion");
 825                         break;
 826                 case AST_CONTROL_FLASH:
 827                         strcpy(subclass, "Flash");
 828                         break;
 829                 case AST_CONTROL_WINK:
 830                         strcpy(subclass, "Wink");
 831                         break;
 832                 case AST_CONTROL_OPTION:
 833                         strcpy(subclass, "Option");
 834                         break;
 835                 case AST_CONTROL_RADIO_KEY:
 836                         strcpy(subclass, "Key Radio");
 837                         break;
 838                 case AST_CONTROL_RADIO_UNKEY:
 839                         strcpy(subclass, "Unkey Radio");
 840                         break;
 841                 case AST_CONTROL_HOLD:
 842                         strcpy(subclass, "Hold");
 843                         break;
 844                 case AST_CONTROL_UNHOLD:
 845                         strcpy(subclass, "Unhold");
 846                         break;
 847                 case AST_CONTROL_T38_PARAMETERS:
 848                         if (f->datalen != sizeof(struct ast_control_t38_parameters)) {
 849                                 message = "Invalid";
 850                         } else {
 851                                 struct ast_control_t38_parameters *parameters = f->data.ptr;
 852                                 enum ast_control_t38 state = parameters->request_response;
 853                                 if (state == AST_T38_REQUEST_NEGOTIATE)
 854                                         message = "Negotiation Requested";
 855                                 else if (state == AST_T38_REQUEST_TERMINATE)
 856                                         message = "Negotiation Request Terminated";
 857                                 else if (state == AST_T38_NEGOTIATED)
 858                                         message = "Negotiated";
 859                                 else if (state == AST_T38_TERMINATED)
 860                                         message = "Terminated";
 861                                 else if (state == AST_T38_REFUSED)
 862                                         message = "Refused";
 863                         }
 864                         snprintf(subclass, sizeof(subclass), "T38_Parameters/%s", message);
 865                         break;
 866                 case -1:
 867                         strcpy(subclass, "Stop generators");
 868                         break;
 869                 default:
 870                         snprintf(subclass, sizeof(subclass), "Unknown control '%d'", f->subclass.integer);
 871                 }
 872                 break;
 873         case AST_FRAME_NULL:
 874                 strcpy(ftype, "Null Frame");
 875                 strcpy(subclass, "N/A");
 876                 break;
 877         case AST_FRAME_IAX:
 878                 /* Should never happen */
 879                 strcpy(ftype, "IAX Specific");
 880                 snprintf(subclass, sizeof(subclass), "IAX Frametype %d", f->subclass.integer);
 881                 break;
 882         case AST_FRAME_TEXT:
 883                 strcpy(ftype, "Text");
 884                 strcpy(subclass, "N/A");
 885                 ast_copy_string(moreinfo, f->data.ptr, sizeof(moreinfo));
 886                 break;
 887         case AST_FRAME_IMAGE:
 888                 strcpy(ftype, "Image");
 889                 snprintf(subclass, sizeof(subclass), "Image format %s\n", ast_getformatname(f->subclass.codec));
 890                 break;
 891         case AST_FRAME_HTML:
 892                 strcpy(ftype, "HTML");
 893                 switch (f->subclass.integer) {
 894                 case AST_HTML_URL:
 895                         strcpy(subclass, "URL");
 896                         ast_copy_string(moreinfo, f->data.ptr, sizeof(moreinfo));
 897                         break;
 898                 case AST_HTML_DATA:
 899                         strcpy(subclass, "Data");
 900                         break;
 901                 case AST_HTML_BEGIN:
 902                         strcpy(subclass, "Begin");
 903                         break;
 904                 case AST_HTML_END:
 905                         strcpy(subclass, "End");
 906                         break;
 907                 case AST_HTML_LDCOMPLETE:
 908                         strcpy(subclass, "Load Complete");
 909                         break;
 910                 case AST_HTML_NOSUPPORT:
 911                         strcpy(subclass, "No Support");
 912                         break;
 913                 case AST_HTML_LINKURL:
 914                         strcpy(subclass, "Link URL");
 915                         ast_copy_string(moreinfo, f->data.ptr, sizeof(moreinfo));
 916                         break;
 917                 case AST_HTML_UNLINK:
 918                         strcpy(subclass, "Unlink");
 919                         break;
 920                 case AST_HTML_LINKREJECT:
 921                         strcpy(subclass, "Link Reject");
 922                         break;
 923                 default:
 924                         snprintf(subclass, sizeof(subclass), "Unknown HTML frame '%d'\n", f->subclass.integer);
 925                         break;
 926                 }
 927                 break;
 928         case AST_FRAME_MODEM:
 929                 strcpy(ftype, "Modem");
 930                 switch (f->subclass.integer) {
 931                 case AST_MODEM_T38:
 932                         strcpy(subclass, "T.38");
 933                         break;
 934                 case AST_MODEM_V150:
 935                         strcpy(subclass, "V.150");
 936                         break;
 937                 default:
 938                         snprintf(subclass, sizeof(subclass), "Unknown MODEM frame '%d'\n", f->subclass.integer);
 939                         break;
 940                 }
 941                 break;
 942         default:
 943                 snprintf(ftype, sizeof(ftype), "Unknown Frametype '%d'", f->frametype);
 944         }
 945         if (!ast_strlen_zero(moreinfo))
 946                 ast_verbose("%s [ TYPE: %s (%d) SUBCLASS: %s (%d) '%s' ] [%s]\n",
 947                             term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
 948                             term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
 949                             f->frametype,
 950                             term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
 951                             f->subclass.integer,
 952                             term_color(cmn, moreinfo, COLOR_BRGREEN, COLOR_BLACK, sizeof(cmn)),
 953                             term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
 954         else
 955                 ast_verbose("%s [ TYPE: %s (%d) SUBCLASS: %s (%d) ] [%s]\n",
 956                             term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
 957                             term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
 958                             f->frametype,
 959                             term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
 960                             f->subclass.integer,
 961                             term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
 962 }
 963
 964
 965 /* Builtin Asterisk CLI-commands for debugging */
 966 static struct ast_cli_entry my_clis[] = {
 967         AST_CLI_DEFINE(show_codecs, "Displays a list of codecs"),
 968         AST_CLI_DEFINE(show_codec_n, "Shows a specific codec"),
 969 };
 970
 971 int init_framer(void)
 972 {
 973         ast_cli_register_multiple(my_clis, ARRAY_LEN(my_clis));
 974         return 0;
 975 }
 976
 977 void ast_codec_pref_convert(struct ast_codec_pref *pref, char *buf, size_t size, int right)
 978 {
 979         int x, differential = (int) 'A', mem;
 980         char *from, *to;
 981
 982         if (right) {
 983                 from = pref->order;
 984                 to = buf;
 985                 mem = size;
 986         } else {
 987                 to = pref->order;
 988                 from = buf;
 989                 mem = sizeof(format_t) * 8;
 990         }
 991
 992         memset(to, 0, mem);
 993         for (x = 0; x < sizeof(format_t) * 8; x++) {
 994                 if (!from[x])
 995                         break;
 996                 to[x] = right ? (from[x] + differential) : (from[x] - differential);
 997         }
 998 }
 999
1000 int ast_codec_pref_string(struct ast_codec_pref *pref, char *buf, size_t size)
1001 {
1002         int x;
1003         format_t codec;
1004         size_t total_len, slen;
1005         char *formatname;
1006
1007         memset(buf, 0, size);
1008         total_len = size;
1009         buf[0] = '(';
1010         total_len--;
1011         for (x = 0; x < sizeof(format_t) * 8; x++) {
1012                 if (total_len <= 0)
1013                         break;
1014                 if (!(codec = ast_codec_pref_index(pref,x)))
1015                         break;
1016                 if ((formatname = ast_getformatname(codec))) {
1017                         slen = strlen(formatname);
1018                         if (slen > total_len)
1019                                 break;
1020                         strncat(buf, formatname, total_len - 1); /* safe */
1021                         total_len -= slen;
1022                 }
1023                 if (total_len && x < sizeof(format_t) * 8 - 1 && ast_codec_pref_index(pref, x + 1)) {
1024                         strncat(buf, "|", total_len - 1); /* safe */
1025                         total_len--;
1026                 }
1027         }
1028         if (total_len) {
1029                 strncat(buf, ")", total_len - 1); /* safe */
1030                 total_len--;
1031         }
1032
1033         return size - total_len;
1034 }
1035
1036 format_t ast_codec_pref_index(struct ast_codec_pref *pref, int idx)
1037 {
1038         int slot = 0;
1039
1040         if ((idx >= 0) && (idx < sizeof(pref->order))) {
1041                 slot = pref->order[idx];
1042         }
1043
1044         return slot ? AST_FORMAT_LIST[slot - 1].bits : 0;
1045 }
1046
1047 /*! \brief Remove codec from pref list */
1048 void ast_codec_pref_remove(struct ast_codec_pref *pref, format_t format)
1049 {
1050         struct ast_codec_pref oldorder;
1051         int x, y = 0;
1052         int slot;
1053         int size;
1054
1055         if (!pref->order[0])
1056                 return;
1057
1058         memcpy(&oldorder, pref, sizeof(oldorder));
1059         memset(pref, 0, sizeof(*pref));
1060
1061         for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1062                 slot = oldorder.order[x];
1063                 size = oldorder.framing[x];
1064                 if (! slot)
1065                         break;
1066                 if (AST_FORMAT_LIST[slot-1].bits != format) {
1067                         pref->order[y] = slot;
1068                         pref->framing[y++] = size;
1069                 }
1070         }
1071 }
1072
1073 /*! \brief Append codec to list */
1074 int ast_codec_pref_append(struct ast_codec_pref *pref, format_t format)
1075 {
1076         int x, newindex = 0;
1077
1078         ast_codec_pref_remove(pref, format);
1079
1080         for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1081                 if (AST_FORMAT_LIST[x].bits == format) {
1082                         newindex = x + 1;
1083                         break;
1084                 }
1085         }
1086
1087         if (newindex) {
1088                 for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1089                         if (!pref->order[x]) {
1090                                 pref->order[x] = newindex;
1091                                 break;
1092                         }
1093                 }
1094         }
1095
1096         return x;
1097 }
1098
1099 /*! \brief Prepend codec to list */
1100 void ast_codec_pref_prepend(struct ast_codec_pref *pref, format_t format, int only_if_existing)
1101 {
1102         int x, newindex = 0;
1103
1104         /* First step is to get the codecs "index number" */
1105         for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1106                 if (AST_FORMAT_LIST[x].bits == format) {
1107                         newindex = x + 1;
1108                         break;
1109                 }
1110         }
1111         /* Done if its unknown */
1112         if (!newindex)
1113                 return;
1114
1115         /* Now find any existing occurrence, or the end */
1116         for (x = 0; x < sizeof(format_t) * 8; x++) {
1117                 if (!pref->order[x] || pref->order[x] == newindex)
1118                         break;
1119         }
1120
1121         if (only_if_existing && !pref->order[x])
1122                 return;
1123
1124         /* Move down to make space to insert - either all the way to the end,
1125            or as far as the existing location (which will be overwritten) */
1126         for (; x > 0; x--) {
1127                 pref->order[x] = pref->order[x - 1];
1128                 pref->framing[x] = pref->framing[x - 1];
1129         }
1130
1131         /* And insert the new entry */
1132         pref->order[0] = newindex;
1133         pref->framing[0] = 0; /* ? */
1134 }
1135
1136 /*! \brief Set packet size for codec */
1137 int ast_codec_pref_setsize(struct ast_codec_pref *pref, format_t format, int framems)
1138 {
1139         int x, idx = -1;
1140
1141         for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1142                 if (AST_FORMAT_LIST[x].bits == format) {
1143                         idx = x;
1144                         break;
1145                 }
1146         }
1147
1148         if (idx < 0)
1149                 return -1;
1150
1151         /* size validation */
1152         if (!framems)
1153                 framems = AST_FORMAT_LIST[idx].def_ms;
1154
1155         if (AST_FORMAT_LIST[idx].inc_ms && framems % AST_FORMAT_LIST[idx].inc_ms) /* avoid division by zero */
1156                 framems -= framems % AST_FORMAT_LIST[idx].inc_ms;
1157
1158         if (framems < AST_FORMAT_LIST[idx].min_ms)
1159                 framems = AST_FORMAT_LIST[idx].min_ms;
1160
1161         if (framems > AST_FORMAT_LIST[idx].max_ms)
1162                 framems = AST_FORMAT_LIST[idx].max_ms;
1163
1164         for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1165                 if (pref->order[x] == (idx + 1)) {
1166                         pref->framing[x] = framems;
1167                         break;
1168                 }
1169         }
1170
1171         return x;
1172 }
1173
1174 /*! \brief Get packet size for codec */
1175 struct ast_format_list ast_codec_pref_getsize(struct ast_codec_pref *pref, format_t format)
1176 {
1177         int x, idx = -1, framems = 0;
1178         struct ast_format_list fmt = { 0, };
1179
1180         for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1181                 if (AST_FORMAT_LIST[x].bits == format) {
1182                         fmt = AST_FORMAT_LIST[x];
1183                         idx = x;
1184                         break;
1185                 }
1186         }
1187
1188         for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1189                 if (pref->order[x] == (idx + 1)) {
1190                         framems = pref->framing[x];
1191                         break;
1192                 }
1193         }
1194
1195         /* size validation */
1196         if (!framems)
1197                 framems = AST_FORMAT_LIST[idx].def_ms;
1198
1199         if (AST_FORMAT_LIST[idx].inc_ms && framems % AST_FORMAT_LIST[idx].inc_ms) /* avoid division by zero */
1200                 framems -= framems % AST_FORMAT_LIST[idx].inc_ms;
1201
1202         if (framems < AST_FORMAT_LIST[idx].min_ms)
1203                 framems = AST_FORMAT_LIST[idx].min_ms;
1204
1205         if (framems > AST_FORMAT_LIST[idx].max_ms)
1206                 framems = AST_FORMAT_LIST[idx].max_ms;
1207
1208         fmt.cur_ms = framems;
1209
1210         return fmt;
1211 }
1212
1213 /*! \brief Pick a codec */
1214 format_t ast_codec_choose(struct ast_codec_pref *pref, format_t formats, int find_best)
1215 {
1216         int x, slot;
1217         format_t ret = 0;
1218
1219         for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1220                 slot = pref->order[x];
1221
1222                 if (!slot)
1223                         break;
1224                 if (formats & AST_FORMAT_LIST[slot-1].bits) {
1225                         ret = AST_FORMAT_LIST[slot-1].bits;
1226                         break;
1227                 }
1228         }
1229         if (ret & AST_FORMAT_AUDIO_MASK)
1230                 return ret;
1231
1232         ast_debug(4, "Could not find preferred codec - %s\n", find_best ? "Going for the best codec" : "Returning zero codec");
1233
1234         return find_best ? ast_best_codec(formats) : 0;
1235 }
1236
1237 int ast_parse_allow_disallow(struct ast_codec_pref *pref, format_t *mask, const char *list, int allowing)
1238 {
1239         int errors = 0, framems = 0;
1240         char *parse = NULL, *this = NULL, *psize = NULL;
1241         format_t format = 0;
1242
1243         parse = ast_strdupa(list);
1244         while ((this = strsep(&parse, ","))) {
1245                 framems = 0;
1246                 if ((psize = strrchr(this, ':'))) {
1247                         *psize++ = '\0';
1248                         ast_debug(1, "Packetization for codec: %s is %s\n", this, psize);
1249                         framems = atoi(psize);
1250                         if (framems < 0) {
1251                                 framems = 0;
1252                                 errors++;
1253                                 ast_log(LOG_WARNING, "Bad packetization value for codec %s\n", this);
1254                         }
1255                 }
1256                 if (!(format = ast_getformatbyname(this))) {
1257                         ast_log(LOG_WARNING, "Cannot %s unknown format '%s'\n", allowing ? "allow" : "disallow", this);
1258                         errors++;
1259                         continue;
1260                 }
1261
1262                 if (mask) {
1263                         if (allowing)
1264                                 *mask |= format;
1265                         else
1266                                 *mask &= ~format;
1267                 }
1268
1269                 /* Set up a preference list for audio. Do not include video in preferences
1270                    since we can not transcode video and have to use whatever is offered
1271                  */
1272                 if (pref && (format & AST_FORMAT_AUDIO_MASK)) {
1273                         if (strcasecmp(this, "all")) {
1274                                 if (allowing) {
1275                                         ast_codec_pref_append(pref, format);
1276                                         ast_codec_pref_setsize(pref, format, framems);
1277                                 }
1278                                 else
1279                                         ast_codec_pref_remove(pref, format);
1280                         } else if (!allowing) {
1281                                 memset(pref, 0, sizeof(*pref));
1282                         }
1283                 }
1284         }
1285         return errors;
1286 }
1287
1288 static int g723_len(unsigned char buf)
1289 {
1290         enum frame_type type = buf & TYPE_MASK;
1291
1292         switch(type) {
1293         case TYPE_DONTSEND:
1294                 return 0;
1295                 break;
1296         case TYPE_SILENCE:
1297                 return 4;
1298                 break;
1299         case TYPE_HIGH:
1300                 return 24;
1301                 break;
1302         case TYPE_LOW:
1303                 return 20;
1304                 break;
1305         default:
1306                 ast_log(LOG_WARNING, "Badly encoded frame (%d)\n", type);
1307         }
1308         return -1;
1309 }
1310
1311 static int g723_samples(unsigned char *buf, int maxlen)
1312 {
1313         int pos = 0;
1314         int samples = 0;
1315         int res;
1316         while(pos < maxlen) {
1317                 res = g723_len(buf[pos]);
1318                 if (res <= 0)
1319                         break;
1320                 samples += 240;
1321                 pos += res;
1322         }
1323         return samples;
1324 }
1325
1326 static unsigned char get_n_bits_at(unsigned char *data, int n, int bit)
1327 {
1328         int byte = bit / 8;       /* byte containing first bit */
1329         int rem = 8 - (bit % 8);  /* remaining bits in first byte */
1330         unsigned char ret = 0;
1331
1332         if (n <= 0 || n > 8)
1333                 return 0;
1334
1335         if (rem < n) {
1336                 ret = (data[byte] << (n - rem));
1337                 ret |= (data[byte + 1] >> (8 - n + rem));
1338         } else {
1339                 ret = (data[byte] >> (rem - n));
1340         }
1341
1342         return (ret & (0xff >> (8 - n)));
1343 }
1344
1345 static int speex_get_wb_sz_at(unsigned char *data, int len, int bit)
1346 {
1347         static const int SpeexWBSubModeSz[] = {
1348                 0, 36, 112, 192,
1349                 352, 0, 0, 0 };
1350         int off = bit;
1351         unsigned char c;
1352
1353         /* skip up to two wideband frames */
1354         if (((len * 8 - off) >= 5) &&
1355                 get_n_bits_at(data, 1, off)) {
1356                 c = get_n_bits_at(data, 3, off + 1);
1357                 off += SpeexWBSubModeSz[c];
1358
1359                 if (((len * 8 - off) >= 5) &&
1360                         get_n_bits_at(data, 1, off)) {
1361                         c = get_n_bits_at(data, 3, off + 1);
1362                         off += SpeexWBSubModeSz[c];
1363
1364                         if (((len * 8 - off) >= 5) &&
1365                                 get_n_bits_at(data, 1, off)) {
1366                                 ast_log(LOG_WARNING, "Encountered corrupt speex frame; too many wideband frames in a row.\n");
1367                                 return -1;
1368                         }
1369                 }
1370
1371         }
1372         return off - bit;
1373 }
1374
1375 static int speex_samples(unsigned char *data, int len)
1376 {
1377         static const int SpeexSubModeSz[] = {
1378                 5, 43, 119, 160,
1379                 220, 300, 364, 492,
1380                 79, 0, 0, 0,
1381                 0, 0, 0, 0 };
1382         static const int SpeexInBandSz[] = {
1383                 1, 1, 4, 4,
1384                 4, 4, 4, 4,
1385                 8, 8, 16, 16,
1386                 32, 32, 64, 64 };
1387         int bit = 0;
1388         int cnt = 0;
1389         int off;
1390         unsigned char c;
1391
1392         while ((len * 8 - bit) >= 5) {
1393                 /* skip wideband frames */
1394                 off = speex_get_wb_sz_at(data, len, bit);
1395                 if (off < 0)  {
1396                         ast_log(LOG_WARNING, "Had error while reading wideband frames for speex samples\n");
1397                         break;
1398                 }
1399                 bit += off;
1400
1401                 if ((len * 8 - bit) < 5) {
1402                         ast_log(LOG_WARNING, "Not enough bits remaining after wide band for speex samples.\n");
1403                         break;
1404                 }
1405
1406                 /* get control bits */
1407                 c = get_n_bits_at(data, 5, bit);
1408                 bit += 5;
1409
1410                 if (c == 15) {
1411                         /* terminator */
1412                         break;
1413                 } else if (c == 14) {
1414                         /* in-band signal; next 4 bits contain signal id */
1415                         c = get_n_bits_at(data, 4, bit);
1416                         bit += 4;
1417                         bit += SpeexInBandSz[c];
1418                 } else if (c == 13) {
1419                         /* user in-band; next 5 bits contain msg len */
1420                         c = get_n_bits_at(data, 5, bit);
1421                         bit += 5;
1422                         bit += c * 8;
1423                 } else if (c > 8) {
1424                         /* unknown */
1425                         break;
1426                 } else {
1427                         /* skip number bits for submode (less the 5 control bits) */
1428                         bit += SpeexSubModeSz[c] - 5;
1429                         cnt += 160; /* new frame */
1430                 }
1431         }
1432         return cnt;
1433 }
1434
1435 int ast_codec_get_samples(struct ast_frame *f)
1436 {
1437         int samples = 0;
1438         char tmp[64];
1439
1440         switch (f->subclass.codec) {
1441         case AST_FORMAT_SPEEX:
1442                 samples = speex_samples(f->data.ptr, f->datalen);
1443                 break;
1444         case AST_FORMAT_G723_1:
1445                 samples = g723_samples(f->data.ptr, f->datalen);
1446                 break;
1447         case AST_FORMAT_ILBC:
1448                 samples = 240 * (f->datalen / 50);
1449                 break;
1450         case AST_FORMAT_GSM:
1451                 samples = 160 * (f->datalen / 33);
1452                 break;
1453         case AST_FORMAT_G729A:
1454                 samples = f->datalen * 8;
1455                 break;
1456         case AST_FORMAT_SLINEAR:
1457         case AST_FORMAT_SLINEAR16:
1458                 samples = f->datalen / 2;
1459                 break;
1460         case AST_FORMAT_LPC10:
1461                 /* assumes that the RTP packet contains one LPC10 frame */
1462                 samples = 22 * 8;
1463                 samples += (((char *)(f->data.ptr))[7] & 0x1) * 8;
1464                 break;
1465         case AST_FORMAT_ULAW:
1466         case AST_FORMAT_ALAW:
1467         case AST_FORMAT_TESTLAW:
1468                 samples = f->datalen;
1469                 break;
1470         case AST_FORMAT_G722:
1471         case AST_FORMAT_ADPCM:
1472         case AST_FORMAT_G726:
1473         case AST_FORMAT_G726_AAL2:
1474                 samples = f->datalen * 2;
1475                 break;
1476         case AST_FORMAT_SIREN7:
1477                 /* 16,000 samples per second at 32kbps is 4,000 bytes per second */
1478                 samples = f->datalen * (16000 / 4000);
1479                 break;
1480         case AST_FORMAT_SIREN14:
1481                 /* 32,000 samples per second at 48kbps is 6,000 bytes per second */
1482                 samples = (int) f->datalen * ((float) 32000 / 6000);
1483                 break;
1484         default:
1485                 ast_log(LOG_WARNING, "Unable to calculate samples for format %s\n", ast_getformatname_multiple(tmp, sizeof(tmp), f->subclass.codec));
1486         }
1487         return samples;
1488 }
1489
1490 int ast_codec_get_len(format_t format, int samples)
1491 {
1492         int len = 0;
1493
1494         /* XXX Still need speex, and lpc10 XXX */
1495         switch(format) {
1496         case AST_FORMAT_G723_1:
1497                 len = (samples / 240) * 20;
1498                 break;
1499         case AST_FORMAT_ILBC:
1500                 len = (samples / 240) * 50;
1501                 break;
1502         case AST_FORMAT_GSM:
1503                 len = (samples / 160) * 33;
1504                 break;
1505         case AST_FORMAT_G729A:
1506                 len = samples / 8;
1507                 break;
1508         case AST_FORMAT_SLINEAR:
1509         case AST_FORMAT_SLINEAR16:
1510                 len = samples * 2;
1511                 break;
1512         case AST_FORMAT_ULAW:
1513         case AST_FORMAT_ALAW:
1514         case AST_FORMAT_TESTLAW:
1515                 len = samples;
1516                 break;
1517         case AST_FORMAT_G722:
1518         case AST_FORMAT_ADPCM:
1519         case AST_FORMAT_G726:
1520         case AST_FORMAT_G726_AAL2:
1521                 len = samples / 2;
1522                 break;
1523         case AST_FORMAT_SIREN7:
1524                 /* 16,000 samples per second at 32kbps is 4,000 bytes per second */
1525                 len = samples / (16000 / 4000);
1526                 break;
1527         case AST_FORMAT_SIREN14:
1528                 /* 32,000 samples per second at 48kbps is 6,000 bytes per second */
1529                 len = (int) samples / ((float) 32000 / 6000);
1530                 break;
1531         default:
1532                 ast_log(LOG_WARNING, "Unable to calculate sample length for format %s\n", ast_getformatname(format));
1533         }
1534
1535         return len;
1536 }
1537
1538 int ast_frame_adjust_volume(struct ast_frame *f, int adjustment)
1539 {
1540         int count;
1541         short *fdata = f->data.ptr;
1542         short adjust_value = abs(adjustment);
1543
1544         if ((f->frametype != AST_FRAME_VOICE) || (f->subclass.codec != AST_FORMAT_SLINEAR))
1545                 return -1;
1546
1547         if (!adjustment)
1548                 return 0;
1549
1550         for (count = 0; count < f->samples; count++) {
1551                 if (adjustment > 0) {
1552                         ast_slinear_saturated_multiply(&fdata[count], &adjust_value);
1553                 } else if (adjustment < 0) {
1554                         ast_slinear_saturated_divide(&fdata[count], &adjust_value);
1555                 }
1556         }
1557
1558         return 0;
1559 }
1560
1561 int ast_frame_slinear_sum(struct ast_frame *f1, struct ast_frame *f2)
1562 {
1563         int count;
1564         short *data1, *data2;
1565
1566         if ((f1->frametype != AST_FRAME_VOICE) || (f1->subclass.codec != AST_FORMAT_SLINEAR))
1567                 return -1;
1568
1569         if ((f2->frametype != AST_FRAME_VOICE) || (f2->subclass.codec != AST_FORMAT_SLINEAR))
1570                 return -1;
1571
1572         if (f1->samples != f2->samples)
1573                 return -1;
1574
1575         for (count = 0, data1 = f1->data.ptr, data2 = f2->data.ptr;
1576              count < f1->samples;
1577              count++, data1++, data2++)
1578                 ast_slinear_saturated_add(data1, data2);
1579
1580         return 0;
1581 }