Prepare for FaderPort16 (ctrl-protocol)
[ardour.git] / libs / surfaces / faderport8 / fp8_strip.h
1 /*
2  * Copyright (C) 2017 Robin Gareus <robin@gareus.org>
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17  */
18
19 #ifndef _ardour_surfaces_fp8strip_h_
20 #define _ardour_surfaces_fp8strip_h_
21
22 #include <stdint.h>
23 #include <boost/shared_ptr.hpp>
24
25 #include "pbd/signals.h"
26 #include "pbd/controllable.h"
27
28 #include "fp8_base.h"
29 #include "fp8_button.h"
30
31 #ifdef FADERPORT16
32 # define N_STRIPS 16
33 #else
34 # define N_STRIPS 8
35 #endif
36
37 namespace ARDOUR {
38         class Stripable;
39         class AutomationControl;
40         class PeakMeter;
41         class ReadOnlyControl;
42 }
43
44 namespace ArdourSurface {
45
46 class FP8Strip
47 {
48 public:
49         FP8Strip (FP8Base& b, uint8_t id);
50         ~FP8Strip ();
51
52         enum CtrlElement {
53                 BtnSolo,
54                 BtnMute,
55                 BtnSelect,
56                 Fader,
57                 Meter,
58                 Redux,
59                 BarVal,
60                 BarMode
61         };
62
63         static uint8_t midi_ctrl_id (CtrlElement type, uint8_t id);
64
65         FP8ButtonInterface& solo_button () { return _solo; }
66         FP8ButtonInterface& mute_button () { return _mute; }
67         FP8ButtonInterface& selrec_button () { return _selrec; }
68         FP8ButtonInterface& recarm_button () { return *_selrec.button_shift(); }
69         FP8ButtonInterface& select_button () { return *_selrec.button(); }
70
71         bool midi_touch (bool t);
72         bool midi_fader (float val);
73
74         void initialize (); // call only when connected, sends midi
75
76         void set_select_cb (boost::function<void ()>&);
77
78         enum DisplayMode {
79                 Stripables,
80                 PluginSelect, // no clock display
81                 PluginParam, // param value
82                 SendDisplay, // param value + select-bar
83         };
84
85         void set_periodic_display_mode (DisplayMode m);
86
87         // convenience function to call all set_XXX_controllable
88         void set_stripable (boost::shared_ptr<ARDOUR::Stripable>, bool panmode);
89         void set_text_line (uint8_t, std::string const&, bool inv = false);
90
91         enum CtrlMask {
92                 CTRL_FADER  = 0x001,
93                 CTRL_MUTE   = 0x002,
94                 CTRL_SOLO   = 0x004,
95                 CTRL_REC    = 0x004,
96                 CTRL_PAN    = 0x008,
97                 CTRL_SELECT = 0x010,
98                 CTRL_TEXT0  = 0x100,
99                 CTRL_TEXT1  = 0x200,
100                 CTRL_TEXT2  = 0x400,
101                 CTRL_TEXT3  = 0x800,
102
103                 CTRL_TEXT01 = 0x300,
104                 CTRL_TEXT   = 0xf00,
105                 CTRL_ALL    = 0xfff,
106         };
107
108         void unset_controllables (int which = CTRL_ALL);
109
110         void set_fader_controllable  (boost::shared_ptr<ARDOUR::AutomationControl>);
111         void set_mute_controllable   (boost::shared_ptr<ARDOUR::AutomationControl>);
112         void set_solo_controllable   (boost::shared_ptr<ARDOUR::AutomationControl>);
113         void set_rec_controllable    (boost::shared_ptr<ARDOUR::AutomationControl>);
114         void set_pan_controllable    (boost::shared_ptr<ARDOUR::AutomationControl>);
115         void set_select_controllable (boost::shared_ptr<ARDOUR::AutomationControl>);
116
117 private:
118         FP8Base&  _base;
119         uint8_t   _id;
120         FP8MomentaryButton _solo;
121         FP8MomentaryButton _mute;
122         FP8ARMSensitiveButton _selrec;
123
124         bool _touching;
125
126         PBD::ScopedConnection _base_connection; // periodic
127         PBD::ScopedConnectionList _button_connections;
128
129         std::string _stripable_name;
130
131         boost::shared_ptr<ARDOUR::AutomationControl> _fader_ctrl;
132         boost::shared_ptr<ARDOUR::AutomationControl> _mute_ctrl;
133         boost::shared_ptr<ARDOUR::AutomationControl> _solo_ctrl;
134         boost::shared_ptr<ARDOUR::AutomationControl> _rec_ctrl;
135         boost::shared_ptr<ARDOUR::AutomationControl> _pan_ctrl;
136         boost::shared_ptr<ARDOUR::AutomationControl> _x_select_ctrl;
137
138         PBD::ScopedConnection _fader_connection;
139         PBD::ScopedConnection _mute_connection;
140         PBD::ScopedConnection _solo_connection;
141         PBD::ScopedConnection _rec_connection;
142         PBD::ScopedConnection _pan_connection;
143         PBD::ScopedConnection _x_select_connection;
144
145         boost::shared_ptr<ARDOUR::PeakMeter> _peak_meter;
146         boost::shared_ptr<ARDOUR::ReadOnlyControl> _redux_ctrl;
147
148         void set_x_select_controllable (boost::shared_ptr<ARDOUR::AutomationControl>);
149         boost::function<void ()> _select_plugin_functor;
150
151         void drop_automation_controls ();
152
153         PBD::Controllable::GroupControlDisposition group_mode () const;
154
155         /* notifications, update view */
156         void notify_fader_changed ();
157         void notify_solo_changed ();
158         void notify_mute_changed ();
159         void notify_rec_changed ();
160         void notify_pan_changed ();
161         void notify_x_select_changed ();
162
163         /* actions, update model */
164         void set_mute (bool);
165         void set_solo (bool);
166         void set_select ();
167         void set_recarm ();
168
169         /* periodic poll, update view */
170         void set_strip_name ();
171         void periodic_update_fader ();
172         void periodic_update_meter ();
173         void periodic_update_timecode (uint32_t);
174         void periodic ();
175
176         /* cache */
177         unsigned short _last_fader;
178         uint8_t _last_meter;
179         uint8_t _last_redux;
180         uint8_t _last_barpos;
181
182         /* display */
183         void set_strip_mode (uint8_t, bool clear = false);
184         void set_bar_mode (uint8_t, bool force = false);
185
186         uint8_t _strip_mode;
187         uint8_t _bar_mode;
188         DisplayMode _displaymode;
189         std::string _last_line[4];
190 };
191
192 } /* namespace */
193 #endif /* _ardour_surfaces_fp8strip_h_ */