globally remove all trailing whitespace from ardour code base.
[ardour.git] / libs / surfaces / mackie / mackie_control_protocol.h
index 238c9c4aa5bcba10c0ce01b467bd519748b8da93..ac1ba53896396d173be015323e770891a11ea306 100644 (file)
@@ -1,16 +1,16 @@
 /*
     Copyright (C) 2006,2007 John Anderson
-    
+
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
-    
+
     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
-    
+
     You should have received a copy of the GNU General Public License
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
@@ -28,8 +28,7 @@
 #include <pthread.h>
 #include <boost/smart_ptr.hpp>
 
-#include <glibmm/thread.h>
-
+#define ABSTRACT_UI_EXPORTS
 #include "pbd/abstract_ui.h"
 #include "midi++/types.h"
 #include "ardour/types.h"
@@ -38,7 +37,7 @@
 #include "types.h"
 #include "midi_byte_array.h"
 #include "controls.h"
-#include "mackie_jog_wheel.h"
+#include "jog_wheel.h"
 #include "timer.h"
 #include "device_info.h"
 #include "device_profile.h"
@@ -51,6 +50,8 @@ namespace MIDI {
        class Port;
 }
 
+namespace ArdourSurface {
+
 namespace Mackie {
        class Surface;
        class Control;
@@ -58,6 +59,8 @@ namespace Mackie {
        class Button;
 }
 
+gboolean ipmidi_input_handler (GIOChannel*, GIOCondition condition, void *data);
+
 /**
        This handles the plugin duties, and the midi encoding and decoding,
        and the signal callbacks, mostly from ARDOUR::Route.
@@ -84,7 +87,7 @@ public:
        ~MackieControlUIRequest () {}
 };
 
-class MackieControlProtocol 
+class MackieControlProtocol
        : public ARDOUR::ControlProtocol
        , public AbstractUI<MackieControlUIRequest>
 {
@@ -93,6 +96,9 @@ class MackieControlProtocol
        static const int MODIFIER_CONTROL;
        static const int MODIFIER_SHIFT;
        static const int MODIFIER_CMDALT;
+       static const int MODIFIER_ZOOM;
+       static const int MODIFIER_SCRUB;
+       static const int MAIN_MODIFIER_MASK;
 
        enum ViewMode {
                Mixer,
@@ -119,23 +125,33 @@ class MackieControlProtocol
        static MackieControlProtocol* instance() { return _instance; }
        
        const Mackie::DeviceInfo& device_info() const { return _device_info; }
-       const Mackie::DeviceProfile& device_profile() const { return _device_profile; }
+       Mackie::DeviceProfile& device_profile() { return _device_profile; }
+
+        void device_ready ();
 
        int set_active (bool yn);
-       void set_device (const std::string&);
-       void set_profile (const std::string&);
+       int  set_device (const std::string&);
+        void set_profile (const std::string&);
 
-       bool     flip_mode () const { return _flip_mode; }
+       FlipMode flip_mode () const { return _flip_mode; }
        ViewMode view_mode () const { return _view_mode; }
+       bool zoom_mode () const { return modifier_state() & MODIFIER_ZOOM; }
+       bool     metering_active () const { return _metering_active; }
 
        void set_view_mode (ViewMode);
-       void set_flip_mode (bool);
+       void set_flip_mode (FlipMode);
 
        XMLNode& get_state ();
        int set_state (const XMLNode&, int version);
-  
+
+       /* Note: because Mackie control is inherently a duplex protocol,
+          we do not implement get/set_feedback() since this aspect of
+          support for the protocol is not optional.
+       */
+       
        static bool probe();
        
+        Glib::Threads::Mutex surfaces_lock;
        typedef std::list<boost::shared_ptr<Mackie::Surface> > Surfaces;
        Surfaces surfaces;
 
@@ -144,7 +160,7 @@ class MackieControlProtocol
        void set_master_on_surface_strip (uint32_t surface, uint32_t strip);
        void set_monitor_on_surface_strip (uint32_t surface, uint32_t strip);
        
-       uint32_t n_strips () const;
+       uint32_t n_strips (bool with_locked_strips = true) const;
        
        bool has_editor () const { return true; }
        void* get_gui () const;
@@ -155,6 +171,10 @@ class MackieControlProtocol
        void notify_route_added (ARDOUR::RouteList &);
        void notify_remote_id_changed();
 
