1 /*---------------------------------------------------------------------------*
2   Project:  NintendoWare
3   File:     snd_SoundArchiveFileReader.h
4 
5   Copyright (C)2009-2011 Nintendo/HAL Laboratory, Inc.  All rights reserved.
6 
7   These coded instructions, statements, and computer programs contain proprietary
8   information of Nintendo and/or its licensed developers and are protected by
9   national and international copyright laws. They may not be disclosed to third
10   parties or copied or duplicated in any form, in whole or in part, without the
11   prior written consent of Nintendo.
12 
13   The content herein is highly confidential and should be handled accordingly.
14 
15   $Revision: 31311 $
16  *---------------------------------------------------------------------------*/
17 
18 #ifndef NW_SND_SOUND_ARCHIVE_FILE_READER_H_
19 #define NW_SND_SOUND_ARCHIVE_FILE_READER_H_
20 
21 #include <nw/snd/snd_SoundArchiveFile.h>
22 #include <nw/snd/snd_SoundArchive.h>
23 
24 namespace nw {
25 namespace snd {
26 namespace internal {
27 
28 class SoundArchiveFileReader
29 {
30 public:
31     static const u32 SIGNATURE_FILE = NW_UT_MAKE_SIGWORD( 'C', 'S', 'A', 'R' );
32 
33     SoundArchiveFileReader();
~SoundArchiveFileReader()34     ~SoundArchiveFileReader() {}
35 
36     // ------------------------------------------------------------------------
37     //  初期化
38     void Initialize( const void* soundArchiveData );
39     void Finalize();
40 
41     // ブロック情報設定
42     void SetStringBlock( const void* stringBlock );
43     void SetInfoBlock( const void* infoBlock );
44 
45     // ブロック情報取得 (Initialize 後に有効)
GetStringBlockSize()46     inline u32 GetStringBlockSize() const   { return m_Header.GetStringBlockSize(); }
GetStringBlockOffset()47     inline s32 GetStringBlockOffset() const { return m_Header.GetStringBlockOffset(); }
GetInfoBlockSize()48     inline u32 GetInfoBlockSize() const     { return m_Header.GetInfoBlockSize(); }
GetInfoBlockOffset()49     inline s32 GetInfoBlockOffset() const   { return m_Header.GetInfoBlockOffset(); }
GetFileBlockSize()50     inline u32 GetFileBlockSize() const     { return m_Header.GetFileBlockSize(); }
GetFileBlockOffset()51     inline s32 GetFileBlockOffset() const   { return m_Header.GetFileBlockOffset(); }
52 
53     // ------------------------------------------------------------------------
54     //  文字列ブロックへのアクセス
55 
56     u32 GetStringCount() const;
57     SoundArchive::ItemId GetItemId( const char* pStr ) const;
58     const char* GetItemLabel( SoundArchive::ItemId id ) const;
59     SoundArchive::FileId GetItemFileId( SoundArchive::ItemId id ) const;
60 
61     // デバッグ
62     void DumpTree() const;
63     const char* GetString( SoundArchive::ItemId stringId ) const;    // 本当は private
64 
65 
66     // ------------------------------------------------------------------------
67     //  情報ブロックへのアクセス
68 
69     // 個数取得
70     u32 GetSoundCount() const;
71     u32 GetBankCount() const;
72     u32 GetPlayerCount() const;
73     u32 GetSoundGroupCount() const;
74     u32 GetGroupCount() const;
75     u32 GetWaveArchiveCount() const;
76     u32 GetFileCount() const;
77 
78     // 情報取得
79     bool ReadSoundInfo(
80             SoundArchive::ItemId soundId,
81             SoundArchive::SoundInfo* info ) const;
82     bool ReadBankInfo(
83             SoundArchive::ItemId bankId,
84             SoundArchive::BankInfo* info ) const;
85     bool ReadPlayerInfo(
86             SoundArchive::ItemId playerId,
87             SoundArchive::PlayerInfo* info ) const;
88     bool ReadSoundGroupInfo(
89             SoundArchive::ItemId soundGroupId,
90             SoundArchive::SoundGroupInfo* info ) const;
91     bool ReadGroupInfo(
92             SoundArchive::ItemId groupId,
93             SoundArchive::GroupInfo* info ) const;
94     bool ReadWaveArchiveInfo(
95             SoundArchive::ItemId warcId,
96             SoundArchive::WaveArchiveInfo* info ) const;
97     bool ReadFileInfo(
98             SoundArchive::FileId id,
99             SoundArchive::FileInfo* info, int index=0 ) const;
100     bool ReadSoundArchivePlayerInfo(
101             SoundArchive::SoundArchivePlayerInfo* info ) const;
102 
103     // 以下は、SoundInfo から直接アクセスする
104     SoundArchive::SoundType GetSoundType( SoundArchive::ItemId soundId ) const;
105     u32 GetSoundUserParam( SoundArchive::ItemId soundId ) const;
106     bool ReadSound3DInfo(
107             SoundArchive::ItemId soundId,
108             SoundArchive::Sound3DInfo* info ) const;
109     bool ReadSequenceSoundInfo(
110             SoundArchive::ItemId soundId,
111             SoundArchive::SequenceSoundInfo* info ) const;
112     bool ReadStreamSoundInfo(
113             SoundArchive::ItemId soundId,
114             SoundArchive::StreamSoundInfo* info ) const;
115     bool ReadWaveSoundInfo(
116             SoundArchive::ItemId soundId,
117             SoundArchive::WaveSoundInfo* info ) const;
118 
119     const internal::Util::Table<u32>* GetWaveArchiveIdTable(
120             SoundArchive::ItemId id ) const;
121 
122     // TODO: 以下は、ファイルブロック周りで、対応がまだ
123     // bool ReadFilePos( SoundArchive::FileId fileId, unsigned long index, SoundArchive::FilePos* info ) const;
124     // bool ReadGroupItemInfo( SoundArchive::GroupId groupId, unsigned long index, SoundArchive::GroupItemInfo* info ) const;
125     // const char* GetExtFilePath( u32 offset ) const;
126 
127 private:
128     SoundArchiveFile::FileHeader m_Header;
129     const SoundArchiveFile::StringBlockBody* m_pStringBlockBody;
130     const SoundArchiveFile::InfoBlockBody* m_pInfoBlockBody;
131     const SoundArchiveFile::FileBlockBody* m_pFileBlockBody;
132 };
133 
134 } // namespace nw::snd::internal
135 } // namespace nw::snd
136 } // namespace nw
137 
138 #endif /* NW_SND_SOUND_ARCHIVE_FILE_READER_H_ */
139 
140