rationalize save/restore of control surface "feedback" property
[ardour.git] / libs / surfaces / mackie / mackie_control_protocol.h
index 177a8f2ef2761f1c4d3961d7475b515433d1255b..f521684a807eaa7f3acc1a3259d06a87582456c3 100644 (file)
 
 #include <vector>
 #include <map>
+#include <list>
+#include <set>
 
 #include <sys/time.h>
 #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"
 #include "control_protocol/control_protocol.h"
 
 #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"
+
+namespace ARDOUR {
+       class AutomationControl;
+}
 
 namespace MIDI {
        class Port;
 }
 
+namespace ArdourSurface {
+
 namespace Mackie {
        class Surface;
        class Control;
@@ -53,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.
@@ -90,7 +98,7 @@ class MackieControlProtocol
        static const int MODIFIER_CMDALT;
 
        enum ViewMode {
-               Global,
+               Mixer,
                Dynamics,
                EQ,
                Loop,
@@ -112,23 +120,35 @@ class MackieControlProtocol
        virtual ~MackieControlProtocol();
 
        static MackieControlProtocol* instance() { return _instance; }
+       
+       const Mackie::DeviceInfo& device_info() const { return _device_info; }
+       Mackie::DeviceProfile& device_profile() { return _device_profile; }
 
-       const std::string& device_name() const { return _device_name; }
-       static std::vector<std::string> get_possible_devices ();
+        void device_ready ();
 
        int set_active (bool yn);
+       int  set_device (const std::string&);
+        void set_profile (const std::string&);
 
        FlipMode flip_mode () const { return _flip_mode; }
        ViewMode view_mode () const { return _view_mode; }
+       bool zoom_mode () const { return _zoom_mode; }
+       bool     metering_active () const { return _metering_active; }
 
        void set_view_mode (ViewMode);
        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;
 
@@ -137,14 +157,12 @@ 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;
        void tear_down_gui ();
 
-       void select_track (boost::shared_ptr<ARDOUR::Route> r);
-       
        void handle_button_event (Mackie::Surface&, Mackie::Button& button, Mackie::ButtonState);
 
        void notify_route_added (ARDOUR::RouteList &);
@@ -158,6 +176,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);
@@ -165,18 +184,32 @@ 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(const std::string & name, Mackie::LedState);
-       void update_global_led(const std::string & name, Mackie::LedState);
+       void update_global_button (int id, Mackie::LedState);
+       void update_global_led (int id, Mackie::LedState);
 
        ARDOUR::Session & get_session() { return *session; }
-       void add_in_use_timeout (Mackie::Surface& surface, Mackie::Control& in_use_control, Mackie::Control* touch_control);
+       framepos_t transport_frame() const;
 
        int modifier_state() const { return _modifier_state; }
+
+       typedef std::list<boost::shared_ptr<ARDOUR::AutomationControl> > ControlList;
+
+       void add_down_button (ARDOUR::AutomationType, int surface, int strip);
+       void remove_down_button (ARDOUR::AutomationType, int surface, int strip);
+       ControlList down_controls (ARDOUR::AutomationType);
+       
+       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);
+
+       void midi_connectivity_established ();
        
   protected:
        // shut down the surface
@@ -216,10 +249,7 @@ class MackieControlProtocol
 
        void thread_init ();
 
-       /* handling function key presses */
-
-       std::string f_action (uint32_t fn);
-       void f_press (uint32_t fn);
+       bool route_is_locked_to_strip (boost::shared_ptr<ARDOUR::Route>) const;
 
   private:
 
@@ -233,20 +263,18 @@ class MackieControlProtocol
            , release (r) {}
        };
 
-       typedef std::map<int,ButtonHandlers> ButtonMap;
-       typedef std::list<GSource*> PortSources;
+       typedef std::map<Mackie::Button::ID,ButtonHandlers> ButtonMap;
 
        static MackieControlProtocol* _instance;
        
-       std::string              _device_name;
        Mackie::DeviceInfo       _device_info;
+       Mackie::DeviceProfile    _device_profile;
        sigc::connection          periodic_connection;
        uint32_t                 _current_initial_bank;
        PBD::ScopedConnectionList audio_engine_connections;
        PBD::ScopedConnectionList session_connections;
-       PBD::ScopedConnectionList port_connections;
        PBD::ScopedConnectionList route_connections;
-       bool _transport_previously_rolling;
+       PBD::ScopedConnectionList gui_connections;
        // timer for two quick marker left presses
        Mackie::Timer            _frm_left_last;
        // last written timecode string
