/*
- Copyright (C) 2000-2001 Paul Davis
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-*/
+ * Copyright (C) 2000-2017 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2006-2014 David Robillard <d@drobilla.net>
+ * Copyright (C) 2007-2012 Carl Hetherington <carl@carlh.net>
+ * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
+ * Copyright (C) 2015-2017 Nick Mainsbridge <mainsbridge@gmail.com>
+ * Copyright (C) 2018 Ben Loftis <ben@harrisonconsoles.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
#ifndef __ardour_region_h__
#define __ardour_region_h__
#include "pbd/undo.h"
#include "pbd/signals.h"
-
#include "ardour/ardour.h"
#include "ardour/data_type.h"
#include "ardour/automatable.h"
#include "ardour/readable.h"
#include "ardour/session_object.h"
#include "ardour/trimmable.h"
+#include "ardour/types_convert.h"
class XMLNode;
LIBARDOUR_API extern PBD::PropertyDescriptor<bool> hidden;
LIBARDOUR_API extern PBD::PropertyDescriptor<bool> position_locked;
LIBARDOUR_API extern PBD::PropertyDescriptor<bool> valid_transients;
- LIBARDOUR_API extern PBD::PropertyDescriptor<framepos_t> start;
- LIBARDOUR_API extern PBD::PropertyDescriptor<framecnt_t> length;
- LIBARDOUR_API extern PBD::PropertyDescriptor<framepos_t> position;
- LIBARDOUR_API extern PBD::PropertyDescriptor<framecnt_t> sync_position;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<samplepos_t> start;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<samplecnt_t> length;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<samplepos_t> position;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<double> beat;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<samplecnt_t> sync_position;
LIBARDOUR_API extern PBD::PropertyDescriptor<layer_t> layer;
- LIBARDOUR_API extern PBD::PropertyDescriptor<framepos_t> ancestral_start;
- LIBARDOUR_API extern PBD::PropertyDescriptor<framecnt_t> ancestral_length;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<samplepos_t> ancestral_start;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<samplecnt_t> ancestral_length;
LIBARDOUR_API extern PBD::PropertyDescriptor<float> stretch;
LIBARDOUR_API extern PBD::PropertyDescriptor<float> shift;
LIBARDOUR_API extern PBD::PropertyDescriptor<PositionLockStyle> position_lock_style;
LIBARDOUR_API extern PBD::PropertyDescriptor<uint64_t> layering_index;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<std::string> tags;
+ LIBARDOUR_API extern PBD::PropertyDescriptor<bool> contents; // type doesn't matter here
};
class Playlist;
, public Trimmable
, public Movable
{
- public:
+public:
typedef std::vector<boost::shared_ptr<Source> > SourceList;
static void make_property_quarks ();
const DataType& data_type () const { return _type; }
- AnalysisFeatureList transients () { return _transients; };
-
/** 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
+ * 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
*/
- framepos_t position () const { return _position; }
- framepos_t start () const { return _start; }
- framecnt_t length () const { return _length; }
+ samplepos_t position () const { return _position; }
+ samplepos_t start () const { return _start; }
+ samplecnt_t length () const { return _length; }
layer_t layer () const { return _layer; }
- framecnt_t source_length(uint32_t n) const;
+ void set_selected_for_solo(bool yn);
+
+ samplecnt_t source_length (uint32_t n) const;
uint32_t max_source_level () const;
/* these two are valid ONLY during a StateChanged signal handler */
- framepos_t last_position () const { return _last_position; }
- framecnt_t last_length () const { return _last_length; }
+ samplepos_t last_position () const { return _last_position; }
+ samplecnt_t last_length () const { return _last_length; }
- framepos_t ancestral_start () const { return _ancestral_start; }
- framecnt_t ancestral_length () const { return _ancestral_length; }
+ samplepos_t ancestral_start () const { return _ancestral_start; }
+ samplecnt_t ancestral_length () const { return _ancestral_length; }
float stretch () const { return _stretch; }
float shift () const { return _shift; }
- void set_ancestral_data (framepos_t start, framecnt_t length, float stretch, float shift);
+ void set_ancestral_data (samplepos_t start, samplecnt_t length, float stretch, float shift);
- frameoffset_t sync_offset (int& dir) const;
- framepos_t sync_position () const;
- framepos_t sync_point () const;
+ sampleoffset_t sync_offset (int& dir) const;
+ samplepos_t sync_position () const;
- framepos_t adjust_to_sync (framepos_t) const;
+ samplepos_t adjust_to_sync (samplepos_t) const;
- /* first_frame() is an alias; last_frame() just hides some math */
+ /* first_sample() is an alias; last_sample() just hides some math */
- framepos_t first_frame () const { return _position; }
- framepos_t last_frame () const { return _position + _length - 1; }
+ samplepos_t first_sample () const { return _position; }
+ samplepos_t last_sample () const { return _position + _length - 1; }
/** Return the earliest possible value of _position given the
* value of _start within the region's sources
*/
- framepos_t earliest_possible_position () const;
- /** Return the last possible value of _last_frame given the
+ samplepos_t earliest_possible_position () const;
+ /** Return the last possible value of _last_sample given the
* value of _startin the regions's sources
*/
- framepos_t latest_possible_frame () const;
+ samplepos_t latest_possible_sample () const;
- Evoral::Range<framepos_t> last_range () const {
- return Evoral::Range<framepos_t> (_last_position, _last_position + _last_length - 1);
+ Evoral::Range<samplepos_t> last_range () const {
+ return Evoral::Range<samplepos_t> (_last_position, _last_position + _last_length - 1);
}
-
- Evoral::Range<framepos_t> range () const {
- return Evoral::Range<framepos_t> (first_frame(), last_frame());
+
+ Evoral::Range<samplepos_t> range () const {
+ return Evoral::Range<samplepos_t> (first_sample(), last_sample());
}
bool hidden () const { return _hidden; }
bool locked () const { return _locked; }
bool position_locked () const { return _position_locked; }
bool video_locked () const { return _video_locked; }
- bool valid_transients () const { return _valid_transients; }
bool automatic () const { return _automatic; }
bool whole_file () const { return _whole_file; }
bool captured () const { return !(_import || _external); }
Trimmable::CanTrim can_trim () const;
PositionLockStyle position_lock_style () const { return _position_lock_style; }
-
void set_position_lock_style (PositionLockStyle ps);
- void recompute_position_from_lock_style ();
+ void recompute_position_from_lock_style (const int32_t sub_num);
+
+ /* meter-based beat at the region position */
+ double beat () const { return _beat; }
+ void set_beat (double beat) { _beat = beat; }
+ /* quarter-note at the region position */
+ double quarter_note () const { return _quarter_note; }
+ void set_quarter_note (double qn) { _quarter_note = qn; }
void suspend_property_changes ();
- bool covers (framepos_t frame) const {
- return first_frame() <= frame && frame <= last_frame();
+ bool covers (samplepos_t sample) const {
+ return first_sample() <= sample && sample <= last_sample();
}
/** @return coverage of this region with the given range;
* OverlapEnd: the range overlaps the end of this region.
* OverlapExternal: the range overlaps all of this region.
*/
- Evoral::OverlapType coverage (framepos_t start, framepos_t end) const {
- return Evoral::coverage (first_frame(), last_frame(), start, end);
+ Evoral::OverlapType coverage (samplepos_t start, samplepos_t end) const {
+ return Evoral::coverage (first_sample(), last_sample(), start, end);
}
- bool equivalent (boost::shared_ptr<const Region>) const;
+ bool exact_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 enclosed_equivalent (boost::shared_ptr<const Region>) const;
+ bool layer_and_time_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;
+ bool uses_source (boost::shared_ptr<const Source>, bool shallow = false) const;
+ void deep_sources (std::set<boost::shared_ptr<Source> >&) const;
std::string source_string () const;
/* EDITING OPERATIONS */
- 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);
+ void set_length (samplecnt_t, const int32_t sub_num);
+ void set_start (samplepos_t);
+ void set_position (samplepos_t, int32_t sub_num = 0);
+ void set_position_music (double qn);
+ void set_initial_position (samplepos_t);
+ void special_set_position (samplepos_t);
+ virtual void update_after_tempo_map_change (bool send_change = true);
+ void nudge_position (sampleoffset_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);
+ void move_start (sampleoffset_t distance, const int32_t sub_num = 0);
+ void trim_front (samplepos_t new_position, const int32_t sub_num = 0);
+ void trim_end (samplepos_t new_position, const int32_t sub_num = 0);
+ void trim_to (samplepos_t position, samplecnt_t length, const int32_t sub_num = 0);
+
+ virtual void fade_range (samplepos_t, samplepos_t) {}
- void cut_front (framepos_t new_position);
- void cut_end (framepos_t new_position);
+ void cut_front (samplepos_t new_position, const int32_t sub_num = 0);
+ void cut_end (samplepos_t new_position, const int32_t sub_num = 0);
void set_layer (layer_t l); /* ONLY Playlist can call this */
void raise ();
void raise_to_top ();
void lower_to_bottom ();
- void set_sync_position (framepos_t n);
+ void set_sync_position (samplepos_t n);
void clear_sync_position ();
void set_hidden (bool yn);
void set_muted (bool yn);
virtual boost::shared_ptr<const Evoral::Control>
control (const Evoral::Parameter& id) const = 0;
+ /* tags */
+
+ std::string tags() const { return _tags; }
+ virtual bool set_tags (const std::string& str) {
+ if (_tags != str) {
+ _tags = str;
+ PropertyChanged (PBD::PropertyChange (Properties::tags));
+ }
+ return true;
+ }
+
/* serialization */
XMLNode& get_state ();
- virtual XMLNode& state ();
virtual int set_state (const XMLNode&, int version);
virtual boost::shared_ptr<Region> get_parent() const;
virtual bool is_dependent() const { return false; }
virtual bool depends_on (boost::shared_ptr<Region> /*other*/) const { return false; }
- virtual void add_transient (framepos_t) {
+ virtual void add_transient (samplepos_t) {
// no transients, but its OK
}
- virtual int update_transient (framepos_t /* old_position */, framepos_t /* new_position */) {
+ virtual void clear_transients () {
// no transients, but its OK
- return 0;
}
- virtual void remove_transient (framepos_t /* where */) {
+ virtual void update_transient (samplepos_t /* old_position */, samplepos_t /* new_position */) {
// no transients, but its OK
}
- virtual int set_transients (AnalysisFeatureList&) {
+ virtual void remove_transient (samplepos_t /* where */) {
// no transients, but its OK
- return 0;
}
- virtual int get_transients (AnalysisFeatureList&, bool force_new = false) {
- (void) force_new;
+ virtual void set_onsets (AnalysisFeatureList&) {
// no transients, but its OK
- return 0;
}
- virtual int adjust_transients (frameoffset_t /*delta*/) {
+ /** merges _onsets and _user_transients into given list
+ * and removed exact duplicates.
+ */
+ void transients (AnalysisFeatureList&);
+
+ /** 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 ()
+ */
+ virtual void get_transients (AnalysisFeatureList&) {
// no transients, but its OK
- return 0;
}
- virtual int separate_by_channel (ARDOUR::Session&,
- std::vector< boost::shared_ptr<Region> >&) const {
- return 0;
+ /* wrapper to the above for easy access throug Lua */
+ AnalysisFeatureList transients () {
+ AnalysisFeatureList rv;
+ get_transients (rv);
+ return rv;
}
- void invalidate_transients ();
+ bool has_transients () const;
+
+ virtual int separate_by_channel (std::vector< boost::shared_ptr<Region> >&) const {
+ return -1;
+ }
+
+ void maybe_invalidate_transients ();
void drop_sources ();
- protected:
+protected:
+ virtual XMLNode& state ();
+
friend class RegionFactory;
/** Construct a region from multiple sources*/
Region (boost::shared_ptr<const Region>);
/** Construct a region from another region, at an offset within that region */
- Region (boost::shared_ptr<const Region>, frameoffset_t start_offset);
+ Region (boost::shared_ptr<const Region>, ARDOUR::MusicSample start_offset);
/** Construct a region as a copy of another region, but with different sources */
Region (boost::shared_ptr<const Region>, const SourceList&);
/** Constructor for derived types only */
- Region (Session& s, framepos_t start, framecnt_t length, const std::string& name, DataType);
+ Region (Session& s, samplepos_t start, samplecnt_t length, const std::string& name, DataType);
virtual bool can_trim_start_before_source_start () const {
return false;
}
- protected:
+protected:
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);
-
+ virtual void set_position_internal (samplepos_t pos, bool allow_bbt_recompute, const int32_t sub_num);
+ virtual void set_position_music_internal (double qn);
+ virtual void set_length_internal (samplecnt_t, const int32_t sub_num);
+ virtual void set_start_internal (samplecnt_t, const int32_t sub_num = 0);
+ bool verify_start_and_length (samplepos_t, samplecnt_t&);
+ void first_edit ();
+
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<samplepos_t> _start;
+ PBD::Property<samplecnt_t> _length;
+ PBD::Property<samplepos_t> _position;
+ PBD::Property<double> _beat;
/** Sync position relative to the start of our file */
- PBD::Property<framepos_t> _sync_position;
-
+ PBD::Property<samplepos_t> _sync_position;
+
+ double _quarter_note;
+
SourceList _sources;
/** Used when timefx are applied, so we can always use the original source */
SourceList _master_sources;
- AnalysisFeatureList _transients;
-
boost::weak_ptr<ARDOUR::Playlist> _playlist;
-
- private:
+
+ void merge_features (AnalysisFeatureList&, const AnalysisFeatureList&, const sampleoffset_t) const;
+
+ AnalysisFeatureList _onsets; // used by the Ferret (Aubio OnsetDetector)
+
+ // _transient_user_start is covered by _valid_transients
+ AnalysisFeatureList _user_transients; // user added
+ samplepos_t _transient_user_start; // region's _start relative to user_transients
+
+ // these are used by Playlist::find_next_transient() in absence of onsets
+ AnalysisFeatureList _transients; // Source Analysis (QM Transient), user read-only
+ samplepos_t _transient_analysis_start;
+ samplepos_t _transient_analysis_end;
+
+ bool _soloSelected;
+
+private:
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);
+ virtual void trim_to_internal (samplepos_t position, samplecnt_t length, const int32_t sub_num);
+ void modify_front (samplepos_t new_position, bool reset_fade, const int32_t sub_num);
+ void modify_end (samplepos_t new_position, bool reset_fade, const int32_t sub_num);
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);
+ bool verify_start (samplepos_t);
+ bool verify_start_mutable (samplepos_t&_start);
+ bool verify_length (samplecnt_t&);
virtual void recompute_at_start () = 0;
virtual void recompute_at_end () = 0;
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<samplepos_t> _ancestral_start;
+ PBD::Property<samplecnt_t> _ancestral_length;
PBD::Property<float> _stretch;
PBD::Property<float> _shift;
PBD::EnumProperty<PositionLockStyle> _position_lock_style;
PBD::Property<uint64_t> _layering_index;
+ PBD::Property<std::string> _tags;
+ PBD::Property<bool> _contents; // type is irrelevant
- framecnt_t _last_length;
- framepos_t _last_position;
+ samplecnt_t _last_length;
+ samplepos_t _last_position;
mutable RegionEditState _first_edit;
- Timecode::BBT_Time _bbt_time;
layer_t _layer;
void register_properties ();
projects / ardour.git / blobdiff