libs/ardour/speakers.cc

   1 /*
   2     Copyright (C) 2010 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 #include "pbd/error.h"
  20 #include "pbd/locale_guard.h"
  21
  22 #include "ardour/speaker.h"
  23 #include "ardour/speakers.h"
  24
  25 #include "pbd/i18n.h"
  26
  27 using namespace ARDOUR;
  28 using namespace PBD;
  29 using namespace std;
  30
  31 Speaker::Speaker (int i, const AngularVector& position)
  32         : id (i)
  33 {
  34         move (position);
  35 }
  36
  37 Speaker::Speaker (Speaker const & o)
  38         : id (o.id)
  39         , _coords (o._coords)
  40         , _angles (o._angles)
  41 {
  42
  43 }
  44
  45 Speaker &
  46 Speaker::operator= (Speaker const & o)
  47 {
  48         if (&o == this) {
  49                 return *this;
  50         }
  51
  52         id = o.id;
  53         _coords = o._coords;
  54         _angles = o._angles;
  55
  56         return *this;
  57 }
  58
  59 void
  60 Speaker::move (const AngularVector& new_position)
  61 {
  62         _angles = new_position;
  63         _angles.cartesian (_coords);
  64
  65         PositionChanged (); /* EMIT SIGNAL */
  66 }
  67
  68 Speakers::Speakers ()
  69 {
  70 }
  71
  72 Speakers::Speakers (const Speakers& s)
  73         : Stateful ()
  74 {
  75         _speakers = s._speakers;
  76 }
  77
  78 Speakers::~Speakers ()
  79 {
  80 }
  81
  82 Speakers&
  83 Speakers::operator= (const Speakers& s)
  84 {
  85         if (&s != this) {
  86                 _speakers = s._speakers;
  87         }
  88         return *this;
  89 }
  90
  91 void
  92 Speakers::dump_speakers (ostream& o)
  93 {
  94         for (vector<Speaker>::iterator i = _speakers.begin(); i != _speakers.end(); ++i) {
  95                 o << "Speaker " << (*i).id << " @ "
  96                   << (*i).coords().x << ", " << (*i).coords().y << ", " << (*i).coords().z
  97                   << " azimuth " << (*i).angles().azi
  98                   << " elevation " << (*i).angles().ele
  99                   << " distance " << (*i).angles().length
 100                   << endl;
 101         }
 102 }
 103
 104 void
 105 Speakers::clear_speakers ()
 106 {
 107         _speakers.clear ();
 108         update ();
 109 }
 110
 111 int
 112 Speakers::add_speaker (const AngularVector& position)
 113 {
 114         int id = _speakers.size();
 115
 116         _speakers.push_back (Speaker (id, position));
 117         update ();
 118
 119         Changed ();
 120
 121         return id;
 122 }
 123
 124 void
 125 Speakers::remove_speaker (int id)
 126 {
 127         for (vector<Speaker>::iterator i = _speakers.begin(); i != _speakers.end(); ++i) {
 128                 if (i->id == id) {
 129                         i = _speakers.erase (i);
 130                         update ();
 131                         break;
 132                 }
 133         }
 134 }
 135
 136 void
 137 Speakers::move_speaker (int id, const AngularVector& new_position)
 138 {
 139         for (vector<Speaker>::iterator i = _speakers.begin(); i != _speakers.end(); ++i) {
 140                 if ((*i).id == id) {
 141                         (*i).move (new_position);
 142                         update ();
 143                         break;
 144                 }
 145         }
 146 }
 147
 148 void
 149 Speakers::setup_default_speakers (uint32_t n)
 150 {
 151         double o = 180.0;
 152
 153         /* default assignment of speaker position for n speakers */
 154
 155         assert (n>0);
 156
 157         switch (n) {
 158         case 1:
 159                 add_speaker (AngularVector (o   +0.0, 0.0));
 160                 break;
 161
 162         case 2:
 163                 add_speaker (AngularVector (o  +60.0, 0.0));
 164                 add_speaker (AngularVector (o  -60.0, 0.0));
 165                 break;
 166
 167         case 3:
 168                 add_speaker (AngularVector (o  +60.0, 0.0));
 169                 add_speaker (AngularVector (o  -60.0, 0.0));
 170                 add_speaker (AngularVector (o +180.0, 0.0));
 171                 break;
 172         case 4:
 173                 /* 4.0 with regular spacing */
 174                 add_speaker (AngularVector (o  +45.0, 0.0));
 175                 add_speaker (AngularVector (o  -45.0, 0.0));
 176                 add_speaker (AngularVector (o +135.0, 0.0));
 177                 add_speaker (AngularVector (o -135.0, 0.0));
 178                 break;
 179         case 5:
 180                 /* 5.0 with regular spacing */
 181                 add_speaker (AngularVector (o  +72.0, 0.0));
 182                 add_speaker (AngularVector (o  -72.0, 0.0));
 183                 add_speaker (AngularVector (o   +0.0, 0.0));
 184                 add_speaker (AngularVector (o +144.0, 0.0));
 185                 add_speaker (AngularVector (o -144.0, 0.0));
 186                 break;
 187         case 6:
 188                 /* 6.0 with regular spacing */
 189                 add_speaker (AngularVector (o  +60.0, 0.0));
 190                 add_speaker (AngularVector (o  -60.0, 0.0));
 191                 add_speaker (AngularVector (o   +0.0, 0.0));
 192                 add_speaker (AngularVector (o +120.0, 0.0));
 193                 add_speaker (AngularVector (o -120.0, 0.0));
 194                 add_speaker (AngularVector (o +180.0, 0.0));
 195                 break;
 196         case 7:
 197                 /* 7.0 with regular front spacing */
 198                 add_speaker (AngularVector (o  +45.0, 0.0));
 199                 add_speaker (AngularVector (o  -45.0, 0.0));
 200                 add_speaker (AngularVector (o   +0.0, 0.0));
 201                 add_speaker (AngularVector (o  +90.0, 0.0));
 202                 add_speaker (AngularVector (o  -90.0, 0.0));
 203                 add_speaker (AngularVector (o +150.0, 0.0));
 204                 add_speaker (AngularVector (o -150.0, 0.0));
 205                 break;
 206         case 10:
 207                 /* 5+4 with 45°/90° spacing */
 208                 add_speaker (AngularVector (o  +45.0, 0.0));
 209                 add_speaker (AngularVector (o  -45.0, 0.0));
 210                 add_speaker (AngularVector (o   +0.0, 0.0));
 211                 add_speaker (AngularVector (o +135.0, 0.0));
 212                 add_speaker (AngularVector (o -135.0, 0.0));
 213                 add_speaker (AngularVector (o  +45.0, 60.0));
 214                 add_speaker (AngularVector (o  -45.0, 60.0));
 215                 add_speaker (AngularVector (o +135.0, 60.0));
 216                 add_speaker (AngularVector (o -135.0, 60.0));
 217                 add_speaker (AngularVector (o   +0.0, 90.0));
 218                 break;
 219
 220         default:
 221         {
 222                 double degree_step = 360.0 / n;
 223                 double deg;
 224                 uint32_t i;
 225
 226                 /* even number of speakers? make sure the top two are either side of "top".
 227                    otherwise, just start at the "top" (90.0 degrees) and rotate around
 228                 */
 229
 230                 if (n % 2) {
 231                         deg = 360 + o + degree_step;
 232                 } else {
 233                         deg = 360 + o;
 234                 }
 235                 for (i = 0; i < n; ++i, deg -= degree_step) {
 236                         add_speaker (AngularVector (fmod(deg, 360), 0.0));
 237                 }
 238         }
 239         }
 240 }
 241
 242 XMLNode&
 243 Speakers::get_state ()
 244 {
 245         XMLNode* node = new XMLNode (X_("Speakers"));
 246         LocaleGuard lg;
 247
 248         for (vector<Speaker>::const_iterator i = _speakers.begin(); i != _speakers.end(); ++i) {
 249                 XMLNode* speaker = new XMLNode (X_("Speaker"));
 250
 251                 speaker->set_property (X_("azimuth"), (*i).angles().azi);
 252                 speaker->set_property (X_("elevation"), (*i).angles().ele);
 253                 speaker->set_property (X_("distance"), (*i).angles().length);
 254
 255                 node->add_child_nocopy (*speaker);
 256         }
 257
 258         return *node;
 259 }
 260
 261 int
 262 Speakers::set_state (const XMLNode& node, int /*version*/)
 263 {
 264         XMLNodeConstIterator i;
 265         LocaleGuard lg;
 266
 267         _speakers.clear ();
 268
 269         for (i = node.children().begin(); i != node.children().end(); ++i) {
 270                 if ((*i)->name() == X_("Speaker")) {
 271                         double a, e, d;
 272                         if (!(*i)->get_property (X_("azimuth"), a) ||
 273                             !(*i)->get_property (X_("elevation"), e) ||
 274                             !(*i)->get_property (X_("distance"), d)) {
 275                                 warning << _("Speaker information is missing - speaker ignored") << endmsg;
 276                                 continue;
 277                         }
 278
 279                         add_speaker (AngularVector (a, e, d));
 280                 }
 281         }
 282
 283         update ();
 284
 285         return 0;
 286 }