fevfile.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_FEVFILE_H
#define AURORA_FEVFILE_H

#include <map>

#include <boost/variant.hpp>

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

namespace Aurora {

class FEVFile {
public:
    enum StreamingType {
        kDecompressIntoMemory,
        kLoadIntoMemory,
        kStreamFromDisk
    };

    enum PlayMode {
        kSequential = 0,
        kRandom,
        kRandomNoRepeat,
        kSequentialNoRepeat,
        kShuffle,
        kProgrammerSelected
    };

    enum PropertyType {
        kPropertyInt = 0,
        kPropertyFloat,
        kPropertyString
    };

    struct Property {
        PropertyType type;
        boost::variant<int32, float, Common::UString> value;
    };

    struct WaveBank {
        uint32 maxStreams;
        StreamingType streamingType;
        Common::UString name;
    };

    struct Category {
        Common::UString name;
        uint32 volume;
        uint32 pitch;
    };

    struct EventCategory {
        Common::UString name;
    };

    struct Event {
        Common::UString name;

        float volume;
        float pitch;
        float pitchRandomization;
        float volumeRandomization;
        uint32 priority;
        uint32 mode;
        uint32 maxPlaybacks;

        float Speaker2DL;
        float Speaker2DR;
        float Speaker2DC;

        float SpeakerLFE;

        float Speaker2DLR;
        float Speaker2DRR;
        float Speaker2DLS;
        float Speaker2DRS;

        float ReverbDryLevel;
        float ReverbWetLevel;

        uint32 fadeInTime;
        uint32 fadeOutTime;

        float spawnIntensity;
        float spawnIntensityRandomization;

        std::map<Common::UString, Property> userProperties;
        Common::UString category;
    };

    struct SoundDefinition {
        PlayMode playMode;

        Common::UString name;

        uint32 spawnTimeMin;
        uint32 spawnTimeMax;
        uint32 maximumSpawnedSounds;
        float volume;
        float volumeRandomization;
        float pitch;
        float pitchRandomization;
        float position3DRandomization;
    };

    FEVFile(const Common::UString &resRef);
    FEVFile(Common::SeekableReadStream &fev);

    const Common::UString &getBankName();

    const std::vector<WaveBank> &getWaveBanks();
    const std::vector<Category> &getCategories();

private:
    void load(Common::SeekableReadStream &fev);

    void readCategory(Common::SeekableReadStream &fev);
    void readEventCategory(Common::SeekableReadStream &fev);
    void readEvent(Common::SeekableReadStream &fev);

    std::map<Common::UString, Property> readProperties(Common::SeekableReadStream &fev);
    Common::UString readLengthPrefixedString(Common::SeekableReadStream &fev);

    Common::UString _bankName;

    std::vector<WaveBank> _waveBanks;
    std::vector<Category> _categories;
    std::vector<Event> _events;
    std::vector<SoundDefinition> _definitions;
};

} // End of namespace Aurora

#endif // AURORA_FEVFILE_H