Configuration for sound observation and audio-control extraction. More...

#include <sound_observation.h>

Public Attributes
size_t	input_field

size_t	modulator_field

SimSoundOutputMode	output_mode

size_t	output_bus

double	output_send

bool	output_pre_fader

SimSoundSamplingMode	sampling_mode

SimSoundSamplingDomain	sampling_domain

SimSoundWindowType	window_type

size_t	window_length

size_t	window_offset

size_t	sample_index

SimSoundTranslationSource	gain_source

SimSoundModulatorSource	gain_modulator

double	gain_base

double	gain_scale

double	gain_min

double	gain_max

SimSoundTranslationSource	pan_source

SimSoundModulatorSource	pan_modulator

double	pan_center

double	pan_width

SimSoundPanLaw	pan_law

SimSoundTranslationSource	pitch_source

SimSoundModulatorSource	pitch_modulator

double	pitch_base_hz

double	pitch_range_octaves

SimSoundPitchScale	pitch_scale

SimSoundTranslationSource	fm_source

SimSoundModulatorSource	fm_modulator

double	fm_depth

double	fm_center

double	fm_ratio

double	fm_clip

double	attack_ms

double	release_ms

double	smoothing_tau

bool	scale_by_dt

SimSoundRawSampleSource	raw_source

SimSoundRawChannelMode	raw_channel_mode

double	raw_gain

double	raw_clip

SimSoundResampleMode	raw_resample_mode

Detailed Description

Configuration for sound observation and audio-control extraction.

Member Data Documentation

◆ attack_ms

double SimSoundObservationConfig::attack_ms

Envelope attack time in milliseconds.

◆ fm_center

double SimSoundObservationConfig::fm_center

FM center value.

◆ fm_clip

double SimSoundObservationConfig::fm_clip

Absolute FM clamp; <=0 disables.

◆ fm_depth

double SimSoundObservationConfig::fm_depth

FM depth.

◆ fm_modulator

SimSoundModulatorSource SimSoundObservationConfig::fm_modulator

Optional FM modulation source.

◆ fm_ratio

double SimSoundObservationConfig::fm_ratio

FM ratio multiplier.

◆ fm_source

SimSoundTranslationSource SimSoundObservationConfig::fm_source

Source driving frequency modulation.

◆ gain_base

double SimSoundObservationConfig::gain_base

Base gain before source scaling.

◆ gain_max

double SimSoundObservationConfig::gain_max

Maximum clamped gain.

◆ gain_min

double SimSoundObservationConfig::gain_min

Minimum clamped gain.

◆ gain_modulator

SimSoundModulatorSource SimSoundObservationConfig::gain_modulator

Optional gain modulation source.

◆ gain_scale

double SimSoundObservationConfig::gain_scale

Scale applied to gain source value.

◆ gain_source

SimSoundTranslationSource SimSoundObservationConfig::gain_source

Source driving gain.

◆ input_field

size_t SimSoundObservationConfig::input_field

Source field supplying samples.

◆ modulator_field

size_t SimSoundObservationConfig::modulator_field

Optional modulator field (SIZE_MAX uses input_field).

◆ output_bus

size_t SimSoundObservationConfig::output_bus

Destination audio bus index.

◆ output_mode

SimSoundOutputMode SimSoundObservationConfig::output_mode

Whether to emit controls or raw samples.

◆ output_pre_fader

bool SimSoundObservationConfig::output_pre_fader

True when the send is pre-fader.

◆ output_send

double SimSoundObservationConfig::output_send

Send amount for the destination bus.

◆ pan_center

double SimSoundObservationConfig::pan_center

Pan center value.

◆ pan_law

SimSoundPanLaw SimSoundObservationConfig::pan_law

Pan law used for stereo gain mapping.

◆ pan_modulator

SimSoundModulatorSource SimSoundObservationConfig::pan_modulator

Optional pan modulation source.

◆ pan_source

SimSoundTranslationSource SimSoundObservationConfig::pan_source

Source driving pan.

◆ pan_width

double SimSoundObservationConfig::pan_width

Source scale applied around pan_center.

◆ pitch_base_hz

double SimSoundObservationConfig::pitch_base_hz

Base pitch frequency in Hz.

◆ pitch_modulator

SimSoundModulatorSource SimSoundObservationConfig::pitch_modulator

Optional pitch modulation source.

◆ pitch_range_octaves

double SimSoundObservationConfig::pitch_range_octaves

Pitch modulation range in octaves.

◆ pitch_scale

SimSoundPitchScale SimSoundObservationConfig::pitch_scale

Pitch scale interpretation.

◆ pitch_source

SimSoundTranslationSource SimSoundObservationConfig::pitch_source

Source driving pitch.

◆ raw_channel_mode

SimSoundRawChannelMode SimSoundObservationConfig::raw_channel_mode

Raw sample channel layout.

◆ raw_clip

double SimSoundObservationConfig::raw_clip

Absolute raw sample clamp; <=0 disables.

◆ raw_gain

double SimSoundObservationConfig::raw_gain

Gain applied to raw samples.

◆ raw_resample_mode

SimSoundResampleMode SimSoundObservationConfig::raw_resample_mode

Resampling kernel for raw output.

◆ raw_source

SimSoundRawSampleSource SimSoundObservationConfig::raw_source

Field component used for raw samples.

◆ release_ms

double SimSoundObservationConfig::release_ms

Envelope release time in milliseconds.

◆ sample_index

size_t SimSoundObservationConfig::sample_index

Anchor sample index for point/windowed sampling.

◆ sampling_domain

SimSoundSamplingDomain SimSoundObservationConfig::sampling_domain

Physical or spectral sampling domain.

◆ sampling_mode

SimSoundSamplingMode SimSoundObservationConfig::sampling_mode

Reduction used to sample the field.

◆ scale_by_dt

bool SimSoundObservationConfig::scale_by_dt

Scale output controls by substep dt when true.

◆ smoothing_tau

double SimSoundObservationConfig::smoothing_tau

Additional smoothing time constant.

◆ window_length

size_t SimSoundObservationConfig::window_length

Number of samples in the reduction window.

◆ window_offset

size_t SimSoundObservationConfig::window_offset

Offset of the reduction window from sample_index.

◆ window_type

SimSoundWindowType SimSoundObservationConfig::window_type

Window function for windowed reductions.

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

sound_observation.h

Public Attributes