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