tek/crates/device/src/clock/clock_model.rs

use crate::*;

#[derive(Clone, Default)]
pub struct Clock {
    /// JACK transport handle.
    pub transport: Arc<Option<tek_engine::jack::Transport>>,
    /// Global temporal resolution (shared by [Moment] fields)
    pub timebase:  Arc<Timebase>,
    /// Current global sample and usec (monotonic from JACK clock)
    pub global:    Arc<Moment>,
    /// Global sample and usec at which playback started
    pub started:   Arc<RwLock<Option<Moment>>>,
    /// Playback offset (when playing not from start)
    pub offset:    Arc<Moment>,
    /// Current playhead position
    pub playhead:  Arc<Moment>,
    /// Note quantization factor
    pub quant:     Arc<Quantize>,
    /// Launch quantization factor
    pub sync:      Arc<LaunchSync>,
    /// Size of buffer in samples
    pub chunk:     Arc<AtomicUsize>,
    /// For syncing the clock to an external source
    pub midi_in:   Arc<RwLock<Option<MidiInput>>>,
    /// For syncing other devices to this clock
    pub midi_out:  Arc<RwLock<Option<MidiOutput>>>,
    /// For emitting a metronome
    pub click_out: Arc<RwLock<Option<AudioOutput>>>,
    // Cache of formatted strings
    pub view_cache: Arc<RwLock<ViewCache>>,
}

impl std::fmt::Debug for Clock {
    fn fmt (&self, f: &mut Formatter<'_>) -> std::result::Result<(), std::fmt::Error> {
        f.debug_struct("Clock")
            .field("timebase", &self.timebase)
            .field("chunk",    &self.chunk)
            .field("quant",    &self.quant)
            .field("sync",     &self.sync)
            .field("global",   &self.global)
            .field("playhead", &self.playhead)
            .field("started",  &self.started)
            .finish()
    }
}

