Improve documentation by making all of the colors used readable,
[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 /*!
355  * \brief 'isolates' a frame by duplicating non-malloc'ed components
356  * (header, src, data).
357  * On return all components are malloc'ed
358  */
359 struct ast_frame *ast_frisolate(struct ast_frame *fr)
360 {
361         struct ast_frame *out;
362         void *newdata;
363
364         /* if none of the existing frame is malloc'd, let ast_frdup() do it
365            since it is more efficient
366         */
367         if (fr->mallocd == 0) {
368                 return ast_frdup(fr);
369         }
370
371         /* if everything is already malloc'd, we are done */
372         if ((fr->mallocd & (AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA)) ==
373             (AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA)) {
374                 return fr;
375         }
376
377         if (!(fr->mallocd & AST_MALLOCD_HDR)) {
378                 /* Allocate a new header if needed */
379                 if (!(out = ast_frame_header_new())) {
380                         return NULL;
381                 }
382                 out->frametype = fr->frametype;
383                 ast_format_copy(&out->subclass.format, &fr->subclass.format);
384                 out->datalen = fr->datalen;
385                 out->samples = fr->samples;
386                 out->offset = fr->offset;
387                 /* Copy the timing data */
388                 ast_copy_flags(out, fr, AST_FLAGS_ALL);
389                 if (ast_test_flag(fr, AST_FRFLAG_HAS_TIMING_INFO)) {
390                         out->ts = fr->ts;
391                         out->len = fr->len;
392                         out->seqno = fr->seqno;
393                 }
394         } else {
395                 out = fr;
396         }
397
398         if (!(fr->mallocd & AST_MALLOCD_SRC) && fr->src) {
399                 if (!(out->src = ast_strdup(fr->src))) {
400                         if (out != fr) {
401                                 ast_free(out);
402                         }
403                         return NULL;
404                 }
405         } else {
406                 out->src = fr->src;
407                 fr->src = NULL;
408                 fr->mallocd &= ~AST_MALLOCD_SRC;
409         }
410
411         if (!(fr->mallocd & AST_MALLOCD_DATA))  {
412                 if (!fr->datalen) {
413                         out->data.uint32 = fr->data.uint32;
414                         out->mallocd = AST_MALLOCD_HDR | AST_MALLOCD_SRC;
415                         return out;
416                 }
417                 if (!(newdata = ast_malloc(fr->datalen + AST_FRIENDLY_OFFSET))) {
418                         if (out->src != fr->src) {
419                                 ast_free((void *) out->src);
420                         }
421                         if (out != fr) {
422                                 ast_free(out);
423                         }
424                         return NULL;
425                 }
426                 newdata += AST_FRIENDLY_OFFSET;
427                 out->offset = AST_FRIENDLY_OFFSET;
428                 out->datalen = fr->datalen;
429                 memcpy(newdata, fr->data.ptr, fr->datalen);
430                 out->data.ptr = newdata;
431         } else {
432                 out->data = fr->data;
433                 memset(&fr->data, 0, sizeof(fr->data));
434                 fr->mallocd &= ~AST_MALLOCD_DATA;
435         }
436
437         out->mallocd = AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA;
438
439         return out;
440 }
441
442 struct ast_frame *ast_frdup(const struct ast_frame *f)
443 {
444         struct ast_frame *out = NULL;
445         int len, srclen = 0;
446         void *buf = NULL;
447
448 #if !defined(LOW_MEMORY)
449         struct ast_frame_cache *frames;
450 #endif
451
452         /* Start with standard stuff */
453         len = sizeof(*out) + AST_FRIENDLY_OFFSET + f->datalen;
454         /* If we have a source, add space for it */
455         /*
456          * XXX Watch out here - if we receive a src which is not terminated
457          * properly, we can be easily attacked. Should limit the size we deal with.
458          */
459         if (f->src)
460                 srclen = strlen(f->src);
461         if (srclen > 0)
462                 len += srclen + 1;
463
464 #if !defined(LOW_MEMORY)
465         if ((frames = ast_threadstorage_get(&frame_cache, sizeof(*frames)))) {
466                 AST_LIST_TRAVERSE_SAFE_BEGIN(&frames->list, out, frame_list) {
467                         if (out->mallocd_hdr_len >= len) {
468                                 size_t mallocd_len = out->mallocd_hdr_len;
469
470                                 AST_LIST_REMOVE_CURRENT(frame_list);
471                                 memset(out, 0, sizeof(*out));
472                                 out->mallocd_hdr_len = mallocd_len;
473                                 buf = out;
474                                 frames->size--;
475                                 break;
476                         }
477                 }
478                 AST_LIST_TRAVERSE_SAFE_END;
479         }
480 #endif
481
482         if (!buf) {
483                 if (!(buf = ast_calloc_cache(1, len)))
484                         return NULL;
485                 out = buf;
486                 out->mallocd_hdr_len = len;
487         }
488
489         out->frametype = f->frametype;
490         ast_format_copy(&out->subclass.format, &f->subclass.format);
491         out->datalen = f->datalen;
492         out->samples = f->samples;
493         out->delivery = f->delivery;
494         /* Even though this new frame was allocated from the heap, we can't mark it
495          * with AST_MALLOCD_HDR, AST_MALLOCD_DATA and AST_MALLOCD_SRC, because that
496          * would cause ast_frfree() to attempt to individually free each of those
497          * under the assumption that they were separately allocated. Since this frame
498          * was allocated in a single allocation, we'll only mark it as if the header
499          * was heap-allocated; this will result in the entire frame being properly freed.
500          */
501         out->mallocd = AST_MALLOCD_HDR;
502         out->offset = AST_FRIENDLY_OFFSET;
503         if (out->datalen) {
504                 out->data.ptr = buf + sizeof(*out) + AST_FRIENDLY_OFFSET;
505                 memcpy(out->data.ptr, f->data.ptr, out->datalen);
506         } else {
507                 out->data.uint32 = f->data.uint32;
508         }
509         if (srclen > 0) {
510                 /* This may seem a little strange, but it's to avoid a gcc (4.2.4) compiler warning */
511                 char *src;
512                 out->src = buf + sizeof(*out) + AST_FRIENDLY_OFFSET + f->datalen;
513                 src = (char *) out->src;
514                 /* Must have space since we allocated for it */
515                 strcpy(src, f->src);
516         }
517         ast_copy_flags(out, f, AST_FLAGS_ALL);
518         out->ts = f->ts;
519         out->len = f->len;
520         out->seqno = f->seqno;
521         return out;
522 }
523
524 void ast_swapcopy_samples(void *dst, const void *src, int samples)
525 {
526         int i;
527         unsigned short *dst_s = dst;
528         const unsigned short *src_s = src;
529
530         for (i = 0; i < samples; i++)
531                 dst_s[i] = (src_s[i]<<8) | (src_s[i]>>8);
532 }
533
534 void ast_frame_subclass2str(struct ast_frame *f, char *subclass, size_t slen, char *moreinfo, size_t mlen)
535 {
536         switch(f->frametype) {
537         case AST_FRAME_DTMF_BEGIN:
538                 if (slen > 1) {
539                         subclass[0] = f->subclass.integer;
540                         subclass[1] = '\0';
541                 }
542                 break;
543         case AST_FRAME_DTMF_END:
544                 if (slen > 1) {
545                         subclass[0] = f->subclass.integer;
546                         subclass[1] = '\0';
547                 }
548                 break;
549         case AST_FRAME_CONTROL:
550                 switch (f->subclass.integer) {
551                 case AST_CONTROL_HANGUP:
552                         ast_copy_string(subclass, "Hangup", slen);
553                         break;
554                 case AST_CONTROL_RING:
555                         ast_copy_string(subclass, "Ring", slen);
556                         break;
557                 case AST_CONTROL_RINGING:
558                         ast_copy_string(subclass, "Ringing", slen);
559                         break;
560                 case AST_CONTROL_ANSWER:
561                         ast_copy_string(subclass, "Answer", slen);
562                         break;
563                 case AST_CONTROL_BUSY:
564                         ast_copy_string(subclass, "Busy", slen);
565                         break;
566                 case AST_CONTROL_TAKEOFFHOOK:
567                         ast_copy_string(subclass, "Take Off Hook", slen);
568                         break;
569                 case AST_CONTROL_OFFHOOK:
570                         ast_copy_string(subclass, "Line Off Hook", slen);
571                         break;
572                 case AST_CONTROL_CONGESTION:
573                         ast_copy_string(subclass, "Congestion", slen);
574                         break;
575                 case AST_CONTROL_FLASH:
576                         ast_copy_string(subclass, "Flash", slen);
577                         break;
578                 case AST_CONTROL_WINK:
579                         ast_copy_string(subclass, "Wink", slen);
580                         break;
581                 case AST_CONTROL_OPTION:
582                         ast_copy_string(subclass, "Option", slen);
583                         break;
584                 case AST_CONTROL_RADIO_KEY:
585                         ast_copy_string(subclass, "Key Radio", slen);
586                         break;
587                 case AST_CONTROL_RADIO_UNKEY:
588                         ast_copy_string(subclass, "Unkey Radio", slen);
589                         break;
590                 case AST_CONTROL_HOLD:
591                         ast_copy_string(subclass, "Hold", slen);
592                         break;
593                 case AST_CONTROL_UNHOLD:
594                         ast_copy_string(subclass, "Unhold", slen);
595                         break;
596                 case AST_CONTROL_T38_PARAMETERS: {
597                         char *message = "Unknown";
598                         if (f->datalen != sizeof(struct ast_control_t38_parameters)) {
599                                 message = "Invalid";
600                         } else {
601                                 struct ast_control_t38_parameters *parameters = f->data.ptr;
602                                 enum ast_control_t38 state = parameters->request_response;
603                                 if (state == AST_T38_REQUEST_NEGOTIATE)
604                                         message = "Negotiation Requested";
605                                 else if (state == AST_T38_REQUEST_TERMINATE)
606                                         message = "Negotiation Request Terminated";
607                                 else if (state == AST_T38_NEGOTIATED)
608                                         message = "Negotiated";
609                                 else if (state == AST_T38_TERMINATED)
610                                         message = "Terminated";
611                                 else if (state == AST_T38_REFUSED)
612                                         message = "Refused";
613                         }
614                         snprintf(subclass, slen, "T38_Parameters/%s", message);
615                         break;
616                 }
617                 case -1:
618                         ast_copy_string(subclass, "Stop generators", slen);
619                         break;
620                 default:
621                         snprintf(subclass, slen, "Unknown control '%d'", f->subclass.integer);
622                 }
623                 break;
624         case AST_FRAME_NULL:
625                 ast_copy_string(subclass, "N/A", slen);
626                 break;
627         case AST_FRAME_IAX:
628                 /* Should never happen */
629                 snprintf(subclass, slen, "IAX Frametype %d", f->subclass.integer);
630                 break;
631         case AST_FRAME_TEXT:
632                 ast_copy_string(subclass, "N/A", slen);
633                 if (moreinfo) {
634                         ast_copy_string(moreinfo, f->data.ptr, mlen);
635                 }
636                 break;
637         case AST_FRAME_IMAGE:
638                 snprintf(subclass, slen, "Image format %s\n", ast_getformatname(&f->subclass.format));
639                 break;
640         case AST_FRAME_HTML:
641                 switch (f->subclass.integer) {
642                 case AST_HTML_URL:
643                         ast_copy_string(subclass, "URL", slen);
644                         if (moreinfo) {
645                                 ast_copy_string(moreinfo, f->data.ptr, mlen);
646                         }
647                         break;
648                 case AST_HTML_DATA:
649                         ast_copy_string(subclass, "Data", slen);
650                         break;
651                 case AST_HTML_BEGIN:
652                         ast_copy_string(subclass, "Begin", slen);
653                         break;
654                 case AST_HTML_END:
655                         ast_copy_string(subclass, "End", slen);
656                         break;
657                 case AST_HTML_LDCOMPLETE:
658                         ast_copy_string(subclass, "Load Complete", slen);
659                         break;
660                 case AST_HTML_NOSUPPORT:
661                         ast_copy_string(subclass, "No Support", slen);
662                         break;
663                 case AST_HTML_LINKURL:
664                         ast_copy_string(subclass, "Link URL", slen);
665                         if (moreinfo) {
666                                 ast_copy_string(moreinfo, f->data.ptr, mlen);
667                         }
668                         break;
669                 case AST_HTML_UNLINK:
670                         ast_copy_string(subclass, "Unlink", slen);
671                         break;
672                 case AST_HTML_LINKREJECT:
673                         ast_copy_string(subclass, "Link Reject", slen);
674                         break;
675                 default:
676                         snprintf(subclass, slen, "Unknown HTML frame '%d'\n", f->subclass.integer);
677                         break;
678                 }
679                 break;
680         case AST_FRAME_MODEM:
681                 switch (f->subclass.integer) {
682                 case AST_MODEM_T38:
683                         ast_copy_string(subclass, "T.38", slen);
684                         break;
685                 case AST_MODEM_V150:
686                         ast_copy_string(subclass, "V.150", slen);
687                         break;
688                 default:
689                         snprintf(subclass, slen, "Unknown MODEM frame '%d'\n", f->subclass.integer);
690                         break;
691                 }
692                 break;
693         default:
694                 ast_copy_string(subclass, "Unknown Subclass", slen);
695         }
696 }
697
698 void ast_frame_type2str(enum ast_frame_type frame_type, char *ftype, size_t len)
699 {
700         switch (frame_type) {
701         case AST_FRAME_DTMF_BEGIN:
702                 ast_copy_string(ftype, "DTMF Begin", len);
703                 break;
704         case AST_FRAME_DTMF_END:
705                 ast_copy_string(ftype, "DTMF End", len);
706                 break;
707         case AST_FRAME_CONTROL:
708                 ast_copy_string(ftype, "Control", len);
709                 break;
710         case AST_FRAME_NULL:
711                 ast_copy_string(ftype, "Null Frame", len);
712                 break;
713         case AST_FRAME_IAX:
714                 /* Should never happen */
715                 ast_copy_string(ftype, "IAX Specific", len);
716                 break;
717         case AST_FRAME_TEXT:
718                 ast_copy_string(ftype, "Text", len);
719                 break;
720         case AST_FRAME_IMAGE:
721                 ast_copy_string(ftype, "Image", len);
722                 break;
723         case AST_FRAME_HTML:
724                 ast_copy_string(ftype, "HTML", len);
725                 break;
726         case AST_FRAME_MODEM:
727                 ast_copy_string(ftype, "Modem", len);
728                 break;
729         case AST_FRAME_VOICE:
730                 ast_copy_string(ftype, "Voice", len);
731                 break;
732         case AST_FRAME_VIDEO:
733                 ast_copy_string(ftype, "Video", len);
734                 break;
735         default:
736                 snprintf(ftype, len, "Unknown Frametype '%d'", frame_type);
737         }
738 }
739
740 /*! Dump a frame for debugging purposes */
741 void ast_frame_dump(const char *name, struct ast_frame *f, char *prefix)
742 {
743         const char noname[] = "unknown";
744         char ftype[40] = "Unknown Frametype";
745         char cft[80];
746         char subclass[40] = "Unknown Subclass";
747         char csub[80];
748         char moreinfo[40] = "";
749         char cn[60];
750         char cp[40];
751         char cmn[40];
752
753         if (!name) {
754                 name = noname;
755         }
756
757         if (!f) {
758                 ast_verb(-1, "%s [ %s (NULL) ] [%s]\n",
759                         term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
760                         term_color(cft, "HANGUP", COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
761                         term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
762                 return;
763         }
764         /* XXX We should probably print one each of voice and video when the format changes XXX */
765         if (f->frametype == AST_FRAME_VOICE) {
766                 return;
767         }
768         if (f->frametype == AST_FRAME_VIDEO) {
769                 return;
770         }
771
772         ast_frame_type2str(f->frametype, ftype, sizeof(ftype));
773         ast_frame_subclass2str(f, subclass, sizeof(subclass), moreinfo, sizeof(moreinfo));
774
775         if (!ast_strlen_zero(moreinfo))
776                 ast_verb(-1, "%s [ TYPE: %s (%d) SUBCLASS: %s (%d) '%s' ] [%s]\n",
777                             term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
778                             term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
779                             f->frametype,
780                             term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
781                             f->subclass.integer,
782                             term_color(cmn, moreinfo, COLOR_BRGREEN, COLOR_BLACK, sizeof(cmn)),
783                             term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
784         else
785                 ast_verb(-1, "%s [ TYPE: %s (%d) SUBCLASS: %s (%d) ] [%s]\n",
786                             term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
787                             term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
788                             f->frametype,
789                             term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
790                             f->subclass.integer,
791                             term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
792 }
793
794 int ast_parse_allow_disallow(struct ast_codec_pref *pref, struct ast_format_cap *cap, const char *list, int allowing)
795 {
796         int errors = 0, framems = 0, all = 0, iter_allowing;
797         char *parse = NULL, *this = NULL, *psize = NULL;
798         struct ast_format format;
799
800         parse = ast_strdupa(list);
801         while ((this = strsep(&parse, ","))) {
802                 iter_allowing = allowing;
803                 framems = 0;
804                 if (*this == '!') {
805                         this++;
806                         iter_allowing = !allowing;
807                 }
808                 if ((psize = strrchr(this, ':'))) {
809                         *psize++ = '\0';
810                         ast_debug(1, "Packetization for codec: %s is %s\n", this, psize);
811                         framems = atoi(psize);
812                         if (framems < 0) {
813                                 framems = 0;
814                                 errors++;
815                                 ast_log(LOG_WARNING, "Bad packetization value for codec %s\n", this);
816                         }
817                 }
818                 all = strcasecmp(this, "all") ? 0 : 1;
819
820                 if (!all && !ast_getformatbyname(this, &format)) {
821                         ast_log(LOG_WARNING, "Cannot %s unknown format '%s'\n", iter_allowing ? "allow" : "disallow", this);
822                         errors++;
823                         continue;
824                 }
825
826                 if (cap) {
827                         if (iter_allowing) {
828                                 if (all) {
829                                         ast_format_cap_add_all(cap);
830                                 } else {
831                                         ast_format_cap_add(cap, &format);
832                                 }
833                         } else {
834                                 if (all) {
835                                         ast_format_cap_remove_all(cap);
836                                 } else {
837                                         ast_format_cap_remove(cap, &format);
838                                 }
839                         }
840                 }
841
842                 if (pref) {
843                         if (!all) {
844                                 if (iter_allowing) {
845                                         ast_codec_pref_append(pref, &format);
846                                         ast_codec_pref_setsize(pref, &format, framems);
847                                 } else {
848                                         ast_codec_pref_remove(pref, &format);
849                                 }
850                         } else if (!iter_allowing) {
851                                 memset(pref, 0, sizeof(*pref));
852                         }
853                 }
854         }
855         return errors;
856 }
857
858 static int g723_len(unsigned char buf)
859 {
860         enum frame_type type = buf & TYPE_MASK;
861
862         switch(type) {
863         case TYPE_DONTSEND:
864                 return 0;
865                 break;
866         case TYPE_SILENCE:
867                 return 4;
868                 break;
869         case TYPE_HIGH:
870                 return 24;
871                 break;
872         case TYPE_LOW:
873                 return 20;
874                 break;
875         default:
876                 ast_log(LOG_WARNING, "Badly encoded frame (%d)\n", type);
877         }
878         return -1;
879 }
880
881 static int g723_samples(unsigned char *buf, int maxlen)
882 {
883         int pos = 0;
884         int samples = 0;
885         int res;
886         while(pos < maxlen) {
887                 res = g723_len(buf[pos]);
888                 if (res <= 0)
889                         break;
890                 samples += 240;
891                 pos += res;
892         }
893         return samples;
894 }
895
896 static unsigned char get_n_bits_at(unsigned char *data, int n, int bit)
897 {
898         int byte = bit / 8;       /* byte containing first bit */
899         int rem = 8 - (bit % 8);  /* remaining bits in first byte */
900         unsigned char ret = 0;
901
902         if (n <= 0 || n > 8)
903                 return 0;
904
905         if (rem < n) {
906                 ret = (data[byte] << (n - rem));
907                 ret |= (data[byte + 1] >> (8 - n + rem));
908         } else {
909                 ret = (data[byte] >> (rem - n));
910         }
911
912         return (ret & (0xff >> (8 - n)));
913 }
914
915 static int speex_get_wb_sz_at(unsigned char *data, int len, int bit)
916 {
917         static const int SpeexWBSubModeSz[] = {
918                 4, 36, 112, 192,
919                 352, 0, 0, 0 };
920         int off = bit;
921         unsigned char c;
922
923         /* skip up to two wideband frames */
924         if (((len * 8 - off) >= 5) &&
925                 get_n_bits_at(data, 1, off)) {
926                 c = get_n_bits_at(data, 3, off + 1);
927                 off += SpeexWBSubModeSz[c];
928
929                 if (((len * 8 - off) >= 5) &&
930                         get_n_bits_at(data, 1, off)) {
931                         c = get_n_bits_at(data, 3, off + 1);
932                         off += SpeexWBSubModeSz[c];
933
934                         if (((len * 8 - off) >= 5) &&
935                                 get_n_bits_at(data, 1, off)) {
936                                 ast_log(LOG_WARNING, "Encountered corrupt speex frame; too many wideband frames in a row.\n");
937                                 return -1;
938                         }
939                 }
940
941         }
942         return off - bit;
943 }
944
945 static int speex_samples(unsigned char *data, int len)
946 {
947         static const int SpeexSubModeSz[] = {
948                 5, 43, 119, 160,
949                 220, 300, 364, 492,
950                 79, 0, 0, 0,
951                 0, 0, 0, 0 };
952         static const int SpeexInBandSz[] = {
953                 1, 1, 4, 4,
954                 4, 4, 4, 4,
955                 8, 8, 16, 16,
956                 32, 32, 64, 64 };
957         int bit = 0;
958         int cnt = 0;
959         int off;
960         unsigned char c;
961
962         while ((len * 8 - bit) >= 5) {
963                 /* skip wideband frames */
964                 off = speex_get_wb_sz_at(data, len, bit);
965                 if (off < 0)  {
966                         ast_log(LOG_WARNING, "Had error while reading wideband frames for speex samples\n");
967                         break;
968                 }
969                 bit += off;
970
971                 if ((len * 8 - bit) < 5)
972                         break;
973
974                 /* get control bits */
975                 c = get_n_bits_at(data, 5, bit);
976                 bit += 5;
977
978                 if (c == 15) {
979                         /* terminator */
980                         break;
981                 } else if (c == 14) {
982                         /* in-band signal; next 4 bits contain signal id */
983                         c = get_n_bits_at(data, 4, bit);
984                         bit += 4;
985                         bit += SpeexInBandSz[c];
986                 } else if (c == 13) {
987                         /* user in-band; next 4 bits contain msg len */
988                         c = get_n_bits_at(data, 4, bit);
989                         bit += 4;
990                         /* after which it's 5-bit signal id + c bytes of data */
991                         bit += 5 + c * 8;
992                 } else if (c > 8) {
993                         /* unknown */
994                         ast_log(LOG_WARNING, "Unknown speex control frame %d\n", c);
995                         break;
996                 } else {
997                         /* skip number bits for submode (less the 5 control bits) */
998                         bit += SpeexSubModeSz[c] - 5;
999                         cnt += 160; /* new frame */
1000                 }
1001         }
1002         return cnt;
1003 }
1004
1005 int ast_codec_get_samples(struct ast_frame *f)
1006 {
1007         int samples = 0;
1008
1009         switch (f->subclass.format.id) {
1010         case AST_FORMAT_SPEEX:
1011                 samples = speex_samples(f->data.ptr, f->datalen);
1012                 break;
1013         case AST_FORMAT_SPEEX16:
1014                 samples = 2 * speex_samples(f->data.ptr, f->datalen);
1015                 break;
1016         case AST_FORMAT_SPEEX32:
1017                 samples = 4 * speex_samples(f->data.ptr, f->datalen);
1018                 break;
1019         case AST_FORMAT_G723_1:
1020                 samples = g723_samples(f->data.ptr, f->datalen);
1021                 break;
1022         case AST_FORMAT_ILBC:
1023                 samples = 240 * (f->datalen / 50);
1024                 break;
1025         case AST_FORMAT_GSM:
1026                 samples = 160 * (f->datalen / 33);
1027                 break;
1028         case AST_FORMAT_G729A:
1029                 samples = f->datalen * 8;
1030                 break;
1031         case AST_FORMAT_SLINEAR:
1032         case AST_FORMAT_SLINEAR16:
1033                 samples = f->datalen / 2;
1034                 break;
1035         case AST_FORMAT_LPC10:
1036                 /* assumes that the RTP packet contains one LPC10 frame */
1037                 samples = 22 * 8;
1038                 samples += (((char *)(f->data.ptr))[7] & 0x1) * 8;
1039                 break;
1040         case AST_FORMAT_ULAW:
1041         case AST_FORMAT_ALAW:
1042         case AST_FORMAT_TESTLAW:
1043                 samples = f->datalen;
1044                 break;
1045         case AST_FORMAT_G722:
1046         case AST_FORMAT_ADPCM:
1047         case AST_FORMAT_G726:
1048         case AST_FORMAT_G726_AAL2:
1049                 samples = f->datalen * 2;
1050                 break;
1051         case AST_FORMAT_SIREN7:
1052                 /* 16,000 samples per second at 32kbps is 4,000 bytes per second */
1053                 samples = f->datalen * (16000 / 4000);
1054                 break;
1055         case AST_FORMAT_SIREN14:
1056                 /* 32,000 samples per second at 48kbps is 6,000 bytes per second */
1057                 samples = (int) f->datalen * ((float) 32000 / 6000);
1058                 break;
1059         case AST_FORMAT_G719:
1060                 /* 48,000 samples per second at 64kbps is 8,000 bytes per second */
1061                 samples = (int) f->datalen * ((float) 48000 / 8000);
1062                 break;
1063         case AST_FORMAT_SILK:
1064                 if (!(ast_format_isset(&f->subclass.format,
1065                         SILK_ATTR_KEY_SAMP_RATE,
1066                         SILK_ATTR_VAL_SAMP_24KHZ,
1067                         AST_FORMAT_ATTR_END))) {
1068                         return 480;
1069                 } else if (!(ast_format_isset(&f->subclass.format,
1070                         SILK_ATTR_KEY_SAMP_RATE,
1071                         SILK_ATTR_VAL_SAMP_16KHZ,
1072                         AST_FORMAT_ATTR_END))) {
1073                         return 320;
1074                 } else if (!(ast_format_isset(&f->subclass.format,
1075                         SILK_ATTR_KEY_SAMP_RATE,
1076                         SILK_ATTR_VAL_SAMP_12KHZ,
1077                         AST_FORMAT_ATTR_END))) {
1078                         return 240;
1079                 } else {
1080                         return 160;
1081                 }
1082         case AST_FORMAT_CELT:
1083                 /* TODO The assumes 20ms delivery right now, which is incorrect */
1084                 samples = ast_format_rate(&f->subclass.format) / 50;
1085                 break;
1086         default:
1087                 ast_log(LOG_WARNING, "Unable to calculate samples for format %s\n", ast_getformatname(&f->subclass.format));
1088         }
1089         return samples;
1090 }
1091
1092 int ast_codec_get_len(struct ast_format *format, int samples)
1093 {
1094         int len = 0;
1095
1096         /* XXX Still need speex, and lpc10 XXX */
1097         switch(format->id) {
1098         case AST_FORMAT_G723_1:
1099                 len = (samples / 240) * 20;
1100                 break;
1101         case AST_FORMAT_ILBC:
1102                 len = (samples / 240) * 50;
1103                 break;
1104         case AST_FORMAT_GSM:
1105                 len = (samples / 160) * 33;
1106                 break;
1107         case AST_FORMAT_G729A:
1108                 len = samples / 8;
1109                 break;
1110         case AST_FORMAT_SLINEAR:
1111         case AST_FORMAT_SLINEAR16:
1112                 len = samples * 2;
1113                 break;
1114         case AST_FORMAT_ULAW:
1115         case AST_FORMAT_ALAW:
1116         case AST_FORMAT_TESTLAW:
1117                 len = samples;
1118                 break;
1119         case AST_FORMAT_G722:
1120         case AST_FORMAT_ADPCM:
1121         case AST_FORMAT_G726:
1122         case AST_FORMAT_G726_AAL2:
1123                 len = samples / 2;
1124                 break;
1125         case AST_FORMAT_SIREN7:
1126                 /* 16,000 samples per second at 32kbps is 4,000 bytes per second */
1127                 len = samples / (16000 / 4000);
1128                 break;
1129         case AST_FORMAT_SIREN14:
1130                 /* 32,000 samples per second at 48kbps is 6,000 bytes per second */
1131                 len = (int) samples / ((float) 32000 / 6000);
1132                 break;
1133         case AST_FORMAT_G719:
1134                 /* 48,000 samples per second at 64kbps is 8,000 bytes per second */
1135                 len = (int) samples / ((float) 48000 / 8000);
1136                 break;
1137         default:
1138                 ast_log(LOG_WARNING, "Unable to calculate sample length for format %s\n", ast_getformatname(format));
1139         }
1140
1141         return len;
1142 }
1143
1144 int ast_frame_adjust_volume(struct ast_frame *f, int adjustment)
1145 {
1146         int count;
1147         short *fdata = f->data.ptr;
1148         short adjust_value = abs(adjustment);
1149
1150         if ((f->frametype != AST_FRAME_VOICE) || !(ast_format_is_slinear(&f->subclass.format))) {
1151                 return -1;
1152         }
1153
1154         if (!adjustment) {
1155                 return 0;
1156         }
1157
1158         for (count = 0; count < f->samples; count++) {
1159                 if (adjustment > 0) {
1160                         ast_slinear_saturated_multiply(&fdata[count], &adjust_value);
1161                 } else if (adjustment < 0) {
1162                         ast_slinear_saturated_divide(&fdata[count], &adjust_value);
1163                 }
1164         }
1165
1166         return 0;
1167 }
1168
1169 int ast_frame_slinear_sum(struct ast_frame *f1, struct ast_frame *f2)
1170 {
1171         int count;
1172         short *data1, *data2;
1173
1174         if ((f1->frametype != AST_FRAME_VOICE) || (f1->subclass.format.id != AST_FORMAT_SLINEAR))
1175                 return -1;
1176
1177         if ((f2->frametype != AST_FRAME_VOICE) || (f2->subclass.format.id != AST_FORMAT_SLINEAR))
1178                 return -1;
1179
1180         if (f1->samples != f2->samples)
1181                 return -1;
1182
1183         for (count = 0, data1 = f1->data.ptr, data2 = f2->data.ptr;
1184              count < f1->samples;
1185              count++, data1++, data2++)
1186                 ast_slinear_saturated_add(data1, data2);
1187
1188         return 0;
1189 }
1190
1191 int ast_frame_clear(struct ast_frame *frame)
1192 {
1193         struct ast_frame *next;
1194
1195         for (next = AST_LIST_NEXT(frame, frame_list);
1196                  frame;
1197                  frame = next, next = frame ? AST_LIST_NEXT(frame, frame_list) : NULL) {
1198                 memset(frame->data.ptr, 0, frame->datalen);
1199         }
1200         return 0;
1201 }