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