Struct spectrusty::clock::VFrameTs

pub struct VFrameTs<V> {
    pub ts: VideoTs,
    // some fields omitted
}

A VideoTs timestamp wrapper with a constraint to the V: VideoFrame, implementing methods and traits for timestamp calculations.

Fields

ts: VideoTs

The current value of the timestamp.

Implementations

impl<V> VFrameTs<V> where
    V: VideoFrame, 

pub const EOF: VFrameTs<V>

The end-of-frame timestamp, equal to the total number of T-states per frame.

pub fn new(vc: i16, hc: i16) -> VFrameTs<V>

Constructs a new VFrameTs from the given vertical and horizontal counter values.

Note: The returned VFrameTs is not normalized.

pub fn is_normalized(self) -> bool

Returns true if a video timestamp is normalized. Otherwise returns false.

pub fn normalized(self) -> VFrameTs<V>

Normalizes self with a horizontal counter within the allowed range and a scan line counter adjusted accordingly.

Panics

Panics when an attempt to normalize leads to an overflow of the capacity of VideoTs.

pub fn saturating_normalized(self) -> VFrameTs<V>

Returns a video timestamp with a horizontal counter within the allowed range and a scan line counter adjusted accordingly. Saturates at VFrameTs::min_value or VFrameTs::max_value.

pub fn max_value() -> VFrameTs<V>

Returns the largest value that can be represented by a normalized timestamp.

pub fn min_value() -> VFrameTs<V>

Returns the smallest value that can be represented by a normalized timestamp.

pub fn is_eof(self) -> bool

Returns true if the counter value is past or near the end of a frame. Otherwise returns false.

Specifically, the condition is met if the vertical counter is equal to or greater than VideoFrame::VSL_COUNT.

pub fn wrap_frame(&mut self)

Ensures the vertical counter is in the range: (-VSL_COUNT, VSL_COUNT) by calculating a remainder of the division of the vertical counter by VideoFrame::VSL_COUNT.

pub fn saturating_sub_frame(self) -> VFrameTs<V>

Returns a video timestamp after subtracting the total number of frame video scanlines from the scan line counter.

pub fn from_tstates(ts: i32) -> VFrameTs<V>

Returns a normalized timestamp from the given number of T-states.

Panics

Panics when the given ts overflows the capacity of the timestamp.

pub fn try_from_tstates(ts: i32) -> Option<VFrameTs<V>>

On success returns a normalized timestamp from the given number of T-states.

Returns None when the given ts overflows the capacity of the timestamp.

pub fn into_tstates(self) -> i32

Converts the timestamp to FTs.

pub fn into_frame_tstates(self, frames: u64) -> (u64, i32)

Returns a tuple with an adjusted frame counter and with the frame-normalized timestamp as the number of T-states measured from the start of the frame.

The frame starts when the horizontal and vertical counter are both 0.

The returned timestamp value is in the range [0, VideoFrame::FRAME_TSTATES_COUNT).

Methods from Deref<Target = VideoTs>

Trait Implementations

impl<V> Add<i32> for VFrameTs<V> where
    V: VideoFrame, 

type Output = VFrameTs<V>

The resulting type after applying the + operator.

pub fn add(self, delta: i32) -> VFrameTs<V>

Returns a normalized video timestamp after adding delta T-states.

Panics

Panics when normalized timestamp after addition leads to an overflow of the capacity of VideoTs.

impl<V> Add<u32> for VFrameTs<V> where
    V: VideoFrame, 

type Output = VFrameTs<V>

The resulting type after applying the + operator.

pub fn add(self, delta: u32) -> VFrameTs<V>

Returns a normalized video timestamp after adding a delta T-state count.

Panics

Panics when normalized timestamp after addition leads to an overflow of the capacity of VideoTs.

impl<V> AddAssign<i32> for VFrameTs<V> where
    V: VideoFrame, 

pub fn add_assign(&mut self, delta: i32)

Performs the += operation.

impl<V> AddAssign<u32> for VFrameTs<V> where
    V: VideoFrame, 

pub fn add_assign(&mut self, delta: u32)

Performs the += operation.

impl<V> Clone for VFrameTs<V>

pub fn clone(&self) -> VFrameTs<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V> Copy for VFrameTs<V> where
    V: Copy, 

impl<V> Debug for VFrameTs<V> where
    V: Debug, 

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

Formats the value using the given formatter.

impl<V> Default for VFrameTs<V>

pub fn default() -> VFrameTs<V>

Returns the "default value" for a type.

impl<V> Deref for VFrameTs<V>

type Target = VideoTs

The resulting type after dereferencing.

pub fn deref(&self) -> &<VFrameTs<V> as Deref>::Target

Dereferences the value.

impl<V> DerefMut for VFrameTs<V>

pub fn deref_mut(&mut self) -> &mut <VFrameTs<V> as Deref>::Target

Mutably dereferences the value.

impl<'de, V> Deserialize<'de> for VFrameTs<V> where
    V: VideoFrame, 

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<VFrameTs<V>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<V> Eq for VFrameTs<V>

impl<'_, V> From<&'_ VideoTsData1> for VFrameTs<V> where
    V: VideoFrame, 

