/*---------------------------------------------------------------------------* Project: NintendoWare File: snd_RomSoundArchive.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 $ *---------------------------------------------------------------------------*/ /** * :include nw/snd/snd_RomSoundArchive.h * * @file snd_RomSoundArchive.h */ #ifndef NW_SND_ROM_SOUND_ARCHIVE_H_ #define NW_SND_ROM_SOUND_ARCHIVE_H_ #include #include #include namespace nw { namespace snd { //--------------------------------------------------------------------------- //! @brief ROM 上にあるサウンドアーカイブを扱うクラスです。 //! //! @see SoundArchive クラス //! //! @date 2010/01/15 初版 //--------------------------------------------------------------------------- class RomSoundArchive : public SoundArchive { private: class RomFileStream; public: //---------------------------------------- //! @name コンストラクタ / デストラクタ //@{ //--------------------------------------------------------------------------- //! @brief コンストラクタです。 //! //! @date 2010/01/15 初版 //--------------------------------------------------------------------------- RomSoundArchive(); //--------------------------------------------------------------------------- //! @brief デストラクタです。 //! //! @date 2010/01/15 初版 //--------------------------------------------------------------------------- virtual ~RomSoundArchive(); //@} //---------------------------------------- //! @name オープン / クローズ //@{ //--------------------------------------------------------------------------- //! @brief ROM 上のサウンドアーカイブファイルを開きます。 //! //! 開いたサウンドアーカイブを使用するためには、@ref LoadHeader //! を呼び出してサウンドアーカイブのヘッダを読み込まなければなりません。 //! //! @param[in] filePath ファイルの ROM ファイルシステム上のパス。 //! //! @return ファイルを開くのに成功したら true を、 //! 失敗したら false を返します。 //! //! @see Close //! @see LoadHeader //! //! @date 2010/01/15 初版 //--------------------------------------------------------------------------- bool Open( const char* filePath ); // TODO: ドキュメント残り。どうするか決める必要がある。 // ファイルパスを指定して開く場合は、内部で @ref SoundArchive::SetExternalFileRoot // を呼び出し、サウンドアーカイブファイルがあるディレクトリを設定します。 // // 関数内部でDVDRead関数を呼び出しています。このためディスクが挿入されていないと、 // 正しいディスクが挿入されるまで、関数から返ってこなくなります。 // DVDに関するエラーメッセージを表示するためには、 // この関数を呼び出したスレッドとは別のスレッドで DVDGetDriveStatus関数を呼び出し、 // ディスクドライブの状態を監視しなければなりません。 // @see @ref SetExternalFileRoot //--------------------------------------------------------------------------- //! @brief ROM 上のサウンドアーカイブファイルを閉じます。 //! //! @see Open //! //! @date 2010/01/15 初版 //--------------------------------------------------------------------------- void Close(); //@} //---------------------------------------- //! @name ヘッダ //@{ //--------------------------------------------------------------------------- //! @brief サウンドアーカイブのヘッダのサイズを取得します。 //! //! @return ヘッダのサイズを返します。 //! //! @see LoadHeader //! //! @date 2010/01/15 初版 //--------------------------------------------------------------------------- size_t GetHeaderSize() const { return m_ArchiveReader.GetInfoBlockSize(); } //--------------------------------------------------------------------------- //! @brief サウンドアーカイブのヘッダをロードします。 //! //! サウンドアーカイブからの情報の取得やサウンドデータのロードを行う前に、 //! この関数を呼びだしてヘッダをロードしておく必要があります。 //! //! ヘッダのロードに必要なメモリのサイズは、 //! @ref GetHeaderSize で取得することができます。 //! //! @param[out] buffer ヘッダをロードするバッファへのポインタ。 //! @param[in] size バッファのサイズ。 //! //! @return ヘッダのロードに成功したら true を、失敗したら false を返します。 //! //! @see Open //! //! @date 2010/01/15 初版 //--------------------------------------------------------------------------- bool LoadHeader( void* buffer, unsigned long size ); // TODO: ドキュメント残り。 // 関数内部でDVDRead関数を呼び出しています。 // このためディスクが挿入されていないと、 正しいディスクが挿入されるまで、 // 関数から返ってこなくなります。 // DVDに関するエラーメッセージを表示するためには、 // この関数を呼び出したスレッドとは別のスレッドで DVDGetDriveStatus関数を呼び出し、 // ディスクドライブの状態を監視しなければなりません。 //@} //---------------------------------------- //! @name ラベル文字列データ //@{ //--------------------------------------------------------------------------- //! @brief サウンドアーカイブ中のラベル文字列データのサイズを取得します。 //! //! @return ラベル文字列データのサイズを返します。 //! //! @see LoadLabelStringData //! //! @date 2010/01/15 初版 //--------------------------------------------------------------------------- size_t GetLabelStringDataSize() const { return m_ArchiveReader.GetStringBlockSize(); } //--------------------------------------------------------------------------- //! @brief サウンドアーカイブ中のラベル文字列データをロードします。 //! //! サウンドアーカイブに含まれるリソースにラベル文字列でアクセスするためには、 //! ラベル文字列データをロードしておく必要があります。 //! //! ラベル文字列データのロードに必要なメモリのサイズは、 //! @ref GetLabelStringDataSize で取得することができます。 //! //! サウンドアーカイブファイル (.bcsar) に文字列テーブルが含まれていないと、 //! 失敗します。その場合は、SoundMaker の [プロジェクト設定] //! - [サウンドアーカイブ] タブ - [文字列テーブルを出力する] //! にチェックがついているかどうかご確認ください。 //! //! @param[out] buffer ラベル文字列をロードするバッファへのポインタ。 //! @param[in] size バッファのサイズ。 //! //! @return ラベル文字列のロードに成功したら true を、失敗したら false を返します。 //! //! @see Open //! //! @date 2010/06/25 サウンドアーカイブの文字列テーブルに関する記述を追加 //! @date 2010/01/15 初版 //--------------------------------------------------------------------------- bool LoadLabelStringData( void* buffer, unsigned long size ); // TODO: // 関数内部でDVDRead関数を呼び出しています。このためディスクが挿入されていないと、 // 正しいディスクが挿入されるまで、関数から返ってこなくなります。 // DVDに関するエラーメッセージを表示するためには、 // この関数を呼び出したスレッドとは別のスレッドで DVDGetDriveStatus関数を呼び出し、 // ディスクドライブの状態を監視しなければなりません。 //@} //! @details :private virtual size_t detail_GetRequiredStreamBufferSize() const; //! @details :private virtual const void* detail_GetFileAddress( FileId fileId ) const { NW_UNUSED_VARIABLE( fileId ); return NULL; // NOTE: MemorySoundArchive なら非 NULL 値を返しうる } protected: //! @details :private virtual io::FileStream* OpenStream( void* buffer, int size, u32 begin, u32 length ); //! @details :private virtual io::FileStream* OpenExtStream( void* buffer, int size, const char* extFilePath, // const wchar_t* extFilePath, u32 begin, u32 length ) const; private: bool LoadFileHeader(); internal::SoundArchiveFileReader m_ArchiveReader; #ifdef NW_PLATFORM_CTRWIN nn::fs::File m_FileInfo; #else nn::fs::FileReader m_FileReader; #endif bool m_IsOpened; }; //! @details :private class RomSoundArchive::RomFileStream : public io::RomFileStream { public: RomFileStream( const char* path, u32 offset, u32 size ); // RomFileStream( const wchar_t* path, u32 offset, u32 size ); #ifdef NW_PLATFORM_CTRWIN RomFileStream( const nn::fs::File* fileInfo, u32 offset, u32 size ); #else RomFileStream( nn::fs::FileReader* fileReader, u32 offset, u32 size ); #endif virtual s32 Read( void* buf, u32 length ); virtual void Seek( s32 offset, u32 origin ); virtual u32 Tell() const { return io::RomFileStream::Tell() - m_Offset; } virtual u32 GetSize() const { return m_Size; } private: s32 m_Offset; u32 m_Size; }; } // namespace nw::snd } // namespace nw #endif /* NW_SND_ROM_SOUND_ARCHIVE_H_ */