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

Inheritance diagram for RegionImpl< RegionT >:

[legend]

Collaboration diagram for RegionImpl< RegionT >:

[legend]

Public Types
using	RegionTPtr = RegionT *

using	ChildT = RegionChildType_t<RegionT>

using	ChildTPtr = ChildT *

Public Types inherited from ArrangerObject
enum class	ResizeType { Normal , Loop , Fade , Stretch , StretchTempoChange }
	Flag used in some functions. More...

enum class	Type { MidiRegion , AudioRegion , ChordRegion , AutomationRegion , MidiNote , ChordObject , ScaleObject , Marker , AutomationPoint }
	The type of the object. More...

enum class	Flags { NonProject = 1 << 0 }
	Flags. More...

enum class	PositionType { Start , End , ClipStart , LoopStart , LoopEnd , FadeIn , FadeOut }

using	SelectionStatusGetter = std::function<bool (const Uuid &)>

using	Position = zrythm::dsp::Position

using	ArrangerObjectPtr = ArrangerObject *

Public Types inherited from NamedObject
using	NameValidator = std::function<bool (const utils::Utf8String &)>

Public Types inherited from ColoredObject
using	Color = zrythm::utils::Color

Public Member Functions
void	append_children (this RegionT &self, std::vector< RegionOwnedObject * > &children)
	Fills the given vector with all the children of this region.

void	fill_midi_events (TrackPtrVariant track_var, const EngineProcessTimeInfo &time_nfo, bool note_off_at_end, bool is_note_off_for_loop_or_region_end, dsp::MidiEventVector &midi_events) const
	Fills MIDI event queue from this MIDI or Chord region.

auto	get_object_ptr (const ArrangerObject::Uuid id) const

auto	get_object_ptr (const ArrangerObjectUuidReference &id) const

auto &	get_arranger_object_registry () const

auto &	get_arranger_object_registry ()

void	remove_all_children (this RegionT &self)
	Removes all children objects from the region.

bool	get_muted (bool check_parent) const override
	Gets the mute status of the object.

ArrangerObjectPtrVariant	add_clone_to_project (bool fire_events) const final
	Appends the ArrangerObject to where it belongs in the project (eg, a Track), without taking into account its previous index (eg, before deletion if undoing).

ArrangerObjectPtrVariant	insert_clone_to_project () const final
	Inserts the object where it belongs in the project (eg, a Track).

void	set_link_group (int group_idx, bool update_identifier)
	Sets the link group to the region.

void	update_identifier (this RegionT &self)
	Disconnects the region and anything using it.

void	unlink ()
	Removes the link group from the region, if any.

bool	are_members_valid (bool is_project, dsp::FramesPerTick frames_per_tick) const

void	stretch (double ratio)
	Stretch the region's contents.

void	create_link_group_if_none ()

Public Member Functions inherited from Region
bool	is_midi () const

bool	is_audio () const

bool	is_automation () const

bool	is_chord () const

RegionLinkGroup *	get_link_group ()
	Returns the region's link group.

bool	has_link_group () const

signed_frame_t	timeline_frames_to_local (signed_frame_t timeline_frames, bool normalize) const
	Converts frames on the timeline (global) to local frames (in the clip).

void	get_frames_till_next_loop_or_end (signed_frame_t timeline_frames, signed_frame_t ret_frames, bool is_loop) const
	Returns the number of frames until the next loop end point or the end of the region.

void	update_link_group ()
	Updates all other regions in the region link group, if any.

bool	is_recording ()
	Returns if this region is currently being recorded onto.

Public Member Functions inherited from ArrangerObject
auto	get_type () const

bool	is_start_hit_by_range (const dsp::Position &start, const dsp::Position &end, bool range_start_inclusive=true, bool range_end_inclusive=false) const
	Returns whether the given object is hit by the given range.

bool	is_start_hit_by_range (const signed_frame_t global_frames_start, const signed_frame_t global_frames_end, bool range_start_inclusive=true, bool range_end_inclusive=false) const

void	set_parent_on_base_qproperties (QObject &derived)
	Set the parent on QObject's that are children of this class.

auto	get_position () const
	Getter.

void	position_setter_validated (const dsp::Position &pos, dsp::TicksPerFrame ticks_per_frame)
	The setter is for use in e.g.

void	set_position_unvalidated (const dsp::Position &pos)

