#include <region.h>

Inheritance diagram for ARDOUR::Region:

Classes
struct	RegionGroupRetainer

Public Types
typedef std::vector< std::shared_ptr< Source > >	SourceList

typedef std::list< std::shared_ptr< RegionFxPlugin > >	RegionFxList

typedef std::map< PBD::PropertyChange, RegionList >	ChangeMap

Public Types inherited from ARDOUR::Trimmable
enum	CanTrim { FrontTrimEarlier = 0x1 , FrontTrimLater = 0x2 , EndTrimEarlier = 0x4 , EndTrimLater = 0x8 , TopTrimUp = 0x10 , TopTrimDown = 0x20 , BottomTrimUp = 0x40 , BottomTrimDown = 0x80 }

Public Member Functions
virtual	~Region ()

bool	set_name (const std::string &str)

PBD::PropertyList	derive_properties (bool with_times=true, bool with_envelope=false) const

const DataType &	data_type () const

Temporal::TimeDomain	time_domain () const

void	start_domain_bounce (Temporal::DomainBounceInfo &)

void	finish_domain_bounce (Temporal::DomainBounceInfo &)

timepos_t	position () const

timepos_t	start () const

timecnt_t	length () const

timepos_t	end () const

timepos_t	nt_last () const

virtual timecnt_t	tail () const

timepos_t	source_position () const

timecnt_t	source_relative_position (Temporal::timepos_t const &) const

timecnt_t	region_relative_position (Temporal::timepos_t const &) const

samplepos_t	position_sample () const

samplecnt_t	start_sample () const

samplecnt_t	length_samples () const

layer_t	layer () const

void	set_selected_for_solo (bool yn)

timepos_t	source_length (uint32_t n) const

uint32_t	max_source_level () const

timepos_t	last_position () const

timecnt_t	last_length () const

samplecnt_t	ancestral_start_sample () const

samplecnt_t	ancestral_length_samples () const

timepos_t	ancestral_start () const

timecnt_t	ancestral_length () const

uint64_t	region_group () const

void	set_region_group (uint64_t rg, bool explicitly=false)

void	unset_region_group (bool explicitly=false)

bool	is_explicitly_grouped ()

bool	is_implicitly_ungrouped ()

bool	is_explicitly_ungrouped ()

float	stretch () const

float	shift () const

void	set_ancestral_data (timepos_t const &start, timecnt_t const &length, float stretch, float shift)

timecnt_t	sync_offset (int &dir) const

timepos_t	sync_position () const

timepos_t	adjust_to_sync (timepos_t const &) const

samplepos_t	first_sample () const

samplepos_t	last_sample () const

timepos_t	earliest_possible_position () const

samplepos_t	latest_possible_sample () const

Temporal::TimeRange	last_range () const

Temporal::TimeRange	range_samples () const

Temporal::TimeRange	range () const

bool	hidden () const

bool	muted () const

bool	opaque () const

bool	locked () const

bool	position_locked () const

bool	video_locked () const

bool	automatic () const

bool	whole_file () const

bool	captured () const

bool	can_move () const

bool	sync_marked () const

bool	external () const

bool	import () const

Trimmable::CanTrim	can_trim () const

Temporal::TimeDomain	position_time_domain () const

void	set_position_time_domain (Temporal::TimeDomain ps)

void	recompute_position_from_time_domain ()

void	suspend_property_changes ()

bool	covers (samplepos_t sample) const

bool	covers (timepos_t const &pos) const

Temporal::OverlapType	coverage (timepos_t const &start, timepos_t const &end, bool with_tail=false) const

bool	exact_equivalent (std::shared_ptr< const Region >) const

bool	size_equivalent (std::shared_ptr< const Region >) const

bool	overlap_equivalent (std::shared_ptr< const Region >) const

bool	enclosed_equivalent (std::shared_ptr< const Region >) const

bool	layer_and_time_equivalent (std::shared_ptr< const Region >) const

bool	source_equivalent (std::shared_ptr< const Region >) const

bool	any_source_equivalent (std::shared_ptr< const Region >) const

bool	uses_source (std::shared_ptr< const Source >, bool shallow=false) const

void	deep_sources (std::set< std::shared_ptr< Source > > &) const

std::string	source_string () const

void	set_length (timecnt_t const &)

void	set_start (timepos_t const &)

void	set_position (timepos_t const &)

void	set_initial_position (timepos_t const &)

void	special_set_position (timepos_t const &)

virtual void	update_after_tempo_map_change (bool send_change=true)

void	nudge_position (timecnt_t const &)

bool	at_natural_position () const

void	move_to_natural_position ()

void	move_start (timecnt_t const &distance)

void	trim_front (timepos_t const &new_position)

void	trim_end (timepos_t const &new_position)

void	trim_to (timepos_t const &pos, timecnt_t const &length)

virtual void	fade_range (samplepos_t, samplepos_t)

void	cut_front (timepos_t const &new_position)

void	cut_end (timepos_t const &new_position)

void	raise ()

void	lower ()

void	raise_to_top ()

void	lower_to_bottom ()

void	set_sync_position (timepos_t const &n)

void	clear_sync_position ()

void	set_hidden (bool yn)

void	set_muted (bool yn)

void	set_whole_file (bool yn)

void	set_automatic (bool yn)

void	set_opaque (bool yn)

void	set_locked (bool yn)

void	set_video_locked (bool yn)

void	set_position_locked (bool yn)

void	set_layer (layer_t l)

void	set_length_unchecked (timecnt_t const &)

void	set_position_unchecked (timepos_t const &)

void	modify_front_unchecked (timepos_t const &new_position, bool reset_fade)

void	modify_end_unchecked (timepos_t const &new_position, bool reset_fade)

Temporal::timepos_t	region_beats_to_absolute_time (Temporal::Beats beats) const

Temporal::timepos_t	region_beats_to_region_time (Temporal::Beats beats) const

Temporal::Beats	region_beats_to_source_beats (Temporal::Beats beats) const

Temporal::Beats	region_distance_to_region_beats (Temporal::timecnt_t const &) const

Temporal::Beats	source_beats_to_absolute_beats (Temporal::Beats beats) const

Temporal::timepos_t	source_beats_to_absolute_time (Temporal::Beats beats) const

Temporal::timepos_t	source_beats_to_region_time (Temporal::Beats beats) const

Temporal::Beats	absolute_time_to_source_beats (Temporal::timepos_t const &) const

Temporal::Beats	absolute_time_to_soucre_beats (Temporal::timepos_t const &) const

Temporal::timepos_t	absolute_time_to_region_time (Temporal::timepos_t const &) const

int	apply (Filter &, PBD::Progress *progress=0)

std::shared_ptr< ARDOUR::Playlist >	playlist () const

virtual void	set_playlist (std::weak_ptr< ARDOUR::Playlist >)

void	source_deleted (std::weak_ptr< Source >)

bool	is_compound () const

std::shared_ptr< Source >	source (uint32_t n=0) const

SourceList &	sources_for_edit ()

const SourceList &	sources () const

const SourceList &	master_sources () const

std::vector< std::string >	master_source_names ()

void	set_master_sources (const SourceList &)

virtual std::shared_ptr< Evoral::Control >	control (const Evoral::Parameter &id, bool create=false)=0

virtual std::shared_ptr< const Evoral::Control >	control (const Evoral::Parameter &id) const =0

std::string	tags () const

virtual bool	set_tags (const std::string &str)

XMLNode &	get_state () const

virtual int	set_state (const XMLNode &, int version)

virtual bool	do_export (std::string const &) const =0

