audio_format Class Reference

#include <audio_format.hpp>

Public Member Functions
	audio_format (unsigned int samples_per_second, unsigned short int bits_per_sample, unsigned short int channels)
virtual	~audio_format (void)
bool	operator== (audio_format &eq) const
unsigned int	sample_rate (void) const
unsigned short int	bits (void) const
unsigned short int	channels (void) const
unsigned int	byte_rate (void) const
unsigned int	block_align (void) const
unsigned int	samples_in_seconds (float seconds) const
unsigned int	samples_in_bytes (unsigned int bytes) const
unsigned int	bytes_in_samples (unsigned int samples) const

Protected Attributes
unsigned int	samples_psec
unsigned short int	bits_psample
unsigned short int	chan

Detailed Description

Definition at line 15 of file audio_format.hpp.

Constructor & Destructor Documentation

audio_format()

audio_format::audio_format ( unsigned int  samples_per_second, unsigned short int  bits_per_sample, unsigned short int  channels  )

inline

Definition at line 23 of file audio_format.hpp.

                                                  : samples_psec(samples_per_second),
                                                    bits_psample(bits_per_sample),
                                                    chan(channels)
        {
        }

~audio_format()

virtual audio_format::~audio_format ( void  )

inlinevirtual

Definition at line 32 of file audio_format.hpp.

        {
        }

Member Function Documentation

bits()

unsigned short int audio_format::bits ( void  ) const

inline

Definition at line 53 of file audio_format.hpp.

        {
            return bits_psample;
        }

Referenced by audio_resampler_acm::init_(), audio_wavein::nsample(), audio_waveout::nsample(), audio_wavein::open(), audio_waveout::open(), audio_wavein::samplevalue_max(), and audio_waveout::samplevalue_max().

block_align()

unsigned int audio_format::block_align ( void  ) const

inline

Definition at line 68 of file audio_format.hpp.

        {
            return (chan * (bits_psample / 8));
        }

Referenced by audio_resampler_acm::init_(), audio_wavein::open(), and audio_waveout::open().

byte_rate()

unsigned int audio_format::byte_rate ( void  ) const

inline

Definition at line 63 of file audio_format.hpp.

        {
            return (samples_psec * chan * (bits_psample / 8));
        }

Referenced by audio_wavein::alloc_buffers_mem_(), audio_waveout::alloc_buffers_mem_(), audio_membuffer::alloc_seconds(), audio_membuffer::audio_membuffer(), audio_membuffer::fseconds_recorded(), audio_membuffer::fseconds_total(), audio_resampler_acm::init_(), audio_resampler_acm::open(), audio_wavein::open(), audio_waveout::open(), audio_membuffer::resize_seconds(), audio_membuffer::seconds_recorded(), and audio_membuffer::seconds_total().

bytes_in_samples()

unsigned int audio_format::bytes_in_samples ( unsigned int  samples ) const

inline

Definition at line 83 of file audio_format.hpp.

        {
            return (samples * ((bits_psample / 8) * chan));
        }

Referenced by audio_wavein::nsample(), and audio_waveout::nsample().

channels()

unsigned short int audio_format::channels ( void  ) const

inline

Definition at line 58 of file audio_format.hpp.

        {
            return chan;
        }

Referenced by audio_resampler_acm::init_(), audio_wavein::open(), and audio_waveout::open().

operator==()

bool audio_format::operator== ( audio_format &  eq ) const

inline

Definition at line 37 of file audio_format.hpp.

        {
            /* The same audio format is when samples per second,
               bit per sample, and channels mono/stereo are equal */
            return ((samples_psec == eq.samples_psec) &&
                    (bits_psample == eq.bits_psample) &&
                    (chan == eq.chan));
        }

sample_rate()

unsigned int audio_format::sample_rate ( void  ) const

inline

Definition at line 48 of file audio_format.hpp.

        {
            return samples_psec;
        }

Referenced by audio_resampler_acm::init_(), audio_wavein::open(), and audio_waveout::open().

samples_in_bytes()

unsigned int audio_format::samples_in_bytes ( unsigned int  bytes ) const

inline

Definition at line 78 of file audio_format.hpp.

        {
            return (bytes / ((bits_psample / 8) * chan));
        }

Referenced by audio_membuffer::audio_receive(), audio_membuffer::read(), audio_membuffer::samples_received(), audio_wavein::tot_samples_buf(), and audio_waveout::tot_samples_buf().

samples_in_seconds()

unsigned int audio_format::samples_in_seconds ( float  seconds ) const

inline

Definition at line 73 of file audio_format.hpp.

        {
            return (unsigned int)(((float)samples_psec * (float) chan) * seconds);
        }

Referenced by audio_membuffer::total_samples().

Member Data Documentation

bits_psample

unsigned short int audio_format::bits_psample

protected

Definition at line 19 of file audio_format.hpp.

Referenced by bits(), block_align(), byte_rate(), bytes_in_samples(), operator==(), and samples_in_bytes().

chan

unsigned short int audio_format::chan

protected

Definition at line 20 of file audio_format.hpp.

Referenced by block_align(), byte_rate(), bytes_in_samples(), channels(), operator==(), samples_in_bytes(), and samples_in_seconds().

samples_psec

unsigned int audio_format::samples_psec

protected

Definition at line 18 of file audio_format.hpp.

Referenced by byte_rate(), operator==(), sample_rate(), and samples_in_seconds().

---

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

• base/applications/sndrec32/audio_format.hpp