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