ssffile.cpp

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/>.
 */

/* See BioWare's own specs released for Neverwinter Nights modding
 * (<https://github.com/xoreos/xoreos-docs/tree/master/specs/bioware>)
 */

#include "src/common/scopedptr.h"
#include "src/common/readstream.h"
#include "src/common/writestream.h"
#include "src/common/writefile.h"
#include "src/common/util.h"
#include "src/common/strutil.h"
#include "src/common/error.h"
#include "src/common/encoding.h"

#include "src/aurora/resman.h"
#include "src/aurora/ssffile.h"

static const uint32 kSSFID     = MKTAG('S', 'S', 'F', ' ');
static const uint32 kVersion10 = MKTAG('V', '1', '.', '0');
static const uint32 kVersion11 = MKTAG('V', '1', '.', '1');

namespace Aurora {

SSFFile::Sound::Sound(const Common::UString &f, uint32 s) : soundFile(f), strRef(s) {
}


SSFFile::SSFFile() {
}

SSFFile::SSFFile(Common::SeekableReadStream &ssf) {
    load(ssf);
}

SSFFile::SSFFile(const Common::UString &ssf) {
    Common::ScopedPtr<Common::SeekableReadStream> res(ResMan.getResource(ssf, kFileTypeSSF));
    if (!res)
        throw Common::Exception("No such SSF \"%s\"", ssf.c_str());

    load(*res);
}

SSFFile::~SSFFile() {
}

void SSFFile::load(Common::SeekableReadStream &ssf) {
    try {
        size_t entryCount, offEntryTable;
        Version version = readSSFHeader(ssf, entryCount, offEntryTable);

        _sounds.resize(entryCount);

        readEntries(ssf, version, offEntryTable);

    } catch (Common::Exception &e) {
        e.add("Failed reading SSF file");
        throw;
    }
}

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

    if (_id != kSSFID)
        throw Common::Exception("Not a SSF file (%s)", Common::debugTag(_id).c_str());

    if ((_version != kVersion10) && (_version != kVersion11))
        throw Common::Exception("Unsupported SSF file version %s", Common::debugTag(_version).c_str());

    entryCount    = ssf.readUint32LE();
    offEntryTable = ssf.readUint32LE();

    if (entryCount >= UINT32_MAX)
        throw Common::Exception("Invalid SSF header");

    // Plain old version V1.0 used in NWN (and NWN2)
    if (_version == kVersion10)
        return kVersion10_NWN;

    // NWN2's V1.1
    if ((offEntryTable < ssf.size()) && ((ssf.size() - offEntryTable) >= ((4 + 32 + 4) * entryCount)))
        return kVersion11_NWN2;

    offEntryTable = entryCount;
    entryCount    = (ssf.size() - offEntryTable) / 4;

    // Sanity check
    if ((offEntryTable > ssf.size()) || (((ssf.size() - offEntryTable) % 4) != 0))
        throw Common::Exception("Invalid SSF header (%u, %u)", (uint32) ssf.size(), (uint32) offEntryTable);

    // KotOR's V1.1
    return kVersion11_KotOR;
}

void SSFFile::readEntries(Common::SeekableReadStream &ssf, Version version, size_t offset) {
    ssf.seek(offset);

    switch (version) {
        case kVersion10_NWN:
            readEntriesNWN(ssf, 16);
            break;

        case kVersion11_NWN2:
            readEntriesNWN(ssf, 32);
            break;

        case kVersion11_KotOR:
            readEntriesKotOR(ssf);
            break;

        default:
            break;
    }
}

void SSFFile::readEntriesNWN(Common::SeekableReadStream &ssf, size_t soundFileLen) {
    /* The NWN/NWN2 versions of an SSF file (V1.0 and V1.1) begin with a list of
       offsets to the data entries. Each of these contains a ResRef of a sound
       file and a StrRef of a text. */

    size_t count = _sounds.size();

    std::vector<uint32> offsets;

    offsets.resize(count);

    for (size_t i = 0; i < count; i++)
        offsets[i] = ssf.readUint32LE();

    for (size_t i = 0; i < count; i++) {
        ssf.seek(offsets[i]);

        _sounds[i].soundFile = Common::readStringFixed(ssf, Common::kEncodingASCII, soundFileLen);
        _sounds[i].strRef    = ssf.readUint32LE();
    }
}

void SSFFile::readEntriesKotOR(Common::SeekableReadStream &ssf) {
    /* The KotOR/KotOR2 version of an SSF file (V1.1) is just a list of StrRefs. */

    for (SoundSet::iterator sound = _sounds.begin(); sound != _sounds.end(); ++sound)
        sound->strRef = ssf.readUint32LE();
}

size_t SSFFile::getSoundCount() const {
    return _sounds.size();
}

const Common::UString &SSFFile::getSoundFile(size_t index) const {
    static const Common::UString kEmptyString = "";

    if (index >= _sounds.size())
        return kEmptyString;

    return _sounds[index].soundFile;
}

uint32 SSFFile::getStrRef(size_t index) const {
    if (index >= _sounds.size())
        return kStrRefInvalid;

    return _sounds[index].strRef;
}

void SSFFile::getSound(size_t index, Common::UString &soundFile, uint32 &strRef) const {
    if (index >= _sounds.size()) {
        soundFile.clear();
        strRef = kStrRefInvalid;

        return;
    }

    soundFile = _sounds[index].soundFile;
    strRef    = _sounds[index].strRef;
}