virtual std::shared_ptr< Region >	get_parent () const

uint64_t	layering_index () const

void	set_layering_index (uint64_t when)

virtual bool	is_dependent () const

virtual bool	depends_on (std::shared_ptr< Region >) const

virtual void	add_transient (samplepos_t)

virtual void	clear_transients ()

virtual void	update_transient (samplepos_t, samplepos_t)

virtual void	remove_transient (samplepos_t)

virtual void	set_onsets (AnalysisFeatureList &)

void	transients (AnalysisFeatureList &)

void	captured_xruns (XrunPositions &, bool abs=false) const

virtual void	get_transients (AnalysisFeatureList &)

AnalysisFeatureList	transients ()

bool	has_transients () const

virtual int	separate_by_channel (std::vector< std::shared_ptr< Region > > &) const

void	maybe_invalidate_transients ()

void	drop_sources ()

void	set_changemap (ChangeMap *changemap)

void	get_cue_markers (CueMarkers &, bool abs=false) const

void	move_cue_marker (CueMarker const &, timepos_t const &region_relative_position)

void	rename_cue_marker (CueMarker &, std::string const &)

bool	load_plugin (ARDOUR::PluginType type, std::string const &name)

bool	add_plugin (std::shared_ptr< RegionFxPlugin >, std::shared_ptr< RegionFxPlugin > pos=std::shared_ptr< RegionFxPlugin >())

virtual bool	remove_plugin (std::shared_ptr< RegionFxPlugin >)

virtual void	reorder_plugins (RegionFxList const &)

bool	has_region_fx () const

size_t	n_region_fx () const

std::shared_ptr< RegionFxPlugin >	nth_plugin (uint32_t n) const

void	foreach_plugin (std::function< void(std::weak_ptr< RegionFxPlugin >)> method) const

std::optional< Temporal::Tempo >	tempo () const

void	set_tempo (Temporal::Tempo const &)

std::optional< Temporal::Meter >	meter () const

void	set_meter (Temporal::Meter const &)

std::shared_ptr< Temporal::TempoMap >	tempo_map () const

Public Member Functions inherited from ARDOUR::SessionObject
	SessionObject (Session &session, const std::string &name)

Session &	session () const

std::string	name () const

Public Member Functions inherited from ARDOUR::SessionHandleRef
	SessionHandleRef (ARDOUR::Session &s)

virtual	~SessionHandleRef ()

Public Member Functions inherited from PBD::ScopedConnectionList
	ScopedConnectionList ()

	ScopedConnectionList (const ScopedConnectionList &)=delete

ScopedConnectionList &	operator= (const ScopedConnectionList &)=delete

virtual	~ScopedConnectionList ()

void	add_connection (const UnscopedConnection &c)

void	drop_connections ()

std::list< ScopedConnectionList * >::size_type	size () const

Public Member Functions inherited from PBD::Stateful
	Stateful ()

virtual	~Stateful ()

virtual bool	apply_change (PropertyBase const &)

PropertyChange	apply_changes (PropertyList const &)

const OwnedPropertyList &	properties () const

void	add_property (PropertyBase &s)

void	add_extra_xml (XMLNode &)

XMLNode *	extra_xml (const std::string &str, bool add_if_missing=false)

void	save_extra_xml (const XMLNode &)

const PBD::ID &	id () const

bool	set_id (const XMLNode &)

void	set_id (const std::string &)

void	reset_id ()

void	clear_changes ()

virtual void	clear_owned_changes ()

PropertyList *	get_changes_as_properties (PBD::Command *) const

virtual void	rdiff (std::vector< PBD::Command * > &) const

bool	changed () const

virtual PropertyList *	property_factory (const XMLNode &) const

virtual void	resume_property_changes ()

bool	property_changes_suspended () const

Public Member Functions inherited from PBD::Destructible
virtual	~Destructible ()

virtual void	drop_references ()

Public Member Functions inherited from ARDOUR::Trimmable
	Trimmable ()

virtual	~Trimmable ()

Public Member Functions inherited from ARDOUR::Movable
	Movable ()

bool	locked () const

Public Member Functions inherited from Temporal::TimeDomainSwapper
virtual	~TimeDomainSwapper ()

Static Public Member Functions
static void	make_property_quarks ()

static uint64_t	next_group_id ()

static void	set_next_group_id (uint64_t ngid)

static uint64_t	get_retained_group_id (uint64_t take=0)

static uint64_t	get_region_operation_group_id (uint64_t old_region_group, RegionOperationFlag flags)

Static Public Member Functions inherited from ARDOUR::SessionObject
static void	make_property_quarks ()

Public Attributes
PBD::Signal< void()>	RegionFxChanged

Public Attributes inherited from PBD::Stateful
PBD::Signal< void(const PropertyChange &)>	PropertyChanged

Public Attributes inherited from PBD::Destructible
PBD::Signal< void()>	Destroyed

PBD::Signal< void()>	DropReferences

Static Public Attributes
static PBD::Signal< void(std::shared_ptr< RegionList >, const PBD::PropertyChange &)>	RegionsPropertyChanged

Static Public Attributes inherited from PBD::Stateful
static int	current_state_version

static int	loading_state_version

Protected Member Functions
virtual XMLNode &	state () const

	Region (const SourceList &srcs)

	Region (std::shared_ptr< const Region >)

	Region (std::shared_ptr< const Region >, timecnt_t const &start_offset)

	Region (std::shared_ptr< const Region >, const SourceList &)

	Region (Session &s, timepos_t const &start, timecnt_t const &length, const std::string &name, DataType)

virtual bool	can_trim_start_before_source_start () const

virtual bool	_add_plugin (std::shared_ptr< RegionFxPlugin >, std::shared_ptr< RegionFxPlugin >, bool)

virtual void	fx_latency_changed (bool no_emit)

virtual void	fx_tail_changed (bool no_emit)

virtual void	send_change (const PBD::PropertyChange &)

virtual int	_set_state (const XMLNode &, int version, PBD::PropertyChange &what_changed, bool send_signal)

virtual void	set_position_internal (timepos_t const &pos)

void	set_length_internal (timecnt_t const &)

virtual void	set_start_internal (timepos_t const &)

bool	verify_start_and_length (timepos_t const &, timecnt_t &)

void	first_edit ()

virtual void	ensure_length_sanity ()

void	override_opaqueness (bool yn)

timepos_t	len_as_tpos () const

void	merge_features (AnalysisFeatureList &, const AnalysisFeatureList &, const sampleoffset_t) const

Protected Member Functions inherited from ARDOUR::SessionHandleRef
virtual void	session_going_away ()

virtual void	insanity_check ()

Protected Member Functions inherited from PBD::Stateful
void	add_instant_xml (XMLNode &, const std::string &directory_path)

XMLNode *	instant_xml (const std::string &str, const std::string &directory_path)

void	add_properties (XMLNode &) const

PropertyChange	set_values (XMLNode const &)

virtual void	post_set (const PropertyChange &)

bool	regenerate_xml_or_string_ids () const

Protected Attributes
DataType	_type

Glib::Threads::RWLock	_fx_lock

uint32_t	_fx_latency

uint32_t	_fx_tail

RegionFxList	_plugins

PBD::Property< bool >	_sync_marked

PBD::Property< bool >	_left_of_split

PBD::Property< bool >	_right_of_split

PBD::Property< bool >	_valid_transients

PBD::Property< timepos_t >	_start

PBD::Property< timecnt_t >	_length

PBD::Property< timepos_t >	_sync_position

SourceList	_sources

SourceList	_master_sources

std::weak_ptr< ARDOUR::Playlist >	_playlist

