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