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/data_type.h"
  48
  49 namespace ARDOUR  {
  50
  51 class Session;
  52 class Region;
  53 class Playlist;
  54
  55 namespace Properties {
  56         /* fake the type, since regions are handled by SequenceProperty which doesn't
  57            care about such things.
  58         */
  59         extern PBD::PropertyDescriptor<bool> regions;
  60 }
  61
  62 class RegionListProperty : public PBD::SequenceProperty<std::list<boost::shared_ptr<Region > > >
  63 {
  64   public:
  65         RegionListProperty (Playlist&);
  66
  67         boost::shared_ptr<Region> lookup_id (const PBD::ID& id);
  68         void diff (PBD::PropertyList& undo, PBD::PropertyList& redo, Command*) const;
  69         bool involves (boost::shared_ptr<Region>);
  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 remove_region_by_source (boost::shared_ptr<Source>);
 140         void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 141         void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 142         void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos);
 143         void split_region (boost::shared_ptr<Region>, framepos_t position);
 144         void split (framepos_t at);
 145         void shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue);
 146         void partition (framepos_t start, framepos_t end, bool cut = false);
 147         void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
 148         void nudge_after (framepos_t start, framecnt_t distance, bool forwards);
 149         void shuffle (boost::shared_ptr<Region>, int dir);
 150         void update_after_tempo_map_change ();
 151
 152         boost::shared_ptr<Playlist> cut  (std::list<AudioRange>&, bool result_is_hidden = true);
 153         boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
 154         int                         paste (boost::shared_ptr<Playlist>, framepos_t position, float times);
 155
 156         const RegionListProperty& region_list () const { return regions; }
 157
 158         RegionList*                regions_at (framepos_t frame);
 159         RegionList*                regions_touched (framepos_t start, framepos_t end);
 160         RegionList*                regions_to_read (framepos_t start, framepos_t end);
 161         boost::shared_ptr<Region>  find_region (const PBD::ID&) const;
 162         boost::shared_ptr<Region>  top_region_at (framepos_t frame);
 163         boost::shared_ptr<Region>  top_unmuted_region_at (framepos_t frame);
 164         boost::shared_ptr<Region>  find_next_region (framepos_t frame, RegionPoint point, int dir);
 165         framepos_t                 find_next_region_boundary (framepos_t frame, int dir);
 166         bool                       region_is_shuffle_constrained (boost::shared_ptr<Region>);
 167         bool                       has_region_at (framepos_t const) const;
 168
 169
 170         framepos_t find_next_transient (framepos_t position, int dir);
 171
 172         void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
 173
 174         XMLNode& get_state ();
 175         int set_state (const XMLNode&, int version);
 176         XMLNode& get_template ();
 177
 178         PBD::Signal1<void,bool> InUse;
 179         PBD::Signal0<void>      ContentsChanged;
 180         PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
 181         PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
 182         PBD::Signal0<void>      NameChanged;
 183         PBD::Signal0<void>      LengthChanged;
 184         PBD::Signal0<void>      LayeringChanged;
 185
 186         /** Emitted when regions have moved (not when regions have only been trimmed) */
 187         PBD::Signal2<void,std::list< Evoral::RangeMove<framepos_t> > const &, bool> RangesMoved;
 188
 189         static std::string bump_name (std::string old_name, Session&);
 190
 191         void freeze ();
 192         void thaw (bool from_undo = false);
 193
 194         void raise_region (boost::shared_ptr<Region>);
 195         void lower_region (boost::shared_ptr<Region>);
 196         void raise_region_to_top (boost::shared_ptr<Region>);
 197         void lower_region_to_bottom (boost::shared_ptr<Region>);
 198
 199         uint32_t read_data_count() const { return _read_data_count; }
 200
 201         /* XXX: use of diskstream here is a little unfortunate */
 202         const PBD::ID& get_orig_diskstream_id () const { return _orig_diskstream_id; }
 203         void set_orig_diskstream_id (const PBD::ID& did) { _orig_diskstream_id = did; }
 204
 205         /* destructive editing */
 206
 207         virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
 208
 209         /* special case function used by UI selection objects, which have playlists that actually own the regions
 210            within them.
 211         */
 212
 213         void drop_regions ();
 214
 215         bool explicit_relayering () const {
 216                 return _explicit_relayering;
 217         }
 218
 219         void set_explicit_relayering (bool e);
 220
 221   protected:
 222         friend class Session;
 223
 224   protected:
 225         struct RegionLock {
 226                 RegionLock (Playlist *pl, bool do_block_notify = true) : playlist (pl), block_notify (do_block_notify) {
 227                         playlist->region_lock.lock();
 228                         if (block_notify) {
 229                                 playlist->delay_notifications();
 230                         }
 231                 }
 232                 ~RegionLock() {
 233                         playlist->region_lock.unlock();
 234                         if (block_notify) {
 235                                 playlist->release_notifications ();
 236                         }
 237                 }
 238                 Playlist *playlist;
 239                 bool block_notify;
 240         };
 241
 242         friend class RegionLock;
 243
 244         RegionListProperty   regions;  /* the current list of regions in the playlist */
 245         std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
 246         PBD::ScopedConnectionList region_state_changed_connections;
 247         DataType        _type;
 248         int             _sort_id;
 249         mutable gint    block_notifications;
 250         mutable gint    ignore_state_changes;
 251         mutable Glib::RecMutex region_lock;
 252         std::set<boost::shared_ptr<Region> > pending_adds;
 253         std::set<boost::shared_ptr<Region> > pending_removes;
 254         RegionList       pending_bounds;
 255         bool             pending_contents_change;
 256         bool             pending_layering;
 257         bool             pending_length;
 258
 259         /** Movements of time ranges caused by region moves; note that
 260          *  region trims are not included in this list; it is used to
 261          *  do automation-follows-regions.
 262          */
 263         std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
 264         bool             save_on_thaw;
 265         std::string      last_save_reason;
 266         uint32_t         in_set_state;
 267         bool             in_update;
 268         bool             first_set_state;
 269         bool            _hidden;
 270         bool            _splicing;
 271         bool            _shuffling;
 272         bool            _nudging;
 273         uint32_t        _refcnt;
 274         EditMode        _edit_mode;
 275         bool             in_flush;
 276         bool             in_partition;
 277         bool            _frozen;
 278         uint32_t         subcnt;
 279         uint32_t        _read_data_count;
 280         PBD::ID         _orig_diskstream_id;
 281         uint64_t         layer_op_counter;
 282         framecnt_t       freeze_length;
 283         bool             auto_partition;
 284
 285         /** true if relayering should be done using region's current layers and their `pending explicit relayer'
 286          *  flags; otherwise false if relayering should be done using the layer-model (most recently moved etc.)
 287          *  Explicit relayering is used by tracks in stacked regionview mode.
 288          */
 289         bool            _explicit_relayering;
 290
 291         void init (bool hide);
 292
 293         bool holding_state () const {
 294                 return g_atomic_int_get (&block_notifications) != 0 ||
 295                         g_atomic_int_get (&ignore_state_changes) != 0;
 296         }
 297
 298         void delay_notifications ();
 299         void release_notifications (bool from_undo = false);
 300         virtual void flush_notifications (bool from_undo = false);
 301         void clear_pending ();
 302
 303         void _set_sort_id ();
 304
 305         void notify_region_removed (boost::shared_ptr<Region>);
 306         void notify_region_added (boost::shared_ptr<Region>);
 307         void notify_length_changed ();
 308         void notify_layering_changed ();
 309         void notify_contents_changed ();
 310         void notify_state_changed (const PBD::PropertyChange&);
 311         void notify_region_moved (boost::shared_ptr<Region>);
 312
 313         void mark_session_dirty();
 314
 315         void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
 316         virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 317
 318         void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 319         void region_deleted (boost::shared_ptr<Region>);
 320
 321         void sort_regions ();
 322
 323         void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 324         void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 325
 326         void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 327         void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 328         void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 329
 330         virtual void finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/) {}
 331
 332         virtual void check_dependents (boost::shared_ptr<Region> /*region*/, bool /*norefresh*/) {}
 333         virtual void refresh_dependents (boost::shared_ptr<Region> /*region*/) {}
 334         virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
 335
 336         virtual XMLNode& state (bool);
 337
 338         bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
 339
 340         int remove_region_internal (boost::shared_ptr<Region>);
 341         RegionList *find_regions_at (framepos_t frame);
 342         void copy_regions (RegionList&) const;
 343         void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
 344
 345         std::pair<framecnt_t, framecnt_t> _get_extent() const;
 346
 347         boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
 348                                               std::list<AudioRange>& ranges, bool result_is_hidden);
 349         boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 350         boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 351
 352         int move_region_to_layer (layer_t, boost::shared_ptr<Region> r, int dir);
 353         void relayer ();
 354
 355         void begin_undo ();
 356         void end_undo ();
 357         void unset_freeze_parent (Playlist*);
 358         void unset_freeze_child (Playlist*);
 359
 360         void timestamp_layer_op (boost::shared_ptr<Region>);
 361
 362         void _split_region (boost::shared_ptr<Region>, framepos_t position);
 363 };
 364
 365 } /* namespace ARDOUR */
 366
 367 #endif  /* __ardour_playlist_h__ */
 368
 369