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

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
tracktion::engine::AggregateJob Struct Reference
Inheritance diagram for tracktion::engine::AggregateJob:
tracktion::engine::RenderManager::Job tracktion::engine::ThreadPoolJobWithProgress juce::MessageListener juce::Timer juce::ThreadPoolJob

Public Member Functions

 AggregateJob (Engine &e, const AudioFile &destFile, const AudioFile &source, juce::ReferenceCountedArray< ClipEffect::ClipEffectRenderJob > j)
 
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.
 
- Public Member Functions inherited from tracktion::engine::RenderManager::Job
JobStatus runJob () override
 Performs the render.
 
float getCurrentTaskProgress () override
 Returns the progress of the job.
 
void cancelJob ()
 Cancels the current job safely making sure any listeners are called appropriately.
 
void cleanUpDanglingJob ()
 Called during app shutdown by the manager on any jobs that haven't had a chance to recieve their async completion callbacks.
 
void incReferenceCount () noexcept
 
bool decReferenceCountWithoutDeleting () noexcept
 
int getReferenceCount () const noexcept
 
void addListener (Listener *l)
 
void removeListener (Listener *l)
 
- Public Member Functions inherited from tracktion::engine::ThreadPoolJobWithProgress
 ThreadPoolJobWithProgress (const juce::String &name)
 
virtual bool canCancel () const
 
void setManager (BackgroundJobManager &)
 
void setName (const juce::String &newName)
 Sets the job's name but also updates the manager so the list will reflect it.
 
void prepareForJobDeletion ()
 Call this in your sub-class destructor to to remvoe it from the manager queue before this class's destructor is called which can result in a pure virtual call.
 
- Public Member Functions inherited from juce::ThreadPoolJob
 ThreadPoolJob (const String &name)
 
String getJobName () const
 
void setJobName (const String &newName)
 
bool isRunning () const noexcept
 
bool shouldExit () const noexcept
 
void signalJobShouldExit ()
 
void addListener (Thread::Listener *)
 
void removeListener (Thread::Listener *)
 

Public Attributes

const AudioFile sourceFile
 
juce::File lastFile
 
juce::ReferenceCountedArray< ClipEffect::ClipEffectRenderJobjobs
 
ClipEffect::ClipEffectRenderJob::Ptr currentJob
 
const int originalNumTasks
 
int numJobsCompleted
 
- Public Attributes inherited from tracktion::engine::RenderManager::Job
Engineengine
 
AudioFile proxy
 
std::atomic< floatprogress
 
- Public Attributes inherited from juce::ThreadPoolJob
 jobHasFinished
 
 jobNeedsRunningAgain
 

Additional Inherited Members

- Public Types inherited from tracktion::engine::RenderManager::Job
using Ptr = juce::ReferenceCountedObjectPtr< Job >
 
- Public Types inherited from juce::ThreadPoolJob
enum  JobStatus
 
- Static Public Member Functions inherited from juce::ThreadPoolJob
static ThreadPoolJobgetCurrentThreadPoolJob ()
 
- Protected Member Functions inherited from tracktion::engine::RenderManager::Job
 Job (Engine &, const AudioFile &proxy)
 

Detailed Description

Definition at line 1708 of file tracktion_ClipEffects.cpp.

Constructor & Destructor Documentation

◆ AggregateJob()

tracktion::engine::AggregateJob::AggregateJob ( Engine e,
const AudioFile destFile,
const AudioFile source,
juce::ReferenceCountedArray< ClipEffect::ClipEffectRenderJob j 
)

Definition at line 1710 of file tracktion_ClipEffects.cpp.

Member Function Documentation

◆ completeRender()

bool tracktion::engine::AggregateJob::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::RenderManager::Job.

Definition at line 1769 of file tracktion_ClipEffects.cpp.

◆ renderNextBlock()

bool tracktion::engine::AggregateJob::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::RenderManager::Job.

Definition at line 1723 of file tracktion_ClipEffects.cpp.

◆ setUpRender()

bool tracktion::engine::AggregateJob::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::RenderManager::Job.

Definition at line 1718 of file tracktion_ClipEffects.cpp.

Member Data Documentation

◆ currentJob

ClipEffect::ClipEffectRenderJob::Ptr tracktion::engine::AggregateJob::currentJob

Definition at line 1777 of file tracktion_ClipEffects.cpp.

◆ jobs

juce::ReferenceCountedArray<ClipEffect::ClipEffectRenderJob> tracktion::engine::AggregateJob::jobs

Definition at line 1776 of file tracktion_ClipEffects.cpp.

◆ lastFile

juce::File tracktion::engine::AggregateJob::lastFile

Definition at line 1775 of file tracktion_ClipEffects.cpp.

◆ numJobsCompleted

int tracktion::engine::AggregateJob::numJobsCompleted

Definition at line 1779 of file tracktion_ClipEffects.cpp.

◆ originalNumTasks

const int tracktion::engine::AggregateJob::originalNumTasks

Definition at line 1778 of file tracktion_ClipEffects.cpp.

◆ sourceFile

const AudioFile tracktion::engine::AggregateJob::sourceFile

Definition at line 1774 of file tracktion_ClipEffects.cpp.


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