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