libs/ardour/presentation_info.cc

   1 /*
   2     Copyright (C) 2016 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 <sstream>
  20 #include <typeinfo>
  21
  22 #include <cassert>
  23
  24 #include "pbd/convert.h"
  25 #include "pbd/debug.h"
  26 #include "pbd/enumwriter.h"
  27 #include "pbd/error.h"
  28 #include "pbd/failed_constructor.h"
  29 #include "pbd/xml++.h"
  30
  31 #include "ardour/presentation_info.h"
  32
  33 #include "pbd/i18n.h"
  34
  35 using namespace ARDOUR;
  36 using namespace PBD;
  37 using std::string;
  38
  39 string PresentationInfo::state_node_name = X_("PresentationInfo");
  40 PBD::Signal0<void> PresentationInfo::Change;
  41
  42 namespace ARDOUR {
  43         namespace Properties {
  44                 PBD::PropertyDescriptor<bool>     selected;
  45                 PBD::PropertyDescriptor<uint32_t> order;
  46                 PBD::PropertyDescriptor<uint32_t> color;
  47         }
  48 }
  49
  50 const PresentationInfo::order_t PresentationInfo::max_order = UINT32_MAX;
  51 const PresentationInfo::Flag PresentationInfo::Bus = PresentationInfo::Flag (PresentationInfo::AudioBus|PresentationInfo::MidiBus);
  52 const PresentationInfo::Flag PresentationInfo::Track = PresentationInfo::Flag (PresentationInfo::AudioTrack|PresentationInfo::MidiTrack);
  53 const PresentationInfo::Flag PresentationInfo::Route = PresentationInfo::Flag (PresentationInfo::Bus|PresentationInfo::Track);
  54 const PresentationInfo::Flag PresentationInfo::AllRoutes = PresentationInfo::Flag (PresentationInfo::Route|PresentationInfo::MasterOut|PresentationInfo::MonitorOut);
  55 const PresentationInfo::Flag PresentationInfo::AllStripables = PresentationInfo::Flag (PresentationInfo::AllRoutes|PresentationInfo::VCA);
  56
  57 void
  58 PresentationInfo::make_property_quarks ()
  59 {
  60         Properties::selected.property_id = g_quark_from_static_string (X_("selected"));
  61         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for selected = %1\n",    Properties::selected.property_id));
  62         Properties::color.property_id = g_quark_from_static_string (X_("color"));
  63         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for color = %1\n",       Properties::color.property_id));
  64         Properties::order.property_id = g_quark_from_static_string (X_("order"));
  65         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for order = %1\n",       Properties::order.property_id));
  66 }
  67
  68 PresentationInfo::PresentationInfo (Flag f)
  69         : _order (0)
  70         , _flags (Flag (f & ~OrderSet))
  71         , _color (0)
  72 {
  73         /* OrderSet is not set */
  74 }
  75
  76 PresentationInfo::PresentationInfo (order_t o, Flag f)
  77         : _order (o)
  78         , _flags (Flag (f | OrderSet))
  79         , _color (0)
  80 {
  81         /* OrderSet is set */
  82 }
  83 PresentationInfo::PresentationInfo (PresentationInfo const& other)
  84         : _order (other.order())
  85         , _flags (other.flags())
  86         , _color (other.color())
  87 {
  88 }
  89
  90 XMLNode&
  91 PresentationInfo::get_state ()
  92 {
  93         XMLNode* node = new XMLNode (state_node_name);
  94         node->add_property ("order", PBD::to_string (_order, std::dec));
  95         node->add_property ("flags", enum_2_string (_flags));
  96         node->add_property ("color", PBD::to_string (_color, std::dec));
  97
  98         return *node;
  99 }
 100
 101 int
 102 PresentationInfo::set_state (XMLNode const& node, int /* version */)
 103 {
 104         if (node.name() != state_node_name) {
 105                 return -1;
 106         }
 107
 108         XMLProperty const* prop;
 109         PropertyChange pc;
 110
 111         if ((prop = node.property (X_("order"))) != 0) {
 112                 order_t o = atoi (prop->value());
 113                 if (o != _order) {
 114                         pc.add (Properties::order);
 115                         _order = o;
 116                 }
 117                 _order = atoi (prop->value());
 118         }
 119
 120         if ((prop = node.property (X_("flags"))) != 0) {
 121                 Flag f = Flag (string_2_enum (prop->value(), f));
 122                 if ((f&Hidden) != (_flags&Hidden)) {
 123                         pc.add (Properties::hidden);
 124                 }
 125                 _flags = f;
 126         }
 127
 128         if ((prop = node.property (X_("color"))) != 0) {
 129                 color_t c = atoi (prop->value());
 130                 if (c != _color) {
 131                         pc.add (Properties::color);
 132                         _color = c;
 133                 }
 134         }
 135
 136         send_change (PropertyChange (pc));
 137
 138         return 0;
 139
 140 }
 141
 142 PresentationInfo::Flag
 143 PresentationInfo::get_flags (XMLNode const& node)
 144 {
 145         XMLNodeList nlist = node.children ();
 146
 147         for (XMLNodeConstIterator niter = nlist.begin(); niter != nlist.end(); ++niter){
 148                 XMLNode* child = *niter;
 149
 150                 if (child->name() == PresentationInfo::state_node_name) {
 151                         XMLProperty const* prop = child->property (X_("flags"));
 152                         if (prop) {
 153                                 Flag f = (Flag) string_2_enum (prop->value(), f);
 154                                 return f;
 155                         }
 156                 }
 157         }
 158         return Flag (0);
 159 }
 160
 161 void
 162 PresentationInfo::set_color (PresentationInfo::color_t c)
 163 {
 164         if (c != _color) {
 165                 _color = c;
 166                 send_change (PropertyChange (Properties::color));
 167         }
 168 }
 169
 170 bool
 171 PresentationInfo::color_set () const
 172 {
 173         /* all RGBA values zero? not set.
 174          *
 175          * this is heuristic, but it is fairly realistic. who will ever set
 176          * a color to completely transparent black? only the constructor ..
 177          */
 178         return _color != 0;
 179 }
 180
 181 void
 182 PresentationInfo::set_selected (bool yn)
 183 {
 184         if (yn != selected()) {
 185                 if (yn) {
 186                         _flags = Flag (_flags | Selected);
 187                 } else {
 188                         _flags = Flag (_flags & ~Selected);
 189                 }
 190                 send_change (PropertyChange (Properties::selected));
 191         }
 192 }
 193
 194 void
 195 PresentationInfo::set_hidden (bool yn)
 196 {
 197         if (yn != hidden()) {
 198
 199                 if (yn) {
 200                         _flags = Flag (_flags | Hidden);
 201                 } else {
 202                         _flags = Flag (_flags & ~Hidden);
 203                 }
 204
 205                 send_change (PropertyChange (Properties::hidden));
 206         }
 207 }
 208
 209 void
 210 PresentationInfo::set_order (order_t order)
 211 {
 212         _flags = Flag (_flags|OrderSet);
 213
 214         if (order != _order) {
 215                 _order = order;
 216                 send_change (PropertyChange (Properties::order));
 217         }
 218 }
 219
 220 PresentationInfo&
 221 PresentationInfo::operator= (PresentationInfo const& other)
 222 {
 223         if (this != &other) {
 224                 _order = other.order();
 225                 _flags = other.flags();
 226                 _color = other.color();
 227         }
 228
 229         return *this;
 230 }
 231
 232 std::ostream&
 233 operator<<(std::ostream& o, ARDOUR::PresentationInfo const& pi)
 234 {
 235         return o << pi.order() << '/' << enum_2_string (pi.flags()) << '/' << pi.color();
 236 }