Physics-based speaker + cabinet + microphone emulator. More...

#include <speaker_cabinet.hpp>

Classes
struct	BreakupMode
	One DIMENSIONLESS breakup mode: a ratio to the archetype's anchor frequency plus a Q and a gain. More...

Public Member Functions
void	prepare (double sample_rate)
	Recompute every corner coefficient for a new sample rate. No allocation.
void	set_driver_archetype (int index)
void	set_box_type (SpeakerBoxType type)
void	set_box_volume_l (double litres)
void	set_resonance_trim_semitones (double semitones)
void	set_q_resonance (double q)
	Override the computed box Qtc.
void	set_cone_breakup_amount (double percent)
void	set_treble_rolloff_hz (double hz)
void	set_drive_db (double db)
void	set_compression_amount (double percent)
void	set_mic_distance_cm (double cm)
void	set_mic_position_pct (double percent)
void	set_mic_axis_deg (double degrees)
void	set_diffraction_amount (double percent)
void	set_output_trim_db (double db)
SampleType	process (SampleType input)
void	process (const SampleType in, SampleType out, int n)
void	reset ()
	Zero every filter and excursion state.
int	latency_samples () const
	The chain is a cascade of minimum-phase filters with no block buffering and no oversampler, so nothing is held back.
double	worst_case_gain () const
	Sum of per-stage peak magnitudes across the parameter space.
double	compliance_ratio () const
	Compliance ratio alpha = Vas / Vb.
double	resonance_fc_hz () const
	Box resonance fc = fs * sqrt(1 + alpha), shifted by the voicing trim.
double	resonance_q () const
	Box Qtc = Qts * sqrt(1 + alpha), unless overridden.
double	resonance_peak_db () const
	Peak magnitude of the second-order high-pass at the resonance, in dB: Q / sqrt(1 - 1/(4 Q^2)).
double	resonance_peak_hz () const
	Frequency of that peak: fc / sqrt(1 - 1/(2 Q^2)).
double	baffle_step_hz () const
	Baffle-step transition c / (pi * W).
double	ripple_hz () const
	First edge-diffraction ripple c / (2 * d_edge).
double	dipole_hz () const
	Open-back dipole corner c / (2 * D).
double	breakup_mode_hz (int index) const
	Centre of breakup mode index, anchored on the archetype.
double	offaxis_corner_hz () const
	Off-axis corner f_on * (1 - k_ax * sin(angle)).
double	proximity_gain_db () const
	Proximity shelf gain, boost-only by construction and clamped at the ceiling: k_prox * (1/d - 1/d_ref) in dB.
double	presence_shelf_db () const
	Cap-to-cone traverse shelf, lerped bright-to-dark.
double	air_loss_db () const
	Air/distance HF trim, in dB (negative), scaling with distance.
double	inductance_magnitude_db (double hz) const
	Exact magnitude of the voice-coil inductance stage ALONE, in dB, from the coefficients currently in force.
double	bl_beta () const
	BL(x) falloff coefficient beta actually in force.
double	cms_gamma () const
	Cms(x) stiffening coefficient gamma actually in force.
double	excursion () const
	Normalized excursion produced by the most recent sample.
double	dynamic_fc_hz () const
	The resonance cutoff currently in force, including Cms stiffening.
int	archetype_index () const
SpeakerBoxType	box_type () const
double	sample_rate () const

Static Public Member Functions
static const SpeakerDriverArchetype &	archetype (int index)
	[design parameter] table; see SpeakerDriverArchetype and the model scope above.
static const BreakupMode &	breakup_mode (int index)
	[design parameter] shape.

Static Public Attributes
static constexpr int	kArchetypeCount = 5
static constexpr double	kSpeedOfSoundMs = 343.0
	Speed of sound in air at ~20 C, standard atmospheric value.
static constexpr double	kBoxVolumeLDefault = 28.0
	Sealed-box internal volume. [dp, default 28 L, range 5..150 L].
static constexpr double	kBoxVolumeLMin = 5.0
static constexpr double	kBoxVolumeLMax = 150.0
static constexpr double	kResonanceTrimSemitonesMin = -12.0
	Voicing shift of the computed resonance. [dp, default 0, range -12..+12].
static constexpr double	kResonanceTrimSemitonesMax = 12.0
static constexpr double	kQResonanceMin = 0.4
	Box Qtc override.
static constexpr double	kQResonanceMax = 2.0
static constexpr double	kConeBreakupAmountDefault = 100.0
	Depth of the cone-breakup bank. [dp, default 100 %, range 0..100 %].
static constexpr double	kTrebleRolloffHzDefault = 4000.0
	Voice-coil-inductance corner. [dp, default 4000 Hz, range 1500..8000 Hz].