AnalysisFeatureList	_onsets

AnalysisFeatureList	_user_transients

samplepos_t	_transient_user_start

AnalysisFeatureList	_transients

samplepos_t	_transient_analysis_start

samplepos_t	_transient_analysis_end

bool	_soloSelected

Protected Attributes inherited from ARDOUR::SessionObject
PBD::Property< std::string >	_name

Protected Attributes inherited from ARDOUR::SessionHandleRef
ARDOUR::Session &	_session

Protected Attributes inherited from PBD::Stateful
XMLNode *	_extra_xml

XMLNode *	_instant_xml

PBD::PropertyChange	_pending_changed

Glib::Threads::Mutex	_lock

std::string	_xml_node_name
	name of node to use for this object in XML More...

OwnedPropertyList *	_properties

Private Types
enum	RegionGroupFlags : uint64_t { NoGroup = 0x0 , Explicit = 0x1 }

Private Member Functions
void	mid_thaw (const PBD::PropertyChange &)

void	trim_to_internal (timepos_t const &position, timecnt_t const &length)

void	maybe_uncopy ()

void	subscribe_to_source_drop ()

bool	verify_start (timepos_t const &)

bool	verify_length (timecnt_t &)

virtual void	recompute_at_start ()=0

virtual void	recompute_at_end ()=0

void	register_properties ()

void	use_sources (SourceList const &)

Private Attributes
PBD::Property< bool >	_muted

PBD::Property< bool >	_opaque

PBD::Property< bool >	_locked

PBD::Property< bool >	_video_locked

PBD::Property< bool >	_automatic

PBD::Property< bool >	_whole_file

PBD::Property< bool >	_import

PBD::Property< bool >	_external

PBD::Property< bool >	_hidden

PBD::Property< bool >	_position_locked

PBD::Property< timepos_t >	_ancestral_start

PBD::Property< timecnt_t >	_ancestral_length

PBD::Property< float >	_stretch

PBD::Property< float >	_shift

PBD::Property< uint64_t >	_layering_index

PBD::Property< std::string >	_tags

PBD::Property< uint64_t >	_reg_group

PBD::Property< bool >	_contents

timecnt_t	_last_length

RegionEditState	_first_edit

layer_t	_layer

ChangeMap *	_changemap

std::atomic< int >	_source_deleted

Glib::Threads::Mutex	_source_list_lock

PBD::ScopedConnectionList	_source_deleted_connections

Static Private Attributes
static uint64_t	_retained_group_id

static uint64_t	_retained_take_cnt

static uint64_t	_next_group_id

static Glib::Threads::Mutex	_operation_rgroup_mutex

static std::map< uint64_t, uint64_t >	_operation_rgroup_map

Friends
class	RegionFactory

Detailed Description

Definition at line 105 of file ardour/ardour/region.h.

Member Typedef Documentation

◆ ChangeMap

typedef std::map<PBD::PropertyChange, RegionList> ARDOUR::Region::ChangeMap

Definition at line 122 of file ardour/ardour/region.h.

◆ RegionFxList

typedef std::list<std::shared_ptr<RegionFxPlugin> > ARDOUR::Region::RegionFxList

Definition at line 114 of file ardour/ardour/region.h.

◆ SourceList

typedef std::vector<std::shared_ptr<Source> > ARDOUR::Region::SourceList

Definition at line 113 of file ardour/ardour/region.h.

Member Enumeration Documentation

◆ RegionGroupFlags

enum ARDOUR::Region::RegionGroupFlags : uint64_t

private

Enumerator
NoGroup
Explicit

Definition at line 680 of file ardour/ardour/region.h.

Constructor & Destructor Documentation

◆ ~Region()

virtual ARDOUR::Region::~Region ( )

virtual

◆ Region() [1/5]

ARDOUR::Region::Region ( const SourceList & srcs )

protected

Construct a region from multiple sources

◆ Region() [2/5]

ARDOUR::Region::Region ( std::shared_ptr< const Region > )

protected

Construct a region from another region

◆ Region() [3/5]

ARDOUR::Region::Region	(	std::shared_ptr< const Region >	,
		timecnt_t const &	start_offset
	)

protected

Construct a region from another region, at an offset within that region

◆ Region() [4/5]

ARDOUR::Region::Region	(	std::shared_ptr< const Region >	,
		const SourceList &
	)

protected

Construct a region as a copy of another region, but with different sources

◆ Region() [5/5]

ARDOUR::Region::Region	(	Session &	s,
		timepos_t const &	start,
		timecnt_t const &	length,
		const std::string &	name,
		DataType
	)

protected

Constructor for derived types only

Member Function Documentation

◆ _add_plugin()

virtual bool ARDOUR::Region::_add_plugin	(	std::shared_ptr< RegionFxPlugin >	,
		std::shared_ptr< RegionFxPlugin >	,
		bool
	)

inlineprotectedvirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 580 of file ardour/ardour/region.h.

◆ _set_state()

virtual int ARDOUR::Region::_set_state	(	const XMLNode &	,
		int	version,
		PBD::PropertyChange &	what_changed,
		bool	send_signal
	)

protectedvirtual

Reimplemented in ARDOUR::AudioRegion.

◆ absolute_time_to_region_time()

Temporal::timepos_t ARDOUR::Region::absolute_time_to_region_time ( Temporal::timepos_t const & ) const

◆ absolute_time_to_soucre_beats()

Temporal::Beats ARDOUR::Region::absolute_time_to_soucre_beats ( Temporal::timepos_t const & ) const

◆ absolute_time_to_source_beats()

Temporal::Beats ARDOUR::Region::absolute_time_to_source_beats ( Temporal::timepos_t const & ) const

Convert a timestamp in absolute time to beats measured from source start

◆ add_plugin()

bool ARDOUR::Region::add_plugin	(	std::shared_ptr< RegionFxPlugin >	,
		std::shared_ptr< RegionFxPlugin >	pos = `std::shared_ptr< RegionFxPlugin >()`
	)

◆ add_transient()

virtual void ARDOUR::Region::add_transient ( samplepos_t )

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 452 of file ardour/ardour/region.h.

◆ adjust_to_sync()

timepos_t ARDOUR::Region::adjust_to_sync ( timepos_t const & ) const

◆ ancestral_length()

timecnt_t ARDOUR::Region::ancestral_length ( ) const

inline

Definition at line 174 of file ardour/ardour/region.h.

◆ ancestral_length_samples()

samplecnt_t ARDOUR::Region::ancestral_length_samples ( ) const

inline

Definition at line 172 of file ardour/ardour/region.h.

◆ ancestral_start()

timepos_t ARDOUR::Region::ancestral_start ( ) const

inline

Definition at line 173 of file ardour/ardour/region.h.

◆ ancestral_start_sample()

samplecnt_t ARDOUR::Region::ancestral_start_sample ( ) const

inline

Definition at line 171 of file ardour/ardour/region.h.

◆ any_source_equivalent()

bool ARDOUR::Region::any_source_equivalent ( std::shared_ptr< const Region > ) const

◆ apply()

int ARDOUR::Region::apply	(	Filter &	,
		PBD::Progress *	progress = `0`
	)

◆ at_natural_position()

bool ARDOUR::Region::at_natural_position ( ) const

◆ automatic()

bool ARDOUR::Region::automatic ( ) const

inline

Definition at line 277 of file ardour/ardour/region.h.

◆ can_move()

bool ARDOUR::Region::can_move ( ) const

inline

Definition at line 280 of file ardour/ardour/region.h.

◆ can_trim()

Trimmable::CanTrim ARDOUR::Region::can_trim ( ) const

