pub struct Video<W: Write> {
    pub state: VideoState,
    pub display_frame: Frame,
    pub display_frame_features: Frame,
    pub instantaneous_view_mode: FramedViewMode,
    pub event_sender: Sender<Vec<Event>>,
    pub encoder: Encoder<W>,
    pub encoder_type: EncoderType,
    /* private fields */
}
Expand description

Attributes common to ADΔER transcode process

Fields§

§state: VideoState

The current state of the video transcode

§display_frame: Frame

The current instantaneous display frame

§display_frame_features: Frame

The current instantaneous display frame with the features drawn on it

§instantaneous_view_mode: FramedViewMode

The current view mode of the instantaneous frame

§event_sender: Sender<Vec<Event>>

Channel for sending events to the encoder

§encoder: Encoder<W>§encoder_type: EncoderType

Implementations§

source§

impl<W: Write + 'static> Video<W>

source

pub fn c_thresh_pos(self, c_thresh_pos: u8) -> Self

👎Deprecated since 0.3.4: please use update_crf or update_quality_manual instead

Set the positive contrast threshold

source

pub fn c_thresh_neg(self, _c_thresh_neg: u8) -> Self

👎Deprecated since 0.3.4: please use update_crf or update_quality_manual instead

Set the negative contrast threshold

source

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

Set the number of rows to process at a time (in each thread)

source

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

Set the time parameters for the video.

These parameters, in conjunction, determine the temporal resolution and maximum transcode accuracy/quality.

Arguments
  • tps: ticks per second
  • ref_time: reference time in ticks.
  • delta_t_max: maximum time difference between events of the same pixel, in ticks

returns: Result<Video<W>, Box<dyn Error, Global>>

source

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

Write out the video to a file.

Arguments
  • source_camera: the type of video source
  • time_mode: the time mode of the video
  • write: the output stream to write to
source

pub fn show_display(self, show_display: bool) -> Self

Set the display mode for the instantaneous view.

source

pub fn end_write_stream(&mut self) -> Result<Option<W>, SourceError>

Close and flush the stream writer.

Errors

Returns an error if the stream writer cannot be closed cleanly.

source

pub fn get_ref_time(&self) -> u32

Get ref_time

source

pub fn get_delta_t_max(&self) -> u32

Get delta_t_max

source

pub fn get_tps(&self) -> u32

Get tps

source

pub fn update_delta_t_max(&mut self, dtm: u32)

Set a new value for delta_t_max

source

pub fn update_detect_features( &mut self, detect_features: bool, show_features: ShowFeatureMode )

Set a new bool for feature_detection

source

pub fn update_adder_thresh_pos(&mut self, c: u8)

👎Deprecated since 0.3.4: please use update_crf or update_quality_manual instead

Set a new value for c_thresh_pos

source

pub fn update_adder_thresh_neg(&mut self, _c: u8)

👎Deprecated since 0.3.4: please use update_crf or update_quality_manual instead

Set a new value for c_thresh_neg

source

pub 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

source

pub fn get_encoder_options(&self) -> EncoderOptions

source

pub fn get_time_mode(&self) -> TimeMode

source

pub fn update_quality_manual( &mut self, c_thresh_baseline: u8, c_thresh_max: u8, delta_t_max_multiplier: u32, c_increase_velocity: u8, feature_c_radius: f32 )

Manually set the parameters dictating quality

source

pub fn get_event_size(&self) -> u8

Trait Implementations§

source§

impl<W: Write> Send for Video<W>

Auto Trait Implementations§

§

impl<W> RefUnwindSafe for Video<W>where W: RefUnwindSafe,

§

impl<W> Sync for Video<W>where W: Sync,

§

impl<W> Unpin for Video<W>where W: Unpin,

§

impl<W> UnwindSafe for Video<W>where W: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

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

§

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

§

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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more