Represents a track in the project. More...

#include <src/gui/dsp/track.h>

Inheritance diagram for Track:

[legend]

Collaboration diagram for Track:

[legend]

Public Types
enum class	Type { Instrument , Audio , Master , Chord , Marker , Tempo , Modulator , AudioBus , AudioGroup , Midi , MidiBus , MidiGroup , Folder }
	The Track's type. More...

using	PortType = dsp::PortType

using	PluginRegistry = gui::old_dsp::plugins::PluginRegistry

using	PluginPtrVariant = PluginRegistry::VariantType

using	PluginSlot = plugins::PluginSlot

using	TrackSelectionStatusGetter = std::function<bool (const TrackUuid &)>

using	Color = zrythm::utils::Color

using	Position = zrythm::dsp::Position

Public Types inherited from IPortOwner
using	TrackUuid = dsp::PortIdentifier::TrackUuid

using	PluginUuid = dsp::PortIdentifier::PluginUuid

using	PortUuid = dsp::PortIdentifier::PortUuid

Public Member Functions
virtual void	init_loaded (PluginRegistry &plugin_registry, PortRegistry &port_registry)=0
	Adds additional metadata to track members after deserialization.

Tracklist *	get_tracklist () const

dsp::PortConnectionsManager *	get_port_connections_manager () const

bool	has_piano_roll () const

bool	should_be_visible () const
	Returns whether the track should be visible.

bool	is_tempo () const

bool	is_folder () const

bool	is_audio_group () const

bool	is_midi_group () const

bool	is_audio_bus () const

bool	is_midi_bus () const

bool	is_modulator () const

bool	is_chord () const

bool	is_marker () const

bool	is_audio () const

bool	is_instrument () const

bool	is_midi () const

bool	is_master () const

bool	is_deletable () const

bool	is_copyable () const

template<typename DerivedT> requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>>
double	get_full_visible_height (this DerivedT &&self)
	Returns the full visible height (main height + height of all visible automation tracks + height of all visible lanes).

template<typename DerivedT> requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>>
bool	multiply_heights (this DerivedT &&self, double multiplier, bool visible_only, bool check_only)

bool	is_auditioner () const
	Whether this track is part of the SampleProcessor auditioner tracklist.

bool	can_be_group_target () const

bool	is_frozen () const

template<FinalRegionSubclass RegionT, FinalClass SelfT>
void	insert_region (this SelfT &self, ArrangerObjectUuidReference region_ref, AutomationTrack *at, std::optional< int > lane_pos, std::optional< int > idx, bool gen_name)
	Inserts a Region to the given lane or AutomationTrack of the track, at the given index.

void	write_audio_clip_to_pool_after_adding_audio_region (AudioClip &clip) const

template<FinalRegionSubclass RegionT>
void	add_region (this auto &self, auto region_ref, AutomationTrack *at, std::optional< int > lane_pos, bool gen_name)
	Appends a Region to the given lane or AutomationTrack of the track.

void	append_objects (std::vector< ArrangerObjectPtrVariant > &objects) const
	Appends all the objects in the track to `objects`.

void	unselect_all ()
	Unselects all arranger objects in the track.

template<typename DerivedT> requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>>
bool	contains_uninstantiated_plugin (this DerivedT &&self)

utils::Utf8String	get_node_name () const override
	Returns a human friendly name of the node.

virtual void	clear_objects ()
	Removes all objects recursively from the track.

virtual bool	validate () const =0
	Verifies the identifiers on a live Track (in the project, not a clone).

void	add_folder_parents (std::vector< FoldableTrack * > &parents, bool prepend) const
	Adds the track's folder parents to the given vector.

FoldableTrack *	get_direct_folder_parent () const
	Returns the closest foldable parent or NULL.

void	remove_from_folder_parents ()
	Remove the track from all folders.

utils::Utf8String	get_name () const
	Getter for the track name.

bool	set_name_with_action_full (const utils::Utf8String &name)
	Internally called by set_name_with_action().

void	set_name_with_action (const utils::Utf8String &name)
	Setter to be used by the UI to create an undoable action.

void	set_name (const Tracklist &tracklist, const utils::Utf8String &name, bool pub_events)
	Setter for the track name.

utils::Utf8String	get_unique_name (const Tracklist &tracklist, const utils::Utf8String &name)
	Returns a unique name for a new track based on the given name.

void	update_positions (bool from_ticks, bool bpm_change, dsp::FramesPerTick frames_per_tick)
	Updates the frames/ticks of each position in each child of the track recursively.

virtual void	get_regions_in_range (std::vector< Region * > &regions, const dsp::Position p1, const dsp::Position p2)
	Returns all the regions inside the given range, or all the regions if both p1 and p2 are NULL.

int	get_index () const

void	set_index (int index)

auto	get_input_signal_type () const

auto	get_output_signal_type () const

template<typename DerivedT> requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>>
void	get_plugins (this DerivedT &&self, std::vector< zrythm::gui::old_dsp::plugins::Plugin * > &arr)
	Fills in the given array with all plugins in the track.

template<typename DerivedT> requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>>
void	activate_all_plugins (this DerivedT &&self, bool activate)
	Activate or deactivate all plugins.

utils::Utf8String	get_comment () const

void	set_comment (const utils::Utf8String &comment, bool undoable)

void	set_comment_with_action (const utils::Utf8String &comment)

void	set_color (const Color &color, bool undoable, bool fire_events)
	Sets the track color.

void	set_icon (const utils::Utf8String &icon_name, bool undoable, bool fire_events)
	Sets the track icon.

