steghide 0.5.1
AudioSampleValue< Type, ValueType > Class Template Reference

a class representing an audio sample

#include <AudioSampleValue.h>

Inheritance diagram for AudioSampleValue< Type, ValueType >:
SampleValue

Public Member Functions

 AudioSampleValue (ValueType v)
ValueType getValue (void) const
SampleValuegetNearestTargetSampleValue (EmbValue t) const
UWORD32 calcDistance (const SampleValue *s) const
std::string getName (void) const
Public Member Functions inherited from SampleValue
 SampleValue (void)
virtual ~SampleValue (void)
virtual bool isNeighbour (const SampleValue *s) const
EmbValue getEmbeddedValue (void) const
UWORD32 getKey (void) const
bool operator== (const SampleValue &sv) const
bool operator!= (const SampleValue &sv) const
bool operator< (const SampleValue &sv) const
UWORD32 getNumEdges (EmbValue t) const
void setNumEdges (EmbValue t, UWORD32 ne)
void incNumEdges (EmbValue t)
void decNumEdges (EmbValue t)
void setLabel (unsigned long l)
unsigned long getLabel (void) const
void print (unsigned short spc=0) const

Private Member Functions

UWORD32 calcKey (ValueType v) const
EmbValue calcEValue (ValueType v) const

Private Attributes

ValueType Value

Static Private Attributes

static const ValueType MinValue
static const ValueType MaxValue

Additional Inherited Members

Protected Attributes inherited from SampleValue
EmbValue EValue
 the bit that is embedded in this sample value - must be set in constructor of derived class
UWORD32 Key
 the key of this sample value - must be different for two different sample values - must be set in constructor of derived class

Constructor & Destructor Documentation

◆ AudioSampleValue()

template<AUDIOSAMPLETYPE Type, class ValueType>
AudioSampleValue< Type, ValueType >::AudioSampleValue ( ValueType v)

Member Function Documentation

◆ calcDistance()

template<AUDIOSAMPLETYPE Type, class ValueType>
UWORD32 AudioSampleValue< Type, ValueType >::calcDistance ( const SampleValue * s) const
virtual

calculate the distance between the sample value s and this sample value

Parameters
sa sample value of the same type as this
Returns
the distance

Implements SampleValue.

◆ calcEValue()

template<AUDIOSAMPLETYPE Type, class ValueType>
EmbValue AudioSampleValue< Type, ValueType >::calcEValue ( ValueType v) const
inlineprivate

◆ calcKey()

template<AUDIOSAMPLETYPE Type, class ValueType>
UWORD32 AudioSampleValue< Type, ValueType >::calcKey ( ValueType v) const
inlineprivate

◆ getName()

template<AUDIOSAMPLETYPE Type, class ValueType>
std::string AudioSampleValue< Type, ValueType >::getName ( void ) const
virtual

return a short name uniquely identifying this sample value

Implements SampleValue.

◆ getNearestTargetSampleValue()

template<AUDIOSAMPLETYPE Type, class ValueType>
SampleValue * AudioSampleValue< Type, ValueType >::getNearestTargetSampleValue ( EmbValue t) const
virtual

get the nearest (with the least distance to this sample value) sample value whose embedded value equals the specified target

Parameters
tthe target embedded value

If two or more target sample values have equal distance each of them should be returned with equal probability.

The returned SampleValue object should be deleted by the callser.

Implements SampleValue.

◆ getValue()

template<AUDIOSAMPLETYPE Type, class ValueType>
ValueType AudioSampleValue< Type, ValueType >::getValue ( void ) const
inline

Member Data Documentation

◆ MaxValue

template<AUDIOSAMPLETYPE Type, class ValueType>
const ValueType AudioSampleValue< Type, ValueType >::MaxValue
staticprivate

◆ MinValue

template<AUDIOSAMPLETYPE Type, class ValueType>
const ValueType AudioSampleValue< Type, ValueType >::MinValue
staticprivate

◆ Value

template<AUDIOSAMPLETYPE Type, class ValueType>
ValueType AudioSampleValue< Type, ValueType >::Value
private

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