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         gain_t g;
 177
 178         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 179                 g = (*i)->amp()->gain();
 180
 181                 if ( (g+g*factor) >= 0.0f)
 182                         continue;
 183
 184                 if ( g <= 0.0000003f )
 185                         return 0.0f;
 186
 187                 factor = 0.0000003f/g - 1.0f;
 188         }
 189         return factor;
 190 }
 191
 192 gain_t
 193 RouteGroup::get_max_factor(gain_t factor)
 194 {
 195         gain_t g;
 196
 197         for (RouteList::iterator i = routes->begin(); i != routes->end(); i++) {
 198                 g = (*i)->amp()->gain();
 199
 200                 // if the current factor woulnd't raise this route above maximum
 201                 if ((g + g * factor) <= 1.99526231f) {
 202                         continue;
 203                 }
 204
 205                 // if route gain is already at peak, return 0.0f factor
 206                 if (g >= 1.99526231f) {
 207                         return 0.0f;
 208                 }
 209
 210                 // factor is calculated so that it would raise current route to max
 211                 factor = 1.99526231f / g - 1.0f;
 212         }
 213
 214         return factor;
 215 }
 216
 217 XMLNode&
 218 RouteGroup::get_state ()
 219 {
 220         XMLNode *node = new XMLNode ("RouteGroup");
 221
 222         char buf[64];
 223         id().print (buf, sizeof (buf));
 224         node->add_property ("id", buf);
 225
 226         add_properties (*node);
 227
 228         if (!routes->empty()) {
 229                 stringstream str;
 230
 231                 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 232                         str << (*i)->id () << ' ';
 233                 }
 234
 235                 node->add_property ("routes", str.str());
 236         }
 237
 238         return *node;
 239 }
 240
 241 int
 242 RouteGroup::set_state (const XMLNode& node, int version)
 243 {
 244         if (version < 3000) {
 245                 return set_state_2X (node, version);
 246         }
 247
 248         const XMLProperty *prop;
 249
 250         if ((prop = node.property ("id")) != 0) {
 251                 _id = prop->value();
 252         }
 253
 254         set_values (node);
 255
 256         if ((prop = node.property ("routes")) != 0) {
 257                 stringstream str (prop->value());
 258                 vector<string> ids;
 259                 split (str.str(), ids, ' ');
 260
 261                 for (vector<string>::iterator i = ids.begin(); i != ids.end(); ++i) {
 262                         PBD::ID id (*i);
 263                         boost::shared_ptr<Route> r = _session.route_by_id (id);
 264
 265                         if (r) {
 266                                 add (r);
 267                         }
 268                 }
 269         }
 270
 271         return 0;
 272 }
 273
 274 int
 275 RouteGroup::set_state_2X (const XMLNode& node, int /*version*/)
 276 {
 277         set_values (node);
 278
 279         if (node.name() == "MixGroup") {
 280                 _gain = true;
 281                 _mute = true;
 282                 _solo = true;
 283                 _recenable = true;
 284                 _edit = false;
 285                 _route_active = true;
 286         } else if (node.name() == "EditGroup") {
 287                 _gain = false;
 288                 _mute = false;
 289                 _solo = false;
 290                 _recenable = false;
 291                 _edit = true;
 292                 _route_active = false;
 293         }
 294
 295         return 0;
 296 }
 297
 298 void
 299 RouteGroup::set_gain (bool yn)
 300 {
 301         if (is_gain() == yn) {
 302                 return;
 303         }
 304         _gain = yn;
 305 }
 306
 307 void
 308 RouteGroup::set_mute (bool yn)
 309 {
 310         if (is_mute() == yn) {
 311                 return;
 312         }
 313         _mute = yn;
 314 }
 315
 316 void
 317 RouteGroup::set_solo (bool yn)
 318 {
 319         if (is_solo() == yn) {
 320                 return;
 321         }
 322         _solo = yn;
 323 }
 324
 325 void
 326 RouteGroup::set_recenable (bool yn)
 327 {
 328         if (is_recenable() == yn) {
 329                 return;
 330         }
 331         _recenable = yn;
 332 }
 333
 334 void
 335 RouteGroup::set_select (bool yn)
 336 {
 337         if (is_select() == yn) {
 338                 return;
 339         }
 340         _select = yn;
 341 }
 342
 343 void
 344 RouteGroup::set_edit (bool yn)
 345 {
 346         if (is_edit() == yn) {
 347                 return;
 348         }
 349         _edit = yn;
 350 }
 351
 352 void
 353 RouteGroup::set_route_active (bool yn)
 354 {
 355         if (is_route_active() == yn) {
 356                 return;
 357         }
 358         _route_active = yn;
 359 }
 360
 361 void
 362 RouteGroup::set_active (bool yn, void* /*src*/)
 363 {
 364         if (is_active() == yn) {
 365                 return;
 366         }
 367
 368         _active = yn;
 369         send_change (PropertyChange (Properties::active));
 370
 371         _session.set_dirty ();
 372 }
 373
 374 void
 375 RouteGroup::set_relative (bool yn, void* /*src*/)
 376 {
 377         if (is_relative() == yn) {
 378                 return;
 379         }
 380         _relative = yn;
 381         _session.set_dirty ();
 382 }
 383
 384 void
 385 RouteGroup::set_hidden (bool yn, void* /*src*/)
 386 {
 387         if (is_hidden() == yn) {
 388                 return;
 389         }
 390
 391         if (yn) {
 392                 _hidden = true;
 393                 if (Config->get_hiding_groups_deactivates_groups()) {
 394                         _active = false;
 395                 }
 396         } else {
 397                 _hidden = false;
 398                 if (Config->get_hiding_groups_deactivates_groups()) {
 399                         _active = true;
 400                 }
 401         }
 402
 403         PropertyChanged (Properties::hidden); /* EMIT SIGNAL */
 404
 405         _session.set_dirty ();
 406 }
 407
 408 void
 409 RouteGroup::audio_track_group (set<boost::shared_ptr<AudioTrack> >& ats)
 410 {
 411         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 412                 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack>(*i);
 413                 if (at) {
 414                         ats.insert (at);
 415                 }
 416         }
 417 }
 418
 419 void
 420 RouteGroup::make_subgroup (bool aux, Placement placement)
 421 {
 422         RouteList rl;
 423         uint32_t nin = 0;
 424
 425         /* since we don't do MIDI Busses yet, check quickly ... */
 426
 427         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 428                 if ((*i)->output()->n_ports().n_midi() != 0) {
 429                         PBD::info << _("You cannot subgroup MIDI tracks at this time") << endmsg;
 430                         return;
 431                 }
 432         }
 433
 434         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 435                 nin = max (nin, (*i)->output()->n_ports().n_audio());
 436         }
 437
 438         try {
 439                 /* use master bus etc. to determine default nouts */
 440                 rl = _session.new_audio_route (nin, 2, 0, 1);
 441         } catch (...) {
 442                 return;
 443         }
 444
 445         subgroup_bus = rl.front();
 446         subgroup_bus->set_name (_name);
 447
 448         if (aux) {
 449
 450                 _session.add_internal_sends (subgroup_bus, placement, routes);
 451
 452         } else {
 453
 454                 boost::shared_ptr<Bundle> bundle = subgroup_bus->input()->bundle ();
 455
 456                 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 457                         (*i)->output()->disconnect (this);
 458                         (*i)->output()->connect_ports_to_bundle (bundle, this);
 459                 }
 460         }
 461 }
 462
 463 void
 464 RouteGroup::destroy_subgroup ()
 465 {
 466         if (!subgroup_bus) {
 467                 return;
 468         }
 469
 470         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 471                 (*i)->output()->disconnect (this);
 472                 /* XXX find a new bundle to connect to */
 473         }
 474
 475         _session.remove_route (subgroup_bus);
 476         subgroup_bus.reset ();
 477 }
 478
 479 bool
 480 RouteGroup::enabled_property (PBD::PropertyID prop)
 481 {
 482         OwnedPropertyList::iterator i = _properties->find (prop);
 483         if (i == _properties->end()) {
 484                 return false;
 485         }
 486
 487         return dynamic_cast<const PropertyTemplate<bool>* > (i->second)->val ();
 488 }