virtual

Reimplemented from ARDOUR::Trimmable.

◆ can_trim_start_before_source_start()

virtual bool ARDOUR::Region::can_trim_start_before_source_start ( ) const

inlineprotectedvirtual

Reimplemented in ARDOUR::MidiRegion.

Definition at line 575 of file ardour/ardour/region.h.

◆ captured()

bool ARDOUR::Region::captured ( ) const

inline

Definition at line 279 of file ardour/ardour/region.h.

◆ captured_xruns()

void ARDOUR::Region::captured_xruns	(	XrunPositions &	,
		bool	abs = `false`
	)		const

◆ clear_sync_position()

void ARDOUR::Region::clear_sync_position ( )

◆ clear_transients()

virtual void ARDOUR::Region::clear_transients ( )

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 456 of file ardour/ardour/region.h.

◆ control() [1/2]

virtual std::shared_ptr<const Evoral::Control> ARDOUR::Region::control ( const Evoral::Parameter & id ) const

pure virtual

Implemented in ARDOUR::MidiRegion, and ARDOUR::AudioRegion.

◆ control() [2/2]

virtual std::shared_ptr<Evoral::Control> ARDOUR::Region::control	(	const Evoral::Parameter &	id,
		bool	create = `false`
	)

pure virtual

Implemented in ARDOUR::MidiRegion, and ARDOUR::AudioRegion.

◆ coverage()

Temporal::OverlapType ARDOUR::Region::coverage	(	timepos_t const &	start,
		timepos_t const &	end,
		bool	with_tail = `false`
	)		const

inline

Returns: coverage of this region with the given range; OverlapInternal: the range is internal to this region. OverlapStart: the range overlaps the start of this region. OverlapEnd: the range overlaps the end of this region. OverlapExternal: the range overlaps all of this region.

Definition at line 307 of file ardour/ardour/region.h.

◆ covers() [1/2]

bool ARDOUR::Region::covers ( samplepos_t sample ) const

inline

Definition at line 293 of file ardour/ardour/region.h.

◆ covers() [2/2]

bool ARDOUR::Region::covers ( timepos_t const & pos ) const

inline

Definition at line 297 of file ardour/ardour/region.h.

◆ cut_end()

void ARDOUR::Region::cut_end ( timepos_t const & new_position )

◆ cut_front()

void ARDOUR::Region::cut_front ( timepos_t const & new_position )

◆ data_type()

const DataType& ARDOUR::Region::data_type ( ) const

inline

Definition at line 131 of file ardour/ardour/region.h.

◆ deep_sources()

void ARDOUR::Region::deep_sources ( std::set< std::shared_ptr< Source > > & ) const

◆ depends_on()

virtual bool ARDOUR::Region::depends_on ( std::shared_ptr< Region > ) const

inlinevirtual

Definition at line 450 of file ardour/ardour/region.h.

◆ derive_properties()

PBD::PropertyList ARDOUR::Region::derive_properties	(	bool	with_times = `true`,
		bool	with_envelope = `false`
	)		const

◆ do_export()

virtual bool ARDOUR::Region::do_export ( std::string const & ) const

pure virtual

Implemented in ARDOUR::MidiRegion, and ARDOUR::AudioRegion.

◆ drop_sources()

void ARDOUR::Region::drop_sources ( )

◆ earliest_possible_position()

timepos_t ARDOUR::Region::earliest_possible_position ( ) const

Return the earliest possible value of _position given the value of _start within the region's sources

◆ enclosed_equivalent()

bool ARDOUR::Region::enclosed_equivalent ( std::shared_ptr< const Region > ) const

◆ end()

timepos_t ARDOUR::Region::end ( ) const

◆ ensure_length_sanity()

virtual void ARDOUR::Region::ensure_length_sanity ( )

inlineprotectedvirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 591 of file ardour/ardour/region.h.

◆ exact_equivalent()

bool ARDOUR::Region::exact_equivalent ( std::shared_ptr< const Region > ) const

◆ external()

bool ARDOUR::Region::external ( ) const

inline

Definition at line 282 of file ardour/ardour/region.h.

◆ fade_range()

virtual void ARDOUR::Region::fade_range	(	samplepos_t	,
		samplepos_t
	)

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 343 of file ardour/ardour/region.h.

◆ finish_domain_bounce()

void ARDOUR::Region::finish_domain_bounce ( Temporal::DomainBounceInfo & )

virtual

Implements Temporal::TimeDomainSwapper.

◆ first_edit()

void ARDOUR::Region::first_edit ( )

protected

◆ first_sample()

samplepos_t ARDOUR::Region::first_sample ( ) const

inline

Definition at line 247 of file ardour/ardour/region.h.

◆ foreach_plugin()

void ARDOUR::Region::foreach_plugin ( std::function< void(std::weak_ptr< RegionFxPlugin >)> method ) const

inline

Definition at line 541 of file ardour/ardour/region.h.

◆ fx_latency_changed()

virtual void ARDOUR::Region::fx_latency_changed ( bool no_emit )

protectedvirtual

Reimplemented in ARDOUR::AudioRegion.

◆ fx_tail_changed()

virtual void ARDOUR::Region::fx_tail_changed ( bool no_emit )

protectedvirtual

Reimplemented in ARDOUR::AudioRegion.

◆ get_cue_markers()

void ARDOUR::Region::get_cue_markers	(	CueMarkers &	,
		bool	abs = `false`
	)		const

◆ get_parent()

virtual std::shared_ptr<Region> ARDOUR::Region::get_parent ( ) const

virtual

◆ get_region_operation_group_id()

static uint64_t ARDOUR::Region::get_region_operation_group_id	(	uint64_t	old_region_group,
		RegionOperationFlag	flags
	)

static

◆ get_retained_group_id()

static uint64_t ARDOUR::Region::get_retained_group_id ( uint64_t take = 0 )

inlinestatic

Definition at line 219 of file ardour/ardour/region.h.

◆ get_state()

XMLNode& ARDOUR::Region::get_state ( ) const

virtual

Implements PBD::Stateful.

◆ get_transients()

virtual void ARDOUR::Region::get_transients ( AnalysisFeatureList & )

inlinevirtual

merges _onsets OR _transients with _user_transients into given list if _onsets and _transients are unset, run analysis. list is not thinned, duplicates remain in place.

intended for: Playlist::find_next_transient ()

Reimplemented in ARDOUR::AudioRegion.

Definition at line 485 of file ardour/ardour/region.h.

◆ has_region_fx()

bool ARDOUR::Region::has_region_fx ( ) const

inline

Definition at line 521 of file ardour/ardour/region.h.

◆ has_transients()

bool ARDOUR::Region::has_transients ( ) const

◆ hidden()

bool ARDOUR::Region::hidden ( ) const

inline

Definition at line 271 of file ardour/ardour/region.h.

◆ import()

bool ARDOUR::Region::import ( ) const

inline

Definition at line 283 of file ardour/ardour/region.h.

◆ is_compound()

bool ARDOUR::Region::is_compound ( ) const

◆ is_dependent()

virtual bool ARDOUR::Region::is_dependent ( ) const

inlinevirtual

Definition at line 449 of file ardour/ardour/region.h.

◆ is_explicitly_grouped()

bool ARDOUR::Region::is_explicitly_grouped ( )

inline

Definition at line 231 of file ardour/ardour/region.h.

◆ is_explicitly_ungrouped()

bool ARDOUR::Region::is_explicitly_ungrouped ( )

inline

Definition at line 233 of file ardour/ardour/region.h.

◆ is_implicitly_ungrouped()