@@ -264,29 +292,46 @@ class MackieControlProtocol
        ViewMode                 _view_mode;
        int                      _current_selected_track;
        int                      _modifier_state;
-       PortSources               port_sources;
-       std::vector<std::string> _f_actions;
        ButtonMap                 button_map;
-
-       std::string find_device_info_file (const std::string& name);
-       void load_device_info (const std::string&);
-       void create_surfaces ();
-       void port_connected_or_disconnected (std::string, std::string, bool);
-       bool control_in_use_timeout (Mackie::Surface*, Mackie::Control *, Mackie::Control *);
+       int16_t                  _ipmidi_base;
+       bool                      needs_ipmidi_restart;
+       bool                     _metering_active;
+       bool                     _initialized;
+       ARDOUR::RouteNotificationList _last_selected_routes;
+        XMLNode*                 _surfaces_state;
+        int                      _surfaces_version;
+
+        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();
        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, 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; 
+
+       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 &);
@@ -295,14 +340,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);
@@ -329,8 +366,6 @@ class MackieControlProtocol
        Mackie::LedState global_solo_release(Mackie::Button &);
        Mackie::LedState marker_press(Mackie::Button &);
        Mackie::LedState marker_release(Mackie::Button &);
-       Mackie::LedState drop_press(Mackie::Button &);
-       Mackie::LedState drop_release(Mackie::Button &);
        Mackie::LedState save_press(Mackie::Button &);
        Mackie::LedState save_release(Mackie::Button &);
        Mackie::LedState timecode_beats_press(Mackie::Button &);
@@ -341,8 +376,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 &);
@@ -352,10 +385,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 &);
@@ -366,8 +395,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 &);
@@ -386,44 +413,65 @@ 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 snapshot_press (Mackie::Button &);
-       Mackie::LedState snapshot_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 read_press (Mackie::Button&);
+       Mackie::LedState read_release (Mackie::Button&);
+       Mackie::LedState write_press (Mackie::Button&);
+       Mackie::LedState write_release (Mackie::Button&);
+       Mackie::LedState clearsolo_press (Mackie::Button&);
+       Mackie::LedState clearsolo_release (Mackie::Button&);
+       Mackie::LedState track_press (Mackie::Button&);
+       Mackie::LedState track_release (Mackie::Button&);
+       Mackie::LedState send_press (Mackie::Button&);
+       Mackie::LedState send_release (Mackie::Button&);
+       Mackie::LedState miditracks_press (Mackie::Button&);
+       Mackie::LedState miditracks_release (Mackie::Button&);
+       Mackie::LedState inputs_press (Mackie::Button&);
+       Mackie::LedState inputs_release (Mackie::Button&);
+       Mackie::LedState audiotracks_press (Mackie::Button&);
+       Mackie::LedState audiotracks_release (Mackie::Button&);
+       Mackie::LedState audioinstruments_press (Mackie::Button&);
+       Mackie::LedState audioinstruments_release (Mackie::Button&);
+       Mackie::LedState aux_press (Mackie::Button&);
+       Mackie::LedState aux_release (Mackie::Button&);
+       Mackie::LedState busses_press (Mackie::Button&);
+       Mackie::LedState busses_release (Mackie::Button&);
+       Mackie::LedState outputs_press (Mackie::Button&);
+       Mackie::LedState outputs_release (Mackie::Button&);
+       Mackie::LedState user_press (Mackie::Button&);
+       Mackie::LedState user_release (Mackie::Button&);
+       Mackie::LedState trim_press (Mackie::Button&);
+       Mackie::LedState trim_release (Mackie::Button&);
+       Mackie::LedState latch_press (Mackie::Button&);
+       Mackie::LedState latch_release (Mackie::Button&);
+       Mackie::LedState grp_press (Mackie::Button&);
+       Mackie::LedState grp_release (Mackie::Button&);
+       Mackie::LedState nudge_press (Mackie::Button&);
+       Mackie::LedState nudge_release (Mackie::Button&);
+       Mackie::LedState drop_press (Mackie::Button&);
+       Mackie::LedState drop_release (Mackie::Button&);
+       Mackie::LedState replace_press (Mackie::Button&);
+       Mackie::LedState replace_release (Mackie::Button&);
+       Mackie::LedState click_press (Mackie::Button&);
+       Mackie::LedState click_release (Mackie::Button&);
+       Mackie::LedState view_press (Mackie::Button&);
+       Mackie::LedState view_release (Mackie::Button&);
 };
 
-
+} // namespace 
 
 #endif // ardour_mackie_control_protocol_h