tek/crates/tek_api/src/api_phrase.rs

use crate::*;

/// A MIDI sequence.
#[derive(Debug, Clone)]
pub struct Phrase {
    pub uuid:        uuid::Uuid,
    /// Name of phrase
    pub name:        String,
    /// Temporal resolution in pulses per quarter note
    pub ppq:         usize,
    /// Length of phrase in pulses
    pub length:      usize,
    /// Notes in phrase
    pub notes:       PhraseData,
    /// Whether to loop the phrase or play it once
    pub loop_on:     bool,
    /// Start of loop
    pub loop_start:  usize,
    /// Length of loop
    pub loop_length: usize,
    /// All notes are displayed with minimum length
    pub percussive:  bool,
    /// Identifying color of phrase
    pub color:       ItemColorTriplet,
}

/// MIDI message structural
pub type PhraseData = Vec<Vec<MidiMessage>>;

impl Phrase {
    pub fn new (
        name:    impl AsRef<str>,
        loop_on: bool,
        length:  usize,
        notes:   Option<PhraseData>,
        color:   Option<ItemColorTriplet>,
    ) -> Self {
        Self {
            uuid:        uuid::Uuid::new_v4(),
            name:        name.as_ref().to_string(),
            ppq:         PPQ,
            length,
            notes:       notes.unwrap_or(vec![Vec::with_capacity(16);length]),
            loop_on,
            loop_start:  0,
            loop_length: length,
            percussive:  true,
            color:       color.unwrap_or_else(ItemColorTriplet::random)
        }
    }
    pub fn duplicate (&self) -> Self {
        let mut clone = self.clone();
        clone.uuid = uuid::Uuid::new_v4();
        clone
    }
    pub fn toggle_loop (&mut self) { self.loop_on = !self.loop_on; }
    pub fn record_event (&mut self, pulse: usize, message: MidiMessage) {
        if pulse >= self.length { panic!("extend phrase first") }
        self.notes[pulse].push(message);
    }
    /// Check if a range `start..end` contains MIDI Note On `k`
    pub fn contains_note_on (&self, k: u7, start: usize, end: usize) -> bool {
        //panic!("{:?} {start} {end}", &self);
        for events in self.notes[start.max(0)..end.min(self.notes.len())].iter() {
            for event in events.iter() {
                if let MidiMessage::NoteOn {key,..} = event { if *key == k { return true } }
            }
        }
        return false
    }
}
impl Default for Phrase {
    fn default () -> Self {
        Self::new("(empty)", false, 0, None, Some(ItemColor::from(Color::Rgb(0, 0, 0)).into()))
    }
}

impl PartialEq for Phrase {
    fn eq (&self, other: &Self) -> bool {
        self.uuid == other.uuid
    }
}

impl Eq for Phrase {}