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 #ifdef HAVE_GLIB_THREADS_RECMUTEX
  35 #include <glibmm/threads.h>
  36 #endif
  37
  38 #include "pbd/undo.h"
  39 #include "pbd/stateful.h"
  40 #include "pbd/statefuldestructible.h"
  41 #include "pbd/sequence_property.h"
  42 #include "pbd/stacktrace.h"
  43
  44 #include "evoral/types.hpp"
  45
  46 #include "ardour/ardour.h"
  47 #include "ardour/session_object.h"
  48 #include "ardour/data_type.h"
  49
  50 namespace ARDOUR  {
  51
  52 class Session;
  53 class Region;
  54 class Playlist;
  55 class Crossfade;
  56
  57 namespace Properties {
  58         /* fake the type, since regions are handled by SequenceProperty which doesn't
  59            care about such things.
  60         */
  61         extern PBD::PropertyDescriptor<bool> regions;
  62 }
  63
  64 class RegionListProperty : public PBD::SequenceProperty<std::list<boost::shared_ptr<Region> > >
  65 {
  66   public:
  67         RegionListProperty (Playlist&);
  68
  69         RegionListProperty* clone () const;
  70         void get_content_as_xml (boost::shared_ptr<Region>, XMLNode &) const;
  71         boost::shared_ptr<Region> get_content_from_xml (XMLNode const &) const;
  72
  73   private:
  74         RegionListProperty* create () const;
  75
  76         /* copy construction only by ourselves */
  77         RegionListProperty (RegionListProperty const & p);
  78
  79         friend class Playlist;
  80         /* we live and die with our playlist, no lifetime management needed */
  81         Playlist& _playlist;
  82 };
  83
  84 class Playlist : public SessionObject , public boost::enable_shared_from_this<Playlist>
  85 {
  86 public:
  87         static void make_property_quarks ();
  88
  89         Playlist (Session&, const XMLNode&, DataType type, bool hidden = false);
  90         Playlist (Session&, std::string name, DataType type, bool hidden = false);
  91         Playlist (boost::shared_ptr<const Playlist>, std::string name, bool hidden = false);
  92         Playlist (boost::shared_ptr<const Playlist>, framepos_t start, framecnt_t cnt, std::string name, bool hidden = false);
  93
  94         virtual ~Playlist ();
  95
  96         void update (const RegionListProperty::ChangeRecord&);
  97         void clear_owned_changes ();
  98         void rdiff (std::vector<Command*>&) const;
  99
 100         boost::shared_ptr<Region> region_by_id (const PBD::ID&) const;
 101
 102         uint32_t max_source_level () const;
 103
 104         void set_region_ownership ();
 105
 106         virtual void clear (bool with_signals=true);
 107         virtual void dump () const;
 108
 109         void use();
 110         void release();
 111         bool used () const { return _refcnt != 0; }
 112
 113         bool set_name (const std::string& str);
 114         int sort_id() { return _sort_id; }
 115
 116         const DataType& data_type() const { return _type; }
 117
 118         bool frozen() const { return _frozen; }
 119         void set_frozen (bool yn);
 120
 121         bool hidden() const { return _hidden; }
 122         bool empty() const;
 123         uint32_t n_regions() const;
 124         std::pair<framepos_t, framepos_t> get_extent () const;
 125         layer_t top_layer() const;
 126
 127         EditMode get_edit_mode() const { return _edit_mode; }
 128         void set_edit_mode (EditMode);
 129
 130         /* Editing operations */
 131
 132         void add_region (boost::shared_ptr<Region>, framepos_t position, float times = 1, bool auto_partition = false);
 133         void remove_region (boost::shared_ptr<Region>);
 134         void remove_region_by_source (boost::shared_ptr<Source>);
 135         void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 136         void get_region_list_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 nudge_after (framepos_t start, framecnt_t distance, bool forwards);
 144         boost::shared_ptr<Region> combine (const RegionList&);
 145         void uncombine (boost::shared_ptr<Region>);
 146
 147         void shuffle (boost::shared_ptr<Region>, int dir);
 148         void update_after_tempo_map_change ();
 149
 150         boost::shared_ptr<Playlist> cut  (std::list<AudioRange>&, bool result_is_hidden = true);
 151         boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
 152         int                         paste (boost::shared_ptr<Playlist>, framepos_t position, float times);
 153
 154         const RegionListProperty& region_list () const { return regions; }
 155
 156         boost::shared_ptr<RegionList> regions_at (framepos_t frame);
 157         uint32_t                   count_regions_at (framepos_t) const;
 158         boost::shared_ptr<RegionList> regions_touched (framepos_t start, framepos_t end);
 159         boost::shared_ptr<RegionList> regions_with_start_within (Evoral::Range<framepos_t>);
 160         boost::shared_ptr<RegionList> regions_with_end_within (Evoral::Range<framepos_t>);
 161         uint32_t                   region_use_count (boost::shared_ptr<Region>) const;
 162         boost::shared_ptr<Region>  find_region (const PBD::ID&) const;
 163         boost::shared_ptr<Region>  top_region_at (framepos_t frame);
 164         boost::shared_ptr<Region>  top_unmuted_region_at (framepos_t frame);
 165         boost::shared_ptr<Region>  find_next_region (framepos_t frame, RegionPoint point, int dir);
 166         framepos_t                 find_next_region_boundary (framepos_t frame, int dir);
 167         bool                       region_is_shuffle_constrained (boost::shared_ptr<Region>);
 168         bool                       has_region_at (framepos_t const) const;
 169
 170         bool uses_source (boost::shared_ptr<const Source> src) const;
 171
 172         framepos_t find_next_transient (framepos_t position, int dir);
 173
 174         void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
 175
 176         XMLNode& get_state ();
 177         virtual int set_state (const XMLNode&, int version);
 178         XMLNode& get_template ();
 179
 180         PBD::Signal1<void,bool> InUse;
 181         PBD::Signal0<void>      ContentsChanged;
 182         PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
 183         PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
 184         PBD::Signal0<void>      NameChanged;
 185         PBD::Signal0<void>      LayeringChanged;
 186
 187         /** Emitted when regions have moved (not when regions have only been trimmed) */
 188         PBD::Signal2<void,std::list< Evoral::RangeMove<framepos_t> > const &, bool> RangesMoved;
 189
 190         /** Emitted when regions are extended; the ranges passed are the new extra time ranges
 191             that these regions now occupy.
 192         */
 193         PBD::Signal1<void,std::list< Evoral::Range<framepos_t> > const &> RegionsExtended;
 194
 195         static std::string bump_name (std::string old_name, Session&);
 196
 197         void freeze ();
 198         void thaw (bool from_undo = false);
 199
 200         void raise_region (boost::shared_ptr<Region>);
 201         void lower_region (boost::shared_ptr<Region>);
 202         void raise_region_to_top (boost::shared_ptr<Region>);
 203         void lower_region_to_bottom (boost::shared_ptr<Region>);
 204
 205         const PBD::ID& get_orig_track_id () const { return _orig_track_id; }
 206         void set_orig_track_id (const PBD::ID& did);
 207
 208         /* destructive editing */
 209
 210         virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
 211
 212         void sync_all_regions_with_regions ();
 213
 214         /* special case function used by UI selection objects, which have playlists that actually own the regions
 215            within them.
 216         */
 217
 218         void drop_regions ();
 219
 220         virtual boost::shared_ptr<Crossfade> find_crossfade (const PBD::ID &) const {
 221                 return boost::shared_ptr<Crossfade> ();
 222         }
 223
 224         framepos_t find_next_top_layer_position (framepos_t) const;
 225         uint32_t combine_ops() const { return _combine_ops; }
 226
 227         void set_layer (boost::shared_ptr<Region>, double);
 228
 229   protected:
 230         friend class Session;
 231
 232   protected:
 233     struct RegionReadLock : public Glib::RWLock::ReaderLock {
 234         RegionReadLock (Playlist *pl) : Glib::RWLock::ReaderLock (pl->region_lock) {}
 235         ~RegionReadLock() {}
 236     };
 237
 238     struct RegionWriteLock : public Glib::RWLock::WriterLock {
 239             RegionWriteLock (Playlist *pl, bool do_block_notify = true)
 240                     : Glib::RWLock::WriterLock (pl->region_lock)
 241                     , playlist (pl)
 242                     , block_notify (do_block_notify) {
 243                     if (block_notify) {
 244                             playlist->delay_notifications();
 245                     }
 246             }
 247
 248         ~RegionWriteLock() {
 249                 Glib::RWLock::WriterLock::release ();
 250                 if (block_notify) {
 251                         playlist->release_notifications ();
 252                 }
 253         }
 254         Playlist *playlist;
 255         bool block_notify;
 256     };
 257
 258         RegionListProperty   regions;  /* the current list of regions in the playlist */
 259         std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
 260         PBD::ScopedConnectionList region_state_changed_connections;
 261         DataType        _type;
 262         int             _sort_id;
 263         mutable gint    block_notifications;
 264         mutable gint    ignore_state_changes;
 265         std::set<boost::shared_ptr<Region> > pending_adds;
 266         std::set<boost::shared_ptr<Region> > pending_removes;
 267         RegionList       pending_bounds;
 268         bool             pending_contents_change;
 269         bool             pending_layering;
 270
 271         /** Movements of time ranges caused by region moves; note that
 272          *  region trims are not included in this list; it is used to
 273          *  do automation-follows-regions.
 274          */
 275         std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
 276         /** Extra sections added to regions during trims */
 277         std::list< Evoral::Range<framepos_t> >     pending_region_extensions;
 278         uint32_t         in_set_state;
 279         bool             in_undo;
 280         bool             first_set_state;
 281         bool            _hidden;
 282         bool            _splicing;
 283         bool            _shuffling;
 284         bool            _nudging;
 285         uint32_t        _refcnt;
 286         EditMode        _edit_mode;
 287         bool             in_flush;
 288         bool             in_partition;
 289         bool            _frozen;
 290         uint32_t         subcnt;
 291         PBD::ID         _orig_track_id;
 292         uint32_t        _combine_ops;
 293
 294         void init (bool hide);
 295
 296         bool holding_state () const {
 297                 return g_atomic_int_get (&block_notifications) != 0 ||
 298                         g_atomic_int_get (&ignore_state_changes) != 0;
 299         }
 300
 301         void delay_notifications ();
 302         void release_notifications (bool from_undo = false);
 303         virtual void flush_notifications (bool from_undo = false);
 304         void clear_pending ();
 305
 306         void _set_sort_id ();
 307
 308         boost::shared_ptr<RegionList> regions_touched_locked (framepos_t start, framepos_t end);
 309
 310         void notify_region_removed (boost::shared_ptr<Region>);
 311         void notify_region_added (boost::shared_ptr<Region>);
 312         void notify_layering_changed ();
 313         void notify_contents_changed ();
 314         void notify_state_changed (const PBD::PropertyChange&);
 315         void notify_region_moved (boost::shared_ptr<Region>);
 316         void notify_region_start_trimmed (boost::shared_ptr<Region>);
 317         void notify_region_end_trimmed (boost::shared_ptr<Region>);
 318
 319         void mark_session_dirty();
 320
 321         void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
 322         virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 323
 324         void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 325         void region_deleted (boost::shared_ptr<Region>);
 326
 327         void sort_regions ();
 328
 329         void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 330         void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 331
 332         void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 333         void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 334         void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 335
 336         virtual void check_crossfades (Evoral::Range<framepos_t>) {}
 337         virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
 338
 339         virtual XMLNode& state (bool);
 340
 341         bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
 342
 343         int remove_region_internal (boost::shared_ptr<Region>);
 344         void copy_regions (RegionList&) const;
 345         void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
 346
 347         std::pair<framepos_t, framepos_t> _get_extent() const;
 348
 349         boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
 350                                               std::list<AudioRange>& ranges, bool result_is_hidden);
 351         boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 352         boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 353
 354         void relayer ();
 355
 356         void begin_undo ();
 357         void end_undo ();
 358
 359         void _split_region (boost::shared_ptr<Region>, framepos_t position);
 360
 361         typedef std::pair<boost::shared_ptr<Region>, boost::shared_ptr<Region> > TwoRegions;
 362
 363         /* this is called before we create a new compound region */
 364         virtual void pre_combine (std::vector<boost::shared_ptr<Region> >&) {}
 365         /* this is called before we create a new compound region */
 366         virtual void post_combine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
 367         /* this is called before we remove a compound region and replace it
 368            with its constituent regions
 369         */
 370         virtual void pre_uncombine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
 371
 372   private:
 373         friend class RegionReadLock;
 374         friend class RegionWriteLock;
 375         mutable Glib::RWLock region_lock;
 376
 377   private:
 378         void setup_layering_indices (RegionList const &);
 379         void coalesce_and_check_crossfades (std::list<Evoral::Range<framepos_t> >);
 380         boost::shared_ptr<RegionList> find_regions_at (framepos_t);
 381 };
 382
 383 } /* namespace ARDOUR */
 384
 385 #endif  /* __ardour_playlist_h__ */
 386
 387