An abstraction to store a tone generation session. More...
#include <libteletone_generate.h>
Collaboration diagram for teletone_generation_session:
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 213 of file libteletone_generate.h.
Field Documentation
◆ buffer
| teletone_audio_t* teletone_generation_session::buffer |
Buffer for storing sample data (dynamic)
Definition at line 247 of file libteletone_generate.h.
Referenced by ensure_buffer(), teletone_destroy_session(), teletone_dtmf_generate_handler(), teletone_handler(), teletone_init_session(), and teletone_mux_tones().
◆ channels
| int teletone_generation_session::channels |
The number of channels the output audio should be in
Definition at line 217 of file libteletone_generate.h.
Referenced by ensure_buffer(), inband_dtmf_generate_callback(), main(), switch_ivr_gentones(), teletone_init_session(), teletone_mux_tones(), and teletone_run().
◆ datalen
| int teletone_generation_session::datalen |
Size of the buffer
Definition at line 249 of file libteletone_generate.h.
Referenced by ensure_buffer(), teletone_init_session(), and teletone_mux_tones().
◆ debug
| int teletone_generation_session::debug |
Debug on/off
Definition at line 241 of file libteletone_generate.h.
Referenced by main(), teletone_mux_tones(), and teletone_run().
◆ debug_stream
| FILE* teletone_generation_session::debug_stream |
FILE stream to write debug data to
Definition at line 243 of file libteletone_generate.h.
Referenced by main(), teletone_mux_tones(), and teletone_run().
◆ decay_direction
| int teletone_generation_session::decay_direction |
Direction to perform volume increase/decrease 1/-1
Definition at line 235 of file libteletone_generate.h.
Referenced by teletone_mux_tones(), and teletone_run().
◆ decay_factor
| 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 233 of file libteletone_generate.h.
Referenced by teletone_init_session(), teletone_mux_tones(), and teletone_run().
◆ decay_step
| int teletone_generation_session::decay_step |
Number of samples between increase/decrease of volume
Definition at line 237 of file libteletone_generate.h.
Referenced by teletone_init_session(), teletone_mux_tones(), and teletone_run().
◆ duration
| int teletone_generation_session::duration |
The duration (in samples) of the output audio
Definition at line 221 of file libteletone_generate.h.
Referenced by inband_dtmf_generate_callback(), main(), teletone_init_session(), teletone_mux_tones(), and teletone_run().
◆ dynamic
| int teletone_generation_session::dynamic |
Callback function called during generation
Definition at line 253 of file libteletone_generate.h.
Referenced by ensure_buffer(), teletone_init_session(), and teletone_mux_tones().
◆ handler
| tone_handler teletone_generation_session::handler |
Definition at line 254 of file libteletone_generate.h.
Referenced by teletone_init_session(), and teletone_run().
◆ loops
| int teletone_generation_session::loops |
Number of loops to repeat a single instruction
Definition at line 229 of file libteletone_generate.h.
Referenced by teletone_run().
◆ LOOPS
| int teletone_generation_session::LOOPS |
Number of loops to repeat the entire set of instructions
Definition at line 231 of file libteletone_generate.h.
Referenced by teletone_run().
◆ rate
| int teletone_generation_session::rate |
The Rate in hz of the output audio
Definition at line 219 of file libteletone_generate.h.
Referenced by inband_dtmf_generate_callback(), main(), setup_ringback(), switch_ivr_gentones(), switch_ivr_wait_for_answer(), teletone_init_session(), teletone_mux_tones(), and teletone_run().
◆ samples
| int teletone_generation_session::samples |
In-Use size of the buffer
Definition at line 251 of file libteletone_generate.h.
Referenced by ensure_buffer(), teletone_destroy_session(), and teletone_mux_tones().
◆ tmp_duration
| int teletone_generation_session::tmp_duration |
The duration (in samples) of the output audio (takes prescedence over actual duration value)
Definition at line 225 of file libteletone_generate.h.
Referenced by teletone_init_session(), teletone_mux_tones(), and teletone_run().
◆ tmp_wait
| 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 227 of file libteletone_generate.h.
Referenced by teletone_init_session(), teletone_mux_tones(), and teletone_run().
◆ TONES
| teletone_tone_map_t teletone_generation_session::TONES[TELETONE_TONE_RANGE] |
An array of tone mappings to character mappings
Definition at line 215 of file libteletone_generate.h.
Referenced by teletone_run(), and teletone_set_tone().
◆ user_data
| void* teletone_generation_session::user_data |
Extra user data to attach to the session
Definition at line 245 of file libteletone_generate.h.
Referenced by teletone_dtmf_generate_handler(), teletone_handler(), and teletone_init_session().
◆ volume
| float teletone_generation_session::volume |
Volume factor of the tone
Definition at line 239 of file libteletone_generate.h.
Referenced by teletone_init_session(), teletone_mux_tones(), and teletone_run().
◆ wait
| int teletone_generation_session::wait |
The duration of silence to append after the initial audio is generated
Definition at line 223 of file libteletone_generate.h.
Referenced by main(), teletone_init_session(), teletone_mux_tones(), and teletone_run().
The documentation for this struct was generated from the following file:
