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/readable.h"
  35 #include "ardour/session_object.h"
  36
  37 class XMLNode;
  38
  39
  40 namespace ARDOUR {
  41
  42 namespace Properties {
  43         extern PBD::PropertyDescriptor<bool> muted;
  44         extern PBD::PropertyDescriptor<bool> opaque;
  45         extern PBD::PropertyDescriptor<bool> locked;
  46         extern PBD::PropertyDescriptor<bool> automatic;
  47         extern PBD::PropertyDescriptor<bool> whole_file;
  48         extern PBD::PropertyDescriptor<bool> import;
  49         extern PBD::PropertyDescriptor<bool> external;
  50         extern PBD::PropertyDescriptor<bool> sync_marked;
  51         extern PBD::PropertyDescriptor<bool> left_of_split;
  52         extern PBD::PropertyDescriptor<bool> right_of_split;
  53         extern PBD::PropertyDescriptor<bool> hidden;
  54         extern PBD::PropertyDescriptor<bool> position_locked;
  55         extern PBD::PropertyDescriptor<framepos_t> start;
  56         extern PBD::PropertyDescriptor<framecnt_t> length;
  57         extern PBD::PropertyDescriptor<framepos_t> position;
  58         extern PBD::PropertyDescriptor<framecnt_t> sync_position;
  59         extern PBD::PropertyDescriptor<layer_t> layer;
  60         extern PBD::PropertyDescriptor<framepos_t> ancestral_start;
  61         extern PBD::PropertyDescriptor<framecnt_t> ancestral_length;
  62         extern PBD::PropertyDescriptor<float> stretch;
  63         extern PBD::PropertyDescriptor<float> shift;
  64 };
  65
  66 class Playlist;
  67 class Filter;
  68 class ExportSpecification;
  69
  70 enum RegionEditState {
  71         EditChangesNothing = 0,
  72         EditChangesName    = 1,
  73         EditChangesID      = 2
  74 };
  75
  76
  77 class Region
  78         : public SessionObject
  79         , public boost::enable_shared_from_this<Region>
  80         , public Readable
  81 {
  82   public:
  83         typedef std::vector<boost::shared_ptr<Source> > SourceList;
  84
  85         static void make_property_quarks ();
  86
  87         enum PositionLockStyle {
  88                 AudioTime,
  89                 MusicTime
  90         };
  91
  92         static PBD::Signal2<void,boost::shared_ptr<ARDOUR::Region>, const PBD::PropertyChange&> RegionPropertyChanged;
  93
  94         PBD::PropertyList* property_factory (const XMLNode&) const;
  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         /** How the region parameters play together:
 104          *
 105          * POSITION: first frame of the region along the timeline
 106          * START:    first frame of the region within its source(s)
 107          * LENGTH:   number of frames the region represents
 108          */
 109         sframes_t  position () const { return _position; }
 110         sframes_t  start ()    const { return _start; }
 111         framecnt_t length()    const { return _length; }
 112         layer_t    layer ()    const { return _layer; }
 113
 114         framecnt_t source_length(uint32_t n) const;
 115
 116         /* these two are valid ONLY during a StateChanged signal handler */
 117
 118         sframes_t  last_position() const { return _last_position; }
 119         framecnt_t last_length() const { return _last_length; }
 120
 121         sframes_t ancestral_start () const { return _ancestral_start; }
 122         framecnt_t ancestral_length () const { return _ancestral_length; }
 123         float stretch() const { return _stretch; }
 124         float shift() const { return _shift; }
 125
 126         void set_ancestral_data (nframes64_t start, nframes64_t length, float stretch, float shift);
 127
 128         frameoffset_t sync_offset(int& dir) const;
 129         framepos_t sync_position() const;
 130         framepos_t sync_point () const;
 131
 132         framepos_t adjust_to_sync (framepos_t) const;
 133
 134         /* first_frame() is an alias; last_frame() just hides some math */
 135
 136         framepos_t first_frame() const { return _position; }
 137         framepos_t last_frame()  const { return _position + _length - 1; }
 138
 139         bool hidden()     const  { return _hidden; }
 140         bool muted()      const  { return _muted; }
 141         bool opaque ()    const  { return _opaque; }
 142         bool locked()     const  { return _locked; }
 143         bool position_locked() const { return _position_locked; }
 144         bool automatic()  const  { return _automatic; }
 145         bool whole_file() const  { return _whole_file; }
 146         bool captured()   const  { return !(_import || _external); }
 147         bool can_move()   const  { return !_position_locked; }
 148         bool sync_marked() const { return _sync_marked; }
 149         bool external() const    { return _external; }
 150         bool import() const      { return _import; }
 151
 152         PositionLockStyle positional_lock_style() const { return _positional_lock_style; }
 153         void set_position_lock_style (PositionLockStyle ps);
 154         void recompute_position_from_lock_style ();
 155
 156         void suspend_property_changes ();
 157
 158         bool covers (framepos_t frame) const {
 159                 return first_frame() <= frame && frame <= last_frame();
 160         }
 161
 162         OverlapType coverage (framepos_t start, framepos_t end) const {
 163                 return ARDOUR::coverage (first_frame(), last_frame(), start, end);
 164         }
 165
 166         bool equivalent (boost::shared_ptr<const Region>) const;
 167         bool size_equivalent (boost::shared_ptr<const Region>) const;
 168         bool overlap_equivalent (boost::shared_ptr<const Region>) const;
 169         bool region_list_equivalent (boost::shared_ptr<const Region>) const;
 170         bool source_equivalent (boost::shared_ptr<const Region>) const;
 171         bool uses_source (boost::shared_ptr<const Source>) const;
 172
 173         /* EDITING OPERATIONS */
 174
 175         void set_length (framecnt_t, void *src);
 176         void set_start (framepos_t, void *src);
 177         void set_position (framepos_t, void *src);
 178         void set_position_on_top (framepos_t, void *src);
 179         void special_set_position (framepos_t);
 180         void update_position_after_tempo_map_change ();
 181         void nudge_position (frameoffset_t, void *src);
 182
 183         bool at_natural_position () const;
 184         void move_to_natural_position (void *src);
 185
 186         void trim_start (framepos_t new_position, void *src);
 187         void trim_front (framepos_t new_position, void *src);
 188         void trim_end (framepos_t new_position, void *src);
 189         void trim_to (framepos_t position, framecnt_t length, void *src);
 190
 191         void cut_front (nframes_t new_position, void *src);
 192         void cut_end (nframes_t new_position, void *src);
 193
 194         void set_layer (layer_t l); /* ONLY Playlist can call this */
 195         void raise ();
 196         void lower ();
 197         void raise_to_top ();
 198         void lower_to_bottom ();
 199
 200         void set_sync_position (framepos_t n);
 201         void clear_sync_position ();
 202         void set_hidden (bool yn);
 203         void set_muted (bool yn);
 204         void set_whole_file (bool yn);
 205         void set_automatic (bool yn);
 206         void set_opaque (bool yn);
 207         void set_locked (bool yn);
 208         void set_position_locked (bool yn);
 209
 210         int apply (Filter&);
 211
 212         virtual uint64_t read_data_count() const { return _read_data_count; }
 213
 214         boost::shared_ptr<ARDOUR::Playlist> playlist() const { return _playlist.lock(); }
 215         virtual void set_playlist (boost::weak_ptr<ARDOUR::Playlist>);
 216
 217         void source_deleted (boost::weak_ptr<Source>);
 218
 219         boost::shared_ptr<Source> source (uint32_t n=0) const { return _sources[ (n < _sources.size()) ? n : 0 ]; }
 220         uint32_t                  n_channels()          const { return _sources.size(); }
 221
 222         const SourceList& sources() const { return _sources; }
 223         const SourceList& master_sources() const { return _master_sources; }
 224
 225         std::vector<std::string> master_source_names();
 226         void set_master_sources (const SourceList&);
 227
 228         /* automation */
 229
 230         virtual boost::shared_ptr<Evoral::Control>
 231         control(const Evoral::Parameter& id, bool create=false) = 0;
 232
 233         virtual boost::shared_ptr<const Evoral::Control>
 234         control(const Evoral::Parameter& id) const = 0;
 235
 236         /* serialization */
 237
 238         XMLNode&         get_state ();
 239         virtual XMLNode& state (bool);
 240         virtual int      set_state (const XMLNode&, int version);
 241
 242         virtual boost::shared_ptr<Region> get_parent() const;
 243
 244         uint64_t last_layer_op() const { return _last_layer_op; }
 245         void set_last_layer_op (uint64_t when);
 246
 247         virtual bool is_dependent() const { return false; }
 248         virtual bool depends_on (boost::shared_ptr<Region> /*other*/) const { return false; }
 249
 250         virtual int exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&) = 0;
 251
 252         virtual int get_transients (AnalysisFeatureList&, bool force_new = false) {
 253                 (void) force_new;
 254                 // no transients, but its OK
 255                 return 0;
 256         }
 257
 258         virtual int separate_by_channel (ARDOUR::Session&,
 259                         std::vector< boost::shared_ptr<Region> >&) const {
 260                 return 0;
 261         }
 262
 263         void invalidate_transients ();
 264
 265         void set_pending_explicit_relayer (bool p) {
 266                 _pending_explicit_relayer = p;
 267         }
 268
 269         bool pending_explicit_relayer () const {
 270                 return _pending_explicit_relayer;
 271         }
 272
 273         void drop_sources ();
 274
 275   protected:
 276         friend class RegionFactory;
 277
 278         /** Construct a region from multiple sources*/
 279         Region (const SourceList& srcs);
 280         /** Construct a region from another region, at an offset within that region */
 281         Region (boost::shared_ptr<const Region>, frameoffset_t start_offset = 0, bool start_relative = true);
 282         /** Construct a region as a copy of another region, but with different sources */
 283         Region (boost::shared_ptr<const Region>, const SourceList&);
 284         /** normal Region copy constructor */
 285         Region (boost::shared_ptr<const Region>);
 286
 287         /** Constructor for derived types only */
 288         Region (Session& s, framepos_t start, framecnt_t length, const std::string& name, DataType);
 289
 290   protected:
 291         void send_change (const PBD::PropertyChange&);
 292         void mid_thaw (const PBD::PropertyChange&);
 293
 294         void trim_to_internal (framepos_t position, framecnt_t length, void *src);
 295         virtual void set_position_internal (framepos_t pos, bool allow_bbt_recompute);
 296         void modify_front (nframes_t new_position, bool reset_fade, void* src);
 297         void modify_end (nframes_t new_position, bool reset_fade, void* src);
 298
 299         void maybe_uncopy ();
 300         void first_edit ();
 301
 302         bool verify_start (framepos_t);
 303         bool verify_start_and_length (framepos_t, framecnt_t&);
 304         bool verify_start_mutable (framepos_t&_start);
 305         bool verify_length (framecnt_t);
 306
 307         virtual void recompute_at_start () = 0;
 308         virtual void recompute_at_end () = 0;
 309
 310         DataType                _type;
 311
 312         PBD::Property<bool>        _muted;
 313         PBD::Property<bool>        _opaque;
 314         PBD::Property<bool>        _locked;
 315         PBD::Property<bool>        _automatic;
 316         PBD::Property<bool>        _whole_file;
 317         PBD::Property<bool>        _import;
 318         PBD::Property<bool>        _external;
 319         PBD::Property<bool>        _sync_marked;
 320         PBD::Property<bool>        _left_of_split;
 321         PBD::Property<bool>        _right_of_split;
 322         PBD::Property<bool>        _hidden;
 323         PBD::Property<bool>        _position_locked;
 324         PBD::Property<framepos_t>  _start;
 325         PBD::Property<framecnt_t>  _length;
 326         PBD::Property<framepos_t>  _position;
 327         PBD::Property<framepos_t>  _sync_position;
 328         PBD::Property<layer_t>     _layer;
 329         PBD::Property<framepos_t>  _ancestral_start;
 330         PBD::Property<framecnt_t>  _ancestral_length;
 331         PBD::Property<float>       _stretch;
 332         PBD::Property<float>       _shift;
 333
 334         framecnt_t              _last_length;
 335         framepos_t              _last_position;
 336         PositionLockStyle       _positional_lock_style;
 337         mutable RegionEditState _first_edit;
 338         BBT_Time                _bbt_time;
 339         AnalysisFeatureList     _transients;
 340         bool                    _valid_transients;
 341         mutable uint64_t        _read_data_count;  ///< modified in read()
 342         uint64_t                _last_layer_op;  ///< timestamp
 343         SourceList              _sources;
 344         /** Used when timefx are applied, so we can always use the original source */
 345         SourceList              _master_sources;
 346
 347         /** true if this region has had its layer explicitly set since the playlist last relayered */
 348         bool                    _pending_explicit_relayer;
 349
 350         boost::weak_ptr<ARDOUR::Playlist> _playlist;
 351
 352         virtual int _set_state (const XMLNode&, int version, PBD::PropertyChange& what_changed, bool send_signal);
 353
 354         void register_properties ();
 355
 356 protected:
 357         void use_sources (SourceList const &);
 358 };
 359
 360 } /* namespace ARDOUR */
 361
 362 #endif /* __ardour_region_h__ */