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         void set_region_ownership ();
 101
 102         virtual void clear (bool with_signals=true);
 103         virtual void dump () const;
 104
 105         void use();
 106         void release();
 107         bool used () const { return _refcnt != 0; }
 108
 109         bool set_name (const std::string& str);
 110         int sort_id() { return _sort_id; }
 111
 112         const DataType& data_type() const { return _type; }
 113
 114         bool frozen() const { return _frozen; }
 115         void set_frozen (bool yn);
 116
 117         bool hidden() const { return _hidden; }
 118         bool empty() const;
 119         uint32_t n_regions() const;
 120         std::pair<framepos_t, framepos_t> get_extent () const;
 121         layer_t top_layer() const;
 122
 123         EditMode get_edit_mode() const { return _edit_mode; }
 124         void set_edit_mode (EditMode);
 125
 126         /* Editing operations */
 127
 128         void add_region (boost::shared_ptr<Region>, framepos_t position, float times = 1, bool auto_partition = false);
 129         void remove_region (boost::shared_ptr<Region>);
 130         void remove_region_by_source (boost::shared_ptr<Source>);
 131         void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 132         void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
 133         void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, framepos_t pos);
 134         void split_region (boost::shared_ptr<Region>, framepos_t position);
 135         void split (framepos_t at);
 136         void shift (framepos_t at, frameoffset_t distance, bool move_intersected, bool ignore_music_glue);
 137         void partition (framepos_t start, framepos_t end, bool cut = false);
 138         void duplicate (boost::shared_ptr<Region>, framepos_t position, float times);
 139         void nudge_after (framepos_t start, framecnt_t distance, bool forwards);
 140         void shuffle (boost::shared_ptr<Region>, int dir);
 141         void update_after_tempo_map_change ();
 142
 143         boost::shared_ptr<Playlist> cut  (std::list<AudioRange>&, bool result_is_hidden = true);
 144         boost::shared_ptr<Playlist> copy (std::list<AudioRange>&, bool result_is_hidden = true);
 145         int                         paste (boost::shared_ptr<Playlist>, framepos_t position, float times);
 146
 147         const RegionListProperty& region_list () const { return regions; }
 148
 149         RegionList*                regions_at (framepos_t frame);
 150         uint32_t                   count_regions_at (framepos_t);
 151         RegionList*                regions_touched (framepos_t start, framepos_t end);
 152         RegionList*                regions_to_read (framepos_t start, framepos_t end);
 153         uint32_t                   region_use_count (boost::shared_ptr<Region>) const;
 154         boost::shared_ptr<Region>  find_region (const PBD::ID&) const;
 155         boost::shared_ptr<Region>  top_region_at (framepos_t frame);
 156         boost::shared_ptr<Region>  top_unmuted_region_at (framepos_t frame);
 157         boost::shared_ptr<Region>  find_next_region (framepos_t frame, RegionPoint point, int dir);
 158         framepos_t                 find_next_region_boundary (framepos_t frame, int dir);
 159         bool                       region_is_shuffle_constrained (boost::shared_ptr<Region>);
 160         bool                       has_region_at (framepos_t const) const;
 161
 162         bool uses_source (boost::shared_ptr<const Source> src) const;
 163
 164         framepos_t find_next_transient (framepos_t position, int dir);
 165
 166         void foreach_region (boost::function<void (boost::shared_ptr<Region>)>);
 167
 168         XMLNode& get_state ();
 169         int set_state (const XMLNode&, int version);
 170         XMLNode& get_template ();
 171
 172         PBD::Signal1<void,bool> InUse;
 173         PBD::Signal0<void>      ContentsChanged;
 174         PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
 175         PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
 176         PBD::Signal0<void>      NameChanged;
 177         PBD::Signal0<void>      LengthChanged;
 178         PBD::Signal0<void>      LayeringChanged;
 179
 180         /** Emitted when regions have moved (not when regions have only been trimmed) */
 181         PBD::Signal2<void,std::list< Evoral::RangeMove<framepos_t> > const &, bool> RangesMoved;
 182
 183         /** Emitted when regions are extended; the ranges passed are the new extra time ranges
 184             that these regions now occupy.
 185         */
 186         PBD::Signal1<void,std::list< Evoral::Range<framepos_t> > const &> RegionsExtended;
 187
 188         static std::string bump_name (std::string old_name, Session&);
 189
 190         void freeze ();
 191         void thaw (bool from_undo = false);
 192
 193         void raise_region (boost::shared_ptr<Region>);
 194         void lower_region (boost::shared_ptr<Region>);
 195         void raise_region_to_top (boost::shared_ptr<Region>);
 196         void lower_region_to_bottom (boost::shared_ptr<Region>);
 197
 198         uint32_t read_data_count() const { return _read_data_count; }
 199
 200         /* XXX: use of diskstream here is a little unfortunate */
 201         const PBD::ID& get_orig_diskstream_id () const { return _orig_diskstream_id; }
 202         void set_orig_diskstream_id (const PBD::ID& did) { _orig_diskstream_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         bool explicit_relayering () const {
 217                 return _explicit_relayering;
 218         }
 219
 220         void set_explicit_relayering (bool e);
 221
 222         virtual boost::shared_ptr<Crossfade> find_crossfade (const PBD::ID &) const {
 223                 return boost::shared_ptr<Crossfade> ();
 224         }
 225
 226         framepos_t find_next_top_layer_position (framepos_t) const;
 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         bool             pending_length;
 265
 266         /** Movements of time ranges caused by region moves; note that
 267          *  region trims are not included in this list; it is used to
 268          *  do automation-follows-regions.
 269          */
 270         std::list< Evoral::RangeMove<framepos_t> > pending_range_moves;
 271         /** Extra sections added to regions during trims */
 272         std::list< Evoral::Range<framepos_t> >     pending_region_extensions;
 273         bool             save_on_thaw;
 274         std::string      last_save_reason;
 275         uint32_t         in_set_state;
 276         bool             in_update;
 277         bool             first_set_state;
 278         bool            _hidden;
 279         bool            _splicing;
 280         bool            _shuffling;
 281         bool            _nudging;
 282         uint32_t        _refcnt;
 283         EditMode        _edit_mode;
 284         bool             in_flush;
 285         bool             in_partition;
 286         bool            _frozen;
 287         uint32_t         subcnt;
 288         uint32_t        _read_data_count;
 289         PBD::ID         _orig_diskstream_id;
 290         uint64_t         layer_op_counter;
 291         framecnt_t       freeze_length;
 292         bool             auto_partition;
 293
 294         /** true if relayering should be done using region's current layers and their `pending explicit relayer'
 295          *  flags; otherwise false if relayering should be done using the layer-model (most recently moved etc.)
 296          *  Explicit relayering is used by tracks in stacked regionview mode.
 297          */
 298         bool            _explicit_relayering;
 299
 300         void init (bool hide);
 301
 302         bool holding_state () const {
 303                 return g_atomic_int_get (&block_notifications) != 0 ||
 304                         g_atomic_int_get (&ignore_state_changes) != 0;
 305         }
 306
 307         void delay_notifications ();
 308         void release_notifications (bool from_undo = false);
 309         virtual void flush_notifications (bool from_undo = false);
 310         void clear_pending ();
 311
 312         void _set_sort_id ();
 313
 314         void notify_region_removed (boost::shared_ptr<Region>);
 315         void notify_region_added (boost::shared_ptr<Region>);
 316         void notify_length_changed ();
 317         void notify_layering_changed ();
 318         void notify_contents_changed ();
 319         void notify_state_changed (const PBD::PropertyChange&);
 320         void notify_region_moved (boost::shared_ptr<Region>);
 321         void notify_region_start_trimmed (boost::shared_ptr<Region>);
 322         void notify_region_end_trimmed (boost::shared_ptr<Region>);
 323
 324         void mark_session_dirty();
 325
 326         void region_changed_proxy (const PBD::PropertyChange&, boost::weak_ptr<Region>);
 327         virtual bool region_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 328
 329         void region_bounds_changed (const PBD::PropertyChange&, boost::shared_ptr<Region>);
 330         void region_deleted (boost::shared_ptr<Region>);
 331
 332         void sort_regions ();
 333
 334         void possibly_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 335         void possibly_splice_unlocked(framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude = boost::shared_ptr<Region>());
 336
 337         void core_splice (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 338         void splice_locked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 339         void splice_unlocked (framepos_t at, framecnt_t distance, boost::shared_ptr<Region> exclude);
 340
 341         virtual void finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/) {}
 342
 343         virtual void check_dependents (boost::shared_ptr<Region> /*region*/, bool /*norefresh*/) {}
 344         virtual void refresh_dependents (boost::shared_ptr<Region> /*region*/) {}
 345         virtual void remove_dependents (boost::shared_ptr<Region> /*region*/) {}
 346
 347         virtual XMLNode& state (bool);
 348
 349         bool add_region_internal (boost::shared_ptr<Region>, framepos_t position);
 350
 351         int remove_region_internal (boost::shared_ptr<Region>);
 352         RegionList *find_regions_at (framepos_t);
 353         void copy_regions (RegionList&) const;
 354         void partition_internal (framepos_t start, framepos_t end, bool cutting, RegionList& thawlist);
 355
 356         std::pair<framepos_t, framepos_t> _get_extent() const;
 357
 358         boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(framepos_t, framecnt_t, bool),
 359                                               std::list<AudioRange>& ranges, bool result_is_hidden);
 360         boost::shared_ptr<Playlist> cut (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 361         boost::shared_ptr<Playlist> copy (framepos_t start, framecnt_t cnt, bool result_is_hidden);
 362
 363         int move_region_to_layer (layer_t, boost::shared_ptr<Region> r, int dir);
 364         void relayer ();
 365
 366         void begin_undo ();
 367         void end_undo ();
 368         void unset_freeze_parent (Playlist*);
 369         void unset_freeze_child (Playlist*);
 370
 371         void timestamp_layer_op (boost::shared_ptr<Region>);
 372
 373         void _split_region (boost::shared_ptr<Region>, framepos_t position);
 374 };
 375
 376 } /* namespace ARDOUR */
 377
 378 #endif  /* __ardour_playlist_h__ */
 379
 380