Bail out early when building an ast_trans_pvt and the translator doesn't supply a...
[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) != -1) {
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         if (!(x >= 0 && y >= 0)) {
267                 return NULL;
268         }
269         return __matrix[x] + y;
270 }
271
272 /*
273  * wrappers around the translator routines.
274  */
275
276 /*!
277  * \brief Allocate the descriptor, required outbuf space,
278  * and possibly desc.
279  */
280 static void *newpvt(struct ast_translator *t, const struct ast_format *explicit_dst)
281 {
282         struct ast_trans_pvt *pvt;
283         int len;
284         char *ofs;
285
286         /* If we don't have a local init routine, don't bother building the
287            ast_trans_pvt  */
288         if (!t->newpvt) {
289                 return NULL;
290         }
291
292         /*
293          * compute the required size adding private descriptor,
294          * buffer, AST_FRIENDLY_OFFSET.
295          */
296         len = sizeof(*pvt) + t->desc_size;
297         if (t->buf_size)
298                 len += AST_FRIENDLY_OFFSET + t->buf_size;
299         pvt = ast_calloc(1, len);
300         if (!pvt) {
301                 return NULL;
302         }
303         pvt->t = t;
304         ofs = (char *)(pvt + 1);        /* pointer to data space */
305         if (t->desc_size) {             /* first comes the descriptor */
306                 pvt->pvt = ofs;
307                 ofs += t->desc_size;
308         }
309         if (t->buf_size) {/* finally buffer and header */
310                 pvt->outbuf.c = ofs + AST_FRIENDLY_OFFSET;
311         }
312         /* if a explicit destination format is provided, set that on the pvt so the
313          * translator will process it. */
314         if (explicit_dst) {
315                 ast_format_copy(&pvt->explicit_dst, explicit_dst);
316         }
317         /* call local init routine, if present */
318         if (t->newpvt(pvt)) {
319                 ast_free(pvt);
320                 return NULL;
321         }
322         ast_module_ref(t->module);
323         return pvt;
324 }
325
326 static void destroy(struct ast_trans_pvt *pvt)
327 {
328         struct ast_translator *t = pvt->t;
329
330         if (t->destroy)
331                 t->destroy(pvt);
332         ast_free(pvt);
333         ast_module_unref(t->module);
334 }
335
336 /*! \brief framein wrapper, deals with bound checks.  */
337 static int framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
338 {
339         int ret;
340         int samples = pvt->samples;     /* initial value */
341
342         /* Copy the last in jb timing info to the pvt */
343         ast_copy_flags(&pvt->f, f, AST_FRFLAG_HAS_TIMING_INFO);
344         pvt->f.ts = f->ts;
345         pvt->f.len = f->len;
346         pvt->f.seqno = f->seqno;
347
348         if (f->samples == 0) {
349                 ast_log(LOG_WARNING, "no samples for %s\n", pvt->t->name);
350         }
351         if (pvt->t->buffer_samples) {   /* do not pass empty frames to callback */
352                 if (f->datalen == 0) { /* perform native PLC if available */
353                         /* If the codec has native PLC, then do that */
354                         if (!pvt->t->native_plc)
355                                 return 0;
356                 }
357                 if (pvt->samples + f->samples > pvt->t->buffer_samples) {
358                         ast_log(LOG_WARNING, "Out of buffer space\n");
359                         return -1;
360                 }
361         }
362         /* we require a framein routine, wouldn't know how to do
363          * it otherwise.
364          */
365         ret = pvt->t->framein(pvt, f);
366         /* diagnostic ... */
367         if (pvt->samples == samples)
368                 ast_log(LOG_WARNING, "%s did not update samples %d\n",
369                         pvt->t->name, pvt->samples);
370         return ret;
371 }
372
373 /*! \brief generic frameout routine.
374  * If samples and datalen are 0, take whatever is in pvt
375  * and reset them, otherwise take the values in the caller and
376  * leave alone the pvt values.
377  */
378 struct ast_frame *ast_trans_frameout(struct ast_trans_pvt *pvt,
379         int datalen, int samples)
380 {
381         struct ast_frame *f = &pvt->f;
382
383         if (samples) {
384                 f->samples = samples;
385         } else {
386                 if (pvt->samples == 0)
387                         return NULL;
388                 f->samples = pvt->samples;
389                 pvt->samples = 0;
390         }
391         if (datalen) {
392                 f->datalen = datalen;
393         } else {
394                 f->datalen = pvt->datalen;
395                 pvt->datalen = 0;
396         }
397
398         f->frametype = AST_FRAME_VOICE;
399         ast_format_copy(&f->subclass.format, &pvt->t->dst_format);
400         f->mallocd = 0;
401         f->offset = AST_FRIENDLY_OFFSET;
402         f->src = pvt->t->name;
403         f->data.ptr = pvt->outbuf.c;
404
405         return ast_frisolate(f);
406 }
407
408 static struct ast_frame *default_frameout(struct ast_trans_pvt *pvt)
409 {
410         return ast_trans_frameout(pvt, 0, 0);
411 }
412
413 /* end of callback wrappers and helpers */
414
415 void ast_translator_free_path(struct ast_trans_pvt *p)
416 {
417         struct ast_trans_pvt *pn = p;
418         while ( (p = pn) ) {
419                 pn = p->next;
420                 destroy(p);
421         }
422 }
423
424 /*! \brief Build a chain of translators based upon the given source and dest formats */
425 struct ast_trans_pvt *ast_translator_build_path(struct ast_format *dst, struct ast_format *src)
426 {
427         struct ast_trans_pvt *head = NULL, *tail = NULL;
428         int src_index, dst_index;
429         struct ast_format tmp_fmt1;
430         struct ast_format tmp_fmt2;
431
432         src_index = format2index(src->id);
433         dst_index = format2index(dst->id);
434
435         if (src_index == -1 || dst_index == -1) {
436                 ast_log(LOG_WARNING, "No translator path: (%s codec is not valid)\n", src_index == -1 ? "starting" : "ending");
437                 return NULL;
438         }
439
440         AST_RWLIST_RDLOCK(&translators);
441
442         while (src_index != dst_index) {
443                 struct ast_trans_pvt *cur;
444                 struct ast_format *explicit_dst = NULL;
445                 struct ast_translator *t = matrix_get(src_index, dst_index)->step;
446                 if (!t) {
447                         int src_id = index2format(src_index);
448                         int dst_id = index2format(dst_index);
449                         ast_log(LOG_WARNING, "No translator path from %s to %s\n",
450                                 ast_getformatname(ast_format_set(&tmp_fmt1, src_id, 0)),
451                                 ast_getformatname(ast_format_set(&tmp_fmt2, dst_id, 0)));
452                         AST_RWLIST_UNLOCK(&translators);
453                         return NULL;
454                 }
455                 if (dst_index == t->dst_fmt_index) {
456                         explicit_dst = dst;
457                 }
458                 if (!(cur = newpvt(t, explicit_dst))) {
459                         int src_id = index2format(src_index);
460                         int dst_id = index2format(dst_index);
461                         ast_log(LOG_WARNING, "Failed to build translator step from %s to %s\n",
462                                 ast_getformatname(ast_format_set(&tmp_fmt1, src_id, 0)),
463                                 ast_getformatname(ast_format_set(&tmp_fmt2, dst_id, 0)));
464                         if (head) {
465                                 ast_translator_free_path(head);
466                         }
467                         AST_RWLIST_UNLOCK(&translators);
468                         return NULL;
469                 }
470                 if (!head) {
471                         head = cur;
472                 } else {
473                         tail->next = cur;
474                 }
475                 tail = cur;
476                 cur->nextin = cur->nextout = ast_tv(0, 0);
477                 /* Keep going if this isn't the final destination */
478                 src_index = cur->t->dst_fmt_index;
479         }
480
481         AST_RWLIST_UNLOCK(&translators);
482         return head;
483 }
484
485 /*! \brief do the actual translation */
486 struct ast_frame *ast_translate(struct ast_trans_pvt *path, struct ast_frame *f, int consume)
487 {
488         struct ast_trans_pvt *p = path;
489         struct ast_frame *out;
490         struct timeval delivery;
491         int has_timing_info;
492         long ts;
493         long len;
494         int seqno;
495
496         has_timing_info = ast_test_flag(f, AST_FRFLAG_HAS_TIMING_INFO);
497         ts = f->ts;
498         len = f->len;
499         seqno = f->seqno;
500
501         if (!ast_tvzero(f->delivery)) {
502                 if (!ast_tvzero(path->nextin)) {
503                         /* Make sure this is in line with what we were expecting */
504                         if (!ast_tveq(path->nextin, f->delivery)) {
505                                 /* The time has changed between what we expected and this
506                                    most recent time on the new packet.  If we have a
507                                    valid prediction adjust our output time appropriately */
508                                 if (!ast_tvzero(path->nextout)) {
509                                         path->nextout = ast_tvadd(path->nextout,
510                                                                   ast_tvsub(f->delivery, path->nextin));
511                                 }
512                                 path->nextin = f->delivery;
513                         }
514                 } else {
515                         /* This is our first pass.  Make sure the timing looks good */
516                         path->nextin = f->delivery;
517                         path->nextout = f->delivery;
518                 }
519                 /* Predict next incoming sample */
520                 path->nextin = ast_tvadd(path->nextin, ast_samp2tv(f->samples, ast_format_rate(&f->subclass.format)));
521         }
522         delivery = f->delivery;
523         for (out = f; out && p ; p = p->next) {
524                 framein(p, out);
525                 if (out != f) {
526                         ast_frfree(out);
527                 }
528                 out = p->t->frameout(p);
529         }
530         if (consume) {
531                 ast_frfree(f);
532         }
533         if (out == NULL) {
534                 return NULL;
535         }
536         /* we have a frame, play with times */
537         if (!ast_tvzero(delivery)) {
538                 /* Regenerate prediction after a discontinuity */
539                 if (ast_tvzero(path->nextout)) {
540                         path->nextout = ast_tvnow();
541                 }
542
543                 /* Use next predicted outgoing timestamp */
544                 out->delivery = path->nextout;
545
546                 /* Predict next outgoing timestamp from samples in this
547                    frame. */
548                 path->nextout = ast_tvadd(path->nextout, ast_samp2tv(out->samples, ast_format_rate(&out->subclass.format)));
549         } else {
550                 out->delivery = ast_tv(0, 0);
551                 ast_set2_flag(out, has_timing_info, AST_FRFLAG_HAS_TIMING_INFO);
552                 if (has_timing_info) {
553                         out->ts = ts;
554                         out->len = len;
555                         out->seqno = seqno;
556                 }
557         }
558         /* Invalidate prediction if we're entering a silence period */
559         if (out->frametype == AST_FRAME_CNG) {
560                 path->nextout = ast_tv(0, 0);
561         }
562         return out;
563 }
564
565 /*!
566  * \internal
567  * \brief Compute the computational cost of a single translation step.
568  *
569  * \note This function is only used to decide which translation path to
570  * use between two translators with identical src and dst formats.  Computational
571  * cost acts only as a tie breaker. This is done so hardware translators
572  * can naturally have precedence over software translators.
573  */
574 static void generate_computational_cost(struct ast_translator *t, int seconds)
575 {
576         int num_samples = 0;
577         struct ast_trans_pvt *pvt;
578         struct rusage start;
579         struct rusage end;
580         int cost;
581         int out_rate = ast_format_rate(&t->dst_format);
582
583         if (!seconds) {
584                 seconds = 1;
585         }
586
587         /* If they don't make samples, give them a terrible score */
588         if (!t->sample) {
589                 ast_debug(3, "Translator '%s' does not produce sample frames.\n", t->name);
590                 t->comp_cost = 999999;
591                 return;
592         }
593
594         pvt = newpvt(t, NULL);
595         if (!pvt) {
596                 ast_log(LOG_WARNING, "Translator '%s' appears to be broken and will probably fail.\n", t->name);
597                 t->comp_cost = 999999;
598                 return;
599         }
600
601         getrusage(RUSAGE_SELF, &start);
602
603         /* Call the encoder until we've processed the required number of samples */
604         while (num_samples < seconds * out_rate) {
605                 struct ast_frame *f = t->sample();
606                 if (!f) {
607                         ast_log(LOG_WARNING, "Translator '%s' failed to produce a sample frame.\n", t->name);
608                         destroy(pvt);
609                         t->comp_cost = 999999;
610                         return;
611                 }
612                 framein(pvt, f);
613                 ast_frfree(f);
614                 while ((f = t->frameout(pvt))) {
615                         num_samples += f->samples;
616                         ast_frfree(f);
617                 }
618         }
619
620         getrusage(RUSAGE_SELF, &end);
621
622         cost = ((end.ru_utime.tv_sec - start.ru_utime.tv_sec) * 1000000) + end.ru_utime.tv_usec - start.ru_utime.tv_usec;
623         cost += ((end.ru_stime.tv_sec - start.ru_stime.tv_sec) * 1000000) + end.ru_stime.tv_usec - start.ru_stime.tv_usec;
624
625         destroy(pvt);
626
627         t->comp_cost = cost / seconds;
628
629         if (!t->comp_cost) {
630                 t->comp_cost = 1;
631         }
632 }
633
634 /*!
635  * \internal
636  *
637  * \brief If no table cost value was pre set by the translator.  An attempt is made to
638  * automatically generate that cost value from the cost table based on our src and
639  * dst formats.
640  *
641  * \note This function allows older translators built before the translation cost
642  * changed away from using onely computational time to continue to be registered
643  * correctly.  It is expected that translators built after the introduction of this
644  * function will manually assign their own table cost value.
645  *
646  * \note This function is safe to use on any audio formats that used to be defined in the
647  * first 64 bits of the old bit field codec representation.
648  *
649  * \retval Table Cost value greater than 0.
650  * \retval 0 on error.
651  */
652 static int generate_table_cost(struct ast_format *src, struct ast_format *dst)
653 {
654         int src_rate = ast_format_rate(src);
655         int src_ll = 0;
656         int dst_rate = ast_format_rate(dst);
657         int dst_ll = 0;
658
659         if ((AST_FORMAT_GET_TYPE(src->id) != AST_FORMAT_TYPE_AUDIO) || (AST_FORMAT_GET_TYPE(dst->id) != AST_FORMAT_TYPE_AUDIO)) {
660                 /* This method of generating table cost is limited to audio.
661                  * Translators for media other than audio must manually set their
662                  * table cost. */
663                 return 0;
664         }
665         src_ll = ast_format_is_slinear(src);
666         dst_ll = ast_format_is_slinear(dst);
667         if (src_ll) {
668                 if (dst_ll && (src_rate == dst_rate)) {
669                         return AST_TRANS_COST_LL_LL_ORIGSAMP;
670                 } else if (!dst_ll && (src_rate == dst_rate)) {
671                         return AST_TRANS_COST_LL_LY_ORIGSAMP;
672                 } else if (dst_ll && (src_rate < dst_rate)) {
673                         return AST_TRANS_COST_LL_LL_UPSAMP;
674                 } else if (!dst_ll && (src_rate < dst_rate)) {
675                         return AST_TRANS_COST_LL_LY_UPSAMP;
676                 } else if (dst_ll && (src_rate > dst_rate)) {
677                         return AST_TRANS_COST_LL_LL_DOWNSAMP;
678                 } else if (!dst_ll && (src_rate > dst_rate)) {
679                         return AST_TRANS_COST_LL_LY_DOWNSAMP;
680                 } else {
681                         return AST_TRANS_COST_LL_UNKNOWN;
682                 }
683         } else {
684                 if (dst_ll && (src_rate == dst_rate)) {
685                         return AST_TRANS_COST_LY_LL_ORIGSAMP;
686                 } else if (!dst_ll && (src_rate == dst_rate)) {
687                         return AST_TRANS_COST_LY_LY_ORIGSAMP;
688                 } else if (dst_ll && (src_rate < dst_rate)) {
689                         return AST_TRANS_COST_LY_LL_UPSAMP;
690                 } else if (!dst_ll && (src_rate < dst_rate)) {
691                         return AST_TRANS_COST_LY_LY_UPSAMP;
692                 } else if (dst_ll && (src_rate > dst_rate)) {
693                         return AST_TRANS_COST_LY_LL_DOWNSAMP;
694                 } else if (!dst_ll && (src_rate > dst_rate)) {
695                         return AST_TRANS_COST_LY_LY_DOWNSAMP;
696                 } else {
697                         return AST_TRANS_COST_LY_UNKNOWN;
698                 }
699         }
700 }
701
702 /*!
703  * \brief rebuild a translation matrix.
704  * \note This function expects the list of translators to be locked
705 */
706 static void matrix_rebuild(int samples)
707 {
708         struct ast_translator *t;
709         int newtablecost;
710         int x;      /* source format index */
711         int y;      /* intermediate format index */
712         int z;      /* destination format index */
713
714         ast_debug(1, "Resetting translation matrix\n");
715
716         matrix_clear();
717
718         /* first, compute all direct costs */
719         AST_RWLIST_TRAVERSE(&translators, t, list) {
720                 if (!t->active) {
721                         continue;
722                 }
723
724                 x = t->src_fmt_index;
725                 z = t->dst_fmt_index;
726
727                 if (samples) {
728                         generate_computational_cost(t, samples);
729                 }
730
731                 /* This new translator is the best choice if any of the below are true.
732                  * 1. no translation path is set between x and z yet.
733                  * 2. the new table cost is less.
734                  * 3. the new computational cost is less.  Computational cost is only used
735                  *    to break a tie between two identical translation paths.
736                  */
737                 if (!matrix_get(x, z)->step ||
738                         (t->table_cost < matrix_get(x, z)->step->table_cost) ||
739                         (t->comp_cost < matrix_get(x, z)->step->comp_cost)) {
740
741                         matrix_get(x, z)->step = t;
742                         matrix_get(x, z)->table_cost = t->table_cost;
743                 }
744         }
745
746         /*
747          * For each triple x, y, z of distinct formats, check if there is
748          * a path from x to z through y which is cheaper than what is
749          * currently known, and in case, update the matrix.
750          * Repeat until the matrix is stable.
751          */
752         for (;;) {
753                 int changed = 0;
754                 for (x = 0; x < cur_max_index; x++) {      /* source format */
755                         for (y = 0; y < cur_max_index; y++) {  /* intermediate format */
756                                 if (x == y) {                      /* skip ourselves */
757                                         continue;
758                                 }
759                                 for (z = 0; z < cur_max_index; z++) {  /* dst format */
760                                         if ((z == x || z == y) ||        /* skip null conversions */
761                                                 !matrix_get(x, y)->step ||   /* no path from x to y */
762                                                 !matrix_get(y, z)->step) {   /* no path from y to z */
763                                                 continue;
764                                         }
765
766                                         /* calculate table cost from x->y->z */
767                                         newtablecost = matrix_get(x, y)->table_cost + matrix_get(y, z)->table_cost;
768
769                                         /* if no step already exists between x and z OR the new cost of using the intermediate
770                                          * step is cheaper, use this step. */
771                                         if (!matrix_get(x, z)->step || (newtablecost < matrix_get(x, z)->table_cost)) {
772                                                 struct ast_format tmpx;
773                                                 struct ast_format tmpy;
774                                                 struct ast_format tmpz;
775                                                 matrix_get(x, z)->step = matrix_get(x, y)->step;
776                                                 matrix_get(x, z)->table_cost = newtablecost;
777                                                 matrix_get(x, z)->multistep = 1;
778                                                 changed++;
779                                                 ast_debug(3, "Discovered %d cost path from %s to %s, via %s\n",
780                                                         matrix_get(x, z)->table_cost,
781                                                         ast_getformatname(ast_format_set(&tmpx, index2format(x), 0)),
782                                                         ast_getformatname(ast_format_set(&tmpy, index2format(z), 0)),
783                                                         ast_getformatname(ast_format_set(&tmpz, index2format(y), 0)));
784                                         }
785                                 }
786                         }
787                 }
788                 if (!changed) {
789                         break;
790                 }
791         }
792 }
793
794 const char *ast_translate_path_to_str(struct ast_trans_pvt *p, struct ast_str **str)
795 {
796         struct ast_trans_pvt *pn = p;
797         char tmp[256];
798
799         if (!p || !p->t) {
800                 return "";
801         }
802
803         ast_str_set(str, 0, "%s", ast_getformatname_multiple_byid(tmp, sizeof(tmp), p->t->src_format.id));
804
805         while ( (p = pn) ) {
806                 pn = p->next;
807                 ast_str_append(str, 0, "->%s", ast_getformatname_multiple_byid(tmp, sizeof(tmp), p->t->dst_format.id));
808         }
809
810         return ast_str_buffer(*str);
811 }
812
813 static char *complete_trans_path_choice(const char *line, const char *word, int pos, int state)
814 {
815         int which = 0;
816         int wordlen = strlen(word);
817         int i;
818         char *ret = NULL;
819         size_t len = 0;
820         const struct ast_format_list *format_list = ast_format_list_get(&len);
821
822         for (i = 0; i < len; i++) {
823                 if (AST_FORMAT_GET_TYPE(format_list[i].format.id) != AST_FORMAT_TYPE_AUDIO) {
824                         continue;
825                 }
826                 if (!strncasecmp(word, format_list[i].name, wordlen) && ++which > state) {
827                         ret = ast_strdup(format_list[i].name);
828                         break;
829                 }
830         }
831         ast_format_list_destroy(format_list);
832         return ret;
833 }
834
835 static void handle_cli_recalc(struct ast_cli_args *a)
836 {
837         int time = a->argv[4] ? atoi(a->argv[4]) : 1;
838
839         if (time <= 0) {
840                 ast_cli(a->fd, "         Recalc must be greater than 0.  Defaulting to 1.\n");
841                 time = 1;
842         }
843
844         if (time > MAX_RECALC) {
845                 ast_cli(a->fd, "         Maximum limit of recalc exceeded by %d, truncating value to %d\n", time - MAX_RECALC, MAX_RECALC);
846                 time = MAX_RECALC;
847         }
848         ast_cli(a->fd, "         Recalculating Codec Translation (number of sample seconds: %d)\n\n", time);
849         AST_RWLIST_WRLOCK(&translators);
850         matrix_rebuild(time);
851         AST_RWLIST_UNLOCK(&translators);
852 }
853
854 static char *handle_show_translation_table(struct ast_cli_args *a)
855 {
856         int x;
857         int y;
858         int i;
859         int k;
860         int curlen = 0;
861         int longest = 0;
862         int f_len;
863         size_t f_size = 0;
864         const struct ast_format_list *f_list = ast_format_list_get(&f_size);
865         struct ast_str *out = ast_str_create(1024);
866
867         f_len = f_size;
868         AST_RWLIST_RDLOCK(&translators);
869         ast_cli(a->fd, "         Translation times between formats (in microseconds) for one second of data\n");
870         ast_cli(a->fd, "          Source Format (Rows) Destination Format (Columns)\n\n");
871
872         /* Get the length of the longest (usable?) codec name, so we know how wide the left side should be */
873         for (i = 0; i < f_len; i++) {
874                 /* translation only applies to audio right now. */
875                 if (AST_FORMAT_GET_TYPE(f_list[i].format.id) != AST_FORMAT_TYPE_AUDIO)
876                         continue;
877                 curlen = strlen(ast_getformatname(&f_list[i].format));
878                 if (curlen > longest) {
879                         longest = curlen;
880                 }
881         }
882
883         for (i = -1; i < f_len; i++) {
884                 x = -1;
885                 if ((i >= 0) && ((x = format2index(f_list[i].format.id)) == -1)) {
886                         continue;
887                 }
888                 /* translation only applies to audio right now. */
889                 if (i >= 0 && (AST_FORMAT_GET_TYPE(f_list[i].format.id) != AST_FORMAT_TYPE_AUDIO)) {
890                         continue;
891                 }
892                 /*Go ahead and move to next iteration if dealing with an unknown codec*/
893                 if (i >= 0 && !strcmp(ast_getformatname(&f_list[i].format), "unknown")) {
894                         continue;
895                 }
896                 ast_str_set(&out, 0, " ");
897                 for (k = -1; k < f_len; k++) {
898                         y = -1;
899                         if ((k >= 0) && ((y = format2index(f_list[k].format.id)) == -1)) {
900                                 continue;
901                         }
902                         /* translation only applies to audio right now. */
903                         if (k >= 0 && (AST_FORMAT_GET_TYPE(f_list[k].format.id) != AST_FORMAT_TYPE_AUDIO)) {
904                                 continue;
905                         }
906                         /*Go ahead and move to next iteration if dealing with an unknown codec*/
907                         if (k >= 0 && !strcmp(ast_getformatname(&f_list[k].format), "unknown")) {
908                                 continue;
909                         }
910                         if (k >= 0) {
911                                 curlen = strlen(ast_getformatname(&f_list[k].format));
912                         }
913                         if (curlen < 5) {
914                                 curlen = 5;
915                         }
916
917                         if (x >= 0 && y >= 0 && matrix_get(x, y)->step) {
918                                 /* Actual codec output */
919                                 ast_str_append(&out, 0, "%*d", curlen + 1, (matrix_get(x, y)->table_cost/100));
920                         } else if (i == -1 && k >= 0) {
921                                 /* Top row - use a dynamic size */
922                                 ast_str_append(&out, 0, "%*s", curlen + 1, ast_getformatname(&f_list[k].format));
923                         } else if (k == -1 && i >= 0) {
924                                 /* Left column - use a static size. */
925                                 ast_str_append(&out, 0, "%*s", longest, ast_getformatname(&f_list[i].format));
926                         } else if (x >= 0 && y >= 0) {
927                                 /* Codec not supported */
928                                 ast_str_append(&out, 0, "%*s", curlen + 1, "-");
929                         } else {
930                                 /* Upper left hand corner */
931                                 ast_str_append(&out, 0, "%*s", longest, "");
932                         }
933                 }
934                 ast_str_append(&out, 0, "\n");
935                 ast_cli(a->fd, "%s", ast_str_buffer(out));
936         }
937         ast_free(out);
938         AST_RWLIST_UNLOCK(&translators);
939         ast_format_list_destroy(f_list);
940         return CLI_SUCCESS;
941 }
942
943 static char *handle_show_translation_path(struct ast_cli_args *a)
944 {
945         struct ast_format input_src_format;
946         size_t len = 0;
947         int i;
948         const struct ast_format_list *format_list = ast_format_list_get(&len);
949         struct ast_str *str = ast_str_alloca(1024);
950         struct ast_translator *step;
951         char tmp[256];
952
953         ast_format_clear(&input_src_format);
954         for (i = 0; i < len; i++) {
955                 if (AST_FORMAT_GET_TYPE(format_list[i].format.id) != AST_FORMAT_TYPE_AUDIO) {
956                         continue;
957                 }
958                 if (!strncasecmp(format_list[i].name, a->argv[4], strlen(format_list[i].name))) {
959                         ast_format_copy(&input_src_format, &format_list[i].format);
960                 }
961         }
962
963         if (!input_src_format.id) {
964                 ast_cli(a->fd, "Source codec \"%s\" is not found.\n", a->argv[4]);
965                 ast_format_list_destroy(format_list);
966                 return CLI_FAILURE;
967         }
968
969         AST_RWLIST_RDLOCK(&translators);
970         ast_cli(a->fd, "--- Translation paths SRC Codec \"%s\" sample rate %d ---\n", a->argv[4], ast_format_rate(&input_src_format));
971         for (i = 0; i < len; i++) {
972                 int src;
973                 int dst;
974                 if ((AST_FORMAT_GET_TYPE(format_list[i].format.id) != AST_FORMAT_TYPE_AUDIO) || (format_list[i].format.id == input_src_format.id)) {
975                         continue;
976                 }
977                 dst = format2index(format_list[i].format.id);
978                 src = format2index(input_src_format.id);
979                 ast_str_reset(str);
980                 if ((len >= cur_max_index) && (src != -1) && (dst != -1) && matrix_get(src, dst)->step) {
981                         ast_str_append(&str, 0, "%s", ast_getformatname_multiple_byid(tmp, sizeof(tmp), matrix_get(src, dst)->step->src_format.id));
982                         while (src != dst) {
983                                 step = matrix_get(src, dst)->step;
984                                 if (!step) {
985                                         ast_str_reset(str);
986                                         break;
987                                 }
988                                 ast_str_append(&str, 0, "->%s", ast_getformatname_multiple_byid(tmp, sizeof(tmp), step->dst_format.id));
989                                 src = step->dst_fmt_index;
990                         }
991                 }
992
993                 if (ast_strlen_zero(ast_str_buffer(str))) {
994                         ast_str_set(&str, 0, "No Translation Path");
995                 }
996                 ast_cli(a->fd, "\t%-10.10s To %-10.10s: %-60.60s\n", a->argv[4], format_list[i].name, ast_str_buffer(str));
997         }
998         AST_RWLIST_UNLOCK(&translators);
999
1000         ast_format_list_destroy(format_list);
1001         return CLI_SUCCESS;
1002 }
1003
1004 static char *handle_cli_core_show_translation(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1005 {
1006         static const char * const option[] = { "recalc", "paths", NULL };
1007
1008         switch (cmd) {
1009         case CLI_INIT:
1010                 e->command = "core show translation";
1011                 e->usage =
1012                         "Usage: 'core show translation' can be used in two ways.\n"
1013                         "       1. 'core show translation [recalc [<recalc seconds>]]\n"
1014                         "          Displays known codec translators and the cost associated\n"
1015                         "          with each conversion.  If the argument 'recalc' is supplied along\n"
1016                         "          with optional number of seconds to test a new test will be performed\n"
1017                         "          as the chart is being displayed.\n"
1018                         "       2. 'core show translation paths [codec]'\n"
1019                         "           This will display all the translation paths associated with a codec\n";
1020                 return NULL;
1021         case CLI_GENERATE:
1022                 if (a->pos == 3) {
1023                         return ast_cli_complete(a->word, option, a->n);
1024                 }
1025                 if (a->pos == 4 && !strcasecmp(a->argv[3], option[1])) {
1026                         return complete_trans_path_choice(a->line, a->word, a->pos, a->n);
1027                 }
1028                 return NULL;
1029         }
1030
1031         if (a->argc > 5)
1032                 return CLI_SHOWUSAGE;
1033
1034         if (a->argv[3] && !strcasecmp(a->argv[3], option[1]) && a->argc == 5) { /* show paths */
1035                 return handle_show_translation_path(a);
1036         } else if (a->argv[3] && !strcasecmp(a->argv[3], option[0])) { /* recalc and then fall through to show table */
1037                 handle_cli_recalc(a);
1038         } else if (a->argc > 3) { /* wrong input */
1039                 return CLI_SHOWUSAGE;
1040         }
1041
1042         return handle_show_translation_table(a);
1043 }
1044
1045 static struct ast_cli_entry cli_translate[] = {
1046         AST_CLI_DEFINE(handle_cli_core_show_translation, "Display translation matrix")
1047 };
1048
1049 /*! \brief register codec translator */
1050 int __ast_register_translator(struct ast_translator *t, struct ast_module *mod)
1051 {
1052         struct ast_translator *u;
1053         char tmp[80];
1054
1055         if (add_format2index(t->src_format.id) || add_format2index(t->dst_format.id)) {
1056                 if (matrix_resize(0)) {
1057                         ast_log(LOG_WARNING, "Translator matrix can not represent any more translators.  Out of resources.\n");
1058                         return -1;
1059                 }
1060                 add_format2index(t->src_format.id);
1061                 add_format2index(t->dst_format.id);
1062         }
1063
1064         if (!mod) {
1065                 ast_log(LOG_WARNING, "Missing module pointer, you need to supply one\n");
1066                 return -1;
1067         }
1068
1069         if (!t->buf_size) {
1070                 ast_log(LOG_WARNING, "empty buf size, you need to supply one\n");
1071                 return -1;
1072         }
1073         if (!t->table_cost && !(t->table_cost = generate_table_cost(&t->src_format, &t->dst_format))) {
1074                 ast_log(LOG_WARNING, "Table cost could not be generated for %s, "
1075                         "Please set table_cost variable on translator.\n", t->name);
1076                 return -1;
1077         }
1078
1079         t->module = mod;
1080         t->src_fmt_index = format2index(t->src_format.id);
1081         t->dst_fmt_index = format2index(t->dst_format.id);
1082         t->active = 1;
1083
1084         if (t->src_fmt_index == -1 || t->dst_fmt_index == -1) {
1085                 ast_log(LOG_WARNING, "Invalid translator path: (%s codec is not valid)\n", t->src_fmt_index == -1 ? "starting" : "ending");
1086                 return -1;
1087         }
1088         if (t->src_fmt_index >= cur_max_index) {
1089                 ast_log(LOG_WARNING, "Source format %s is larger than cur_max_index\n", ast_getformatname(&t->src_format));
1090                 return -1;
1091         }
1092
1093         if (t->dst_fmt_index >= cur_max_index) {
1094                 ast_log(LOG_WARNING, "Destination format %s is larger than cur_max_index\n", ast_getformatname(&t->dst_format));
1095                 return -1;
1096         }
1097
1098         if (t->buf_size) {
1099                 /*
1100                  * Align buf_size properly, rounding up to the machine-specific
1101                  * alignment for pointers.
1102                  */
1103                 struct _test_align { void *a, *b; } p;
1104                 int align = (char *)&p.b - (char *)&p.a;
1105
1106                 t->buf_size = ((t->buf_size + align - 1) / align) * align;
1107         }
1108
1109         if (t->frameout == NULL) {
1110                 t->frameout = default_frameout;
1111         }
1112
1113         generate_computational_cost(t, 1);
1114
1115         ast_verb(2, "Registered translator '%s' from format %s to %s, table cost, %d, computational cost %d\n",
1116                             term_color(tmp, t->name, COLOR_MAGENTA, COLOR_BLACK, sizeof(tmp)),
1117                             ast_getformatname(&t->src_format), ast_getformatname(&t->dst_format), t->table_cost, t->comp_cost);
1118
1119         AST_RWLIST_WRLOCK(&translators);
1120
1121         /* find any existing translators that provide this same srcfmt/dstfmt,
1122            and put this one in order based on computational cost */
1123         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&translators, u, list) {
1124                 if ((u->src_fmt_index == t->src_fmt_index) &&
1125                     (u->dst_fmt_index == t->dst_fmt_index) &&
1126                     (u->comp_cost > t->comp_cost)) {
1127                         AST_RWLIST_INSERT_BEFORE_CURRENT(t, list);
1128                         t = NULL;
1129                         break;
1130                 }
1131         }
1132         AST_RWLIST_TRAVERSE_SAFE_END;
1133
1134         /* if no existing translator was found for this format combination,
1135            add it to the beginning of the list */
1136         if (t) {
1137                 AST_RWLIST_INSERT_HEAD(&translators, t, list);
1138         }
1139
1140         matrix_rebuild(0);
1141
1142         AST_RWLIST_UNLOCK(&translators);
1143
1144         return 0;
1145 }
1146
1147 /*! \brief unregister codec translator */
1148 int ast_unregister_translator(struct ast_translator *t)
1149 {
1150         char tmp[80];
1151         struct ast_translator *u;
1152         int found = 0;
1153
1154         AST_RWLIST_WRLOCK(&translators);
1155         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&translators, u, list) {
1156                 if (u == t) {
1157                         AST_RWLIST_REMOVE_CURRENT(list);
1158                         ast_verb(2, "Unregistered translator '%s' from format %s to %s\n",
1159                                 term_color(tmp, t->name, COLOR_MAGENTA, COLOR_BLACK, sizeof(tmp)),
1160                                 ast_getformatname(&t->src_format),
1161                                 ast_getformatname(&t->dst_format));
1162                         found = 1;
1163                         break;
1164                 }
1165         }
1166         AST_RWLIST_TRAVERSE_SAFE_END;
1167
1168         if (found) {
1169                 matrix_rebuild(0);
1170         }
1171
1172         AST_RWLIST_UNLOCK(&translators);
1173
1174         return (u ? 0 : -1);
1175 }
1176
1177 void ast_translator_activate(struct ast_translator *t)
1178 {
1179         AST_RWLIST_WRLOCK(&translators);
1180         t->active = 1;
1181         matrix_rebuild(0);
1182         AST_RWLIST_UNLOCK(&translators);
1183 }
1184
1185 void ast_translator_deactivate(struct ast_translator *t)
1186 {
1187         AST_RWLIST_WRLOCK(&translators);
1188         t->active = 0;
1189         matrix_rebuild(0);
1190         AST_RWLIST_UNLOCK(&translators);
1191 }
1192
1193 /*! \brief Calculate our best translator source format, given costs, and a desired destination */
1194 int ast_translator_best_choice(struct ast_format_cap *dst_cap,
1195         struct ast_format_cap *src_cap,
1196         struct ast_format *dst_fmt_out,
1197         struct ast_format *src_fmt_out)
1198 {
1199         unsigned int besttablecost = INT_MAX;
1200         unsigned int beststeps = INT_MAX;
1201         struct ast_format best;
1202         struct ast_format bestdst;
1203         struct ast_format_cap *joint_cap = ast_format_cap_joint(dst_cap, src_cap);
1204         ast_format_clear(&best);
1205         ast_format_clear(&bestdst);
1206
1207         if (joint_cap) { /* yes, pick one and return */
1208                 struct ast_format tmp_fmt;
1209                 ast_format_cap_iter_start(joint_cap);
1210                 while (!ast_format_cap_iter_next(joint_cap, &tmp_fmt)) {
1211                         /* We are guaranteed to find one common format. */
1212                         if (!best.id) {
1213                                 ast_format_copy(&best, &tmp_fmt);
1214                                 continue;
1215                         }
1216                         /* If there are multiple common formats, pick the one with the highest sample rate */
1217                         if (ast_format_rate(&best) < ast_format_rate(&tmp_fmt)) {
1218                                 ast_format_copy(&best, &tmp_fmt);
1219                                 continue;
1220                         }
1221
1222                 }
1223                 ast_format_cap_iter_end(joint_cap);
1224
1225                 /* We are done, this is a common format to both. */
1226                 ast_format_copy(dst_fmt_out, &best);
1227                 ast_format_copy(src_fmt_out, &best);
1228                 ast_format_cap_destroy(joint_cap);
1229                 return 0;
1230         } else {      /* No, we will need to translate */
1231                 struct ast_format cur_dst;
1232                 struct ast_format cur_src;
1233                 AST_RWLIST_RDLOCK(&translators);
1234
1235                 ast_format_cap_iter_start(dst_cap);
1236                 while (!ast_format_cap_iter_next(dst_cap, &cur_dst)) {
1237                         ast_format_cap_iter_start(src_cap);
1238                         while (!ast_format_cap_iter_next(src_cap, &cur_src)) {
1239                                 int x = format2index(cur_src.id);
1240                                 int y = format2index(cur_dst.id);
1241                                 if (x < 0 || y < 0) {
1242                                         continue;
1243                                 }
1244                                 if (!matrix_get(x, y) || !(matrix_get(x, y)->step)) {
1245                                         continue;
1246                                 }
1247                                 if (((matrix_get(x, y)->table_cost < besttablecost) || (matrix_get(x, y)->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 = matrix_get(x, y)->table_cost;
1252                                         beststeps = matrix_get(x, y)->multistep;
1253                                 }
1254                         }
1255                         ast_format_cap_iter_end(src_cap);
1256                 }
1257
1258                 ast_format_cap_iter_end(dst_cap);
1259                 AST_RWLIST_UNLOCK(&translators);
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 == -1 || dest == -1) {
1278                 ast_log(LOG_WARNING, "No translator path: (%s codec is not valid)\n", src == -1 ? "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 int ast_translate_init(void)
1406 {
1407         int res = 0;
1408         ast_rwlock_init(&tablelock);
1409         res = matrix_resize(1);
1410         res |= ast_cli_register_multiple(cli_translate, ARRAY_LEN(cli_translate));
1411         return res;
1412 }