Kwave::SampleFormat Class Reference

#include <SampleFormat.h>

Collaboration diagram for Kwave::SampleFormat:

Classes
class	Map

Public Types
enum	Format {   Unknown = -1, Signed = 401, Unsigned = 402, Float = 403,   Double = 404 }

Public Member Functions
	SampleFormat ()
	SampleFormat (const Format x)
	SampleFormat (const SampleFormat &f)
virtual	~SampleFormat ()
	operator Format () const
void	assign (Format f)
bool	operator== (const Format &f) const
int	toInt () const
void	fromInt (int i)

Private Attributes
Format	m_format

Detailed Description

Definition at line 30 of file SampleFormat.h.

Member Enumeration Documentation

Format

enum Kwave::SampleFormat::Format

numeric representation of a sample format

Note

for compatibility with older settings these values are the same as defined in audiofile.h.

Enumerator
Unknown	unknown/invalid format
Signed	signed integer
Unsigned	unsigned integer
Float	32 bit floating point
Double	64 bit floating point

Definition at line 38 of file SampleFormat.h.

                     {
            Unknown  =  -1, 
            Signed   = 401, 
            Unsigned = 402, 
            Float    = 403, 
            Double   = 404  
        } Format;

Constructor & Destructor Documentation

SampleFormat() [1/3]

Kwave::SampleFormat::SampleFormat ( )

inline

Default constructor

Definition at line 47 of file SampleFormat.h.

{ assign(Unknown); }

SampleFormat() [2/3]

Kwave::SampleFormat::SampleFormat ( const Format  x )

inlineexplicit

Constructor, from SampleFormat::xxx

Definition at line 50 of file SampleFormat.h.

{ assign(x); }

SampleFormat() [3/3]

Kwave::SampleFormat::SampleFormat ( const SampleFormat &  f )

inline

Copy constructor

Definition at line 53 of file SampleFormat.h.

{ assign(f); }

~SampleFormat()

virtual Kwave::SampleFormat::~SampleFormat ( )

inlinevirtual

Destructor

Definition at line 56 of file SampleFormat.h.

{}

Member Function Documentation

assign()

void Kwave::SampleFormat::assign ( Format  f )

inline

assignment operator from Format

Definition at line 62 of file SampleFormat.h.

Referenced by Kwave::WavEncoder::encode().

{ m_format = f; }

Here is the caller graph for this function:

fromInt()

void Kwave::SampleFormat::fromInt

(

int

i

)

conversion from int (e.g. for use in plugin parameters)

Definition at line 47 of file SampleFormat.cpp.

References Kwave::TypesMap< IDX, DATA >::findFromData(), m_format, and Unknown.

Referenced by Kwave::WavEncoder::encode(), Kwave::RecordParams::fromList(), and Kwave::RecordDialog::sampleFormatChanged().

{
    Kwave::SampleFormat::Map map;
    Kwave::SampleFormat::Format format =
        static_cast<Kwave::SampleFormat::Format>(i);
    int index = map.findFromData(format);
    m_format = (index >= 0) ? format : Kwave::SampleFormat::Unknown;
}

Here is the call graph for this function:

Here is the caller graph for this function:

operator Format()

Kwave::SampleFormat::operator Format ( ) const

inline

conversion operator to Format

Definition at line 59 of file SampleFormat.h.

{ return m_format; }

operator==()

bool Kwave::SampleFormat::operator== ( const Format &  f ) const

inline

compare operator

Definition at line 65 of file SampleFormat.h.

                                                        {
            return (f == m_format);
        }

toInt()

int Kwave::SampleFormat::toInt ( ) const

inline

conversion to int (e.g. for use in plugin parameters)

Definition at line 70 of file SampleFormat.h.

Referenced by Kwave::WavEncoder::encode(), and Kwave::RecordDialog::setSupportedSampleFormats().

{ return static_cast<int>(m_format); }

Here is the caller graph for this function:

Member Data Documentation

m_format

Format Kwave::SampleFormat::m_format

private

internal storage of the sample format, see Format

Definition at line 78 of file SampleFormat.h.

Referenced by fromInt().

---

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

• libkwave/SampleFormat.h
• libkwave/SampleFormat.cpp