Struct AudityExecContext

Everything a table-dispatched node’s exec function may touch this block. DarkEffekt.Audity.AudityExecContext.engine is the executor state (engine-internal; built-in defs reach it via Engine()). Deliberately absent: the control pipe and generator arguments - they are ref structs that cannot cross the function-pointer boundary, so the nodes that need them (Output, WavePlayer) run as direct engine calls instead of through the table.

Assembly: DarkEffekt.Audity.Runtime

Declaration

public struct AudityExecContext

Properties

SampleRate

Engine sample rate for this instance.

Declaration

public int SampleRate { get; }

LocalFrame

The instance’s local sample clock: engine frames since instance start, at this block’s first frame. Trigger frame offsets are relative to this, so LocalFrame + offset is a trigger’s absolute local time.

Declaration

public long LocalFrame { get; }

MaxTriggersPerBlock

Upper bound of trigger offsets a pin can carry per block.

Declaration

public static int MaxTriggersPerBlock { get; }

Stopping

True once the instance has been asked to stop. Terminal: it never clears. A node that schedules future triggers (a repeater, a delay line’s pending list) must check this each block and cancel its schedule, or it will keep conjuring sound under the stop fade.

Declaration

public bool Stopping { get; }

Random

The instance’s deterministic random stream, shared by every random node and consumed in executor order: the same program with the same seed replays the same values (the sonic-stability contract). Draw only from exec, never speculatively - an extra draw shifts every consumer after you.

Declaration

public ref Random Random { get; }

InstanceSeed

The instance’s seed (pinned by the author or salted per play). For a node that wants a PRIVATE random stream instead of DarkEffekt.Audity.AudityExecContext.Random: keep a Random in your State<T>, and on first exec seed it from a hash of this and something node-local. A private stream survives graph edits that would reorder the shared stream’s draws.

Declaration

public uint InstanceSeed { get; }

Fields

realtimeContext

Declaration

public RealtimeContext realtimeContext

frames

Declaration

public int frames

firstBlock

Declaration

public byte firstBlock

DefaultStateBytes

Default per-node state size in bytes when a def does not override DarkEffekt.Audity.AudityNodeDef.StateBytes: 16 floats, the classic DarkEffekt.Audity.AudityExecContext.UserState(DarkEffekt.Audity.AudityNodeDesc%40) scratch.

Declaration

public const int DefaultStateBytes = 64

Methods

SecondsToFrames(float)

Seconds to engine frames, the way every built-in seconds-valued input reads: NaN/Inf/negative collapse to 0, single-precision multiply (authored periods round the way the engine always rounded them), capped short of overflow.

Declaration

public long SecondsToFrames(float seconds)

Returns

System.Int64

Parameters

Type	Name
System.Single	seconds

ReadFloat(in AudityNodeDesc, int)

A float input pin’s block-rate value (fallback when unconnected).

Declaration

public float ReadFloat(in AudityNodeDesc node, int inputPin)

Returns

System.Single

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	inputPin

ReadFloat(in AudityNodeDesc, int, float, float)

DarkEffekt.Audity.AudityExecContext.ReadFloat(DarkEffekt.Audity.AudityNodeDesc%40%2cSystem.Int32) clamped to the pin’s safe operating range. Wires can carry anything (LFO excursions, math results, live parameters) - the authoring-side [Range] only bounds the inline default, so sanitize every wired read against the DSP’s real limits, which may be wider than the authoring hint (e.g. a filter’s stability bound).

Declaration

public float ReadFloat(in AudityNodeDesc node, int inputPin, float min, float max)

Returns

System.Single

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	inputPin
System.Single	min
System.Single	max

ReadRamp(in AudityNodeDesc, int, float, out float, out float)

Reads a float input as a block ramp - the engine-standard zipper for click-free block-rate parameter moves. current is the value to apply this block (already transformed - dB to linear, clamped, whatever the node’s law is); start comes back as the previous block’s applied value (or current on the first read, so nothing sweeps in from silence) and end as current, which is recorded for the next block.

Declaration

public void ReadRamp(in AudityNodeDesc node, int inputPin, float current, out float start, out float end)

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	inputPin
System.Single	current
System.Single	start
System.Single	end

WriteFloat(in AudityNodeDesc, int, float)

Writes a float output pin’s block-rate value.

Declaration

public void WriteFloat(in AudityNodeDesc node, int outputPin, float value)

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	outputPin
System.Single	value

ReadVec(in AudityNodeDesc, int, out int)

