tracktion-engine 3.0-10-g034fdde4aa5
Tracktion Engine — High level data model for audio applications

« « « Anklang Documentation
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
tracktion::engine::AudioNodeRenderJob Struct Reference

Takes an AudioNode and renders it to a file. More...

Inheritance diagram for tracktion::engine::AudioNodeRenderJob:
tracktion::engine::ClipEffect::ClipEffectRenderJob juce::ReferenceCountedObject

Classes

struct  RenderContext
 

Public Member Functions

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

Public Attributes

std::unique_ptr< AudioNodenode
 
std::unique_ptr< RenderContextrenderContext
 
const double prerollTime
 
- Public Attributes inherited from tracktion::engine::ClipEffect::ClipEffectRenderJob
Engineengine
 
const AudioFile destination
 
const AudioFile source
 
const SampleCount blockSize
 
std::atomic< floatprogress
 

Additional Inherited Members

- Public Types inherited from tracktion::engine::ClipEffect::ClipEffectRenderJob
using Ptr = juce::ReferenceCountedObjectPtr< ClipEffectRenderJob >
 
- Static Public Attributes inherited from tracktion::engine::ClipEffect::ClipEffectRenderJob
static constexpr SampleCount defaultBlockSize
 
- Protected Member Functions inherited from juce::ReferenceCountedObject
 ReferenceCountedObject (const ReferenceCountedObject &) noexcept
 
 ReferenceCountedObject (ReferenceCountedObject &&) noexcept
 
ReferenceCountedObjectoperator= (const ReferenceCountedObject &) noexcept
 
ReferenceCountedObjectoperator= (ReferenceCountedObject &&) noexcept
 
void resetReferenceCount () noexcept
 

Detailed Description

Takes an AudioNode and renders it to a file.

Definition at line 378 of file tracktion_ClipEffects.cpp.

Constructor & Destructor Documentation

◆ AudioNodeRenderJob()

tracktion::engine::AudioNodeRenderJob::AudioNodeRenderJob ( Engine e,
AudioNode n,
const AudioFile dest,
const AudioFile src,
SampleCount  blockSizeToUse = defaultBlockSize,
double  prerollTimeSeconds = 0 
)

Definition at line 380 of file tracktion_ClipEffects.cpp.

Member Function Documentation

◆ completeRender()

bool tracktion::engine::AudioNodeRenderJob::completeRender ( )
overridevirtual

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.

Implements tracktion::engine::ClipEffect::ClipEffectRenderJob.

Definition at line 403 of file tracktion_ClipEffects.cpp.

◆ createAndPrepareRenderContext()

void tracktion::engine::AudioNodeRenderJob::createAndPrepareRenderContext ( )

Definition at line 539 of file tracktion_ClipEffects.cpp.

◆ renderNextBlock()

bool tracktion::engine::AudioNodeRenderJob::renderNextBlock ( )
overridevirtual

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.

Implements tracktion::engine::ClipEffect::ClipEffectRenderJob.

Definition at line 397 of file tracktion_ClipEffects.cpp.

◆ setUpRender()

bool tracktion::engine::AudioNodeRenderJob::setUpRender ( )
overridevirtual

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.

Implements tracktion::engine::ClipEffect::ClipEffectRenderJob.

Definition at line 390 of file tracktion_ClipEffects.cpp.

Member Data Documentation

◆ node

std::unique_ptr<AudioNode> tracktion::engine::AudioNodeRenderJob::node

Definition at line 535 of file tracktion_ClipEffects.cpp.

◆ prerollTime

const double tracktion::engine::AudioNodeRenderJob::prerollTime

Definition at line 537 of file tracktion_ClipEffects.cpp.

◆ renderContext

std::unique_ptr<RenderContext> tracktion::engine::AudioNodeRenderJob::renderContext

Definition at line 536 of file tracktion_ClipEffects.cpp.


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