A region (clip) is an object on the timeline that contains either MidiNote's or AudioClip's. More...

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

Inheritance diagram for Region:

[legend]

Collaboration diagram for Region:

[legend]

Public Member Functions
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.

virtual ArrangerObjectPtrVariant	add_clone_to_project (bool fire_events) const =0
	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).

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

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
virtual bool	get_muted (bool check_parent) const
	Gets the mute status of the object.

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 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.

Data Fields
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.

Protected Member Functions
	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)

Friends
void	to_json (nlohmann::json &j, const Region &region)

void	from_json (const nlohmann::json &j, Region &region)

Additional Inherited Members
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

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

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

A region (clip) is an object on the timeline that contains either MidiNote's or AudioClip's.

It is uniquely identified using its name, so it must be unique throughout the Project.

Definition at line 106 of file region.h.

Constructor & Destructor Documentation

◆ Region()

Region::Region ( ArrangerObjectRegistry & object_registry )

inlineprotected

Definition at line 184 of file region.h.

Member Function Documentation

◆ get_at_pos()

static std::optional< ArrangerObjectPtrVariant > Region::get_at_pos	(	dsp::Position	pos,
		Track *	track,
		AutomationTrack *	at,
		bool	include_region_end = false )

static

Returns the region at the given position, if any.

Either at (for automation regions) or track (for other regions) must be passed.

Parameters

track
at
include_region_end

◆ get_frames_till_next_loop_or_end()

void Region::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.

Parameters

[in]	timeline_frames	Global frames at start.
[out]	ret_frames	Return frames.
[out]	is_loop	Whether the return frames are for a loop (if false, the return frames are for the region's end).

◆ has_link_group()

bool Region::has_link_group ( ) const

inline

Definition at line 126 of file region.h.

◆ is_audio()

bool Region::is_audio ( ) const

inline

Definition at line 117 of file region.h.

◆ is_automation()

bool Region::is_automation ( ) const

inline

Definition at line 118 of file region.h.

◆ is_chord()

bool Region::is_chord ( ) const

inline

Definition at line 119 of file region.h.

◆ is_midi()

bool Region::is_midi ( ) const

inline

Definition at line 116 of file region.h.

◆ timeline_frames_to_local()

signed_frame_t Region::timeline_frames_to_local	(	signed_frame_t	timeline_frames,
		bool	normalize ) const

Converts frames on the timeline (global) to local frames (in the clip).

If normalize is 1 it will only return a position from 0 to loop_end (it will traverse the loops to find the appropriate position), otherwise it may exceed loop_end.

Parameters

timeline_frames Timeline position in frames.

Returns: The local frames.

Friends And Related Symbol Documentation

◆ from_json

void from_json	(	const nlohmann::json &	j,
		Region &	region )

friend

Definition at line 198 of file region.h.

◆ to_json

void to_json	(	nlohmann::json &	j,
		const Region &	region )

friend

Definition at line 194 of file region.h.

Field Documentation

◆ before_length_

double Region::before_length_ = 0.0

The length before stretching, in ticks.

Definition at line 232 of file region.h.

◆ bounce_

int Region::bounce_ = 0

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

Only relevant for audio and midi regions.

Definition at line 215 of file region.h.

◆ link_group_

std::optional<int> Region::link_group_

Definition at line 208 of file region.h.

◆ object_registry_

ArrangerObjectRegistry& Region::object_registry_

Definition at line 204 of file region.h.

◆ stretch_ratio_

double Region::stretch_ratio_ = 1.0

Used during arranger UI overlay actions.

Definition at line 227 of file region.h.

◆ stretching_

bool Region::stretching_ = false

Whether currently running the stretching algorithm.

If this is true, region drawing will be deferred.

Definition at line 224 of file region.h.

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

src/gui/dsp/region.h

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Region()

Member Function Documentation

◆ get_at_pos()

◆ get_frames_till_next_loop_or_end()

◆ has_link_group()

◆ is_audio()

◆ is_automation()

◆ is_chord()

◆ is_midi()

◆ timeline_frames_to_local()

Friends And Related Symbol Documentation

◆ from_json

◆ to_json

Field Documentation

◆ before_length_

◆ bounce_

◆ link_group_

◆ object_registry_

◆ stretch_ratio_

◆ stretching_