AudioSampleValue< Type, ValueType > Class Template Reference

a class representing an audio sample

#include <AudioSampleValue.h>

Inheritance diagram for AudioSampleValue< Type, ValueType >:

SampleValue List of all members.

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

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

template<AUDIOSAMPLETYPE Type, class ValueType>
class AudioSampleValue< Type, ValueType >


Constructor & Destructor Documentation

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


Member Function Documentation

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

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:
t the 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.

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:
s a sample value of the same type as this
Returns:
the distance

Implements SampleValue.

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.

template<AUDIOSAMPLETYPE Type, class ValueType>
UWORD32 AudioSampleValue< Type, ValueType >::calcKey ( ValueType  v  )  const [inline, private]

template<AUDIOSAMPLETYPE Type, class ValueType>
EmbValue AudioSampleValue< Type, ValueType >::calcEValue ( ValueType  v  )  const [inline, private]


Member Data Documentation

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

template<AUDIOSAMPLETYPE Type, class ValueType>
const SWORD32 AuPCM32SampleValue::MinValue [static, private]

template<AUDIOSAMPLETYPE Type, class ValueType>
const SWORD32 AuPCM32SampleValue::MaxValue [static, private]


The documentation for this class was generated from the following files:
Generated on Fri Feb 2 13:54:25 2007 for steghide by  doxygen 1.5.1