ardour/libs/surfaces/mackie/strip.cc

1939 lines
48 KiB
C++

/*
Copyright (C) 2006,2007 John Anderson
Copyright (C) 2012 Paul Davis
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 <sstream>
#include <vector>
#include <climits>
#include <stdint.h>
#include <sys/time.h>
#include <glibmm/convert.h>
#include "midi++/port.h"
#include "pbd/compose.h"
#include "pbd/convert.h"
#include "ardour/amp.h"
#include "ardour/bundle.h"
#include "ardour/debug.h"
#include "ardour/midi_ui.h"
#include "ardour/meter.h"
#include "ardour/monitor_control.h"
#include "ardour/plugin_insert.h"
#include "ardour/pannable.h"
#include "ardour/panner.h"
#include "ardour/panner_shell.h"
#include "ardour/phase_control.h"
#include "ardour/rc_configuration.h"
#include "ardour/record_enable_control.h"
#include "ardour/route.h"
#include "ardour/session.h"
#include "ardour/send.h"
#include "ardour/solo_isolate_control.h"
#include "ardour/track.h"
#include "ardour/midi_track.h"
#include "ardour/user_bundle.h"
#include "ardour/profile.h"
#include "mackie_control_protocol.h"
#include "surface_port.h"
#include "surface.h"
#include "strip.h"
#include "button.h"
#include "led.h"
#include "pot.h"
#include "fader.h"
#include "jog.h"
#include "meter.h"
using namespace std;
using namespace ARDOUR;
using namespace PBD;
using namespace ArdourSurface;
using namespace Mackie;
#ifndef timeradd /// only avail with __USE_BSD
#define timeradd(a,b,result) \
do { \
(result)->tv_sec = (a)->tv_sec + (b)->tv_sec; \
(result)->tv_usec = (a)->tv_usec + (b)->tv_usec; \
if ((result)->tv_usec >= 1000000) \
{ \
++(result)->tv_sec; \
(result)->tv_usec -= 1000000; \
} \
} while (0)
#endif
#define ui_context() MackieControlProtocol::instance() /* a UICallback-derived object that specifies the event loop for signal handling */
Strip::Strip (Surface& s, const std::string& name, int index, const map<Button::ID,StripButtonInfo>& strip_buttons)
: Group (name)
, _solo (0)
, _recenable (0)
, _mute (0)
, _select (0)
, _vselect (0)
, _fader_touch (0)
, _vpot (0)
, _fader (0)
, _meter (0)
, _index (index)
, _surface (&s)
, _controls_locked (false)
, _transport_is_rolling (false)
, _metering_active (true)
, _block_screen_redisplay_until (0)
, return_to_vpot_mode_display_at (UINT64_MAX)
, eq_band (-1)
, _pan_mode (PanAzimuthAutomation)
, _last_gain_position_written (-1.0)
, _last_pan_azi_position_written (-1.0)
, _last_pan_width_position_written (-1.0)
, _last_trim_position_written (-1.0)
{
_fader = dynamic_cast<Fader*> (Fader::factory (*_surface, index, "fader", *this));
_vpot = dynamic_cast<Pot*> (Pot::factory (*_surface, Pot::ID + index, "vpot", *this));
if (s.mcp().device_info().has_meters()) {
_meter = dynamic_cast<Meter*> (Meter::factory (*_surface, index, "meter", *this));
}
for (map<Button::ID,StripButtonInfo>::const_iterator b = strip_buttons.begin(); b != strip_buttons.end(); ++b) {
Button* bb = dynamic_cast<Button*> (Button::factory (*_surface, b->first, b->second.base_id + index, b->second.name, *this));
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("surface %1 strip %2 new button BID %3 id %4 from base %5\n",
_surface->number(), index, Button::id_to_name (bb->bid()),
bb->id(), b->second.base_id));
}
}
Strip::~Strip ()
{
/* surface is responsible for deleting all controls */
}
void
Strip::add (Control & control)
{
Button* button;
Group::add (control);
/* fader, vpot, meter were all set explicitly */
if ((button = dynamic_cast<Button*>(&control)) != 0) {
switch (button->bid()) {
case Button::RecEnable:
_recenable = button;
break;
case Button::Mute:
_mute = button;
break;
case Button::Solo:
_solo = button;
break;
case Button::Select:
_select = button;
break;
case Button::VSelect:
_vselect = button;
break;
case Button::FaderTouch:
_fader_touch = button;
break;
default:
break;
}
}
}
void
Strip::set_stripable (boost::shared_ptr<Stripable> r, bool /*with_messages*/)
{
if (_controls_locked) {
return;
}
mb_pan_controllable.reset();
stripable_connections.drop_connections ();
_solo->set_control (boost::shared_ptr<AutomationControl>());
_mute->set_control (boost::shared_ptr<AutomationControl>());
_select->set_control (boost::shared_ptr<AutomationControl>());
_recenable->set_control (boost::shared_ptr<AutomationControl>());
_fader->set_control (boost::shared_ptr<AutomationControl>());
_vpot->set_control (boost::shared_ptr<AutomationControl>());
_stripable = r;
reset_saved_values ();
if (!r) {
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 Strip %2 mapped to null route\n", _surface->number(), _index));
zero ();
return;
}
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Surface %1 strip %2 now mapping stripable %3\n",
_surface->number(), _index, _stripable->name()));
_solo->set_control (_stripable->solo_control());
_mute->set_control (_stripable->mute_control());
_stripable->solo_control()->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_solo_changed, this), ui_context());
_stripable->mute_control()->Changed.connect(stripable_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_mute_changed, this), ui_context());
boost::shared_ptr<AutomationControl> pan_control = _stripable->pan_azimuth_control();
if (pan_control) {
pan_control->Changed.connect(stripable_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_panner_azi_changed, this, false), ui_context());
}
pan_control = _stripable->pan_width_control();
if (pan_control) {
pan_control->Changed.connect(stripable_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_panner_width_changed, this, false), ui_context());
}
_stripable->gain_control()->Changed.connect(stripable_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_gain_changed, this, false), ui_context());
_stripable->PropertyChanged.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_property_changed, this, _1), ui_context());
_stripable->presentation_info().PropertyChanged.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_property_changed, this, _1), ui_context());
boost::shared_ptr<AutomationControl> rec_enable_control = _stripable->rec_enable_control ();
if (rec_enable_control) {
_recenable->set_control (rec_enable_control);
rec_enable_control->Changed.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_record_enable_changed, this), ui_context());
}
// TODO this works when a currently-banked stripable is made inactive, but not
// when a stripable is activated which should be currently banked.
_stripable->DropReferences.connect (stripable_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_stripable_deleted, this), ui_context());
/* setup legal VPot modes for this stripable */
possible_pot_parameters.clear();
if (_stripable->pan_azimuth_control()) {
possible_pot_parameters.push_back (PanAzimuthAutomation);
}
if (_stripable->pan_width_control()) {
possible_pot_parameters.push_back (PanWidthAutomation);
}
if (_stripable->pan_elevation_control()) {
possible_pot_parameters.push_back (PanElevationAutomation);
}
if (_stripable->pan_frontback_control()) {
possible_pot_parameters.push_back (PanFrontBackAutomation);
}
if (_stripable->pan_lfe_control()) {
possible_pot_parameters.push_back (PanLFEAutomation);
}
_pan_mode = PanAzimuthAutomation;
if (_surface->mcp().subview_mode() == MackieControlProtocol::None) {
set_vpot_parameter (_pan_mode);
}
_fader->set_control (_stripable->gain_control());
notify_all ();
}
void
Strip::notify_all()
{
if (!_stripable) {
zero ();
return;
}
// The active V-pot control may not be active for this strip
// But if we zero it in the controls function it may erase
// the one we do want
_surface->write (_vpot->zero());
notify_solo_changed ();
notify_mute_changed ();
notify_gain_changed ();
notify_property_changed (PBD::PropertyChange (ARDOUR::Properties::name));
notify_property_changed (PBD::PropertyChange (ARDOUR::Properties::selected));
notify_panner_azi_changed ();
notify_panner_width_changed ();
notify_record_enable_changed ();
notify_processor_changed ();
}
void
Strip::notify_solo_changed ()
{
if (_stripable && _solo) {
_surface->write (_solo->set_state (_stripable->solo_control()->soloed() ? on : off));
}
}
void
Strip::notify_mute_changed ()
{
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("Strip %1 mute changed\n", _index));
if (_stripable && _mute) {
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("\tstripable muted ? %1\n", _stripable->mute_control()->muted()));
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("mute message: %1\n", _mute->set_state (_stripable->mute_control()->muted() ? on : off)));
_surface->write (_mute->set_state (_stripable->mute_control()->muted() ? on : off));
}
}
void
Strip::notify_record_enable_changed ()
{
if (_stripable && _recenable) {
boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (_stripable);
if (trk) {
_surface->write (_recenable->set_state (trk->rec_enable_control()->get_value() ? on : off));
}
}
}
void
Strip::notify_stripable_deleted ()
{
_surface->mcp().notify_stripable_removed ();
_surface->mcp().refresh_current_bank();
}
void
Strip::notify_gain_changed (bool force_update)
{
if (!_stripable) {
return;
}
boost::shared_ptr<AutomationControl> ac = _stripable->gain_control();
Control* control;
if (!ac) {
/* doesn't seem possible but lets be safe */
return;
}
/* track gain control could be on vpot or fader, depending in
* flip mode.
*/
if (_vpot->control() == ac) {
control = _vpot;
} else if (_fader->control() == ac) {
control = _fader;
} else {
return;
}
float gain_coefficient = ac->get_value();
float normalized_position = ac->internal_to_interface (gain_coefficient);
if (force_update || normalized_position != _last_gain_position_written) {
if (!control->in_use()) {
if (control == _vpot) {
_surface->write (_vpot->set (normalized_position, true, Pot::wrap));
} else {
_surface->write (_fader->set_position (normalized_position));
}
}
do_parameter_display (GainAutomation, gain_coefficient);
_last_gain_position_written = normalized_position;
}
}
void
Strip::notify_processor_changed (bool force_update)
{
}
void
Strip::notify_property_changed (const PropertyChange& what_changed)
{
if (what_changed.contains (ARDOUR::Properties::name)) {
show_stripable_name ();
}
if (what_changed.contains (ARDOUR::Properties::selected)) {
if (_stripable) {
_surface->write (_select->set_state (_stripable->presentation_info().selected()));
_surface->mcp().update_selected (_stripable, _stripable->presentation_info().selected());
}
}
}
void
Strip::show_stripable_name ()
{
MackieControlProtocol::SubViewMode svm = _surface->mcp().subview_mode();
if (svm != MackieControlProtocol::None) {
/* subview mode is responsible for upper line */
return;
}
string fullname = string();
if (!_stripable) {
fullname = string();
} else {
fullname = _stripable->name();
}
if (fullname.length() <= 6) {
pending_display[0] = fullname;
} else {
pending_display[0] = PBD::short_version (fullname, 6);
}
}
void
Strip::notify_send_level_change (AutomationType type, uint32_t send_num, bool force_update)
{
boost::shared_ptr<Stripable> r = _surface->mcp().subview_stripable();
if (!r) {
/* not in subview mode */
return;
}
if (_surface->mcp().subview_mode() != MackieControlProtocol::Sends) {
/* no longer in Sends subview mode */
return;
}
boost::shared_ptr<AutomationControl> control = r->send_level_controllable (send_num);
if (!control) {
return;
}
if (control) {
float val = control->get_value();
do_parameter_display (type, val);
if (_vpot->control() == control) {
/* update pot/encoder */
_surface->write (_vpot->set (control->internal_to_interface (val), true, Pot::wrap));
}
}
}
void
Strip::notify_trackview_change (AutomationType type, uint32_t send_num, bool force_update)
{
boost::shared_ptr<Stripable> r = _surface->mcp().subview_stripable();
if (!r) {
/* not in subview mode */
return;
}
if (_surface->mcp().subview_mode() != MackieControlProtocol::TrackView) {
/* no longer in TrackViewsubview mode */
return;
}
boost::shared_ptr<AutomationControl> control;
boost::shared_ptr<Track> track = boost::dynamic_pointer_cast<Track> (r);
switch (type) {
case TrimAutomation:
control = r->trim_control();
break;
case SoloIsolateAutomation:
control = r->solo_isolate_control ();
break;
case SoloSafeAutomation:
control = r->solo_safe_control ();
break;
case MonitoringAutomation:
if (track) {
control = track->monitoring_control();
}
break;
case PhaseAutomation:
control = r->phase_control ();
break;
default:
break;
}
if (control) {
float val = control->get_value();
/* Note: all of the displayed controllables require the display
* of their *actual* ("internal") value, not the version mapped
* into the normalized 0..1.0 ("interface") range.
*/
do_parameter_display (type, val);
/* update pot/encoder */
_surface->write (_vpot->set (control->internal_to_interface (val), true, Pot::wrap));
}
}
void
Strip::notify_eq_change (AutomationType type, uint32_t band, bool force_update)
{
boost::shared_ptr<Stripable> r = _surface->mcp().subview_stripable();
if (!r) {
/* not in subview mode */
return;
}
if (_surface->mcp().subview_mode() != MackieControlProtocol::EQ) {
/* no longer in EQ subview mode */
return;
}
boost::shared_ptr<AutomationControl> control;
switch (type) {
case EQGain:
control = r->eq_gain_controllable (band);
break;
case EQFrequency:
control = r->eq_freq_controllable (band);
break;
case EQQ:
control = r->eq_q_controllable (band);
break;
case EQShape:
control = r->eq_shape_controllable (band);
break;
case EQHPF:
control = r->eq_hpf_controllable ();
break;
case EQEnable:
control = r->eq_enable_controllable ();
break;
default:
break;
}
if (control) {
float val = control->get_value();
do_parameter_display (type, val);
/* update pot/encoder */
_surface->write (_vpot->set (control->internal_to_interface (val), true, Pot::wrap));
}
}
void
Strip::notify_dyn_change (AutomationType type, bool force_update, bool propagate_mode)
{
boost::shared_ptr<Stripable> r = _surface->mcp().subview_stripable();
if (!r) {
/* not in subview mode */
return;
}
if (_surface->mcp().subview_mode() != MackieControlProtocol::Dynamics) {
/* no longer in EQ subview mode */
return;
}
boost::shared_ptr<AutomationControl> control;
bool reset_all = false;
switch (type) {
case CompThreshold:
control = r->comp_threshold_controllable ();
break;
case CompSpeed:
control = r->comp_speed_controllable ();
break;
case CompMode:
control = r->comp_mode_controllable ();
reset_all = true;
break;
case CompMakeup:
control = r->comp_makeup_controllable ();
break;
case CompRedux:
control = r->comp_redux_controllable ();
break;
case CompEnable:
control = r->comp_enable_controllable ();
break;
default:
break;
}
if (propagate_mode && reset_all) {
_surface->subview_mode_changed ();
}
if (control) {
float val = control->get_value();
do_parameter_display (type, val);
/* update pot/encoder */
_surface->write (_vpot->set (control->internal_to_interface (val), true, Pot::wrap));
}
}
void
Strip::notify_panner_azi_changed (bool force_update)
{
if (!_stripable) {
return;
}
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("pan change for strip %1\n", _index));
boost::shared_ptr<AutomationControl> pan_control = _stripable->pan_azimuth_control ();
if (!pan_control) {
/* basically impossible, since we're here because that control
* changed, but sure, whatever.
*/
return;
}
if (_vpot->control() != pan_control) {
return;
}
double normalized_pos = pan_control->internal_to_interface (pan_control->get_value());
double internal_pos = pan_control->get_value();
if (force_update || (normalized_pos != _last_pan_azi_position_written)) {
_surface->write (_vpot->set (normalized_pos, true, Pot::dot));
/* show actual internal value to user */
do_parameter_display (PanAzimuthAutomation, internal_pos);
_last_pan_azi_position_written = normalized_pos;
}
}
void
Strip::notify_panner_width_changed (bool force_update)
{
if (!_stripable) {
return;
}
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("pan width change for strip %1\n", _index));
boost::shared_ptr<AutomationControl> pan_control = _stripable->pan_width_control ();
if (!pan_control) {
/* basically impossible, since we're here because that control
* changed, but sure, whatever.
*/
return;
}
if (_vpot->control() != pan_control) {
return;
}
double pos = pan_control->internal_to_interface (pan_control->get_value());
if (force_update || pos != _last_pan_width_position_written) {
_surface->write (_vpot->set (pos, true, Pot::spread));
do_parameter_display (PanWidthAutomation, pos);
_last_pan_width_position_written = pos;
}
}
void
Strip::select_event (Button&, ButtonState bs)
{
DEBUG_TRACE (DEBUG::MackieControl, "select button\n");
if (bs == press) {
int ms = _surface->mcp().main_modifier_state();
if (ms & MackieControlProtocol::MODIFIER_CMDALT) {
_controls_locked = !_controls_locked;
_surface->write (display (1,_controls_locked ? "Locked" : "Unlock"));
block_vpot_mode_display_for (1000);
return;
}
DEBUG_TRACE (DEBUG::MackieControl, "add select button on press\n");
_surface->mcp().add_down_select_button (_surface->number(), _index);
_surface->mcp().select_range (_surface->mcp().global_index (*this));
} else {
DEBUG_TRACE (DEBUG::MackieControl, "remove select button on release\n");
_surface->mcp().remove_down_select_button (_surface->number(), _index);
}
}
void
Strip::vselect_event (Button&, ButtonState bs)
{
if (_surface->mcp().subview_mode() != MackieControlProtocol::None) {
/* most subview modes: vpot press acts like a button for toggle parameters */
if (bs != press) {
return;
}
if (_surface->mcp().subview_mode() != MackieControlProtocol::Sends) {
boost::shared_ptr<AutomationControl> control = _vpot->control ();
if (!control) {
return;
}
Controllable::GroupControlDisposition gcd;
if (_surface->mcp().main_modifier_state() & MackieControlProtocol::MODIFIER_SHIFT) {
gcd = Controllable::InverseGroup;
} else {
gcd = Controllable::UseGroup;
}
if (control->toggled()) {
if (control->toggled()) {
control->set_value (!control->get_value(), gcd);
}
} else if (control->desc().enumeration || control->desc().integer_step) {
double val = control->get_value ();
if (val <= control->upper() - 1.0) {
control->set_value (val + 1.0, gcd);
} else {
control->set_value (control->lower(), gcd);
}
}
} else {
/* Send mode: press enables/disables the relevant
* send, but the vpot is bound to the send-level so we
* need to lookup the enable/disable control
* explicitly.
*/
boost::shared_ptr<Stripable> r = _surface->mcp().subview_stripable();
if (r) {
const uint32_t global_pos = _surface->mcp().global_index (*this);
boost::shared_ptr<AutomationControl> control = r->send_enable_controllable (global_pos);
if (control) {
bool currently_enabled = (bool) control->get_value();
Controllable::GroupControlDisposition gcd;
if (_surface->mcp().main_modifier_state() & MackieControlProtocol::MODIFIER_SHIFT) {
gcd = Controllable::InverseGroup;
} else {
gcd = Controllable::UseGroup;
}
control->set_value (!currently_enabled, gcd);
if (currently_enabled) {
/* we just turned it off */
pending_display[1] = "off";
} else {
/* we just turned it on, show the level
*/
control = _stripable->send_level_controllable (global_pos);
do_parameter_display (BusSendLevel, control->get_value());
}
}
}
}
/* done with this event in subview mode */
return;
}
if (bs == press) {
int ms = _surface->mcp().main_modifier_state();
if (ms & MackieControlProtocol::MODIFIER_SHIFT) {
boost::shared_ptr<AutomationControl> ac = _vpot->control ();
if (ac) {
/* reset to default/normal value */
ac->set_value (ac->normal(), Controllable::NoGroup);
}
} else {
#ifdef MIXBUS
if (_stripable) {
boost::shared_ptr<AutomationControl> ac = _stripable->master_send_enable_controllable ();
if (ac) {
Controllable::GroupControlDisposition gcd;
if (_surface->mcp().main_modifier_state() & MackieControlProtocol::MODIFIER_SHIFT) {
gcd = Controllable::InverseGroup;
} else {
gcd = Controllable::UseGroup;
}
bool enabled = ac->get_value();
ac->set_value (!enabled, gcd);
}
}
#else
DEBUG_TRACE (DEBUG::MackieControl, "switching to next pot mode\n");
/* switch vpot to control next available parameter */
next_pot_mode ();
#endif
}
}
}
void
Strip::fader_touch_event (Button&, ButtonState bs)
{
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("fader touch, press ? %1\n", (bs == press)));
if (bs == press) {
boost::shared_ptr<AutomationControl> ac = _fader->control ();
_fader->set_in_use (true);
_fader->start_touch (_surface->mcp().transport_frame());
if (ac) {
do_parameter_display ((AutomationType) ac->parameter().type(), ac->get_value());
}
} else {
_fader->set_in_use (false);
_fader->stop_touch (_surface->mcp().transport_frame(), true);
}
}
void
Strip::handle_button (Button& button, ButtonState bs)
{
boost::shared_ptr<AutomationControl> control;
if (bs == press) {
button.set_in_use (true);
} else {
button.set_in_use (false);
}
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("strip %1 handling button %2 press ? %3\n", _index, button.bid(), (bs == press)));
switch (button.bid()) {
case Button::Select:
select_event (button, bs);
break;
case Button::VSelect:
vselect_event (button, bs);
break;
case Button::FaderTouch:
fader_touch_event (button, bs);
break;
default:
if ((control = button.control ())) {
if (bs == press) {
DEBUG_TRACE (DEBUG::MackieControl, "add button on press\n");
_surface->mcp().add_down_button ((AutomationType) control->parameter().type(), _surface->number(), _index);
float new_value = control->get_value() ? 0.0 : 1.0;
/* get all controls that either have their
* button down or are within a range of
* several down buttons
*/
MackieControlProtocol::ControlList controls = _surface->mcp().down_controls ((AutomationType) control->parameter().type(),
_surface->mcp().global_index(*this));
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("there are %1 buttons down for control type %2, new value = %3\n",
controls.size(), control->parameter().type(), new_value));
/* apply change, with potential modifier semantics */
Controllable::GroupControlDisposition gcd;
if (_surface->mcp().main_modifier_state() & MackieControlProtocol::MODIFIER_SHIFT) {
gcd = Controllable::InverseGroup;
} else {
gcd = Controllable::UseGroup;
}
for (MackieControlProtocol::ControlList::iterator c = controls.begin(); c != controls.end(); ++c) {
(*c)->set_value (new_value, gcd);
}
} else {
DEBUG_TRACE (DEBUG::MackieControl, "remove button on release\n");
_surface->mcp().remove_down_button ((AutomationType) control->parameter().type(), _surface->number(), _index);
}
}
break;
}
}
void
Strip::do_parameter_display (AutomationType type, float val)
{
bool screen_hold = false;
char buf[16];
switch (type) {
case GainAutomation:
if (val == 0.0) {
pending_display[1] = " -inf ";
} else {
float dB = accurate_coefficient_to_dB (val);
snprintf (buf, sizeof (buf), "%6.1f", dB);
pending_display[1] = buf;
screen_hold = true;
}
break;
case BusSendLevel:
if (Profile->get_mixbus()) { //Mixbus sends are already stored in dB
snprintf (buf, sizeof (buf), "%2.1f", val);
pending_display[1] = buf;
screen_hold = true;
} else {
if (val == 0.0) {
pending_display[1] = " -inf ";
} else {
float dB = accurate_coefficient_to_dB (val);
snprintf (buf, sizeof (buf), "%6.1f", dB);
pending_display[1] = buf;
screen_hold = true;
}
}
break;
case PanAzimuthAutomation:
if (Profile->get_mixbus()) {
snprintf (buf, sizeof (buf), "%2.1f", val);
pending_display[1] = buf;
screen_hold = true;
} else {
if (_stripable) {
boost::shared_ptr<AutomationControl> pa = _stripable->pan_azimuth_control();
if (pa) {
pending_display[1] = pa->get_user_string ();
screen_hold = true;
}
}
}
break;
case PanWidthAutomation:
if (_stripable) {
snprintf (buf, sizeof (buf), "%5ld%%", lrintf ((val * 200.0)-100));
pending_display[1] = buf;
screen_hold = true;
}
break;
case TrimAutomation:
if (_stripable) {
float dB = accurate_coefficient_to_dB (val);
snprintf (buf, sizeof (buf), "%6.1f", dB);
pending_display[1] = buf;
screen_hold = true;
}
break;
case PhaseAutomation:
if (_stripable) {
if (val < 0.5) {
pending_display[1] = "Normal";
} else {
pending_display[1] = "Invert";
}
screen_hold = true;
}
break;
case EQGain:
case EQFrequency:
case EQQ:
case EQShape:
case EQHPF:
case CompThreshold:
case CompSpeed:
case CompMakeup:
case CompRedux:
snprintf (buf, sizeof (buf), "%6.1f", val);
pending_display[1] = buf;
screen_hold = true;
break;
case EQEnable:
case CompEnable:
if (val >= 0.5) {
pending_display[1] = "on";
} else {
pending_display[1] = "off";
}
break;
case CompMode:
if (_surface->mcp().subview_stripable()) {
pending_display[1] = _surface->mcp().subview_stripable()->comp_mode_name (val);
}
break;
case SoloSafeAutomation:
case SoloIsolateAutomation:
if (val >= 0.5) {
pending_display[1] = "on";
} else {
pending_display[1] = "off";
}
break;
case MonitoringAutomation:
switch (MonitorChoice ((int) val)) {
case MonitorAuto:
pending_display[1] = "auto";
break;
case MonitorInput:
pending_display[1] = "input";
break;
case MonitorDisk:
pending_display[1] = "disk";
break;
case MonitorCue: /* XXX not implemented as of jan 2016 */
pending_display[1] = "cue";
break;
}
break;
default:
break;
}
if (screen_hold) {
/* we just queued up a parameter to be displayed.
1 second from now, switch back to vpot mode display.
*/
block_vpot_mode_display_for (1000);
}
}
void
Strip::handle_fader_touch (Fader& fader, bool touch_on)
{
if (touch_on) {
fader.start_touch (_surface->mcp().transport_frame());
} else {
fader.stop_touch (_surface->mcp().transport_frame(), false);
}
}
void
Strip::handle_fader (Fader& fader, float position)
{
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("fader to %1\n", position));
boost::shared_ptr<AutomationControl> ac = fader.control();
if (!ac) {
return;
}
Controllable::GroupControlDisposition gcd = Controllable::UseGroup;
if (_surface->mcp().main_modifier_state() & MackieControlProtocol::MODIFIER_SHIFT) {
gcd = Controllable::InverseGroup;
}
fader.set_value (position, gcd);
/* From the Mackie Control MIDI implementation docs:
In order to ensure absolute synchronization with the host software,
Mackie Control uses a closed-loop servo system for the faders,
meaning the faders will always move to their last received position.
When a host receives a Fader Position Message, it must then
re-transmit that message to the Mackie Control or else the faders
will return to their last position.
*/
_surface->write (fader.set_position (position));
}
void
Strip::handle_pot (Pot& pot, float delta)
{
/* Pots only emit events when they move, not when they
stop moving. So to get a stop event, we need to use a timeout.
*/
boost::shared_ptr<AutomationControl> ac = pot.control();
if (!ac) {
return;
}
Controllable::GroupControlDisposition gcd;
if (_surface->mcp().main_modifier_state() & MackieControlProtocol::MODIFIER_SHIFT) {
gcd = Controllable::InverseGroup;
} else {
gcd = Controllable::UseGroup;
}
if (ac->toggled()) {
/* make it like a single-step, directional switch */
if (delta > 0) {
ac->set_value (1.0, gcd);
} else {
ac->set_value (0.0, gcd);
}
} else if (ac->desc().enumeration || ac->desc().integer_step) {
/* use Controllable::get_value() to avoid the
* "scaling-to-interface" that takes place in
* Control::get_value() via the pot member.
*
* an enumeration with 4 values will have interface values of
* 0.0, 0.25, 0.5 and 0.75 or some similar oddness. Lets not
* deal with that.
*/
if (delta > 0) {
ac->set_value (min (ac->upper(), ac->get_value() + 1.0), gcd);
} else {
ac->set_value (max (ac->lower(), ac->get_value() - 1.0), gcd);
}
} else {
double p = ac->get_interface();
p += delta;
p = max (0.0, p);
p = min (1.0, p);
ac->set_value ( ac->interface_to_internal(p), gcd);
}
}
void
Strip::periodic (ARDOUR::microseconds_t now)
{
update_meter ();
update_automation ();
}
void
Strip::redisplay (ARDOUR::microseconds_t now, bool force)
{
if (_block_screen_redisplay_until >= now) {
/* no drawing allowed */
return;
}
if (_block_screen_redisplay_until) {
/* we were blocked, but the time period has elapsed, so we must
* force a redraw.
*/
force = true;
_block_screen_redisplay_until = 0;
}
if (force || (current_display[0] != pending_display[0])) {
_surface->write (display (0, pending_display[0]));
current_display[0] = pending_display[0];
}
if (return_to_vpot_mode_display_at <= now) {
return_to_vpot_mode_display_at = UINT64_MAX;
return_to_vpot_mode_display ();
}
if (force || (current_display[1] != pending_display[1])) {
_surface->write (display (1, pending_display[1]));
current_display[1] = pending_display[1];
}
}
void
Strip::update_automation ()
{
if (!_stripable) {
return;
}
ARDOUR::AutoState state = _stripable->gain_control()->automation_state();
if (state == Touch || state == Play) {
notify_gain_changed (false);
}
boost::shared_ptr<AutomationControl> pan_control = _stripable->pan_azimuth_control ();
if (pan_control) {
state = pan_control->automation_state ();
if (state == Touch || state == Play) {
notify_panner_azi_changed (false);
}
}
pan_control = _stripable->pan_width_control ();
if (pan_control) {
state = pan_control->automation_state ();
if (state == Touch || state == Play) {
notify_panner_width_changed (false);
}
}
}
void
Strip::update_meter ()
{
if (!_stripable) {
return;
}
if (_surface->mcp().subview_mode() != MackieControlProtocol::None) {
return;
}
if (_meter && _transport_is_rolling && _metering_active && _stripable->peak_meter()) {
float dB = _stripable->peak_meter()->meter_level (0, MeterMCP);
_meter->send_update (*_surface, dB);
return;
}
}
void
Strip::zero ()
{
for (Group::Controls::const_iterator it = _controls.begin(); it != _controls.end(); ++it) {
_surface->write ((*it)->zero ());
}
_surface->write (blank_display (0));
_surface->write (blank_display (1));
pending_display[0] = string();
pending_display[1] = string();
current_display[0] = string();
current_display[1] = string();
}
MidiByteArray
Strip::blank_display (uint32_t line_number)
{
return display (line_number, string());
}
MidiByteArray
Strip::display (uint32_t line_number, const std::string& line)
{
assert (line_number <= 1);
MidiByteArray retval;
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("strip_display index: %1, line %2 = %3\n", _index, line_number, line));
// sysex header
retval << _surface->sysex_hdr();
// code for display
retval << 0x12;
// offset (0 to 0x37 first line, 0x38 to 0x6f for second line)
retval << (_index * 7 + (line_number * 0x38));
// ascii data to display. @param line is UTF-8
string ascii = Glib::convert_with_fallback (line, "UTF-8", "ISO-8859-1", "_");
string::size_type len = ascii.length();
if (len > 6) {
ascii = ascii.substr (0, 6);
len = 6;
}
retval << ascii;
// pad with " " out to 6 chars
for (int i = len; i < 6; ++i) {
retval << ' ';
}
// column spacer, unless it's the right-hand column
if (_index < 7) {
retval << ' ';
}
// sysex trailer
retval << MIDI::eox;
return retval;
}
void
Strip::lock_controls ()
{
_controls_locked = true;
}
void
Strip::unlock_controls ()
{
_controls_locked = false;
}
string
Strip::vpot_mode_string ()
{
if (_surface->mcp().subview_mode() != MackieControlProtocol::None) {
return string();
}
boost::shared_ptr<AutomationControl> ac = _vpot->control();
if (!ac) {
return string();
}
switch (ac->desc().type) {
case PanAzimuthAutomation:
return "Pan";
case PanWidthAutomation:
return "Width";
case PanElevationAutomation:
return "Elev";
case PanFrontBackAutomation:
return "F/Rear";
case PanLFEAutomation:
return "LFE";
default:
break;
}
#ifdef MIXBUS
//"None" mode, by definition (currently) shows the pan control above the fader.
//Mixbus controllers are created from a LADSPA so they don't have ac->desc().type
//For the forseeable future, we will just return "Pan" here.
return "Pan";
#endif
return "???";
}
void
Strip::flip_mode_changed ()
{
if (_surface->mcp().subview_mode() == MackieControlProtocol::Sends) {
boost::shared_ptr<AutomationControl> pot_control = _vpot->control();
boost::shared_ptr<AutomationControl> fader_control = _fader->control();
if (pot_control && fader_control) {
_vpot->set_control (fader_control);
_fader->set_control (pot_control);
/* update fader with pot value */
_surface->write (_fader->set_position (pot_control->internal_to_interface (pot_control->get_value ())));
/* update pot with fader value */
_surface->write (_vpot->set (fader_control->internal_to_interface (fader_control->get_value()), true, Pot::wrap));
if (_surface->mcp().flip_mode() == MackieControlProtocol::Normal) {
do_parameter_display (GainAutomation, fader_control->get_value());
} else {
do_parameter_display (BusSendLevel, pot_control->get_value());
}
}
} else {
/* do nothing */
}
}
void
Strip::block_screen_display_for (uint32_t msecs)
{
_block_screen_redisplay_until = ARDOUR::get_microseconds() + (msecs * 1000);
}
void
Strip::block_vpot_mode_display_for (uint32_t msecs)
{
return_to_vpot_mode_display_at = ARDOUR::get_microseconds() + (msecs * 1000);
}
void
Strip::return_to_vpot_mode_display ()
{
/* returns the second line of the two-line per-strip display
back the mode where it shows what the VPot controls.
*/
if (_surface->mcp().subview_mode() != MackieControlProtocol::None) {
/* do nothing - second line shows value of current subview parameter */
return;
} else if (_stripable) {
pending_display[1] = vpot_mode_string();
} else {
pending_display[1] = string();
}
}
void
Strip::next_pot_mode ()
{
vector<AutomationType>::iterator i;
if (_surface->mcp().flip_mode() != MackieControlProtocol::Normal) {
/* do not change vpot mode while in flipped mode */
DEBUG_TRACE (DEBUG::MackieControl, "not stepping pot mode - in flip mode\n");
pending_display[1] = "Flip";
block_vpot_mode_display_for (1000);
return;
}
boost::shared_ptr<AutomationControl> ac = _vpot->control();
if (!ac) {
return;
}
if (_surface->mcp().subview_mode() != MackieControlProtocol::None) {
return;
}
if (possible_pot_parameters.empty() || (possible_pot_parameters.size() == 1 && possible_pot_parameters.front() == ac->parameter().type())) {
return;
}
for (i = possible_pot_parameters.begin(); i != possible_pot_parameters.end(); ++i) {
if ((*i) == ac->parameter().type()) {
break;
}
}
/* move to the next mode in the list, or back to the start (which will
also happen if the current mode is not in the current pot mode list)
*/
if (i != possible_pot_parameters.end()) {
++i;
}
if (i == possible_pot_parameters.end()) {
i = possible_pot_parameters.begin();
}
set_vpot_parameter (*i);
}
void
Strip::subview_mode_changed ()
{
boost::shared_ptr<Stripable> r = _surface->mcp().subview_stripable();
subview_connections.drop_connections ();
switch (_surface->mcp().subview_mode()) {
case MackieControlProtocol::None:
set_vpot_parameter (_pan_mode);
/* need to show strip name again */
show_stripable_name ();
if (!_stripable) {
_surface->write (_vpot->set (0, true, Pot::wrap));
_surface->write (_fader->set_position (0.0));
}
notify_metering_state_changed ();
eq_band = -1;
break;
case MackieControlProtocol::EQ:
if (r) {
setup_eq_vpot (r);
} else {
/* leave it as it was */
}
break;
case MackieControlProtocol::Dynamics:
if (r) {
setup_dyn_vpot (r);
} else {
/* leave it as it was */
}
eq_band = -1;
break;
case MackieControlProtocol::Sends:
if (r) {
setup_sends_vpot (r);
} else {
/* leave it as it was */
}
eq_band = -1;
break;
case MackieControlProtocol::TrackView:
if (r) {
setup_trackview_vpot (r);
} else {
/* leave it as it was */
}
eq_band = -1;
break;
}
}
void
Strip::setup_dyn_vpot (boost::shared_ptr<Stripable> r)
{
if (!r) {
return;
}
boost::shared_ptr<AutomationControl> tc = r->comp_threshold_controllable ();
boost::shared_ptr<AutomationControl> sc = r->comp_speed_controllable ();
boost::shared_ptr<AutomationControl> mc = r->comp_mode_controllable ();
boost::shared_ptr<AutomationControl> kc = r->comp_makeup_controllable ();
boost::shared_ptr<AutomationControl> rc = r->comp_redux_controllable ();
boost::shared_ptr<AutomationControl> ec = r->comp_enable_controllable ();
uint32_t pos = _surface->mcp().global_index (*this);
/* we will control the pos-th available parameter, from the list in the
* order shown above.
*/
vector<boost::shared_ptr<AutomationControl> > available;
vector<AutomationType> params;
if (tc) { available.push_back (tc); params.push_back (CompThreshold); }
if (sc) { available.push_back (sc); params.push_back (CompSpeed); }
if (mc) { available.push_back (mc); params.push_back (CompMode); }
if (kc) { available.push_back (kc); params.push_back (CompMakeup); }
if (rc) { available.push_back (rc); params.push_back (CompRedux); }
if (ec) { available.push_back (ec); params.push_back (CompEnable); }
if (pos >= available.size()) {
/* this knob is not needed to control the available parameters */
_vpot->set_control (boost::shared_ptr<AutomationControl>());
pending_display[0] = string();
pending_display[1] = string();
return;
}
boost::shared_ptr<AutomationControl> pc;
AutomationType param;
pc = available[pos];
param = params[pos];
pc->Changed.connect (subview_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_dyn_change, this, param, false, true), ui_context());
_vpot->set_control (pc);
string pot_id;
switch (param) {
case CompThreshold:
pot_id = "Thresh";
break;
case CompSpeed:
if (mc) {
pot_id = r->comp_speed_name (mc->get_value());
} else {
pot_id = "Speed";
}
break;
case CompMode:
pot_id = "Mode";
break;
case CompMakeup:
pot_id = "Makeup";
break;
case CompRedux:
pot_id = "Redux";
break;
case CompEnable:
pot_id = "on/off";
break;
default:
break;
}
if (!pot_id.empty()) {
pending_display[0] = pot_id;
} else {
pending_display[0] = string();
}
notify_dyn_change (param, true, false);
}
void
Strip::setup_eq_vpot (boost::shared_ptr<Stripable> r)
{
uint32_t bands = r->eq_band_cnt ();
if (bands == 0) {
/* should never get here */
return;
}
/* figure out how many params per band are available */
boost::shared_ptr<AutomationControl> pc;
uint32_t params_per_band = 0;
if ((pc = r->eq_gain_controllable (0))) {
params_per_band += 1;
}
if ((pc = r->eq_freq_controllable (0))) {
params_per_band += 1;
}
if ((pc = r->eq_q_controllable (0))) {
params_per_band += 1;
}
if ((pc = r->eq_shape_controllable (0))) {
params_per_band += 1;
}
/* pick the one for this strip, based on its global position across
* all surfaces
*/
pc.reset ();
const uint32_t total_band_parameters = bands * params_per_band;
const uint32_t global_pos = _surface->mcp().global_index (*this);
AutomationType param = NullAutomation;
string band_name;
eq_band = -1;
if (global_pos < total_band_parameters) {
/* show a parameter for an EQ band */
const uint32_t parameter = global_pos % params_per_band;
eq_band = global_pos / params_per_band;
band_name = r->eq_band_name (eq_band);
switch (parameter) {
case 0:
pc = r->eq_gain_controllable (eq_band);
param = EQGain;
break;
case 1:
pc = r->eq_freq_controllable (eq_band);
param = EQFrequency;
break;
case 2:
pc = r->eq_q_controllable (eq_band);
param = EQQ;
break;
case 3:
pc = r->eq_shape_controllable (eq_band);
param = EQShape;
break;
}
} else {
/* show a non-band parameter (HPF or enable)
*/
uint32_t parameter = global_pos - total_band_parameters;
switch (parameter) {
case 0: /* first control after band parameters */
pc = r->eq_hpf_controllable();
param = EQHPF;
break;
case 1: /* second control after band parameters */
pc = r->eq_enable_controllable();
param = EQEnable;
break;
default:
/* nothing to control */
_vpot->set_control (boost::shared_ptr<AutomationControl>());
pending_display[0] = string();
pending_display[1] = string();
/* done */
return;
break;
}
}
if (pc) {
pc->Changed.connect (subview_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_eq_change, this, param, eq_band, false), ui_context());
_vpot->set_control (pc);
string pot_id;
switch (param) {
case EQGain:
pot_id = band_name + "Gain";
break;
case EQFrequency:
pot_id = band_name + "Freq";
break;
case EQQ:
pot_id = band_name + " Q";
break;
case EQShape:
pot_id = band_name + " Shp";
break;
case EQHPF:
pot_id = "HPFreq";
break;
case EQEnable:
pot_id = "on/off";
break;
default:
break;
}
if (!pot_id.empty()) {
pending_display[0] = pot_id;
} else {
pending_display[0] = string();
}
notify_eq_change (param, eq_band, true);
}
}
void
Strip::setup_sends_vpot (boost::shared_ptr<Stripable> r)
{
if (!r) {
return;
}
const uint32_t global_pos = _surface->mcp().global_index (*this);
boost::shared_ptr<AutomationControl> pc = r->send_level_controllable (global_pos);
if (!pc) {
/* nothing to control */
_vpot->set_control (boost::shared_ptr<AutomationControl>());
pending_display[0] = string();
pending_display[1] = string();
return;
}
pc->Changed.connect (subview_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_send_level_change, this, BusSendLevel, global_pos, false), ui_context());
_vpot->set_control (pc);
pending_display[0] = PBD::short_version (r->send_name (global_pos), 6);
notify_send_level_change (BusSendLevel, global_pos, true);
}
void
Strip::setup_trackview_vpot (boost::shared_ptr<Stripable> r)
{
if (!r) {
return;
}
const uint32_t global_pos = _surface->mcp().global_index (*this);
if (global_pos >= 8) {
/* nothing to control */
_vpot->set_control (boost::shared_ptr<AutomationControl>());
pending_display[0] = string();
pending_display[1] = string();
return;
}
boost::shared_ptr<AutomationControl> pc;
boost::shared_ptr<Track> track = boost::dynamic_pointer_cast<Track> (r);
string label;
switch (global_pos) {
case 0:
pc = r->trim_control ();
if (pc) {
pc->Changed.connect (subview_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_trackview_change, this, TrimAutomation, global_pos, false), ui_context());
pending_display[0] = "Trim";
notify_trackview_change (TrimAutomation, global_pos, true);
}
break;
case 1:
if (track) {
pc = track->monitoring_control();
if (pc) {
pc->Changed.connect (subview_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_trackview_change, this, MonitoringAutomation, global_pos, false), ui_context());
pending_display[0] = "Mon";
notify_trackview_change (MonitoringAutomation, global_pos, true);
}
}
break;
case 2:
pc = r->solo_isolate_control ();
if (pc) {
pc->Changed.connect (subview_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_trackview_change, this, SoloIsolateAutomation, global_pos, false), ui_context());
notify_trackview_change (SoloIsolateAutomation, global_pos, true);
pending_display[0] = "S-Iso";
}
break;
case 3:
pc = r->solo_safe_control ();
if (pc) {
pc->Changed.connect (subview_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_trackview_change, this, SoloSafeAutomation, global_pos, false), ui_context());
notify_trackview_change (SoloSafeAutomation, global_pos, true);
pending_display[0] = "S-Safe";
}
break;
case 4:
pc = r->phase_control();
if (pc) {
pc->Changed.connect (subview_connections, MISSING_INVALIDATOR, boost::bind (&Strip::notify_trackview_change, this, PhaseAutomation, global_pos, false), ui_context());
notify_trackview_change (PhaseAutomation, global_pos, true);
pending_display[0] = "Phase";
}
break;
case 5:
// pc = r->trim_control ();
break;
case 6:
// pc = r->trim_control ();
break;
case 7:
// pc = r->trim_control ();
break;
}
if (!pc) {
pending_display[0] = string();
pending_display[1] = string();
return;
}
_vpot->set_control (pc);
}
void
Strip::set_vpot_parameter (AutomationType p)
{
if (!_stripable || (p == NullAutomation)) {
_vpot->set_control (boost::shared_ptr<AutomationControl>());
pending_display[1] = string();
return;
}
boost::shared_ptr<AutomationControl> pan_control;
DEBUG_TRACE (DEBUG::MackieControl, string_compose ("switch to vpot mode %1\n", p));
reset_saved_values ();
switch (p) {
case PanAzimuthAutomation:
pan_control = _stripable->pan_azimuth_control ();
break;
case PanWidthAutomation:
pan_control = _stripable->pan_width_control ();
break;
case PanElevationAutomation:
break;
case PanFrontBackAutomation:
break;
case PanLFEAutomation:
break;
default:
return;
}
if (pan_control) {
_pan_mode = p;
_vpot->set_control (pan_control);
}
pending_display[1] = vpot_mode_string ();
}
bool
Strip::is_midi_track () const
{
return boost::dynamic_pointer_cast<MidiTrack>(_stripable) != 0;
}
void
Strip::reset_saved_values ()
{
_last_pan_azi_position_written = -1.0;
_last_pan_width_position_written = -1.0;
_last_gain_position_written = -1.0;
_last_trim_position_written = -1.0;
}
void
Strip::notify_metering_state_changed()
{
if (_surface->mcp().subview_mode() != MackieControlProtocol::None) {
return;
}
if (!_stripable || !_meter) {
return;
}
bool transport_is_rolling = (_surface->mcp().get_transport_speed () != 0.0f);
bool metering_active = _surface->mcp().metering_active ();
if ((_transport_is_rolling == transport_is_rolling) && (_metering_active == metering_active)) {
return;
}
_meter->notify_metering_state_changed (*_surface, transport_is_rolling, metering_active);
if (!transport_is_rolling || !metering_active) {
notify_property_changed (PBD::PropertyChange (ARDOUR::Properties::name));
notify_panner_azi_changed (true);
}
_transport_is_rolling = transport_is_rolling;
_metering_active = metering_active;
}