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