bool ARDOUR::Region::is_implicitly_ungrouped ( )

inline

Definition at line 232 of file ardour/ardour/region.h.

◆ last_length()

timecnt_t ARDOUR::Region::last_length ( ) const

inline

Definition at line 169 of file ardour/ardour/region.h.

◆ last_position()

timepos_t ARDOUR::Region::last_position ( ) const

inline

Definition at line 168 of file ardour/ardour/region.h.

◆ last_range()

Temporal::TimeRange ARDOUR::Region::last_range ( ) const

inline

Definition at line 259 of file ardour/ardour/region.h.

◆ last_sample()

samplepos_t ARDOUR::Region::last_sample ( ) const

inline

Definition at line 248 of file ardour/ardour/region.h.

◆ latest_possible_sample()

samplepos_t ARDOUR::Region::latest_possible_sample ( ) const

Return the last possible value of _last_sample given the value of _startin the regions's sources

◆ layer()

layer_t ARDOUR::Region::layer ( ) const

inline

Definition at line 159 of file ardour/ardour/region.h.

◆ layer_and_time_equivalent()

bool ARDOUR::Region::layer_and_time_equivalent ( std::shared_ptr< const Region > ) const

◆ layering_index()

uint64_t ARDOUR::Region::layering_index ( ) const

inline

Definition at line 446 of file ardour/ardour/region.h.

◆ len_as_tpos()

timepos_t ARDOUR::Region::len_as_tpos ( ) const

inlineprotected

Definition at line 598 of file ardour/ardour/region.h.

◆ length()

timecnt_t ARDOUR::Region::length ( ) const

inline

Definition at line 145 of file ardour/ardour/region.h.

◆ length_samples()

samplecnt_t ARDOUR::Region::length_samples ( ) const

inline

Definition at line 157 of file ardour/ardour/region.h.

◆ load_plugin()

bool ARDOUR::Region::load_plugin	(	ARDOUR::PluginType	type,
		std::string const &	name
	)

◆ locked()

bool ARDOUR::Region::locked ( ) const

inline

Definition at line 274 of file ardour/ardour/region.h.

◆ lower()

void ARDOUR::Region::lower ( )

◆ lower_to_bottom()

void ARDOUR::Region::lower_to_bottom ( )

◆ make_property_quarks()

static void ARDOUR::Region::make_property_quarks ( )

static

◆ master_source_names()

std::vector<std::string> ARDOUR::Region::master_source_names ( )

◆ master_sources()

const SourceList& ARDOUR::Region::master_sources ( ) const

inline

Definition at line 413 of file ardour/ardour/region.h.

◆ max_source_level()

uint32_t ARDOUR::Region::max_source_level ( ) const

◆ maybe_invalidate_transients()

void ARDOUR::Region::maybe_invalidate_transients ( )

◆ maybe_uncopy()

void ARDOUR::Region::maybe_uncopy ( )

private

◆ merge_features()

void ARDOUR::Region::merge_features	(	AnalysisFeatureList &	,
		const AnalysisFeatureList &	,
		const	sampleoffset_t
	)		const

protected

◆ meter()

std::optional<Temporal::Meter> ARDOUR::Region::meter ( ) const

◆ mid_thaw()

void ARDOUR::Region::mid_thaw ( const PBD::PropertyChange & )

privatevirtual

derived classes can implement this in order to process a property change within thaw() just before send_change() is called.

Reimplemented from PBD::Stateful.

◆ modify_end_unchecked()

void ARDOUR::Region::modify_end_unchecked	(	timepos_t const &	new_position,
		bool	reset_fade
	)

◆ modify_front_unchecked()

void ARDOUR::Region::modify_front_unchecked	(	timepos_t const &	new_position,
		bool	reset_fade
	)

◆ move_cue_marker()

void ARDOUR::Region::move_cue_marker	(	CueMarker const &	,
		timepos_t const &	region_relative_position
	)

◆ move_start()

void ARDOUR::Region::move_start ( timecnt_t const & distance )

◆ move_to_natural_position()

void ARDOUR::Region::move_to_natural_position ( )

◆ muted()

bool ARDOUR::Region::muted ( ) const

inline

Definition at line 272 of file ardour/ardour/region.h.

◆ n_region_fx()

size_t ARDOUR::Region::n_region_fx ( ) const

inline

Definition at line 526 of file ardour/ardour/region.h.

◆ next_group_id()

static uint64_t ARDOUR::Region::next_group_id ( )

inlinestatic

Definition at line 211 of file ardour/ardour/region.h.

◆ nt_last()

timepos_t ARDOUR::Region::nt_last ( ) const

inline

Definition at line 147 of file ardour/ardour/region.h.

◆ nth_plugin()

std::shared_ptr<RegionFxPlugin> ARDOUR::Region::nth_plugin ( uint32_t n ) const

inline

Definition at line 531 of file ardour/ardour/region.h.

◆ nudge_position()

void ARDOUR::Region::nudge_position ( timecnt_t const & )

◆ opaque()

bool ARDOUR::Region::opaque ( ) const

inline

Definition at line 273 of file ardour/ardour/region.h.

◆ overlap_equivalent()

bool ARDOUR::Region::overlap_equivalent ( std::shared_ptr< const Region > ) const

◆ override_opaqueness()

void ARDOUR::Region::override_opaqueness ( bool yn )

inlineprotected

Definition at line 593 of file ardour/ardour/region.h.

◆ playlist()

std::shared_ptr<ARDOUR::Playlist> ARDOUR::Region::playlist ( ) const

inline

Definition at line 402 of file ardour/ardour/region.h.

◆ position()

timepos_t ARDOUR::Region::position ( ) const

inline

How the region parameters play together:

POSITION: first sample of the region along the timeline START: first sample of the region within its source(s) LENGTH: number of samples the region represents

Definition at line 143 of file ardour/ardour/region.h.

◆ position_locked()

bool ARDOUR::Region::position_locked ( ) const

inline

Definition at line 275 of file ardour/ardour/region.h.

◆ position_sample()

samplepos_t ARDOUR::Region::position_sample ( ) const

inline

Definition at line 155 of file ardour/ardour/region.h.

◆ position_time_domain()

Temporal::TimeDomain ARDOUR::Region::position_time_domain ( ) const

◆ raise()

void ARDOUR::Region::raise ( )

◆ raise_to_top()

void ARDOUR::Region::raise_to_top ( )

◆ range()

Temporal::TimeRange ARDOUR::Region::range ( ) const

inline

Definition at line 267 of file ardour/ardour/region.h.

◆ range_samples()

Temporal::TimeRange ARDOUR::Region::range_samples ( ) const

inline

Definition at line 263 of file ardour/ardour/region.h.

◆ recompute_at_end()

virtual void ARDOUR::Region::recompute_at_end ( )

privatepure virtual

Implemented in ARDOUR::MidiRegion, and ARDOUR::AudioRegion.

◆ recompute_at_start()

virtual void ARDOUR::Region::recompute_at_start ( )

privatepure virtual

Implemented in ARDOUR::MidiRegion, and ARDOUR::AudioRegion.

◆ recompute_position_from_time_domain()

void ARDOUR::Region::recompute_position_from_time_domain ( )

◆ region_beats_to_absolute_time()

Temporal::timepos_t ARDOUR::Region::region_beats_to_absolute_time ( Temporal::Beats beats ) const

◆ region_beats_to_region_time()

Temporal::timepos_t ARDOUR::Region::region_beats_to_region_time ( Temporal::Beats beats ) const

inline

Convert a timestamp in beats into timepos_t (both relative to region position)

