Sound.h

Go to the documentation of this file.

// Sound.h generated from model.xml using generate-code.xsl

#ifndef SOUND_H
#define SOUND_H

#include "UnderlyingTypes.h"

typedef enum
{
    e_classIdCSound,

} EClassIdCSound;

const int32 e_classIdCSoundCount = 1;

typedef enum
{
    e_soundBlendLinear,

    e_soundBlendInverse,

    e_soundBlendLogarithmic,

} ESoundBlend;

const int32 e_soundBlendCount = 3;

typedef enum
{
    e_soundFlagAutoUnload,

    e_soundFlagDownload,

    e_soundFlagIgnorable,

    e_soundFlagPurgable,

    e_soundFlagStream,

    e_soundFlagUnpausable,

    e_soundFlagWait,

    e_soundFlagHideSubtitle,

    e_soundFlagTemporary,

    e_soundFlagNeedsUpdate,

    e_soundFlagNeedsFXA,

    e_soundFlagNeedsTTS,

    e_soundFlagRerecord,

    e_soundFlagObsolete,

    e_soundFlagManualOverride,

} ESoundFlag;

const int32 e_soundFlagCount = 15;

typedef enum
{
    e_soundSelectSequential,

    e_soundSelectShuffle,

} ESoundSelect;

const int32 e_soundSelectCount = 2;

typedef enum
{
    e_soundCategoryTest,

    e_soundCategoryME,

    e_soundCategoryMovie,

    e_soundCategoryTV,

    e_soundCategoryDialogue,

    e_soundCategoryMission,

    e_soundCategoryMusic,

    e_soundCategoryOther,

    e_soundCategoryAmbient,

    e_soundCategorySAmbient,

    e_soundCategoryAlert,

    e_soundCategoryDeath,

    e_soundCategoryReady,

    e_soundCategorySpell,

    e_soundCategoryCombat,

    e_soundCategoryVoice,

    e_soundCategoryMessage,

    e_soundCategoryUI,

    e_soundCategoryUIMovie,

    e_soundCategoryFlames,

    e_soundCategoryBuild,

    e_soundCategoryGather,

    e_soundCategoryDoodad,

    e_soundCategorySEmitters,

    e_soundCategorySPieces,

    e_soundCategoryFoley,

    e_soundCategoryMovement,

} ESoundCategory;

const int32 e_soundCategoryCount = 27;

typedef enum
{
    e_soundDupePrevent,

    e_soundDupeReplace,

} ESoundDupe;

const int32 e_soundDupeCount = 2;

typedef enum
{
    e_soundFormatPCM8,

    e_soundFormatPCM16,

    e_soundFormatPCM24,

    e_soundFormatPCM32,

    e_soundFormatPCMFLOAT,

} ESoundFormat;

const int32 e_soundFormatCount = 5;

typedef enum
{
    e_soundMode2D,

    e_soundMode3DHead,

    e_soundMode3DWorld,

} ESoundMode;

const int32 e_soundModeCount = 3;

typedef enum
{
    e_soundResamplerNone,

    e_soundResamplerLinear,

    e_soundResamplerCubic,

    e_soundResamplerSpline,

} ESoundResampler;

const int32 e_soundResamplerCount = 4;

typedef enum
{
    e_speakerFrontLeft,

    e_speakerFrontRight,

    e_speakerCenter,

    e_speakerLFE,

    e_speakerBackLeft,

    e_speakerBackRight,

    e_speakerSideLeft,

    e_speakerSideRight,

} ESpeaker;

const int32 e_speakerCount = 8;

typedef enum
{
    e_speakerModeMono,

    e_speakerModeStereo,

    e_speakerModeQuad,

    e_speakerModeSurround,

    e_speakerMode5Point1,

    e_speakerMode7Point1,

    e_speakerModeProLogic,

} ESpeakerMode;

const int32 e_speakerModeCount = 7;

struct SPitchShift
{
    uint32 Time;

    CPitch Pitch;
};

