tracktion::engine::BlockBasedRenderJob Struct Reference

Inheritance diagram for tracktion::engine::BlockBasedRenderJob:

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

Protected Member Functions
SampleCount	getNumSamplesForCurrentBlock () const
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

Protected Attributes
std::unique_ptr< juce::AudioFormatReader >	reader
std::unique_ptr< AudioFileWriter >	writer
double	sourceLengthSeconds
SampleCount	position
SampleCount	sourceLengthSamples

Additional Inherited Members
Public Types inherited from tracktion::engine::ClipEffect::ClipEffectRenderJob
using	Ptr = juce::ReferenceCountedObjectPtr< ClipEffectRenderJob >
Public Attributes inherited from tracktion::engine::ClipEffect::ClipEffectRenderJob
Engine &	engine
const AudioFile	destination
const AudioFile	source
const SampleCount	blockSize
std::atomic< float >	progress
Static Public Attributes inherited from tracktion::engine::ClipEffect::ClipEffectRenderJob
static constexpr SampleCount	defaultBlockSize

Detailed Description

Definition at line 570 of file tracktion_ClipEffects.cpp.

Constructor & Destructor Documentation

BlockBasedRenderJob()

tracktion::engine::BlockBasedRenderJob::BlockBasedRenderJob	(	Engine &	e,
		const AudioFile &	dest,
		const AudioFile &	src,
		double	sourceLength
	)

Definition at line 572 of file tracktion_ClipEffects.cpp.

Member Function Documentation

completeRender()

bool tracktion::engine::BlockBasedRenderJob::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 603 of file tracktion_ClipEffects.cpp.

getNumSamplesForCurrentBlock()

SampleCount tracktion::engine::BlockBasedRenderJob::getNumSamplesForCurrentBlock ( ) const

protected

Definition at line 619 of file tracktion_ClipEffects.cpp.

setUpRender()

bool tracktion::engine::BlockBasedRenderJob::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.

Reimplemented in tracktion::engine::MakeMonoEffect::MakeMonoRenderJob.

Definition at line 578 of file tracktion_ClipEffects.cpp.

Member Data Documentation

position

SampleCount tracktion::engine::BlockBasedRenderJob::position

protected

Definition at line 617 of file tracktion_ClipEffects.cpp.

reader

std::unique_ptr<juce::AudioFormatReader> tracktion::engine::BlockBasedRenderJob::reader

protected

Definition at line 613 of file tracktion_ClipEffects.cpp.

sourceLengthSamples

SampleCount tracktion::engine::BlockBasedRenderJob::sourceLengthSamples

protected

Definition at line 617 of file tracktion_ClipEffects.cpp.

sourceLengthSeconds

double tracktion::engine::BlockBasedRenderJob::sourceLengthSeconds

protected

Definition at line 616 of file tracktion_ClipEffects.cpp.

writer

std::unique_ptr<AudioFileWriter> tracktion::engine::BlockBasedRenderJob::writer

protected

Definition at line 614 of file tracktion_ClipEffects.cpp.

---

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

• tracktion_engine/model/clips/tracktion_ClipEffects.cpp