Definition at line 373 of file ardour/ardour/region.h.

◆ region_beats_to_source_beats()

Temporal::Beats ARDOUR::Region::region_beats_to_source_beats ( Temporal::Beats beats ) const

inline

Convert a timestamp in beats relative to region position into beats relative to source start

Definition at line 377 of file ardour/ardour/region.h.

◆ region_distance_to_region_beats()

Temporal::Beats ARDOUR::Region::region_distance_to_region_beats ( Temporal::timecnt_t const & ) const

Convert a distance within a region to beats relative to region position

◆ region_group()

uint64_t ARDOUR::Region::region_group ( ) const

inline

Definition at line 227 of file ardour/ardour/region.h.

◆ region_relative_position()

timecnt_t ARDOUR::Region::region_relative_position ( Temporal::timepos_t const & ) const

◆ register_properties()

void ARDOUR::Region::register_properties ( )

private

◆ remove_plugin()

virtual bool ARDOUR::Region::remove_plugin ( std::shared_ptr< RegionFxPlugin > )

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 518 of file ardour/ardour/region.h.

◆ remove_transient()

virtual void ARDOUR::Region::remove_transient ( samplepos_t )

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 464 of file ardour/ardour/region.h.

◆ rename_cue_marker()

void ARDOUR::Region::rename_cue_marker	(	CueMarker &	,
		std::string const &
	)

◆ reorder_plugins()

virtual void ARDOUR::Region::reorder_plugins ( RegionFxList const & )

virtual

Reimplemented in ARDOUR::AudioRegion.

◆ send_change()

virtual void ARDOUR::Region::send_change ( const PBD::PropertyChange & )

protectedvirtual

Reimplemented from PBD::Stateful.

Reimplemented in ARDOUR::AudioRegion.

◆ separate_by_channel()

virtual int ARDOUR::Region::separate_by_channel ( std::vector< std::shared_ptr< Region > > & ) const

inlinevirtual

Reimplemented in ARDOUR::MidiRegion, and ARDOUR::AudioRegion.

Definition at line 498 of file ardour/ardour/region.h.

◆ set_ancestral_data()

void ARDOUR::Region::set_ancestral_data	(	timepos_t const &	start,
		timecnt_t const &	length,
		float	stretch,
		float	shift
	)

◆ set_automatic()

void ARDOUR::Region::set_automatic ( bool yn )

◆ set_changemap()

void ARDOUR::Region::set_changemap ( ChangeMap * changemap )

inline

Definition at line 507 of file ardour/ardour/region.h.

◆ set_hidden()

void ARDOUR::Region::set_hidden ( bool yn )

◆ set_initial_position()

void ARDOUR::Region::set_initial_position ( timepos_t const & )

◆ set_layer()

void ARDOUR::Region::set_layer ( layer_t l )

◆ set_layering_index()

void ARDOUR::Region::set_layering_index ( uint64_t when )

inline

Definition at line 447 of file ardour/ardour/region.h.

◆ set_length()

void ARDOUR::Region::set_length ( timecnt_t const & )

◆ set_length_internal()

void ARDOUR::Region::set_length_internal ( timecnt_t const & )

protected

◆ set_length_unchecked()

void ARDOUR::Region::set_length_unchecked ( timecnt_t const & )

◆ set_locked()

void ARDOUR::Region::set_locked ( bool yn )

◆ set_master_sources()

void ARDOUR::Region::set_master_sources ( const SourceList & )

◆ set_meter()

void ARDOUR::Region::set_meter ( Temporal::Meter const & )

◆ set_muted()

void ARDOUR::Region::set_muted ( bool yn )

◆ set_name()

bool ARDOUR::Region::set_name ( const std::string & str )

virtual

Note: changing the name of a Region does not constitute an edit

Reimplemented from ARDOUR::SessionObject.

◆ set_next_group_id()

static void ARDOUR::Region::set_next_group_id ( uint64_t ngid )

inlinestatic

Definition at line 212 of file ardour/ardour/region.h.

◆ set_onsets()

virtual void ARDOUR::Region::set_onsets ( AnalysisFeatureList & )

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 468 of file ardour/ardour/region.h.

◆ set_opaque()

void ARDOUR::Region::set_opaque ( bool yn )

◆ set_playlist()

virtual void ARDOUR::Region::set_playlist ( std::weak_ptr< ARDOUR::Playlist > )

virtual

◆ set_position()

void ARDOUR::Region::set_position ( timepos_t const & )

◆ set_position_internal()

virtual void ARDOUR::Region::set_position_internal ( timepos_t const & pos )

protectedvirtual

◆ set_position_locked()

void ARDOUR::Region::set_position_locked ( bool yn )

◆ set_position_time_domain()

void ARDOUR::Region::set_position_time_domain ( Temporal::TimeDomain ps )

◆ set_position_unchecked()

void ARDOUR::Region::set_position_unchecked ( timepos_t const & )

◆ set_region_group()

void ARDOUR::Region::set_region_group	(	uint64_t	rg,
		bool	explicitly = `false`
	)

inline

Definition at line 228 of file ardour/ardour/region.h.

◆ set_selected_for_solo()

void ARDOUR::Region::set_selected_for_solo ( bool yn )

◆ set_start()

void ARDOUR::Region::set_start ( timepos_t const & )

◆ set_start_internal()

virtual void ARDOUR::Region::set_start_internal ( timepos_t const & )

protectedvirtual

◆ set_state()

virtual int ARDOUR::Region::set_state	(	const XMLNode &	,
		int	version
	)

virtual

Implements PBD::Stateful.

Reimplemented in ARDOUR::MidiRegion, and ARDOUR::AudioRegion.

◆ set_sync_position()

void ARDOUR::Region::set_sync_position ( timepos_t const & n )

◆ set_tags()

virtual bool ARDOUR::Region::set_tags ( const std::string & str )

inlinevirtual

Definition at line 429 of file ardour/ardour/region.h.

◆ set_tempo()

void ARDOUR::Region::set_tempo ( Temporal::Tempo const & )

◆ set_video_locked()

void ARDOUR::Region::set_video_locked ( bool yn )

◆ set_whole_file()

void ARDOUR::Region::set_whole_file ( bool yn )

◆ shift()

float ARDOUR::Region::shift ( ) const

inline

Definition at line 236 of file ardour/ardour/region.h.

◆ size_equivalent()

bool ARDOUR::Region::size_equivalent ( std::shared_ptr< const Region > ) const

◆ source()

std::shared_ptr<Source> ARDOUR::Region::source ( uint32_t n = 0 ) const

inline

Definition at line 409 of file ardour/ardour/region.h.

◆ source_beats_to_absolute_beats()

Temporal::Beats ARDOUR::Region::source_beats_to_absolute_beats ( Temporal::Beats beats ) const

Convert a timestamp in beats measured from source start into absolute beats

◆ source_beats_to_absolute_time()

Temporal::timepos_t ARDOUR::Region::source_beats_to_absolute_time ( Temporal::Beats beats ) const

Convert a timestamp in beats measured from source start into absolute samples

◆ source_beats_to_region_time()

Temporal::timepos_t ARDOUR::Region::source_beats_to_region_time ( Temporal::Beats beats ) const

inline

Convert a timestamp in beats measured from source start into region-relative samples

Definition at line 390 of file ardour/ardour/region.h.

◆ source_deleted()

void ARDOUR::Region::source_deleted ( std::weak_ptr< Source > )

◆ source_equivalent()

bool ARDOUR::Region::source_equivalent ( std::shared_ptr< const Region > ) const

◆ source_length()

