PerformMIDI.h

/*
  $Id: PerformMIDI.h 3281 2005-05-22 07:33:05Z leighsmith $
  Defined In: The MusicKit

  Description:
    MIDI driver typedefs, defines, and functions exported to other MusicKit frameworks.
    See the HeaderDoc header below.

  Original Author: Leigh M. Smith, <leigh@leighsmith.com>

  Copyright (c) 2000-2004 The MusicKit Project.

  Permission is granted to use and modify this code for commercial and non-commercial
  purposes so long as the author attribution and this copyright message remains intact
  and accompanies all derived code.
*/
#ifndef _MKMD_
#define _MKMD_

/* We #include this file regardless of the setting of
   HAVE_CONFIG_H so that other applications compiling against this
   header don't have to define it. If you are seeing errors for
   MKPerformSndMIDIConfig.h not found, you haven't run ./configure 
 */
#include "MKPerformSndMIDIConfig.h"
#include <objc/objc.h> /* for BOOL */

/* kludge around type definitions. This should be replaced. */
typedef int kern_return_t;
typedef int msg_header_t;
typedef int boolean_t;

#define MKMDPort int

#define MKMDOwnerPort int

#define MKMDReplyPort int

typedef int MKMDReturn;

#define MKMD_RECEPTION_USING_PORTS 0

#define MKMD_PORT_NULL 0

/* Each event consists of a byte and a time stamp. */
typedef struct {
    int time;
    unsigned char byte;
} MKMDRawEvent;

typedef MKMDRawEvent *MKMDRawEventPtr;

#define MKMD_MAX_EVENT 100

#define MKMD_MAX_MSG_SIZE 1024  // More than enough

#define MKMD_CLOCK_MODE_INTERNAL 0

#define MKMD_CLOCK_MODE_MTC_SYNC 1

/* error codes */
#define MKMD_SUCCESS 0

/* error codes */
#define MKMD_ERROR_BUSY 100
#define MKMD_ERROR_NOT_OWNER 101
#define MKMD_ERROR_QUEUE_FULL 102
#define MKMD_ERROR_BAD_MODE 103
#define MKMD_ERROR_UNIT_UNAVAILABLE 104
#define MKMD_ERROR_ILLEGAL_OPERATION 105
#define MKMD_ERROR_UNKNOWN_ERROR 106

/* exception codes */
#define MKMD_EXCEPTION_MTC_STOPPED 1
#define MKMD_EXCEPTION_MTC_STARTED_FORWARD 2
#define MKMD_EXCEPTION_MTC_STARTED_REVERSE 3

/* Defines for system ignores. */
#define MKMD_IGNORE_CLOCK        0x0100
#define MKMD_IGNORE_START        0x0400
#define MKMD_IGNORE_CONTINUE     0x0800
#define MKMD_IGNORE_STOP         0x1000
#define MKMD_IGNORE_ACTIVE       0x4000
#define MKMD_IGNORE_RESET        0x8000
#define MKMD_IGNORE_REAL_TIME    0xdd00  /* All of the above */

#define MKMD_PORT_A_UNIT 0

#define MKMD_PORT_B_UNIT 1

/* Reply function types. */
typedef void (*MKMDDataReplyFunction)
    (MKMDReplyPort replyPort, short unit, MKMDRawEvent *events, unsigned int count);

typedef void (*MKMDAlarmReplyFunction)
    (MKMDReplyPort replyPort, int requestedTime, int actualTime);

typedef void (*MKMDExceptionReplyFunction)
    (MKMDReplyPort replyPort, int exception);

typedef void (*MKMDQueueReplyFunction)
    (MKMDReplyPort replyPort, short unit);

typedef struct _MKMDReplyFunctions {
    MKMDDataReplyFunction dataReply;
    MKMDAlarmReplyFunction alarmReply;
    MKMDExceptionReplyFunction exceptionReply;
    MKMDQueueReplyFunction queueReply;
} MKMDReplyFunctions;

PERFORM_API char *MKMDErrorString(MKMDReturn errorCode);

PERFORM_API MKMDPort
    MKMDGetMIDIDeviceOnHost(const char *hostname);

/******* Managing ownership of the driver ********/
PERFORM_API MKMDReturn 
    MKMDBecomeOwner(MKMDPort mididriver_port, MKMDOwnerPort owner_port);

PERFORM_API MKMDReturn 
    MKMDReleaseOwnership(MKMDPort mididriver_port, MKMDOwnerPort owner_port);


