Skip to content

EPOK RUNTIME

Instrument Synth

instrument_synth.hpp · the instrument synth module

Module

the instrument synth module.

Header: instrument_synth.hpp
Include: #include "instrument_synth.hpp"
Stability: Epok runtime API

Include this module

C++ include

#include "instrument_synth.hpp"

Types

AttenuationTableStruct declared by the instrument-synth module for the instrument synth module.Struct ControlsStruct declared by the instrument-synth module for the instrument synth module.Struct ErrorEnum declared by the instrument-synth module for the instrument synth module.Enum OctaveTableOne-cent knots, generated at compile time.Struct OutputStruct declared by the instrument-synth module for the instrument synth module.Struct StateClass declared by the instrument-synth module for the instrument synth module.Class

Functions and methods

activePerforms `active` as part of the instrument synth module.Method advancePerforms `advance` as part of the instrument synth module.Method advance_phasePerforms `advance phase` as part of the instrument synth module.Function attenuation_for_gain_q16Performs `attenuation for gain q16` as part of the instrument synth module.Function attenuation_gain_q15Performs `attenuation gain q15` as part of the instrument synth module.Function AttenuationTableConstructs `epok::instrument::synth::detail::AttenuationTable` for the instrument synth module.constructor clampPerforms `clamp` as part of the instrument synth module.Function concavePerforms `concave` as part of the instrument synth module.Function ControlsConstructs `epok::instrument::synth::Controls` for the instrument synth module.constructor convexPerforms `convex` as part of the instrument synth module.Function copy_blockPerforms `copy block` as part of the instrument synth module.Function template copy_initialThe immutable prepared source must outlive this voice, like its bank.Method copy_valuePerforms `copy value` as part of the instrument synth module.Function template errorPerforms `error` as part of the instrument synth module.Method fast_pow2_cents_q30Performs `fast pow2 cents q30` as part of the instrument synth module.Function gain_at_whole_centibelPerforms `gain at whole centibel` as part of the instrument synth module.Function lfo_rate_q48Performs `lfo rate q48` as part of the instrument synth module.Function local_bank_spanPerforms `local bank span` as part of the instrument synth module.Function OctaveTableConstructs `epok::instrument::synth::detail::OctaveTable` for the instrument synth module.constructor outputPerforms `output` as part of the instrument synth module.Method pow2_cents_q30Tenth-order integer exp2 on [0,1), followed by an integral power-of-two.Function releasePerforms `release` as part of the instrument synth module.Method resetResets reset as part of the instrument synth module.Method same_controlsPerforms `same controls` as part of the instrument synth module.Function scale_q15Performs `scale q15` as part of the instrument synth module.Function source_changedPerforms `source changed` as part of the instrument synth module.Function source_q30Performs `source q30` as part of the instrument synth module.Function start`bank.data` must outlive this state.Method start_validatedPSX loader has validated the immutable bank and the kernel has validated controls/note data.Method start_voiceHost source-preview adapters may construct the same neutral wire structs without fabricating an EPSB container.Method StateConstructs `epok::instrument::synth::State` for the instrument synth module.constructor time_microsecondsPerforms `time microseconds` as part of the instrument synth module.Function triangle_q15Performs `triangle q15` as part of the instrument synth module.Function update_controlsUpdates controls as part of the instrument synth module.Method validPerforms `valid` as part of the instrument synth module.Method

Fields, variables and values

ArithmeticOverflowNamed value `ArithmeticOverflow` in `epok::instrument::synth::Error`.Enum value attenuation_tableExposes `attenuation_table` on the `epok::instrument::synth::detail` namespace for the instrument synth module.Variable bendExposes `bend` on `epok::instrument::synth::Controls` for the instrument synth module.Field bend_range_centsExposes `bend_range_cents` on `epok::instrument::synth::Controls` for the instrument synth module.Field ccExposes `cc` on `epok::instrument::synth::Controls` for the instrument synth module.Field channel_pressureExposes `channel_pressure` on `epok::instrument::synth::Controls` for the instrument synth module.Field coarse_tuningExposes `coarse_tuning` on `epok::instrument::synth::Controls` for the instrument synth module.Field concave_q30SF2 2.04 section 8.2.4's 96 dB concave curve sampled at every native seven-bit input.Variable fine_tuningExposes `fine_tuning` on `epok::instrument::synth::Controls` for the instrument synth module.Field finishedExposes `finished` on `epok::instrument::synth::Output` for the instrument synth module.Field gain_q15Exposes `gain_q15` on `epok::instrument::synth::Output` for the instrument synth module.Field InvalidBankNamed value `InvalidBank` in `epok::instrument::synth::Error`.Enum value InvalidControlsNamed value `InvalidControls` in `epok::instrument::synth::Error`.Enum value InvalidNoteNamed value `InvalidNote` in `epok::instrument::synth::Error`.Enum value InvalidZoneNamed value `InvalidZone` in `epok::instrument::synth::Error`.Enum value modulation_envelope_q15Neutral control signals for host-only dynamic filter preview.Field modulation_lfo_q15Exposes `modulation_lfo_q15` on `epok::instrument::synth::Output` for the instrument synth module.Field NoneNamed value `None` in `epok::instrument::synth::Error`.Enum value octave_tableExposes `octave_table` on the `epok::instrument::synth::detail` namespace for the instrument synth module.Variable pan_permilleExposes `pan_permille` on `epok::instrument::synth::Output` for the instrument synth module.Field pitch_cents_x100One unit is 0.01 cent.Field poly_pressureExposes `poly_pressure` on `epok::instrument::synth::Controls` for the instrument synth module.Field q16Exposes `q16` on the `epok::instrument::synth::detail` namespace for the instrument synth module.Variable q30Exposes `q30` on the `epok::instrument::synth::detail` namespace for the instrument synth module.Variable reservedNatural word alignment for bounded PSX copies.Field reverb_send_permilleExposes `reverb_send_permille` on `epok::instrument::synth::Output` for the instrument synth module.Field UnsupportedDestinationNamed value `UnsupportedDestination` in `epok::instrument::synth::Error`.Enum value valuesExposes `values` on `epok::instrument::synth::detail::AttenuationTable` for the instrument synth module.Field valuesExposes `values` on `epok::instrument::synth::detail::OctaveTable` for the instrument synth module.Field vibrato_lfo_q15Exposes `vibrato_lfo_q15` on `epok::instrument::synth::Output` for the instrument synth module.Field