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