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

Complete-file fixed-duration energy analysis for offline processors. More...

#include <OfflineEnergyAnalyzer.h>

Classes

class  Analysis
 Read-only source-bound energy map; owns bins, never source samples. More...
 
struct  Bin
 Linked-channel RMS and maximum absolute sample for an actual interval. More...
 
class  MidSideAnalysis
 Immutable 10 ms stereo energy map, bound to the supplied PCM/clock. More...
 
struct  MidSideBin
 Energy of M=(L+R)/2 and S=(L-R)/2 over the same actual interval. More...
 
struct  MidSideResult
 Separate stereo result; failed calls never publish a partial map. More...
 
struct  Result
 Only a successful result owns an analysis; memoryBytes is requested payload. More...
 

Public Member Functions

Result analyze (OfflineAudioSource< T > &source, const OfflineJobOptions &options={}) const
 Analyzes a complete mono/stereo source, with no input mutation.
 
MidSideResult analyzeMidSide (OfflineAudioSource< T > &source, const OfflineJobOptions &options={}) const
 Analyzes stereo PCM into separate central/lateral 10 ms energy bins.
 

Detailed Description

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

Complete-file fixed-duration energy analysis for offline processors.

Definition at line 42 of file OfflineEnergyAnalyzer.h.

Member Function Documentation

◆ analyze()

template<FloatType T>
Result dspark::OfflineEnergyAnalyzer< T >::analyze ( OfflineAudioSource< T > &  source,
const OfflineJobOptions &  options = {} 
) const
inline

Analyzes a complete mono/stereo source, with no input mutation.

Definition at line 212 of file OfflineEnergyAnalyzer.h.

◆ analyzeMidSide()

template<FloatType T>
MidSideResult dspark::OfflineEnergyAnalyzer< T >::analyzeMidSide ( OfflineAudioSource< T > &  source,
const OfflineJobOptions &  options = {} 
) const
inline

Analyzes stereo PCM into separate central/lateral 10 ms energy bins.

One complete scan; no generation, gain processing, retained PCM or implicit mono duplication. The format must have exactly two channels. Source offsets are relative to zero; the original timelineOrigin remains in the result.

Definition at line 225 of file OfflineEnergyAnalyzer.h.


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