libs/surfaces/mackie/mackie_midi_builder.h

   1 /*
   2         Copyright (C) 2006,2007 John Anderson
   3
   4         This program is free software; you can redistribute it and/or modify
   5         it under the terms of the GNU General Public License as published by
   6         the Free Software Foundation; either version 2 of the License, or
   7         (at your option) any later version.
   8
   9         This program is distributed in the hope that it will be useful,
  10         but WITHOUT ANY WARRANTY; without even the implied warranty of
  11         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12         GNU General Public License for more details.
  13
  14         You should have received a copy of the GNU General Public License
  15         along with this program; if not, write to the Free Software
  16         Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18 #ifndef mackie_midi_builder_h
  19 #define mackie_midi_builder_h
  20
  21 #include "midi_byte_array.h"
  22 #include "types.h"
  23 #include "controls.h"
  24
  25 namespace Mackie
  26 {
  27
  28 class SurfacePort;
  29
  30 /**
  31         This knows how to build midi messages given a control and
  32         a state.
  33 */
  34 class MackieMidiBuilder
  35 {
  36 public:
  37         /**
  38                 The first byte of a midi message from the surface
  39                 will contain one of these, sometimes bitmasked
  40                 with the control id
  41         */
  42         enum midi_types {
  43                 midi_fader_id = Control::type_fader
  44                 , midi_button_id = Control::type_button
  45                 , midi_pot_id = Control::type_pot
  46         };
  47
  48         /**
  49                 The LED rings have these modes.
  50         */
  51         enum midi_pot_mode {
  52                 midi_pot_mode_dot = 0
  53                 , midi_pot_mode_boost_cut = 1
  54                 , midi_pot_mode_wrap = 2
  55                 , midi_pot_mode_spread = 3
  56         };
  57
  58         MidiByteArray build_led_ring( const Pot & pot, const ControlState &, midi_pot_mode mode = midi_pot_mode_dot );
  59         MidiByteArray build_led_ring( const LedRing & led_ring, const ControlState &, midi_pot_mode mode = midi_pot_mode_dot );
  60
  61         MidiByteArray build_led( const Led & led, LedState ls );
  62         MidiByteArray build_led( const Button & button, LedState ls );
  63
  64         MidiByteArray build_fader( const Fader & fader, float pos );
  65
  66         /// return bytes that will reset all controls to their zero positions
  67         /// And blank the display for the strip. Pass SurfacePort so we know which sysex header to use.
  68         MidiByteArray zero_strip( SurfacePort &, const Strip & strip );
  69
  70         // provide bytes to zero the given control
  71         MidiByteArray zero_control( const Control & control );
  72
  73         // display the first 2 chars of the msg in the 2 char display
  74         // . is appended to the previous character, so A.B. would
  75         // be two characters
  76         MidiByteArray two_char_display( const std::string & msg, const std::string & dots = "  " );
  77         MidiByteArray two_char_display( unsigned int value, const std::string & dots = "  " );
  78
  79         /**
  80                 Timecode display. Only the difference between timecode and last_timecode will
  81                 be encoded, to save midi bandwidth. If they're the same, an empty array will
  82                 be returned
  83         */
  84         MidiByteArray timecode_display( SurfacePort &, const std::string & timecode, const std::string & last_timecode = "" );
  85
  86         /**
  87                 for displaying characters on the strip LCD
  88                 pass SurfacePort so we know which sysex header to use
  89         */
  90         MidiByteArray strip_display( SurfacePort &, const Strip & strip, unsigned int line_number, const std::string & line );
  91
  92         /// blank the strip LCD, ie write all spaces. Pass SurfacePort so we know which sysex header to use.
  93         MidiByteArray strip_display_blank( SurfacePort &, const Strip & strip, unsigned int line_number );
  94
  95         /// for generating all strip names. Pass SurfacePort so we know which sysex header to use.
  96         MidiByteArray all_strips_display( SurfacePort &, std::vector<std::string> & lines1, std::vector<std::string> & lines2 );
  97
  98 protected:
  99         static MIDI::byte calculate_pot_value( midi_pot_mode mode, const ControlState & );
 100 };
 101
 102 }
 103
 104 #endif