Add OSX configuration script.
[ardour.git] / libs / surfaces / faderport / faderport.cc
index a1ca393d7309cf8cbfc4b877f904ef04f7cf41f9..72190c1e8a0370970723688de1d5f832d41ae39c 100644 (file)
@@ -26,7 +26,6 @@
 #include <glibmm/fileutils.h>
 #include <glibmm/miscutils.h>
 
-#include "pbd/controllable_descriptor.h"
 #include "pbd/error.h"
 #include "pbd/failed_constructor.h"
 #include "pbd/file_utils.h"
@@ -40,6 +39,7 @@
 #include "ardour/audioengine.h"
 #include "ardour/amp.h"
 #include "ardour/bundle.h"
+#include "ardour/controllable_descriptor.h"
 #include "ardour/debug.h"
 #include "ardour/filesystem_paths.h"
 #include "ardour/midi_port.h"
@@ -47,7 +47,8 @@
 #include "ardour/monitor_processor.h"
 #include "ardour/profile.h"
 #include "ardour/rc_configuration.h"
-#include "ardour/route.h"
+#include "ardour/record_enable_control.h"
+#include "ardour/stripable.h"
 #include "ardour/session.h"
 #include "ardour/session_configuration.h"
 #include "ardour/track.h"
@@ -60,12 +61,12 @@ using namespace PBD;
 using namespace Glib;
 using namespace std;
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 #include "pbd/abstract_ui.cc" // instantiate template
 
 FaderPort::FaderPort (Session& s)
-       : ControlProtocol (s, _("Faderport"))
+       : ControlProtocol (s, _("PreSonus FaderPort"))
        , AbstractUI<FaderPortRequest> (name())
        , gui (0)
        , connection_state (ConnectionState (0))
@@ -75,6 +76,7 @@ FaderPort::FaderPort (Session& s)
        , fader_is_touched (false)
        , button_state (ButtonState (0))
        , blink_state (false)
+       , rec_enable_state (false)
 {
        last_encoder_time = 0;
 
@@ -106,9 +108,6 @@ FaderPort::FaderPort (Session& s)
                session->engine().make_port_name_non_relative (outp->name())
                );
 
-
-       TrackSelectionChanged.connect (selection_connection, MISSING_INVALIDATOR, boost::bind (&FaderPort::gui_track_selection_changed, this, _1), this);
-
        /* Catch port connections and disconnections */
        ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect (port_connection, MISSING_INVALIDATOR, boost::bind (&FaderPort::connection_handler, this, _1, _2, _3, _4, _5), this);
 
@@ -136,6 +135,7 @@ FaderPort::FaderPort (Session& s)
        buttons.insert (std::make_pair (Stop, Button (*this, _("Stop"), Stop, 2)));
        buttons.insert (std::make_pair (Play, Button (*this, _("Play"), Play, 1)));
        buttons.insert (std::make_pair (RecEnable, Button (*this, _("RecEnable"), RecEnable, 0)));
+       buttons.insert (std::make_pair (Footswitch, Button (*this, _("Footswitch"), Footswitch, -1)));
        buttons.insert (std::make_pair (FaderTouch, Button (*this, _("Fader (touch)"), FaderTouch, -1)));
 
        get_button (Shift).set_flash (true);
@@ -171,7 +171,7 @@ FaderPort::FaderPort (Session& s)
        /* See comments about Stop above .. */
        get_button (Rewind).set_action (boost::bind (&BasicUI::rewind, this), true, RewindDown);
        get_button (Rewind).set_action (boost::bind (&BasicUI::goto_zero, this), true, ButtonState (RewindDown|StopDown));
-       get_button (Rewind).set_action (boost::bind (&BasicUI::goto_start, this), true, ButtonState (RewindDown|ShiftDown));
+       get_button (Rewind).set_action (boost::bind (&BasicUI::goto_start, this, false), true, ButtonState (RewindDown|ShiftDown));
 
        get_button (Ffwd).set_action (boost::bind (&BasicUI::ffwd, this), true);
        get_button (Ffwd).set_action (boost::bind (&BasicUI::goto_end, this), true, ShiftDown);
