13
0
livetrax/libs/surfaces/mackie/mackie_control_protocol.cc
Paul Davis 411e2536c2 MCP: more button tracing, more config stuff
git-svn-id: svn://localhost/ardour2/branches/3.0@11962 d708f5d6-7413-0410-9779-e7cbd77b26cf
2012-04-13 17:58:36 +00:00

1347 lines
40 KiB
C++

/*
Copyright (C) 2006,2007 John Anderson
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <fcntl.h>
#include <iostream>
#include <algorithm>
#include <cmath>
#include <sstream>
#include <vector>
#include <iomanip>
#include <inttypes.h>
#include <float.h>
#include <sys/time.h>
#include <errno.h>
#include <poll.h>
#include <boost/shared_array.hpp>
#include "midi++/types.h"
#include "midi++/port.h"
#include "pbd/pthread_utils.h"
#include "pbd/error.h"
#include "pbd/memento_command.h"
#include "pbd/convert.h"
#include "ardour/automation_control.h"
#include "ardour/dB.h"
#include "ardour/debug.h"
#include "ardour/location.h"
#include "ardour/meter.h"
#include "ardour/panner.h"
#include "ardour/panner_shell.h"
#include "ardour/route.h"
#include "ardour/session.h"
#include "ardour/tempo.h"
#include "ardour/types.h"
#include "ardour/audioengine.h"
#include "mackie_control_protocol.h"
#include "midi_byte_array.h"
#include "mackie_control_exception.h"
#include "surface_port.h"
#include "surface.h"
#include "strip.h"
#include "control_group.h"
#include "meter.h"
#include "button.h"
#include "fader.h"
#include "pot.h"
using namespace ARDOUR;
using namespace std;
using namespace Mackie;
using namespace PBD;
using namespace Glib;
#include "i18n.h"
#include "pbd/abstract_ui.cc" // instantiate template
#define ui_bind(f, ...) boost::protect (boost::bind (f, __VA_ARGS__))
const int MackieControlProtocol::MODIFIER_OPTION = 0x1;
const int MackieControlProtocol::MODIFIER_CONTROL = 0x2;
const int MackieControlProtocol::MODIFIER_SHIFT = 0x3;
const int MackieControlProtocol::MODIFIER_CMDALT = 0x4;
MackieControlProtocol* MackieControlProtocol::_instance = 0;
bool MackieControlProtocol::probe()
{
return true;
}
MackieControlProtocol::MackieControlProtocol (Session& session)
: ControlProtocol (session, X_("Mackie"), this)
, AbstractUI<MackieControlUIRequest> ("mackie")
, _current_initial_bank (0)
, _timecode_type (ARDOUR::AnyTime::BBT)
, _input_bundle (new ARDOUR::Bundle (_("Mackie Control In"), true))
, _output_bundle (new ARDOUR::Bundle (_("Mackie Control Out"), false))
, _gui (0)
, _zoom_mode (false)
, _scrub_mode (false)
, _flip_mode (false)
, _view_mode (Mixer)
, _current_selected_track (-1)
, _modifier_state (0)
{
DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::MackieControlProtocol\n");
DeviceInfo::reload_device_info ();
set_device (Config->get_mackie_device_name());
AudioEngine::instance()->PortConnectedOrDisconnected.connect (
audio_engine_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::port_connected_or_disconnected, this, _2, _4, _5),
this
);
TrackSelectionChanged.connect (gui_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::gui_track_selection_changed, this, _1), this);
_instance = this;
build_button_map ();
}
MackieControlProtocol::~MackieControlProtocol()
{
DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::~MackieControlProtocol\n");
_active = false;
try {
close();
}
catch (exception & e) {
cout << "~MackieControlProtocol caught " << e.what() << endl;
}
catch (...) {
cout << "~MackieControlProtocol caught unknown" << endl;
}
DEBUG_TRACE (DEBUG::MackieControl, "finished ~MackieControlProtocol::MackieControlProtocol\n");
_instance = 0;
}
void
MackieControlProtocol::thread_init ()
{
struct sched_param rtparam;
pthread_set_name (X_("MackieControl"));
PBD::notify_gui_about_thread_creation (X_("gui"), pthread_self(), X_("MackieControl"), 2048);
ARDOUR::SessionEvent::create_per_thread_pool (X_("MackieControl"), 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.
}
}
// go to the previous track.
// Assume that get_sorted_routes().size() > route_table.size()
void
MackieControlProtocol::prev_track()
{
if (_current_initial_bank >= 1) {
switch_banks (_current_initial_bank - 1);
}
}
// go to the next track.
// Assume that get_sorted_routes().size() > route_table.size()
void
MackieControlProtocol::next_track()
{
Sorted sorted = get_sorted_routes();
if (_current_initial_bank + n_strips() < sorted.size()) {
switch_banks (_current_initial_bank + 1);
}
}
// predicate for sort call in get_sorted_routes
struct RouteByRemoteId
{
bool operator () (const boost::shared_ptr<Route> & a, const boost::shared_ptr<Route> & b) const
{
return a->remote_control_id() < b->remote_control_id();
}
bool operator () (const Route & a, const Route & b) const
{
return a.remote_control_id() < b.remote_control_id();
}
bool operator () (const Route * a, const Route * b) const
{
return a->remote_control_id() < b->remote_control_id();
}
};
MackieControlProtocol::Sorted
MackieControlProtocol::get_sorted_routes()
{
Sorted sorted;
// fetch all routes
boost::shared_ptr<RouteList> routes = session->get_routes();
set<uint32_t> remote_ids;
// routes with remote_id 0 should never be added
// TODO verify this with ardour devs
// remote_ids.insert (0);
// sort in remote_id order, and exclude master, control and hidden routes
// and any routes that are already set.
for (RouteList::iterator it = routes->begin(); it != routes->end(); ++it) {
Route & route = **it;
if (remote_ids.find (route.remote_control_id()) != remote_ids.end()) {
continue;
}
if (route.is_hidden() || route.is_master() || route.is_monitor()) {
continue;
}
switch (_view_mode) {
case Mixer:
break;
case AudioTracks:
break;
case Busses:
break;
case MidiTracks:
break;
case Dynamics:
break;
case EQ:
break;
case Loop:
break;
case Sends:
break;
case Plugins:
break;
}
sorted.push_back (*it);
remote_ids.insert (route.remote_control_id());
}
sort (sorted.begin(), sorted.end(), RouteByRemoteId());
return sorted;
}
void
MackieControlProtocol::refresh_current_bank()
{
switch_banks (_current_initial_bank, true);
}
uint32_t
MackieControlProtocol::n_strips() const
{
uint32_t strip_count = 0;
for (Surfaces::const_iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
strip_count += (*si)->n_strips ();
}
return strip_count;
}
void
MackieControlProtocol::switch_banks (uint32_t initial, bool force)
{
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch banking to start at %1 force ? %2 current = %3\n", initial, force, _current_initial_bank));
if (initial == _current_initial_bank && !force) {
return;
}
Sorted sorted = get_sorted_routes();
uint32_t strip_cnt = n_strips();
if (sorted.size() <= strip_cnt && !force) {
/* no banking - not enough routes to fill all strips */
return;
}
uint32_t delta = sorted.size() - strip_cnt;
if (delta > 0 && initial > delta) {
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("not switching to %1\n", initial));
return;
}
_current_initial_bank = initial;
_current_selected_track = -1;
for (Surfaces::iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
(*si)->drop_routes ();
}
// Map current bank of routes onto each surface(+strip)
if (_current_initial_bank <= sorted.size()) {
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch to %1, %2, available routes %3\n", _current_initial_bank, strip_cnt, sorted.size()));
// link routes to strips
Sorted::iterator r = sorted.begin() + _current_initial_bank;
for (Surfaces::iterator si = surfaces.begin(); si != surfaces.end(); ++si) {
vector<boost::shared_ptr<Route> > routes;
uint32_t added = 0;
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface has %1 strips\n", (*si)->n_strips()));
for (; r != sorted.end() && added < (*si)->n_strips(); ++r, ++added) {
routes.push_back (*r);
}
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("give surface %1 routes\n", routes.size()));
(*si)->map_routes (routes);
}
}
/* reset this to get the right display of view mode after the switch */
set_view_mode (_view_mode);
/* current bank has not been saved */
session->set_dirty();
}
int
MackieControlProtocol::set_active (bool yn)
{
if (yn == _active) {
return 0;
}
try
{
if (yn) {
/* start event loop */
BaseUI::run ();
create_surfaces ();
connect_session_signals ();
_active = true;
update_surfaces ();
/* set up periodic task for metering and automation
*/
Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (100); // milliseconds
periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &MackieControlProtocol::periodic));
periodic_timeout->attach (main_loop()->get_context());
} else {
BaseUI::quit ();
close();
_active = false;
}
}
catch (exception & e) {
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("set_active to false because exception caught: %1\n", e.what()));
_active = false;
throw;
}
return 0;
}
bool
MackieControlProtocol::periodic ()
{
if (!_active) {
return false;
}
struct timeval now;
uint64_t now_usecs;
gettimeofday (&now, 0);
now_usecs = (now.tv_sec * 1000000) + now.tv_usec;
for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
(*s)->periodic (now_usecs);
}
return true;
}
void
MackieControlProtocol::update_timecode_beats_led()
{
switch (_timecode_type) {
case ARDOUR::AnyTime::BBT:
update_global_led ("beats", on);
update_global_led ("timecode", off);
break;
case ARDOUR::AnyTime::Timecode:
update_global_led ("timecode", on);
update_global_led ("beats", off);
break;
default:
ostringstream os;
os << "Unknown Anytime::Type " << _timecode_type;
throw runtime_error (os.str());
}
}
void
MackieControlProtocol::update_global_button (const string & name, LedState ls)
{
boost::shared_ptr<Surface> surface = surfaces.front();
if (!surface->type() == mcu) {
return;
}
if (surface->controls_by_name.find (name) != surface->controls_by_name.end()) {
Button * button = dynamic_cast<Button*> (surface->controls_by_name[name]);
surface->write (button->set_state (ls));
} else {
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Button %1 not found\n", name));
}
}
void
MackieControlProtocol::update_global_led (const string & name, LedState ls)
{
boost::shared_ptr<Surface> surface = surfaces.front();
if (!surface->type() == mcu) {
return;
}
if (surface->controls_by_name.find (name) != surface->controls_by_name.end()) {
Led * led = dynamic_cast<Led*> (surface->controls_by_name[name]);
surface->write (led->set_state (ls));
} else {
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Led %1 not found\n", name));
}
}
// send messages to surface to set controls to correct values
void
MackieControlProtocol::update_surfaces()
{
if (!_active) {
return;
}
// do the initial bank switch to connect signals
// _current_initial_bank is initialised by set_state
switch_banks (_current_initial_bank, true);
// sometimes the jog wheel is a pot
surfaces.front()->blank_jog_ring ();
// update global buttons and displays
notify_record_state_changed();
notify_transport_state_changed();
update_timecode_beats_led();
}
void
MackieControlProtocol::connect_session_signals()
{
// receive routes added
session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_route_added, this, _1), this);
// receive record state toggled
session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_record_state_changed, this), this);
// receive transport state changed
session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_transport_state_changed, this), this);
session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_loop_state_changed, this), this);
// receive punch-in and punch-out
Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_parameter_changed, this, _1), this);
// receive rude solo changed
session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_solo_active_changed, this, _1), this);
// make sure remote id changed signals reach here
// see also notify_route_added
Sorted sorted = get_sorted_routes();
for (Sorted::iterator it = sorted.begin(); it != sorted.end(); ++it) {
(*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind(&MackieControlProtocol::notify_remote_id_changed, this), this);
}
}
void
MackieControlProtocol::set_device (const string& device_name)
{
map<string,DeviceInfo>::iterator d = DeviceInfo::device_info.find (device_name);
if (d == DeviceInfo::device_info.end()) {
return;
}
_device_info = d->second;
/* store it away in a global location */
Config->set_mackie_device_name (device_name);
if (_active) {
clear_ports ();
surfaces.clear ();
create_surfaces ();
switch_banks (0, true);
}
}
void
MackieControlProtocol::create_surfaces ()
{
string device_name;
surface_type_t stype = mcu;
char buf[128];
if (_device_info.extenders() == 0) {
device_name = X_("mackie control");
} else {
device_name = X_("mackie control #1");
}
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Create %1 surfaces\n", 1 + _device_info.extenders()));
for (uint32_t n = 0; n < 1 + _device_info.extenders(); ++n) {
boost::shared_ptr<Surface> surface (new Surface (*this, device_name, n, stype));
surfaces.push_back (surface);
/* next device will be an extender */
if (_device_info.extenders() < 2) {
device_name = X_("mackie control #2");
} else {
snprintf (buf, sizeof (buf), X_("mackie control #%d"), n+2);
device_name = buf;
}
stype = ext;
_input_bundle->add_channel (
surface->port().input_port().name(),
ARDOUR::DataType::MIDI,
session->engine().make_port_name_non_relative (surface->port().input_port().name())
);
_output_bundle->add_channel (
surface->port().output_port().name(),
ARDOUR::DataType::MIDI,
session->engine().make_port_name_non_relative (surface->port().output_port().name())
);
int fd;
MIDI::Port& input_port (surface->port().input_port());
if ((fd = input_port.selectable ()) >= 0) {
Glib::RefPtr<IOSource> psrc = IOSource::create (fd, IO_IN|IO_HUP|IO_ERR);
psrc->connect (sigc::bind (sigc::mem_fun (this, &MackieControlProtocol::midi_input_handler), &input_port));
psrc->attach (main_loop()->get_context());
// glibmm hack: for now, store only the GSource*
port_sources.push_back (psrc->gobj());
g_source_ref (psrc->gobj());
}
}
}
void
MackieControlProtocol::close()
{
clear_ports ();
port_connections.drop_connections ();
session_connections.drop_connections ();
route_connections.drop_connections ();
periodic_connection.disconnect ();
surfaces.clear ();
}
XMLNode&
MackieControlProtocol::get_state()
{
DEBUG_TRACE (DEBUG::MackieControl, "MackieControlProtocol::get_state\n");
// add name of protocol
XMLNode* node = new XMLNode (X_("Protocol"));
node->add_property (X_("name"), ARDOUR::ControlProtocol::_name);
// add current bank
ostringstream os;
os << _current_initial_bank;
node->add_property (X_("bank"), os.str());
for (uint32_t n = 0; n < 16; ++n) {
ostringstream s;
s << string_compose ("f%1-action", n+1);
node->add_property (s.str().c_str(), f_action (n));
}
return *node;
}
int
MackieControlProtocol::set_state (const XMLNode & node, int /*version*/)
{
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("MackieControlProtocol::set_state: active %1\n", _active));
int retval = 0;
const XMLProperty* prop;
// fetch current bank
if ((prop = node.property (X_("bank"))) != 0) {
string bank = prop->value();
set_active (true);
uint32_t new_bank = atoi (bank.c_str());
if (_current_initial_bank != new_bank) {
switch_banks (new_bank);
}
}
_f_actions.clear ();
_f_actions.resize (16);
for (uint32_t n = 0; n < 16; ++n) {
string action;
if ((prop = node.property (string_compose ("f%1-action", n+1))) != 0) {
action = prop->value();
}
if (action.empty()) {
/* default action if nothing is specified */
action = string_compose ("Editor/goto-visual-state-%1", n+1);
}
_f_actions[n] = action;
}
return retval;
}
/////////////////////////////////////////////////
// handlers for Route signals
// TODO should these be part of RouteSignal?
// They started off as signal/slot handlers for signals
// from Route, but they're also used in polling for automation
/////////////////////////////////////////////////
// TODO handle plugin automation polling
string
MackieControlProtocol::format_bbt_timecode (framepos_t now_frame)
{
Timecode::BBT_Time bbt_time;
session->bbt_time (now_frame, bbt_time);
// According to the Logic docs
// digits: 888/88/88/888
// BBT mode: Bars/Beats/Subdivisions/Ticks
ostringstream os;
os << setw(3) << setfill('0') << bbt_time.bars;
os << setw(2) << setfill('0') << bbt_time.beats;
// figure out subdivisions per beat
const ARDOUR::Meter & meter = session->tempo_map().meter_at (now_frame);
int subdiv = 2;
if (meter.note_divisor() == 8 && (meter.divisions_per_bar() == 12.0 || meter.divisions_per_bar() == 9.0 || meter.divisions_per_bar() == 6.0)) {
subdiv = 3;
}
uint32_t subdivisions = bbt_time.ticks / uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
uint32_t ticks = bbt_time.ticks % uint32_t (Timecode::BBT_Time::ticks_per_beat / subdiv);
os << setw(2) << setfill('0') << subdivisions + 1;
os << setw(3) << setfill('0') << ticks;
return os.str();
}
string
MackieControlProtocol::format_timecode_timecode (framepos_t now_frame)
{
Timecode::Time timecode;
session->timecode_time (now_frame, timecode);
// According to the Logic docs
// digits: 888/88/88/888
// Timecode mode: Hours/Minutes/Seconds/Frames
ostringstream os;
os << setw(3) << setfill('0') << timecode.hours;
os << setw(2) << setfill('0') << timecode.minutes;
os << setw(2) << setfill('0') << timecode.seconds;
os << setw(3) << setfill('0') << timecode.frames;
return os.str();
}
void
MackieControlProtocol::update_timecode_display()
{
boost::shared_ptr<Surface> surface = surfaces.front();
if (surface->type() != mcu || !surface->has_timecode_display()) {
return;
}
// do assignment here so current_frame is fixed
framepos_t current_frame = session->transport_frame();
string timecode;
switch (_timecode_type) {
case ARDOUR::AnyTime::BBT:
timecode = format_bbt_timecode (current_frame);
break;
case ARDOUR::AnyTime::Timecode:
timecode = format_timecode_timecode (current_frame);
break;
default:
return;
}
// only write the timecode string to the MCU if it's changed
// since last time. This is to reduce midi bandwidth used.
if (timecode != _timecode_last) {
surface->display_timecode (timecode, _timecode_last);
_timecode_last = timecode;
}
}
///////////////////////////////////////////
// Session signals
///////////////////////////////////////////
void MackieControlProtocol::notify_parameter_changed (std::string const & p)
{
if (p == "punch-in") {
update_global_button ("punch_in", session->config.get_punch_in());
} else if (p == "punch-out") {
update_global_button ("punch_out", session->config.get_punch_out());
} else if (p == "clicking") {
update_global_button ("clicking", Config->get_clicking());
} else {
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("parameter changed: %1\n", p));
}
}
// RouteList is the set of routes that have just been added
void
MackieControlProtocol::notify_route_added (ARDOUR::RouteList & rl)
{
// currently assigned banks are less than the full set of
// strips, so activate the new strip now.
refresh_current_bank();
// otherwise route added, but current bank needs no updating
// make sure remote id changes in the new route are handled
typedef ARDOUR::RouteList ARS;
for (ARS::iterator it = rl.begin(); it != rl.end(); ++it) {
(*it)->RemoteControlIDChanged.connect (route_connections, MISSING_INVALIDATOR, ui_bind (&MackieControlProtocol::notify_remote_id_changed, this), this);
}
}
void
MackieControlProtocol::notify_solo_active_changed (bool active)
{
boost::shared_ptr<Surface> surface = surfaces.front();
Led* rude_solo = dynamic_cast<Led*> (surface->controls_by_name["solo"]);
if (rude_solo) {
surface->write (rude_solo->set_state (active ? flashing : off));
}
}
void
MackieControlProtocol::notify_remote_id_changed()
{
Sorted sorted = get_sorted_routes();
uint32_t sz = n_strips();
// if a remote id has been moved off the end, we need to shift
// the current bank backwards.
if (sorted.size() - _current_initial_bank < sz) {
// but don't shift backwards past the zeroth channel
switch_banks (max((Sorted::size_type) 0, sorted.size() - sz));
} else {
// Otherwise just refresh the current bank
refresh_current_bank();
}
}
///////////////////////////////////////////
// Transport signals
///////////////////////////////////////////
void
MackieControlProtocol::notify_loop_state_changed()
{
update_global_button ("loop", session->get_play_loop());
}
void
MackieControlProtocol::notify_transport_state_changed()
{
// switch various play and stop buttons on / off
update_global_button ("play", session->transport_speed() == 1.0);
update_global_button ("stop", !session->transport_rolling());
update_global_button ("rewind", session->transport_speed() < 0.0);
update_global_button ("ffwd", session->transport_speed() > 1.0);
_transport_previously_rolling = session->transport_rolling();
}
void
MackieControlProtocol::notify_record_state_changed ()
{
/* rec is a tristate */
Button * rec = reinterpret_cast<Button*> (surfaces.front()->controls_by_name["record"]);
if (rec) {
LedState ls;
switch (session->record_status()) {
case Session::Disabled:
DEBUG_TRACE (DEBUG::MackieControl, "record state changed to disabled, LED off\n");
ls = off;
break;
case Session::Recording:
DEBUG_TRACE (DEBUG::MackieControl, "record state changed to recording, LED on\n");
ls = on;
break;
case Session::Enabled:
DEBUG_TRACE (DEBUG::MackieControl, "record state changed to enabled, LED flashing\n");
ls = flashing;
break;
}
surfaces.front()->write (rec->set_state (ls));
} else {
DEBUG_TRACE (DEBUG::MackieControl, "record button control not found\n");
}
}
list<boost::shared_ptr<ARDOUR::Bundle> >
MackieControlProtocol::bundles ()
{
list<boost::shared_ptr<ARDOUR::Bundle> > b;
b.push_back (_input_bundle);
b.push_back (_output_bundle);
return b;
}
void
MackieControlProtocol::port_connected_or_disconnected (string a, string b, bool connected)
{
/* If something is connected to one of our output ports, send MIDI to update the surface
to whatever state it should have.
*/
if (!connected) {
return;
}
for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
string const n = AudioEngine::instance()->make_port_name_non_relative ((*s)->port().output_port().name ());
if (a == n || b == n) {
update_surfaces ();
return;
}
}
}
void
MackieControlProtocol::do_request (MackieControlUIRequest* req)
{
if (req->type == CallSlot) {
call_slot (MISSING_INVALIDATOR, req->the_slot);
} else if (req->type == Quit) {
stop ();
}
}
int
MackieControlProtocol::stop ()
{
BaseUI::quit ();
return 0;
}
/** Add a timeout so that a control's in_use flag will be reset some time in the future.
* @param in_use_control the control whose in_use flag to reset.
* @param touch_control a touch control to emit an event for, or 0.
*/
void
MackieControlProtocol::add_in_use_timeout (Surface& surface, Control& in_use_control, boost::weak_ptr<AutomationControl> touched)
{
Glib::RefPtr<Glib::TimeoutSource> timeout (Glib::TimeoutSource::create (250)); // milliseconds
in_use_control.in_use_connection.disconnect ();
in_use_control.in_use_connection = timeout->connect (
sigc::bind (sigc::mem_fun (*this, &MackieControlProtocol::control_in_use_timeout), &surface, &in_use_control, touched));
timeout->attach (main_loop()->get_context());
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("timeout queued for surface %1, control %2\n",
surface.number(), &in_use_control));}
/** Handle timeouts to reset in_use for controls that can't
* do this by themselves (e.g. pots, and faders without touch support).
* @param in_use_control the control whose in_use flag to reset.
* @param touch_control a touch control to emit an event for, or 0.
*/
bool
MackieControlProtocol::control_in_use_timeout (Surface* surface, Control* in_use_control, boost::weak_ptr<AutomationControl> wtouched)
{
boost::shared_ptr<AutomationControl> touched (wtouched.lock());
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("timeout elapsed for surface %1, control %2\n", surface->number(), in_use_control));
in_use_control->set_in_use (false);
if (touched) {
/* end the touch, and mark the end */
touched->stop_touch (session->transport_frame(), true);
}
// only call this method once from the timer
return false;
}
void
MackieControlProtocol::update_led (Surface& surface, Button& button, Mackie::LedState ls)
{
if (ls != none) {
surface.port().write (button.set_state (ls));
}
}
void
MackieControlProtocol::build_button_map ()
{
#define DEFINE_BUTTON_HANDLER(b,p,r) button_map.insert (pair<int,ButtonHandlers> ((b), ButtonHandlers ((p),(r))));
DEFINE_BUTTON_HANDLER (Button::Io, &MackieControlProtocol::io_press, &MackieControlProtocol::io_release);
DEFINE_BUTTON_HANDLER (Button::Sends, &MackieControlProtocol::sends_press, &MackieControlProtocol::sends_release);
DEFINE_BUTTON_HANDLER (Button::Pan, &MackieControlProtocol::pan_press, &MackieControlProtocol::pan_release);
DEFINE_BUTTON_HANDLER (Button::Plugin, &MackieControlProtocol::plugin_press, &MackieControlProtocol::plugin_release);
DEFINE_BUTTON_HANDLER (Button::Eq, &MackieControlProtocol::eq_press, &MackieControlProtocol::eq_release);
DEFINE_BUTTON_HANDLER (Button::Dyn, &MackieControlProtocol::dyn_press, &MackieControlProtocol::dyn_release);
DEFINE_BUTTON_HANDLER (Button::Left, &MackieControlProtocol::left_press, &MackieControlProtocol::left_release);
DEFINE_BUTTON_HANDLER (Button::Right, &MackieControlProtocol::right_press, &MackieControlProtocol::right_release);
DEFINE_BUTTON_HANDLER (Button::ChannelLeft, &MackieControlProtocol::channel_left_press, &MackieControlProtocol::channel_left_release);
DEFINE_BUTTON_HANDLER (Button::ChannelRight, &MackieControlProtocol::channel_right_press, &MackieControlProtocol::channel_right_release);
DEFINE_BUTTON_HANDLER (Button::Flip, &MackieControlProtocol::flip_press, &MackieControlProtocol::flip_release);
DEFINE_BUTTON_HANDLER (Button::Edit, &MackieControlProtocol::edit_press, &MackieControlProtocol::edit_release);
DEFINE_BUTTON_HANDLER (Button::NameValue, &MackieControlProtocol::name_value_press, &MackieControlProtocol::name_value_release);
DEFINE_BUTTON_HANDLER (Button::TimecodeBeats, &MackieControlProtocol::timecode_beats_press, &MackieControlProtocol::timecode_beats_release);
DEFINE_BUTTON_HANDLER (Button::F1, &MackieControlProtocol::F1_press, &MackieControlProtocol::F1_release);
DEFINE_BUTTON_HANDLER (Button::F2, &MackieControlProtocol::F2_press, &MackieControlProtocol::F2_release);
DEFINE_BUTTON_HANDLER (Button::F3, &MackieControlProtocol::F3_press, &MackieControlProtocol::F3_release);
DEFINE_BUTTON_HANDLER (Button::F4, &MackieControlProtocol::F4_press, &MackieControlProtocol::F4_release);
DEFINE_BUTTON_HANDLER (Button::F5, &MackieControlProtocol::F5_press, &MackieControlProtocol::F5_release);
DEFINE_BUTTON_HANDLER (Button::F6, &MackieControlProtocol::F6_press, &MackieControlProtocol::F6_release);
DEFINE_BUTTON_HANDLER (Button::F7, &MackieControlProtocol::F7_press, &MackieControlProtocol::F7_release);
DEFINE_BUTTON_HANDLER (Button::F8, &MackieControlProtocol::F8_press, &MackieControlProtocol::F8_release);
DEFINE_BUTTON_HANDLER (Button::F9, &MackieControlProtocol::F9_press, &MackieControlProtocol::F9_release);
DEFINE_BUTTON_HANDLER (Button::F10, &MackieControlProtocol::F10_press, &MackieControlProtocol::F10_release);
DEFINE_BUTTON_HANDLER (Button::F11, &MackieControlProtocol::F11_press, &MackieControlProtocol::F11_release);
DEFINE_BUTTON_HANDLER (Button::F12, &MackieControlProtocol::F12_press, &MackieControlProtocol::F12_release);
DEFINE_BUTTON_HANDLER (Button::F13, &MackieControlProtocol::F13_press, &MackieControlProtocol::F13_release);
DEFINE_BUTTON_HANDLER (Button::F14, &MackieControlProtocol::F14_press, &MackieControlProtocol::F14_release);
DEFINE_BUTTON_HANDLER (Button::F15, &MackieControlProtocol::F15_press, &MackieControlProtocol::F15_release);
DEFINE_BUTTON_HANDLER (Button::F16, &MackieControlProtocol::F16_press, &MackieControlProtocol::F16_release);
DEFINE_BUTTON_HANDLER (Button::Shift, &MackieControlProtocol::shift_press, &MackieControlProtocol::shift_release);
DEFINE_BUTTON_HANDLER (Button::Option, &MackieControlProtocol::option_press, &MackieControlProtocol::option_release);
DEFINE_BUTTON_HANDLER (Button::Ctrl, &MackieControlProtocol::control_press, &MackieControlProtocol::control_release);
DEFINE_BUTTON_HANDLER (Button::CmdAlt, &MackieControlProtocol::cmd_alt_press, &MackieControlProtocol::cmd_alt_release);
DEFINE_BUTTON_HANDLER (Button::On, &MackieControlProtocol::on_press, &MackieControlProtocol::on_release);
DEFINE_BUTTON_HANDLER (Button::RecReady, &MackieControlProtocol::rec_ready_press, &MackieControlProtocol::rec_ready_release);
DEFINE_BUTTON_HANDLER (Button::Undo, &MackieControlProtocol::undo_press, &MackieControlProtocol::undo_release);
DEFINE_BUTTON_HANDLER (Button::Save, &MackieControlProtocol::save_press, &MackieControlProtocol::save_release);
DEFINE_BUTTON_HANDLER (Button::Touch, &MackieControlProtocol::touch_press, &MackieControlProtocol::touch_release);
DEFINE_BUTTON_HANDLER (Button::Redo, &MackieControlProtocol::redo_press, &MackieControlProtocol::redo_release);
DEFINE_BUTTON_HANDLER (Button::Marker, &MackieControlProtocol::marker_press, &MackieControlProtocol::marker_release);
DEFINE_BUTTON_HANDLER (Button::Enter, &MackieControlProtocol::enter_press, &MackieControlProtocol::enter_release);
DEFINE_BUTTON_HANDLER (Button::Cancel, &MackieControlProtocol::cancel_press, &MackieControlProtocol::cancel_release);
DEFINE_BUTTON_HANDLER (Button::Mixer, &MackieControlProtocol::mixer_press, &MackieControlProtocol::mixer_release);
DEFINE_BUTTON_HANDLER (Button::FrmLeft, &MackieControlProtocol::frm_left_press, &MackieControlProtocol::frm_left_release);
DEFINE_BUTTON_HANDLER (Button::FrmRight, &MackieControlProtocol::frm_right_press, &MackieControlProtocol::frm_right_release);
DEFINE_BUTTON_HANDLER (Button::Loop, &MackieControlProtocol::loop_press, &MackieControlProtocol::loop_release);
DEFINE_BUTTON_HANDLER (Button::PunchIn, &MackieControlProtocol::punch_in_press, &MackieControlProtocol::punch_in_release);
DEFINE_BUTTON_HANDLER (Button::PunchOut, &MackieControlProtocol::punch_out_press, &MackieControlProtocol::punch_out_release);
DEFINE_BUTTON_HANDLER (Button::Home, &MackieControlProtocol::home_press, &MackieControlProtocol::home_release);
DEFINE_BUTTON_HANDLER (Button::End, &MackieControlProtocol::end_press, &MackieControlProtocol::end_release);
DEFINE_BUTTON_HANDLER (Button::Rewind, &MackieControlProtocol::rewind_press, &MackieControlProtocol::rewind_release);
DEFINE_BUTTON_HANDLER (Button::Ffwd, &MackieControlProtocol::ffwd_press, &MackieControlProtocol::ffwd_release);
DEFINE_BUTTON_HANDLER (Button::Stop, &MackieControlProtocol::stop_press, &MackieControlProtocol::stop_release);
DEFINE_BUTTON_HANDLER (Button::Play, &MackieControlProtocol::play_press, &MackieControlProtocol::play_release);
DEFINE_BUTTON_HANDLER (Button::Record, &MackieControlProtocol::record_press, &MackieControlProtocol::record_release);
DEFINE_BUTTON_HANDLER (Button::CursorUp, &MackieControlProtocol::cursor_up_press, &MackieControlProtocol::cursor_up_release);
DEFINE_BUTTON_HANDLER (Button::CursorDown, &MackieControlProtocol::cursor_down_press, &MackieControlProtocol::cursor_down_release);
DEFINE_BUTTON_HANDLER (Button::CursorLeft, &MackieControlProtocol::cursor_left_press, &MackieControlProtocol::cursor_left_release);
DEFINE_BUTTON_HANDLER (Button::CursorRight, &MackieControlProtocol::cursor_right_press, &MackieControlProtocol::cursor_right_release);
DEFINE_BUTTON_HANDLER (Button::Zoom, &MackieControlProtocol::zoom_press, &MackieControlProtocol::zoom_release);
DEFINE_BUTTON_HANDLER (Button::Scrub, &MackieControlProtocol::scrub_press, &MackieControlProtocol::scrub_release);
DEFINE_BUTTON_HANDLER (Button::UserA, &MackieControlProtocol::user_a_press, &MackieControlProtocol::user_a_release);
DEFINE_BUTTON_HANDLER (Button::UserB, &MackieControlProtocol::user_b_press, &MackieControlProtocol::user_b_release);
}
void
MackieControlProtocol::handle_button_event (Surface& surface, Button& button, ButtonState bs)
{
if (bs != press && bs != release) {
update_led (surface, button, none);
return;
}
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Handling %1 for button %2\n", (bs == press ? "press" : "release"), button.id()));
ButtonMap::iterator b = button_map.find (button.id());
if (b != button_map.end()) {
ButtonHandlers& bh (b->second);
switch (bs) {
case press:
surface.write (button.set_state ((this->*(bh.press)) (button)));
case release:
surface.write (button.set_state ((this->*(bh.release)) (button)));
break;
default:
break;
}
} else {
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("no button handlers for ID %1\n", button.id()));
}
}
bool
MackieControlProtocol::midi_input_handler (IOCondition ioc, MIDI::Port* port)
{
DEBUG_TRACE (DEBUG::MidiIO, string_compose ("something happend on %1\n", port->name()));
if (ioc & ~IO_IN) {
return false;
}
if (ioc & IO_IN) {
CrossThreadChannel::drain (port->selectable());
DEBUG_TRACE (DEBUG::MidiIO, string_compose ("data available on %1\n", port->name()));
framepos_t now = session->engine().frame_time();
port->parse (now);
}
return true;
}
void
MackieControlProtocol::clear_ports ()
{
_input_bundle->remove_channels ();
_output_bundle->remove_channels ();
for (PortSources::iterator i = port_sources.begin(); i != port_sources.end(); ++i) {
g_source_destroy (*i);
g_source_unref (*i);
}
port_sources.clear ();
}
string
MackieControlProtocol::f_action (uint32_t fn)
{
if (fn >= _f_actions.size()) {
return string();
}
return _f_actions[fn];
}
void
MackieControlProtocol::f_press (uint32_t fn)
{
string action = f_action (0);
if (!action.empty()) {
access_action (action);
}
}
void
MackieControlProtocol::set_view_mode (ViewMode m)
{
_view_mode = m;
for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
(*s)->update_view_mode_display ();
}
}
void
MackieControlProtocol::set_flip_mode (bool yn)
{
_flip_mode = yn;
for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
(*s)->update_flip_mode_display ();
}
}
void
MackieControlProtocol::set_master_on_surface_strip (uint32_t surface, uint32_t strip_number)
{
force_special_route_to_strip (session->master_out(), surface, strip_number);
}
void
MackieControlProtocol::set_monitor_on_surface_strip (uint32_t surface, uint32_t strip_number)
{
force_special_route_to_strip (session->monitor_out(), surface, strip_number);
}
void
MackieControlProtocol::force_special_route_to_strip (boost::shared_ptr<Route> r, uint32_t surface, uint32_t strip_number)
{
if (!r) {
return;
}
for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
if ((*s)->number() == surface) {
Strip* strip = (*s)->nth_strip (strip_number);
if (strip) {
strip->set_route (session->master_out());
strip->lock_controls ();
}
}
}
}
void
MackieControlProtocol::gui_track_selection_changed (ARDOUR::RouteNotificationListPtr rl)
{
for (Surfaces::iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
(*s)->gui_selection_changed (rl);
}
}
framepos_t
MackieControlProtocol::transport_frame() const
{
return session->transport_frame();
}
void
MackieControlProtocol::add_down_select_button (int surface, int strip)
{
_down_select_buttons.push_back ((surface<<8)|(strip&0xf));
}
void
MackieControlProtocol::remove_down_select_button (int surface, int strip)
{
list<uint32_t>::iterator x = find (_down_select_buttons.begin(), _down_select_buttons.end(), (surface<<8)|(strip&0xf));
if (x != _down_select_buttons.end()) {
_down_select_buttons.erase (x);
}
}
void
MackieControlProtocol::select_range ()
{
RouteList routes;
pull_route_range (_down_select_buttons, routes);
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("select range: found %1 routes\n", routes.size()));
if (!routes.empty()) {
for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
if (r == routes.begin()) {
SetRouteSelection ((*r)->remote_control_id());
} else {
AddRouteToSelection ((*r)->remote_control_id());
}
}
}
}
void
MackieControlProtocol::add_down_button (AutomationType a, int surface, int strip)
{
DownButtonMap::iterator m = _down_buttons.find (a);
if (m == _down_buttons.end()) {
_down_buttons[a] = DownButtonList();
}
_down_buttons[a].push_back ((surface<<8)|(strip&0xf));
}
void
MackieControlProtocol::remove_down_button (AutomationType a, int surface, int strip)
{
DownButtonMap::iterator m = _down_buttons.find (a);
if (m == _down_buttons.end()) {
return;
}
DownButtonList& l (m->second);
list<uint32_t>::iterator x = find (l.begin(), l.end(), (surface<<8)|(strip&0xf));
if (x != l.end()) {
l.erase (x);
}
}
MackieControlProtocol::ControlList
MackieControlProtocol::down_controls (AutomationType p)
{
ControlList controls;
RouteList routes;
DownButtonMap::iterator m = _down_buttons.find (p);
if (m == _down_buttons.end()) {
return controls;
}
pull_route_range (m->second, routes);
switch (p) {
case GainAutomation:
for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
controls.push_back ((*r)->gain_control());
}
break;
case SoloAutomation:
for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
controls.push_back ((*r)->solo_control());
}
break;
case MuteAutomation:
for (RouteList::iterator r = routes.begin(); r != routes.end(); ++r) {
controls.push_back ((*r)->mute_control());
}
break;
default:
break;
}
return controls;
}
struct ButtonRangeSorter {
bool operator() (const uint32_t& a, const uint32_t& b) {
return (a>>8) < (b>>8) // a.surface < b.surface
||
((a>>8) == (b>>8) && (a&0xf) < (b&0xf)); // a.surface == b.surface && a.strip < b.strip
}
};
void
MackieControlProtocol::pull_route_range (list<uint32_t>& down, RouteList& selected)
{
ButtonRangeSorter cmp;
if (down.empty()) {
return;
}
down.sort (cmp);
uint32_t first = down.front();
uint32_t last = down.back ();
uint32_t first_surface = first>>8;
uint32_t first_strip = first&0x8;
uint32_t last_surface = last>>8;
uint32_t last_strip = last&0x8;
for (Surfaces::const_iterator s = surfaces.begin(); s != surfaces.end(); ++s) {
if ((*s)->number() >= first_surface && (*s)->number() <= last_surface) {
uint32_t fs;
uint32_t ls;
if ((*s)->number() == first_surface) {
fs = first_strip;
} else {
fs = 0;
}
if ((*s)->number() == last_surface) {
ls = last_strip;
} else {
ls = (*s)->n_strips ();
}
for (uint32_t n = fs; n < ls; ++n) {
boost::shared_ptr<Route> r = (*s)->nth_strip (n)->route();
if (r) {
selected.push_back (r);
}
}
}
}
}