virtual void	append_ports (std::vector< Port * > &ports, bool include_plugins) const =0
	Appends all channel ports and optionally plugin ports to the array.

void	track_freeze (bool freeze)
	Freezes or unfreezes the track.

template<typename DerivedT> requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>>
PluginPtrVariant	insert_plugin (this DerivedT &&self, PluginUuid plugin_id, plugins::PluginSlot slot, bool instantiate_plugin, bool replacing_plugin, bool moving_plugin, bool confirm, bool gen_automatables, bool recalc_graph, bool fire_events)
	Wrapper over Channel.add_plugin() and ModulatorTrack.insert_modulator().

template<typename SelfT> requires ( std::derived_from<SelfT, ChannelTrack> \|\| std::is_same_v<SelfT, ModulatorTrack>)
void	remove_plugin (this SelfT &self, plugins::PluginSlot slot)
	Wrapper over Channel::remove_plugin() and ModulatorTrack::remove_modulator().

template<typename SelfT> requires ( std::derived_from<SelfT, ChannelTrack> \|\| std::is_same_v<SelfT, ModulatorTrack>)
plugins::PluginSlot	get_plugin_slot (this const SelfT &self, const PluginUuid &plugin_id)

void	disconnect_track ()
	Disconnects the track from the processing chain and removes any plugins it contains.

bool	is_enabled () const

bool	get_enabled () const

bool	get_disabled () const

void	set_enabled (bool enabled)

void	set_enabled (bool enabled, bool trigger_undo, bool auto_select, bool fire_events)

int	get_total_bars (const Transport &transport, int total_bars) const

void	set_caches (CacheType types)
	Set various caches (snapshots, track name hash, plugin input/output ports, etc).

bool	is_in_active_project () const override

void	set_port_metadata_from_owner (dsp::PortIdentifier &id, PortRange &range) const override
	Function that will be called by the Port to update the identifier's relevant members based on this port owner.

utils::Utf8String	get_full_designation_for_port (const dsp::PortIdentifier &id) const override

virtual bool	get_muted () const

virtual bool	get_listened () const