@@ -194,15 +194,21 @@ FaderPort::FaderPort (Session& s)
 
 FaderPort::~FaderPort ()
 {
+       cerr << "~FP\n";
+
+       all_lights_out ();
+
        if (_input_port) {
                DEBUG_TRACE (DEBUG::FaderPort, string_compose ("unregistering input port %1\n", boost::shared_ptr<ARDOUR::Port>(_input_port)->name()));
+               Glib::Threads::Mutex::Lock em (AudioEngine::instance()->process_lock());
                AudioEngine::instance()->unregister_port (_input_port);
                _input_port.reset ();
        }
 
        if (_output_port) {
-//             _output_port->drain (10000);  //ToDo:  is this necessary?  It hangs the shutdown, for me
+               _output_port->drain (10000,  250000); /* check every 10 msecs, wait up to 1/4 second for the port to drain */
                DEBUG_TRACE (DEBUG::FaderPort, string_compose ("unregistering output port %1\n", boost::shared_ptr<ARDOUR::Port>(_output_port)->name()));
+               Glib::Threads::Mutex::Lock em (AudioEngine::instance()->process_lock());
                AudioEngine::instance()->unregister_port (_output_port);
                _output_port.reset ();
        }
@@ -242,7 +248,7 @@ FaderPort::start_midi_handling ()
         * method, which will read the data, and invoke the parser.
         */
 
-       _input_port->xthread().set_receive_handler (sigc::bind (sigc::mem_fun (this, &FaderPort::midi_input_handler), _input_port));
+       _input_port->xthread().set_receive_handler (sigc::bind (sigc::mem_fun (this, &FaderPort::midi_input_handler), boost::weak_ptr<AsyncMIDIPort> (_input_port)));
        _input_port->xthread().attach (main_loop()->get_context());
 }
 
@@ -280,19 +286,12 @@ FaderPort::stop ()
 void
 FaderPort::thread_init ()
 {
-       struct sched_param rtparam;
-
        pthread_set_name (event_loop_name().c_str());
 
        PBD::notify_event_loops_about_thread_creation (pthread_self(), event_loop_name(), 2048);
        ARDOUR::SessionEvent::create_per_thread_pool (event_loop_name(), 128);
 
-       memset (&rtparam, 0, sizeof (rtparam));
-       rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
-
-       if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
-               // do we care? not particularly.
-       }
+       set_thread_priority ();
 }
 
 void
@@ -368,14 +367,14 @@ FaderPort::button_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
                break;
        case FaderTouch:
                fader_is_touched = tb->value;
-               if (_current_route) {
-                       boost::shared_ptr<AutomationControl> gain = _current_route->gain_control ();
+               if (_current_stripable) {
+                       boost::shared_ptr<AutomationControl> gain = _current_stripable->gain_control ();
                        if (gain) {
                                framepos_t now = session->engine().sample_time();
                                if (tb->value) {
                                        gain->start_touch (now);
                                } else {
-                                       gain->stop_touch (true, now);
+                                       gain->stop_touch (now);
                                }
                        }
                }
@@ -439,7 +438,7 @@ FaderPort::encoder_handler (MIDI::Parser &, MIDI::pitchbend_t pb)
                last_good_encoder_delta = delta;
        }
 
