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 #include "pbd/undo.h"
  36 #include "pbd/stateful.h"
  37 #include "pbd/statefuldestructible.h"
  38 #include "pbd/sequence_property.h"
  39 #include "pbd/stacktrace.h"
  40
  41 #include "evoral/Range.hpp"
  42
  43 #include "ardour/ardour.h"
  44 #include "ardour/region.h"
  45 #include "ardour/session_object.h"
  46 #include "ardour/data_type.h"
  47
  48 namespace ARDOUR  {
  49
  50 class Session;
  51 class Playlist;
  52 class Crossfade;
  53
  54 namespace Properties {
  55         /* fake the type, since regions are handled by SequenceProperty which doesn't
  56            care about such things.
  57         */
  58         LIBARDOUR_API extern PBD::PropertyDescriptor<bool> regions;
  59 }
  60
  61 class LIBARDOUR_API RegionListProperty : public PBD::SequenceProperty<std::list<boost::shared_ptr<Region> > >
  62 {
  63   public:
  64         RegionListProperty (Playlist&);
  65
  66         RegionListProperty* clone () const;
  67         void get_content_as_xml (boost::shared_ptr<Region>, XMLNode &) const;
  68         boost::shared_ptr<Region> get_content_from_xml (XMLNode const &) const;
  69
  70   private:
  71         RegionListProperty* create () const;
  72
  73         /* copy construction only by ourselves */
  74         RegionListProperty (RegionListProperty const & p);
  75
  76         friend class Playlist;
  77         /* we live and die with our playlist, no lifetime management needed */
  78         Playlist& _playlist;
  79 };
  80
  81 class LIBARDOUR_API Playlist : public SessionObject , public boost::enable_shared_from_this<Playlist>
  82 {
  83 public:
  84         static void make_property_quarks ();
  85
  86         Playlist (Session&, const XMLNode&, DataType type, bool hidden = false);
  87         Playlist (Session&, std::string name, DataType type, bool hidden = false);
  88         Playlist (boost::shared_ptr<const Playlist>, std::string name, bool hidden = false);
  89         Playlist (boost::shared_ptr<const Playlist>, framepos_t start, framecnt_t cnt, std::string name, bool hidden = false);
  90
  91         virtual ~Playlist ();
  92
  93         void update (const RegionListProperty::ChangeRecord&);
  94         void clear_owned_changes ();
  95         void rdiff (std::vector<Command*>&) const;
  96
  97         boost::shared_ptr<Region> region_by_id (const PBD::ID&) const;
  98
  99         uint32_t max_source_level () const;
 100
 101         void set_region_ownership ();
 102
 103         virtual void clear (bool with_signals=true);
 104         virtual void dump () const;
 105
 106         void use();
 107         void release();
 108         bool used () const { return _refcnt != 0; }
 109
 110         bool set_name (const std::string& str);
 111         int sort_id() { return _sort_id; }
 112
 113         const DataType& data_type() const { return _type; }
 114
 115         bool frozen() const { return _frozen; }
 116         void set_frozen (bool yn);
 117
 118         bool hidden() const { return _hidden; }
 119         bool empty() const;
 120         uint32_t n_regions() const;
 121         bool all_regions_empty() const;
 122         std::pair<framepos_t, framepos_t> get_extent () const;
 123         std::pair<framepos_t, framepos_t> get_extent_with_endspace() const;
 124         layer_t top_layer() const;
 125
 126         EditMode get_edit_mode() const { return _edit_mode; }
 127         void set_edit_mode (EditMode);
 128
 129         /* Editing operations */
 130
 131         void add_region (boost::shared_ptr<Region>, framepos_t position, float times = 1, bool auto_partition = false, const int32_t sub_num = 0);
 132         void remove_region (boost::shared_ptr<Region>);
 133         void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 134         void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 135         void get_source_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 136         void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos);
 137         void split_region (boost::shared_ptr<Region>, framepos_t position, const int32_t sub_num);
 138         void split (framepos_t at, const int32_t sub_num);
 139         void shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue);
 140         void partition (framepos_t start, framepos_t end, bool cut = false);
 141         void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
 142         void duplicate (boost::shared_ptr<Region>, framepos_t position, framecnt_t gap, float times);
 143         void duplicate_until (boost::shared_ptr<Region>, framepos_t position, framecnt_t gap, framepos_t end);
 144         void duplicate_range (AudioRange&, float times);
 145         void duplicate_ranges (std::list<AudioRange>&, float times);
 146         void nudge_after (framepos_t start, framecnt_t distance, bool forwards);
 147         boost::shared_ptr<Region> combine (const RegionList&);
 148         void uncombine (boost::shared_ptr<Region>);
 149         void fade_range (std::list<AudioRange>&);
 150
 151         void shuffle (boost::shared_ptr<Region>, int dir);
 152         void ripple (framepos_t at, framecnt_t distance, RegionList *exclude);
 153         void ripple (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude) {
 154                  RegionList el;
 155                  if (exclude)
 156                          el.push_back (exclude);
 157                  ripple (at, distance, &el);
 158         }
 159
 160         void update_after_tempo_map_change ();
 161
 162         boost::shared_ptr<Playlist> cut  (std::list<AudioRange>&, bool result_is_hidden = true);
 163         boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
 164         int                         paste (boost::shared_ptr<Playlist>, framepos_t position, float times, const int32_t sub_num);
 165
 166         const RegionListProperty& region_list_property () const { return regions; }
 167         boost::shared_ptr<RegionList> region_list();
 168
 169         boost::shared_ptr<RegionList> regions_at (framepos_t frame);
 170         uint32_t                   count_regions_at (framepos_t) const;
 171         boost::shared_ptr<RegionList> regions_touched (framepos_t start, framepos_t end);
 172         boost::shared_ptr<RegionList> regions_with_start_within (Evoral::Range<framepos_t>);
 173         boost::shared_ptr<RegionList> regions_with_end_within (Evoral::Range<framepos_t>);
 174         uint32_t                   region_use_count (boost::shared_ptr<Region>) const;
 175         boost::shared_ptr<Region>  find_region (const PBD::ID&) const;
 176         boost::shared_ptr<Region>  top_region_at (framepos_t frame);
 177         boost::shared_ptr<Region>  top_unmuted_region_at (framepos_t frame);
 178         boost::shared_ptr<Region>  find_next_region (framepos_t frame, RegionPoint point, int dir);
 179         framepos_t                 find_next_region_boundary (framepos_t frame, int dir);
 180         bool                       region_is_shuffle_constrained (boost::shared_ptr<Region>);
 181         bool                       has_region_at (framepos_t const) const;
 182
 183         bool uses_source (boost::shared_ptr<const Source> src, bool shallow = false) const;
 184         void deep_sources (std::set<boost::shared_ptr<Source> >&) const;
 185
 186         framepos_t find_next_transient (framepos_t position, int dir);
 187
 188         void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
 189
 190         XMLNode& get_state ();
 191         virtual int set_state (const XMLNode&, int version);
 192         XMLNode& get_template ();
 193
 194         PBD::Signal1<void,bool> InUse;
 195         PBD::Signal0<void>      ContentsChanged;
 196         PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
 197         PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
 198         PBD::Signal0<void>      NameChanged;
 199         PBD::Signal0<void>      LayeringChanged;
 200
 201         /** Emitted when regions have moved (not when regions have only been trimmed) */
 202         PBD::Signal2<void,std::list< Evoral::RangeMove<framepos_t> > const &, bool> RangesMoved;
 203
 204         /** Emitted when regions are extended; the ranges passed are the new extra time ranges
 205             that these regions now occupy.
 206         */
 207         PBD::Signal1<void,std::list< Evoral::Range<framepos_t> > const &> RegionsExtended;
 208
 209         static std::string bump_name (std::string old_name, Session&);
 210
 211         void freeze ();
 212         void thaw (bool from_undo = false);
 213
 214         void raise_region (boost::shared_ptr<Region>);
 215         void lower_region (boost::shared_ptr<Region>);
 216         void raise_region_to_top (boost::shared_ptr<Region>);
 217         void lower_region_to_bottom (boost::shared_ptr<Region>);
 218
 219         const PBD::ID& get_orig_track_id () const { return _orig_track_id; }
 220         void set_orig_track_id (const PBD::ID& did);
 221
 222         /* destructive editing */
 223
 224         virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
 225
 226         void sync_all_regions_with_regions ();
 227
 228         /* special case function used by UI selection objects, which have playlists that actually own the regions
 229            within them.
 230         */
 231
 232         void drop_regions ();
 233
 234         virtual boost::shared_ptr<Crossfade> find_crossfade (const PBD::ID &) const {
 235                 return boost::shared_ptr<Crossfade> ();
 236         }
 237
 238         framepos_t find_next_top_layer_position (framepos_t) const;
 239         uint32_t combine_ops() const { return _combine_ops; }
 240
 241         void set_layer (boost::shared_ptr<Region>, double);
 242
 243         void set_capture_insertion_in_progress (bool yn);
 244
 245   protected:
 246         friend class Session;
 247
 248   protected:
 249     class RegionReadLock : public Glib::Threads::RWLock::ReaderLock {
 250     public:
 251         RegionReadLock (Playlist *pl) : Glib::Threads::RWLock::ReaderLock (pl->region_lock) {}
 252         ~RegionReadLock() {}
 253     };
 254
 255     class RegionWriteLock : public Glib::Threads::RWLock::WriterLock {
 256     public:
 257             RegionWriteLock (Playlist *pl, bool do_block_notify = true)
 258                     : Glib::Threads::RWLock::WriterLock (pl->region_lock)
 259                     , playlist (pl)
 260                     , block_notify (do_block_notify) {
 261                     if (block_notify) {
 262                             playlist->delay_notifications();
 263                     }
 264             }
 265
 266         ~RegionWriteLock() {
 267                 Glib::Threads::RWLock::WriterLock::release ();
 268                 if (block_notify) {
 269                         playlist->release_notifications ();
 270                 }
 271         }
 272         Playlist *playlist;
 273         bool block_notify;
 274     };
 275
 276         RegionListProperty   regions;  /* the current list of regions in the playlist */
 277         std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
 278         PBD::ScopedConnectionList region_state_changed_connections;
 279         PBD::ScopedConnectionList region_drop_references_connections;
 280         DataType        _type;
 281         int             _sort_id;
 282         mutable gint    block_notifications;
 283         mutable gint    ignore_state_changes;
 284         std::set<boost::shared_ptr<Region> > pending_adds;
 285         std::set<boost::shared_ptr<Region> > pending_removes;
 286         RegionList       pending_bounds;
 287         bool             pending_contents_change;
 288         bool             pending_layering;
 289
 290         /** Movements of time ranges caused by region moves; note that
 291          *  region trims are not included in this list; it is used to
 292          *  do automation-follows-regions.
 293          */
 294         std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
 295         /** Extra sections added to regions during trims */
 296         std::list< Evoral::Range<framepos_t> >     pending_region_extensions;
 297         uint32_t         in_set_state;
 298         bool             in_undo;
 299         bool             first_set_state;
 300         bool            _hidden;
 301         bool            _splicing;
 302         bool            _rippling;
 303         bool            _shuffling;
 304         bool            _nudging;
 305         uint32_t        _refcnt;
 306         EditMode        _edit_mode;
 307         bool             in_flush;
 308         bool             in_partition;
 309         bool            _frozen;
 310         bool            _capture_insertion_underway;
 311         uint32_t         subcnt;
 312         PBD::ID         _orig_track_id;
 313         uint32_t        _combine_ops;
 314
 315         void init (bool hide);
 316
 317         bool holding_state () const {
 318                 return g_atomic_int_get (&block_notifications) != 0 ||
 319                         g_atomic_int_get (&ignore_state_changes) != 0;
 320         }
 321
 322         void delay_notifications ();
 323         void release_notifications (bool from_undo = false);
 324         virtual void flush_notifications (bool from_undo = false);
 325         void clear_pending ();
 326
 327         void _set_sort_id ();
 328
 329         boost::shared_ptr<RegionList> regions_touched_locked (framepos_t start, framepos_t end);
 330
 331         void notify_region_removed (boost::shared_ptr<Region>);
 332         void notify_region_added (boost::shared_ptr<Region>);
 333         void notify_layering_changed ();
 334         void notify_contents_changed ();
 335         void notify_state_changed (const PBD::PropertyChange&);
 336         void notify_region_moved (boost::shared_ptr<Region>);
 337         void notify_region_start_trimmed (boost::shared_ptr<Region>);
 338         void notify_region_end_trimmed (boost::shared_ptr<Region>);
 339
 340         void mark_session_dirty();
 341
 342         void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
 343         virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 344
 345         void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 346         void region_deleted (boost::shared_ptr<Region>);
 347
 348         void sort_regions ();
 349
 350         void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 351         void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 352
 353         void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 354         void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 355         void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 356
 357         void core_ripple (framepos_t at, framecnt_t distance, RegionList *exclude);
 358         void ripple_locked (framepos_t at, framecnt_t distance, RegionList *exclude);
 359         void ripple_unlocked (framepos_t at, framecnt_t distance, RegionList *exclude);
 360
 361
 362         virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
 363         virtual void region_going_away (boost::weak_ptr<Region> /*region*/) {}
 364
 365         virtual XMLNode& state (bool);
 366
 367         bool add_region_internal (boost::shared_ptr<Region>, framepos_t position, const int32_t sub_num = 0);
 368
 369         int remove_region_internal (boost::shared_ptr<Region>);
 370         void copy_regions (RegionList&) const;
 371         void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
 372
 373         std::pair<framepos_t, framepos_t> _get_extent() const;
 374
 375         boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
 376                                               std::list<AudioRange>& ranges, bool result_is_hidden);
 377         boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 378         boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 379
 380         void relayer ();
 381
 382         void begin_undo ();
 383         void end_undo ();
 384
 385         void _split_region (boost::shared_ptr<Region>, framepos_t position, const int32_t sub_num);
 386
 387         typedef std::pair<boost::shared_ptr<Region>, boost::shared_ptr<Region> > TwoRegions;
 388
 389         /* this is called before we create a new compound region */
 390         virtual void pre_combine (std::vector<boost::shared_ptr<Region> >&) {}
 391         /* this is called before we create a new compound region */
 392         virtual void post_combine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
 393         /* this is called before we remove a compound region and replace it
 394            with its constituent regions
 395         */
 396         virtual void pre_uncombine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
 397
 398   private:
 399         friend class RegionReadLock;
 400         friend class RegionWriteLock;
 401         mutable Glib::Threads::RWLock region_lock;
 402
 403   private:
 404         void setup_layering_indices (RegionList const &);
 405         void coalesce_and_check_crossfades (std::list<Evoral::Range<framepos_t> >);
 406         boost::shared_ptr<RegionList> find_regions_at (framepos_t);
 407
 408         framepos_t _end_space;  //this is used when we are pasting a range with extra space at the end
 409 };
 410
 411 } /* namespace ARDOUR */
 412
 413 #endif  /* __ardour_playlist_h__ */
 414
 415