Struct ClockAnchor 

pub struct ClockAnchor {
    pub sample_rate: u32,
    pub ref_sample: i64,
    pub ref_ptp_ns: i64,
}

A linear map between a sample index and a PTP timestamp.

Given a sample rate and a single anchor pair (ref_sample, ref_ptp_ns) — “sample index ref_sample occurred at PTP time ref_ptp_ns” — every other index or timestamp is determined by the linear relation:

ptp_ns = ref_ptp_ns + (sample - ref_sample) * 1e9 / sample_rate
sample = ref_sample + (ptp_ns - ref_ptp_ns) * sample_rate / 1e9

The arithmetic is performed in i128 and checked against i64 overflow, so a conversion that would wrap silently instead yields ClockError::ConversionOverflow.

Fields

sample_rate: u32

Sample rate in Hz (48000 is the common baseline). Must be positive.

ref_sample: i64

The sample index at the anchor point.

ref_ptp_ns: i64

The PTP timestamp (nanoseconds since epoch) at the anchor point.

Implementations

impl ClockAnchor

pub fn new(sample_rate: u32, ref_sample: i64, ref_ptp_ns: i64) -> Result<Self>

Creates a new anchor, validating that the sample rate is positive.

Errors

Returns ClockError::InvalidSampleRate when sample_rate == 0.

pub fn at_origin(sample_rate: u32, ref_ptp_ns: i64) -> Option<Self>

Creates an anchor at sample index 0 with the given reference timestamp.

pub fn sample_to_ptp_checked(&self, sample_idx: i64) -> Result<i64>

Converts a sample index to a PTP timestamp in nanoseconds.

Errors

Returns ClockError::ConversionOverflow if the result does not fit in i64.

pub fn ptp_to_sample_checked(&self, ptp_ns: i64) -> Result<i64>

Converts a PTP timestamp in nanoseconds to a sample index.

Errors

Returns ClockError::ConversionOverflow if the intermediate or result does not fit in i64.

Trait Implementations

impl Clone for ClockAnchor

fn clone(&self) -> ClockAnchor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ClockAnchor

impl Debug for ClockAnchor

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

Formats the value using the given formatter.

impl Eq for ClockAnchor

impl PartialEq for ClockAnchor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClockAnchor