Twilight Princess
Decompilation of The Legend of Zelda: Twilight Princess
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Private Attributes | Friends | List of all members
nw4hbm::snd::detail::BasicSound Class Referenceabstract

#include <BasicSound.h>

+ Inheritance diagram for nw4hbm::snd::detail::BasicSound:
+ Collaboration diagram for nw4hbm::snd::detail::BasicSound:

Classes

struct  AmbientArgAllocaterCallback
 
struct  AmbientArgInfo
 
struct  AmbientArgUpdateCallback
 
struct  AmbientParamUpdateCallback
 

Public Types

typedef struct nw4hbm::snd::detail::BasicSound::AmbientParamUpdateCallback AmbientParamUpdateCallback
 
typedef struct nw4hbm::snd::detail::BasicSound::AmbientArgUpdateCallback AmbientArgUpdateCallback
 
typedef struct nw4hbm::snd::detail::BasicSound::AmbientArgAllocaterCallback AmbientArgAllocaterCallback
 
typedef struct nw4hbm::snd::detail::BasicSound::AmbientArgInfo AmbientArgInfo
 

Public Member Functions

 BasicSound ()
 
virtual ~BasicSound ()
 
virtual void Update ()
 
virtual void StartPrepared ()
 
virtual void Stop (int frames=0)
 
virtual void Pause (bool flag, int frames)
 
virtual void SetAutoStopCounter (int count)
 
virtual void FadeIn (int frames)
 
virtual void Shutdown ()
 
virtual bool IsPrepared () const
 
virtual bool IsPause () const
 
virtual void SetInitialVolume (f32 volume)
 
virtual void SetVolume (f32 volume, int frames)
 
virtual void SetPitch (f32 pitch)
 
virtual void SetPan (f32 pan)
 
virtual void SetSurroundPan (f32 pan)
 
virtual void SetLpfFreq (f32 freq)
 
virtual void SetPlayerPriority (int priority)
 
virtual bool IsAttachedTempSpecialHandle ()=0
 
virtual void DetachTempSpecialHandle ()=0
 
virtual void InitParam ()
 
virtual BasicPlayer & GetBasicPlayer ()=0
 
virtual const BasicPlayer & GetBasicPlayer () const =0
 
PlayerHeap * GetPlayerHeap ()
 
void SetPlayerHeap (PlayerHeap *heap)
 
bool IsAttachedGeneralHandle ()
 
void DetachGeneralHandle ()
 
bool IsAttachedTempGeneralHandle ()
 
void DetachTempGeneralHandle ()
 
SoundPlayer * GetSoundPlayer ()
 
void SetSoundPlayer (SoundPlayer *player)
 
ExternalSoundPlayer * GetExternalSoundPlayer ()
 
void SetExternalSoundPlayer (ExternalSoundPlayer *extPlayer)
 
AmbientParamUpdateCallback * GetAmbientParamUpdateCallback ()
 
AmbientArgUpdateCallback * GetAmbientArgUpdateCallback ()
 
void ClearAmbientArgUpdateCallback ()
 
AmbientArgAllocaterCallback * GetAmbientArgAllocaterCallback ()
 
void * GetAmbientArg ()
 
SoundParam & GetAmbientParam ()
 
void SetAmbientParamCallback (AmbientParamUpdateCallback *paramUpdateCallback, AmbientArgUpdateCallback *argUpdateCallback, AmbientArgAllocaterCallback *argAllocaterCallback, void *callbackArg)
 
void SetPriority (int priority)
 
u32 GetId () const
 
void SetId (u32 id)
 
f32 GetMoveVolume ()
 
f32 GetInitialVolume () const
 
f32 GetPan () const
 
f32 GetSurroundPan () const
 
f32 GetPitch () const
 
f32 GetVolume () const
 
void SetOutputLine (int flag)
 
bool IsEnabledOutputLine () const
 
int GetOutputLine () const
 
f32 GetMainOutVolume () const
 
void SetMainOutVolume (f32 volume)
 
f32 GetRemoteOutVolume (int remote) const
 
void SetRemoteOutVolume (int remote, f32 volume)
 
void SetFxSend (AuxBus bus, f32 send)
 
int CalcCurrentPlayerPriority () const
 