static constexpr double	kTrebleRolloffHzMin = 1500.0
static constexpr double	kTrebleRolloffHzMax = 8000.0
static constexpr double	kSemiInductanceDefault = 0.25
	Leach semi-inductance blend and its shelf floor: the fraction of the un-rolled signal mixed back through a high shelf to give the "leaky", gentler-than-6-dB/oct HF decay real motors measure.
static constexpr double	kSemiInductanceMin = 0.0
static constexpr double	kSemiInductanceMax = 1.0
static constexpr double	kSemiInductanceShelfDb = -12.0
static constexpr double	kSemiInductanceShelfDbMin = -18.0
static constexpr double	kSemiInductanceShelfDbMax = -6.0
static constexpr double	kDriveDbDefault = 0.0
	Excursion drive. [dp, default 0 dB, range -12..+24 dB].
static constexpr double	kDriveDbMin = -12.0
static constexpr double	kDriveDbMax = 24.0
static constexpr double	kCompressionAmountDefault = 60.0
	Depth of the BL(x) / Cms(x) nonlinearity. [dp, default 60 %, range 0..100].
static constexpr double	kExcursionReference = 0.5
	Normalized reference excursion.
static constexpr double	kExcursionReferenceMin = 0.1
static constexpr double	kExcursionReferenceMax = 2.0
static constexpr double	kBlFalloff = 1.5
	BL(x) falloff rate: g_bl = 1/(1 + betax^2), beta = amount k_bl.
static constexpr double	kBlFalloffMin = 0.0
static constexpr double	kBlFalloffMax = 4.0
static constexpr double	kCmsStiffening = 0.35
	Cms(x) stiffening rate: fc' = fc(1 + gammax^2), gamma = amount * k_cms.
static constexpr double	kCmsStiffeningMin = 0.0
static constexpr double	kCmsStiffeningMax = 1.0
static constexpr double	kMicDistanceCmDefault = 3.0
	Mic distance. [dp, default 3 cm, range 1..60 cm].
static constexpr double	kMicDistanceCmMin = 1.0
static constexpr double	kMicDistanceCmMax = 60.0
static constexpr double	kProximityGainK = 12.0
	Proximity shelf.
static constexpr double	kProximityGainKMin = 0.0
static constexpr double	kProximityGainKMax = 24.0
static constexpr double	kProximityReferenceCm = 30.0
static constexpr double	kProximityReferenceCmMin = 20.0
static constexpr double	kProximityReferenceCmMax = 50.0
static constexpr double	kProximityCeilingDb = 8.0
static constexpr double	kProximityCeilingDbMin = 6.0
static constexpr double	kProximityCeilingDbMax = 12.0
static constexpr double	kProximityCornerHz = 250.0
static constexpr double	kProximityCornerHzMin = 150.0
static constexpr double	kProximityCornerHzMax = 400.0
static constexpr double	kAirLossDbPerCm = 0.05
	Air/distance HF loss above a corner, scaling with distance.
static constexpr double	kAirLossDbPerCmMin = 0.02
static constexpr double	kAirLossDbPerCmMax = 0.10
static constexpr double	kAirLossCornerHz = 6000.0
static constexpr double	kAirLossCornerHzMin = 4000.0
static constexpr double	kAirLossCornerHzMax = 8000.0
static constexpr double	kPresenceCapDb = 3.0
	Cap-to-cone traverse: a high shelf lerped from bright at the dust cap to dark at the cone edge.
static constexpr double	kPresenceEdgeDb = -8.0
static constexpr double	kPresenceDbMax = 6.0
static constexpr double	kPresenceDbMin = -12.0
static constexpr double	kPresenceCornerHz = 2500.0
static constexpr double	kPresenceCornerHzMin = 1500.0
static constexpr double	kPresenceCornerHzMax = 3500.0
static constexpr double	kMicPositionPctDefault = 30.0
static constexpr double	kOffAxisOnAxisHz = 8000.0
	Off-axis rolloff: fc = f_on * (1 - k_ax * sin(angle)).
static constexpr double	kOffAxisOnAxisHzMin = 5000.0
static constexpr double	kOffAxisOnAxisHzMax = 12000.0
static constexpr double	kOffAxisFactor = 0.7
static constexpr double	kOffAxisFactorMin = 0.0
static constexpr double	kOffAxisFactorMax = 0.95
static constexpr double	kMicAxisDegMin = 0.0
static constexpr double	kMicAxisDegMax = 90.0
static constexpr double	kBaffleStepDb = 6.0
	Baffle step: +6 dB high shelf at c / (pi * W), depth scaled by diffraction_amount.
static constexpr double	kEdgeDistanceM = 0.15
	Edge-diffraction ripple: two low-Q sections at c/(2*d_edge) and twice that.
