libs/surfaces/faderport8/faderport8.h

   1 /*
   2  * Copyright (C) 2017 Robin Gareus <robin@gareus.org>
   3  * Copyright (C) 2015 Paul Davis
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  */
  19
  20 #ifndef ardour_surface_faderport8_h
  21 #define ardour_surface_faderport8_h
  22
  23 #include <list>
  24 #include <map>
  25 #include <glibmm/threads.h>
  26
  27 #define ABSTRACT_UI_EXPORTS
  28 #include "pbd/abstract_ui.h"
  29 #include "pbd/properties.h"
  30
  31 #include "ardour/types.h"
  32 #include "ardour/async_midi_port.h"
  33 #include "ardour/midi_port.h"
  34
  35 #include "control_protocol/control_protocol.h"
  36
  37 #include "fp8_base.h"
  38 #include "fp8_controls.h"
  39
  40 namespace MIDI {
  41         class Parser;
  42 }
  43
  44 namespace ARDOUR {
  45         class Bundle;
  46         class Session;
  47         class Processor;
  48 }
  49
  50 namespace ArdourSurface {
  51
  52 struct FaderPort8Request : public BaseUI::BaseRequestObject
  53 {
  54         public:
  55                 FaderPort8Request () {}
  56                 ~FaderPort8Request () {}
  57 };
  58
  59 class FaderPort8 : public FP8Base, public ARDOUR::ControlProtocol, public AbstractUI<FaderPort8Request>
  60 {
  61 public:
  62         FaderPort8 (ARDOUR::Session&);
  63         virtual ~FaderPort8();
  64
  65         int set_active (bool yn);
  66
  67         /* we probe for a device when our ports are connected. Before that,
  68          * there's no way to know if the device exists or not.
  69          */
  70         static bool  probe() { return true; }
  71         static void* request_factory (uint32_t);
  72
  73         XMLNode& get_state ();
  74         int set_state (const XMLNode&, int version);
  75
  76         /* configuration GUI */
  77         bool  has_editor () const { return true; }
  78         void* get_gui () const;
  79         void  tear_down_gui ();
  80         PBD::Signal0<void> ConnectionChange;
  81
  82         void set_button_action (FP8Controls::ButtonId, bool, std::string const&);
  83         std::string get_button_action (FP8Controls::ButtonId, bool);
  84         FP8Controls const& control () const { return  _ctrls; }
  85
  86         int stop ();
  87         void do_request (FaderPort8Request*);
  88         void thread_init ();
  89
  90         boost::shared_ptr<ARDOUR::Port> input_port() const { return _input_port; }
  91         boost::shared_ptr<ARDOUR::Port> output_port() const { return _output_port; }
  92         std::list<boost::shared_ptr<ARDOUR::Bundle> > bundles ();
  93
  94         size_t tx_midi (std::vector<uint8_t> const&) const;
  95
  96 private:
  97         void close ();
  98
  99         void start_midi_handling ();
 100         void stop_midi_handling ();
 101
 102         /* I/O Ports */
 103         PBD::ScopedConnectionList port_connections;
 104         boost::shared_ptr<ARDOUR::AsyncMIDIPort> _input_port;
 105         boost::shared_ptr<ARDOUR::AsyncMIDIPort> _output_port;
 106         boost::shared_ptr<ARDOUR::Bundle>        _input_bundle;
 107         boost::shared_ptr<ARDOUR::Bundle>        _output_bundle;
 108
 109         bool midi_input_handler (Glib::IOCondition ioc, boost::weak_ptr<ARDOUR::AsyncMIDIPort> port);
 110
 111         bool connection_handler (std::string name1, std::string name2);
 112         void engine_reset ();
 113
 114         enum ConnectionState {
 115                 InputConnected = 0x1,
 116                 OutputConnected = 0x2
 117         };
 118
 119         void connected ();
 120         void disconnected ();
 121         int  _connection_state;
 122         bool _device_active;
 123
 124         /* MIDI input message handling */
 125         void sysex_handler (MIDI::Parser &p, MIDI::byte *, size_t);
 126         void polypressure_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb);
 127         void pitchbend_handler (MIDI::Parser &, uint8_t chan, MIDI::pitchbend_t pb);
 128         void controller_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb);
 129         void note_on_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb);
 130         void note_off_handler (MIDI::Parser &, MIDI::EventTwoBytes* tb);
 131         PBD::ScopedConnectionList midi_connections;
 132
 133         /* ***************************************************************************
 134          * Control Elements
 135          */
 136         FP8Controls _ctrls;
 137         void notify_stripable_added_or_removed ();
 138         void notify_fader_mode_changed ();
 139         void filter_stripables (ARDOUR::StripableList& strips) const;
 140         void assign_stripables (bool select_only = false);
 141         void set_periodic_display_mode (FP8Strip::DisplayMode);
 142
 143         void assign_strips (bool reset_bank);
 144         void bank (bool down, bool page);
 145         void move_selected_into_view ();
 146         void select_prev_next (bool next);
 147
 148         void assign_sends ();
 149         void spill_plugins ();
 150         void assign_processor_ctrls ();
 151         void build_well_known_processor_ctrls (boost::shared_ptr<ARDOUR::Stripable>, bool);
 152         void select_plugin (int num);
 153
 154         void bank_param (bool down, bool page);
 155         /* bank offsets */
 156         int _channel_off;
 157         int _plugin_off;
 158         int _parameter_off;
 159
 160         /* plugin + send mode stripable
 161          *
 162          * This is used when parameters of one strip are assigned to
 163          * individual FP8Strip controls (Edit Send, Edit Plugins).
 164          *
 165          * When there's one stripable per FP8Strip, FP8Strip itself keeps
 166          * track of the object lifetime and these are NULL.
 167          */
 168         PBD::ScopedConnectionList processor_connections;
 169
 170         PBD::ScopedConnectionList assigned_stripable_connections;
 171         typedef std::map<boost::shared_ptr<ARDOUR::Stripable>, uint8_t> StripAssignmentMap;
 172         StripAssignmentMap _assigned_strips;
 173
 174         void drop_ctrl_connections ();
 175
 176         void select_strip (boost::weak_ptr<ARDOUR::Stripable>);
 177
 178         void notify_pi_property_changed (const PBD::PropertyChange&);
 179         void notify_stripable_property_changed (boost::weak_ptr<ARDOUR::Stripable>, const PBD::PropertyChange&);
 180         void notify_gui_track_selection_changed ();
 181
 182         PBD::ScopedConnection selection_connection;
 183         PBD::ScopedConnectionList automation_state_connections;
 184         PBD::ScopedConnectionList modechange_connections;
 185         /* **************************************************************************/
 186         struct ProcessorCtrl {
 187                 ProcessorCtrl (std::string const &n, boost::shared_ptr<ARDOUR::AutomationControl> c)
 188                  : name (n)
 189                  , ac (c)
 190                 {}
 191                 std::string name;
 192                 boost::shared_ptr<ARDOUR::AutomationControl> ac;
 193         };
 194         std::list <ProcessorCtrl> _proc_params;
 195         int _showing_well_known;
 196         /* **************************************************************************/
 197
 198         /* periodic updates, parameter poll */
 199         sigc::connection _periodic_connection;
 200         bool periodic ();
 201         std::string _timecode;
 202         std::string const& timecode () const { return _timecode; }
 203
 204         /* sync button blink -- the FP's blink mode does not work */
 205         sigc::connection _blink_connection;
 206         bool _blink_onoff;
 207         bool blink_it ();
 208
 209         /* shift key */
 210         sigc::connection _shift_connection;
 211         bool _shift_lock;
 212         int _shift_pressed;
 213         bool shift_timeout () { _shift_lock = true; return false; }
 214         bool shift_mod () const { return _shift_lock || (_shift_pressed > 0); }
 215
 216         /* GUI */
 217         void build_gui ();
 218         mutable void *gui;
 219
 220         /* setup callbacks & actions */
 221         void connect_session_signals ();
 222         void setup_actions ();
 223         void send_session_state ();
 224
 225         /* callbacks */
 226         PBD::ScopedConnectionList session_connections;
 227         void notify_parameter_changed (std::string);
 228         void notify_record_state_changed ();
 229         void notify_transport_state_changed ();
 230         void notify_loop_state_changed ();
 231         void notify_snap_change ();
 232         void notify_session_dirty_changed ();
 233         void notify_history_changed ();
 234         void notify_solo_changed ();
 235         void notify_mute_changed ();
 236         void notify_automation_mode_changed ();
 237
 238         /* actions */
 239         PBD::ScopedConnectionList button_connections;
 240         void button_play ();
 241         void button_stop ();
 242         void button_record ();
 243         void button_loop ();
 244         void button_metronom ();
 245         void button_varispeed (bool);
 246         void button_mute_clear ();
 247         void button_arm (bool);
 248         void button_arm_all ();
 249         void button_automation (ARDOUR::AutoState);
 250         void button_prev_next (bool);
 251         void button_action (const std::string& group, const std::string& item);
 252
 253         void button_encoder ();
 254         void button_parameter ();
 255         void encoder_navigate (bool, int);
 256         void encoder_parameter (bool, int);
 257
 258         /* user bound actions */
 259         void button_user (bool, FP8Controls::ButtonId);
 260
 261         enum ActionType {
 262                 Unset,
 263                 NamedAction,
 264                 // InternalFunction, // unused
 265         };
 266
 267         struct UserAction {
 268                 UserAction () : _type (Unset) {}
 269
 270                 ActionType _type;
 271                 std::string _action_name;
 272                 //boost::function<void()> function; // unused
 273
 274                 void clear ()
 275                 {
 276                         _type = Unset;
 277                         _action_name.clear();
 278                 }
 279
 280                 void assign_action (std::string const& action_name)
 281                 {
 282                         if (action_name.empty ()) {
 283                                 _type = Unset;
 284                                 _action_name.clear();
 285                         } else {
 286                                 _type = NamedAction;
 287                                 _action_name = action_name;
 288                         }
 289                 }
 290
 291                 bool empty () const
 292                 {
 293                         return _type == Unset;
 294                 }
 295
 296                 void call (FaderPort8& _base) const
 297                 {
 298                         switch (_type) {
 299                                 case NamedAction:
 300                                         _base.access_action (_action_name);
 301                                         break;
 302                                 default:
 303                                         break;
 304                         }
 305                 }
 306         };
 307
 308         struct ButtonAction {
 309                 UserAction on_press;
 310                 UserAction on_release;
 311
 312                 UserAction& action (bool press)
 313                 {
 314                         return press ? on_press : on_release;
 315                 }
 316
 317                 UserAction const& action (bool press) const
 318                 {
 319                         return press ? on_press : on_release;
 320                 }
 321
 322                 void call (FaderPort8& _base, bool press) const
 323                 {
 324                         action (press).call (_base);
 325                 }
 326                 bool empty () const
 327                 {
 328                         return on_press.empty () && on_release.empty();
 329                 }
 330         };
 331
 332         typedef std::map<FP8Controls::ButtonId, ButtonAction> UserActionMap;
 333         UserActionMap _user_action_map;
 334 };
 335
 336 } /* namespace */
 337
 338 #endif /* ardour_surface_faderport8_h */