/*
- Copyright (C) 2000-2007 Paul Davis
+ Copyright (C) 2000-2007 Paul Davis
This program is free software; you can redistribute it and/or modify
-v it under the terms of the GNU General Public License as published by
+ 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.
#include <set>
#include <map>
+#include "pbd/libpbd_visibility.h"
#include "pbd/signals.h"
-#include <glibmm/thread.h>
+#include <glibmm/threads.h>
#include "pbd/statefuldestructible.h"
+using std::min;
+using std::max;
+
class XMLNode;
namespace PBD {
-class Controllable : public PBD::StatefulDestructible {
+/** This is a pure virtual class to represent a scalar control.
+ *
+ * Note that it contains no storage/state for the controllable thing that it
+ * represents. Derived classes must provide set_value()/get_value() methods,
+ * which will involve (somehow) an actual location to store the value.
+ *
+ * In essence, this is an interface, not a class.
+ *
+ * Without overriding upper() and lower(), a derived class will function
+ * as a control whose value can range between 0 and 1.0.
+ *
+ */
+class LIBPBD_API Controllable : public PBD::StatefulDestructible {
public:
enum Flag {
Toggle = 0x1,
- Discrete = 0x2,
- GainLike = 0x4,
- IntegerOnly = 0x8
+ 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. `UI' --- as used in some cases for the internal representation
- * of the UI. This may be the same as `user', or may be something
- * like the natural log of frequency in order that sliders operate
- * in a logarithmic fashion.
- * 3. `plugin' --- as passed to a plugin.
+ * 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.
+ */
+
+ /* Within an application, various Controllables might be considered to
+ * be "grouped" in a way that implies that setting 1 of them also
+ * modifies others in the group.
*/
- /** Set `user' value */
- virtual void set_value (double) = 0;
- /** @return `user' value */
+ enum GroupControlDisposition {
+ InverseGroup, /* set all controls in the same "group" as this one */
+ NoGroup, /* set only this control */
+ UseGroup, /* use group settings to decide which group controls are altered */
+ ForGroup /* this setting is being done *for* the group
+ (i.e. UseGroup was set in the callchain
+ somewhere).
+ */
+ };
+
+ /** Get and Set `internal' value
+ *
+ * All derived classes must implement this.
+ *
+ * Basic derived classes will ignore @param group_override,
+ * but more sophisticated children, notably those that
+ * proxy the value setting logic via an object that is aware of group
+ * relationships between this control and others, will find it useful.
+ */
+ virtual void set_value (double, GroupControlDisposition group_override) = 0;
virtual double get_value (void) const = 0;
+ /** Conversions between `internal', 'interface', and 'user' values */
+ virtual double internal_to_interface (double i) const {return (i-lower())/(upper() - lower());} //by default, the interface range is just a linear interpolation between lower and upper values
+ virtual double interface_to_internal (double i) const {return lower() + i*(upper() - lower());}
+ virtual double internal_to_user (double i) const {return i;} //by default the internal value is the same as the user value
+ virtual double user_to_internal (double i) const {return i;} //by default the internal value is the same as the user value
+
+ /** Get and Set `interface' value (typically, fraction of knob travel) */
+ virtual float get_interface() const { return (internal_to_interface(get_value())); }
+ virtual void set_interface (float fraction) { fraction = min( max(0.0f, fraction), 1.0f); set_value(interface_to_internal(fraction), NoGroup); }
+
+ /** Get and Set `user' value ( dB or milliseconds, etc. This MIGHT be the same as the internal value, but in a few cases it is not ) */
+ virtual float get_user() const { return (internal_to_user(get_value())); }
+ virtual void set_user (float user_v) { set_value(user_to_internal(user_v), NoGroup); }
+ virtual std::string get_user_string() const { return std::string(); }
+
PBD::Signal0<void> LearningFinished;
static PBD::Signal3<void,PBD::Controllable*,int,int> CreateBinding;
static PBD::Signal1<void,PBD::Controllable*> DeleteBinding;
static PBD::Signal1<void,PBD::Controllable*> StopLearning;
static PBD::Signal1<void,Controllable*> Destroyed;
-
+
PBD::Signal0<void> Changed;
int set_state (const XMLNode&, int version);
void set_touching (bool yn) { _touching = yn; }
bool is_toggle() const { return _flags & Toggle; }
- bool is_discrete() const { return _flags & Discrete; }
bool is_gain_like() const { return _flags & GainLike; }
- bool is_integral_only() const { return _flags & IntegerOnly; }
virtual double lower() const { return 0.0; }
virtual double upper() const { return 1.0; }
+ virtual double normal() const { return 0.0; } //the default value
Flag flags() const { return _flags; }
void set_flags (Flag f);
- virtual uint32_t get_discrete_values (std::list<float>&) { return 0; /* no values returned */ }
-
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;
-
+ std::string _units;
Flag _flags;
bool _touching;
static void remove (Controllable*);
typedef std::set<PBD::Controllable*> Controllables;
- static Glib::StaticRWLock registry_lock;
+ static Glib::Threads::RWLock registry_lock;
static Controllables registry;
};
a Controllable
*/
-class IgnorableControllable : public Controllable
+class LIBPBD_API IgnorableControllable : public Controllable
{
- public:
+ public:
IgnorableControllable () : PBD::Controllable ("ignoreMe") {}
~IgnorableControllable () {}
-
- void set_value (double /*v*/) {}
+
+ void set_value (double /*v*/, PBD::Controllable::GroupControlDisposition /* group_override */) {}
double get_value () const { return 0.0; }
};
projects / ardour.git / blobdiff