#include <tracktion_ARAWrapperInterfaces.h>

Classes
struct	ScopedEdit

class	ScopedEditorView
	RAII registration of an editor view bound to this document - a clip player's instance or an additional binding like the plugin panel's browser instance - for selection fan-out (see ARAClipPlayer::setViewSelection). More...

Public Member Functions
	ARADocument (Edit &sourceEdit, ARAInstance validPluginWrapper, const ARAPlugInExtensionInstance &, const ARADocumentControllerInstance &dc, ARADocumentControllerHostInstance dchi, ArchivingState *archState)

	~ARADocument ()

bool	canEdit (bool dontCheckMusicalContext) const

void	beginEditing (bool dontCheckMusicalContext)

void	endEditing (bool dontCheckMusicalContext)

void	flushStateToValueTree (juce::ValueTree &v)

void	beginRestoringState (const juce::ValueTree &state)

void	endRestoringState (juce::Array< PersistentIDMappingGroup > groups={})

juce::MemoryBlock	storeObjectsForCopy (ARAAudioSourceRef source, ARAAudioModificationRef modification)
	Store a partial ARA archive containing just the given audio source and modification.

void	restoreObjectsForPaste (const juce::MemoryBlock &data, const juce::String &archivedSourceID, const juce::String &currentSourceID, const juce::String &archivedModID, const juce::String &currentModID, const juce::String &documentArchiveID={})
	Restore a partial ARA archive, mapping archived persistent IDs to current ones.

void	willCreatePlaybackRegionOnTrack (Track *track)

void	willDestroyPlaybackRegionOnTrack (EditItemID trackID)

std::shared_ptr< AudioSourceWrapper >	acquireAudioSource (AudioClipBase &audioClip)

void	releaseAudioSource (const juce::String &key)

void	visitEditorViews (const std::function< void(const ARAPlugInExtensionInstance &, ExternalPlugin &)> &fn) const
	Calls the given function for every registered editor view.

void	musicalContextContentChanged ()
	Notifies the plugin that the edit's tempo/key/chord content has changed so the musical context is re-read.

Public Attributes
Edit &	edit

const ARADocumentControllerInterface *	dci

ARADocumentControllerRef	dcRef

std::unique_ptr< MusicalContextWrapper >	musicalContext

std::map< EditItemID, std::unique_ptr< RegionSequenceWrapper > >	regionSequences

std::map< EditItemID, int >	regionSequencePlaybackRegionCount

std::map< juce::String, std::shared_ptr< AudioSourceWrapper > >	audioSources

std::map< juce::String, int >	audioSourceRefCount

std::unique_ptr< juce::MemoryBlock >	lastArchiveState

juce::String	lastArchiveDocumentArchiveID

Constructor & Destructor Documentation

◆ ARADocument()

ARADocument::ARADocument	(	Edit &	sourceEdit,
		ARAInstance *	validPluginWrapper,
		const ARAPlugInExtensionInstance &	,
		const ARADocumentControllerInstance &	dc,
		ARADocumentControllerHostInstance *	dchi,
		ArchivingState *	archState
	)

References CRASH_TRACER, and musicalContext.

◆ ~ARADocument()

ARADocument::~ARADocument ( )

References audioSourceRefCount, audioSources, CRASH_TRACER, dci, dcRef, musicalContext, and regionSequences.

Member Function Documentation

◆ canEdit()

bool ARADocument::canEdit ( bool dontCheckMusicalContext ) const

References dci, dcRef, lastArchiveState, and musicalContext.

Referenced by beginEditing(), endEditing(), and MusicalContextWrapper::update().

◆ beginEditing()

void ARADocument::beginEditing ( bool dontCheckMusicalContext )

References canEdit(), dci, and dcRef.

Referenced by beginRestoringState(), and ARADocument::ScopedEdit::ScopedEdit().

◆ endEditing()

void ARADocument::endEditing ( bool dontCheckMusicalContext )

References canEdit(), dci, and dcRef.

Referenced by ARADocument::ScopedEdit::~ScopedEdit().

◆ flushStateToValueTree()

void ARADocument::flushStateToValueTree ( juce::ValueTree & v )

References CRASH_TRACER, dci, and dcRef.

◆ beginRestoringState()

void ARADocument::beginRestoringState ( const juce::ValueTree & state )

Note: Must not be editing or already restoring the document while restoring from a state.

References beginEditing(), CRASH_TRACER, lastArchiveDocumentArchiveID, and lastArchiveState.

◆ endRestoringState()

void ARADocument::endRestoringState ( juce::Array< PersistentIDMappingGroup > groups = {} )

◆ storeObjectsForCopy()

juce::MemoryBlock ARADocument::storeObjectsForCopy	(	ARAAudioSourceRef	source,
		ARAAudioModificationRef	modification
	)

Store a partial ARA archive containing just the given audio source and modification.

Used by clipboard copy to capture ARA plugin edits (e.g. Melodyne note corrections).

References CRASH_TRACER, dci, dcRef, and T_ARA_DBG.

◆ restoreObjectsForPaste()

void ARADocument::restoreObjectsForPaste	(	const juce::MemoryBlock &	data,
		const juce::String &	archivedSourceID,
		const juce::String &	currentSourceID,
		const juce::String &	archivedModID,
		const juce::String &	currentModID,
		const juce::String &	documentArchiveID = `{}`
	)

Restore a partial ARA archive, mapping archived persistent IDs to current ones.

Used by clipboard paste to restore ARA plugin edits into a newly pasted clip.

◆ willCreatePlaybackRegionOnTrack()

void ARADocument::willCreatePlaybackRegionOnTrack ( Track * track )

References regionSequencePlaybackRegionCount, and regionSequences.

Referenced by PlaybackRegionWrapper::PlaybackRegionWrapper(), and PlaybackRegionWrapper::PlaybackRegionWrapper().

◆ willDestroyPlaybackRegionOnTrack()

void ARADocument::willDestroyPlaybackRegionOnTrack ( EditItemID trackID )

References regionSequencePlaybackRegionCount, and regionSequences.

Referenced by PlaybackRegionWrapper::~PlaybackRegionWrapper().

◆ acquireAudioSource()

std::shared_ptr< AudioSourceWrapper > ARADocument::acquireAudioSource ( AudioClipBase & audioClip )

References audioSourceRefCount, and audioSources.

Referenced by PlaybackRegionAndSource::PlaybackRegionAndSource().

◆ releaseAudioSource()

void ARADocument::releaseAudioSource ( const juce::String & key )

References audioSourceRefCount, and audioSources.

Referenced by PlaybackRegionAndSource::~PlaybackRegionAndSource().

◆ visitEditorViews()

void ARADocument::visitEditorViews ( const std::function< void(const ARAPlugInExtensionInstance &, ExternalPlugin &)> & fn ) const

Calls the given function for every registered editor view.

◆ musicalContextContentChanged()

void ARADocument::musicalContextContentChanged ( )

Notifies the plugin that the edit's tempo/key/chord content has changed so the musical context is re-read.

Driven at document level (Edit::sendTempoOrPitchSequenceChangedUpdates → ARADocumentHolder) so it also works when no ARA clips exist to forward the change, e.g. a browser/panel-only instance (QA 16550).

References musicalContext.