Asterisk - The Open Source Telephony Project: ast_trans_pvt Struct Reference

Asterisk - The Open Source Telephony Project 18.5.0

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...

#include <translate.h>

Collaboration diagram for ast_trans_pvt:

Collaboration graph

[legend]

Data Fields
int	datalen
	actual space used in outbuf More...

struct ast_format *	explicit_dst

struct ast_frame	f

int	interleaved_stereo

struct ast_trans_pvt *	next

struct timeval	nextin

struct timeval	nextout

union {
char * c

int16_t * i16

unsigned char * uc

uint8_t * ui8

}	outbuf

plc_state_t *	plc

void *	pvt

int	samples

struct ast_translator *	t

Detailed Description

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.

*_framein() routines operate in two ways:

some convert on the fly and place the data directly in outbuf; in this case 'samples' and 'datalen' contain the number of samples and number of bytes available in the buffer. In this case we can use a generic *_frameout() routine that simply takes whatever is there and places it into the output frame.
others simply store the (unconverted) samples into a working buffer, and leave the conversion task to *_frameout(). In this case, the intermediate buffer must be in the private descriptor, 'datalen' is left to 0, while 'samples' is still updated with the number of samples received.

Definition at line 213 of file translate.h.

Field Documentation

◆ c

char* c

the useful portion of the buffer

Definition at line 221 of file translate.h.

Referenced by ast_trans_frameout(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), lintoadpcm_frameout(), lintoalaw_framein(), lintog726_framein(), lintog726aal2_framein(), lintogsm_frameout(), lintospeex_frameout(), lintoulaw_framein(), and newpvt().

◆ datalen

int datalen

◆ explicit_dst

struct ast_format* explicit_dst

If a translation path using a format with attributes requires the output to be a specific set of attributes, this variable will be set describing those attributes to the translator. Otherwise, the translator must choose a set of format attributes for the destination that preserves the quality of the audio in the best way possible. For example with the Opus Codec, explicit_dst contains an attribute which describes whether both parties want to do forward-error correction (FEC).

Definition at line 237 of file translate.h.

Referenced by destroy(), generate_interpolated_slin(), lintoilbc_new(), and newpvt().

◆ f

struct ast_frame f

used in frameout. This frame holds a f.subclass.format ref.

Definition at line 215 of file translate.h.

Referenced by ast_trans_frameout(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_translate(), destroy(), fax_gateway_framehook(), framein(), lintoilbc_frameout(), newpvt(), and resamp_new().

◆ i16

Definition at line 223 of file translate.h.

Referenced by adpcmtolin_framein(), alawtolin_framein(), codec2tolin_framein(), g722tolin_framein(), g726aal2tolin_framein(), g726tolin_framein(), gsmtolin_framein(), ilbctolin_framein(), lpc10tolin_framein(), resamp_framein(), speextolin_framein(), ulawtolin(), and ulawtolin_framein().

◆ interleaved_stereo

int interleaved_stereo

indicates if samples are in interleaved order, for stereo lin

Definition at line 238 of file translate.h.

Referenced by set_format().

◆ next

struct ast_trans_pvt* next

next in translator chain

Definition at line 227 of file translate.h.

Referenced by ast_translate(), ast_translate_path_to_str(), ast_translator_build_path(), and ast_translator_free_path().

◆ nextin

struct timeval nextin

Definition at line 228 of file translate.h.

Referenced by ast_translate(), and ast_translator_build_path().

◆ nextout

struct timeval nextout

Definition at line 229 of file translate.h.

Referenced by ast_translate(), and ast_translator_build_path().

◆ outbuf

◆ plc

plc_state_t* plc

optional plc pointer

Definition at line 226 of file translate.h.

◆ pvt

void* pvt

more private data, if any

Definition at line 219 of file translate.h.

Referenced by adpcmtolin_framein(), codec2_destroy_stuff(), codec2_new(), codec2tolin_framein(), dahdi_decoder_framein(), dahdi_decoder_frameout(), dahdi_destroy(), dahdi_encoder_framein(), dahdi_encoder_frameout(), dahdi_translate(), g722tolin16_new(), g722tolin_framein(), g722tolin_new(), g726aal2tolin_framein(), g726tolin_framein(), generate_computational_cost(), gsm_destroy_stuff(), gsm_new(), gsmtolin_framein(), ilbctolin_framein(), ilbctolin_new(), lin16tog722_new(), lintoadpcm_framein(), lintoadpcm_frameout(), lintocodec2_framein(), lintocodec2_frameout(), lintog722_framein(), lintog722_new(), lintog726_framein(), lintog726_new(), lintog726aal2_framein(), lintogsm_framein(), lintogsm_frameout(), lintoilbc_framein(), lintoilbc_frameout(), lintoilbc_new(), lintolpc10_framein(), lintolpc10_frameout(), lintospeex_destroy(), lintospeex_feedback(), lintospeex_framein(), lintospeex_frameout(), lintoulaw(), lpc10_dec_new(), lpc10_destroy(), lpc10_enc_new(), lpc10tolin_framein(), newpvt(), resamp_destroy(), resamp_framein(), resamp_new(), speex_decoder_construct(), speex_encoder_construct(), speextolin_destroy(), speextolin_framein(), and ulawtolin().

◆ samples

int samples

samples available in outbuf

Definition at line 216 of file translate.h.

Referenced by adpcmtolin_framein(), alawtolin_framein(), alawtoulaw_framein(), ast_trans_frameout(), codec2tolin_framein(), dahdi_decoder_framein(), dahdi_decoder_frameout(), dahdi_encoder_framein(), dahdi_encoder_frameout(), framein(), g722tolin_framein(), g726aal2tolin_framein(), g726tolin_framein(), gsmtolin_framein(), ilbctolin_framein(), lintoadpcm_framein(), lintoadpcm_frameout(), lintoalaw_framein(), lintocodec2_framein(), lintocodec2_frameout(), lintog722_framein(), lintog726_framein(), lintog726aal2_framein(), lintogsm_framein(), lintogsm_frameout(), lintoilbc_framein(), lintoilbc_frameout(), lintolpc10_framein(), lintolpc10_frameout(), lintospeex_framein(), lintospeex_frameout(), lintoulaw_framein(), lpc10tolin_framein(), resamp_framein(), speextolin_framein(), ulawtoalaw_framein(), and ulawtolin_framein().

◆ t

struct ast_translator* t

Definition at line 214 of file translate.h.

Referenced by ast_translate(), ast_translate_path_to_str(), ast_translator_build_path(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_new(), dahdi_translate(), destroy(), framein(), ilbctolin_framein(), lintoilbc_frameout(), lintospeex_frameout(), newpvt(), and resamp_new().

◆ uc

unsigned char* uc

the useful portion of the buffer

Definition at line 222 of file translate.h.

Referenced by alawtoulaw_framein(), lintocodec2_frameout(), lintolpc10_frameout(), and ulawtoalaw_framein().

◆ ui8

uint8_t* ui8

Definition at line 224 of file translate.h.

Referenced by lintog722_framein().

The documentation for this struct was generated from the following file:

translate.h