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