Public Attributes

 NW4HBM_UT_RUNTIME_TYPEINFO
 
ut::LinkListNode mPriorityLink
 
ut::LinkListNode mSoundPlayerPlayLink
 
ut::LinkListNode mSoundPlayerPriorityLink
 
ut::LinkListNode mExtSoundPlayerPlayLink
 

Static Public Attributes

static const u32 INVALID_ID = 0xFFFFFFFF
 
static const int PRIORITY_MAX = 127
 

Private Attributes

PlayerHeap * mHeap
 
SoundHandle * mGeneralHandle
 
SoundHandle * mTempGeneralHandle
 
SoundPlayer * mSoundPlayer
 
ExternalSoundPlayer * mExtSoundPlayer
 
AmbientParamUpdateCallback * mAmbientParamUpdateCallback
 
AmbientArgUpdateCallback * mAmbientArgUpdateCallback
 
AmbientArgAllocaterCallback * mAmbientArgAllocaterCallback
 
void * mAmbientArg
 
SoundParam mAmbientParam
 
MoveValue< f32, int > mFadeVolume
 
MoveValue< f32, int > mPauseFadeVolume
 
bool mStartFlag
 
bool mStartedFlag
 
bool mAutoStopFlag
 
bool mPauseFlag
 
bool mPauseFadeFlag
 
bool mFadeOutFlag
 
int mAutoStopCounter
 
u32 mUpdateCounter
 
u8 mPriority
 
u32 mId
 
MoveValue< f32, int > mExtMoveVolume
 
f32 mInitVolume
 
f32 mExtPan
 
f32 mExtSurroundPan
 
f32 mExtPitch
 
bool mOutputLineFlagEnable
 
int mOutputLineFlag
 
f32 mMainOutVolume
 
f32 mRemoteOutVolume [WPAD_MAX_CONTROLLERS]
 

Friends

class SoundHandle
 

Member Typedef Documentation

◆ AmbientArgAllocaterCallback

struct nw4hbm::snd::detail::BasicSound::AmbientArgAllocaterCallback nw4hbm::snd::detail::BasicSound::AmbientArgAllocaterCallback

◆ AmbientArgInfo

struct nw4hbm::snd::detail::BasicSound::AmbientArgInfo nw4hbm::snd::detail::BasicSound::AmbientArgInfo

◆ AmbientArgUpdateCallback

struct nw4hbm::snd::detail::BasicSound::AmbientArgUpdateCallback nw4hbm::snd::detail::BasicSound::AmbientArgUpdateCallback

◆ AmbientParamUpdateCallback

struct nw4hbm::snd::detail::BasicSound::AmbientParamUpdateCallback nw4hbm::snd::detail::BasicSound::AmbientParamUpdateCallback

Constructor & Destructor Documentation

◆ BasicSound()

nw4hbm::snd::detail::BasicSound::BasicSound ( )

◆ ~BasicSound()

virtual nw4hbm::snd::detail::BasicSound::~BasicSound ( )
inlinevirtual

Member Function Documentation

◆ CalcCurrentPlayerPriority()

int nw4hbm::snd::detail::BasicSound::CalcCurrentPlayerPriority ( ) const
inline

◆ ClearAmbientArgUpdateCallback()

void nw4hbm::snd::detail::BasicSound::ClearAmbientArgUpdateCallback ( )
inline

◆ DetachGeneralHandle()

void nw4hbm::snd::detail::BasicSound::DetachGeneralHandle ( )

◆ DetachTempGeneralHandle()

void nw4hbm::snd::detail::BasicSound::DetachTempGeneralHandle ( )

◆ DetachTempSpecialHandle()

virtual void nw4hbm::snd::detail::BasicSound::DetachTempSpecialHandle ( )
pure virtual

Implemented in nw4hbm::snd::detail::SeqSound, nw4hbm::snd::detail::StrmSound, and nw4hbm::snd::detail::WaveSound.

◆ FadeIn()

virtual void nw4hbm::snd::detail::BasicSound::FadeIn ( int frames)
virtual

◆ GetAmbientArg()

void * nw4hbm::snd::detail::BasicSound::GetAmbientArg ( )
inline

◆ GetAmbientArgAllocaterCallback()

