libs/ardour/route_group.cc

   1 /*
   2     Copyright (C) 2000-2009 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <inttypes.h>
  21
  22 #include <algorithm>
  23
  24
  25 #include "pbd/error.h"
  26 #include "pbd/enumwriter.h"
  27 #include "pbd/strsplit.h"
  28
  29 #include "ardour/amp.h"
  30 #include "ardour/debug.h"
  31 #include "ardour/route_group.h"
  32 #include "ardour/audio_track.h"
  33 #include "ardour/audio_diskstream.h"
  34 #include "ardour/configuration.h"
  35 #include "ardour/session.h"
  36
  37 #include "i18n.h"
  38
  39 using namespace ARDOUR;
  40 using namespace PBD;
  41 using namespace std;
  42
  43 namespace ARDOUR {
  44         namespace Properties {
  45                 PropertyDescriptor<bool> relative;
  46                 PropertyDescriptor<bool> active;
  47                 PropertyDescriptor<bool> gain;
  48                 PropertyDescriptor<bool> mute;
  49                 PropertyDescriptor<bool> solo;
  50                 PropertyDescriptor<bool> recenable;
  51                 PropertyDescriptor<bool> select;
  52                 PropertyDescriptor<bool> edit;
  53                 PropertyDescriptor<bool> route_active;
  54                 PropertyDescriptor<bool> color;
  55         }
  56 }
  57
  58 void
  59 RouteGroup::make_property_quarks ()
  60 {
  61         Properties::relative.property_id = g_quark_from_static_string (X_("relative"));
  62         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for relative = %1\n",    Properties::relative.property_id));
  63         Properties::active.property_id = g_quark_from_static_string (X_("active"));
  64         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for active = %1\n",      Properties::active.property_id));
  65         Properties::hidden.property_id = g_quark_from_static_string (X_("hidden"));
  66         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for hidden = %1\n",      Properties::hidden.property_id));
  67         Properties::gain.property_id = g_quark_from_static_string (X_("gain"));
  68         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for gain = %1\n",        Properties::gain.property_id));
  69         Properties::mute.property_id = g_quark_from_static_string (X_("mute"));
  70         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for mute = %1\n",        Properties::mute.property_id));
  71         Properties::solo.property_id = g_quark_from_static_string (X_("solo"));
  72         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for solo = %1\n",        Properties::solo.property_id));
  73         Properties::recenable.property_id = g_quark_from_static_string (X_("recenable"));
  74         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for recenable = %1\n",   Properties::recenable.property_id));
  75         Properties::select.property_id = g_quark_from_static_string (X_("select"));
  76         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for select = %1\n",      Properties::select.property_id));
  77         Properties::edit.property_id = g_quark_from_static_string (X_("edit"));
  78         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for edit = %1\n",        Properties::edit.property_id));
  79         Properties::route_active.property_id = g_quark_from_static_string (X_("route-active"));
  80         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for route-active = %1\n", Properties::route_active.property_id));
  81         Properties::color.property_id = g_quark_from_static_string (X_("color"));
  82         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for color = %1\n",       Properties::color.property_id));
  83 }
  84
  85 #define ROUTE_GROUP_DEFAULT_PROPERTIES  _relative (Properties::relative, false) \
  86         , _active (Properties::active, false) \
  87         , _hidden (Properties::hidden, false) \
  88         , _gain (Properties::gain, false) \
  89         , _mute (Properties::mute, false) \
  90         , _solo (Properties::solo, false) \
  91         , _recenable (Properties::recenable, false) \
  92         , _select (Properties::select, false) \
  93         , _edit (Properties::edit, false) \
  94         , _route_active (Properties::route_active, false) \
  95         , _color (Properties::color, false)
  96
  97 RouteGroup::RouteGroup (Session& s, const string &n)
  98         : SessionObject (s, n)
  99         , routes (new RouteList)
 100         , ROUTE_GROUP_DEFAULT_PROPERTIES
 101 {
 102         _xml_node_name = X_("RouteGroup");
 103
 104         add_property (_relative);
 105         add_property (_active);
 106         add_property (_hidden);
 107         add_property (_gain);
 108         add_property (_mute);
 109         add_property (_solo);
 110         add_property (_recenable);
 111         add_property (_select);
 112         add_property (_edit);
 113         add_property (_route_active);
 114         add_property (_color);
 115 }
 116
 117 RouteGroup::~RouteGroup ()
 118 {
 119         for (RouteList::iterator i = routes->begin(); i != routes->end();) {
 120                 RouteList::iterator tmp = i;
 121                 ++tmp;
 122
 123                 (*i)->leave_route_group ();
 124
 125                 i = tmp;
 126         }
 127 }
 128
 129 /** Add a route to a group.  Adding a route which is already in the group is allowed; nothing will happen.
 130  *  @param r Route to add.
 131  */
 132 int
 133 RouteGroup::add (boost::shared_ptr<Route> r)
 134 {
 135         if (find (routes->begin(), routes->end(), r) != routes->end()) {
 136                 return 0;
 137         }
 138
 139         r->leave_route_group ();
 140
 141         routes->push_back (r);
 142
 143         r->join_route_group (this);
 144         r->DropReferences.connect_same_thread (*this, boost::bind (&RouteGroup::remove_when_going_away, this, boost::weak_ptr<Route> (r)));
 145
 146         _session.set_dirty ();
 147         MembershipChanged (); /* EMIT SIGNAL */
 148         return 0;
 149 }
 150
 151 void
 152 RouteGroup::remove_when_going_away (boost::weak_ptr<Route> wr)
 153 {
 154         boost::shared_ptr<Route> r (wr.lock());
 155
 156         if (r) {
 157                 remove (r);
 158         }
 159 }
 160
 161 int
 162 RouteGroup::remove (boost::shared_ptr<Route> r)
 163 {
 164         RouteList::iterator i;
 165
 166         if ((i = find (routes->begin(), routes->end(), r)) != routes->end()) {
 167                 r->leave_route_group ();
 168                 routes->erase (i);
 169                 _session.set_dirty ();
 170                 MembershipChanged (); /* EMIT SIGNAL */
 171                 return 0;
 172         }
 173
 174         return -1;
 175 }
 176
 177
 178 gain_t
 179 RouteGroup::get_min_factor (gain_t factor)
 180 {
 181         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 182                 gain_t const g = (*i)->amp()->gain();
 183
 184                 if ((g + g * factor) >= 0.0f) {
 185                         continue;
 186                 }
 187
 188                 if (g <= 0.0000003f) {
 189                         return 0.0f;
 190                 }
 191
 192                 factor = 0.0000003f / g - 1.0f;
 193         }
 194
 195         return factor;
 196 }
 197
 198 gain_t
 199 RouteGroup::get_max_factor (gain_t factor)
 200 {
 201         for (RouteList::iterator i = routes->begin(); i != routes->end(); i++) {
 202                 gain_t const g = (*i)->amp()->gain();
 203
 204                 // if the current factor woulnd't raise this route above maximum
 205                 if ((g + g * factor) <= 1.99526231f) {
 206                         continue;
 207                 }
 208
 209                 // if route gain is already at peak, return 0.0f factor
 210                 if (g >= 1.99526231f) {
 211                         return 0.0f;
 212                 }
 213
 214                 // factor is calculated so that it would raise current route to max
 215                 factor = 1.99526231f / g - 1.0f;
 216         }
 217
 218         return factor;
 219 }
 220
 221 XMLNode&
 222 RouteGroup::get_state ()
 223 {
 224         XMLNode *node = new XMLNode ("RouteGroup");
 225
 226         char buf[64];
 227         id().print (buf, sizeof (buf));
 228         node->add_property ("id", buf);
 229
 230         add_properties (*node);
 231
 232         if (!routes->empty()) {
 233                 stringstream str;
 234
 235                 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 236                         str << (*i)->id () << ' ';
 237                 }
 238
 239                 node->add_property ("routes", str.str());
 240         }
 241
 242         return *node;
 243 }
 244
 245 int
 246 RouteGroup::set_state (const XMLNode& node, int version)
 247 {
 248         if (version < 3000) {
 249                 return set_state_2X (node, version);
 250         }
 251
 252         const XMLProperty *prop;
 253
 254         if ((prop = node.property ("id")) != 0) {
 255                 _id = prop->value();
 256         }
 257
 258         set_values (node);
 259
 260         if ((prop = node.property ("routes")) != 0) {
 261                 stringstream str (prop->value());
 262                 vector<string> ids;
 263                 split (str.str(), ids, ' ');
 264
 265                 for (vector<string>::iterator i = ids.begin(); i != ids.end(); ++i) {
 266                         PBD::ID id (*i);
 267                         boost::shared_ptr<Route> r = _session.route_by_id (id);
 268
 269                         if (r) {
 270                                 add (r);
 271                         }
 272                 }
 273         }
 274
 275         return 0;
 276 }
 277
 278 int
 279 RouteGroup::set_state_2X (const XMLNode& node, int /*version*/)
 280 {
 281         set_values (node);
 282
 283         if (node.name() == "MixGroup") {
 284                 _gain = true;
 285                 _mute = true;
 286                 _solo = true;
 287                 _recenable = true;
 288                 _edit = false;
 289                 _route_active = true;
 290                 _color = false;
 291         } else if (node.name() == "EditGroup") {
 292                 _gain = false;
 293                 _mute = false;
 294                 _solo = false;
 295                 _recenable = false;
 296                 _edit = true;
 297                 _route_active = false;
 298                 _color = false;
 299         }
 300
 301         return 0;
 302 }
 303
 304 void
 305 RouteGroup::set_gain (bool yn)
 306 {
 307         if (is_gain() == yn) {
 308                 return;
 309         }
 310         _gain = yn;
 311 }
 312
 313 void
 314 RouteGroup::set_mute (bool yn)
 315 {
 316         if (is_mute() == yn) {
 317                 return;
 318         }
 319         _mute = yn;
 320 }
 321
 322 void
 323 RouteGroup::set_solo (bool yn)
 324 {
 325         if (is_solo() == yn) {
 326                 return;
 327         }
 328         _solo = yn;
 329 }
 330
 331 void
 332 RouteGroup::set_recenable (bool yn)
 333 {
 334         if (is_recenable() == yn) {
 335                 return;
 336         }
 337         _recenable = yn;
 338 }
 339
 340 void
 341 RouteGroup::set_select (bool yn)
 342 {
 343         if (is_select() == yn) {
 344                 return;
 345         }
 346         _select = yn;
 347 }
 348
 349 void
 350 RouteGroup::set_edit (bool yn)
 351 {
 352         if (is_edit() == yn) {
 353                 return;
 354         }
 355         _edit = yn;
 356 }
 357
 358 void
 359 RouteGroup::set_route_active (bool yn)
 360 {
 361         if (is_route_active() == yn) {
 362                 return;
 363         }
 364         _route_active = yn;
 365 }
 366
 367 void
 368 RouteGroup::set_color (bool yn)
 369 {
 370         if (is_color() == yn) {
 371                 return;
 372         }
 373         _color = yn;
 374
 375         /* This is a bit of a hack, but this might change
 376            our route's effective color, so emit gui_changed
 377            for our routes.
 378         */
 379
 380         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 381                 (*i)->gui_changed (X_("color"), this);
 382         }
 383 }
 384
 385 void
 386 RouteGroup::set_active (bool yn, void* /*src*/)
 387 {
 388         if (is_active() == yn) {
 389                 return;
 390         }
 391
 392         _active = yn;
 393         send_change (PropertyChange (Properties::active));
 394
 395         _session.set_dirty ();
 396 }
 397
 398 void
 399 RouteGroup::set_relative (bool yn, void* /*src*/)
 400 {
 401         if (is_relative() == yn) {
 402                 return;
 403         }
 404         _relative = yn;
 405         _session.set_dirty ();
 406 }
 407
 408 void
 409 RouteGroup::set_hidden (bool yn, void* /*src*/)
 410 {
 411         if (is_hidden() == yn) {
 412                 return;
 413         }
 414
 415         if (yn) {
 416                 _hidden = true;
 417                 if (Config->get_hiding_groups_deactivates_groups()) {
 418                         _active = false;
 419                 }
 420         } else {
 421                 _hidden = false;
 422                 if (Config->get_hiding_groups_deactivates_groups()) {
 423                         _active = true;
 424                 }
 425         }
 426
 427         send_change (Properties::hidden);
 428
 429         _session.set_dirty ();
 430 }
 431
 432 void
 433 RouteGroup::audio_track_group (set<boost::shared_ptr<AudioTrack> >& ats)
 434 {
 435         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 436                 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack>(*i);
 437                 if (at) {
 438                         ats.insert (at);
 439                 }
 440         }
 441 }
 442
 443 void
 444 RouteGroup::make_subgroup (bool aux, Placement placement)
 445 {
 446         RouteList rl;
 447         uint32_t nin = 0;
 448
 449         /* since we don't do MIDI Busses yet, check quickly ... */
 450
 451         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 452                 if ((*i)->output()->n_ports().n_midi() != 0) {
 453                         PBD::info << _("You cannot subgroup MIDI tracks at this time") << endmsg;
 454                         return;
 455                 }
 456         }
 457
 458         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 459                 nin = max (nin, (*i)->output()->n_ports().n_audio());
 460         }
 461
 462         try {
 463                 /* use master bus etc. to determine default nouts */
 464                 rl = _session.new_audio_route (nin, 2, 0, 1);
 465         } catch (...) {
 466                 return;
 467         }
 468
 469         subgroup_bus = rl.front();
 470         subgroup_bus->set_name (_name);
 471
 472         if (aux) {
 473
 474                 _session.add_internal_sends (subgroup_bus, placement, routes);
 475
 476         } else {
 477
 478                 boost::shared_ptr<Bundle> bundle = subgroup_bus->input()->bundle ();
 479
 480                 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 481                         (*i)->output()->disconnect (this);
 482                         (*i)->output()->connect_ports_to_bundle (bundle, this);
 483                 }
 484         }
 485 }
 486
 487 void
 488 RouteGroup::destroy_subgroup ()
 489 {
 490         if (!subgroup_bus) {
 491                 return;
 492         }
 493
 494         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 495                 (*i)->output()->disconnect (this);
 496                 /* XXX find a new bundle to connect to */
 497         }
 498
 499         _session.remove_route (subgroup_bus);
 500         subgroup_bus.reset ();
 501 }
 502
 503 bool
 504 RouteGroup::enabled_property (PBD::PropertyID prop)
 505 {
 506         OwnedPropertyList::iterator i = _properties->find (prop);
 507         if (i == _properties->end()) {
 508                 return false;
 509         }
 510
 511         return dynamic_cast<const PropertyTemplate<bool>* > (i->second)->val ();
 512 }