static constexpr double	kEdgeDistanceMMin = 0.08
static constexpr double	kEdgeDistanceMMax = 0.30
static constexpr double	kRipple1Q = 2.0
static constexpr double	kRipple1Db = 2.5
static constexpr double	kRipple2Q = 2.5
static constexpr double	kRipple2Db = -2.0
static constexpr double	kRippleQMin = 1.5
static constexpr double	kRippleQMax = 4.0
static constexpr double	kRippleDbMax = 4.0
static constexpr double	kDiffractionAmountDefault = 50.0
static constexpr double	kDipolePathM = 0.30
	Open-back dipole: first-order high-pass at c / (2*D) plus a notch.
static constexpr double	kDipolePathMMin = 0.15
static constexpr double	kDipolePathMMax = 0.50
static constexpr double	kDipoleNotchRatio = 1.8
static constexpr double	kDipoleNotchRatioMin = 1.4
static constexpr double	kDipoleNotchRatioMax = 2.2
static constexpr double	kDipoleNotchQ = 1.5
static constexpr double	kDipoleNotchQMin = 1.0
static constexpr double	kDipoleNotchQMax = 3.0
static constexpr double	kDipoleNotchDb = -4.0
static constexpr double	kDipoleNotchDbMin = -8.0
static constexpr double	kDipoleNotchDbMax = -2.0
static constexpr double	kOutputTrimDbMin = -24.0
	Output make-up. [dp, default 0 dB, range -24..+24 dB].
static constexpr double	kOutputTrimDbMax = 24.0
static constexpr double	kDcBlockerHz = 5.0
	Input DC-blocker corner.
static constexpr double	kDcBlockerHzMin = 2.0
static constexpr double	kDcBlockerHzMax = 20.0
static constexpr double	kSmoothingMs = 15.0
	Parameter smoothing time. [dp, default 15 ms, range 5..30 ms].
static constexpr double	kSmoothingMsMin = 5.0
static constexpr double	kSmoothingMsMax = 30.0
static constexpr int	kControlBlock = 32
	Coefficient recompute cadence, in samples.
static constexpr int	kControlBlockMin = 16
static constexpr int	kControlBlockMax = 64
static constexpr double	kWorstCaseGain = 10.0
	Sum of per-stage peak magnitudes across the whole parameter space, the bound the Forge registry cites.
static constexpr int	kBreakupModeCount = 4
static constexpr double	kBreakupRatioMin = 1.0
static constexpr double	kBreakupRatioMax = 4.0
static constexpr double	kBreakupQMin = 1.5
static constexpr double	kBreakupQMax = 8.0
static constexpr double	kBreakupGainDbMax = 6.0

Detailed Description

template<typename SampleType = float>
class pulp::signal::SpeakerModelT< SampleType >

Physics-based speaker + cabinet + microphone emulator.

See the file doc block for the sibling relationship with ZeroLatencyConvolverT, the composition notes, and the anti-aliasing policy. Signal chain, in order: DC block, drive, Thiele-Small resonance (HP tap = pressure, LP tap = excursion), BL(x) compression, voice-coil inductance rolloff, cone-breakup modal bank, cabinet (baffle step, edge ripple, open-back dipole), microphone (proximity, air loss, cap-to-cone traverse, off-axis), output trim.

Member Function Documentation

◆ air_loss_db()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::air_loss_db ( ) const

inline

Air/distance HF trim, in dB (negative), scaling with distance.

◆ archetype()

template<typename SampleType = float>

const SpeakerDriverArchetype & pulp::signal::SpeakerModelT< SampleType >::archetype ( int index )

inlinestatic

[design parameter] table; see SpeakerDriverArchetype and the model scope above.

Ranges below each figure are the datasheet envelope the value is drawn from.

◆ archetype_index()

template<typename SampleType = float>

int pulp::signal::SpeakerModelT< SampleType >::archetype_index ( ) const

inline

◆ baffle_step_hz()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::baffle_step_hz ( ) const

inline

Baffle-step transition c / (pi * W).

◆ bl_beta()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::bl_beta ( ) const

inline

BL(x) falloff coefficient beta actually in force.

◆ box_type()

template<typename SampleType = float>

SpeakerBoxType pulp::signal::SpeakerModelT< SampleType >::box_type ( ) const

inline

◆ breakup_mode()

template<typename SampleType = float>

const BreakupMode & pulp::signal::SpeakerModelT< SampleType >::breakup_mode ( int index )

inlinestatic

[design parameter] shape.

Ranges: ratio 1.0..4.0, Q 1.5..8.0, gain +-6 dB. Honest gap: exact modal maps are driver-specific and are not published as citable tables; these are engineered presence-region values.

