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