Asterisk - The Open Source Telephony Project GIT-master-55f4e6d
Data Structures | Macros | Enumerations | Functions
translate.h File Reference

Support for translation of data formats. translate.c. More...

#include "asterisk/frame.h"
#include "asterisk/plc.h"
#include "asterisk/linkedlists.h"
#include "asterisk/format_cap.h"
#include "asterisk/format_cache.h"
Include dependency graph for translate.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ast_trans_pvt
 Default structure for translators, with the basic fields and buffers, all allocated as part of the same chunk of memory. The buffer is preceded by AST_FRIENDLY_OFFSET bytes in front of the user portion. 'buf' points right after this space. More...
 
struct  ast_translator
 Descriptor of a translator. More...
 

Macros

#define ast_register_translator(t)   __ast_register_translator(t, AST_MODULE_SELF)
 See __ast_register_translator() More...
 

Enumerations

enum  ast_trans_cost_table {
  AST_TRANS_COST_LL_LL_ORIGSAMP = 400000 , AST_TRANS_COST_LL_LY_ORIGSAMP = 600000 , AST_TRANS_COST_LL_LL_UPSAMP = 800000 , AST_TRANS_COST_LL_LY_UPSAMP = 825000 ,
  AST_TRANS_COST_LL_LL_DOWNSAMP = 850000 , AST_TRANS_COST_LL_LY_DOWNSAMP = 875000 , AST_TRANS_COST_LL_UNKNOWN = 885000 , AST_TRANS_COST_LY_LL_ORIGSAMP = 900000 ,
  AST_TRANS_COST_LY_LY_ORIGSAMP = 915000 , AST_TRANS_COST_LY_LL_UPSAMP = 930000 , AST_TRANS_COST_LY_LY_UPSAMP = 945000 , AST_TRANS_COST_LY_LL_DOWNSAMP = 960000 ,
  AST_TRANS_COST_LY_LY_DOWNSAMP = 975000 , AST_TRANS_COST_LY_UNKNOWN = 985000
}
 Translator Cost Table definition. More...
 

Functions

int __ast_register_translator (struct ast_translator *t, struct ast_module *module)
 Register a translator This registers a codec translator with asterisk. More...
 
struct ast_frameast_trans_frameout (struct ast_trans_pvt *pvt, int datalen, int samples)
 generic frameout function More...
 
struct ast_frameast_translate (struct ast_trans_pvt *tr, struct ast_frame *f, int consume)
 translates one or more frames Apply an input frame into the translator and receive zero or one output frames. Consume determines whether the original frame should be freed. In case the frame type is AST_FRAME_RTCP, the frame is not translated but passed to the translator codecs via the feedback callback, and a pointer to ast_null_frame is returned after that. More...
 
void ast_translate_available_formats (struct ast_format_cap *dest, struct ast_format_cap *src, struct ast_format_cap *result)
 Find available formats. More...
 
int ast_translate_init (void)
 Initialize the translation matrix and index to format conversion table. More...
 
unsigned int ast_translate_path_steps (struct ast_format *dest, struct ast_format *src)
 Returns the number of steps required to convert from 'src' to 'dest'. More...
 
const char * ast_translate_path_to_str (struct ast_trans_pvt *t, struct ast_str **str)
 Puts a string representation of the translation path into outbuf. More...
 
void ast_translator_activate (struct ast_translator *t)
 Activate a previously deactivated translator. More...
 
int ast_translator_best_choice (struct ast_format_cap *dst_cap, struct ast_format_cap *src_cap, struct ast_format **dst_fmt_out, struct ast_format **src_fmt_out)
 Chooses the best translation path. More...
 
struct ast_trans_pvtast_translator_build_path (struct ast_format *dest, struct ast_format *source)
 Builds a translator path Build a path (possibly NULL) from source to dest. More...
 
void ast_translator_deactivate (struct ast_translator *t)
 Deactivate a translator. More...
 
void ast_translator_free_path (struct ast_trans_pvt *tr)
 Frees a translator path Frees the given translator path structure. More...
 
int ast_unregister_translator (struct ast_translator *t)
 Unregister a translator Unregisters the given translator. More...
 

Detailed Description

Support for translation of data formats. translate.c.

Definition in file translate.h.

Macro Definition Documentation

◆ ast_register_translator

#define ast_register_translator (   t)    __ast_register_translator(t, AST_MODULE_SELF)

See __ast_register_translator()

Definition at line 258 of file translate.h.

Enumeration Type Documentation

◆ ast_trans_cost_table

Translator Cost Table definition.

Note
The defined values in this table must be used to set the translator's table_cost value.
The cost value of the first two values must always add up to be greater than the largest value defined in this table. This is done to guarantee a direct translation will always have precedence over a multi step translation.

This table is built in a way that allows translation paths to be built that guarantee the best possible balance between performance and quality. With this table direct translation paths between two formats will always take precedence over multi step paths, lossless intermediate steps will always be chosen over lossy intermediate steps, and preservation of sample rate across the translation will always have precedence over a path that involves any re-sampling.

Enumerator
AST_TRANS_COST_LL_LL_ORIGSAMP 

[lossless -> lossless] original sampling

AST_TRANS_COST_LL_LY_ORIGSAMP 

[lossless -> lossy] original sampling

AST_TRANS_COST_LL_LL_UPSAMP 

[lossless -> lossless] up sample

AST_TRANS_COST_LL_LY_UPSAMP 

[lossless -> lossy] up sample

AST_TRANS_COST_LL_LL_DOWNSAMP 

[lossless -> lossless] down sample

AST_TRANS_COST_LL_LY_DOWNSAMP 

[lossless -> lossy] down sample

AST_TRANS_COST_LL_UNKNOWN 

[lossless -> unknown] unknown. This value is for a lossless source translation with an unknown destination and or sample rate conversion.

