/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     snd_HardwareChannelManager.h

  Copyright (C)2009-2010 Nintendo Co., Ltd./HAL Laboratory, Inc.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Revision: 19566 $
 *---------------------------------------------------------------------------*/

#ifndef NW_SND_HARDWARE_CHANNEL_MANAGER_H_
#define NW_SND_HARDWARE_CHANNEL_MANAGER_H_

#include <nw/ut/ut_LinkList.h>  // for ut::LinkList
#include <nw/snd/snd_HardwareChannel.h>

namespace nw {
namespace snd {
namespace internal {
namespace driver {

class HardwareChannelManager
{
public:
    static const int CHANNEL_COUNT_MARGIN = 4;  // RVL は計96ch中、マージン16だった
    typedef
        ut::LinkList< HardwareChannel, offsetof(HardwareChannel, m_LinkNode) >
        HardwareChannelList;

    static HardwareChannelManager& GetInstance();
    static bool IsChannelPlay( u8 ch_no );

    unsigned long GetRequiredMemSize( int hardwareChannelCount );
    void Initialize( void* mem, unsigned long memSize );
    void Finalize();

    HardwareChannel* AllocHardwareChannel(  // NW4R AcquireAxVoice 相当
        u32 priority,
        HardwareChannel::HardwareChannelCallback callback,
        void* callbackData
    );
    void FreeHardwareChannel( HardwareChannel* hardwareChannel );
    void ReserveForFreeHardwareChannel( HardwareChannel* hardwareChannel );

    void FreeAllReservedHardwareChannel();

    int GetHardwareChannelCount() const { return m_HardwareChannelCount; }
    unsigned long GetActiveVoiceCount() const { return m_ActiveList.GetSize(); }
    unsigned long GetFreeVoiceCount() const { return m_FreeList.GetSize(); }
    unsigned long GetFreeReservedVoiceCount() const { return m_FreeReservedList.GetSize(); }

private:
    HardwareChannelManager();
    void OnInitialize();

    HardwareChannel* Alloc();
    void Free( HardwareChannel* hardwareChannel );
    void ReserveForFree( HardwareChannel* hardwareChannel );

    HardwareChannelList m_ActiveList;   // プライオリティの低い順
    HardwareChannelList m_FreeList;
    HardwareChannelList m_FreeReservedList;

    int  m_HardwareChannelCount;
    bool m_IsInitialized;
};

} // namespace nw::snd::internal::driver
} // namespace nw::snd::internal
} // namespace nw::snd
} // namespace nw

#endif /* NW_SND_HARDWARE_CHANNEL_MANAGER_H_ */