RtMidi.h

Go to the documentation of this file.

/**********************************************************************/
/**********************************************************************/

// RtMidi: Version 1.0.7

#ifndef RTMIDI_H
#define RTMIDI_H

#include "RtError.h"
#include <string>

class RtMidi
{
 public:

  virtual void openPort( unsigned int portNumber = 0 ) = 0;

  virtual void openVirtualPort( const std::string portName = std::string( "RtMidi" ) ) = 0;

  virtual unsigned int getPortCount() = 0;

  virtual std::string getPortName( unsigned int portNumber = 0 ) = 0;

  virtual void closePort( void ) = 0;

 protected:

  RtMidi();
  virtual ~RtMidi() {};

  // A basic error reporting function for internal use in the RtMidi
  // subclasses.  The behavior of this function can be modified to
  // suit specific needs.
  void error( RtError::Type type );

  void *apiData_;
  bool connected_;
  std::string errorString_;
};

/**********************************************************************/
/**********************************************************************/

#include <vector>
#include <queue>

class RtMidiIn : public RtMidi
{
 public:

  typedef void (*RtMidiCallback)( double timeStamp, std::vector<unsigned char> *message, void *userData);


  RtMidiIn();

  ~RtMidiIn();


  void openPort( unsigned int portNumber = 0 );


  void openVirtualPort( const std::string portName = std::string( "RtMidi Input" ) );


  void setCallback( RtMidiCallback callback, void *userData = 0 );


  void cancelCallback();

  void closePort( void );

  unsigned int getPortCount();


  std::string getPortName( unsigned int portNumber = 0 );


  void setQueueSizeLimit( unsigned int queueSize );


  void ignoreTypes( bool midiSysex = true, bool midiTime = true, bool midiSense = true );


  double getMessage( std::vector<unsigned char> *message );

  // A MIDI structure used internally by the class to store incoming
  // messages.  Each message represents one and only one MIDI message.
  struct MidiMessage { 
    std::vector<unsigned char> bytes; 
    double timeStamp;

    // Default constructor.
    MidiMessage()
      :bytes(3), timeStamp(0.0) {}
  };

  // The RtMidiInData structure is used to pass private class data to
  // the MIDI input handling function or thread.
  struct RtMidiInData {
    std::queue<MidiMessage> queue;
    unsigned int queueLimit;
    unsigned char ignoreFlags;
    bool doInput;
    bool firstMessage;
    void *apiData;
    bool usingCallback;
    void *userCallback;
    void *userData;

    // Default constructor.
    RtMidiInData()
      : queueLimit(1024), ignoreFlags(7), doInput(false), firstMessage(true),
        apiData(0), usingCallback(false), userCallback(0), userData(0) {}
  };

 private:

  void initialize( void );
  RtMidiInData inputData_;

};

/**********************************************************************/
/**********************************************************************/

class RtMidiOut : public RtMidi
{
 public:


  RtMidiOut();

  ~RtMidiOut();


  void openPort( unsigned int portNumber = 0 );

  void closePort();


  void openVirtualPort( const std::string portName = std::string( "RtMidi Output" ) );

  unsigned int getPortCount();


  std::string getPortName( unsigned int portNumber = 0 );


  void sendMessage( std::vector<unsigned char> *message );

 private:

  void initialize( void );
};

#endif