void SSFFile::setSoundFile(size_t index, const Common::UString &soundFile) {
    if (index >= UINT32_MAX)
        throw Common::Exception("Sound index out of range");

    if (_sounds.size() <= index)
        _sounds.resize(index + 1);

    _sounds[index].soundFile = soundFile;
}

void SSFFile::setStrRef(size_t index, uint32 strRef) {
    if (index >= UINT32_MAX)
        throw Common::Exception("Sound index out of range");

    if (_sounds.size() <= index)
        _sounds.resize(index + 1);

    _sounds[index].strRef = strRef;
}

void SSFFile::setSound(size_t index, const Common::UString &soundFile, uint32 strRef) {
    if (index >= UINT32_MAX)
        throw Common::Exception("Sound index out of range");

    if (_sounds.size() <= index)
        _sounds.resize(index + 1);

    _sounds[index].soundFile = soundFile;
    _sounds[index].strRef    = strRef;
}

size_t SSFFile::getMaxSoundFileLen() const {
    size_t maxSoundFileLen = 0;
    for (SoundSet::const_iterator s = _sounds.begin(); s != _sounds.end(); ++s)
        maxSoundFileLen = MAX(maxSoundFileLen, s->soundFile.size());

    return maxSoundFileLen;
}

bool SSFFile::existNonASCIISoundFile() const {
    for (SoundSet::const_iterator s = _sounds.begin(); s != _sounds.end(); ++s)
        for (Common::UString::iterator c = s->soundFile.begin(); c != s->soundFile.end(); ++c)
            if (!Common::UString::isASCII(*c))
                return true;

    return false;
}

void SSFFile::checkVersionFeatures(Version version) const {
    assert(_sounds.size() < UINT32_MAX);

    if (existNonASCIISoundFile())
        throw Common::Exception("SSF files do not support non-ASCII sound filenames");

    const size_t maxFileLen = getMaxSoundFileLen();

    switch (version) {
        case kVersion10_NWN:
            if (maxFileLen > 16)
                throw Common::Exception("Sound filenames in SSF V1.0 need to be 16 characters or less");
            break;

        case kVersion11_NWN2:
            if (maxFileLen > 32)
                throw Common::Exception("Sound filenames in SSF V1.1 (NWN2) need to be 32 characters or less");
            break;

        case kVersion11_KotOR:
            if (maxFileLen > 0)
                throw Common::Exception("SSF V1.1 (KotOR/KotOR2) does not support sound filenames");
            break;

        default:
            throw Common::Exception("Invalid SSF version");
    }
}

SSFFile::Version SSFFile::determineVersionForGame(GameID game) const {
    switch (game) {
        case kGameIDNWN:
            return kVersion10_NWN;

        case kGameIDNWN2:
            if (getMaxSoundFileLen() > 16)
                return kVersion11_NWN2;
            return kVersion10_NWN;

        case kGameIDKotOR:
        case kGameIDKotOR2:
            return kVersion11_KotOR;

        default:
            break;
    }

    throw Common::Exception("This game does not support SSF files");
}

void SSFFile::writeSSF(Common::WriteStream &out, Version version) const {
    checkVersionFeatures(version);

    switch (version) {
        case kVersion10_NWN:
            writeNWN(out);
            break;

        case kVersion11_NWN2:
            writeNWN2(out);
            break;

        case kVersion11_KotOR:
            writeKotOR(out);
            break;
    }
}

bool SSFFile::writeSSF(const Common::UString &fileName, Version version) const {
    Common::WriteFile file;
    if (!file.open(fileName))
        return false;

    writeSSF(file, version);
    file.close();

    return true;
}

void SSFFile::writeNWN(Common::WriteStream &out, size_t soundFileLen) const {
    static const size_t kOffsetEntryTable = 0x28;

    out.writeUint32LE(_sounds.size());
    out.writeUint32LE(kOffsetEntryTable);

    // Reserved
    for (size_t i = 16; i < kOffsetEntryTable; i++)
        out.writeByte(0);

    size_t offsetData = kOffsetEntryTable + _sounds.size() * 4;

    for (SoundSet::const_iterator s = _sounds.begin(); s != _sounds.end();
         ++s, offsetData += soundFileLen + 4) {

        if (offsetData >= UINT32_MAX)
            throw Common::Exception(Common::kSeekError);

        out.writeUint32LE(offsetData);
    }

    for (SoundSet::const_iterator s = _sounds.begin(); s != _sounds.end(); ++s) {
        Common::writeStringFixed(out, s->soundFile, Common::kEncodingASCII, soundFileLen);

        out.writeUint32LE(s->strRef);
    }
}

void SSFFile::writeNWN(Common::WriteStream &out) const {
    out.writeString("SSF V1.0");

    writeNWN(out, 16);
}

void SSFFile::writeNWN2(Common::WriteStream &out) const {
    out.writeString("SSF V1.1");

    writeNWN(out, 32);
}

void SSFFile::writeKotOR(Common::WriteStream &out) const {
    out.writeString("SSF V1.1");

    out.writeUint32LE(0x0C); // Offset to the entries

    for (SoundSet::const_iterator s = _sounds.begin(); s != _sounds.end(); ++s)
        out.writeUint32LE(s->strRef);
}

} // End of namespace Aurora