timepos_t ARDOUR::Region::source_length ( uint32_t n ) const

◆ source_position()

timepos_t ARDOUR::Region::source_position ( ) const

◆ source_relative_position()

timecnt_t ARDOUR::Region::source_relative_position ( Temporal::timepos_t const & ) const

◆ source_string()

std::string ARDOUR::Region::source_string ( ) const

◆ sources()

const SourceList& ARDOUR::Region::sources ( ) const

inline

Definition at line 412 of file ardour/ardour/region.h.

◆ sources_for_edit()

SourceList& ARDOUR::Region::sources_for_edit ( )

inline

Definition at line 411 of file ardour/ardour/region.h.

◆ special_set_position()

void ARDOUR::Region::special_set_position ( timepos_t const & )

◆ start()

timepos_t ARDOUR::Region::start ( void ) const

inline

Definition at line 144 of file ardour/ardour/region.h.

◆ start_domain_bounce()

void ARDOUR::Region::start_domain_bounce ( Temporal::DomainBounceInfo & )

virtual

Implements Temporal::TimeDomainSwapper.

◆ start_sample()

samplecnt_t ARDOUR::Region::start_sample ( ) const

inline

Definition at line 156 of file ardour/ardour/region.h.

◆ state()

virtual XMLNode& ARDOUR::Region::state ( ) const

protectedvirtual

Reimplemented in ARDOUR::MidiRegion, and ARDOUR::AudioRegion.

◆ stretch()

float ARDOUR::Region::stretch ( ) const

inline

Definition at line 235 of file ardour/ardour/region.h.

◆ subscribe_to_source_drop()

void ARDOUR::Region::subscribe_to_source_drop ( )

private

◆ suspend_property_changes()

void ARDOUR::Region::suspend_property_changes ( )

virtual

Reimplemented from PBD::Stateful.

◆ sync_marked()

bool ARDOUR::Region::sync_marked ( ) const

inline

Definition at line 281 of file ardour/ardour/region.h.

◆ sync_offset()

timecnt_t ARDOUR::Region::sync_offset ( int & dir ) const

◆ sync_position()

timepos_t ARDOUR::Region::sync_position ( ) const

◆ tags()

std::string ARDOUR::Region::tags ( ) const

inline

Definition at line 428 of file ardour/ardour/region.h.

◆ tail()

virtual timecnt_t ARDOUR::Region::tail ( ) const

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 149 of file ardour/ardour/region.h.

◆ tempo()

std::optional<Temporal::Tempo> ARDOUR::Region::tempo ( ) const

◆ tempo_map()

std::shared_ptr<Temporal::TempoMap> ARDOUR::Region::tempo_map ( ) const

◆ time_domain()

Temporal::TimeDomain ARDOUR::Region::time_domain ( ) const

◆ transients() [1/2]

AnalysisFeatureList ARDOUR::Region::transients ( )

inline

Definition at line 490 of file ardour/ardour/region.h.

◆ transients() [2/2]

void ARDOUR::Region::transients ( AnalysisFeatureList & )

merges _onsets and _user_transients into given list and removed exact duplicates.

◆ trim_end()

void ARDOUR::Region::trim_end ( timepos_t const & new_position )

◆ trim_front()

void ARDOUR::Region::trim_front ( timepos_t const & new_position )

◆ trim_to()

void ARDOUR::Region::trim_to	(	timepos_t const &	pos,
		timecnt_t const &	length
	)

◆ trim_to_internal()

void ARDOUR::Region::trim_to_internal	(	timepos_t const &	position,
		timecnt_t const &	length
	)

private

◆ unset_region_group()

void ARDOUR::Region::unset_region_group ( bool explicitly = false )

inline

Definition at line 229 of file ardour/ardour/region.h.

◆ update_after_tempo_map_change()

virtual void ARDOUR::Region::update_after_tempo_map_change ( bool send_change = true )

virtual

◆ update_transient()

virtual void ARDOUR::Region::update_transient	(	samplepos_t	,
		samplepos_t
	)

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 460 of file ardour/ardour/region.h.

◆ use_sources()

void ARDOUR::Region::use_sources ( SourceList const & )

private

◆ uses_source()

bool ARDOUR::Region::uses_source	(	std::shared_ptr< const Source >	,
		bool	shallow = `false`
	)		const

◆ verify_length()

bool ARDOUR::Region::verify_length ( timecnt_t & )

private

◆ verify_start()

bool ARDOUR::Region::verify_start ( timepos_t const & )

private

◆ verify_start_and_length()

bool ARDOUR::Region::verify_start_and_length	(	timepos_t const &	,
		timecnt_t &
	)

protected

◆ video_locked()

bool ARDOUR::Region::video_locked ( ) const

inline

Definition at line 276 of file ardour/ardour/region.h.

◆ whole_file()

bool ARDOUR::Region::whole_file ( ) const

inline

Definition at line 278 of file ardour/ardour/region.h.

Friends And Related Function Documentation

◆ RegionFactory

friend class RegionFactory

friend

Definition at line 558 of file ardour/ardour/region.h.

Member Data Documentation

◆ _ancestral_length

PBD::Property<timecnt_t> ARDOUR::Region::_ancestral_length

private

Definition at line 662 of file ardour/ardour/region.h.

◆ _ancestral_start

PBD::Property<timepos_t> ARDOUR::Region::_ancestral_start

private

Definition at line 661 of file ardour/ardour/region.h.

◆ _automatic

PBD::Property<bool> ARDOUR::Region::_automatic

private

Definition at line 655 of file ardour/ardour/region.h.

◆ _changemap

ChangeMap* ARDOUR::Region::_changemap

private

Definition at line 674 of file ardour/ardour/region.h.

◆ _contents

PBD::Property<bool> ARDOUR::Region::_contents

private

Definition at line 668 of file ardour/ardour/region.h.

◆ _external

PBD::Property<bool> ARDOUR::Region::_external

private

Definition at line 658 of file ardour/ardour/region.h.

◆ _first_edit

RegionEditState ARDOUR::Region::_first_edit

mutableprivate

Definition at line 671 of file ardour/ardour/region.h.

◆ _fx_latency

uint32_t ARDOUR::Region::_fx_latency

protected

Definition at line 603 of file ardour/ardour/region.h.

◆ _fx_lock

Glib::Threads::RWLock ARDOUR::Region::_fx_lock

mutableprotected

Definition at line 602 of file ardour/ardour/region.h.

◆ _fx_tail

uint32_t ARDOUR::Region::_fx_tail

protected

Definition at line 604 of file ardour/ardour/region.h.

◆ _hidden

PBD::Property<bool> ARDOUR::Region::_hidden

private

Definition at line 659 of file ardour/ardour/region.h.

◆ _import

PBD::Property<bool> ARDOUR::Region::_import

private

Definition at line 657 of file ardour/ardour/region.h.

◆ _last_length

timecnt_t ARDOUR::Region::_last_length

private

Definition at line 670 of file ardour/ardour/region.h.

◆ _layer

layer_t ARDOUR::Region::_layer

private

Definition at line 672 of file ardour/ardour/region.h.

◆ _layering_index

PBD::Property<uint64_t> ARDOUR::Region::_layering_index

private

Definition at line 665 of file ardour/ardour/region.h.

◆ _left_of_split

PBD::Property<bool> ARDOUR::Region::_left_of_split

protected

Definition at line 608 of file ardour/ardour/region.h.

◆ _length

PBD::Property<timecnt_t> ARDOUR::Region::_length

protected

Definition at line 612 of file ardour/ardour/region.h.

◆ _locked

PBD::Property<bool> ARDOUR::Region::_locked