AmbientArgAllocaterCallback * nw4hbm::snd::detail::BasicSound::GetAmbientArgAllocaterCallback ( )
inline

◆ GetAmbientArgUpdateCallback()

AmbientArgUpdateCallback * nw4hbm::snd::detail::BasicSound::GetAmbientArgUpdateCallback ( )
inline

◆ GetAmbientParam()

SoundParam & nw4hbm::snd::detail::BasicSound::GetAmbientParam ( )
inline

◆ GetAmbientParamUpdateCallback()

AmbientParamUpdateCallback * nw4hbm::snd::detail::BasicSound::GetAmbientParamUpdateCallback ( )
inline

◆ GetBasicPlayer() [1/2]

virtual const BasicPlayer & nw4hbm::snd::detail::BasicSound::GetBasicPlayer ( ) const
pure virtual

Implemented in nw4hbm::snd::detail::SeqSound, nw4hbm::snd::detail::StrmSound, and nw4hbm::snd::detail::WaveSound.

◆ GetBasicPlayer() [2/2]

virtual BasicPlayer & nw4hbm::snd::detail::BasicSound::GetBasicPlayer ( )
pure virtual

Implemented in nw4hbm::snd::detail::SeqSound, nw4hbm::snd::detail::StrmSound, and nw4hbm::snd::detail::WaveSound.

◆ GetExternalSoundPlayer()

ExternalSoundPlayer * nw4hbm::snd::detail::BasicSound::GetExternalSoundPlayer ( )
inline

◆ GetId()

u32 nw4hbm::snd::detail::BasicSound::GetId ( ) const
inline

◆ GetInitialVolume()

f32 nw4hbm::snd::detail::BasicSound::GetInitialVolume ( ) const

◆ GetMainOutVolume()

f32 nw4hbm::snd::detail::BasicSound::GetMainOutVolume ( ) const

◆ GetMoveVolume()

f32 nw4hbm::snd::detail::BasicSound::GetMoveVolume ( )
inline

◆ GetOutputLine()

int nw4hbm::snd::detail::BasicSound::GetOutputLine ( ) const

◆ GetPan()

f32 nw4hbm::snd::detail::BasicSound::GetPan ( ) const

◆ GetPitch()

f32 nw4hbm::snd::detail::BasicSound::GetPitch ( ) const

◆ GetPlayerHeap()

PlayerHeap * nw4hbm::snd::detail::BasicSound::GetPlayerHeap ( )
inline

◆ GetRemoteOutVolume()

f32 nw4hbm::snd::detail::BasicSound::GetRemoteOutVolume ( int remote) const

◆ GetSoundPlayer()

SoundPlayer * nw4hbm::snd::detail::BasicSound::GetSoundPlayer ( )
inline

◆ GetSurroundPan()

f32 nw4hbm::snd::detail::BasicSound::GetSurroundPan ( ) const

◆ GetVolume()

f32 nw4hbm::snd::detail::BasicSound::GetVolume ( ) const

◆ InitParam()

virtual void nw4hbm::snd::detail::BasicSound::InitParam ( )
virtual

Reimplemented in nw4hbm::snd::detail::SeqSound.

◆ IsAttachedGeneralHandle()

bool nw4hbm::snd::detail::BasicSound::IsAttachedGeneralHandle ( )

◆ IsAttachedTempGeneralHandle()

bool nw4hbm::snd::detail::BasicSound::IsAttachedTempGeneralHandle ( )

◆ IsAttachedTempSpecialHandle()

virtual bool nw4hbm::snd::detail::BasicSound::IsAttachedTempSpecialHandle ( )
pure virtual

Implemented in nw4hbm::snd::detail::SeqSound, nw4hbm::snd::detail::StrmSound, and nw4hbm::snd::detail::WaveSound.

◆ IsEnabledOutputLine()

bool nw4hbm::snd::detail::BasicSound::IsEnabledOutputLine ( ) const

◆ IsPause()

virtual bool nw4hbm::snd::detail::BasicSound::IsPause ( ) const
virtual

◆ IsPrepared()

virtual bool nw4hbm::snd::detail::BasicSound::IsPrepared ( ) const
virtual

◆ Pause()

virtual void nw4hbm::snd::detail::BasicSound::Pause ( bool flag,
int frames )
virtual

