MCP: properly (?) handle bank/channel scrolling with locked strips
[ardour.git] / libs / surfaces / mackie / strip.h
1 #ifndef __ardour_mackie_control_protocol_strip_h__
2 #define __ardour_mackie_control_protocol_strip_h__
3
4 #include <string>
5 #include <iostream>
6
7 #include "evoral/Parameter.hpp"
8
9 #include "pbd/property_basics.h"
10 #include "pbd/signals.h"
11
12 #include "ardour/types.h"
13 #include "control_protocol/types.h"
14
15 #include "control_group.h"
16 #include "types.h"
17 #include "midi_byte_array.h"
18 #include "device_info.h"
19
20 namespace ARDOUR {
21         class Route;
22         class Bundle;
23         class ChannelCount;
24 }
25
26 namespace Mackie {
27
28 class Control;
29 class Surface;
30 class Button;
31 class Pot;
32 class Fader;
33 class Meter;
34 class SurfacePort;
35
36 struct StripControlDefinition {
37     const char* name;
38     uint32_t base_id;
39     Control* (*factory)(Surface&, int index, const char* name, Group&);
40 };
41
42 struct GlobalControlDefinition {
43     const char* name;
44     uint32_t id;
45     Control* (*factory)(Surface&, int index, const char* name, Group&);
46     const char* group_name;
47 };
48
49 /**
50         This is the set of controls that make up a strip.
51 */
52 class Strip : public Group
53 {
54 public:
55         Strip (Surface&, const std::string & name, int index, const std::map<Button::ID,StripButtonInfo>&);
56         ~Strip();
57
58         boost::shared_ptr<ARDOUR::Route> route() const { return _route; }
59
60         void add (Control & control);
61         int index() const { return _index; } // zero based
62         
63         void set_route (boost::shared_ptr<ARDOUR::Route>, bool with_messages = true);
64
65         // call all signal handlers manually
66         void notify_all();
67
68         void handle_button (Button&, ButtonState bs);
69         void handle_fader (Fader&, float position);
70         void handle_pot (Pot&, float delta);
71
72         void periodic (uint64_t now_usecs);
73
74         MidiByteArray display (uint32_t line_number, const std::string&);
75         MidiByteArray blank_display (uint32_t line_number);
76
77         void zero ();
78
79         void flip_mode_changed (bool notify=false);
80
81         void lock_controls ();
82         void unlock_controls ();
83         bool locked() const { return _controls_locked; }
84
85         void gui_selection_changed (ARDOUR::RouteNotificationListPtr);
86
87 private:
88         Button*  _solo;
89         Button*  _recenable;
90         Button*  _mute;
91         Button*  _select;
92         Button*  _vselect;
93         Button*  _fader_touch;
94         Pot*     _vpot;
95         Fader*   _fader;
96         Meter*   _meter;
97         int      _index;
98         Surface* _surface;
99         bool     _controls_locked;
100         uint64_t _reset_display_at;
101         boost::shared_ptr<ARDOUR::Route> _route;
102         PBD::ScopedConnectionList route_connections;
103
104         float _last_gain_position_written;
105         float _last_pan_azi_position_written;
106         float _last_pan_width_position_written;
107
108         void notify_solo_changed ();
109         void notify_mute_changed ();
110         void notify_record_enable_changed ();
111         void notify_gain_changed (bool force_update = true);
112         void notify_property_changed (const PBD::PropertyChange&);
113         void notify_panner_azi_changed (bool force_update = true);
114         void notify_panner_width_changed (bool force_update = true);
115         void notify_active_changed ();
116         void notify_route_deleted ();
117         
118         void update_automation ();
119         void update_meter ();
120
121         std::string vpot_mode_string () const;
122
123         void queue_display_reset (uint32_t msecs);
124         void clear_display_reset ();
125         void reset_display ();
126         void do_parameter_display (ARDOUR::AutomationType, float val);
127         
128         typedef std::map<std::string,boost::shared_ptr<ARDOUR::Bundle> > BundleMap;
129         BundleMap input_bundles;
130         BundleMap output_bundles;
131
132         void build_input_list (const ARDOUR::ChanCount&);
133         void build_output_list (const ARDOUR::ChanCount&);
134         void maybe_add_to_bundle_map (BundleMap& bm, boost::shared_ptr<ARDOUR::Bundle>, bool for_input, const ARDOUR::ChanCount&);
135
136         void select_event (Button&, ButtonState);
137         void vselect_event (Button&, ButtonState);
138         void fader_touch_event (Button&, ButtonState);
139
140         std::vector<Evoral::Parameter> possible_pot_parameters;
141         void next_pot_mode ();
142         void set_vpot_parameter (Evoral::Parameter);
143
144         void reset_saved_values ();
145
146         std::map<Evoral::Parameter,Control*> control_by_parameter;
147 };
148
149 }
150
151 #endif /* __ardour_mackie_control_protocol_strip_h__ */