AWaveBank Class Reference

#include <AWaveBank.h>

Inheritance diagram for AWaveBank:

Public Types
enum	LOADFLAGS_ : LOADFLAGS { LOADFLAGS_NONE = 0 , LOADFLAGS_LOCALISE = BITFLAG( 0 ) }
enum	LOADRESULT { LOADRESULT_ERR = -1 , LOADRESULT_OK = 0 }
enum	UNLOADRESULT { UNLOADRESULT_OK = 0 }
using	LOADFLAGS = TUINT32

Public Member Functions
	AWaveBank (const Toshi::TPString8 &a_strBank, const Toshi::TPString8 &a_strPath, TBOOL a_bSetFrequency)
virtual TBOOL	IsReady () const =0
virtual LOADRESULT	Load (LOADFLAGS a_uiFlags, TINT a_iBufferSize)=0
virtual UNLOADRESULT	Unload ()=0
virtual AWaveSampleHandle	GetWaveSample (TINT a_iWaveIndex, TINT a_iUnused) const
virtual void	ResetWave (TINT a_iWaveIndex)
virtual	~AWaveBank ()
AWave *	GetWave (TINT a_iWaveIndex)
TINT	GetWaveId (TINT a_iWaveIndex)
TINT	GetWaveFrequency (TINT a_iWaveIndex)
AWaveSampleHandle	CreateWaveSample (TINT a_iWaveIndex, TINT a_iUnused)
void	SetWaveFlag1 (TINT a_iWaveIndex)
void	SetWaveFlag2 (TINT a_iWaveIndex)
void	ParseWavesData (const PBProperties *a_pBankProperties, TUINT a_uiForcedFlags)

Protected Attributes
TINT	m_iNumWaves
TINT	m_iNumLoads
Toshi::TPString8	m_strBank
Toshi::TPString8	m_strPath
Toshi::TPString8	m_strExtension
TBOOL	m_bSetFrequency
AWave *	m_pWaves
AWaveBankFileHandle	m_FileHandle

Detailed Description

Definition at line 10 of file AWaveBank.h.

Member Typedef Documentation

LOADFLAGS

using AWaveBank::LOADFLAGS = TUINT32

Definition at line 13 of file AWaveBank.h.

Member Enumeration Documentation

LOADFLAGS_

enum AWaveBank::LOADFLAGS_ : LOADFLAGS

Enumerator
LOADFLAGS_NONE
LOADFLAGS_LOCALISE

Definition at line 14 of file AWaveBank.h.

    {
        LOADFLAGS_NONE     = 0,
        LOADFLAGS_LOCALISE = BITFLAG( 0 ),
    };

LOADRESULT

enum AWaveBank::LOADRESULT

Enumerator
LOADRESULT_ERR
LOADRESULT_OK

Definition at line 20 of file AWaveBank.h.

    {
        LOADRESULT_ERR = -1,
        LOADRESULT_OK  = 0,
    };

UNLOADRESULT

enum AWaveBank::UNLOADRESULT

Enumerator
UNLOADRESULT_OK

Definition at line 26 of file AWaveBank.h.

    {
        UNLOADRESULT_OK = 0
    };

Constructor & Destructor Documentation

AWaveBank()

AWaveBank::AWaveBank	(	const Toshi::TPString8 &	a_strBank,
		const Toshi::TPString8 &	a_strPath,
		TBOOL	a_bSetFrequency )

Definition at line 17 of file AWaveBank.cpp.

{
    m_iNumWaves = 0;
    m_iNumLoads = 0;
    m_strBank   = a_strBank;
    m_strPath   = a_strPath;
    m_pWaves    = TNULL;
 
    m_FileHandle    = TNULL;
    m_bSetFrequency = a_bSetFrequency;
 
    ASoundManager::ms_WaveBanks.Insert( a_strBank, this );
}

~AWaveBank()

AWaveBank::~AWaveBank ( )

virtual

Definition at line 41 of file AWaveBank.cpp.

{
    ASoundManager::ms_WaveBanks.Remove( m_strBank );
    delete[] m_pWaves;
}

Member Function Documentation

CreateWaveSample()

AWaveSampleHandle AWaveBank::CreateWaveSample	(	TINT	a_iWaveIndex,
		TINT	a_iUnused )

Definition at line 65 of file AWaveBank.cpp.

{
    TASSERT( a_iWaveIndex < m_iNumWaves );
 
    if ( m_pWaves[ a_iWaveIndex ].pSampleHandle == TNULL )
    {
        m_pWaves[ a_iWaveIndex ].pSampleHandle = GetWaveSample( a_iWaveIndex, a_iUnused );
    }
 
    return m_pWaves[ a_iWaveIndex ].pSampleHandle;
}

GetWave()

AWave * AWaveBank::GetWave

(

TINT

a_iWaveIndex

)

Definition at line 47 of file AWaveBank.cpp.

{
    TASSERT( a_iWaveIndex < m_iNumWaves );
    return &m_pWaves[ a_iWaveIndex ];
}

GetWaveFrequency()

TINT AWaveBank::GetWaveFrequency

(

TINT

a_iWaveIndex

)

Definition at line 59 of file AWaveBank.cpp.

{
    TASSERT( a_iWaveIndex < m_iNumWaves );
    return m_pWaves[ a_iWaveIndex ].iFrequency;
}

GetWaveId()

TINT AWaveBank::GetWaveId

(

TINT

a_iWaveIndex

)

Definition at line 53 of file AWaveBank.cpp.

