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