/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     snd_PlayerHeapDataManager.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: $
 *---------------------------------------------------------------------------*/

#ifndef NW_SND_PLAYER_HEAP_DATA_MANAGER_H_
#define NW_SND_PLAYER_HEAP_DATA_MANAGER_H_

#include <nw/snd/snd_DisposeCallback.h>
#include <nw/snd/snd_SoundArchiveLoader.h>
#include <nw/snd/snd_SoundArchive.h>

namespace nw {
namespace snd {
namespace internal {

class PlayerHeapDataManager : public internal::driver::DisposeCallback,
                              public internal::SoundArchiveLoader
{
public:
    PlayerHeapDataManager();
    virtual ~PlayerHeapDataManager();

    void Initialize( const SoundArchive* arc );
    void Finalize();

    const void* SetFileAddress( SoundArchive::FileId fileId, const void* address );
    const void* GetFileAddress( SoundArchive::FileId ) const;

    static const int FILE_ADDRESS_COUNT = 1 + 4 + 4;

protected:
    virtual void InvalidateData( const void* start, const void* end );
    virtual const void* SetFileAddressToTable(
            SoundArchive::FileId, const void* address );
    virtual const void* GetFileAddressFromTable( SoundArchive::FileId fileId ) const;
    virtual const void* GetFileAddressImpl( SoundArchive::FileId fileId ) const;

private:
    struct FileAddress
    {
        SoundArchive::FileId fileId;
        const void* address;
    };

    FileAddress m_FileAddress[FILE_ADDRESS_COUNT];
        // NW4C-1.3.0 現在、ひとつのサウンドを鳴らすのに必要なファイルは、最大９個
        // (== bcseq + 4 * bcbnk + 4 * bcwar)。
    bool m_IsInitialized;
    bool m_IsFinalized;
};

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


#endif /* NW_SND_PLAYER_HEAP_DATA_MANAGER_H_ */