Enum sofiza::Header

pub enum Header {
    Region,
    Group,
    Control,
    Global,
    Curve,
    Effect,
    Master,
    Midi,
    Sample,
}

SFZ files are subdivided into sections by headers.

The global/group/region or global/master/group/region hierarchy contains the opcodes which define which samples are played, when they are to be played, and how.

sfzformat.com/headers/

Variants

Region

The basic component of an instrument. An instrument is defined by one or more regions.

• version: v1
• info: region

Group

Multiple regions can be arranged in a group. Groups allow entering common parameters for multiple regions.

• version: v1
• info: group

Control

The control header would be found at the beginning of the file and includes special opcodes for setting up MIDI CC controls.

• version: v2
• info: control

Global

The global header (one per file), contains opcodes which apply to all regions in the file.

• version: v2
• info: global

Curve

The curve headers, when used, are normally found at the end of the file, and define the curves used for shaping envelopes, parameter response etc.

• version: v2
• info: curve

Effect

SFZ v2 header for effects controls.

In SFZ v1 only effect1 and effect2 opcodes was available and only at ‹region› level.

From SFZ v2 this header was added together with the addition of effect3 and effect4 opcodes also to modulate the related bus. Other opcodes listed in the book are bus, type and dsp_order.

• version: v2
• info: effect

Master

The master header is an extra level added inbetween group and global for the ARIA player.

• version: aria extension
• info: master

Midi

ARIA extension, was added for MIDI pre-processor effects. From ARIA v1.0.8.0+ an ‹effect› section with a bus=midi can be used instead.

• version: aria extension
• info: midi

Sample

Allows to embed sample data directly in SFZ files (Rapture).

• version: cakewalk extension
• info: sample

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl PartialEq<Header> for Header

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Header

impl Eq for Header

impl StructuralEq for Header

impl StructuralPartialEq for Header