Merge "lock: Improve performance of DEBUG_THREADS."
[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 static struct ast_frame *generate_interpolated_slin(struct ast_trans_pvt *p, struct ast_frame *f)
528 {
529         struct ast_frame res = { AST_FRAME_VOICE };
530
531         /*
532          * If we've gotten here then we should have an interpolated frame that was not handled
533          * by the translation codec. So create an interpolated frame in the appropriate format
534          * that was going to be written. This frame might be handled later by other resources.
535          * For instance, generic plc.
536          *
537          * Note, generic plc is currently only available for the format type 'slin' (8KHz only -
538          * The generic plc code appears to have been based around that). Generic plc is filled
539          * in later on frame write.
540          */
541         if (!ast_opt_generic_plc || f->datalen != 0 ||
542                 ast_format_cmp(p->explicit_dst, ast_format_slin) == AST_FORMAT_CMP_NOT_EQUAL) {
543                 return NULL;
544         }
545
546         res.subclass.format = ast_format_cache_get_slin_by_rate(8000); /* ref bumped on dup */
547         res.samples = f->samples;
548         res.datalen = 0;
549         res.data.ptr = NULL;
550         res.offset = AST_FRIENDLY_OFFSET;
551
552         return ast_frdup(&res);
553 }
554
555 /*! \brief do the actual translation */
556 struct ast_frame *ast_translate(struct ast_trans_pvt *path, struct ast_frame *f, int consume)
557 {
558         struct ast_trans_pvt *p = path;
559         struct ast_frame *out;
560         struct timeval delivery;
561         int has_timing_info;
562         long ts;
563         long len;
564         int seqno;
565
566         if (f->frametype == AST_FRAME_RTCP) {
567                 /* Just pass the feedback to the right callback, if it exists.
568                  * This "translation" does nothing so return a null frame. */
569                 struct ast_trans_pvt *tp;
570                 for (tp = p; tp; tp = tp->next) {
571                         if (tp->t->feedback)
572                                 tp->t->feedback(tp, f);
573                 }
574                 return &ast_null_frame;
575         }
576
577         has_timing_info = ast_test_flag(f, AST_FRFLAG_HAS_TIMING_INFO);
578         ts = f->ts;
579         len = f->len;
580         seqno = f->seqno;
581
582         if (!ast_tvzero(f->delivery)) {
583                 if (!ast_tvzero(path->nextin)) {
584                         /* Make sure this is in line with what we were expecting */
585                         if (!ast_tveq(path->nextin, f->delivery)) {
586                                 /* The time has changed between what we expected and this
587                                    most recent time on the new packet.  If we have a
588                                    valid prediction adjust our output time appropriately */
589                                 if (!ast_tvzero(path->nextout)) {
590                                         path->nextout = ast_tvadd(path->nextout,
591                                                                   ast_tvsub(f->delivery, path->nextin));
592                                 }
593                                 path->nextin = f->delivery;
594                         }
595                 } else {
596                         /* This is our first pass.  Make sure the timing looks good */
597                         path->nextin = f->delivery;
598                         path->nextout = f->delivery;
599                 }
600                 /* Predict next incoming sample */
601                 path->nextin = ast_tvadd(path->nextin, ast_samp2tv(
602                          f->samples, ast_format_get_sample_rate(f->subclass.format)));
603         }
604         delivery = f->delivery;
605         for (out = f; out && p ; p = p->next) {
606                 struct ast_frame *current = out;
607
608                 do {
609                         framein(p, current);
610                         current = AST_LIST_NEXT(current, frame_list);
611                 } while (current);
612                 if (out != f) {
613                         ast_frfree(out);
614                 }
615                 out = p->t->frameout(p);
616         }
617
618         if (!out) {
619                 out = generate_interpolated_slin(path, f);
620         }
621
622         if (out) {
623                 /* we have a frame, play with times */
624                 if (!ast_tvzero(delivery)) {
625                         struct ast_frame *current = out;
626
627                         do {
628                                 /* Regenerate prediction after a discontinuity */
629                                 if (ast_tvzero(path->nextout)) {
630                                         path->nextout = ast_tvnow();
631                                 }
632
633                                 /* Use next predicted outgoing timestamp */
634                                 current->delivery = path->nextout;
635
636                                 /* Invalidate prediction if we're entering a silence period */
637                                 if (current->frametype == AST_FRAME_CNG) {
638                                         path->nextout = ast_tv(0, 0);
639                                 /* Predict next outgoing timestamp from samples in this
640                                    frame. */
641                                 } else {
642                                         path->nextout = ast_tvadd(path->nextout, ast_samp2tv(
643                                                 current->samples, ast_format_get_sample_rate(current->subclass.format)));
644                                 }
645
646                                 if (f->samples != current->samples && ast_test_flag(current, AST_FRFLAG_HAS_TIMING_INFO)) {
647                                         ast_debug(4, "Sample size different %d vs %d\n", f->samples, current->samples);
648                                         ast_clear_flag(current, AST_FRFLAG_HAS_TIMING_INFO);
649                                 }
650                                 current = AST_LIST_NEXT(current, frame_list);
651                         } while (current);
652                 } else {
653                         out->delivery = ast_tv(0, 0);
654                         ast_set2_flag(out, has_timing_info, AST_FRFLAG_HAS_TIMING_INFO);
655                         if (has_timing_info) {
656                                 out->ts = ts;
657                                 out->len = len;
658                                 out->seqno = seqno;
659                         }
660                         /* Invalidate prediction if we're entering a silence period */
661                         if (out->frametype == AST_FRAME_CNG) {
662                                 path->nextout = ast_tv(0, 0);
663                         }
664                 }
665         }
666         if (consume) {
667                 ast_frfree(f);
668         }
669         return out;
670 }
671
672 /*!
673  * \internal
674  * \brief Compute the computational cost of a single translation step.
675  *
676  * \note This function is only used to decide which translation path to
677  * use between two translators with identical src and dst formats.  Computational
678  * cost acts only as a tie breaker. This is done so hardware translators
679  * can naturally have precedence over software translators.
680  */
681 static void generate_computational_cost(struct ast_translator *t, int seconds)
682 {
683         int num_samples = 0;
684         struct ast_trans_pvt *pvt;
685         struct rusage start;
686         struct rusage end;
687         int cost;
688         int out_rate = t->dst_codec.sample_rate;
689
690         if (!seconds) {
691                 seconds = 1;
692         }
693
694         /* If they don't make samples, give them a terrible score */
695         if (!t->sample) {
696                 ast_debug(3, "Translator '%s' does not produce sample frames.\n", t->name);
697                 t->comp_cost = 999999;
698                 return;
699         }
700
701         pvt = newpvt(t, NULL);
702         if (!pvt) {
703                 ast_log(LOG_WARNING, "Translator '%s' appears to be broken and will probably fail.\n", t->name);
704                 t->comp_cost = 999999;
705                 return;
706         }
707
708         getrusage(RUSAGE_SELF, &start);
709
710         /* Call the encoder until we've processed the required number of samples */
711         while (num_samples < seconds * out_rate) {
712                 struct ast_frame *f = t->sample();
713                 if (!f) {
714                         ast_log(LOG_WARNING, "Translator '%s' failed to produce a sample frame.\n", t->name);
715                         destroy(pvt);
716                         t->comp_cost = 999999;
717                         return;
718                 }
719                 framein(pvt, f);
720                 ast_frfree(f);
721                 while ((f = t->frameout(pvt))) {
722                         num_samples += f->samples;
723                         ast_frfree(f);
724                 }
725         }
726
727         getrusage(RUSAGE_SELF, &end);
728
729         cost = ((end.ru_utime.tv_sec - start.ru_utime.tv_sec) * 1000000) + end.ru_utime.tv_usec - start.ru_utime.tv_usec;
730         cost += ((end.ru_stime.tv_sec - start.ru_stime.tv_sec) * 1000000) + end.ru_stime.tv_usec - start.ru_stime.tv_usec;
731
732         destroy(pvt);
733
734         t->comp_cost = cost / seconds;
735
736         if (!t->comp_cost) {
737                 t->comp_cost = 1;
738         }
739 }
740
741 /*!
742  * \internal
743  *
744  * \brief If no table cost value was pre set by the translator.  An attempt is made to
745  * automatically generate that cost value from the cost table based on our src and
746  * dst formats.
747  *
748  * \note This function allows older translators built before the translation cost
749  * changed away from using onely computational time to continue to be registered
750  * correctly.  It is expected that translators built after the introduction of this
751  * function will manually assign their own table cost value.
752  *
753  * \note This function is safe to use on any audio formats that used to be defined in the
754  * first 64 bits of the old bit field codec representation.
755  *
756  * \retval Table Cost value greater than 0.
757  * \retval 0 on error.
758  */
759 static int generate_table_cost(struct ast_codec *src, struct ast_codec *dst)
760 {
761         int src_rate = src->sample_rate;
762         int src_ll = 0;
763         int dst_rate = dst->sample_rate;
764         int dst_ll = 0;
765
766         if ((src->type != AST_MEDIA_TYPE_AUDIO) ||
767             (dst->type != AST_MEDIA_TYPE_AUDIO)) {
768                 /* This method of generating table cost is limited to audio.
769                  * Translators for media other than audio must manually set their
770                  * table cost. */
771                 return 0;
772         }
773
774         src_ll = !strcmp(src->name, "slin");
775         dst_ll = !strcmp(dst->name, "slin");
776         if (src_ll) {
777                 if (dst_ll && (src_rate == dst_rate)) {
778                         return AST_TRANS_COST_LL_LL_ORIGSAMP;
779                 } else if (!dst_ll && (src_rate == dst_rate)) {
780                         return AST_TRANS_COST_LL_LY_ORIGSAMP;
781                 } else if (dst_ll && (src_rate < dst_rate)) {
782                         return AST_TRANS_COST_LL_LL_UPSAMP;
783                 } else if (!dst_ll && (src_rate < dst_rate)) {
784                         return AST_TRANS_COST_LL_LY_UPSAMP;
785                 } else if (dst_ll && (src_rate > dst_rate)) {
786                         return AST_TRANS_COST_LL_LL_DOWNSAMP;
787                 } else if (!dst_ll && (src_rate > dst_rate)) {
788                         return AST_TRANS_COST_LL_LY_DOWNSAMP;
789                 } else {
790                         return AST_TRANS_COST_LL_UNKNOWN;
791                 }
792         } else {
793                 if (dst_ll && (src_rate == dst_rate)) {
794                         return AST_TRANS_COST_LY_LL_ORIGSAMP;
795                 } else if (!dst_ll && (src_rate == dst_rate)) {
796                         return AST_TRANS_COST_LY_LY_ORIGSAMP;
797                 } else if (dst_ll && (src_rate < dst_rate)) {
798                         return AST_TRANS_COST_LY_LL_UPSAMP;
799                 } else if (!dst_ll && (src_rate < dst_rate)) {
800                         return AST_TRANS_COST_LY_LY_UPSAMP;
801                 } else if (dst_ll && (src_rate > dst_rate)) {
802                         return AST_TRANS_COST_LY_LL_DOWNSAMP;
803                 } else if (!dst_ll && (src_rate > dst_rate)) {
804                         return AST_TRANS_COST_LY_LY_DOWNSAMP;
805                 } else {
806                         return AST_TRANS_COST_LY_UNKNOWN;
807                 }
808         }
809 }
810
811 /*!
812  * \brief rebuild a translation matrix.
813  * \note This function expects the list of translators to be locked
814 */
815 static void matrix_rebuild(int samples)
816 {
817         struct ast_translator *t;
818         int newtablecost;
819         int x;      /* source format index */
820         int y;      /* intermediate format index */
821         int z;      /* destination format index */
822
823         ast_debug(1, "Resetting translation matrix\n");
824
825         matrix_clear();
826
827         /* first, compute all direct costs */
828         AST_RWLIST_TRAVERSE(&translators, t, list) {
829                 if (!t->active) {
830                         continue;
831                 }
832
833                 x = t->src_fmt_index;
834                 z = t->dst_fmt_index;
835
836                 if (samples) {
837                         generate_computational_cost(t, samples);
838                 }
839
840                 /* This new translator is the best choice if any of the below are true.
841                  * 1. no translation path is set between x and z yet.
842                  * 2. the new table cost is less.
843                  * 3. the new computational cost is less.  Computational cost is only used
844                  *    to break a tie between two identical translation paths.
845                  */
846                 if (!matrix_get(x, z)->step ||
847                         (t->table_cost < matrix_get(x, z)->step->table_cost) ||
848                         (t->comp_cost < matrix_get(x, z)->step->comp_cost)) {
849
850                         matrix_get(x, z)->step = t;
851                         matrix_get(x, z)->table_cost = t->table_cost;
852                 }
853         }
854
855         /*
856          * For each triple x, y, z of distinct formats, check if there is
857          * a path from x to z through y which is cheaper than what is
858          * currently known, and in case, update the matrix.
859          * Repeat until the matrix is stable.
860          */
861         for (;;) {
862                 int changed = 0;
863                 for (x = 0; x < cur_max_index; x++) {      /* source format */
864                         for (y = 0; y < cur_max_index; y++) {  /* intermediate format */
865                                 if (x == y) {                      /* skip ourselves */
866                                         continue;
867                                 }
868                                 for (z = 0; z < cur_max_index; z++) {  /* dst format */
869                                         if ((z == x || z == y) ||        /* skip null conversions */
870                                                 !matrix_get(x, y)->step ||   /* no path from x to y */
871                                                 !matrix_get(y, z)->step) {   /* no path from y to z */
872                                                 continue;
873                                         }
874
875                                         /* calculate table cost from x->y->z */
876                                         newtablecost = matrix_get(x, y)->table_cost + matrix_get(y, z)->table_cost;
877
878                                         /* if no step already exists between x and z OR the new cost of using the intermediate
879                                          * step is cheaper, use this step. */
880                                         if (!matrix_get(x, z)->step || (newtablecost < matrix_get(x, z)->table_cost)) {
881                                                 matrix_get(x, z)->step = matrix_get(x, y)->step;
882                                                 matrix_get(x, z)->table_cost = newtablecost;
883                                                 matrix_get(x, z)->multistep = 1;
884                                                 changed++;
885
886                                                 if (DEBUG_ATLEAST(10)) {
887                                                         struct ast_codec *x_codec = index2codec(x);
888                                                         struct ast_codec *y_codec = index2codec(y);
889                                                         struct ast_codec *z_codec = index2codec(z);
890
891                                                         ast_log(LOG_DEBUG,
892                                                                 "Discovered %u cost path from %s to %s, via %s\n",
893                                                                 matrix_get(x, z)->table_cost, x_codec->name,
894                                                                 y_codec->name, z_codec->name);
895
896                                                         ao2_ref(x_codec, -1);
897                                                         ao2_ref(y_codec, -1);
898                                                         ao2_ref(z_codec, -1);
899                                                 }
900                                         }
901                                 }
902                         }
903                 }
904                 if (!changed) {
905                         break;
906                 }
907         }
908 }
909
910 static void codec_append_name(const struct ast_codec *codec, struct ast_str **buf)
911 {
912         if (codec) {
913                 ast_str_append(buf, 0, "(%s@%u)", codec->name, codec->sample_rate);
914         } else {
915                 ast_str_append(buf, 0, "(nothing)");
916         }
917 }
918
919 const char *ast_translate_path_to_str(struct ast_trans_pvt *p, struct ast_str **str)
920 {
921         if (!p || !p->t) {
922                 return "";
923         }
924
925         ast_str_reset(*str);
926         codec_append_name(&p->t->src_codec, str);
927         while (p) {
928                 ast_str_append(str, 0, "->");
929                 codec_append_name(&p->t->dst_codec, str);
930                 p = p->next;
931         }
932
933         return ast_str_buffer(*str);
934 }
935
936 static char *complete_trans_path_choice(const char *word)
937 {
938         int i = 1;
939         int wordlen = strlen(word);
940         struct ast_codec *codec;
941
942         while ((codec = ast_codec_get_by_id(i))) {
943                 ++i;
944                 if (codec->type != AST_MEDIA_TYPE_AUDIO) {
945                         ao2_ref(codec, -1);
946                         continue;
947                 }
948                 if (!strncasecmp(word, codec->name, wordlen)) {
949                         if (ast_cli_completion_add(ast_strdup(codec->name))) {
950                                 ao2_ref(codec, -1);
951                                 break;
952                         }
953                 }
954                 ao2_ref(codec, -1);
955         }
956
957         return NULL;
958 }
959
960 static void handle_cli_recalc(struct ast_cli_args *a)
961 {
962         int time = a->argv[4] ? atoi(a->argv[4]) : 1;
963
964         if (time <= 0) {
965                 ast_cli(a->fd, "         Recalc must be greater than 0.  Defaulting to 1.\n");
966                 time = 1;
967         }
968
969         if (time > MAX_RECALC) {
970                 ast_cli(a->fd, "         Maximum limit of recalc exceeded by %d, truncating value to %d\n", time - MAX_RECALC, MAX_RECALC);
971                 time = MAX_RECALC;
972         }
973         ast_cli(a->fd, "         Recalculating Codec Translation (number of sample seconds: %d)\n\n", time);
974         AST_RWLIST_WRLOCK(&translators);
975         matrix_rebuild(time);
976         AST_RWLIST_UNLOCK(&translators);
977 }
978
979 static char *handle_show_translation_table(struct ast_cli_args *a)
980 {
981         int x, y, i, k;
982         int longest = 7; /* slin192 */
983         int num_codecs = 0, curlen = 0;
984         struct ast_str *out = ast_str_create(1024);
985         struct ast_codec *codec;
986
987         /* Get the length of the longest (usable?) codec name,
988            so we know how wide the left side should be */
989         for (i = 1; (codec = ast_codec_get_by_id(i)); ao2_ref(codec, -1), ++i) {
990                 ++num_codecs;
991                 if (codec->type != AST_MEDIA_TYPE_AUDIO) {
992                         continue;
993                 }
994                 curlen = strlen(codec->name);
995                 if (curlen > longest) {
996                         longest = curlen;
997                 }
998         }
999
1000         AST_RWLIST_RDLOCK(&translators);
1001         ast_cli(a->fd, "         Translation times between formats (in microseconds) for one second of data\n");
1002         ast_cli(a->fd, "          Source Format (Rows) Destination Format (Columns)\n\n");
1003
1004         for (i = 0; i < num_codecs; i++) {
1005                 struct ast_codec *row = i ? ast_codec_get_by_id(i) : NULL;
1006
1007                 x = -1;
1008                 if ((i > 0) && (row->type != AST_MEDIA_TYPE_AUDIO)) {
1009                         ao2_ref(row, -1);
1010                         continue;
1011                 }
1012
1013                 if ((i > 0) && (x = codec2index(row)) == -1) {
1014                         ao2_ref(row, -1);
1015                         continue;
1016                 }
1017
1018                 ast_str_set(&out, 0, " ");
1019                 for (k = 0; k < num_codecs; k++) {
1020                         int adjust = 0;
1021                         struct ast_codec *col = k ? ast_codec_get_by_id(k) : NULL;
1022
1023                         y = -1;
1024                         if ((k > 0) && (col->type != AST_MEDIA_TYPE_AUDIO)) {
1025                                 ao2_ref(col, -1);
1026                                 continue;
1027                         }
1028
1029                         if ((k > 0) && (y = codec2index(col)) == -1) {
1030                                 ao2_ref(col, -1);
1031                                 continue;
1032                         }
1033
1034                         if (k > 0) {
1035                                 curlen = strlen(col->name);
1036                                 if (!strcmp(col->name, "slin") ||
1037                                         !strcmp(col->name, "speex") ||
1038                                         !strcmp(col->name, "silk")) {
1039                                         adjust = log10(col->sample_rate / 1000) + 1;
1040                                         curlen = curlen + adjust;
1041                                 }
1042                         }
1043
1044                         if (curlen < 5) {
1045                                 curlen = 5;
1046                         }
1047
1048                         if (x >= 0 && y >= 0 && matrix_get(x, y)->step) {
1049                                 /* Actual codec output */
1050                                 ast_str_append(&out, 0, "%*u", curlen + 1, (matrix_get(x, y)->table_cost/100));
1051                         } else if (i == 0 && k > 0) {
1052                                 /* Top row - use a dynamic size */
1053                                 if (!strcmp(col->name, "slin") ||
1054                                         !strcmp(col->name, "speex") ||
1055                                         !strcmp(col->name, "silk")) {
1056                                         ast_str_append(&out, 0, "%*s%u", curlen - adjust + 1,
1057                                                 col->name, col->sample_rate / 1000);
1058                                 } else {
1059                                         ast_str_append(&out, 0, "%*s", curlen + 1, col->name);
1060                                 }
1061                         } else if (k == 0 && i > 0) {
1062                                 /* Left column - use a static size. */
1063                                 if (!strcmp(row->name, "slin") ||
1064                                         !strcmp(row->name, "speex") ||
1065                                         !strcmp(row->name, "silk")) {
1066                                         int adjust_row = log10(row->sample_rate / 1000) + 1;
1067                                         ast_str_append(&out, 0, "%*s%u", longest - adjust_row,
1068                                                 row->name, row->sample_rate / 1000);
1069                                 } else {
1070                                         ast_str_append(&out, 0, "%*s", longest, row->name);
1071                                 }
1072                         } else if (x >= 0 && y >= 0) {
1073                                 /* Codec not supported */
1074                                 ast_str_append(&out, 0, "%*s", curlen + 1, "-");
1075                         } else {
1076                                 /* Upper left hand corner */
1077                                 ast_str_append(&out, 0, "%*s", longest, "");
1078                         }
1079                         ao2_cleanup(col);
1080                 }
1081                 ast_str_append(&out, 0, "\n");
1082                 ast_cli(a->fd, "%s", ast_str_buffer(out));
1083                 ao2_cleanup(row);
1084         }
1085         ast_free(out);
1086         AST_RWLIST_UNLOCK(&translators);
1087         return CLI_SUCCESS;
1088 }
1089
1090 static char *handle_show_translation_path(struct ast_cli_args *a, const char *codec_name, unsigned int sample_rate)
1091 {
1092         int i = 1;
1093         struct ast_str *str = ast_str_alloca(1024);
1094         struct ast_translator *step;
1095         struct ast_codec *dst_codec;
1096         struct ast_codec *src_codec = ast_codec_get(codec_name, AST_MEDIA_TYPE_AUDIO, sample_rate);
1097
1098         if (!src_codec) {
1099                 ast_cli(a->fd, "Source codec \"%s\" is not found.\n", codec_name);
1100                 return CLI_FAILURE;
1101         }
1102
1103         AST_RWLIST_RDLOCK(&translators);
1104         ast_cli(a->fd, "--- Translation paths SRC Codec \"%s\" sample rate %u ---\n",
1105                 codec_name, src_codec->sample_rate);
1106
1107         while ((dst_codec = ast_codec_get_by_id(i))) {
1108                 int src, dst;
1109                 char src_buffer[64];
1110                 char dst_buffer[64];
1111
1112                 ++i;
1113                 if (src_codec == dst_codec ||
1114                     dst_codec->type != AST_MEDIA_TYPE_AUDIO) {
1115                         ao2_ref(dst_codec, -1);
1116                         continue;
1117                 }
1118
1119                 dst = codec2index(dst_codec);
1120                 src = codec2index(src_codec);
1121
1122                 if (src < 0 || dst < 0) {
1123                         ast_str_set(&str, 0, "No Translation Path");
1124                 } else {
1125                         step = matrix_get(src, dst)->step;
1126
1127                         if (step) {
1128                                 codec_append_name(&step->src_codec, &str);
1129                                 while (src != dst) {
1130                                         src = step->dst_fmt_index;
1131                                         step = matrix_get(src, dst)->step;
1132                                         if (!step) {
1133                                                 ast_str_append(&str, 0, "->");
1134                                                 codec_append_name(dst_codec, &str);
1135                                                 break;
1136                                         }
1137                                         ast_str_append(&str, 0, "->");
1138                                         codec_append_name(&step->src_codec, &str);
1139                                 }
1140                         }
1141                 }
1142
1143                 snprintf(src_buffer, sizeof(src_buffer), "%s:%u", src_codec->name, src_codec->sample_rate);
1144                 snprintf(dst_buffer, sizeof(dst_buffer), "%s:%u", dst_codec->name, dst_codec->sample_rate);
1145                 ast_cli(a->fd, "\t%-16.16s To %-16.16s: %-60.60s\n",
1146                         src_buffer, dst_buffer, ast_str_buffer(str));
1147                 ast_str_reset(str);
1148                 ao2_ref(dst_codec, -1);
1149         }
1150         AST_RWLIST_UNLOCK(&translators);
1151         ao2_ref(src_codec, -1);
1152         return CLI_SUCCESS;
1153 }
1154
1155 static char *handle_cli_core_show_translation(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1156 {
1157         static const char * const option[] = { "recalc", "paths", NULL };
1158
1159         switch (cmd) {
1160         case CLI_INIT:
1161                 e->command = "core show translation";
1162                 e->usage =
1163                         "Usage: 'core show translation' can be used in two ways.\n"
1164                         "       1. 'core show translation [recalc [<recalc seconds>]]\n"
1165                         "          Displays known codec translators and the cost associated\n"
1166                         "          with each conversion.  If the argument 'recalc' is supplied along\n"
1167                         "          with optional number of seconds to test a new test will be performed\n"
1168                         "          as the chart is being displayed.\n"
1169                         "       2. 'core show translation paths [codec [sample_rate]]'\n"
1170                         "           This will display all the translation paths associated with a codec.\n"
1171                         "           If a codec has multiple sample rates, the sample rate must be\n"
1172                         "           provided as well.\n";
1173                 return NULL;
1174         case CLI_GENERATE:
1175                 if (a->pos == 3) {
1176                         return ast_cli_complete(a->word, option, -1);
1177                 }
1178                 if (a->pos == 4 && !strcasecmp(a->argv[3], option[1])) {
1179                         return complete_trans_path_choice(a->word);
1180                 }
1181                 /* BUGBUG - add tab completion for sample rates */
1182                 return NULL;
1183         }
1184
1185         if (a->argc > 6)
1186                 return CLI_SHOWUSAGE;
1187
1188         if (a->argv[3] && !strcasecmp(a->argv[3], option[1]) && a->argc == 5) { /* show paths */
1189                 return handle_show_translation_path(a, a->argv[4], 0);
1190         } else if (a->argv[3] && !strcasecmp(a->argv[3], option[1]) && a->argc == 6) {
1191                 unsigned int sample_rate;
1192                 if (sscanf(a->argv[5], "%30u", &sample_rate) != 1) {
1193                         ast_cli(a->fd, "Invalid sample rate: %s.\n", a->argv[5]);
1194                         return CLI_FAILURE;
1195                 }
1196                 return handle_show_translation_path(a, a->argv[4], sample_rate);
1197         } else if (a->argv[3] && !strcasecmp(a->argv[3], option[0])) { /* recalc and then fall through to show table */
1198                 handle_cli_recalc(a);
1199         } else if (a->argc > 3) { /* wrong input */
1200                 return CLI_SHOWUSAGE;
1201         }
1202
1203         return handle_show_translation_table(a);
1204 }
1205
1206 static struct ast_cli_entry cli_translate[] = {
1207         AST_CLI_DEFINE(handle_cli_core_show_translation, "Display translation matrix")
1208 };
1209
1210 /*! \brief register codec translator */
1211 int __ast_register_translator(struct ast_translator *t, struct ast_module *mod)
1212 {
1213         struct ast_translator *u;
1214         char tmp[80];
1215         RAII_VAR(struct ast_codec *, src_codec, NULL, ao2_cleanup);
1216         RAII_VAR(struct ast_codec *, dst_codec, NULL, ao2_cleanup);
1217
1218         src_codec = ast_codec_get(t->src_codec.name, t->src_codec.type, t->src_codec.sample_rate);
1219         if (!src_codec) {
1220                 ast_assert(0);
1221                 ast_log(LOG_WARNING, "Failed to register translator: unknown source codec %s\n", t->src_codec.name);
1222                 return -1;
1223         }
1224
1225         dst_codec = ast_codec_get(t->dst_codec.name, t->dst_codec.type, t->dst_codec.sample_rate);
1226         if (!dst_codec) {
1227                 ast_log(LOG_WARNING, "Failed to register translator: unknown destination codec %s\n", t->dst_codec.name);
1228                 return -1;
1229         }
1230
1231         if (add_codec2index(src_codec) || add_codec2index(dst_codec)) {
1232                 if (matrix_resize(0)) {
1233                         ast_log(LOG_WARNING, "Translator matrix can not represent any more translators.  Out of resources.\n");
1234                         return -1;
1235                 }
1236                 add_codec2index(src_codec);
1237                 add_codec2index(dst_codec);
1238         }
1239
1240         if (!mod) {
1241                 ast_log(LOG_WARNING, "Missing module pointer, you need to supply one\n");
1242                 return -1;
1243         }
1244
1245         if (!t->buf_size) {
1246                 ast_log(LOG_WARNING, "empty buf size, you need to supply one\n");
1247                 return -1;
1248         }
1249         if (!t->table_cost && !(t->table_cost = generate_table_cost(src_codec, dst_codec))) {
1250                 ast_log(LOG_WARNING, "Table cost could not be generated for %s, "
1251                         "Please set table_cost variable on translator.\n", t->name);
1252                 return -1;
1253         }
1254
1255         t->module = mod;
1256         t->src_fmt_index = codec2index(src_codec);
1257         t->dst_fmt_index = codec2index(dst_codec);
1258         t->active = 1;
1259
1260         if (t->src_fmt_index < 0 || t->dst_fmt_index < 0) {
1261                 ast_log(LOG_WARNING, "Invalid translator path: (%s codec is not valid)\n", t->src_fmt_index < 0 ? "starting" : "ending");
1262                 return -1;
1263         }
1264         if (t->src_fmt_index >= cur_max_index) {
1265                 ast_log(LOG_WARNING, "Source codec %s is larger than cur_max_index\n", t->src_codec.name);
1266                 return -1;
1267         }
1268
1269         if (t->dst_fmt_index >= cur_max_index) {
1270                 ast_log(LOG_WARNING, "Destination codec %s is larger than cur_max_index\n", t->dst_codec.name);
1271                 return -1;
1272         }
1273
1274         if (t->buf_size) {
1275                 /*
1276                  * Align buf_size properly, rounding up to the machine-specific
1277                  * alignment for pointers.
1278                  */
1279                 struct _test_align { void *a, *b; } p;
1280                 int align = (char *)&p.b - (char *)&p.a;
1281
1282                 t->buf_size = ((t->buf_size + align - 1) / align) * align;
1283         }
1284
1285         if (t->frameout == NULL) {
1286                 t->frameout = default_frameout;
1287         }
1288
1289         generate_computational_cost(t, 1);
1290
1291         ast_verb(2, "Registered translator '%s' from codec %s to %s, table cost, %d, computational cost %d\n",
1292                  term_color(tmp, t->name, COLOR_MAGENTA, COLOR_BLACK, sizeof(tmp)),
1293                  t->src_codec.name, t->dst_codec.name, t->table_cost, t->comp_cost);
1294
1295         AST_RWLIST_WRLOCK(&translators);
1296
1297         /* find any existing translators that provide this same srcfmt/dstfmt,
1298            and put this one in order based on computational cost */
1299         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&translators, u, list) {
1300                 if ((u->src_fmt_index == t->src_fmt_index) &&
1301                     (u->dst_fmt_index == t->dst_fmt_index) &&
1302                     (u->comp_cost > t->comp_cost)) {
1303                         AST_RWLIST_INSERT_BEFORE_CURRENT(t, list);
1304                         t = NULL;
1305                         break;
1306                 }
1307         }
1308         AST_RWLIST_TRAVERSE_SAFE_END;
1309
1310         /* if no existing translator was found for this codec combination,
1311            add it to the beginning of the list */
1312         if (t) {
1313                 AST_RWLIST_INSERT_HEAD(&translators, t, list);
1314         }
1315
1316         matrix_rebuild(0);
1317
1318         AST_RWLIST_UNLOCK(&translators);
1319
1320         return 0;
1321 }
1322
1323 /*! \brief unregister codec translator */
1324 int ast_unregister_translator(struct ast_translator *t)
1325 {
1326         char tmp[80];
1327         struct ast_translator *u;
1328         int found = 0;
1329
1330         AST_RWLIST_WRLOCK(&translators);
1331         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&translators, u, list) {
1332                 if (u == t) {
1333                         AST_RWLIST_REMOVE_CURRENT(list);
1334                         ast_verb(2, "Unregistered translator '%s' from codec %s to %s\n",
1335                                 term_color(tmp, t->name, COLOR_MAGENTA, COLOR_BLACK, sizeof(tmp)),
1336                                 t->src_codec.name, t->dst_codec.name);
1337                         found = 1;
1338                         break;
1339                 }
1340         }
1341         AST_RWLIST_TRAVERSE_SAFE_END;
1342
1343         if (found && !ast_shutting_down()) {
1344                 matrix_rebuild(0);
1345         }
1346
1347         AST_RWLIST_UNLOCK(&translators);
1348
1349         return (u ? 0 : -1);
1350 }
1351
1352 void ast_translator_activate(struct ast_translator *t)
1353 {
1354         AST_RWLIST_WRLOCK(&translators);
1355         t->active = 1;
1356         matrix_rebuild(0);
1357         AST_RWLIST_UNLOCK(&translators);
1358 }
1359
1360 void ast_translator_deactivate(struct ast_translator *t)
1361 {
1362         AST_RWLIST_WRLOCK(&translators);
1363         t->active = 0;
1364         matrix_rebuild(0);
1365         AST_RWLIST_UNLOCK(&translators);
1366 }
1367
1368 /*! Calculate the absolute difference between sample rate of two formats. */
1369 #define format_sample_rate_absdiff(fmt1, fmt2) ({ \
1370         unsigned int rate1 = ast_format_get_sample_rate(fmt1); \
1371         unsigned int rate2 = ast_format_get_sample_rate(fmt2); \
1372         (rate1 > rate2 ? rate1 - rate2 : rate2 - rate1); \
1373 })
1374
1375 /*! \brief Calculate our best translator source format, given costs, and a desired destination */
1376 int ast_translator_best_choice(struct ast_format_cap *dst_cap,
1377         struct ast_format_cap *src_cap,
1378         struct ast_format **dst_fmt_out,
1379         struct ast_format **src_fmt_out)
1380 {
1381         unsigned int besttablecost = INT_MAX;
1382         unsigned int beststeps = INT_MAX;
1383         struct ast_format *fmt;
1384         struct ast_format *dst;
1385         struct ast_format *src;
1386         RAII_VAR(struct ast_format *, best, NULL, ao2_cleanup);
1387         RAII_VAR(struct ast_format *, bestdst, NULL, ao2_cleanup);
1388         struct ast_format_cap *joint_cap;
1389         int i;
1390         int j;
1391
1392         if (ast_format_cap_empty(dst_cap) || ast_format_cap_empty(src_cap)) {
1393                 ast_log(LOG_ERROR, "Cannot determine best translation path since one capability supports no formats\n");
1394                 return -1;
1395         }
1396
1397         joint_cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
1398         if (!joint_cap) {
1399                 return -1;
1400         }
1401         ast_format_cap_get_compatible(dst_cap, src_cap, joint_cap);
1402
1403         for (i = 0; i < ast_format_cap_count(joint_cap); ++i, ao2_cleanup(fmt)) {
1404                 fmt = ast_format_cap_get_format(joint_cap, i);
1405                 if (!fmt
1406                         || ast_format_get_type(fmt) != AST_MEDIA_TYPE_AUDIO) {
1407                         continue;
1408                 }
1409
1410                 if (!best
1411                         || ast_format_get_sample_rate(best) < ast_format_get_sample_rate(fmt)) {
1412                         ao2_replace(best, fmt);
1413                 }
1414         }
1415         ao2_ref(joint_cap, -1);
1416
1417         if (best) {
1418                 ao2_replace(*dst_fmt_out, best);
1419                 ao2_replace(*src_fmt_out, best);
1420                 return 0;
1421         }
1422
1423         /* need to translate */
1424         AST_RWLIST_RDLOCK(&translators);
1425         for (i = 0; i < ast_format_cap_count(dst_cap); ++i, ao2_cleanup(dst)) {
1426                 dst = ast_format_cap_get_format(dst_cap, i);
1427                 if (!dst
1428                         || ast_format_get_type(dst) != AST_MEDIA_TYPE_AUDIO) {
1429                         continue;
1430                 }
1431
1432                 for (j = 0; j < ast_format_cap_count(src_cap); ++j, ao2_cleanup(src)) {
1433                         int x;
1434                         int y;
1435
1436                         src = ast_format_cap_get_format(src_cap, j);
1437                         if (!src
1438                                 || ast_format_get_type(src) != AST_MEDIA_TYPE_AUDIO) {
1439                                 continue;
1440                         }
1441
1442                         x = format2index(src);
1443                         y = format2index(dst);
1444                         if (x < 0 || y < 0) {
1445                                 continue;
1446                         }
1447                         if (!matrix_get(x, y) || !(matrix_get(x, y)->step)) {
1448                                 continue;
1449                         }
1450                         if (matrix_get(x, y)->table_cost < besttablecost
1451                                 || matrix_get(x, y)->multistep < beststeps) {
1452                                 /* better than what we have so far */
1453                                 ao2_replace(best, src);
1454                                 ao2_replace(bestdst, dst);
1455                                 besttablecost = matrix_get(x, y)->table_cost;
1456                                 beststeps = matrix_get(x, y)->multistep;
1457                         } else if (matrix_get(x, y)->table_cost == besttablecost
1458                                         && matrix_get(x, y)->multistep == beststeps) {
1459                                 unsigned int gap_selected = format_sample_rate_absdiff(best, bestdst);
1460                                 unsigned int gap_current = format_sample_rate_absdiff(src, dst);
1461
1462                                 if (gap_current < gap_selected) {
1463                                         /* better than what we have so far */
1464                                         ao2_replace(best, src);
1465                                         ao2_replace(bestdst, dst);
1466                                         besttablecost = matrix_get(x, y)->table_cost;
1467                                         beststeps = matrix_get(x, y)->multistep;
1468                                 }
1469                         }
1470                 }
1471         }
1472         AST_RWLIST_UNLOCK(&translators);
1473
1474         if (!best) {
1475                 return -1;
1476         }
1477         ao2_replace(*dst_fmt_out, bestdst);
1478         ao2_replace(*src_fmt_out, best);
1479         return 0;
1480 }
1481
1482 unsigned int ast_translate_path_steps(struct ast_format *dst_format, struct ast_format *src_format)
1483 {
1484         unsigned int res = -1;
1485         /* convert bitwise format numbers into array indices */
1486         int src = format2index(src_format);
1487         int dest = format2index(dst_format);
1488
1489         if (src < 0 || dest < 0) {
1490                 ast_log(LOG_WARNING, "No translator path: (%s codec is not valid)\n", src < 0 ? "starting" : "ending");
1491                 return -1;
1492         }
1493         AST_RWLIST_RDLOCK(&translators);
1494
1495         if (matrix_get(src, dest)->step) {
1496                 res = matrix_get(src, dest)->multistep + 1;
1497         }
1498
1499         AST_RWLIST_UNLOCK(&translators);
1500
1501         return res;
1502 }
1503
1504 static void check_translation_path(
1505         struct ast_format_cap *dest, struct ast_format_cap *src,
1506         struct ast_format_cap *result, struct ast_format *src_fmt,
1507         enum ast_media_type type)
1508 {
1509         int index, src_index = format2index(src_fmt);
1510         /* For a given source format, traverse the list of
1511            known formats to determine whether there exists
1512            a translation path from the source format to the
1513            destination format. */
1514         for (index = 0; (src_index >= 0) && index < cur_max_index; index++) {
1515                 struct ast_codec *codec = index2codec(index);
1516                 RAII_VAR(struct ast_format *, fmt, ast_format_create(codec), ao2_cleanup);
1517
1518                 ao2_ref(codec, -1);
1519
1520                 if (ast_format_get_type(fmt) != type) {
1521                         continue;
1522                 }
1523
1524                 /* if this is not a desired format, nothing to do */
1525                 if (ast_format_cap_iscompatible_format(dest, fmt) == AST_FORMAT_CMP_NOT_EQUAL) {
1526                         continue;
1527                 }
1528
1529                 /* if the source is supplying this format, then
1530                    we can leave it in the result */
1531                 if (ast_format_cap_iscompatible_format(src, fmt) == AST_FORMAT_CMP_EQUAL) {
1532                         continue;
1533                 }
1534
1535                 /* if we don't have a translation path from the src
1536                    to this format, remove it from the result */
1537                 if (!matrix_get(src_index, index)->step) {
1538                         ast_format_cap_remove(result, fmt);
1539                         continue;
1540                 }
1541
1542                 /* now check the opposite direction */
1543                 if (!matrix_get(index, src_index)->step) {
1544                         ast_format_cap_remove(result, fmt);
1545                 }
1546         }
1547
1548 }
1549
1550 void ast_translate_available_formats(struct ast_format_cap *dest, struct ast_format_cap *src, struct ast_format_cap *result)
1551 {
1552         struct ast_format *cur_dest, *cur_src;
1553         int index;
1554
1555         for (index = 0; index < ast_format_cap_count(dest); ++index) {
1556                 if (!(cur_dest = ast_format_cap_get_format(dest, index))) {
1557                         continue;
1558                 }
1559
1560                 /* We give preference to a joint format structure if possible */
1561                 if ((cur_src = ast_format_cap_get_compatible_format(src, cur_dest))) {
1562                         ast_format_cap_append(result, cur_src, 0);
1563                         ao2_ref(cur_src, -1);
1564                 } else {
1565                         /* Otherwise we just use the destination format */
1566                         ast_format_cap_append(result, cur_dest, 0);
1567                 }
1568                 ao2_ref(cur_dest, -1);
1569         }
1570
1571         /* if we don't have a source format, we just have to try all
1572            possible destination formats */
1573         if (!src) {
1574                 return;
1575         }
1576
1577         for (index = 0; index < ast_format_cap_count(src); ++index) {
1578                 if (!(cur_src = ast_format_cap_get_format(src, index))) {
1579                         continue;
1580                 }
1581
1582                 AST_RWLIST_RDLOCK(&translators);
1583                 check_translation_path(dest, src, result,
1584                                        cur_src, AST_MEDIA_TYPE_AUDIO);
1585                 check_translation_path(dest, src, result,
1586                                        cur_src, AST_MEDIA_TYPE_VIDEO);
1587                 AST_RWLIST_UNLOCK(&translators);
1588                 ao2_ref(cur_src, -1);
1589         }
1590 }
1591
1592 static void translate_shutdown(void)
1593 {
1594         int x;
1595         ast_cli_unregister_multiple(cli_translate, ARRAY_LEN(cli_translate));
1596
1597         ast_rwlock_wrlock(&tablelock);
1598         for (x = 0; x < index_size; x++) {
1599                 ast_free(__matrix[x]);
1600         }
1601         ast_free(__matrix);
1602         __matrix = NULL;
1603         ast_free(__indextable);
1604         __indextable = NULL;
1605         ast_rwlock_unlock(&tablelock);
1606         ast_rwlock_destroy(&tablelock);
1607 }
1608
1609 int ast_translate_init(void)
1610 {
1611         int res = 0;
1612         ast_rwlock_init(&tablelock);
1613         res = matrix_resize(1);
1614         res |= ast_cli_register_multiple(cli_translate, ARRAY_LEN(cli_translate));
1615         ast_register_cleanup(translate_shutdown);
1616         return res;
1617 }