tracktion::engine::Renderer::RenderTask Class Reference

Task that actually performs the render operation in blocks. More...

#include "tracktion_Renderer.h"

Inheritance diagram for tracktion::engine::Renderer::RenderTask:

Public Member Functions
	RenderTask (const juce::String &taskDescription, const Renderer::Parameters &, std::atomic< float > *progressToUpdate, juce::AudioFormatWriter::ThreadedWriter::IncomingDataReceiver *)
	RenderTask (const juce::String &taskDescription, const Renderer::Parameters &, std::unique_ptr< tracktion::graph::Node >, std::unique_ptr< tracktion::graph::PlayHead >, std::unique_ptr< tracktion::graph::PlayHeadState >, std::unique_ptr< ProcessState >, std::atomic< float > *progressToUpdate, juce::AudioFormatWriter::ThreadedWriter::IncomingDataReceiver *)
JobStatus	runJob () override
float	getCurrentTaskProgress () override
bool	performNormalisingAndTrimming (const Renderer::Parameters &target, const Renderer::Parameters &intermediate)
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 *)

Static Public Member Functions
static void	flushAllPlugins (const Plugin::Array &, double sampleRate, int samplesPerBlock)
static void	setAllPluginsRealtime (const Plugin::Array &, bool realtime)
static bool	addMidiMetaDataAndWriteToFile (juce::File, juce::MidiMessageSequence, const TempoSequence &)
Static Public Member Functions inherited from juce::ThreadPoolJob
static ThreadPoolJob *	getCurrentThreadPoolJob ()

Public Attributes
Renderer::Parameters	params
juce::String	errorMessage
Public Attributes inherited from juce::ThreadPoolJob
	jobHasFinished
	jobNeedsRunningAgain

Additional Inherited Members
Public Types inherited from juce::ThreadPoolJob
enum	JobStatus

Detailed Description

Task that actually performs the render operation in blocks.

You should continually call the runJob method until it returns jobHasFinished.

Definition at line 86 of file tracktion_Renderer.h.

Constructor & Destructor Documentation

RenderTask() [1/2]

tracktion::engine::Renderer::RenderTask::RenderTask	(	const juce::String &	taskDescription,
		const Renderer::Parameters &	r,
		std::atomic< float > *	progressToUpdate,
		juce::AudioFormatWriter::ThreadedWriter::IncomingDataReceiver *	source
	)

Definition at line 114 of file tracktion_Renderer.cpp.

RenderTask() [2/2]

tracktion::engine::Renderer::RenderTask::RenderTask	(	const juce::String &	taskDescription,
		const Renderer::Parameters &	rp,
		std::unique_ptr< tracktion::graph::Node >	n,
		std::unique_ptr< tracktion::graph::PlayHead >	playHead_,
		std::unique_ptr< tracktion::graph::PlayHeadState >	playHeadState_,
		std::unique_ptr< ProcessState >	processState_,
		std::atomic< float > *	progressToUpdate,
		juce::AudioFormatWriter::ThreadedWriter::IncomingDataReceiver *	source
	)

Definition at line 145 of file tracktion_Renderer.cpp.

~RenderTask()

tracktion::engine::Renderer::RenderTask::~RenderTask ( )

override

Definition at line 161 of file tracktion_Renderer.cpp.

Member Function Documentation

addMidiMetaDataAndWriteToFile()

bool tracktion::engine::Renderer::RenderTask::addMidiMetaDataAndWriteToFile ( juce::File  destFile, juce::MidiMessageSequence  outputSequence, const TempoSequence &  tempoSequence  )

static

Definition at line 353 of file tracktion_Renderer.cpp.

flushAllPlugins()

void tracktion::engine::Renderer::RenderTask::flushAllPlugins ( const Plugin::Array &  plugins, double  sampleRate, int  samplesPerBlock  )

static

Definition at line 292 of file tracktion_Renderer.cpp.

getCurrentTaskProgress()

float tracktion::engine::Renderer::RenderTask::getCurrentTaskProgress ( )

overridevirtual

Implements tracktion::engine::ThreadPoolJobWithProgress.

Definition at line 106 of file tracktion_Renderer.h.

performNormalisingAndTrimming()

bool tracktion::engine::Renderer::RenderTask::performNormalisingAndTrimming	(	const Renderer::Parameters &	target,
		const Renderer::Parameters &	intermediate
	)

Definition at line 179 of file tracktion_Renderer.cpp.

runJob()

juce::ThreadPoolJob::JobStatus tracktion::engine::Renderer::RenderTask::runJob ( )

overridevirtual

Implements juce::ThreadPoolJob.

Definition at line 165 of file tracktion_Renderer.cpp.

setAllPluginsRealtime()

void tracktion::engine::Renderer::RenderTask::setAllPluginsRealtime ( const Plugin::Array &  plugins, bool  realtime  )

static

Definition at line 330 of file tracktion_Renderer.cpp.

Member Data Documentation

errorMessage

juce::String tracktion::engine::Renderer::RenderTask::errorMessage

Definition at line 109 of file tracktion_Renderer.h.

params

Renderer::Parameters tracktion::engine::Renderer::RenderTask::params

Definition at line 108 of file tracktion_Renderer.h.

---

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

• tracktion_engine/model/export/tracktion_Renderer.h
• tracktion_engine/model/export/tracktion_Renderer.cpp