An FEV file is used to define events for the FMOD system and categorize them. More...
#include <fevfile.h>
Classes | |
| struct | Category |
| A category which is organized hierarchically. More... | |
| struct | Event |
| An FMOD event. More... | |
| struct | EventCategory |
| An event category for storing events. More... | |
| struct | Property |
| Some objects in FMOD can have generic properties. More... | |
| struct | SoundDefinition |
| A sound definition. More... | |
| struct | WaveBank |
| Reference to an external wave bank. More... | |
Public Types | |
| enum | StreamingType { kDecompressIntoMemory, kLoadIntoMemory, kStreamFromDisk } |
| Possible types of streaming for FMOD. More... | |
| enum | PlayMode { kSequential = 0, kRandom, kRandomNoRepeat, kSequentialNoRepeat, kShuffle, kProgrammerSelected } |
| Possible Play modes. More... | |
| enum | PropertyType { kPropertyInt = 0, kPropertyFloat, kPropertyString } |
| Possible Property types. More... | |
Public Member Functions | |
| FEVFile (const Common::UString &resRef) | |
| FEVFile (Common::SeekableReadStream &fev) | |
| const Common::UString & | getBankName () |
| const std::vector< WaveBank > & | getWaveBanks () |
| const std::vector< Category > & | getCategories () |
Private Member Functions | |
| void | load (Common::SeekableReadStream &fev) |
| void | readCategory (Common::SeekableReadStream &fev) |
| Read a general category. More... | |
| void | readEventCategory (Common::SeekableReadStream &fev) |
| Read a category for events. More... | |
| void | readEvent (Common::SeekableReadStream &fev) |
| Read an event. More... | |
| std::map< Common::UString, Property > | readProperties (Common::SeekableReadStream &fev) |
| Read properties. More... | |
| Common::UString | readLengthPrefixedString (Common::SeekableReadStream &fev) |
| Read an FEV length prefixed string. More... | |
Private Attributes | |
| Common::UString | _bankName |
| std::vector< WaveBank > | _waveBanks |
| std::vector< Category > | _categories |
| std::vector< Event > | _events |
| std::vector< SoundDefinition > | _definitions |
Detailed Description
An FEV file is used to define events for the FMOD system and categorize them.
There is currently only one relevant version of fev files with the FourCC "FEV1".
Member Enumeration Documentation
◆ PlayMode
◆ PropertyType
◆ StreamingType
Constructor & Destructor Documentation
◆ FEVFile() [1/2]
| Aurora::FEVFile::FEVFile | ( | const Common::UString & | resRef | ) |
Definition at line 34 of file fevfile.cpp.
References Common::UString::c_str(), Aurora::kFileTypeFEV, load(), and ResMan.
◆ FEVFile() [2/2]
| Aurora::FEVFile::FEVFile | ( | Common::SeekableReadStream & | fev | ) |
Definition at line 43 of file fevfile.cpp.
References load().
Member Function Documentation
◆ getBankName()
| const Common::UString & Aurora::FEVFile::getBankName | ( | ) |
Definition at line 47 of file fevfile.cpp.
References _bankName.
◆ getCategories()
| const std::vector< FEVFile::Category > & Aurora::FEVFile::getCategories | ( | ) |
Definition at line 55 of file fevfile.cpp.
References _categories.
◆ getWaveBanks()
| const std::vector< FEVFile::WaveBank > & Aurora::FEVFile::getWaveBanks | ( | ) |
Definition at line 51 of file fevfile.cpp.
References _waveBanks.
◆ load()
|
private |
Definition at line 59 of file fevfile.cpp.
References _bankName, _definitions, _waveBanks, kDecompressIntoMemory, Aurora::kFEVID, kLoadIntoMemory, kStreamFromDisk, Aurora::FEVFile::WaveBank::maxStreams, Aurora::FEVFile::WaveBank::name, Aurora::FEVFile::SoundDefinition::name, readCategory(), readEventCategory(), Common::ReadStream::readIEEEFloatLE(), readLengthPrefixedString(), Common::ReadStream::readUint32BE(), Common::ReadStream::readUint32LE(), Common::SeekableReadStream::skip(), and Aurora::FEVFile::WaveBank::streamingType.
Referenced by FEVFile().
◆ readCategory()
|
private |
Read a general category.
Definition at line 136 of file fevfile.cpp.
References _categories, Aurora::FEVFile::Category::pitch, Common::ReadStream::readIEEEFloatLE(), readLengthPrefixedString(), Common::ReadStream::readUint32LE(), Common::SeekableReadStream::skip(), and Aurora::FEVFile::Category::volume.
Referenced by load().
◆ readEvent()
|
private |
Read an event.
Definition at line 171 of file fevfile.cpp.
References _events, Common::ReadStream::readIEEEFloatLE(), readLengthPrefixedString(), readProperties(), Common::ReadStream::readUint32LE(), and Common::SeekableReadStream::skip().
Referenced by readEventCategory().
◆ readEventCategory()
|
private |
Read a category for events.
Definition at line 153 of file fevfile.cpp.
References readEvent(), readLengthPrefixedString(), readProperties(), and Common::ReadStream::readUint32LE().
Referenced by load().
◆ readLengthPrefixedString()
|
private |
Read an FEV length prefixed string.
Definition at line 250 of file fevfile.cpp.
References Common::kEncodingASCII, Common::readStringFixed(), and Common::ReadStream::readUint32LE().
Referenced by load(), readCategory(), readEvent(), readEventCategory(), and readProperties().
◆ readProperties()
|
private |
Read properties.
Definition at line 223 of file fevfile.cpp.
References kPropertyFloat, kPropertyInt, kPropertyString, Common::ReadStream::readIEEEFloatLE(), readLengthPrefixedString(), Common::ReadStream::readSint32LE(), Common::ReadStream::readUint32LE(), and Aurora::FEVFile::Property::type.
Referenced by readEvent(), and readEventCategory().
Member Data Documentation
◆ _bankName
|
private |
Definition at line 175 of file fevfile.h.
Referenced by getBankName(), and load().
◆ _categories
|
private |
Definition at line 178 of file fevfile.h.
Referenced by getCategories(), and readCategory().
◆ _definitions
|
private |
◆ _events
|
private |
Definition at line 179 of file fevfile.h.
Referenced by readEvent().
◆ _waveBanks
|
private |
Definition at line 177 of file fevfile.h.
Referenced by getWaveBanks(), and load().
The documentation for this class was generated from the following files:
- src/aurora/fevfile.h
- src/aurora/fevfile.cpp
