ArielQP.h

/*
  $Id: ArielQP.h 3287 2005-05-27 09:52:26Z leighsmith $
  Defined In: The MusicKit

  Description:
    See the discussion below. With the demise of the QuintProcessor board (and NeXT hardware),
    this class becomes an example of multiple DSP operation. In theory it still works.
    
    This class is the MKOrchestra that represents the Quint Processor "hub"
    (or "master") DSP.  Creating an instance of ArielQP also creates the
    associated "satellite" DSPs ("sat" for short).  These are also called
    "slave" DSPs.  Note, however, that sending -open (or -run, etc.) to the ArielQP
    opens (or whatever) only the hub orchestra.   To send a messge to all the 
    satellite DSPs for this QuintProcessor, invoke the method makeSatellitesPerform:.
    Example:  [anArielQP makeSatellitesPerform:@selector(open)];  To send to all
    the DSPs for the QP, invoked makeQPPerform:.

    You may control whether sound from the satellite DSPs is brought into the
    hub DSP.  To control whether such sound is included or excluded, send 
    setSatSoundIn:.  The defualt is to include it.  Excluding it
    saves processing power on the hub, but means that the satellites will be useless,
    unless they send their sound out their serial port.

    If the satellite sound is included, it can be accessed via the In1qpUG MKUnitGenerator.
    Each instance of this unit generator takes sound from a particular channel on
    a particular DSP.  Note that you may have any number of these so that you can
    have multiple effects applied to the sound coming from a single source.

    For the common case of simply mixing each satellite to the output sample stream,
    a MKSynthPatch called ArielQPMix is provided in the Music Kit MKSynthPatch Library.
    This MKSynthPatch needs only to be allocated to work.   Be sure to deallocate it 
    before closing the MKOrchestra.
    
    FIXME: DRAM allocation

  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 Copyright (c) 1999-2001, The MusicKit Project.
*/
/*
  $Log$
  Revision 1.8  2005/05/27 09:52:25  leighsmith
  Added constants and types doxygen comments from old RTF doco

  Revision 1.7  2005/05/22 07:34:06  leighsmith
  Corrected and updated headerdoc

  Revision 1.6  2005/05/09 15:52:49  leighsmith
  Converted headerdoc comments to doxygen comments

  Revision 1.5  2001/09/07 00:12:52  leighsmith
  Corrected naming of satellite class

  Revision 1.4  2001/09/06 21:27:47  leighsmith
  Merged RTF Reference documentation into headerdoc comments and prepended MK to any older class names

  Revision 1.3  2000/03/31 00:16:44  leigh
  TODOs have become more standard FIXMEs

  Revision 1.2  1999/07/29 01:25:41  leigh
  Added Win32 compatibility, CVS logs, SBs changes

*/
#ifndef __MK_ArielQP_H___
#define __MK_ArielQP_H___

#import "MKOrchestra.h"
#import "MKSynthData.h"

#define MK_DRAM_ZERO 0           /* Use first sample as a ZERO */

#define MK_DRAM_SINK 1           /* Use second sample as a SINK */

@interface ArielQP: MKOrchestra
{
    int slot;         /* One of 2, 4 or 6 */
    BOOL satSoundIn;  /* YES if we're receiving sound from the satellites */
    BOOL DRAMAutoRefresh; /* YES if we're refreshing when needed */
    MKSynthData *_satSynthData; /* Buffers for incoming sound data */
    BOOL _initialized;
    NSDate * _reservedArielQP1; //sb: was double
}

+new;

+newInSlot:(unsigned short)slot;

-satellite:(char)which;

-setSatSoundIn:(BOOL)yesOrNo;
/* Controls whether sound is obtained from the satellites. Default is YES. */


- setDRAMAutoRefresh:(BOOL)yesOrNo;
/* Controls whether DRAM auto refresh is on.  Default is off. */


-(BOOL)DRAMAutoRefresh;

-(BOOL)satSoundIn;

-makeSatellitesPerform:(SEL)selector;

-makeSatellitesPerform:(SEL)selector with: (id) arg;

-makeQPPerform:(SEL)selector;

- makeQPPerform: (SEL) selector with: (id) arg;

- setDRAMAutoRefresh:(BOOL)yesOrNo;

@end

#import "MusicKit.h"

@interface ArielQPSat:MKOrchestra
{
    BOOL hubSoundOut; /* YES if we're sending sound to the hub. */
    NSDate * _reservedArielQPSat1; //sb: changed from double
}


-hub;

-setHubSoundOut:(BOOL)yesOrNo;
/* Default is YES. Setting hubSoundOut disables serialSoundOut.  
 * Must be invoked when the deviceStatus is closed.
 */


-(BOOL)hubSoundOut;

-(int)outputChannelOffset;

-(int)outputChannelCount;

-(int)outputInitialOffset;

-(BOOL)upSamplingOutput;

-(BOOL)isRealTime;
/* 
 * For all of these methods:
 * if hubSoundOut, forwards message to hubOrchestra.  Otherwise,
 * invokes superclass implementation.
 */


-setSerialSoundOut:(BOOL)yesOrNo;

@end

#endif

---