wwisesoundbank.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef SOUND_WWISESOUNDBANK_H
#define SOUND_WWISESOUNDBANK_H

#include <vector>
#include <map>

#include "src/common/ustring.h"
#include "src/common/scopedptr.h"
#include "src/common/readstream.h"

namespace Sound {

class RewindableAudioStream;

class WwiseSoundBank {
public:
    WwiseSoundBank(Common::SeekableReadStream *bnk);
    WwiseSoundBank(const Common::UString &name);
    WwiseSoundBank(uint64 hash);
    ~WwiseSoundBank() { }

    size_t getFileCount() const;
    size_t getSoundCount() const;

    uint32 getFileID(size_t index) const;
    uint32 getSoundID(size_t index) const;

    uint32 getSoundFileID(size_t index) const;

    size_t findFileByID(uint32 id) const;
    size_t findSoundByID(uint32 id) const;

    RewindableAudioStream *getFile(size_t index) const;
    RewindableAudioStream *getSound(size_t index) const;

private:
    struct File {
        uint32 id;

        size_t offset; 
        size_t size;   
    };

    enum SoundType {
        kSoundTypeSFX,
        kSoundTypeVoice,
        kSoundTypeMusic
    };

    struct Sound {
        uint32 id;

        SoundType type;

        bool isEmbedded;
        bool zeroLatency;

        uint32 fileID;
        uint32 fileSource;

        size_t fileOffset;
        size_t fileSize;
    };

    Common::ScopedPtr<Common::SeekableReadStream> _bnk;

    uint32 _bankID;
    size_t _dataOffset;

    std::vector<File> _files;
    std::vector<Sound> _sounds;

    std::map<uint32, Common::UString> _banks;

    std::map<uint32, size_t> _fileIDs;
    std::map<uint32, size_t> _soundIDs;


    void load(Common::SeekableReadStream &bnk);

    const File &getFileStruct(size_t index) const;
    const Sound &getSoundStruct(size_t index) const;

    bool isEmptyFile(size_t index) const;
    bool isEmptySound(size_t index) const;

    Common::SeekableReadStream *getFileData(size_t index) const;
    Common::SeekableReadStream *getSoundData(size_t index) const;
};

} // End of namespace Sound

#endif // SOUND_WWISESOUNDBANK_H