add group disposition argument to Route::set_gain() and use it in various UIs
[ardour.git] / libs / surfaces / faderport / faderport.cc
index a8f89380693fe4f6af2803f8dc82d31b88575469..50250a5f13ca2e30f7ea0a23ffae6ca7bc3a4bb5 100644 (file)
 #include "ardour/async_midi_port.h"
 #include "ardour/audioengine.h"
 #include "ardour/amp.h"
+#include "ardour/bundle.h"
 #include "ardour/debug.h"
 #include "ardour/filesystem_paths.h"
 #include "ardour/midi_port.h"
 #include "ardour/midiport_manager.h"
 #include "ardour/monitor_processor.h"
+#include "ardour/profile.h"
 #include "ardour/rc_configuration.h"
 #include "ardour/route.h"
 #include "ardour/session.h"
+#include "ardour/session_configuration.h"
 #include "ardour/track.h"
 
 #include "faderport.h"
@@ -63,7 +66,7 @@ using namespace std;
 
 FaderPort::FaderPort (Session& s)
        : ControlProtocol (s, _("Faderport"))
-       , AbstractUI<FaderPortRequest> ("faderport")
+       , AbstractUI<FaderPortRequest> (name())
        , gui (0)
        , connection_state (ConnectionState (0))
        , _device_active (false)
@@ -88,70 +91,105 @@ FaderPort::FaderPort (Session& s)
                throw failed_constructor();
        }
 
+       _input_bundle.reset (new ARDOUR::Bundle (_("Faderport Support (Receive)"), true));
+       _output_bundle.reset (new ARDOUR::Bundle (_("Faderport Support (Send) "), false));
+
+       _input_bundle->add_channel (
+               inp->name(),
+               ARDOUR::DataType::MIDI,
+               session->engine().make_port_name_non_relative (inp->name())
+               );
+
+       _output_bundle->add_channel (
+               outp->name(),
+               ARDOUR::DataType::MIDI,
+               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);
 