◆ SetAmbientParamCallback()

void nw4hbm::snd::detail::BasicSound::SetAmbientParamCallback ( AmbientParamUpdateCallback * paramUpdateCallback,
AmbientArgUpdateCallback * argUpdateCallback,
AmbientArgAllocaterCallback * argAllocaterCallback,
void * callbackArg )

◆ SetAutoStopCounter()

virtual void nw4hbm::snd::detail::BasicSound::SetAutoStopCounter ( int count)
virtual

◆ SetExternalSoundPlayer()

void nw4hbm::snd::detail::BasicSound::SetExternalSoundPlayer ( ExternalSoundPlayer * extPlayer)
inline

◆ SetFxSend()

void nw4hbm::snd::detail::BasicSound::SetFxSend ( AuxBus bus,
f32 send )

◆ SetId()

void nw4hbm::snd::detail::BasicSound::SetId ( u32 id)

◆ SetInitialVolume()

virtual void nw4hbm::snd::detail::BasicSound::SetInitialVolume ( f32 volume)
virtual

◆ SetLpfFreq()

virtual void nw4hbm::snd::detail::BasicSound::SetLpfFreq ( f32 freq)
virtual

◆ SetMainOutVolume()

void nw4hbm::snd::detail::BasicSound::SetMainOutVolume ( f32 volume)

◆ SetOutputLine()

void nw4hbm::snd::detail::BasicSound::SetOutputLine ( int flag)

◆ SetPan()

virtual void nw4hbm::snd::detail::BasicSound::SetPan ( f32 pan)
virtual

◆ SetPitch()

virtual void nw4hbm::snd::detail::BasicSound::SetPitch ( f32 pitch)
virtual

◆ SetPlayerHeap()

void nw4hbm::snd::detail::BasicSound::SetPlayerHeap ( PlayerHeap * heap)
inline

◆ SetPlayerPriority()

virtual void nw4hbm::snd::detail::BasicSound::SetPlayerPriority ( int priority)
virtual

Reimplemented in nw4hbm::snd::detail::SeqSound, nw4hbm::snd::detail::StrmSound, and nw4hbm::snd::detail::WaveSound.

◆ SetPriority()

void nw4hbm::snd::detail::BasicSound::SetPriority ( int priority)
inline

◆ SetRemoteOutVolume()

void nw4hbm::snd::detail::BasicSound::SetRemoteOutVolume ( int remote,
f32 volume )

◆ SetSoundPlayer()

void nw4hbm::snd::detail::BasicSound::SetSoundPlayer ( SoundPlayer * player)
inline

◆ SetSurroundPan()

virtual void nw4hbm::snd::detail::BasicSound::SetSurroundPan ( f32 pan)
virtual

◆ SetVolume()

virtual void nw4hbm::snd::detail::BasicSound::SetVolume ( f32 volume,
int frames )
virtual

◆ Shutdown()

virtual void nw4hbm::snd::detail::BasicSound::Shutdown ( )
virtual

Reimplemented in nw4hbm::snd::detail::SeqSound, nw4hbm::snd::detail::StrmSound, and nw4hbm::snd::detail::WaveSound.

◆ StartPrepared()

virtual void nw4hbm::snd::detail::BasicSound::StartPrepared ( )
virtual

◆ Stop()

virtual void nw4hbm::snd::detail::BasicSound::Stop ( int frames = 0)
virtual

◆ Update()

virtual void nw4hbm::snd::detail::BasicSound::Update ( )
virtual

Friends And Related Symbol Documentation

◆ SoundHandle

friend class SoundHandle
friend

Member Data Documentation

◆ INVALID_ID

const u32 nw4hbm::snd::detail::BasicSound::INVALID_ID = 0xFFFFFFFF
static

◆ mAmbientArg

void* nw4hbm::snd::detail::BasicSound::mAmbientArg
private

◆ mAmbientArgAllocaterCallback

AmbientArgAllocaterCallback* nw4hbm::snd::detail::BasicSound::mAmbientArgAllocaterCallback
private

◆ mAmbientArgUpdateCallback

AmbientArgUpdateCallback* nw4hbm::snd::detail::BasicSound::mAmbientArgUpdateCallback
private

◆ mAmbientParam

