libs/surfaces/generic_midi/midicontrollable.h

   1 /*
   2     Copyright (C) 1998-2006 Paul Davis
   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 */
  19
  20 #ifndef __gm_midicontrollable_h__
  21 #define __gm_midicontrollable_h__
  22
  23 #include <string>
  24
  25 #include "midi++/types.h"
  26
  27 #include "pbd/controllable.h"
  28 #include "pbd/signals.h"
  29 #include "pbd/stateful.h"
  30
  31 #include "ardour/types.h"
  32
  33 namespace PBD {
  34         class ControllableDescriptor;
  35 }
  36
  37 namespace MIDI {
  38         class Channel;
  39         class Parser;
  40 }
  41
  42 class GenericMidiControlProtocol;
  43
  44 namespace ARDOUR {
  45         class AsyncMIDIPort;
  46 }
  47
  48 class MIDIControllable : public PBD::Stateful
  49 {
  50   public:
  51         MIDIControllable (GenericMidiControlProtocol *, MIDI::Parser&, PBD::Controllable&, bool momentary);
  52         MIDIControllable (GenericMidiControlProtocol *, MIDI::Parser&, bool momentary = false);
  53         virtual ~MIDIControllable ();
  54
  55         int init (const std::string&);
  56
  57         void rediscover_controllable ();
  58         bool bank_relative() const { return _bank_relative; }
  59         uint32_t rid() const { return _rid; }
  60         std::string what() const { return _what; }
  61
  62         MIDI::byte* write_feedback (MIDI::byte* buf, int32_t& bufsize, bool force = false);
  63
  64         void midi_rebind (MIDI::channel_t channel=-1);
  65         void midi_forget ();
  66         void learn_about_external_control ();
  67         void stop_learning ();
  68         void drop_external_control ();
  69
  70         bool get_midi_feedback () { return feedback; }
  71         void set_midi_feedback (bool val) { feedback = val; }
  72
  73         int control_to_midi(float val);
  74         float midi_to_control(int val);
  75
  76         bool learned() const { return _learned; }
  77
  78         MIDI::Parser& get_parser() { return _parser; }
  79         PBD::Controllable* get_controllable() const { return controllable; }
  80         void set_controllable (PBD::Controllable*);
  81         const std::string& current_uri() const { return _current_uri; }
  82
  83         PBD::ControllableDescriptor& descriptor() const { return *_descriptor; }
  84
  85         std::string control_description() const { return _control_description; }
  86
  87         XMLNode& get_state (void);
  88         int set_state (const XMLNode&, int version);
  89
  90         void bind_midi (MIDI::channel_t, MIDI::eventType, MIDI::byte);
  91         MIDI::channel_t get_control_channel () { return control_channel; }
  92         MIDI::eventType get_control_type () { return control_type; }
  93         MIDI::byte get_control_additional () { return control_additional; }
  94
  95         int lookup_controllable();
  96
  97   private:
  98
  99         int max_value_for_type () const;
 100
 101         GenericMidiControlProtocol* _surface;
 102         PBD::Controllable* controllable;
 103         PBD::ControllableDescriptor* _descriptor;
 104         std::string     _current_uri;
 105         MIDI::Parser&   _parser;
 106         bool             setting;
 107         int              last_value;
 108         float            last_controllable_value;
 109         bool            _momentary;
 110         bool            _is_gain_controller;
 111         bool            _learned;
 112         int              midi_msg_id;      /* controller ID or note number */
 113         PBD::ScopedConnection midi_sense_connection[2];
 114         PBD::ScopedConnection midi_learn_connection;
 115         PBD::ScopedConnection controllable_death_connection;
 116         /** the type of MIDI message that is used for this control */
 117         MIDI::eventType  control_type;
 118         MIDI::byte       control_additional;
 119         MIDI::channel_t  control_channel;
 120         std::string     _control_description;
 121         bool             feedback;
 122         uint32_t        _rid;
 123         std::string     _what;
 124         bool            _bank_relative;
 125
 126         void drop_controllable();
 127
 128         void midi_receiver (MIDI::Parser &p, MIDI::byte *, size_t);
 129         void midi_sense_note (MIDI::Parser &, MIDI::EventTwoBytes *, bool is_on);
 130         void midi_sense_note_on (MIDI::Parser &p, MIDI::EventTwoBytes *tb);
 131         void midi_sense_note_off (MIDI::Parser &p, MIDI::EventTwoBytes *tb);
 132         void midi_sense_controller (MIDI::Parser &, MIDI::EventTwoBytes *);
 133         void midi_sense_program_change (MIDI::Parser &, MIDI::byte);
 134         void midi_sense_pitchbend (MIDI::Parser &, MIDI::pitchbend_t);
 135 };
 136
 137 #endif // __gm_midicontrollable_h__
 138