AST_TRANS_COST_LY_LL_ORIGSAMP 

[lossy -> lossless] original sampling

AST_TRANS_COST_LY_LY_ORIGSAMP 

[lossy -> lossy] original sampling

AST_TRANS_COST_LY_LL_UPSAMP 

[lossy -> lossless] up sample

AST_TRANS_COST_LY_LY_UPSAMP 

[lossy -> lossy] up sample

AST_TRANS_COST_LY_LL_DOWNSAMP 

[lossy -> lossless] down sample

AST_TRANS_COST_LY_LY_DOWNSAMP 

[lossy -> lossy] down sample

AST_TRANS_COST_LY_UNKNOWN 

[lossy -> unknown] unknown. This value is for a lossy source translation with an unknown destination and or sample rate conversion.

Definition at line 61 of file translate.h.

61 {
62
63 /* Lossless Source Translation Costs */
64
65 /*! [lossless -> lossless] original sampling */
67 /*! [lossless -> lossy] original sampling */
69
70 /*! [lossless -> lossless] up sample */
72 /*! [lossless -> lossy] up sample */
74
75 /*! [lossless -> lossless] down sample */
77 /*! [lossless -> lossy] down sample */
79
80 /*! [lossless -> unknown] unknown.
81 * This value is for a lossless source translation
82 * with an unknown destination and or sample rate conversion. */
84
85 /* Lossy Source Translation Costs */
86
87 /*! [lossy -> lossless] original sampling */
89 /*! [lossy -> lossy] original sampling */
91
92 /*! [lossy -> lossless] up sample */
94 /*! [lossy -> lossy] up sample */
96
97 /*! [lossy -> lossless] down sample */
99 /*! [lossy -> lossy] down sample */
101
102 /*! [lossy -> unknown] unknown.
103 * This value is for a lossy source translation
104 * with an unknown destination and or sample rate conversion. */
106
107};
@ AST_TRANS_COST_LY_LY_DOWNSAMP
Definition: translate.h:100
@ AST_TRANS_COST_LL_LL_DOWNSAMP
Definition: translate.h:76
@ AST_TRANS_COST_LY_LY_ORIGSAMP
Definition: translate.h:90
@ AST_TRANS_COST_LL_LL_UPSAMP
Definition: translate.h:71
@ AST_TRANS_COST_LY_LL_ORIGSAMP
Definition: translate.h:88
@ AST_TRANS_COST_LL_UNKNOWN
Definition: translate.h:83
@ AST_TRANS_COST_LY_LL_DOWNSAMP
Definition: translate.h:98
@ AST_TRANS_COST_LL_LY_DOWNSAMP
Definition: translate.h:78
@ AST_TRANS_COST_LL_LY_ORIGSAMP
Definition: translate.h:68
@ AST_TRANS_COST_LY_UNKNOWN
Definition: translate.h:105
@ AST_TRANS_COST_LL_LY_UPSAMP
Definition: translate.h:73
@ AST_TRANS_COST_LY_LY_UPSAMP
Definition: translate.h:95
@ AST_TRANS_COST_LY_LL_UPSAMP
Definition: translate.h:93
@ AST_TRANS_COST_LL_LL_ORIGSAMP
Definition: translate.h:66

Function Documentation

◆ __ast_register_translator()

int __ast_register_translator ( struct ast_translator t,
struct ast_module mod 
)

Register a translator This registers a codec translator with asterisk.

Parameters
tpopulated ast_translator structure
modmodule handle to the module that owns this translator
Return values
0on success
-1on failure

Register a translator This registers a codec translator with asterisk.

Definition at line 1237 of file translate.c.