◆ breakup_mode_hz()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::breakup_mode_hz ( int index ) const

inline

Centre of breakup mode index, anchored on the archetype.

◆ cms_gamma()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::cms_gamma ( ) const

inline

Cms(x) stiffening coefficient gamma actually in force.

◆ compliance_ratio()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::compliance_ratio ( ) const

inline

Compliance ratio alpha = Vas / Vb.

Zero in open-back: the rear wave escapes, so there is no trapped-air stiffness and the driver runs near free air. That is the real physical difference between the two cabinet types, exposed as one enum.

◆ dipole_hz()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::dipole_hz ( ) const

inline

Open-back dipole corner c / (2 * D).

◆ dynamic_fc_hz()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::dynamic_fc_hz ( ) const

inline

The resonance cutoff currently in force, including Cms stiffening.

◆ excursion()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::excursion ( ) const

inline

Normalized excursion produced by the most recent sample.

◆ inductance_magnitude_db()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::inductance_magnitude_db ( double hz ) const

inline

Exact magnitude of the voice-coil inductance stage ALONE, in dB, from the coefficients currently in force.

The stage is a parallel blend of a first-order lowpass and a high shelf, so it cannot be read off the chain's response: every other stage sits on top of it, and the off-axis lowpass in particular is a second HF rolloff that is always present. Exposing the stage's own response lets its corner and slope be asserted directly — and lets a UI draw the rolloff the "treble" control is actually applying.

◆ latency_samples()

template<typename SampleType = float>

int pulp::signal::SpeakerModelT< SampleType >::latency_samples ( ) const

inline

The chain is a cascade of minimum-phase filters with no block buffering and no oversampler, so nothing is held back.

◆ offaxis_corner_hz()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::offaxis_corner_hz ( ) const

inline

Off-axis corner f_on * (1 - k_ax * sin(angle)).

◆ prepare()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::prepare ( double sample_rate )

inline

Recompute every corner coefficient for a new sample rate. No allocation.

◆ presence_shelf_db()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::presence_shelf_db ( ) const

inline

Cap-to-cone traverse shelf, lerped bright-to-dark.

◆ process() [1/2]

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::process	(	const SampleType *	in,
		SampleType *	out,
		int	n )

inline

◆ process() [2/2]

template<typename SampleType = float>

SampleType pulp::signal::SpeakerModelT< SampleType >::process ( SampleType input )

inline

◆ proximity_gain_db()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::proximity_gain_db ( ) const

inline

Proximity shelf gain, boost-only by construction and clamped at the ceiling: k_prox * (1/d - 1/d_ref) in dB.

◆ reset()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::reset ( )

inline

Zero every filter and excursion state.

No allocation. A zero-initialised instance is equivalent to a reset one.

◆ resonance_fc_hz()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::resonance_fc_hz ( ) const

inline

Box resonance fc = fs * sqrt(1 + alpha), shifted by the voicing trim.

◆ resonance_peak_db()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::resonance_peak_db ( ) const

inline

Peak magnitude of the second-order high-pass at the resonance, in dB: Q / sqrt(1 - 1/(4 Q^2)).

Only defined for Q > 1/sqrt(2); below that the response is monotone and there is no peak.

◆ resonance_peak_hz()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::resonance_peak_hz ( ) const

inline

Frequency of that peak: fc / sqrt(1 - 1/(2 Q^2)).

NOT fc — a second-order high-pass peaks ABOVE its corner, unlike a bandpass.

◆ resonance_q()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::resonance_q ( ) const

inline

Box Qtc = Qts * sqrt(1 + alpha), unless overridden.

◆ ripple_hz()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::ripple_hz ( ) const

inline

First edge-diffraction ripple c / (2 * d_edge).

◆ sample_rate()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::sample_rate ( ) const

inline

◆ set_box_type()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_box_type ( SpeakerBoxType type )

inline

◆ set_box_volume_l()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_box_volume_l ( double litres )

inline

◆ set_compression_amount()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_compression_amount ( double percent )

inline

◆ set_cone_breakup_amount()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_cone_breakup_amount ( double percent )

inline

◆ set_diffraction_amount()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_diffraction_amount ( double percent )

inline

◆ set_drive_db()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_drive_db ( double db )

inline

◆ set_driver_archetype()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_driver_archetype ( int index )

inline

◆ set_mic_axis_deg()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_mic_axis_deg ( double degrees )

inline

◆ set_mic_distance_cm()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_mic_distance_cm ( double cm )

inline

◆ set_mic_position_pct()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_mic_position_pct ( double percent )

inline

◆ set_output_trim_db()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_output_trim_db ( double db )

inline

◆ set_q_resonance()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_q_resonance ( double q )

