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