f2aa5886b2d47f2bb14ca394f965e111e2eff784
[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 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 #include <sys/time.h>
33 #include <sys/resource.h>
34 #include <math.h>
35
36 #include "asterisk/lock.h"
37 #include "asterisk/channel.h"
38 #include "asterisk/translate.h"
39 #include "asterisk/module.h"
40 #include "asterisk/frame.h"
41 #include "asterisk/sched.h"
42 #include "asterisk/cli.h"
43 #include "asterisk/term.h"
44 #include "asterisk/format.h"
45 #include "asterisk/linkedlists.h"
46
47 /*! \todo
48  * TODO: sample frames for each supported input format.
49  * We build this on the fly, by taking an SLIN frame and using
50  * the existing converter to play with it.
51  */
52
53 /*! max sample recalc */
54 #define MAX_RECALC 1000
55
56 /*! \brief the list of translators */
57 static AST_RWLIST_HEAD_STATIC(translators, ast_translator);
58
59 struct translator_path {
60         struct ast_translator *step;       /*!< Next step translator */
61         uint32_t table_cost;               /*!< Complete table cost to destination */
62         uint8_t multistep;                 /*!< Multiple conversions required for this translation */
63 };
64
65 /*!
66  * \brief a matrix that, for any pair of supported formats,
67  * indicates the total cost of translation and the first step.
68  * The full path can be reconstricted iterating on the matrix
69  * until step->dstfmt == desired_format.
70  *
71  * Array indexes are 'src' and 'dest', in that order.
72  *
73  * Note: the lock in the 'translators' list is also used to protect
74  * this structure.
75  */
76 static struct translator_path **__matrix;
77
78 /*!
79  * \brief table for converting index to format values.
80  *
81  * \note this table is protected by the table_lock.
82  */
83 static unsigned int *__indextable;
84
85 /*! protects the __indextable for resizing */
86 static ast_rwlock_t tablelock;
87
88 /* index size starts at this*/
89 #define INIT_INDEX 32
90 /* index size grows by this as necessary */
91 #define GROW_INDEX 16
92
93 /*! the current largest index used by the __matrix and __indextable arrays*/
94 static int cur_max_index;
95 /*! the largest index that can be used in either the __indextable or __matrix before resize must occur */
96 static int index_size;
97
98 static void matrix_rebuild(int samples);
99
100 /*!
101  * \internal
102  * \brief converts codec id to index value.
103  */
104 static int codec_to_index(unsigned int id)
105 {
106         int x;
107
108         ast_rwlock_rdlock(&tablelock);
109         for (x = 0; x < cur_max_index; x++) {
110                 if (__indextable[x] == id) {
111                         /* format already exists in index2format table */
112                         ast_rwlock_unlock(&tablelock);
113                         return x;
114                 }
115         }
116         ast_rwlock_unlock(&tablelock);
117         return -1; /* not found */
118 }
119
120 /*!
121  * \internal
122  * \brief converts codec to index value.
123  */
124 static int codec2index(struct ast_codec *codec)
125 {
126         return codec_to_index(codec->id);
127 }
128
129 /*!
130  * \internal
131  * \brief converts format to codec index value.
132  */
133 static int format2index(struct ast_format *format)
134 {
135         return codec_to_index(ast_format_get_codec_id(format));
136 }
137
138 /*!
139  * \internal
140  * \brief add a new codec to the matrix and index table structures.
141  *
142  * \note it is perfectly safe to call this on codecs already indexed.
143  *
144  * \retval 0, success
145  * \retval -1, matrix and index table need to be resized
146  */
147 static int add_codec2index(struct ast_codec *codec)
148 {
149         if (codec2index(codec) != -1) {
150                 /* format is already already indexed */
151                 return 0;
152         }
153
154         ast_rwlock_wrlock(&tablelock);
155         if (cur_max_index == (index_size)) {
156                 ast_rwlock_unlock(&tablelock);
157                 return -1; /* hit max length */
158         }
159         __indextable[cur_max_index] = codec->id;
160         cur_max_index++;
161         ast_rwlock_unlock(&tablelock);
162
163         return 0;
164 }
165
166 /*!
167  * \internal
168  * \brief converts index value back to codec
169  */
170 static struct ast_codec *index2codec(int index)
171 {
172         struct ast_codec *codec;
173
174         if (index >= cur_max_index) {
175                 return 0;
176         }
177         ast_rwlock_rdlock(&tablelock);
178         codec = ast_codec_get_by_id(__indextable[index]);
179         ast_rwlock_unlock(&tablelock);
180
181         return codec;
182 }
183
184 /*!
185  * \internal
186  * \brief resize both the matrix and index table so they can represent
187  * more translators
188  *
189  * \note _NO_ locks can be held prior to calling this function
190  *
191  * \retval 0, success
192  * \retval -1, failure.  Old matrix and index table can still be used though
193  */
194 static int matrix_resize(int init)
195 {
196         struct translator_path **tmp_matrix = NULL;
197         unsigned int *tmp_table = NULL;
198         int old_index;
199         int x;
200
201         AST_RWLIST_WRLOCK(&translators);
202         ast_rwlock_wrlock(&tablelock);
203
204         old_index = index_size;
205         if (init) {
206                 index_size += INIT_INDEX;
207         } else {
208                 index_size += GROW_INDEX;
209         }
210
211         /* make new 2d array of translator_path structures */
212         if (!(tmp_matrix = ast_calloc(1, sizeof(struct translator_path *) * (index_size)))) {
213                 goto resize_cleanup;
214         }
215
216         for (x = 0; x < index_size; x++) {
217                 if (!(tmp_matrix[x] = ast_calloc(1, sizeof(struct translator_path) * (index_size)))) {
218                         goto resize_cleanup;
219                 }
220         }
221
222         /* make new index table */
223         if (!(tmp_table = ast_calloc(1, sizeof(unsigned int) * index_size))) {
224                 goto resize_cleanup;
225         }
226
227         /* if everything went well this far, free the old and use the new */
228         if (!init) {
229                 for (x = 0; x < old_index; x++) {
230                         ast_free(__matrix[x]);
231                 }
232                 ast_free(__matrix);
233
234                 memcpy(tmp_table, __indextable, sizeof(unsigned int) * old_index);
235                 ast_free(__indextable);
236         }
237
238         /* now copy them over */
239         __matrix = tmp_matrix;
240         __indextable = tmp_table;
241
242         matrix_rebuild(0);
243         ast_rwlock_unlock(&tablelock);
244         AST_RWLIST_UNLOCK(&translators);
245
246         return 0;
247
248 resize_cleanup:
249         ast_rwlock_unlock(&tablelock);
250         AST_RWLIST_UNLOCK(&translators);
251         if (tmp_matrix) {
252                 for (x = 0; x < index_size; x++) {
253                         ast_free(tmp_matrix[x]);
254                 }
255                 ast_free(tmp_matrix);
256         }
257         ast_free(tmp_table);
258
259         return -1;
260 }
261
262 /*!
263  * \internal
264  * \brief reinitialize the __matrix during matrix rebuild
265  *
266  * \note must be protected by the translators list lock
267  */
268 static void matrix_clear(void)
269 {
270         int x;
271         for (x = 0; x < index_size; x++) {
272                 memset(__matrix[x], '\0', sizeof(struct translator_path) * (index_size));
273         }
274 }
275
276 /*!
277  * \internal
278  * \brief get a matrix entry
279  *
280  * \note This function must be protected by the translators list lock
281  */
282 static struct translator_path *matrix_get(unsigned int x, unsigned int y)
283 {
284         return __matrix[x] + y;
285 }
286
287 /*
288  * wrappers around the translator routines.
289  */
290
291 static void destroy(struct ast_trans_pvt *pvt)
292 {
293         struct ast_translator *t = pvt->t;
294
295         if (t->destroy) {
296                 t->destroy(pvt);
297         }
298         ao2_cleanup(pvt->f.subclass.format);
299         if (pvt->explicit_dst) {
300                 ao2_ref(pvt->explicit_dst, -1);
301                 pvt->explicit_dst = NULL;
302         }
303         ast_free(pvt);
304         ast_module_unref(t->module);
305 }
306
307 /*!
308  * \brief Allocate the descriptor, required outbuf space,
309  * and possibly desc.
310  */
311 static struct ast_trans_pvt *newpvt(struct ast_translator *t, struct ast_format *explicit_dst)
312 {
313         struct ast_trans_pvt *pvt;
314         int len;
315         char *ofs;
316
317         /*
318          * compute the required size adding private descriptor,
319          * buffer, AST_FRIENDLY_OFFSET.
320          */
321         len = sizeof(*pvt) + t->desc_size;
322         if (t->buf_size)
323                 len += AST_FRIENDLY_OFFSET + t->buf_size;
324         pvt = ast_calloc(1, len);
325         if (!pvt) {
326                 return NULL;
327         }
328         pvt->t = t;
329         ofs = (char *)(pvt + 1);        /* pointer to data space */
330         if (t->desc_size) {             /* first comes the descriptor */
331                 pvt->pvt = ofs;
332                 ofs += t->desc_size;
333         }
334         if (t->buf_size) {/* finally buffer and header */
335                 pvt->outbuf.c = ofs + AST_FRIENDLY_OFFSET;
336         }
337         /*
338          * If the format has an attribute module, explicit_dst includes the (joined)
339          * result of the SDP negotiation. For example with the Opus Codec, the format
340          * knows whether both parties want to do forward-error correction (FEC).
341          */
342         pvt->explicit_dst = ao2_bump(explicit_dst);
343
344         ast_module_ref(t->module);
345
346         /* call local init routine, if present */
347         if (t->newpvt && t->newpvt(pvt)) {
348                 ast_free(pvt);
349                 ast_module_unref(t->module);
350                 return NULL;
351         }
352
353         /* Setup normal static translation frame. */
354         pvt->f.frametype = AST_FRAME_VOICE;
355         pvt->f.mallocd = 0;
356         pvt->f.offset = AST_FRIENDLY_OFFSET;
357         pvt->f.src = pvt->t->name;
358         pvt->f.data.ptr = pvt->outbuf.c;
359
360         /*
361          * If the translator has not provided a format
362          * A) use the joined one,
363          * B) use the cached one, or
364          * C) create one.
365          */
366         if (!pvt->f.subclass.format) {
367                 pvt->f.subclass.format = ao2_bump(pvt->explicit_dst);
368
369                 if (!pvt->f.subclass.format && !ast_strlen_zero(pvt->t->format)) {
370                         pvt->f.subclass.format = ast_format_cache_get(pvt->t->format);
371                 }
372
373                 if (!pvt->f.subclass.format) {
374                         struct ast_codec *codec = ast_codec_get(t->dst_codec.name,
375                                 t->dst_codec.type, t->dst_codec.sample_rate);
376                         if (!codec) {
377                                 ast_log(LOG_ERROR, "Unable to get destination codec\n");
378                                 destroy(pvt);
379                                 return NULL;
380                         }
381                         pvt->f.subclass.format = ast_format_create(codec);
382                         ao2_ref(codec, -1);
383                 }
384
385                 if (!pvt->f.subclass.format) {
386                         ast_log(LOG_ERROR, "Unable to create format\n");
387                         destroy(pvt);
388                         return NULL;
389                 }
390         }
391
392         return pvt;
393 }
394
395 /*! \brief framein wrapper, deals with bound checks.  */
396 static int framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
397 {
398         /* Copy the last in jb timing info to the pvt */
399         ast_copy_flags(&pvt->f, f, AST_FRFLAG_HAS_TIMING_INFO);
400         pvt->f.ts = f->ts;
401         pvt->f.len = f->len;
402         pvt->f.seqno = f->seqno;
403
404         if (f->samples == 0) {
405                 ast_log(LOG_WARNING, "no samples for %s\n", pvt->t->name);
406         }
407         if (pvt->t->buffer_samples) {   /* do not pass empty frames to callback */
408                 if (f->datalen == 0) { /* perform native PLC if available */
409                         /* If the codec has native PLC, then do that */
410                         if (!pvt->t->native_plc)
411                                 return 0;
412                 }
413                 if (pvt->samples + f->samples > pvt->t->buffer_samples) {
414                         ast_log(LOG_WARNING, "Out of buffer space\n");
415                         return -1;
416                 }
417         }
418         /* we require a framein routine, wouldn't know how to do
419          * it otherwise.
420          */
421         return pvt->t->framein(pvt, f);
422 }
423
424 /*! \brief generic frameout routine.
425  * If samples and datalen are 0, take whatever is in pvt
426  * and reset them, otherwise take the values in the caller and
427  * leave alone the pvt values.
428  */
429 struct ast_frame *ast_trans_frameout(struct ast_trans_pvt *pvt,
430         int datalen, int samples)
431 {
432         struct ast_frame *f = &pvt->f;
433
434         if (samples) {
435                 f->samples = samples;
436         } else {
437                 if (pvt->samples == 0) {
438                         return NULL;
439                 }
440                 f->samples = pvt->samples;
441                 pvt->samples = 0;
442         }
443         if (datalen) {
444                 f->datalen = datalen;
445                 f->data.ptr = pvt->outbuf.c;
446         } else {
447                 f->datalen = pvt->datalen;
448                 if (!f->datalen) {
449                         f->data.ptr = NULL;
450                 } else {
451                         f->data.ptr = pvt->outbuf.c;
452                 }
453                 pvt->datalen = 0;
454         }
455
456         return ast_frisolate(f);
457 }
458
459 static struct ast_frame *default_frameout(struct ast_trans_pvt *pvt)
460 {
461         return ast_trans_frameout(pvt, 0, 0);
462 }
463
464 /* end of callback wrappers and helpers */
465
466 void ast_translator_free_path(struct ast_trans_pvt *p)
467 {
468         struct ast_trans_pvt *pn = p;
469         while ( (p = pn) ) {
470                 pn = p->next;
471                 destroy(p);
472         }
473 }
474
475 /*! \brief Build a chain of translators based upon the given source and dest formats */
476 struct ast_trans_pvt *ast_translator_build_path(struct ast_format *dst, struct ast_format *src)
477 {
478         struct ast_trans_pvt *head = NULL, *tail = NULL;
479         int src_index, dst_index;
480
481         src_index = format2index(src);
482         dst_index = format2index(dst);
483
484         if (src_index < 0 || dst_index < 0) {
485                 ast_log(LOG_WARNING, "No translator path: (%s codec is not valid)\n", src_index < 0 ? "starting" : "ending");
486                 return NULL;
487         }
488
489         AST_RWLIST_RDLOCK(&translators);
490
491         while (src_index != dst_index) {
492                 struct ast_trans_pvt *cur;
493                 struct ast_format *explicit_dst = NULL;
494                 struct ast_translator *t = matrix_get(src_index, dst_index)->step;
495                 if (!t) {
496                         ast_log(LOG_WARNING, "No translator path from %s to %s\n",
497                                 ast_format_get_name(src), ast_format_get_name(dst));
498                         AST_RWLIST_UNLOCK(&translators);
499                         return NULL;
500                 }
501                 if ((t->dst_codec.sample_rate == ast_format_get_sample_rate(dst)) && (t->dst_codec.type == ast_format_get_type(dst))) {
502                         explicit_dst = dst;
503                 }
504                 if (!(cur = newpvt(t, explicit_dst))) {
505                         ast_log(LOG_WARNING, "Failed to build translator step from %s to %s\n",
506                                 ast_format_get_name(src), ast_format_get_name(dst));
507                         if (head) {
508                                 ast_translator_free_path(head);
509                         }
510                         AST_RWLIST_UNLOCK(&translators);
511                         return NULL;
512                 }
513                 if (!head) {
514                         head = cur;
515                 } else {
516                         tail->next = cur;
517                 }
518                 tail = cur;
519                 cur->nextin = cur->nextout = ast_tv(0, 0);
520                 /* Keep going if this isn't the final destination */
521                 src_index = cur->t->dst_fmt_index;
522         }
523
524         AST_RWLIST_UNLOCK(&translators);
525         return head;
526 }
527
528 /*! \brief do the actual translation */
529 struct ast_frame *ast_translate(struct ast_trans_pvt *path, struct ast_frame *f, int consume)
530 {
531         struct ast_trans_pvt *p = path;
532         struct ast_frame *out;
533         struct timeval delivery;
534         int has_timing_info;
535         long ts;
536         long len;
537         int seqno;
538
539         if (f->frametype == AST_FRAME_RTCP) {
540                 /* Just pass the feedback to the right callback, if it exists.
541                  * This "translation" does nothing so return a null frame. */
542                 struct ast_trans_pvt *tp;
543                 for (tp = p; tp; tp = tp->next) {
544                         if (tp->t->feedback)
545                                 tp->t->feedback(tp, f);
546                 }
547                 return &ast_null_frame;
548         }
549
550         has_timing_info = ast_test_flag(f, AST_FRFLAG_HAS_TIMING_INFO);
551         ts = f->ts;
552         len = f->len;
553         seqno = f->seqno;
554
555         if (!ast_tvzero(f->delivery)) {
556                 if (!ast_tvzero(path->nextin)) {
557                         /* Make sure this is in line with what we were expecting */
558                         if (!ast_tveq(path->nextin, f->delivery)) {
559                                 /* The time has changed between what we expected and this
560                                    most recent time on the new packet.  If we have a
561                                    valid prediction adjust our output time appropriately */
562                                 if (!ast_tvzero(path->nextout)) {
563                                         path->nextout = ast_tvadd(path->nextout,
564                                                                   ast_tvsub(f->delivery, path->nextin));
565                                 }
566                                 path->nextin = f->delivery;
567                         }
568                 } else {
569                         /* This is our first pass.  Make sure the timing looks good */
570                         path->nextin = f->delivery;
571                         path->nextout = f->delivery;
572                 }
573                 /* Predict next incoming sample */
574                 path->nextin = ast_tvadd(path->nextin, ast_samp2tv(
575                          f->samples, ast_format_get_sample_rate(f->subclass.format)));
576         }
577         delivery = f->delivery;
578         for (out = f; out && p ; p = p->next) {
579                 struct ast_frame *current = out;
580
581                 do {
582                         framein(p, current);
583                         current = AST_LIST_NEXT(current, frame_list);
584                 } while (current);
585                 if (out != f) {
586                         ast_frfree(out);
587                 }
588                 out = p->t->frameout(p);
589         }
590         if (out) {
591                 /* we have a frame, play with times */
592                 if (!ast_tvzero(delivery)) {
593                         struct ast_frame *current = out;
594
595                         do {
596                                 /* Regenerate prediction after a discontinuity */
597                                 if (ast_tvzero(path->nextout)) {
598                                         path->nextout = ast_tvnow();
599                                 }
600
601                                 /* Use next predicted outgoing timestamp */
602                                 current->delivery = path->nextout;
603
604                                 /* Invalidate prediction if we're entering a silence period */
605                                 if (current->frametype == AST_FRAME_CNG) {
606                                         path->nextout = ast_tv(0, 0);
607                                 /* Predict next outgoing timestamp from samples in this
608                                    frame. */
609                                 } else {
610                                         path->nextout = ast_tvadd(path->nextout, ast_samp2tv(
611                                                 current->samples, ast_format_get_sample_rate(current->subclass.format)));
612                                 }
613
614                                 if (f->samples != current->samples && ast_test_flag(current, AST_FRFLAG_HAS_TIMING_INFO)) {
615                                         ast_debug(4, "Sample size different %d vs %d\n", f->samples, current->samples);
616                                         ast_clear_flag(current, AST_FRFLAG_HAS_TIMING_INFO);
617                                 }
618                                 current = AST_LIST_NEXT(current, frame_list);
619                         } while (current);
620                 } else {
621                         out->delivery = ast_tv(0, 0);
622                         ast_set2_flag(out, has_timing_info, AST_FRFLAG_HAS_TIMING_INFO);
623                         if (has_timing_info) {
624                                 out->ts = ts;
625                                 out->len = len;
626                                 out->seqno = seqno;
627                         }
628                         /* Invalidate prediction if we're entering a silence period */
629                         if (out->frametype == AST_FRAME_CNG) {
630                                 path->nextout = ast_tv(0, 0);
631                         }
632                 }
633         }
634         if (consume) {
635                 ast_frfree(f);
636         }
637         return out;
638 }
639
640 /*!
641  * \internal
642  * \brief Compute the computational cost of a single translation step.
643  *
644  * \note This function is only used to decide which translation path to
645  * use between two translators with identical src and dst formats.  Computational
646  * cost acts only as a tie breaker. This is done so hardware translators
647  * can naturally have precedence over software translators.
648  */
649 static void generate_computational_cost(struct ast_translator *t, int seconds)
650 {
651         int num_samples = 0;
652         struct ast_trans_pvt *pvt;
653         struct rusage start;
654         struct rusage end;
655         int cost;
656         int out_rate = t->dst_codec.sample_rate;
657
658         if (!seconds) {
659                 seconds = 1;
660         }
661
662         /* If they don't make samples, give them a terrible score */
663         if (!t->sample) {
664                 ast_debug(3, "Translator '%s' does not produce sample frames.\n", t->name);
665                 t->comp_cost = 999999;
666                 return;
667         }
668
669         pvt = newpvt(t, NULL);
670         if (!pvt) {
671                 ast_log(LOG_WARNING, "Translator '%s' appears to be broken and will probably fail.\n", t->name);
672                 t->comp_cost = 999999;
673                 return;
674         }
675
676         getrusage(RUSAGE_SELF, &start);
677
678         /* Call the encoder until we've processed the required number of samples */
679         while (num_samples < seconds * out_rate) {
680                 struct ast_frame *f = t->sample();
681                 if (!f) {
682                         ast_log(LOG_WARNING, "Translator '%s' failed to produce a sample frame.\n", t->name);
683                         destroy(pvt);
684                         t->comp_cost = 999999;
685                         return;
686                 }
687                 framein(pvt, f);
688                 ast_frfree(f);
689                 while ((f = t->frameout(pvt))) {
690                         num_samples += f->samples;
691                         ast_frfree(f);
692                 }
693         }
694
695         getrusage(RUSAGE_SELF, &end);
696
697         cost = ((end.ru_utime.tv_sec - start.ru_utime.tv_sec) * 1000000) + end.ru_utime.tv_usec - start.ru_utime.tv_usec;
698         cost += ((end.ru_stime.tv_sec - start.ru_stime.tv_sec) * 1000000) + end.ru_stime.tv_usec - start.ru_stime.tv_usec;
699
700         destroy(pvt);
701
702         t->comp_cost = cost / seconds;
703
704         if (!t->comp_cost) {
705                 t->comp_cost = 1;
706         }
707 }
708
709 /*!
710  * \internal
711  *
712  * \brief If no table cost value was pre set by the translator.  An attempt is made to
713  * automatically generate that cost value from the cost table based on our src and
714  * dst formats.
715  *
716  * \note This function allows older translators built before the translation cost
717  * changed away from using onely computational time to continue to be registered
718  * correctly.  It is expected that translators built after the introduction of this
719  * function will manually assign their own table cost value.
720  *
721  * \note This function is safe to use on any audio formats that used to be defined in the
722  * first 64 bits of the old bit field codec representation.
723  *
724  * \retval Table Cost value greater than 0.
725  * \retval 0 on error.
726  */
727 static int generate_table_cost(struct ast_codec *src, struct ast_codec *dst)
728 {
729         int src_rate = src->sample_rate;
730         int src_ll = 0;
731         int dst_rate = dst->sample_rate;
732         int dst_ll = 0;
733
734         if ((src->type != AST_MEDIA_TYPE_AUDIO) ||
735             (dst->type != AST_MEDIA_TYPE_AUDIO)) {
736                 /* This method of generating table cost is limited to audio.
737                  * Translators for media other than audio must manually set their
738                  * table cost. */
739                 return 0;
740         }
741
742         src_ll = !strcmp(src->name, "slin");
743         dst_ll = !strcmp(dst->name, "slin");
744         if (src_ll) {
745                 if (dst_ll && (src_rate == dst_rate)) {
746                         return AST_TRANS_COST_LL_LL_ORIGSAMP;
747                 } else if (!dst_ll && (src_rate == dst_rate)) {
748                         return AST_TRANS_COST_LL_LY_ORIGSAMP;
749                 } else if (dst_ll && (src_rate < dst_rate)) {
750                         return AST_TRANS_COST_LL_LL_UPSAMP;
751                 } else if (!dst_ll && (src_rate < dst_rate)) {
752                         return AST_TRANS_COST_LL_LY_UPSAMP;
753                 } else if (dst_ll && (src_rate > dst_rate)) {
754                         return AST_TRANS_COST_LL_LL_DOWNSAMP;
755                 } else if (!dst_ll && (src_rate > dst_rate)) {
756                         return AST_TRANS_COST_LL_LY_DOWNSAMP;
757                 } else {
758                         return AST_TRANS_COST_LL_UNKNOWN;
759                 }
760         } else {
761                 if (dst_ll && (src_rate == dst_rate)) {
762                         return AST_TRANS_COST_LY_LL_ORIGSAMP;
763                 } else if (!dst_ll && (src_rate == dst_rate)) {
764                         return AST_TRANS_COST_LY_LY_ORIGSAMP;
765                 } else if (dst_ll && (src_rate < dst_rate)) {
766                         return AST_TRANS_COST_LY_LL_UPSAMP;
767                 } else if (!dst_ll && (src_rate < dst_rate)) {
768                         return AST_TRANS_COST_LY_LY_UPSAMP;
769                 } else if (dst_ll && (src_rate > dst_rate)) {
770                         return AST_TRANS_COST_LY_LL_DOWNSAMP;
771                 } else if (!dst_ll && (src_rate > dst_rate)) {
772                         return AST_TRANS_COST_LY_LY_DOWNSAMP;
773                 } else {
774                         return AST_TRANS_COST_LY_UNKNOWN;
775                 }
776         }
777 }
778
779 /*!
780  * \brief rebuild a translation matrix.
781  * \note This function expects the list of translators to be locked
782 */
783 static void matrix_rebuild(int samples)
784 {
785         struct ast_translator *t;
786         int newtablecost;
787         int x;      /* source format index */
788         int y;      /* intermediate format index */
789         int z;      /* destination format index */
790
791         ast_debug(1, "Resetting translation matrix\n");
792
793         matrix_clear();
794
795         /* first, compute all direct costs */
796         AST_RWLIST_TRAVERSE(&translators, t, list) {
797                 if (!t->active) {
798                         continue;
799                 }
800
801                 x = t->src_fmt_index;
802                 z = t->dst_fmt_index;
803
804                 if (samples) {
805                         generate_computational_cost(t, samples);
806                 }
807
808                 /* This new translator is the best choice if any of the below are true.
809                  * 1. no translation path is set between x and z yet.
810                  * 2. the new table cost is less.
811                  * 3. the new computational cost is less.  Computational cost is only used
812                  *    to break a tie between two identical translation paths.
813                  */
814                 if (!matrix_get(x, z)->step ||
815                         (t->table_cost < matrix_get(x, z)->step->table_cost) ||
816                         (t->comp_cost < matrix_get(x, z)->step->comp_cost)) {
817
818                         matrix_get(x, z)->step = t;
819                         matrix_get(x, z)->table_cost = t->table_cost;
820                 }
821         }
822
823         /*
824          * For each triple x, y, z of distinct formats, check if there is
825          * a path from x to z through y which is cheaper than what is
826          * currently known, and in case, update the matrix.
827          * Repeat until the matrix is stable.
828          */
829         for (;;) {
830                 int changed = 0;
831                 for (x = 0; x < cur_max_index; x++) {      /* source format */
832                         for (y = 0; y < cur_max_index; y++) {  /* intermediate format */
833                                 if (x == y) {                      /* skip ourselves */
834                                         continue;
835                                 }
836                                 for (z = 0; z < cur_max_index; z++) {  /* dst format */
837                                         if ((z == x || z == y) ||        /* skip null conversions */
838                                                 !matrix_get(x, y)->step ||   /* no path from x to y */
839                                                 !matrix_get(y, z)->step) {   /* no path from y to z */
840                                                 continue;
841                                         }
842
843                                         /* calculate table cost from x->y->z */
844                                         newtablecost = matrix_get(x, y)->table_cost + matrix_get(y, z)->table_cost;
845
846                                         /* if no step already exists between x and z OR the new cost of using the intermediate
847                                          * step is cheaper, use this step. */
848                                         if (!matrix_get(x, z)->step || (newtablecost < matrix_get(x, z)->table_cost)) {
849                                                 matrix_get(x, z)->step = matrix_get(x, y)->step;
850                                                 matrix_get(x, z)->table_cost = newtablecost;
851                                                 matrix_get(x, z)->multistep = 1;
852                                                 changed++;
853
854                                                 if (DEBUG_ATLEAST(10)) {
855                                                         struct ast_codec *x_codec = index2codec(x);
856                                                         struct ast_codec *y_codec = index2codec(y);
857                                                         struct ast_codec *z_codec = index2codec(z);
858
859                                                         ast_log(LOG_DEBUG,
860                                                                 "Discovered %u cost path from %s to %s, via %s\n",
861                                                                 matrix_get(x, z)->table_cost, x_codec->name,
862                                                                 y_codec->name, z_codec->name);
863
864                                                         ao2_ref(x_codec, -1);
865                                                         ao2_ref(y_codec, -1);
866                                                         ao2_ref(z_codec, -1);
867                                                 }
868                                         }
869                                 }
870                         }
871                 }
872                 if (!changed) {
873                         break;
874                 }
875         }
876 }
877
878 static void codec_append_name(const struct ast_codec *codec, struct ast_str **buf)
879 {
880         if (codec) {
881                 ast_str_append(buf, 0, "(%s@%u)", codec->name, codec->sample_rate);
882         } else {
883                 ast_str_append(buf, 0, "(nothing)");
884         }
885 }
886
887 const char *ast_translate_path_to_str(struct ast_trans_pvt *p, struct ast_str **str)
888 {
889         if (!p || !p->t) {
890                 return "";
891         }
892
893         ast_str_reset(*str);
894         codec_append_name(&p->t->src_codec, str);
895         while (p) {
896                 ast_str_append(str, 0, "->");
897                 codec_append_name(&p->t->dst_codec, str);
898                 p = p->next;
899         }
900
901         return ast_str_buffer(*str);
902 }
903
904 static char *complete_trans_path_choice(const char *line, const char *word, int pos, int state)
905 {
906         int i = 1, which = 0;
907         int wordlen = strlen(word);
908         struct ast_codec *codec;
909
910         while ((codec = ast_codec_get_by_id(i))) {
911                 ++i;
912                 if (codec->type != AST_MEDIA_TYPE_AUDIO) {
913                         ao2_ref(codec, -1);
914                         continue;
915                 }
916                 if (!strncasecmp(word, codec->name, wordlen) && ++which > state) {
917                         char *res = ast_strdup(codec->name);
918                         ao2_ref(codec, -1);
919                         return res;
920                 }
921                 ao2_ref(codec, -1);
922         }
923         return NULL;
924 }
925
926 static void handle_cli_recalc(struct ast_cli_args *a)
927 {
928         int time = a->argv[4] ? atoi(a->argv[4]) : 1;
929
930         if (time <= 0) {
931                 ast_cli(a->fd, "         Recalc must be greater than 0.  Defaulting to 1.\n");
932                 time = 1;
933         }
934
935         if (time > MAX_RECALC) {
936                 ast_cli(a->fd, "         Maximum limit of recalc exceeded by %d, truncating value to %d\n", time - MAX_RECALC, MAX_RECALC);
937                 time = MAX_RECALC;
938         }
939         ast_cli(a->fd, "         Recalculating Codec Translation (number of sample seconds: %d)\n\n", time);
940         AST_RWLIST_WRLOCK(&translators);
941         matrix_rebuild(time);
942         AST_RWLIST_UNLOCK(&translators);
943 }
944
945 static char *handle_show_translation_table(struct ast_cli_args *a)
946 {
947         int x, y, i, k;
948         int longest = 0, num_codecs = 0, curlen = 0;
949         struct ast_str *out = ast_str_create(1024);
950         struct ast_codec *codec;
951
952         /* Get the length of the longest (usable?) codec name,
953            so we know how wide the left side should be */
954         for (i = 1; (codec = ast_codec_get_by_id(i)); ao2_ref(codec, -1), ++i) {
955                 ++num_codecs;
956                 if (codec->type != AST_MEDIA_TYPE_AUDIO) {
957                         continue;
958                 }
959                 curlen = strlen(codec->name);
960                 if (curlen > longest) {
961                         longest = curlen;
962                 }
963         }
964
965         AST_RWLIST_RDLOCK(&translators);
966         ast_cli(a->fd, "         Translation times between formats (in microseconds) for one second of data\n");
967         ast_cli(a->fd, "          Source Format (Rows) Destination Format (Columns)\n\n");
968
969         for (i = 0; i < num_codecs; i++) {
970                 struct ast_codec *row = i ? ast_codec_get_by_id(i) : NULL;
971
972                 x = -1;
973                 if ((i > 0) && (row->type != AST_MEDIA_TYPE_AUDIO)) {
974                         ao2_ref(row, -1);
975                         continue;
976                 }
977
978                 if ((i > 0) && (x = codec2index(row)) == -1) {
979                         ao2_ref(row, -1);
980                         continue;
981                 }
982
983                 ast_str_set(&out, 0, " ");
984                 for (k = 0; k < num_codecs; k++) {
985                         struct ast_codec *col = k ? ast_codec_get_by_id(k) : NULL;
986
987                         y = -1;
988                         if ((k > 0) && (col->type != AST_MEDIA_TYPE_AUDIO)) {
989                                 ao2_ref(col, -1);
990                                 continue;
991                         }
992
993                         if ((k > 0) && (y = codec2index(col)) == -1) {
994                                 ao2_ref(col, -1);
995                                 continue;
996                         }
997
998                         if (k > 0) {
999                                 curlen = strlen(col->name);
1000                         }
1001
1002                         if (curlen < 5) {
1003                                 curlen = 5;
1004                         }
1005
1006                         if (x >= 0 && y >= 0 && matrix_get(x, y)->step) {
1007                                 /* Actual codec output */
1008                                 ast_str_append(&out, 0, "%*u", curlen + 1, (matrix_get(x, y)->table_cost/100));
1009                         } else if (i == 0 && k > 0) {
1010                                 /* Top row - use a dynamic size */
1011                                 ast_str_append(&out, 0, "%*s", curlen + 1, col->name);
1012                         } else if (k == 0 && i > 0) {
1013                                 /* Left column - use a static size. */
1014                                 ast_str_append(&out, 0, "%*s", longest, row->name);
1015                         } else if (x >= 0 && y >= 0) {
1016                                 /* Codec not supported */
1017                                 ast_str_append(&out, 0, "%*s", curlen + 1, "-");
1018                         } else {
1019                                 /* Upper left hand corner */
1020                                 ast_str_append(&out, 0, "%*s", longest, "");
1021                         }
1022                         ao2_cleanup(col);
1023                 }
1024                 ast_str_append(&out, 0, "\n");
1025                 ast_cli(a->fd, "%s", ast_str_buffer(out));
1026                 ao2_cleanup(row);
1027         }
1028         ast_free(out);
1029         AST_RWLIST_UNLOCK(&translators);
1030         return CLI_SUCCESS;
1031 }
1032
1033 static char *handle_show_translation_path(struct ast_cli_args *a, const char *codec_name, unsigned int sample_rate)
1034 {
1035         int i = 1;
1036         struct ast_str *str = ast_str_alloca(1024);
1037         struct ast_translator *step;
1038         struct ast_codec *dst_codec;
1039         struct ast_codec *src_codec = ast_codec_get(codec_name, AST_MEDIA_TYPE_AUDIO, sample_rate);
1040
1041         if (!src_codec) {
1042                 ast_cli(a->fd, "Source codec \"%s\" is not found.\n", codec_name);
1043                 return CLI_FAILURE;
1044         }
1045
1046         AST_RWLIST_RDLOCK(&translators);
1047         ast_cli(a->fd, "--- Translation paths SRC Codec \"%s\" sample rate %u ---\n",
1048                 codec_name, src_codec->sample_rate);
1049
1050         while ((dst_codec = ast_codec_get_by_id(i))) {
1051                 int src, dst;
1052                 char src_buffer[64];
1053                 char dst_buffer[64];
1054
1055                 ++i;
1056                 if (src_codec == dst_codec ||
1057                     dst_codec->type != AST_MEDIA_TYPE_AUDIO) {
1058                         ao2_ref(dst_codec, -1);
1059                         continue;
1060                 }
1061
1062                 dst = codec2index(dst_codec);
1063                 src = codec2index(src_codec);
1064
1065                 if (src < 0 || dst < 0) {
1066                         ast_str_set(&str, 0, "No Translation Path");
1067                 } else {
1068                         step = matrix_get(src, dst)->step;
1069
1070                         if (step) {
1071                                 codec_append_name(&step->src_codec, &str);
1072                                 while (src != dst) {
1073                                         src = step->dst_fmt_index;
1074                                         step = matrix_get(src, dst)->step;
1075                                         if (!step) {
1076                                                 ast_str_append(&str, 0, "->");
1077                                                 codec_append_name(dst_codec, &str);
1078                                                 break;
1079                                         }
1080                                         ast_str_append(&str, 0, "->");
1081                                         codec_append_name(&step->src_codec, &str);
1082                                 }
1083                         }
1084                 }
1085
1086                 snprintf(src_buffer, sizeof(src_buffer), "%s:%u", src_codec->name, src_codec->sample_rate);
1087                 snprintf(dst_buffer, sizeof(dst_buffer), "%s:%u", dst_codec->name, dst_codec->sample_rate);
1088                 ast_cli(a->fd, "\t%-16.16s To %-16.16s: %-60.60s\n",
1089                         src_buffer, dst_buffer, ast_str_buffer(str));
1090                 ast_str_reset(str);
1091                 ao2_ref(dst_codec, -1);
1092         }
1093         AST_RWLIST_UNLOCK(&translators);
1094         ao2_ref(src_codec, -1);
1095         return CLI_SUCCESS;
1096 }
1097
1098 static char *handle_cli_core_show_translation(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1099 {
1100         static const char * const option[] = { "recalc", "paths", NULL };
1101
1102         switch (cmd) {
1103         case CLI_INIT:
1104                 e->command = "core show translation";
1105                 e->usage =
1106                         "Usage: 'core show translation' can be used in two ways.\n"
1107                         "       1. 'core show translation [recalc [<recalc seconds>]]\n"
1108                         "          Displays known codec translators and the cost associated\n"
1109                         "          with each conversion.  If the argument 'recalc' is supplied along\n"
1110                         "          with optional number of seconds to test a new test will be performed\n"
1111                         "          as the chart is being displayed.\n"
1112                         "       2. 'core show translation paths [codec [sample_rate]]'\n"
1113                         "           This will display all the translation paths associated with a codec.\n"
1114                         "           If a codec has multiple sample rates, the sample rate must be\n"
1115                         "           provided as well.\n";
1116                 return NULL;
1117         case CLI_GENERATE:
1118                 if (a->pos == 3) {
1119                         return ast_cli_complete(a->word, option, a->n);
1120                 }
1121                 if (a->pos == 4 && !strcasecmp(a->argv[3], option[1])) {
1122                         return complete_trans_path_choice(a->line, a->word, a->pos, a->n);
1123                 }
1124                 /* BUGBUG - add tab completion for sample rates */
1125                 return NULL;
1126         }
1127
1128         if (a->argc > 6)
1129                 return CLI_SHOWUSAGE;
1130
1131         if (a->argv[3] && !strcasecmp(a->argv[3], option[1]) && a->argc == 5) { /* show paths */
1132                 return handle_show_translation_path(a, a->argv[4], 0);
1133         } else if (a->argv[3] && !strcasecmp(a->argv[3], option[1]) && a->argc == 6) {
1134                 unsigned int sample_rate;
1135                 if (sscanf(a->argv[5], "%30u", &sample_rate) != 1) {
1136                         ast_cli(a->fd, "Invalid sample rate: %s.\n", a->argv[5]);
1137                         return CLI_FAILURE;
1138                 }
1139                 return handle_show_translation_path(a, a->argv[4], sample_rate);
1140         } else if (a->argv[3] && !strcasecmp(a->argv[3], option[0])) { /* recalc and then fall through to show table */
1141                 handle_cli_recalc(a);
1142         } else if (a->argc > 3) { /* wrong input */
1143                 return CLI_SHOWUSAGE;
1144         }
1145
1146         return handle_show_translation_table(a);
1147 }
1148
1149 static struct ast_cli_entry cli_translate[] = {
1150         AST_CLI_DEFINE(handle_cli_core_show_translation, "Display translation matrix")
1151 };
1152
1153 /*! \brief register codec translator */
1154 int __ast_register_translator(struct ast_translator *t, struct ast_module *mod)
1155 {
1156         struct ast_translator *u;
1157         char tmp[80];
1158         RAII_VAR(struct ast_codec *, src_codec, NULL, ao2_cleanup);
1159         RAII_VAR(struct ast_codec *, dst_codec, NULL, ao2_cleanup);
1160
1161         src_codec = ast_codec_get(t->src_codec.name, t->src_codec.type, t->src_codec.sample_rate);
1162         if (!src_codec) {
1163                 ast_assert(0);
1164                 ast_log(LOG_WARNING, "Failed to register translator: unknown source codec %s\n", t->src_codec.name);
1165                 return -1;
1166         }
1167
1168         dst_codec = ast_codec_get(t->dst_codec.name, t->dst_codec.type, t->dst_codec.sample_rate);
1169         if (!dst_codec) {
1170                 ast_log(LOG_WARNING, "Failed to register translator: unknown destination codec %s\n", t->dst_codec.name);
1171                 return -1;
1172         }
1173
1174         if (add_codec2index(src_codec) || add_codec2index(dst_codec)) {
1175                 if (matrix_resize(0)) {
1176                         ast_log(LOG_WARNING, "Translator matrix can not represent any more translators.  Out of resources.\n");
1177                         return -1;
1178                 }
1179                 add_codec2index(src_codec);
1180                 add_codec2index(dst_codec);
1181         }
1182
1183         if (!mod) {
1184                 ast_log(LOG_WARNING, "Missing module pointer, you need to supply one\n");
1185                 return -1;
1186         }
1187
1188         if (!t->buf_size) {
1189                 ast_log(LOG_WARNING, "empty buf size, you need to supply one\n");
1190                 return -1;
1191         }
1192         if (!t->table_cost && !(t->table_cost = generate_table_cost(src_codec, dst_codec))) {
1193                 ast_log(LOG_WARNING, "Table cost could not be generated for %s, "
1194                         "Please set table_cost variable on translator.\n", t->name);
1195                 return -1;
1196         }
1197
1198         t->module = mod;
1199         t->src_fmt_index = codec2index(src_codec);
1200         t->dst_fmt_index = codec2index(dst_codec);
1201         t->active = 1;
1202
1203         if (t->src_fmt_index < 0 || t->dst_fmt_index < 0) {
1204                 ast_log(LOG_WARNING, "Invalid translator path: (%s codec is not valid)\n", t->src_fmt_index < 0 ? "starting" : "ending");
1205                 return -1;
1206         }
1207         if (t->src_fmt_index >= cur_max_index) {
1208                 ast_log(LOG_WARNING, "Source codec %s is larger than cur_max_index\n", t->src_codec.name);
1209                 return -1;
1210         }
1211
1212         if (t->dst_fmt_index >= cur_max_index) {
1213                 ast_log(LOG_WARNING, "Destination codec %s is larger than cur_max_index\n", t->dst_codec.name);
1214                 return -1;
1215         }
1216
1217         if (t->buf_size) {
1218                 /*
1219                  * Align buf_size properly, rounding up to the machine-specific
1220                  * alignment for pointers.
1221                  */
1222                 struct _test_align { void *a, *b; } p;
1223                 int align = (char *)&p.b - (char *)&p.a;
1224
1225                 t->buf_size = ((t->buf_size + align - 1) / align) * align;
1226         }
1227
1228         if (t->frameout == NULL) {
1229                 t->frameout = default_frameout;
1230         }
1231
1232         generate_computational_cost(t, 1);
1233
1234         ast_verb(2, "Registered translator '%s' from codec %s to %s, table cost, %d, computational cost %d\n",
1235                  term_color(tmp, t->name, COLOR_MAGENTA, COLOR_BLACK, sizeof(tmp)),
1236                  t->src_codec.name, t->dst_codec.name, t->table_cost, t->comp_cost);
1237
1238         AST_RWLIST_WRLOCK(&translators);
1239
1240         /* find any existing translators that provide this same srcfmt/dstfmt,
1241            and put this one in order based on computational cost */
1242         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&translators, u, list) {
1243                 if ((u->src_fmt_index == t->src_fmt_index) &&
1244                     (u->dst_fmt_index == t->dst_fmt_index) &&
1245                     (u->comp_cost > t->comp_cost)) {
1246                         AST_RWLIST_INSERT_BEFORE_CURRENT(t, list);
1247                         t = NULL;
1248                         break;
1249                 }
1250         }
1251         AST_RWLIST_TRAVERSE_SAFE_END;
1252
1253         /* if no existing translator was found for this codec combination,
1254            add it to the beginning of the list */
1255         if (t) {
1256                 AST_RWLIST_INSERT_HEAD(&translators, t, list);
1257         }
1258
1259         matrix_rebuild(0);
1260
1261         AST_RWLIST_UNLOCK(&translators);
1262
1263         return 0;
1264 }
1265
1266 /*! \brief unregister codec translator */
1267 int ast_unregister_translator(struct ast_translator *t)
1268 {
1269         char tmp[80];
1270         struct ast_translator *u;
1271         int found = 0;
1272
1273         AST_RWLIST_WRLOCK(&translators);
1274         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&translators, u, list) {
1275                 if (u == t) {
1276                         AST_RWLIST_REMOVE_CURRENT(list);
1277                         ast_verb(2, "Unregistered translator '%s' from codec %s to %s\n",
1278                                 term_color(tmp, t->name, COLOR_MAGENTA, COLOR_BLACK, sizeof(tmp)),
1279                                 t->src_codec.name, t->dst_codec.name);
1280                         found = 1;
1281                         break;
1282                 }
1283         }
1284         AST_RWLIST_TRAVERSE_SAFE_END;
1285
1286         if (found) {
1287                 matrix_rebuild(0);
1288         }
1289
1290         AST_RWLIST_UNLOCK(&translators);
1291
1292         return (u ? 0 : -1);
1293 }
1294
1295 void ast_translator_activate(struct ast_translator *t)
1296 {
1297         AST_RWLIST_WRLOCK(&translators);
1298         t->active = 1;
1299         matrix_rebuild(0);
1300         AST_RWLIST_UNLOCK(&translators);
1301 }
1302
1303 void ast_translator_deactivate(struct ast_translator *t)
1304 {
1305         AST_RWLIST_WRLOCK(&translators);
1306         t->active = 0;
1307         matrix_rebuild(0);
1308         AST_RWLIST_UNLOCK(&translators);
1309 }
1310
1311 /*! \brief Calculate our best translator source format, given costs, and a desired destination */
1312 int ast_translator_best_choice(struct ast_format_cap *dst_cap,
1313         struct ast_format_cap *src_cap,
1314         struct ast_format **dst_fmt_out,
1315         struct ast_format **src_fmt_out)
1316 {
1317         unsigned int besttablecost = INT_MAX;
1318         unsigned int beststeps = INT_MAX;
1319         struct ast_format *fmt;
1320         struct ast_format *dst;
1321         struct ast_format *src;
1322         RAII_VAR(struct ast_format *, best, NULL, ao2_cleanup);
1323         RAII_VAR(struct ast_format *, bestdst, NULL, ao2_cleanup);
1324         struct ast_format_cap *joint_cap;
1325         int i;
1326         int j;
1327
1328         if (ast_format_cap_empty(dst_cap) || ast_format_cap_empty(src_cap)) {
1329                 ast_log(LOG_ERROR, "Cannot determine best translation path since one capability supports no formats\n");
1330                 return -1;
1331         }
1332
1333         joint_cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
1334         if (!joint_cap) {
1335                 return -1;
1336         }
1337         ast_format_cap_get_compatible(dst_cap, src_cap, joint_cap);
1338
1339         for (i = 0; i < ast_format_cap_count(joint_cap); ++i, ao2_cleanup(fmt)) {
1340                 fmt = ast_format_cap_get_format(joint_cap, i);
1341                 if (!fmt
1342                         || ast_format_get_type(fmt) != AST_MEDIA_TYPE_AUDIO) {
1343                         continue;
1344                 }
1345
1346                 if (!best
1347                         || ast_format_get_sample_rate(best) < ast_format_get_sample_rate(fmt)) {
1348                         ao2_replace(best, fmt);
1349                 }
1350         }
1351         ao2_ref(joint_cap, -1);
1352
1353         if (best) {
1354                 ao2_replace(*dst_fmt_out, best);
1355                 ao2_replace(*src_fmt_out, best);
1356                 return 0;
1357         }
1358
1359         /* need to translate */
1360         AST_RWLIST_RDLOCK(&translators);
1361         for (i = 0; i < ast_format_cap_count(dst_cap); ++i, ao2_cleanup(dst)) {
1362                 dst = ast_format_cap_get_format(dst_cap, i);
1363                 if (!dst
1364                         || ast_format_get_type(dst) != AST_MEDIA_TYPE_AUDIO) {
1365                         continue;
1366                 }
1367
1368                 for (j = 0; j < ast_format_cap_count(src_cap); ++j, ao2_cleanup(src)) {
1369                         int x;
1370                         int y;
1371
1372                         src = ast_format_cap_get_format(src_cap, j);
1373                         if (!src
1374                                 || ast_format_get_type(src) != AST_MEDIA_TYPE_AUDIO) {
1375                                 continue;
1376                         }
1377
1378                         x = format2index(src);
1379                         y = format2index(dst);
1380                         if (x < 0 || y < 0) {
1381                                 continue;
1382                         }
1383                         if (!matrix_get(x, y) || !(matrix_get(x, y)->step)) {
1384                                 continue;
1385                         }
1386                         if (matrix_get(x, y)->table_cost < besttablecost
1387                                 || matrix_get(x, y)->multistep < beststeps) {
1388                                 /* better than what we have so far */
1389                                 ao2_replace(best, src);
1390                                 ao2_replace(bestdst, dst);
1391                                 besttablecost = matrix_get(x, y)->table_cost;
1392                                 beststeps = matrix_get(x, y)->multistep;
1393                         }
1394                 }
1395         }
1396         AST_RWLIST_UNLOCK(&translators);
1397
1398         if (!best) {
1399                 return -1;
1400         }
1401         ao2_replace(*dst_fmt_out, bestdst);
1402         ao2_replace(*src_fmt_out, best);
1403         return 0;
1404 }
1405
1406 unsigned int ast_translate_path_steps(struct ast_format *dst_format, struct ast_format *src_format)
1407 {
1408         unsigned int res = -1;
1409         /* convert bitwise format numbers into array indices */
1410         int src = format2index(src_format);
1411         int dest = format2index(dst_format);
1412
1413         if (src < 0 || dest < 0) {
1414                 ast_log(LOG_WARNING, "No translator path: (%s codec is not valid)\n", src < 0 ? "starting" : "ending");
1415                 return -1;
1416         }
1417         AST_RWLIST_RDLOCK(&translators);
1418
1419         if (matrix_get(src, dest)->step) {
1420                 res = matrix_get(src, dest)->multistep + 1;
1421         }
1422
1423         AST_RWLIST_UNLOCK(&translators);
1424
1425         return res;
1426 }
1427
1428 static void check_translation_path(
1429         struct ast_format_cap *dest, struct ast_format_cap *src,
1430         struct ast_format_cap *result, struct ast_format *src_fmt,
1431         enum ast_media_type type)
1432 {
1433         int index, src_index = format2index(src_fmt);
1434         /* For a given source format, traverse the list of
1435            known formats to determine whether there exists
1436            a translation path from the source format to the
1437            destination format. */
1438         for (index = 0; (src_index >= 0) && index < cur_max_index; index++) {
1439                 struct ast_codec *codec = index2codec(index);
1440                 RAII_VAR(struct ast_format *, fmt, ast_format_create(codec), ao2_cleanup);
1441
1442                 ao2_ref(codec, -1);
1443
1444                 if (ast_format_get_type(fmt) != type) {
1445                         continue;
1446                 }
1447
1448                 /* if this is not a desired format, nothing to do */
1449                 if (ast_format_cap_iscompatible_format(dest, fmt) == AST_FORMAT_CMP_NOT_EQUAL) {
1450                         continue;
1451                 }
1452
1453                 /* if the source is supplying this format, then
1454                    we can leave it in the result */
1455                 if (ast_format_cap_iscompatible_format(src, fmt) == AST_FORMAT_CMP_EQUAL) {
1456                         continue;
1457                 }
1458
1459                 /* if we don't have a translation path from the src
1460                    to this format, remove it from the result */
1461                 if (!matrix_get(src_index, index)->step) {
1462                         ast_format_cap_remove(result, fmt);
1463                         continue;
1464                 }
1465
1466                 /* now check the opposite direction */
1467                 if (!matrix_get(index, src_index)->step) {
1468                         ast_format_cap_remove(result, fmt);
1469                 }
1470         }
1471
1472 }
1473
1474 void ast_translate_available_formats(struct ast_format_cap *dest, struct ast_format_cap *src, struct ast_format_cap *result)
1475 {
1476         struct ast_format *cur_dest, *cur_src;
1477         int index;
1478
1479         for (index = 0; index < ast_format_cap_count(dest); ++index) {
1480                 if (!(cur_dest = ast_format_cap_get_format(dest, index))) {
1481                         continue;
1482                 }
1483
1484                 /* We give preference to a joint format structure if possible */
1485                 if ((cur_src = ast_format_cap_get_compatible_format(src, cur_dest))) {
1486                         ast_format_cap_append(result, cur_src, 0);
1487                         ao2_ref(cur_src, -1);
1488                 } else {
1489                         /* Otherwise we just use the destination format */
1490                         ast_format_cap_append(result, cur_dest, 0);
1491                 }
1492                 ao2_ref(cur_dest, -1);
1493         }
1494
1495         /* if we don't have a source format, we just have to try all
1496            possible destination formats */
1497         if (!src) {
1498                 return;
1499         }
1500
1501         for (index = 0; index < ast_format_cap_count(src); ++index) {
1502                 if (!(cur_src = ast_format_cap_get_format(src, index))) {
1503                         continue;
1504                 }
1505
1506                 AST_RWLIST_RDLOCK(&translators);
1507                 check_translation_path(dest, src, result,
1508                                        cur_src, AST_MEDIA_TYPE_AUDIO);
1509                 check_translation_path(dest, src, result,
1510                                        cur_src, AST_MEDIA_TYPE_VIDEO);
1511                 AST_RWLIST_UNLOCK(&translators);
1512                 ao2_ref(cur_src, -1);
1513         }
1514 }
1515
1516 static void translate_shutdown(void)
1517 {
1518         int x;
1519         ast_cli_unregister_multiple(cli_translate, ARRAY_LEN(cli_translate));
1520
1521         ast_rwlock_wrlock(&tablelock);
1522         for (x = 0; x < index_size; x++) {
1523                 ast_free(__matrix[x]);
1524         }
1525         ast_free(__matrix);
1526         __matrix = NULL;
1527         ast_free(__indextable);
1528         __indextable = NULL;
1529         ast_rwlock_unlock(&tablelock);
1530         ast_rwlock_destroy(&tablelock);
1531 }
1532
1533 int ast_translate_init(void)
1534 {
1535         int res = 0;
1536         ast_rwlock_init(&tablelock);
1537         res = matrix_resize(1);
1538         res |= ast_cli_register_multiple(cli_translate, ARRAY_LEN(cli_translate));
1539         ast_register_cleanup(translate_shutdown);
1540         return res;
1541 }