bool	is_position_valid (const dsp::Position &pos, PositionType pos_type, dsp::TicksPerFrame ticks_per_frame) const
	Returns if the given Position is valid.

bool	set_position (const dsp::Position &pos, PositionType pos_type, bool validate, dsp::TicksPerFrame ticks_per_frame)
	Sets the given position on the object, optionally attempting to validate before.

void	move (double ticks, dsp::FramesPerTick frames_per_tick)
	Moves the object by the given amount of ticks.

void	set_track_id (const TrackUuid &track_id)

void	set_track_id (std::optional< TrackUuid > track_id)

void	unset_track_id ()

void	update_positions (bool from_ticks, bool bpm_change, dsp::FramesPerTick frames_per_tick)
	Updates the positions in each child recursively.

auto	get_track () const
	Returns the Track this ArrangerObject is in.

std::optional< TrackUuid >	get_track_id () const

virtual bool	validate (bool is_project, dsp::FramesPerTick frames_per_tick) const =0
	Validates the arranger object.

std::optional< ArrangerObjectPtrVariant >	remove_from_project (bool free_obj, bool fire_events=false)
	Removes the object (which can be obtained from find_in_project()) from its parent in the project.

void	set_selection_status_getter (SelectionStatusGetter getter)

void	unset_selection_status_getter ()

virtual bool	is_deletable () const
	Returns whether the given object is deletable or not (eg, start marker).

Public Member Functions inherited from zrythm::utils::UuidIdentifiableObject< ArrangerObject >
	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)

Public Member Functions inherited from NamedObject
	NamedObject (NameValidator validator=[](const utils::Utf8String &) { return true;})

utils::Utf8String	get_name () const
	Returns the name of the object.

void	gen_escaped_name ()
	Generates the escaped name for the object.

void	set_name (this auto &&self, const utils::Utf8String &name)
	Sets the name of the object.

void	generate_name_from_automation_track (this auto &self, const auto &track, const auto &at)

void	generate_name_from_track (this auto &self, const auto &track)

void	generate_name (this auto &self, std::optional< utils::Utf8String > base_name, const auto at, const auto track)

void	set_name_with_action (const utils::Utf8String &name)
	Changes the name and adds an action to the undo stack.

utils::Utf8String	gen_human_friendly_name () const final
	Generates a human readable name for the object.

Public Member Functions inherited from MuteableObject
void	set_muted (bool muted, bool fire_events)
	Sets the mute status of the object.

Public Member Functions inherited from LoopableObject
int	get_num_loops (bool count_incomplete) const
	Returns the number of loops in the ArrangerObject, optionally including incomplete ones.

const auto &	get_clip_start_pos () const
	Getter.

const auto &	get_loop_start_pos () const
	Getter.

const auto &	get_loop_end_pos () const
	Getter.

void	clip_start_position_setter_validated (const dsp::Position &pos, dsp::TicksPerFrame ticks_per_frame)
	The setter is for use in e.g.

void	loop_start_position_setter_validated (const dsp::Position &pos, dsp::TicksPerFrame ticks_per_frame)
	The setter is for use in e.g.

void	loop_end_position_setter_validated (const dsp::Position &pos, dsp::TicksPerFrame ticks_per_frame)
	The setter is for use in e.g.

void	set_loop_start_position_unvalidated (const dsp::Position &pos)

void	set_loop_end_position_unvalidated (const dsp::Position &pos)

void	set_clip_start_position_unvalidated (const dsp::Position &pos)

double	get_loop_length_in_ticks () const
	Returns the length of the loop in ticks.

auto	get_loop_length_in_frames () const
	Returns the length of the loop in frames.

bool	is_looped () const

Public Member Functions inherited from BoundedObject
auto	get_end_position () const
	Getter.

void	parent_base_qproperties (QObject &derived)

void	end_position_setter_validated (const dsp::Position &pos, dsp::TicksPerFrame ticks_per_frame)
	The setter is for use in e.g.

void	set_end_position_unvalidated (const dsp::Position &pos)

auto	get_length_in_ticks () const
	Returns the length in ticks.

auto	get_length_in_frames () const
	Returns the length in frames.

