libs/surfaces/generic_midi/midifunction.h

   1 /*
   2     Copyright (C) 2009 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_midifunction_h__
  21 #define __gm_midifunction_h__
  22
  23 #include <string>
  24
  25 #include "midi++/types.h"
  26
  27 #include "pbd/signals.h"
  28 #include "pbd/stateful.h"
  29
  30 #include "ardour/types.h"
  31
  32 #include "midiinvokable.h"
  33
  34 namespace MIDI {
  35         class Channel;
  36         class Port;
  37         class Parser;
  38 }
  39
  40 class GenericMidiControlProtocol;
  41
  42 class MIDIFunction : public MIDIInvokable
  43 {
  44   public:
  45         enum Function {
  46                 NextBank,
  47                 PrevBank,
  48                 TransportRoll,
  49                 TransportStop,
  50                 TransportZero,
  51                 TransportStart,
  52                 TransportEnd,
  53                 TransportLoopToggle,
  54                 TransportRecordEnable,
  55                 TransportRecordDisable
  56         };
  57
  58         MIDIFunction (MIDI::Port&);
  59         virtual ~MIDIFunction ();
  60
  61         int init (GenericMidiControlProtocol&, const std::string& function_name, MIDI::byte* sysex = 0, size_t ssize = 0);
  62
  63         const std::string& function_name() const { return _invokable_name; }
  64
  65         XMLNode& get_state (void);
  66         int set_state (const XMLNode&, int version);
  67
  68   private:
  69         Function        _function;
  70         void execute ();
  71 };
  72
  73 #endif // __gm_midicontrollable_h__
  74