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
  30 #include <sys/stat.h>
  31
  32 #include <glib.h>
  33
  34 #include <sigc++/signal.h>
  35
  36 #include <pbd/undo.h>
  37 #include <pbd/stateful.h>
  38 #include <pbd/statefuldestructible.h>
  39
  40 #include <ardour/ardour.h>
  41 #include <ardour/crossfade_compare.h>
  42 #include <ardour/location.h>
  43 #include <ardour/data_type.h>
  44
  45 namespace ARDOUR  {
  46
  47 class Session;
  48 class Region;
  49
  50 class Playlist : public PBD::StatefulDestructible, public boost::enable_shared_from_this<Playlist> {
  51   public:
  52         typedef list<boost::shared_ptr<Region> >    RegionList;
  53
  54         Playlist (Session&, const XMLNode&, DataType type, bool hidden = false);
  55         Playlist (Session&, string name, DataType type, bool hidden = false);
  56         Playlist (boost::shared_ptr<const Playlist>, string name, bool hidden = false);
  57         Playlist (boost::shared_ptr<const Playlist>, nframes_t start, nframes_t cnt, string name, bool hidden = false);
  58
  59         virtual ~Playlist ();
  60
  61         void set_region_ownership ();
  62
  63         virtual void clear (bool with_signals=true);
  64         virtual void dump () const;
  65
  66         void use();
  67         void release();
  68         bool used () const { return _refcnt != 0; }
  69
  70         std::string name() const { return _name; }
  71         void set_name (std::string str);
  72
  73         const DataType& data_type() const { return _type; }
  74
  75         bool frozen() const { return _frozen; }
  76         void set_frozen (bool yn);
  77
  78         bool hidden() const { return _hidden; }
  79         bool empty() const;
  80         uint32_t n_regions() const;
  81         nframes_t get_maximum_extent () const;
  82         layer_t top_layer() const;
  83
  84         EditMode get_edit_mode() const { return _edit_mode; }
  85         void set_edit_mode (EditMode);
  86
  87         /* Editing operations */
  88
  89         void add_region (boost::shared_ptr<Region>, nframes_t position, float times = 1);
  90         void remove_region (boost::shared_ptr<Region>);
  91         void get_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
  92         void get_region_list_equivalent_regions (boost::shared_ptr<Region>, std::vector<boost::shared_ptr<Region> >&);
  93         void replace_region (boost::shared_ptr<Region> old, boost::shared_ptr<Region> newr, nframes_t pos);
  94         void split_region (boost::shared_ptr<Region>, nframes_t position);
  95         void partition (nframes_t start, nframes_t end, bool just_top_level);
  96         void duplicate (boost::shared_ptr<Region>, nframes_t position, float times);
  97         void nudge_after (nframes_t start, nframes_t distance, bool forwards);
  98
  99         boost::shared_ptr<Playlist> cut  (list<AudioRange>&, bool result_is_hidden = true);
 100         boost::shared_ptr<Playlist> copy (list<AudioRange>&, bool result_is_hidden = true);
 101         int                         paste (boost::shared_ptr<Playlist>, nframes_t position, float times);
 102
 103         RegionList*                regions_at (nframes_t frame);
 104         RegionList*                regions_touched (nframes_t start, nframes_t end);
 105         boost::shared_ptr<Region>  find_region (const PBD::ID&) const;
 106         boost::shared_ptr<Region>  top_region_at (nframes_t frame);
 107         boost::shared_ptr<Region>  find_next_region (nframes_t frame, RegionPoint point, int dir);
 108
 109         template<class T> void foreach_region (T *t, void (T::*func)(boost::shared_ptr<Region>, void *), void *arg);
 110         template<class T> void foreach_region (T *t, void (T::*func)(boost::shared_ptr<Region>));
 111
 112         XMLNode& get_state ();
 113         int set_state (const XMLNode&);
 114         XMLNode& get_template ();
 115
 116         sigc::signal<void,bool> InUse;
 117         sigc::signal<void>      Modified;
 118         sigc::signal<void>      NameChanged;
 119         sigc::signal<void>      LengthChanged;
 120         sigc::signal<void>      LayeringChanged;
 121
 122         static string bump_name (string old_name, Session&);
 123         static string bump_name_once (string old_name);
 124
 125         void freeze ();
 126         void thaw ();
 127
 128         void raise_region (boost::shared_ptr<Region>);
 129         void lower_region (boost::shared_ptr<Region>);
 130         void raise_region_to_top (boost::shared_ptr<Region>);
 131         void lower_region_to_bottom (boost::shared_ptr<Region>);
 132
 133         uint32_t read_data_count() const { return _read_data_count; }
 134
 135         Session& session() { return _session; }
 136
 137         const PBD::ID& get_orig_diskstream_id () const { return _orig_diskstream_id; }
 138         void set_orig_diskstream_id (const PBD::ID& did) { _orig_diskstream_id = did; }
 139
 140         /* destructive editing */
 141
 142         virtual bool destroy_region (boost::shared_ptr<Region>) = 0;
 143
 144         /* special case function used by UI selection objects, which have playlists that actually own the regions
 145            within them.
 146         */
 147
 148         void drop_regions ();
 149
 150   protected:
 151         friend class Session;
 152
 153   protected:
 154         struct RegionLock {
 155             RegionLock (Playlist *pl, bool do_block_notify = true) : playlist (pl), block_notify (do_block_notify) {
 156                     playlist->region_lock.lock();
 157                     if (block_notify) {
 158                             playlist->delay_notifications();
 159                     }
 160             }
 161             ~RegionLock() {
 162                     playlist->region_lock.unlock();
 163                     if (block_notify) {
 164                             playlist->release_notifications ();
 165                     }
 166             }
 167             Playlist *playlist;
 168             bool block_notify;
 169         };
 170
 171         friend class RegionLock;
 172
 173         RegionList       regions;  /* the current list of regions in the playlist */
 174         std::set<boost::shared_ptr<Region> > all_regions; /* all regions ever added to this playlist */
 175         string          _name;
 176         Session&        _session;
 177         DataType        _type;
 178         mutable gint    block_notifications;
 179         mutable gint    ignore_state_changes;
 180         mutable Glib::Mutex region_lock;
 181         std::set<boost::shared_ptr<Region> > pending_adds;
 182         std::set<boost::shared_ptr<Region> > pending_removes;
 183         RegionList       pending_bounds;
 184         bool             pending_modified;
 185         bool             pending_length;
 186         bool             save_on_thaw;
 187         string           last_save_reason;
 188         uint32_t         in_set_state;
 189         bool             first_set_state;
 190         bool            _hidden;
 191         bool            _splicing;
 192         bool            _nudging;
 193         uint32_t        _refcnt;
 194         EditMode        _edit_mode;
 195         bool             in_flush;
 196         bool             in_partition;
 197         bool            _frozen;
 198         uint32_t         subcnt;
 199         uint32_t        _read_data_count;
 200         PBD::ID         _orig_diskstream_id;
 201         uint64_t         layer_op_counter;
 202         nframes_t   freeze_length;
 203
 204         void init (bool hide);
 205
 206         bool holding_state () const {
 207                 return g_atomic_int_get (&block_notifications) != 0 ||
 208                         g_atomic_int_get (&ignore_state_changes) != 0;
 209         }
 210
 211         /* prevent the compiler from ever generating these */
 212
 213         Playlist (const Playlist&);
 214         Playlist (Playlist&);
 215
 216         void delay_notifications ();
 217         void release_notifications ();
 218         virtual void flush_notifications ();
 219
 220         void notify_region_removed (boost::shared_ptr<Region>);
 221         void notify_region_added (boost::shared_ptr<Region>);
 222         void notify_length_changed ();
 223         void notify_layering_changed ();
 224         void notify_modified ();
 225         void notify_state_changed (Change);
 226
 227         void mark_session_dirty();
 228
 229         void region_changed_proxy (Change, boost::weak_ptr<Region>);
 230         virtual bool region_changed (Change, boost::shared_ptr<Region>);
 231
 232         void region_bounds_changed (Change, boost::shared_ptr<Region>);
 233         void region_deleted (boost::shared_ptr<Region>);
 234
 235         void sort_regions ();
 236
 237         void possibly_splice ();
 238         void possibly_splice_unlocked();
 239         void core_splice ();
 240         void splice_locked ();
 241         void splice_unlocked ();
 242
 243
 244         virtual void finalize_split_region (boost::shared_ptr<Region> original, boost::shared_ptr<Region> left, boost::shared_ptr<Region> right) {}
 245
 246         virtual void check_dependents (boost::shared_ptr<Region> region, bool norefresh) {}
 247         virtual void refresh_dependents (boost::shared_ptr<Region> region) {}
 248         virtual void remove_dependents (boost::shared_ptr<Region> region) {}
 249
 250         virtual XMLNode& state (bool);
 251
 252         boost::shared_ptr<Region> region_by_id (PBD::ID);
 253
 254         void add_region_internal (boost::shared_ptr<Region>, nframes_t position);
 255
 256         int remove_region_internal (boost::shared_ptr<Region>);
 257         RegionList *find_regions_at (nframes_t frame);
 258         void copy_regions (RegionList&) const;
 259         void partition_internal (nframes_t start, nframes_t end, bool cutting, RegionList& thawlist);
 260
 261         nframes_t _get_maximum_extent() const;
 262
 263         boost::shared_ptr<Playlist> cut_copy (boost::shared_ptr<Playlist> (Playlist::*pmf)(nframes_t, nframes_t, bool),
 264                                               list<AudioRange>& ranges, bool result_is_hidden);
 265         boost::shared_ptr<Playlist> cut (nframes_t start, nframes_t cnt, bool result_is_hidden);
 266         boost::shared_ptr<Playlist> copy (nframes_t start, nframes_t cnt, bool result_is_hidden);
 267
 268
 269         int move_region_to_layer (layer_t, boost::shared_ptr<Region> r, int dir);
 270         void relayer ();
 271
 272         void unset_freeze_parent (Playlist*);
 273         void unset_freeze_child (Playlist*);
 274
 275         void timestamp_layer_op (boost::shared_ptr<Region>);
 276 };
 277
 278 } /* namespace ARDOUR */
 279
 280 #endif  /* __ardour_playlist_h__ */
 281
 282