MCP: more debug tracing
[ardour.git] / libs / surfaces / mackie / surface.cc
index 01be2c60c2c1f00867ad429cebb6c11147086832..971934c2d9b5441c7f700791e3e6bcf88e78b08f 100644 (file)
-#include "surface.h"
-
 #include <sstream>
 #include <iomanip>
 #include <iostream>
+#include <cstdio>
+#include <cmath>
+
+#include "midi++/port.h"
+#include "midi++/manager.h"
+
+#include "ardour/debug.h"
+#include "ardour/route.h"
+#include "ardour/panner.h"
+#include "ardour/panner_shell.h"
+#include "ardour/rc_configuration.h"
+
+#include "control_group.h"
+#include "surface_port.h"
+#include "surface.h"
+#include "strip.h"
+#include "mackie_midi_builder.h"
+#include "mackie_control_protocol.h"
+#include "mackie_jog_wheel.h"
+
+#include "strip.h"
+#include "button.h"
+#include "led.h"
+#include "ledring.h"
+#include "pot.h"
+#include "fader.h"
+#include "jog.h"
+#include "meter.h"
+
+#include "i18n.h"
 
 using namespace std;
+using namespace PBD;
 using namespace Mackie;
+using ARDOUR::Route;
+using ARDOUR::Panner;
+using ARDOUR::Pannable;
+using ARDOUR::PannerShell;
 
-Surface::Surface( uint32_t max_strips, uint32_t unit_strips )
-: _max_strips( max_strips ), _unit_strips( unit_strips )
-{
-}
+// The MCU sysex header
+static MidiByteArray mackie_sysex_hdr  (5, MIDI::sysex, 0x0, 0x0, 0x66, 0x10);
+
+// The MCU extender sysex header
+static MidiByteArray mackie_sysex_hdr_xt  (5, MIDI::sysex, 0x0, 0x0, 0x66, 0x11);
+
+static MidiByteArray empty_midi_byte_array;
 
-void Surface::init()
+Surface::Surface (MackieControlProtocol& mcp, jack_client_t* jack, const std::string& device_name, uint32_t number, surface_type_t stype)
+       : _mcp (mcp)
+       , _stype (stype)
+       , _number (number)
+       , _active (false)
+       , _connected (false)
+       , _jog_wheel (0)
 {
-       init_controls();
-       init_strips( _max_strips, _unit_strips );
+       DEBUG_TRACE (DEBUG::MackieControl, "Surface::init\n");
+       
+       MIDI::Manager * mm = MIDI::Manager::instance();
+       MIDI::Port * input = mm->add_port (new MIDI::Port (string_compose (_("%1 in"), device_name), MIDI::Port::IsInput, jack));
+       MIDI::Port * output = mm->add_port (new MIDI::Port (string_compose (_("%1 out"), device_name), MIDI::Port::IsOutput, jack));
+
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface has ports named %1 and %2\n",
+                                                          input->name(), output->name()));
+
+       _port = new SurfacePort (*this, *input, *output);
+       _port->open();
+       _port->inactive_event.connect_same_thread (*this, boost::bind (&Surface::handle_port_inactive, this, _port));
+
+       switch (stype) {
+       case mcu:
+               init_controls ();
+               _jog_wheel = new Mackie::JogWheel (_mcp);
+               break;
+       default:
+               break;
+       }
+
+       switch (stype) {
+       case mcu:
+       case ext:
+               strips.resize (8);
+               init_strips ();
+               break;
+       default:
+               break;
+       }
+
+       DEBUG_TRACE (DEBUG::MackieControl, "Surface::init finish\n");
 }
 
