Struct rea_rs::audio_accessor::AudioAccessor

pub struct AudioAccessor<'a, T: KnowsProject, P: ProbablyMutable> { /* private fields */ }

Implementations

impl<'a, T: KnowsProject, P: ProbablyMutable> AudioAccessor<'a, T, P>

pub fn new(parent: &'a T, ptr: AudioAccessor) -> Self

pub fn has_state_changed(&self) -> bool

pub fn start(&self) -> Position

pub fn end(&self) -> Position

pub fn get_sample_block_raw(
    &self,
    start: SampleAmount,
    samples_per_channel: u32,
    n_channels: u8,
    samplerate: u32
) -> ReaperResult<Option<Vec<f64>>>

Get buffer of samples with given absolute project position in samples.

Returned buffer is Vec<f64> of length samples_per_channel * n_channels: values placed sample by sample for each channel in a turn. E.g. [spl1_ch1, spl1_ch2, spl1_ch3, spl2_ch1, spl2_ch2, spl3_ch3]

start is amount of samples since audio accessor start time.

You can look at the routing scheme to see where AudioAccessor is connected in case of track or take parenting: https://wiki.cockos.com/wiki/images/5/50/SWS_loudness_analysis_signal_flow_chart.png

Example from SWS: https://github.com/reaper-oss/sws/blob/bcc8fbc96f30a943bd04fb8030b4a03ea1ff7557/Breeder/BR_Loudness.cpp#L1020-L1079

note

Samples converted back to seconds as persized as possible, but I still afraid a bit of this function being sample-accurate.

impl<'a, T: KnowsProject> AudioAccessor<'a, T, Mutable>

pub fn validate(&mut self) -> bool

Validates the current state of the audio accessor

– must ONLY call this from the main thread.

Returns true if the state changed.

pub fn update(&mut self)

Force the accessor to reload its state from the underlying track or media item take.

Trait Implementations

impl<'a, T: Debug + KnowsProject, P: Debug + ProbablyMutable> Debug for AudioAccessor<'a, T, P>

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

Formats the value using the given formatter.

impl<'a, T: KnowsProject, P: ProbablyMutable> Drop for AudioAccessor<'a, T, P>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T: PartialEq + KnowsProject, P: PartialEq + ProbablyMutable> PartialEq<AudioAccessor<'a, T, P>> for AudioAccessor<'a, T, P>

fn eq(&self, other: &AudioAccessor<'a, T, P>) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T: KnowsProject, P: ProbablyMutable> WithReaperPtr<'a> for AudioAccessor<'a, T, P>

type Ptr = NonNull<AudioAccessor>

fn get_pointer(&self) -> Self::Ptr

Get underlying ReaperPointer.

fn get(&self) -> Self::Ptr

Get underlying ReaperPointer with validity check.

fn make_unchecked(&mut self)

Turn validity checks off.

fn make_checked(&mut self)

Turn validity checks on.

fn should_check(&self) -> bool

State of validity checks.

fn require_valid(&self) -> ReaperResult<()>

Return ReaperError::NullPtr if check failed.

fn require_valid_2(&self, project: &Project) -> ReaperResult<()>

Return ReaperError::NullPtr if check failed.

fn with_valid_ptr(
    &mut self,
    f: impl FnMut(&mut Self) -> ReaperResult<()>
) -> ReaperResult<()>

Perform function with only one validity check.

impl<'a, T: KnowsProject, P: ProbablyMutable> StructuralPartialEq for AudioAccessor<'a, T, P>