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

Offline transient emphasis with a positive boost-dB control. More...

#include <OfflinePunch.h>

Classes

struct  Options
 
class  Plan
 Immutable sparse weight plan bound to a complete source fingerprint. More...
 
struct  PlanResult
 
struct  Report
 
struct  Result
 

Public Types

enum class  Reason : std::uint8_t {
  Boosted , RepresentabilityLimited , ZeroAmount , NoSignal ,
  NoTransients , AllExcluded
}
 

Public Member Functions

PlanResult makePlan (OfflineAudioSource< T > &source, const typename OfflineTransientAnalyzer< T >::Analysis &analysis, const Options &options={}, const OfflineJobOptions &jobOptions={}) const
 Reuses attack events, then verifies PCM and bounds representable boost.
 
PlanResult analyze (OfflineAudioSource< T > &source, const Options &options={}, const OfflineJobOptions &job={}) const
 Complete-source analysis and planning; retains only sparse automation.
 
Result render (OfflineAudioSource< T > &source, const Plan &plan, OfflineAudioSink< T > &sink, const OfflineJobOptions &job={}) const
 Verifies the source, then measures provisional PCM before committing the sink.
 
template<int MaxChannels>
Result run (const AudioBuffer< T, MaxChannels > &input, AudioBuffer< T, MaxChannels > &output, double sampleRate, const Options &options={}, const OfflineJobOptions &job={}) const
 Owning convenience render; aliases are safe and failures preserve output.
 

Detailed Description

template<FloatType T>
class dspark::OfflinePunch< T >

Offline transient emphasis with a positive boost-dB control.

Definition at line 44 of file OfflinePunch.h.

Member Enumeration Documentation

◆ Reason

template<FloatType T>
enum class dspark::OfflinePunch::Reason : std::uint8_t
strong
Enumerator
Boosted 
RepresentabilityLimited 
ZeroAmount 
NoSignal 
NoTransients 
AllExcluded 

Definition at line 52 of file OfflinePunch.h.

Member Function Documentation

◆ analyze()

template<FloatType T>
PlanResult dspark::OfflinePunch< T >::analyze ( OfflineAudioSource< T > &  source,
const Options &  options = {},
const OfflineJobOptions &  job = {} 
) const
inline

Complete-source analysis and planning; retains only sparse automation.

Definition at line 224 of file OfflinePunch.h.

◆ makePlan()

template<FloatType T>
PlanResult dspark::OfflinePunch< T >::makePlan ( OfflineAudioSource< T > &  source,
const typename OfflineTransientAnalyzer< T >::Analysis &  analysis,
const Options &  options = {},
const OfflineJobOptions &  jobOptions = {} 
) const
inline

Reuses attack events, then verifies PCM and bounds representable boost.

Definition at line 142 of file OfflinePunch.h.

◆ render()

template<FloatType T>
Result dspark::OfflinePunch< T >::render ( OfflineAudioSource< T > &  source,
const Plan &  plan,
OfflineAudioSink< T > &  sink,
const OfflineJobOptions &  job = {} 
) const
inline

Verifies the source, then measures provisional PCM before committing the sink.

Definition at line 252 of file OfflinePunch.h.

◆ run()

template<FloatType T>
template<int MaxChannels>
Result dspark::OfflinePunch< T >::run ( const AudioBuffer< T, MaxChannels > &  input,
AudioBuffer< T, MaxChannels > &  output,
double  sampleRate,
const Options &  options = {},
const OfflineJobOptions &  job = {} 
) const
inline

Owning convenience render; aliases are safe and failures preserve output.

Definition at line 274 of file OfflinePunch.h.


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