ssffile.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 AURORA_SSFFILE_H
#define AURORA_SSFFILE_H

#include <vector>

#include "src/common/types.h"
#include "src/common/ustring.h"

#include "src/aurora/types.h"
#include "src/aurora/aurorafile.h"

namespace Common {
    class SeekableReadStream;
    class WriteStream;
}

namespace Aurora {

class SSFFile : public AuroraFile {
public:
    enum Version {
        kVersion10_NWN,  
        kVersion11_NWN2, 
        kVersion11_KotOR 
    };

    SSFFile();
    SSFFile(Common::SeekableReadStream &ssf);
    SSFFile(const Common::UString &ssf);
    ~SSFFile();

    size_t getSoundCount() const;

    // .--- Reading sounds from the sound set
    const Common::UString &getSoundFile(size_t index) const;
    uint32 getStrRef(size_t index) const;
    void getSound(size_t index, Common::UString &soundFile, uint32 &strRef) const;
    // '---

    // .--- Writing sounds to the sound set
    void setSoundFile(size_t index, const Common::UString &soundFile);
    void setStrRef(size_t index, uint32 strRef);
    void setSound(size_t index, const Common::UString &soundFile, uint32 strRef);
    // '---

    // .--- Writing SSF files
    Version determineVersionForGame(GameID game) const;

    void writeSSF(Common::WriteStream &out, Version version) const;
    bool writeSSF(const Common::UString &fileName, Version version) const;
    // '---

private:
    struct Sound {
        Common::UString soundFile; 
        uint32          strRef;    

        Sound(const Common::UString &f = "", uint32 s = kStrRefInvalid);
    };

    typedef std::vector<Sound> SoundSet;

    SoundSet _sounds;

    void load(Common::SeekableReadStream &ssf);

    Version readSSFHeader(Common::SeekableReadStream &ssf, size_t &entryCount, size_t &offEntryTable);

    void readEntries(Common::SeekableReadStream &ssf, Version version, size_t offset);
    void readEntriesNWN(Common::SeekableReadStream &ssf, size_t soundFileLen);
    void readEntriesKotOR(Common::SeekableReadStream &ssf);

    size_t getMaxSoundFileLen() const;
    bool existNonASCIISoundFile() const;
    void checkVersionFeatures(Version version) const;

    void writeNWN(Common::WriteStream &out) const;
    void writeNWN2(Common::WriteStream &out) const;
    void writeKotOR(Common::WriteStream &out) const;

    void writeNWN(Common::WriteStream &out, size_t soundFileLen) const;
};

} // End of namespace Aurora

#endif // AURORA_SSFFILE_H