This class should be used to hold meta information about a sound sample. More...

#include <SampleMetadata.hxx>

Public Member Functions
	DYNAMIC_TYPE (SampleMetadata, 6)
	DYN_ATTRIBUTE (0, public, CLAM::Filename, Filename)
	DYN_ATTRIBUTE (SAMPLE_METADATA_PITCH_INDEX, public, double, Pitch)
	DYN_ATTRIBUTE (SAMPLE_METADATA_AMPLITUDE_INDEX, public, double, Amplitude)
	DYN_ATTRIBUTE (3, public, int, SortIndex)
	DYN_ATTRIBUTE (4, public, int, StartSteadyState)
	DYN_CONTAINER_ATTRIBUTE (5, public, std::vector< SimpleLoopMetadata >, ListOfLoops, Loop)
void	DefaultInit ()
	The concrete dynamic type constructor calls DefaultInit().
void	ConfigureAfterRestore ()
bool	operator< (const SampleMetadata &argSampleMetadata) const
bool	operator> (const SampleMetadata &argSampleMetadata) const
bool	operator== (const SampleMetadata &argSampleMetadata) const
Public Member Functions inherited from CLAM::DynamicType
	DynamicType (const int nAttr)
	Constructs a DynamicType object that can hold.
	DynamicType (const DynamicType &prototype, const bool shareData, const bool deepCopy)
	Copy constructor of a dynamic Type.
	DynamicType (const DynamicType &prototype)
virtual	~DynamicType ()
virtual const char *	GetClassName () const =0
	Return the class name.
void	CopyInit (const DynamicType &dt)
	This method allows custom code for the copy-constructor of a dynamic type, since the copy-constructor is macro expanded and can not be overwritted.
bool	UpdateData ()
	Method used to resize the data space of the dynamic type, necessary when some AddXXX() / RemoveXXX() (where XXX is an attribute name) has been done.
unsigned	GetNDynamicAttributes () const
const char *	GetDynamicAttributeName (unsigned i)
virtual const std::type_info &	GetTypeId (unsigned i) const =0
bool	AttributeIsComponent (unsigned i) const
bool	AttributeIsDynamictype (unsigned i) const
bool	IsAttributeInstantiated (unsigned i) const
const void *	GetAttributeAsVoidPtr (unsigned i) const
const Component *	GetAttributeAsComponent (unsigned i) const
Component *	GetAttributeAsComponent (unsigned i)
void	FullfilsInvariant () const
virtual Component *	DeepCopy () const
void	Debug () const
virtual void	StoreOn (CLAM::Storage &storage) const
	Stores component's subitems on the given Storage.
virtual void	LoadFrom (CLAM::Storage &storage)
	Loads component's subitems from the given Storage.
Public Member Functions inherited from CLAM::Component
virtual	~Component ()

Additional Inherited Members
Public Types inherited from CLAM::DynamicType
enum	{ idLength = 120, typeLength = 120 }
Protected Types inherited from CLAM::DynamicType
enum	{ shrinkThreshold = 80 }
Protected Member Functions inherited from CLAM::DynamicType
virtual void	InformAll ()
	implemented by the macros in the concrete class.
void	InformTypedAttr_ (unsigned id, const char name, unsigned size, const char type, const bool isPtr, const t_new, const t_new_copy, const t_destructor, const Component *ptr)
void	InformTypedAttr_ (unsigned id, const char name, unsigned size, const char type, const bool isPtr, const t_new, const t_new_copy, const t_destructor, const DynamicType *ptr)
void	InformTypedAttr_ (unsigned id, const char name, unsigned size, const char type, const bool isPtr, const t_new, const t_new_copy, const t_destructor, const void *ptr)
void	AddAttr_ (const unsigned i, const unsigned size)
void	RemoveAttr_ (const unsigned id)
virtual DynamicType &	GetDynamicTypeCopy (const bool shareData=false, const bool deep=false) const =0
virtual Component *	ShallowCopy () const
DynamicType &	operator= (const DynamicType &source)
unsigned	GetNumAttr () const
unsigned	GetNumActiveAttr () const
char *	GetData () const
void	SetData (char *srcData)
TDynInfo *	GetDynamicTable () const
TAttr *	GetTypeDescTable () const
unsigned	GetDataSize () const
bool	IsInstanciate () const
bool	OwnsItsMemory () const
void	SetOwnsItsMemory (const bool owns)
bool	ExistAttr (unsigned id) const
void	SetPreAllocateAllAttributes ()
int	DynTableRefCounter ()
void	InitDynTableRefCounter ()
int	DecrementDynTableRefCounter ()
int	IncrementDynTableRefCounter ()
virtual void	StoreDynAttributes (CLAM::Storage &s) const =0
virtual void	LoadDynAttributes (CLAM::Storage &s)=0
template<typename AttribType >
void	StoreAttribute (StaticTrue asLeave, CLAM::Storage &s, AttribType &object, const char name) const
template<typename AttribType >
void	StoreAttribute (StaticFalse asLeave, CLAM::Storage &s, AttribType &object, const char name) const
template<typename AttribType >
void	StoreIterableAttribute (CLAM::Storage &s, AttribType &object, const char name, const char elemName) const
template<typename AttribType >
bool	LoadAttribute (StaticTrue asLeave, CLAM::Storage &s, AttribType &object, const char name)
template<typename AttribType >
bool	LoadAttribute (StaticFalse asLeave, CLAM::Storage &s, AttribType &object, const char name)
template<typename AttribType >
bool	LoadIterableAttribute (CLAM::Storage &s, AttribType &object, const char name, const char elemName)
Protected Attributes inherited from CLAM::DynamicType
unsigned	numActiveAttr
char *	data
TDynInfo *	dynamicTable
TAttr *	typeDescTable
unsigned	dataSize
bool	bOwnsItsMemory
unsigned	numAttr
unsigned	maxAttrSize
unsigned	allocatedDataSize

