X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fpbd%2Fpbd%2Fcontrollable.h;h=d9cd21d28dc24e3a455f2d8801793686b2fed9b9;hb=a1a8794dadc0ab972f441481594b53117df1ca92;hp=c46e477b6ecd1fda518a3a879b59c5684fcc3c56;hpb=26843b34fdd62e6f80630868c5eb3f8fee0c17f1;p=ardour.git diff --git a/libs/pbd/pbd/controllable.h b/libs/pbd/pbd/controllable.h index c46e477b6e..d9cd21d28d 100644 --- a/libs/pbd/pbd/controllable.h +++ b/libs/pbd/pbd/controllable.h @@ -1,44 +1,126 @@ +/* + Copyright (C) 2000-2007 Paul Davis + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +*/ + #ifndef __pbd_controllable_h__ #define __pbd_controllable_h__ -#include -#include +#include +#include +#include + +#include "pbd/signals.h" +#include -#include -#include +#include "pbd/statefuldestructible.h" class XMLNode; namespace PBD { -class Controllable : public virtual sigc::trackable, public Stateful { +class Controllable : public PBD::StatefulDestructible { public: - Controllable (); - virtual ~Controllable() { GoingAway (this); } + enum Flag { + Toggle = 0x1, + GainLike = 0x2, + }; + + Controllable (const std::string& name, Flag f = Flag (0)); + virtual ~Controllable() { Destroyed (this); } + + /* We express Controllable values in one of three ways: + * 1. `user' --- as presented to the user (e.g. dB, Hz, etc.) + * 2. `interface' --- as used in some cases for the UI representation + * (in order to make controls behave logarithmically). + * 3. `internal' --- as passed to a processor, track, plugin, or whatever. + * + * Note that in some cases user and processor may be the same + * (and interface different) e.g. frequency, which is presented + * to the user and passed to the processor in linear terms, but + * which needs log scaling in the interface. + * + * In other cases, user and interface may be the same (and processor different) + * e.g. gain, which is presented to the user in log terms (dB) + * but passed to the processor as a linear quantity. + */ + + /** Set `internal' value */ + virtual void set_value (double) = 0; + /** @return `internal' value */ + virtual double get_value (void) const = 0; + + PBD::Signal0 LearningFinished; + static PBD::Signal3 CreateBinding; + static PBD::Signal1 DeleteBinding; + + static PBD::Signal1 StartLearning; + static PBD::Signal1 StopLearning; + + static PBD::Signal1 Destroyed; + + PBD::Signal0 Changed; + + int set_state (const XMLNode&, int version); + XMLNode& get_state (); - virtual void set_value (float) = 0; - virtual float get_value (void) const = 0; + std::string name() const { return _name; } - virtual bool can_send_feedback() const { return true; } + bool touching () const { return _touching; } + void set_touching (bool yn) { _touching = yn; } - sigc::signal LearningFinished; + bool is_toggle() const { return _flags & Toggle; } + bool is_gain_like() const { return _flags & GainLike; } - static sigc::signal Created; - static sigc::signal GoingAway; + virtual double lower() const { return 0.0; } + virtual double upper() const { return 1.0; } + Flag flags() const { return _flags; } + void set_flags (Flag f); - static sigc::signal StartLearning; - static sigc::signal StopLearning; + static Controllable* by_id (const PBD::ID&); + static Controllable* by_name (const std::string&); + static const std::string xml_node_name; + private: + std::string _name; - sigc::signal Changed; + Flag _flags; + bool _touching; - const PBD::ID& id() const { return _id; } + static void add (Controllable&); + static void remove (Controllable*); - int set_state (const XMLNode&) { return 0; } - XMLNode& get_state (); + typedef std::set Controllables; + static Glib::Threads::RWLock registry_lock; + static Controllables registry; +}; - private: - PBD::ID _id; +/* a utility class for the occasions when you need but do not have + a Controllable +*/ + +class IgnorableControllable : public Controllable +{ + public: + IgnorableControllable () : PBD::Controllable ("ignoreMe") {} + ~IgnorableControllable () {} + + void set_value (double /*v*/) {} + double get_value () const { return 0.0; } }; }