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