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/types.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);
 132         void remove_region (boost::shared_ptr<Region>);
 133         void remove_region_by_source (boost::shared_ptr<Source>);
 134         void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 135         void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 136         void get_source_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 137         void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos);
 138         void split_region (boost::shared_ptr<Region>, framepos_t position);
 139         void split (framepos_t at);
 140         void shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue);
 141         void partition (framepos_t start, framepos_t end, bool cut = false);
 142         void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
 143         void duplicate (boost::shared_ptr<Region>, framepos_t position, framecnt_t gap, float times);
 144         void nudge_after (framepos_t start, framecnt_t distance, bool forwards);
 145         boost::shared_ptr<Region> combine (const RegionList&);
 146         void uncombine (boost::shared_ptr<Region>);
 147         void fade_range (std::list<AudioRange>&);
 148
 149         void shuffle (boost::shared_ptr<Region>, int dir);
 150         void ripple (framepos_t at, framecnt_t distance, RegionList *exclude);
 151         void ripple (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude) {
 152                  RegionList el;
 153                  if (exclude)
 154                          el.push_back (exclude);
 155                  ripple (at, distance, &el);
 156         }
 157
 158         void update_after_tempo_map_change ();
 159
 160         boost::shared_ptr<Playlist> cut  (std::list<AudioRange>&, bool result_is_hidden = true);
 161         boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
 162         int                         paste (boost::shared_ptr<Playlist>, framepos_t position, float times);
 163
 164         const RegionListProperty& region_list () const { return regions; }
 165
 166         boost::shared_ptr<RegionList> regions_at (framepos_t frame);
 167         uint32_t                   count_regions_at (framepos_t) const;
 168         boost::shared_ptr<RegionList> regions_touched (framepos_t start, framepos_t end);
 169         boost::shared_ptr<RegionList> regions_with_start_within (Evoral::Range<framepos_t>);
 170         boost::shared_ptr<RegionList> regions_with_end_within (Evoral::Range<framepos_t>);
 171         uint32_t                   region_use_count (boost::shared_ptr<Region>) const;
 172         boost::shared_ptr<Region>  find_region (const PBD::ID&) const;
 173         boost::shared_ptr<Region>  top_region_at (framepos_t frame);
 174         boost::shared_ptr<Region>  top_unmuted_region_at (framepos_t frame);
 175         boost::shared_ptr<Region>  find_next_region (framepos_t frame, RegionPoint point, int dir);
 176         framepos_t                 find_next_region_boundary (framepos_t frame, int dir);
 177         bool                       region_is_shuffle_constrained (boost::shared_ptr<Region>);
 178         bool                       has_region_at (framepos_t const) const;
 179
 180         bool uses_source (boost::shared_ptr<const Source> src) const;
 181
 182         framepos_t find_next_transient (framepos_t position, int dir);
 183
 184         void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
 185
 186         XMLNode& get_state ();
 187         virtual int set_state (const XMLNode&, int version);
 188         XMLNode& get_template ();
 189
 190         PBD::Signal1<void,bool> InUse;
 191         PBD::Signal0<void>      ContentsChanged;
 192         PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
 193         PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
 194         PBD::Signal0<void>      NameChanged;
 195         PBD::Signal0<void>      LayeringChanged;
 196
 197         /** Emitted when regions have moved (not when regions have only been trimmed) */
 198         PBD::Signal2<void,std::list< Evoral::RangeMove<framepos_t> > const &, bool> RangesMoved;
 199
 200         /** Emitted when regions are extended; the ranges passed are the new extra time ranges
 201             that these regions now occupy.
 202         */
 203         PBD::Signal1<void,std::list< Evoral::Range<framepos_t> > const &> RegionsExtended;
 204
 205         static std::string bump_name (std::string old_name, Session&);
 206
 207         void freeze ();
 208         void thaw (bool from_undo = false);
 209
 210         void raise_region (boost::shared_ptr<Region>);
 211         void lower_region (boost::shared_ptr<Region>);
 212         void raise_region_to_top (boost::shared_ptr<Region>);
 213         void lower_region_to_bottom (boost::shared_ptr<Region>);
 214
 215         const PBD::ID& get_orig_track_id () const { return _orig_track_id; }
 216         void set_orig_track_id (const PBD::ID& did);
 217
 218         /* destructive editing */
 219
 220         virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
 221
 222         void sync_all_regions_with_regions ();
 223
 224         /* special case function used by UI selection objects, which have playlists that actually own the regions
 225            within them.
 226         */
 227
 228         void drop_regions ();
 229
 230         virtual boost::shared_ptr<Crossfade> find_crossfade (const PBD::ID &) const {
 231                 return boost::shared_ptr<Crossfade> ();
 232         }
 233
 234         framepos_t find_next_top_layer_position (framepos_t) const;
 235         uint32_t combine_ops() const { return _combine_ops; }
 236
 237         void set_layer (boost::shared_ptr<Region>, double);
 238
 239         void set_capture_insertion_in_progress (bool yn);
 240
 241   protected:
 242         friend class Session;
 243
 244   protected:
 245     class RegionReadLock : public Glib::Threads::RWLock::ReaderLock {
 246     public:
 247         RegionReadLock (Playlist *pl) : Glib::Threads::RWLock::ReaderLock (pl->region_lock) {}
 248         ~RegionReadLock() {}
 249     };
 250
 251     class RegionWriteLock : public Glib::Threads::RWLock::WriterLock {
 252     public:
 253             RegionWriteLock (Playlist *pl, bool do_block_notify = true)
 254                     : Glib::Threads::RWLock::WriterLock (pl->region_lock)
 255                     , playlist (pl)
 256                     , block_notify (do_block_notify) {
 257                     if (block_notify) {
 258                             playlist->delay_notifications();
 259                     }
 260             }
 261
 262         ~RegionWriteLock() {
 263                 Glib::Threads::RWLock::WriterLock::release ();
 264                 if (block_notify) {
 265                         playlist->release_notifications ();
 266                 }
 267         }
 268         Playlist *playlist;
 269         bool block_notify;
 270     };
 271
 272         RegionListProperty   regions;  /* the current list of regions in the playlist */
 273         std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
 274         PBD::ScopedConnectionList region_state_changed_connections;
 275         DataType        _type;
 276         int             _sort_id;
 277         mutable gint    block_notifications;
 278         mutable gint    ignore_state_changes;
 279         std::set<boost::shared_ptr<Region> > pending_adds;
 280         std::set<boost::shared_ptr<Region> > pending_removes;
 281         RegionList       pending_bounds;
 282         bool             pending_contents_change;
 283         bool             pending_layering;
 284
 285         /** Movements of time ranges caused by region moves; note that
 286          *  region trims are not included in this list; it is used to
 287          *  do automation-follows-regions.
 288          */
 289         std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
 290         /** Extra sections added to regions during trims */
 291         std::list< Evoral::Range<framepos_t> >     pending_region_extensions;
 292         uint32_t         in_set_state;
 293         bool             in_undo;
 294         bool             first_set_state;
 295         bool            _hidden;
 296         bool            _splicing;
 297         bool            _rippling;
 298         bool            _shuffling;
 299         bool            _nudging;
 300         uint32_t        _refcnt;
 301         EditMode        _edit_mode;
 302         bool             in_flush;
 303         bool             in_partition;
 304         bool            _frozen;
 305         bool            _capture_insertion_underway;
 306         uint32_t         subcnt;
 307         PBD::ID         _orig_track_id;
 308         uint32_t        _combine_ops;
 309
 310         void init (bool hide);
 311
 312         bool holding_state () const {
 313                 return g_atomic_int_get (&block_notifications) != 0 ||
 314                         g_atomic_int_get (&ignore_state_changes) != 0;
 315         }
 316
 317         void delay_notifications ();
 318         void release_notifications (bool from_undo = false);
 319         virtual void flush_notifications (bool from_undo = false);
 320         void clear_pending ();
 321
 322         void _set_sort_id ();
 323
 324         boost::shared_ptr<RegionList> regions_touched_locked (framepos_t start, framepos_t end);
 325
 326         void notify_region_removed (boost::shared_ptr<Region>);
 327         void notify_region_added (boost::shared_ptr<Region>);
 328         void notify_layering_changed ();
 329         void notify_contents_changed ();
 330         void notify_state_changed (const PBD::PropertyChange&);
 331         void notify_region_moved (boost::shared_ptr<Region>);
 332         void notify_region_start_trimmed (boost::shared_ptr<Region>);
 333         void notify_region_end_trimmed (boost::shared_ptr<Region>);
 334
 335         void mark_session_dirty();
 336
 337         void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
 338         virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 339
 340         void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 341         void region_deleted (boost::shared_ptr<Region>);
 342
 343         void sort_regions ();
 344
 345         void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 346         void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 347
 348         void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 349         void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 350         void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 351
 352         void core_ripple (framepos_t at, framecnt_t distance, RegionList *exclude);
 353         void ripple_locked (framepos_t at, framecnt_t distance, RegionList *exclude);
 354         void ripple_unlocked (framepos_t at, framecnt_t distance, RegionList *exclude);
 355
 356
 357         virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
 358
 359         virtual XMLNode& state (bool);
 360
 361         bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
 362
 363         int remove_region_internal (boost::shared_ptr<Region>);
 364         void copy_regions (RegionList&) const;
 365         void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
 366
 367         std::pair<framepos_t, framepos_t> _get_extent() const;
 368
 369         boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
 370                                               std::list<AudioRange>& ranges, bool result_is_hidden);
 371         boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 372         boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 373
 374         void relayer ();
 375
 376         void begin_undo ();
 377         void end_undo ();
 378
 379         void _split_region (boost::shared_ptr<Region>, framepos_t position);
 380
 381         typedef std::pair<boost::shared_ptr<Region>, boost::shared_ptr<Region> > TwoRegions;
 382
 383         /* this is called before we create a new compound region */
 384         virtual void pre_combine (std::vector<boost::shared_ptr<Region> >&) {}
 385         /* this is called before we create a new compound region */
 386         virtual void post_combine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
 387         /* this is called before we remove a compound region and replace it
 388            with its constituent regions
 389         */
 390         virtual void pre_uncombine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
 391
 392   private:
 393         friend class RegionReadLock;
 394         friend class RegionWriteLock;
 395         mutable Glib::Threads::RWLock region_lock;
 396
 397   private:
 398         void setup_layering_indices (RegionList const &);
 399         void coalesce_and_check_crossfades (std::list<Evoral::Range<framepos_t> >);
 400         boost::shared_ptr<RegionList> find_regions_at (framepos_t);
 401
 402         framepos_t _end_space;  //this is used when we are pasting a range with extra space at the end
 403 };
 404
 405 } /* namespace ARDOUR */
 406
 407 #endif  /* __ardour_playlist_h__ */
 408
 409