A Float input pin read at its resolved width (unused lanes 0), adapting the producer Shader Graph-style: scalars splat, narrower pads 0, wider truncates.

Declaration

public float4 ReadVec(in AudityNodeDesc node, int inputPin, out int width)

Returns

Unity.Mathematics.float4

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	inputPin
System.Int32	width

WriteVec(in AudityNodeDesc, int, float4, int)

Writes a Float output pin’s first width lanes (the pin’s resolved width).

Declaration

public void WriteVec(in AudityNodeDesc node, int outputPin, float4 value, int width)

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	outputPin
Unity.Mathematics.float4	value
System.Int32	width

OutWidth(in AudityNodeDesc, int)

Resolved value width of a Float output pin.

Declaration

public int OutWidth(in AudityNodeDesc node, int outputPin)

Returns

System.Int32

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	outputPin

ValueOut(in AudityNodeDesc, int)

A Float output pin’s lanes as writable memory - the wide counterpart of DarkEffekt.Audity.AudityExecContext.WriteVec(DarkEffekt.Audity.AudityNodeDesc%40%2cSystem.Int32%2cUnity.Mathematics.float4%2cSystem.Int32), for pins past the 4 a float4 holds (a Spectrum Analyzer’s bands). The span is exactly the pin’s resolved width; every lane is the exec’s to fill, and stale lanes are never cleared for you.

Declaration

public Span<float> ValueOut(in AudityNodeDesc node, int outputPin)

Returns

System.Span<System.Single>

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	outputPin

ReadValues(in AudityNodeDesc, int, Span<float>)

Copies a Float input pin’s lanes into dest and returns how many it wrote - the wide counterpart of DarkEffekt.Audity.AudityExecContext.ReadVec(DarkEffekt.Audity.AudityNodeDesc%40%2cSystem.Int32%2cSystem.Int32%40), adapting the producer by the same rules (scalars splat across the whole span, narrower pads 0, wider truncates to dest’s length). Size dest with DarkEffekt.Audity.AudityNodeSpec.MaxValueWidth when the width is not known up front.

Declaration

public int ReadValues(in AudityNodeDesc node, int inputPin, Span<float> dest)

Returns

System.Int32

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	inputPin
System.Span<System.Single>	dest

AudioIn(in AudityNodeDesc, int, out int)

An audio input pin’s interleaved block (frames × channels); empty when the pin is unconnected (render silence or pass through, per node policy).

Declaration

public Span<float> AudioIn(in AudityNodeDesc node, int inputPin, out int channels)

Returns

System.Span<System.Single>

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	inputPin
System.Int32	channels

AudioOut(in AudityNodeDesc, int, out int)

An audio output pin’s interleaved block (frames × channels).

Declaration

public Span<float> AudioOut(in AudityNodeDesc node, int outputPin, out int channels)

Returns

System.Span<System.Single>

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	outputPin
System.Int32	channels

GatherTriggers(in AudityNodeDesc, int, Span<int>)

Collects a trigger input pin’s frame offsets for this block, ascending. Size frameOffsets with DarkEffekt.Audity.AudityExecContext.MaxTriggersPerBlock.

Declaration

public int GatherTriggers(in AudityNodeDesc node, int inputPin, Span<int> frameOffsets)

Returns

System.Int32

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	inputPin
System.Span<System.Int32>	frameOffsets

EmitTrigger(in AudityNodeDesc, int, int)

Emits on a trigger output pin at a frame offset within this block.

Declaration

public void EmitTrigger(in AudityNodeDesc node, int outputPin, int frameOffset)

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	outputPin
System.Int32	frameOffset

NodeParam(in AudityNodeDesc, int)

A value from this node’s param blob (layout is the def’s contract).

Declaration

public float NodeParam(in AudityNodeDesc node, int index)

Returns

System.Single

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	index

NodeParams(in AudityNodeDesc)

This node’s whole param blob (layout is the def’s contract).

Declaration

public ReadOnlySpan<float> NodeParams(in AudityNodeDesc node)

Returns

System.ReadOnlySpan<System.Single>

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node

NodeParamCount(in AudityNodeDesc)

Number of floats in this node’s param blob.

Declaration

public int NodeParamCount(in AudityNodeDesc node)

Returns

System.Int32

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node

State<T>(in AudityNodeDesc)

This node’s per-instance DSP state, reinterpreted as T (phase accumulators, filter memories, envelope stages). Zeroed at instance start; persists across blocks for the life of the instance. The def declares the size via DarkEffekt.Audity.AudityNodeDef.StateBytes; T must fit inside it. Layout is the def’s own contract with itself.

