Bayonne2 / Common C++ 2 Framework
|
MFTones is used to generate a series of mf audio data from a "telephone" number passed as an ASCII string. More...
#include <audio2.h>
Public Member Functions | |
MFTones (const char *digits, Level level, timeout_t duration=20, timeout_t interdigit=60) | |
Generate a mf dialer for a specified dialing string. More... | |
~MFTones () | |
Linear | getFrame (void) |
Iterate the tone frame, and extract linear samples in native frame. More... | |
bool | isComplete (void) |
See if at end of tone. More... | |
Rate | getRate (void) |
Get the sample encoding rate being used for the tone generator. More... | |
size_t | getSamples (void) |
Get the frame size for the number of audio samples generated. More... | |
bool | isSilent (void) |
Test if the tone generator is currently set to silence. More... | |
unsigned | getFrames (Linear buffer, unsigned number) |
This is used to copy one or more pages of framed audio quickly to an external buffer. More... | |
Static Public Member Functions | |
static Rate | getRate (Encoding encoding) |
Return default sample rate associated with the specified audio encoding format. More... | |
static Rate | getRate (Encoding e, Rate request) |
Return optional rate setting effect. More... | |
static int | getFrame (Encoding encoding, int samples=0) |
Returns the number of bytes in a sample frame for the given encoding type, rounded up to the nearest integer. More... | |
static Level | tolevel (float dbm) |
Convert dbm power level to integer value (0-32768). More... | |
static float | todbm (Level power) |
Convert integer power levels to dbm. More... | |
static bool | hasDevice (unsigned device=0) |
Test for the presense of a specified (indexed) audio device. More... | |
static AudioDevice * | getDevice (unsigned device=0, DeviceMode mode=PLAY) |
Get a audio device object that can be used to play or record audio. More... | |
static const char * | getCodecPath (void) |
Get pathname to where loadable codec modules are stored. More... | |
static const char * | getMIME (Info &info) |
Get the mime descriptive type for a given Audio encoding description, usually retrieved from a newly opened audio file. More... | |
static const char * | getName (Encoding encoding) |
Get the short ascii description used for the given audio encoding type. More... | |
static const char * | getExtension (Encoding encoding) |
Get the preferred file extension name to use for a given audio encoding type. More... | |
static Encoding | getEncoding (const char *name) |
Get the audio encoding format that is specified by a short ascii name. More... | |
static Encoding | getStereo (Encoding encoding) |
Get the stereo encoding format associated with the given format. More... | |
static Encoding | getMono (Encoding encoding) |
Get the mono encoding format associated with the given format. More... | |
static bool | isLinear (Encoding encoding) |
Test if the audio encoding format is a linear one. More... | |
static bool | isBuffered (Encoding encoding) |
Test if the audio encoding format must be packetized (that is, has irregular sized frames) and must be processed only through buffered codecs. More... | |
static bool | isMono (Encoding encoding) |
Test if the audio encoding format is a mono format. More... | |
static bool | isStereo (Encoding encoding) |
Test if the audio encoding format is a stereo format. More... | |
static timeout_t | getFraming (Encoding encoding, timeout_t timeout=0) |
Return frame timing for an audio encoding format. More... | |
static timeout_t | getFraming (Info &info, timeout_t timeout=0) |
Return frame time for an audio source description. More... | |
static bool | isEndian (Encoding encoding) |
Test if the endian byte order of the encoding format is different from the machine's native byte order. More... | |
static bool | isEndian (Info &info) |
Test if the endian byte order of the audio source description is different from the machine's native byte order. More... | |
static bool | swapEndian (Encoding encoding, void *buffer, unsigned number) |
Optionally swap endian of audio data if the encoding format endian byte order is different from the machine's native endian. More... | |
static bool | swapEndian (Info &info, void *buffer, unsigned number) |
Optionally swap endian of audio data if the audio source description byte order is different from the machine's native endian byte order. More... | |
static void | swapEncoded (Info &info, Encoded data, size_t bytes) |
Optionally swap endian of encoded audio data based on the audio encoding type, and relationship to native byte order. More... | |
static Level | getImpulse (Encoding encoding, void *buffer, unsigned number) |
Get the energey impulse level of a frame of audio data. More... | |
static Level | getImpulse (Info &info, void *buffer, unsigned number=0) |
Get the energey impulse level of a frame of audio data. More... | |
static Level | getPeak (Encoding encoding, void *buffer, unsigned number) |
Get the peak (highest energy) level found in a frame of audio data. More... | |
static Level | getPeak (Info &info, void *buffer, unsigned number=0) |
Get the peak (highest energy) level found in a frame of audio data. More... | |
static void | toTimestamp (timeout_t duration, char *address, size_t size) |
Provide ascii timestamp representation of a timeout value. More... | |
static timeout_t | toTimeout (const char *timestamp) |
Convert ascii timestamp representation to a timeout number. More... | |
static int | getCount (Encoding encoding) |
Returns the number of samples in all channels for a frame in the given encoding. More... | |
static unsigned long | toSamples (Encoding encoding, size_t bytes) |
Compute byte counts of audio data into number of samples based on the audio encoding format used. More... | |
static unsigned long | toSamples (Info &info, size_t bytes) |
Compute byte counts of audio data into number of samples based on the audio source description used. More... | |
static size_t | toBytes (Info &info, unsigned long number) |
Compute the number of bytes a given number of samples in a given audio encoding will occupy. More... | |
static size_t | toBytes (Encoding encoding, unsigned long number) |
Compute the number of bytes a given number of samples in a given audio encoding will occupy. More... | |
static void | fill (unsigned char *address, int number, Encoding encoding) |
Fill an audio buffer with "empty" (silent) audio data, based on the audio encoding format. More... | |
static bool | loadPlugin (const char *path) |
Load a dso plugin (codec plugin), used internally... More... | |
static size_t | maxFramesize (Info &info) |
Maximum framesize for a given coding that may be needed to store a result. More... | |
Static Public Attributes | |
static const unsigned | ndata |
Protected Member Functions | |
void | silence (void) |
Set the frame to silent. More... | |
void | reset (void) |
Reset the tone generator completely. More... | |
void | cleanup (void) |
Cleanup for virtual destructors to use. More... | |
void | single (unsigned freq, Level level) |
Set frame to generate single tone... More... | |
void | dual (unsigned f1, unsigned f2, Level l1, Level l2) |
Set frame to generate dual tone... More... | |
Protected Attributes | |
unsigned | remaining |
unsigned | mfframes |
timeout_t | frametime |
const char * | digits |
Level | level |
bool | complete |
bool | kflag |
Rate | rate |
unsigned | samples |
Linear | frame |
double | df1 |
double | df2 |
double | p1 |
double | p2 |
Level | m1 |
Level | m2 |
bool | silencer |
MFTones is used to generate a series of mf audio data from a "telephone" number passed as an ASCII string.
Each time getFrame() is called, the next audio frame of dtmf audio will be created and pulled.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Audio encoding formats.
|
inherited |
Audio error conditions.
|
inherited |
|
inherited |
|
inherited |
ost::MFTones::MFTones | ( | const char * | digits, |
Level | level, | ||
timeout_t | duration = 20 , |
||
timeout_t | interdigit = 60 |
||
) |
Generate a mf dialer for a specified dialing string.
digits | to generate tone dialing for. |
level | for mf. |
duration | timing for generated audio. |
interdigit | timing, should be multiple of frame. |
ost::MFTones::~MFTones | ( | ) |
|
protectedinherited |
Cleanup for virtual destructors to use.
Set frame to generate dual tone...
f1 | frequency of tone 1 |
f2 | frequency of tone 2 |
l1 | level of tone 1 |
l2 | level of tone 2 |
|
staticinherited |
Fill an audio buffer with "empty" (silent) audio data, based on the audio encoding format.
address | of data to fill. |
number | of samples to fill. |
encoding | format of data. |
|
staticinherited |
Get pathname to where loadable codec modules are stored.
|
staticinherited |
Returns the number of samples in all channels for a frame in the given encoding.
For example, pcm32Stereo has a frame size of 8 bytes: Note that different codecs have different definitions of a frame - for example, compressed encodings have a rather large frame size relative to the sample size due to the way bytes are fed to the decompression engine.
encoding | The encoding to calculate the frame sample count for. |
|
staticinherited |
Get a audio device object that can be used to play or record audio.
This is normally a local soundcard, though an abstract base class is returned, so the underlying device may be different.
device | index or 0 for default audio device. |
mode | of device; play, record, or full duplex. |
|
staticinherited |
Get the audio encoding format that is specified by a short ascii name.
This will either accept names like those returned from getName(), or .xxx file extensions, and return the audio encoding type associated with the name or extension.
name | of encoding or file extension. |
|
staticinherited |
Get the preferred file extension name to use for a given audio encoding type.
encoding | format. |
|
staticinherited |
Returns the number of bytes in a sample frame for the given encoding type, rounded up to the nearest integer.
A frame is defined as the minimum number of bytes necessary to create a point or points in the output waveform for all output channels. For example, 16-bit mono PCM has a frame size of two (because those two bytes constitute a point in the output waveform). GSM has it's own definition of a frame which involves decompressing a sequence of bytes to determine the final points on the output waveform. The minimum number of bytes you can feed to the decompression engine is 32.5 (260 bits), so this function will return 33 (because we round up) given an encoding type of GSM. Other compressed encodings will return similar results. Be prepared to deal with nonintuitive return values for rare encodings.
encoding | The encoding type to get the frame size for. |
samples | Reserved. Use zero. |
|
virtual |
Iterate the tone frame, and extract linear samples in native frame.
If endian flag passed, then convert for standard endian representation (byte swap) if needed.
Reimplemented from ost::AudioTone.
|
inherited |
This is used to copy one or more pages of framed audio quickly to an external buffer.
buffer | to copy into. |
number | of frames requested. |
|
staticinherited |
Return frame timing for an audio encoding format.
encoding | of frame to get timing segment for. |
timeout | of frame time segment to request. |
Return frame time for an audio source description.
info | descriptor of frame encoding to get timing segment for. |
timeout | of frame time segment to request. |
|
staticinherited |
Get the energey impulse level of a frame of audio data.
encoding | format of data to examine. |
buffer | of audio data to examine. |
number | of audio samples to examine. |
|
staticinherited |
Get the energey impulse level of a frame of audio data.
info | encoding source description object. |
buffer | of audio data to examine. |
number | of audio samples to examine. |
|
staticinherited |
Get the mime descriptive type for a given Audio encoding description, usually retrieved from a newly opened audio file.
info | source description object |
Get the mono encoding format associated with the given format.
encoding | format. |
|
staticinherited |
Get the short ascii description used for the given audio encoding type.
encoding | format. |
|
staticinherited |
Get the peak (highest energy) level found in a frame of audio data.
encoding | format of data. |
buffer | of audio data. |
number | of samples to examine. |
|
staticinherited |
Get the peak (highest energy) level found in a frame of audio data.
info | description object of audio data. |
buffer | of audio data. |
number | of samples to examine. |
Return default sample rate associated with the specified audio encoding format.
encoding | format. |
Return optional rate setting effect.
Many codecs are fixed rate.
encoding | format. |
requested | rate. |
|
inlineinherited |
|
inlineinherited |
Get the stereo encoding format associated with the given format.
encoding | format being tested for stereo. |
|
staticinherited |
Test for the presense of a specified (indexed) audio device.
This is normally used to test for local soundcard access.
device | index or 0 for default audio device. |
|
staticinherited |
Test if the audio encoding format must be packetized (that is, has irregular sized frames) and must be processed only through buffered codecs.
encoding | format. |
|
virtual |
See if at end of tone.
This is used for non-continues audio tones, or to detect "break" events.
Reimplemented from ost::AudioTone.
|
staticinherited |
Test if the endian byte order of the encoding format is different from the machine's native byte order.
encoding | format. |
|
staticinherited |
Test if the endian byte order of the audio source description is different from the machine's native byte order.
info | source description object. |
|
staticinherited |
Test if the audio encoding format is a linear one.
encoding | format. |
|
staticinherited |
Test if the audio encoding format is a mono format.
encoding | format. |
|
inherited |
Test if the tone generator is currently set to silence.
|
staticinherited |
Test if the audio encoding format is a stereo format.
encoding | format. |
|
staticinherited |
Load a dso plugin (codec plugin), used internally...
path | to codec. |
|
staticinherited |
Maximum framesize for a given coding that may be needed to store a result.
info | source description object. |
|
protectedinherited |
Reset the tone generator completely.
Produces silence.,
|
protectedinherited |
Set the frame to silent.
|
protectedinherited |
Set frame to generate single tone...
freq | of tone. |
level | of tone. |
Optionally swap endian of encoded audio data based on the audio encoding type, and relationship to native byte order.
info | source description of object. |
buffer | of audio data. |
number | of bytes of audio data. |
|
staticinherited |
Optionally swap endian of audio data if the encoding format endian byte order is different from the machine's native endian.
encoding | format of data. |
buffer | of audio data. |
number | of audio samples. |
|
staticinherited |
Optionally swap endian of audio data if the audio source description byte order is different from the machine's native endian byte order.
info | source description object of data. |
buffer | of audio data. |
number | of audio samples. |
|
staticinherited |
Compute the number of bytes a given number of samples in a given audio encoding will occupy.
info | encoding source description. |
number | of samples. |
|
staticinherited |
Compute the number of bytes a given number of samples in a given audio encoding will occupy.
encoding | format. |
number | of samples. |
|
staticinherited |
Convert integer power levels to dbm.
power | level. |
|
staticinherited |
Convert dbm power level to integer value (0-32768).
dbm | power level |
|
staticinherited |
Compute byte counts of audio data into number of samples based on the audio encoding format used.
encoding | format. |
bytes | of data. |
|
staticinherited |
Compute byte counts of audio data into number of samples based on the audio source description used.
info | encoding source description. |
bytes | of data. |
|
staticinherited |
Convert ascii timestamp representation to a timeout number.
timestamp | ascii data. |
|
staticinherited |
Provide ascii timestamp representation of a timeout value.
duration | timeout value |
address | for ascii data. |
size | of ascii data. |