SoundParam nw4hbm::snd::detail::BasicSound::mAmbientParam
private

◆ mAmbientParamUpdateCallback

AmbientParamUpdateCallback* nw4hbm::snd::detail::BasicSound::mAmbientParamUpdateCallback
private

◆ mAutoStopCounter

int nw4hbm::snd::detail::BasicSound::mAutoStopCounter
private

◆ mAutoStopFlag

bool nw4hbm::snd::detail::BasicSound::mAutoStopFlag
private

◆ mExtMoveVolume

MoveValue<f32, int> nw4hbm::snd::detail::BasicSound::mExtMoveVolume
private

◆ mExtPan

f32 nw4hbm::snd::detail::BasicSound::mExtPan
private

◆ mExtPitch

f32 nw4hbm::snd::detail::BasicSound::mExtPitch
private

◆ mExtSoundPlayer

ExternalSoundPlayer* nw4hbm::snd::detail::BasicSound::mExtSoundPlayer
private

◆ mExtSoundPlayerPlayLink

ut::LinkListNode nw4hbm::snd::detail::BasicSound::mExtSoundPlayerPlayLink

◆ mExtSurroundPan

f32 nw4hbm::snd::detail::BasicSound::mExtSurroundPan
private

◆ mFadeOutFlag

bool nw4hbm::snd::detail::BasicSound::mFadeOutFlag
private

◆ mFadeVolume

MoveValue<f32, int> nw4hbm::snd::detail::BasicSound::mFadeVolume
private

◆ mGeneralHandle

SoundHandle* nw4hbm::snd::detail::BasicSound::mGeneralHandle
private

◆ mHeap

PlayerHeap* nw4hbm::snd::detail::BasicSound::mHeap
private

◆ mId

u32 nw4hbm::snd::detail::BasicSound::mId
private

◆ mInitVolume

f32 nw4hbm::snd::detail::BasicSound::mInitVolume
private

◆ mMainOutVolume

f32 nw4hbm::snd::detail::BasicSound::mMainOutVolume
private

◆ mOutputLineFlag

int nw4hbm::snd::detail::BasicSound::mOutputLineFlag
private

◆ mOutputLineFlagEnable

bool nw4hbm::snd::detail::BasicSound::mOutputLineFlagEnable
private

◆ mPauseFadeFlag

bool nw4hbm::snd::detail::BasicSound::mPauseFadeFlag
private

◆ mPauseFadeVolume

MoveValue<f32, int> nw4hbm::snd::detail::BasicSound::mPauseFadeVolume
private

◆ mPauseFlag

bool nw4hbm::snd::detail::BasicSound::mPauseFlag
private

◆ mPriority

u8 nw4hbm::snd::detail::BasicSound::mPriority
private

◆ mPriorityLink

ut::LinkListNode nw4hbm::snd::detail::BasicSound::mPriorityLink

◆ mRemoteOutVolume

f32 nw4hbm::snd::detail::BasicSound::mRemoteOutVolume[WPAD_MAX_CONTROLLERS]
private

◆ mSoundPlayer

SoundPlayer* nw4hbm::snd::detail::BasicSound::mSoundPlayer
private

◆ mSoundPlayerPlayLink

ut::LinkListNode nw4hbm::snd::detail::BasicSound::mSoundPlayerPlayLink

◆ mSoundPlayerPriorityLink

ut::LinkListNode nw4hbm::snd::detail::BasicSound::mSoundPlayerPriorityLink

◆ mStartedFlag

bool nw4hbm::snd::detail::BasicSound::mStartedFlag
private

◆ mStartFlag

bool nw4hbm::snd::detail::BasicSound::mStartFlag
private

◆ mTempGeneralHandle

SoundHandle* nw4hbm::snd::detail::BasicSound::mTempGeneralHandle
private

◆ mUpdateCounter

u32 nw4hbm::snd::detail::BasicSound::mUpdateCounter
private

◆ NW4HBM_UT_RUNTIME_TYPEINFO

nw4hbm::snd::detail::BasicSound::NW4HBM_UT_RUNTIME_TYPEINFO

◆ PRIORITY_MAX

const int nw4hbm::snd::detail::BasicSound::PRIORITY_MAX = 127
static
The documentation for this class was generated from the following file: