Core functionality of a Zrythm project. More...

#include <src/structure/project/project.h>

Inheritance diagram for zrythm::structure::project::Project:

Collaboration diagram for zrythm::structure::project::Project:

[legend]

Public Types
using	TrackUuid = structure::tracks::TrackUuid
using	PluginPtrVariant = plugins::PluginPtrVariant
using	PluginRegistry = plugins::PluginRegistry
using	ProjectDirectoryPathProvider
using	AudioInputSelectionProvider
	Callback to look up audio input selection for a track.

Public Member Functions
	Project (utils::AppSettings &app_settings, ProjectDirectoryPathProvider project_directory_path_provider, dsp::IHardwareAudioInterface &hw_interface, std::shared_ptr< juce::AudioPluginFormatManager > plugin_format_manager, plugins::PluginHostWindowFactory plugin_host_window_provider, dsp::Metronome &metronome, dsp::Fader &monitor_fader, QObject *parent=nullptr)
structure::tracks::Tracklist *	tracklist () const
structure::scenes::ClipLauncher *	clipLauncher () const
structure::scenes::ClipPlaybackService *	clipPlaybackService () const
dsp::Transport *	getTransport () const
dsp::AudioEngine *	engine () const
dsp::TempoMapWrapper *	getTempoMap () const
structure::arrangement::TempoObjectManager *	tempoObjectManager () const
dsp::Fader &	monitor_fader () const
dsp::Metronome &	metronome () const
auto *	arrangerObjectFactory () const
void	add_default_tracks ()
	Adds the default undeletable tracks to the project.
structure::tracks::FinalTrackDependencies	get_final_track_dependencies () const
auto &	get_file_audio_source_registry () const
auto &	get_track_registry () const
auto &	get_plugin_registry () const
auto &	get_port_registry () const
auto &	get_param_registry () const
auto &	get_arranger_object_registry () const
std::optional< dsp::PortPtrVariant >	find_port_by_id (const dsp::Port::Uuid &id) const
	Finds the Port corresponding to the identifier.
dsp::ProcessorParameter *	find_param_by_id (const dsp::ProcessorParameter::Uuid &id) const
std::optional< plugins::PluginPtrVariant >	find_plugin_by_id (plugins::Plugin::Uuid id) const
std::optional< zrythm::structure::tracks::TrackPtrVariant >	find_track_by_id (structure::tracks::Track::Uuid id) const
std::optional< zrythm::structure::arrangement::ArrangerObjectPtrVariant >	find_arranger_object_by_id (structure::arrangement::ArrangerObject::Uuid id) const
const auto &	tempo_map () const
void	set_audio_input_selection_provider (AudioInputSelectionProvider provider)
const auto &	audio_input_selection_provider () const
void	install_recording_callback (structure::tracks::TrackRecordingCallback callback)
	Installs the recording callback used by all tracks.

Data Fields
utils::QObjectUniquePtr< dsp::PortConnectionsManager >	port_connections_manager_
	Must be free'd after engine.
utils::QObjectUniquePtr< dsp::Transport >	transport_
	Timeline metadata like BPM, time signature, etc.
utils::QObjectUniquePtr< dsp::AudioEngine >	audio_engine_
	The audio backend.
std::unique_ptr< dsp::AudioPool >	pool_
	Audio file pool.
utils::QObjectUniquePtr< structure::tracks::Tracklist >	tracklist_
	Manager for region link groups.
boost::unordered_flat_map< structure::tracks::TrackUuid, structure::tracks::TrackPtrVariant >	tracks_rt_
	Realtime cache of tracks.
utils::QObjectUniquePtr< plugins::PluginFactory >	plugin_factory_
std::unique_ptr< structure::tracks::TrackFactory >	track_factory_

Properties
QML_ELEMENT zrythm::structure::tracks::Tracklist *	tracklist
zrythm::structure::scenes::ClipLauncher *	clipLauncher
zrythm::structure::scenes::ClipPlaybackService *	clipPlaybackService
zrythm::dsp::AudioEngine *	engine
zrythm::dsp::Transport *	transport
zrythm::dsp::TempoMapWrapper *	tempoMap
zrythm::structure::arrangement::TempoObjectManager *	tempoObjectManager

Friends
struct	PluginBuilderForDeserialization
void	init_from (Project &obj, const Project &other, utils::ObjectCloneType clone_type)
void	to_json (nlohmann::json &j, const Project &project)
void	from_json (const nlohmann::json &j, Project &project)

Detailed Description

Core functionality of a Zrythm project.

Definition at line 51 of file project.h.

Member Typedef Documentation

◆ AudioInputSelectionProvider

using zrythm::structure::project::Project::AudioInputSelectionProvider

Initial value:

std::function<dsp::AudioInputSelection *(

const structure::tracks::Track::Uuid &)>

zrythm::dsp::AudioInputSelection

Audio hardware input selection for a track.

Definition audio_input_selection.h:28

zrythm::utils::UuidIdentifiableObject< Track >::Uuid

Callback to look up audio input selection for a track.

Set by ProjectSession after construction. Returns nullptr if no selection exists for the given track UUID.

Definition at line 79 of file project.h.

◆ PluginPtrVariant

using zrythm::structure::project::Project::PluginPtrVariant = plugins::PluginPtrVariant

Definition at line 68 of file project.h.

◆ PluginRegistry

using zrythm::structure::project::Project::PluginRegistry = plugins::PluginRegistry

Definition at line 69 of file project.h.

◆ ProjectDirectoryPathProvider

using zrythm::structure::project::Project::ProjectDirectoryPathProvider

Initial value:

std::function<std::filesystem::path (bool for_backup)>

Definition at line 70 of file project.h.

◆ TrackUuid

using zrythm::structure::project::Project::TrackUuid = structure::tracks::TrackUuid

Definition at line 67 of file project.h.

Member Function Documentation

◆ add_default_tracks()

void zrythm::structure::project::Project::add_default_tracks ( )

Adds the default undeletable tracks to the project.

To be called when creating new projects.

◆ arrangerObjectFactory()

auto * zrythm::structure::project::Project::arrangerObjectFactory ( ) const

inline

Definition at line 114 of file project.h.

◆ audio_input_selection_provider()

const auto & zrythm::structure::project::Project::audio_input_selection_provider ( ) const

inline

Definition at line 197 of file project.h.

◆ find_arranger_object_by_id()

std::optional< zrythm::structure::arrangement::ArrangerObjectPtrVariant > zrythm::structure::project::Project::find_arranger_object_by_id ( structure::arrangement::ArrangerObject::Uuid id ) const

inline

Definition at line 184 of file project.h.

◆ find_param_by_id()

dsp::ProcessorParameter * zrythm::structure::project::Project::find_param_by_id ( const dsp::ProcessorParameter::Uuid & id ) const

inline

Definition at line 161 of file project.h.

◆ find_plugin_by_id()

std::optional< plugins::PluginPtrVariant > zrythm::structure::project::Project::find_plugin_by_id ( plugins::Plugin::Uuid id ) const

inline

Definition at line 172 of file project.h.

◆ find_port_by_id()

std::optional< dsp::PortPtrVariant > zrythm::structure::project::Project::find_port_by_id ( const dsp::Port::Uuid & id ) const

inline

Finds the Port corresponding to the identifier.

Parameters

id	The PortIdentifier to use for searching.

Note: Ported from Port::find_from_identifier() in older code.

Definition at line 155 of file project.h.

◆ find_track_by_id()

std::optional< zrythm::structure::tracks::TrackPtrVariant > zrythm::structure::project::Project::find_track_by_id ( structure::tracks::Track::Uuid id ) const

inline

Definition at line 178 of file project.h.

◆ get_arranger_object_registry()

auto & zrythm::structure::project::Project::get_arranger_object_registry ( ) const

inline

Definition at line 142 of file project.h.

◆ get_file_audio_source_registry()

auto & zrythm::structure::project::Project::get_file_audio_source_registry ( ) const

inline

Definition at line 134 of file project.h.

◆ get_param_registry()

auto & zrythm::structure::project::Project::get_param_registry ( ) const

inline

Definition at line 141 of file project.h.

◆ get_plugin_registry()

auto & zrythm::structure::project::Project::get_plugin_registry ( ) const

inline

Definition at line 139 of file project.h.

◆ get_port_registry()

auto & zrythm::structure::project::Project::get_port_registry ( ) const

inline

Definition at line 140 of file project.h.

◆ get_track_registry()

auto & zrythm::structure::project::Project::get_track_registry ( ) const

inline

Definition at line 138 of file project.h.

◆ install_recording_callback()

void zrythm::structure::project::Project::install_recording_callback ( structure::tracks::TrackRecordingCallback callback )

Installs the recording callback used by all tracks.

Must be called exactly once by ProjectSession after construction, before any tracks are created.

◆ set_audio_input_selection_provider()

void zrythm::structure::project::Project::set_audio_input_selection_provider ( AudioInputSelectionProvider provider )

inline

Definition at line 192 of file project.h.

◆ tempo_map()

const auto & zrythm::structure::project::Project::tempo_map ( ) const

inline

Definition at line 190 of file project.h.

◆ PluginBuilderForDeserialization

friend struct PluginBuilderForDeserialization

friend

Definition at line 64 of file project.h.

Field Documentation

◆ audio_engine_

utils::QObjectUniquePtr<dsp::AudioEngine> zrythm::structure::project::Project::audio_engine_

The audio backend.

Definition at line 270 of file project.h.

◆ plugin_factory_

utils::QObjectUniquePtr<plugins::PluginFactory> zrythm::structure::project::Project::plugin_factory_

Definition at line 302 of file project.h.

◆ pool_

std::unique_ptr<dsp::AudioPool> zrythm::structure::project::Project::pool_

Audio file pool.

Definition at line 273 of file project.h.

◆ port_connections_manager_

utils::QObjectUniquePtr<dsp::PortConnectionsManager> zrythm::structure::project::Project::port_connections_manager_

Must be free'd after engine.

Definition at line 259 of file project.h.

◆ track_factory_

std::unique_ptr<structure::tracks::TrackFactory> zrythm::structure::project::Project::track_factory_

Definition at line 303 of file project.h.

◆ tracklist_

utils::QObjectUniquePtr<structure::tracks::Tracklist> zrythm::structure::project::Project::tracklist_

Manager for region link groups.

Tracklist.

Must be free'd before engine and port connection manager.

Definition at line 283 of file project.h.

◆ tracks_rt_

boost::unordered_flat_map< structure::tracks::TrackUuid, structure::tracks::TrackPtrVariant> zrythm::structure::project::Project::tracks_rt_

Realtime cache of tracks.

Definition at line 291 of file project.h.

◆ transport_

utils::QObjectUniquePtr<dsp::Transport> zrythm::structure::project::Project::transport_

Timeline metadata like BPM, time signature, etc.

Definition at line 265 of file project.h.

Property Documentation

◆ clipLauncher

zrythm::structure::scenes::ClipLauncher * zrythm::structure::project::Project::clipLauncher

read

Definition at line 56 of file project.h.

◆ clipPlaybackService

zrythm::structure::scenes::ClipPlaybackService * zrythm::structure::project::Project::clipPlaybackService

read

Definition at line 57 of file project.h.

◆ engine

zrythm::dsp::AudioEngine * zrythm::structure::project::Project::engine

read

Definition at line 58 of file project.h.

◆ tempoMap

zrythm::dsp::TempoMapWrapper * zrythm::structure::project::Project::tempoMap

read

Definition at line 60 of file project.h.

◆ tempoObjectManager

zrythm::structure::arrangement::TempoObjectManager * zrythm::structure::project::Project::tempoObjectManager

read

Definition at line 61 of file project.h.

◆ tracklist

QML_ELEMENT zrythm::structure::tracks::Tracklist * zrythm::structure::project::Project::tracklist

read

Definition at line 55 of file project.h.

◆ transport

zrythm::dsp::Transport * zrythm::structure::project::Project::transport

read

Definition at line 59 of file project.h.

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

src/structure/project/project.h

Public Types

Public Member Functions

Data Fields

Properties

Friends

Detailed Description

Member Typedef Documentation

◆ AudioInputSelectionProvider

◆ PluginPtrVariant

◆ PluginRegistry

◆ ProjectDirectoryPathProvider

◆ TrackUuid

Member Function Documentation

◆ add_default_tracks()

◆ arrangerObjectFactory()

◆ audio_input_selection_provider()

◆ find_arranger_object_by_id()

◆ find_param_by_id()

◆ find_plugin_by_id()

◆ find_port_by_id()

◆ find_track_by_id()

◆ get_arranger_object_registry()

◆ get_file_audio_source_registry()

◆ get_param_registry()

◆ get_plugin_registry()

◆ get_port_registry()

◆ get_track_registry()

◆ install_recording_callback()

◆ set_audio_input_selection_provider()

◆ tempo_map()

Friends And Related Symbol Documentation

◆ PluginBuilderForDeserialization

Field Documentation

◆ audio_engine_

◆ plugin_factory_

◆ pool_

◆ port_connections_manager_

◆ track_factory_

◆ tracklist_

◆ tracks_rt_

◆ transport_

Property Documentation

◆ clipLauncher

◆ clipPlaybackService

◆ engine

◆ tempoMap

◆ tempoObjectManager

◆ tracklist

◆ transport