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 Port;
  40         class Parser;
  41 }
  42
  43 class MIDIControllable : public PBD::Stateful
  44 {
  45   public:
  46         MIDIControllable (MIDI::Port&, PBD::Controllable&, bool momentary);
  47         MIDIControllable (MIDI::Port&, bool momentary = false);
  48         virtual ~MIDIControllable ();
  49
  50         int init (const std::string&);
  51
  52         void rediscover_controllable ();
  53         bool bank_relative() const { return _bank_relative; }
  54         uint32_t rid() const { return _rid; }
  55         std::string what() const { return _what; }
  56
  57         MIDI::byte* write_feedback (MIDI::byte* buf, int32_t& bufsize, bool force = false);
  58
  59         void midi_rebind (MIDI::channel_t channel=-1);
  60         void midi_forget ();
  61         void learn_about_external_control ();
  62         void stop_learning ();
  63         void drop_external_control ();
  64
  65         bool get_midi_feedback () { return feedback; }
  66         void set_midi_feedback (bool val) { feedback = val; }
  67
  68         float control_to_midi(float val);
  69         float midi_to_control(float val);
  70
  71         bool learned() const { return _learned; }
  72
  73         MIDI::Port& get_port() const { return _port; }
  74         PBD::Controllable* get_controllable() const { return controllable; }
  75         void set_controllable (PBD::Controllable*);
  76         const std::string& current_uri() const { return _current_uri; }
  77
  78         PBD::ControllableDescriptor& descriptor() const { return *_descriptor; }
  79
  80         std::string control_description() const { return _control_description; }
  81
  82         XMLNode& get_state (void);
  83         int set_state (const XMLNode&, int version);
  84
  85         void bind_midi (MIDI::channel_t, MIDI::eventType, MIDI::byte);
  86         MIDI::channel_t get_control_channel () { return control_channel; }
  87         MIDI::eventType get_control_type () { return control_type; }
  88         MIDI::byte get_control_additional () { return control_additional; }
  89
  90   private:
  91
  92         int max_value_for_type () const;
  93
  94         PBD::Controllable* controllable;
  95         PBD::ControllableDescriptor* _descriptor;
  96         std::string        _current_uri;
  97         MIDI::Port&     _port;
  98         bool             setting;
  99         int              last_value;
 100         float            last_controllable_value;
 101         bool            _momentary;
 102         bool            _is_gain_controller;
 103         bool            _learned;
 104         int              midi_msg_id;      /* controller ID or note number */
 105         PBD::ScopedConnection midi_sense_connection[2];
 106         PBD::ScopedConnection midi_learn_connection;
 107         /** the type of MIDI message that is used for this control */
 108         MIDI::eventType  control_type;
 109         MIDI::byte       control_additional;
 110         MIDI::channel_t  control_channel;
 111         std::string     _control_description;
 112         bool             feedback;
 113         uint32_t        _rid;
 114         std::string     _what;
 115         bool            _bank_relative;
 116
 117         void midi_receiver (MIDI::Parser &p, MIDI::byte *, size_t);
 118         void midi_sense_note (MIDI::Parser &, MIDI::EventTwoBytes *, bool is_on);
 119         void midi_sense_note_on (MIDI::Parser &p, MIDI::EventTwoBytes *tb);
 120         void midi_sense_note_off (MIDI::Parser &p, MIDI::EventTwoBytes *tb);
 121         void midi_sense_controller (MIDI::Parser &, MIDI::EventTwoBytes *);
 122         void midi_sense_program_change (MIDI::Parser &, MIDI::byte);
 123         void midi_sense_pitchbend (MIDI::Parser &, MIDI::pitchbend_t);
 124 };
 125
 126 #endif // __gm_midicontrollable_h__
 127