Struct klib::core::note::Note

pub struct Note { /* private fields */ }

A note type.

This is a named pitch with an octave. This type allows for correctly attributing octave changes across an interval from one Note to another.

Implementations

impl Note

pub fn new(pitch: NamedPitch, octave: Octave) -> Self

Creates a new Note from the given NamedPitch and Octave.

impl Note

pub async fn try_from_mic(length_in_seconds: u8) -> Res<Vec<Note>>

Attempts to use the default microphone to listen to audio for the specified time to identify the notes in the recorded audio.

Currently, this does not work with WASM.

pub fn try_from_audio(data: &[f32], length_in_seconds: u8) -> Res<Vec<Note>>

Attempts to use the provided to identify the notes in the audio data.

pub async fn try_from_mic_ml(length_in_seconds: u8) -> Res<Vec<Self>>

Attempts to use the default microphone to listen to audio for the specified time to identify the notes in the recorded audio using ML.

Currently, this does not work with WASM.

pub fn try_from_audio_ml(data: &[f32], length_in_seconds: u8) -> Res<Vec<Self>>

Attempts to use the provided to identify the notes in the audio data using ML.

Trait Implementations

impl Add<Interval> for Note

type Output = Note

The resulting type after applying the + operator.

fn add(self, rhs: Interval) -> Self::Output

Performs the + operation.

impl AddAssign<Interval> for Note

fn add_assign(&mut self, rhs: Interval)

Performs the += operation.

impl Clone for Note

fn clone(&self) -> Note

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Note

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Note

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

Formats the value using the given formatter.

impl HasFrequency for Note

fn frequency(&self) -> f32

Returns the frequency of the type (usually a [Note]).

fn frequency_range(&self) -> (f32, f32)

Returns the frequency range of the type (usually a [Note]). Essentially, mid way between the frequency and the next frequency on either side.

fn tight_frequency_range(&self) -> (f32, f32)

Returns the tight frequency range of the type (usually a [Note]). Essentially, 1/8 the way between the frequency and the next frequency on either side.

impl HasName for Note

fn name(&self) -> String

Returns the computed name of the type.

impl HasNamedPitch for Note

fn named_pitch(&self) -> NamedPitch

Returns the named pitch of the type.

impl HasNoteId for Note

fn id(self) -> u128

Returns the ID of the note.

fn id_index(self) -> u8

Returns the position of the 1 for the ID of the note.

fn from_id(id: u128) -> Res<Self>

Returns the note from the given ID.

fn id_mask(notes: &[Self]) -> u128

where Self: Sized,

Returns the ID mask for the given notes.

fn from_id_mask(id_mask: u128) -> Res<Vec<Self>>

where Self: Sized,

Returns the notes from the given ID mask.

impl HasOctave for Note

fn octave(&self) -> Octave

Returns the octave of the type.

impl HasPitch for Note

fn pitch(&self) -> Pitch

Returns the pitch of the type (usually a [Note]).

impl HasPrimaryHarmonicSeries for Note

fn primary_harmonic_series(self) -> Vec<Self>

Returns the primary harmonic series of the note.

impl HasStaticName for Note

fn static_name(&self) -> &'static str

Returns the static name of the type.

impl Hash for Note

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoChord for Note

fn into_chord(self) -> Chord

Converts this type into a Chord (usually a Note).

impl NoteRecreator for Note

fn with_named_pitch(self, named_pitch: NamedPitch) -> Self

Recreates this Note with the given NamedPitch.

fn with_octave(self, octave: Octave) -> Self

Recreates this Note with the given Octave.

impl Ord for Note

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl Parsable for Note

fn parse(input: &str) -> Res<Self>

where Self: Sized,

Parses the type from a string.

impl PartialEq for Note

fn eq(&self, other: &Note) -> 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 PartialOrd for Note

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Note

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Interval> for Note

type Output = Note

The resulting type after applying the - operator.

fn sub(self, rhs: Interval) -> Self::Output

Performs the - operation.

impl Sub for Note

type Output = Interval

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl ToUniversal for Note

fn to_universal(self) -> Note

Converts this note to a universal pitch.

impl Copy for Note

impl Eq for Note

impl StructuralEq for Note

impl StructuralPartialEq for Note