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