ARDOUR::Region Class Reference

#include <region.h>

Inheritance diagram for ARDOUR::Region:

Public Types
typedef std::vector < boost::shared_ptr< Source > >	SourceList
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)
const DataType &	data_type () const
AnalysisFeatureList	transients ()
framepos_t	position () const
framepos_t	start () const
framecnt_t	length () const
layer_t	layer () const
framecnt_t	source_length (uint32_t n) const
uint32_t	max_source_level () const
framepos_t	last_position () const
framecnt_t	last_length () const
framepos_t	ancestral_start () const
framecnt_t	ancestral_length () const
float	stretch () const
float	shift () const
void	set_ancestral_data (framepos_t start, framecnt_t length, float stretch, float shift)
frameoffset_t	sync_offset (int &dir) const
framepos_t	sync_position () const
framepos_t	sync_point () const
framepos_t	adjust_to_sync (framepos_t) const
framepos_t	first_frame () const
framepos_t	last_frame () const
framepos_t	earliest_possible_position () const
framepos_t	latest_possible_frame () const
Evoral::Range< framepos_t >	last_range () const
Evoral::Range< framepos_t >	range () const
bool	hidden () const
bool	muted () const
bool	opaque () const
bool	locked () const
bool	position_locked () const
bool	video_locked () const
bool	valid_transients () 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
PositionLockStyle	position_lock_style () const
void	set_position_lock_style (PositionLockStyle ps)
void	recompute_position_from_lock_style ()
void	suspend_property_changes ()
bool	covers (framepos_t frame) const
Evoral::OverlapType	coverage (framepos_t start, framepos_t end) const
bool	equivalent (boost::shared_ptr< const Region >) const
bool	size_equivalent (boost::shared_ptr< const Region >) const
bool	overlap_equivalent (boost::shared_ptr< const Region >) const
bool	region_list_equivalent (boost::shared_ptr< const Region >) const
bool	source_equivalent (boost::shared_ptr< const Region >) const
bool	any_source_equivalent (boost::shared_ptr< const Region >) const
bool	uses_source (boost::shared_ptr< const Source >) const
std::string	source_string () const
void	set_length (framecnt_t)
void	set_start (framepos_t)
void	set_position (framepos_t)
void	special_set_position (framepos_t)
virtual void	update_after_tempo_map_change ()
void	nudge_position (frameoffset_t)
bool	at_natural_position () const
void	move_to_natural_position ()
void	move_start (frameoffset_t distance)
void	trim_front (framepos_t new_position)
void	trim_end (framepos_t new_position)
void	trim_to (framepos_t position, framecnt_t length)
virtual void	fade_range (framepos_t, framepos_t)
void	cut_front (framepos_t new_position)
void	cut_end (framepos_t new_position)
void	set_layer (layer_t l)
void	raise ()
void	lower ()
void	raise_to_top ()
void	lower_to_bottom ()
void	set_sync_position (framepos_t 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)
int	apply (Filter &, Progress *progress=0)
boost::shared_ptr < ARDOUR::Playlist >	playlist () const
virtual void	set_playlist (boost::weak_ptr< ARDOUR::Playlist >)
void	source_deleted (boost::weak_ptr< Source >)
bool	is_compound () const
boost::shared_ptr< Source >	source (uint32_t n=0) const
uint32_t	n_channels () const
const SourceList &	sources () const
const SourceList &	master_sources () const
std::vector< std::string >	master_source_names ()
void	set_master_sources (const SourceList &)
virtual boost::shared_ptr < Evoral::Control >	control (const Evoral::Parameter &id, bool create=false)=0
virtual boost::shared_ptr < const Evoral::Control >	control (const Evoral::Parameter &id) const =0
XMLNode &	get_state ()
virtual XMLNode &	state ()
virtual int	set_state (const XMLNode &, int version)
virtual boost::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 (boost::shared_ptr< Region >) const
virtual void	add_transient (framepos_t)
virtual int	update_transient (framepos_t, framepos_t)
virtual void	remove_transient (framepos_t)
virtual int	set_transients (AnalysisFeatureList &)
virtual int	get_transients (AnalysisFeatureList &, bool force_new=false)
virtual int	adjust_transients (frameoffset_t)
virtual int	separate_by_channel (ARDOUR::Session &, std::vector< boost::shared_ptr< Region > > &) const
void	invalidate_transients ()
void	drop_sources ()
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 ()
virtual	~ScopedConnectionList ()
void	add_connection (const UnscopedConnection &c)
void	drop_connections ()
Public Member Functions inherited from PBD::Stateful
	Stateful ()
