/*---------------------------------------------------------------------------*
  Project:  NintendoWare
  File:     snd_WaveSoundFileReader.h
  
  Copyright (C)2009-2011 Nintendo/HAL Laboratory, Inc.  All rights reserved.
  
  These coded instructions, statements, and computer programs contain proprietary
  information of Nintendo and/or its licensed developers and are protected by
  national and international copyright laws. 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.
  
  The content herein is highly confidential and should be handled accordingly.
  
  $Revision: 31311 $
 *---------------------------------------------------------------------------*/

#ifndef NW_SND_WAVE_SOUND_FILE_READER_H_
#define NW_SND_WAVE_SOUND_FILE_READER_H_

#include <nw/snd/snd_WaveSoundFile.h>
#include <nw/snd/snd_Global.h>      // AUX_BUS_NUM

namespace nw {
namespace snd {
namespace internal {

struct WaveSoundInfo;
struct WaveSoundNoteInfo;

class WaveSoundFileReader
{
public:
    static const u32 SIGNATURE_FILE = NW_UT_MAKE_SIGWORD( 'C', 'W', 'S', 'D' );

    WaveSoundFileReader( const void* waveSoundFile );
    bool IsAvailable() const { return m_pHeader != NULL; }

    u32 GetWaveSoundCount() const;
    u32 GetNoteInfoCount( u32 index ) const;
    u32 GetTrackInfoCount( u32 index ) const;

    bool ReadWaveSoundInfo( WaveSoundInfo* dst, u32 index ) const;
    bool ReadNoteInfo( WaveSoundNoteInfo* dst, u32 index, u32 noteIndex ) const;

private:
    const WaveSoundFile::FileHeader*    m_pHeader;
    const WaveSoundFile::InfoBlockBody* m_pInfoBlockBody;
};

struct WaveSoundInfo
{
    f32 pitch;
    AdshrCurve adshr;
    u8 pan;
    u8 surroundPan;
    u8 mainSend;
    u8 fxSend[ AUX_BUS_NUM ];
};

struct WaveSoundNoteInfo
{
    u32 waveArchiveId;
    s32 waveIndex;
    AdshrCurve adshr;
    u8 originalKey;
    u8 pan;
    u8 surroundPan;
    u8 volume;
    f32 pitch;
    // TODO: SendValue を入れる？ (バイナリには入れれる)
};

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

#endif /* NW_SND_WAVE_SOUND_FILE_READER_H_ */