-       buttons.insert (std::make_pair (Mute, ButtonInfo (*this, _("Mute"), Mute, 21)));
-       buttons.insert (std::make_pair (Solo, ButtonInfo (*this, _("Solo"), Solo, 22)));
-       buttons.insert (std::make_pair (Rec, ButtonInfo (*this, _("Rec"), Rec, 23)));
-       buttons.insert (std::make_pair (Left, ButtonInfo (*this, _("Left"), Left, 20)));
-       buttons.insert (std::make_pair (Bank, ButtonInfo (*this, _("Bank"), Bank, 19)));
-       buttons.insert (std::make_pair (Right, ButtonInfo (*this, _("Right"), Right, 18)));
-       buttons.insert (std::make_pair (Output, ButtonInfo (*this, _("Output"), Output, 17)));
-       buttons.insert (std::make_pair (Read, ButtonInfo (*this, _("Read"), Read, 13)));
-       buttons.insert (std::make_pair (Write, ButtonInfo (*this, _("Write"), Write, 14)));
-       buttons.insert (std::make_pair (Touch, ButtonInfo (*this, _("Touch"), Touch, 15)));
-       buttons.insert (std::make_pair (Off, ButtonInfo (*this, _("Off"), Off, 16)));
-       buttons.insert (std::make_pair (Mix, ButtonInfo (*this, _("Mix"), Mix, 12)));
-       buttons.insert (std::make_pair (Proj, ButtonInfo (*this, _("Proj"), Proj, 11)));
-       buttons.insert (std::make_pair (Trns, ButtonInfo (*this, _("Trns"), Trns, 10)));
-       buttons.insert (std::make_pair (Undo, ButtonInfo (*this, _("Undo"), Undo, 9)));
-       buttons.insert (std::make_pair (Shift, ButtonInfo (*this, _("Shift"), Shift, 5)));
-       buttons.insert (std::make_pair (Punch, ButtonInfo (*this, _("Punch"), Punch, 6)));
-       buttons.insert (std::make_pair (User, ButtonInfo (*this, _("User"), User, 7)));
-       buttons.insert (std::make_pair (Loop, ButtonInfo (*this, _("Loop"), Loop, 8)));
-       buttons.insert (std::make_pair (Rewind, ButtonInfo (*this, _("Rewind"), Rewind, 4)));
-       buttons.insert (std::make_pair (Ffwd, ButtonInfo (*this, _("Ffwd"), Ffwd, 3)));
-       buttons.insert (std::make_pair (Stop, ButtonInfo (*this, _("Stop"), Stop, 2)));
-       buttons.insert (std::make_pair (Play, ButtonInfo (*this, _("Play"), Play, 1)));
-       buttons.insert (std::make_pair (RecEnable, ButtonInfo (*this, _("RecEnable"), RecEnable, 0)));
-       buttons.insert (std::make_pair (FaderTouch, ButtonInfo (*this, _("Fader (touch)"), FaderTouch, -1)));
-
-       button_info (Undo).set_action (boost::bind (&FaderPort::undo, this), true);
-       button_info (Undo).set_action (boost::bind (&FaderPort::redo, this), true, ShiftDown);
-       button_info (Undo).set_flash (true);
-
-       button_info (Play).set_action (boost::bind (&BasicUI::transport_play, this, true), true);
-       button_info (RecEnable).set_action (boost::bind (&BasicUI::rec_enable_toggle, this), true);
+       buttons.insert (std::make_pair (Mute, Button (*this, _("Mute"), Mute, 21)));
+       buttons.insert (std::make_pair (Solo, Button (*this, _("Solo"), Solo, 22)));
+       buttons.insert (std::make_pair (Rec, Button (*this, _("Rec"), Rec, 23)));
+       buttons.insert (std::make_pair (Left, Button (*this, _("Left"), Left, 20)));
+       buttons.insert (std::make_pair (Bank, Button (*this, _("Bank"), Bank, 19)));
+       buttons.insert (std::make_pair (Right, Button (*this, _("Right"), Right, 18)));
+       buttons.insert (std::make_pair (Output, Button (*this, _("Output"), Output, 17)));
+       buttons.insert (std::make_pair (FP_Read, Button (*this, _("Read"), FP_Read, 13)));
+       buttons.insert (std::make_pair (FP_Write, Button (*this, _("Write"), FP_Write, 14)));
+       buttons.insert (std::make_pair (FP_Touch, Button (*this, _("Touch"), FP_Touch, 15)));
+       buttons.insert (std::make_pair (FP_Off, Button (*this, _("Off"), FP_Off, 16)));
+       buttons.insert (std::make_pair (Mix, Button (*this, _("Mix"), Mix, 12)));
+       buttons.insert (std::make_pair (Proj, Button (*this, _("Proj"), Proj, 11)));
+       buttons.insert (std::make_pair (Trns, Button (*this, _("Trns"), Trns, 10)));
+       buttons.insert (std::make_pair (Undo, Button (*this, _("Undo"), Undo, 9)));
+       buttons.insert (std::make_pair (Shift, Button (*this, _("Shift"), Shift, 5)));
+       buttons.insert (std::make_pair (Punch, Button (*this, _("Punch"), Punch, 6)));
+       buttons.insert (std::make_pair (User, Button (*this, _("User"), User, 7)));
+       buttons.insert (std::make_pair (Loop, Button (*this, _("Loop"), Loop, 8)));
+       buttons.insert (std::make_pair (Rewind, Button (*this, _("Rewind"), Rewind, 4)));
+       buttons.insert (std::make_pair (Ffwd, Button (*this, _("Ffwd"), Ffwd, 3)));
+       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 (FaderTouch, Button (*this, _("Fader (touch)"), FaderTouch, -1)));
+
+       get_button (Shift).set_flash (true);
+       get_button (Mix).set_flash (true);
+       get_button (Proj).set_flash (true);
+       get_button (Trns).set_flash (true);
+       get_button (User).set_flash (true);
+
+       get_button (Left).set_action ( boost::bind (&FaderPort::left, this), true);
+       get_button (Right).set_action ( boost::bind (&FaderPort::right, this), true);
+
+       get_button (Undo).set_action (boost::bind (&FaderPort::undo, this), true);
+       get_button (Undo).set_action (boost::bind (&FaderPort::redo, this), true, ShiftDown);
+       get_button (Undo).set_flash (true);
+
+       get_button (FP_Read).set_action (boost::bind (&FaderPort::read, this), true);
+       get_button (FP_Read).set_action (boost::bind (&FaderPort::off, this), false, LongPress);
+       get_button (FP_Write).set_action (boost::bind (&FaderPort::write, this), true);
+       get_button (FP_Write).set_action (boost::bind (&FaderPort::off, this), false, LongPress);
+       get_button (FP_Touch).set_action (boost::bind (&FaderPort::touch, this), true);
+       get_button (FP_Touch).set_action (boost::bind (&FaderPort::off, this), false, LongPress);
+       get_button (FP_Off).set_action (boost::bind (&FaderPort::off, this), true);
+
+       get_button (Play).set_action (boost::bind (&BasicUI::transport_play, this, true), true);
+       get_button (RecEnable).set_action (boost::bind (&BasicUI::rec_enable_toggle, this), true);
        /* Stop is a modifier, so we have to use its own button state to get
           the default action (since StopDown will be set when looking for the
           action to invoke.
        */
-       button_info (Stop).set_action (boost::bind (&BasicUI::transport_stop, this), true, StopDown);
-       button_info (Ffwd).set_action (boost::bind (&BasicUI::ffwd, this), true);
+       get_button (Stop).set_action (boost::bind (&BasicUI::transport_stop, this), true, StopDown);
+       get_button (Ffwd).set_action (boost::bind (&BasicUI::ffwd, this), true);
 
        /* See comments about Stop above .. */
-       button_info (Rewind).set_action (boost::bind (&BasicUI::rewind, this), true, RewindDown);
-       button_info (Rewind).set_action (boost::bind (&BasicUI::goto_zero, this), true, ButtonState (RewindDown|StopDown));
-       button_info (Rewind).set_action (boost::bind (&BasicUI::goto_start, this), true, ButtonState (RewindDown|ShiftDown));
+       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));
 
-       button_info (Ffwd).set_action (boost::bind (&BasicUI::ffwd, this), true);
-       button_info (Ffwd).set_action (boost::bind (&BasicUI::goto_end, this), true, 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);
 
-       button_info (Loop).set_action (boost::bind (&BasicUI::loop_toggle, this), true);
-       button_info (Loop).set_action (boost::bind (&BasicUI::add_marker, this, string()), true, ShiftDown);
+       get_button (Punch).set_action (boost::bind (&FaderPort::punch, this), true);
 
