talktable_tlk.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_TALKTABLE_TLK_H
#define AURORA_TALKTABLE_TLK_H

#include <vector>

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

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

namespace Aurora {

class TalkTable_TLK : public AuroraFile, public TalkTable {
public:
    TalkTable_TLK(Common::SeekableReadStream *tlk, Common::Encoding encoding);
    ~TalkTable_TLK();

    uint32 getLanguageID() const;

    bool hasEntry(uint32 strRef) const;

    const Common::UString &getString     (uint32 strRef) const;
    const Common::UString &getSoundResRef(uint32 strRef) const;

    uint32 getSoundID(uint32 strRef) const;

    static uint32 getLanguageID(Common::SeekableReadStream &tlk);
    static uint32 getLanguageID(const Common::UString &file);


private:
    enum EntryFlags {
        kFlagTextPresent        = (1 << 0),
        kFlagSoundPresent       = (1 << 1),
        kFlagSoundLengthPresent = (1 << 2)
    };

    struct Entry {
        Common::UString text;
        uint32 offset;
        uint32 length;

        // V3
        uint32 flags;
        Common::UString soundResRef;
        uint32 volumeVariance; // Unused
        uint32 pitchVariance; // Unused
        float soundLength; // In seconds

        // V4
        uint32 soundID;
    };

    typedef std::vector<Entry> Entries;


    Common::ScopedPtr<Common::SeekableReadStream> _tlk;

    uint32 _languageID;

    mutable Entries _entries;

    void load();

    void readEntryTableV3(uint32 stringsOffset);
    void readEntryTableV4();

    void readString(Entry &entry) const;
};

} // End of namespace Aurora

#endif // AURORA_TALKTABLE_TLK_H