/*
- Copyright (C) 2000-2002 Paul Davis
+ Copyright (C) 2000-2016 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
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- $Id$
*/
-#define __STDC_FORMAT_MACROS
#include <inttypes.h>
#include <algorithm>
-#include <sigc++/bind.h>
+#include "pbd/error.h"
+#include "pbd/enumwriter.h"
+#include "pbd/strsplit.h"
+#include "pbd/types_convert.h"
+#include "pbd/debug.h"
-#include <pbd/error.h>
+#include "ardour/amp.h"
+#include "ardour/audio_track.h"
+#include "ardour/debug.h"
+#include "ardour/monitor_control.h"
+#include "ardour/route.h"
+#include "ardour/route_group.h"
+#include "ardour/session.h"
+#include "ardour/vca.h"
+#include "ardour/vca_manager.h"
-#include <ardour/route_group.h>
-#include <ardour/audio_track.h>
-#include <ardour/diskstream.h>
-#include <ardour/configuration.h>
+#include "pbd/i18n.h"
using namespace ARDOUR;
-using namespace sigc;
+using namespace PBD;
using namespace std;
-RouteGroup::RouteGroup (Session& s, const string &n, Flag f)
- : _session (s), _name (n), _flags (f)
-{
+namespace ARDOUR {
+ namespace Properties {
+ PropertyDescriptor<bool> active;
+ PropertyDescriptor<bool> group_relative;
+ PropertyDescriptor<bool> group_gain;
+ PropertyDescriptor<bool> group_mute;
+ PropertyDescriptor<bool> group_solo;
+ PropertyDescriptor<bool> group_recenable;
+ PropertyDescriptor<bool> group_select;
+ PropertyDescriptor<bool> group_route_active;
+ PropertyDescriptor<bool> group_color;
+ PropertyDescriptor<bool> group_monitoring;
+ PropertyDescriptor<int32_t> group_master_number;
+ }
}
void
-RouteGroup::set_name (string str)
+RouteGroup::make_property_quarks ()
{
- _name = str;
- _session.set_dirty ();
- FlagsChanged (0); /* EMIT SIGNAL */
+ Properties::active.property_id = g_quark_from_static_string (X_("active"));
+ DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for active = %1\n", Properties::active.property_id));
+
+ Properties::group_relative.property_id = g_quark_from_static_string (X_("relative"));
+ DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for relative = %1\n", Properties::group_relative.property_id));
+ Properties::group_gain.property_id = g_quark_from_static_string (X_("gain"));
+ DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for gain = %1\n", Properties::group_gain.property_id));
+ Properties::group_mute.property_id = g_quark_from_static_string (X_("mute"));
+ DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for mute = %1\n", Properties::group_mute.property_id));
+ Properties::group_solo.property_id = g_quark_from_static_string (X_("solo"));
+ DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for solo = %1\n", Properties::group_solo.property_id));
+ Properties::group_recenable.property_id = g_quark_from_static_string (X_("recenable"));
+ DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for recenable = %1\n", Properties::group_recenable.property_id));
+ Properties::group_select.property_id = g_quark_from_static_string (X_("select"));
+ DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for select = %1\n", Properties::group_select.property_id));
+ Properties::group_route_active.property_id = g_quark_from_static_string (X_("route-active"));
+ DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for route-active = %1\n", Properties::group_route_active.property_id));
+ Properties::group_color.property_id = g_quark_from_static_string (X_("color"));
+ DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for color = %1\n", Properties::group_color.property_id));
+ Properties::group_monitoring.property_id = g_quark_from_static_string (X_("monitoring"));
+ DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for monitoring = %1\n", Properties::group_monitoring.property_id));
+ Properties::group_master_number.property_id = g_quark_from_static_string (X_("group-master-number"));
+ DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for group-master-number = %1\n", Properties::group_master_number.property_id));
+}
+
+#define ROUTE_GROUP_DEFAULT_PROPERTIES _relative (Properties::group_relative, true) \
+ , _active (Properties::active, true) \
+ , _hidden (Properties::hidden, false) \
+ , _gain (Properties::group_gain, true) \
+ , _mute (Properties::group_mute, true) \
+ , _solo (Properties::group_solo, true) \
+ , _recenable (Properties::group_recenable, true) \
+ , _select (Properties::group_select, true) \
+ , _route_active (Properties::group_route_active, true) \
+ , _color (Properties::group_color, true) \
+ , _monitoring (Properties::group_monitoring, true) \
+ , _group_master_number (Properties::group_master_number, -1)
+
+RouteGroup::RouteGroup (Session& s, const string &n)
+ : SessionObject (s, n)
+ , routes (new RouteList)
+ , ROUTE_GROUP_DEFAULT_PROPERTIES
+ , _solo_group (new ControlGroup (SoloAutomation))
+ , _mute_group (new ControlGroup (MuteAutomation))
+ , _rec_enable_group (new ControlGroup (RecEnableAutomation))
+ , _gain_group (new GainControlGroup ())
+ , _monitoring_group (new ControlGroup (MonitoringAutomation))
+{
+ _xml_node_name = X_("RouteGroup");
+
+ add_property (_relative);
+ add_property (_active);
+ add_property (_hidden);
+ add_property (_gain);
+ add_property (_mute);
+ add_property (_solo);
+ add_property (_recenable);
+ add_property (_select);
+ add_property (_route_active);
+ add_property (_color);
+ add_property (_monitoring);
+ add_property (_group_master_number);
}
+RouteGroup::~RouteGroup ()
+{
+ _solo_group->clear ();
+ _mute_group->clear ();
+ _gain_group->clear ();
+ _rec_enable_group->clear ();
+ _monitoring_group->clear ();
+
+ boost::shared_ptr<VCA> vca (group_master.lock());
+
+ for (RouteList::iterator i = routes->begin(); i != routes->end();) {
+ RouteList::iterator tmp = i;
+ ++tmp;
+
+ (*i)->set_route_group (0);
+
+ if (vca) {
+ (*i)->unassign (vca);
+ }
+
+ i = tmp;
+ }
+}
+
+/** Add a route to a group. Adding a route which is already in the group is allowed; nothing will happen.
+ * @param r Route to add.
+ */
int
-RouteGroup::add (Route *r)
+RouteGroup::add (boost::shared_ptr<Route> r)
{
- routes.push_back (r);
- r->GoingAway.connect (sigc::bind (mem_fun (*this, &RouteGroup::remove_when_going_away), r));
+ if (r->is_master()) {
+ return 0;
+ }
+
+ if (find (routes->begin(), routes->end(), r) != routes->end()) {
+ return 0;
+ }
+
+ if (r->route_group()) {
+ r->route_group()->remove (r);
+ }
+
+ routes->push_back (r);
+
+ _solo_group->add_control (r->solo_control());
+ _mute_group->add_control (r->mute_control());
+ _gain_group->add_control (r->gain_control());
+ boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (r);
+ if (trk) {
+ _rec_enable_group->add_control (trk->rec_enable_control());
+ _monitoring_group->add_control (trk->monitoring_control());
+ }
+
+ r->set_route_group (this);
+ r->DropReferences.connect_same_thread (*this, boost::bind (&RouteGroup::remove_when_going_away, this, boost::weak_ptr<Route> (r)));
+
+ boost::shared_ptr<VCA> vca (group_master.lock());
+
+ if (vca) {
+ r->assign (vca, false);
+ }
+
_session.set_dirty ();
- changed (); /* EMIT SIGNAL */
+ RouteAdded (this, boost::weak_ptr<Route> (r)); /* EMIT SIGNAL */
return 0;
}
void
-RouteGroup::remove_when_going_away (Route *r)
+RouteGroup::remove_when_going_away (boost::weak_ptr<Route> wr)
{
- remove (r);
+ boost::shared_ptr<Route> r (wr.lock());
+
+ if (r) {
+ remove (r);
+ }
}
-
+
int
-RouteGroup::remove (Route *r)
+RouteGroup::remove (boost::shared_ptr<Route> r)
{
- list<Route *>::iterator i;
+ RouteList::iterator i;
+
+ if ((i = find (routes->begin(), routes->end(), r)) != routes->end()) {
+ r->set_route_group (0);
- if ((i = find (routes.begin(), routes.end(), r)) != routes.end()) {
- routes.erase (i);
+ boost::shared_ptr<VCA> vca = group_master.lock();
+
+ if (vca) {
+ r->unassign (vca);
+ }
+
+ _solo_group->remove_control (r->solo_control());
+ _mute_group->remove_control (r->mute_control());
+ _gain_group->remove_control (r->gain_control());
+ boost::shared_ptr<Track> trk = boost::dynamic_pointer_cast<Track> (r);
+ if (trk) {
+ _rec_enable_group->remove_control (trk->rec_enable_control());
+ _monitoring_group->remove_control (trk->monitoring_control());
+ }
+ routes->erase (i);
_session.set_dirty ();
- changed (); /* EMIT SIGNAL */
+ RouteRemoved (this, boost::weak_ptr<Route> (r)); /* EMIT SIGNAL */
return 0;
}
+
return -1;
}
-gain_t
-RouteGroup::get_min_factor(gain_t factor)
+XMLNode&
+RouteGroup::get_state ()
{
- gain_t g;
-
- for (list<Route *>::iterator i = routes.begin(); i != routes.end(); i++) {
- g = (*i)->gain();
+ XMLNode *node = new XMLNode ("RouteGroup");
+
+ node->set_property ("id", id());
+
+ add_properties (*node);
- if ( (g+g*factor) >= 0.0f)
- continue;
+ if (!routes->empty()) {
+ stringstream str;
- if ( g <= 0.0000003f )
- return 0.0f;
-
- factor = 0.0000003f/g - 1.0f;
- }
- return factor;
+ for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
+ str << (*i)->id () << ' ';
+ }
+
+ node->set_property ("routes", str.str());
+ }
+
+ return *node;
}
-gain_t
-RouteGroup::get_max_factor(gain_t factor)
+int
+RouteGroup::set_state (const XMLNode& node, int version)
{
- gain_t g;
-
- for (list<Route *>::iterator i = routes.begin(); i != routes.end(); i++) {
- g = (*i)->gain();
-
- // if the current factor woulnd't raise this route above maximum
- if ( (g+g*factor) <= 1.99526231f)
- continue;
-
- // if route gain is already at peak, return 0.0f factor
- if (g>=1.99526231f)
- return 0.0f;
+ if (version < 3000) {
+ return set_state_2X (node, version);
+ }
- // factor is calculated so that it would raise current route to max
- factor = 1.99526231f/g - 1.0f;
+ set_id (node);
+ set_values (node);
+
+ std::string routes;
+ if (node.get_property ("routes", routes)) {
+ stringstream str (routes);
+ vector<string> ids;
+ split (str.str(), ids, ' ');
+
+ for (vector<string>::iterator i = ids.begin(); i != ids.end(); ++i) {
+ PBD::ID id (*i);
+ boost::shared_ptr<Route> r = _session.route_by_id (id);
+
+ if (r) {
+ add (r);
+ }
+ }
+ }
+
+ if (_group_master_number.val() > 0) {
+ boost::shared_ptr<VCA> vca = _session.vca_manager().vca_by_number (_group_master_number.val());
+ if (vca) {
+ /* no need to do the assignment because slaves will
+ handle that themselves. But we can set group_master
+ to use with future assignments of newly added routes.
+ */
+ group_master = vca;
+ }
}
- return factor;
+ push_to_groups ();
+
+ return 0;
}
-XMLNode&
-RouteGroup::get_state (void)
+int
+RouteGroup::set_state_2X (const XMLNode& node, int /*version*/)
{
- char buf[32];
- XMLNode *node = new XMLNode ("RouteGroup");
- node->add_property ("name", _name);
- snprintf (buf, sizeof (buf), "%" PRIu32, (uint32_t) _flags);
- node->add_property ("flags", buf);
- return *node;
+ set_values (node);
+
+ if (node.name() == "MixGroup") {
+ _gain = true;
+ _mute = true;
+ _solo = true;
+ _recenable = true;
+ _route_active = true;
+ _color = false;
+ } else if (node.name() == "EditGroup") {
+ _gain = false;
+ _mute = false;
+ _solo = false;
+ _recenable = false;
+ _route_active = false;
+ _color = false;
+ }
+
+ push_to_groups ();
+
+ return 0;
}
-int
-RouteGroup::set_state (const XMLNode& node)
+void
+RouteGroup::set_gain (bool yn)
{
- const XMLProperty *prop;
+ if (is_gain() == yn) {
+ return;
+ }
+ if (has_control_master()) {
+ return;
+ }
- if ((prop = node.property ("name")) != 0) {
- _name = prop->value();
+ _gain = yn;
+ _gain_group->set_active (yn);
+
+ send_change (PropertyChange (Properties::group_gain));
+}
+
+void
+RouteGroup::set_mute (bool yn)
+{
+ if (is_mute() == yn) {
+ return;
}
+ _mute = yn;
+ _mute_group->set_active (yn);
+
+ send_change (PropertyChange (Properties::group_mute));
+}
- if ((prop = node.property ("flags")) != 0) {
- _flags = atoi (prop->value().c_str());
+void
+RouteGroup::set_solo (bool yn)
+{
+ if (is_solo() == yn) {
+ return;
}
+ _solo = yn;
+ _solo_group->set_active (yn);
- return 0;
+ send_change (PropertyChange (Properties::group_solo));
}
void
-RouteGroup::set_active (bool yn, void *src)
+RouteGroup::set_recenable (bool yn)
+{
+ if (is_recenable() == yn) {
+ return;
+ }
+ _recenable = yn;
+ _rec_enable_group->set_active (yn);
+ send_change (PropertyChange (Properties::group_recenable));
+}
+void
+RouteGroup::set_select (bool yn)
{
- if (is_active() == yn) {
+ if (is_select() == yn) {
return;
}
- if (yn) {
- _flags |= Active;
- } else {
- _flags &= ~Active;
+ _select = yn;
+ send_change (PropertyChange (Properties::group_select));
+}
+
+void
+RouteGroup::set_route_active (bool yn)
+{
+ if (is_route_active() == yn) {
+ return;
}
- _session.set_dirty ();
- FlagsChanged (src); /* EMIT SIGNAL */
+ _route_active = yn;
+ send_change (PropertyChange (Properties::group_route_active));
}
void
-RouteGroup::set_relative (bool yn, void *src)
+RouteGroup::set_color (bool yn)
+{
+ if (is_color() == yn) {
+ return;
+ }
+ _color = yn;
+ send_change (PropertyChange (Properties::group_color));
+
+ /* This is a bit of a hack, but this might change
+ our route's effective color, so emit gui_changed
+ for our routes.
+ */
+
+ for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
+ (*i)->gui_changed (X_("color"), this);
+ }
+}
+
+void
+RouteGroup::set_monitoring (bool yn)
{
- if (is_relative() == yn) {
+ if (is_monitoring() == yn) {
return;
}
- if (yn) {
- _flags |= Relative;
- } else {
- _flags &= ~Relative;
+
+ _monitoring = yn;
+ _monitoring_group->set_active (yn);
+
+ send_change (PropertyChange (Properties::group_monitoring));
+
+ _session.set_dirty ();
+}
+
+void
+RouteGroup::set_active (bool yn, void* /*src*/)
+{
+ if (is_active() == yn) {
+ return;
}
+
+ _active = yn;
+
+ push_to_groups ();
+
+ send_change (PropertyChange (Properties::active));
_session.set_dirty ();
- FlagsChanged (src); /* EMIT SIGNAL */
}
void
-RouteGroup::set_hidden (bool yn, void *src)
+RouteGroup::set_relative (bool yn, void* /*src*/)
+{
+ if (is_relative() == yn) {
+ return;
+ }
+ _relative = yn;
+
+ push_to_groups ();
+
+ send_change (PropertyChange (Properties::group_relative));
+ _session.set_dirty ();
+}
+
+void
+RouteGroup::set_hidden (bool yn, void* /*src*/)
{
if (is_hidden() == yn) {
return;
}
+
if (yn) {
- _flags |= Hidden;
+ _hidden = true;
if (Config->get_hiding_groups_deactivates_groups()) {
- _flags &= ~Active;
+ _active = false;
}
} else {
- _flags &= ~Hidden;
+ _hidden = false;
if (Config->get_hiding_groups_deactivates_groups()) {
- _flags |= Active;
+ _active = true;
}
}
+
+ send_change (Properties::hidden);
+
_session.set_dirty ();
- FlagsChanged (src); /* EMIT SIGNAL */
}
void
-RouteGroup::audio_track_group (set<AudioTrack*>& ats)
-{
- for (list<Route*>::iterator i = routes.begin(); i != routes.end(); ++i) {
- AudioTrack* at = dynamic_cast<AudioTrack*>(*i);
+RouteGroup::audio_track_group (set<boost::shared_ptr<AudioTrack> >& ats)
+{
+ for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
+ boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack>(*i);
if (at) {
ats.insert (at);
}
}
}
+void
+RouteGroup::make_subgroup (bool aux, Placement placement)
+{
+ RouteList rl;
+ uint32_t nin = 0;
+
+ /* since we don't do MIDI Busses yet, check quickly ... */
+
+ for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
+ if ((*i)->output()->n_ports().n_midi() != 0) {
+ PBD::warning << _("You cannot subgroup MIDI tracks at this time") << endmsg;
+ return;
+ }
+ }
+
+ for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
+ if (!aux && nin != 0 && nin != (*i)->output()->n_ports().n_audio()) {
+ PBD::warning << _("You cannot subgroup tracks with different number of outputs at this time.") << endmsg;
+ return;
+ }
+ nin = max (nin, (*i)->output()->n_ports().n_audio());
+ }
+
+ try {
+ /* use master bus etc. to determine default nouts.
+ *
+ * (since tracks can't have fewer outs than ins,
+ * "nin" currently defines the number of outpus if nin > 2)
+ */
+ rl = _session.new_audio_route (nin, 2, 0, 1, string(), PresentationInfo::AudioBus, PresentationInfo::max_order);
+ } catch (...) {
+ return;
+ }
+
+ subgroup_bus = rl.front();
+ subgroup_bus->set_name (_name);
+
+ if (aux) {
+
+ _session.add_internal_sends (subgroup_bus, placement, routes);
+
+ } else {
+
+ boost::shared_ptr<Bundle> bundle = subgroup_bus->input()->bundle ();
+
+ for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
+ (*i)->output()->disconnect (this);
+ (*i)->output()->connect_ports_to_bundle (bundle, false, this);
+ }
+ }
+}
+
+void
+RouteGroup::destroy_subgroup ()
+{
+ if (!subgroup_bus) {
+ return;
+ }
+
+ for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
+ (*i)->output()->disconnect (this);
+ /* XXX find a new bundle to connect to */
+ }
+
+ _session.remove_route (subgroup_bus);
+ subgroup_bus.reset ();
+}
+
+bool
+RouteGroup::has_subgroup() const
+{
+ return subgroup_bus != 0;
+}
+
+bool
+RouteGroup::enabled_property (PBD::PropertyID prop)
+{
+ OwnedPropertyList::iterator i = _properties->find (prop);
+ if (i == _properties->end()) {
+ return false;
+ }
+
+ return dynamic_cast<const PropertyTemplate<bool>* > (i->second)->val ();
+}
+
+void
+RouteGroup::post_set (PBD::PropertyChange const &)
+{
+ push_to_groups ();
+}
+
+void
+RouteGroup::push_to_groups ()
+{
+ if (is_relative()) {
+ _gain_group->set_mode (ControlGroup::Mode (_gain_group->mode()|ControlGroup::Relative));
+ } else {
+ _gain_group->set_mode (ControlGroup::Mode (_gain_group->mode()&~ControlGroup::Relative));
+ }
+
+ if (_active) {
+ _gain_group->set_active (is_gain());
+ _solo_group->set_active (is_solo());
+ _mute_group->set_active (is_mute());
+ _rec_enable_group->set_active (is_recenable());
+ _monitoring_group->set_active (is_monitoring());
+ } else {
+ _gain_group->set_active (false);
+ _solo_group->set_active (false);
+ _mute_group->set_active (false);
+
+ _rec_enable_group->set_active (false);
+ _monitoring_group->set_active (false);
+ }
+}
+
+void
+RouteGroup::assign_master (boost::shared_ptr<VCA> master)
+{
+ if (!routes || routes->empty()) {
+ return;
+ }
+
+ boost::shared_ptr<Route> front = routes->front ();
+
+ if (front->slaved_to (master)) {
+ return;
+ }
+
+ for (RouteList::iterator r = routes->begin(); r != routes->end(); ++r) {
+ (*r)->assign (master, false);
+ }
+
+ bool used_to_share_gain = false;
+
+ if (is_gain()) {
+ used_to_share_gain = true;
+ }
+
+ group_master = master;
+ _group_master_number = master->number();
+ _gain_group->set_active (false);
+
+ if (used_to_share_gain) {
+ send_change (PropertyChange (Properties::group_gain));
+ }
+}
+
+void
+RouteGroup::unassign_master (boost::shared_ptr<VCA> master)
+{
+ if (!routes || routes->empty()) {
+ return;
+ }
+
+ boost::shared_ptr<Route> front = routes->front ();
+
+ if (!front->slaved_to (master)) {
+ return;
+ }
+
+ for (RouteList::iterator r = routes->begin(); r != routes->end(); ++r) {
+ (*r)->unassign (master);
+ }
+
+ group_master.reset ();
+ _group_master_number = -1;
+
+ /* this is slightly tricky: is_gain() will return whether or not
+ the group is supposed to be sharing gain adjustment, and now that
+ we've reset _group_master_number to -1, it will reflect the user's
+ intentions correctly. Since there was a master before, and now there
+ is not, we are going to reactivate gain sharing ... and then tell
+ the world about it.
+ */
+ if (is_gain()) {
+ _gain_group->set_active (true);
+ send_change (PropertyChange (Properties::group_gain));
+ }
+}
+
+bool
+RouteGroup::slaved () const
+{
+ if (!routes || routes->empty()) {
+ return false;
+ }
+
+ return routes->front()->slaved ();
+}
+
+bool
+RouteGroup::has_control_master() const
+{
+ return group_master.lock() != 0;
+}