libs/surfaces/mackie/strip.h

   1 #ifndef __ardour_mackie_control_protocol_strip_h__
   2 #define __ardour_mackie_control_protocol_strip_h__
   3
   4 #include <string>
   5 #include <iostream>
   6
   7 #include "evoral/Parameter.hpp"
   8
   9 #include "pbd/property_basics.h"
  10 #include "pbd/ringbuffer.h"
  11 #include "pbd/signals.h"
  12
  13 #include "ardour/types.h"
  14 #include "control_protocol/types.h"
  15
  16 #include "control_group.h"
  17 #include "types.h"
  18 #include "midi_byte_array.h"
  19 #include "device_info.h"
  20
  21 namespace ARDOUR {
  22         class Route;
  23         class Bundle;
  24         class ChannelCount;
  25 }
  26
  27 namespace ArdourSurface {
  28
  29 namespace Mackie {
  30
  31 class Control;
  32 class Surface;
  33 class Button;
  34 class Pot;
  35 class Fader;
  36 class Meter;
  37 class SurfacePort;
  38
  39 struct GlobalControlDefinition {
  40     const char* name;
  41     int id;
  42     Control* (*factory)(Surface&, int index, const char* name, Group&);
  43     const char* group_name;
  44 };
  45
  46 /**
  47         This is the set of controls that make up a strip.
  48 */
  49 class Strip : public Group
  50 {
  51 public:
  52         Strip (Surface&, const std::string & name, int index, const std::map<Button::ID,StripButtonInfo>&);
  53         ~Strip();
  54
  55         boost::shared_ptr<ARDOUR::Route> route() const { return _route; }
  56
  57         void add (Control & control);
  58         int index() const { return _index; } // zero based
  59
  60         void set_route (boost::shared_ptr<ARDOUR::Route>, bool with_messages = true);
  61
  62         // call all signal handlers manually
  63         void notify_all ();
  64
  65         void handle_button (Button&, ButtonState bs);
  66         void handle_fader (Fader&, float position);
  67         void handle_fader_touch (Fader&, bool touch_on);
  68         void handle_pot (Pot&, float delta);
  69
  70         void periodic (ARDOUR::microseconds_t now_usecs);
  71         void redisplay (ARDOUR::microseconds_t now_usecs);
  72
  73         MidiByteArray display (uint32_t line_number, const std::string&);
  74         MidiByteArray blank_display (uint32_t line_number);
  75
  76         void zero ();
  77
  78         void potmode_changed (bool notify=false);
  79
  80         void lock_controls ();
  81         void unlock_controls ();
  82         bool locked() const { return _controls_locked; }
  83
  84         void gui_selection_changed (const ARDOUR::StrongRouteNotificationList&);
  85
  86         void notify_metering_state_changed();
  87
  88         void block_screen_display_for (uint32_t msecs);
  89         void block_vpot_mode_display_for (uint32_t msecs);
  90
  91 private:
  92         Button*  _solo;
  93         Button*  _recenable;
  94         Button*  _mute;
  95         Button*  _select;
  96         Button*  _vselect;
  97         Button*  _fader_touch;
  98         Pot*     _vpot;
  99         Fader*   _fader;
 100         Meter*   _meter;
 101         int      _index;
 102         Surface* _surface;
 103         bool     _controls_locked;
 104         bool     _transport_is_rolling;
 105         bool     _metering_active;
 106         uint64_t _block_vpot_mode_redisplay_until;
 107         uint64_t _block_screen_redisplay_until;
 108         boost::shared_ptr<ARDOUR::Route> _route;
 109         PBD::ScopedConnectionList route_connections;
 110
 111         ARDOUR::AutomationType  _pan_mode;
 112         ARDOUR::AutomationType  _trim_mode;
 113
 114         float _last_gain_position_written;
 115         float _last_pan_azi_position_written;
 116         float _last_pan_width_position_written;
 117         float _last_trim_position_written;
 118
 119         void notify_solo_changed ();
 120         void notify_mute_changed ();
 121         void notify_record_enable_changed ();
 122         void notify_gain_changed (bool force_update = true);
 123         void notify_property_changed (const PBD::PropertyChange&);
 124         void notify_panner_azi_changed (bool force_update = true);
 125         void notify_panner_width_changed (bool force_update = true);
 126         void notify_active_changed ();
 127         void notify_route_deleted ();
 128         void notify_trim_changed (bool force_update = true);
 129         void notify_phase_changed (bool force_update = true);
 130
 131         void update_automation ();
 132         void update_meter ();
 133
 134         std::string vpot_mode_string () const;
 135
 136         void return_to_vpot_mode_display ();
 137
 138         struct RedisplayRequest {
 139                 ARDOUR::AutomationType type;
 140                 float val;
 141         };
 142
 143         RingBuffer<RedisplayRequest> redisplay_requests;
 144
 145         void do_parameter_display (ARDOUR::AutomationType, float val);
 146         void queue_parameter_display (ARDOUR::AutomationType, float val);
 147
 148         void select_event (Button&, ButtonState);
 149         void vselect_event (Button&, ButtonState);
 150         void fader_touch_event (Button&, ButtonState);
 151
 152         std::vector<Evoral::Parameter> possible_pot_parameters;
 153         std::vector<Evoral::Parameter> possible_trim_parameters;
 154         void next_pot_mode ();
 155         void set_vpot_parameter (Evoral::Parameter);
 156         void show_route_name ();
 157
 158         void reset_saved_values ();
 159
 160         bool is_midi_track () const;
 161
 162         typedef std::map<Evoral::Parameter,Control*> ControlParameterMap;
 163         ControlParameterMap control_by_parameter;
 164 };
 165
 166 }
 167 }
 168
 169 #endif /* __ardour_mackie_control_protocol_strip_h__ */