struct SReverbBalance
{
    TSoundBalance Direct;

    TSoundBalance Room;
};

struct SReverbRolloff
{
    real32 Distance;

    real32 Direct;

    real32 Room;
};

struct SVolumeFade
{
    uint32 Time;

    CVolume Volume;
};

struct SVolumeRolloff
{
    real32 Distance;

    CVolume Volume;
};

struct SVolumeThreshold
{
    uint32 Count;

    CVolume Volume;
};

struct SSoundAsset
{
    CSoundPath File;

    int32 LoopCount;

    CiRange LoopTime;

    CiRange Offset;

    CPitchRange Pitch;

    std::vector<uint32> SyncPoints;

    CVolumeRange Volume;

    TSoundWeight Weight;

    CString FacialAnim;

    CString FacialGroup;

    CString PortraitAnim;

    CFacialPath FacialFile;

    CModelLink PortraitModel;

    CActorLink PortraitActor;

    CStringLink Speaker;

    CStringLink Subtitle;
};

struct SSoundLocaleFlags
{
    TLocaleId Locale;

    CFlags Flags;
};

class CSound
{
public:
    TEditorCategories EditorCategories;

    std::vector<SSoundAsset> AssetArray;

    CFlags Flags;

    ESoundCategory Category;

    uint8 Chance;

    CRange ConeAngle;

    C3Vector ConeOrientation;

    CRange ConeVolume;

    real32 DopplerLevel;

    uint16 DupeDestroyCount;

    ESoundBlend DupeFadeBlend;

    std::vector<SVolumeFade> DupeFadeIn;

    std::vector<SVolumeFade> DupeFadeOut;

    uint16 DupeHistoryCount;

    ESoundDupe DupeMaximumMethod;

    uint16 DupeMuteCount;

    uint16 DupeRepeatCount;

    uint32 DupeThresholdFadeTime;

    std::vector<SVolumeThreshold> DupeThresholdPoints;

    CiRange DupeWait;

    ESoundBlend FogFadeBlend;

    std::vector<SVolumeFade> FogFadeIn;

    std::vector<SVolumeFade> FogFadeOut;

    CHerdNodeLink HerdNode;

    std::vector<SSoundLocaleFlags> LocaleFlags;

    int32 LoopCount;

    CiRange LoopDelay;

    real32 LowPassGain;

    ESoundMode Mode;

    ESoundBlend MuteFadeBlend;

    std::vector<SVolumeFade> MuteFadeIn;

    std::vector<SVolumeFade> MuteFadeOut;

    CRange OcclusionDirect;

    CRange OcclusionReverb;

    ESoundBlend OffsetFadeBlend;

    std::vector<SVolumeFade> OffsetFadeIn;

    std::vector<SVolumeFade> OffsetFadeOut;

    ESoundBlend OffsetShiftBlend;

    std::vector<SPitchShift> OffsetShiftIn;

    std::vector<SPitchShift> OffsetShiftOut;

    real32 OverlapPitchDelta;

    uint16 OverlapTimeDelta;

    CRange Pan;

    real32 PanLevel;

    CPitchRange Pitch;

    uint8 ResourcePriority;

    SReverbBalance ReverbBalance;

    ESoundBlend ReverbRolloffBlend;

    std::vector<SReverbRolloff> ReverbRolloffPoints;

    ESoundSelect Select;

    std::vector<real32> SpeakerMix;

    real32 Spread;

    ESoundBlend SustainFadeBlend;

    std::vector<SVolumeFade> SustainFade;

    uint32 Timeout;

    uint32 VariationMinimum;

    CVolumeRange Volume;

    ESoundBlend VolumeRolloffBlend;

    ESoundBlend VolumeRolloffFadeBlend;

    std::vector<SVolumeFade> VolumeRolloffFadeIn;

    std::vector<SVolumeFade> VolumeRolloffFadeOut;

    std::vector<SVolumeRolloff> VolumeRolloffPoints;
};

#endif // SOUND_H