Add iLBC codec
[asterisk/asterisk.git] / frame.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Frame manipulation routines
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #include <asterisk/lock.h>
15 #include <asterisk/frame.h>
16 #include <asterisk/logger.h>
17 #include <asterisk/options.h>
18 #include <asterisk/cli.h>
19 #include <asterisk/term.h>
20 #include <stdlib.h>
21 #include <unistd.h>
22 #include <string.h>
23 #include <errno.h>
24 #include <pthread.h>
25 #include <stdio.h>
26 #include "asterisk.h"
27
28 #ifdef TRACE_FRAMES
29 static int headers = 0;
30 static struct ast_frame *headerlist = NULL;
31 static pthread_mutex_t framelock = AST_MUTEX_INITIALIZER;
32 #endif
33
34 #define SMOOTHER_SIZE 8000
35
36 struct ast_smoother {
37         int size;
38         int format;
39         int readdata;
40         int optimizablestream;
41         float samplesperbyte;
42         struct ast_frame f;
43         char data[SMOOTHER_SIZE];
44         char framedata[SMOOTHER_SIZE + AST_FRIENDLY_OFFSET];
45         struct ast_frame *opt;
46         int len;
47 };
48
49 void ast_smoother_reset(struct ast_smoother *s, int size)
50 {
51         memset(s, 0, sizeof(struct ast_smoother));
52         s->size = size;
53 }
54
55 struct ast_smoother *ast_smoother_new(int size)
56 {
57         struct ast_smoother *s;
58         if (size < 1)
59                 return NULL;
60         s = malloc(sizeof(struct ast_smoother));
61         if (s)
62                 ast_smoother_reset(s, size);
63         return s;
64 }
65
66 int ast_smoother_feed(struct ast_smoother *s, struct ast_frame *f)
67 {
68         if (f->frametype != AST_FRAME_VOICE) {
69                 ast_log(LOG_WARNING, "Huh?  Can't smooth a non-voice frame!\n");
70                 return -1;
71         }
72         if (!s->format) {
73                 s->format = f->subclass;
74                 s->samplesperbyte = (float)f->samples / (float)f->datalen;
75         } else if (s->format != f->subclass) {
76                 ast_log(LOG_WARNING, "Smoother was working on %d format frames, now trying to feed %d?\n", s->format, f->subclass);
77                 return -1;
78         }
79         if (s->len + f->datalen > SMOOTHER_SIZE) {
80                 ast_log(LOG_WARNING, "Out of smoother space\n");
81                 return -1;
82         }
83         if ((f->datalen == s->size) && !s->opt) {
84                 if (!s->len) {
85                         /* Optimize by sending the frame we just got
86                            on the next read, thus eliminating the douple
87                            copy */
88                         s->opt = f;
89                         return 0;
90                 } else {
91                         s->optimizablestream++;
92                         if (s->optimizablestream > 10) {
93                                 /* For the past 10 rounds, we have input and output
94                                    frames of the correct size for this smoother, yet
95                                    we were unable to optimize because there was still
96                                    some cruft left over.  Lets just drop the cruft so
97                                    we can move to a fully optimized path */
98                                 s->len = 0;
99                                 s->opt = f;
100                                 return 0;
101                         }
102                 }
103         } else 
104                 s->optimizablestream = 0;
105         memcpy(s->data + s->len, f->data, f->datalen);
106         s->len += f->datalen;
107         return 0;
108 }
109
110 struct ast_frame *ast_smoother_read(struct ast_smoother *s)
111 {
112         struct ast_frame *opt;
113
114         /* IF we have an optimization frame, send it */
115         if (s->opt) {
116                 opt = s->opt;
117                 s->opt = NULL;
118                 return opt;
119         }
120
121         /* Make sure we have enough data */
122         if (s->len < s->size) {
123                 return NULL;
124         }
125         /* Make frame */
126         s->f.frametype = AST_FRAME_VOICE;
127         s->f.subclass = s->format;
128         s->f.data = s->framedata + AST_FRIENDLY_OFFSET;
129         s->f.offset = AST_FRIENDLY_OFFSET;
130         s->f.datalen = s->size;
131         s->f.samples = s->size * s->samplesperbyte;
132         /* Fill Data */
133         memcpy(s->f.data, s->data, s->size);
134         s->len -= s->size;
135         /* Move remaining data to the front if applicable */
136         if (s->len) 
137                 memmove(s->data, s->data + s->size, s->len);
138         /* Return frame */
139         return &s->f;
140 }
141
142 void ast_smoother_free(struct ast_smoother *s)
143 {
144         free(s);
145 }
146
147 static struct ast_frame *ast_frame_header_new(void)
148 {
149         struct ast_frame *f;
150         f = malloc(sizeof(struct ast_frame));
151         if (f)
152                 memset(f, 0, sizeof(struct ast_frame));
153 #ifdef TRACE_FRAMES
154         if (f) {
155                 headers++;
156                 f->prev = NULL;
157                 ast_pthread_mutex_lock(&framelock);
158                 f->next = headerlist;
159                 if (headerlist)
160                         headerlist->prev = f;
161                 headerlist = f;
162                 pthread_mutex_unlock(&framelock);
163         }
164 #endif  
165         return f;
166 }
167
168 /*
169  * Important: I should be made more efficient.  Frame headers should
170  * most definitely be cached
171  */
172
173 void ast_frfree(struct ast_frame *fr)
174 {
175         if (fr->mallocd & AST_MALLOCD_DATA) {
176                 if (fr->data) 
177                         free(fr->data - fr->offset);
178         }
179         if (fr->mallocd & AST_MALLOCD_SRC) {
180                 if (fr->src)
181                         free(fr->src);
182         }
183         if (fr->mallocd & AST_MALLOCD_HDR) {
184 #ifdef TRACE_FRAMES
185                 headers--;
186                 ast_pthread_mutex_lock(&framelock);
187                 if (fr->next)
188                         fr->next->prev = fr->prev;
189                 if (fr->prev)
190                         fr->prev->next = fr->next;
191                 else
192                         headerlist = fr->next;
193                 pthread_mutex_unlock(&framelock);
194 #endif                  
195                 free(fr);
196         }
197 }
198
199 struct ast_frame *ast_frisolate(struct ast_frame *fr)
200 {
201         struct ast_frame *out;
202         if (!(fr->mallocd & AST_MALLOCD_HDR)) {
203                 /* Allocate a new header if needed */
204                 out = ast_frame_header_new();
205                 if (!out) {
206                         ast_log(LOG_WARNING, "Out of memory\n");
207                         return NULL;
208                 }
209                 out->frametype = fr->frametype;
210                 out->subclass = fr->subclass;
211                 out->datalen = 0;
212                 out->samples = fr->samples;
213                 out->offset = 0;
214                 out->src = NULL;
215                 out->data = NULL;
216         } else {
217                 out = fr;
218         }
219         if (!(fr->mallocd & AST_MALLOCD_SRC)) {
220                 if (fr->src)
221                         out->src = strdup(fr->src);
222         } else
223                 out->src = fr->src;
224         if (!(fr->mallocd & AST_MALLOCD_DATA))  {
225                 out->data = malloc(fr->datalen + AST_FRIENDLY_OFFSET);
226                 if (!out->data) {
227                         free(out);
228                         ast_log(LOG_WARNING, "Out of memory\n");
229                         return NULL;
230                 }
231                 out->data += AST_FRIENDLY_OFFSET;
232                 out->offset = AST_FRIENDLY_OFFSET;
233                 out->datalen = fr->datalen;
234                 memcpy(out->data, fr->data, fr->datalen);
235         }
236         out->mallocd = AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA;
237         return out;
238 }
239
240 struct ast_frame *ast_frdup(struct ast_frame *f)
241 {
242         struct ast_frame *out;
243         int len;
244         void *buf;
245         /* Start with standard stuff */
246         len = sizeof(struct ast_frame) + AST_FRIENDLY_OFFSET + f->datalen;
247         /* If we have a source, add space for it */
248         if (f->src && strlen(f->src))
249                 len += strlen(f->src) + 1;
250         buf = malloc(len);
251         if (!buf)
252                 return NULL;
253         out = buf;
254         /* Set us as having malloc'd header only, so it will eventually
255            get freed. */
256         out->frametype = f->frametype;
257         out->subclass = f->subclass;
258         out->datalen = f->datalen;
259         out->samples = f->samples;
260         out->mallocd = AST_MALLOCD_HDR;
261         out->offset = AST_FRIENDLY_OFFSET;
262         out->data = buf + sizeof(struct ast_frame) + AST_FRIENDLY_OFFSET;
263         if (f->src && strlen(f->src)) {
264                 out->src = out->data + f->datalen;
265                 /* Must have space since we allocated for it */
266                 strcpy(out->src, f->src);
267         } else
268                 out->src = NULL;
269         out->prev = NULL;
270         out->next = NULL;
271         memcpy(out->data, f->data, out->datalen);       
272         return out;
273 }
274
275 struct ast_frame *ast_fr_fdread(int fd)
276 {
277         char buf[65536];
278         int res;
279         int ttl = sizeof(struct ast_frame);
280         struct ast_frame *f = (struct ast_frame *)buf;
281         /* Read a frame directly from there.  They're always in the
282            right format. */
283         
284         while(ttl) {
285                 res = read(fd, buf, ttl);
286                 if (res < 0) {
287                         ast_log(LOG_WARNING, "Bad read on %d: %s\n", fd, strerror(errno));
288                         return NULL;
289                 }
290                 ttl -= res;
291         }
292         
293         /* read the frame header */
294         f->mallocd = 0;
295         /* Re-write data position */
296         f->data = buf + sizeof(struct ast_frame);
297         f->offset = 0;
298         /* Forget about being mallocd */
299         f->mallocd = 0;
300         /* Re-write the source */
301         f->src = __FUNCTION__;
302         if (f->datalen > sizeof(buf) - sizeof(struct ast_frame)) {
303                 /* Really bad read */
304                 ast_log(LOG_WARNING, "Strange read (%d bytes)\n", f->datalen);
305                 return NULL;
306         }
307         if (f->datalen) {
308                 if ((res = read(fd, f->data, f->datalen)) != f->datalen) {
309                         /* Bad read */
310                         ast_log(LOG_WARNING, "How very strange, expected %d, got %d\n", f->datalen, res);
311                         return NULL;
312                 }
313         }
314         if ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_HANGUP)) {
315                 return NULL;
316         }
317         return ast_frisolate(f);
318 }
319
320 /* Some convenient routines for sending frames to/from stream or datagram
321    sockets, pipes, etc (maybe even files) */
322
323 int ast_fr_fdwrite(int fd, struct ast_frame *frame)
324 {
325         /* Write the frame exactly */
326         if (write(fd, frame, sizeof(struct ast_frame)) != sizeof(struct ast_frame)) {
327                 ast_log(LOG_WARNING, "Write error: %s\n", strerror(errno));
328                 return -1;
329         }
330         if (write(fd, frame->data, frame->datalen) != frame->datalen) {
331                 ast_log(LOG_WARNING, "Write error: %s\n", strerror(errno));
332                 return -1;
333         }
334         return 0;
335 }
336
337 int ast_fr_fdhangup(int fd)
338 {
339         struct ast_frame hangup = {
340                 AST_FRAME_CONTROL,
341                 AST_CONTROL_HANGUP
342         };
343         return ast_fr_fdwrite(fd, &hangup);
344 }
345
346 int ast_getformatbyname(char *name)
347 {
348         if (!strcasecmp(name, "g723.1")) 
349                 return AST_FORMAT_G723_1;
350         else if (!strcasecmp(name, "gsm"))
351                 return AST_FORMAT_GSM;
352         else if (!strcasecmp(name, "ulaw"))
353                 return AST_FORMAT_ULAW;
354         else if (!strcasecmp(name, "alaw"))
355                 return AST_FORMAT_ALAW;
356         else if (!strcasecmp(name, "mp3"))
357                 return AST_FORMAT_MP3;
358         else if (!strcasecmp(name, "slinear"))
359                 return AST_FORMAT_SLINEAR;
360         else if (!strcasecmp(name, "lpc10"))
361                 return AST_FORMAT_LPC10;
362         else if (!strcasecmp(name, "adpcm"))
363                 return AST_FORMAT_ADPCM;
364         else if (!strcasecmp(name, "g729"))
365                 return AST_FORMAT_G729A;
366         else if (!strcasecmp(name, "speex"))
367                 return AST_FORMAT_SPEEX;
368         else if (!strcasecmp(name, "ilbc"))
369                 return AST_FORMAT_ILBC;
370         else if (!strcasecmp(name, "all"))
371                 return 0x7FFFFFFF;
372         return 0;
373 }
374
375 void ast_frame_dump(char *name, struct ast_frame *f, char *prefix)
376 {
377         char *n = "unknown";
378         char ftype[40] = "Unknown Frametype";
379         char cft[80];
380         char subclass[40] = "Unknown Subclass";
381         char csub[80];
382         char moreinfo[40] = "";
383         char cn[40];
384         char cp[40];
385         char cmn[40];
386         if (name)
387                 n = name;
388         if (!f) {
389                 ast_verbose("%s [ %s (NULL) ] [%s]\n", 
390                         term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
391                         term_color(cft, "HANGUP", COLOR_BRRED, COLOR_BLACK, sizeof(cft)), 
392                         term_color(cn, n, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
393                 return;
394         }
395         /* XXX We should probably print one each of voice and video when the format changes XXX */
396         if (f->frametype == AST_FRAME_VOICE)
397                 return;
398         if (f->frametype == AST_FRAME_VIDEO)
399                 return;
400         switch(f->frametype) {
401         case AST_FRAME_DTMF:
402                 strcpy(ftype, "DTMF");
403                 subclass[0] = f->subclass;
404                 subclass[1] = '\0';
405                 break;
406         case AST_FRAME_CONTROL:
407                 strcpy(ftype, "Control");
408                 switch(f->subclass) {
409                 case AST_CONTROL_HANGUP:
410                         strcpy(subclass, "Hangup");
411                         break;
412                 case AST_CONTROL_RING:
413                         strcpy(subclass, "Ring");
414                         break;
415                 case AST_CONTROL_RINGING:
416                         strcpy(subclass, "Ringing");
417                         break;
418                 case AST_CONTROL_ANSWER:
419                         strcpy(subclass, "Answer");
420                         break;
421                 case AST_CONTROL_BUSY:
422                         strcpy(subclass, "Busy");
423                         break;
424                 case AST_CONTROL_TAKEOFFHOOK:
425                         strcpy(subclass, "Take Off Hook");
426                         break;
427                 case AST_CONTROL_OFFHOOK:
428                         strcpy(subclass, "Line Off Hook");
429                         break;
430                 case AST_CONTROL_CONGESTION:
431                         strcpy(subclass, "Congestion");
432                         break;
433                 case AST_CONTROL_FLASH:
434                         strcpy(subclass, "Flash");
435                         break;
436                 case AST_CONTROL_WINK:
437                         strcpy(subclass, "Wink");
438                         break;
439                 case AST_CONTROL_OPTION:
440                         strcpy(subclass, "Option");
441                         break;
442                 case AST_CONTROL_RADIO_KEY:
443                         strcpy(subclass, "Key Radio");
444                         break;
445                 case AST_CONTROL_RADIO_UNKEY:
446                         strcpy(subclass, "Unkey Radio");
447                         break;
448                 default:
449                         snprintf(subclass, sizeof(subclass), "Unknown control '%d'", f->subclass);
450                 }
451         case AST_FRAME_NULL:
452                 strcpy(ftype, "Null Frame");
453                 strcpy(subclass, "N/A");
454                 break;
455         case AST_FRAME_IAX:
456                 /* Should never happen */
457                 strcpy(ftype, "IAX Specific");
458                 snprintf(subclass, sizeof(subclass), "IAX Frametype %d", f->subclass);
459                 break;
460         case AST_FRAME_TEXT:
461                 strcpy(ftype, "Text");
462                 strcpy(subclass, "N/A");
463                 strncpy(moreinfo, f->data, sizeof(moreinfo) - 1);
464                 break;
465         case AST_FRAME_IMAGE:
466                 strcpy(ftype, "Image");
467                 snprintf(subclass, sizeof(subclass), "Image format %d\n", f->subclass);
468                 break;
469         case AST_FRAME_HTML:
470                 strcpy(ftype, "HTML");
471                 switch(f->subclass) {
472                 case AST_HTML_URL:
473                         strcpy(subclass, "URL");
474                         strncpy(moreinfo, f->data, sizeof(moreinfo) - 1);
475                         break;
476                 case AST_HTML_DATA:
477                         strcpy(subclass, "Data");
478                         break;
479                 case AST_HTML_BEGIN:
480                         strcpy(subclass, "Begin");
481                         break;
482                 case AST_HTML_END:
483                         strcpy(subclass, "End");
484                         break;
485                 case AST_HTML_LDCOMPLETE:
486                         strcpy(subclass, "Load Complete");
487                         break;
488                 case AST_HTML_NOSUPPORT:
489                         strcpy(subclass, "No Support");
490                         break;
491                 case AST_HTML_LINKURL:
492                         strcpy(subclass, "Link URL");
493                         strncpy(moreinfo, f->data, sizeof(moreinfo) - 1);
494                         break;
495                 case AST_HTML_UNLINK:
496                         strcpy(subclass, "Unlink");
497                         break;
498                 case AST_HTML_LINKREJECT:
499                         strcpy(subclass, "Link Reject");
500                         break;
501                 default:
502                         snprintf(subclass, sizeof(subclass), "Unknown HTML frame '%d'\n", f->subclass);
503                         break;
504                 }
505                 break;
506         default:
507                 snprintf(ftype, sizeof(ftype), "Unknown Frametype '%d'", f->frametype);
508         }
509         if (strlen(moreinfo))
510                 ast_verbose("%s [ TYPE: %s (%d) SUBCLASS: %s (%d) '%s' ] [%s]\n",  
511                         term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
512                         term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
513                         f->frametype, 
514                         term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
515                         f->subclass, 
516                         term_color(cmn, moreinfo, COLOR_BRGREEN, COLOR_BLACK, sizeof(cmn)),
517                         term_color(cn, n, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
518         else
519                 ast_verbose("%s [ TYPE: %s (%d) SUBCLASS: %s (%d) ] [%s]\n",  
520                         term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
521                         term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
522                         f->frametype, 
523                         term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
524                         f->subclass, 
525                         term_color(cn, n, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
526
527 }
528
529
530 #ifdef TRACE_FRAMES
531 static int show_frame_stats(int fd, int argc, char *argv[])
532 {
533         struct ast_frame *f;
534         int x=1;
535         if (argc != 3)
536                 return RESULT_SHOWUSAGE;
537         ast_cli(fd, "     Framer Statistics     \n");
538         ast_cli(fd, "---------------------------\n");
539         ast_cli(fd, "Total allocated headers: %d\n", headers);
540         ast_cli(fd, "Queue Dump:\n");
541         ast_pthread_mutex_lock(&framelock);
542         for (f=headerlist; f; f = f->next) {
543                 ast_cli(fd, "%d.  Type %d, subclass %d from %s\n", x++, f->frametype, f->subclass, f->src ? f->src : "<Unknown>");
544         }
545         pthread_mutex_unlock(&framelock);
546         return RESULT_SUCCESS;
547 }
548
549 static char frame_stats_usage[] =
550 "Usage: show frame stats\n"
551 "       Displays debugging statistics from framer\n";
552
553 struct ast_cli_entry cli_frame_stats =
554 { { "show", "frame", "stats", NULL }, show_frame_stats, "Shows frame statistics", frame_stats_usage };
555 #endif
556
557 int init_framer(void)
558 {
559 #ifdef TRACE_FRAMES
560         ast_cli_register(&cli_frame_stats);
561 #endif
562         return 0;       
563 }