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         }
  55 }
  56
  57 void
  58 RouteGroup::make_property_quarks ()
  59 {
  60         Properties::relative.property_id = g_quark_from_static_string (X_("relative"));
  61         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for relative = %1\n",    Properties::relative.property_id));
  62         Properties::active.property_id = g_quark_from_static_string (X_("active"));
  63         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for active = %1\n",      Properties::active.property_id));
  64         Properties::hidden.property_id = g_quark_from_static_string (X_("hidden"));
  65         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for hidden = %1\n",      Properties::hidden.property_id));
  66         Properties::gain.property_id = g_quark_from_static_string (X_("gain"));
  67         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for gain = %1\n",        Properties::gain.property_id));
  68         Properties::mute.property_id = g_quark_from_static_string (X_("mute"));
  69         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for mute = %1\n",        Properties::mute.property_id));
  70         Properties::solo.property_id = g_quark_from_static_string (X_("solo"));
  71         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for solo = %1\n",        Properties::solo.property_id));
  72         Properties::recenable.property_id = g_quark_from_static_string (X_("recenable"));
  73         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for recenable = %1\n",   Properties::recenable.property_id));
  74         Properties::select.property_id = g_quark_from_static_string (X_("select"));
  75         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for select = %1\n",      Properties::select.property_id));
  76         Properties::edit.property_id = g_quark_from_static_string (X_("edit"));
  77         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for edit = %1\n",        Properties::edit.property_id));
  78         Properties::route_active.property_id = g_quark_from_static_string (X_("route-active"));
  79         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for route-active = %1\n", Properties::route_active.property_id));
  80 }
  81
  82 #define ROUTE_GROUP_DEFAULT_PROPERTIES  _relative (Properties::relative, false) \
  83         , _active (Properties::active, false) \
  84         , _hidden (Properties::hidden, false) \
  85         , _gain (Properties::gain, false) \
  86         , _mute (Properties::mute, false) \
  87         , _solo (Properties::solo, false) \
  88         , _recenable (Properties::recenable, false) \
  89         , _select (Properties::select, false) \
  90         , _edit (Properties::edit, false) \
  91         , _route_active (Properties::route_active, false)
  92
  93 RouteGroup::RouteGroup (Session& s, const string &n)
  94         : SessionObject (s, n)
  95         , routes (new RouteList)
  96         , ROUTE_GROUP_DEFAULT_PROPERTIES
  97 {
  98         _xml_node_name = X_("RouteGroup");
  99
 100         add_property (_relative);
 101         add_property (_active);
 102         add_property (_hidden);
 103         add_property (_gain);
 104         add_property (_mute);
 105         add_property (_solo);
 106         add_property (_recenable);
 107         add_property (_select);
 108         add_property (_edit);
 109         add_property (_route_active);
 110 }
 111
 112 RouteGroup::~RouteGroup ()
 113 {
 114         for (RouteList::iterator i = routes->begin(); i != routes->end();) {
 115                 RouteList::iterator tmp = i;
 116                 ++tmp;
 117
 118                 (*i)->leave_route_group ();
 119
 120                 i = tmp;
 121         }
 122 }
 123
 124 /** Add a route to a group.  Adding a route which is already in the group is allowed; nothing will happen.
 125  *  @param r Route to add.
 126  */
 127 int
 128 RouteGroup::add (boost::shared_ptr<Route> r)
 129 {
 130         if (find (routes->begin(), routes->end(), r) != routes->end()) {
 131                 return 0;
 132         }
 133
 134         r->leave_route_group ();
 135
 136         routes->push_back (r);
 137
 138         r->join_route_group (this);
 139         r->DropReferences.connect_same_thread (*this, boost::bind (&RouteGroup::remove_when_going_away, this, boost::weak_ptr<Route> (r)));
 140
 141         _session.set_dirty ();
 142         MembershipChanged (); /* EMIT SIGNAL */
 143         return 0;
 144 }
 145
 146 void
 147 RouteGroup::remove_when_going_away (boost::weak_ptr<Route> wr)
 148 {
 149         boost::shared_ptr<Route> r (wr.lock());
 150
 151         if (r) {
 152                 remove (r);
 153         }
 154 }
 155
 156 int
 157 RouteGroup::remove (boost::shared_ptr<Route> r)
 158 {
 159         RouteList::iterator i;
 160
 161         if ((i = find (routes->begin(), routes->end(), r)) != routes->end()) {
 162                 r->leave_route_group ();
 163                 routes->erase (i);
 164                 _session.set_dirty ();
 165                 MembershipChanged (); /* EMIT SIGNAL */
 166                 return 0;
 167         }
 168
 169         return -1;
 170 }
 171
 172
 173 gain_t
 174 RouteGroup::get_min_factor (gain_t factor)
 175 {
 176         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 177                 gain_t const g = (*i)->amp()->gain();
 178
 179                 if ((g + g * factor) >= 0.0f) {
 180                         continue;
 181                 }
 182
 183                 if (g <= 0.0000003f) {
 184                         return 0.0f;
 185                 }
 186
 187                 factor = 0.0000003f / g - 1.0f;
 188         }
 189
 190         return factor;
 191 }
 192
 193 gain_t
 194 RouteGroup::get_max_factor (gain_t factor)
 195 {
 196         for (RouteList::iterator i = routes->begin(); i != routes->end(); i++) {
 197                 gain_t const g = (*i)->amp()->gain();
 198
 199                 // if the current factor woulnd't raise this route above maximum
 200                 if ((g + g * factor) <= 1.99526231f) {
 201                         continue;
 202                 }
 203
 204                 // if route gain is already at peak, return 0.0f factor
 205                 if (g >= 1.99526231f) {
 206                         return 0.0f;
 207                 }
 208
 209                 // factor is calculated so that it would raise current route to max
 210                 factor = 1.99526231f / g - 1.0f;
 211         }
 212
 213         return factor;
 214 }
 215
 216 XMLNode&
 217 RouteGroup::get_state ()
 218 {
 219         XMLNode *node = new XMLNode ("RouteGroup");
 220
 221         char buf[64];
 222         id().print (buf, sizeof (buf));
 223         node->add_property ("id", buf);
 224
 225         add_properties (*node);
 226
 227         if (!routes->empty()) {
 228                 stringstream str;
 229
 230                 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 231                         str << (*i)->id () << ' ';
 232                 }
 233
 234                 node->add_property ("routes", str.str());
 235         }
 236
 237         return *node;
 238 }
 239
 240 int
 241 RouteGroup::set_state (const XMLNode& node, int version)
 242 {
 243         if (version < 3000) {
 244                 return set_state_2X (node, version);
 245         }
 246
 247         const XMLProperty *prop;
 248
 249         if ((prop = node.property ("id")) != 0) {
 250                 _id = prop->value();
 251         }
 252
 253         set_values (node);
 254
 255         if ((prop = node.property ("routes")) != 0) {
 256                 stringstream str (prop->value());
 257                 vector<string> ids;
 258                 split (str.str(), ids, ' ');
 259
 260                 for (vector<string>::iterator i = ids.begin(); i != ids.end(); ++i) {
 261                         PBD::ID id (*i);
 262                         boost::shared_ptr<Route> r = _session.route_by_id (id);
 263
 264                         if (r) {
 265                                 add (r);
 266                         }
 267                 }
 268         }
 269
 270         return 0;
 271 }
 272
 273 int
 274 RouteGroup::set_state_2X (const XMLNode& node, int /*version*/)
 275 {
 276         set_values (node);
 277
 278         if (node.name() == "MixGroup") {
 279                 _gain = true;
 280                 _mute = true;
 281                 _solo = true;
 282                 _recenable = true;
 283                 _edit = false;
 284                 _route_active = true;
 285         } else if (node.name() == "EditGroup") {
 286                 _gain = false;
 287                 _mute = false;
 288                 _solo = false;
 289                 _recenable = false;
 290                 _edit = true;
 291                 _route_active = false;
 292         }
 293
 294         return 0;
 295 }
 296
 297 void
 298 RouteGroup::set_gain (bool yn)
 299 {
 300         if (is_gain() == yn) {
 301                 return;
 302         }
 303         _gain = yn;
 304 }
 305
 306 void
 307 RouteGroup::set_mute (bool yn)
 308 {
 309         if (is_mute() == yn) {
 310                 return;
 311         }
 312         _mute = yn;
 313 }
 314
 315 void
 316 RouteGroup::set_solo (bool yn)
 317 {
 318         if (is_solo() == yn) {
 319                 return;
 320         }
 321         _solo = yn;
 322 }
 323
 324 void
 325 RouteGroup::set_recenable (bool yn)
 326 {
 327         if (is_recenable() == yn) {
 328                 return;
 329         }
 330         _recenable = yn;
 331 }
 332
 333 void
 334 RouteGroup::set_select (bool yn)
 335 {
 336         if (is_select() == yn) {
 337                 return;
 338         }
 339         _select = yn;
 340 }
 341
 342 void
 343 RouteGroup::set_edit (bool yn)
 344 {
 345         if (is_edit() == yn) {
 346                 return;
 347         }
 348         _edit = yn;
 349 }
 350
 351 void
 352 RouteGroup::set_route_active (bool yn)
 353 {
 354         if (is_route_active() == yn) {
 355                 return;
 356         }
 357         _route_active = yn;
 358 }
 359
 360 void
 361 RouteGroup::set_active (bool yn, void* /*src*/)
 362 {
 363         if (is_active() == yn) {
 364                 return;
 365         }
 366
 367         _active = yn;
 368         send_change (PropertyChange (Properties::active));
 369
 370         _session.set_dirty ();
 371 }
 372
 373 void
 374 RouteGroup::set_relative (bool yn, void* /*src*/)
 375 {
 376         if (is_relative() == yn) {
 377                 return;
 378         }
 379         _relative = yn;
 380         _session.set_dirty ();
 381 }
 382
 383 void
 384 RouteGroup::set_hidden (bool yn, void* /*src*/)
 385 {
 386         if (is_hidden() == yn) {
 387                 return;
 388         }
 389
 390         if (yn) {
 391                 _hidden = true;
 392                 if (Config->get_hiding_groups_deactivates_groups()) {
 393                         _active = false;
 394                 }
 395         } else {
 396                 _hidden = false;
 397                 if (Config->get_hiding_groups_deactivates_groups()) {
 398                         _active = true;
 399                 }
 400         }
 401
 402         PropertyChanged (Properties::hidden); /* EMIT SIGNAL */
 403
 404         _session.set_dirty ();
 405 }
 406
 407 void
 408 RouteGroup::audio_track_group (set<boost::shared_ptr<AudioTrack> >& ats)
 409 {
 410         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 411                 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack>(*i);
 412                 if (at) {
 413                         ats.insert (at);
 414                 }
 415         }
 416 }
 417
 418 void
 419 RouteGroup::make_subgroup (bool aux, Placement placement)
 420 {
 421         RouteList rl;
 422         uint32_t nin = 0;
 423
 424         /* since we don't do MIDI Busses yet, check quickly ... */
 425
 426         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 427                 if ((*i)->output()->n_ports().n_midi() != 0) {
 428                         PBD::info << _("You cannot subgroup MIDI tracks at this time") << endmsg;
 429                         return;
 430                 }
 431         }
 432
 433         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 434                 nin = max (nin, (*i)->output()->n_ports().n_audio());
 435         }
 436
 437         try {
 438                 /* use master bus etc. to determine default nouts */
 439                 rl = _session.new_audio_route (nin, 2, 0, 1);
 440         } catch (...) {
 441                 return;
 442         }
 443
 444         subgroup_bus = rl.front();
 445         subgroup_bus->set_name (_name);
 446
 447         if (aux) {
 448
 449                 _session.add_internal_sends (subgroup_bus, placement, routes);
 450
 451         } else {
 452
 453                 boost::shared_ptr<Bundle> bundle = subgroup_bus->input()->bundle ();
 454
 455                 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 456                         (*i)->output()->disconnect (this);
 457                         (*i)->output()->connect_ports_to_bundle (bundle, this);
 458                 }
 459         }
 460 }
 461
 462 void
 463 RouteGroup::destroy_subgroup ()
 464 {
 465         if (!subgroup_bus) {
 466                 return;
 467         }
 468
 469         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 470                 (*i)->output()->disconnect (this);
 471                 /* XXX find a new bundle to connect to */
 472         }
 473
 474         _session.remove_route (subgroup_bus);
 475         subgroup_bus.reset ();
 476 }
 477
 478 bool
 479 RouteGroup::enabled_property (PBD::PropertyID prop)
 480 {
 481         OwnedPropertyList::iterator i = _properties->find (prop);
 482         if (i == _properties->end()) {
 483                 return false;
 484         }
 485
 486         return dynamic_cast<const PropertyTemplate<bool>* > (i->second)->val ();
 487 }