d82a463138386bc53050ded424fe1d9433dda726
[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         struct ast_format 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 struct ast_frame ast_null_frame = { AST_FRAME_NULL, };
96
97 static int smoother_frame_feed(struct ast_smoother *s, struct ast_frame *f, int swap)
98 {
99         if (s->flags & AST_SMOOTHER_FLAG_G729) {
100                 if (s->len % 10) {
101                         ast_log(LOG_NOTICE, "Dropping extra frame of G.729 since we already have a VAD frame at the end\n");
102                         return 0;
103                 }
104         }
105         if (swap) {
106                 ast_swapcopy_samples(s->data + s->len, f->data.ptr, f->samples);
107         } else {
108                 memcpy(s->data + s->len, f->data.ptr, f->datalen);
109         }
110         /* If either side is empty, reset the delivery time */
111         if (!s->len || ast_tvzero(f->delivery) || ast_tvzero(s->delivery)) {    /* XXX really ? */
112                 s->delivery = f->delivery;
113         }
114         s->len += f->datalen;
115
116         return 0;
117 }
118
119 void ast_smoother_reset(struct ast_smoother *s, int bytes)
120 {
121         memset(s, 0, sizeof(*s));
122         s->size = bytes;
123 }
124
125 void ast_smoother_reconfigure(struct ast_smoother *s, int bytes)
126 {
127         /* if there is no change, then nothing to do */
128         if (s->size == bytes) {
129                 return;
130         }
131         /* set the new desired output size */
132         s->size = bytes;
133         /* if there is no 'optimized' frame in the smoother,
134          *   then there is nothing left to do
135          */
136         if (!s->opt) {
137                 return;
138         }
139         /* there is an 'optimized' frame here at the old size,
140          * but it must now be put into the buffer so the data
141          * can be extracted at the new size
142          */
143         smoother_frame_feed(s, s->opt, s->opt_needs_swap);
144         s->opt = NULL;
145 }
146
147 struct ast_smoother *ast_smoother_new(int size)
148 {
149         struct ast_smoother *s;
150         if (size < 1)
151                 return NULL;
152         if ((s = ast_malloc(sizeof(*s))))
153                 ast_smoother_reset(s, size);
154         return s;
155 }
156
157 int ast_smoother_get_flags(struct ast_smoother *s)
158 {
159         return s->flags;
160 }
161
162 void ast_smoother_set_flags(struct ast_smoother *s, int flags)
163 {
164         s->flags = flags;
165 }
166
167 int ast_smoother_test_flag(struct ast_smoother *s, int flag)
168 {
169         return (s->flags & flag);
170 }
171
172 int __ast_smoother_feed(struct ast_smoother *s, struct ast_frame *f, int swap)
173 {
174         if (f->frametype != AST_FRAME_VOICE) {
175                 ast_log(LOG_WARNING, "Huh?  Can't smooth a non-voice frame!\n");
176                 return -1;
177         }
178         if (!s->format.id) {
179                 ast_format_copy(&s->format, &f->subclass.format);
180                 s->samplesperbyte = (float)f->samples / (float)f->datalen;
181         } else if (ast_format_cmp(&s->format, &f->subclass.format) == AST_FORMAT_CMP_NOT_EQUAL) {
182                 ast_log(LOG_WARNING, "Smoother was working on %s format frames, now trying to feed %s?\n",
183                         ast_getformatname(&s->format), ast_getformatname(&f->subclass.format));
184                 return -1;
185         }
186         if (s->len + f->datalen > SMOOTHER_SIZE) {
187                 ast_log(LOG_WARNING, "Out of smoother space\n");
188                 return -1;
189         }
190         if (((f->datalen == s->size) ||
191              ((f->datalen < 10) && (s->flags & AST_SMOOTHER_FLAG_G729))) &&
192             !s->opt &&
193             !s->len &&
194             (f->offset >= AST_MIN_OFFSET)) {
195                 /* Optimize by sending the frame we just got
196                    on the next read, thus eliminating the douple
197                    copy */
198                 if (swap)
199                         ast_swapcopy_samples(f->data.ptr, f->data.ptr, f->samples);
200                 s->opt = f;
201                 s->opt_needs_swap = swap ? 1 : 0;
202                 return 0;
203         }
204
205         return smoother_frame_feed(s, f, swap);
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->len % 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         ast_format_copy(&s->f.subclass.format, &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         
289         return f;
290 }
291
292 #if !defined(LOW_MEMORY)
293 static void frame_cache_cleanup(void *data)
294 {
295         struct ast_frame_cache *frames = data;
296         struct ast_frame *f;
297
298         while ((f = AST_LIST_REMOVE_HEAD(&frames->list, frame_list)))
299                 ast_free(f);
300         
301         ast_free(frames);
302 }
303 #endif
304
305 static void __frame_free(struct ast_frame *fr, int cache)
306 {
307         if (!fr->mallocd)
308                 return;
309
310 #if !defined(LOW_MEMORY)
311         if (cache && fr->mallocd == AST_MALLOCD_HDR) {
312                 /* Cool, only the header is malloc'd, let's just cache those for now 
313                  * to keep things simple... */
314                 struct ast_frame_cache *frames;
315
316                 if ((frames = ast_threadstorage_get(&frame_cache, sizeof(*frames))) &&
317                     (frames->size < FRAME_CACHE_MAX_SIZE)) {
318                         AST_LIST_INSERT_HEAD(&frames->list, fr, frame_list);
319                         frames->size++;
320                         return;
321                 }
322         }
323 #endif
324         
325         if (fr->mallocd & AST_MALLOCD_DATA) {
326                 if (fr->data.ptr) 
327                         ast_free(fr->data.ptr - fr->offset);
328         }
329         if (fr->mallocd & AST_MALLOCD_SRC) {
330                 if (fr->src)
331                         ast_free((void *) fr->src);
332         }
333         if (fr->mallocd & AST_MALLOCD_HDR) {
334                 ast_free(fr);
335         }
336 }
337
338
339 void ast_frame_free(struct ast_frame *frame, int cache)
340 {
341         struct ast_frame *next;
342
343         for (next = AST_LIST_NEXT(frame, frame_list);
344              frame;
345              frame = next, next = frame ? AST_LIST_NEXT(frame, frame_list) : NULL) {
346                 __frame_free(frame, cache);
347         }
348 }
349
350 /*!
351  * \brief 'isolates' a frame by duplicating non-malloc'ed components
352  * (header, src, data).
353  * On return all components are malloc'ed
354  */
355 struct ast_frame *ast_frisolate(struct ast_frame *fr)
356 {
357         struct ast_frame *out;
358         void *newdata;
359
360         /* if none of the existing frame is malloc'd, let ast_frdup() do it
361            since it is more efficient
362         */
363         if (fr->mallocd == 0) {
364                 return ast_frdup(fr);
365         }
366
367         /* if everything is already malloc'd, we are done */
368         if ((fr->mallocd & (AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA)) ==
369             (AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA)) {
370                 return fr;
371         }
372
373         if (!(fr->mallocd & AST_MALLOCD_HDR)) {
374                 /* Allocate a new header if needed */
375                 if (!(out = ast_frame_header_new())) {
376                         return NULL;
377                 }
378                 out->frametype = fr->frametype;
379                 ast_format_copy(&out->subclass.format, &fr->subclass.format);
380                 out->datalen = fr->datalen;
381                 out->samples = fr->samples;
382                 out->offset = fr->offset;
383                 /* Copy the timing data */
384                 ast_copy_flags(out, fr, AST_FRFLAG_HAS_TIMING_INFO);
385                 if (ast_test_flag(fr, AST_FRFLAG_HAS_TIMING_INFO)) {
386                         out->ts = fr->ts;
387                         out->len = fr->len;
388                         out->seqno = fr->seqno;
389                 }
390         } else {
391                 out = fr;
392         }
393         
394         if (!(fr->mallocd & AST_MALLOCD_SRC) && fr->src) {
395                 if (!(out->src = ast_strdup(fr->src))) {
396                         if (out != fr) {
397                                 ast_free(out);
398                         }
399                         return NULL;
400                 }
401         } else {
402                 out->src = fr->src;
403                 fr->src = NULL;
404                 fr->mallocd &= ~AST_MALLOCD_SRC;
405         }
406         
407         if (!(fr->mallocd & AST_MALLOCD_DATA))  {
408                 if (!fr->datalen) {
409                         out->data.uint32 = fr->data.uint32;
410                         out->mallocd = AST_MALLOCD_HDR | AST_MALLOCD_SRC;
411                         return out;
412                 }
413                 if (!(newdata = ast_malloc(fr->datalen + AST_FRIENDLY_OFFSET))) {
414                         if (out->src != fr->src) {
415                                 ast_free((void *) out->src);
416                         }
417                         if (out != fr) {
418                                 ast_free(out);
419                         }
420                         return NULL;
421                 }
422                 newdata += AST_FRIENDLY_OFFSET;
423                 out->offset = AST_FRIENDLY_OFFSET;
424                 out->datalen = fr->datalen;
425                 memcpy(newdata, fr->data.ptr, fr->datalen);
426                 out->data.ptr = newdata;
427         } else {
428                 out->data = fr->data;
429                 memset(&fr->data, 0, sizeof(fr->data));
430                 fr->mallocd &= ~AST_MALLOCD_DATA;
431         }
432
433         out->mallocd = AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA;
434         
435         return out;
436 }
437
438 struct ast_frame *ast_frdup(const struct ast_frame *f)
439 {
440         struct ast_frame *out = NULL;
441         int len, srclen = 0;
442         void *buf = NULL;
443
444 #if !defined(LOW_MEMORY)
445         struct ast_frame_cache *frames;
446 #endif
447
448         /* Start with standard stuff */
449         len = sizeof(*out) + AST_FRIENDLY_OFFSET + f->datalen;
450         /* If we have a source, add space for it */
451         /*
452          * XXX Watch out here - if we receive a src which is not terminated
453          * properly, we can be easily attacked. Should limit the size we deal with.
454          */
455         if (f->src)
456                 srclen = strlen(f->src);
457         if (srclen > 0)
458                 len += srclen + 1;
459         
460 #if !defined(LOW_MEMORY)
461         if ((frames = ast_threadstorage_get(&frame_cache, sizeof(*frames)))) {
462                 AST_LIST_TRAVERSE_SAFE_BEGIN(&frames->list, out, frame_list) {
463                         if (out->mallocd_hdr_len >= len) {
464                                 size_t mallocd_len = out->mallocd_hdr_len;
465
466                                 AST_LIST_REMOVE_CURRENT(frame_list);
467                                 memset(out, 0, sizeof(*out));
468                                 out->mallocd_hdr_len = mallocd_len;
469                                 buf = out;
470                                 frames->size--;
471                                 break;
472                         }
473                 }
474                 AST_LIST_TRAVERSE_SAFE_END;
475         }
476 #endif
477
478         if (!buf) {
479                 if (!(buf = ast_calloc_cache(1, len)))
480                         return NULL;
481                 out = buf;
482                 out->mallocd_hdr_len = len;
483         }
484
485         out->frametype = f->frametype;
486         ast_format_copy(&out->subclass.format, &f->subclass.format);
487         out->datalen = f->datalen;
488         out->samples = f->samples;
489         out->delivery = f->delivery;
490         /* Set us as having malloc'd header only, so it will eventually
491            get freed. */
492         out->mallocd = AST_MALLOCD_HDR;
493         out->offset = AST_FRIENDLY_OFFSET;
494         if (out->datalen) {
495                 out->data.ptr = buf + sizeof(*out) + AST_FRIENDLY_OFFSET;
496                 memcpy(out->data.ptr, f->data.ptr, out->datalen);       
497         } else {
498                 out->data.uint32 = f->data.uint32;
499         }
500         if (srclen > 0) {
501                 /* This may seem a little strange, but it's to avoid a gcc (4.2.4) compiler warning */
502                 char *src;
503                 out->src = buf + sizeof(*out) + AST_FRIENDLY_OFFSET + f->datalen;
504                 src = (char *) out->src;
505                 /* Must have space since we allocated for it */
506                 strcpy(src, f->src);
507         }
508         ast_copy_flags(out, f, AST_FRFLAG_HAS_TIMING_INFO);
509         out->ts = f->ts;
510         out->len = f->len;
511         out->seqno = f->seqno;
512         return out;
513 }
514
515 void ast_swapcopy_samples(void *dst, const void *src, int samples)
516 {
517         int i;
518         unsigned short *dst_s = dst;
519         const unsigned short *src_s = src;
520
521         for (i = 0; i < samples; i++)
522                 dst_s[i] = (src_s[i]<<8) | (src_s[i]>>8);
523 }
524
525 /*! Dump a frame for debugging purposes */
526 void ast_frame_dump(const char *name, struct ast_frame *f, char *prefix)
527 {
528         const char noname[] = "unknown";
529         char ftype[40] = "Unknown Frametype";
530         char cft[80];
531         char subclass[40] = "Unknown Subclass";
532         char csub[80];
533         char moreinfo[40] = "";
534         char cn[60];
535         char cp[40];
536         char cmn[40];
537         const char *message = "Unknown";
538
539         if (!name)
540                 name = noname;
541
542
543         if (!f) {
544                 ast_verbose("%s [ %s (NULL) ] [%s]\n", 
545                         term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
546                         term_color(cft, "HANGUP", COLOR_BRRED, COLOR_BLACK, sizeof(cft)), 
547                         term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
548                 return;
549         }
550         /* XXX We should probably print one each of voice and video when the format changes XXX */
551         if (f->frametype == AST_FRAME_VOICE)
552                 return;
553         if (f->frametype == AST_FRAME_VIDEO)
554                 return;
555         switch(f->frametype) {
556         case AST_FRAME_DTMF_BEGIN:
557                 strcpy(ftype, "DTMF Begin");
558                 subclass[0] = f->subclass.integer;
559                 subclass[1] = '\0';
560                 break;
561         case AST_FRAME_DTMF_END:
562                 strcpy(ftype, "DTMF End");
563                 subclass[0] = f->subclass.integer;
564                 subclass[1] = '\0';
565                 break;
566         case AST_FRAME_CONTROL:
567                 strcpy(ftype, "Control");
568                 switch (f->subclass.integer) {
569                 case AST_CONTROL_HANGUP:
570                         strcpy(subclass, "Hangup");
571                         break;
572                 case AST_CONTROL_RING:
573                         strcpy(subclass, "Ring");
574                         break;
575                 case AST_CONTROL_RINGING:
576                         strcpy(subclass, "Ringing");
577                         break;
578                 case AST_CONTROL_ANSWER:
579                         strcpy(subclass, "Answer");
580                         break;
581                 case AST_CONTROL_BUSY:
582                         strcpy(subclass, "Busy");
583                         break;
584                 case AST_CONTROL_TAKEOFFHOOK:
585                         strcpy(subclass, "Take Off Hook");
586                         break;
587                 case AST_CONTROL_OFFHOOK:
588                         strcpy(subclass, "Line Off Hook");
589                         break;
590                 case AST_CONTROL_CONGESTION:
591                         strcpy(subclass, "Congestion");
592                         break;
593                 case AST_CONTROL_FLASH:
594                         strcpy(subclass, "Flash");
595                         break;
596                 case AST_CONTROL_WINK:
597                         strcpy(subclass, "Wink");
598                         break;
599                 case AST_CONTROL_OPTION:
600                         strcpy(subclass, "Option");
601                         break;
602                 case AST_CONTROL_RADIO_KEY:
603                         strcpy(subclass, "Key Radio");
604                         break;
605                 case AST_CONTROL_RADIO_UNKEY:
606                         strcpy(subclass, "Unkey Radio");
607                         break;
608                 case AST_CONTROL_HOLD:
609                         strcpy(subclass, "Hold");
610                         break;
611                 case AST_CONTROL_UNHOLD:
612                         strcpy(subclass, "Unhold");
613                         break;
614                 case AST_CONTROL_T38_PARAMETERS:
615                         if (f->datalen != sizeof(struct ast_control_t38_parameters)) {
616                                 message = "Invalid";
617                         } else {
618                                 struct ast_control_t38_parameters *parameters = f->data.ptr;
619                                 enum ast_control_t38 state = parameters->request_response;
620                                 if (state == AST_T38_REQUEST_NEGOTIATE)
621                                         message = "Negotiation Requested";
622                                 else if (state == AST_T38_REQUEST_TERMINATE)
623                                         message = "Negotiation Request Terminated";
624                                 else if (state == AST_T38_NEGOTIATED)
625                                         message = "Negotiated";
626                                 else if (state == AST_T38_TERMINATED)
627                                         message = "Terminated";
628                                 else if (state == AST_T38_REFUSED)
629                                         message = "Refused";
630                         }
631                         snprintf(subclass, sizeof(subclass), "T38_Parameters/%s", message);
632                         break;
633                 case -1:
634                         strcpy(subclass, "Stop generators");
635                         break;
636                 default:
637                         snprintf(subclass, sizeof(subclass), "Unknown control '%d'", f->subclass.integer);
638                 }
639                 break;
640         case AST_FRAME_NULL:
641                 strcpy(ftype, "Null Frame");
642                 strcpy(subclass, "N/A");
643                 break;
644         case AST_FRAME_IAX:
645                 /* Should never happen */
646                 strcpy(ftype, "IAX Specific");
647                 snprintf(subclass, sizeof(subclass), "IAX Frametype %d", f->subclass.integer);
648                 break;
649         case AST_FRAME_TEXT:
650                 strcpy(ftype, "Text");
651                 strcpy(subclass, "N/A");
652                 ast_copy_string(moreinfo, f->data.ptr, sizeof(moreinfo));
653                 break;
654         case AST_FRAME_IMAGE:
655                 strcpy(ftype, "Image");
656                 snprintf(subclass, sizeof(subclass), "Image format %s\n", ast_getformatname(&f->subclass.format));
657                 break;
658         case AST_FRAME_HTML:
659                 strcpy(ftype, "HTML");
660                 switch (f->subclass.integer) {
661                 case AST_HTML_URL:
662                         strcpy(subclass, "URL");
663                         ast_copy_string(moreinfo, f->data.ptr, sizeof(moreinfo));
664                         break;
665                 case AST_HTML_DATA:
666                         strcpy(subclass, "Data");
667                         break;
668                 case AST_HTML_BEGIN:
669                         strcpy(subclass, "Begin");
670                         break;
671                 case AST_HTML_END:
672                         strcpy(subclass, "End");
673                         break;
674                 case AST_HTML_LDCOMPLETE:
675                         strcpy(subclass, "Load Complete");
676                         break;
677                 case AST_HTML_NOSUPPORT:
678                         strcpy(subclass, "No Support");
679                         break;
680                 case AST_HTML_LINKURL:
681                         strcpy(subclass, "Link URL");
682                         ast_copy_string(moreinfo, f->data.ptr, sizeof(moreinfo));
683                         break;
684                 case AST_HTML_UNLINK:
685                         strcpy(subclass, "Unlink");
686                         break;
687                 case AST_HTML_LINKREJECT:
688                         strcpy(subclass, "Link Reject");
689                         break;
690                 default:
691                         snprintf(subclass, sizeof(subclass), "Unknown HTML frame '%d'\n", f->subclass.integer);
692                         break;
693                 }
694                 break;
695         case AST_FRAME_MODEM:
696                 strcpy(ftype, "Modem");
697                 switch (f->subclass.integer) {
698                 case AST_MODEM_T38:
699                         strcpy(subclass, "T.38");
700                         break;
701                 case AST_MODEM_V150:
702                         strcpy(subclass, "V.150");
703                         break;
704                 default:
705                         snprintf(subclass, sizeof(subclass), "Unknown MODEM frame '%d'\n", f->subclass.integer);
706                         break;
707                 }
708                 break;
709         default:
710                 snprintf(ftype, sizeof(ftype), "Unknown Frametype '%d'", f->frametype);
711         }
712         if (!ast_strlen_zero(moreinfo))
713                 ast_verbose("%s [ TYPE: %s (%d) SUBCLASS: %s (%d) '%s' ] [%s]\n",  
714                             term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
715                             term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
716                             f->frametype, 
717                             term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
718                             f->subclass.integer, 
719                             term_color(cmn, moreinfo, COLOR_BRGREEN, COLOR_BLACK, sizeof(cmn)),
720                             term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
721         else
722                 ast_verbose("%s [ TYPE: %s (%d) SUBCLASS: %s (%d) ] [%s]\n",  
723                             term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
724                             term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
725                             f->frametype, 
726                             term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
727                             f->subclass.integer, 
728                             term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
729 }
730
731 int ast_parse_allow_disallow(struct ast_codec_pref *pref, struct ast_format_cap *cap, const char *list, int allowing) 
732 {
733         int errors = 0, framems = 0, all = 0;
734         char *parse = NULL, *this = NULL, *psize = NULL;
735         struct ast_format format;
736
737         parse = ast_strdupa(list);
738         while ((this = strsep(&parse, ","))) {
739                 framems = 0;
740                 if ((psize = strrchr(this, ':'))) {
741                         *psize++ = '\0';
742                         ast_debug(1, "Packetization for codec: %s is %s\n", this, psize);
743                         framems = atoi(psize);
744                         if (framems < 0) {
745                                 framems = 0;
746                                 errors++;
747                                 ast_log(LOG_WARNING, "Bad packetization value for codec %s\n", this);
748                         }
749                 }
750                 all = strcasecmp(this, "all") ? 0 : 1;
751
752                 if (!all && !ast_getformatbyname(this, &format)) {
753                         ast_log(LOG_WARNING, "Cannot %s unknown format '%s'\n", allowing ? "allow" : "disallow", this);
754                         errors++;
755                         continue;
756                 }
757
758                 if (cap) {
759                         if (allowing) {
760                                 if (all) {
761                                         ast_format_cap_add_all(cap);
762                                 } else {
763                                         ast_format_cap_add(cap, &format);
764                                 }
765                         } else {
766                                 if (all) {
767                                         ast_format_cap_remove_all(cap);
768                                 } else {
769                                         ast_format_cap_remove(cap, &format);
770                                 }
771                         }
772                 }
773
774                 if (pref) {
775                         if (!all) {
776                                 if (allowing) {
777                                         ast_codec_pref_append(pref, &format);
778                                         ast_codec_pref_setsize(pref, &format, framems);
779                                 } else {
780                                         ast_codec_pref_remove(pref, &format);
781                                 }
782                         } else if (!allowing) {
783                                 memset(pref, 0, sizeof(*pref));
784                         }
785                 }
786         }
787         return errors;
788 }
789
790 static int g723_len(unsigned char buf)
791 {
792         enum frame_type type = buf & TYPE_MASK;
793
794         switch(type) {
795         case TYPE_DONTSEND:
796                 return 0;
797                 break;
798         case TYPE_SILENCE:
799                 return 4;
800                 break;
801         case TYPE_HIGH:
802                 return 24;
803                 break;
804         case TYPE_LOW:
805                 return 20;
806                 break;
807         default:
808                 ast_log(LOG_WARNING, "Badly encoded frame (%d)\n", type);
809         }
810         return -1;
811 }
812
813 static int g723_samples(unsigned char *buf, int maxlen)
814 {
815         int pos = 0;
816         int samples = 0;
817         int res;
818         while(pos < maxlen) {
819                 res = g723_len(buf[pos]);
820                 if (res <= 0)
821                         break;
822                 samples += 240;
823                 pos += res;
824         }
825         return samples;
826 }
827
828 static unsigned char get_n_bits_at(unsigned char *data, int n, int bit)
829 {
830         int byte = bit / 8;       /* byte containing first bit */
831         int rem = 8 - (bit % 8);  /* remaining bits in first byte */
832         unsigned char ret = 0;
833         
834         if (n <= 0 || n > 8)
835                 return 0;
836
837         if (rem < n) {
838                 ret = (data[byte] << (n - rem));
839                 ret |= (data[byte + 1] >> (8 - n + rem));
840         } else {
841                 ret = (data[byte] >> (rem - n));
842         }
843
844         return (ret & (0xff >> (8 - n)));
845 }
846
847 static int speex_get_wb_sz_at(unsigned char *data, int len, int bit)
848 {
849         static const int SpeexWBSubModeSz[] = {
850                 4, 36, 112, 192,
851                 352, 0, 0, 0 };
852         int off = bit;
853         unsigned char c;
854
855         /* skip up to two wideband frames */
856         if (((len * 8 - off) >= 5) && 
857                 get_n_bits_at(data, 1, off)) {
858                 c = get_n_bits_at(data, 3, off + 1);
859                 off += SpeexWBSubModeSz[c];
860
861                 if (((len * 8 - off) >= 5) && 
862                         get_n_bits_at(data, 1, off)) {
863                         c = get_n_bits_at(data, 3, off + 1);
864                         off += SpeexWBSubModeSz[c];
865
866                         if (((len * 8 - off) >= 5) && 
867                                 get_n_bits_at(data, 1, off)) {
868                                 ast_log(LOG_WARNING, "Encountered corrupt speex frame; too many wideband frames in a row.\n");
869                                 return -1;
870                         }
871                 }
872
873         }
874         return off - bit;
875 }
876
877 static int speex_samples(unsigned char *data, int len)
878 {
879         static const int SpeexSubModeSz[] = {
880                 5, 43, 119, 160,
881                 220, 300, 364, 492, 
882                 79, 0, 0, 0,
883                 0, 0, 0, 0 };
884         static const int SpeexInBandSz[] = { 
885                 1, 1, 4, 4,
886                 4, 4, 4, 4,
887                 8, 8, 16, 16,
888                 32, 32, 64, 64 };
889         int bit = 0;
890         int cnt = 0;
891         int off;
892         unsigned char c;
893
894         while ((len * 8 - bit) >= 5) {
895                 /* skip wideband frames */
896                 off = speex_get_wb_sz_at(data, len, bit);
897                 if (off < 0)  {
898                         ast_log(LOG_WARNING, "Had error while reading wideband frames for speex samples\n");
899                         break;
900                 }
901                 bit += off;
902
903                 if ((len * 8 - bit) < 5)
904                         break;
905
906                 /* get control bits */
907                 c = get_n_bits_at(data, 5, bit);
908                 bit += 5;
909
910                 if (c == 15) { 
911                         /* terminator */
912                         break; 
913                 } else if (c == 14) {
914                         /* in-band signal; next 4 bits contain signal id */
915                         c = get_n_bits_at(data, 4, bit);
916                         bit += 4;
917                         bit += SpeexInBandSz[c];
918                 } else if (c == 13) {
919                         /* user in-band; next 4 bits contain msg len */
920                         c = get_n_bits_at(data, 4, bit);
921                         bit += 4;
922                         /* after which it's 5-bit signal id + c bytes of data */
923                         bit += 5 + c * 8;
924                 } else if (c > 8) {
925                         /* unknown */
926                         ast_log(LOG_WARNING, "Unknown speex control frame %d\n", c);
927                         break;
928                 } else {
929                         /* skip number bits for submode (less the 5 control bits) */
930                         bit += SpeexSubModeSz[c] - 5;
931                         cnt += 160; /* new frame */
932                 }
933         }
934         return cnt;
935 }
936
937 int ast_codec_get_samples(struct ast_frame *f)
938 {
939         int samples = 0;
940
941         switch (f->subclass.format.id) {
942         case AST_FORMAT_SPEEX:
943                 samples = speex_samples(f->data.ptr, f->datalen);
944                 break;
945         case AST_FORMAT_SPEEX16:
946                 samples = 2 * speex_samples(f->data.ptr, f->datalen);
947                 break;
948         case AST_FORMAT_SPEEX32:
949                 samples = 4 * speex_samples(f->data.ptr, f->datalen);
950                 break;
951         case AST_FORMAT_G723_1:
952                 samples = g723_samples(f->data.ptr, f->datalen);
953                 break;
954         case AST_FORMAT_ILBC:
955                 samples = 240 * (f->datalen / 50);
956                 break;
957         case AST_FORMAT_GSM:
958                 samples = 160 * (f->datalen / 33);
959                 break;
960         case AST_FORMAT_G729A:
961                 samples = f->datalen * 8;
962                 break;
963         case AST_FORMAT_SLINEAR:
964         case AST_FORMAT_SLINEAR16:
965                 samples = f->datalen / 2;
966                 break;
967         case AST_FORMAT_LPC10:
968                 /* assumes that the RTP packet contains one LPC10 frame */
969                 samples = 22 * 8;
970                 samples += (((char *)(f->data.ptr))[7] & 0x1) * 8;
971                 break;
972         case AST_FORMAT_ULAW:
973         case AST_FORMAT_ALAW:
974         case AST_FORMAT_TESTLAW:
975                 samples = f->datalen;
976                 break;
977         case AST_FORMAT_G722:
978         case AST_FORMAT_ADPCM:
979         case AST_FORMAT_G726:
980         case AST_FORMAT_G726_AAL2:
981                 samples = f->datalen * 2;
982                 break;
983         case AST_FORMAT_SIREN7:
984                 /* 16,000 samples per second at 32kbps is 4,000 bytes per second */
985                 samples = f->datalen * (16000 / 4000);
986                 break;
987         case AST_FORMAT_SIREN14:
988                 /* 32,000 samples per second at 48kbps is 6,000 bytes per second */
989                 samples = (int) f->datalen * ((float) 32000 / 6000);
990                 break;
991         case AST_FORMAT_G719:
992                 /* 48,000 samples per second at 64kbps is 8,000 bytes per second */
993                 samples = (int) f->datalen * ((float) 48000 / 8000);
994                 break;
995         case AST_FORMAT_SILK:
996                 if (!(ast_format_isset(&f->subclass.format,
997                         SILK_ATTR_KEY_SAMP_RATE,
998                         SILK_ATTR_VAL_SAMP_24KHZ,
999                         AST_FORMAT_ATTR_END))) {
1000                         return 480;
1001                 } else if (!(ast_format_isset(&f->subclass.format,
1002                         SILK_ATTR_KEY_SAMP_RATE,
1003                         SILK_ATTR_VAL_SAMP_16KHZ,
1004                         AST_FORMAT_ATTR_END))) {
1005                         return 320;
1006                 } else if (!(ast_format_isset(&f->subclass.format,
1007                         SILK_ATTR_KEY_SAMP_RATE,
1008                         SILK_ATTR_VAL_SAMP_12KHZ,
1009                         AST_FORMAT_ATTR_END))) {
1010                         return 240;
1011                 } else {
1012                         return 160;
1013                 }
1014         default:
1015                 ast_log(LOG_WARNING, "Unable to calculate samples for format %s\n", ast_getformatname(&f->subclass.format));
1016         }
1017         return samples;
1018 }
1019
1020 int ast_codec_get_len(struct ast_format *format, int samples)
1021 {
1022         int len = 0;
1023
1024         /* XXX Still need speex, and lpc10 XXX */       
1025         switch(format->id) {
1026         case AST_FORMAT_G723_1:
1027                 len = (samples / 240) * 20;
1028                 break;
1029         case AST_FORMAT_ILBC:
1030                 len = (samples / 240) * 50;
1031                 break;
1032         case AST_FORMAT_GSM:
1033                 len = (samples / 160) * 33;
1034                 break;
1035         case AST_FORMAT_G729A:
1036                 len = samples / 8;
1037                 break;
1038         case AST_FORMAT_SLINEAR:
1039         case AST_FORMAT_SLINEAR16:
1040                 len = samples * 2;
1041                 break;
1042         case AST_FORMAT_ULAW:
1043         case AST_FORMAT_ALAW:
1044         case AST_FORMAT_TESTLAW:
1045                 len = samples;
1046                 break;
1047         case AST_FORMAT_G722:
1048         case AST_FORMAT_ADPCM:
1049         case AST_FORMAT_G726:
1050         case AST_FORMAT_G726_AAL2:
1051                 len = samples / 2;
1052                 break;
1053         case AST_FORMAT_SIREN7:
1054                 /* 16,000 samples per second at 32kbps is 4,000 bytes per second */
1055                 len = samples / (16000 / 4000);
1056                 break;
1057         case AST_FORMAT_SIREN14:
1058                 /* 32,000 samples per second at 48kbps is 6,000 bytes per second */
1059                 len = (int) samples / ((float) 32000 / 6000);
1060                 break;
1061         case AST_FORMAT_G719:
1062                 /* 48,000 samples per second at 64kbps is 8,000 bytes per second */
1063                 len = (int) samples / ((float) 48000 / 8000);
1064                 break;
1065         default:
1066                 ast_log(LOG_WARNING, "Unable to calculate sample length for format %s\n", ast_getformatname(format));
1067         }
1068
1069         return len;
1070 }
1071
1072 int ast_frame_adjust_volume(struct ast_frame *f, int adjustment)
1073 {
1074         int count;
1075         short *fdata = f->data.ptr;
1076         short adjust_value = abs(adjustment);
1077
1078         if ((f->frametype != AST_FRAME_VOICE) || !(ast_format_is_slinear(&f->subclass.format))) {
1079                 return -1;
1080         }
1081
1082         if (!adjustment) {
1083                 return 0;
1084         }
1085
1086         for (count = 0; count < f->samples; count++) {
1087                 if (adjustment > 0) {
1088                         ast_slinear_saturated_multiply(&fdata[count], &adjust_value);
1089                 } else if (adjustment < 0) {
1090                         ast_slinear_saturated_divide(&fdata[count], &adjust_value);
1091                 }
1092         }
1093
1094         return 0;
1095 }
1096
1097 int ast_frame_slinear_sum(struct ast_frame *f1, struct ast_frame *f2)
1098 {
1099         int count;
1100         short *data1, *data2;
1101
1102         if ((f1->frametype != AST_FRAME_VOICE) || (f1->subclass.format.id != AST_FORMAT_SLINEAR))
1103                 return -1;
1104
1105         if ((f2->frametype != AST_FRAME_VOICE) || (f2->subclass.format.id != AST_FORMAT_SLINEAR))
1106                 return -1;
1107
1108         if (f1->samples != f2->samples)
1109                 return -1;
1110
1111         for (count = 0, data1 = f1->data.ptr, data2 = f2->data.ptr;
1112              count < f1->samples;
1113              count++, data1++, data2++)
1114                 ast_slinear_saturated_add(data1, data2);
1115
1116         return 0;
1117 }
1118
1119 int ast_frame_clear(struct ast_frame *frame)
1120 {
1121         struct ast_frame *next;
1122
1123         for (next = AST_LIST_NEXT(frame, frame_list);
1124                  frame;
1125                  frame = next, next = frame ? AST_LIST_NEXT(frame, frame_list) : NULL) {
1126                 memset(frame->data.ptr, 0, frame->datalen);
1127         }
1128         return 0;
1129 }