-       button_info (Punch).set_action (boost::bind (&BasicUI::prev_marker, this), true, ShiftDown);
-       button_info (User).set_action (boost::bind (&BasicUI::next_marker, this), true, ShiftDown);
+       get_button (Loop).set_action (boost::bind (&BasicUI::loop_toggle, this), true);
+       get_button (Loop).set_action (boost::bind (&BasicUI::add_marker, this, string()), true, ShiftDown);
 
-       button_info (Mute).set_action (boost::bind (&FaderPort::mute, this), true);
-       button_info (Solo).set_action (boost::bind (&FaderPort::solo, this), true);
-       button_info (Rec).set_action (boost::bind (&FaderPort::rec_enable, this), true);
+       get_button (Punch).set_action (boost::bind (&BasicUI::prev_marker, this), true, ShiftDown);
+       get_button (User).set_action (boost::bind (&BasicUI::next_marker, this), true, ButtonState(ShiftDown|UserDown));
 
-       button_info (Output).set_action (boost::bind (&FaderPort::use_master, this), true);
-       button_info (Output).set_action (boost::bind (&FaderPort::use_monitor, this), true, ShiftDown);
+       get_button (Mute).set_action (boost::bind (&FaderPort::mute, this), true);
+       get_button (Solo).set_action (boost::bind (&FaderPort::solo, this), true);
+       get_button (Rec).set_action (boost::bind (&FaderPort::rec_enable, this), true);
+
+       get_button (Output).set_action (boost::bind (&FaderPort::use_master, this), true);
+       get_button (Output).set_action (boost::bind (&FaderPort::use_monitor, this), true, ShiftDown);
 }
 
 FaderPort::~FaderPort ()
@@ -170,6 +208,21 @@ FaderPort::~FaderPort ()
        }
 
        tear_down_gui ();
+
+       /* stop event loop */
+       DEBUG_TRACE (DEBUG::FaderPort, "BaseUI::quit ()\n");
+       BaseUI::quit ();
+}
+
+void*
+FaderPort::request_factory (uint32_t num_requests)
+{
+       /* AbstractUI<T>::request_buffer_factory() is a template method only
+          instantiated in this source module. To provide something visible for
+          use in the interface/descriptor, we have this static method that is
+          template-free.
+       */
+       return request_buffer_factory (num_requests);
 }
 
 void
