The base class that all generator jobs derive from. More...

#include "tracktion_RenderManager.h"

Inheritance diagram for tracktion::engine::RenderManager::Job:

Classes
struct	Listener

Public Types
using	Ptr = juce::ReferenceCountedObjectPtr< Job >

Public Types inherited from juce::ThreadPoolJob
enum	JobStatus

Public Member Functions
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)

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 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
Engine &	engine

AudioFile	proxy

std::atomic< float >	progress

Public Attributes inherited from juce::ThreadPoolJob
	jobHasFinished

	jobNeedsRunningAgain

Protected Member Functions
	Job (Engine &, const AudioFile &proxy)

Additional Inherited Members
Static Public Member Functions inherited from juce::ThreadPoolJob
static ThreadPoolJob *	getCurrentThreadPoolJob ()

Detailed Description

The base class that all generator jobs derive from.

This provides access to the jobs progress and also a listener interface so subclasses can be notified when a job is started or completed.

Definition at line 29 of file tracktion_RenderManager.h.

Member Typedef Documentation

◆ Ptr

using tracktion::engine::RenderManager::Job::Ptr = juce::ReferenceCountedObjectPtr<Job>

Definition at line 35 of file tracktion_RenderManager.h.

Constructor & Destructor Documentation

◆ ~Job()

tracktion::engine::RenderManager::Job::~Job ( )

override

Definition at line 29 of file tracktion_RenderManager.cpp.

◆ Job()

tracktion::engine::RenderManager::Job::Job	(	Engine &	e,
		const AudioFile &	proxy
	)

protected

Definition at line 14 of file tracktion_RenderManager.cpp.

Member Function Documentation

◆ addListener()

void tracktion::engine::RenderManager::Job::addListener ( Listener * l )

Definition at line 66 of file tracktion_RenderManager.h.

◆ cancelJob()

void tracktion::engine::RenderManager::Job::cancelJob ( )

Cancels the current job safely making sure any listeners are called appropriately.

Definition at line 76 of file tracktion_RenderManager.cpp.

◆ cleanUpDanglingJob()

void tracktion::engine::RenderManager::Job::cleanUpDanglingJob ( )

Called during app shutdown by the manager on any jobs that haven't had a chance to recieve their async completion callbacks.

Definition at line 51 of file tracktion_RenderManager.h.

◆ completeRender()

virtual bool tracktion::engine::RenderManager::Job::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::AggregateJob, tracktion::engine::EditRenderJob, tracktion::engine::ReverseRenderJob, tracktion::engine::TransientDetectionJob, and tracktion::engine::WarpTimeRenderJob.

◆ decReferenceCountWithoutDeleting()

bool tracktion::engine::RenderManager::Job::decReferenceCountWithoutDeleting ( )

noexcept

Definition at line 87 of file tracktion_RenderManager.cpp.

◆ getCurrentTaskProgress()

float tracktion::engine::RenderManager::Job::getCurrentTaskProgress ( )

overridevirtual

Returns the progress of the job.

Implements tracktion::engine::ThreadPoolJobWithProgress.

Definition at line 43 of file tracktion_RenderManager.h.

◆ getReferenceCount()

int tracktion::engine::RenderManager::Job::getReferenceCount ( ) const

noexcept

Definition at line 56 of file tracktion_RenderManager.h.

◆ incReferenceCount()

void tracktion::engine::RenderManager::Job::incReferenceCount ( )

noexcept

Definition at line 54 of file tracktion_RenderManager.h.

◆ removeListener()

void tracktion::engine::RenderManager::Job::removeListener ( Listener * l )

Definition at line 67 of file tracktion_RenderManager.h.

◆ renderNextBlock()

virtual bool tracktion::engine::RenderManager::Job::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::AggregateJob, tracktion::engine::EditRenderJob, tracktion::engine::ReverseRenderJob, tracktion::engine::TransientDetectionJob, and tracktion::engine::WarpTimeRenderJob.

◆ runJob()

juce::ThreadPoolJob::JobStatus tracktion::engine::RenderManager::Job::runJob ( )

overridevirtual

Performs the render.

Implements juce::ThreadPoolJob.

Definition at line 38 of file tracktion_RenderManager.cpp.

◆ setUpRender()

virtual bool tracktion::engine::RenderManager::Job::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::AggregateJob, tracktion::engine::EditRenderJob, tracktion::engine::ReverseRenderJob, tracktion::engine::TransientDetectionJob, and tracktion::engine::WarpTimeRenderJob.

Member Data Documentation

◆ engine

Engine& tracktion::engine::RenderManager::Job::engine

Definition at line 70 of file tracktion_RenderManager.h.

◆ progress

std::atomic<float> tracktion::engine::RenderManager::Job::progress

Definition at line 72 of file tracktion_RenderManager.h.

◆ proxy

AudioFile tracktion::engine::RenderManager::Job::proxy

Definition at line 71 of file tracktion_RenderManager.h.

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

tracktion_engine/model/export/tracktion_RenderManager.h
tracktion_engine/model/export/tracktion_RenderManager.cpp

Classes

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ ~Job()

◆ Job()

Member Function Documentation

◆ addListener()

◆ cancelJob()

◆ cleanUpDanglingJob()

◆ completeRender()

◆ decReferenceCountWithoutDeleting()

◆ getCurrentTaskProgress()

◆ getReferenceCount()

◆ incReferenceCount()

◆ removeListener()

◆ renderNextBlock()

◆ runJob()

◆ setUpRender()

Member Data Documentation

◆ engine

◆ progress

◆ proxy