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