+       void recalibrate_faders ();
+       void toggle_backlight ();
+       void set_touch_sensitivity (int);
+       
        /// rebuild the current bank. Called on route added/removed and
        /// remote id changed.
        void refresh_current_bank();
@@ -163,6 +183,7 @@ class MackieControlProtocol
        void notify_record_state_changed();
        void notify_transport_state_changed();
        void notify_loop_state_changed();
+       void notify_metering_state_changed();
        // mainly to pick up punch-in and punch-out
        void notify_parameter_changed(std::string const &);
        void notify_solo_active_changed(bool);
@@ -170,10 +191,10 @@ class MackieControlProtocol
        /// Turn timecode on and beats off, or vice versa, depending
        /// on state of _timecode_type
        void update_timecode_beats_led();
-  
+       
        /// this is called to generate the midi to send in response to a button press.
        void update_led(Mackie::Surface&, Mackie::Button & button, Mackie::LedState);
-  
+
        void update_global_button (int id, Mackie::LedState);
        void update_global_led (int id, Mackie::LedState);
 
@@ -181,6 +202,7 @@ class MackieControlProtocol
        framepos_t transport_frame() const;
 
        int modifier_state() const { return _modifier_state; }
+       int main_modifier_state() const { return _modifier_state & MAIN_MODIFIER_MASK; }
 
        typedef std::list<boost::shared_ptr<ARDOUR::AutomationControl> > ControlList;
 
@@ -191,11 +213,19 @@ class MackieControlProtocol
        void add_down_select_button (int surface, int strip);
        void remove_down_select_button (int surface, int strip);
        void select_range ();
+
+       int16_t ipmidi_base() const { return _ipmidi_base; }
+       void    set_ipmidi_base (int16_t);
+
+       bool session_load () { return _session_load; }
+       void not_session_load () { _session_load = false; }
+
+       void midi_connectivity_established ();
        
   protected:
        // shut down the surface
        void close();
-  
+
        // This sets up the notifications and sets the
        // controls to the correct values
        void update_surfaces();
@@ -213,12 +243,12 @@ class MackieControlProtocol
        */
        typedef std::vector<boost::shared_ptr<ARDOUR::Route> > Sorted;
        Sorted get_sorted_routes();
-  
+
        // bank switching
        void switch_banks (uint32_t first_remote_id, bool force = false);
        void prev_track ();
        void next_track ();
-  
+
        // also called from poll_automation to update timecode display
        void update_timecode_display();
 
@@ -230,37 +260,34 @@ class MackieControlProtocol
 
        void thread_init ();
 
-       /* handling function key presses */
-
-       void f_press (uint32_t fn);
+       bool route_is_locked_to_strip (boost::shared_ptr<ARDOUR::Route>) const;
 
   private:
 
        struct ButtonHandlers {
            Mackie::LedState (MackieControlProtocol::*press) (Mackie::Button&);
            Mackie::LedState (MackieControlProtocol::*release) (Mackie::Button&);
-           
+       
            ButtonHandlers (Mackie::LedState (MackieControlProtocol::*p) (Mackie::Button&),
-                           Mackie::LedState (MackieControlProtocol::*r) (Mackie::Button&)) 
+                           Mackie::LedState (MackieControlProtocol::*r) (Mackie::Button&))
            : press (p)
            , release (r) {}
        };
 
        typedef std::map<Mackie::Button::ID,ButtonHandlers> ButtonMap;
-       typedef std::list<GSource*> PortSources;
 
        static MackieControlProtocol* _instance;
        
        Mackie::DeviceInfo       _device_info;
        Mackie::DeviceProfile    _device_profile;
        sigc::connection          periodic_connection;
+       sigc::connection          redisplay_connection;
+       sigc::connection          hui_connection;
        uint32_t                 _current_initial_bank;
        PBD::ScopedConnectionList audio_engine_connections;
        PBD::ScopedConnectionList session_connections;
-       PBD::ScopedConnectionList port_connections;
        PBD::ScopedConnectionList route_connections;
        PBD::ScopedConnectionList gui_connections;
-       bool _transport_previously_rolling;
        // timer for two quick marker left presses
        Mackie::Timer            _frm_left_last;
        // last written timecode string
@@ -272,41 +299,55 @@ class MackieControlProtocol
        // Bundle to represent our output ports
        boost::shared_ptr<ARDOUR::Bundle> _output_bundle;
        void*                    _gui;
-       bool                     _zoom_mode;
        bool                     _scrub_mode;
-       bool                     _flip_mode;
+       FlipMode                 _flip_mode;
        ViewMode                 _view_mode;
        int                      _current_selected_track;
        int                      _modifier_state;