inline

Override the computed box Qtc.

Pass a non-positive value to return to the archetype-and-volume computation.

◆ set_resonance_trim_semitones()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_resonance_trim_semitones ( double semitones )

inline

◆ set_treble_rolloff_hz()

template<typename SampleType = float>

void pulp::signal::SpeakerModelT< SampleType >::set_treble_rolloff_hz ( double hz )

inline

◆ worst_case_gain()

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::worst_case_gain ( ) const

inline

Sum of per-stage peak magnitudes across the parameter space.

Asserted, not estimated — see the worst-case-gain test.

Member Data Documentation

◆ kAirLossCornerHz

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kAirLossCornerHz = 6000.0

staticconstexpr

◆ kAirLossCornerHzMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kAirLossCornerHzMax = 8000.0

staticconstexpr

◆ kAirLossCornerHzMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kAirLossCornerHzMin = 4000.0

staticconstexpr

◆ kAirLossDbPerCm

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kAirLossDbPerCm = 0.05

staticconstexpr

Air/distance HF loss above a corner, scaling with distance.

[dp: 0.05 dB/cm, range 0.02..0.10] [dp: corner 6 kHz, range 4..8 kHz]

◆ kAirLossDbPerCmMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kAirLossDbPerCmMax = 0.10

staticconstexpr

◆ kAirLossDbPerCmMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kAirLossDbPerCmMin = 0.02

staticconstexpr

◆ kArchetypeCount

template<typename SampleType = float>

int pulp::signal::SpeakerModelT< SampleType >::kArchetypeCount = 5

staticconstexpr

◆ kBaffleStepDb

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kBaffleStepDb = 6.0

staticconstexpr

Baffle step: +6 dB high shelf at c / (pi * W), depth scaled by diffraction_amount.

The +6 dB is the PUBLISHED half-space-to-full-space transition (Olson 1969), not a tunable.

◆ kBlFalloff

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kBlFalloff = 1.5

staticconstexpr

BL(x) falloff rate: g_bl = 1/(1 + beta*x^2), beta = amount * k_bl.

[dp, default 1.5, range 0..4]

◆ kBlFalloffMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kBlFalloffMax = 4.0

staticconstexpr

◆ kBlFalloffMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kBlFalloffMin = 0.0

staticconstexpr

◆ kBoxVolumeLDefault

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kBoxVolumeLDefault = 28.0

staticconstexpr

Sealed-box internal volume. [dp, default 28 L, range 5..150 L].

◆ kBoxVolumeLMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kBoxVolumeLMax = 150.0

staticconstexpr

◆ kBoxVolumeLMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kBoxVolumeLMin = 5.0

staticconstexpr

◆ kBreakupGainDbMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kBreakupGainDbMax = 6.0

staticconstexpr

◆ kBreakupModeCount

template<typename SampleType = float>

int pulp::signal::SpeakerModelT< SampleType >::kBreakupModeCount = 4

staticconstexpr

◆ kBreakupQMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kBreakupQMax = 8.0

staticconstexpr

◆ kBreakupQMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kBreakupQMin = 1.5

staticconstexpr

◆ kBreakupRatioMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kBreakupRatioMax = 4.0

staticconstexpr

◆ kBreakupRatioMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kBreakupRatioMin = 1.0

staticconstexpr

◆ kCmsStiffening

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kCmsStiffening = 0.35

staticconstexpr

Cms(x) stiffening rate: fc' = fc*(1 + gamma*x^2), gamma = amount * k_cms.

[dp, default 0.35, range 0..1]

◆ kCmsStiffeningMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kCmsStiffeningMax = 1.0

staticconstexpr

◆ kCmsStiffeningMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kCmsStiffeningMin = 0.0

staticconstexpr

◆ kCompressionAmountDefault

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kCompressionAmountDefault = 60.0

staticconstexpr

Depth of the BL(x) / Cms(x) nonlinearity. [dp, default 60 %, range 0..100].

◆ kConeBreakupAmountDefault

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kConeBreakupAmountDefault = 100.0

staticconstexpr

Depth of the cone-breakup bank. [dp, default 100 %, range 0..100 %].

◆ kControlBlock

template<typename SampleType = float>

int pulp::signal::SpeakerModelT< SampleType >::kControlBlock = 32

staticconstexpr

Coefficient recompute cadence, in samples.

[dp, default 32, range 16..64] Keeps transcendentals out of the hot loop beyond the resonator's own tick.

◆ kControlBlockMax

template<typename SampleType = float>

int pulp::signal::SpeakerModelT< SampleType >::kControlBlockMax = 64

staticconstexpr

◆ kControlBlockMin

template<typename SampleType = float>

