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