Merge the rest of the FullyBooted patch
[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 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 (t->destroy)
138                 t->destroy(pvt);
139         ast_free(pvt);
140         ast_module_unref(t->module);
141 }
142
143 /*! \brief framein wrapper, deals with plc and bound checks.  */
144 static int framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
145 {
146         int16_t *dst = pvt->outbuf.i16;
147         int ret;
148         int samples = pvt->samples;     /* initial value */
149         
150         /* Copy the last in jb timing info to the pvt */
151         ast_copy_flags(&pvt->f, f, AST_FRFLAG_HAS_TIMING_INFO);
152         pvt->f.ts = f->ts;
153         pvt->f.len = f->len;
154         pvt->f.seqno = f->seqno;
155
156         if (f->samples == 0) {
157                 ast_log(LOG_WARNING, "no samples for %s\n", pvt->t->name);
158         }
159         if (pvt->t->buffer_samples) {   /* do not pass empty frames to callback */
160                 if (f->datalen == 0) { /* perform PLC with nominal framesize of 20ms/160 samples */
161                         if (pvt->plc) {
162                                 int l = pvt->t->plc_samples;
163                                 if (pvt->samples + l > pvt->t->buffer_samples) {
164                                         ast_log(LOG_WARNING, "Out of buffer space\n");
165                                         return -1;
166                                 }
167                                 l = plc_fillin(pvt->plc, dst + pvt->samples, l);
168                                 pvt->samples += l;
169                                 pvt->datalen = pvt->samples * 2;        /* SLIN has 2bytes for 1sample */
170                         }
171                         /* We don't want generic PLC. If the codec has native PLC, then do that */
172                         if (!pvt->t->native_plc)
173                                 return 0;
174                 }
175                 if (pvt->samples + f->samples > pvt->t->buffer_samples) {
176                         ast_log(LOG_WARNING, "Out of buffer space\n");
177                         return -1;
178                 }
179         }
180         /* we require a framein routine, wouldn't know how to do
181          * it otherwise.
182          */
183         ret = pvt->t->framein(pvt, f);
184         /* possibly store data for plc */
185         if (!ret && pvt->plc) {
186                 int l = pvt->t->plc_samples;
187                 if (pvt->samples < l)
188                         l = pvt->samples;
189                 plc_rx(pvt->plc, dst + pvt->samples - l, l);
190         }
191         /* diagnostic ... */
192         if (pvt->samples == samples)
193                 ast_log(LOG_WARNING, "%s did not update samples %d\n",
194                         pvt->t->name, pvt->samples);
195         return ret;
196 }
197
198 /*! \brief generic frameout routine.
199  * If samples and datalen are 0, take whatever is in pvt
200  * and reset them, otherwise take the values in the caller and
201  * leave alone the pvt values.
202  */
203 struct ast_frame *ast_trans_frameout(struct ast_trans_pvt *pvt,
204         int datalen, int samples)
205 {
206         struct ast_frame *f = &pvt->f;
207
208         if (samples)
209                 f->samples = samples;
210         else {
211                 if (pvt->samples == 0)
212                         return NULL;
213                 f->samples = pvt->samples;
214                 pvt->samples = 0;
215         }
216         if (datalen)
217                 f->datalen = datalen;
218         else {
219                 f->datalen = pvt->datalen;
220                 pvt->datalen = 0;
221         }
222
223         f->frametype = AST_FRAME_VOICE;
224         f->subclass.codec = 1LL << (pvt->t->dstfmt);
225         f->mallocd = 0;
226         f->offset = AST_FRIENDLY_OFFSET;
227         f->src = pvt->t->name;
228         f->data.ptr = pvt->outbuf.c;
229
230         return ast_frisolate(f);
231 }
232
233 static struct ast_frame *default_frameout(struct ast_trans_pvt *pvt)
234 {
235         return ast_trans_frameout(pvt, 0, 0);
236 }
237
238 /* end of callback wrappers and helpers */
239
240 void ast_translator_free_path(struct ast_trans_pvt *p)
241 {
242         struct ast_trans_pvt *pn = p;
243         while ( (p = pn) ) {
244                 pn = p->next;
245                 destroy(p);
246         }
247 }
248
249 /*! \brief Build a chain of translators based upon the given source and dest formats */
250 struct ast_trans_pvt *ast_translator_build_path(format_t dest, format_t source)
251 {
252         struct ast_trans_pvt *head = NULL, *tail = NULL;
253         
254         source = powerof(source);
255         dest = powerof(dest);
256
257         if (source == -1 || dest == -1) {
258                 ast_log(LOG_WARNING, "No translator path: (%s codec is not valid)\n", source == -1 ? "starting" : "ending");
259                 return NULL;
260         }
261
262         AST_RWLIST_RDLOCK(&translators);
263
264         while (source != dest) {
265                 struct ast_trans_pvt *cur;
266                 struct ast_translator *t = tr_matrix[source][dest].step;
267                 if (!t) {
268                         ast_log(LOG_WARNING, "No translator path from %s to %s\n", 
269                                 ast_getformatname(source), ast_getformatname(dest));
270                         AST_RWLIST_UNLOCK(&translators);
271                         return NULL;
272                 }
273                 if (!(cur = newpvt(t))) {
274                         ast_log(LOG_WARNING, "Failed to build translator step from %s to %s\n",
275                                 ast_getformatname(source), ast_getformatname(dest));
276                         if (head)
277                                 ast_translator_free_path(head); 
278                         AST_RWLIST_UNLOCK(&translators);
279                         return NULL;
280                 }
281                 if (!head)
282                         head = cur;
283                 else
284                         tail->next = cur;
285                 tail = cur;
286                 cur->nextin = cur->nextout = ast_tv(0, 0);
287                 /* Keep going if this isn't the final destination */
288                 source = cur->t->dstfmt;
289         }
290
291         AST_RWLIST_UNLOCK(&translators);
292         return head;
293 }
294
295 /*! \brief do the actual translation */
296 struct ast_frame *ast_translate(struct ast_trans_pvt *path, struct ast_frame *f, int consume)
297 {
298         struct ast_trans_pvt *p = path;
299         struct ast_frame *out = f;
300         struct timeval delivery;
301         int has_timing_info;
302         long ts;
303         long len;
304         int seqno;
305
306         has_timing_info = ast_test_flag(f, AST_FRFLAG_HAS_TIMING_INFO);
307         ts = f->ts;
308         len = f->len;
309         seqno = f->seqno;
310
311         /* XXX hmmm... check this below */
312         if (!ast_tvzero(f->delivery)) {
313                 if (!ast_tvzero(path->nextin)) {
314                         /* Make sure this is in line with what we were expecting */
315                         if (!ast_tveq(path->nextin, f->delivery)) {
316                                 /* The time has changed between what we expected and this
317                                    most recent time on the new packet.  If we have a
318                                    valid prediction adjust our output time appropriately */
319                                 if (!ast_tvzero(path->nextout)) {
320                                         path->nextout = ast_tvadd(path->nextout,
321                                                                   ast_tvsub(f->delivery, path->nextin));
322                                 }
323                                 path->nextin = f->delivery;
324                         }
325                 } else {
326                         /* This is our first pass.  Make sure the timing looks good */
327                         path->nextin = f->delivery;
328                         path->nextout = f->delivery;
329                 }
330                 /* Predict next incoming sample */
331                 path->nextin = ast_tvadd(path->nextin, ast_samp2tv(f->samples, ast_format_rate(f->subclass.codec)));
332         }
333         delivery = f->delivery;
334         for ( ; out && p ; p = p->next) {
335                 framein(p, out);
336                 if (out != f)
337                         ast_frfree(out);
338                 out = p->t->frameout(p);
339         }
340         if (consume)
341                 ast_frfree(f);
342         if (out == NULL)
343                 return NULL;
344         /* we have a frame, play with times */
345         if (!ast_tvzero(delivery)) {
346                 /* Regenerate prediction after a discontinuity */
347                 if (ast_tvzero(path->nextout))
348                         path->nextout = ast_tvnow();
349
350                 /* Use next predicted outgoing timestamp */
351                 out->delivery = path->nextout;
352                 
353                 /* Predict next outgoing timestamp from samples in this
354                    frame. */
355                 path->nextout = ast_tvadd(path->nextout, ast_samp2tv(out->samples, ast_format_rate(out->subclass.codec)));
356         } else {
357                 out->delivery = ast_tv(0, 0);
358                 ast_set2_flag(out, has_timing_info, AST_FRFLAG_HAS_TIMING_INFO);
359                 if (has_timing_info) {
360                         out->ts = ts;
361                         out->len = len;
362                         out->seqno = seqno;
363                 }
364         }
365         /* Invalidate prediction if we're entering a silence period */
366         if (out->frametype == AST_FRAME_CNG)
367                 path->nextout = ast_tv(0, 0);
368         return out;
369 }
370
371 /*! \brief compute the cost of a single translation step */
372 static void calc_cost(struct ast_translator *t, int seconds)
373 {
374         int num_samples = 0;
375         struct ast_trans_pvt *pvt;
376         struct rusage start;
377         struct rusage end;
378         int cost;
379         int out_rate = ast_format_rate(t->dstfmt);
380
381         if (!seconds)
382                 seconds = 1;
383         
384         /* If they don't make samples, give them a terrible score */
385         if (!t->sample) {
386                 ast_log(LOG_WARNING, "Translator '%s' does not produce sample frames.\n", t->name);
387                 t->cost = 999999;
388                 return;
389         }
390
391         pvt = newpvt(t);
392         if (!pvt) {
393                 ast_log(LOG_WARNING, "Translator '%s' appears to be broken and will probably fail.\n", t->name);
394                 t->cost = 999999;
395                 return;
396         }
397
398         getrusage(RUSAGE_SELF, &start);
399
400         /* Call the encoder until we've processed the required number of samples */
401         while (num_samples < seconds * out_rate) {
402                 struct ast_frame *f = t->sample();
403                 if (!f) {
404                         ast_log(LOG_WARNING, "Translator '%s' failed to produce a sample frame.\n", t->name);
405                         destroy(pvt);
406                         t->cost = 999999;
407                         return;
408                 }
409                 framein(pvt, f);
410                 ast_frfree(f);
411                 while ((f = t->frameout(pvt))) {
412                         num_samples += f->samples;
413                         ast_frfree(f);
414                 }
415         }
416
417         getrusage(RUSAGE_SELF, &end);
418
419         cost = ((end.ru_utime.tv_sec - start.ru_utime.tv_sec) * 1000000) + end.ru_utime.tv_usec - start.ru_utime.tv_usec;
420         cost += ((end.ru_stime.tv_sec - start.ru_stime.tv_sec) * 1000000) + end.ru_stime.tv_usec - start.ru_stime.tv_usec;
421
422         destroy(pvt);
423
424         t->cost = cost / seconds;
425
426         if (!t->cost)
427                 t->cost = 1;
428 }
429
430 /*!
431  * \brief rebuild a translation matrix.
432  * \note This function expects the list of translators to be locked
433 */
434 static void rebuild_matrix(int samples)
435 {
436         struct ast_translator *t;
437         int x;      /* source format index */
438         int y;      /* intermediate format index */
439         int z;      /* destination format index */
440
441         ast_debug(1, "Resetting translation matrix\n");
442
443         memset(tr_matrix, '\0', sizeof(tr_matrix));
444
445         /* first, compute all direct costs */
446         AST_RWLIST_TRAVERSE(&translators, t, list) {
447                 if (!t->active)
448                         continue;
449
450                 x = t->srcfmt;
451                 z = t->dstfmt;
452
453                 if (samples)
454                         calc_cost(t, samples);
455           
456                 if (!tr_matrix[x][z].step || t->cost < tr_matrix[x][z].cost) {
457                         tr_matrix[x][z].step = t;
458                         tr_matrix[x][z].cost = t->cost;
459                 }
460         }
461
462         /*
463          * For each triple x, y, z of distinct formats, check if there is
464          * a path from x to z through y which is cheaper than what is
465          * currently known, and in case, update the matrix.
466          * Repeat until the matrix is stable.
467          */
468         for (;;) {
469                 int changed = 0;
470                 for (x = 0; x < MAX_FORMAT; x++) {      /* source format */
471                         for (y = 0; y < MAX_FORMAT; y++) {    /* intermediate format */
472                                 if (x == y)                     /* skip ourselves */
473                                         continue;
474
475                                 for (z = 0; z<MAX_FORMAT; z++) {  /* dst format */
476                                         int newcost;
477
478                                         if (z == x || z == y)       /* skip null conversions */
479                                                 continue;
480                                         if (!tr_matrix[x][y].step)  /* no path from x to y */
481                                                 continue;
482                                         if (!tr_matrix[y][z].step)  /* no path from y to z */
483                                                 continue;
484                                         newcost = tr_matrix[x][y].cost + tr_matrix[y][z].cost;
485                                         if (tr_matrix[x][z].step && newcost >= tr_matrix[x][z].cost)
486                                                 continue;               /* x->y->z is more expensive than
487                                                                          * the existing path */
488                                         /* ok, we can get from x to z via y with a cost that
489                                            is the sum of the transition from x to y and
490                                            from y to z */
491                                                  
492                                         tr_matrix[x][z].step = tr_matrix[x][y].step;
493                                         tr_matrix[x][z].cost = newcost;
494                                         tr_matrix[x][z].multistep = 1;
495                                         ast_debug(3, "Discovered %d cost path from %s to %s, via %s\n", tr_matrix[x][z].cost,
496                                                   ast_getformatname(1LL << x), ast_getformatname(1LL << z), ast_getformatname(1LL << y));
497                                         changed++;
498                                 }
499                         }
500                 }
501                 if (!changed)
502                         break;
503         }
504 }
505
506 static char *handle_cli_core_show_translation(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
507 {
508 #define SHOW_TRANS 16
509         int x, y, z;
510         int curlen = 0, longest = 0, magnitude[SHOW_TRANS] = { 0, };
511
512         switch (cmd) {
513         case CLI_INIT:
514                 e->command = "core show translation [recalc]";
515                 e->usage =
516                         "Usage: core show translation [recalc [<recalc seconds>]]\n"
517                         "       Displays known codec translators and the cost associated\n"
518                         "       with each conversion.  If the argument 'recalc' is supplied along\n"
519                         "       with optional number of seconds to test a new test will be performed\n"
520                         "       as the chart is being displayed.\n";
521                 return NULL;
522         case CLI_GENERATE:
523                 return NULL;
524         }
525
526         if (a->argc > 5)
527                 return CLI_SHOWUSAGE;
528
529         if (a->argv[3] && !strcasecmp(a->argv[3], "recalc")) {
530                 z = a->argv[4] ? atoi(a->argv[4]) : 1;
531
532                 if (z <= 0) {
533                         ast_cli(a->fd, "         Recalc must be greater than 0.  Defaulting to 1.\n");
534                         z = 1;
535                 }
536
537                 if (z > MAX_RECALC) {
538                         ast_cli(a->fd, "         Maximum limit of recalc exceeded by %d, truncating value to %d\n", z - MAX_RECALC, MAX_RECALC);
539                         z = MAX_RECALC;
540                 }
541                 ast_cli(a->fd, "         Recalculating Codec Translation (number of sample seconds: %d)\n\n", z);
542                 AST_RWLIST_WRLOCK(&translators);
543                 rebuild_matrix(z);
544                 AST_RWLIST_UNLOCK(&translators);
545         } else if (a->argc > 3)
546                 return CLI_SHOWUSAGE;
547
548         AST_RWLIST_RDLOCK(&translators);
549
550         ast_cli(a->fd, "         Translation times between formats (in microseconds) for one second of data\n");
551         ast_cli(a->fd, "          Source Format (Rows) Destination Format (Columns)\n\n");
552         /* Get the length of the longest (usable?) codec name, so we know how wide the left side should be */
553         for (x = 0; x < SHOW_TRANS; x++) {
554                 curlen = strlen(ast_getformatname(1LL << (x)));
555                 if (curlen > longest)
556                         longest = curlen;
557                 for (y = 0; y < SHOW_TRANS; y++) {
558                         if (tr_matrix[x][y].cost > pow(10, magnitude[x])) {
559                                 magnitude[y] = floor(log10(tr_matrix[x][y].cost));
560                         }
561                 }
562         }
563         for (x = -1; x < SHOW_TRANS; x++) {
564                 struct ast_str *out = ast_str_alloca(125);
565                 /*Go ahead and move to next iteration if dealing with an unknown codec*/
566                 if(x >= 0 && !strcmp(ast_getformatname(1LL << (x)), "unknown"))
567                         continue;
568                 ast_str_set(&out, -1, " ");
569                 for (y = -1; y < SHOW_TRANS; y++) {
570                         /*Go ahead and move to next iteration if dealing with an unknown codec*/
571                         if (y >= 0 && !strcmp(ast_getformatname(1LL << (y)), "unknown"))
572                                 continue;
573                         if (y >= 0)
574                                 curlen = strlen(ast_getformatname(1LL << (y)));
575                         if (y >= 0 && magnitude[y] + 1 > curlen) {
576                                 curlen = magnitude[y] + 1;
577                         }
578                         if (curlen < 5)
579                                 curlen = 5;
580                         if (x >= 0 && y >= 0 && tr_matrix[x][y].step) {
581                                 /* Actual codec output */
582                                 ast_str_append(&out, -1, "%*d", curlen + 1, tr_matrix[x][y].cost);
583                         } else if (x == -1 && y >= 0) {
584                                 /* Top row - use a dynamic size */
585                                 ast_str_append(&out, -1, "%*s", curlen + 1, ast_getformatname(1LL << (y)) );
586                         } else if (y == -1 && x >= 0) {
587                                 /* Left column - use a static size. */
588                                 ast_str_append(&out, -1, "%*s", longest, ast_getformatname(1LL << (x)) );
589                         } else if (x >= 0 && y >= 0) {
590                                 /* Codec not supported */
591                                 ast_str_append(&out, -1, "%*s", curlen + 1, "-");
592                         } else {
593                                 /* Upper left hand corner */
594                                 ast_str_append(&out, -1, "%*s", longest, "");
595                         }
596                 }
597                 ast_str_append(&out, -1, "\n");
598                 ast_cli(a->fd, "%s", ast_str_buffer(out));
599         }
600         AST_RWLIST_UNLOCK(&translators);
601         return CLI_SUCCESS;
602 }
603
604 static struct ast_cli_entry cli_translate[] = {
605         AST_CLI_DEFINE(handle_cli_core_show_translation, "Display translation matrix")
606 };
607
608 /*! \brief register codec translator */
609 int __ast_register_translator(struct ast_translator *t, struct ast_module *mod)
610 {
611         static int added_cli = 0;
612         struct ast_translator *u;
613         char tmp[80];
614
615         if (!mod) {
616                 ast_log(LOG_WARNING, "Missing module pointer, you need to supply one\n");
617                 return -1;
618         }
619
620         if (!t->buf_size) {
621                 ast_log(LOG_WARNING, "empty buf size, you need to supply one\n");
622                 return -1;
623         }
624
625         t->module = mod;
626
627         t->srcfmt = powerof(t->srcfmt);
628         t->dstfmt = powerof(t->dstfmt);
629         t->active = 1;
630
631         if (t->srcfmt == -1 || t->dstfmt == -1) {
632                 ast_log(LOG_WARNING, "Invalid translator path: (%s codec is not valid)\n", t->srcfmt == -1 ? "starting" : "ending");
633                 return -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 %llx\n",
643                                 t->plc_samples, (unsigned long long) 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(1LL << t->srcfmt), ast_getformatname(1LL << t->dstfmt), t->cost);
674
675         if (!added_cli) {
676                 ast_cli_register_multiple(cli_translate, ARRAY_LEN(cli_translate));
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(1LL << t->srcfmt), ast_getformatname(1LL << 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 format_t ast_translator_best_choice(format_t *dst, format_t *srcs)
750 {
751         int x,y;
752         format_t best = -1;
753         format_t bestdst = 0;
754         format_t cur, cursrc;
755         int besttime = INT_MAX;
756         int beststeps = INT_MAX;
757         format_t 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(format_t dest, format_t 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         if (src == -1 || dest == -1) {
805                 ast_log(LOG_WARNING, "No translator path: (%s codec is not valid)\n", src == -1 ? "starting" : "ending");
806                 return -1;
807         }
808         AST_RWLIST_RDLOCK(&translators);
809
810         if (tr_matrix[src][dest].step)
811                 res = tr_matrix[src][dest].multistep + 1;
812
813         AST_RWLIST_UNLOCK(&translators);
814
815         return res;
816 }
817
818 format_t ast_translate_available_formats(format_t dest, format_t src)
819 {
820         format_t res = dest;
821         format_t x;
822         format_t src_audio = src & AST_FORMAT_AUDIO_MASK;
823         format_t src_video = src & AST_FORMAT_VIDEO_MASK;
824
825         /* if we don't have a source format, we just have to try all
826            possible destination formats */
827         if (!src)
828                 return dest;
829
830         /* If we have a source audio format, get its format index */
831         if (src_audio)
832                 src_audio = powerof(src_audio);
833
834         /* If we have a source video format, get its format index */
835         if (src_video)
836                 src_video = powerof(src_video);
837
838         AST_RWLIST_RDLOCK(&translators);
839
840         /* For a given source audio format, traverse the list of
841            known audio formats to determine whether there exists
842            a translation path from the source format to the
843            destination format. */
844         for (x = 1LL; src_audio && x > 0; x <<= 1) {
845                 if (!(x & AST_FORMAT_AUDIO_MASK)) {
846                         continue;
847                 }
848
849                 /* if this is not a desired format, nothing to do */
850                 if (!(dest & x))
851                         continue;
852
853                 /* if the source is supplying this format, then
854                    we can leave it in the result */
855                 if (src & x)
856                         continue;
857
858                 /* if we don't have a translation path from the src
859                    to this format, remove it from the result */
860                 if (!tr_matrix[src_audio][powerof(x)].step) {
861                         res &= ~x;
862                         continue;
863                 }
864
865                 /* now check the opposite direction */
866                 if (!tr_matrix[powerof(x)][src_audio].step)
867                         res &= ~x;
868         }
869
870         /* For a given source video format, traverse the list of
871            known video formats to determine whether there exists
872            a translation path from the source format to the
873            destination format. */
874         for (x = 1LL; src_video && x > 0; x <<= 1) {
875                 if (!(x & AST_FORMAT_VIDEO_MASK)) {
876                         continue;
877                 }
878
879                 /* if this is not a desired format, nothing to do */
880                 if (!(dest & x))
881                         continue;
882
883                 /* if the source is supplying this format, then
884                    we can leave it in the result */
885                 if (src & x)
886                         continue;
887
888                 /* if we don't have a translation path from the src
889                    to this format, remove it from the result */
890                 if (!tr_matrix[src_video][powerof(x)].step) {
891                         res &= ~x;
892                         continue;
893                 }
894
895                 /* now check the opposite direction */
896                 if (!tr_matrix[powerof(x)][src_video].step)
897                         res &= ~x;
898         }
899
900         AST_RWLIST_UNLOCK(&translators);
901
902         return res;
903 }