int pulp::signal::SpeakerModelT< SampleType >::kControlBlockMin = 16

staticconstexpr

◆ kDcBlockerHz

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDcBlockerHz = 5.0

staticconstexpr

Input DC-blocker corner.

[dp, default 5 Hz, range 2..20 Hz]

This must be set explicitly rather than left at DcBlocker's default pole of 0.995, which is a ~38 Hz corner at 48 kHz — inside the passband of every archetype here and directly on top of the Bass-15's 45 Hz resonance. A DC blocker's job is removing DC, not shaping the low end; at 5 Hz it is 18 dB below the lowest resonance in the table and the second-order-high-pass asymptote below fc is the driver's, not the blocker's.

◆ kDcBlockerHzMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDcBlockerHzMax = 20.0

staticconstexpr

◆ kDcBlockerHzMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDcBlockerHzMin = 2.0

staticconstexpr

◆ kDiffractionAmountDefault

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDiffractionAmountDefault = 50.0

staticconstexpr

◆ kDipoleNotchDb

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDipoleNotchDb = -4.0

staticconstexpr

◆ kDipoleNotchDbMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDipoleNotchDbMax = -2.0

staticconstexpr

◆ kDipoleNotchDbMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDipoleNotchDbMin = -8.0

staticconstexpr

◆ kDipoleNotchQ

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDipoleNotchQ = 1.5

staticconstexpr

◆ kDipoleNotchQMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDipoleNotchQMax = 3.0

staticconstexpr

◆ kDipoleNotchQMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDipoleNotchQMin = 1.0

staticconstexpr

◆ kDipoleNotchRatio

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDipoleNotchRatio = 1.8

staticconstexpr

◆ kDipoleNotchRatioMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDipoleNotchRatioMax = 2.2

staticconstexpr

◆ kDipoleNotchRatioMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDipoleNotchRatioMin = 1.4

staticconstexpr

◆ kDipolePathM

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDipolePathM = 0.30

staticconstexpr

Open-back dipole: first-order high-pass at c / (2*D) plus a notch.

[dp: D 0.30 m, range 0.15..0.5] [dp: notch ratio 1.8, range 1.4..2.2] [dp: notch Q 1.5, range 1.0..3.0] [dp: notch -4 dB, range -8..-2]

◆ kDipolePathMMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDipolePathMMax = 0.50

staticconstexpr

◆ kDipolePathMMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDipolePathMMin = 0.15

staticconstexpr

◆ kDriveDbDefault

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDriveDbDefault = 0.0

staticconstexpr

Excursion drive. [dp, default 0 dB, range -12..+24 dB].

◆ kDriveDbMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDriveDbMax = 24.0

staticconstexpr

◆ kDriveDbMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kDriveDbMin = -12.0

staticconstexpr

◆ kEdgeDistanceM

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kEdgeDistanceM = 0.15

staticconstexpr

Edge-diffraction ripple: two low-Q sections at c/(2*d_edge) and twice that.

[dp: d_edge 0.15 m, range 0.08..0.30] [dp: (Q 2.0, +2.5 dB) and (Q 2.5, -2.0 dB), Q range 1.5..4, gain +-4 dB]

◆ kEdgeDistanceMMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kEdgeDistanceMMax = 0.30

staticconstexpr

◆ kEdgeDistanceMMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kEdgeDistanceMMin = 0.08

staticconstexpr

◆ kExcursionReference

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kExcursionReference = 0.5

staticconstexpr

Normalized reference excursion.

Signals here are normalized audio, not metres, so this and drive_db together set WHERE compression begins rather than claiming a physical Xmax. [dp, default 0.5, range 0.1..2.0]

◆ kExcursionReferenceMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kExcursionReferenceMax = 2.0

staticconstexpr

◆ kExcursionReferenceMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kExcursionReferenceMin = 0.1

staticconstexpr

◆ kMicAxisDegMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kMicAxisDegMax = 90.0

staticconstexpr

◆ kMicAxisDegMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kMicAxisDegMin = 0.0

staticconstexpr

◆ kMicDistanceCmDefault

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kMicDistanceCmDefault = 3.0

staticconstexpr

Mic distance. [dp, default 3 cm, range 1..60 cm].

◆ kMicDistanceCmMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kMicDistanceCmMax = 60.0

staticconstexpr

◆ kMicDistanceCmMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kMicDistanceCmMin = 1.0

staticconstexpr

◆ kMicPositionPctDefault

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kMicPositionPctDefault = 30.0

staticconstexpr

◆ kOffAxisFactor

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kOffAxisFactor = 0.7

staticconstexpr

◆ kOffAxisFactorMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kOffAxisFactorMax = 0.95

staticconstexpr

◆ kOffAxisFactorMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kOffAxisFactorMin = 0.0

