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 hidden, its _flags member will have the Hidden
105 /* Type information */
114 /* These are for sharing Stripable states between the GUI and other
115 * user interfaces/control surfaces
118 /* single bit indicates that the group order is set */
120 /* bus type for monitor mixes */
121 FoldbackBus = 0x2000,
123 /* special mask to delect out "state" bits */
124 StatusMask = (Hidden),
125 /* special mask to delect select type bits */
126 TypeMask = (AudioBus|AudioTrack|MidiTrack|MidiBus|VCA|MasterOut|MonitorOut|Auditioner|FoldbackBus)
129 static const Flag AllStripables; /* mask to use for any route or VCA (but not auditioner) */
130 static const Flag MixerStripables; /* mask to use for any route or VCA (but not auditioner or foldbackbus) */
131 static const Flag AllRoutes; /* mask to use for any route include master+monitor, but not auditioner */
132 static const Flag MixerRoutes; /* mask to use for any route include master+monitor, but not auditioner or foldbackbus*/
133 static const Flag Route; /* mask for any route (bus or track */
134 static const Flag Track; /* mask to use for any track */
135 static const Flag Bus; /* mask to use for any bus */
137 typedef uint32_t order_t;
138 typedef uint32_t color_t;
140 PresentationInfo (Flag f);
141 PresentationInfo (order_t o, Flag f);
142 PresentationInfo (PresentationInfo const &);
144 static const order_t max_order;
146 PresentationInfo::Flag flags() const { return _flags; }
147 order_t order() const { return _order; }
148 color_t color() const { return _color; }
150 bool color_set() const;
152 void set_color (color_t);
153 void set_hidden (bool yn);
154 void set_flags (Flag f) { _flags = f; }
156 bool order_set() const { return _flags & OrderSet; }
158 int selection_cnt() const { return _selection_cnt; }
160 bool hidden() const { return _flags & Hidden; }
161 bool special(bool with_master = true) const { return _flags & ((with_master ? MasterOut : 0)|MonitorOut|Auditioner); }
163 bool flag_match (Flag f) const {
164 /* no flags, match all */
170 if (f & StatusMask) {
171 /* status bits set, must match them */
172 if ((_flags & StatusMask) != (f & StatusMask)) {
177 /* Generic flags in f, match the right stuff */
179 if (f == Bus && (_flags & Bus)) {
180 /* some kind of bus */
183 if (f == Track && (_flags & Track)) {
184 /* some kind of track */
187 if (f == Route && (_flags & Route)) {
188 /* any kind of route, but not master, monitor in
194 if (f == AllRoutes && (_flags & AllRoutes)) {
195 /* any kind of route, but not auditioner. Ask for that
201 if (f == AllStripables && (_flags & AllStripables)) {
202 /* any kind of stripable, but not auditioner. Ask for that
208 /* check for any matching type bits.
210 * Do comparisoon without status mask or order set bits - we
211 * already checked that above.
214 return ((f & TypeMask) & _flags);
217 int set_state (XMLNode const&, int);
218 XMLNode& get_state ();
220 bool operator==(PresentationInfo const& other) {
221 return (_order == other.order()) && (_flags == other.flags());
224 bool operator!=(PresentationInfo const& other) {
225 return (_order != other.order()) || (_flags != other.flags());
228 PresentationInfo& operator= (PresentationInfo const& other);
230 static Flag get_flags (XMLNode const& node);
231 static std::string state_node_name;
233 /* for things concerned about *any* PresentationInfo.
236 static PBD::Signal1<void,PBD::PropertyChange const &> Change;
237 static void send_static_change (const PBD::PropertyChange&);
239 static void make_property_quarks ();
242 friend class ChangeSuspender;
243 static void suspend_change_signal ();
244 static void unsuspend_change_signal ();
247 class ChangeSuspender {
250 PresentationInfo::suspend_change_signal ();
253 PresentationInfo::unsuspend_change_signal ();
258 friend class Stripable;
259 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;
271 static int selection_counter;
276 std::ostream& operator<<(std::ostream& o, ARDOUR::PresentationInfo const& rid);
278 #endif /* __libardour_presentation_info_h__ */