pub fn from(vtsd: &VideoTsData1) -> VFrameTs<V>

Performs the conversion.

impl<'_, V> From<&'_ VideoTsData2> for VFrameTs<V> where
    V: VideoFrame, 

pub fn from(vtsd: &VideoTsData2) -> VFrameTs<V>

Performs the conversion.

impl<'_, V> From<&'_ VideoTsData3> for VFrameTs<V> where
    V: VideoFrame, 

pub fn from(vtsd: &VideoTsData3) -> VFrameTs<V>

Performs the conversion.

impl<'_, V> From<&'_ VideoTsData6> for VFrameTs<V> where
    V: VideoFrame, 

pub fn from(vtsd: &VideoTsData6) -> VFrameTs<V>

Performs the conversion.

impl<V> From<VFrameTs<V>> for VideoTs

pub fn from(vfts: VFrameTs<V>) -> VideoTs

Performs the conversion.

impl<V, C> From<VFrameTsCounter<V, C>> for VFrameTs<V>

pub fn from(vftsc: VFrameTsCounter<V, C>) -> VFrameTs<V>

Performs the conversion.

impl<V> From<VideoTs> for VFrameTs<V>

pub fn from(ts: VideoTs) -> VFrameTs<V>

Returns a VFrameTs from the given VideoTs. A returned VFrameTs is not being normalized.

Panics

Panics when the given ts overflows the capacity of VideoTs.

impl<V> From<VideoTsData1> for VFrameTs<V> where
    V: VideoFrame, 

pub fn from(vtsd: VideoTsData1) -> VFrameTs<V>

Performs the conversion.

impl<V> From<VideoTsData2> for VFrameTs<V> where
    V: VideoFrame, 

pub fn from(vtsd: VideoTsData2) -> VFrameTs<V>

Performs the conversion.

impl<V> From<VideoTsData3> for VFrameTs<V> where
    V: VideoFrame, 

pub fn from(vtsd: VideoTsData3) -> VFrameTs<V>

Performs the conversion.

impl<V> From<VideoTsData6> for VFrameTs<V> where
    V: VideoFrame, 

pub fn from(vtsd: VideoTsData6) -> VFrameTs<V>

Performs the conversion.

impl<V> Hash for VFrameTs<V>

pub fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<V> Ord for VFrameTs<V>

pub fn cmp(&self, other: &VFrameTs<V>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<V> PartialEq<VFrameTs<V>> for VFrameTs<V>

pub fn eq(&self, other: &VFrameTs<V>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<V> PartialOrd<VFrameTs<V>> for VFrameTs<V>

pub fn partial_cmp(&self, other: &VFrameTs<V>) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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<V> Serialize for VFrameTs<V> where
    V: VideoFrame, 

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

Serialize this value into the given Serde serializer.

impl<V> Sub<i32> for VFrameTs<V> where
    V: VideoFrame, 

type Output = VFrameTs<V>

The resulting type after applying the - operator.

pub fn sub(self, delta: i32) -> VFrameTs<V>

Returns a normalized video timestamp after subtracting delta T-states.

Panics

Panics when normalized timestamp after addition leads to an overflow of the capacity of VideoTs.

impl<V> Sub<u32> for VFrameTs<V> where
    V: VideoFrame, 

type Output = VFrameTs<V>

The resulting type after applying the - operator.

pub fn sub(self, delta: u32) -> VFrameTs<V>

Returns a normalized video timestamp after adding a delta T-state count.

Panics

Panics when normalized timestamp after addition leads to an overflow of the capacity of VideoTs.

impl<V> SubAssign<i32> for VFrameTs<V> where
    V: VideoFrame, 

pub fn sub_assign(&mut self, delta: i32)

Performs the -= operation.

impl<V> SubAssign<u32> for VFrameTs<V> where
    V: VideoFrame, 

pub fn sub_assign(&mut self, delta: u32)

Performs the -= operation.

impl<V> TimestampOps for VFrameTs<V> where
    V: VideoFrame, 

pub fn from_tstates(ts: i32) -> VFrameTs<V>

Returns a normalized timestamp from the given number of T-states.

pub fn into_tstates(self) -> i32

Converts the timestamp to FTs.

pub fn max_value() -> VFrameTs<V>

Returns the largest value that can be represented by a normalized timestamp.

pub fn min_value() -> VFrameTs<V>

Returns the smallest value that can be represented by a normalized timestamp.

pub fn diff_from(self, vts_from: VFrameTs<V>) -> i32

Returns the difference between ts_from and self in the number of T-states.

pub fn saturating_add(self, other: VFrameTs<V>) -> VFrameTs<V>

Panics

May panic if self or other hasn't been normalized.

pub fn saturating_sub(self, other: VFrameTs<V>) -> VFrameTs<V>

Panics

May panic if self or other hasn't been normalized.

impl<V> TryFrom<i32> for VFrameTs<V> where
    V: VideoFrame, 

type Error = &'static str

The type returned in the event of a conversion error.

pub fn try_from(
    ts: i32
) -> Result<VFrameTs<V>, <VFrameTs<V> as TryFrom<i32>>::Error>

Performs the conversion.