Struct Framed

pub struct Framed<W: Write + 'static + Send + Sync> {
    pub frame_idx_start: u32,
    pub source_fps: f32,
    pub scale: f64,
    /* private fields */
}

Attributes of a framed video -> ADΔER transcode

Fields

frame_idx_start: u32

Index of the first frame to be read from the input video

source_fps: f32

FPS of the input video. Set automatically by Framed::new()

scale: f64

Scale of the input video. Input frames are resized to this scale before transcoding.

Implementations

impl<W: Write + 'static + Send + Sync> Framed<W>

pub fn new( input_path: PathBuf, color_input: bool, scale: f64, ) -> Result<Framed<W>, SourceError>

Create a new Framed source

pub fn frame_start(self, frame_idx_start: u32) -> Result<Self, SourceError>

Set the start frame of the source

pub fn auto_time_parameters( self, ref_time: DeltaT, delta_t_max: DeltaT, time_mode: Option<TimeMode>, ) -> Result<Self, SourceError>

Automatically derive the ticks per second from the source FPS and ref_time

pub fn get_ref_time(&self) -> u32

Get the number of ticks each frame is said to span

pub fn get_last_input_frame(&self) -> &Frame

Get the previous input frame

Trait Implementations

impl<W: Write + 'static + Send + Sync> From<Framed<W>> for AdderSource<W>

fn from(v: Framed<W>) -> AdderSource<W>

Converts to this type from the input type.

impl<W: Write + 'static + Send + Sync> Source<W> for Framed<W>

fn consume(&mut self) -> Result<Vec<Vec<Event>>, SourceError>

Get pixel-wise intensities directly from source frame, and integrate them with ref_time (the number of ticks each frame is said to span)

fn crf(&mut self, crf: u8)

Set the Constant Rate Factor (CRF) quality setting for the encoder. 0 is lossless, 9 is worst quality.

fn get_video_mut(&mut self) -> &mut Video<W>

Get a mutable reference to the Video object associated with this Source.

fn get_video_ref(&self) -> &Video<W>

Get an immutable reference to the Video object associated with this Source.

fn get_video(self) -> Video<W>

Get the Video object associated with this Source, consuming the Source in the process.

fn get_input(&self) -> Option<&Frame>

Get the input frame from the source

fn get_running_input_bitrate(&self) -> f64

Get the last-calculated bitrate of the input (in bits per second)

impl<W: Write + 'static + Send + Sync> TryInto<Framed<W>> for AdderSource<W>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Framed<W>, <Self as TryInto<Framed<W>>>::Error>

Performs the conversion.

impl<W: Write + 'static + Send + Sync> VideoBuilder<W> for Framed<W>

fn crf(self, crf: u8) -> Self

Set the Constant Rate Factor (CRF) quality setting for the encoder. 0 is lossless, 9 is worst quality.

fn quality_manual( self, c_thresh_baseline: u8, c_thresh_max: u8, delta_t_max_multiplier: u32, c_increase_velocity: u8, feature_c_radius_denom: f32, ) -> Self

Manually set the parameters dictating quality

fn chunk_rows(self, chunk_rows: usize) -> Self

Set the chunk rows

fn time_parameters( self, tps: DeltaT, ref_time: DeltaT, delta_t_max: DeltaT, time_mode: Option<TimeMode>, ) -> Result<Self, SourceError>

Set the time parameters

fn write_out( self, source_camera: SourceCamera, time_mode: TimeMode, pixel_multi_mode: PixelMultiMode, adu_interval: Option<usize>, encoder_type: EncoderType, encoder_options: EncoderOptions, write: W, ) -> Result<Box<Self>, SourceError>

Set the Encoder

fn detect_features( self, detect_features: bool, show_features: ShowFeatureMode, ) -> Self

Set whether or not to detect features, and whether or not to display the features

impl<W: Write + Send + Sync> Sync for Framed<W>