Terry found this problem with running the expr2 parser on OSX. Make the #defines...
[asterisk/asterisk.git] / main / translate.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, 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 Translate via the use of pseudo channels
22  *
23  * \author Mark Spencer <markster@digium.com> 
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <sys/time.h>
31 #include <sys/resource.h>
32
33 #include "asterisk/lock.h"
34 #include "asterisk/channel.h"
35 #include "asterisk/translate.h"
36 #include "asterisk/module.h"
37 #include "asterisk/frame.h"
38 #include "asterisk/sched.h"
39 #include "asterisk/cli.h"
40 #include "asterisk/term.h"
41
42 #define MAX_RECALC 1000 /* max sample recalc */
43
44 /*! \brief the list of translators */
45 static AST_RWLIST_HEAD_STATIC(translators, ast_translator);
46
47 struct translator_path {
48         struct ast_translator *step;    /*!< Next step translator */
49         unsigned int cost;              /*!< Complete cost to destination */
50         unsigned int multistep;         /*!< Multiple conversions required for this translation */
51 };
52
53 /*! \brief a matrix that, for any pair of supported formats,
54  * indicates the total cost of translation and the first step.
55  * The full path can be reconstricted iterating on the matrix
56  * until step->dstfmt == desired_format.
57  *
58  * Array indexes are 'src' and 'dest', in that order.
59  *
60  * Note: the lock in the 'translators' list is also used to protect
61  * this structure.
62  */
63 static struct translator_path tr_matrix[MAX_FORMAT][MAX_FORMAT];
64
65 /*! \todo
66  * TODO: sample frames for each supported input format.
67  * We build this on the fly, by taking an SLIN frame and using
68  * the existing converter to play with it.
69  */
70
71 /*! \brief returns the index of the lowest bit set */
72 static force_inline int powerof(unsigned int d)
73 {
74         int x = ffs(d);
75
76         if (x)
77                 return x - 1;
78
79         ast_log(LOG_WARNING, "No bits set? %d\n", d);
80
81         return -1;
82 }
83
84 /*
85  * wrappers around the translator routines.
86  */
87
88 /*!
89  * \brief Allocate the descriptor, required outbuf space,
90  * and possibly also plc and desc.
91  */
92 static void *newpvt(struct ast_translator *t)
93 {
94         struct ast_trans_pvt *pvt;
95         int len;
96         int useplc = t->plc_samples > 0 && t->useplc;   /* cache, because it can change on the fly */
97         char *ofs;
98
99         /*
100          * compute the required size adding private descriptor,
101          * plc, buffer, AST_FRIENDLY_OFFSET.
102          */
103         len = sizeof(*pvt) + t->desc_size;
104         if (useplc)
105                 len += sizeof(plc_state_t);
106         if (t->buf_size)
107                 len += AST_FRIENDLY_OFFSET + t->buf_size;
108         pvt = ast_calloc(1, len);
109         if (!pvt)
110                 return NULL;
111         pvt->t = t;
112         ofs = (char *)(pvt + 1);        /* pointer to data space */
113         if (t->desc_size) {             /* first comes the descriptor */
114                 pvt->pvt = ofs;
115                 ofs += t->desc_size;
116         }
117         if (useplc) {                   /* then plc state */
118                 pvt->plc = (plc_state_t *)ofs;
119                 ofs += sizeof(plc_state_t);
120         }
121         if (t->buf_size)                /* finally buffer and header */
122                 pvt->outbuf = ofs + AST_FRIENDLY_OFFSET;
123         /* call local init routine, if present */
124         if (t->newpvt && t->newpvt(pvt)) {
125                 ast_free(pvt);
126                 return NULL;
127         }
128         ast_module_ref(t->module);
129         return pvt;
130 }
131
132 static void destroy(struct ast_trans_pvt *pvt)
133 {
134         struct ast_translator *t = pvt->t;
135
136         if (ast_test_flag(&pvt->f, AST_FRFLAG_FROM_TRANSLATOR)) {
137                 /* If this flag is still set, that means that the translation path has
138                  * been torn down, while we still have a frame out there being used.
139                  * When ast_frfree() gets called on that frame, this ast_trans_pvt
140                  * will get destroyed, too. */
141
142                 pvt->destroy = 1;
143
144                 return;
145         }
146
147         if (t->destroy)
148                 t->destroy(pvt);
149         ast_free(pvt);
150         ast_module_unref(t->module);
151 }
152
153 /*! \brief framein wrapper, deals with plc and bound checks.  */
154 static int framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
155 {
156         int16_t *dst = (int16_t *)pvt->outbuf;
157         int ret;
158         int samples = pvt->samples;     /* initial value */
159         
160         /* Copy the last in jb timing info to the pvt */
161         ast_copy_flags(&pvt->f, f, AST_FRFLAG_HAS_TIMING_INFO);
162         pvt->f.ts = f->ts;
163         pvt->f.len = f->len;
164         pvt->f.seqno = f->seqno;
165
166         if (f->samples == 0) {
167                 ast_log(LOG_WARNING, "no samples for %s\n", pvt->t->name);
168         }
169         if (pvt->t->buffer_samples) {   /* do not pass empty frames to callback */
170                 if (f->datalen == 0) { /* perform PLC with nominal framesize of 20ms/160 samples */
171                         if (pvt->plc) {
172                                 int l = pvt->t->plc_samples;
173                                 if (pvt->samples + l > pvt->t->buffer_samples) {
174                                         ast_log(LOG_WARNING, "Out of buffer space\n");
175                                         return -1;
176                                 }
177                                 l = plc_fillin(pvt->plc, dst + pvt->samples, l);
178                                 pvt->samples += l;
179                                 pvt->datalen = pvt->samples * 2;        /* SLIN has 2bytes for 1sample */
180                         }
181                         /* We don't want generic PLC. If the codec has native PLC, then do that */
182                         if (!pvt->t->native_plc)
183                                 return 0;
184                 }
185                 if (pvt->samples + f->samples > pvt->t->buffer_samples) {
186                         ast_log(LOG_WARNING, "Out of buffer space\n");
187                         return -1;
188                 }
189         }
190         /* we require a framein routine, wouldn't know how to do
191          * it otherwise.
192          */
193         ret = pvt->t->framein(pvt, f);
194         /* possibly store data for plc */
195         if (!ret && pvt->plc) {
196                 int l = pvt->t->plc_samples;
197                 if (pvt->samples < l)
198                         l = pvt->samples;
199                 plc_rx(pvt->plc, dst + pvt->samples - l, l);
200         }
201         /* diagnostic ... */
202         if (pvt->samples == samples)
203                 ast_log(LOG_WARNING, "%s did not update samples %d\n",
204                         pvt->t->name, pvt->samples);
205         return ret;
206 }
207
208 /*! \brief generic frameout routine.
209  * If samples and datalen are 0, take whatever is in pvt
210  * and reset them, otherwise take the values in the caller and
211  * leave alone the pvt values.
212  */
213 struct ast_frame *ast_trans_frameout(struct ast_trans_pvt *pvt,
214         int datalen, int samples)
215 {
216         struct ast_frame *f = &pvt->f;
217
218         if (samples)
219                 f->samples = samples;
220         else {
221                 if (pvt->samples == 0)
222                         return NULL;
223                 f->samples = pvt->samples;
224                 pvt->samples = 0;
225         }
226         if (datalen)
227                 f->datalen = datalen;
228         else {
229                 f->datalen = pvt->datalen;
230                 pvt->datalen = 0;
231         }
232
233         f->frametype = AST_FRAME_VOICE;
234         f->subclass = 1 << (pvt->t->dstfmt);
235         f->mallocd = 0;
236         f->offset = AST_FRIENDLY_OFFSET;
237         f->src = pvt->t->name;
238         f->data = pvt->outbuf;
239
240         ast_set_flag(f, AST_FRFLAG_FROM_TRANSLATOR);
241
242         return f;
243 }
244
245 static struct ast_frame *default_frameout(struct ast_trans_pvt *pvt)
246 {
247         return ast_trans_frameout(pvt, 0, 0);
248 }
249
250 /* end of callback wrappers and helpers */
251
252 void ast_translator_free_path(struct ast_trans_pvt *p)
253 {
254         struct ast_trans_pvt *pn = p;
255         while ( (p = pn) ) {
256                 pn = p->next;
257                 destroy(p);
258         }
259 }
260
261 /*! \brief Build a chain of translators based upon the given source and dest formats */
262 struct ast_trans_pvt *ast_translator_build_path(int dest, int source)
263 {
264         struct ast_trans_pvt *head = NULL, *tail = NULL;
265         
266         source = powerof(source);
267         dest = powerof(dest);
268         
269         AST_RWLIST_RDLOCK(&translators);
270
271         while (source != dest) {
272                 struct ast_trans_pvt *cur;
273                 struct ast_translator *t = tr_matrix[source][dest].step;
274                 if (!t) {
275                         ast_log(LOG_WARNING, "No translator path from %s to %s\n", 
276                                 ast_getformatname(source), ast_getformatname(dest));
277                         AST_RWLIST_UNLOCK(&translators);
278                         return NULL;
279                 }
280                 if (!(cur = newpvt(t))) {
281                         ast_log(LOG_WARNING, "Failed to build translator step from %d to %d\n", source, dest);
282                         if (head)
283                                 ast_translator_free_path(head); 
284                         AST_RWLIST_UNLOCK(&translators);
285                         return NULL;
286                 }
287                 if (!head)
288                         head = cur;
289                 else
290                         tail->next = cur;
291                 tail = cur;
292                 cur->nextin = cur->nextout = ast_tv(0, 0);
293                 /* Keep going if this isn't the final destination */
294                 source = cur->t->dstfmt;
295         }
296
297         AST_RWLIST_UNLOCK(&translators);
298         return head;
299 }
300
301 static inline int format_rate(int format)
302 {
303         if (format == AST_FORMAT_G722 || format == AST_FORMAT_SLINEAR16)
304                 return 16000;
305
306         return 8000;
307 }
308
309 /*! \brief do the actual translation */
310 struct ast_frame *ast_translate(struct ast_trans_pvt *path, struct ast_frame *f, int consume)
311 {
312         struct ast_trans_pvt *p = path;
313         struct ast_frame *out = f;
314         struct timeval delivery;
315         int has_timing_info;
316         long ts;
317         long len;
318         int seqno;
319
320         has_timing_info = ast_test_flag(f, AST_FRFLAG_HAS_TIMING_INFO);
321         ts = f->ts;
322         len = f->len;
323         seqno = f->seqno;
324
325         /* XXX hmmm... check this below */
326         if (!ast_tvzero(f->delivery)) {
327                 if (!ast_tvzero(path->nextin)) {
328                         /* Make sure this is in line with what we were expecting */
329                         if (!ast_tveq(path->nextin, f->delivery)) {
330                                 /* The time has changed between what we expected and this
331                                    most recent time on the new packet.  If we have a
332                                    valid prediction adjust our output time appropriately */
333                                 if (!ast_tvzero(path->nextout)) {
334                                         path->nextout = ast_tvadd(path->nextout,
335                                                                   ast_tvsub(f->delivery, path->nextin));
336                                 }
337                                 path->nextin = f->delivery;
338                         }
339                 } else {
340                         /* This is our first pass.  Make sure the timing looks good */
341                         path->nextin = f->delivery;
342                         path->nextout = f->delivery;
343                 }
344                 /* Predict next incoming sample */
345                 path->nextin = ast_tvadd(path->nextin, ast_samp2tv(f->samples, format_rate(f->subclass)));
346         }
347         delivery = f->delivery;
348         for ( ; out && p ; p = p->next) {
349                 framein(p, out);
350                 out = p->t->frameout(p);
351         }
352         if (consume)
353                 ast_frfree(f);
354         if (out == NULL)
355                 return NULL;
356         /* we have a frame, play with times */
357         if (!ast_tvzero(delivery)) {
358                 /* Regenerate prediction after a discontinuity */
359                 if (ast_tvzero(path->nextout))
360                         path->nextout = ast_tvnow();
361
362                 /* Use next predicted outgoing timestamp */
363                 out->delivery = path->nextout;
364                 
365                 /* Predict next outgoing timestamp from samples in this
366                    frame. */
367                 path->nextout = ast_tvadd(path->nextout, ast_samp2tv(out->samples, format_rate(out->subclass)));
368         } else {
369                 out->delivery = ast_tv(0, 0);
370                 ast_set2_flag(out, has_timing_info, AST_FRFLAG_HAS_TIMING_INFO);
371                 if (has_timing_info) {
372                         out->ts = ts;
373                         out->len = len;
374                         out->seqno = seqno;
375                 }
376         }
377         /* Invalidate prediction if we're entering a silence period */
378         if (out->frametype == AST_FRAME_CNG)
379                 path->nextout = ast_tv(0, 0);
380         return out;
381 }
382
383 /*! \brief compute the cost of a single translation step */
384 static void calc_cost(struct ast_translator *t, int seconds)
385 {
386         int num_samples = 0;
387         struct ast_trans_pvt *pvt;
388         struct rusage start;
389         struct rusage end;
390         int cost;
391         int out_rate = format_rate(t->dstfmt);
392
393         if (!seconds)
394                 seconds = 1;
395         
396         /* If they don't make samples, give them a terrible score */
397         if (!t->sample) {
398                 ast_log(LOG_WARNING, "Translator '%s' does not produce sample frames.\n", t->name);
399                 t->cost = 999999;
400                 return;
401         }
402
403         pvt = newpvt(t);
404         if (!pvt) {
405                 ast_log(LOG_WARNING, "Translator '%s' appears to be broken and will probably fail.\n", t->name);
406                 t->cost = 999999;
407                 return;
408         }
409
410         getrusage(RUSAGE_SELF, &start);
411
412         /* Call the encoder until we've processed the required number of samples */
413         while (num_samples < seconds * out_rate) {
414                 struct ast_frame *f = t->sample();
415                 if (!f) {
416                         ast_log(LOG_WARNING, "Translator '%s' failed to produce a sample frame.\n", t->name);
417                         destroy(pvt);
418                         t->cost = 999999;
419                         return;
420                 }
421                 framein(pvt, f);
422                 ast_frfree(f);
423                 while ((f = t->frameout(pvt))) {
424                         num_samples += f->samples;
425                         ast_frfree(f);
426                 }
427         }
428
429         getrusage(RUSAGE_SELF, &end);
430
431         cost = ((end.ru_utime.tv_sec - start.ru_utime.tv_sec) * 1000000) + end.ru_utime.tv_usec - start.ru_utime.tv_usec;
432         cost += ((end.ru_stime.tv_sec - start.ru_stime.tv_sec) * 1000000) + end.ru_stime.tv_usec - start.ru_stime.tv_usec;
433
434         destroy(pvt);
435
436         t->cost = cost / seconds;
437
438         if (!t->cost)
439                 t->cost = 1;
440 }
441
442 /*!
443  * \brief rebuild a translation matrix.
444  * \note This function expects the list of translators to be locked
445 */
446 static void rebuild_matrix(int samples)
447 {
448         struct ast_translator *t;
449         int x;      /* source format index */
450         int y;      /* intermediate format index */
451         int z;      /* destination format index */
452
453         ast_debug(1, "Resetting translation matrix\n");
454
455         bzero(tr_matrix, sizeof(tr_matrix));
456
457         /* first, compute all direct costs */
458         AST_RWLIST_TRAVERSE(&translators, t, list) {
459                 if (!t->active)
460                         continue;
461
462                 x = t->srcfmt;
463                 z = t->dstfmt;
464
465                 if (samples)
466                         calc_cost(t, samples);
467           
468                 if (!tr_matrix[x][z].step || t->cost < tr_matrix[x][z].cost) {
469                         tr_matrix[x][z].step = t;
470                         tr_matrix[x][z].cost = t->cost;
471                 }
472         }
473
474         /*
475          * For each triple x, y, z of distinct formats, check if there is
476          * a path from x to z through y which is cheaper than what is
477          * currently known, and in case, update the matrix.
478          * Repeat until the matrix is stable.
479          */
480         for (;;) {
481                 int changed = 0;
482                 for (x = 0; x < MAX_FORMAT; x++) {      /* source format */
483                         for (y=0; y < MAX_FORMAT; y++) {    /* intermediate format */
484                                 if (x == y)                     /* skip ourselves */
485                                         continue;
486
487                                 for (z=0; z<MAX_FORMAT; z++) {  /* dst format */
488                                         int newcost;
489
490                                         if (z == x || z == y)       /* skip null conversions */
491                                                 continue;
492                                         if (!tr_matrix[x][y].step)  /* no path from x to y */
493                                                 continue;
494                                         if (!tr_matrix[y][z].step)  /* no path from y to z */
495                                                 continue;
496                                         newcost = tr_matrix[x][y].cost + tr_matrix[y][z].cost;
497                                         if (tr_matrix[x][z].step && newcost >= tr_matrix[x][z].cost)
498                                                 continue;               /* x->y->z is more expensive than
499                                                                          * the existing path */
500                                         /* ok, we can get from x to z via y with a cost that
501                                            is the sum of the transition from x to y and
502                                            from y to z */
503                                                  
504                                         tr_matrix[x][z].step = tr_matrix[x][y].step;
505                                         tr_matrix[x][z].cost = newcost;
506                                         tr_matrix[x][z].multistep = 1;
507                                         ast_debug(3, "Discovered %d cost path from %s to %s, via %d\n", tr_matrix[x][z].cost, ast_getformatname(x), ast_getformatname(z), y);
508                                         changed++;
509                                 }
510                         }
511                 }
512                 if (!changed)
513                         break;
514         }
515 }
516
517 static char *handle_cli_core_show_translation(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
518 {
519 #define SHOW_TRANS 16
520         int x, y, z;
521         int curlen = 0, longest = 0;
522
523         switch (cmd) {
524         case CLI_INIT:
525                 e->command = "core show translation [recalc]";
526                 e->usage =
527                         "Usage: core show translation [recalc [<recalc seconds>]]\n"
528                         "       Displays known codec translators and the cost associated\n"
529                         "       with each conversion.  If the argument 'recalc' is supplied along\n"
530                         "       with optional number of seconds to test a new test will be performed\n"
531                         "       as the chart is being displayed.\n";
532                 return NULL;
533         case CLI_GENERATE:
534                 return NULL;
535         }
536
537         if (a->argc > 5)
538                 return CLI_SHOWUSAGE;
539         
540         if (a->argv[3] && !strcasecmp(a->argv[3], "recalc")) {
541                 z = a->argv[4] ? atoi(a->argv[4]) : 1;
542
543                 if (z <= 0) {
544                         ast_cli(a->fd, "         Recalc must be greater than 0.  Defaulting to 1.\n");
545                         z = 1;
546                 }
547
548                 if (z > MAX_RECALC) {
549                         ast_cli(a->fd, "         Maximum limit of recalc exceeded by %d, truncating value to %d\n", z - MAX_RECALC, MAX_RECALC);
550                         z = MAX_RECALC;
551                 }
552                 ast_cli(a->fd, "         Recalculating Codec Translation (number of sample seconds: %d)\n\n", z);
553                 AST_RWLIST_WRLOCK(&translators);
554                 rebuild_matrix(z);
555                 AST_RWLIST_UNLOCK(&translators);
556         } else if (a->argc > 3)
557                 return CLI_SHOWUSAGE;
558
559         AST_RWLIST_RDLOCK(&translators);
560
561         ast_cli(a->fd, "         Translation times between formats (in microseconds) for one second of data\n");
562         ast_cli(a->fd, "          Source Format (Rows) Destination Format (Columns)\n\n");
563         /* Get the length of the longest (usable?) codec name, so we know how wide the left side should be */
564         for (x = 0; x < SHOW_TRANS; x++) {
565                 curlen = strlen(ast_getformatname(1 << (x)));
566                 if (curlen > longest)
567                         longest = curlen;
568         }
569         for (x = -1; x < SHOW_TRANS; x++) {
570                 struct ast_str *out = ast_str_alloca(120);
571                 /*Go ahead and move to next iteration if dealing with an unknown codec*/
572                 if(x >= 0 && !strcmp(ast_getformatname(1 << (x)), "unknown"))
573                         continue;
574                 ast_str_set(&out, -1, " ");
575                 for (y = -1; y < SHOW_TRANS; y++) {
576                         /*Go ahead and move to next iteration if dealing with an unknown codec*/
577                         if (y >= 0 && !strcmp(ast_getformatname(1 << (y)), "unknown"))
578                                 continue;
579                         if (y >= 0)
580                                 curlen = strlen(ast_getformatname(1 << (y)));
581                         if (curlen < 5)
582                                 curlen = 5;
583                         if (x >= 0 && y >= 0 && tr_matrix[x][y].step) {
584                                 /* XXX 99999 is a little hackish
585                                    We don't want this number being larger than the shortest (or current) codec
586                                    For now, that is "gsm" */
587                                 ast_str_append(&out, -1, "%*d", curlen + 1, tr_matrix[x][y].cost > 99999 ? 0 : tr_matrix[x][y].cost);
588                         } else if (x == -1 && y >= 0) {
589                                 /* Top row - use a dynamic size */
590                                 ast_str_append(&out, -1, "%*s", curlen + 1, ast_getformatname(1 << (y)) );
591                         } else if (y == -1 && x >= 0) {
592                                 /* Left column - use a static size. */
593                                 ast_str_append(&out, -1, "%*s", longest, ast_getformatname(1 << (x)) );
594                         } else if (x >= 0 && y >= 0) {
595                                 ast_str_append(&out, -1, "%*s", curlen + 1, "-");
596                         } else {
597                                 ast_str_append(&out, -1, "%*s", longest, "");
598                         }
599                 }
600                 ast_str_append(&out, -1, "\n");
601                 ast_cli(a->fd, out->str);                       
602         }
603         AST_RWLIST_UNLOCK(&translators);
604         return CLI_SUCCESS;
605 }
606
607 static struct ast_cli_entry cli_translate[] = {
608         AST_CLI_DEFINE(handle_cli_core_show_translation, "Display translation matrix")
609 };
610
611 /*! \brief register codec translator */
612 int __ast_register_translator(struct ast_translator *t, struct ast_module *mod)
613 {
614         static int added_cli = 0;
615         struct ast_translator *u;
616         char tmp[80];
617
618         if (!mod) {
619                 ast_log(LOG_WARNING, "Missing module pointer, you need to supply one\n");
620                 return -1;
621         }
622
623         if (!t->buf_size) {
624                 ast_log(LOG_WARNING, "empty buf size, you need to supply one\n");
625                 return -1;
626         }
627
628         t->module = mod;
629
630         t->srcfmt = powerof(t->srcfmt);
631         t->dstfmt = powerof(t->dstfmt);
632         t->active = 1;
633
634         if (t->plc_samples) {
635                 if (t->buffer_samples < t->plc_samples) {
636                         ast_log(LOG_WARNING, "plc_samples %d buffer_samples %d\n",
637                                 t->plc_samples, t->buffer_samples);
638                         return -1;
639                 }
640                 if (t->dstfmt != powerof(AST_FORMAT_SLINEAR))
641                         ast_log(LOG_WARNING, "plc_samples %d format %x\n",
642                                 t->plc_samples, t->dstfmt);
643         }
644         if (t->srcfmt >= MAX_FORMAT) {
645                 ast_log(LOG_WARNING, "Source format %s is larger than MAX_FORMAT\n", ast_getformatname(t->srcfmt));
646                 return -1;
647         }
648
649         if (t->dstfmt >= MAX_FORMAT) {
650                 ast_log(LOG_WARNING, "Destination format %s is larger than MAX_FORMAT\n", ast_getformatname(t->dstfmt));
651                 return -1;
652         }
653
654         if (t->buf_size) {
655                /*
656                 * Align buf_size properly, rounding up to the machine-specific
657                 * alignment for pointers.
658                 */
659                 struct _test_align { void *a, *b; } p;
660                 int align = (char *)&p.b - (char *)&p.a;
661
662                 t->buf_size = ((t->buf_size + align - 1) / align) * align;
663         }
664
665         if (t->frameout == NULL)
666                 t->frameout = default_frameout;
667   
668         calc_cost(t, 1);
669
670         ast_verb(2, "Registered translator '%s' from format %s to %s, cost %d\n",
671                             term_color(tmp, t->name, COLOR_MAGENTA, COLOR_BLACK, sizeof(tmp)),
672                             ast_getformatname(1 << t->srcfmt), ast_getformatname(1 << t->dstfmt), t->cost);
673
674         if (!added_cli) {
675                 ast_cli_register_multiple(cli_translate, sizeof(cli_translate) / sizeof(struct ast_cli_entry));
676                 added_cli++;
677         }
678
679         AST_RWLIST_WRLOCK(&translators);
680
681         /* find any existing translators that provide this same srcfmt/dstfmt,
682            and put this one in order based on cost */
683         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&translators, u, list) {
684                 if ((u->srcfmt == t->srcfmt) &&
685                     (u->dstfmt == t->dstfmt) &&
686                     (u->cost > t->cost)) {
687                         AST_RWLIST_INSERT_BEFORE_CURRENT(t, list);
688                         t = NULL;
689                 }
690         }
691         AST_RWLIST_TRAVERSE_SAFE_END;
692
693         /* if no existing translator was found for this format combination,
694            add it to the beginning of the list */
695         if (t)
696                 AST_RWLIST_INSERT_HEAD(&translators, t, list);
697
698         rebuild_matrix(0);
699
700         AST_RWLIST_UNLOCK(&translators);
701
702         return 0;
703 }
704
705 /*! \brief unregister codec translator */
706 int ast_unregister_translator(struct ast_translator *t)
707 {
708         char tmp[80];
709         struct ast_translator *u;
710         int found = 0;
711
712         AST_RWLIST_WRLOCK(&translators);
713         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&translators, u, list) {
714                 if (u == t) {
715                         AST_RWLIST_REMOVE_CURRENT(list);
716                         ast_verb(2, "Unregistered translator '%s' from format %s to %s\n", term_color(tmp, t->name, COLOR_MAGENTA, COLOR_BLACK, sizeof(tmp)), ast_getformatname(1 << t->srcfmt), ast_getformatname(1 << t->dstfmt));
717                         found = 1;
718                         break;
719                 }
720         }
721         AST_RWLIST_TRAVERSE_SAFE_END;
722
723         if (found)
724                 rebuild_matrix(0);
725
726         AST_RWLIST_UNLOCK(&translators);
727
728         return (u ? 0 : -1);
729 }
730
731 void ast_translator_activate(struct ast_translator *t)
732 {
733         AST_RWLIST_WRLOCK(&translators);
734         t->active = 1;
735         rebuild_matrix(0);
736         AST_RWLIST_UNLOCK(&translators);
737 }
738
739 void ast_translator_deactivate(struct ast_translator *t)
740 {
741         AST_RWLIST_WRLOCK(&translators);
742         t->active = 0;
743         rebuild_matrix(0);
744         AST_RWLIST_UNLOCK(&translators);
745 }
746
747 /*! \brief Calculate our best translator source format, given costs, and a desired destination */
748 int ast_translator_best_choice(int *dst, int *srcs)
749 {
750         int x,y;
751         int best = -1;
752         int bestdst = 0;
753         int cur, cursrc;
754         int besttime = INT_MAX;
755         int beststeps = INT_MAX;
756         int common = ((*dst) & (*srcs)) & AST_FORMAT_AUDIO_MASK;        /* are there common formats ? */
757
758         if (common) { /* yes, pick one and return */
759                 for (cur = 1, y = 0; y <= MAX_AUDIO_FORMAT; cur <<= 1, y++) {
760                         if (cur & common)       /* guaranteed to find one */
761                                 break;
762                 }
763                 /* We are done, this is a common format to both. */
764                 *srcs = *dst = cur;
765                 return 0;
766         } else {        /* No, we will need to translate */
767                 AST_RWLIST_RDLOCK(&translators);
768                 for (cur = 1, y = 0; y <= MAX_AUDIO_FORMAT; cur <<= 1, y++) {
769                         if (! (cur & *dst))
770                                 continue;
771                         for (cursrc = 1, x = 0; x <= MAX_AUDIO_FORMAT; cursrc <<= 1, x++) {
772                                 if (!(*srcs & cursrc) || !tr_matrix[x][y].step ||
773                                     tr_matrix[x][y].cost >  besttime)
774                                         continue;       /* not existing or no better */
775                                 if (tr_matrix[x][y].cost < besttime ||
776                                     tr_matrix[x][y].multistep < beststeps) {
777                                         /* better than what we have so far */
778                                         best = cursrc;
779                                         bestdst = cur;
780                                         besttime = tr_matrix[x][y].cost;
781                                         beststeps = tr_matrix[x][y].multistep;
782                                 }
783                         }
784                 }
785                 AST_RWLIST_UNLOCK(&translators);
786                 if (best > -1) {
787                         *srcs = best;
788                         *dst = bestdst;
789                         best = 0;
790                 }
791                 return best;
792         }
793 }
794
795 unsigned int ast_translate_path_steps(unsigned int dest, unsigned int src)
796 {
797         unsigned int res = -1;
798
799         /* convert bitwise format numbers into array indices */
800         src = powerof(src);
801         dest = powerof(dest);
802
803         AST_RWLIST_RDLOCK(&translators);
804
805         if (tr_matrix[src][dest].step)
806                 res = tr_matrix[src][dest].multistep + 1;
807
808         AST_RWLIST_UNLOCK(&translators);
809
810         return res;
811 }
812
813 unsigned int ast_translate_available_formats(unsigned int dest, unsigned int src)
814 {
815         unsigned int res = dest;
816         unsigned int x;
817         unsigned int src_audio = src & AST_FORMAT_AUDIO_MASK;
818         unsigned int src_video = src & AST_FORMAT_VIDEO_MASK;
819
820         /* if we don't have a source format, we just have to try all
821            possible destination formats */
822         if (!src)
823                 return dest;
824
825         /* If we have a source audio format, get its format index */
826         if (src_audio)
827                 src_audio = powerof(src_audio);
828
829         /* If we have a source video format, get its format index */
830         if (src_video)
831                 src_video = powerof(src_video);
832
833         AST_RWLIST_RDLOCK(&translators);
834
835         /* For a given source audio format, traverse the list of
836            known audio formats to determine whether there exists
837            a translation path from the source format to the
838            destination format. */
839         for (x = 1; src_audio && (x & AST_FORMAT_AUDIO_MASK); x <<= 1) {
840                 /* if this is not a desired format, nothing to do */
841                 if (!dest & x)
842                         continue;
843
844                 /* if the source is supplying this format, then
845                    we can leave it in the result */
846                 if (src & x)
847                         continue;
848
849                 /* if we don't have a translation path from the src
850                    to this format, remove it from the result */
851                 if (!tr_matrix[src_audio][powerof(x)].step) {
852                         res &= ~x;
853                         continue;
854                 }
855
856                 /* now check the opposite direction */
857                 if (!tr_matrix[powerof(x)][src_audio].step)
858                         res &= ~x;
859         }
860
861         /* For a given source video format, traverse the list of
862            known video formats to determine whether there exists
863            a translation path from the source format to the
864            destination format. */
865         for (; src_video && (x & AST_FORMAT_VIDEO_MASK); x <<= 1) {
866                 /* if this is not a desired format, nothing to do */
867                 if (!dest & x)
868                         continue;
869
870                 /* if the source is supplying this format, then
871                    we can leave it in the result */
872                 if (src & x)
873                         continue;
874
875                 /* if we don't have a translation path from the src
876                    to this format, remove it from the result */
877                 if (!tr_matrix[src_video][powerof(x)].step) {
878                         res &= ~x;
879                         continue;
880                 }
881
882                 /* now check the opposite direction */
883                 if (!tr_matrix[powerof(x)][src_video].step)
884                         res &= ~x;
885         }
886
887         AST_RWLIST_UNLOCK(&translators);
888
889         return res;
890 }
891
892 void ast_translate_frame_freed(struct ast_frame *fr)
893 {
894         struct ast_trans_pvt *pvt;
895
896         ast_clear_flag(fr, AST_FRFLAG_FROM_TRANSLATOR);
897
898         pvt = (struct ast_trans_pvt *) (((char *) fr) - offsetof(struct ast_trans_pvt, f));
899
900         if (!pvt->destroy)
901                 return;
902         
903         destroy(pvt);
904 }