2 Copyright (C) 2016 Paul Davis
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.
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.
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.
20 #ifndef __libardour_presentation_info_h__
21 #define __libardour_presentation_info_h__
28 #include "pbd/signals.h"
29 #include "pbd/stateful.h"
30 #include "pbd/properties.h"
32 #include "ardour/libardour_visibility.h"
38 namespace Properties {
39 LIBARDOUR_API extern PBD::PropertyDescriptor<uint32_t> order;
40 LIBARDOUR_API extern PBD::PropertyDescriptor<uint32_t> color;
41 LIBARDOUR_API extern PBD::PropertyDescriptor<bool> selected;
42 /* we use this; declared in region.cc */
43 LIBARDOUR_API extern PBD::PropertyDescriptor<bool> hidden;
46 class LIBARDOUR_API PresentationInfo : public PBD::Stateful
50 /* a PresentationInfo object exists to share information between
51 * different user interfaces (e.g. GUI and a Mackie Control surface)
61 * One UI takes control of ordering by setting the "order" value for
62 * the PresentationInfo component of every Stripable object. In Ardour,
63 * this is done by the GUI (mostly because it is very hard for the user
64 * to re-order things on a control surface).
66 * Ordering is a complex beast, however. Different user interfaces may
67 * display things in different ways. For example, the GUI of Ardour
68 * allows the user to mix busses in between tracks. A control surface
69 * may do the same, but may also allow the user to press a button that
70 * makes it show only busses, or only MIDI tracks. At that point, the
71 * ordering on the surface differs from the ordering in the GUI.
73 * There are several pathways for the order being set:
75 * - object created during session loading from XML
76 * - numeric order will be set during ::set_state(), based on
77 * - type will be set during ctor call
79 * - object created in response to user request
80 * - numeric order will be set by Session, before adding
82 * - type set during ctor call
87 * Control surfaces/protocols often need to be able to get a handle on
88 * an object identified only abstractly, such as the "5th audio track"
89 * or "the master out". A PresentationInfo object uniquely identifies
90 * all objects in this way through the combination of its _order member
91 * and part of its _flags member. The _flags member identifies the type
92 * of object, as well as selection/hidden status. The type may never
93 * change after construction (not strictly the constructor itself, but
94 * a more generalized notion of construction, as in "ready to use").
98 * When an object is selected, its _flags member will have the Selected
103 * When an object is hidden, its _flags member will have the Hidden
110 /* Type information */
119 /* These are for sharing Stripable states between the GUI and other
120 * user interfaces/control surfaces
124 /* single bit indicates that the group order is set */
127 /* special mask to delect out "state" bits */
128 StatusMask = (Selected|Hidden),
129 /* special mask to delect select type bits */
130 TypeMask = (AudioBus|AudioTrack|MidiTrack|MidiBus|VCA|MasterOut|MonitorOut|Auditioner)
133 static const Flag AllStripables; /* mask to use for any route or VCA (but not auditioner) */
134 static const Flag AllRoutes; /* mask to use for any route include master+monitor, but not auditioner */
135 static const Flag Route; /* mask for any route (bus or track */
136 static const Flag Track; /* mask to use for any track */
137 static const Flag Bus; /* mask to use for any bus */
139 typedef uint32_t order_t;
140 typedef uint32_t color_t;
142 PresentationInfo (Flag f);
143 PresentationInfo (order_t o, Flag f);
144 PresentationInfo (PresentationInfo const &);
146 static const order_t max_order;
148 PresentationInfo::Flag flags() const { return _flags; }
149 order_t order() const { return _order; }
150 color_t color() const { return _color; }
152 bool color_set() const;
154 void set_color (color_t);
155 void set_selected (bool yn);
156 void set_hidden (bool yn);
157 void set_flags (Flag f) { _flags = f; }
159 bool order_set() const { return _flags & OrderSet; }
161 bool hidden() const { return _flags & Hidden; }
162 bool selected() const { return _flags & Selected; }
163 bool special() const { return _flags & (MasterOut|MonitorOut|Auditioner); }
165 bool flag_match (Flag f) const {
166 /* no flags, match all */
172 if (f & StatusMask) {
173 /* status bits set, must match them */
174 if ((_flags & StatusMask) != (f & StatusMask)) {
179 /* Generic flags in f, match the right stuff */
181 if (f == Bus && (_flags & Bus)) {
182 /* some kind of bus */
185 if (f == Track && (_flags & Track)) {
186 /* some kind of track */
189 if (f == Route && (_flags & Route)) {
190 /* any kind of route, but not master, monitor in
196 if (f == AllRoutes && (_flags & AllRoutes)) {
197 /* any kind of route, but not auditioner. Ask for that
203 if (f == AllStripables && (_flags & AllStripables)) {
204 /* any kind of stripable, but not auditioner. Ask for that
210 /* check for any matching type bits.
212 * Do comparisoon without status mask or order set bits - we
213 * already checked that above.
216 return ((f & TypeMask) & _flags);
219 int set_state (XMLNode const&, int);
220 XMLNode& get_state ();
222 bool operator==(PresentationInfo const& other) {
223 return (_order == other.order()) && (_flags == other.flags());
226 bool operator!=(PresentationInfo const& other) {
227 return (_order != other.order()) || (_flags != other.flags());
230 PresentationInfo& operator= (PresentationInfo const& other);
232 static Flag get_flags (XMLNode const& node);
233 static std::string state_node_name;
235 /* for things concerned about *any* PresentationInfo.
238 static PBD::Signal1<void,PBD::PropertyChange const &> Change;
240 static void make_property_quarks ();
243 friend class ChangeSuspender;
244 static void suspend_change_signal ();
245 static void unsuspend_change_signal ();
248 class ChangeSuspender {
251 PresentationInfo::suspend_change_signal ();
254 PresentationInfo::unsuspend_change_signal ();
259 friend class Stripable;
260 void set_order (order_t order);
267 static PBD::PropertyChange _pending_static_changes;
268 static Glib::Threads::Mutex static_signal_lock;
269 static int _change_signal_suspended;
270 static void send_static_change (const PBD::PropertyChange&);
275 std::ostream& operator<<(std::ostream& o, ARDOUR::PresentationInfo const& rid);
277 #endif /* __libardour_presentation_info_h__ */