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