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         typedef std::list<boost::shared_ptr<Region> > RegionList;
  85         static void make_property_quarks ();
  86
  87         Playlist (Session&, const XMLNode&, DataType type, bool hidden = false);
  88         Playlist (Session&, std::string name, DataType type, bool hidden = false);
  89         Playlist (boost::shared_ptr<const Playlist>, std::string name, bool hidden = false);
  90         Playlist (boost::shared_ptr<const Playlist>, framepos_t start, framecnt_t cnt, std::string name, bool hidden = false);
  91
  92         virtual ~Playlist ();
  93
  94         void update (const RegionListProperty::ChangeRecord&);
  95         void clear_owned_changes ();
  96         void rdiff (std::vector<Command*>&) const;
  97
  98         boost::shared_ptr<Region> region_by_id (const PBD::ID&) const;
  99
 100         uint32_t max_source_level () const;
 101
 102         void set_region_ownership ();
 103
 104         virtual void clear (bool with_signals=true);
 105         virtual void dump () const;
 106
 107         void use();
 108         void release();
 109         bool used () const { return _refcnt != 0; }
 110
 111         bool set_name (const std::string& str);
 112         int sort_id() { return _sort_id; }
 113
 114         const DataType& data_type() const { return _type; }
 115
 116         bool frozen() const { return _frozen; }
 117         void set_frozen (bool yn);
 118
 119         bool hidden() const { return _hidden; }
 120         bool empty() const;
 121         uint32_t n_regions() const;
 122         std::pair<framepos_t, framepos_t> get_extent () const;
 123         layer_t top_layer() const;
 124
 125         EditMode get_edit_mode() const { return _edit_mode; }
 126         void set_edit_mode (EditMode);
 127
 128         /* Editing operations */
 129
 130         void add_region (boost::shared_ptr<Region>, framepos_t position, float times = 1, bool auto_partition = false);
 131         void remove_region (boost::shared_ptr<Region>);
 132         void remove_region_by_source (boost::shared_ptr<Source>);
 133         void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 134         void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 135         void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos);
 136         void split_region (boost::shared_ptr<Region>, framepos_t position);
 137         void split (framepos_t at);
 138         void shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue);
 139         void partition (framepos_t start, framepos_t end, bool cut = false);
 140         void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
 141         void nudge_after (framepos_t start, framecnt_t distance, bool forwards);
 142         boost::shared_ptr<Region> combine (const RegionList&);
 143         void uncombine (boost::shared_ptr<Region>);
 144
 145         void shuffle (boost::shared_ptr<Region>, int dir);
 146         void update_after_tempo_map_change ();
 147
 148         boost::shared_ptr<Playlist> cut  (std::list<AudioRange>&, bool result_is_hidden = true);
 149         boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
 150         int                         paste (boost::shared_ptr<Playlist>, framepos_t position, float times);
 151
 152         const RegionListProperty& region_list () const { return regions; }
 153
 154         RegionList*                regions_at (framepos_t frame);
 155         uint32_t                   count_regions_at (framepos_t) const;
 156         uint32_t                   count_joined_regions () const;
 157         RegionList*                regions_touched (framepos_t start, framepos_t end);
 158         RegionList*                regions_to_read (framepos_t start, framepos_t end);
 159         uint32_t                   region_use_count (boost::shared_ptr<Region>) const;
 160         boost::shared_ptr<Region>  find_region (const PBD::ID&) const;
 161         boost::shared_ptr<Region>  top_region_at (framepos_t frame);
 162         boost::shared_ptr<Region>  top_unmuted_region_at (framepos_t frame);
 163         boost::shared_ptr<Region>  find_next_region (framepos_t frame, RegionPoint point, int dir);
 164         framepos_t                 find_next_region_boundary (framepos_t frame, int dir);
 165         bool                       region_is_shuffle_constrained (boost::shared_ptr<Region>);
 166         bool                       has_region_at (framepos_t const) const;
 167
 168         bool uses_source (boost::shared_ptr<const Source> src) const;
 169
 170         framepos_t find_next_transient (framepos_t position, int dir);
 171
 172         void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
 173
 174         XMLNode& get_state ();
 175         int set_state (const XMLNode&, int version);
 176         XMLNode& get_template ();
 177
 178         PBD::Signal1<void,bool> InUse;
 179         PBD::Signal0<void>      ContentsChanged;
 180         PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
 181         PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
 182         PBD::Signal0<void>      NameChanged;
 183         PBD::Signal0<void>      LayeringChanged;
 184
 185         /** Emitted when regions have moved (not when regions have only been trimmed) */
 186         PBD::Signal2<void,std::list< Evoral::RangeMove<framepos_t> > const &, bool> RangesMoved;
 187
 188         /** Emitted when regions are extended; the ranges passed are the new extra time ranges
 189             that these regions now occupy.
 190         */
 191         PBD::Signal1<void,std::list< Evoral::Range<framepos_t> > const &> RegionsExtended;
 192
 193         static std::string bump_name (std::string old_name, Session&);
 194
 195         void freeze ();
 196         void thaw (bool from_undo = false);
 197
 198         void raise_region (boost::shared_ptr<Region>);
 199         void lower_region (boost::shared_ptr<Region>);
 200         void raise_region_to_top (boost::shared_ptr<Region>);
 201         void lower_region_to_bottom (boost::shared_ptr<Region>);
 202
 203         const PBD::ID& get_orig_track_id () const { return _orig_track_id; }
 204         void set_orig_track_id (const PBD::ID& did);
 205
 206         /* destructive editing */
 207
 208         virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
 209
 210         void sync_all_regions_with_regions ();
 211
 212         /* special case function used by UI selection objects, which have playlists that actually own the regions
 213            within them.
 214         */
 215
 216         void drop_regions ();
 217
 218         bool explicit_relayering () const {
 219                 return _explicit_relayering;
 220         }
 221
 222         void set_explicit_relayering (bool e);
 223
 224         virtual boost::shared_ptr<Crossfade> find_crossfade (const PBD::ID &) const {
 225                 return boost::shared_ptr<Crossfade> ();
 226         }
 227
 228         framepos_t find_next_top_layer_position (framepos_t) const;
 229         uint32_t combine_ops() const { return _combine_ops; }
 230
 231   protected:
 232         friend class Session;
 233
 234   protected:
 235         struct RegionLock {
 236                 RegionLock (Playlist *pl, bool do_block_notify = true) : playlist (pl), block_notify (do_block_notify) {
 237                         playlist->region_lock.lock();
 238                         if (block_notify) {
 239                                 playlist->delay_notifications();
 240                         }
 241                 }
 242                 ~RegionLock() {
 243                         playlist->region_lock.unlock();
 244                         if (block_notify) {
 245                                 playlist->release_notifications ();
 246                         }
 247                 }
 248                 Playlist *playlist;
 249                 bool block_notify;
 250         };
 251
 252         friend class RegionLock;
 253
 254         RegionListProperty   regions;  /* the current list of regions in the playlist */
 255         std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
 256         PBD::ScopedConnectionList region_state_changed_connections;
 257         DataType        _type;
 258         int             _sort_id;
 259         mutable gint    block_notifications;
 260         mutable gint    ignore_state_changes;
 261         mutable Glib::RecMutex region_lock;
 262         std::set<boost::shared_ptr<Region> > pending_adds;
 263         std::set<boost::shared_ptr<Region> > pending_removes;
 264         RegionList       pending_bounds;
 265         bool             pending_contents_change;
 266         bool             pending_layering;
 267
 268         /** Movements of time ranges caused by region moves; note that
 269          *  region trims are not included in this list; it is used to
 270          *  do automation-follows-regions.
 271          */
 272         std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
 273         /** Extra sections added to regions during trims */
 274         std::list< Evoral::Range<framepos_t> >     pending_region_extensions;
 275         bool             save_on_thaw;
 276         std::string      last_save_reason;
 277         uint32_t         in_set_state;
 278         bool             in_update;
 279         bool             first_set_state;
 280         bool            _hidden;
 281         bool            _splicing;
 282         bool            _shuffling;
 283         bool            _nudging;
 284         uint32_t        _refcnt;
 285         EditMode        _edit_mode;
 286         bool             in_flush;
 287         bool             in_partition;
 288         bool            _frozen;
 289         uint32_t         subcnt;
 290         PBD::ID         _orig_track_id;
 291         uint64_t         layer_op_counter;
 292         framecnt_t       freeze_length;
 293         bool             auto_partition;
 294         uint32_t        _combine_ops;
 295
 296         /** true if relayering should be done using region's current layers and their `pending explicit relayer'
 297          *  flags; otherwise false if relayering should be done using the layer-model (most recently moved etc.)
 298          *  Explicit relayering is used by tracks in stacked regionview mode.
 299          */
 300         bool            _explicit_relayering;
 301
 302         void init (bool hide);
 303
 304         bool holding_state () const {
 305                 return g_atomic_int_get (&block_notifications) != 0 ||
 306                         g_atomic_int_get (&ignore_state_changes) != 0;
 307         }
 308
 309         void delay_notifications ();
 310         void release_notifications (bool from_undo = false);
 311         virtual void flush_notifications (bool from_undo = false);
 312         void clear_pending ();
 313
 314         void _set_sort_id ();
 315
 316         void notify_region_removed (boost::shared_ptr<Region>);
 317         void notify_region_added (boost::shared_ptr<Region>);
 318         void notify_layering_changed ();
 319         void notify_contents_changed ();
 320         void notify_state_changed (const PBD::PropertyChange&);
 321         void notify_region_moved (boost::shared_ptr<Region>);
 322         void notify_region_start_trimmed (boost::shared_ptr<Region>);
 323         void notify_region_end_trimmed (boost::shared_ptr<Region>);
 324
 325         void mark_session_dirty();
 326
 327         void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
 328         virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 329
 330         void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 331         void region_deleted (boost::shared_ptr<Region>);
 332
 333         void sort_regions ();
 334
 335         void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 336         void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 337
 338         void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 339         void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 340         void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 341
 342         virtual void finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/) {}
 343
 344         virtual void check_dependents (boost::shared_ptr<Region> /*region*/, bool /*norefresh*/) {}
 345         virtual void refresh_dependents (boost::shared_ptr<Region> /*region*/) {}
 346         virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
 347
 348         virtual XMLNode& state (bool);
 349
 350         bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
 351
 352         int remove_region_internal (boost::shared_ptr<Region>);
 353         RegionList *find_regions_at (framepos_t);
 354         void copy_regions (RegionList&) const;
 355         void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
 356
 357         std::pair<framepos_t, framepos_t> _get_extent() const;
 358
 359         boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
 360                                               std::list<AudioRange>& ranges, bool result_is_hidden);
 361         boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 362         boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 363
 364         int move_region_to_layer (layer_t, boost::shared_ptr<Region> r, int dir);
 365         void relayer ();
 366
 367         void begin_undo ();
 368         void end_undo ();
 369         void unset_freeze_parent (Playlist*);
 370         void unset_freeze_child (Playlist*);
 371
 372         void timestamp_layer_op (boost::shared_ptr<Region>);
 373
 374         void _split_region (boost::shared_ptr<Region>, framepos_t position);
 375
 376         typedef std::pair<boost::shared_ptr<Region>, boost::shared_ptr<Region> > TwoRegions;
 377         virtual void copy_dependents (const std::vector<TwoRegions>&, Playlist*) const { }
 378
 379         struct RegionInfo {
 380             boost::shared_ptr<Region> region;
 381             framepos_t position;
 382             framecnt_t length;
 383             framepos_t start;
 384         };
 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
 396 } /* namespace ARDOUR */
 397
 398 #endif  /* __ardour_playlist_h__ */
 399
 400