-       if (_current_route) {
+       if (_current_stripable) {
 
                ButtonState trim_modifier;
                ButtonState width_modifier;
@@ -453,11 +452,11 @@ FaderPort::encoder_handler (MIDI::Parser &, MIDI::pitchbend_t pb)
                }
 
                if ((button_state & trim_modifier) == trim_modifier ) {    // mod+encoder = input trim
-                       boost::shared_ptr<AutomationControl> trim = _current_route->trim()->gain_control ();
+                       boost::shared_ptr<AutomationControl> trim = _current_stripable->trim_control ();
                        if (trim) {
-                               float val = trim->get_user();  //for gain elements, the "user" value is in dB
-                               val += delta;
-                               trim->set_user(val);
+                               float val = accurate_coefficient_to_dB (trim->get_value());
+                               val += delta * .5f; // use 1/2 dB Steps -20..+20
+                               trim->set_value (dB_to_coefficient (val), Controllable::UseGroup);
                        }
                } else if (width_modifier && ((button_state & width_modifier) == width_modifier)) {
                        ardour_pan_width (delta);
@@ -494,16 +493,16 @@ FaderPort::fader_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
        }
 
        if (was_fader) {
-               if (_current_route) {
-                       boost::shared_ptr<AutomationControl> gain = _current_route->gain_control ();
+               if (_current_stripable) {
+                       boost::shared_ptr<AutomationControl> gain = _current_stripable->gain_control ();
                        if (gain) {
                                int ival = (fader_msb << 7) | fader_lsb;
                                float val = gain->interface_to_internal (ival/16384.0);
                                /* even though the faderport only controls a
-                                  single route at a time, allow the fader to
+                                  single stripable at a time, allow the fader to
                                   modify the group, if appropriate.
                                */
-                               _current_route->set_gain (val, Controllable::UseGroup);
+                               _current_stripable->gain_control()->set_value (val, Controllable::UseGroup);
                        }
                }
        }
@@ -548,6 +547,9 @@ FaderPort::sysex_handler (MIDI::Parser &p, MIDI::byte *buf, size_t sz)
 
        /* catch up on state */
 
+       /* make sure that rec_enable_state is consistent with current device state */
+       get_button (RecEnable).set_led_state (_output_port, rec_enable_state);
+
        map_transport_state ();
        map_recenable_state ();
 }
@@ -594,11 +596,11 @@ FaderPort::set_active (bool yn)
 bool
 FaderPort::periodic ()
 {
-       if (!_current_route) {
+       if (!_current_stripable) {
                return true;
        }
 
-       ARDOUR::AutoState gain_state = _current_route->gain_control()->automation_state();
+       ARDOUR::AutoState gain_state = _current_stripable->gain_control()->automation_state();
 
        if (gain_state == ARDOUR::Touch || gain_state == ARDOUR::Play) {
                map_gain ();
@@ -630,6 +632,8 @@ FaderPort::blink ()
                get_button(*b).set_led_state (_output_port, blink_state);
        }
 
+       map_recenable_state ();
+
        return true;
 }
 
@@ -643,27 +647,52 @@ FaderPort::close ()
        port_connection.disconnect ();
        blink_connection.disconnect ();
        selection_connection.disconnect ();
-       route_connections.drop_connections ();
+       stripable_connections.drop_connections ();
 
 #if 0
-       route_connections.drop_connections ();
+       stripable_connections.drop_connections ();
 #endif
 }
 
 void
 FaderPort::map_recenable_state ()
 {
+       /* special case for RecEnable because its status can change as a
+        * confluence of unrelated parameters: (a) session rec-enable state (b)
+        * rec-enabled tracks. So we don't add the button to the blinkers list,
+        * we just call this:
+        *
+        *  * from the blink callback
+        *  * when the session tells us about a status change
+        *
+        * We do the last one so that the button changes state promptly rather
+        * than waiting for the next blink callback. The change in "blinking"
+        * based on having record-enabled tracks isn't urgent, and that happens
+        * during the blink callback.
+        */
+
+       bool onoff;
+
        switch (session->record_status()) {
        case Session::Disabled:
-               stop_blinking (RecEnable);
+               onoff = false;
                break;
        case Session::Enabled:
-               start_blinking (RecEnable);
+               onoff = blink_state;
                break;
        case Session::Recording:
-               stop_blinking (RecEnable);
+               if (session->have_rec_enabled_track ()) {
+                       onoff = true;
+               } else {
+                       onoff = blink_state;
+               }
                break;
        }
+
+       if (onoff != rec_enable_state) {
+               get_button(RecEnable).set_led_state (_output_port, onoff);
+               rec_enable_state = onoff;
+       }
 }
 
 void
@@ -714,8 +743,14 @@ FaderPort::connect_session_signals()
 }
 
 bool
