coastline 0.0.4
Loading...
Searching...
No Matches
EarEnvironmentRegistration Class Reference

Packed 0x40-byte environment registration copied by EAR_DLL_RegisterEnvironment(). More...

#include <environment.h>

Collaboration diagram for EarEnvironmentRegistration:

Public Member Functions

void InitializeDefaultEnvironment ()
 Set default environment properties, clear reserved bytes, and request handle 1.

Public Attributes

std::uint16_t size
 Registration byte count; registration requires 0x40.
std::uint16_t reservedRegistrationWord
 Uninterpreted registration property, defaulting to 16000.
std::uint16_t soundSpeed
 Doppler sound speed in centimetres per millisecond, defaulting to 33.
std::uint32_t reservedRegistrationDwordA
 First uninterpreted 32-bit property, defaulting to zero.
std::uint32_t reservedRegistrationDwordB
 Second uninterpreted 32-bit property, defaulting to zero.
std::uint32_t reservedRegistrationDwordC
 Third uninterpreted 32-bit property, defaulting to 500.
std::uint16_t frequency
 Nominal frequency in hertz, defaulting to 22050; not transferred into EarEnvironment.
std::uint16_t bitDepth
 Nominal sample bit depth, defaulting to 16; not transferred into EarEnvironment.
std::uint16_t pitchVariationRange
 Pitch variation half-range in units of 1/10000, clamped to at least 100 on registration.
std::uint16_t initialGain
 Suppression initial gain in units of 1/10000 of full amplitude, defaulting to 6000.
std::uint16_t reservedAuxiliaryWordA
 Uninterpreted auxiliary property A, defaulting to zero.
std::uint16_t reservedAuxiliaryWordB
 Uninterpreted auxiliary property B, defaulting to zero.
std::uint16_t dopplerCrossoverDistance
 Doppler crossover distance in centimetres, defaulting to zero.
std::uint16_t reservedAuxiliaryWordC
 Uninterpreted auxiliary property C, defaulting to zero.
std::uint16_t reservedAuxiliaryWordD
 Uninterpreted auxiliary property D, defaulting to zero.
std::uint16_t reservedAuxiliaryWordE
 Uninterpreted auxiliary property E, defaulting to zero.
std::uint8_t unknownBytes [22]
 Unrecovered registration bytes cleared by default initialisation.
std::uint32_t requestedHandle
 Requested handle truncated to 16 bits, with 1 replacing the default and 0xffffffff allocating a new handle.

Detailed Description

Packed 0x40-byte environment registration copied by EAR_DLL_RegisterEnvironment().

Initialisation assigns defaults; public fields can be adjusted before registration.

Member Function Documentation

◆ InitializeDefaultEnvironment()

void EarEnvironmentRegistration::InitializeDefaultEnvironment ( )

Set default environment properties, clear reserved bytes, and request handle 1.

Defaults include gain 6000, pitch variation 1500, sound speed 33, and zero crossover distance.

Ghidra address:
EAR: 0x10007220

Member Data Documentation

◆ size

std::uint16_t EarEnvironmentRegistration::size

Registration byte count; registration requires 0x40.

◆ reservedRegistrationWord

std::uint16_t EarEnvironmentRegistration::reservedRegistrationWord

Uninterpreted registration property, defaulting to 16000.

◆ soundSpeed

std::uint16_t EarEnvironmentRegistration::soundSpeed

Doppler sound speed in centimetres per millisecond, defaulting to 33.

◆ reservedRegistrationDwordA

std::uint32_t EarEnvironmentRegistration::reservedRegistrationDwordA

First uninterpreted 32-bit property, defaulting to zero.

◆ reservedRegistrationDwordB

std::uint32_t EarEnvironmentRegistration::reservedRegistrationDwordB

Second uninterpreted 32-bit property, defaulting to zero.

◆ reservedRegistrationDwordC

std::uint32_t EarEnvironmentRegistration::reservedRegistrationDwordC

Third uninterpreted 32-bit property, defaulting to 500.

◆ frequency

std::uint16_t EarEnvironmentRegistration::frequency

Nominal frequency in hertz, defaulting to 22050; not transferred into EarEnvironment.

◆ bitDepth

std::uint16_t EarEnvironmentRegistration::bitDepth

Nominal sample bit depth, defaulting to 16; not transferred into EarEnvironment.

◆ pitchVariationRange

std::uint16_t EarEnvironmentRegistration::pitchVariationRange

Pitch variation half-range in units of 1/10000, clamped to at least 100 on registration.

◆ initialGain

std::uint16_t EarEnvironmentRegistration::initialGain

Suppression initial gain in units of 1/10000 of full amplitude, defaulting to 6000.

◆ reservedAuxiliaryWordA

std::uint16_t EarEnvironmentRegistration::reservedAuxiliaryWordA

Uninterpreted auxiliary property A, defaulting to zero.

◆ reservedAuxiliaryWordB

std::uint16_t EarEnvironmentRegistration::reservedAuxiliaryWordB

Uninterpreted auxiliary property B, defaulting to zero.

◆ dopplerCrossoverDistance

std::uint16_t EarEnvironmentRegistration::dopplerCrossoverDistance

Doppler crossover distance in centimetres, defaulting to zero.

◆ reservedAuxiliaryWordC

std::uint16_t EarEnvironmentRegistration::reservedAuxiliaryWordC

Uninterpreted auxiliary property C, defaulting to zero.

◆ reservedAuxiliaryWordD

std::uint16_t EarEnvironmentRegistration::reservedAuxiliaryWordD

Uninterpreted auxiliary property D, defaulting to zero.

◆ reservedAuxiliaryWordE

std::uint16_t EarEnvironmentRegistration::reservedAuxiliaryWordE

Uninterpreted auxiliary property E, defaulting to zero.

◆ unknownBytes

std::uint8_t EarEnvironmentRegistration::unknownBytes[22]

Unrecovered registration bytes cleared by default initialisation.

◆ requestedHandle

std::uint32_t EarEnvironmentRegistration::requestedHandle

Requested handle truncated to 16 bits, with 1 replacing the default and 0xffffffff allocating a new handle.


The documentation for this class was generated from the following file: