MKMidi.h

/*
  $Id: MKMidi.h 3519 2009-04-18 09:23:57Z leighsmith $
  Defined In: The MusicKit

  Description: 
    The MKMidi object provides MIDI input/output access. It emulates some of the
    behavior of a MKPerformer: It contains a NSMutableArray of MKNoteSenders, one per MIDI
    channel (as well as an extra one for MIDI system and channel mode messages).
    You can receive MKNotes derived from MIDI input by connecting an MKInstrument's
    MKNoteReceivers to the MKNoteSenders of a MKMidi instance.
   
    Similarly, MKMidi emulates some of the behavior of an MKInstrument: It contains
    an array of MKNoteReceivers, one per MIDI channel (as well as the extra one).
    You can send MKNotes to MIDI output by connecting a MKPerformer's MKNoteSenders
    to the MKNoteReceivers of a MKMidi instance.
   
    However, the MKMidi object is unlike a MKPerformer in that it represents a 
    real-time  device. In this manner, MKMidi is somewhat like MKOrchestra, 
    which represents the DSP. The protocol for controlling MKMidi is the same 
    as that for the MKOrchestra. This protocol is described in the file 
    <MusicKit/MKDeviceStatus.h>.
    
    The conversion between MusicKit and MIDI semantics is described in the
    MusicKit documentation.

  Original Author: David A. Jaffe

  Copyright (c) 1988-1992, NeXT Computer, Inc.
  Portions Copyright (c) 1994 NeXT Computer, Inc. and reproduced under license from NeXT
  Portions Copyright (c) 1994 CCRMA, Stanford University
  Portions (Time code extensions) Copyright (c) 1993 Pinnacle Research
  Portions Copyright (c) 1999-2000, The MusicKit Project.
*/
@class MKConductor;

#ifndef __MK_Midi_H___
#define __MK_Midi_H___

#import <Foundation/NSObject.h>
#import <MKPerformSndMIDI/PerformMIDI.h>
#import "MKDeviceStatus.h"
#import "params.h"
#import "_midi.h"  // for _MKMidiInStruct and _MKMidiOutStruct definitions

/* sbrandon: 10/05/2001
 * get around the fact that GNUstep does not have NSMach ports, but does respond to -machPort
 * and +portWithMachPort
 */
#ifdef GNUSTEP
#define NSMachPort NSPort
#endif

@interface MKMidi: NSObject
{
    NSMutableArray *noteSenders;         
    NSMutableArray *noteReceivers;       
    MKDeviceStatus deviceStatus;         
    NSString *midiDevName;               
    BOOL useInputTimeStamps;             
    BOOL outputIsTimed;                  
    double localDeltaT;                  
@private
    /* systemIgnoreBits A bit map indicating which MIDI system messages to ignore from input */
    unsigned int systemIgnoreBits;
    _MKMidiInStruct *_pIn;               // determines input source
    _MKMidiOutStruct *_pOut;             // determines output sink
    double timeOffset;
    enum MKMidiDirection {MKMidiInputOnly, MKMidiOutputOnly, MKMidiInputOutput} ioMode; 
    BOOL isOwner;
    // These are handles used to identify the MIDI communication channel.
    // We pretend they are Mach-like ports even though they function only as references.
    MKMDPort devicePort;         // Device port
    MKMDOwnerPort ownerPort;     // Owner port, as for the device port.
    MKMDReplyPort recvPort;      // Port on which we receive midiIn messages
    MKMDReplyPort queuePort;     // Port on which we notify when there is space on the playback queue.
    BOOL mergeInput;
    NSString *hostname;          // for MIDI communicated across hosts.
    int inputUnit;
    int outputUnit;
    int queueSize;
    MKConductor *conductor;      // Used by conductor and setConductor: methods
    MKConductor *synchConductor;
    NSMachPort *exceptionPort;   // Exception port.  Only one unit per device may have one.
    NSMachPort *alarmPort;       // Alarm port.  Only one unit per device may have one.
    MKMidi *mtcMidiObj;
    BOOL displayReceivedMIDI;
    double alarmTime;
    int intAlarmTime;
    BOOL alarmTimeValid;
    BOOL alarmPending;
}

#define MK_MAXMIDIS 16  /* Maximum number of Intel-based Midi objects */

- (MKConductor *) conductor;

- setConductor: (MKConductor *) aConductor;

+ midiOnDevice: (NSString *) devName host: (NSString *) hostName;

+ midiOnDevice: (NSString *) devName;
 /* Allocates and initializes a new object, if one doesn't exist already, for
    specified device. 
    For the NeXT hardware, "midi1" is serial port B and "midi0" is port A.
    For Intel hardware, "midi0" corresponds to MIDI0 in the defaults
    data base, "midi1" corresponds to MIDI1, etc.  You may also specify the
    driver/unit name explicitly as "Mididriver0", "Mididriver1", etc., in 
    which case no indirection via the defaults data base is done.
  */


+ midi;

- initOnDevice: (NSString *) devName hostName: (NSString *) hostName;

- initOnDevice: (NSString *) devName;

- init;

- (void) dealloc;

- (MKDeviceStatus) deviceStatus;

- open;

- openInputOnly;

- openOutputOnly;

- run;

- stop;

- (void) close;

- abort;

- setOutputTimed: (BOOL) yesOrNo;

- (BOOL) outputIsTimed;

- (MKNoteSender *) channelNoteSender: (unsigned) channel;

- (MKNoteReceiver *) channelNoteReceiver: (unsigned) channel;

- (MKNoteReceiver *) noteReceiver;

- (NSArray *) noteReceivers;

- (MKNoteSender *) noteSender;

- (NSArray *) noteSenders;
  
/* sb: added 30/6/98 to replace MidiIn function */
- (void) handleMachMessage: (void *) machMessage;

- setUseInputTimeStamps: (BOOL) yesOrNo;

- (BOOL) useInputTimeStamps;

- ignoreSys: (MKMidiParVal) param;

- acceptSys: (MKMidiParVal) param;

- (double) localDeltaT;

- setLocalDeltaT: (double) value;

- setMergeInput: (BOOL) yesOrNo;

- awaitQueueDrain;

- allNotesOffBlast;

- allNotesOff;

- (double) time;

- getMTCFormat: (short *) format
         hours: (short *) h
           min: (short *) m
           sec: (short *) s
        frames: (short *) f;

- synchConductor;

+ (NSArray *) getDriverNames;

+ (NSArray *) getDriverNamesForInput;

+ (NSArray *) getDriverNamesForOutput;

- (NSString *) driverName;

- (NSString *) description;

- (void) downloadDLS: (NSArray *) dlsPatches;

@end

#endif

---