abort if configuration fails
[ardour.git] / libs / ardour / route_group.cc
index 13b90474ccbc3d230f564e37eb9383951c12f1dc..9ad5aa91e6cfc16fd7caa47b0ad91446707b42c7 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2002 Paul Davis 
+    Copyright (C) 2000-2009 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
 
 */
 
-#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/debug.h"
 
-#include <pbd/error.h>
-#include <pbd/enumwriter.h>
+#include "ardour/amp.h"
+#include "ardour/audio_track.h"
+#include "ardour/route.h"
+#include "ardour/route_group.h"
+#include "ardour/session.h"
 
-#include <ardour/route_group.h>
-#include <ardour/audio_track.h>
-#include <ardour/audio_diskstream.h>
-#include <ardour/configuration.h>
+#include "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> relative;
+               PropertyDescriptor<bool> active;
+               PropertyDescriptor<bool> gain;
+               PropertyDescriptor<bool> mute;
+               PropertyDescriptor<bool> solo;
+               PropertyDescriptor<bool> recenable;
+               PropertyDescriptor<bool> select;
+               PropertyDescriptor<bool> route_active;
+               PropertyDescriptor<bool> color;
+               PropertyDescriptor<bool> monitoring;
+       }
 }
 
 void
-RouteGroup::set_name (string str)
+RouteGroup::make_property_quarks ()
 {
-       _name = str;
-       _session.set_dirty ();
-       FlagsChanged (0); /* EMIT SIGNAL */
+       Properties::relative.property_id = g_quark_from_static_string (X_("relative"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for relative = %1\n",   Properties::relative.property_id));
+       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::hidden.property_id = g_quark_from_static_string (X_("hidden"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for hidden = %1\n",     Properties::hidden.property_id));
+       Properties::gain.property_id = g_quark_from_static_string (X_("gain"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for gain = %1\n",       Properties::gain.property_id));
+       Properties::mute.property_id = g_quark_from_static_string (X_("mute"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for mute = %1\n",       Properties::mute.property_id));
+       Properties::solo.property_id = g_quark_from_static_string (X_("solo"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for solo = %1\n",       Properties::solo.property_id));
+       Properties::recenable.property_id = g_quark_from_static_string (X_("recenable"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for recenable = %1\n",  Properties::recenable.property_id));
+       Properties::select.property_id = g_quark_from_static_string (X_("select"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for select = %1\n",     Properties::select.property_id));
+       Properties::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::route_active.property_id));
+       Properties::color.property_id = g_quark_from_static_string (X_("color"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for color = %1\n",       Properties::color.property_id));
+       Properties::monitoring.property_id = g_quark_from_static_string (X_("monitoring"));
+        DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for monitoring = %1\n",       Properties::monitoring.property_id));
+}
+
+#define ROUTE_GROUP_DEFAULT_PROPERTIES  _relative (Properties::relative, true) \
+       , _active (Properties::active, true) \
+       , _hidden (Properties::hidden, false) \
+       , _gain (Properties::gain, true) \
+       , _mute (Properties::mute, true) \
+       , _solo (Properties::solo, true) \
+       , _recenable (Properties::recenable, true) \
+       , _select (Properties::select, true) \
+       , _route_active (Properties::route_active, true) \
+       , _color (Properties::color, true) \
+       , _monitoring (Properties::monitoring, true)
+
+RouteGroup::RouteGroup (Session& s, const string &n)
+       : SessionObject (s, n)
+       , routes (new RouteList)
+       , ROUTE_GROUP_DEFAULT_PROPERTIES
+{
+       _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);
+}
+
+RouteGroup::~RouteGroup ()
+{
+       for (RouteList::iterator i = routes->begin(); i != routes->end();) {
+               RouteList::iterator tmp = i;
+               ++tmp;
+
+               (*i)->set_route_group (0);
+
+               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 (find (routes->begin(), routes->end(), r) != routes->end()) {
+               return 0;
+       }
+
+       if (r->route_group()) {
+               r->route_group()->remove (r);
+       }
+
+       routes->push_back (r);
+
+       r->set_route_group (this);
+       r->DropReferences.connect_same_thread (*this, boost::bind (&RouteGroup::remove_when_going_away, this, boost::weak_ptr<Route> (r)));
+
        _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()) {
-               routes.erase (i);
+       if ((i = find (routes->begin(), routes->end(), r)) != routes->end()) {
+               r->set_route_group (0);
+               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)
+RouteGroup::get_min_factor (gain_t factor)
 {
-       gain_t g;
-       
-       for (list<Route *>::iterator i = routes.begin(); i != routes.end(); i++) {
-               g = (*i)->gain();
+       for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
+               gain_t const g = (*i)->gain_control()->get_value();
 
-               if ( (g+g*factor) >= 0.0f)
+               if ((g + g * factor) >= 0.0f) {
                        continue;
+               }
 
-               if ( g <= 0.0000003f )
+               if (g <= 0.0000003f) {
                        return 0.0f;
-               
-               factor = 0.0000003f/g - 1.0f;
-       }       
+               }
+
+               factor = 0.0000003f / g - 1.0f;
+       }
+
        return factor;
 }
 
 gain_t
-RouteGroup::get_max_factor(gain_t factor)
+RouteGroup::get_max_factor (gain_t factor)
 {
-       gain_t g;
-       
-       for (list<Route *>::iterator i = routes.begin(); i != routes.end(); i++) {
-               g = (*i)->gain();
-               
+       for (RouteList::iterator i = routes->begin(); i != routes->end(); i++) {
+               gain_t const g = (*i)->gain_control()->get_value();
+
                // if the current factor woulnd't raise this route above maximum
-               if ( (g+g*factor) <= 1.99526231f) 
+               if ((g + g * factor) <= 1.99526231f) {
                        continue;
-               
+               }
+
                // if route gain is already at peak, return 0.0f factor
-           if (g>=1.99526231f)
+               if (g >= 1.99526231f) {
                        return 0.0f;
+               }
 
                // factor is calculated so that it would raise current route to max
-               factor = 1.99526231f/g - 1.0f;
+               factor = 1.99526231f / g - 1.0f;
        }
 
        return factor;
 }
 
 XMLNode&
-RouteGroup::get_state (void)
+RouteGroup::get_state ()
 {
        XMLNode *node = new XMLNode ("RouteGroup");
-       node->add_property ("name", _name);
-       node->add_property ("flags", enum_2_string (_flags));
+
+       char buf[64];
+       id().print (buf, sizeof (buf));
+       node->add_property ("id", buf);
+
+       add_properties (*node);
+
+       if (!routes->empty()) {
+               stringstream str;
+
+               for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
+                       str << (*i)->id () << ' ';
+               }
+
+               node->add_property ("routes", str.str());
+       }
+
        return *node;
 }
 
-int 
-RouteGroup::set_state (const XMLNode& node)
+int
+RouteGroup::set_state (const XMLNode& node, int version)
 {
+       if (version < 3000) {
+               return set_state_2X (node, version);
+       }
+
        const XMLProperty *prop;
 
-       if ((prop = node.property ("name")) != 0) {
-               _name = prop->value();
+       set_id (node);
+       set_values (node);
+
+       if ((prop = node.property ("routes")) != 0) {
+               stringstream str (prop->value());
+               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 ((prop = node.property ("flags")) != 0) {
-               _flags = Flag (string_2_enum (prop->value(), _flags));
+       return 0;
+}
+
+int
+RouteGroup::set_state_2X (const XMLNode& node, int /*version*/)
+{
+       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;
        }
 
        return 0;
 }
 
 void
-RouteGroup::set_active (bool yn, void *src)
+RouteGroup::set_gain (bool yn)
+{
+       if (is_gain() == yn) {
+               return;
+       }
+       _gain = yn;
+       send_change (PropertyChange (Properties::gain));
+}
 
+void
+RouteGroup::set_mute (bool yn)
 {
-       if (is_active() == yn) {
+       if (is_mute() == yn) {
                return;
        }
-       if (yn) {
-               _flags = Flag (_flags | Active);
-       } else {
-               _flags = Flag (_flags & ~Active);
+       _mute = yn;
+       send_change (PropertyChange (Properties::mute));
+}
+
+void
+RouteGroup::set_solo (bool yn)
+{
+       if (is_solo() == yn) {
+               return;
        }
-       _session.set_dirty ();
-       FlagsChanged (src); /* EMIT SIGNAL */
+       _solo = yn;
+       send_change (PropertyChange (Properties::solo));
 }
 
 void
-RouteGroup::set_relative (bool yn, void *src)
+RouteGroup::set_recenable (bool yn)
+{
+       if (is_recenable() == yn) {
+               return;
+       }
+       _recenable = yn;
+       send_change (PropertyChange (Properties::recenable));
+}
 
+void
+RouteGroup::set_select (bool yn)
 {
-       if (is_relative() == yn) {
+       if (is_select() == yn) {
                return;
        }
-       if (yn) {
-               _flags = Flag (_flags | Relative);
-       } else {
-               _flags = Flag (_flags & ~Relative);
+       _select = yn;
+       send_change (PropertyChange (Properties::select));
+}
+
+void
+RouteGroup::set_route_active (bool yn)
+{
+       if (is_route_active() == yn) {
+               return;
+       }
+       _route_active = yn;
+       send_change (PropertyChange (Properties::route_active));
+}
+
+void
+RouteGroup::set_color (bool yn)
+{
+       if (is_color() == yn) {
+               return;
+       }
+       _color = yn;
+
+       send_change (PropertyChange (Properties::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_monitoring() == yn) {
+               return;
        }
+
+       _monitoring = yn;
+       send_change (PropertyChange (Properties::monitoring));
+
        _session.set_dirty ();
-       FlagsChanged (src); /* EMIT SIGNAL */
 }
 
 void
-RouteGroup::set_hidden (bool yn, void *src)
+RouteGroup::set_active (bool yn, void* /*src*/)
+{
+       if (is_active() == yn) {
+               return;
+       }
+
+       _active = yn;
+       send_change (PropertyChange (Properties::active));
+       _session.set_dirty ();
+}
 
+void
+RouteGroup::set_relative (bool yn, void* /*src*/)
+{
+       if (is_relative() == yn) {
+               return;
+       }
+       _relative = yn;
+       send_change (PropertyChange (Properties::relative));
+       _session.set_dirty ();
+}
+
+void
+RouteGroup::set_hidden (bool yn, void* /*src*/)
 {
        if (is_hidden() == yn) {
                return;
        }
+
        if (yn) {
-               _flags = Flag (_flags | Hidden);
+               _hidden = true;
                if (Config->get_hiding_groups_deactivates_groups()) {
-                       _flags = Flag (_flags & ~Active);
+                       _active = false;
                }
        } else {
-               _flags = Flag (_flags & ~Hidden);
+               _hidden = false;
                if (Config->get_hiding_groups_deactivates_groups()) {
-                       _flags = Flag (_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 /*XXX*/, 0, 1);
+       } 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 ();
+}