/*---------------------------------------------------------------------------* Project: NintendoWare File: snd_HioSoundArchive.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: $ *---------------------------------------------------------------------------*/ /** * :include nw/snd/snd_HioSoundArchive.h * * @file snd_HioSoundArchive.h */ #ifndef NW_SND_HIO_SOUND_ARCHIVE_H_ #define NW_SND_HIO_SOUND_ARCHIVE_H_ #include #include #include #include namespace nw { namespace snd { //--------------------------------------------------------------------------- //! @brief ホスト PC 上にあるサウンドアーカイブを扱うクラスです。 //! //! Host IO を使ってホスト PC 上にあるサウンドアーカイブファイルを利用することができます。 //! 使い方は RomSoundArchive と同じです。 //! //! デバッグ用途にお使いください。 //! 製品ではホスト PC との通信はできませんので、 //! 本クラスを製品版で使うことはおやめください。 //! //! また、通常 Release 版では Host IO を利用することはできません。 //! そのため、nw/snd.h に本クラスのヘッダーファイルはインクルードされておりません。 //! 本クラスを利用する場合は、独自に nw/snd/snd_HioSoundArchive.h //! をインクルードしてください。 //! //! HioSoundPlayer は、このクラスを使って実装されています。 //! //! @see SoundArchive クラス //! @see RomSoundArchive クラス //! //! @date 2010/11/12 初版 //--------------------------------------------------------------------------- class HioSoundArchive : public SoundArchive { public: class HioFileStream; public: //---------------------------------------- //! @name コンストラクタ / デストラクタ //@{ //--------------------------------------------------------------------------- //! @brief コンストラクタです。 //! //! @date 2010/11/12 初版 //--------------------------------------------------------------------------- HioSoundArchive(); //--------------------------------------------------------------------------- //! @brief デストラクタです。 //! //! @date 2010/11/12 初版 //--------------------------------------------------------------------------- virtual ~HioSoundArchive(); //@} //---------------------------------------- //! @name オープン / クローズ //@{ //--------------------------------------------------------------------------- //! @brief ホスト PC 上のサウンドアーカイブファイルを開きます。 //! //! 開いたサウンドアーカイブを使用するためには、@ref LoadHeader //! を呼び出してサウンドアーカイブのヘッダを読み込まなければなりません。 //! //! @param[in] filePath ファイルの ROM ファイルシステム上のパス。 //! //! @return ファイルを開くのに成功したら true を、 //! 失敗したら false を返します。 //! //! @see Close //! @see LoadHeader //! //! @date 2010/11/12 初版 //--------------------------------------------------------------------------- bool Open( const char* filePath ); //--------------------------------------------------------------------------- //! @brief ホスト PC 上のサウンドアーカイブファイルを閉じます。 //! //! @see Open //! //! @date 2010/11/12 初版 //--------------------------------------------------------------------------- void Close(); //@} //---------------------------------------- //! @name ヘッダ //@{ //--------------------------------------------------------------------------- //! @brief サウンドアーカイブのヘッダのサイズを取得します。 //! //! @return ヘッダのサイズを返します。 //! //! @see LoadHeader //! //! @date 2010/11/12 初版 //--------------------------------------------------------------------------- size_t GetHeaderSize() const { return m_ArchiveReader.GetInfoBlockSize(); } //--------------------------------------------------------------------------- //! @brief サウンドアーカイブのヘッダをロードします。 //! //! サウンドアーカイブからの情報の取得やサウンドデータのロードを行う前に、 //! この関数を呼びだしてヘッダをロードしておく必要があります。 //! //! ヘッダのロードに必要なメモリのサイズは、 //! @ref GetHeaderSize で取得することができます。 //! //! @param[out] buffer ヘッダをロードするバッファへのポインタ。 //! @param[in] size バッファのサイズ。 //! //! @return ヘッダのロードに成功したら true を、失敗したら false を返します。 //! //! @see Open //! //! @date 2010/11/12 初版 //--------------------------------------------------------------------------- bool LoadHeader( void* buffer, size_t size ); //@} //---------------------------------------- //! @name ラベル文字列データ //@{ //--------------------------------------------------------------------------- //! @brief サウンドアーカイブ中のラベル文字列データのサイズを取得します。 //! //! @return ラベル文字列データのサイズを返します。 //! //! @see LoadLabelStringData //! //! @date 2010/11/12 初版 //--------------------------------------------------------------------------- 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/11/12 初版 //--------------------------------------------------------------------------- bool LoadLabelStringData( void* buffer, size_t size ); //@} //! @details :private virtual size_t detail_GetRequiredStreamBufferSize() const; //! @details :private virtual const void* detail_GetFileAddress( FileId ) const { 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* extFilePathFilePath, u32 begin, u32 length ) const; private: bool LoadFileHeader(); internal::SoundArchiveFileReader m_ArchiveReader; nn::hio::HostFile m_HostFile; // PcSDK 版は未実装 bool m_IsOpened; char m_RootDirectory[ FILE_PATH_MAX ]; }; //! @details :private class HioSoundArchive::HioFileStream : public io::HioFileStream { public: HioFileStream( const char* path, u32 uffset, u32 size ); HioFileStream( nn::hio::HostFile* openedFile, u32 offset, u32 size ); virtual s32 Read( void* buf, u32 length ); virtual void Seek( s32 offset, u32 origin ); virtual u32 Tell() const { return io::HioFileStream::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_HIO_SOUND_ARCHIVE_H_ */