@@ -177,8 +230,8 @@ FaderPort::start_midi_handling ()
 {
        /* handle device inquiry response */
        _input_port->parser()->sysex.connect_same_thread (midi_connections, boost::bind (&FaderPort::sysex_handler, this, _1, _2, _3));
-       /* handle switches */
-       _input_port->parser()->poly_pressure.connect_same_thread (midi_connections, boost::bind (&FaderPort::switch_handler, this, _1, _2));
+       /* handle buttons */
+       _input_port->parser()->poly_pressure.connect_same_thread (midi_connections, boost::bind (&FaderPort::button_handler, this, _1, _2));
        /* handle encoder */
        _input_port->parser()->pitchbend.connect_same_thread (midi_connections, boost::bind (&FaderPort::encoder_handler, this, _1, _2));
        /* handle fader */
@@ -229,10 +282,10 @@ FaderPort::thread_init ()
 {
        struct sched_param rtparam;
 
-       pthread_set_name (X_("FaderPort"));
+       pthread_set_name (event_loop_name().c_str());
 
-       PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("FaderPort"), 2048);
-       ARDOUR::SessionEvent::create_per_thread_pool (X_("FaderPort"), 128);
+       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 */
@@ -246,58 +299,120 @@ void
 FaderPort::all_lights_out ()
 {
        for (ButtonMap::iterator b = buttons.begin(); b != buttons.end(); ++b) {
-               b->second.set_led_state (_output_port, false, true);
+               b->second.set_led_state (_output_port, false);
        }
 }
 
-FaderPort::ButtonInfo&
-FaderPort::button_info (ButtonID id) const
+FaderPort::Button&
+FaderPort::get_button (ButtonID id) const
 {
        ButtonMap::const_iterator b = buttons.find (id);
        assert (b != buttons.end());
-       return const_cast<ButtonInfo&>(b->second);
+       return const_cast<Button&>(b->second);
+}
+
+bool
+FaderPort::button_long_press_timeout (ButtonID id)
+{
+       if (buttons_down.find (id) != buttons_down.end()) {
+               get_button (id).invoke (ButtonState (LongPress|button_state), false);
+       } else {
+               /* release happened and somehow we were not cancelled */
+       }
+
+       /* whichever button this was, we've used it ... don't invoke the
+          release action.
+       */
+       consumed.insert (id);
+
+       return false; /* don't get called again */
+}
+
+void
+FaderPort::start_press_timeout (Button& button, ButtonID id)
+{
+       Glib::RefPtr<Glib::TimeoutSource> timeout = Glib::TimeoutSource::create (500); // milliseconds
+       button.timeout_connection = timeout->connect (sigc::bind (sigc::mem_fun (*this, &FaderPort::button_long_press_timeout), id));
+       timeout->attach (main_loop()->get_context());
 }
 
 void
-FaderPort::switch_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
+FaderPort::button_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
 {
        ButtonID id (ButtonID (tb->controller_number));
+       Button& button (get_button (id));
+
+       DEBUG_TRACE (DEBUG::FaderPort, string_compose ("button event for ID %1 press ? %2\n", (int) tb->controller_number, (tb->value ? "yes" : "no")));
+
+       if (tb->value) {
+               buttons_down.insert (id);
+       } else {
+               buttons_down.erase (id);
+               button.timeout_connection.disconnect ();
+       }
+
+       ButtonState bs (ButtonState (0));
 
        switch (id) {
        case Shift:
-               button_state = (tb->value ? ButtonState (button_state|ShiftDown) : ButtonState (button_state&~ShiftDown));
+               bs = ShiftDown;
                break;
        case Stop:
-               button_state = (tb->value ? ButtonState (button_state|StopDown) : ButtonState (button_state&~StopDown));
+               bs = StopDown;
                break;
        case Rewind:
-               button_state = (tb->value ? ButtonState (button_state|RewindDown) : ButtonState (button_state&~RewindDown));
+               bs = RewindDown;
+               break;
+       case User:
+               bs = UserDown;
                break;
        case FaderTouch:
                fader_is_touched = tb->value;
+               if (_current_route) {
+                       boost::shared_ptr<AutomationControl> gain = _current_route->gain_control ();
+                       if (gain) {
+                               framepos_t now = session->engine().sample_time();
+                               if (tb->value) {
+                                       gain->start_touch (now);
+                               } else {
+                                       gain->stop_touch (true, now);
+                               }
+                       }
+               }
                break;
        default:
+               if (tb->value) {
+                       start_press_timeout (button, id);
+               }
                break;
        }
 
-       ButtonInfo& bi (button_info (id));
+       if (bs) {
+               button_state = (tb->value ? ButtonState (button_state|bs) : ButtonState (button_state&~bs));
+               DEBUG_TRACE (DEBUG::FaderPort, string_compose ("reset button state to %1 using %2\n", button_state, (int) bs));
+       }
 
-       if (bi.uses_flash()) {
-               bi.set_led_state (_output_port, (int)tb->value);
+       if (button.uses_flash()) {
+               button.set_led_state (_output_port, (int)tb->value);
        }
 
-       bi.invoke (button_state, tb->value ? true : false);
+       set<ButtonID>::iterator c = consumed.find (id);
+
+       if (c == consumed.end()) {
+               button.invoke (button_state, tb->value ? true : false);
+       } else {
+               DEBUG_TRACE (DEBUG::FaderPort, "button was consumed, ignored\n");
+               consumed.erase (c);
+       }
 }
 
 void
 FaderPort::encoder_handler (MIDI::Parser &, MIDI::pitchbend_t pb)
 {
        int delta = 1;
-       if (pb < 8192) {
-               cerr << "Encoder right\n";
-       } else {
+
+       if (pb >= 8192) {
                delta = -1;
-               cerr << "Encoder left\n";
        }
 
        //knob debouncing and hysteresis.  The presonus encoder often sends bursts of events, or goes the wrong direction
@@ -326,19 +441,43 @@ FaderPort::encoder_handler (MIDI::Parser &, MIDI::pitchbend_t pb)
 
        if (_current_route) {
 
-               if ( (button_state & ShiftDown) == ShiftDown ) {    //shift+encoder = input trim
-                       boost::shared_ptr<AutomationControl> gain = _current_route->trim()->gain_control ();
-                       if (gain) {
-                               float val = gain->get_user();  //for gain elements, the "user" value is in dB
+               ButtonState trim_modifier;
+               ButtonState width_modifier;
+
+               if (Profile->get_mixbus()) {
+                       trim_modifier = ShiftDown;
+                       width_modifier = ButtonState (0);
+               } else {
+                       trim_modifier = UserDown;
+                       width_modifier = ShiftDown;
+               }
+
+               if ((button_state & trim_modifier) == trim_modifier ) {    // mod+encoder = input trim
+                       boost::shared_ptr<AutomationControl> trim = _current_route->trim()->gain_control ();
+                       if (trim) {
+                               float val = trim->get_user();  //for gain elements, the "user" value is in dB
                                val += delta;
-                               gain->set_user(val);
+                               trim->set_user(val);
+                       }
+               } else if (width_modifier && ((button_state & width_modifier) == width_modifier)) {
+                       ardour_pan_width (delta);
+
+               } else {  // pan/balance
+                       if (!Profile->get_mixbus()) {
+                               ardour_pan_azimuth (delta);
+                       } else {
+                               mixbus_pan (delta);
                        }
-               } else {  //pan / balance
-                       //ToDo
                }
-
        }
 
+       /* if the user button was pressed, mark it as consumed so that its
+        * release action has no effect.
+        */
+
+       if (!Profile->get_mixbus() && (button_state & UserDown)) {
+               consumed.insert (User);
+       }
 }
 
 void
@@ -360,7 +499,11 @@ FaderPort::fader_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
                        if (gain) {
                                int ival = (fader_msb << 7) | fader_lsb;
                                float val = gain->interface_to_internal (ival/16384.0);
-                               _current_route->set_gain (val, this);
+                               /* even though the faderport only controls a
+                                  single route at a time, allow the fader to
+                                  modify the group, if appropriate.
+                               */
+                               _current_route->set_gain (val, Controllable::UseGroup);
                        }
                }
        }
@@ -369,6 +512,8 @@ FaderPort::fader_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb)
 void
 FaderPort::sysex_handler (MIDI::Parser &p, MIDI::byte *buf, size_t sz)
 {
+        DEBUG_TRACE (DEBUG::FaderPort, string_compose ("sysex message received, size = %1\n", sz));
+
        if (sz < 17) {
                return;
        }
@@ -388,7 +533,7 @@ FaderPort::sysex_handler (MIDI::Parser &p, MIDI::byte *buf, size_t sz)
 
        _device_active = true;
 
-       cerr << "FaderPort identified\n";
+       DEBUG_TRACE (DEBUG::FaderPort, "FaderPort identified via MIDI Device Inquiry response\n");
 
        /* put it into native mode */
 
@@ -403,14 +548,14 @@ FaderPort::sysex_handler (MIDI::Parser &p, MIDI::byte *buf, size_t sz)
 
        /* catch up on state */
 
-       notify_transport_state_changed ();
-       notify_record_state_changed ();
+       map_transport_state ();
+       map_recenable_state ();
 }
 
 int
 FaderPort::set_active (bool yn)
 {
-       DEBUG_TRACE (DEBUG::FaderPort, string_compose("MackieControlProtocol::set_active init with yn: '%1'\n", yn));
+       DEBUG_TRACE (DEBUG::FaderPort, string_compose("Faderport::set_active init with yn: '%1'\n", yn));
 
        if (yn == active()) {
                return 0;
@@ -428,6 +573,10 @@ FaderPort::set_active (bool yn)
                blink_connection = blink_timeout->connect (sigc::mem_fun (*this, &FaderPort::blink));
                blink_timeout->attach (main_loop()->get_context());
 
+               Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
+               periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &FaderPort::periodic));
+               periodic_timeout->attach (main_loop()->get_context());
+
        } else {
 
                BaseUI::quit ();
@@ -437,18 +586,48 @@ FaderPort::set_active (bool yn)
 
        ControlProtocol::set_active (yn);
 
-       DEBUG_TRACE (DEBUG::FaderPort, string_compose("MackieControlProtocol::set_active done with yn: '%1'\n", yn));
+       DEBUG_TRACE (DEBUG::FaderPort, string_compose("Faderport::set_active done with yn: '%1'\n", yn));
 
        return 0;
 }
 
+bool
+FaderPort::periodic ()
+{
+       if (!_current_route) {
+               return true;
+       }
+
+       ARDOUR::AutoState gain_state = _current_route->gain_control()->automation_state();
+
+       if (gain_state == ARDOUR::Touch || gain_state == ARDOUR::Play) {
+               map_gain ();
+       }
+
+       return true;
+}
+
+void
+FaderPort::stop_blinking (ButtonID id)
+{
+       blinkers.remove (id);
+       get_button (id).set_led_state (_output_port, false);
+}
+
+void
+FaderPort::start_blinking (ButtonID id)
+{
+       blinkers.push_back (id);
+       get_button (id).set_led_state (_output_port, true);
+}
+
 bool
 FaderPort::blink ()
 {
        blink_state = !blink_state;
 
        for (Blinkers::iterator b = blinkers.begin(); b != blinkers.end(); b++) {
-               button_info(*b).set_led_state (_output_port, blink_state);
+               get_button(*b).set_led_state (_output_port, blink_state);
        }
 
        return true;
@@ -472,39 +651,66 @@ FaderPort::close ()
 }
 
 void
-FaderPort::notify_record_state_changed ()
+FaderPort::map_recenable_state ()
 {
        switch (session->record_status()) {
        case Session::Disabled:
-               button_info (RecEnable).set_led_state (_output_port, false);
-               blinkers.remove (RecEnable);
+               stop_blinking (RecEnable);
                break;
        case Session::Enabled:
-               button_info (RecEnable).set_led_state (_output_port, true);
-               blinkers.push_back (RecEnable);
+               start_blinking (RecEnable);
                break;
        case Session::Recording:
-               button_info (RecEnable).set_led_state (_output_port, true);
-               blinkers.remove (RecEnable);
+               stop_blinking (RecEnable);
                break;
        }
 }
 
 void
-FaderPort::notify_transport_state_changed ()
+FaderPort::map_transport_state ()
 {
-       button_info (Loop).set_led_state (_output_port, session->get_play_loop());
-       button_info (Play).set_led_state (_output_port, session->transport_speed() == 1.0);
-       button_info (Stop).set_led_state (_output_port, session->transport_stopped ());
-       button_info (Rewind).set_led_state (_output_port, session->transport_speed() < 0.0);
-       button_info (Ffwd).set_led_state (_output_port, session->transport_speed() > 1.0);
+       get_button (Loop).set_led_state (_output_port, session->get_play_loop());
+
+       float ts = session->transport_speed();
+
+       if (ts == 0) {
+               stop_blinking (Play);
+       } else if (fabs (ts) == 1.0) {
+               stop_blinking (Play);
+               get_button (Play).set_led_state (_output_port, true);
+       } else {
+               start_blinking (Play);
+       }
+
+       get_button (Stop).set_led_state (_output_port, session->transport_stopped ());
+       get_button (Rewind).set_led_state (_output_port, session->transport_speed() < 0.0);
+       get_button (Ffwd).set_led_state (_output_port, session->transport_speed() > 1.0);
+}
+
+void
+FaderPort::parameter_changed (string what)
+{
+       if (what == "punch-in" || what == "punch-out") {
+               bool in = session->config.get_punch_in ();
+               bool out = session->config.get_punch_out ();
+               if (in && out) {
+                       get_button (Punch).set_led_state (_output_port, true);
+                       blinkers.remove (Punch);
+               } else if (in || out) {
+                       start_blinking (Punch);
+               } else {
+                       stop_blinking (Punch);
+               }
+       }
 }
 
 void
 FaderPort::connect_session_signals()
 {
-       session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::notify_record_state_changed, this), this);
-       session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::notify_transport_state_changed, this), this);
+       session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_recenable_state, this), this);
+       session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::map_transport_state, this), this);
+       /* not session, but treat it similarly */
+       session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&FaderPort::parameter_changed, this, _1), this);
 }
 
 bool
