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