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         boost::shared_ptr<RegionList> regions_touched (framepos_t start, framepos_t end);
 156         boost::shared_ptr<RegionList> regions_to_read (framepos_t start, framepos_t end);
 157         uint32_t                   region_use_count (boost::shared_ptr<Region>) const;
 158         boost::shared_ptr<Region>  find_region (const PBD::ID&) const;
 159         boost::shared_ptr<Region>  top_region_at (framepos_t frame);
 160         boost::shared_ptr<Region>  top_unmuted_region_at (framepos_t frame);
 161         boost::shared_ptr<Region>  find_next_region (framepos_t frame, RegionPoint point, int dir);
 162         framepos_t                 find_next_region_boundary (framepos_t frame, int dir);
 163         bool                       region_is_shuffle_constrained (boost::shared_ptr<Region>);
 164         bool                       has_region_at (framepos_t const) const;
 165
 166         bool uses_source (boost::shared_ptr<const Source> src) const;
 167
 168         framepos_t find_next_transient (framepos_t position, int dir);
 169
 170         void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
 171
 172         XMLNode& get_state ();
 173         int set_state (const XMLNode&, int version);
 174         XMLNode& get_template ();
 175
 176         PBD::Signal1<void,bool> InUse;
 177         PBD::Signal0<void>      ContentsChanged;
 178         PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
 179         PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
 180         PBD::Signal0<void>      NameChanged;
 181         PBD::Signal0<void>      LayeringChanged;
 182
 183         /** Emitted when regions have moved (not when regions have only been trimmed) */
 184         PBD::Signal2<void,std::list< Evoral::RangeMove<framepos_t> > const &, bool> RangesMoved;
 185
 186         /** Emitted when regions are extended; the ranges passed are the new extra time ranges
 187             that these regions now occupy.
 188         */
 189         PBD::Signal1<void,std::list< Evoral::Range<framepos_t> > const &> RegionsExtended;
 190
 191         static std::string bump_name (std::string old_name, Session&);
 192
 193         void freeze ();
 194         void thaw (bool from_undo = false);
 195
 196         void raise_region (boost::shared_ptr<Region>);
 197         void lower_region (boost::shared_ptr<Region>);
 198         void raise_region_to_top (boost::shared_ptr<Region>);
 199         void lower_region_to_bottom (boost::shared_ptr<Region>);
 200
 201         const PBD::ID& get_orig_track_id () const { return _orig_track_id; }
 202         void set_orig_track_id (const PBD::ID& did);
 203
 204         /* destructive editing */
 205
 206         virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
 207
 208         void sync_all_regions_with_regions ();
 209
 210         /* special case function used by UI selection objects, which have playlists that actually own the regions
 211            within them.
 212         */
 213
 214         void drop_regions ();
 215
 216         virtual boost::shared_ptr<Crossfade> find_crossfade (const PBD::ID &) const {
 217                 return boost::shared_ptr<Crossfade> ();
 218         }
 219
 220         framepos_t find_next_top_layer_position (framepos_t) const;
 221         uint32_t combine_ops() const { return _combine_ops; }
 222
 223         void set_layer (boost::shared_ptr<Region>, double);
 224
 225   protected:
 226         friend class Session;
 227
 228   protected:
 229         struct RegionLock {
 230                 RegionLock (Playlist *pl, bool do_block_notify = true) : playlist (pl), block_notify (do_block_notify) {
 231                         playlist->region_lock.lock();
 232                         if (block_notify) {
 233                                 playlist->delay_notifications();
 234                         }
 235                 }
 236                 ~RegionLock() {
 237                         playlist->region_lock.unlock();
 238                         if (block_notify) {
 239                                 playlist->release_notifications ();
 240                         }
 241                 }
 242                 Playlist *playlist;
 243                 bool block_notify;
 244         };
 245
 246         friend class RegionLock;
 247
 248         RegionListProperty   regions;  /* the current list of regions in the playlist */
 249         std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
 250         PBD::ScopedConnectionList region_state_changed_connections;
 251         DataType        _type;
 252         int             _sort_id;
 253         mutable gint    block_notifications;
 254         mutable gint    ignore_state_changes;
 255         mutable Glib::RecMutex region_lock;
 256         std::set<boost::shared_ptr<Region> > pending_adds;
 257         std::set<boost::shared_ptr<Region> > pending_removes;
 258         RegionList       pending_bounds;
 259         bool             pending_contents_change;
 260         bool             pending_layering;
 261
 262         /** Movements of time ranges caused by region moves; note that
 263          *  region trims are not included in this list; it is used to
 264          *  do automation-follows-regions.
 265          */
 266         std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
 267         /** Extra sections added to regions during trims */
 268         std::list< Evoral::Range<framepos_t> >     pending_region_extensions;
 269         uint32_t         in_set_state;
 270         bool             in_undo;
 271         bool             first_set_state;
 272         bool            _hidden;
 273         bool            _splicing;
 274         bool            _shuffling;
 275         bool            _nudging;
 276         uint32_t        _refcnt;
 277         EditMode        _edit_mode;
 278         bool             in_flush;
 279         bool             in_partition;
 280         bool            _frozen;
 281         uint32_t         subcnt;
 282         PBD::ID         _orig_track_id;
 283         uint32_t        _combine_ops;
 284
 285         void init (bool hide);
 286
 287         bool holding_state () const {
 288                 return g_atomic_int_get (&block_notifications) != 0 ||
 289                         g_atomic_int_get (&ignore_state_changes) != 0;
 290         }
 291
 292         void delay_notifications ();
 293         void release_notifications (bool from_undo = false);
 294         virtual void flush_notifications (bool from_undo = false);
 295         void clear_pending ();
 296
 297         void _set_sort_id ();
 298
 299         void notify_region_removed (boost::shared_ptr<Region>);
 300         void notify_region_added (boost::shared_ptr<Region>);
 301         void notify_layering_changed ();
 302         void notify_contents_changed ();
 303         void notify_state_changed (const PBD::PropertyChange&);
 304         void notify_region_moved (boost::shared_ptr<Region>);
 305         void notify_region_start_trimmed (boost::shared_ptr<Region>);
 306         void notify_region_end_trimmed (boost::shared_ptr<Region>);
 307
 308         void mark_session_dirty();
 309
 310         void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
 311         virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 312
 313         void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 314         void region_deleted (boost::shared_ptr<Region>);
 315
 316         void sort_regions ();
 317
 318         void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 319         void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 320
 321         void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 322         void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 323         void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 324
 325         virtual void finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/) {}
 326
 327         virtual void check_dependents (boost::shared_ptr<Region> /*region*/, bool /*norefresh*/) {}
 328         virtual void refresh_dependents (boost::shared_ptr<Region> /*region*/) {}
 329         virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
 330
 331         virtual XMLNode& state (bool);
 332
 333         bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
 334
 335         int remove_region_internal (boost::shared_ptr<Region>);
 336         void copy_regions (RegionList&) const;
 337         void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
 338
 339         std::pair<framepos_t, framepos_t> _get_extent() const;
 340
 341         boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
 342                                               std::list<AudioRange>& ranges, bool result_is_hidden);
 343         boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 344         boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 345
 346         void relayer ();
 347
 348         void begin_undo ();
 349         void end_undo ();
 350
 351         void _split_region (boost::shared_ptr<Region>, framepos_t position);
 352
 353         typedef std::pair<boost::shared_ptr<Region>, boost::shared_ptr<Region> > TwoRegions;
 354         virtual void copy_dependents (const std::vector<TwoRegions>&, Playlist*) const { }
 355
 356         struct RegionInfo {
 357             boost::shared_ptr<Region> region;
 358             framepos_t position;
 359             framecnt_t length;
 360             framepos_t start;
 361         };
 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
 374         void setup_layering_indices (RegionList const &) const;
 375         boost::shared_ptr<RegionList> find_regions_at (framepos_t);
 376 };
 377
 378 } /* namespace ARDOUR */
 379
 380 #endif  /* __ardour_playlist_h__ */
 381
 382