@@ -518,10 +724,7 @@ FaderPort::midi_input_handler (Glib::IOCondition ioc, boost::shared_ptr<ARDOUR::
 
        if (ioc & IO_IN) {
 
-               if (port) {
-                       port->clear ();
-               }
-
+               port->clear ();
                DEBUG_TRACE (DEBUG::FaderPort, string_compose ("data available on %1\n", boost::shared_ptr<MIDI::Port>(port)->name()));
                framepos_t now = session->engine().sample_time();
                port->parse (now);
@@ -547,6 +750,17 @@ FaderPort::get_state ()
        child->add_child_nocopy (boost::shared_ptr<ARDOUR::Port>(_output_port)->get_state());
        node.add_child_nocopy (*child);
 
+       /* Save action state for Mix, Proj, Trns and User buttons, since these
+        * are user controlled. We can only save named-action operations, since
+        * internal functions are just pointers to functions and hard to
+        * serialize without enumerating them all somewhere.
+        */
+
+       node.add_child_nocopy (get_button (Mix).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());
+
        return node;
 }
 
@@ -575,12 +789,28 @@ 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) {
+                               continue;
+                       }
+                       int xid = atoi (prop->value());
+                       ButtonMap::iterator b = buttons.find (ButtonID (xid));
+                       if (b == buttons.end()) {
+                               continue;
+                       }
+                       b->second.set_state (**n);
+               }
+       }
+
        return 0;
 }
 
 bool
 FaderPort::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool yn)
 {
+       DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler  start\n");
        if (!_input_port || !_output_port) {
                return false;
        }
@@ -601,6 +831,7 @@ FaderPort::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1,
                        connection_state &= ~OutputConnected;
                }
        } else {
+               DEBUG_TRACE (DEBUG::FaderPort, string_compose ("Connections between %1 and %2 changed, but I ignored it\n", name1, name2));
                /* not our ports */
                return false;
        }