-       PortSources               port_sources;
        ButtonMap                 button_map;
-
-       void create_surfaces ();
-       void port_connected_or_disconnected (std::string, std::string, bool);
+       int16_t                  _ipmidi_base;
+       bool                      needs_ipmidi_restart;
+       bool                     _metering_active;
+       bool                     _initialized;
+       ARDOUR::RouteNotificationList _last_selected_routes;
+       XMLNode*                                _surfaces_state;
+       int                                             _surfaces_version;
+       bool                                    _session_load;
+       boost::shared_ptr<ArdourSurface::Mackie::Surface>       _master_surface;
+
+        struct ipMIDIHandler {
+                MackieControlProtocol* mcp;
+                MIDI::Port* port;
+        };
+        friend struct ipMIDIHandler; /* is this necessary */
+       friend gboolean ArdourSurface::ipmidi_input_handler (GIOChannel*, GIOCondition condition, void *data);
+
+       int create_surfaces ();
        bool periodic();
+       bool redisplay();
+       bool hui_heartbeat ();
        void build_gui ();
        bool midi_input_handler (Glib::IOCondition ioc, MIDI::Port* port);
        void clear_ports ();
+       void clear_surfaces ();
        void force_special_route_to_strip (boost::shared_ptr<ARDOUR::Route> r, uint32_t surface, uint32_t strip_number);
        void build_button_map ();
-
-       void gui_track_selection_changed (ARDOUR::RouteNotificationListPtr);
-
+       void gui_track_selection_changed (ARDOUR::RouteNotificationListPtr, bool save_list);
+       void _gui_track_selection_changed (ARDOUR::RouteNotificationList*, bool save_list);
+       int ipmidi_restart ();
+        void initialize ();
+        int set_device_info (const std::string& device_name);
 
        /* BUTTON HANDLING */
 
        typedef std::set<uint32_t> DownButtonList;
        typedef std::map<ARDOUR::AutomationType,DownButtonList> DownButtonMap;
        DownButtonMap  _down_buttons;
-       DownButtonList _down_select_buttons; 
+       DownButtonList _down_select_buttons;
 
        void pull_route_range (DownButtonList&, ARDOUR::RouteList&);
 
        /* implemented button handlers */
-       Mackie::LedState frm_left_press(Mackie::Button &);
-       Mackie::LedState frm_left_release(Mackie::Button &);
-       Mackie::LedState frm_right_press(Mackie::Button &);
-       Mackie::LedState frm_right_release(Mackie::Button &);
        Mackie::LedState stop_press(Mackie::Button &);
        Mackie::LedState stop_release(Mackie::Button &);
        Mackie::LedState play_press(Mackie::Button &);
@@ -315,14 +356,6 @@ class MackieControlProtocol
        Mackie::LedState record_release(Mackie::Button &);
        Mackie::LedState loop_press(Mackie::Button &);
        Mackie::LedState loop_release(Mackie::Button &);
-       Mackie::LedState punch_in_press(Mackie::Button &);
-       Mackie::LedState punch_in_release(Mackie::Button &);
-       Mackie::LedState punch_out_press(Mackie::Button &);
-       Mackie::LedState punch_out_release(Mackie::Button &);
-       Mackie::LedState home_press(Mackie::Button &);
-       Mackie::LedState home_release(Mackie::Button &);
-       Mackie::LedState end_press(Mackie::Button &);
-       Mackie::LedState end_release(Mackie::Button &);
        Mackie::LedState rewind_press(Mackie::Button & button);
        Mackie::LedState rewind_release(Mackie::Button & button);
        Mackie::LedState ffwd_press(Mackie::Button & button);
@@ -359,8 +392,6 @@ class MackieControlProtocol
        Mackie::LedState scrub_release(Mackie::Button &);
        Mackie::LedState undo_press (Mackie::Button &);
        Mackie::LedState undo_release (Mackie::Button &);
-       Mackie::LedState redo_press (Mackie::Button &);
-       Mackie::LedState redo_release (Mackie::Button &);
        Mackie::LedState shift_press (Mackie::Button &);
        Mackie::LedState shift_release (Mackie::Button &);
        Mackie::LedState option_press (Mackie::Button &);
@@ -370,10 +401,6 @@ class MackieControlProtocol
        Mackie::LedState cmd_alt_press (Mackie::Button &);
        Mackie::LedState cmd_alt_release (Mackie::Button &);
 
