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