@@ -613,6 +844,7 @@ FaderPort::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1,
                */
 
                g_usleep (100000);
+                DEBUG_TRACE (DEBUG::FaderPort, "device now connected for both input and output\n");
                connected ();
 
        } else {
@@ -620,13 +852,17 @@ FaderPort::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1,
                _device_active = false;
        }
 
+       ConnectionChange (); /* emit signal for our GUI */
+
+       DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler  end\n");
+
        return true; /* connection status changed */
 }
 
 void
 FaderPort::connected ()
 {
-       std::cerr << "faderport connected\n";
+       DEBUG_TRACE (DEBUG::FaderPort, "sending device inquiry message...\n");
 
        start_midi_handling ();
 
@@ -645,86 +881,107 @@ FaderPort::connected ()
 }
 
 void
-FaderPort::ButtonInfo::invoke (FaderPort::ButtonState bs, bool press)
+FaderPort::Button::invoke (FaderPort::ButtonState bs, bool press)
 {
-       switch (type) {
+       DEBUG_TRACE (DEBUG::FaderPort, string_compose ("invoke button %1 for %2 state %3%4%5\n", id, (press ? "press":"release"), hex, bs, dec));
+
+       ToDoMap::iterator x;
+
+       if (press) {
+               if ((x = on_press.find (bs)) == on_press.end()) {
+                       DEBUG_TRACE (DEBUG::FaderPort, string_compose ("no press action for button %1 state %2 @ %3 in %4\n", id, bs, this, &on_press));
+                       return;
+               }
+       } else {
+               if ((x = on_release.find (bs)) == on_release.end()) {
+                       DEBUG_TRACE (DEBUG::FaderPort, string_compose ("no release action for button %1 state %2 @%3 in %4\n", id, bs, this, &on_release));
+                       return;
+               }
+       }
+
+       switch (x->second.type) {
        case NamedAction:
-               if (press) {
-                       ToDoMap::iterator x = on_press.find (bs);
-                       if (x != on_press.end()) {
-                               if (!x->second.action_name.empty()) {
-                                       fp.access_action (x->second.action_name);
-                               }
-                       }
-               } else {
-                       ToDoMap::iterator x = on_release.find (bs);
-                       if (x != on_release.end()) {
-                               if (!x->second.action_name.empty()) {
-                                       fp.access_action (x->second.action_name);
-                               }
-                       }
+               if (!x->second.action_name.empty()) {
+                       fp.access_action (x->second.action_name);
                }
                break;
        case InternalFunction:
-               if (press) {
-                       ToDoMap::iterator x = on_press.find (bs);
-                       if (x != on_press.end()) {
-                               if (x->second.function) {
-                                       x->second.function ();
-                               }
-                       }
-               } else {
-                       ToDoMap::iterator x = on_release.find (bs);
-                       if (x != on_release.end()) {
-                               if (x->second.function) {
-                                       x->second.function ();
-                               }
-                       }
+               if (x->second.function) {
+                       x->second.function ();
                }
-               break;
        }
 }
 
 void
-FaderPort::ButtonInfo::set_action (string const& name, bool when_pressed, FaderPort::ButtonState bs)
+FaderPort::Button::set_action (string const& name, bool when_pressed, FaderPort::ButtonState bs)
 {
        ToDo todo;
 
-       type = NamedAction;
+       todo.type = NamedAction;
 
        if (when_pressed) {
-               todo.action_name = name;
-               on_press[bs] = todo;
+               if (name.empty()) {
+                       on_press.erase (bs);
+               } else {
+                       DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 to action %2 on press + %3%4%5\n", id, name, bs));
+                       todo.action_name = name;
+                       on_press[bs] = todo;
+               }
        } else {
-               todo.action_name = name;
-               on_release[bs] = todo;
+               if (name.empty()) {
+                       on_release.erase (bs);
+               } else {
+                       DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 to action %2 on release + %3%4%5\n", id, name, bs));
+                       todo.action_name = name;
+                       on_release[bs] = todo;
+               }
        }
+}
+
+string
+FaderPort::Button::get_action (bool press, FaderPort::ButtonState bs)
+{
+       ToDoMap::iterator x;
 
+       if (press) {
+               if ((x = on_press.find (bs)) == on_press.end()) {
+                       return string();
+               }
+               if (x->second.type != NamedAction) {
+                       return string ();
+               }
+               return x->second.action_name;
+       } else {
+               if ((x = on_release.find (bs)) == on_release.end()) {
+                       return string();
+               }
+               if (x->second.type != NamedAction) {
+                       return string ();
+               }
+               return x->second.action_name;
+       }
 }
 
 void
-FaderPort::ButtonInfo::set_action (boost::function<void()> f, bool when_pressed, FaderPort::ButtonState bs)
+FaderPort::Button::set_action (boost::function<void()> f, bool when_pressed, FaderPort::ButtonState bs)
 {
        ToDo todo;
-       type = InternalFunction;
+       todo.type = InternalFunction;
 
        if (when_pressed) {
+               DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 (%2) @ %5 to some functor on press + %3 in %4\n", id, name, bs, &on_press, this));
                todo.function = f;
                on_press[bs] = todo;
        } else {
+               DEBUG_TRACE (DEBUG::FaderPort, string_compose ("set button %1 (%2) @ %5 to some functor on release + %3\n", id, name, bs, this));
                todo.function = f;
                on_release[bs] = todo;
        }
 }
 
 void
-FaderPort::ButtonInfo::set_led_state (boost::shared_ptr<MIDI::Port> port, int onoff, bool force)
+FaderPort::Button::set_led_state (boost::shared_ptr<MIDI::Port> port, bool onoff)
 {
-       if (!force && (led_on == (bool) onoff)) {
-               /* nothing to do */
-               return;
-       }
-
        if (out < 0) {
                /* fader button ID - no LED */
                return;
@@ -735,7 +992,80 @@ FaderPort::ButtonInfo::set_led_state (boost::shared_ptr<MIDI::Port> port, int on
        buf[1] = out;
        buf[2] = onoff ? 1 : 0;
        port->write (buf, 3, 0);
-       led_on = (onoff ? true : false);
+}
+
+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) {
+               return -1;
+       }
+
+       typedef pair<string,FaderPort::ButtonState> state_pair_t;
+       vector<state_pair_t> state_pairs;
+
+       state_pairs.push_back (make_pair (string ("plain"), ButtonState (0)));
+       state_pairs.push_back (make_pair (string ("shift"), ShiftDown));
+       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);
+               }
+
+               propname = sp->first + X_("-release");
+               if ((prop = node.property (propname)) != 0) {
+                       set_action (prop->value(), false, sp->second);
+               }
+       }
+
+       return 0;
+}
+
+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);
+
+       ToDoMap::const_iterator x;
+       ToDo null;
+       null.type = NamedAction;
+
+       typedef pair<string,FaderPort::ButtonState> state_pair_t;
+       vector<state_pair_t> state_pairs;
+
+       state_pairs.push_back (make_pair (string ("plain"), ButtonState (0)));
+       state_pairs.push_back (make_pair (string ("shift"), ShiftDown));
+       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) {
+               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);
+                       }
+               }
+
+               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);
+                       }
+               }
+       }
+
+       return *node;
 }
 
 void
