Skip to main content

PitchRemap

Enum PitchRemap 

Source
pub enum PitchRemap {
    Chromatic(i32),
    ScaleDegree {
        scale: Scale,
        steps: i32,
    },
    PitchClass {
        from: PitchClass,
        to: PitchClass,
    },
    DrumKey(BTreeMap<u8, u8>),
    ChordTone {
        scale: Scale,
        degree: usize,
    },
    Tuning(TuningRemap),
    Vector {
        scale: Scale,
        offsets: Vec<i32>,
    },
    Matrix {
        scale: Scale,
        matrix: IntMatrix,
    },
    Callable(CallablePitchMap),
    Map(PitchMap),
}
Expand description

A pitch remapping strategy applied note by note across material.

Variants§

§

Chromatic(i32)

Shift every pitch by a fixed number of semitones.

§

ScaleDegree

Transpose by scale degrees within scale.

Fields

§scale: Scale

Scale that defines the diatonic steps.

§steps: i32

Number of scale degrees to move.

§

PitchClass

Replace one pitch class with another, keeping the octave.

Fields

§from: PitchClass

Pitch class to match.

§to: PitchClass

Pitch class to substitute.

§

DrumKey(BTreeMap<u8, u8>)

Remap MIDI drum keys via an explicit key-to-key table.

§

ChordTone

Snap each pitch to the nearest tone of a chord built on scale.

Fields

§scale: Scale

Scale the chord is drawn from.

§degree: usize

Chord degree within the scale.

§

Tuning(TuningRemap)

Apply a microtonal tuning offset.

§

Vector

Offset each pitch by a per-degree vector of semitone offsets.

Fields

§scale: Scale

Scale used to find each pitch’s degree.

§offsets: Vec<i32>

Per-degree semitone offsets, indexed cyclically.

§

Matrix

Apply an integer affine IntMatrix over (degree, octave).

Fields

§scale: Scale

Scale used to resolve degrees.

§matrix: IntMatrix

Transformation matrix.

§

Callable(CallablePitchMap)

Apply a named CallablePitchMap.

§

Map(PitchMap)

Apply a first-class partial pitch map.

Implementations§

Source§

impl PitchRemap

Source

pub fn apply(&self, object: &dyn MusicObject) -> Result<Music, TransformError>

Applies the remap and returns just the music, discarding diagnostics.

Source

pub fn apply_report( &self, object: &dyn MusicObject, ) -> Result<TransformReport, TransformError>

Applies the remap, returning the music together with any diagnostics.

Source

pub fn as_pitch_map(&self) -> Option<PitchMap>

Returns this remap as a composable pitch map when it is static and expressible in the integer pitch-map domain.

Trait Implementations§

Source§

impl Clone for PitchRemap

Source§

fn clone(&self) -> PitchRemap

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PitchRemap

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for PitchRemap

Source§

impl PartialEq for PitchRemap

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PitchRemap

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> RealizationService for T
where T: Any + Send + Sync,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Returns a downcast hook for typed access.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.