Skip to main content

LatencyAnalyzer

Struct LatencyAnalyzer 

Source
pub struct LatencyAnalyzer;
Expand description

Stateless benchmark utility for measuring DSP processor CPU execution cost.

Implementations§

Source§

impl LatencyAnalyzer

Source

pub fn measure_processor_execution_us<E: AudioProcessor>( effect: &mut E, iterations: usize, block_size: usize, ) -> f64

Measures the average wall-clock execution time of a processor in µs per sample.

Runs effect over iterations × block_size synthetic samples and returns the mean time spent per sample. The input alternates between +0.5 and -0.5 to exercise both halves of any branch-dependent code, and black_box prevents dead-code elimination of the loop body.

Returns 0.0 immediately if iterations × block_size overflows or is zero.

§Arguments
  • effect — The processor to benchmark. Mutable because processors may carry internal filter state that updates on every sample.
  • iterations — Number of full block_size passes to run.
  • block_size — Samples per iteration. Larger values reduce timer-call overhead relative to actual processing; 256–2 048 is a practical range.
§Returns

Total wall-clock time divided by total samples, in microseconds per sample.

Source

pub fn measure_effect_added_execution_us<E: AudioProcessor>( effect: &mut E, iterations: usize, block_size: usize, ) -> f64

Measures the net CPU cost added by a processor, relative to a zero-work passthrough.

Runs measure_processor_execution_us twice — once for a PassthroughProcessor that simply returns its input unchanged, and once for effect — then subtracts the baseline. The passthrough baseline accounts for loop overhead, Instant::now() cost, and black_box calls, so the returned value reflects only the processor’s own work.

The result is clamped to ≥ 0.0 to avoid negative readings from measurement noise when the processor is extremely cheap (sub-nanosecond per sample).

§Arguments
  • effect — The processor under test.
  • iterations — Number of benchmark iterations (passed to measure_processor_execution_us).
  • block_size — Samples per iteration.
§Returns

Net added execution cost in microseconds per sample (µs/sample), ≥ 0.

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
§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

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.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

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

§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

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

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
§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,