libs/surfaces/mackie/dummy_port.h

   1 /*
   2         Copyright (C) 2008 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 dummy_port_h
  19 #define dummy_port_h
  20
  21 #include "surface_port.h"
  22
  23 #include "midi_byte_array.h"
  24
  25 namespace MIDI {
  26         class Port;
  27 }
  28
  29 namespace Mackie
  30 {
  31
  32 /**
  33         A Dummy Port, to catch things that shouldn't be sent.
  34 */
  35 class DummyPort : public SurfacePort
  36 {
  37 public:
  38         DummyPort();
  39         virtual ~DummyPort();
  40
  41         // when this is successful, active() should return true
  42         virtual void open();
  43
  44         // subclasses should call this before doing their own close
  45         virtual void close();
  46
  47         /// read bytes from the port. They'll either end up in the
  48         /// parser, or if that's not active they'll be returned
  49         virtual MidiByteArray read();
  50
  51         /// an easier way to output bytes via midi
  52         virtual void write( const MidiByteArray & );
  53
  54         virtual const MidiByteArray & sysex_hdr() const;
  55         virtual int strips() const;
  56 };
  57
  58 }
  59
  60 #endif