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