Struct Pyramid 

pub struct Pyramid { /* private fields */ }

A min/max pyramid of one recording, in memory or in a file.

Implementations

impl Pyramid

pub fn in_memory(source: &dyn RecordingSource, base: u64) -> DspResult<Self>

An empty pyramid of source in memory, with level-0 buckets of base samples (MEMORY_BASE unless there is a reason otherwise).

pub fn open_file( path: &Path, identity: &PyramidIdentity, base: u64, ) -> DspResult<Option<Self>>

The complete pyramid file at path built from identity with level-0 bucket base; None when it is missing, incomplete or built from something else.

pub fn create_file( path: &Path, identity: &PyramidIdentity, base: u64, ) -> DspResult<Self>

A new, empty pyramid file at path (replacing any other) to fill.

pub fn open_or_create( source: &dyn RecordingSource, recording: Option<(&Path, &str)>, ) -> DspResult<(Self, bool)>

The pyramid of source source_id of the recording at path, base FILE_BASE: the complete file next to it, else a new file there, else (no path, or a folder that cannot be written) one in memory at MEMORY_BASE. Returns it and whether it is complete.

pub fn path(&self) -> Option<&Path>

The file behind this pyramid, if any.

pub fn base(&self) -> u64

pub fn samples(&self) -> u64

pub fn page_samples(&self) -> u64

Samples per page (the unit of filling).

pub fn covers(&self, start: u64, end: u64) -> bool

Whether every page holding samples start..end is built.

pub fn is_complete(&self) -> bool

Whether every bucket of every level is built.

pub fn fill( &self, source: &dyn RecordingSource, start: u64, end: u64, block_values: usize, stop: impl Fn() -> bool + Sync, ) -> DspResult<bool>

Builds the pages holding samples start..end that are not built yet, reading every channel in the source’s native order, consecutive pages together (up to block_values values per read, at least one page), reading ahead while pages are built. Returns Ok(false) when stop returned true before a read; pages built until then are kept. A file is marked complete once every page is built.

pub fn envelope( &self, channels: &[usize], start: u64, end: u64, width: usize, out: &mut [[f32; 2]], ) -> DspResult<bool>

[min, max] per pixel column of samples start..end for each of channels, written row by row into out (channels.len() × width). Columns not built yet, or holding only NaN samples, are NaN. Returns false (leaving out untouched) when a column spans fewer than base samples: read those windows from the recording.

pub fn column_samples( &self, start: u64, end: u64, width: usize, x: usize, ) -> Option<(u64, u64)>

Sample range column x of a width-column envelope of start..end covers (the bucket-aligned edges envelope uses), or None for raw windows.

Trait Implementations

impl Send for Pyramid

impl Sync for Pyramid