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