Struct xsynth_core::channel_group::ParallelismOptions

pub struct ParallelismOptions {
    pub channel: ThreadCount,
    pub key: ThreadCount,
}

Options regarding which parts of the ChannelGroup should be multithreaded.

Responsibilities of a channel: processing input events for the channel, dispatching per-key rendering of audio, applying filters to the final channel’s audio

Responsibilities of a key: Rendering per-voice audio for all the voices stored in a key for a channel. This is generally the most compute intensive part of the synth.

Best practices:

• As there are often 16 channels in MIDI, per-key multithreading can balance out the load more evenly between CPU cores.
• However, per-key multithreading adds some overhead, so if the synth is invoked to render very small sample counts each time (e.g. sub 1 millisecond), not using per-key multithreading becomes more efficient.

Fields

channel: ThreadCount

Render the MIDI channels parallel in a threadpool with the specified thread count.

key: ThreadCount

Render the individisual keys of each channel parallel in a threadpool with the specified thread count.

Implementations

impl ParallelismOptions

pub const AUTO_PER_KEY: Self = _

pub const AUTO_PER_CHANNEL: Self = _

Trait Implementations

impl Clone for ParallelismOptions

fn clone(&self) -> ParallelismOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParallelismOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ParallelismOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ParallelismOptions

fn eq(&self, other: &ParallelismOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ParallelismOptions

impl StructuralPartialEq for ParallelismOptions