first vaguely working version using PresentationInfo
[ardour.git] / libs / surfaces / mackie / mackie_control_protocol.h
index 4ff5d53f2567ab7b2ddef8cd792b64d2c28f7b7f..37d0b69bb39f9ee7c1b171ec49b2f21169899374 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.
 
 namespace ARDOUR {
        class AutomationControl;
+       class Port;
 }
 
 namespace MIDI {
        class Port;
 }
 
+namespace ArdourSurface {
+
 namespace Mackie {
        class Surface;
        class Control;
        class SurfacePort;
        class Button;
+       class Strip;
 }
 
+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.
@@ -83,7 +89,7 @@ public:
        ~MackieControlUIRequest () {}
 };
 
-class MackieControlProtocol 
+class MackieControlProtocol
        : public ARDOUR::ControlProtocol
        , public AbstractUI<MackieControlUIRequest>
 {
@@ -92,70 +98,121 @@ 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 MODIFIER_MARKER;
+       static const int MODIFIER_NUDGE;
+       static const int MAIN_MODIFIER_MASK;
 
        enum ViewMode {
                Mixer,
-               Dynamics,
-               EQ,
-               Loop,
                AudioTracks,
                MidiTracks,
                Busses,
-               Sends,
+               Auxes,
+               Selected,
+               Hidden,
                Plugins,
        };
 
+       enum SubViewMode {
+               None,
+               EQ,
+               Dynamics,
+               Sends,
+               TrackView,
+       };
+
        enum FlipMode {
                Normal, /* fader controls primary, vpot controls secondary */
                Mirror, /* fader + vpot control secondary */
                Swap,   /* fader controls secondary, vpot controls primary */
                Zero,   /* fader controls primary, but doesn't move, vpot controls secondary */
        };
-       
+
        MackieControlProtocol(ARDOUR::Session &);
        virtual ~MackieControlProtocol();
 
        static MackieControlProtocol* instance() { return _instance; }
-       
+
        const Mackie::DeviceInfo& device_info() const { return _device_info; }
        Mackie::DeviceProfile& device_profile() { return _device_profile; }
 
+       PBD::Signal0<void> DeviceChanged;
+       PBD::Signal1<void,boost::shared_ptr<Mackie::Surface> > ConnectionChange;
+
+        void device_ready ();
+
        int set_active (bool yn);
-       int  set_device (const std::string&);
+       int  set_device (const std::string&, bool force);
         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; }
+       SubViewMode subview_mode () const { return _subview_mode; }
+       static bool subview_mode_would_be_ok (SubViewMode, boost::shared_ptr<ARDOUR::Route>);
+       boost::shared_ptr<ARDOUR::Route> subview_route() const;
+       bool zoom_mode () const { return modifier_state() & MODIFIER_ZOOM; }
        bool     metering_active () const { return _metering_active; }
 
+       bool is_track (boost::shared_ptr<ARDOUR::Route>) const;
+       bool is_audio_track (boost::shared_ptr<ARDOUR::Route>) const;
+       bool is_midi_track (boost::shared_ptr<ARDOUR::Route>) const;
+       bool selected (boost::shared_ptr<ARDOUR::Route>) const;
+       bool is_hidden (boost::shared_ptr<ARDOUR::Route>) const;
+       bool is_mapped (boost::shared_ptr<ARDOUR::Route>) const;
+       boost::shared_ptr<ARDOUR::Route> first_selected_route () const;
+
+       void check_fader_automation_state ();
+       void update_fader_automation_state ();
+       void set_automation_state (ARDOUR::AutoState);
+
        void set_view_mode (ViewMode);
+       int set_subview_mode (SubViewMode, boost::shared_ptr<ARDOUR::Route>);
        void set_flip_mode (FlipMode);
+       void display_view_mode ();
 
        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;
+       static void* request_factory (uint32_t);
+
+       mutable Glib::Threads::Mutex surfaces_lock;
        typedef std::list<boost::shared_ptr<Mackie::Surface> > Surfaces;
        Surfaces surfaces;
 
+       boost::shared_ptr<Mackie::Surface> get_surface_by_raw_pointer (void*) const;
+       boost::shared_ptr<Mackie::Surface> nth_surface (uint32_t) const;
+
+       uint32_t global_index (Mackie::Strip&);
+
        std::list<boost::shared_ptr<ARDOUR::Bundle> > bundles ();
 
        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 (bool with_locked_strips = true) const;
-       
+
        bool has_editor () const { return true; }
        void* get_gui () const;
        void tear_down_gui ();
 
        void handle_button_event (Mackie::Surface&, Mackie::Button& button, Mackie::ButtonState);
 
+       void notify_subview_route_deleted ();
+       void notify_route_removed ();
        void notify_route_added (ARDOUR::RouteList &);
-       void notify_remote_id_changed();
+       void notify_presentation_info_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.
@@ -173,10 +230,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);
 
@@ -184,13 +241,14 @@ 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;
 
        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 ();