impl Clock {
    pub fn new (jack: &Jack<'static>, bpm: Option<f64>) -> Usually<Self> {
        let (chunk, transport) = jack.with_client(|c|(c.buffer_size(), c.transport()));
        let timebase = Arc::new(Timebase::default());
        let clock = Self {
            quant:     Arc::new(24.into()),
            sync:      Arc::new(384.into()),
            transport: Arc::new(Some(transport)),
            chunk:     Arc::new((chunk as usize).into()),
            global:    Arc::new(Moment::zero(&timebase)),
            playhead:  Arc::new(Moment::zero(&timebase)),
            offset:    Arc::new(Moment::zero(&timebase)),
            started:   RwLock::new(None).into(),
            timebase,
            midi_in:   Arc::new(RwLock::new(Some(MidiInput::new(jack,   &"M/clock", &[])?))),
            midi_out:  Arc::new(RwLock::new(Some(MidiOutput::new(jack,  &"clock/M", &[])?))),
            click_out: Arc::new(RwLock::new(Some(AudioOutput::new(jack, &"click",   &[])?))),
            ..Default::default()
        };
        if let Some(bpm) = bpm {
            clock.timebase.bpm.set(bpm);
        }
        Ok(clock)
    }
    pub fn timebase (&self) -> &Arc<Timebase> {
        &self.timebase
    }
    /// Current sample rate
    pub fn sr (&self) -> &SampleRate {
        &self.timebase.sr
    }
    /// Current tempo
    pub fn bpm (&self) -> &BeatsPerMinute {
        &self.timebase.bpm
    }
    /// Current MIDI resolution
    pub fn ppq (&self) -> &PulsesPerQuaver {
        &self.timebase.ppq
    }
    /// Next pulse that matches launch sync (for phrase switchover)
    pub fn next_launch_pulse (&self) -> usize {
        let sync  = self.sync.get() as usize;
        let pulse = self.playhead.pulse.get() as usize;
        if pulse % sync == 0 {
            pulse
        } else {
            (pulse / sync + 1) * sync
        }
    }
    /// Start playing, optionally seeking to a given location beforehand
    pub fn play_from (&self, start: Option<u32>) -> Usually<()> {
        if let Some(transport) = self.transport.as_ref() {
            if let Some(start) = start {
                transport.locate(start)?;
            }
            transport.start()?;
        }
        Ok(())
    }
    /// Pause, optionally seeking to a given location afterwards
    pub fn pause_at (&self, pause: Option<u32>) -> Usually<()> {
        if let Some(transport) = self.transport.as_ref() {
            transport.stop()?;
            if let Some(pause) = pause {
                transport.locate(pause)?;
            }
        }
        Ok(())
    }
    /// Is currently paused?
    pub fn is_stopped (&self) -> bool {
        self.started.read().unwrap().is_none()
    }
    /// Is currently playing?
    pub fn is_rolling (&self) -> bool {
        self.started.read().unwrap().is_some()
    }
    /// Update chunk size
    pub fn set_chunk (&self, n_frames: usize) {
        self.chunk.store(n_frames, Relaxed);
    }
    pub fn update_from_scope (&self, scope: &ProcessScope) -> Usually<()> {
        // Store buffer length
        self.set_chunk(scope.n_frames() as usize);

        // Store reported global frame and usec
        let tek_engine::jack::CycleTimes { current_frames, current_usecs, .. } = scope.cycle_times()?;
        self.global.sample.set(current_frames as f64);
        self.global.usec.set(current_usecs as f64);

        let mut started = self.started.write().unwrap();

        // If transport has just started or just stopped,
        // update starting point:
        if let Some(transport) = self.transport.as_ref() {
            match (transport.query_state()?, started.as_ref()) {
                (TransportState::Rolling, None) => {
                    let moment = Moment::zero(&self.timebase);
                    moment.sample.set(current_frames as f64);
                    moment.usec.set(current_usecs as f64);
                    *started = Some(moment);
                },
                (TransportState::Stopped, Some(_)) => {
                    *started = None;
                },
                _ => {}
            };
        }

        self.playhead.update_from_sample(started.as_ref()
            .map(|started|current_frames as f64 - started.sample.get())
            .unwrap_or(0.));

        Ok(())
    }

    pub fn bbt (&self) -> tek_engine::jack::PositionBBT {
        let pulse = self.playhead.pulse.get() as i32;
        let ppq   = self.timebase.ppq.get() as i32;
        let bpm   = self.timebase.bpm.get();
        let bar   = (pulse / ppq) / 4;
        tek_engine::jack::PositionBBT {
            bar:              1 + bar,
            beat:             1 + (pulse / ppq) % 4,
            tick:             (pulse % ppq),
            bar_start_tick:   (bar * 4 * ppq) as f64,
            beat_type:        4.,
            beats_per_bar:    4.,
            beats_per_minute: bpm,
            ticks_per_beat:   ppq as f64
        }
    }

    pub fn next_launch_instant (&self) -> Moment {
        Moment::from_pulse(self.timebase(), self.next_launch_pulse() as f64)
    }

    /// Get index of first sample to populate.
    ///
    /// Greater than 0 means that the first pulse of the clip
    /// falls somewhere in the middle of the chunk.
    pub fn get_sample_offset (&self, scope: &ProcessScope, started: &Moment) -> usize{
        (scope.last_frame_time() as usize).saturating_sub(
            started.sample.get() as usize +
            self.started.read().unwrap().as_ref().unwrap().sample.get() as usize
        )
    }

    // Get iterator that emits sample paired with pulse.
    //
    // * Sample: index into output buffer at which to write MIDI event
    // * Pulse: index into clip from which to take the MIDI event
    //
    // Emitted for each sample of the output buffer that corresponds to a MIDI pulse.
    pub fn get_pulses (&self, scope: &ProcessScope, offset: usize) -> TicksIterator {
        self.timebase().pulses_between_samples(offset, offset + scope.n_frames() as usize)
    }
}