staticconstexpr

◆ kOffAxisOnAxisHz

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kOffAxisOnAxisHz = 8000.0

staticconstexpr

Off-axis rolloff: fc = f_on * (1 - k_ax * sin(angle)).

[dp: f_on 8 kHz, range 5..12 kHz] [dp: k_ax 0.7, range 0..0.95]

◆ kOffAxisOnAxisHzMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kOffAxisOnAxisHzMax = 12000.0

staticconstexpr

◆ kOffAxisOnAxisHzMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kOffAxisOnAxisHzMin = 5000.0

staticconstexpr

◆ kOutputTrimDbMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kOutputTrimDbMax = 24.0

staticconstexpr

◆ kOutputTrimDbMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kOutputTrimDbMin = -24.0

staticconstexpr

Output make-up. [dp, default 0 dB, range -24..+24 dB].

◆ kPresenceCapDb

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kPresenceCapDb = 3.0

staticconstexpr

Cap-to-cone traverse: a high shelf lerped from bright at the dust cap to dark at the cone edge.

[dp: +3 dB at cap, -8 dB at edge, range +6..-12] [dp: corner 2.5 kHz, range 1.5..3.5 kHz]

◆ kPresenceCornerHz

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kPresenceCornerHz = 2500.0

staticconstexpr

◆ kPresenceCornerHzMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kPresenceCornerHzMax = 3500.0

staticconstexpr

◆ kPresenceCornerHzMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kPresenceCornerHzMin = 1500.0

staticconstexpr

◆ kPresenceDbMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kPresenceDbMax = 6.0

staticconstexpr

◆ kPresenceDbMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kPresenceDbMin = -12.0

staticconstexpr

◆ kPresenceEdgeDb

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kPresenceEdgeDb = -8.0

staticconstexpr

◆ kProximityCeilingDb

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kProximityCeilingDb = 8.0

staticconstexpr

◆ kProximityCeilingDbMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kProximityCeilingDbMax = 12.0

staticconstexpr

◆ kProximityCeilingDbMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kProximityCeilingDbMin = 6.0

staticconstexpr

◆ kProximityCornerHz

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kProximityCornerHz = 250.0

staticconstexpr

◆ kProximityCornerHzMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kProximityCornerHzMax = 400.0

staticconstexpr

◆ kProximityCornerHzMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kProximityCornerHzMin = 150.0

staticconstexpr

◆ kProximityGainK

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kProximityGainK = 12.0

staticconstexpr

Proximity shelf.

The gain law is k_prox * (1/distance - 1/d_ref), clamped to [0, ceiling] — the 0 dB floor is STRUCTURAL (the shelf is boost-only by construction), the ceiling is a design parameter. [dp: k_prox 12, range 0..24] [dp: d_ref 30 cm, range 20..50] [dp: ceiling +8 dB, range +6..+12] [dp: corner 250 Hz, range 150..400]

◆ kProximityGainKMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kProximityGainKMax = 24.0

staticconstexpr

◆ kProximityGainKMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kProximityGainKMin = 0.0

staticconstexpr

◆ kProximityReferenceCm

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kProximityReferenceCm = 30.0

staticconstexpr

◆ kProximityReferenceCmMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kProximityReferenceCmMax = 50.0

staticconstexpr

◆ kProximityReferenceCmMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kProximityReferenceCmMin = 20.0

staticconstexpr

◆ kQResonanceMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kQResonanceMax = 2.0

staticconstexpr

◆ kQResonanceMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kQResonanceMin = 0.4

staticconstexpr

Box Qtc override.

[dp, default = computed from archetype + volume, range 0.4..2.0]

◆ kResonanceTrimSemitonesMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kResonanceTrimSemitonesMax = 12.0

staticconstexpr

◆ kResonanceTrimSemitonesMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kResonanceTrimSemitonesMin = -12.0

staticconstexpr

Voicing shift of the computed resonance. [dp, default 0, range -12..+12].

◆ kRipple1Db

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kRipple1Db = 2.5

staticconstexpr

◆ kRipple1Q

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kRipple1Q = 2.0

staticconstexpr

◆ kRipple2Db

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kRipple2Db = -2.0

staticconstexpr

◆ kRipple2Q

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kRipple2Q = 2.5

staticconstexpr

◆ kRippleDbMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kRippleDbMax = 4.0

staticconstexpr

◆ kRippleQMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kRippleQMax = 4.0

staticconstexpr

◆ kRippleQMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kRippleQMin = 1.5

staticconstexpr

◆ kSemiInductanceDefault

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kSemiInductanceDefault = 0.25

staticconstexpr