virtual bool	get_implied_soloed () const
	Returns whether the track is not soloed on its own but its direct out (or its direct out's direct out, etc.) is soloed.

virtual bool	get_soloed () const

void	set_selection_status_getter (TrackSelectionStatusGetter getter)

void	unset_selection_status_getter ()

auto &	get_plugin_registry () const

auto &	get_plugin_registry ()

auto &	get_port_registry () const

auto &	get_port_registry ()

auto &	get_object_registry () const

auto &	get_object_registry ()

auto	get_type () const

auto	get_icon_name () const

Public Member Functions inherited from zrythm::dsp::graph::IProcessable
virtual nframes_t	get_single_playback_latency () const
	Returns the latency of only the given processable, without adding the previous/next latencies.

virtual void	process_block (EngineProcessTimeInfo time_nfo)

virtual void	clear_external_buffer (nframes_t block_length)

virtual bool	needs_external_buffer_clear_on_early_return () const

Public Member Functions inherited from IPortOwner
virtual void	on_control_change_event (const PortUuid &port_uuid, const dsp::PortIdentifier &id, float val)
	Will be called when a control port's value changes.

virtual void	on_midi_activity (const dsp::PortIdentifier &id)
	Called during processing if the MIDI port contains new MIDI events.

virtual bool	should_sum_data_from_backend () const
	Whether during processing, the port should sum the data from its backend buffers coming in.

virtual bool	should_bounce_to_master (utils::audio::BounceStep step) const
	Whether the port should add its data to the master output when bouncing.

virtual bool	are_events_on_midi_channel_approved (midi_byte_t channel) const
	Returns whether MIDI events on this channel on an input port should be processed (not ignored).

Public Member Functions inherited from zrythm::utils::UuidIdentifiableObject< Track >
	UuidIdentifiableObject (const Uuid &id)

	UuidIdentifiableObject (const UuidIdentifiableObject &other)=default

	UuidIdentifiableObject (UuidIdentifiableObject &&other)=default

UuidIdentifiableObject &	operator= (const UuidIdentifiableObject &other)=default

UuidIdentifiableObject &	operator= (UuidIdentifiableObject &&other)=default

auto	get_uuid () const

void	copy_members_from (const UuidIdentifiableObject &other)

Static Public Member Functions
static Fader::Type	type_get_prefader_type (const Type type)
	Returns the prefader type.

static constexpr bool	type_can_have_direct_out (Type type)

static bool	type_can_have_region_type (Type type, ArrangerObject::Type region_type)

static constexpr bool	type_is_copyable (Type type)

static constexpr bool	type_is_deletable (Type type)
	Returns whether a track of the given type should be deletable by the user.

static Type	type_get_from_plugin_descriptor (const zrythm::plugins::PluginDescriptor &descr)

static consteval bool	type_has_mono_compat_switch (const Type tt)

static constexpr bool	type_is_compatible_for_moving (const Type type1, const Type type2)
	Returns if regions in tracks from `type1` can be moved to `type2`.

static constexpr bool	type_has_piano_roll (const Type type)
	Returns if the Track should have a piano roll.

static constexpr bool	type_has_inputs (const Type type)
	Returns if the Track should have an inputs selector.

static bool	type_can_be_group_target (const Type type)
	Returns if the Track can be a direct route target.

template<typename T>
static consteval Type	get_type_for_class ()

static TrackUniquePtrVariant	create_unique_from_type (Type type)

static Track *	from_variant (const TrackPtrVariant &variant)

static bool	is_plugin_descriptor_valid_for_slot_type (const plugins::PluginDescriptor &descr, zrythm::plugins::PluginSlotType slot_type, Track::Type track_type)
	Returns if `descr` can be dropped at `slot_type` in a track of type `track_type`.

static void	create_with_action (Type type, const zrythm::plugins::PluginConfiguration pl_setting, const FileDescriptor file_descr, const dsp::Position *pos, int index, int num_tracks, int disable_track_idx, TracksReadyCallback ready_cb)
	Creates a new track with the given parameters.

static Track *	create_empty_at_idx_with_action (Type type, int index)
	Creates a new empty track at the given index.

static Track *	create_for_plugin_at_idx_w_action (Type type, const zrythm::plugins::PluginConfiguration *pl_setting, int index)
	Creates a new track for the given plugin at the given index.

template<typename T = Track>
static T *	create_for_plugin_at_idx_w_action (const zrythm::plugins::PluginConfiguration *pl_setting, int index)

static Track *	create_empty_with_action (Type type)
	Creates a new empty track at the end of the tracklist.

template<typename T = Track>
static T *	create_empty_with_action ()

static TrackUniquePtrVariant	create_track (Type type, const utils::Utf8String &name, int pos)
	Create a track of the given type with the given name and position.

Data Fields
bool	bounce_ {}
	Set to ON during bouncing if this track should be included.

bool	bounce_to_master_ = false
	Whether to temporarily route the output to master (e.g., when bouncing the track on its own without its parents).

bool	disconnecting_ = false
	Whether currently disconnecting.

bool	trigger_midi_activity_ = false
	Flag to tell the UI that this channel had MIDI activity.

std::optional< AudioClip::Uuid >	frozen_clip_id_
	Pool ID of the clip if track is frozen (unset if not frozen).

Tracklist *	tracklist_ = nullptr
	Pointer to owner tracklist, if any.

std::optional< TrackSelectionStatusGetter >	track_selection_status_getter_
	Track selection status getter.

Static Public Attributes
static constexpr int	MIN_HEIGHT = 26

static constexpr int	DEF_HEIGHT = 52

Protected Member Functions
	Track (Type type, PortType in_signal_type, PortType out_signal_type, PluginRegistry &plugin_registry, PortRegistry &port_registry, ArrangerObjectRegistry &obj_registry)
	Constructor to be used by subclasses.

void	copy_members_from (const Track &other, ObjectCloneType clone_type)

bool	validate_base () const

virtual void	set_playback_caches ()
	Set the playback caches for a track.

void	add_region_if_in_range (const dsp::Position p1, const dsp::Position p2, std::vector< Region * > &regions, Region *region)

Protected Attributes
PluginRegistry &	plugin_registry_

PortRegistry &	port_registry_

ArrangerObjectRegistry &	object_registry_

int	pos_ = 0
	Position in the Tracklist.

Type	type_ = {}
	The type of track this is.

utils::Utf8String	name_
	Track name, used in channel too.

utils::Utf8String	icon_name_
	Icon name of the track.

bool	visible_ = true
	Track Widget created dynamically.

bool	filtered_ = false
	Track will be hidden if true (temporary and not serializable).

double	main_height_ { DEF_HEIGHT }
	Height of the main part (without lanes).

bool	enabled_ = true
	Active (enabled) or not.

Color	color_
	Track color.

PortType	in_signal_type_ = {}
	The input signal type (eg audio bus tracks have audio input signals).

PortType	out_signal_type_ = {}
	The output signal type (eg midi tracks have MIDI output signals).

utils::Utf8String	comment_
	User comments.

Friends
bool	operator< (const Track &lhs, const Track &rhs)

void	to_json (nlohmann::json &j, const Track &track)

void	from_json (const nlohmann::json &j, Track &track)

Detailed Description

Represents a track in the project.

The Track class is the base class for all types of tracks in the project. It provides common functionality and properties shared by all track types, such as the track's position in the tracklist, its label, and whether it is muted.

Subclasses of Track represent specific types of tracks, such as MIDI tracks, instrument tracks, and audio tracks.

Definition at line 278 of file track.h.

Member Typedef Documentation

◆ Color

using Track::Color = zrythm::utils::Color

Definition at line 371 of file track.h.

◆ PluginPtrVariant

using Track::PluginPtrVariant = PluginRegistry::VariantType

Definition at line 289 of file track.h.

◆ PluginRegistry

using Track::PluginRegistry = gui::old_dsp::plugins::PluginRegistry

Definition at line 288 of file track.h.

◆ PluginSlot

using Track::PluginSlot = plugins::PluginSlot

Definition at line 290 of file track.h.

◆ PortType

using Track::PortType = dsp::PortType

Definition at line 287 of file track.h.

◆ Position

using Track::Position = zrythm::dsp::Position

Definition at line 372 of file track.h.

◆ TrackSelectionStatusGetter

using Track::TrackSelectionStatusGetter = std::function<bool (const TrackUuid &)>

Definition at line 292 of file track.h.

Member Enumeration Documentation

◆ Type

enum class Track::Type

strong

The Track's type.

Enumerator
Instrument	Instrument tracks must have an Instrument plugin at the first slot and they produce audio output.
Audio	Audio tracks can record and contain audio clips. Other than that their channel strips are similar to buses.
Master	The master track is a special type of group track.
Chord	The chord track contains chords that can be used to modify midi in real time or to color the piano roll.
Marker	Marker Track's contain named markers at specific Position's in the song.
Tempo	Special track for BPM (tempo) and time signature events.
Modulator	Special track to contain global Modulator's.
AudioBus	Buses are channels that receive audio input and have effects on their channel strip. They are similar to Group Tracks, except that they cannot be routed to directly. Buses are used for send effects.
AudioGroup	Group Tracks are used for grouping audio signals, for example routing multiple drum tracks to a "Drums" group track. Like buses, they only contain effects but unlike buses they can be routed to.
Midi	Midi tracks can only have MIDI effects in the strip and produce MIDI output that can be routed to instrument channels or hardware.
MidiBus	Same with audio bus but for MIDI signals.
MidiGroup	Same with audio group but for MIDI signals.
Folder	Foldable track used for visual grouping.

Definition at line 300 of file track.h.

Constructor & Destructor Documentation

◆ Track()

Track::Track	(	Type	type,
		PortType	in_signal_type,
		PortType	out_signal_type,
		PluginRegistry &	plugin_registry,
		PortRegistry &	port_registry,
		ArrangerObjectRegistry &	obj_registry )

protected

Constructor to be used by subclasses.

Parameters

pos	Position in the Tracklist.

Member Function Documentation

◆ activate_all_plugins()

template<typename DerivedT>
requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>>

void Track::activate_all_plugins	(	this DerivedT &&	self,
		bool	activate )

inline

Activate or deactivate all plugins.

This is useful for exporting: deactivating and reactivating a plugin will reset its state.

Definition at line 985 of file track.h.

◆ add_folder_parents()

void Track::add_folder_parents	(	std::vector< FoldableTrack * > &	parents,
		bool	prepend ) const

Adds the track's folder parents to the given vector.

Parameters

prepend Whether to prepend instead of append.

◆ add_region()

template<FinalRegionSubclass RegionT>

void Track::add_region	(	this auto &	self,
		auto	region_ref,
		AutomationTrack *	at,
		std::optional< int >	lane_pos,
		bool	gen_name )

inline

Appends a Region to the given lane or AutomationTrack of the track.

See also: insert_region().

Exceptions

ZrythmException if the insertion fails.

Definition at line 802 of file track.h.

◆ append_objects()

void Track::append_objects ( std::vector< ArrangerObjectPtrVariant > & objects ) const

Appends all the objects in the track to objects.

This only appends top-level objects. For example, region children will not be added.

Parameters

objects

◆ append_ports()

virtual void Track::append_ports	(	std::vector< Port * > &	ports,
		bool	include_plugins ) const

pure virtual

Appends all channel ports and optionally plugin ports to the array.

Implemented in AudioBusTrack, AudioGroupTrack, AudioTrack, ChordTrack, FolderTrack, InstrumentTrack, MarkerTrack, MasterTrack, MidiBusTrack, MidiGroupTrack, MidiTrack, ModulatorTrack, and TempoTrack.

◆ can_be_group_target()

bool Track::can_be_group_target ( ) const

inline

Definition at line 682 of file track.h.

◆ clear_objects()

virtual void Track::clear_objects ( )

inlinevirtual

Removes all objects recursively from the track.

Reimplemented in AudioTrack, AutomatableTrack, ChordTrack, LanedTrackImpl< TrackLaneT >, LanedTrackImpl< AudioLane >, LanedTrackImpl< MidiLane >, MarkerTrack, PianoRollTrack, and TempoTrack.

Definition at line 845 of file track.h.

◆ contains_uninstantiated_plugin()

template<typename DerivedT>
requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>>

bool Track::contains_uninstantiated_plugin ( this DerivedT && self )

inline

Definition at line 829 of file track.h.

◆ create_empty_at_idx_with_action()

static Track * Track::create_empty_at_idx_with_action	(	Type	type,
		int	index )

static

Creates a new empty track at the given index.

Parameters

type
index
error

Returns: Track*

Exceptions

ZrythmException on error.

◆ create_empty_with_action() [1/2]

template<typename T = Track>

static T * Track::create_empty_with_action ( )

inlinestatic

Definition at line 1282 of file track.h.

◆ create_empty_with_action() [2/2]

static Track * Track::create_empty_with_action ( Type type )

static

Creates a new empty track at the end of the tracklist.

Parameters

type

Returns: Track*

Exceptions

ZrythmException on error.

◆ create_for_plugin_at_idx_w_action() [1/2]

template<typename T = Track>

static T * Track::create_for_plugin_at_idx_w_action	(	const zrythm::plugins::PluginConfiguration *	pl_setting,
		int	index )

inlinestatic

Definition at line 1265 of file track.h.

◆ create_for_plugin_at_idx_w_action() [2/2]

static Track * Track::create_for_plugin_at_idx_w_action	(	Type	type,
		const zrythm::plugins::PluginConfiguration *	pl_setting,
		int	index )

static

Creates a new track for the given plugin at the given index.

Parameters

type
pl_setting
index
error

Returns: Track*

Exceptions

ZrythmException on error.

◆ create_track()

static TrackUniquePtrVariant Track::create_track	(	Type	type,
		const utils::Utf8String &	name,
		int	pos )

staticnodiscard

Create a track of the given type with the given name and position.

Note: Only works for non-singleton tracks.

Parameters

name
pos

◆ create_with_action()

static void Track::create_with_action	(	Type	type,
		const zrythm::plugins::PluginConfiguration *	pl_setting,
		const FileDescriptor *	file_descr,
		const dsp::Position *	pos,
		int	index,
		int	num_tracks,
		int	disable_track_idx,
		TracksReadyCallback	ready_cb )

static

Creates a new track with the given parameters.

Parameters

disable_track_idx	Track index to disable, or -1.
ready_cb	Callback to be called when the tracks are ready (added to the project).

Exceptions

ZrythmException on error.

◆ get_comment()

utils::Utf8String Track::get_comment ( ) const

inline

Definition at line 1013 of file track.h.

◆ get_direct_folder_parent()

FoldableTrack * Track::get_direct_folder_parent ( ) const

inline

Returns the closest foldable parent or NULL.

Definition at line 865 of file track.h.

◆ get_disabled()

bool Track::get_disabled ( ) const

inline

Definition at line 1202 of file track.h.

◆ get_enabled()

bool Track::get_enabled ( ) const

inline

Definition at line 1201 of file track.h.

◆ get_full_designation_for_port()

utils::Utf8String Track::get_full_designation_for_port ( const dsp::PortIdentifier & id ) const

overridevirtual

Reimplemented from IPortOwner.

◆ get_full_visible_height()

template<typename DerivedT>
requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>>

double Track::get_full_visible_height ( this DerivedT && self )

inline

Returns the full visible height (main height + height of all visible automation tracks + height of all visible lanes).

Definition at line 590 of file track.h.

◆ get_icon_name()

auto Track::get_icon_name ( ) const

inline

Definition at line 1337 of file track.h.

◆ get_implied_soloed()

virtual bool Track::get_implied_soloed ( ) const

inlinevirtual

Returns whether the track is not soloed on its own but its direct out (or its direct out's direct out, etc.) is soloed.

Reimplemented in ChannelTrack, and FolderTrack.

Definition at line 1316 of file track.h.

◆ get_index()

int Track::get_index ( ) const

inline

Definition at line 945 of file track.h.

◆ get_input_signal_type()

auto Track::get_input_signal_type ( ) const

inline

Definition at line 948 of file track.h.

◆ get_listened()

virtual bool Track::get_listened ( ) const

inlinevirtual

Reimplemented in ChannelTrack.

Definition at line 1310 of file track.h.

◆ get_muted()

virtual bool Track::get_muted ( ) const

inlinevirtual

Reimplemented in ChannelTrack.

Definition at line 1308 of file track.h.

◆ get_name()

utils::Utf8String Track::get_name ( ) const

inline

Getter for the track name.

Definition at line 886 of file track.h.

◆ get_node_name()

utils::Utf8String Track::get_node_name ( ) const

inlineoverridevirtual

Returns a human friendly name of the node.

Implements zrythm::dsp::graph::IProcessable.

Definition at line 840 of file track.h.

◆ get_object_registry() [1/2]

auto & Track::get_object_registry ( )

inline

Definition at line 1334 of file track.h.

◆ get_object_registry() [2/2]

auto & Track::get_object_registry ( ) const

inline

Definition at line 1333 of file track.h.

◆ get_output_signal_type()

auto Track::get_output_signal_type ( ) const

inline

Definition at line 949 of file track.h.

◆ get_plugin_registry() [1/2]

auto & Track::get_plugin_registry ( )

inline

Definition at line 1330 of file track.h.

◆ get_plugin_registry() [2/2]

auto & Track::get_plugin_registry ( ) const

inline

Definition at line 1329 of file track.h.

◆ get_plugin_slot()

template<typename SelfT>
requires ( std::derived_from<SelfT, ChannelTrack> || std::is_same_v<SelfT, ModulatorTrack>)

plugins::PluginSlot Track::get_plugin_slot	(	this const SelfT &	self,
		const PluginUuid &	plugin_id )

inline

Definition at line 1147 of file track.h.

◆ get_plugins()

template<typename DerivedT>
requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>>

void Track::get_plugins	(	this DerivedT &&	self,
		std::vector< zrythm::gui::old_dsp::plugins::Plugin * > &	arr )

inline

Fills in the given array with all plugins in the track.

Definition at line 955 of file track.h.

◆ get_port_registry() [1/2]

auto & Track::get_port_registry ( )

inline

Definition at line 1332 of file track.h.

◆ get_port_registry() [2/2]

auto & Track::get_port_registry ( ) const

inline

Definition at line 1331 of file track.h.

◆ get_regions_in_range()

virtual void Track::get_regions_in_range	(	std::vector< Region * > &	regions,
		const dsp::Position *	p1,
		const dsp::Position *	p2 )

inlinevirtual

Returns all the regions inside the given range, or all the regions if both p1 and p2 are NULL.

Returns: The number of regions returned.

Reimplemented in AudioTrack, AutomatableTrack, ChordTrack, LanedTrackImpl< TrackLaneT >, and PianoRollTrack.

Definition at line 937 of file track.h.

◆ get_soloed()

virtual bool Track::get_soloed ( ) const

inlinevirtual

Definition at line 1318 of file track.h.

◆ get_type()

auto Track::get_type ( ) const

inline

Definition at line 1336 of file track.h.

◆ get_type_for_class()

template<typename T>

static consteval Type Track::get_type_for_class ( )

inlinestaticconsteval

Definition at line 485 of file track.h.

◆ has_piano_roll()

bool Track::has_piano_roll ( ) const

inline

Definition at line 553 of file track.h.

◆ init_loaded()

virtual void Track::init_loaded	(	PluginRegistry &	plugin_registry,
		PortRegistry &	port_registry )

pure virtual

Adds additional metadata to track members after deserialization.

Note: Each implementor must chain up to its direct superclass.

Implemented in AudioBusTrack, AudioGroupTrack, AudioTrack, AutomatableTrack, ChannelTrack, ChordTrack, FolderTrack, InstrumentTrack, LanedTrackImpl< TrackLaneT >, LanedTrackImpl< AudioLane >, LanedTrackImpl< MidiLane >, MarkerTrack, MasterTrack, MidiBusTrack, MidiGroupTrack, MidiTrack, ModulatorTrack, PianoRollTrack, ProcessableTrack, RecordableTrack, and TempoTrack.

◆ insert_plugin()

template<typename DerivedT>
requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>>

PluginPtrVariant Track::insert_plugin	(	this DerivedT &&	self,
		PluginUuid	plugin_id,
		plugins::PluginSlot	slot,
		bool	instantiate_plugin,
		bool	replacing_plugin,
		bool	moving_plugin,
		bool	confirm,
		bool	gen_automatables,
		bool	recalc_graph,
		bool	fire_events )

inline

Wrapper over Channel.add_plugin() and ModulatorTrack.insert_modulator().

Parameters

instantiate_plugin Whether to attempt to instantiate the plugin.

Definition at line 1063 of file track.h.

◆ insert_region()

template<FinalRegionSubclass RegionT, FinalClass SelfT>

void Track::insert_region	(	this SelfT &	self,
		ArrangerObjectUuidReference	region_ref,
		AutomationTrack *	at,
		std::optional< int >	lane_pos,
		std::optional< int >	idx,
		bool	gen_name )

inline

Inserts a Region to the given lane or AutomationTrack of the track, at the given index.

The Region must be the main region (see ArrangerObjectInfo).

Parameters

at	The AutomationTrack of this Region, if automation region.
lane_pos	The position of the lane to add to, if applicable.
idx	The index to insert the region at inside its parent, or nullopt to append.
gen_name	Generate a unique region name or not. This will be 0 if the caller already generated a unique name.

Exceptions

ZrythmException if the insertion fails.

Definition at line 702 of file track.h.

◆ is_audio()

bool Track::is_audio ( ) const

inline

Definition at line 572 of file track.h.

◆ is_audio_bus()

bool Track::is_audio_bus ( ) const

inline

Definition at line 567 of file track.h.

◆ is_audio_group()

bool Track::is_audio_group ( ) const

inline

Definition at line 565 of file track.h.

◆ is_chord()

bool Track::is_chord ( ) const

inline

Definition at line 570 of file track.h.

◆ is_copyable()

bool Track::is_copyable ( ) const

inline

Definition at line 582 of file track.h.

◆ is_deletable()

bool Track::is_deletable ( ) const

inline

Definition at line 581 of file track.h.

◆ is_enabled()

bool Track::is_enabled ( ) const

inline

Definition at line 1200 of file track.h.

◆ is_folder()

bool Track::is_folder ( ) const

inline

Definition at line 564 of file track.h.

◆ is_frozen()

bool Track::is_frozen ( ) const

inline

Definition at line 684 of file track.h.

◆ is_in_active_project()

bool Track::is_in_active_project ( ) const

overridevirtual

Implements IPortOwner.

◆ is_instrument()

bool Track::is_instrument ( ) const

inline

Definition at line 573 of file track.h.

◆ is_marker()

bool Track::is_marker ( ) const

inline

Definition at line 571 of file track.h.

◆ is_master()

bool Track::is_master ( ) const

inline

Definition at line 575 of file track.h.

◆ is_midi()

bool Track::is_midi ( ) const

inline

Definition at line 574 of file track.h.

◆ is_midi_bus()

bool Track::is_midi_bus ( ) const

inline

Definition at line 568 of file track.h.

◆ is_midi_group()

bool Track::is_midi_group ( ) const

inline

Definition at line 566 of file track.h.

◆ is_modulator()

bool Track::is_modulator ( ) const

inline

Definition at line 569 of file track.h.

◆ is_plugin_descriptor_valid_for_slot_type()

static bool Track::is_plugin_descriptor_valid_for_slot_type	(	const plugins::PluginDescriptor &	descr,
		zrythm::plugins::PluginSlotType	slot_type,
		Track::Type	track_type )

inlinestatic

Returns if descr can be dropped at slot_type in a track of type track_type.

Definition at line 1166 of file track.h.

◆ is_tempo()

bool Track::is_tempo ( ) const

inline

Definition at line 563 of file track.h.

◆ multiply_heights()

template<typename DerivedT>
requires std::derived_from<base_type<DerivedT>, Track> && FinalClass<base_type<DerivedT>>

bool Track::multiply_heights	(	this DerivedT &&	self,
		double	multiplier,
		bool	visible_only,
		bool	check_only )

inline

Definition at line 617 of file track.h.

◆ remove_from_folder_parents()

void Track::remove_from_folder_parents ( )

Remove the track from all folders.

Used when deleting tracks.

◆ remove_plugin()

template<typename SelfT>
requires ( std::derived_from<SelfT, ChannelTrack> || std::is_same_v<SelfT, ModulatorTrack>)

void Track::remove_plugin	(	this SelfT &	self,
		plugins::PluginSlot	slot )

inline

Wrapper over Channel::remove_plugin() and ModulatorTrack::remove_modulator().

Definition at line 1127 of file track.h.

◆ set_comment()

void Track::set_comment	(	const utils::Utf8String &	comment,
		bool	undoable )

Parameters

undoable Create an undable action.

◆ set_comment_with_action()

void Track::set_comment_with_action ( const utils::Utf8String & comment )

inline

Definition at line 1020 of file track.h.

◆ set_enabled()

void Track::set_enabled ( bool enabled )

inline

Definition at line 1203 of file track.h.

◆ set_index()

void Track::set_index ( int index )

inline

Definition at line 946 of file track.h.

◆ set_name()

void Track::set_name	(	const Tracklist &	tracklist,
		const utils::Utf8String &	name,
		bool	pub_events )

Setter for the track name.

If a track with that name already exists, it adds a number at the end.

Must only be called from the GTK thread.

◆ set_playback_caches()

virtual void Track::set_playback_caches ( )

inlineprotectedvirtual

Set the playback caches for a track.

This is called by set_caches().

Reimplemented in AutomatableTrack, LanedTrackImpl< TrackLaneT >, LanedTrackImpl< AudioLane >, LanedTrackImpl< MidiLane >, and PianoRollTrack.

Definition at line 1354 of file track.h.

◆ set_port_metadata_from_owner()

void Track::set_port_metadata_from_owner	(	dsp::PortIdentifier &	id,
		PortRange &	range ) const

overridevirtual

Function that will be called by the Port to update the identifier's relevant members based on this port owner.

Parameters

id	The identifier to update.

Implements IPortOwner.

◆ set_selection_status_getter()

void Track::set_selection_status_getter ( TrackSelectionStatusGetter getter )

inline

Definition at line 1320 of file track.h.

◆ should_be_visible()

bool Track::should_be_visible ( ) const

Returns whether the track should be visible.

Takes into account Track.visible and whether any of the track's foldable parents are folded.

◆ track_freeze()

void Track::track_freeze ( bool freeze )

Freezes or unfreezes the track.

When a track is frozen, it is bounced with effects to a temporary file in the pool, which is played back directly from disk.

When the track is unfrozen, this file will be removed from the pool and the track will be played normally again.

Remarks: Unimplemented/not used.

Exceptions

ZrythmException on error.

◆ type_can_be_group_target()

static bool Track::type_can_be_group_target ( const Type type )

inlinestatic

Returns if the Track can be a direct route target.

Parameters

type

Returns: true; false

Definition at line 479 of file track.h.

◆ type_can_have_direct_out()

static constexpr bool Track::type_can_have_direct_out ( Type type )

inlinestaticconstexpr

Definition at line 400 of file track.h.

◆ type_can_have_region_type()

static bool Track::type_can_have_region_type	(	Type	type,
		ArrangerObject::Type	region_type )

inlinestatic

Definition at line 406 of file track.h.

◆ type_get_prefader_type()

static Fader::Type Track::type_get_prefader_type ( const Type type )

inlinestatic

Returns the prefader type.

Definition at line 377 of file track.h.

◆ type_has_inputs()

static constexpr bool Track::type_has_inputs ( const Type type )

inlinestaticconstexpr

Returns if the Track should have an inputs selector.

Definition at line 467 of file track.h.

◆ type_has_mono_compat_switch()

static consteval bool Track::type_has_mono_compat_switch ( const Type tt )

inlinestaticconsteval

Definition at line 440 of file track.h.

◆ type_has_piano_roll()

static constexpr bool Track::type_has_piano_roll ( const Type type )

inlinestaticconstexpr

Returns if the Track should have a piano roll.

Definition at line 459 of file track.h.

◆ type_is_compatible_for_moving()

static constexpr bool Track::type_is_compatible_for_moving	(	const Type	type1,
		const Type	type2 )

inlinestaticconstexpr

Returns if regions in tracks from type1 can be moved to type2.

Definition at line 449 of file track.h.

◆ type_is_copyable()

static constexpr bool Track::type_is_copyable ( Type type )

inlinestaticconstexpr

Definition at line 423 of file track.h.

◆ type_is_deletable()

static constexpr bool Track::type_is_deletable ( Type type )

inlinestaticconstexpr

Returns whether a track of the given type should be deletable by the user.

Definition at line 432 of file track.h.

◆ unset_selection_status_getter()

void Track::unset_selection_status_getter ( )

inline

Definition at line 1324 of file track.h.

◆ update_positions()

void Track::update_positions	(	bool	from_ticks,
		bool	bpm_change,
		dsp::FramesPerTick	frames_per_tick )

Updates the frames/ticks of each position in each child of the track recursively.

Parameters

from_ticks	Whether to update the positions based on ticks (true) or frames (false).
frames_per_tick	This will be used when doing position conversions via dependency injection instead of relying on the current project's transport.

◆ validate()

virtual bool Track::validate ( ) const

pure virtual

Verifies the identifiers on a live Track (in the project, not a clone).

Returns: True if pass.

Implemented in AudioBusTrack, AudioGroupTrack, AudioTrack, ChordTrack, FolderTrack, InstrumentTrack, MarkerTrack, MasterTrack, MidiBusTrack, MidiGroupTrack, MidiTrack, ModulatorTrack, and TempoTrack.

Friends And Related Symbol Documentation

◆ from_json

void from_json	(	const nlohmann::json &	j,
		Track &	track )

friend

Definition at line 1391 of file track.h.

◆ operator<

bool operator<	(	const Track &	lhs,
		const Track &	rhs )

friend

Definition at line 1339 of file track.h.

◆ to_json

void to_json	(	nlohmann::json &	j,
		const Track &	track )

friend

Definition at line 1375 of file track.h.

Field Documentation

◆ bounce_

bool Track::bounce_ {}

Set to ON during bouncing if this track should be included.

Only relevant for tracks that output audio.

Definition at line 1494 of file track.h.

◆ bounce_to_master_

bool Track::bounce_to_master_ = false

Whether to temporarily route the output to master (e.g., when bouncing the track on its own without its parents).

Definition at line 1500 of file track.h.

◆ color_

Color Track::color_

protected

Track color.

This is used in the channels as well.

Definition at line 1473 of file track.h.

◆ comment_

utils::Utf8String Track::comment_

protected

User comments.

Definition at line 1486 of file track.h.

◆ DEF_HEIGHT

int Track::DEF_HEIGHT = 52

staticconstexpr

Definition at line 295 of file track.h.

◆ disconnecting_

bool Track::disconnecting_ = false

Whether currently disconnecting.

Definition at line 1503 of file track.h.

◆ enabled_

bool Track::enabled_ = true

protected

Active (enabled) or not.

Disabled tracks should be ignored in routing. Similar to Plugin.enabled (bypass).

Definition at line 1466 of file track.h.

◆ filtered_

bool Track::filtered_ = false

protected

Track will be hidden if true (temporary and not serializable).

Definition at line 1455 of file track.h.

◆ frozen_clip_id_

std::optional<AudioClip::Uuid> Track::frozen_clip_id_

Pool ID of the clip if track is frozen (unset if not frozen).

Definition at line 1514 of file track.h.

◆ icon_name_

utils::Utf8String Track::icon_name_

protected

Icon name of the track.

Definition at line 1442 of file track.h.

◆ in_signal_type_

PortType Track::in_signal_type_ = {}

protected

The input signal type (eg audio bus tracks have audio input signals).

Definition at line 1478 of file track.h.

◆ main_height_

double Track::main_height_ { DEF_HEIGHT }

protected

Height of the main part (without lanes).

Definition at line 1458 of file track.h.

◆ MIN_HEIGHT

int Track::MIN_HEIGHT = 26

staticconstexpr

Definition at line 294 of file track.h.

◆ name_

utils::Utf8String Track::name_

protected

Track name, used in channel too.

Definition at line 1439 of file track.h.

◆ object_registry_

ArrangerObjectRegistry& Track::object_registry_

protected

Definition at line 1425 of file track.h.

◆ out_signal_type_

PortType Track::out_signal_type_ = {}

protected

The output signal type (eg midi tracks have MIDI output signals).

Definition at line 1483 of file track.h.

◆ plugin_registry_

PluginRegistry& Track::plugin_registry_

protected

Definition at line 1423 of file track.h.

◆ port_registry_

PortRegistry& Track::port_registry_

protected

Definition at line 1424 of file track.h.

◆ pos_

int Track::pos_ = 0

protected

Position in the Tracklist.

This is also used in the Mixer for the Channels. If a track doesn't have a Channel, the Mixer can just skip.

Definition at line 1433 of file track.h.

◆ track_selection_status_getter_

std::optional<TrackSelectionStatusGetter> Track::track_selection_status_getter_

Track selection status getter.

To be set by the tracklist when a track gets added to it.

Definition at line 1524 of file track.h.

◆ tracklist_

Tracklist* Track::tracklist_ = nullptr

Pointer to owner tracklist, if any.

Definition at line 1517 of file track.h.

◆ trigger_midi_activity_

bool Track::trigger_midi_activity_ = false

Flag to tell the UI that this channel had MIDI activity.

When processing this and setting it to 0, the UI should create a separate event using EVENTS_PUSH.

Definition at line 1511 of file track.h.

◆ type_

Type Track::type_ = {}

protected

The type of track this is.

Definition at line 1436 of file track.h.

◆ visible_

bool Track::visible_ = true

protected

Track Widget created dynamically.

1 track has 1 widget. Whole Track is visible or not.

Definition at line 1452 of file track.h.

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

src/gui/dsp/track.h

Public Types

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Color

◆ PluginPtrVariant

◆ PluginRegistry

◆ PluginSlot

◆ PortType

◆ Position

◆ TrackSelectionStatusGetter

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ Track()

Member Function Documentation

◆ activate_all_plugins()

◆ add_folder_parents()

◆ add_region()

◆ append_objects()

◆ append_ports()

◆ can_be_group_target()

◆ clear_objects()

◆ contains_uninstantiated_plugin()

◆ create_empty_at_idx_with_action()

◆ create_empty_with_action() [1/2]

◆ create_empty_with_action() [2/2]

◆ create_for_plugin_at_idx_w_action() [1/2]

◆ create_for_plugin_at_idx_w_action() [2/2]

◆ create_track()

◆ create_with_action()

◆ get_comment()

◆ get_direct_folder_parent()

◆ get_disabled()

◆ get_enabled()

◆ get_full_designation_for_port()

◆ get_full_visible_height()

◆ get_icon_name()

◆ get_implied_soloed()

◆ get_index()

◆ get_input_signal_type()

◆ get_listened()

◆ get_muted()

◆ get_name()

◆ get_node_name()

◆ get_object_registry() [1/2]

◆ get_object_registry() [2/2]

◆ get_output_signal_type()

◆ get_plugin_registry() [1/2]

◆ get_plugin_registry() [2/2]

◆ get_plugin_slot()

◆ get_plugins()

◆ get_port_registry() [1/2]

◆ get_port_registry() [2/2]

◆ get_regions_in_range()

◆ get_soloed()

◆ get_type()

◆ get_type_for_class()

◆ has_piano_roll()

◆ init_loaded()

◆ insert_plugin()

◆ insert_region()

◆ is_audio()

◆ is_audio_bus()

◆ is_audio_group()

◆ is_chord()

◆ is_copyable()

◆ is_deletable()

◆ is_enabled()

◆ is_folder()

◆ is_frozen()

◆ is_in_active_project()

◆ is_instrument()

◆ is_marker()