Edinburgh Speech Tools  2.4-release
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Pages
EST_Wave Class Reference

#include <include/EST_Wave.h>

Inheritance diagram for EST_Wave:
Collaboration diagram for EST_Wave:

Public Member Functions

 EST_Wave ()
 default constructor
 
 EST_Wave (const EST_Wave &a)
 copy constructor
 
 EST_Wave (int n, int c, int sr)
 
 EST_Wave (int samps, int chans, short *memory, int offset=0, int sample_rate=default_sample_rate, int free_when_destroyed=0)
 Construct from memory supplied by caller.
 
const EST_SMatrixvalues () const
 
EST_SMatrixvalues ()
 
EST_Waveoperator= (const EST_Wave &w)
 Assignment operator.
 
EST_Waveoperator+= (const EST_Wave &a)
 
EST_Waveoperator|= (const EST_Wave &a)
 
void integrity () const
 
Access functions for finding amplitudes of samples
short & a (int i, int channel=0)
 
short a (int i, int channel=0) const
 
INLINE short & a_no_check (int i, int channel=0)
 
INLINE short a_no_check (int i, int channel=0) const
 
INLINE short & a_no_check_1 (int i, int channel=0)
 
INLINE short a_no_check_1 (int i, int channel=0) const
 
INLINE short set_a (int i, int channel=0, short val=0)
 
short operator() (int i, int channel) const
 
short operator() (int i) const
 
short & a_safe (int i, int channel=0)
 
float t (int i) const
 return the time position in seconds of the ith sample
 
Information functions
int num_samples () const
 return the number of samples in the waveform
 
int num_channels () const
 return the number of channels in the waveform
 
int sample_rate () const
 return the sampling rate (frequency)
 
void set_sample_rate (const int n)
 Set sampling rate to n
 
int length () const
 return the size of the waveform, i.e. the number of samples.
 
float end ()
 return the time position of the last sample.
 
bool have_left_context (unsigned int n) const
 Can we look N samples to the left?
 
EST_String sample_type () const
 
void set_sample_type (const EST_String t)
 
EST_String file_type () const
 
void set_file_type (const EST_String t)
 
EST_String name () const
 A string identifying the waveform, commonly used to store the filename.
 
void set_name (const EST_String n)
 Sets name.
 
Waveform manipulation functions
void resize (int num_samples, int num_channels=EST_ALL, int set=1)
 resize the waveform
 
void resample (int rate)
 Resample waveform to rate
 
void rescale (float gain, int normalize=0)
 
void rescale (const EST_Track &factor_contour)
 
void clear ()
 clear waveform and set size to 0.
 
void copy (const EST_Wave &from)
 
void fill (short v=0, int channel=EST_ALL)
 
void empty (int channel=EST_ALL)
 
void sample (EST_TVector< short > &sv, int n)
 
void channel (EST_TVector< short > &cv, int n)
 
void copy_channel (int n, short *buf, int offset=0, int num=EST_ALL) const
 
void copy_sample (int n, short *buf, int offset=0, int num=EST_ALL) const
 
void set_channel (int n, const short *buf, int offset=0, int num=EST_ALL)
 
void set_sample (int n, const short *buf, int offset=0, int num=EST_ALL)
 
void sub_wave (EST_Wave &sw, int offset=0, int num=EST_ALL, int start_c=0, int nchan=EST_ALL)
 
void sub_wave (EST_Wave &sw, int offset=0, int num=EST_ALL, int start_c=0, int nchan=EST_ALL) const
 
File i/o functions
EST_read_status load (const EST_String filename, int offset=0, int length=0, int rate=default_sample_rate)
 
EST_read_status load (EST_TokenStream &ts, int offset=0, int length=0, int rate=default_sample_rate)
 
EST_read_status load (const EST_String filename, const EST_String filetype, int offset=0, int length=0, int rate=default_sample_rate)
 
EST_read_status load (EST_TokenStream &ts, const EST_String filetype, int offset=0, int length=0, int rate=default_sample_rate)
 
EST_read_status load_file (const EST_String filename, const EST_String filetype, int sample_rate, const EST_String sample_type, int bo, int nc, int offset=0, int length=0)
 
