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