libs/ardour/ardour/playlist.h

   1 /*
   2     Copyright (C) 2000 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_playlist_h__
  21 #define __ardour_playlist_h__
  22
  23 #include <string>
  24 #include <set>
  25 #include <map>
  26 #include <list>
  27 #include <boost/shared_ptr.hpp>
  28 #include <boost/enable_shared_from_this.hpp>
  29 #include <boost/utility.hpp>
  30
  31 #include <sys/stat.h>
  32
  33 #include <glib.h>
  34
  35
  36 #include "pbd/undo.h"
  37 #include "pbd/stateful.h"
  38 #include "pbd/stateful_owner.h"
  39 #include "pbd/statefuldestructible.h"
  40 #include "pbd/sequence_property.h"
  41
  42 #include "evoral/types.hpp"
  43
  44 #include "ardour/ardour.h"
  45 #include "ardour/session_object.h"
  46 #include "ardour/crossfade_compare.h"
  47 #include "ardour/location.h"
  48 #include "ardour/data_type.h"
  49
  50 namespace ARDOUR  {
  51
  52 class Session;
  53 class Region;
  54 class Playlist;
  55
  56 namespace Properties {
  57         /* fake the type, since regions are handled by SequenceProperty which doesn't
  58            care about such things.
  59         */
  60         extern PBD::PropertyDescriptor<bool> regions;
  61 }
  62
  63 class RegionListProperty : public PBD::SequenceProperty<std::list<boost::shared_ptr<Region > > >
  64 {
  65   public:
  66         RegionListProperty (Playlist&);
  67
  68         boost::shared_ptr<Region> lookup_id (const PBD::ID& id);
  69         void diff (PBD::PropertyList& undo, PBD::PropertyList& redo) const;
  70
  71   private:
  72         friend class Playlist;
  73         std::list<boost::shared_ptr<Region> > rlist() { return _val; }
  74
  75         /* we live and die with our playlist, no lifetime management needed */
  76         Playlist& _playlist;
  77
  78         /* create a copy of this RegionListProperty that only
  79            has what is needed for use in a history list command. This
  80            means that it won't contain the actual region list but
  81            will have the added/removed list.
  82         */
  83         RegionListProperty* copy_for_history () const;
  84 };
  85
  86 class Playlist : public SessionObject
  87                , public PBD::StatefulOwner
  88                , public boost::enable_shared_from_this<Playlist> {
  89   public:
  90         typedef std::list<boost::shared_ptr<Region> >    RegionList;
  91         static void make_property_quarks ();
  92
  93         Playlist (Session&, const XMLNode&, DataType type, bool hidden = false);
  94         Playlist (Session&, std::string name, DataType type, bool hidden = false);
  95         Playlist (boost::shared_ptr<const Playlist>, std::string name, bool hidden = false);
  96         Playlist (boost::shared_ptr<const Playlist>, framepos_t start, framecnt_t cnt, std::string name, bool hidden = false);
  97
  98         virtual ~Playlist ();
  99
 100         bool set_property (const PBD::PropertyBase&);
 101         void update (const RegionListProperty::ChangeRecord&);
 102         void clear_owned_history ();
 103         void rdiff (std::vector<PBD::StatefulDiffCommand*>&) const;
 104
 105         PBD::PropertyList* property_factory (const XMLNode&) const;
 106
 107         boost::shared_ptr<Region> region_by_id (const PBD::ID&);
 108
 109         void set_region_ownership ();
 110
 111         virtual void clear (bool with_signals=true);
 112         virtual void dump () const;
 113
 114         void use();
 115         void release();
 116         bool used () const { return _refcnt != 0; }
 117
 118         bool set_name (const std::string& str);
 119         int sort_id() { return _sort_id; }
 120
 121         const DataType& data_type() const { return _type; }
 122
 123         bool frozen() const { return _frozen; }
 124         void set_frozen (bool yn);
 125
 126         bool hidden() const { return _hidden; }
 127         bool empty() const;
 128         uint32_t n_regions() const;
 129         std::pair<framecnt_t, framecnt_t> get_extent () const;
 130         layer_t top_layer() const;
 131
 132         EditMode get_edit_mode() const { return _edit_mode; }
 133         void set_edit_mode (EditMode);
 134
 135         /* Editing operations */
 136
 137         void add_region (boost::shared_ptr<Region>, framepos_t position, float times = 1, bool auto_partition = false);
 138         void remove_region (boost::shared_ptr<Region>);
 139         void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 140         void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 141         void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos);
 142         void split_region (boost::shared_ptr<Region>, framepos_t position);
 143         void split (framepos_t at);
 144         void shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue);
 145         void partition (framepos_t start, framepos_t end, bool cut = false);
 146         void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
 147         void nudge_after (framepos_t start, framecnt_t distance, bool forwards);
 148         void shuffle (boost::shared_ptr<Region>, int dir);
 149         void update_after_tempo_map_change ();
 150
 151         boost::shared_ptr<Playlist> cut  (std::list<AudioRange>&, bool result_is_hidden = true);
 152         boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
 153         int                         paste (boost::shared_ptr<Playlist>, framepos_t position, float times);
 154
 155         const RegionListProperty& region_list () const { return regions; }
 156
 157         RegionList*                regions_at (framepos_t frame);
 158         RegionList*                regions_touched (framepos_t start, framepos_t end);
 159         RegionList*                regions_to_read (framepos_t start, framepos_t end);
 160         boost::shared_ptr<Region>  find_region (const PBD::ID&) const;
 161         boost::shared_ptr<Region>  top_region_at (framepos_t frame);
 162         boost::shared_ptr<Region>  top_unmuted_region_at (framepos_t frame);
 163         boost::shared_ptr<Region>  find_next_region (framepos_t frame, RegionPoint point, int dir);
 164         framepos_t                 find_next_region_boundary (framepos_t frame, int dir);
 165         bool                       region_is_shuffle_constrained (boost::shared_ptr<Region>);
 166         bool                       has_region_at (framepos_t const) const;
 167
 168
 169         framepos_t find_next_transient (framepos_t position, int dir);
 170
 171         void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
 172
 173         XMLNode& get_state ();
 174         int set_state (const XMLNode&, int version);
 175         XMLNode& get_template ();
 176
 177         PBD::Signal1<void,bool> InUse;
 178         PBD::Signal0<void>      ContentsChanged;
 179         PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
 180         PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
 181         PBD::Signal0<void>      NameChanged;
 182         PBD::Signal0<void>      LengthChanged;
 183         PBD::Signal0<void>      LayeringChanged;
 184         PBD::Signal1<void,std::list< Evoral::RangeMove<framepos_t> > const &> RangesMoved;
 185
 186         static std::string bump_name (std::string old_name, Session&);
 187
 188         void freeze ();
 189         void thaw ();
 190
 191         void raise_region (boost::shared_ptr<Region>);
 192         void lower_region (boost::shared_ptr<Region>);
 193         void raise_region_to_top (boost::shared_ptr<Region>);
 194         void lower_region_to_bottom (boost::shared_ptr<Region>);
 195
 196         uint32_t read_data_count() const { return _read_data_count; }
 197
 198         /* XXX: use of diskstream here is a little unfortunate */
 199         const PBD::ID& get_orig_diskstream_id () const { return _orig_diskstream_id; }
 200         void set_orig_diskstream_id (const PBD::ID& did) { _orig_diskstream_id = did; }
 201
 202         /* destructive editing */
 203
 204         virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
 205
 206         /* special case function used by UI selection objects, which have playlists that actually own the regions
 207            within them.
 208         */
 209
 210         void drop_regions ();
 211
 212         bool explicit_relayering () const {
 213                 return _explicit_relayering;
 214         }
 215
 216         void set_explicit_relayering (bool e);
 217
 218   protected:
 219         friend class Session;
 220
 221   protected:
 222         struct RegionLock {
 223                 RegionLock (Playlist *pl, bool do_block_notify = true) : playlist (pl), block_notify (do_block_notify) {
 224                         playlist->region_lock.lock();
 225                         if (block_notify) {
 226                                 playlist->delay_notifications();
 227                         }
 228                 }
 229                 ~RegionLock() {
 230                         playlist->region_lock.unlock();
 231                         if (block_notify) {
 232                                 playlist->release_notifications ();
 233                         }
 234                 }
 235                 Playlist *playlist;
 236                 bool block_notify;
 237         };
 238
 239         friend class RegionLock;
 240
 241         RegionListProperty   regions;  /* the current list of regions in the playlist */
 242         std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
 243         PBD::ScopedConnectionList region_state_changed_connections;
 244         DataType        _type;
 245         int             _sort_id;
 246         mutable gint    block_notifications;
 247         mutable gint    ignore_state_changes;
 248         mutable Glib::RecMutex region_lock;
 249         std::set<boost::shared_ptr<Region> > pending_adds;
 250         std::set<boost::shared_ptr<Region> > pending_removes;
 251         RegionList       pending_bounds;
 252         bool             pending_contents_change;
 253         bool             pending_layering;
 254         bool             pending_length;
 255         std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
 256         bool             save_on_thaw;
 257         std::string      last_save_reason;
 258         uint32_t         in_set_state;
 259         bool             in_update;
 260         bool             first_set_state;
 261         bool            _hidden;
 262         bool            _splicing;
 263         bool            _shuffling;
 264         bool            _nudging;
 265         uint32_t        _refcnt;
 266         EditMode        _edit_mode;
 267         bool             in_flush;
 268         bool             in_partition;
 269         bool            _frozen;
 270         uint32_t         subcnt;
 271         uint32_t        _read_data_count;
 272         PBD::ID         _orig_diskstream_id;
 273         uint64_t         layer_op_counter;
 274         framecnt_t       freeze_length;
 275         bool             auto_partition;
 276
 277         /** true if relayering should be done using region's current layers and their `pending explicit relayer'
 278          *  flags; otherwise false if relayering should be done using the layer-model (most recently moved etc.)
 279          *  Explicit relayering is used by tracks in stacked regionview mode.
 280          */
 281         bool            _explicit_relayering;
 282
 283         void init (bool hide);
 284
 285         bool holding_state () const {
 286                 return g_atomic_int_get (&block_notifications) != 0 ||
 287                         g_atomic_int_get (&ignore_state_changes) != 0;
 288         }
 289
 290         void delay_notifications ();
 291         void release_notifications ();
 292         virtual void flush_notifications ();
 293         void clear_pending ();
 294
 295         void _set_sort_id ();
 296
 297         void notify_region_removed (boost::shared_ptr<Region>);
 298         void notify_region_added (boost::shared_ptr<Region>);
 299         void notify_length_changed ();
 300         void notify_layering_changed ();
 301         void notify_contents_changed ();
 302         void notify_state_changed (const PBD::PropertyChange&);
 303         void notify_region_moved (boost::shared_ptr<Region>);
 304
 305         void mark_session_dirty();
 306
 307         void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
 308         virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 309
 310         void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 311         void region_deleted (boost::shared_ptr<Region>);
 312
 313         void sort_regions ();
 314
 315         void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 316         void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 317
 318         void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 319         void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 320         void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 321
 322         virtual void finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/) {}
 323
 324         virtual void check_dependents (boost::shared_ptr<Region> /*region*/, bool /*norefresh*/) {}
 325         virtual void refresh_dependents (boost::shared_ptr<Region> /*region*/) {}
 326         virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
 327
 328         virtual XMLNode& state (bool);
 329
 330         bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
 331
 332         int remove_region_internal (boost::shared_ptr<Region>);
 333         RegionList *find_regions_at (framepos_t frame);
 334         void copy_regions (RegionList&) const;
 335         void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
 336
 337         std::pair<framecnt_t, framecnt_t> _get_extent() const;
 338
 339         boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
 340                                               std::list<AudioRange>& ranges, bool result_is_hidden);
 341         boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 342         boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 343
 344         int move_region_to_layer (layer_t, boost::shared_ptr<Region> r, int dir);
 345         void relayer ();
 346
 347         void begin_undo ();
 348         void end_undo ();
 349         void unset_freeze_parent (Playlist*);
 350         void unset_freeze_child (Playlist*);
 351
 352         void timestamp_layer_op (boost::shared_ptr<Region>);
 353
 354         void _split_region (boost::shared_ptr<Region>, framepos_t position);
 355 };
 356
 357 } /* namespace ARDOUR */
 358
 359 #endif  /* __ardour_playlist_h__ */
 360
 361