EST_read_status load_file (EST_TokenStream &ts, const EST_String filetype, int sample_rate, const EST_String sample_type, int bo, int nc, int offset=0, int length=0)
 
EST_write_status save (const EST_String filename, const EST_String EST_filetype="")
 
EST_write_status save (FILE *fp, const EST_String EST_filetype="")
 
EST_write_status save_file (const EST_String filename, EST_String filetype, EST_String sample_type, int bo)
 
EST_write_status save_file (FILE *fp, EST_String filetype, EST_String sample_type, int bo)
 

Static Public Attributes

static const int default_sample_rate =16000
 
static const int default_num_channels
 

Protected Member Functions

void default_vals (int n=0, int c=1)
 
void free_wave ()
 
void copy_data (const EST_Wave &w)
 
void copy_setup (const EST_Wave &w)
 

Protected Attributes

EST_SMatrix p_values
 
int p_sample_rate
 

Friends

ostream & operator<< (ostream &p_values, const EST_Wave &sig)
 print waveform
 

Additional Inherited Members

Detailed Description

A class for storing digital waveforms. The waveform is stored as

an array of 16 bit shorts. Multiple channels are supported, but if no channel information is given the 0th channel is accessed.

The waveforms can be of any sample rate, and can be changed to another sampling rate using the resample function.

Definition at line 64 of file EST_Wave.h.

Member Function Documentation

short & EST_Wave::a ( int  i,
int  channel = 0 
)

return amplitude of sample i from channel channel. By default the 0th channel is selected. This function can be used for assignment.

Definition at line 126 of file EST_Wave.cc.

INLINE short EST_Wave::set_a ( int  i,
int  channel = 0,
short  val = 0 
)
inline

explicit set_a, easier to wrap than assignment

Definition at line 117 of file EST_Wave.h.

short EST_Wave::operator() ( int  i,
int  channel 
) const
inline

return amplitude of sample i from channel channel. By default the 0th channel is selected.

Definition at line 123 of file EST_Wave.h.

short EST_Wave::operator() ( int  i) const
inline

return amplitude of sample i from channel 0.

Definition at line 128 of file EST_Wave.h.

short & EST_Wave::a_safe ( int  i,
int  channel = 0 
)

Version of a() that returns zero if index is out of array bounds. This is particularly useful in signal processing when you want to have windows going off the end of the waveform.

Definition at line 150 of file EST_Wave.cc.

EST_String EST_Wave::sample_type ( ) const
inline

returns the file format of the file from which the waveform was read. If the waveform has not been read from a file, this is set to the default type

Definition at line 163 of file EST_Wave.h.

void EST_Wave::rescale ( float  gain,
int  normalize = 0 
)

multiply all samples by a factor gain. This checks for overflows and puts them to the maximum positive or negative value as appropriate.

Definition at line 453 of file EST_Wave.cc.

EST_read_status EST_Wave::load ( const EST_String  filename,
int  offset = 0,
int  length = 0,
int  rate = default_sample_rate 
)

Load a file into the waveform. The load routine attempts to automatically determine which file type is being loaded. A portion of the waveform can be loaded by setting offset to the sample position from the beginning and <length> to the number of required samples after this.

Definition at line 178 of file EST_Wave.cc.

EST_read_status EST_Wave::load_file ( const EST_String  filename,
const EST_String  filetype,
int  sample_rate,
const EST_String  sample_type,
int  bo,
int  nc,
int  offset = 0,
int  length = 0 
)

Load a file of type filetype into the waveform. This can be used to load unheadered files, in which case the fields sample_rate, sample_type, bo and nc are used to specify the sample rate, type, byte order and number of channels. A portion of the waveform can be loaded by setting offset to the sample position from the beginning and <length> to the number of required samples after this.

Definition at line 286 of file EST_Wave.cc.

EST_Wave & EST_Wave::operator+= ( const EST_Wave a)

Add to existing wave in serial. Waveforms must have the same number of channels.

Definition at line 554 of file EST_Wave.cc.

EST_Wave & EST_Wave::operator|= ( const EST_Wave a)

Add wave in parallel, i.e. make wave a become new channels in existing waveform.

Definition at line 578 of file EST_Wave.cc.


The documentation for this class was generated from the following files: