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