teletone_generation_session Struct Reference

An abstraction to store a tone generation session. More...

#include <libteletone_generate.h>

Collaboration diagram for teletone_generation_session:

[legend]

Data Fields
teletone_tone_map_t	TONES [TELETONE_TONE_RANGE]
int	channels
int	rate
int	duration
int	wait
int	tmp_duration
int	tmp_wait
int	loops
int	LOOPS
float	decay_factor
int	decay_direction
int	decay_step
float	volume
int	debug
FILE *	debug_stream
void *	user_data
teletone_audio_t *	buffer
int	datalen
int	samples
int	dynamic
tone_handler	handler

---

Detailed Description

An abstraction to store a tone generation session.

Definition at line 204 of file libteletone_generate.h.

---

Field Documentation

teletone_audio_t* teletone_generation_session::buffer

Buffer for storing sample data (dynamic)

Definition at line 238 of file libteletone_generate.h.

Referenced by ensure_buffer(), teletone_dtmf_generate_handler(), and teletone_handler().

int teletone_generation_session::channels

The number of channels the output audio should be in

Definition at line 208 of file libteletone_generate.h.

Referenced by ensure_buffer(), inband_dtmf_generate_callback(), and main().

int teletone_generation_session::datalen

Size of the buffer

Definition at line 240 of file libteletone_generate.h.

Referenced by ensure_buffer().

int teletone_generation_session::debug

Debug on/off

Definition at line 232 of file libteletone_generate.h.

Referenced by main().

FILE* teletone_generation_session::debug_stream

FILE stream to write debug data to

Definition at line 234 of file libteletone_generate.h.

Referenced by main().

int teletone_generation_session::decay_direction

Direction to perform volume increase/decrease 1/-1

Definition at line 226 of file libteletone_generate.h.

float teletone_generation_session::decay_factor

Number to mutiply total samples by to determine when to begin ascent or decent e.g. 0=beginning 4=(last 25%)

Definition at line 224 of file libteletone_generate.h.

int teletone_generation_session::decay_step

Number of samples between increase/decrease of volume

Definition at line 228 of file libteletone_generate.h.

int teletone_generation_session::duration

The duration (in samples) of the output audio

Definition at line 212 of file libteletone_generate.h.

Referenced by inband_dtmf_generate_callback(), and main().

int teletone_generation_session::dynamic

Callback function called during generation

Definition at line 244 of file libteletone_generate.h.

Referenced by ensure_buffer().

tone_handler teletone_generation_session::handler

Definition at line 245 of file libteletone_generate.h.

int teletone_generation_session::LOOPS

Number of loops to repeat the entire set of instructions

Definition at line 222 of file libteletone_generate.h.

int teletone_generation_session::loops

Number of loops to repeat a single instruction

Definition at line 220 of file libteletone_generate.h.

int teletone_generation_session::rate

The Rate in hz of the output audio

Definition at line 210 of file libteletone_generate.h.

Referenced by inband_dtmf_generate_callback(), main(), setup_ringback(), and switch_ivr_wait_for_answer().

int teletone_generation_session::samples

In-Use size of the buffer

Definition at line 242 of file libteletone_generate.h.

Referenced by ensure_buffer().

int teletone_generation_session::tmp_duration

The duration (in samples) of the output audio (takes prescedence over actual duration value)

Definition at line 216 of file libteletone_generate.h.

int teletone_generation_session::tmp_wait

The duration of silence to append after the initial audio is generated (takes prescedence over actual wait value)

Definition at line 218 of file libteletone_generate.h.

teletone_tone_map_t teletone_generation_session::TONES[TELETONE_TONE_RANGE]

An array of tone mappings to character mappings

Definition at line 206 of file libteletone_generate.h.

void* teletone_generation_session::user_data

Extra user data to attach to the session

Definition at line 236 of file libteletone_generate.h.

Referenced by teletone_dtmf_generate_handler(), and teletone_handler().

float teletone_generation_session::volume

Volume factor of the tone

Definition at line 230 of file libteletone_generate.h.

int teletone_generation_session::wait

The duration of silence to append after the initial audio is generated

Definition at line 214 of file libteletone_generate.h.

Referenced by main().

---

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

• libteletone_generate.h

---