/*** Claiming a particular serial port (ownership of driver required) *****/
PERFORM_API MKMDReturn 
    MKMDClaimUnit(BOOL input, MKMDPort driver, MKMDOwnerPort owner, short unit);

PERFORM_API MKMDReturn 
    MKMDReleaseUnit(BOOL input, MKMDPort driver, MKMDOwnerPort owner, short unit);

/******** Controlling the clock ****************/

PERFORM_API MKMDReturn 
    MKMDSetClockMode(MKMDPort driver, MKMDOwnerPort owner, short synchUnit, int mode);

PERFORM_API MKMDReturn 
    MKMDSetClockQuantum(MKMDPort driver, MKMDOwnerPort owner, int microseconds);

PERFORM_API MKMDReturn 
    MKMDSetClockTime(MKMDPort driver, MKMDOwnerPort owner, int time);

PERFORM_API MKMDReturn 
    MKMDGetClockTime(MKMDPort driver, MKMDOwnerPort owner, int *time);

PERFORM_API MKMDReturn 
    MKMDGetMTCTime(MKMDPort driver, MKMDOwnerPort owner, short *format, short *hours, short *minutes, short *seconds, short *frames);

PERFORM_API MKMDReturn 
    MKMDStartClock(MKMDPort driver, MKMDOwnerPort owner);

PERFORM_API MKMDReturn 
    MKMDStopClock(MKMDPort driver, MKMDOwnerPort owner);


/****************** Requesting asynchronous messages *******************/

PERFORM_API MKMDReturn 
    MKMDRequestData(MKMDPort driver, MKMDOwnerPort owner, short unit, MKMDReplyPort replyPort);

PERFORM_API MKMDReturn 
    MKMDRequestAlarm(MKMDPort driver, MKMDOwnerPort owner, MKMDReplyPort replyPort, int time);

PERFORM_API MKMDReturn 
    MKMDRequestExceptions(MKMDPort driver, MKMDOwnerPort owner, MKMDReplyPort exceptionPort);

PERFORM_API MKMDReturn 
    MKMDRequestQueueNotification(MKMDPort driver, MKMDOwnerPort owner, short unit, MKMDReplyPort notificationPort, int size);

/****************** Receiving asynchronous messages *******************/

PERFORM_API MKMDReturn 
    MKMDAwaitReply(MKMDReplyPort ports, MKMDReplyFunctions *funcs, int timeout);

#define MKMD_NO_TIMEOUT (-1)

PERFORM_API MKMDReturn 
    MKMDHandleReply(msg_header_t *msg, MKMDReplyFunctions *funcs);

PERFORM_API MKMDReturn MKMDSetReplyCallback (
        MKMDPort mididriver_port,
        MKMDOwnerPort owner_port,
        short unit,
        void (*newCallbackFn)(void *),
        void *newCallbackParam);


/****************** Writing MKMD data to the driver *********************/

PERFORM_API MKMDReturn 
    MKMDSendData(MKMDPort driver, MKMDOwnerPort owner, short unit, MKMDRawEvent *data, unsigned int count);

PERFORM_API MKMDReturn 
    MKMDGetAvailableQueueSize(MKMDPort driver, MKMDOwnerPort owner, short unit, int *size);

PERFORM_API MKMDReturn 
    MKMDClearQueue(MKMDPort driver, MKMDOwnerPort owner, short unit);

PERFORM_API MKMDReturn 
    MKMDFlushQueue(MKMDPort device_port, MKMDOwnerPort owner_port, short unit);

PERFORM_API MKMDReturn 
    MKMDDownloadDLSInstruments(unsigned int *patches, int patchCount);

PERFORM_API const char **
    MKMDGetAvailableDrivers(BOOL inputDrivers, unsigned int *selectedDriver);

/********************* Controling how incoming data is formatted ***********/
PERFORM_API MKMDReturn 
    MKMDFilterMessage(MKMDPort driver, MKMDOwnerPort owner, short unit, unsigned char statusByte, boolean_t filterIt);

PERFORM_API MKMDReturn 
    MKMDParseInput(MKMDPort driver, MKMDOwnerPort owner, short unit, boolean_t parseIt);

PERFORM_API char *MKMDErrorString(MKMDReturn errorCode);

PERFORM_API MKMDReturn 
    MKMDSetSystemIgnores(MKMDPort driver, MKMDOwnerPort owner, short unit, unsigned int ignoreBits);


#endif /* _MKMD_ */

---