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