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