libs/ardour/ardour/location.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_location_h__
  21 #define __ardour_location_h__
  22
  23 #include <string>
  24 #include <list>
  25 #include <iostream>
  26 #include <map>
  27
  28 #include <sys/types.h>
  29
  30 #include <glibmm/thread.h>
  31
  32 #include "pbd/undo.h"
  33 #include "pbd/stateful.h"
  34 #include "pbd/statefuldestructible.h"
  35
  36 #include "ardour/ardour.h"
  37
  38 namespace ARDOUR {
  39
  40 class Location : public PBD::StatefulDestructible
  41 {
  42   public:
  43         enum Flags {
  44                 IsMark = 0x1,
  45                 IsAutoPunch = 0x2,
  46                 IsAutoLoop = 0x4,
  47                 IsHidden = 0x8,
  48                 IsCDMarker = 0x10,
  49                 IsRangeMarker = 0x20,
  50                 IsSessionRange = 0x40
  51         };
  52
  53         Location (nframes64_t sample_start,
  54                         nframes64_t sample_end,
  55                         const std::string &name,
  56                         Flags bits = Flags(0))
  57
  58                 : _name (name),
  59                 _start (sample_start),
  60                 _end (sample_end),
  61                 _flags (bits),
  62                 _locked (false) { }
  63
  64         Location () {
  65                 _start = 0;
  66                 _end = 0;
  67                 _flags = Flags (0);
  68                 _locked = false;
  69         }
  70
  71         Location (const Location& other);
  72         Location (const XMLNode&);
  73         Location* operator= (const Location& other);
  74
  75         bool locked() const { return _locked; }
  76         void lock() { _locked = true; changed (this); }
  77         void unlock() { _locked = false; changed (this); }
  78
  79         nframes64_t start() const  { return _start; }
  80         nframes64_t end() const { return _end; }
  81         nframes64_t length() const { return _end - _start; }
  82
  83         int set_start (nframes64_t s, bool force = false);
  84         int set_end (nframes64_t e, bool force = false);
  85         int set (nframes64_t start, nframes64_t end);
  86
  87         int move_to (nframes64_t pos);
  88
  89         const std::string& name() const { return _name; }
  90         void set_name (const std::string &str) { _name = str; name_changed(this); }
  91
  92         void set_auto_punch (bool yn, void *src);
  93         void set_auto_loop (bool yn, void *src);
  94         void set_hidden (bool yn, void *src);
  95         void set_cd (bool yn, void *src);
  96         void set_is_range_marker (bool yn, void* src);
  97
  98         bool is_auto_punch () const { return _flags & IsAutoPunch; }
  99         bool is_auto_loop () const { return _flags & IsAutoLoop; }
 100         bool is_mark () const { return _flags & IsMark; }
 101         bool is_hidden () const { return _flags & IsHidden; }
 102         bool is_cd_marker () const { return _flags & IsCDMarker; }
 103         bool is_session_range () const { return _flags & IsSessionRange; }
 104         bool is_range_marker() const { return _flags & IsRangeMarker; }
 105         bool matches (Flags f) const { return _flags & f; }
 106
 107         Flags flags () const { return _flags; }
 108
 109         PBD::Signal1<void,Location*> name_changed;
 110         PBD::Signal1<void,Location*> end_changed;
 111         PBD::Signal1<void,Location*> start_changed;
 112
 113         PBD::Signal2<void,Location*,void*> FlagsChanged;
 114
 115         /* this is sent only when both start&end change at the same time */
 116
 117         PBD::Signal1<void,Location*> changed;
 118
 119         /* CD Track / CD-Text info */
 120
 121         std::map<std::string, std::string> cd_info;
 122         XMLNode& cd_info_node (const std::string &, const std::string &);
 123
 124         XMLNode& get_state (void);
 125         int set_state (const XMLNode&, int version);
 126
 127   private:
 128         std::string   _name;
 129         nframes64_t   _start;
 130         nframes64_t   _end;
 131         Flags         _flags;
 132         bool          _locked;
 133
 134         void set_mark (bool yn);
 135         bool set_flag_internal (bool yn, Flags flag);
 136 };
 137
 138 class Locations : public PBD::StatefulDestructible
 139 {
 140   public:
 141         typedef std::list<Location *> LocationList;
 142
 143         Locations ();
 144         ~Locations ();
 145
 146         const LocationList& list() { return locations; }
 147
 148         void add (Location *, bool make_current = false);
 149         void remove (Location *);
 150         void clear ();
 151         void clear_markers ();
 152         void clear_ranges ();
 153
 154         XMLNode& get_state (void);
 155         int set_state (const XMLNode&, int version);
 156         Location *get_location_by_id(PBD::ID);
 157
 158         Location* auto_loop_location () const;
 159         Location* auto_punch_location () const;
 160         Location* session_range_location() const;
 161
 162         int next_available_name(std::string& result,std::string base);
 163         uint32_t num_range_markers() const;
 164
 165         int set_current (Location *, bool want_lock = true);
 166         Location *current () const { return current_location; }
 167
 168         Location* first_location_before (nframes64_t, bool include_special_ranges = false);
 169         Location* first_location_after (nframes64_t, bool include_special_ranges = false);
 170
 171         void marks_either_side (nframes64_t const, nframes64_t &, nframes64_t &) const;
 172
 173         void find_all_between (nframes64_t start, nframes64_t, LocationList&, Location::Flags);
 174
 175         enum Change {
 176                 ADDITION, ///< a location was added, but nothing else changed
 177                 REMOVAL, ///< a location was removed, but nothing else changed
 178                 OTHER ///< something more complicated happened
 179         };
 180
 181         PBD::Signal1<void,Location*> current_changed;
 182         /** something changed about the location list; the parameter gives some idea as to what */
 183         PBD::Signal1<void,Change>    changed;
 184         /** a location has been added to the end of the list */
 185         PBD::Signal1<void,Location*> added;
 186         PBD::Signal1<void,Location*> removed;
 187         PBD::Signal1<void,const PBD::PropertyChange&>    StateChanged;
 188
 189         template<class T> void apply (T& obj, void (T::*method)(LocationList&)) {
 190                 Glib::Mutex::Lock lm (lock);
 191                 (obj.*method)(locations);
 192         }
 193
 194         template<class T1, class T2> void apply (T1& obj, void (T1::*method)(LocationList&, T2& arg), T2& arg) {
 195                 Glib::Mutex::Lock lm (lock);
 196                 (obj.*method)(locations, arg);
 197         }
 198
 199   private:
 200
 201         LocationList         locations;
 202         Location            *current_location;
 203         mutable Glib::Mutex  lock;
 204
 205         int set_current_unlocked (Location *);
 206         void location_changed (Location*);
 207 };
 208
 209 } // namespace ARDOUR
 210
 211 #endif /* __ardour_location_h__ */