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

Borrowed planar-buffer adapter; does not allocate, copy or own input. More...

#include <OfflineProcessing.h>

Inheritance diagram for dspark::OfflineBufferSource< T, MaxChannels >:
Collaboration diagram for dspark::OfflineBufferSource< T, MaxChannels >:

Public Member Functions

 OfflineBufferSource (AudioBufferView< const T, MaxChannels > audio, double sampleRate, std::uint64_t sourceId=0, std::uint64_t revision=0, std::int64_t timelineOrigin=0) noexcept
 Binds an existing view and optional host content/revision keys.
 
OfflineAudioSpec getSpec () const noexcept override
 Returns format and provenance by value.
 
bool read (std::int64_t first, AudioBufferView< T > destination) override
 Copies a bounded source-relative range into the supplied block.
 
- Public Member Functions inherited from dspark::OfflineAudioSource< T >
virtual ~OfflineAudioSource ()=default
 

Detailed Description

template<FloatType T, int MaxChannels = 16>
class dspark::OfflineBufferSource< T, MaxChannels >

Borrowed planar-buffer adapter; does not allocate, copy or own input.

Threading: the buffer must stay alive and immutable until the worker job ends. A view's channel capacity is preserved, including unsupported layouts that a particular algorithm must reject rather than silently truncate.

Definition at line 184 of file OfflineProcessing.h.

Constructor & Destructor Documentation

◆ OfflineBufferSource()

template<FloatType T, int MaxChannels = 16>
dspark::OfflineBufferSource< T, MaxChannels >::OfflineBufferSource ( AudioBufferView< const T, MaxChannels >  audio,
double  sampleRate,
std::uint64_t  sourceId = 0,
std::uint64_t  revision = 0,
std::int64_t  timelineOrigin = 0 
)
inlinenoexcept

Binds an existing view and optional host content/revision keys.

Definition at line 188 of file OfflineProcessing.h.

Member Function Documentation

◆ getSpec()

template<FloatType T, int MaxChannels = 16>
OfflineAudioSpec dspark::OfflineBufferSource< T, MaxChannels >::getSpec ( ) const
inlineoverridevirtualnoexcept

Returns format and provenance by value.

Implements dspark::OfflineAudioSource< T >.

Definition at line 196 of file OfflineProcessing.h.

◆ read()

template<FloatType T, int MaxChannels = 16>
bool dspark::OfflineBufferSource< T, MaxChannels >::read ( std::int64_t  first,
AudioBufferView< T >  destination 
)
inlineoverridevirtual

Copies a bounded source-relative range into the supplied block.

Implements dspark::OfflineAudioSource< T >.

Definition at line 200 of file OfflineProcessing.h.


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