Struct VideoVBIEncoder

Source

pub struct VideoVBIEncoder { /* private fields */ }

Expand description

An encoder for writing ancillary data to the Vertical Blanking Interval lines of component signals.

Implementations§

Source §

impl VideoVBIEncoder

Source

pub fn try_new( format: VideoFormat, pixel_width: u32, ) -> Result<VideoVBIEncoder, VideoVBIError>

Source

pub fn add_did_ancillary( &mut self, adf_mode: VideoAFDDescriptionMode, did: VideoAncillaryDID, block_number: u8, data: &[u8], ) -> Result<(), VideoVBIError>

Adds the provided ancillary data as a DID and block number AFD.

Source

pub fn add_did16_ancillary( &mut self, adf_mode: VideoAFDDescriptionMode, did16: VideoAncillaryDID16, data: &[u8], ) -> Result<(), VideoVBIError>

Adds the provided ancillary data as a DID16 (DID & SDID) AFD.

Source

pub fn add_ancillary( &mut self, adf_mode: VideoAFDDescriptionMode, did: u8, sdid_block_number: u8, data: &[u8], ) -> Result<(), VideoVBIError>

Stores Video Ancillary data, according to SMPTE-291M specification.

Note that the contents of the data are always read as 8bit data (i.e. do not contain the parity check bits).

§`composite`

true if composite ADF should be created, component otherwise

§`DID`

The Data Identifier

§`SDID_block_number`

The Secondary Data Identifier (if type 2) or the Data Block Number (if type 1)

§`data`

The user data content of the Ancillary packet. Does not contain the ADF, DID, SDID nor CS.

§Returns

true if enough space was left in the current line, false otherwise.

Source

pub fn line_buffer_len(&self) -> usize

Returns the buffer length needed to store the line.

Source

pub fn write_line(&mut self, data: &mut [u8]) -> Result<usize, VideoVBIError>

Writes the ancillaries encoded for VBI to the provided buffer.

Use Self::line_buffer_len to get the expected buffer length.

Resets the internal state, so this VideoVBIEncoder can be reused for subsequent VBI encodings.

§Returns

Ok with the written length in bytes in the line buffer containing the encoded ancilliaries previously added using VideoVBIEncoder::add_ancillary, VideoVBIEncoder::add_did_ancillary or VideoVBIEncoder::add_did16_ancillary.
Err if the ancillary could not be added.

Trait Implementations§

Source §

impl Debug for VideoVBIEncoder

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Hash for VideoVBIEncoder

Source §

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

Source §

impl Ord for VideoVBIEncoder

Source §

fn cmp(&self, other: &VideoVBIEncoder) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

Source §

impl PartialEq for VideoVBIEncoder

Source §

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Source §

impl PartialOrd for VideoVBIEncoder

Source §

fn partial_cmp(&self, other: &VideoVBIEncoder) -> Option<Ordering>

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

1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Source §

impl<'a> TryFrom<&'a VideoInfo> for VideoVBIEncoder

Source §

type Error = VideoVBIError

The type returned in the event of a conversion error.

Source §

fn try_from(info: &'a VideoInfo) -> Result<VideoVBIEncoder, VideoVBIError>

Performs the conversion.

Source §

impl Sync for VideoVBIEncoder

Auto Trait Implementations§

§

impl Freeze for VideoVBIEncoder

§

impl RefUnwindSafe for VideoVBIEncoder

§

impl Unpin for VideoVBIEncoder

§

impl UnwindSafe for VideoVBIEncoder

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

impl<T, U> TryFrom for T
where U: Into<T>,

Source §

type Error = Infallible

The type returned in the event of a conversion error.

Source §

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

VideoVBIEncoder

Struct VideoVBIEncoder Copy item path

Implementations§

impl VideoVBIEncoder

pub fn try_new( format: VideoFormat, pixel_width: u32, ) -> Result<VideoVBIEncoder, VideoVBIError>

pub fn add_did_ancillary( &mut self, adf_mode: VideoAFDDescriptionMode, did: VideoAncillaryDID, block_number: u8, data: &[u8], ) -> Result<(), VideoVBIError>

pub fn add_did16_ancillary( &mut self, adf_mode: VideoAFDDescriptionMode, did16: VideoAncillaryDID16, data: &[u8], ) -> Result<(), VideoVBIError>

pub fn add_ancillary( &mut self, adf_mode: VideoAFDDescriptionMode, did: u8, sdid_block_number: u8, data: &[u8], ) -> Result<(), VideoVBIError>

§composite

§DID

§SDID_block_number

§data

§Returns

pub fn line_buffer_len(&self) -> usize

pub fn write_line(&mut self, data: &mut [u8]) -> Result<usize, VideoVBIError>

§Returns

Trait Implementations§

impl Debug for VideoVBIEncoder

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

impl Hash for VideoVBIEncoder

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

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

impl Ord for VideoVBIEncoder

fn cmp(&self, other: &VideoVBIEncoder) -> Ordering

fn max(self, other: Self) -> Selfwhere Self: Sized,

fn min(self, other: Self) -> Selfwhere Self: Sized,

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized,

impl PartialEq for VideoVBIEncoder

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

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

impl PartialOrd for VideoVBIEncoder

fn partial_cmp(&self, other: &VideoVBIEncoder) -> Option<Ordering>

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

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

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

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

impl<'a> TryFrom<&'a VideoInfo> for VideoVBIEncoder

type Error = VideoVBIError

fn try_from(info: &'a VideoInfo) -> Result<VideoVBIEncoder, VideoVBIError>

impl Eq for VideoVBIEncoder

impl Send for VideoVBIEncoder

impl StructuralPartialEq for VideoVBIEncoder

impl Sync for VideoVBIEncoder

Auto Trait Implementations§

impl Freeze for VideoVBIEncoder

impl RefUnwindSafe for VideoVBIEncoder

impl Unpin for VideoVBIEncoder

impl UnwindSafe for VideoVBIEncoder

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct VideoVBIEncoder

§`composite`

§`DID`

§`SDID_block_number`

§`data`

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

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

fn max(self, other: Self) -> Self
where Self: Sized,

fn min(self, other: Self) -> Self
where Self: Sized,

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,