1238{
1239 struct ast_translator *u;
1240 char tmp[80];
1243
1245 if (!src_codec) {
1246 ast_assert(0);
1247 ast_log(LOG_WARNING, "Failed to register translator: unknown source codec %s\n", t->src_codec.name);
1248 return -1;
1249 }
1250
1252 if (!dst_codec) {
1253 ast_log(LOG_WARNING, "Failed to register translator: unknown destination codec %s\n", t->dst_codec.name);
1254 return -1;
1255 }
1256
1258 if (matrix_resize(0)) {
1259 ast_log(LOG_WARNING, "Translator matrix can not represent any more translators. Out of resources.\n");
1260 return -1;
1261 }
1264 }
1265
1266 if (!mod) {
1267 ast_log(LOG_WARNING, "Missing module pointer, you need to supply one\n");
1268 return -1;
1269 }
1270
1271 if (!t->buf_size) {
1272 ast_log(LOG_WARNING, "empty buf size, you need to supply one\n");
1273 return -1;
1274 }
1276 ast_log(LOG_WARNING, "Table cost could not be generated for %s, "
1277 "Please set table_cost variable on translator.\n", t->name);
1278 return -1;
1279 }
1280
1281 t->module = mod;
1284 t->active = 1;
1285
1286 if (t->src_fmt_index < 0 || t->dst_fmt_index < 0) {
1287 ast_log(LOG_WARNING, "Invalid translator path: (%s codec is not valid)\n", t->src_fmt_index < 0 ? "starting" : "ending");
1288 return -1;
1289 }
1290 if (t->src_fmt_index >= cur_max_index) {
1291 ast_log(LOG_WARNING, "Source codec %s is larger than cur_max_index\n", t->src_codec.name);
1292 return -1;
1293 }
1294
1295 if (t->dst_fmt_index >= cur_max_index) {
1296 ast_log(LOG_WARNING, "Destination codec %s is larger than cur_max_index\n", t->dst_codec.name);
1297 return -1;
1298 }
1299
1300 if (t->buf_size) {
1301 /*
1302 * Align buf_size properly, rounding up to the machine-specific
1303 * alignment for pointers.
1304 */
1305 struct _test_align { void *a, *b; } p;
1306 int align = (char *)&p.b - (char *)&p.a;
1307
1308 t->buf_size = ((t->buf_size + align - 1) / align) * align;
1309 }
1310
1311 if (t->frameout == NULL) {
1313 }
1314
1316
1317 ast_verb(5, "Registered translator '%s' from codec %s to %s, table cost, %d, computational cost %d\n",
1320
1322
1323 /* find any existing translators that provide this same srcfmt/dstfmt,
1324 and put this one in order based on computational cost */
1326 if ((u->src_fmt_index == t->src_fmt_index) &&
1327 (u->dst_fmt_index == t->dst_fmt_index) &&
1328 (u->comp_cost > t->comp_cost)) {
1330 t = NULL;
1331 break;
1332 }
1333 }
1335
1336 /* if no existing translator was found for this codec combination,
1337 add it to the beginning of the list */
1338 if (t) {
1340 }
1341
1342 matrix_rebuild(0);
1343
1345
1346 return 0;
1347}
#define ast_log
Definition: astobj2.c:42
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
static int tmp()
Definition: bt_open.c:389
struct ast_codec * ast_codec_get(const char *name, enum ast_media_type type, unsigned int sample_rate)
Retrieve a codec given a name, type, and sample rate.
Definition: codec.c:327
#define ast_verb(level,...)
#define LOG_WARNING
#define AST_RWLIST_TRAVERSE_SAFE_BEGIN
Definition: linkedlists.h:545
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:52
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:151
#define AST_RWLIST_TRAVERSE_SAFE_END
Definition: linkedlists.h:617
#define AST_RWLIST_INSERT_HEAD
Definition: linkedlists.h:718
#define AST_RWLIST_INSERT_BEFORE_CURRENT
Definition: linkedlists.h:610
#define NULL
Definition: resample.c:96
Represents a media codec within Asterisk.
Definition: codec.h:42
unsigned int sample_rate
Sample rate (number of samples carried in a second)
Definition: codec.h:52
enum ast_media_type type
Type of media this codec contains.
Definition: codec.h:50
const char * name
Name for this codec.
Definition: codec.h:46
Descriptor of a translator.
Definition: translate.h:137
char name[80]
Definition: translate.h:138
int buf_size
size of outbuf, in bytes. Mandatory. The wrapper code will also allocate an AST_FRIENDLY_OFFSET space...
Definition: translate.h:182
struct ast_codec src_codec
Definition: translate.h:139
struct ast_module * module
Definition: translate.h:187
struct ast_frame *(* frameout)(struct ast_trans_pvt *pvt)
Definition: translate.h:158
struct ast_codec dst_codec
Definition: translate.h:140
the list of translators
Definition: codec_dahdi.c:281
#define COLOR_MAGENTA
Definition: term.h:60
#define COLOR_BLACK
Definition: term.h:50
char * term_color(char *outbuf, const char *inbuf, int fgcolor, int bgcolor, int maxout)
Colorize a specified string by adding terminal color codes.
Definition: term.c:235
static struct test_val b
static struct test_val a
static int cur_max_index
Definition: translate.c:95
static int add_codec2index(struct ast_codec *codec)
Definition: translate.c:148
static struct ast_frame * default_frameout(struct ast_trans_pvt *pvt)
Definition: translate.c:469
static void matrix_rebuild(int samples)
rebuild a translation matrix.
Definition: translate.c:825
static int matrix_resize(int init)
Definition: translate.c:195
static int codec2index(struct ast_codec *codec)
Definition: translate.c:125
static void generate_computational_cost(struct ast_translator *t, int seconds)
Definition: translate.c:691
static int generate_table_cost(struct ast_codec *src, struct ast_codec *dst)
Definition: translate.c:769
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:941
#define ast_assert(a)
Definition: utils.h:739

References a, ast_translator::active, add_codec2index(), ao2_cleanup, ast_assert, ast_codec_get(), ast_log, AST_RWLIST_INSERT_BEFORE_CURRENT, AST_RWLIST_INSERT_HEAD, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, b, ast_translator::buf_size, codec2index(), COLOR_BLACK, COLOR_MAGENTA, ast_translator::comp_cost, cur_max_index, default_frameout(), ast_translator::dst_codec, ast_translator::dst_fmt_index, ast_translator::frameout, generate_computational_cost(), generate_table_cost(), LOG_WARNING, matrix_rebuild(), matrix_resize(), ast_translator::module, ast_codec::name, ast_translator::name, NULL, RAII_VAR, ast_codec::sample_rate, ast_translator::src_codec, ast_translator::src_fmt_index, ast_translator::table_cost, term_color(), tmp(), and ast_codec::type.

◆ ast_trans_frameout()

struct ast_frame * ast_trans_frameout ( struct ast_trans_pvt pvt,
int  datalen,
int  samples 
)

generic frameout function

generic frameout function

Definition at line 439 of file translate.c.

441{
442 struct ast_frame *f = &pvt->f;
443
444 if (samples) {
445 f->samples = samples;
446 } else {
447 if (pvt->samples == 0) {
448 return NULL;
449 }
450 f->samples = pvt->samples;
451 pvt->samples = 0;
452 }
453 if (datalen) {
454 f->datalen = datalen;
455 f->data.ptr = pvt->outbuf.c;
456 } else {
457 f->datalen = pvt->datalen;
458 if (!f->datalen) {
459 f->data.ptr = NULL;
460 } else {
461 f->data.ptr = pvt->outbuf.c;
462 }
463 pvt->datalen = 0;
464 }
465
466 return ast_frisolate(f);
467}
#define ast_frisolate(fr)
Makes a frame independent of any static storage.
Data structure associated with a single frame of data.
union ast_frame::@226 data
struct ast_frame f
Definition: translate.h:215
int datalen
actual space used in outbuf
Definition: translate.h:218
union ast_trans_pvt::@287 outbuf

