Struct exr::meta::attribute::TimeCode

pub struct TimeCode {
    pub hours: u8,
    pub minutes: u8,
    pub seconds: u8,
    pub frame: u8,
    pub drop_frame: bool,
    pub color_frame: bool,
    pub field_phase: bool,
    pub binary_group_flags: [bool; 3],
    pub binary_groups: [u8; 8],
}

Contains time information for this frame within a sequence. Also defined methods to compile this information into a TV60, TV50 or Film24 bit sequence, packed into u32.

Satisfies the SMPTE standard 12M-1999. For more in-depth information, see philrees.co.uk/timecode.

Fields

hours: u8

Hours 0 - 23 are valid.

minutes: u8

Minutes 0 - 59 are valid.

seconds: u8

Seconds 0 - 59 are valid.

frame: u8

Frame Indices 0 - 29 are valid.

drop_frame: bool

Whether this is a drop frame.

color_frame: bool

Whether this is a color frame.

field_phase: bool

Field Phase.

binary_group_flags: [bool; 3]

Flags for TimeCode.binary_groups.

binary_groups: [u8; 8]

The user-defined control codes. Every entry in this array can use at most 3 bits. This results in a maximum value of 15, including 0, for each u8.

Implementations

impl TimeCode

pub const BYTE_SIZE: usize

Number of bytes this would consume in an exr file.

pub fn validate(&self, strict: bool) -> UnitResult

Returns an error if this time code is considered invalid.

pub fn pack_time_as_tv60_u32(&self) -> Result<u32>

Pack the SMPTE time code into a u32 value, according to TV60 packing. This is the encoding which is used within a binary exr file.

pub fn from_tv60_time(tv60_time: u32, user_data: u32) -> Self

Unpack a time code from one TV60 encoded u32 value and the encoded user data. This is the encoding which is used within a binary exr file.

pub fn pack_time_as_tv50_u32(&self) -> Result<u32>

Pack the SMPTE time code into a u32 value, according to TV50 packing. This encoding does not support the drop_frame flag, it will be lost.

pub fn from_tv50_time(tv50_time: u32, user_data: u32) -> Self

Unpack a time code from one TV50 encoded u32 value and the encoded user data. This encoding does not support the drop_frame flag, it will always be false.

pub fn pack_time_as_film24_u32(&self) -> Result<u32>

Pack the SMPTE time code into a u32 value, according to FILM24 packing. This encoding does not support the drop_frame and color_frame flags, they will be lost.

pub fn from_film24_time(film24_time: u32, user_data: u32) -> Self

Unpack a time code from one TV60 encoded u32 value and the encoded user data. This encoding does not support the drop_frame and color_frame flags, they will always be false.

pub fn pack_user_data_as_u32(&self) -> u32

Pack the user data u8 array into one u32. User data values are clamped to the valid range (maximum value is 4).

pub fn write<W: Write>(&self, write: &mut W) -> UnitResult

Write this time code to the byte stream, encoded as TV60 integers. Returns an Error::Invalid if the fields are out of the allowed range.

pub fn read<R: Read>(read: &mut R) -> Result<Self>

Read the time code, without validating, extracting from TV60 integers.

Trait Implementations

impl Clone for TimeCode

fn clone(&self) -> TimeCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeCode

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

Formats the value using the given formatter.

impl Hash for TimeCode

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<TimeCode> for TimeCode

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

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

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

This method tests for !=.

impl Copy for TimeCode

impl Eq for TimeCode

impl StructuralEq for TimeCode

impl StructuralPartialEq for TimeCode