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