-FaderPort::midi_input_handler (Glib::IOCondition ioc, boost::shared_ptr<ARDOUR::AsyncMIDIPort> port)
+FaderPort::midi_input_handler (Glib::IOCondition ioc, boost::weak_ptr<ARDOUR::AsyncMIDIPort> wport)
 {
+       boost::shared_ptr<AsyncMIDIPort> port (wport.lock());
+
+       if (!port) {
+               return false;
+       }
+
        DEBUG_TRACE (DEBUG::FaderPort, string_compose ("something happend on  %1\n", boost::shared_ptr<MIDI::Port>(port)->name()));
 
        if (ioc & ~IO_IN) {
@@ -760,6 +795,7 @@ FaderPort::get_state ()
        node.add_child_nocopy (get_button (Proj).get_state());
        node.add_child_nocopy (get_button (Trns).get_state());
        node.add_child_nocopy (get_button (User).get_state());
+       node.add_child_nocopy (get_button (Footswitch).get_state());
 
        return node;
 }
@@ -791,11 +827,10 @@ FaderPort::set_state (const XMLNode& node, int version)
 
        for (XMLNodeList::const_iterator n = node.children().begin(); n != node.children().end(); ++n) {
                if ((*n)->name() == X_("Button")) {
-                       XMLProperty const * prop = (*n)->property (X_("id"));
-                       if (!prop) {
+                       int32_t xid;
+                       if (!(*n)->get_property (X_("id"), xid)) {
                                continue;
                        }
-                       int xid = atoi (prop->value());
                        ButtonMap::iterator b = buttons.find (ButtonID (xid));
                        if (b == buttons.end()) {
                                continue;
@@ -997,13 +1032,8 @@ FaderPort::Button::set_led_state (boost::shared_ptr<MIDI::Port> port, bool onoff
 int
 FaderPort::Button::set_state (XMLNode const& node)
 {
-       const XMLProperty* prop = node.property ("id");
-       if (!prop) {
-               return -1;
-       }
-
-       int xid = atoi (prop->value());
-       if (xid != id) {
+       int32_t xid;
+       if (!node.get_property ("id", xid) || xid != id) {
                return -1;
        }
 
@@ -1015,16 +1045,16 @@ FaderPort::Button::set_state (XMLNode const& node)
        state_pairs.push_back (make_pair (string ("long"), LongPress));
 
        for (vector<state_pair_t>::const_iterator sp = state_pairs.begin(); sp != state_pairs.end(); ++sp) {
-               string propname;
 
-               propname = sp->first + X_("-press");
-               if ((prop = node.property (propname)) != 0) {
-                       set_action (prop->value(), true, sp->second);
+               string propname = sp->first + X_("-press");
+               string value;
+               if (node.get_property (propname.c_str(), value)) {
+                       set_action (value, true, sp->second);
                }
 
                propname = sp->first + X_("-release");
-               if ((prop = node.property (propname)) != 0) {
-                       set_action (prop->value(), false, sp->second);
+               if (node.get_property (propname.c_str(), value)) {
+                       set_action (value, false, sp->second);
                }
        }
 
@@ -1035,10 +1065,8 @@ XMLNode&
 FaderPort::Button::get_state () const
 {
        XMLNode* node = new XMLNode (X_("Button"));
-       char buf[16];
-       snprintf (buf, sizeof (buf), "%d", id);
 
-       node->add_property (X_("id"), buf);
+       node->set_property (X_("id"), to_string<int32_t>(id));
 
        ToDoMap::const_iterator x;
        ToDo null;
@@ -1054,13 +1082,13 @@ FaderPort::Button::get_state () const
        for (vector<state_pair_t>::const_iterator sp = state_pairs.begin(); sp != state_pairs.end(); ++sp) {
                if ((x = on_press.find (sp->second)) != on_press.end()) {
                        if (x->second.type == NamedAction) {
-                               node->add_property (string (sp->first + X_("-press")).c_str(), x->second.action_name);
+                               node->set_property (string (sp->first + X_("-press")).c_str(), x->second.action_name);
                        }
                }
 
                if ((x = on_release.find (sp->second)) != on_release.end()) {
                        if (x->second.type == NamedAction) {
-                               node->add_property (string (sp->first + X_("-release")).c_str(), x->second.action_name);
+                               node->set_property (string (sp->first + X_("-release")).c_str(), x->second.action_name);
                        }
                }
        }
@@ -1069,68 +1097,61 @@ FaderPort::Button::get_state () const
 }
 
 void
-FaderPort::gui_track_selection_changed (RouteNotificationListPtr routes)
+FaderPort::stripable_selection_changed ()
 {
-       boost::shared_ptr<Route> r;
-
-       if (!routes->empty()) {
-               r = routes->front().lock();
-       }
-
-       set_current_route (r);
+       set_current_stripable (ControlProtocol::first_selected_stripable());
 }
 
 void
-FaderPort::drop_current_route ()
+FaderPort::drop_current_stripable ()
 {
-       if (_current_route) {
-               if (_current_route == session->monitor_out()) {
-                       set_current_route (session->master_out());
+       if (_current_stripable) {
+               if (_current_stripable == session->monitor_out()) {
+                       set_current_stripable (session->master_out());
                } else {
-                       set_current_route (boost::shared_ptr<Route>());
+                       set_current_stripable (boost::shared_ptr<Stripable>());
                }
        }
 }
 
 void
-FaderPort::set_current_route (boost::shared_ptr<Route> r)
+FaderPort::set_current_stripable (boost::shared_ptr<Stripable> r)
 {
-       route_connections.drop_connections ();
+       stripable_connections.drop_connections ();
 
-       _current_route = r;
+       _current_stripable = r;
 
        /* turn this off. It will be turned on back on in use_master() or
           use_monitor() as appropriate.
        */
        get_button(Output).set_led_state (_output_port, false);
 
-       if (_current_route) {
-               _current_route->DropReferences.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::drop_current_route, this), this);
+       if (_current_stripable) {
+               _current_stripable->DropReferences.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::drop_current_stripable, this), this);
 
-               _current_route->mute_changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_mute, this), this);
-               _current_route->solo_changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_solo, this), this);
-               _current_route->listen_changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_listen, this), this);
+               _current_stripable->mute_control()->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_mute, this), this);
+               _current_stripable->solo_control()->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_solo, this), this);
 
-               boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_route);
+               boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_stripable);
                if (t) {
-                       t->RecordEnableChanged.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_recenable, this), this);
+                       t->rec_enable_control()->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_recenable, this), this);
                }
 