-Surface::~Surface()
+Surface::~Surface ()
 {
+       DEBUG_TRACE (DEBUG::MackieControl, "Surface: destructor\n");
+
+       zero_all ();
+
        // delete groups
-       for( Groups::iterator it = groups.begin(); it != groups.end(); ++it )
-       {
+       for (Groups::iterator it = groups.begin(); it != groups.end(); ++it) {
                delete it->second;
        }
        
        // delete controls
-       for( Controls::iterator it = controls.begin(); it != controls.end(); ++it )
-       {
+       for (Controls::iterator it = controls.begin(); it != controls.end(); ++it) {
                delete *it;
        }
+       
+       delete _jog_wheel;
+       delete _port;
+}
+
+const MidiByteArray& 
+Surface::sysex_hdr() const
+{
+       switch  (_stype) {
+       case mcu: return mackie_sysex_hdr;
+       case ext: return mackie_sysex_hdr_xt;
+       }
+       cout << "SurfacePort::sysex_hdr _port_type not known" << endl;
+       return mackie_sysex_hdr;
 }
 
-// Mackie-specific, because of multiple devices on separate ports
-// add the strips from 9..max_strips
-// unit_strips is the number of strips for additional units.
-void Surface::init_strips( uint32_t max_strips, uint32_t unit_strips )
+static GlobalControlDefinition mackie_global_controls[] = {
+       { "jog", 0x3c, Jog::factory, "none" },
+       { "external", 0x2e, Pot::factory, "none" },
+       { "io", 0x28, Button::factory, "assignment" },
+       { "sends", 0x29, Button::factory, "assignment" },
+       { "pan", 0x2a, Button::factory, "assignment" },
+       { "plugin", 0x2b, Button::factory, "assignment" },
+       { "eq", 0x2c, Button::factory, "assignment" },
+       { "dyn", 0x2d, Button::factory, "assignment" },
+       { "left", 0x2e, Button::factory, "bank" },
+       { "right", 0x2f, Button::factory, "bank" },
+       { "channel_left", 0x30, Button::factory, "bank" },
+       { "channel_right", 0x31, Button::factory, "bank" },
+       { "flip", 0x32, Button::factory, "none" },
+       { "edit", 0x33, Button::factory, "none" },
+       { "name_value", 0x34, Button::factory, "display" },
+       { "timecode_beats", 0x35, Button::factory, "display" },
+       { "F1", 0x36, Button::factory, "none" },
+       { "F2", 0x37, Button::factory, "none" },
+       { "F3", 0x38, Button::factory, "none" },
+       { "F4", 0x39, Button::factory, "none" },
+       { "F5", 0x3a, Button::factory, "none" },
+       { "F6", 0x3b, Button::factory, "none" },
+       { "F7", 0x3c, Button::factory, "none" },
+       { "F8", 0x3d, Button::factory, "none" },
+       { "F9", 0x3e, Button::factory, "none" },
+       { "F10", 0x3f, Button::factory, "none" },
+       { "F11", 0x40, Button::factory, "none" },
+       { "F12", 0x41, Button::factory, "none" },
+       { "F13", 0x42, Button::factory, "none" },
+       { "F14", 0x43, Button::factory, "none" },
+       { "F15", 0x44, Button::factory, "none" },
+       { "F16", 0x45, Button::factory, "none" },
+       { "shift", 0x46, Button::factory, "modifiers" },
+       { "option", 0x47, Button::factory, "modifiers" },
+       { "control", 0x48, Button::factory, "modifiers" },
+       { "cmd_alt", 0x49, Button::factory, "modifiers" },
+       { "on", 0x4a, Button::factory, "automation" },
+       { "rec_ready", 0x4b, Button::factory, "automation" },
+       { "undo", 0x4c, Button::factory, "functions" },
+       { "snapshot", 0x4d, Button::factory, "automation" },
+       { "touch", 0x4e, Button::factory, "automation" },
+       { "redo", 0x4f, Button::factory, "functions" },
+       { "marker", 0x50, Button::factory, "functions" },
+       { "enter", 0x51, Button::factory, "functions" },
+       { "cancel", 0x52, Button::factory, "functions" },
+       { "mixer", 0x53, Button::factory, "functions" },
+       { "frm_left", 0x54, Button::factory, "transport" },
+       { "frm_right", 0x55, Button::factory, "transport" },
+       { "loop", 0x56, Button::factory, "transport" },
+       { "punch_in", 0x57, Button::factory, "transport" },
+       { "punch_out", 0x58, Button::factory, "transport" },
+       { "home", 0x59, Button::factory, "transport" },
+       { "end", 0x5a, Button::factory, "transport" },
+       { "rewind", 0x5b, Button::factory, "transport" },
+       { "ffwd", 0x5c, Button::factory, "transport" },
+       { "stop", 0x5d, Button::factory, "transport" },
+       { "play", 0x5e, Button::factory, "transport" },
+       { "record", 0x5f, Button::factory, "transport" },
+       { "cursor_up", 0x60, Button::factory, "cursor" },
+       { "cursor_down", 0x61, Button::factory, "cursor" },
+       { "cursor_left", 0x62, Button::factory, "cursor" },
+       { "cursor_right", 0x63, Button::factory, "cursor" },
+       { "zoom", 0x64, Button::factory, "none" },
+       { "scrub", 0x65, Button::factory, "none" },
+       { "user_a", 0x66, Button::factory, "user" },
+       { "user_b", 0x67, Button::factory, "user" },
+       { "fader_touch", 0x70, Led::factory, "master" },
+       { "timecode", 0x71, Led::factory, "none" },
+       { "beats", 0x72, Led::factory, "none" },
+       { "solo", 0x73, Led::factory, "none" },
+       { "relay_click", 0x73, Led::factory, "none" },
+       { "", 0, Button::factory, "" }
+};
+       
+void 
+Surface::init_controls()
+{
+       Group* group;
+
+       groups["assignment"] = new Group  ("assignment");
+       groups["automation"] = new Group  ("automation");
+       groups["bank"] = new Group  ("bank");
+       groups["cursor"] = new Group  ("cursor");
+       groups["display"] = new Group  ("display");
+       groups["functions"] = new Group  ("functions");
+       groups["modifiers"] = new Group  ("modifiers");
+       groups["none"] = new Group  ("none");
+       groups["transport"] = new Group  ("transport");
+       groups["user"] = new Group  ("user");
+       groups["master"] = new Group ("master");
+
+       for (uint32_t n = 0; mackie_global_controls[n].name[0]; ++n) {
+               group = groups[mackie_global_controls[n].group_name];
+               Control* control = mackie_global_controls[n].factory (*this, mackie_global_controls[n].id, mackie_global_controls[n].name, *group);
+               controls_by_name[mackie_global_controls[n].name] = control;
+               group->add (*control);
+       }
+}
+
+static StripControlDefinition mackie_strip_controls[] = {
+       { "gain", Control::fader_base_id, Fader::factory, },
+       { "vpot", Control::pot_base_id, Pot::factory, },
+       { "recenable", Control::recenable_button_base_id, Button::factory, },
+       { "solo", Control::solo_button_base_id, Button::factory, },
+       { "mute", Control::mute_button_base_id, Button::factory, },
+       { "select", Control::select_button_base_id, Button::factory, },
+       { "vselect", Control::vselect_button_base_id, Button::factory, },
+       { "fader_touch", Control::fader_touch_button_base_id, Button::factory, },
+       { "meter", 0, Meter::factory, },
+       { "", 0, Button::factory, }
+};
+
+void 
+Surface::init_strips ()
+{
+       for (uint32_t i = 0; i < 8; ++i) {
+
+               char name[32];
+               
+               snprintf (name, sizeof (name), "strip_%d", (8* _number) + i);
+
+               cerr << "Register strip " << i << endl;
+               
+               Strip* strip = new Strip (*this, name, i, mackie_strip_controls);
+               
+               groups[name] = strip;
+               strips[i] = strip;
+       }
+}
+
+void 
+Surface::display_timecode (const std::string & timecode, const std::string & timecode_last)
+{
+       if (has_timecode_display()) {
+               _port->write (builder.timecode_display (*this, timecode, timecode_last));
+       }
+}
+
+float 
+Surface::scaled_delta (const ControlState & state, float current_speed)
+{
+       return state.sign *  (std::pow (float(state.ticks + 1), 2) + current_speed) / 100.0;
+}
+
+void 
+Surface::display_bank_start (uint32_t current_bank)
+{
+       if  (current_bank == 0) {
+               // send Ar. to 2-char display on the master
+               _port->write (builder.two_char_display ("Ar", ".."));
+       } else {
+               // write the current first remote_id to the 2-char display
+               _port->write (builder.two_char_display (current_bank));
+       }
+}
+
+void 
+Surface::blank_jog_ring ()
+{
+       Control* control = controls_by_name["jog"];
+
+       if (control) {
+               _port->write (builder.build_led_ring (*(dynamic_cast<Pot*> (control)), off));
+       }
+}
+
+bool 
+Surface::has_timecode_display () const
+{
+       return false;
+}
+
+float
+Surface::scrub_scaling_factor () const
+{
+       return 100.0;
+}
+
+void 
+Surface::connect_to_signals ()
+{
+       if (!_connected) {
+
+               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 connecting to signals on port %2\n", 
+                                                                  number(), _port->input_port().name()));
+
+               MIDI::Parser* p = _port->input_port().parser();
+
+               /* V-Pot messages are Controller */
+               p->controller.connect_same_thread (*this, boost::bind (&Surface::handle_midi_controller_message, this, _1, _2));
+               /* Button messages are NoteOn */
+               p->note_on.connect_same_thread (*this, boost::bind (&Surface::handle_midi_note_on_message, this, _1, _2));
+               /* Fader messages are Pitchbend */
+               p->channel_pitchbend[0].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 0U));
+               p->channel_pitchbend[1].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 1U));
+               p->channel_pitchbend[2].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 2U));
+               p->channel_pitchbend[3].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 3U));
+               p->channel_pitchbend[4].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 4U));
+               p->channel_pitchbend[5].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 5U));
+               p->channel_pitchbend[6].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 6U));
+               p->channel_pitchbend[7].connect_same_thread (*this, boost::bind (&Surface::handle_midi_pitchbend_message, this, _1, _2, 7U));
+               
+               _connected = true;
+       }
+}
+
+
+void
+Surface::handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t pb, uint32_t fader_id)
 {
-       if ( strips.size() < max_strips )
-       {
-               strips.resize( max_strips );
-               for ( uint32_t i = strips.size(); i < max_strips; ++i )
-               {
-                       // because I can't find itoa
-                       ostringstream os;
-                       os << "strip_" << i + 1;
-                       string name = os.str();
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("handle_midi pitchbend on port %3, fader = %1 value = %2\n", 
+                                                          fader_id, pb, _number));
+       
+       Control* control = faders[fader_id];
+
+       if (control) {
+               float midi_pos = pb >> 4; // only the top 10 bytes are used
+               handle_control_event (*control, midi_pos / 1023.0);
+       } else {
+               DEBUG_TRACE (DEBUG::MackieControl, "fader not found\n");
+       }
+}
+
+void 
+Surface::handle_midi_note_on_message (MIDI::Parser &, MIDI::EventTwoBytes* ev)
+{
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("SurfacePort::handle_note_on %1 = %2\n", ev->note_number, ev->velocity));
+
+       Control* control = buttons[ev->note_number];
+
+       if (control) {
+               ControlState control_state (ev->velocity == 0x7f ? press : release);
+               control->set_in_use (control_state.button_state == press);
+               handle_control_event (*control, control_state);
+       } else {
+               DEBUG_TRACE (DEBUG::MackieControl, "button not found\n");
+       }
+}
+
+void 
+Surface::handle_midi_controller_message (MIDI::Parser &, MIDI::EventTwoBytes* ev)
+{
+       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("SurfacePort::handle_midi_controller %1 = %2\n", ev->controller_number, ev->value));
+
+       Control* control = pots[ev->controller_number];
+
+       if (!control && ev->controller_number == Control::jog_base_id) {
+               control = controls_by_name["jog"];
+       }
+
+       if (control) {
+               ControlState state;
+               
+               // bytes[2] & 0b01000000 (0x40) give sign
+               state.sign = (ev->value & 0x40) == 0 ? 1 : -1; 
+               // bytes[2] & 0b00111111 (0x3f) gives delta
+               state.ticks = (ev->value & 0x3f);
+               if (state.ticks == 0) {
+                       /* euphonix and perhaps other devices send zero
+                          when they mean 1, we think.
+                       */
+                       state.ticks = 1;
+               }
+               state.delta = float (state.ticks) / float (0x3f);
+               
+               /* Pots only emit events when they move, not when they
+                  stop moving. So to get a stop event, we need to use a timeout.
+               */
+               
+               control->set_in_use (true);
+               _mcp.add_in_use_timeout (*this, *control, control);
+
+               handle_control_event (*control, state);
+       } else {
+               DEBUG_TRACE (DEBUG::MackieControl, "pot not found\n");
+       }
+}
+
+void 
+Surface::handle_control_event (Control & control, const ControlState & state)
+{
+       // find the route for the control, if there is one
+       boost::shared_ptr<Route> route;
+       Strip* strip;
+
+       if ((strip = dynamic_cast<Strip*> (&control.group())) != 0) {
+               route = strip->route ();
+       }
+
+       // This handles control element events from the surface
+       // the state of the controls on the surface is usually updated
+       // from UI events.
+
+       switch (control.type()) {
+       case Control::type_fader:
+               // find the route in the route table for the id
+               // if the route isn't available, skip it
+               // at which point the fader should just reset itself
+               if (route != 0) {
+                       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("fader to %1\n", state.pos));
                        
-                       // shallow copy existing strip
-                       // which works because the controls
-                       // have the same ids across units
-                       Strip * strip = new Strip( *strips[i % unit_strips] );
+                       route->gain_control()->set_value (slider_position_to_gain (state.pos));
                        
-                       // update the relevant values
-                       strip->index( i );
-                       strip->name( name );
+                       if (ARDOUR::Config->get_mackie_emulation() == "bcf") {
+                               /* reset the timeout while we're still moving the fader */
+                               _mcp.add_in_use_timeout (*this, control, control.in_use_touch_control);
+                       }
                        
-                       // add to data structures
-                       groups[name] = strip;
-                       strips[i] = strip;
+                       // must echo bytes back to slider now, because
+                       // the notifier only works if the fader is not being
+                       // touched. Which it is if we're getting input.
+                       _port->write (builder.build_fader ((Fader&)control, state.pos));
                }
+               break;
+               
+       case Control::type_button:
+               if (strip) {
+                       strip->handle_button (*_port, control, state.button_state);
+               } else {
+                       // handle all non-strip buttons
+                       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("global button %1\n", control.id()));
+                       _mcp.handle_button_event (*this, dynamic_cast<Button&>(control), state.button_state);
+                       
+               }
+               break;
+               
+               // pot (jog wheel, external control)
+       case Control::type_pot:
+               if (strip) {
+                       DEBUG_TRACE (DEBUG::MackieControl, string_compose ("strip pot %1\n", control.id()));
+                       if (route) {
+                               boost::shared_ptr<Panner> panner = route->panner_shell()->panner();
+                               // pan for mono input routes, or stereo linked panners
+                               if (panner) {
+                                       double p = panner->position ();
+                                        
+                                       // calculate new value, and adjust
+                                       p += state.delta * state.sign;
+                                       p = min (1.0, p);
+                                       p = max (0.0, p);
+                                       panner->set_position (p);
+                               }
+                       } else {
+                               // it's a pot for an umnapped route, so turn all the lights off
+                               _port->write (builder.build_led_ring (dynamic_cast<Pot &> (control), off));
+                       }
+               } else {
+                       if (control.is_jog()) {
+                               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Jog wheel moved %1\n", state.ticks));
+                               if (_jog_wheel) {
+                                       _jog_wheel->jog_event (*_port, control, state);
+                               }
+                       } else {
+                               DEBUG_TRACE (DEBUG::MackieControl, string_compose ("External controller moved %1\n", state.ticks));
+                               cout << "external controller" << state.ticks * state.sign << endl;
+                       }
+               }
+               break;
+               
+       default:
+               break;
        }
 }
 