@@ -198,41 +256,41 @@ class MackieControlProtocol
        int16_t ipmidi_base() const { return _ipmidi_base; }
        void    set_ipmidi_base (int16_t);
 
-       void midi_connectivity_established ();
-       
+       void ping_devices ();
+
   protected:
        // shut down the surface
        void close();
-  
+
        // This sets up the notifications and sets the
        // controls to the correct values
        void update_surfaces();
-       
+
        // connects global (not strip) signals from the Session to here
        // so the surface can be notified of changes from the other UIs.
        void connect_session_signals();
-       
+
        // set all controls to their zero position
        void zero_all();
-       
+
        /**
           Fetch the set of routes to be considered for control by the
           surface. Excluding master, hidden and control routes, and inactive routes
        */
        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);
+       int 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();
 
        std::string format_bbt_timecode (ARDOUR::framepos_t now_frame);
        std::string format_timecode_timecode (ARDOUR::framepos_t now_frame);
-       
+
        void do_request (MackieControlUIRequest*);
        int stop ();
 
@@ -245,30 +303,36 @@ class MackieControlProtocol
        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;
-       
+
+       bool profile_exists (std::string const&) const;
+
        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 route_connections;
+       PBD::ScopedConnectionList subview_route_connections;
        PBD::ScopedConnectionList gui_connections;
+       PBD::ScopedConnectionList fader_automation_connections;
        // timer for two quick marker left presses
        Mackie::Timer            _frm_left_last;
        // last written timecode string
        std::string              _timecode_last;
+       framepos_t                               _frame_last;
        // Which timecode are we displaying? BBT or Timecode
        ARDOUR::AnyTime::Type    _timecode_type;
        // Bundle to represent our input ports
@@ -276,24 +340,39 @@ class MackieControlProtocol
        // Bundle to represent our output ports
        boost::shared_ptr<ARDOUR::Bundle> _output_bundle;
        void*                    _gui;
-       bool                     _zoom_mode;
        bool                     _scrub_mode;
        FlipMode                 _flip_mode;
        ViewMode                 _view_mode;
+       SubViewMode              _subview_mode;
+       boost::shared_ptr<ARDOUR::Route> _subview_route;
        int                      _current_selected_track;
        int                      _modifier_state;
-       PortSources               port_sources;
        ButtonMap                 button_map;
        int16_t                  _ipmidi_base;
        bool                      needs_ipmidi_restart;
        bool                     _metering_active;
        bool                     _initialized;
        ARDOUR::RouteNotificationList _last_selected_routes;
-        XMLNode*                 _surfaces_state;
-        int                      _surfaces_version;
+       XMLNode*                 configuration_state;
+       int                      state_version;
+       int                      _last_bank[9];
+       bool                     marker_modifier_consumed_by_button;
+       bool                     nudge_modifier_consumed_by_button;
+
+       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 redisplay_subview_mode ();
+       bool hui_heartbeat ();
        void build_gui ();
        bool midi_input_handler (Glib::IOCondition ioc, MIDI::Port* port);
        void clear_ports ();
@@ -301,25 +380,27 @@ class MackieControlProtocol
        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);
+       void _gui_track_selection_changed (ARDOUR::RouteNotificationList*, bool save_list, bool gui_did_change);
        int ipmidi_restart ();
         void initialize ();
         int set_device_info (const std::string& device_name);
+       void update_configuration_state ();
+
+       /* MIDI port connection management */
+
+       PBD::ScopedConnection port_connection;
+       void connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool);
 
        /* 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 &);
@@ -328,14 +409,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);
@@ -356,10 +429,6 @@ class MackieControlProtocol
        Mackie::LedState channel_left_release(Mackie::Button &);
        Mackie::LedState channel_right_press(Mackie::Button &);
        Mackie::LedState channel_right_release(Mackie::Button &);
-       Mackie::LedState clicking_press(Mackie::Button &);
-       Mackie::LedState clicking_release(Mackie::Button &);
-       Mackie::LedState global_solo_press(Mackie::Button &);
-       Mackie::LedState global_solo_release(Mackie::Button &);
        Mackie::LedState marker_press(Mackie::Button &);
        Mackie::LedState marker_release(Mackie::Button &);
        Mackie::LedState save_press(Mackie::Button &);
@@ -372,8 +441,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 &);
@@ -383,10 +450,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 &);
@@ -397,8 +460,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 &);
@@ -417,34 +478,12 @@ 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 &);
@@ -454,14 +493,10 @@ class MackieControlProtocol
        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&);
@@ -500,6 +535,10 @@ class MackieControlProtocol
        Mackie::LedState click_release (Mackie::Button&);
        Mackie::LedState view_press (Mackie::Button&);
        Mackie::LedState view_release (Mackie::Button&);
+
+       Mackie::LedState bank_release (Mackie::Button&, uint32_t bank_num);
 };
 
+} // namespace
+
 #endif // ardour_mackie_control_protocol_h