HARDT - The Ham Radio DSP Toolkit
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
HWav Class Reference

#include <hwav.h>

Inheritance diagram for HWav:
Inheritance graph
[legend]

Public Member Functions

H_SAMPLE_FORMAT GetFormat ()
 
int GetChannels ()
 
H_SAMPLE_RATE GetRate ()
 
size_t GetSize ()
 
const char * GetFilename ()
 
 HWav (const char *filename)
 

Protected Member Functions

 HWav (HWav const &wav)
 
 HWav (const char *filename, H_SAMPLE_FORMAT format, int channels, H_SAMPLE_RATE rate)
 

Protected Attributes

WavHeader _header
 

Detailed Description

This class contains the basic description of a wav file, a generic header and functions to map between an array of bytes and specific property names.

Please be aware that the current wav implementation only supports 1 and 2 channels with 16 bit data.

You should never have to use this class directly!

Constructor & Destructor Documentation

◆ HWav() [1/3]

HWav::HWav ( HWav const &  wav)
inlineprotected

Construct a new wav object from another wav object

◆ HWav() [2/3]

HWav::HWav ( const char *  filename,
H_SAMPLE_FORMAT  format,
int  channels,
H_SAMPLE_RATE  rate 
)
protected

Construct a new wav object with the given format, channels and samplerate

◆ HWav() [3/3]

HWav::HWav ( const char *  filename)

Construct a new wav object from a local file

Member Function Documentation

◆ GetChannels()

int HWav::GetChannels ( )

Return the number of channels used by this object

◆ GetFilename()

const char * HWav::GetFilename ( )

Get the name of the file from where the sample where read, or should be written

◆ GetFormat()

H_SAMPLE_FORMAT HWav::GetFormat ( )

Return the sample format used by this object

◆ GetRate()

H_SAMPLE_RATE HWav::GetRate ( )

Return the samplerate used by this object

◆ GetSize()

size_t HWav::GetSize ( )

Get the size of the sample data contained by this object

Member Data Documentation

◆ _header

WavHeader HWav::_header
protected

Mapping of datafields in the wav header. Please see the wav specification for detailed description of the fields.. It can be found here: http://soundfile.sapp.org/doc/WaveFormat Contains the header data of the wav object


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