References ast_frisolate, ast_trans_pvt::c, ast_frame::data, ast_frame::datalen, ast_trans_pvt::datalen, ast_trans_pvt::f, NULL, ast_trans_pvt::outbuf, ast_frame::ptr, ast_frame::samples, and ast_trans_pvt::samples.

Referenced by default_frameout(), lintoadpcm_frameout(), lintocodec2_frameout(), lintogsm_frameout(), lintoilbc_frameout(), lintolpc10_frameout(), and lintospeex_frameout().

◆ ast_translate()

struct ast_frame * ast_translate ( struct ast_trans_pvt path,
struct ast_frame f,
int  consume 
)

translates one or more frames Apply an input frame into the translator and receive zero or one output frames. Consume determines whether the original frame should be freed. In case the frame type is AST_FRAME_RTCP, the frame is not translated but passed to the translator codecs via the feedback callback, and a pointer to ast_null_frame is returned after that.

Parameters
pathtr translator structure to use for translation
fframe to translate
consumeWhether or not to free the original frame
Returns
an ast_frame of the new translation format on success
Return values
NULLon failure

translates one or more frames Apply an input frame into the translator and receive zero or one output frames. Consume determines whether the original frame should be freed. In case the frame type is AST_FRAME_RTCP, the frame is not translated but passed to the translator codecs via the feedback callback, and a pointer to ast_null_frame is returned after that.

Definition at line 566 of file translate.c.