Leach semi-inductance blend and its shelf floor: the fraction of the un-rolled signal mixed back through a high shelf to give the "leaky", gentler-than-6-dB/oct HF decay real motors measure.

[dp, default 0.25, range 0..1] and [dp, default -12 dB, range -18..-6]

◆ kSemiInductanceMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kSemiInductanceMax = 1.0

staticconstexpr

◆ kSemiInductanceMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kSemiInductanceMin = 0.0

staticconstexpr

◆ kSemiInductanceShelfDb

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kSemiInductanceShelfDb = -12.0

staticconstexpr

◆ kSemiInductanceShelfDbMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kSemiInductanceShelfDbMax = -6.0

staticconstexpr

◆ kSemiInductanceShelfDbMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kSemiInductanceShelfDbMin = -18.0

staticconstexpr

◆ kSmoothingMs

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kSmoothingMs = 15.0

staticconstexpr

Parameter smoothing time. [dp, default 15 ms, range 5..30 ms].

◆ kSmoothingMsMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kSmoothingMsMax = 30.0

staticconstexpr

◆ kSmoothingMsMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kSmoothingMsMin = 5.0

staticconstexpr

◆ kSpeedOfSoundMs

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kSpeedOfSoundMs = 343.0

staticconstexpr

Speed of sound in air at ~20 C, standard atmospheric value.

PUBLISHED physical constant, not a tunable — it sets the baffle-step and dipole frequencies from geometry.

◆ kTrebleRolloffHzDefault

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kTrebleRolloffHzDefault = 4000.0

staticconstexpr

Voice-coil-inductance corner. [dp, default 4000 Hz, range 1500..8000 Hz].

◆ kTrebleRolloffHzMax

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kTrebleRolloffHzMax = 8000.0

staticconstexpr

◆ kTrebleRolloffHzMin

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kTrebleRolloffHzMin = 1500.0

staticconstexpr

◆ kWorstCaseGain

template<typename SampleType = float>

double pulp::signal::SpeakerModelT< SampleType >::kWorstCaseGain = 10.0

staticconstexpr

Sum of per-stage peak magnitudes across the whole parameter space, the bound the Forge registry cites.

Asserted by the worst-case-gain test — a measured invariant, not an estimate.

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

/home/runner/work/pulp/pulp/core/signal/include/pulp/signal/speaker_cabinet.hpp

Pulp 1.88.0 Cross-platform audio plugin framework

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ air_loss_db()

◆ archetype()

◆ archetype_index()

◆ baffle_step_hz()

◆ bl_beta()

◆ box_type()

◆ breakup_mode()

◆ breakup_mode_hz()

◆ cms_gamma()

◆ compliance_ratio()

◆ dipole_hz()

◆ dynamic_fc_hz()

◆ excursion()

◆ inductance_magnitude_db()

◆ latency_samples()

◆ offaxis_corner_hz()

◆ prepare()

◆ presence_shelf_db()

◆ process() [1/2]

◆ process() [2/2]

◆ proximity_gain_db()

◆ reset()

◆ resonance_fc_hz()

◆ resonance_peak_db()

◆ resonance_peak_hz()

◆ resonance_q()

◆ ripple_hz()

◆ sample_rate()

◆ set_box_type()

◆ set_box_volume_l()

◆ set_compression_amount()

◆ set_cone_breakup_amount()

◆ set_diffraction_amount()

◆ set_drive_db()

◆ set_driver_archetype()

◆ set_mic_axis_deg()

◆ set_mic_distance_cm()

◆ set_mic_position_pct()

◆ set_output_trim_db()

◆ set_q_resonance()

◆ set_resonance_trim_semitones()

◆ set_treble_rolloff_hz()

◆ worst_case_gain()

Member Data Documentation

◆ kAirLossCornerHz

◆ kAirLossCornerHzMax

◆ kAirLossCornerHzMin

◆ kAirLossDbPerCm

◆ kAirLossDbPerCmMax

◆ kAirLossDbPerCmMin

◆ kArchetypeCount

◆ kBaffleStepDb

◆ kBlFalloff

◆ kBlFalloffMax

◆ kBlFalloffMin

◆ kBoxVolumeLDefault

◆ kBoxVolumeLMax

◆ kBoxVolumeLMin

◆ kBreakupGainDbMax

◆ kBreakupModeCount

◆ kBreakupQMax

◆ kBreakupQMin

◆ kBreakupRatioMax

◆ kBreakupRatioMin

◆ kCmsStiffening

◆ kCmsStiffeningMax

◆ kCmsStiffeningMin

◆ kCompressionAmountDefault

◆ kConeBreakupAmountDefault

◆ kControlBlock

◆ kControlBlockMax

◆ kControlBlockMin

◆ kDcBlockerHz

◆ kDcBlockerHzMax