-       Mackie::LedState io_press (Mackie::Button &);
-       Mackie::LedState io_release (Mackie::Button &);
-       Mackie::LedState sends_press (Mackie::Button &);
-       Mackie::LedState sends_release (Mackie::Button &);
        Mackie::LedState pan_press (Mackie::Button &);
        Mackie::LedState pan_release (Mackie::Button &);
        Mackie::LedState plugin_press (Mackie::Button &);
@@ -384,8 +411,6 @@ class MackieControlProtocol
        Mackie::LedState dyn_release (Mackie::Button &);
        Mackie::LedState flip_press (Mackie::Button &);
        Mackie::LedState flip_release (Mackie::Button &);
-       Mackie::LedState edit_press (Mackie::Button &);
-       Mackie::LedState edit_release (Mackie::Button &);
        Mackie::LedState name_value_press (Mackie::Button &);
        Mackie::LedState name_value_release (Mackie::Button &);
        Mackie::LedState F1_press (Mackie::Button &);
@@ -404,49 +429,25 @@ class MackieControlProtocol
        Mackie::LedState F7_release (Mackie::Button &);
        Mackie::LedState F8_press (Mackie::Button &);
        Mackie::LedState F8_release (Mackie::Button &);
-       Mackie::LedState F9_press (Mackie::Button &);
-       Mackie::LedState F9_release (Mackie::Button &);
-       Mackie::LedState F10_press (Mackie::Button &);
-       Mackie::LedState F10_release (Mackie::Button &);
-       Mackie::LedState F11_press (Mackie::Button &);
-       Mackie::LedState F11_release (Mackie::Button &);
-       Mackie::LedState F12_press (Mackie::Button &);
-       Mackie::LedState F12_release (Mackie::Button &);
-       Mackie::LedState F13_press (Mackie::Button &);
-       Mackie::LedState F13_release (Mackie::Button &);
-       Mackie::LedState F14_press (Mackie::Button &);
-       Mackie::LedState F14_release (Mackie::Button &);
-       Mackie::LedState F15_press (Mackie::Button &);
-       Mackie::LedState F15_release (Mackie::Button &);
-       Mackie::LedState F16_press (Mackie::Button &);
-       Mackie::LedState F16_release (Mackie::Button &);
-       Mackie::LedState on_press (Mackie::Button &);
-       Mackie::LedState on_release (Mackie::Button &);
-       Mackie::LedState rec_ready_press (Mackie::Button &);
-       Mackie::LedState rec_ready_release (Mackie::Button &);
        Mackie::LedState touch_press (Mackie::Button &);
        Mackie::LedState touch_release (Mackie::Button &);
        Mackie::LedState enter_press (Mackie::Button &);
        Mackie::LedState enter_release (Mackie::Button &);
        Mackie::LedState cancel_press (Mackie::Button &);
        Mackie::LedState cancel_release (Mackie::Button &);
-       Mackie::LedState mixer_press (Mackie::Button &);
-       Mackie::LedState mixer_release (Mackie::Button &);
        Mackie::LedState user_a_press (Mackie::Button &);
        Mackie::LedState user_a_release (Mackie::Button &);
        Mackie::LedState user_b_press (Mackie::Button &);
        Mackie::LedState user_b_release (Mackie::Button &);
        Mackie::LedState fader_touch_press (Mackie::Button &);
        Mackie::LedState fader_touch_release (Mackie::Button &);
+       Mackie::LedState master_fader_touch_press (Mackie::Button &);
+       Mackie::LedState master_fader_touch_release (Mackie::Button &);
 
-       Mackie::LedState snapshot_press (Mackie::Button&);
-       Mackie::LedState snapshot_release (Mackie::Button&);
        Mackie::LedState read_press (Mackie::Button&);
        Mackie::LedState read_release (Mackie::Button&);
        Mackie::LedState write_press (Mackie::Button&);
        Mackie::LedState write_release (Mackie::Button&);
-       Mackie::LedState fdrgroup_press (Mackie::Button&);
-       Mackie::LedState fdrgroup_release (Mackie::Button&);
        Mackie::LedState clearsolo_press (Mackie::Button&);
        Mackie::LedState clearsolo_release (Mackie::Button&);
        Mackie::LedState track_press (Mackie::Button&);
@@ -487,6 +488,6 @@ class MackieControlProtocol
        Mackie::LedState view_release (Mackie::Button&);
 };
 
-
+} // namespace
 
 #endif // ardour_mackie_control_protocol_h