567{
568 struct ast_trans_pvt *p = path;
569 struct ast_frame *out;
570 struct timeval delivery;
571 int has_timing_info;
572 long ts;
573 long len;
574 int seqno;
575
576 if (f->frametype == AST_FRAME_RTCP) {
577 /* Just pass the feedback to the right callback, if it exists.
578 * This "translation" does nothing so return a null frame. */
579 struct ast_trans_pvt *tp;
580 for (tp = p; tp; tp = tp->next) {
581 if (tp->t->feedback)
582 tp->t->feedback(tp, f);
583 }
584 return &ast_null_frame;
585 }
586
587 has_timing_info = ast_test_flag(f, AST_FRFLAG_HAS_TIMING_INFO);
588 ts = f->ts;
589 len = f->len;
590 seqno = f->seqno;
591
592 if (!ast_tvzero(f->delivery)) {
593 if (!ast_tvzero(path->nextin)) {
594 /* Make sure this is in line with what we were expecting */
595 if (!ast_tveq(path->nextin, f->delivery)) {
596 /* The time has changed between what we expected and this
597 most recent time on the new packet. If we have a
598 valid prediction adjust our output time appropriately */
599 if (!ast_tvzero(path->nextout)) {
600 path->nextout = ast_tvadd(path->nextout,
601 ast_tvsub(f->delivery, path->nextin));
602 }
603 path->nextin = f->delivery;
604 }
605 } else {
606 /* This is our first pass. Make sure the timing looks good */
607 path->nextin = f->delivery;
608 path->nextout = f->delivery;
609 }
610 /* Predict next incoming sample */
611 path->nextin = ast_tvadd(path->nextin, ast_samp2tv(
613 }
614 delivery = f->delivery;
615 for (out = f; out && p ; p = p->next) {
616 struct ast_frame *current = out;
617
618 do {
619 framein(p, current);
621 } while (current);
622 if (out != f) {
624 }
625 out = p->t->frameout(p);
626 }
627
628 if (!out) {
630 }
631
632 if (out) {
633 /* we have a frame, play with times */
634 if (!ast_tvzero(delivery)) {
635 struct ast_frame *current = out;
636
637 do {
638 /* Regenerate prediction after a discontinuity */
639 if (ast_tvzero(path->nextout)) {
640 path->nextout = ast_tvnow();
641 }
642
643 /* Use next predicted outgoing timestamp */
644 current->delivery = path->nextout;
645
646 /* Invalidate prediction if we're entering a silence period */
647 if (current->frametype == AST_FRAME_CNG) {
648 path->nextout = ast_tv(0, 0);
649 /* Predict next outgoing timestamp from samples in this
650 frame. */
651 } else {
652 path->nextout = ast_tvadd(path->nextout, ast_samp2tv(
653 current->samples, ast_format_get_sample_rate(current->subclass.format)));
654 }
655
657 ast_debug(4, "Sample size different %d vs %d\n", f->samples, current->samples);
659 }
661 } while (current);
662 } else {
663 out->delivery = ast_tv(0, 0);
665 if (has_timing_info) {
666 out->ts = ts;
667 out->len = len;
668 out->seqno = seqno;
669 }
670 /* Invalidate prediction if we're entering a silence period */
671 if (out->frametype == AST_FRAME_CNG) {
672 path->nextout = ast_tv(0, 0);
673 }
674 }
675 }
676 if (consume) {
677 ast_frfree(f);
678 }
679 return out;
680}
unsigned int ast_format_get_sample_rate(const struct ast_format *format)
Get the sample rate of a media format.
Definition: format.c:379
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
@ AST_FRFLAG_HAS_TIMING_INFO
#define ast_frfree(fr)
@ AST_FRAME_RTCP
struct ast_frame ast_null_frame
Definition: main/frame.c:79
#define ast_debug(level,...)
Log a DEBUG message.
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Definition: linkedlists.h:439
size_t current
Definition: main/cli.c:113
struct ast_format * format
struct ast_frame_subclass subclass
struct timeval delivery
enum ast_frame_type frametype
Default structure for translators, with the basic fields and buffers, all allocated as part of the sa...
Definition: translate.h:213
struct timeval nextout
Definition: translate.h:229
struct timeval nextin
Definition: translate.h:228
struct ast_trans_pvt * next
Definition: translate.h:227
struct ast_translator * t
Definition: translate.h:214
void(* feedback)(struct ast_trans_pvt *pvt, struct ast_frame *feedback)
Definition: translate.h:162
struct timeval ast_samp2tv(unsigned int _nsamp, unsigned int _rate)
Returns a timeval corresponding to the duration of n samples at rate r. Useful to convert samples to ...
Definition: time.h:282
int ast_tveq(struct timeval _a, struct timeval _b)
Returns true if the two struct timeval arguments are equal.
Definition: time.h:147
int ast_tvzero(const struct timeval t)
Returns true if the argument is 0,0.
Definition: time.h:117
struct timeval ast_tvadd(struct timeval a, struct timeval b)
Returns the sum of two timevals a + b.
Definition: extconf.c:2282
struct timeval ast_tvsub(struct timeval a, struct timeval b)
Returns the difference of two timevals a - b.
Definition: extconf.c:2297
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition: time.h:159
struct timeval ast_tv(ast_time_t sec, ast_suseconds_t usec)
Returns a timeval from sec, usec.
Definition: time.h:235
static struct ast_frame * generate_interpolated_slin(struct ast_trans_pvt *p, struct ast_frame *f)
Definition: translate.c:537
static int framein(struct ast_trans_pvt *pvt, struct ast_frame *f)
framein wrapper, deals with bound checks.
Definition: translate.c:397
FILE * out
Definition: utils/frame.c:33
#define ast_test_flag(p, flag)
Definition: utils.h:63
#define ast_set2_flag(p, value, flag)
Definition: utils.h:94
#define ast_clear_flag(p, flag)
Definition: utils.h:77

References ast_clear_flag, ast_debug, ast_format_get_sample_rate(), AST_FRAME_CNG, AST_FRAME_RTCP, AST_FRFLAG_HAS_TIMING_INFO, ast_frfree, AST_LIST_NEXT, ast_null_frame, ast_samp2tv(), ast_set2_flag, ast_test_flag, ast_tv(), ast_tvadd(), ast_tveq(), ast_tvnow(), ast_tvsub(), ast_tvzero(), current, ast_frame::delivery, ast_trans_pvt::f, ast_translator::feedback, ast_frame_subclass::format, framein(), ast_translator::frameout, ast_frame::frametype, generate_interpolated_slin(), len(), ast_frame::len, ast_trans_pvt::next, ast_trans_pvt::nextin, ast_trans_pvt::nextout, out, ast_frame::samples, ast_frame::seqno, ast_frame::subclass, ast_trans_pvt::t, and ast_frame::ts.

Referenced by __ast_read(), ast_slinfactory_feed(), ast_write_stream(), ast_writestream(), audiohook_list_translate_to_native(), audiohook_list_translate_to_slin(), audiohook_read_frame_helper(), conf_run(), fax_gateway_framehook(), and softmix_process_write_audio().

◆ ast_translate_available_formats()

void ast_translate_available_formats ( struct ast_format_cap dest,
struct ast_format_cap src,
struct ast_format_cap result 
)

Find available formats.

Parameters
destpossible destination formats
srcsource formats
[out]resultcapabilities structure to store available formats in returns the destination formats that are available in the source or translatable

The result will include all formats from 'dest' that are either present in 'src' or translatable from a format present in 'src'.

Note
Only a single audio format and a single video format can be present in 'src', or the function will produce unexpected results.

Definition at line 1616 of file translate.c.

1617{
1618 struct ast_format *cur_dest, *cur_src;
1619 int index;
1620
1621 for (index = 0; index < ast_format_cap_count(dest); ++index) {
1622 if (!(cur_dest = ast_format_cap_get_format(dest, index))) {
1623 continue;
1624 }
1625
1626 /* We give preference to a joint format structure if possible */
1627 if ((cur_src = ast_format_cap_get_compatible_format(src, cur_dest))) {
1628 ast_format_cap_append(result, cur_src, 0);
1629 ao2_ref(cur_src, -1);
1630 } else {
1631 /* Otherwise we just use the destination format */
1632 ast_format_cap_append(result, cur_dest, 0);
1633 }
1634 ao2_ref(cur_dest, -1);
1635 }
1636
1637 /* if we don't have a source format, we just have to try all
1638 possible destination formats */
1639 if (!src) {
1640 return;
1641 }
1642
1643 for (index = 0; index < ast_format_cap_count(src); ++index) {
1644 if (!(cur_src = ast_format_cap_get_format(src, index))) {
1645 continue;
1646 }
1647
1649 check_translation_path(dest, src, result,
1650 cur_src, AST_MEDIA_TYPE_AUDIO);
1651 check_translation_path(dest, src, result,
1652 cur_src, AST_MEDIA_TYPE_VIDEO);
1654 ao2_ref(cur_src, -1);
1655 }
1656}
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
static PGresult * result
Definition: cel_pgsql.c:84
@ AST_MEDIA_TYPE_AUDIO
Definition: codec.h:32
@ AST_MEDIA_TYPE_VIDEO
Definition: codec.h:33
struct ast_format * ast_format_cap_get_format(const struct ast_format_cap *cap, int position)
Get the format at a specific index.
Definition: format_cap.c:400
#define ast_format_cap_append(cap, format, framing)
Add format capability to capabilities structure.
Definition: format_cap.h:99
size_t ast_format_cap_count(const struct ast_format_cap *cap)
Get the number of formats present within the capabilities structure.
Definition: format_cap.c:395
struct ast_format * ast_format_cap_get_compatible_format(const struct ast_format_cap *cap, const struct ast_format *format)
Find if input ast_format is within the capabilities of the ast_format_cap object then return the comp...
Definition: format_cap.c:546
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition: linkedlists.h:78
Definition of a media format.
Definition: format.c:43
static void check_translation_path(struct ast_format_cap *dest, struct ast_format_cap *src, struct ast_format_cap *result, struct ast_format *src_fmt, enum ast_media_type type)
Definition: translate.c:1558

References ao2_ref, ast_format_cap_append, ast_format_cap_count(), ast_format_cap_get_compatible_format(), ast_format_cap_get_format(), AST_MEDIA_TYPE_AUDIO, AST_MEDIA_TYPE_VIDEO, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, check_translation_path(), and result.

Referenced by ast_rtp_instance_available_formats().

◆ ast_translate_init()

int ast_translate_init ( void  )

Initialize the translation matrix and index to format conversion table.

Return values
0on success
-1on failure

Definition at line 1675 of file translate.c.

1676{
1677 int res = 0;
1679 res = matrix_resize(1);
1682 return res;
1683}
int ast_register_cleanup(void(*func)(void))
Register a function to be executed before Asterisk gracefully exits.
Definition: clicompat.c:19
#define ast_cli_register_multiple(e, len)
Register multiple commands.
Definition: cli.h:265
#define ast_rwlock_init(rwlock)
wrapper for rwlock with tracking enabled
Definition: lock.h:224
static ast_rwlock_t tablelock
Definition: translate.c:87
static void translate_shutdown(void)
Definition: translate.c:1658
static struct ast_cli_entry cli_translate[]
Definition: translate.c:1232
#define ARRAY_LEN(a)
Definition: utils.h:666

References ARRAY_LEN, ast_cli_register_multiple, ast_register_cleanup(), ast_rwlock_init, cli_translate, matrix_resize(), tablelock, and translate_shutdown().

Referenced by asterisk_daemon().

◆ ast_translate_path_steps()

unsigned int ast_translate_path_steps ( struct ast_format dest,
struct ast_format src 
)

Returns the number of steps required to convert from 'src' to 'dest'.

Parameters
destdestination format
srcsource format
Returns
the number of translation steps required
Return values
-1if no path is available

Definition at line 1536 of file translate.c.

1537{
1538 unsigned int res = -1;
1539 /* convert bitwise format numbers into array indices */
1540 int src = format2index(src_format);
1541 int dest = format2index(dst_format);
1542
1543 if (src < 0 || dest < 0) {
1544 ast_log(LOG_WARNING, "No translator path: (%s codec is not valid)\n", src < 0 ? "starting" : "ending");
1545 return -1;
1546 }
1548
1549 if (matrix_get(src, dest)->step) {
1550 res = matrix_get(src, dest)->multistep + 1;
1551 }
1552
1554
1555 return res;
1556}
uint8_t multistep
Definition: translate.c:63
static struct translator_path * matrix_get(unsigned int x, unsigned int y)
Definition: translate.c:283
static int format2index(struct ast_format *format)
Definition: translate.c:134

References ast_log, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, format2index(), LOG_WARNING, matrix_get(), and translator_path::multistep.

Referenced by ast_channel_make_compatible_helper().

◆ ast_translate_path_to_str()

const char * ast_translate_path_to_str ( struct ast_trans_pvt t,
struct ast_str **  str 
)

Puts a string representation of the translation path into outbuf.

Parameters
ttranslator structure containing the translation path
strast_str output buffer
Returns
on success pointer to beginning of outbuf
Return values
""on failure

Definition at line 930 of file translate.c.

931{
932 if (!p || !p->t) {
933 return "";
934 }
935
937 codec_append_name(&p->t->src_codec, str);
938 while (p) {
939 ast_str_append(str, 0, "->");
940 codec_append_name(&p->t->dst_codec, str);
941 p = p->next;
942 }
943
944 return ast_str_buffer(*str);
945}
const char * str
Definition: app_jack.c:147
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition: strings.h:1139
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:761
void ast_str_reset(struct ast_str *buf)
Reset the content of a dynamic string. Useful before a series of ast_str_append.
Definition: strings.h:693
static void codec_append_name(const struct ast_codec *codec, struct ast_str **buf)
Definition: translate.c:921

References ast_str_append(), ast_str_buffer(), ast_str_reset(), codec_append_name(), ast_translator::dst_codec, ast_trans_pvt::next, ast_translator::src_codec, str, and ast_trans_pvt::t.

Referenced by chan_pjsip_write_stream(), generate_status(), handle_showchan(), and serialize_showchan().

◆ ast_translator_activate()

void ast_translator_activate ( struct ast_translator t)

Activate a previously deactivated translator.

Parameters
ttranslator to activate

Enables the specified translator for use.

Definition at line 1378 of file translate.c.

1379{
1381 t->active = 1;
1382 matrix_rebuild(0);
1384}

References ast_translator::active, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and matrix_rebuild().

◆ ast_translator_best_choice()

int ast_translator_best_choice ( struct ast_format_cap dst_cap,
struct ast_format_cap src_cap,
struct ast_format **  dst_fmt_out,
struct ast_format **  src_fmt_out 
)

Chooses the best translation path.

Given a list of sources, and a designed destination format, which should I choose?

Parameters
dst_capdestination capabilities
src_capsource capabilities
dst_fmt_outdestination format chosen out of destination capabilities
src_fmt_outsource format chosen out of source capabilities
Return values
0on success
-1if no path could be found.
Note
dst_cap and src_cap are not mondified.

Chooses the best translation path.

Definition at line 1402 of file translate.c.

1406{
1407 unsigned int besttablecost = INT_MAX;
1408 unsigned int beststeps = INT_MAX;
1409 struct ast_format *fmt;
1410 struct ast_format *dst;
1411 struct ast_format *src;
1412 RAII_VAR(struct ast_format *, best, NULL, ao2_cleanup);
1413 RAII_VAR(struct ast_format *, bestdst, NULL, ao2_cleanup);
1414 struct ast_format_cap *joint_cap;
1415 int i;
1416 int j;
1417
1418 if (ast_format_cap_empty(dst_cap) || ast_format_cap_empty(src_cap)) {
1419 ast_log(LOG_ERROR, "Cannot determine best translation path since one capability supports no formats\n");
1420 return -1;
1421 }
1422
1424 if (!joint_cap) {
1425 return -1;
1426 }
1427 ast_format_cap_get_compatible(dst_cap, src_cap, joint_cap);
1428
1429 for (i = 0; i < ast_format_cap_count(joint_cap); ++i, ao2_cleanup(fmt)) {
1430 fmt = ast_format_cap_get_format(joint_cap, i);
1431 if (!fmt
1433 continue;
1434 }
1435
1436 if (!best
1438 ao2_replace(best, fmt);
1439 }
1440 }
1441 ao2_ref(joint_cap, -1);
1442
1443 if (best) {
1444 ao2_replace(*dst_fmt_out, best);
1445 ao2_replace(*src_fmt_out, best);
1446 return 0;
1447 }
1448
1449 /* need to translate */
1451 for (i = 0; i < ast_format_cap_count(dst_cap); ++i, ao2_cleanup(dst)) {
1452 dst = ast_format_cap_get_format(dst_cap, i);
1453 if (!dst
1455 continue;
1456 }
1457
1458 for (j = 0; j < ast_format_cap_count(src_cap); ++j, ao2_cleanup(src)) {
1459 int x;
1460 int y;
1461
1462 src = ast_format_cap_get_format(src_cap, j);
1463 if (!src
1465 continue;
1466 }
1467
1468 x = format2index(src);
1469 y = format2index(dst);
1470 if (x < 0 || y < 0) {
1471 continue;
1472 }
1473 if (!matrix_get(x, y) || !(matrix_get(x, y)->step)) {
1474 continue;
1475 }
1476 if (matrix_get(x, y)->table_cost < besttablecost
1477 || matrix_get(x, y)->multistep < beststeps) {
1478 /* better than what we have so far */
1479 ao2_replace(best, src);
1480 ao2_replace(bestdst, dst);
1481 besttablecost = matrix_get(x, y)->table_cost;
1482 beststeps = matrix_get(x, y)->multistep;
1483 } else if (matrix_get(x, y)->table_cost == besttablecost
1484 && matrix_get(x, y)->multistep == beststeps) {
1485 int replace = 0;
1486 unsigned int gap_selected = format_sample_rate_absdiff(best, bestdst);
1487 unsigned int gap_current = format_sample_rate_absdiff(src, dst);
1488
1489 if (gap_current < gap_selected) {
1490 /* better than what we have so far */
1491 replace = 1;
1492 } else if (gap_current == gap_selected) {
1493 int src_quality, best_quality;
1494 struct ast_codec *src_codec, *best_codec;
1495
1496 src_codec = ast_format_get_codec(src);
1497 best_codec = ast_format_get_codec(best);
1498 src_quality = src_codec->quality;
1499 best_quality = best_codec->quality;
1500
1501 ao2_cleanup(src_codec);
1502 ao2_cleanup(best_codec);
1503
1504 /* We have a tie, so choose the format with the higher quality, if they differ. */
1505 if (src_quality > best_quality) {
1506 /* Better than what we had before. */
1507 replace = 1;
1508 ast_debug(2, "Tiebreaker: preferring format %s (%d) to %s (%d)\n", ast_format_get_name(src), src_quality,
1509 ast_format_get_name(best), best_quality);
1510 } else {
1511 /* This isn't necessarily indicative of a problem, but in reality this shouldn't really happen, unless
1512 * there are 2 formats that are basically the same. */
1513 ast_debug(1, "Completely ambiguous tie between formats %s and %s (quality %d): sticking with %s, but this is arbitrary\n",
1514 ast_format_get_name(src), ast_format_get_name(best), best_quality, ast_format_get_name(best));
1515 }
1516 }
1517 if (replace) {
1518 ao2_replace(best, src);
1519 ao2_replace(bestdst, dst);
1520 besttablecost = matrix_get(x, y)->table_cost;
1521 beststeps = matrix_get(x, y)->multistep;
1522 }
1523 }
1524 }
1525 }
1527
1528 if (!best) {
1529 return -1;
1530 }
1531 ao2_replace(*dst_fmt_out, bestdst);
1532 ao2_replace(*src_fmt_out, best);
1533 return 0;
1534}
#define ao2_replace(dst, src)
Replace one object reference with another cleaning up the original.
Definition: astobj2.h:501
enum ast_media_type ast_format_get_type(const struct ast_format *format)
Get the media type of a format.
Definition: format.c:354
struct ast_codec * ast_format_get_codec(const struct ast_format *format)
Get the codec associated with a format.
Definition: format.c:324
const char * ast_format_get_name(const struct ast_format *format)
Get the name associated with a format.
Definition: format.c:334
int ast_format_cap_empty(const struct ast_format_cap *cap)
Determine if a format cap has no formats in it.
Definition: format_cap.c:744
int ast_format_cap_get_compatible(const struct ast_format_cap *cap1, const struct ast_format_cap *cap2, struct ast_format_cap *result)
Find the compatible formats between two capabilities structures.
Definition: format_cap.c:628
@ AST_FORMAT_CAP_FLAG_DEFAULT
Definition: format_cap.h:38
#define ast_format_cap_alloc(flags)
Allocate a new ast_format_cap structure.
Definition: format_cap.h:49
static int replace(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **buf, ssize_t len)
Definition: func_strings.c:888
#define LOG_ERROR
unsigned int quality
Format quality, on scale from 0 to 150 (100 is ulaw, the reference). This allows better format to be ...
Definition: codec.h:82
Format capabilities structure, holds formats + preference order + etc.
Definition: format_cap.c:54
uint32_t table_cost
Definition: translate.c:61
#define format_sample_rate_absdiff(fmt1, fmt2)
Definition: translate.c:1395

References ao2_cleanup, ao2_ref, ao2_replace, ast_debug, ast_format_cap_alloc, ast_format_cap_count(), ast_format_cap_empty(), AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_cap_get_compatible(), ast_format_cap_get_format(), ast_format_get_codec(), ast_format_get_name(), ast_format_get_sample_rate(), ast_format_get_type(), ast_log, AST_MEDIA_TYPE_AUDIO, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, format2index(), format_sample_rate_absdiff, LOG_ERROR, matrix_get(), translator_path::multistep, NULL, ast_codec::quality, RAII_VAR, replace(), and translator_path::table_cost.

Referenced by ast_channel_make_compatible_helper(), ast_speech_new(), iax2_request(), local_request_with_stream_topology(), request_channel(), and set_format().

◆ ast_translator_build_path()

struct ast_trans_pvt * ast_translator_build_path ( struct ast_format dst,
struct ast_format src 
)

Builds a translator path Build a path (possibly NULL) from source to dest.

Parameters
dstdest destination format
srcsource source format
Returns
ast_trans_pvt on success
Return values
NULLon failure

Builds a translator path Build a path (possibly NULL) from source to dest.

Definition at line 486 of file translate.c.

487{
488 struct ast_trans_pvt *head = NULL, *tail = NULL;
489 int src_index, dst_index;
490
491 src_index = format2index(src);
492 dst_index = format2index(dst);
493
494 if (src_index < 0 || dst_index < 0) {
495 ast_log(LOG_WARNING, "No translator path: (%s codec is not valid)\n", src_index < 0 ? "starting" : "ending");
496 return NULL;
497 }
498
500
501 while (src_index != dst_index) {
502 struct ast_trans_pvt *cur;
503 struct ast_format *explicit_dst = NULL;
504 struct ast_translator *t = matrix_get(src_index, dst_index)->step;
505 if (!t) {
506 ast_log(LOG_WARNING, "No translator path from %s to %s\n",
510 return NULL;
511 }
513 explicit_dst = dst;
514 }
515 if (!(cur = newpvt(t, explicit_dst))) {
516 ast_log(LOG_WARNING, "Failed to build translator step from %s to %s\n",
520 return NULL;
521 }
522 if (!head) {
523 head = cur;
524 } else {
525 tail->next = cur;
526 }
527 tail = cur;
528 cur->nextin = cur->nextout = ast_tv(0, 0);
529 /* Keep going if this isn't the final destination */
530 src_index = cur->t->dst_fmt_index;
531 }
532
534 return head;
535}
struct ast_translator * step
Definition: translate.c:60
void ast_translator_free_path(struct ast_trans_pvt *p)
Frees a translator path Frees the given translator path structure.
Definition: translate.c:476
static struct ast_trans_pvt * newpvt(struct ast_translator *t, struct ast_format *explicit_dst)
Allocate the descriptor, required outbuf space, and possibly desc.
Definition: translate.c:312

References ast_format_get_name(), ast_format_get_sample_rate(), ast_format_get_type(), ast_log, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, ast_translator_free_path(), ast_tv(), ast_translator::dst_codec, ast_translator::dst_fmt_index, format2index(), LOG_WARNING, matrix_get(), newpvt(), ast_trans_pvt::next, ast_trans_pvt::nextin, ast_trans_pvt::nextout, NULL, ast_codec::sample_rate, translator_path::step, ast_trans_pvt::t, and ast_codec::type.

Referenced by ast_set_read_format_path(), ast_set_write_format_path(), ast_slinfactory_feed(), ast_writestream(), audiohook_list_translate_to_native(), audiohook_list_translate_to_slin(), audiohook_read_frame_helper(), conf_run(), set_format(), softmix_process_write_audio(), and softmix_translate_helper_change_rate().

◆ ast_translator_deactivate()

void ast_translator_deactivate ( struct ast_translator t)

Deactivate a translator.

Parameters
ttranslator to deactivate

Disables the specified translator from being used.

Definition at line 1386 of file translate.c.

1387{
1389 t->active = 0;
1390 matrix_rebuild(0);
1392}

References ast_translator::active, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and matrix_rebuild().

◆ ast_translator_free_path()

void ast_translator_free_path ( struct ast_trans_pvt tr)

◆ ast_unregister_translator()

int ast_unregister_translator ( struct ast_translator t)

Unregister a translator Unregisters the given translator.

Parameters
ttranslator to unregister
Return values
0on success
-1on failure

Unregister a translator Unregisters the given translator.

Definition at line 1350 of file translate.c.

1351{
1352 char tmp[80];
1353 struct ast_translator *u;
1354 int found = 0;
1355
1358 if (u == t) {
1360 ast_verb(5, "Unregistered translator '%s' from codec %s to %s\n",
1362 t->src_codec.name, t->dst_codec.name);
1363 found = 1;
1364 break;
1365 }
1366 }
1368
1369 if (found && !ast_shutting_down()) {
1370 matrix_rebuild(0);
1371 }
1372
1374
1375 return (u ? 0 : -1);
1376}
int ast_shutting_down(void)
Definition: asterisk.c:1873
#define AST_RWLIST_REMOVE_CURRENT
Definition: linkedlists.h:570
struct ast_translator::@286 list

References AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_shutting_down(), ast_verb, COLOR_BLACK, COLOR_MAGENTA, ast_translator::dst_codec, ast_translator::list, matrix_rebuild(), ast_codec::name, ast_translator::name, ast_translator::src_codec, term_color(), and tmp().

Referenced by unload_module(), and unregister_translators().