libs/evoral/evoral/ControlSet.hpp

   1 /* This file is part of Evoral.
   2  * Copyright (C) 2008 David Robillard <http://drobilla.net>
   3  * Copyright (C) 2000-2008 Paul Davis
   4  *
   5  * Evoral is free software; you can redistribute it and/or modify it under the
   6  * terms of the GNU General Public License as published by the Free Software
   7  * Foundation; either version 2 of the License, or (at your option) any later
   8  * version.
   9  *
  10  * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
  11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef EVORAL_CONTROLLABLE_HPP
  20 #define EVORAL_CONTROLLABLE_HPP
  21
  22 #include <set>
  23 #include <map>
  24 #include <boost/shared_ptr.hpp>
  25 #include <boost/utility.hpp>
  26 #include <glibmm/threads.h>
  27 #include "pbd/signals.h"
  28
  29 #include "evoral/visibility.h"
  30 #include "evoral/types.hpp"
  31 #include "evoral/Parameter.hpp"
  32 #include "evoral/ControlList.hpp"
  33
  34 namespace Evoral {
  35
  36 class Control;
  37 class ControlEvent;
  38
  39 class LIBEVORAL_API ControlSet : public boost::noncopyable {
  40 public:
  41         ControlSet();
  42         ControlSet (const ControlSet&);
  43         virtual ~ControlSet() {}
  44
  45         virtual boost::shared_ptr<Evoral::Control>
  46         control_factory(const Evoral::Parameter& id) = 0;
  47
  48         boost::shared_ptr<Control>
  49         control (const Parameter& id, bool create_if_missing=false);
  50
  51         inline boost::shared_ptr<const Control>
  52         control (const Parameter& id) const {
  53                 const Controls::const_iterator i = _controls.find(id);
  54                 return (i != _controls.end() ? i->second : boost::shared_ptr<Control>());
  55         }
  56
  57         typedef std::map< Parameter, boost::shared_ptr<Control> > Controls;
  58         inline Controls&       controls()       { return _controls; }
  59         inline const Controls& controls() const { return _controls; }
  60
  61         virtual void add_control(boost::shared_ptr<Control>);
  62
  63         virtual bool find_next_event(double start, double end, ControlEvent& ev, bool only_active = true) const = 0;
  64
  65         virtual bool controls_empty() const { return _controls.size() == 0; }
  66         virtual void clear_controls();
  67
  68         void what_has_data(std::set<Parameter>&) const;
  69
  70         Glib::Threads::Mutex& control_lock() const { return _control_lock; }
  71
  72 protected:
  73         virtual void control_list_marked_dirty () {}
  74         virtual void control_list_interpolation_changed (Parameter, ControlList::InterpolationStyle) {}
  75
  76         mutable Glib::Threads::Mutex _control_lock;
  77         Controls            _controls;
  78
  79         PBD::ScopedConnectionList _list_connections;
  80
  81 private:
  82
  83         PBD::ScopedConnectionList _control_connections;
  84 };
  85
  86
  87 } // namespace Evoral
  88
  89 #endif // EVORAL_CONTROLLABLE_HPP