Struct LtcFrame 

pub struct LtcFrame {
    pub hours: u8,
    pub minutes: u8,
    pub seconds: u8,
    pub frames: u8,
    pub drop_frame_flag: bool,
    pub color_frame_flag: bool,
    pub flag_bit_27: bool,
    pub flag_bit_43: bool,
    pub flag_bit_58: bool,
    pub flag_bit_59: bool,
    pub user_bits: [u8; 8],
}

A parsed (or to-be-serialized) 80-bit LTC codeword (§9.2): the BCD time address, drop/color frame flags, the four rate-dependent flag bits (polarity correction / BGF0 / BGF1 / BGF2 — see FrameRate), the eight 4-bit binary groups (“user bits”, §8.1), and the fixed synchronization word (always SYNC_WORD on serialize; validated on parse).

This models only the logical codeword content — not the §9.3 biphase-mark modulation that carries it as an analog/digital audio signal (see docs/st12-1.md’s “Scope” section).

Fields

hours: u8

Hours, 00-23 (§9.2.1, Table 2 bits 48-51/56-57).

minutes: u8

Minutes, 00-59 (Table 2 bits 32-35/40-42).

seconds: u8

Seconds, 00-59 (Table 2 bits 16-19/24-26).

frames: u8

Frames, 00-29 (Table 2 bits 0-3/8-9); the caller applies the tighter per-FrameRate bound if it needs one (see MAX_FRAMES).

drop_frame_flag: bool

Drop frame flag, bit 10 (§8.3.1): set when NTSC drop-frame compensation (§5.2.2) is in effect. Fixed bit position across all frame rates; reserved-zero where not applicable (§9.2.2 note).

color_frame_flag: bool

Color frame flag, bit 11 (§8.3.2). Fixed bit position across all frame rates; reserved-zero where not applicable (§9.2.2 note).

flag_bit_27: bool

The wire bit at position 27 (Table 3): 30-frame/24-frame’s polarity correction bit, or 25-frame’s BGF0 — see LtcFrame::polarity_correction / LtcFrame::binary_group_flags to resolve its meaning for a given FrameRate.

flag_bit_43: bool

The wire bit at position 43 (Table 3): 30-frame/24-frame’s BGF0, or 25-frame’s BGF2.

flag_bit_58: bool

The wire bit at position 58 (Table 3): BGF1 in all three frame rates.

flag_bit_59: bool

The wire bit at position 59 (Table 3): 30-frame/24-frame’s BGF2, or 25-frame’s polarity correction bit.

user_bits: [u8; 8]

The eight 4-bit binary groups (“user bits”), each 0x0-0xF, in first..eighth order (Table 4 bits 4-7/12-15/20-23/28-31/36-39/44-47/ 52-55/60-63). Their collective meaning is given by LtcFrame::binary_group_flags.usage().

Implementations

impl LtcFrame

pub fn polarity_correction(&self, rate: FrameRate) -> bool

Resolve the §9.2.3 biphase-mark polarity-correction bit for rate (Table 3: bit 27 for 30-frame/24-frame, bit 59 for 25-frame).

pub fn binary_group_flags(&self, rate: FrameRate) -> BinaryGroupFlags

Resolve the §8.3.3 binary group flags (BGF2/BGF1/BGF0) for rate (Table 3’s per-rate bit-position mapping).

Trait Implementations

impl Clone for LtcFrame

fn clone(&self) -> LtcFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LtcFrame

impl Debug for LtcFrame

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LtcFrame

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for LtcFrame

impl Hash for LtcFrame

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Parse<'a> for LtcFrame

type Error = Error

The error type this implementer returns. Typically the enclosing crate’s Error enum.

fn parse(bytes: &'a [u8]) -> Result<Self>

Parse bytes as Self. Returns Err(Self::Error) on any protocol violation or buffer underrun.

impl PartialEq for LtcFrame

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for LtcFrame

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Serialize for LtcFrame

type Error = Error

The error type this implementer returns (usually the same as the corresponding Parse impl, but need not be).

fn serialized_len(&self) -> usize

Number of bytes serialize_into will write.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Write the serialised form into buf. Returns the number of bytes written (always equal to serialized_len()).

fn to_bytes(&self) -> Vec<u8>

where Self::Error: Debug,

Convenience: allocate a Vec and serialise into it.

impl StructuralPartialEq for LtcFrame