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