Skip to main content

LtcAudioEncoder

Struct LtcAudioEncoder 

Source
pub struct LtcAudioEncoder { /* private fields */ }
Expand description

Generates biphase-mark modulated audio samples from LTC bit words.

Biphase-mark encoding: every bit cell starts with a transition. A ‘1’ bit has an additional mid-cell transition; a ‘0’ bit does not.

§Example

use oximedia_timecode::ltc_encoder::{LtcAudioEncoder, LtcSignalParams, LtcBitEncoder};
use oximedia_timecode::{Timecode, FrameRate, FrameRateInfo};

let params = LtcSignalParams::default_25fps();
let mut encoder = LtcAudioEncoder::new(params);
let tc = Timecode {
    hours: 1, minutes: 0, seconds: 0, frames: 0,
    frame_rate: FrameRateInfo { fps: 25, drop_frame: false },
    user_bits: 0,
};
let bits = LtcBitEncoder::encode(&tc);
let samples = encoder.encode_frame(&bits);
assert!(!samples.is_empty());

Implementations§

Source§

impl LtcAudioEncoder

Source

pub fn new(params: LtcSignalParams) -> Self

Create a new audio encoder.

Source

pub fn encode_frame(&mut self, bits: &[u8; 80]) -> Vec<f32>

Encode a single 80-bit LTC word into audio samples.

Returns a Vec<f32> of biphase-mark modulated audio.

Source

pub fn encode_sequence(&mut self, timecodes: &[Timecode]) -> Vec<f32>

Encode multiple consecutive timecodes into a continuous audio stream.

Source

pub fn polarity(&self) -> f32

Return the current polarity state.

Source

pub fn reset_polarity(&mut self)

Reset the polarity to +1.

Source

pub fn params(&self) -> &LtcSignalParams

Return the signal parameters.

Trait Implementations§

Source§

impl Clone for LtcAudioEncoder

Source§

fn clone(&self) -> LtcAudioEncoder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LtcAudioEncoder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.