-               boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
+               boost::shared_ptr<AutomationControl> control = _current_stripable->gain_control ();
                if (control) {
-                       control->Changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_gain, this), this);
-                       control->alist()->automation_state_changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_auto, this), this);
+                       control->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_gain, this), this);
+                       control->alist()->automation_state_changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_auto, this), this);
                }
 
-               boost::shared_ptr<MonitorProcessor> mp = _current_route->monitor_control();
+               boost::shared_ptr<MonitorProcessor> mp = _current_stripable->monitor_control();
                if (mp) {
-                       mp->cut_control()->Changed.connect (route_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_cut, this), this);
+                       mp->cut_control()->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_cut, this), this);
                }
        }
 
        //ToDo: subscribe to the fader automation modes so we can light the LEDs
 
-       map_route_state ();
+       map_stripable_state ();
 }
 
 void
@@ -1140,7 +1161,7 @@ FaderPort::map_auto ()
         * the Off button, because this will disable the fader.
         */
 
-       boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
+       boost::shared_ptr<AutomationControl> control = _current_stripable->gain_control ();
        const AutoState as = control->automation_state ();
 
        switch (as) {
@@ -1172,7 +1193,7 @@ FaderPort::map_auto ()
 void
 FaderPort::map_cut ()
 {
-       boost::shared_ptr<MonitorProcessor> mp = _current_route->monitor_control();
+       boost::shared_ptr<MonitorProcessor> mp = _current_stripable->monitor_control();
 
        if (mp) {
                bool yn = mp->cut_all ();
@@ -1189,11 +1210,11 @@ FaderPort::map_cut ()
 void
 FaderPort::map_mute ()
 {
-       if (_current_route) {
-               if (_current_route->muted()) {
+       if (_current_stripable) {
+               if (_current_stripable->mute_control()->muted()) {
                        stop_blinking (Mute);
                        get_button (Mute).set_led_state (_output_port, true);
-               } else if (_current_route->muted_by_others()) {
+               } else if (_current_stripable->mute_control()->muted_by_others_soloing () || _current_stripable->mute_control()->muted_by_masters()) {
                        start_blinking (Mute);
                } else {
                        stop_blinking (Mute);
@@ -1206,18 +1227,8 @@ FaderPort::map_mute ()
 void
 FaderPort::map_solo ()
 {
-       if (_current_route) {
-               get_button (Solo).set_led_state (_output_port, _current_route->soloed() || _current_route->listening_via_monitor());
-       } else {
-               get_button (Solo).set_led_state (_output_port, false);
-       }
-}
-
-void
-FaderPort::map_listen ()
-{
-       if (_current_route) {
-               get_button (Solo).set_led_state (_output_port, _current_route->listening_via_monitor());
+       if (_current_stripable) {
+               get_button (Solo).set_led_state (_output_port, _current_stripable->solo_control()->soloed());
        } else {
                get_button (Solo).set_led_state (_output_port, false);
        }
@@ -1226,9 +1237,9 @@ FaderPort::map_listen ()
 void
 FaderPort::map_recenable ()
 {
-       boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_route);
+       boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_stripable);
        if (t) {
-               get_button (Rec).set_led_state (_output_port, t->record_enabled());
+               get_button (Rec).set_led_state (_output_port, t->rec_enable_control()->get_value());
        } else {
                get_button (Rec).set_led_state (_output_port, false);
        }
@@ -1242,11 +1253,11 @@ FaderPort::map_gain ()
                return;
        }
 
-       if (!_current_route) {
+       if (!_current_stripable) {
                return;
        }
 
-       boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
+       boost::shared_ptr<AutomationControl> control = _current_stripable->gain_control ();
        double val;
 
        if (!control) {
@@ -1285,9 +1296,9 @@ FaderPort::map_gain ()
 }
 
 void
-FaderPort::map_route_state ()
+FaderPort::map_stripable_state ()
 {
-       if (!_current_route) {
+       if (!_current_stripable) {
                stop_blinking (Mute);
                stop_blinking (Solo);
                get_button (Rec).set_led_state (_output_port, false);
@@ -1297,7 +1308,7 @@ FaderPort::map_route_state ()
                map_gain ();
                map_auto ();
 
-               if (_current_route == session->monitor_out()) {
+               if (_current_stripable == session->monitor_out()) {
                        map_cut ();
                } else {
                        map_mute ();