DSPark 1.8.0
Header-only C++20 DSP for real-time and offline audio
Loading...
Searching...
No Matches
dspark::OfflineLeveler< T >::Plan Class Referencefinal

Immutable source-bound linear-amplitude automation, with int64 lookup. More...

#include <OfflineLeveler.h>

Public Member Functions

 Plan ()=default
 
 Plan (Plan &&) noexcept=default
 
Plan & operator= (Plan &&) noexcept=default
 
bool isValid () const noexcept
 
OfflineAudioSpec getSpec () const noexcept
 
Report getReport () const noexcept
 
std::size_t controlPoints () const noexcept
 
std::size_t retainedBytes () const noexcept
 
std::span< const OfflineRegion > exclusions () const noexcept
 Borrowed read-only regions; invalidated by destruction/move of the plan.
 
double gainAt (std::int64_t frame) const noexcept
 Gain at a source-relative frame. Outside the source or on an invalid plan: 1.
 

Friends

class OfflineLeveler
 

Detailed Description

template<FloatType T>
class dspark::OfflineLeveler< T >::Plan

Immutable source-bound linear-amplitude automation, with int64 lookup.

Definition at line 98 of file OfflineLeveler.h.

Constructor & Destructor Documentation

◆ Plan() [1/2]

template<FloatType T>
dspark::OfflineLeveler< T >::Plan::Plan ( )
default

◆ Plan() [2/2]

template<FloatType T>
dspark::OfflineLeveler< T >::Plan::Plan ( Plan &&  )
defaultnoexcept

Member Function Documentation

◆ controlPoints()

template<FloatType T>
std::size_t dspark::OfflineLeveler< T >::Plan::controlPoints ( ) const
inlinenoexcept

Definition at line 116 of file OfflineLeveler.h.

◆ exclusions()

template<FloatType T>
std::span< const OfflineRegion > dspark::OfflineLeveler< T >::Plan::exclusions ( ) const
inlinenoexcept

Borrowed read-only regions; invalidated by destruction/move of the plan.

Definition at line 125 of file OfflineLeveler.h.

◆ gainAt()

template<FloatType T>
double dspark::OfflineLeveler< T >::Plan::gainAt ( std::int64_t  frame) const
inlinenoexcept

Gain at a source-relative frame. Outside the source or on an invalid plan: 1.

Definition at line 130 of file OfflineLeveler.h.

◆ getReport()

template<FloatType T>
Report dspark::OfflineLeveler< T >::Plan::getReport ( ) const
inlinenoexcept

Definition at line 112 of file OfflineLeveler.h.

◆ getSpec()

template<FloatType T>
OfflineAudioSpec dspark::OfflineLeveler< T >::Plan::getSpec ( ) const
inlinenoexcept

Definition at line 108 of file OfflineLeveler.h.

◆ isValid()

template<FloatType T>
bool dspark::OfflineLeveler< T >::Plan::isValid ( ) const
inlinenoexcept

Definition at line 104 of file OfflineLeveler.h.

◆ operator=()

template<FloatType T>
Plan & dspark::OfflineLeveler< T >::Plan::operator= ( Plan &&  )
defaultnoexcept

◆ retainedBytes()

template<FloatType T>
std::size_t dspark::OfflineLeveler< T >::Plan::retainedBytes ( ) const
inlinenoexcept

Definition at line 120 of file OfflineLeveler.h.

Friends And Related Symbol Documentation

◆ OfflineLeveler

template<FloatType T>
friend class OfflineLeveler
friend

Definition at line 141 of file OfflineLeveler.h.


The documentation for this class was generated from the following file: