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