libs/ardour/ardour/region.h

   1 /*
   2     Copyright (C) 2000-2001 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_region_h__
  21 #define __ardour_region_h__
  22
  23 #include <vector>
  24 #include <boost/shared_ptr.hpp>
  25 #include <boost/enable_shared_from_this.hpp>
  26 #include <boost/utility.hpp>
  27
  28 #include "pbd/undo.h"
  29 #include "pbd/signals.h"
  30
  31 #include "ardour/ardour.h"
  32 #include "ardour/data_type.h"
  33 #include "ardour/automatable.h"
  34 #include "ardour/movable.h"
  35 #include "ardour/readable.h"
  36 #include "ardour/session_object.h"
  37 #include "ardour/trimmable.h"
  38
  39 class XMLNode;
  40
  41
  42 namespace ARDOUR {
  43
  44 namespace Properties {
  45         extern PBD::PropertyDescriptor<bool>              muted;
  46         extern PBD::PropertyDescriptor<bool>              opaque;
  47         extern PBD::PropertyDescriptor<bool>              locked;
  48         extern PBD::PropertyDescriptor<bool>              automatic;
  49         extern PBD::PropertyDescriptor<bool>              whole_file;
  50         extern PBD::PropertyDescriptor<bool>              import;
  51         extern PBD::PropertyDescriptor<bool>              external;
  52         extern PBD::PropertyDescriptor<bool>              sync_marked;
  53         extern PBD::PropertyDescriptor<bool>              left_of_split;
  54         extern PBD::PropertyDescriptor<bool>              right_of_split;
  55         extern PBD::PropertyDescriptor<bool>              hidden;
  56         extern PBD::PropertyDescriptor<bool>              position_locked;
  57         extern PBD::PropertyDescriptor<bool>              valid_transients;
  58         extern PBD::PropertyDescriptor<framepos_t>        start;
  59         extern PBD::PropertyDescriptor<framecnt_t>        length;
  60         extern PBD::PropertyDescriptor<framepos_t>        position;
  61         extern PBD::PropertyDescriptor<framecnt_t>        sync_position;
  62         extern PBD::PropertyDescriptor<layer_t>           layer;
  63         extern PBD::PropertyDescriptor<framepos_t>        ancestral_start;
  64         extern PBD::PropertyDescriptor<framecnt_t>        ancestral_length;
  65         extern PBD::PropertyDescriptor<float>             stretch;
  66         extern PBD::PropertyDescriptor<float>             shift;
  67         extern PBD::PropertyDescriptor<PositionLockStyle> position_lock_style;
  68 };
  69
  70 class Playlist;
  71 class Filter;
  72 class ExportSpecification;
  73 class Progress;
  74
  75 enum RegionEditState {
  76         EditChangesNothing = 0,
  77         EditChangesName    = 1,
  78         EditChangesID      = 2
  79 };
  80
  81
  82 class Region
  83         : public SessionObject
  84         , public boost::enable_shared_from_this<Region>
  85         , public Readable
  86         , public Trimmable
  87         , public Movable
  88 {
  89   public:
  90         typedef std::vector<boost::shared_ptr<Source> > SourceList;
  91
  92         static void make_property_quarks ();
  93
  94         static PBD::Signal2<void,boost::shared_ptr<ARDOUR::Region>, const PBD::PropertyChange&> RegionPropertyChanged;
  95
  96         virtual ~Region();
  97
  98         /** Note: changing the name of a Region does not constitute an edit */
  99         bool set_name (const std::string& str);
 100
 101         const DataType& data_type () const { return _type; }
 102
 103         AnalysisFeatureList transients () { return _transients; };
 104
 105         /** How the region parameters play together:
 106          *
 107          * POSITION: first frame of the region along the timeline
 108          * START:    first frame of the region within its source(s)
 109          * LENGTH:   number of frames the region represents
 110          */
 111         framepos_t position ()  const { return _position; }
 112         framepos_t start ()     const { return _start; }
 113         framecnt_t length ()    const { return _length; }
 114         layer_t    layer ()     const { return _layer; }
 115
 116         framecnt_t source_length(uint32_t n) const;
 117         uint32_t   max_source_level () const;
 118
 119         /* these two are valid ONLY during a StateChanged signal handler */
 120
 121         framepos_t last_position () const { return _last_position; }
 122         framecnt_t last_length ()   const { return _last_length; }
 123
 124         framepos_t ancestral_start ()  const { return _ancestral_start; }
 125         framecnt_t ancestral_length () const { return _ancestral_length; }
 126
 127         float stretch () const { return _stretch; }
 128         float shift ()   const { return _shift; }
 129
 130         void set_ancestral_data (framepos_t start, framepos_t length, float stretch, float shift);
 131
 132         frameoffset_t sync_offset (int& dir) const;
 133         framepos_t sync_position () const;
 134         framepos_t sync_point () const;
 135
 136         framepos_t adjust_to_sync (framepos_t) const;
 137
 138         /* first_frame() is an alias; last_frame() just hides some math */
 139
 140         framepos_t first_frame () const { return _position; }
 141         framepos_t last_frame ()  const { return _position + _length - 1; }
 142
 143         bool hidden ()           const { return _hidden; }
 144         bool muted ()            const { return _muted; }
 145         bool opaque ()           const { return _opaque; }
 146         bool locked ()           const { return _locked; }
 147         bool position_locked ()  const { return _position_locked; }
 148         bool valid_transients () const { return _valid_transients; }
 149         bool automatic ()        const { return _automatic; }
 150         bool whole_file ()       const { return _whole_file; }
 151         bool captured ()         const { return !(_import || _external); }
 152         bool can_move ()         const { return !_position_locked; }
 153         bool sync_marked ()      const { return _sync_marked; }
 154         bool external ()         const { return _external; }
 155         bool import ()           const { return _import; }
 156
 157         Trimmable::CanTrim can_trim () const;
 158
 159         PositionLockStyle position_lock_style () const { return _position_lock_style; }
 160
 161         void set_position_lock_style (PositionLockStyle ps);
 162         void recompute_position_from_lock_style ();
 163
 164         void suspend_property_changes ();
 165
 166         bool covers (framepos_t frame) const {
 167                 return first_frame() <= frame && frame <= last_frame();
 168         }
 169
 170         OverlapType coverage (framepos_t start, framepos_t end) const {
 171                 return ARDOUR::coverage (first_frame(), last_frame(), start, end);
 172         }
 173
 174         bool equivalent (boost::shared_ptr<const Region>) const;
 175         bool size_equivalent (boost::shared_ptr<const Region>) const;
 176         bool overlap_equivalent (boost::shared_ptr<const Region>) const;
 177         bool region_list_equivalent (boost::shared_ptr<const Region>) const;
 178         bool source_equivalent (boost::shared_ptr<const Region>) const;
 179         bool uses_source (boost::shared_ptr<const Source>) const;
 180         bool uses_source_path (const std::string&) const;
 181
 182         std::string source_string () const;
 183
 184
 185         /* EDITING OPERATIONS */
 186
 187         void set_length (framecnt_t);
 188         void set_start (framepos_t);
 189         void set_position (framepos_t);
 190         void set_position_on_top (framepos_t);
 191         void special_set_position (framepos_t);
 192         void update_position_after_tempo_map_change ();
 193         void nudge_position (frameoffset_t);
 194
 195         bool at_natural_position () const;
 196         void move_to_natural_position ();
 197
 198         void trim_start (framepos_t new_position);
 199         void trim_front (framepos_t new_position);
 200         void trim_end (framepos_t new_position);
 201         void trim_to (framepos_t position, framecnt_t length);
 202
 203         void cut_front (framepos_t new_position);
 204         void cut_end (framepos_t new_position);
 205
 206         void set_layer (layer_t l); /* ONLY Playlist can call this */
 207         void raise ();
 208         void lower ();
 209         void raise_to_top ();
 210         void lower_to_bottom ();
 211
 212         void set_sync_position (framepos_t n);
 213         void clear_sync_position ();
 214         void set_hidden (bool yn);
 215         void set_muted (bool yn);
 216         void set_whole_file (bool yn);
 217         void set_automatic (bool yn);
 218         void set_opaque (bool yn);
 219         void set_locked (bool yn);
 220         void set_position_locked (bool yn);
 221
 222         int apply (Filter &, Progress* progress = 0);
 223
 224         virtual uint64_t read_data_count () const { return _read_data_count; }
 225
 226         boost::shared_ptr<ARDOUR::Playlist> playlist () const { return _playlist.lock(); }
 227         virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
 228
 229         void source_deleted (boost::weak_ptr<Source>);
 230
 231         bool is_compound () const;
 232
 233         boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
 234         uint32_t n_channels() const { return _sources.size(); }
 235
 236         const SourceList& sources ()        const { return _sources; }
 237         const SourceList& master_sources () const { return _master_sources; }
 238
 239         std::vector<std::string> master_source_names();
 240         void set_master_sources (const SourceList&);
 241
 242         /* automation */
 243
 244         virtual boost::shared_ptr<Evoral::Control>
 245         control (const Evoral::Parameter& id, bool create=false) = 0;
 246
 247         virtual boost::shared_ptr<const Evoral::Control>
 248         control (const Evoral::Parameter& id) const = 0;
 249
 250         /* serialization */
 251
 252         XMLNode&         get_state ();
 253         virtual XMLNode& state ();
 254         virtual int      set_state (const XMLNode&, int version);
 255
 256         virtual boost::shared_ptr<Region> get_parent() const;
 257
 258         uint64_t last_layer_op() const { return _last_layer_op; }
 259         void set_last_layer_op (uint64_t when);
 260
 261         virtual bool is_dependent() const { return false; }
 262         virtual bool depends_on (boost::shared_ptr<Region> /*other*/) const { return false; }
 263
 264         virtual int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&) = 0;
 265
 266         virtual void add_transient (framepos_t) {
 267                 // no transients, but its OK
 268         }
 269
 270         virtual int update_transient (framepos_t /* old_position */, framepos_t /* new_position */) {
 271                 // no transients, but its OK
 272                 return 0;
 273         }
 274
 275         virtual void remove_transient (framepos_t /* where */) {
 276                 // no transients, but its OK
 277         }
 278
 279         virtual int set_transients (AnalysisFeatureList&) {
 280                 // no transients, but its OK
 281                 return 0;
 282         }
 283
 284         virtual int get_transients (AnalysisFeatureList&, bool force_new = false) {
 285                 (void) force_new;
 286                 // no transients, but its OK
 287                 return 0;
 288         }
 289
 290         virtual int adjust_transients (framepos_t /*delta*/) {
 291                 // no transients, but its OK
 292                 return 0;
 293         }
 294
 295         virtual int separate_by_channel (ARDOUR::Session&,
 296                         std::vector< boost::shared_ptr<Region> >&) const {
 297                 return 0;
 298         }
 299
 300         void invalidate_transients ();
 301
 302         void set_pending_explicit_relayer (bool p) {
 303                 _pending_explicit_relayer = p;
 304         }
 305
 306         bool pending_explicit_relayer () const {
 307                 return _pending_explicit_relayer;
 308         }
 309
 310         void drop_sources ();
 311
 312   protected:
 313         friend class RegionFactory;
 314
 315         /** Construct a region from multiple sources*/
 316         Region (const SourceList& srcs);
 317
 318         /** Construct a region from another region */
 319         Region (boost::shared_ptr<const Region>);
 320
 321         /** Construct a region from another region, at an offset within that region */
 322         Region (boost::shared_ptr<const Region>, frameoffset_t start_offset);
 323
 324         /** Construct a region as a copy of another region, but with different sources */
 325         Region (boost::shared_ptr<const Region>, const SourceList&);
 326
 327         /** Constructor for derived types only */
 328         Region (Session& s, framepos_t start, framecnt_t length, const std::string& name, DataType);
 329
 330         virtual bool can_trim_start_before_source_start () const {
 331                 return false;
 332         }
 333
 334   protected:
 335         void send_change (const PBD::PropertyChange&);
 336         void mid_thaw (const PBD::PropertyChange&);
 337
 338         void trim_to_internal (framepos_t position, framecnt_t length);
 339         virtual void set_position_internal (framepos_t pos, bool allow_bbt_recompute);
 340         virtual void set_length_internal (framepos_t pos);
 341         void modify_front (framepos_t new_position, bool reset_fade);
 342         void modify_end (framepos_t new_position, bool reset_fade);
 343
 344         void maybe_uncopy ();
 345         void first_edit ();
 346
 347         bool verify_start (framepos_t);
 348         bool verify_start_and_length (framepos_t, framecnt_t&);
 349         bool verify_start_mutable (framepos_t&_start);
 350         bool verify_length (framecnt_t);
 351
 352         virtual void recompute_at_start () = 0;
 353         virtual void recompute_at_end () = 0;
 354
 355         DataType _type;
 356
 357         PBD::Property<bool>        _muted;
 358         PBD::Property<bool>        _opaque;
 359         PBD::Property<bool>        _locked;
 360         PBD::Property<bool>        _automatic;
 361         PBD::Property<bool>        _whole_file;
 362         PBD::Property<bool>        _import;
 363         PBD::Property<bool>        _external;
 364         PBD::Property<bool>        _sync_marked;
 365         PBD::Property<bool>        _left_of_split;
 366         PBD::Property<bool>        _right_of_split;
 367         PBD::Property<bool>        _hidden;
 368         PBD::Property<bool>        _position_locked;
 369         PBD::Property<bool>        _valid_transients;
 370         PBD::Property<framepos_t>  _start;
 371         PBD::Property<framecnt_t>  _length;
 372         PBD::Property<framepos_t>  _position;
 373         /** Sync position relative to the start of our file */
 374         PBD::Property<framepos_t>  _sync_position;
 375         PBD::Property<layer_t>     _layer;
 376         PBD::Property<framepos_t>  _ancestral_start;
 377         PBD::Property<framecnt_t>  _ancestral_length;
 378         PBD::Property<float>       _stretch;
 379         PBD::Property<float>       _shift;
 380         PBD::EnumProperty<PositionLockStyle> _position_lock_style;
 381
 382         framecnt_t              _last_length;
 383         framepos_t              _last_position;
 384         mutable RegionEditState _first_edit;
 385         Timecode::BBT_Time      _bbt_time;
 386         AnalysisFeatureList     _transients;
 387
 388         mutable uint64_t        _read_data_count;  ///< modified in read()
 389         uint64_t                _last_layer_op;  ///< timestamp
 390         SourceList              _sources;
 391         /** Used when timefx are applied, so we can always use the original source */
 392         SourceList              _master_sources;
 393
 394         /** true if this region has had its layer explicitly set since the playlist last relayered */
 395         bool                    _pending_explicit_relayer;
 396
 397         boost::weak_ptr<ARDOUR::Playlist> _playlist;
 398
 399         virtual int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
 400
 401         void register_properties ();
 402
 403 protected:
 404         void use_sources (SourceList const &);
 405 };
 406
 407 } /* namespace ARDOUR */
 408
 409 #endif /* __ardour_region_h__ */