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
  36 #include "pbd/undo.h"
  37 #include "pbd/stateful.h"
  38 #include "pbd/statefuldestructible.h"
  39 #include "pbd/sequence_property.h"
  40
  41 #include "evoral/types.hpp"
  42
  43 #include "ardour/ardour.h"
  44 #include "ardour/session_object.h"
  45 #include "ardour/data_type.h"
  46
  47 namespace ARDOUR  {
  48
  49 class Session;
  50 class Region;
  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         extern PBD::PropertyDescriptor<bool> regions;
  59 }
  60
  61 class 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 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         std::pair<framepos_t, framepos_t> get_extent () const;
 122         layer_t top_layer() const;
 123
 124         EditMode get_edit_mode() const { return _edit_mode; }
 125         void set_edit_mode (EditMode);
 126
 127         /* Editing operations */
 128
 129         void add_region (boost::shared_ptr<Region>, framepos_t position, float times = 1, bool auto_partition = false);
 130         void remove_region (boost::shared_ptr<Region>);
 131         void remove_region_by_source (boost::shared_ptr<Source>);
 132         void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 133         void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 134         void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos);
 135         void split_region (boost::shared_ptr<Region>, framepos_t position);
 136         void split (framepos_t at);
 137         void shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue);
 138         void partition (framepos_t start, framepos_t end, bool cut = false);
 139         void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
 140         void nudge_after (framepos_t start, framecnt_t distance, bool forwards);
 141         boost::shared_ptr<Region> combine (const RegionList&);
 142         void uncombine (boost::shared_ptr<Region>);
 143
 144         void shuffle (boost::shared_ptr<Region>, int dir);
 145         void update_after_tempo_map_change ();
 146
 147         boost::shared_ptr<Playlist> cut  (std::list<AudioRange>&, bool result_is_hidden = true);
 148         boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
 149         int                         paste (boost::shared_ptr<Playlist>, framepos_t position, float times);
 150
 151         const RegionListProperty& region_list () const { return regions; }
 152
 153         boost::shared_ptr<RegionList> regions_at (framepos_t frame);
 154         uint32_t                   count_regions_at (framepos_t) const;
 155         uint32_t                   count_joined_regions () const;
 156         boost::shared_ptr<RegionList> regions_touched (framepos_t start, framepos_t end);
 157         boost::shared_ptr<RegionList> regions_to_read (framepos_t start, framepos_t end);
 158         uint32_t                   region_use_count (boost::shared_ptr<Region>) const;
 159         boost::shared_ptr<Region>  find_region (const PBD::ID&) const;
 160         boost::shared_ptr<Region>  top_region_at (framepos_t frame);
 161         boost::shared_ptr<Region>  top_unmuted_region_at (framepos_t frame);
 162         boost::shared_ptr<Region>  find_next_region (framepos_t frame, RegionPoint point, int dir);
 163         framepos_t                 find_next_region_boundary (framepos_t frame, int dir);
 164         bool                       region_is_shuffle_constrained (boost::shared_ptr<Region>);
 165         bool                       has_region_at (framepos_t const) const;
 166
 167         bool uses_source (boost::shared_ptr<const Source> src) const;
 168
 169         framepos_t find_next_transient (framepos_t position, int dir);
 170
 171         void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
 172
 173         XMLNode& get_state ();
 174         int set_state (const XMLNode&, int version);
 175         XMLNode& get_template ();
 176
 177         PBD::Signal1<void,bool> InUse;
 178         PBD::Signal0<void>      ContentsChanged;
 179         PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
 180         PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
 181         PBD::Signal0<void>      NameChanged;
 182         PBD::Signal0<void>      LayeringChanged;
 183
 184         /** Emitted when regions have moved (not when regions have only been trimmed) */
 185         PBD::Signal2<void,std::list< Evoral::RangeMove<framepos_t> > const &, bool> RangesMoved;
 186
 187         /** Emitted when regions are extended; the ranges passed are the new extra time ranges
 188             that these regions now occupy.
 189         */
 190         PBD::Signal1<void,std::list< Evoral::Range<framepos_t> > const &> RegionsExtended;
 191
 192         static std::string bump_name (std::string old_name, Session&);
 193
 194         void freeze ();
 195         void thaw (bool from_undo = false);
 196
 197         void raise_region (boost::shared_ptr<Region>);
 198         void lower_region (boost::shared_ptr<Region>);
 199         void raise_region_to_top (boost::shared_ptr<Region>);
 200         void lower_region_to_bottom (boost::shared_ptr<Region>);
 201
 202         const PBD::ID& get_orig_track_id () const { return _orig_track_id; }
 203         void set_orig_track_id (const PBD::ID& did);
 204
 205         /* destructive editing */
 206
 207         virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
 208
 209         void sync_all_regions_with_regions ();
 210
 211         /* special case function used by UI selection objects, which have playlists that actually own the regions
 212            within them.
 213         */
 214
 215         void drop_regions ();
 216
 217         virtual boost::shared_ptr<Crossfade> find_crossfade (const PBD::ID &) const {
 218                 return boost::shared_ptr<Crossfade> ();
 219         }
 220
 221         framepos_t find_next_top_layer_position (framepos_t) const;
 222         uint32_t combine_ops() const { return _combine_ops; }
 223
 224         uint64_t highest_layering_index () const;
 225
 226         void set_layer (boost::shared_ptr<Region>, double);
 227
 228   protected:
 229         friend class Session;
 230
 231   protected:
 232         struct RegionLock {
 233                 RegionLock (Playlist *pl, bool do_block_notify = true) : playlist (pl), block_notify (do_block_notify) {
 234                         playlist->region_lock.lock();
 235                         if (block_notify) {
 236                                 playlist->delay_notifications();
 237                         }
 238                 }
 239                 ~RegionLock() {
 240                         playlist->region_lock.unlock();
 241                         if (block_notify) {
 242                                 playlist->release_notifications ();
 243                         }
 244                 }
 245                 Playlist *playlist;
 246                 bool block_notify;
 247         };
 248
 249         friend class RegionLock;
 250
 251         RegionListProperty   regions;  /* the current list of regions in the playlist */
 252         std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
 253         PBD::ScopedConnectionList region_state_changed_connections;
 254         DataType        _type;
 255         int             _sort_id;
 256         mutable gint    block_notifications;
 257         mutable gint    ignore_state_changes;
 258         mutable Glib::RecMutex region_lock;
 259         std::set<boost::shared_ptr<Region> > pending_adds;
 260         std::set<boost::shared_ptr<Region> > pending_removes;
 261         RegionList       pending_bounds;
 262         bool             pending_contents_change;
 263         bool             pending_layering;
 264
 265         /** Movements of time ranges caused by region moves; note that
 266          *  region trims are not included in this list; it is used to
 267          *  do automation-follows-regions.
 268          */
 269         std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
 270         /** Extra sections added to regions during trims */
 271         std::list< Evoral::Range<framepos_t> >     pending_region_extensions;
 272         bool             save_on_thaw;
 273         std::string      last_save_reason;
 274         uint32_t         in_set_state;
 275         bool             in_undo;
 276         bool             first_set_state;
 277         bool            _hidden;
 278         bool            _splicing;
 279         bool            _shuffling;
 280         bool            _nudging;
 281         uint32_t        _refcnt;
 282         EditMode        _edit_mode;
 283         bool             in_flush;
 284         bool             in_partition;
 285         bool            _frozen;
 286         uint32_t         subcnt;
 287         PBD::ID         _orig_track_id;
 288         bool             auto_partition;
 289         uint32_t        _combine_ops;
 290
 291         void init (bool hide);
 292
 293         bool holding_state () const {
 294                 return g_atomic_int_get (&block_notifications) != 0 ||
 295                         g_atomic_int_get (&ignore_state_changes) != 0;
 296         }
 297
 298         void delay_notifications ();
 299         void release_notifications (bool from_undo = false);
 300         virtual void flush_notifications (bool from_undo = false);
 301         void clear_pending ();
 302
 303         void _set_sort_id ();
 304
 305         void notify_region_removed (boost::shared_ptr<Region>);
 306         void notify_region_added (boost::shared_ptr<Region>);
 307         void notify_layering_changed ();
 308         void notify_contents_changed ();
 309         void notify_state_changed (const PBD::PropertyChange&);
 310         void notify_region_moved (boost::shared_ptr<Region>);
 311         void notify_region_start_trimmed (boost::shared_ptr<Region>);
 312         void notify_region_end_trimmed (boost::shared_ptr<Region>);
 313
 314         void mark_session_dirty();
 315
 316         void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
 317         virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 318
 319         void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 320         void region_deleted (boost::shared_ptr<Region>);
 321
 322         void sort_regions ();
 323
 324         void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 325         void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 326
 327         void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 328         void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 329         void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 330
 331         virtual void finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/) {}
 332
 333         virtual void check_dependents (boost::shared_ptr<Region> /*region*/, bool /*norefresh*/) {}
 334         virtual void refresh_dependents (boost::shared_ptr<Region> /*region*/) {}
 335         virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
 336
 337         virtual XMLNode& state (bool);
 338
 339         bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
 340
 341         int remove_region_internal (boost::shared_ptr<Region>);
 342         void copy_regions (RegionList&) const;
 343         void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
 344
 345         std::pair<framepos_t, framepos_t> _get_extent() const;
 346
 347         boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
 348                                               std::list<AudioRange>& ranges, bool result_is_hidden);
 349         boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 350         boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 351
 352         void relayer ();
 353
 354         void begin_undo ();
 355         void end_undo ();
 356         void unset_freeze_parent (Playlist*);
 357         void unset_freeze_child (Playlist*);
 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         virtual void copy_dependents (const std::vector<TwoRegions>&, Playlist*) const { }
 363
 364         struct RegionInfo {
 365             boost::shared_ptr<Region> region;
 366             framepos_t position;
 367             framecnt_t length;
 368             framepos_t start;
 369         };
 370
 371         /* this is called before we create a new compound region */
 372         virtual void pre_combine (std::vector<boost::shared_ptr<Region> >&) {}
 373         /* this is called before we create a new compound region */
 374         virtual void post_combine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
 375         /* this is called before we remove a compound region and replace it
 376            with its constituent regions
 377         */
 378         virtual void pre_uncombine (std::vector<boost::shared_ptr<Region> >&, boost::shared_ptr<Region>) {}
 379
 380 private:
 381
 382         void setup_layering_indices (RegionList const &) const;
 383         boost::shared_ptr<RegionList> find_regions_at (framepos_t);
 384 };
 385
 386 } /* namespace ARDOUR */
 387
 388 #endif  /* __ardour_playlist_h__ */
 389
 390