Add the ability to dynamically specify weights for responses to DUNDi queries.
[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_RWLIST_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                                 pvt->datalen = pvt->samples * 2;        /* SLIN has 2bytes for 1sample */
176                         }
177                         return 0;
178                 }
179                 if (pvt->samples + f->samples > pvt->t->buffer_samples) {
180                         ast_log(LOG_WARNING, "Out of buffer space\n");
181                         return -1;
182                 }
183         }
184         /* we require a framein routine, wouldn't know how to do
185          * it otherwise.
186          */
187         ret = pvt->t->framein(pvt, f);
188         /* possibly store data for plc */
189         if (!ret && pvt->plc) {
190                 int l = pvt->t->plc_samples;
191                 if (pvt->samples < l)
192                         l = pvt->samples;
193                 plc_rx(pvt->plc, dst + pvt->samples - l, l);
194         }
195         /* diagnostic ... */
196         if (pvt->samples == samples)
197                 ast_log(LOG_WARNING, "%s did not update samples %d\n",
198                         pvt->t->name, pvt->samples);
199         return ret;
200 }
201
202 /*! \brief generic frameout routine.
203  * If samples and datalen are 0, take whatever is in pvt
204  * and reset them, otherwise take the values in the caller and
205  * leave alone the pvt values.
206  */
207 struct ast_frame *ast_trans_frameout(struct ast_trans_pvt *pvt,
208         int datalen, int samples)
209 {
210         struct ast_frame *f = &pvt->f;
211
212         if (samples)
213                 f->samples = samples;
214         else {
215                 if (pvt->samples == 0)
216                         return NULL;
217                 f->samples = pvt->samples;
218                 pvt->samples = 0;
219         }
220         if (datalen)
221                 f->datalen = datalen;
222         else {
223                 f->datalen = pvt->datalen;
224                 pvt->datalen = 0;
225         }
226
227         f->frametype = AST_FRAME_VOICE;
228         f->subclass = 1 << (pvt->t->dstfmt);
229         f->mallocd = 0;
230         f->offset = AST_FRIENDLY_OFFSET;
231         f->src = pvt->t->name;
232         f->data = pvt->outbuf;
233         return f;
234 }
235
236 static struct ast_frame *default_frameout(struct ast_trans_pvt *pvt)
237 {
238         return ast_trans_frameout(pvt, 0, 0);
239 }
240
241 /* end of callback wrappers and helpers */
242
243 void ast_translator_free_path(struct ast_trans_pvt *p)
244 {
245         struct ast_trans_pvt *pn = p;
246         while ( (p = pn) ) {
247                 pn = p->next;
248                 destroy(p);
249         }
250 }
251
252 /*! \brief Build a chain of translators based upon the given source and dest formats */
253 struct ast_trans_pvt *ast_translator_build_path(int dest, int source)
254 {
255         struct ast_trans_pvt *head = NULL, *tail = NULL;
256         
257         source = powerof(source);
258         dest = powerof(dest);
259         
260         AST_RWLIST_RDLOCK(&translators);
261
262         while (source != dest) {
263                 struct ast_trans_pvt *cur;
264                 struct ast_translator *t = tr_matrix[source][dest].step;
265                 if (!t) {
266                         ast_log(LOG_WARNING, "No translator path from %s to %s\n", 
267                                 ast_getformatname(source), ast_getformatname(dest));
268                         AST_RWLIST_UNLOCK(&translators);
269                         return NULL;
270                 }
271                 if (!(cur = newpvt(t))) {
272                         ast_log(LOG_WARNING, "Failed to build translator step from %d to %d\n", source, dest);
273                         if (head)
274                                 ast_translator_free_path(head); 
275                         AST_RWLIST_UNLOCK(&translators);
276                         return NULL;
277                 }
278                 if (!head)
279                         head = cur;
280                 else
281                         tail->next = cur;
282                 tail = cur;
283                 cur->nextin = cur->nextout = ast_tv(0, 0);
284                 /* Keep going if this isn't the final destination */
285                 source = cur->t->dstfmt;
286         }
287
288         AST_RWLIST_UNLOCK(&translators);
289         return head;
290 }
291
292 /*! \brief do the actual translation */
293 struct ast_frame *ast_translate(struct ast_trans_pvt *path, struct ast_frame *f, int consume)
294 {
295         struct ast_trans_pvt *p = path;
296         struct ast_frame *out = f;
297         struct timeval delivery;
298         int has_timing_info;
299         long ts;
300         long len;
301         int seqno;
302
303         has_timing_info = f->has_timing_info;
304         ts = f->ts;
305         len = f->len;
306         seqno = f->seqno;
307
308         /* XXX hmmm... check this below */
309         if (!ast_tvzero(f->delivery)) {
310                 if (!ast_tvzero(path->nextin)) {
311                         /* Make sure this is in line with what we were expecting */
312                         if (!ast_tveq(path->nextin, f->delivery)) {
313                                 /* The time has changed between what we expected and this
314                                    most recent time on the new packet.  If we have a
315                                    valid prediction adjust our output time appropriately */
316                                 if (!ast_tvzero(path->nextout)) {
317                                         path->nextout = ast_tvadd(path->nextout,
318                                                                   ast_tvsub(f->delivery, path->nextin));
319                                 }
320                                 path->nextin = f->delivery;
321                         }
322                 } else {
323                         /* This is our first pass.  Make sure the timing looks good */
324                         path->nextin = f->delivery;
325                         path->nextout = f->delivery;
326                 }
327                 /* Predict next incoming sample */
328                 path->nextin = ast_tvadd(path->nextin, ast_samp2tv(f->samples, 8000));
329         }
330         delivery = f->delivery;
331         for ( ; out && p ; p = p->next) {
332                 framein(p, out);
333                 out = p->t->frameout(p);
334         }
335         if (consume)
336                 ast_frfree(f);
337         if (out == NULL)
338                 return NULL;
339         /* we have a frame, play with times */
340         if (!ast_tvzero(delivery)) {
341                 /* Regenerate prediction after a discontinuity */
342                 if (ast_tvzero(path->nextout))
343                         path->nextout = ast_tvnow();
344
345                 /* Use next predicted outgoing timestamp */
346                 out->delivery = path->nextout;
347                 
348                 /* Predict next outgoing timestamp from samples in this
349                    frame. */
350                 path->nextout = ast_tvadd(path->nextout, ast_samp2tv( out->samples, 8000));
351         } else {
352                 out->delivery = ast_tv(0, 0);
353                 out->has_timing_info = has_timing_info;
354                 if (has_timing_info) {
355                         out->ts = ts;
356                         out->len = len;
357                         out->seqno = seqno;
358                 }
359         }
360         /* Invalidate prediction if we're entering a silence period */
361         if (out->frametype == AST_FRAME_CNG)
362                 path->nextout = ast_tv(0, 0);
363         return out;
364 }
365
366 /*! \brief compute the cost of a single translation step */
367 static void calc_cost(struct ast_translator *t, int seconds)
368 {
369         int sofar=0;
370         struct ast_trans_pvt *pvt;
371         struct timeval start;
372         int cost;
373
374         if (!seconds)
375                 seconds = 1;
376         
377         /* If they don't make samples, give them a terrible score */
378         if (!t->sample) {
379                 ast_log(LOG_WARNING, "Translator '%s' does not produce sample frames.\n", t->name);
380                 t->cost = 99999;
381                 return;
382         }
383         pvt = newpvt(t);
384         if (!pvt) {
385                 ast_log(LOG_WARNING, "Translator '%s' appears to be broken and will probably fail.\n", t->name);
386                 t->cost = 99999;
387                 return;
388         }
389         start = ast_tvnow();
390         /* Call the encoder until we've processed the required number of samples */
391         while (sofar < seconds * 8000) {
392                 struct ast_frame *f = t->sample();
393                 if (!f) {
394                         ast_log(LOG_WARNING, "Translator '%s' failed to produce a sample frame.\n", t->name);
395                         destroy(pvt);
396                         t->cost = 99999;
397                         return;
398                 }
399                 framein(pvt, f);
400                 ast_frfree(f);
401                 while ((f = t->frameout(pvt))) {
402                         sofar += f->samples;
403                         ast_frfree(f);
404                 }
405         }
406         cost = ast_tvdiff_ms(ast_tvnow(), start);
407         destroy(pvt);
408         t->cost = cost / seconds;
409         if (!t->cost)
410                 t->cost = 1;
411 }
412
413 /*!
414  * \brief rebuild a translation matrix.
415  * \note This function expects the list of translators to be locked
416 */
417 static void rebuild_matrix(int samples)
418 {
419         struct ast_translator *t;
420         int x;      /* source format index */
421         int y;      /* intermediate format index */
422         int z;      /* destination format index */
423
424         if (option_debug)
425                 ast_log(LOG_DEBUG, "Resetting translation matrix\n");
426
427         bzero(tr_matrix, sizeof(tr_matrix));
428
429         /* first, compute all direct costs */
430         AST_RWLIST_TRAVERSE(&translators, t, list) {
431                 if (!t->active)
432                         continue;
433
434                 x = t->srcfmt;
435                 z = t->dstfmt;
436
437                 if (samples)
438                         calc_cost(t, samples);
439           
440                 if (!tr_matrix[x][z].step || t->cost < tr_matrix[x][z].cost) {
441                         tr_matrix[x][z].step = t;
442                         tr_matrix[x][z].cost = t->cost;
443                 }
444         }
445
446         /*
447          * For each triple x, y, z of distinct formats, check if there is
448          * a path from x to z through y which is cheaper than what is
449          * currently known, and in case, update the matrix.
450          * Repeat until the matrix is stable.
451          */
452         for (;;) {
453                 int changed = 0;
454                 for (x = 0; x < MAX_FORMAT; x++) {      /* source format */
455                         for (y=0; y < MAX_FORMAT; y++) {    /* intermediate format */
456                                 if (x == y)                     /* skip ourselves */
457                                         continue;
458
459                                 for (z=0; z<MAX_FORMAT; z++) {  /* dst format */
460                                         int newcost;
461
462                                         if (z == x || z == y)       /* skip null conversions */
463                                                 continue;
464                                         if (!tr_matrix[x][y].step)  /* no path from x to y */
465                                                 continue;
466                                         if (!tr_matrix[y][z].step)  /* no path from y to z */
467                                                 continue;
468                                         newcost = tr_matrix[x][y].cost + tr_matrix[y][z].cost;
469                                         if (tr_matrix[x][z].step && newcost >= tr_matrix[x][z].cost)
470                                                 continue;               /* x->y->z is more expensive than
471                                                                          * the existing path */
472                                         /* ok, we can get from x to z via y with a cost that
473                                            is the sum of the transition from x to y and
474                                            from y to z */
475                                                  
476                                         tr_matrix[x][z].step = tr_matrix[x][y].step;
477                                         tr_matrix[x][z].cost = newcost;
478                                         tr_matrix[x][z].multistep = 1;
479                                         if (option_debug)
480                                                 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);
481                                         changed++;
482                                 }
483                         }
484                 }
485                 if (!changed)
486                         break;
487         }
488 }
489
490 static int show_translation(int fd, int argc, char *argv[])
491 {
492 #define SHOW_TRANS 13
493         int x, y, z;
494         int curlen = 0, longest = 0;
495
496         if (argc > 5)
497                 return RESULT_SHOWUSAGE;
498         
499         if (argv[3] && !strcasecmp(argv[3], "recalc")) {
500                 z = argv[4] ? atoi(argv[4]) : 1;
501
502                 if (z <= 0) {
503                         ast_cli(fd, "         C'mon let's be serious here... defaulting to 1.\n");
504                         z = 1;
505                 }
506
507                 if (z > MAX_RECALC) {
508                         ast_cli(fd, "         Maximum limit of recalc exceeded by %d, truncating value to %d\n", z - MAX_RECALC, MAX_RECALC);
509                         z = MAX_RECALC;
510                 }
511                 ast_cli(fd, "         Recalculating Codec Translation (number of sample seconds: %d)\n\n", z);
512                 AST_RWLIST_WRLOCK(&translators);
513                 rebuild_matrix(z);
514                 AST_RWLIST_UNLOCK(&translators);
515         }
516
517         AST_RWLIST_RDLOCK(&translators);
518
519         ast_cli(fd, "         Translation times between formats (in milliseconds) for one second of data\n");
520         ast_cli(fd, "          Source Format (Rows) Destination Format (Columns)\n\n");
521         /* Get the length of the longest (usable?) codec name, so we know how wide the left side should be */
522         for (x = 0; x < SHOW_TRANS; x++) {
523                 curlen = strlen(ast_getformatname(1 << (x + 1)));
524                 if (curlen > longest)
525                         longest = curlen;
526         }
527         for (x = -1; x < SHOW_TRANS; x++) {
528                 struct ast_str *out = ast_str_alloca(120);
529                 
530                 ast_str_set(&out, -1, " ");
531                 for (y = -1; y < SHOW_TRANS; y++) {
532                         curlen = strlen(ast_getformatname(1 << (y)));
533
534                         if (x >= 0 && y >= 0 && tr_matrix[x][y].step) {
535                                 /* XXX 999 is a little hackish
536                                    We don't want this number being larger than the shortest (or current) codec
537                                    For now, that is "gsm" */
538                                 ast_str_append(&out, -1, "%*d", curlen + 1, tr_matrix[x][y].cost > 999 ? 0 : tr_matrix[x][y].cost);
539                         } else if (x == -1 && y >= 0) {
540                                 /* Top row - use a dynamic size */
541                                 ast_str_append(&out, -1, "%*s", curlen + 1, ast_getformatname(1 << (x + y + 1)) );
542                         } else if (y == -1 && x >= 0) {
543                                 /* Left column - use a static size. */
544                                 ast_str_append(&out, -1, "%*s", longest, ast_getformatname(1 << (x + y + 1)) );
545                         } else if (x >= 0 && y >= 0) {
546                                 ast_str_append(&out, -1, "%*s", curlen + 1, "-");
547                         } else {
548                                 ast_str_append(&out, -1, "%*s", longest, "");
549                         }
550                 }
551                 ast_str_append(&out, -1, "\n");
552                 ast_cli(fd, out->str);                  
553         }
554         AST_RWLIST_UNLOCK(&translators);
555         return RESULT_SUCCESS;
556 }
557
558 static const char show_trans_usage[] =
559 "Usage: core show translation [recalc] [<recalc seconds>]\n"
560 "       Displays known codec translators and the cost associated\n"
561 "with each conversion.  If the argument 'recalc' is supplied along\n"
562 "with optional number of seconds to test a new test will be performed\n"
563 "as the chart is being displayed.\n";
564
565 static struct ast_cli_entry cli_translate[] = {
566         { { "core", "show", "translation", NULL },
567         show_translation, "Display translation matrix",
568         show_trans_usage, NULL, NULL },
569 };
570
571 /*! \brief register codec translator */
572 int __ast_register_translator(struct ast_translator *t, struct ast_module *mod)
573 {
574         static int added_cli = 0;
575         struct ast_translator *u;
576
577         if (!mod) {
578                 ast_log(LOG_WARNING, "Missing module pointer, you need to supply one\n");
579                 return -1;
580         }
581
582         if (!t->buf_size) {
583                 ast_log(LOG_WARNING, "empty buf size, you need to supply one\n");
584                 return -1;
585         }
586
587         t->module = mod;
588
589         t->srcfmt = powerof(t->srcfmt);
590         t->dstfmt = powerof(t->dstfmt);
591         t->active = 1;
592
593         if (t->plc_samples) {
594                 if (t->buffer_samples < t->plc_samples) {
595                         ast_log(LOG_WARNING, "plc_samples %d buffer_samples %d\n",
596                                 t->plc_samples, t->buffer_samples);
597                         return -1;
598                 }
599                 if (t->dstfmt != AST_FORMAT_SLINEAR)
600                         ast_log(LOG_WARNING, "plc_samples %d format %x\n",
601                                 t->plc_samples, t->dstfmt);
602         }
603         if (t->srcfmt >= MAX_FORMAT) {
604                 ast_log(LOG_WARNING, "Source format %s is larger than MAX_FORMAT\n", ast_getformatname(t->srcfmt));
605                 return -1;
606         }
607
608         if (t->dstfmt >= MAX_FORMAT) {
609                 ast_log(LOG_WARNING, "Destination format %s is larger than MAX_FORMAT\n", ast_getformatname(t->dstfmt));
610                 return -1;
611         }
612
613         if (t->buf_size) {
614                /*
615                 * Align buf_size properly, rounding up to the machine-specific
616                 * alignment for pointers.
617                 */
618                 struct _test_align { void *a, *b; } p;
619                 int align = (char *)&p.b - (char *)&p.a;
620
621                 t->buf_size = ((t->buf_size + align - 1) / align) * align;
622         }
623
624         if (t->frameout == NULL)
625                 t->frameout = default_frameout;
626   
627         calc_cost(t, 1);
628
629         if (option_verbose > 1) {
630                 char tmp[80];
631
632                 ast_verbose(VERBOSE_PREFIX_2 "Registered translator '%s' from format %s to %s, cost %d\n",
633                             term_color(tmp, t->name, COLOR_MAGENTA, COLOR_BLACK, sizeof(tmp)),
634                             ast_getformatname(1 << t->srcfmt), ast_getformatname(1 << t->dstfmt), t->cost);
635         }
636
637         if (!added_cli) {
638                 ast_cli_register_multiple(cli_translate, sizeof(cli_translate) / sizeof(struct ast_cli_entry));
639                 added_cli++;
640         }
641
642         AST_RWLIST_WRLOCK(&translators);
643
644         /* find any existing translators that provide this same srcfmt/dstfmt,
645            and put this one in order based on cost */
646         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&translators, u, list) {
647                 if ((u->srcfmt == t->srcfmt) &&
648                     (u->dstfmt == t->dstfmt) &&
649                     (u->cost > t->cost)) {
650                         AST_RWLIST_INSERT_BEFORE_CURRENT(&translators, t, list);
651                         t = NULL;
652                 }
653         }
654         AST_RWLIST_TRAVERSE_SAFE_END;
655
656         /* if no existing translator was found for this format combination,
657            add it to the beginning of the list */
658         if (t)
659                 AST_RWLIST_INSERT_HEAD(&translators, t, list);
660
661         rebuild_matrix(0);
662
663         AST_RWLIST_UNLOCK(&translators);
664
665         return 0;
666 }
667
668 /*! \brief unregister codec translator */
669 int ast_unregister_translator(struct ast_translator *t)
670 {
671         char tmp[80];
672         struct ast_translator *u;
673         int found = 0;
674
675         AST_RWLIST_WRLOCK(&translators);
676         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&translators, u, list) {
677                 if (u == t) {
678                         AST_RWLIST_REMOVE_CURRENT(&translators, list);
679                         if (option_verbose > 1)
680                                 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));
681                         found = 1;
682                         break;
683                 }
684         }
685         AST_RWLIST_TRAVERSE_SAFE_END;
686
687         if (found)
688                 rebuild_matrix(0);
689
690         AST_RWLIST_UNLOCK(&translators);
691
692         return (u ? 0 : -1);
693 }
694
695 void ast_translator_activate(struct ast_translator *t)
696 {
697         AST_RWLIST_WRLOCK(&translators);
698         t->active = 1;
699         rebuild_matrix(0);
700         AST_RWLIST_UNLOCK(&translators);
701 }
702
703 void ast_translator_deactivate(struct ast_translator *t)
704 {
705         AST_RWLIST_WRLOCK(&translators);
706         t->active = 0;
707         rebuild_matrix(0);
708         AST_RWLIST_UNLOCK(&translators);
709 }
710
711 /*! \brief Calculate our best translator source format, given costs, and a desired destination */
712 int ast_translator_best_choice(int *dst, int *srcs)
713 {
714         int x,y;
715         int best = -1;
716         int bestdst = 0;
717         int cur, cursrc;
718         int besttime = INT_MAX;
719         int beststeps = INT_MAX;
720         int common = (*dst) & (*srcs);  /* are there common formats ? */
721
722         if (common) { /* yes, pick one and return */
723                 for (cur = 1, y = 0; y < MAX_FORMAT; cur <<= 1, y++) {
724                         if (cur & common)       /* guaranteed to find one */
725                                 break;
726                 }
727                 /* We are done, this is a common format to both. */
728                 *srcs = *dst = cur;
729                 return 0;
730         } else {        /* No, we will need to translate */
731                 AST_RWLIST_RDLOCK(&translators);
732                 for (cur = 1, y = 0; y < MAX_FORMAT; cur <<= 1, y++) {
733                         if (! (cur & *dst))
734                                 continue;
735                         for (cursrc = 1, x = 0; x < MAX_FORMAT; cursrc <<= 1, x++) {
736                                 if (!(*srcs & cursrc) || !tr_matrix[x][y].step ||
737                                     tr_matrix[x][y].cost >  besttime)
738                                         continue;       /* not existing or no better */
739                                 if (tr_matrix[x][y].cost < besttime ||
740                                     tr_matrix[x][y].multistep < beststeps) {
741                                         /* better than what we have so far */
742                                         best = cursrc;
743                                         bestdst = cur;
744                                         besttime = tr_matrix[x][y].cost;
745                                         beststeps = tr_matrix[x][y].multistep;
746                                 }
747                         }
748                 }
749                 AST_RWLIST_UNLOCK(&translators);
750                 if (best > -1) {
751                         *srcs = best;
752                         *dst = bestdst;
753                         best = 0;
754                 }
755                 return best;
756         }
757 }
758
759 unsigned int ast_translate_path_steps(unsigned int dest, unsigned int src)
760 {
761         unsigned int res = -1;
762
763         /* convert bitwise format numbers into array indices */
764         src = powerof(src);
765         dest = powerof(dest);
766
767         AST_RWLIST_RDLOCK(&translators);
768
769         if (tr_matrix[src][dest].step)
770                 res = tr_matrix[src][dest].multistep + 1;
771
772         AST_RWLIST_UNLOCK(&translators);
773
774         return res;
775 }
776
777 unsigned int ast_translate_available_formats(unsigned int dest, unsigned int src)
778 {
779         unsigned int res = dest;
780         unsigned int x;
781         unsigned int src_audio = src & AST_FORMAT_AUDIO_MASK;
782         unsigned int src_video = src & AST_FORMAT_VIDEO_MASK;
783
784         /* if we don't have a source format, we just have to try all
785            possible destination formats */
786         if (!src)
787                 return dest;
788
789         /* If we have a source audio format, get its format index */
790         if (src_audio)
791                 src_audio = powerof(src_audio);
792
793         /* If we have a source video format, get its format index */
794         if (src_video)
795                 src_video = powerof(src_video);
796
797         AST_RWLIST_RDLOCK(&translators);
798
799         /* For a given source audio format, traverse the list of
800            known audio formats to determine whether there exists
801            a translation path from the source format to the
802            destination format. */
803         for (x = 1; src_audio && x < AST_FORMAT_MAX_AUDIO; x <<= 1) {
804                 /* if this is not a desired format, nothing to do */
805                 if (!dest & x)
806                         continue;
807
808                 /* if the source is supplying this format, then
809                    we can leave it in the result */
810                 if (src & x)
811                         continue;
812
813                 /* if we don't have a translation path from the src
814                    to this format, remove it from the result */
815                 if (!tr_matrix[src_audio][powerof(x)].step) {
816                         res &= ~x;
817                         continue;
818                 }
819
820                 /* now check the opposite direction */
821                 if (!tr_matrix[powerof(x)][src_audio].step)
822                         res &= ~x;
823         }
824
825         /* For a given source video format, traverse the list of
826            known video formats to determine whether there exists
827            a translation path from the source format to the
828            destination format. */
829         for (; src_video && x < AST_FORMAT_MAX_VIDEO; x <<= 1) {
830                 /* if this is not a desired format, nothing to do */
831                 if (!dest & x)
832                         continue;
833
834                 /* if the source is supplying this format, then
835                    we can leave it in the result */
836                 if (src & x)
837                         continue;
838
839                 /* if we don't have a translation path from the src
840                    to this format, remove it from the result */
841                 if (!tr_matrix[src_video][powerof(x)].step) {
842                         res &= ~x;
843                         continue;
844                 }
845
846                 /* now check the opposite direction */
847                 if (!tr_matrix[powerof(x)][src_video].step)
848                         res &= ~x;
849         }
850
851         AST_RWLIST_UNLOCK(&translators);
852
853         return res;
854 }