Detailed Description

This class should be used to hold meta information about a sound sample.

This meta information includes both content-based audio descriptors such as the pitch and amplitude of a sample as well as information about the properties of the sound generation process. Finally, this class also holds information about the possible loop points to be used by a sample.

Author:: greg kellum [gkell.nosp@m.um@i.nosp@m.ua.up.nosp@m.f.ed.nosp@m.u] 6/15/2007

Since:: CLAM v1.1.

Definition at line 29 of file SampleMetadata.hxx.

Member Function Documentation

void CLAM::SampleMetadata::ConfigureAfterRestore ( )

Definition at line 17 of file SampleMetadata.cxx.

References CLAM::DynamicType::UpdateData().

void CLAM::SampleMetadata::DefaultInit ( void )

The concrete dynamic type constructor calls DefaultInit().

This allows user to initialize his/her object. But we define DefaultInit() here because we don't want to force writting one DefaultInit() function for each concrete dynamic type. If a dynamic type concrete class defines some (not-default) constructors, this should also call the DefaultInit().

See also:: CopyInit()

Reimplemented from CLAM::DynamicType.

Definition at line 7 of file SampleMetadata.cxx.

References SAMPLE_METADATA_PITCH_INDEX, and CLAM::DynamicType::UpdateData().

CLAM::SampleMetadata::DYN_ATTRIBUTE	(	0	,
		public	,
		CLAM::Filename	,
		Filename
	)

CLAM::SampleMetadata::DYN_ATTRIBUTE	(	SAMPLE_METADATA_PITCH_INDEX	,
		public	,
		double	,
		Pitch
	)

CLAM::SampleMetadata::DYN_ATTRIBUTE	(	SAMPLE_METADATA_AMPLITUDE_INDEX	,
		public	,
		double	,
		Amplitude
	)

CLAM::SampleMetadata::DYN_ATTRIBUTE	(	3	,
		public	,
		int	,
		SortIndex
	)

CLAM::SampleMetadata::DYN_ATTRIBUTE	(	4	,
		public	,
		int	,
		StartSteadyState
	)

CLAM::SampleMetadata::DYN_CONTAINER_ATTRIBUTE	(	5	,
		public	,
		std::vector< SimpleLoopMetadata >	,
		ListOfLoops	,
		Loop
	)

CLAM::SampleMetadata::DYNAMIC_TYPE	(	SampleMetadata	,
		6
	)

bool CLAM::SampleMetadata::operator< ( const SampleMetadata & argSampleMetadata ) const

Definition at line 23 of file SampleMetadata.cxx.

References SAMPLE_METADATA_AMPLITUDE_INDEX, and SAMPLE_METADATA_PITCH_INDEX.

bool CLAM::SampleMetadata::operator== ( const SampleMetadata & argSampleMetadata ) const

Definition at line 62 of file SampleMetadata.cxx.

References SAMPLE_METADATA_AMPLITUDE_INDEX, and SAMPLE_METADATA_PITCH_INDEX.

bool CLAM::SampleMetadata::operator> ( const SampleMetadata & argSampleMetadata ) const

Definition at line 43 of file SampleMetadata.cxx.

References SAMPLE_METADATA_AMPLITUDE_INDEX, and SAMPLE_METADATA_PITCH_INDEX.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation