tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications
« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
tracktion::engine::ClipEffect::ClipEffectRenderJob Struct Referenceabstract
Inheritance diagram for tracktion::engine::ClipEffect::ClipEffectRenderJob:
juce::ReferenceCountedObject tracktion::engine::AudioNodeRenderJob tracktion::engine::BlockBasedRenderJob tracktion::engine::InvertEffect::InvertRenderJob tracktion::engine::MakeMonoEffect::MakeMonoRenderJob tracktion::engine::NormaliseEffect::NormaliseRenderJob tracktion::engine::ReverseEffect::ReverseRenderJob tracktion::engine::WarpTimeEffectRenderJob

Public Types

using Ptr = juce::ReferenceCountedObjectPtr< ClipEffectRenderJob >
 

Public Member Functions

 ClipEffectRenderJob (Engine &e, const AudioFile &dest, const AudioFile &src, SampleCount blockSizeToUse)
 
virtual bool setUpRender ()=0
 Subclasses should override this to set-up their render process.
 
virtual bool renderNextBlock ()=0
 During a render process this will be repeatedly called.
 
virtual bool completeRender ()=0
 This is called once after all the render blocks have completed.
 
- Public Member Functions inherited from juce::ReferenceCountedObject
void incReferenceCount () noexcept
 
void decReferenceCount () noexcept
 
bool decReferenceCountWithoutDeleting () noexcept
 
int getReferenceCount () const noexcept
 

Public Attributes

Engine & engine
 
const AudioFile destination
 
const AudioFile source
 
const SampleCount blockSize
 
std::atomic< float > progress
 

Static Public Attributes

static constexpr SampleCount defaultBlockSize
 

Additional Inherited Members

- Protected Member Functions inherited from juce::ReferenceCountedObject
 ReferenceCountedObject (const ReferenceCountedObject &) noexcept
 
 ReferenceCountedObject (ReferenceCountedObject &&) noexcept
 
ReferenceCountedObject & operator= (const ReferenceCountedObject &) noexcept
 
ReferenceCountedObject & operator= (ReferenceCountedObject &&) noexcept
 
void resetReferenceCount () noexcept
 

Detailed Description

Definition at line 182 of file tracktion_ClipEffects.cpp.

Member Typedef Documentation

◆ Ptr

using tracktion::engine::ClipEffect::ClipEffectRenderJob::Ptr = juce::ReferenceCountedObjectPtr<ClipEffectRenderJob>

Definition at line 184 of file tracktion_ClipEffects.cpp.

Constructor & Destructor Documentation

◆ ClipEffectRenderJob()

tracktion::engine::ClipEffect::ClipEffectRenderJob::ClipEffectRenderJob ( Engine &  e,
const AudioFile &  dest,
const AudioFile &  src,
SampleCount  blockSizeToUse 
)

Definition at line 188 of file tracktion_ClipEffects.cpp.

◆ ~ClipEffectRenderJob()

virtual tracktion::engine::ClipEffect::ClipEffectRenderJob::~ClipEffectRenderJob ( )
virtual

Definition at line 196 of file tracktion_ClipEffects.cpp.

Member Function Documentation

◆ completeRender()

virtual bool tracktion::engine::ClipEffect::ClipEffectRenderJob::completeRender ( )
pure virtual

This is called once after all the render blocks have completed.

Subclasses should override this to finish off their render by closing files and etc. returning true if everything completed successfully, false otherwise.

Implemented in tracktion::engine::AudioNodeRenderJob, and tracktion::engine::BlockBasedRenderJob.

◆ renderNextBlock()

virtual bool tracktion::engine::ClipEffect::ClipEffectRenderJob::renderNextBlock ( )
pure virtual

During a render process this will be repeatedly called.

Return true once all the blocks have completed, false if this needs to be called again.

Implemented in tracktion::engine::AudioNodeRenderJob, tracktion::engine::WarpTimeEffectRenderJob, tracktion::engine::NormaliseEffect::NormaliseRenderJob, tracktion::engine::MakeMonoEffect::MakeMonoRenderJob, tracktion::engine::ReverseEffect::ReverseRenderJob, and tracktion::engine::InvertEffect::InvertRenderJob.

◆ setUpRender()

virtual bool tracktion::engine::ClipEffect::ClipEffectRenderJob::setUpRender ( )
pure virtual

Subclasses should override this to set-up their render process.

Return true if the set-up completed successfully and the rest of the render callbacks should be called, false if there was a problem and the render should be stopped.

Implemented in tracktion::engine::AudioNodeRenderJob, tracktion::engine::BlockBasedRenderJob, and tracktion::engine::MakeMonoEffect::MakeMonoRenderJob.

Member Data Documentation

◆ blockSize

const SampleCount tracktion::engine::ClipEffect::ClipEffectRenderJob::blockSize

Definition at line 217 of file tracktion_ClipEffects.cpp.

◆ defaultBlockSize

constexpr SampleCount tracktion::engine::ClipEffect::ClipEffectRenderJob::defaultBlockSize
staticconstexpr

Definition at line 186 of file tracktion_ClipEffects.cpp.

◆ destination

const AudioFile tracktion::engine::ClipEffect::ClipEffectRenderJob::destination

Definition at line 216 of file tracktion_ClipEffects.cpp.

◆ engine

Engine& tracktion::engine::ClipEffect::ClipEffectRenderJob::engine

Definition at line 215 of file tracktion_ClipEffects.cpp.

◆ progress

std::atomic<float> tracktion::engine::ClipEffect::ClipEffectRenderJob::progress

Definition at line 218 of file tracktion_ClipEffects.cpp.

◆ source

const AudioFile tracktion::engine::ClipEffect::ClipEffectRenderJob::source

Definition at line 216 of file tracktion_ClipEffects.cpp.

The documentation for this struct was generated from the following file:
« « « Anklang Documentation