Merged revisions 98943 via svnmerge from
[asterisk/asterisk.git] / main / translate.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Translate via the use of pseudo channels
22  *
23  * \author Mark Spencer <markster@digium.com> 
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <sys/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                 /* Set the magic hint that this has been requested to be destroyed. */
143                 pvt->datalen = -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 = (int16_t *)pvt->outbuf;
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 = pvt->outbuf;
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         AST_RWLIST_RDLOCK(&translators);
271
272         while (source != dest) {
273                 struct ast_trans_pvt *cur;
274                 struct ast_translator *t = tr_matrix[source][dest].step;
275                 if (!t) {
276                         ast_log(LOG_WARNING, "No translator path from %s to %s\n", 
277                                 ast_getformatname(source), ast_getformatname(dest));
278                         AST_RWLIST_UNLOCK(&translators);
279                         return NULL;
280                 }
281                 if (!(cur = newpvt(t))) {
282                         ast_log(LOG_WARNING, "Failed to build translator step from %d to %d\n", source, dest);
283                         if (head)
284                                 ast_translator_free_path(head); 
285                         AST_RWLIST_UNLOCK(&translators);
286                         return NULL;
287                 }
288                 if (!head)
289                         head = cur;
290                 else
291                         tail->next = cur;
292                 tail = cur;
293                 cur->nextin = cur->nextout = ast_tv(0, 0);
294                 /* Keep going if this isn't the final destination */
295                 source = cur->t->dstfmt;
296         }
297
298         AST_RWLIST_UNLOCK(&translators);
299         return head;
300 }
301
302 static inline int format_rate(int format)
303 {
304         if (format == AST_FORMAT_G722 || format == AST_FORMAT_SLINEAR16)
305                 return 16000;
306
307         return 8000;
308 }
309
310 /*! \brief do the actual translation */
311 struct ast_frame *ast_translate(struct ast_trans_pvt *path, struct ast_frame *f, int consume)
312 {
313         struct ast_trans_pvt *p = path;
314         struct ast_frame *out = f;
315         struct timeval delivery;
316         int has_timing_info;
317         long ts;
318         long len;
319         int seqno;
320
321         has_timing_info = ast_test_flag(f, AST_FRFLAG_HAS_TIMING_INFO);
322         ts = f->ts;
323         len = f->len;
324         seqno = f->seqno;
325
326         /* XXX hmmm... check this below */
327         if (!ast_tvzero(f->delivery)) {
328                 if (!ast_tvzero(path->nextin)) {
329                         /* Make sure this is in line with what we were expecting */
330                         if (!ast_tveq(path->nextin, f->delivery)) {
331                                 /* The time has changed between what we expected and this
332                                    most recent time on the new packet.  If we have a
333                                    valid prediction adjust our output time appropriately */
334                                 if (!ast_tvzero(path->nextout)) {
335                                         path->nextout = ast_tvadd(path->nextout,
336                                                                   ast_tvsub(f->delivery, path->nextin));
337                                 }
338                                 path->nextin = f->delivery;
339                         }
340                 } else {
341                         /* This is our first pass.  Make sure the timing looks good */
342                         path->nextin = f->delivery;
343                         path->nextout = f->delivery;
344                 }
345                 /* Predict next incoming sample */
346                 path->nextin = ast_tvadd(path->nextin, ast_samp2tv(f->samples, format_rate(f->subclass)));
347         }
348         delivery = f->delivery;
349         for ( ; out && p ; p = p->next) {
350                 framein(p, out);
351                 out = p->t->frameout(p);
352         }
353         if (consume)
354                 ast_frfree(f);
355         if (out == NULL)
356                 return NULL;
357         /* we have a frame, play with times */
358         if (!ast_tvzero(delivery)) {
359                 /* Regenerate prediction after a discontinuity */
360                 if (ast_tvzero(path->nextout))
361                         path->nextout = ast_tvnow();
362
363                 /* Use next predicted outgoing timestamp */
364                 out->delivery = path->nextout;
365                 
366                 /* Predict next outgoing timestamp from samples in this
367                    frame. */
368                 path->nextout = ast_tvadd(path->nextout, ast_samp2tv(out->samples, format_rate(out->subclass)));
369         } else {
370                 out->delivery = ast_tv(0, 0);
371                 ast_set2_flag(out, has_timing_info, AST_FRFLAG_HAS_TIMING_INFO);
372                 if (has_timing_info) {
373                         out->ts = ts;
374                         out->len = len;
375                         out->seqno = seqno;
376                 }
377         }
378         /* Invalidate prediction if we're entering a silence period */
379         if (out->frametype == AST_FRAME_CNG)
380                 path->nextout = ast_tv(0, 0);
381         return out;
382 }
383
384 /*! \brief compute the cost of a single translation step */
385 static void calc_cost(struct ast_translator *t, int seconds)
386 {
387         int num_samples = 0;
388         struct ast_trans_pvt *pvt;
389         struct rusage start;
390         struct rusage end;
391         int cost;
392         int out_rate = format_rate(t->dstfmt);
393
394         if (!seconds)
395                 seconds = 1;
396         
397         /* If they don't make samples, give them a terrible score */
398         if (!t->sample) {
399                 ast_log(LOG_WARNING, "Translator '%s' does not produce sample frames.\n", t->name);
400                 t->cost = 999999;
401                 return;
402         }
403
404         pvt = newpvt(t);
405         if (!pvt) {
406                 ast_log(LOG_WARNING, "Translator '%s' appears to be broken and will probably fail.\n", t->name);
407                 t->cost = 999999;
408                 return;
409         }
410
411         getrusage(RUSAGE_SELF, &start);
412
413         /* Call the encoder until we've processed the required number of samples */
414         while (num_samples < seconds * out_rate) {
415                 struct ast_frame *f = t->sample();
416                 if (!f) {
417                         ast_log(LOG_WARNING, "Translator '%s' failed to produce a sample frame.\n", t->name);
418                         destroy(pvt);
419                         t->cost = 999999;
420                         return;
421                 }
422                 framein(pvt, f);
423                 ast_frfree(f);
424                 while ((f = t->frameout(pvt))) {
425                         num_samples += f->samples;
426                         ast_frfree(f);
427                 }
428         }
429
430         getrusage(RUSAGE_SELF, &end);
431
432         cost = ((end.ru_utime.tv_sec - start.ru_utime.tv_sec) * 1000000) + end.ru_utime.tv_usec - start.ru_utime.tv_usec;
433         cost += ((end.ru_stime.tv_sec - start.ru_stime.tv_sec) * 1000000) + end.ru_stime.tv_usec - start.ru_stime.tv_usec;
434
435         destroy(pvt);
436
437         t->cost = cost / seconds;
438
439         if (!t->cost)
440                 t->cost = 1;
441 }
442
443 /*!
444  * \brief rebuild a translation matrix.
445  * \note This function expects the list of translators to be locked
446 */
447 static void rebuild_matrix(int samples)
448 {
449         struct ast_translator *t;
450         int x;      /* source format index */
451         int y;      /* intermediate format index */
452         int z;      /* destination format index */
453
454         ast_debug(1, "Resetting translation matrix\n");
455
456         bzero(tr_matrix, sizeof(tr_matrix));
457
458         /* first, compute all direct costs */
459         AST_RWLIST_TRAVERSE(&translators, t, list) {
460                 if (!t->active)
461                         continue;
462
463                 x = t->srcfmt;
464                 z = t->dstfmt;
465
466                 if (samples)
467                         calc_cost(t, samples);
468           
469                 if (!tr_matrix[x][z].step || t->cost < tr_matrix[x][z].cost) {
470                         tr_matrix[x][z].step = t;
471                         tr_matrix[x][z].cost = t->cost;
472                 }
473         }
474
475         /*
476          * For each triple x, y, z of distinct formats, check if there is
477          * a path from x to z through y which is cheaper than what is
478          * currently known, and in case, update the matrix.
479          * Repeat until the matrix is stable.
480          */
481         for (;;) {
482                 int changed = 0;
483                 for (x = 0; x < MAX_FORMAT; x++) {      /* source format */
484                         for (y=0; y < MAX_FORMAT; y++) {    /* intermediate format */
485                                 if (x == y)                     /* skip ourselves */
486                                         continue;
487
488                                 for (z=0; z<MAX_FORMAT; z++) {  /* dst format */
489                                         int newcost;
490
491                                         if (z == x || z == y)       /* skip null conversions */
492                                                 continue;
493                                         if (!tr_matrix[x][y].step)  /* no path from x to y */
494                                                 continue;
495                                         if (!tr_matrix[y][z].step)  /* no path from y to z */
496                                                 continue;
497                                         newcost = tr_matrix[x][y].cost + tr_matrix[y][z].cost;
498                                         if (tr_matrix[x][z].step && newcost >= tr_matrix[x][z].cost)
499                                                 continue;               /* x->y->z is more expensive than
500                                                                          * the existing path */
501                                         /* ok, we can get from x to z via y with a cost that
502                                            is the sum of the transition from x to y and
503                                            from y to z */
504                                                  
505                                         tr_matrix[x][z].step = tr_matrix[x][y].step;
506                                         tr_matrix[x][z].cost = newcost;
507                                         tr_matrix[x][z].multistep = 1;
508                                         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);
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;
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         }
570         for (x = -1; x < SHOW_TRANS; x++) {
571                 struct ast_str *out = ast_str_alloca(120);
572                 /*Go ahead and move to next iteration if dealing with an unknown codec*/
573                 if(x >= 0 && !strcmp(ast_getformatname(1 << (x)), "unknown"))
574                         continue;
575                 ast_str_set(&out, -1, " ");
576                 for (y = -1; y < SHOW_TRANS; y++) {
577                         /*Go ahead and move to next iteration if dealing with an unknown codec*/
578                         if (y >= 0 && !strcmp(ast_getformatname(1 << (y)), "unknown"))
579                                 continue;
580                         if (y >= 0)
581                                 curlen = strlen(ast_getformatname(1 << (y)));
582                         if (curlen < 5)
583                                 curlen = 5;
584                         if (x >= 0 && y >= 0 && tr_matrix[x][y].step) {
585                                 /* XXX 99999 is a little hackish
586                                    We don't want this number being larger than the shortest (or current) codec
587                                    For now, that is "gsm" */
588                                 ast_str_append(&out, -1, "%*d", curlen + 1, tr_matrix[x][y].cost > 99999 ? 0 : tr_matrix[x][y].cost);
589                         } else if (x == -1 && y >= 0) {
590                                 /* Top row - use a dynamic size */
591                                 ast_str_append(&out, -1, "%*s", curlen + 1, ast_getformatname(1 << (y)) );
592                         } else if (y == -1 && x >= 0) {
593                                 /* Left column - use a static size. */
594                                 ast_str_append(&out, -1, "%*s", longest, ast_getformatname(1 << (x)) );
595                         } else if (x >= 0 && y >= 0) {
596                                 ast_str_append(&out, -1, "%*s", curlen + 1, "-");
597                         } else {
598                                 ast_str_append(&out, -1, "%*s", longest, "");
599                         }
600                 }
601                 ast_str_append(&out, -1, "\n");
602                 ast_cli(a->fd, out->str);                       
603         }
604         AST_RWLIST_UNLOCK(&translators);
605         return CLI_SUCCESS;
606 }
607
608 static struct ast_cli_entry cli_translate[] = {
609         AST_CLI_DEFINE(handle_cli_core_show_translation, "Display translation matrix")
610 };
611
612 /*! \brief register codec translator */
613 int __ast_register_translator(struct ast_translator *t, struct ast_module *mod)
614 {
615         static int added_cli = 0;
616         struct ast_translator *u;
617         char tmp[80];
618
619         if (!mod) {
620                 ast_log(LOG_WARNING, "Missing module pointer, you need to supply one\n");
621                 return -1;
622         }
623
624         if (!t->buf_size) {
625                 ast_log(LOG_WARNING, "empty buf size, you need to supply one\n");
626                 return -1;
627         }
628
629         t->module = mod;
630
631         t->srcfmt = powerof(t->srcfmt);
632         t->dstfmt = powerof(t->dstfmt);
633         t->active = 1;
634
635         if (t->plc_samples) {
636                 if (t->buffer_samples < t->plc_samples) {
637                         ast_log(LOG_WARNING, "plc_samples %d buffer_samples %d\n",
638                                 t->plc_samples, t->buffer_samples);
639                         return -1;
640                 }
641                 if (t->dstfmt != powerof(AST_FORMAT_SLINEAR))
642                         ast_log(LOG_WARNING, "plc_samples %d format %x\n",
643                                 t->plc_samples, t->dstfmt);
644         }
645         if (t->srcfmt >= MAX_FORMAT) {
646                 ast_log(LOG_WARNING, "Source format %s is larger than MAX_FORMAT\n", ast_getformatname(t->srcfmt));
647                 return -1;
648         }
649
650         if (t->dstfmt >= MAX_FORMAT) {
651                 ast_log(LOG_WARNING, "Destination format %s is larger than MAX_FORMAT\n", ast_getformatname(t->dstfmt));
652                 return -1;
653         }
654
655         if (t->buf_size) {
656                /*
657                 * Align buf_size properly, rounding up to the machine-specific
658                 * alignment for pointers.
659                 */
660                 struct _test_align { void *a, *b; } p;
661                 int align = (char *)&p.b - (char *)&p.a;
662
663                 t->buf_size = ((t->buf_size + align - 1) / align) * align;
664         }
665
666         if (t->frameout == NULL)
667                 t->frameout = default_frameout;
668   
669         calc_cost(t, 1);
670
671         ast_verb(2, "Registered translator '%s' from format %s to %s, cost %d\n",
672                             term_color(tmp, t->name, COLOR_MAGENTA, COLOR_BLACK, sizeof(tmp)),
673                             ast_getformatname(1 << t->srcfmt), ast_getformatname(1 << t->dstfmt), t->cost);
674
675         if (!added_cli) {
676                 ast_cli_register_multiple(cli_translate, sizeof(cli_translate) / sizeof(struct ast_cli_entry));
677                 added_cli++;
678         }
679
680         AST_RWLIST_WRLOCK(&translators);
681
682         /* find any existing translators that provide this same srcfmt/dstfmt,
683            and put this one in order based on cost */
684         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&translators, u, list) {
685                 if ((u->srcfmt == t->srcfmt) &&
686                     (u->dstfmt == t->dstfmt) &&
687                     (u->cost > t->cost)) {
688                         AST_RWLIST_INSERT_BEFORE_CURRENT(t, list);
689                         t = NULL;
690                 }
691         }
692         AST_RWLIST_TRAVERSE_SAFE_END;
693
694         /* if no existing translator was found for this format combination,
695            add it to the beginning of the list */
696         if (t)
697                 AST_RWLIST_INSERT_HEAD(&translators, t, list);
698
699         rebuild_matrix(0);
700
701         AST_RWLIST_UNLOCK(&translators);
702
703         return 0;
704 }
705
706 /*! \brief unregister codec translator */
707 int ast_unregister_translator(struct ast_translator *t)
708 {
709         char tmp[80];
710         struct ast_translator *u;
711         int found = 0;
712
713         AST_RWLIST_WRLOCK(&translators);
714         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&translators, u, list) {
715                 if (u == t) {
716                         AST_RWLIST_REMOVE_CURRENT(list);
717                         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));
718                         found = 1;
719                         break;
720                 }
721         }
722         AST_RWLIST_TRAVERSE_SAFE_END;
723
724         if (found)
725                 rebuild_matrix(0);
726
727         AST_RWLIST_UNLOCK(&translators);
728
729         return (u ? 0 : -1);
730 }
731
732 void ast_translator_activate(struct ast_translator *t)
733 {
734         AST_RWLIST_WRLOCK(&translators);
735         t->active = 1;
736         rebuild_matrix(0);
737         AST_RWLIST_UNLOCK(&translators);
738 }
739
740 void ast_translator_deactivate(struct ast_translator *t)
741 {
742         AST_RWLIST_WRLOCK(&translators);
743         t->active = 0;
744         rebuild_matrix(0);
745         AST_RWLIST_UNLOCK(&translators);
746 }
747
748 /*! \brief Calculate our best translator source format, given costs, and a desired destination */
749 int ast_translator_best_choice(int *dst, int *srcs)
750 {
751         int x,y;
752         int best = -1;
753         int bestdst = 0;
754         int cur, cursrc;
755         int besttime = INT_MAX;
756         int beststeps = INT_MAX;
757         int common = ((*dst) & (*srcs)) & AST_FORMAT_AUDIO_MASK;        /* are there common formats ? */
758
759         if (common) { /* yes, pick one and return */
760                 for (cur = 1, y = 0; y <= MAX_AUDIO_FORMAT; cur <<= 1, y++) {
761                         if (cur & common)       /* guaranteed to find one */
762                                 break;
763                 }
764                 /* We are done, this is a common format to both. */
765                 *srcs = *dst = cur;
766                 return 0;
767         } else {        /* No, we will need to translate */
768                 AST_RWLIST_RDLOCK(&translators);
769                 for (cur = 1, y = 0; y <= MAX_AUDIO_FORMAT; cur <<= 1, y++) {
770                         if (! (cur & *dst))
771                                 continue;
772                         for (cursrc = 1, x = 0; x <= MAX_AUDIO_FORMAT; cursrc <<= 1, x++) {
773                                 if (!(*srcs & cursrc) || !tr_matrix[x][y].step ||
774                                     tr_matrix[x][y].cost >  besttime)
775                                         continue;       /* not existing or no better */
776                                 if (tr_matrix[x][y].cost < besttime ||
777                                     tr_matrix[x][y].multistep < beststeps) {
778                                         /* better than what we have so far */
779                                         best = cursrc;
780                                         bestdst = cur;
781                                         besttime = tr_matrix[x][y].cost;
782                                         beststeps = tr_matrix[x][y].multistep;
783                                 }
784                         }
785                 }
786                 AST_RWLIST_UNLOCK(&translators);
787                 if (best > -1) {
788                         *srcs = best;
789                         *dst = bestdst;
790                         best = 0;
791                 }
792                 return best;
793         }
794 }
795
796 unsigned int ast_translate_path_steps(unsigned int dest, unsigned int src)
797 {
798         unsigned int res = -1;
799
800         /* convert bitwise format numbers into array indices */
801         src = powerof(src);
802         dest = powerof(dest);
803
804         AST_RWLIST_RDLOCK(&translators);
805
806         if (tr_matrix[src][dest].step)
807                 res = tr_matrix[src][dest].multistep + 1;
808
809         AST_RWLIST_UNLOCK(&translators);
810
811         return res;
812 }
813
814 unsigned int ast_translate_available_formats(unsigned int dest, unsigned int src)
815 {
816         unsigned int res = dest;
817         unsigned int x;
818         unsigned int src_audio = src & AST_FORMAT_AUDIO_MASK;
819         unsigned int src_video = src & AST_FORMAT_VIDEO_MASK;
820
821         /* if we don't have a source format, we just have to try all
822            possible destination formats */
823         if (!src)
824                 return dest;
825
826         /* If we have a source audio format, get its format index */
827         if (src_audio)
828                 src_audio = powerof(src_audio);
829
830         /* If we have a source video format, get its format index */
831         if (src_video)
832                 src_video = powerof(src_video);
833
834         AST_RWLIST_RDLOCK(&translators);
835
836         /* For a given source audio format, traverse the list of
837            known audio formats to determine whether there exists
838            a translation path from the source format to the
839            destination format. */
840         for (x = 1; src_audio && (x & AST_FORMAT_AUDIO_MASK); x <<= 1) {
841                 /* if this is not a desired format, nothing to do */
842                 if (!dest & x)
843                         continue;
844
845                 /* if the source is supplying this format, then
846                    we can leave it in the result */
847                 if (src & x)
848                         continue;
849
850                 /* if we don't have a translation path from the src
851                    to this format, remove it from the result */
852                 if (!tr_matrix[src_audio][powerof(x)].step) {
853                         res &= ~x;
854                         continue;
855                 }
856
857                 /* now check the opposite direction */
858                 if (!tr_matrix[powerof(x)][src_audio].step)
859                         res &= ~x;
860         }
861
862         /* For a given source video format, traverse the list of
863            known video formats to determine whether there exists
864            a translation path from the source format to the
865            destination format. */
866         for (; src_video && (x & AST_FORMAT_VIDEO_MASK); x <<= 1) {
867                 /* if this is not a desired format, nothing to do */
868                 if (!dest & x)
869                         continue;
870
871                 /* if the source is supplying this format, then
872                    we can leave it in the result */
873                 if (src & x)
874                         continue;
875
876                 /* if we don't have a translation path from the src
877                    to this format, remove it from the result */
878                 if (!tr_matrix[src_video][powerof(x)].step) {
879                         res &= ~x;
880                         continue;
881                 }
882
883                 /* now check the opposite direction */
884                 if (!tr_matrix[powerof(x)][src_video].step)
885                         res &= ~x;
886         }
887
888         AST_RWLIST_UNLOCK(&translators);
889
890         return res;
891 }
892
893 void ast_translate_frame_freed(struct ast_frame *fr)
894 {
895         struct ast_trans_pvt *pvt;
896
897         ast_clear_flag(fr, AST_FRFLAG_FROM_TRANSLATOR);
898
899         pvt = (struct ast_trans_pvt *) (((char *) fr) - offsetof(struct ast_trans_pvt, f));
900
901         if (pvt->datalen != -1)
902                 return;
903         
904         destroy(pvt);
905 }