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     $Id$
  19 */
  20
  21 #ifndef __ardour_region_h__
  22 #define __ardour_region_h__
  23
  24 #include <vector>
  25
  26 #include <pbd/undo.h>
  27
  28 #include <ardour/ardour.h>
  29 #include <ardour/state_manager.h>
  30
  31 class XMLNode;
  32
  33 namespace ARDOUR {
  34
  35 class Playlist;
  36 class Source;
  37
  38 enum RegionEditState {
  39         EditChangesNothing = 0,
  40         EditChangesName    = 1,
  41         EditChangesID      = 2
  42 };
  43
  44 struct RegionState : public StateManager::State
  45 {
  46         RegionState (std::string why) : StateManager::State (why) {}
  47
  48         jack_nframes_t          _start;
  49         jack_nframes_t          _length;
  50         jack_nframes_t          _position;
  51         uint32_t                _flags;
  52         jack_nframes_t          _sync_position;
  53         layer_t                 _layer;
  54         string                  _name;
  55         mutable RegionEditState _first_edit;
  56 };
  57
  58 class Region : public Stateful, public StateManager
  59 {
  60   public:
  61         typedef std::vector<Source *> SourceList;
  62
  63         enum Flag {
  64                 Muted = 0x1,
  65                 Opaque = 0x2,
  66                 EnvelopeActive = 0x4,
  67                 DefaultFadeIn = 0x8,
  68                 DefaultFadeOut = 0x10,
  69                 Locked = 0x20,
  70                 Automatic = 0x40,
  71                 WholeFile = 0x80,
  72                 FadeIn = 0x100,
  73                 FadeOut = 0x200,
  74                 Copied = 0x400,
  75                 Import = 0x800,
  76                 External = 0x1000,
  77                 SyncMarked = 0x2000,
  78                 LeftOfSplit = 0x4000,
  79                 RightOfSplit = 0x8000,
  80                 Hidden = 0x10000,
  81                 DoNotSaveState = 0x20000,
  82                 //
  83                 range_guarantoor = USHRT_MAX
  84         };
  85
  86         static const Flag DefaultFlags = Flag (Opaque|DefaultFadeIn|DefaultFadeOut|FadeIn|FadeOut);
  87
  88         static Change FadeChanged;
  89         static Change SyncOffsetChanged;
  90         static Change MuteChanged;
  91         static Change OpacityChanged;
  92         static Change LockChanged;
  93         static Change LayerChanged;
  94         static Change HiddenChanged;
  95
  96         Region (Source& src, jack_nframes_t start, jack_nframes_t length,
  97                 const string& name, layer_t = 0, Flag flags = DefaultFlags);
  98         Region (SourceList& srcs, jack_nframes_t start, jack_nframes_t length,
  99                 const string& name, layer_t = 0, Flag flags = DefaultFlags);
 100         Region (const Region&, jack_nframes_t start, jack_nframes_t length,
 101                 const string& name, layer_t = 0, Flag flags = DefaultFlags);
 102         Region (const Region&);
 103         Region (SourceList& srcs, const XMLNode&);
 104         Region (Source& src, const XMLNode&);
 105         virtual ~Region();
 106
 107         const PBD::ID& id() const { return _id; }
 108
 109         /* Note: changing the name of a Region does not constitute an edit */
 110
 111         string name() const { return _name; }
 112         void set_name (string str);
 113
 114         jack_nframes_t position () const { return _position; }
 115         jack_nframes_t start ()    const { return _start; }
 116         jack_nframes_t length()    const { return _length; }
 117         layer_t        layer ()    const { return _layer; }
 118
 119         jack_nframes_t sync_offset(int& dir) const;
 120         jack_nframes_t sync_position() const;
 121
 122         jack_nframes_t adjust_to_sync (jack_nframes_t);
 123
 124         /* first_frame() is an alias; last_frame() just hides some math */
 125
 126         jack_nframes_t first_frame() const { return _position; }
 127         jack_nframes_t last_frame() const { return _position + _length - 1; }
 128
 129         Flag flags()      const { return _flags; }
 130         bool hidden()     const { return _flags & Hidden; }
 131         bool muted()      const { return _flags & Muted; }
 132         bool opaque ()    const { return _flags & Opaque; }
 133         bool locked()     const { return _flags & Locked; }
 134         bool automatic()  const { return _flags & Automatic; }
 135         bool whole_file() const { return _flags & WholeFile ; }
 136         bool captured()   const { return !(_flags & (Region::Flag (Region::Import|Region::External))); }
 137
 138         virtual bool should_save_state () const { return !(_flags & DoNotSaveState); };
 139
 140         void freeze ();
 141         void thaw (const string& why);
 142
 143         bool covers (jack_nframes_t frame) const {
 144                 return _position <= frame && frame < _position + _length;
 145         }
 146
 147         OverlapType coverage (jack_nframes_t start, jack_nframes_t end) const {
 148                 return ARDOUR::coverage (_position, _position + _length - 1, start, end);
 149         }
 150
 151         bool equivalent (const Region&) const;
 152         bool size_equivalent (const Region&) const;
 153         bool overlap_equivalent (const Region&) const;
 154         bool region_list_equivalent (const Region&) const;
 155         bool source_equivalent (const Region&) const;
 156
 157         /* EDITING OPERATIONS */
 158
 159         void set_length (jack_nframes_t, void *src);
 160         void set_start (jack_nframes_t, void *src);
 161         void set_position (jack_nframes_t, void *src);
 162         void set_position_on_top (jack_nframes_t, void *src);
 163         void special_set_position (jack_nframes_t);
 164         void nudge_position (long, void *src);
 165
 166         void move_to_natural_position (void *src);
 167
 168         void trim_start (jack_nframes_t new_position, void *src);
 169         void trim_front (jack_nframes_t new_position, void *src);
 170         void trim_end (jack_nframes_t new_position, void *src);
 171         void trim_to (jack_nframes_t position, jack_nframes_t length, void *src);
 172
 173         void set_layer (layer_t l); /* ONLY Playlist can call this */
 174         void raise ();
 175         void lower ();
 176         void raise_to_top ();
 177         void lower_to_bottom ();
 178
 179         void set_sync_position (jack_nframes_t n);
 180         void clear_sync_position ();
 181         void set_hidden (bool yn);
 182         void set_muted (bool yn);
 183         void set_opaque (bool yn);
 184         void set_locked (bool yn);
 185
 186         virtual uint32_t read_data_count() const { return _read_data_count; }
 187
 188         ARDOUR::Playlist* playlist() const { return _playlist; }
 189
 190         virtual UndoAction get_memento() const = 0;
 191
 192         void set_playlist (ARDOUR::Playlist*);
 193
 194         void lock_sources ();
 195         void unlock_sources ();
 196         void source_deleted (Source*);
 197
 198         Source&  source (uint32_t n=0) const { return *_sources[ (n < _sources.size()) ? n : 0 ]; }
 199         uint32_t n_channels()          const { return _sources.size(); }
 200
 201         std::vector<string> master_source_names();
 202
 203
 204         /* serialization */
 205
 206         XMLNode&         get_state ();
 207         virtual XMLNode& state (bool);
 208         virtual int      set_state (const XMLNode&);
 209
 210         sigc::signal<void,Region*> GoingAway;
 211
 212         /* This is emitted only when a new id is assigned. Therefore,
 213            in a pure Region copy, it will not be emitted.
 214
 215            It must be emitted by derived classes, not Region
 216            itself, to permit dynamic_cast<> to be used to
 217            infer the type of Region.
 218         */
 219
 220         static sigc::signal<void,Region*> CheckNewRegion;
 221
 222         Region* get_parent();
 223
 224         uint64_t last_layer_op() const { return _last_layer_op; }
 225         void set_last_layer_op (uint64_t when);
 226
 227   protected:
 228         XMLNode& get_short_state (); /* used only by Session */
 229
 230         /* state management */
 231
 232         void send_change (Change);
 233
 234         /* derived classes need these during their own state management calls */
 235
 236         void   store_state (RegionState&) const;
 237         Change restore_and_return_flags (RegionState&);
 238
 239         void trim_to_internal (jack_nframes_t position, jack_nframes_t length, void *src);
 240
 241         bool copied() const { return _flags & Copied; }
 242         void maybe_uncopy ();
 243         void first_edit ();
 244
 245         bool verify_start (jack_nframes_t);
 246         bool verify_start_and_length (jack_nframes_t, jack_nframes_t);
 247         bool verify_start_mutable (jack_nframes_t&_start);
 248         bool verify_length (jack_nframes_t);
 249         virtual void recompute_at_start () = 0;
 250         virtual void recompute_at_end () = 0;
 251
 252
 253         PBD::ID                 _id;
 254         string                  _name;
 255         Flag                    _flags;
 256         jack_nframes_t          _start;
 257         jack_nframes_t          _length;
 258         jack_nframes_t          _position;
 259         jack_nframes_t          _sync_position;
 260         layer_t                 _layer;
 261         mutable RegionEditState _first_edit;
 262         int                     _frozen;
 263         mutable uint32_t        _read_data_count;  ///< modified in read()
 264         Change                  _pending_changed;
 265         uint64_t                _last_layer_op;  ///< timestamp
 266         Glib::Mutex             _lock;
 267         ARDOUR::Playlist*       _playlist;
 268         SourceList              _sources;
 269         /** Used when timefx are applied, so we can always use the original source */
 270         SourceList              _master_sources;
 271 };
 272
 273 } /* namespace ARDOUR */
 274
 275 #endif /* __ardour_region_h__ */