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