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