-ostream & Mackie::operator << ( ostream & os, const Mackie::Control & control )
+void 
+Surface::handle_port_inactive (SurfacePort * port)
 {
-       os << typeid( control ).name();
-       os << " { ";
-       os << "name: " << control.name();
-       os << ", ";
-       os << "id: " << "0x" << setw(2) << setfill('0') << hex << control.id() << setfill(' ');
-       os << ", ";
-       os << "ordinal: " << dec << control.ordinal();
-       os << ", ";
-       os << "group: " << control.group().name();
-       os << " }";
-       
-       return os;
-}
-
-/**
-       TODO could optimise this to use enum, but it's only
-       called during the protocol class instantiation.
-
-       generated using
-
-       irb -r controls.rb
-       sf=Surface.new
-       sf.parse
-       controls = sf.groups.find{|x| x[0] =~ /strip/}.each{|x| puts x[1]}
-       controls[1].each {|x| puts "\telse if ( control.name() == \"#{x.name}\" )\n\t{\n\t\t_#{x.name} = reinterpret_cast<#{x.class.name}*>(&control);\n\t}\n"}
-*/
-void Strip::add( Control & control )
-{
-       Group::add( control );
-       if ( control.name() == "gain" )
-       {
-               _gain = reinterpret_cast<Fader*>(&control);
-       }
-       else if ( control.name() == "vpot" )
-       {
-               _vpot = reinterpret_cast<Pot*>(&control);
-       }
-       else if ( control.name() == "recenable" )
-       {
-               _recenable = reinterpret_cast<Button*>(&control);
-       }
-       else if ( control.name() == "solo" )
-       {
-               _solo = reinterpret_cast<Button*>(&control);
-       }
-       else if ( control.name() == "mute" )
-       {
-               _mute = reinterpret_cast<Button*>(&control);
-       }
-       else if ( control.name() == "select" )
-       {
-               _select = reinterpret_cast<Button*>(&control);
-       }
-       else if ( control.name() == "vselect" )
-       {
-               _vselect = reinterpret_cast<Button*>(&control);
-       }
-       else if ( control.name() == "fader_touch" )
-       {
-               _fader_touch = reinterpret_cast<Button*>(&control);
-       }
-       else if ( control.type() == Control::type_led || control.type() == Control::type_led_ring )
-       {
-               // do nothing
-               cout << "Strip::add not adding " << control << endl;
-       }
-       else
-       {
-               ostringstream os;
-               os << "Strip::add: unknown control type " << control;
-               throw MackieControlException( os.str() );
+       _active = false;
+}
+
+void 
+Surface::write_sysex (const MidiByteArray & mba)
+{
+       if (mba.empty()) {
+               return;
+       }
+
+       MidiByteArray buf;
+       buf << sysex_hdr() << mba << MIDI::eox;
+       _port->write (buf);
+}
+
+void 
+Surface::write_sysex (MIDI::byte msg)
+{
+       MidiByteArray buf;
+       buf << sysex_hdr() << msg << MIDI::eox;
+       _port->write (buf);
+}
+
+void
+Surface::drop_routes ()
+{
+       for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
+               (*s)->set_route (boost::shared_ptr<Route>());
+       }
+}
+
+uint32_t
+Surface::n_strips () const
+{
+       return strips.size();
+}
+
+Strip*
+Surface::nth_strip (uint32_t n) const
+{
+       if (n > n_strips()) {
+               return 0;
+       }
+       return strips[n];
+}
+
+void
+Surface::zero_all ()
+{
+       // TODO turn off Timecode displays
+
+       // zero all strips
+       for (Strips::iterator it = strips.begin(); it != strips.end(); ++it) {
+               _port->write (builder.zero_strip (*this, **it));
+       }
+
+       // turn off global buttons and leds
+        // global buttons are only ever on mcu_port, so we don't have
+       // to figure out which port.
+
+       for (Controls::iterator it = controls.begin(); it != controls.end(); ++it) {
+               Control & control = **it;
+               if (!control.group().is_strip() && control.accepts_feedback()) {
+                       _port->write (builder.zero_control (control));
+               }
+       }
+
+       // any hardware-specific stuff
+       // clear 2-char display
+       _port->write (builder.two_char_display ("LC"));
+
+       // and the led ring for the master strip
+       blank_jog_ring ();
+}
+
+void
+Surface::periodic ()
+{
+       for (Strips::iterator s = strips.begin(); s != strips.end(); ++s) {
+               (*s)->periodic ();
+       }
+}
+
+void
+Surface::write (const MidiByteArray& data) 
+{
+       _port->write (data);
+}
+
+void 
+Surface::jog_wheel_state_display (JogWheel::State state)
+{
+       switch (state) {
+       case JogWheel::zoom:
+                       _port->write (builder.two_char_display ("Zm"));
+                       break;
+               case JogWheel::scroll:
+                       _port->write (builder.two_char_display ("Sc"));
+                       break;
+               case JogWheel::scrub:
+                       _port->write (builder.two_char_display ("Sb"));
+                       break;
+               case JogWheel::shuttle:
+                       _port->write (builder.two_char_display ("Sh"));
+                       break;
+               case JogWheel::speed:
+                       _port->write (builder.two_char_display ("Sp"));
+                       break;
+               case JogWheel::select:
+                       _port->write (builder.two_char_display ("Se"));
+                       break;
        }
 }