@@ -772,7 +1102,7 @@ FaderPort::set_current_route (boost::shared_ptr<Route> r)
        /* turn this off. It will be turned on back on in use_master() or
           use_monitor() as appropriate.
        */
-       button_info(Output).set_led_state (_output_port, false);
+       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);
@@ -789,6 +1119,7 @@ FaderPort::set_current_route (boost::shared_ptr<Route> r)
                boost::shared_ptr<AutomationControl> control = _current_route->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);
                }
 
                boost::shared_ptr<MonitorProcessor> mp = _current_route->monitor_control();
@@ -797,9 +1128,47 @@ FaderPort::set_current_route (boost::shared_ptr<Route> r)
                }
        }
 
+       //ToDo: subscribe to the fader automation modes so we can light the LEDs
+
        map_route_state ();
 }
 
+void
+FaderPort::map_auto ()
+{
+       /* Under no circumstances send a message to "enable" the LED state of
+        * the Off button, because this will disable the fader.
+        */
+
+       boost::shared_ptr<AutomationControl> control = _current_route->gain_control ();
+       const AutoState as = control->automation_state ();
+
+       switch (as) {
+               case ARDOUR::Play:
+                       get_button (FP_Read).set_led_state (_output_port, true);
+                       get_button (FP_Write).set_led_state (_output_port, false);
+                       get_button (FP_Touch).set_led_state (_output_port, false);
+               break;
+               case ARDOUR::Write:
+                       get_button (FP_Read).set_led_state (_output_port, false);
+                       get_button (FP_Write).set_led_state (_output_port, true);
+                       get_button (FP_Touch).set_led_state (_output_port, false);
+               break;
+               case ARDOUR::Touch:
+                       get_button (FP_Read).set_led_state (_output_port, false);
+                       get_button (FP_Write).set_led_state (_output_port, false);
+                       get_button (FP_Touch).set_led_state (_output_port, true);
+               break;
+               case ARDOUR::Off:
+                       get_button (FP_Read).set_led_state (_output_port, false);
+                       get_button (FP_Write).set_led_state (_output_port, false);
+                       get_button (FP_Touch).set_led_state (_output_port, false);
+               break;
+       }
+
+}
+
+
 void
 FaderPort::map_cut ()
 {
@@ -807,33 +1176,51 @@ FaderPort::map_cut ()
 
        if (mp) {
                bool yn = mp->cut_all ();
-               button_info (Mute).set_led_state (_output_port, yn);
                if (yn) {
-                       blinkers.push_back (Mute);
+                       start_blinking (Mute);
                } else {
-                       blinkers.remove (Mute);
+                       stop_blinking (Mute);
                }
        } else {
-               blinkers.remove (Mute);
+               stop_blinking (Mute);
        }
 }
 
 void
 FaderPort::map_mute (void*)
 {
-       button_info (Mute).set_led_state (_output_port, _current_route->muted());
+       if (_current_route) {
+               if (_current_route->muted()) {
+                       stop_blinking (Mute);
+                       get_button (Mute).set_led_state (_output_port, true);
+               } else if (_current_route->muted_by_others()) {
+                       start_blinking (Mute);
+               } else {
+                       stop_blinking (Mute);
+               }
+       } else {
+               stop_blinking (Mute);
+       }
 }
 
 void
 FaderPort::map_solo (bool, void*, bool)
 {
-       button_info (Solo).set_led_state (_output_port, _current_route->soloed() || _current_route->listening_via_monitor());
+       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 (void*, bool)
 {
-       button_info (Solo).set_led_state (_output_port, _current_route->listening_via_monitor());
+       if (_current_route) {
+               get_button (Solo).set_led_state (_output_port, _current_route->listening_via_monitor());
+       } else {
+               get_button (Solo).set_led_state (_output_port, false);
+       }
 }
 
 void
@@ -841,9 +1228,9 @@ FaderPort::map_recenable ()
 {
        boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (_current_route);
        if (t) {
-               button_info (Rec).set_led_state (_output_port, t->record_enabled());
+               get_button (Rec).set_led_state (_output_port, t->record_enabled());
        } else {
-               button_info (Rec).set_led_state (_output_port, false);
+               get_button (Rec).set_led_state (_output_port, false);
        }
 }
 
@@ -901,17 +1288,57 @@ void
 FaderPort::map_route_state ()
 {
        if (!_current_route) {
-               button_info (Mute).set_led_state (_output_port, false);
-               button_info (Solo).set_led_state (_output_port, false);
-               button_info (Rec).set_led_state (_output_port, false);
-               blinkers.remove (Mute);
-               blinkers.remove (Solo);
+               stop_blinking (Mute);
+               stop_blinking (Solo);
+               get_button (Rec).set_led_state (_output_port, false);
        } else {
                /* arguments to these map_*() methods are all ignored */
-               map_mute (0);
                map_solo (false, 0, false);
                map_recenable ();
                map_gain ();
-               map_cut ();
+               map_auto ();
+
+               if (_current_route == session->monitor_out()) {
+                       map_cut ();
+               } else {
+                       map_mute (0);
+               }
        }
 }
+
+list<boost::shared_ptr<ARDOUR::Bundle> >
+FaderPort::bundles ()
+{
+       list<boost::shared_ptr<ARDOUR::Bundle> > b;
+
+       if (_input_bundle) {
+               b.push_back (_input_bundle);
+               b.push_back (_output_bundle);
+       }
+
+       return b;
+}
+
+boost::shared_ptr<Port>
+FaderPort::output_port()
+{
+       return _output_port;
+}
+
+boost::shared_ptr<Port>
+FaderPort::input_port()
+{
+       return _input_port;
+}
+
+void
+FaderPort::set_action (ButtonID id, std::string const& action_name, bool on_press, ButtonState bs)
+{
+       get_button(id).set_action (action_name, on_press, bs);
+}
+
+string
+FaderPort::get_action (ButtonID id, bool press, ButtonState bs)
+{
+       return get_button(id).get_action (press, bs);
+}