Struct JamSyncController 

pub struct JamSyncController { /* private fields */ }

Controller that synchronises a local timecode generator to an external timecode reference.

State machine

WaitingForReference ──(first feed_reference)──► Locking
      ▲                                              │
      │              ┌───────────────────────────────┘
      │              │  N consecutive sequential frames
      │              ▼
      │           Locked ◄─────────────────────────────┐
      │              │                                  │
      │   (reference lost > holdover_budget)    (reference resumes)
      │              ▼                                  │
      │          Holdover ──────────────────────────────┘
      │              │
      └──(reset())───┘

Implementations

impl JamSyncController

pub fn new( frame_rate: FrameRate, config: JamSyncConfig, ) -> Result<Self, TimecodeError>

Create a new controller for the given frame_rate using the provided config.

Errors

Returns an error if TimecodeGenerator::at_midnight fails (should not occur for well-defined frame rates).

pub fn with_default_config(frame_rate: FrameRate) -> Result<Self, TimecodeError>

Create a controller with default configuration.

Errors

See new.

pub fn state(&self) -> JamSyncState

Current synchronisation state.

pub fn feed_reference(&mut self, tc: Timecode)

Feed an incoming reference timecode frame.

This drives the state machine forward:

• WaitingForReference → Locking on the first call.
• Locking → Locked after lock_threshold consecutive sequential frames.
• Holdover → Locked (immediate re-lock) when a sequential frame arrives.

pub fn output(&mut self) -> Timecode

Return the current output timecode.

In Locked or Holdover state the local generator advances by one frame each call. In WaitingForReference or Locking the generator is frozen until lock is acquired.

Calling output() also updates the holdover counter: if frames_since_ref > holdover_budget while in Locked state the controller transitions to Holdover.

pub fn reset(&mut self) -> Result<(), TimecodeError>

Reset the controller to WaitingForReference state.

The local generator is reset to midnight.

Errors

Returns an error if resetting the generator fails.

pub fn enter_holdover(&mut self)

Force the controller into Holdover state (e.g. reference cable disconnected).

pub fn frames_since_reference(&self) -> u64

Number of output() calls since the last feed_reference() call.