private

Definition at line 653 of file ardour/ardour/region.h.

◆ _master_sources

SourceList ARDOUR::Region::_master_sources

protected

Used when timefx are applied, so we can always use the original source

Definition at line 618 of file ardour/ardour/region.h.

◆ _muted

PBD::Property<bool> ARDOUR::Region::_muted

private

Definition at line 651 of file ardour/ardour/region.h.

◆ _next_group_id

uint64_t ARDOUR::Region::_next_group_id

staticprivate

Definition at line 686 of file ardour/ardour/region.h.

◆ _onsets

AnalysisFeatureList ARDOUR::Region::_onsets

protected

Definition at line 624 of file ardour/ardour/region.h.

◆ _opaque

PBD::Property<bool> ARDOUR::Region::_opaque

private

Definition at line 652 of file ardour/ardour/region.h.

◆ _operation_rgroup_map

std::map<uint64_t, uint64_t> ARDOUR::Region::_operation_rgroup_map

staticprivate

Definition at line 689 of file ardour/ardour/region.h.

◆ _operation_rgroup_mutex

Glib::Threads::Mutex ARDOUR::Region::_operation_rgroup_mutex

staticprivate

Definition at line 688 of file ardour/ardour/region.h.

◆ _playlist

std::weak_ptr<ARDOUR::Playlist> ARDOUR::Region::_playlist

protected

Definition at line 620 of file ardour/ardour/region.h.

◆ _plugins

RegionFxList ARDOUR::Region::_plugins

protected

Definition at line 605 of file ardour/ardour/region.h.

◆ _position_locked

PBD::Property<bool> ARDOUR::Region::_position_locked

private

Definition at line 660 of file ardour/ardour/region.h.

◆ _reg_group

PBD::Property<uint64_t> ARDOUR::Region::_reg_group

private

Definition at line 667 of file ardour/ardour/region.h.

◆ _retained_group_id

uint64_t ARDOUR::Region::_retained_group_id

staticprivate

Definition at line 684 of file ardour/ardour/region.h.

◆ _retained_take_cnt

uint64_t ARDOUR::Region::_retained_take_cnt

staticprivate

Definition at line 685 of file ardour/ardour/region.h.

◆ _right_of_split

PBD::Property<bool> ARDOUR::Region::_right_of_split

protected

Definition at line 609 of file ardour/ardour/region.h.

◆ _shift

PBD::Property<float> ARDOUR::Region::_shift

private

Definition at line 664 of file ardour/ardour/region.h.

◆ _soloSelected

bool ARDOUR::Region::_soloSelected

protected

Definition at line 635 of file ardour/ardour/region.h.

◆ _source_deleted

std::atomic<int> ARDOUR::Region::_source_deleted

private

Definition at line 691 of file ardour/ardour/region.h.

◆ _source_deleted_connections

PBD::ScopedConnectionList ARDOUR::Region::_source_deleted_connections

private

Definition at line 693 of file ardour/ardour/region.h.

◆ _source_list_lock

Glib::Threads::Mutex ARDOUR::Region::_source_list_lock

private

Definition at line 692 of file ardour/ardour/region.h.

◆ _sources

SourceList ARDOUR::Region::_sources

protected

Definition at line 616 of file ardour/ardour/region.h.

◆ _start

PBD::Property<timepos_t> ARDOUR::Region::_start

protected

Definition at line 611 of file ardour/ardour/region.h.

◆ _stretch

PBD::Property<float> ARDOUR::Region::_stretch

private

Definition at line 663 of file ardour/ardour/region.h.

◆ _sync_marked

PBD::Property<bool> ARDOUR::Region::_sync_marked

protected

Definition at line 607 of file ardour/ardour/region.h.

◆ _sync_position

PBD::Property<timepos_t> ARDOUR::Region::_sync_position

protected

Sync position relative to the start of our file

Definition at line 614 of file ardour/ardour/region.h.

◆ _tags

PBD::Property<std::string> ARDOUR::Region::_tags

private

Definition at line 666 of file ardour/ardour/region.h.

◆ _transient_analysis_end

samplepos_t ARDOUR::Region::_transient_analysis_end

protected

Definition at line 633 of file ardour/ardour/region.h.

◆ _transient_analysis_start

samplepos_t ARDOUR::Region::_transient_analysis_start

protected

Definition at line 632 of file ardour/ardour/region.h.

◆ _transient_user_start

samplepos_t ARDOUR::Region::_transient_user_start

protected

Definition at line 628 of file ardour/ardour/region.h.

◆ _transients

AnalysisFeatureList ARDOUR::Region::_transients

protected

Definition at line 631 of file ardour/ardour/region.h.

◆ _type

DataType ARDOUR::Region::_type

protected

Definition at line 600 of file ardour/ardour/region.h.

◆ _user_transients

AnalysisFeatureList ARDOUR::Region::_user_transients

protected

Definition at line 627 of file ardour/ardour/region.h.

◆ _valid_transients

PBD::Property<bool> ARDOUR::Region::_valid_transients

protected

Definition at line 610 of file ardour/ardour/region.h.

◆ _video_locked

PBD::Property<bool> ARDOUR::Region::_video_locked

private

Definition at line 654 of file ardour/ardour/region.h.

◆ _whole_file

PBD::Property<bool> ARDOUR::Region::_whole_file

private

Definition at line 656 of file ardour/ardour/region.h.

◆ RegionFxChanged

PBD::Signal<void()> ARDOUR::Region::RegionFxChanged

Definition at line 120 of file ardour/ardour/region.h.

◆ RegionsPropertyChanged

PBD::Signal<void(std::shared_ptr<RegionList>, const PBD::PropertyChange&)> ARDOUR::Region::RegionsPropertyChanged

static

Definition at line 118 of file ardour/ardour/region.h.

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

ardour/ardour/region.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ChangeMap

◆ RegionFxList

◆ SourceList

Member Enumeration Documentation

◆ RegionGroupFlags

Constructor & Destructor Documentation

◆ ~Region()

◆ Region() [1/5]

◆ Region() [2/5]

◆ Region() [3/5]

◆ Region() [4/5]

◆ Region() [5/5]

Member Function Documentation

◆ _add_plugin()

◆ _set_state()

◆ absolute_time_to_region_time()

◆ absolute_time_to_soucre_beats()

◆ absolute_time_to_source_beats()

◆ add_plugin()

◆ add_transient()

◆ adjust_to_sync()

◆ ancestral_length()

◆ ancestral_length_samples()

◆ ancestral_start()

◆ ancestral_start_sample()

◆ any_source_equivalent()

◆ apply()

◆ at_natural_position()

◆ automatic()

◆ can_move()

◆ can_trim()

◆ can_trim_start_before_source_start()

◆ captured()

◆ captured_xruns()

◆ clear_sync_position()

◆ clear_transients()

◆ control() [1/2]

◆ control() [2/2]

◆ coverage()

◆ covers() [1/2]

◆ covers() [2/2]

◆ cut_end()

◆ cut_front()

◆ data_type()

◆ deep_sources()

◆ depends_on()

◆ derive_properties()

◆ do_export()

◆ drop_sources()

◆ earliest_possible_position()

◆ enclosed_equivalent()

◆ end()

◆ ensure_length_sanity()

◆ exact_equivalent()

◆ external()

◆ fade_range()

◆ finish_domain_bounce()

◆ first_edit()

◆ first_sample()

◆ foreach_plugin()

◆ fx_latency_changed()

◆ fx_tail_changed()

◆ get_cue_markers()

◆ get_parent()

◆ get_region_operation_group_id()