Declaration

public ref T State<T>(in AudityNodeDesc node) where T : unmanaged

Returns

<T>

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node

Type Parameters

• T

UserState(in AudityNodeDesc)

This node’s per-instance DSP state as floats (DarkEffekt.Audity.AudityNodeDef.StateBytes / 4 of them; 16 by default). The untyped view of the same memory DarkEffekt.Audity.AudityExecContext.State%60%601(DarkEffekt.Audity.AudityNodeDesc%40) reinterprets - use whichever fits the node.

Declaration

public Span<float> UserState(in AudityNodeDesc node)

Returns

System.Span<System.Single>

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node

DspRegion(in AudityNodeDesc)

This node’s DSP-pool region: DarkEffekt.Audity.AudityNodeDef.DspSecondsPerChannel(System.Single%5b%5d) seconds per resolved channel of float memory (delay lines, reverb tanks), sized at Configure. Empty when the def declares none. Contents survive across blocks; layout inside the region is the exec’s own business.

Declaration

public Span<float> DspRegion(in AudityNodeDesc node)

Returns

System.Span<System.Single>

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node

HoldFinish()

Declares this node still-active for this block’s finish gate: a non-idle envelope, a scheduled future trigger, a running repeater. A finite instance will not finish during a block in which any node held it. The engine clears the hold before each block’s exec - assert it every block the condition holds.

Declaration

public void HoldFinish()

ReportDroppedTriggers(int)

Counts triggers this node had to drop (per-block capacity overflow, see DarkEffekt.Audity.AudityExecContext.MaxTriggersPerBlock) into the instance’s telemetry.

Declaration

public void ReportDroppedTriggers(int count)

Parameters

Type	Name
System.Int32	count

HoldTail(long)

Holds a finite instance open for tailFrames engine frames past the start of this block: an effect whose memory still carries audible signal (an echo not yet landed, a decaying tank) reports its tail here so the instance cannot finish out from under it. Re-arm every block while the tail is audible; the hold lapses on its own once you stop.

Declaration

public void HoldTail(long tailFrames)

Parameters

Type	Name
System.Int64	tailFrames

SpawnVoice(in AudityNodeDesc, int)

Requests a voice for this player, starting at startFrame within the block (sample-accurate). When the pool is full the declared steal policy applies. Returns an invalid handle if refused (Reject policy) or the node is not a voice-player. Per-voice scratch (DarkEffekt.Audity.AudityExecContext.VoiceState(DarkEffekt.Audity.AudityVoiceHandle)) is zeroed on spawn.

Declaration

public AudityVoiceHandle SpawnVoice(in AudityNodeDesc node, int startFrame)

Returns

DarkEffekt.Audity.AudityVoiceHandle

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node
System.Int32	startFrame

FinishVoice(AudityVoiceHandle)

Retires a voice, freeing its pool slot. Emit any onFinished trigger yourself (via DarkEffekt.Audity.AudityExecContext.EmitTrigger(DarkEffekt.Audity.AudityNodeDesc%40%2cSystem.Int32%2cSystem.Int32)) before calling this.

Declaration

public void FinishVoice(AudityVoiceHandle voice)

Parameters

Type	Name
DarkEffekt.Audity.AudityVoiceHandle	voice

LiveVoices(in AudityNodeDesc)

Enumerates this player’s currently-playing voices (foreach-able, no allocation).

Declaration

public AudityVoiceEnumerator LiveVoices(in AudityNodeDesc node)

Returns

DarkEffekt.Audity.AudityVoiceEnumerator

Parameters

Type	Name
DarkEffekt.Audity.AudityNodeDesc	node

VoiceState(AudityVoiceHandle)

Per-voice scratch (DarkEffekt.Audity.WaveVoice.VoiceUserFloats floats, zeroed on spawn) - the voice’s phase, envelope, pitch, etc. Persists while the voice lives.

Declaration

public Span<float> VoiceState(AudityVoiceHandle voice)

Returns

System.Span<System.Single>

Parameters

Type	Name
DarkEffekt.Audity.AudityVoiceHandle	voice

VoiceStartFrame(AudityVoiceHandle)

The block-frame offset at which this voice starts rendering this block (its spawn offset on the first block; 0 thereafter).

Declaration

public int VoiceStartFrame(AudityVoiceHandle voice)

Returns

System.Int32

Parameters

Type	Name
DarkEffekt.Audity.AudityVoiceHandle	voice