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

Immutable source-bound sparse gain plan; positions are int64 source frames. More...

#include <OfflinePeakCompressor.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 retainedBytes () const noexcept
 
std::span< const OfflineRegion > exclusions () const noexcept
 Borrowed regions, valid while the plan remains alive and unmoved.
 
double gainAt (std::int64_t frame) const noexcept
 

Friends

class OfflinePeakCompressor
 

Detailed Description

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

Immutable source-bound sparse gain plan; positions are int64 source frames.

Definition at line 88 of file OfflinePeakCompressor.h.

Constructor & Destructor Documentation

◆ Plan() [1/2]

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

◆ Plan() [2/2]

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

Member Function Documentation

◆ exclusions()

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

Borrowed regions, valid while the plan remains alive and unmoved.

Definition at line 111 of file OfflinePeakCompressor.h.

◆ gainAt()

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

Definition at line 115 of file OfflinePeakCompressor.h.

◆ getReport()

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

Definition at line 102 of file OfflinePeakCompressor.h.

◆ getSpec()

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

Definition at line 98 of file OfflinePeakCompressor.h.

◆ isValid()

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

Definition at line 94 of file OfflinePeakCompressor.h.

◆ operator=()

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

◆ retainedBytes()

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

Definition at line 106 of file OfflinePeakCompressor.h.

Friends And Related Symbol Documentation

◆ OfflinePeakCompressor

template<FloatType T>
friend class OfflinePeakCompressor
friend

Definition at line 124 of file OfflinePeakCompressor.h.


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