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 #define __STDC_FORMAT_MACROS
  21 #include <inttypes.h>
  22
  23 #include <algorithm>
  24
  25 #include <sigc++/bind.h>
  26
  27 #include "pbd/error.h"
  28 #include "pbd/enumwriter.h"
  29 #include "pbd/strsplit.h"
  30
  31 #include "ardour/amp.h"
  32 #include "ardour/route_group.h"
  33 #include "ardour/audio_track.h"
  34 #include "ardour/audio_diskstream.h"
  35 #include "ardour/configuration.h"
  36 #include "ardour/session.h"
  37
  38 #include "i18n.h"
  39
  40 using namespace ARDOUR;
  41 using namespace std;
  42
  43 RouteGroup::RouteGroup (Session& s, const string &n, Flag f, Property p)
  44         : _session (s)
  45         , routes (new RouteList)
  46         , _name (n)
  47         , _flags (f)
  48         , _properties (Property (p))
  49 {
  50 }
  51
  52 RouteGroup::~RouteGroup ()
  53 {
  54         for (RouteList::iterator i = routes->begin(); i != routes->end();) {
  55                 RouteList::iterator tmp = i;
  56                 ++tmp;
  57
  58                 (*i)->leave_route_group ();
  59
  60                 i = tmp;
  61         }
  62 }
  63
  64 void
  65 RouteGroup::set_name (string str)
  66 {
  67         _name = str;
  68         _session.set_dirty ();
  69         FlagsChanged (0); /* EMIT SIGNAL */
  70 }
  71
  72 int
  73 RouteGroup::add (boost::shared_ptr<Route> r)
  74 {
  75         r->leave_route_group ();
  76
  77         routes->push_back (r);
  78
  79         r->join_route_group (this);
  80         r->GoingAway.connect (sigc::bind (sigc::mem_fun (*this, &RouteGroup::remove_when_going_away), boost::weak_ptr<Route> (r)));
  81
  82         _session.set_dirty ();
  83         changed (); /* EMIT SIGNAL */
  84         return 0;
  85 }
  86
  87 void
  88 RouteGroup::remove_when_going_away (boost::weak_ptr<Route> wr)
  89 {
  90         boost::shared_ptr<Route> r (wr.lock());
  91
  92         if (r) {
  93                 remove (r);
  94         }
  95 }
  96
  97 int
  98 RouteGroup::remove (boost::shared_ptr<Route> r)
  99 {
 100         RouteList::iterator i;
 101
 102         if ((i = find (routes->begin(), routes->end(), r)) != routes->end()) {
 103                 r->leave_route_group ();
 104                 routes->erase (i);
 105                 _session.set_dirty ();
 106                 changed (); /* EMIT SIGNAL */
 107                 return 0;
 108         }
 109
 110         return -1;
 111 }
 112
 113
 114 gain_t
 115 RouteGroup::get_min_factor(gain_t factor)
 116 {
 117         gain_t g;
 118
 119         for (RouteList::iterator i = routes->begin(); i != routes->end(); i++) {
 120                 g = (*i)->amp()->gain();
 121
 122                 if ( (g+g*factor) >= 0.0f)
 123                         continue;
 124
 125                 if ( g <= 0.0000003f )
 126                         return 0.0f;
 127
 128                 factor = 0.0000003f/g - 1.0f;
 129         }
 130         return factor;
 131 }
 132
 133 gain_t
 134 RouteGroup::get_max_factor(gain_t factor)
 135 {
 136         gain_t g;
 137
 138         for (RouteList::iterator i = routes->begin(); i != routes->end(); i++) {
 139                 g = (*i)->amp()->gain();
 140
 141                 // if the current factor woulnd't raise this route above maximum
 142                 if ( (g+g*factor) <= 1.99526231f)
 143                         continue;
 144
 145                 // if route gain is already at peak, return 0.0f factor
 146             if (g>=1.99526231f)
 147                         return 0.0f;
 148
 149                 // factor is calculated so that it would raise current route to max
 150                 factor = 1.99526231f/g - 1.0f;
 151         }
 152
 153         return factor;
 154 }
 155
 156 XMLNode&
 157 RouteGroup::get_state (void)
 158 {
 159         XMLNode *node = new XMLNode ("RouteGroup");
 160         node->add_property ("name", _name);
 161         node->add_property ("flags", enum_2_string (_flags));
 162         node->add_property ("properties", enum_2_string (_properties));
 163
 164         if (!routes->empty()) {
 165                 stringstream str;
 166
 167                 for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 168                         str << (*i)->id () << ' ';
 169                 }
 170
 171                 node->add_property ("routes", str.str());
 172         }
 173
 174         return *node;
 175 }
 176
 177 int
 178 RouteGroup::set_state (const XMLNode& node, int version)
 179 {
 180         if (version < 3000) {
 181                 return set_state_2X (node, version);
 182         }
 183
 184         const XMLProperty *prop;
 185
 186         if ((prop = node.property ("name")) != 0) {
 187                 _name = prop->value();
 188         }
 189
 190         if ((prop = node.property ("flags")) != 0) {
 191                 _flags = Flag (string_2_enum (prop->value(), _flags));
 192         }
 193
 194         if ((prop = node.property ("properties")) != 0) {
 195                 _properties = Property (string_2_enum (prop->value(), _properties));
 196         }
 197
 198         if ((prop = node.property ("routes")) != 0) {
 199                 stringstream str (prop->value());
 200                 vector<string> ids;
 201                 split (str.str(), ids, ' ');
 202
 203                 for (vector<string>::iterator i = ids.begin(); i != ids.end(); ++i) {
 204                         PBD::ID id (*i);
 205                         boost::shared_ptr<Route> r = _session.route_by_id (id);
 206
 207                         if (r) {
 208                                 add (r);
 209                         }
 210                 }
 211         }
 212
 213         return 0;
 214 }
 215
 216 int
 217 RouteGroup::set_state_2X (const XMLNode& node, int /*version*/)
 218 {
 219         XMLProperty const * prop;
 220
 221         if ((prop = node.property ("name")) != 0) {
 222                 _name = prop->value();
 223         }
 224
 225         if ((prop = node.property ("flags")) != 0) {
 226                 _flags = Flag (string_2_enum (prop->value(), _flags));
 227         }
 228
 229         if (node.name() == "MixGroup") {
 230                 _properties = Property (Gain | Mute | Solo | RecEnable);
 231         } else if (node.name() == "EditGroup") {
 232                 _properties = Property (Select | Edit);
 233         }
 234
 235         return 0;
 236 }
 237
 238 void
 239 RouteGroup::set_active (bool yn, void *src)
 240 {
 241         if (is_active() == yn) {
 242                 return;
 243         }
 244         if (yn) {
 245                 _flags = Flag (_flags | Active);
 246         } else {
 247                 _flags = Flag (_flags & ~Active);
 248         }
 249         _session.set_dirty ();
 250         FlagsChanged (src); /* EMIT SIGNAL */
 251 }
 252
 253 void
 254 RouteGroup::set_relative (bool yn, void *src)
 255
 256 {
 257         if (is_relative() == yn) {
 258                 return;
 259         }
 260         if (yn) {
 261                 _flags = Flag (_flags | Relative);
 262         } else {
 263                 _flags = Flag (_flags & ~Relative);
 264         }
 265         _session.set_dirty ();
 266         FlagsChanged (src); /* EMIT SIGNAL */
 267 }
 268
 269 void
 270 RouteGroup::set_hidden (bool yn, void *src)
 271
 272 {
 273         if (is_hidden() == yn) {
 274                 return;
 275         }
 276         if (yn) {
 277                 _flags = Flag (_flags | Hidden);
 278                 if (Config->get_hiding_groups_deactivates_groups()) {
 279                         _flags = Flag (_flags & ~Active);
 280                 }
 281         } else {
 282                 _flags = Flag (_flags & ~Hidden);
 283                 if (Config->get_hiding_groups_deactivates_groups()) {
 284                         _flags = Flag (_flags | Active);
 285                 }
 286         }
 287         _session.set_dirty ();
 288         FlagsChanged (src); /* EMIT SIGNAL */
 289 }
 290
 291 void
 292 RouteGroup::audio_track_group (set<boost::shared_ptr<AudioTrack> >& ats)
 293 {
 294         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 295                 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack>(*i);
 296                 if (at) {
 297                         ats.insert (at);
 298                 }
 299         }
 300 }
 301
 302 void
 303 RouteGroup::make_subgroup ()
 304 {
 305         RouteList rl;
 306         uint32_t nin = 0;
 307
 308         /* since we don't do MIDI Busses yet, check quickly ... */
 309
 310         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 311                 if ((*i)->output()->n_ports().n_midi() != 0) {
 312                         PBD::info << _("You cannot subgroup MIDI tracks at this time") << endmsg;
 313                         return;
 314                 }
 315         }
 316
 317         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 318                 nin = max (nin, (*i)->output()->n_ports().n_audio());
 319         }
 320
 321         try {
 322                 /* use master bus etc. to determine default nouts */
 323                 rl = _session.new_audio_route (false, nin, 2, 0, 1);
 324         } catch (...) {
 325                 return;
 326         }
 327
 328         subgroup_bus = rl.front();
 329         subgroup_bus->set_name (_name);
 330
 331         boost::shared_ptr<Bundle> bundle = subgroup_bus->input()->bundle ();
 332
 333         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 334                 (*i)->output()->disconnect (this);
 335                 (*i)->output()->connect_ports_to_bundle (bundle, this);
 336         }
 337 }
 338
 339 void
 340 RouteGroup::destroy_subgroup ()
 341 {
 342         if (!subgroup_bus) {
 343                 return;
 344         }
 345
 346         for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
 347                 (*i)->output()->disconnect (this);
 348                 /* XXX find a new bundle to connect to */
 349         }
 350
 351         _session.remove_route (subgroup_bus);
 352         subgroup_bus.reset ();
 353 }