{
    TASSERT( a_iWaveIndex < m_iNumWaves );
    return m_pWaves[ a_iWaveIndex ].iIndex;
}

GetWaveSample()

AWaveSampleHandle AWaveBank::GetWaveSample ( TINT a_iWaveIndex, TINT a_iUnused ) const

virtual

Definition at line 31 of file AWaveBank.cpp.

{
    TASSERT( a_iWaveIndex < m_iNumWaves );
    return m_pWaves[ a_iWaveIndex ].pSampleHandle;
}

IsReady()

virtual TBOOL AWaveBank::IsReady ( ) const

pure virtual

Implemented in AWaveBankFMODFSB, and AWaveBankFMODFSBStream.

Load()

virtual LOADRESULT AWaveBank::Load ( LOADFLAGS a_uiFlags, TINT a_iBufferSize )

pure virtual

Implemented in AWaveBankFMODFSB, and AWaveBankFMODFSBStream.

ParseWavesData()

void AWaveBank::ParseWavesData	(	const PBProperties *	a_pBankProperties,
		TUINT	a_uiForcedFlags )

Definition at line 91 of file AWaveBank.cpp.

{
    TVALIDPTR( a_pBankProperties );
 
    m_iNumWaves = 0;
 
    T2DynamicVector<AWave> vecWaves( GetGlobalAllocator(), 128, 128 );
 
    for ( TUINT i = 0; i < a_pBankProperties->GetPropertyCount(); i++ )
    {
        const PBProperties::PBProperty* pProperty = a_pBankProperties->GetPropertyByIndex( i );
 
        // Skip any properties other than Wave
        if ( pProperty->GetName().GetString()[ 0 ] != 'W' ) continue;
 
        TINT   iFrequency = 22050;
        TFLOAT fLength    = 0.0f;
        TUINT  uiFlags    = a_uiForcedFlags;
 
        const PBProperties* pWaveProperties = pProperty->GetValue()->GetProperties();
 
        // Parse flags
        const PBPropertyValue* pFlagsProperty = pWaveProperties->GetProperty( "flags" );
        if ( pFlagsProperty && uiFlags == 0 ) uiFlags = pFlagsProperty->GetInteger();
 
        // Parse frequency
        const PBPropertyValue* pFreqProperty = pWaveProperties->GetProperty( "frequency" );
        if ( pFreqProperty )
        {
            if ( m_bSetFrequency )
                iFrequency = pFreqProperty->GetInteger();
            else
                iFrequency = ASoundManager::GetSingleton()->m_iGlobalFrequency;
        }
 
        // Parse length
        pWaveProperties->GetOptionalPropertyValue( fLength, "length" );
 
        vecWaves.EmplaceBack( uiFlags, iFrequency, fLength, TNULL, -1 );
        m_iNumWaves += 1;
    }
 
    // Allocate the actual array that will store info about samples
    m_pWaves = new ( AMemory::GetMemBlock( AMemory::POOL_Sound ) ) AWave[ m_iNumWaves ];
 
    // Copy data from the vector
    for ( TINT i = 0; i < m_iNumWaves; i++ )
        m_pWaves[ i ] = vecWaves[ i ];
}

ResetWave()

void AWaveBank::ResetWave ( TINT a_iWaveIndex )

virtual

Definition at line 37 of file AWaveBank.cpp.

{
}

SetWaveFlag1()

void AWaveBank::SetWaveFlag1

(

TINT

a_iWaveIndex

)

Definition at line 77 of file AWaveBank.cpp.

{
    TASSERT( a_iWaveIndex < m_iNumWaves );
    m_pWaves[ a_iWaveIndex ].iFlags &= ~2;
    m_pWaves[ a_iWaveIndex ].iFlags |= 1;
}

SetWaveFlag2()

void AWaveBank::SetWaveFlag2

(

TINT

a_iWaveIndex

)

Definition at line 84 of file AWaveBank.cpp.

{
    TASSERT( a_iWaveIndex < m_iNumWaves );
    m_pWaves[ a_iWaveIndex ].iFlags &= ~1;
    m_pWaves[ a_iWaveIndex ].iFlags |= 2;
}

Unload()

virtual UNLOADRESULT AWaveBank::Unload ( )

pure virtual

Implemented in AWaveBankFMODFSB, and AWaveBankFMODFSBStream.

Member Data Documentation

m_bSetFrequency

TBOOL AWaveBank::m_bSetFrequency

protected

Definition at line 59 of file AWaveBank.h.

m_FileHandle

AWaveBankFileHandle AWaveBank::m_FileHandle

protected

Definition at line 61 of file AWaveBank.h.

m_iNumLoads

TINT AWaveBank::m_iNumLoads

protected

Definition at line 55 of file AWaveBank.h.

m_iNumWaves

TINT AWaveBank::m_iNumWaves

protected

Definition at line 54 of file AWaveBank.h.

m_pWaves

AWave* AWaveBank::m_pWaves

protected

Definition at line 60 of file AWaveBank.h.

m_strBank

Toshi::TPString8 AWaveBank::m_strBank

protected

Definition at line 56 of file AWaveBank.h.

m_strExtension

Toshi::TPString8 AWaveBank::m_strExtension

protected

Definition at line 58 of file AWaveBank.h.

m_strPath

Toshi::TPString8 AWaveBank::m_strPath

protected

Definition at line 57 of file AWaveBank.h.

---

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

• D:/_dev/OpenBarnyard/Source/OpenBarnyard/Source/Sound/AWaveBank.h
• D:/_dev/OpenBarnyard/Source/OpenBarnyard/Source/Sound/AWaveBank.cpp