virtual	~Stateful ()
virtual bool	apply_changes (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 (Command *) const
virtual void	rdiff (std::vector< 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
	Destructible ()
virtual	~Destructible ()
void	drop_references ()
Public Member Functions inherited from ARDOUR::Readable
	Readable ()
virtual	~Readable ()
virtual framecnt_t	read (Sample *, framepos_t pos, framecnt_t cnt, int channel) const =0
virtual framecnt_t	readable_length () const =0
Public Member Functions inherited from ARDOUR::Trimmable
	Trimmable ()
virtual	~Trimmable ()
Public Member Functions inherited from ARDOUR::Movable
	Movable ()
bool	locked () const

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

Static Public Attributes
static PBD::Signal2< void, boost::shared_ptr < ARDOUR::Region >, const PBD::PropertyChange & >	RegionPropertyChanged
Static Public Attributes inherited from PBD::Stateful
static int	current_state_version = 0
static int	loading_state_version = 0

Protected Member Functions
	Region (const SourceList &srcs)
	Region (boost::shared_ptr< const Region >)
	Region (boost::shared_ptr< const Region >, frameoffset_t start_offset)
	Region (boost::shared_ptr< const Region >, const SourceList &)
	Region (Session &s, framepos_t start, framecnt_t length, const std::string &name, DataType)
virtual bool	can_trim_start_before_source_start () const
void	send_change (const PBD::PropertyChange &)
virtual int	_set_state (const XMLNode &, int version, PBD::PropertyChange &what_changed, bool send_signal)
void	post_set (const PBD::PropertyChange &)
virtual void	set_position_internal (framepos_t pos, bool allow_bbt_recompute)
virtual void	set_length_internal (framecnt_t)
virtual void	set_start_internal (framecnt_t)
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 &)
PropertyChange	set_values (XMLNode const &)

Protected Attributes
DataType	_type
PBD::Property< bool >	_sync_marked
PBD::Property< bool >	_left_of_split
PBD::Property< bool >	_right_of_split
PBD::Property< bool >	_valid_transients
PBD::Property< framepos_t >	_start
PBD::Property< framecnt_t >	_length
PBD::Property< framepos_t >	_position
PBD::Property< framepos_t >	_sync_position
SourceList	_sources
SourceList	_master_sources
AnalysisFeatureList	_transients
boost::weak_ptr< ARDOUR::Playlist >	_playlist
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 Member Functions
void	mid_thaw (const PBD::PropertyChange &)
void	trim_to_internal (framepos_t position, framecnt_t length)
void	modify_front (framepos_t new_position, bool reset_fade)
void	modify_end (framepos_t new_position, bool reset_fade)
void	maybe_uncopy ()
void	first_edit ()
bool	verify_start (framepos_t)
bool	verify_start_and_length (framepos_t, framecnt_t &)
bool	verify_start_mutable (framepos_t &_start)
bool	verify_length (framecnt_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< framepos_t >	_ancestral_start
PBD::Property< framecnt_t >	_ancestral_length
PBD::Property< float >	_stretch
PBD::Property< float >	_shift
PBD::EnumProperty < PositionLockStyle >	_position_lock_style
PBD::Property< uint64_t >	_layering_index
framecnt_t	_last_length
framepos_t	_last_position
RegionEditState	_first_edit
Timecode::BBT_Time	_bbt_time
layer_t	_layer

Friends
class	RegionFactory

Additional Inherited Members
Public Attributes inherited from PBD::Stateful
PBD::Signal1< void, const PropertyChange & >	PropertyChanged
Public Attributes inherited from PBD::Destructible
PBD::Signal0< void >	Destroyed
PBD::Signal0< void >	DropReferences

Detailed Description

Definition at line 83 of file region.h.

Member Typedef Documentation

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

Definition at line 91 of file region.h.

Constructor & Destructor Documentation

Region::~Region ( )

virtual

Definition at line 404 of file region.cc.

Region::Region ( const SourceList &  srcs )

protected

Construct a region from multiple sources

Basic Region constructor (many sources)

Definition at line 233 of file region.cc.

Region::Region ( boost::shared_ptr< const Region >  other )

protected

Construct a region from another region

Create a new Region from an existing one

Definition at line 253 of file region.cc.

Region::Region ( boost::shared_ptr< const Region >  other, frameoffset_t  offset  )

protected

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

Create a new Region from part of an existing one.

the start within other is given by offset (i.e. relative to the start of other's sources, the start is offset + other.start()

Definition at line 323 of file region.cc.

Region::Region ( boost::shared_ptr< const Region >  other, const SourceList &  srcs  )

protected

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

Create a copy of

Parameters

other

but with different sources. Used by filters

Definition at line 378 of file region.cc.

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

protected

Constructor for derived types only

Member Function Documentation

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

protectedvirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 1241 of file region.cc.

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

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 289 of file region.h.

framepos_t Region::adjust_to_sync

(

framepos_t

pos

)

const

Definition at line 1058 of file region.cc.

virtual int ARDOUR::Region::adjust_transients ( frameoffset_t  )

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 313 of file region.h.

framecnt_t ARDOUR::Region::ancestral_length ( ) const

inline

Definition at line 126 of file region.h.

framepos_t ARDOUR::Region::ancestral_start ( ) const

inline

Definition at line 125 of file region.h.

bool Region::any_source_equivalent

(

boost::shared_ptr< const Region >

other

)

const

Definition at line 1437 of file region.cc.

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

Definition at line 1601 of file region.cc.

bool Region::at_natural_position

(

)

const

Definition at line 496 of file region.cc.

bool ARDOUR::Region::automatic ( ) const

inline

Definition at line 168 of file region.h.

bool ARDOUR::Region::can_move ( ) const

inline

Definition at line 171 of file region.h.

Trimmable::CanTrim Region::can_trim ( ) const

virtual

Reimplemented from ARDOUR::Trimmable.

Definition at line 1655 of file region.cc.

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

inlineprotectedvirtual

Reimplemented in ARDOUR::MidiRegion.

Definition at line 345 of file region.h.

bool ARDOUR::Region::captured ( ) const

inline

Definition at line 170 of file region.h.

void Region::clear_sync_position

(

)

Definition at line 1027 of file region.cc.

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

pure virtual

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

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

pure virtual

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

Evoral::OverlapType ARDOUR::Region::coverage ( framepos_t  start, framepos_t  end  ) 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 195 of file region.h.

bool ARDOUR::Region::covers ( framepos_t  frame ) const

inline

Definition at line 185 of file region.h.

void Region::cut_end

(

framepos_t

new_position

)

Definition at line 758 of file region.cc.

void Region::cut_front

(

framepos_t

new_position

)

Definition at line 752 of file region.cc.

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

inline

Definition at line 102 of file region.h.

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

inlinevirtual

Definition at line 287 of file region.h.

void Region::drop_sources

(

)

Definition at line 1617 of file region.cc.

framepos_t Region::earliest_possible_position

(

)

const

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

Definition at line 1714 of file region.cc.

bool Region::equivalent

(

boost::shared_ptr< const Region >

other

)

const

Definition at line 1341 of file region.cc.

bool ARDOUR::Region::external ( ) const

inline

Definition at line 173 of file region.h.

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

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 227 of file region.h.

void Region::first_edit ( )

private

Definition at line 480 of file region.cc.

framepos_t ARDOUR::Region::first_frame ( ) const

inline

Definition at line 141 of file region.h.

boost::shared_ptr< Region > Region::get_parent ( ) const

virtual

Definition at line 1584 of file region.cc.

XMLNode & Region::get_state ( void  )

virtual

Implements PBD::Stateful.

Definition at line 1228 of file region.cc.

virtual int ARDOUR::Region::get_transients ( AnalysisFeatureList &  , bool  force_new = false  )

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 307 of file region.h.

bool ARDOUR::Region::hidden ( ) const

inline

Definition at line 161 of file region.h.

bool ARDOUR::Region::import ( ) const

inline

Definition at line 174 of file region.h.

void Region::invalidate_transients

(

)

Definition at line 1608 of file region.cc.

bool Region::is_compound

(

)

const

Definition at line 1694 of file region.cc.

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

inlinevirtual

Definition at line 286 of file region.h.

framepos_t ARDOUR::Region::last_frame ( ) const

inline

Definition at line 142 of file region.h.

framecnt_t ARDOUR::Region::last_length ( ) const

inline

Definition at line 123 of file region.h.

framepos_t ARDOUR::Region::last_position ( ) const

inline

Definition at line 122 of file region.h.

Evoral::Range<framepos_t> ARDOUR::Region::last_range ( ) const

inline

Definition at line 153 of file region.h.

framecnt_t Region::latest_possible_frame

(

)

const

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

Definition at line 1724 of file region.cc.

layer_t ARDOUR::Region::layer ( ) const

inline

Definition at line 115 of file region.h.

uint64_t ARDOUR::Region::layering_index ( ) const

inline

Definition at line 283 of file region.h.

framecnt_t ARDOUR::Region::length ( ) const

inline

Definition at line 114 of file region.h.

bool ARDOUR::Region::locked ( ) const

inline

Definition at line 164 of file region.h.

void Region::lower

(

)

Definition at line 1102 of file region.cc.

void Region::lower_to_bottom

(

)

Definition at line 1121 of file region.cc.

void Region::make_property_quarks ( )

static

Definition at line 80 of file region.cc.

vector< string > Region::master_source_names

(

)

Definition at line 1380 of file region.cc.

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

inline

Definition at line 262 of file region.h.

uint32_t Region::max_source_level

(

)

const

Definition at line 1682 of file region.cc.

void Region::maybe_uncopy ( )

private

Definition at line 474 of file region.cc.

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

Definition at line 1300 of file region.cc.

void Region::modify_end ( framepos_t  new_position, bool  reset_fade  )

private

Definition at line 814 of file region.cc.

void Region::modify_front ( framepos_t  new_position, bool  reset_fade  )

private

Definition at line 764 of file region.cc.

void Region::move_start

(

frameoffset_t

distance

)

Definition at line 701 of file region.cc.

void Region::move_to_natural_position

(

)

Definition at line 516 of file region.cc.

bool ARDOUR::Region::muted ( ) const

inline

Definition at line 162 of file region.h.

uint32_t ARDOUR::Region::n_channels ( ) const

inlinevirtual

Implements ARDOUR::Readable.

Definition at line 259 of file region.h.

void Region::nudge_position

(

frameoffset_t

n

)

Definition at line 634 of file region.cc.

bool ARDOUR::Region::opaque ( ) const

inline

Definition at line 163 of file region.h.

bool Region::overlap_equivalent

(

boost::shared_ptr< const Region >

other

)

const

Definition at line 1335 of file region.cc.

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

inline

Definition at line 251 of file region.h.

framepos_t ARDOUR::Region::position ( ) const

inline

How the region parameters play together:

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

Definition at line 112 of file region.h.

PositionLockStyle ARDOUR::Region::position_lock_style ( ) const

inline

Definition at line 178 of file region.h.

bool ARDOUR::Region::position_locked ( ) const

inline

Definition at line 165 of file region.h.

void Region::post_set ( const PBD::PropertyChange &  pc )

protectedvirtual

Reimplemented from PBD::Stateful.

Definition at line 1700 of file region.cc.

void Region::raise

(

)

Definition at line 1093 of file region.cc.

void Region::raise_to_top

(

)

Definition at line 1112 of file region.cc.

Evoral::Range<framepos_t> ARDOUR::Region::range ( ) const

inline

Definition at line 157 of file region.h.

virtual void ARDOUR::Region::recompute_at_end ( )

privatepure virtual

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

virtual void ARDOUR::Region::recompute_at_start ( )

privatepure virtual

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

void Region::recompute_position_from_lock_style

(

)

Definition at line 626 of file region.cc.

bool Region::region_list_equivalent

(

boost::shared_ptr< const Region >

other

)

const

Definition at line 1356 of file region.cc.

void Region::register_properties ( )

private

Definition at line 135 of file region.cc.

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

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 298 of file region.h.

void Region::send_change ( const PBD::PropertyChange &  what_changed )

protectedvirtual

Reimplemented from PBD::Stateful.

Definition at line 1311 of file region.cc.

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

inlinevirtual

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

Definition at line 318 of file region.h.

void Region::set_ancestral_data	(	framepos_t	start,
		framecnt_t	length,
		float	stretch,
		float	shift
	)

Definition at line 666 of file region.cc.

void Region::set_automatic

(

bool

yn

)

Definition at line 955 of file region.cc.

void Region::set_hidden

(

bool

yn

)

Definition at line 939 of file region.cc.

void Region::set_layer

(

layer_t

l

)

Definition at line 1130 of file region.cc.

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

inline

Definition at line 284 of file region.h.

void Region::set_length

(

framecnt_t

len

)

Definition at line 430 of file region.cc.

void Region::set_length_internal ( framecnt_t  len )

protectedvirtual

Reimplemented in ARDOUR::MidiRegion.

Definition at line 468 of file region.cc.

void Region::set_locked

(

bool

yn

)

Definition at line 980 of file region.cc.

void Region::set_master_sources

(

const SourceList &

srcs

)

Definition at line 1393 of file region.cc.

void Region::set_muted

(

bool

yn

)

Definition at line 962 of file region.cc.

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

virtual

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

Reimplemented from ARDOUR::SessionObject.

Definition at line 417 of file region.cc.

void Region::set_opaque

(

bool

yn

)

Definition at line 971 of file region.cc.

void Region::set_playlist ( boost::weak_ptr< ARDOUR::Playlist >  wpl )

virtual

Definition at line 411 of file region.cc.

void Region::set_position

(

framepos_t

pos

)

Definition at line 579 of file region.cc.

void Region::set_position_internal ( framepos_t  pos, bool  allow_bbt_recompute  )

protectedvirtual

Reimplemented in ARDOUR::MidiRegion.

Definition at line 595 of file region.cc.

void Region::set_position_lock_style

(

PositionLockStyle

ps

)

Definition at line 543 of file region.cc.

void Region::set_position_locked

(

bool

yn

)

Definition at line 998 of file region.cc.

void Region::set_start

(

framepos_t

pos

)

Definition at line 675 of file region.cc.

void Region::set_start_internal ( framecnt_t  s )

protectedvirtual

Reimplemented in ARDOUR::MidiRegion.

Definition at line 1708 of file region.cc.

int Region::set_state ( const XMLNode &  node, int  version  )

virtual

Implements PBD::Stateful.

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

Definition at line 1234 of file region.cc.

void Region::set_sync_position

(

framepos_t

absolute_pos

)

Set the region's sync point.

Parameters

absolute_pos

Session time.

Definition at line 1010 of file region.cc.

virtual int ARDOUR::Region::set_transients ( AnalysisFeatureList &  )

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 302 of file region.h.

void Region::set_video_locked

(

bool

yn

)

Definition at line 989 of file region.cc.

void Region::set_whole_file

(

bool

yn

)

Definition at line 948 of file region.cc.

float ARDOUR::Region::shift ( ) const

inline

Definition at line 129 of file region.h.

bool Region::size_equivalent

(

boost::shared_ptr< const Region >

other

)

const

Definition at line 1349 of file region.cc.

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

inline

Definition at line 258 of file region.h.

void Region::source_deleted

(

boost::weak_ptr< Source >

)

Definition at line 1362 of file region.cc.

bool Region::source_equivalent

(

boost::shared_ptr< const Region >

other

)

const

Definition at line 1408 of file region.cc.

framecnt_t Region::source_length

(

uint32_t

n

)

const

Definition at line 1511 of file region.cc.

std::string Region::source_string

(

)

const

Definition at line 1456 of file region.cc.

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

inline

Definition at line 261 of file region.h.

void Region::special_set_position

(

framepos_t

pos

)

Definition at line 532 of file region.cc.

framepos_t ARDOUR::Region::start ( ) const

inline

Definition at line 113 of file region.h.

XMLNode & Region::state ( )

virtual

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

Definition at line 1136 of file region.cc.

float ARDOUR::Region::stretch ( ) const

inline

Definition at line 128 of file region.h.

void Region::suspend_property_changes ( )

virtual

Reimplemented from PBD::Stateful.

Definition at line 1292 of file region.cc.

bool ARDOUR::Region::sync_marked ( ) const

inline

Definition at line 172 of file region.h.

frameoffset_t Region::sync_offset

(

int &

dir

)

const

Definition at line 1041 of file region.cc.

framepos_t ARDOUR::Region::sync_point

(

)

const

framepos_t Region::sync_position

(

)

const

Returns

Sync position in session time

Definition at line 1082 of file region.cc.

AnalysisFeatureList ARDOUR::Region::transients ( )

inline

Definition at line 104 of file region.h.

void Region::trim_end

(

framepos_t

new_endpoint

)

Parameters

new_endpoint

New region end point, such that, for example, a region at 0 of length 10 has an endpoint of 9.

Definition at line 836 of file region.cc.

void Region::trim_front

(

framepos_t

new_position

)

Definition at line 746 of file region.cc.

void Region::trim_to	(	framepos_t	position,
		framecnt_t	length
	)

Definition at line 842 of file region.cc.

void Region::trim_to_internal ( framepos_t  position, framecnt_t  length  )

private

Definition at line 857 of file region.cc.

void Region::update_after_tempo_map_change ( )

virtual

Reimplemented in ARDOUR::MidiRegion.

Definition at line 560 of file region.cc.

virtual int ARDOUR::Region::update_transient ( framepos_t  , framepos_t    )

inlinevirtual

Reimplemented in ARDOUR::AudioRegion.

Definition at line 293 of file region.h.

void Region::use_sources ( SourceList const &  s )

private

Definition at line 1633 of file region.cc.

bool Region::uses_source

(

boost::shared_ptr< const Source >

source

)

const

Definition at line 1477 of file region.cc.

bool ARDOUR::Region::valid_transients ( ) const

inline

Definition at line 167 of file region.h.

bool Region::verify_length ( framecnt_t &  len )

private

Definition at line 1518 of file region.cc.

bool Region::verify_start ( framepos_t  pos )

private

Definition at line 1554 of file region.cc.

bool Region::verify_start_and_length ( framepos_t  new_start, framecnt_t &  new_length  )

private

Definition at line 1536 of file region.cc.

bool Region::verify_start_mutable ( framepos_t &  _start )

private

Definition at line 1569 of file region.cc.

bool ARDOUR::Region::video_locked ( ) const

inline

Definition at line 166 of file region.h.

bool ARDOUR::Region::whole_file ( ) const

inline

Definition at line 169 of file region.h.

Friends And Related Function Documentation

friend class RegionFactory

friend

Definition at line 328 of file region.h.

Member Data Documentation

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

private

Definition at line 407 of file region.h.

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

private

Definition at line 406 of file region.h.

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

private

Definition at line 400 of file region.h.

Timecode::BBT_Time ARDOUR::Region::_bbt_time

private

Definition at line 416 of file region.h.

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

private

Definition at line 403 of file region.h.

RegionEditState ARDOUR::Region::_first_edit

mutableprivate

Definition at line 415 of file region.h.

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

private

Definition at line 404 of file region.h.

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

private

Definition at line 402 of file region.h.

framecnt_t ARDOUR::Region::_last_length

private

Definition at line 413 of file region.h.

framepos_t ARDOUR::Region::_last_position

private

Definition at line 414 of file region.h.

layer_t ARDOUR::Region::_layer

private

Definition at line 417 of file region.h.

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

private

Definition at line 411 of file region.h.

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

protected

Definition at line 361 of file region.h.

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

protected

Definition at line 365 of file region.h.

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

private

Definition at line 398 of file region.h.

SourceList ARDOUR::Region::_master_sources

protected

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

Definition at line 372 of file region.h.

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

private

Definition at line 396 of file region.h.

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

private

Definition at line 397 of file region.h.

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

protected

Definition at line 376 of file region.h.

PBD::Property<framepos_t> ARDOUR::Region::_position

protected

Definition at line 366 of file region.h.

PBD::EnumProperty<PositionLockStyle> ARDOUR::Region::_position_lock_style

private

Definition at line 410 of file region.h.

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

private

Definition at line 405 of file region.h.

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

protected

Definition at line 362 of file region.h.

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

private

Definition at line 409 of file region.h.

SourceList ARDOUR::Region::_sources

protected

Definition at line 370 of file region.h.

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

protected

Definition at line 364 of file region.h.

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

private

Definition at line 408 of file region.h.

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

protected

Definition at line 360 of file region.h.

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

protected

Sync position relative to the start of our file

Definition at line 368 of file region.h.

AnalysisFeatureList ARDOUR::Region::_transients

protected

Definition at line 374 of file region.h.

DataType ARDOUR::Region::_type

protected

Definition at line 358 of file region.h.

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

protected

Definition at line 363 of file region.h.

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

private

Definition at line 399 of file region.h.

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

private

Definition at line 401 of file region.h.

PBD::Signal2< void, boost::shared_ptr< ARDOUR::Region >, const PropertyChange & > Region::RegionPropertyChanged

static

Definition at line 95 of file region.h.

---

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

• /usr/local/music/src/ardour/4.0/libs/ardour/ardour/region.h
• /usr/local/music/src/ardour/4.0/libs/ardour/region.cc