void	resize (bool left, ResizeType type, double ticks, bool during_ui_action)
	Resizes the object on the left side or right side by given amount of ticks, for objects that do not have loops (currently none?

template<typename SelfT> requires (FinalArrangerObjectSubclass<SelfT>)
void	set_start_pos_full_size (this SelfT &self, const Position &pos, dsp::FramesPerTick frames_per_tick)
	Sets the end position of the ArrangerObject and also sets the loop end and fade out (if object supports those) so that they are at the end.

template<typename SelfT> requires (FinalArrangerObjectSubclass<SelfT>)
void	set_end_pos_full_size (this SelfT &self, const dsp::Position &pos, dsp::FramesPerTick frames_per_tick)
	Sets the end position of the ArrangerObject and also sets the loop end and fade out (if object supports those) to that position.

bool	is_hit (const dsp::Position &pos, bool object_end_pos_inclusive=false) const
	Returns whether the object is hit by the given position (local position if non-timeline object).

bool	is_hit (const signed_frame_t frames, bool object_end_pos_inclusive=false) const

bool	is_hit_by_range (const dsp::Position &start, const dsp::Position &end, bool range_start_inclusive=true, bool range_end_inclusive=false, bool object_end_pos_inclusive=false) const
	Returns whether the given object is hit by the given range.

bool	is_hit_by_range (signed_frame_t global_frames_start, signed_frame_t global_frames_end, bool range_start_inclusive=true, bool range_end_inclusive=false, bool object_end_pos_inclusive=false) const

virtual bool	is_inside_range (const dsp::Position &start, const dsp::Position &end) const
	Checks if any part of the object is hit by the given range.

Public Member Functions inherited from ColoredObject
QColor	get_effective_color () const
	Returns the color of the object if set, otherwise the owner track's color.

Static Public Member Functions
static constexpr bool	is_midi ()

static constexpr bool	is_audio ()

static constexpr bool	is_automation ()

static constexpr bool	is_chord ()

static constexpr bool	is_laned ()

static constexpr bool	has_children ()

static RegionT *	at_position (const Track track, const AutomationTrack at, dsp::Position pos)
	Returns the region at the given position in the given Track.

Static Public Member Functions inherited from Region
static std::optional< ArrangerObjectPtrVariant >	get_at_pos (dsp::Position pos, Track track, AutomationTrack at, bool include_region_end=false)
	Returns the region at the given position, if any.

Additional Inherited Members
Data Fields inherited from Region
ArrangerObjectRegistry &	object_registry_

std::optional< int >	link_group_

int	bounce_ = 0
	Set to ON during bouncing if this region should be included.

bool	stretching_ = false
	Whether currently running the stretching algorithm.

double	stretch_ratio_ = 1.0
	Used during arranger UI overlay actions.

double	before_length_ = 0.0
	The length before stretching, in ticks.

Data Fields inherited from ArrangerObject
Flags	flags_ {}
	Track this object belongs to (cache to be set during graph calculation).

Data Fields inherited from MuteableObject
bool	muted_ = false
	Whether muted or not.

Data Fields inherited from LoopableObject
dsp::Position	clip_start_pos_
	Start position of the clip loop, relative to the object's start.

dsp::Position	loop_start_pos_
	Loop start Position relative to the object's start.

dsp::Position	loop_end_pos_
	End position of the clip loop, relative to the object's start.

Data Fields inherited from BoundedObject
PositionProxy *	end_pos_ = nullptr
	End Position, if the object has one.

Data Fields inherited from ColoredObject
Color	color_
	Color independent of owner (Track/Region etc.).

bool	use_color_ = false
	Whether to use the custom color.

Static Public Attributes inherited from ArrangerObject
static constexpr double	DEFAULT_NUDGE_TICKS = 0.1

Protected Member Functions inherited from Region
	Region (ArrangerObjectRegistry &object_registry)

void	copy_members_from (const Region &other, ObjectCloneType clone_type)

Protected Member Functions inherited from TimelineObject
void	copy_members_from (const TimelineObject &other, ObjectCloneType clone_type)

Protected Member Functions inherited from ArrangerObject
	ArrangerObject (Type type, TrackResolver track_resolver) noexcept

void	copy_members_from (const ArrangerObject &other, ObjectCloneType clone_type)

bool	are_members_valid (bool is_project, dsp::FramesPerTick frames_per_tick) const
	To be called by validate() implementations.

Protected Member Functions inherited from NamedObject
void	copy_members_from (const NamedObject &other, ObjectCloneType clone_type)

Protected Member Functions inherited from MuteableObject
void	copy_members_from (const MuteableObject &other, ObjectCloneType clone_type)

Protected Member Functions inherited from LoopableObject
void	copy_members_from (const LoopableObject &other, ObjectCloneType clone_type)

bool	are_members_valid (bool is_project, dsp::FramesPerTick frames_per_tick) const

Protected Member Functions inherited from BoundedObject
void	copy_members_from (const BoundedObject &other, ObjectCloneType clone_type)

bool	are_members_valid (bool is_project, dsp::FramesPerTick frames_per_tick) const

Protected Member Functions inherited from ColoredObject
void	copy_members_from (const ColoredObject &other, ObjectCloneType clone_type)

template<typename Derived>
void	init_colored_object (this Derived &self)

Protected Attributes inherited from ArrangerObject
TrackResolver	track_resolver_

PositionProxy *	pos_ = nullptr
	Position (or start Position if the object has length).

std::optional< TrackUuid >	track_id_
	ID of the track this object belongs to.

std::optional< SelectionStatusGetter >	selection_status_getter_
	Whether part of an auditioner track.

Protected Attributes inherited from NamedObject
utils::Utf8String	name_
	Name to be shown on the widget.

utils::Utf8String	escaped_name_
	Escaped name for drawing.

NameValidator	name_validator_

Detailed Description

template<typename RegionT>
class RegionImpl< RegionT >

Template Parameters

RegionT The region type to specialize for (CRTP type).

Definition at line 240 of file region.h.

Member Typedef Documentation

◆ ChildT

template<typename RegionT>

using RegionImpl< RegionT >::ChildT = RegionChildType_t<RegionT>

Definition at line 278 of file region.h.

◆ ChildTPtr

template<typename RegionT>

using RegionImpl< RegionT >::ChildTPtr = ChildT *

Definition at line 279 of file region.h.

◆ RegionTPtr

template<typename RegionT>

using RegionImpl< RegionT >::RegionTPtr = RegionT *

Definition at line 249 of file region.h.

Constructor & Destructor Documentation

◆ RegionImpl()

template<typename RegionT>

RegionImpl< RegionT >::RegionImpl ( )

inlineprotectednoexcept

Definition at line 243 of file region.h.

Member Function Documentation

◆ add_clone_to_project()

template<typename RegionT>

ArrangerObjectPtrVariant RegionImpl< RegionT >::add_clone_to_project ( bool fire_events ) const

inlinefinalvirtual

Appends the ArrangerObject to where it belongs in the project (eg, a Track), without taking into account its previous index (eg, before deletion if undoing).

Exceptions

ZrythmError on failure.

Returns: A reference to the newly added clone.

Implements ArrangerObject.

Definition at line 387 of file region.h.

◆ append_children()

template<typename RegionT>

void RegionImpl< RegionT >::append_children	(	this RegionT &	self,
		std::vector< RegionOwnedObject * > &	children )

inline

Fills the given vector with all the children of this region.

Definition at line 285 of file region.h.

◆ at_position()

template<typename RegionT>

static RegionT * RegionImpl< RegionT >::at_position	(	const Track *	track,
		const AutomationTrack *	at,
		dsp::Position	pos )

static

Returns the region at the given position in the given Track.

Parameters

at	The automation track to look in.
track	The track to look in, if at is NULL.
pos	The position.

◆ fill_midi_events()

template<typename RegionT>

void RegionImpl< RegionT >::fill_midi_events	(	TrackPtrVariant	track_var,
		const EngineProcessTimeInfo &	time_nfo,
		bool	note_off_at_end,
		bool	is_note_off_for_loop_or_region_end,
		dsp::MidiEventVector &	midi_events ) const

Fills MIDI event queue from this MIDI or Chord region.

The events are dequeued right after the call to this function.

Note: The caller already splits calls to this function at each sub-loop inside the region, so region loop related logic is not needed.

Parameters

note_off_at_end	Whether a note off should be added at the end frame (eg, when the caller knows there is a region loop or the region ends).
is_note_off_for_loop_or_region_end	Whether `note_off_at_end` is for a region loop end or the region's end (in this case normal note offs will be sent, otherwise a single ALL NOTES OFF event will be sent).
midi_events	MidiEvents (queued) to fill (from Piano Roll Port for example).

◆ get_arranger_object_registry() [1/2]

template<typename RegionT>

auto & RegionImpl< RegionT >::get_arranger_object_registry ( )

inline

Definition at line 368 of file region.h.

◆ get_arranger_object_registry() [2/2]

template<typename RegionT>

auto & RegionImpl< RegionT >::get_arranger_object_registry ( ) const

inline

Definition at line 367 of file region.h.

◆ get_muted()

template<typename RegionT>

bool RegionImpl< RegionT >::get_muted ( bool check_parent ) const

overridevirtual

Gets the mute status of the object.

Parameters

check_parent Whether to check parent (parent region or parent track lane if region), otherwise only whether this object itself is muted is returned. This will take the solo status of other lanes if true and if this is a region that can have lanes.

Reimplemented from MuteableObject.

◆ get_object_ptr() [1/2]

template<typename RegionT>

auto RegionImpl< RegionT >::get_object_ptr ( const ArrangerObject::Uuid id ) const

inline

Definition at line 321 of file region.h.

◆ get_object_ptr() [2/2]

template<typename RegionT>

auto RegionImpl< RegionT >::get_object_ptr ( const ArrangerObjectUuidReference & id ) const

inline

Definition at line 327 of file region.h.

◆ has_children()

template<typename RegionT>

static constexpr bool RegionImpl< RegionT >::has_children ( )

inlinestaticconstexpr

Definition at line 273 of file region.h.

◆ insert_clone_to_project()

template<typename RegionT>

ArrangerObjectPtrVariant RegionImpl< RegionT >::insert_clone_to_project ( ) const

inlinefinalvirtual

Inserts the object where it belongs in the project (eg, a Track).

This function assumes that the object already knows the index where it should be inserted in its parent.

This is mostly used when undoing.

Exceptions

ZrythmException on failure.

Returns: A reference to the newly inserted clone.

Implements ArrangerObject.

Definition at line 392 of file region.h.

◆ is_audio()

template<typename RegionT>

static constexpr bool RegionImpl< RegionT >::is_audio ( )

inlinestaticconstexpr

Definition at line 255 of file region.h.

◆ is_automation()

template<typename RegionT>

static constexpr bool RegionImpl< RegionT >::is_automation ( )

inlinestaticconstexpr

Definition at line 259 of file region.h.

◆ is_chord()

template<typename RegionT>

static constexpr bool RegionImpl< RegionT >::is_chord ( )

inlinestaticconstexpr

Definition at line 263 of file region.h.

◆ is_laned()

template<typename RegionT>

static constexpr bool RegionImpl< RegionT >::is_laned ( )

inlinestaticconstexpr

Definition at line 267 of file region.h.

◆ is_midi()

template<typename RegionT>

static constexpr bool RegionImpl< RegionT >::is_midi ( )

inlinestaticconstexpr

Definition at line 251 of file region.h.

◆ remove_all_children()

template<typename RegionT>

void RegionImpl< RegionT >::remove_all_children ( this RegionT & self )

inline

Removes all children objects from the region.

Definition at line 373 of file region.h.

◆ set_link_group()

template<typename RegionT>

void RegionImpl< RegionT >::set_link_group	(	int	group_idx,
		bool	update_identifier )

Sets the link group to the region.

Parameters

group_idx If -1, the region will be removed from its current link group, if any.

◆ stretch()

template<typename RegionT>

void RegionImpl< RegionT >::stretch ( double ratio )

Stretch the region's contents.

This should be called right after changing the region's size.

Parameters

ratio The ratio to stretch by.

Exceptions

ZrythmException on error.

◆ update_identifier()

template<typename RegionT>

void RegionImpl< RegionT >::update_identifier ( this RegionT & self )

inline

Disconnects the region and anything using it.

Does not free the Region or its children's resources. To be called every time the identifier changes to update the region's children.

Definition at line 416 of file region.h.

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

src/gui/dsp/region.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ChildT

◆ ChildTPtr

◆ RegionTPtr

Constructor & Destructor Documentation

◆ RegionImpl()

Member Function Documentation

◆ add_clone_to_project()

◆ append_children()

◆ at_position()

◆ fill_midi_events()

◆ get_arranger_object_registry() [1/2]

◆ get_arranger_object_registry() [2/2]

◆ get_muted()

◆ get_object_ptr() [1/2]

◆ get_object_ptr() [2/2]

◆ has_children()

◆ insert_clone_to_project()

◆ is_audio()

◆ is_automation()

◆ is_chord()

◆ is_laned()

◆ is_midi()

◆ remove_all_children()

◆ set_link_group()

◆ stretch()

◆ update_identifier()