Module vital 

The Vital adapter: the .vital JSON format, the parameter registry, the built-in template, the capabilities and the laws that span controls.

Facts come from the Vital 1.0.6 open source (GPL-3.0), restated in our own words and layout; no code or comment of it is copied. The retail app is newer than that source, so a fact carries the build it was read from.

Modules

laws

Vital laws that span several controls: unison spread, LFO tempo rates, pan gains, modulation depth and the amplitude path.

Structs

Keyframe

One keyframe of a wavetable: a frame position and one cycle.

LfoShape

An LFO shape: points with one curve power per point.

VitalFormat

The .vital format.

VitalMapper

Maps layer groups to Vital edits.

VitalModel

A decoded .vital preset.

VitalTemplate

The template rules of Vital.

VitalVersion

A Vital build stamp, major.minor.patch.

Wavetable

A wavetable built from one-cycle keyframes. Frames between keyframes are interpolated by the synth when it loads the table.

Enums

EngineScale

The engine transform of a stored value, applied after modulation adds to it.

Constants

DEFAULT_STAMP

The synth_version stamp of files built from the built-in template: the version of the open source.

EFFECT_ORDER

The effect list of code 0, top to bottom: the order of a new patch.

EFFECT_ORDERS

The number of effect orders, 9!. Codes run from 0 to one less.

FRAME_BASE64_CHARS

Base64 characters of one frame: 8192 bytes with padding.

FRAME_SAMPLES

Samples in one wavetable frame.

MAX_LFO_POINTS

The most points an LFO shape holds.

MAX_POSITION

The highest keyframe position: a table has 257 frames.

MAX_PRESET_BYTES

The largest file the reader accepts: 64 MiB.

OPEN_ENGINE

The engine the render probes of #179 ran on: the open 1.0.x engine through the vita 0.1.0 binding.

RETAIL_BUILD

The stable retail build that written files are checked against: the load check of #181 ran on it. Its saved default state holds every created control at the registry default.

RETAIL_ONLY_KEYS

Keys that retail builds from 1.5 on write and the open source cannot read. A rewrite keeps them.

ROUTE_SOURCES

The 32 modulation source names.

Statics

CAPABILITIES

The structure of Vital, from the 1.0.6 source. The portamento span is 2^-10 s to 2^4 s; the bend range and the velocity amount are the registry defaults of pitch_bend_range and velocity_track.

FORMAT

The Vital format with the default size cap.

MAPPER

The Vital mapper. Each group maps to no edit until its Vital task writes the controls: pitch and envelope through pitch_envelope::map.

Functions

default_polarity

The polarity of a route whose edit names none: bipolar for LFOs, random sources, stereo and pitch_wheel, unipolar for the rest.

effect_order

The effect list of an effect_chain_order code, top to bottom, or None for a code of 9! or more. The inverse of effect_order_code.

effect_order_code

The effect_chain_order code of an effect list, top to bottom.

engine_scale

The engine scale of a Vital key, which modulation adds before.