Crate knyst

Knyst - audio graph and synthesis library

Knyst is a real time audio synthesis framework focusing on flexibility and performance. It’s main target use case is desktop multi-threaded real time environments, but it can also do single threaded and/or non real time synthesis. Embedded platforms are currently not supported, but on the roadmap.

The main selling point of Knyst is that the graph can be modified while it’s running: nodes and connections between nodes can be added/removed. It also supports shared resources such as wavetables and buffers.

Status

Knyst is in its early stages. Expect large breaking API changes between versions.

The name

“Knyst” is a Swedish word meaning very faint sound.

Architecture

The core of Knyst is the Graph struct and the Gen trait. Graphs can have nodes containing anything that implements Gen. Graphs can also themselves be added as a node.

Nodes in a running Graph can be freed or signal to the Graph that they or the entire Graph should be freed. Connections between Nodes and the inputs and outputs of a Graph can also be changed while the Graph is running. This way, Knyst acheives a similar flexibility to SuperCollider.

It is easy to get things wrong when using a Graph as a Gen directly so that functionality is encapsulated. For the highest level Graph of your program you may want to use RunGraph to get a node which you can run in a real time thread or non real time to generate samples. Using the audio_backends this process is automated for you.

Modules

• audio_backend
  Audio backends for getting up and running quickly. To use the backends in this module you need to enable either the jack or the cpal feature.
• buffer
  Loading sound files and other data and reading from them. Module containing buffer functionality:
• controller
  API for interacting with a running top level Graph from any number of threads without having to manually keep track of running Graph::update regularly.
• envelope
  A pretty barebones Envelope Gen
• graph
  Graph is the audio graph, the core of Knyst. Implement Gen and you can be a Node.
• prelude
  Exports the most often used parts of Knyst
• scheduling
  This module contains things related to scheduling that are more generic than graph internals.
• time
  Structs for dealing with time with determinism and high accuracy in seconds and beats.
• trig
  Triggers
• wavetable
  Wavetable synthesis
• xorrng
  Simple pseudorandom number generator

Macros

• inputs
  Create an InputBundle using the syntax

Structs

• BufferId
  A unique id for a Buffer. Can be converted to a BufferKey by the Resources.
• Resources
  Common resources for all Nodes in a Graph and all its sub Graphs:
• ResourcesSettings
  Settings used to initialise Resources.
• WavetableId
  A unique id for a Wavetable. Can be converted to a WavetableKey by the Resources.

Enums

• IdOrKey
  Used for holding either an Id (user facing identifier) or Key (internal identifier) for certain APIs.
• KnystError
  Combined error type for Knyst, containing any other error in the library.
• ResourcesCommand
  Command to modify the Resources instance while it is being used on the audio thread. Prefer the methods on [KnystCommands] to making these directly.
• ResourcesError
  Error from changing a Resources
• ResourcesResponse
  Response to a ResourcesCommand. Usually used to send anything that deallocates away from the audio thread, but also reports any errors.
• StopAction
  Specify what happens when a Gen is done with its processing. This translates to a GenState being returned from the Gen, but without additional parameters.

Traits

• AnyData
  Trait for

Functions

• amplitude_to_db
  Convert amplitude to db
• db_to_amplitude
  Convert db to amplitude

Type Definitions

• Sample
  The current sample type used throughout Knyst