params.h

/*
  $Id: params.h 3623 2009-09-25 11:14:32Z leighsmith $
  Defined In: The MusicKit

  Description:
    This file defines the MusicKit MKNote parameters. You can also create your
    own parameters using the MKNote method +parTagForName:. When an unrecognized
    parameter is found in a scorefile, it is created automatically.

    These parameters are not recognized by all MKSynthPatches. You must check
    the class description (or header file) for the individual MKSynthPatch to
    determine the parameters to which it responds.

  Original Author: David 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 Stanford University.
  Portions Copyright (c) 1999-2005, The MusicKit Project.
*/
#ifndef __MK_params_H___
#define __MK_params_H___

typedef enum _MKPars {
    MK_noPar = 0,          
    /* MIDI opcodes are represented by the presence of one of the following
       12 parameters, along with the noteType */

    MK_keyPressure,     
    MK_afterTouch,      
    MK_controlChange,   
    MK_pitchBend,       
    MK_programChange,   
    MK_timeCodeQ,       
    MK_songPosition,    
    MK_songSelect,      
    MK_tuneRequest,     
    MK_sysExclusive,    
    MK_chanMode,        
    MK_sysRealTime,     
    /* The remaining MIDI parameters provide additional data needed to
       represent MIDI messages. */

    MK_basicChan,       
    MK_controlVal,      
    MK_monoChans,       
    /* The following are derived from MIDI but are used extensively in 
       MKOrchestra synthesis as well. Most MKSynthPatches support them. */

    MK_velocity,        
    MK_relVelocity,     
    MK_keyNum,          
    MK_velocitySensitivity,   
    MK_afterTouchSensitivity, 
    MK_modWheelSensitivity,   
    MK_breathSensitivity,     
    MK_footSensitivity,       
    MK_portamentoSensitivity, 
    MK_balanceSensitivity,    
    MK_panSensitivity,        
    MK_expressionSensitivity, 
    MK_pitchBendSensitivity,  
    /* The following are basic synthesis parameters, which should be 
       supported by all MKSynthPatch classes, if possible.  */ 

    MK_freq,          
    MK_amp,           
    MK_bearing,       
    MK_bright,        
    MK_portamento,    
    /* The following are supported by oscillator-based MKSynthPatch classes. */

    MK_waveform,        
    MK_waveLen,         
    MK_phase,           
    /* The following are supported by MKSynthPatch classes which use
       frequency modulation synthesis.  Parameters are predefined
       for three carriers and four modulators, enough to emulate
       the patches on 4-operator fm synthesizers.  For fm instruments, 
       the brightness parameter is usually a synonym for one or more of 
       the modulator indices. */
       
    MK_cRatio,        
    MK_c2Ratio,       
    MK_c2Amp,         
    MK_c2Waveform,    
    MK_c2Phase,       
    MK_c3Ratio,       
    MK_c3Amp,         
    MK_c3Waveform,    
    MK_c3Phase,       
    MK_m1Ratio,       
    MK_m1Ind,         
    MK_m1Waveform,    
    MK_m1Phase,       
    MK_m2Ratio,       
    MK_m2Ind,
    MK_m2Waveform,        
    MK_m2Phase,
    MK_m3Ratio,       
    MK_m3Ind,
    MK_m3Waveform,
    MK_m3Phase,
    MK_m4Ratio,       
    MK_m4Ind,
    MK_m4Waveform,
    MK_m4Phase,
    MK_feedback,      
    /* The following are recognized by the Pluck MKSynthPatch */

    MK_pickNoise,     
    MK_decay,         
    MK_sustain,       
    MK_lowestFreq,    
    /* The following vibrato parameters are supported by MKSynthPatches
       that allow vibrato of various kinds */

    MK_svibFreq,       
    MK_svibAmp,        
    MK_rvibFreq,       
    MK_rvibAmp,        
    MK_indSvibFreq,    
    MK_indSvibAmp,     
    MK_indRvibFreq,    
    MK_indRvibAmp,     
    /* A noise generator may play a role in some MKSynthPatches to create
       special effects or increase realism.  The following predefined 
       parameters are useful in these cases. Note that for MKSynthPatches where
       the noise generator is the primary source of sound (as in Pluck),
       the standard parameters MK_amp and MK_freq are used instead of 
       these parameters. */

    MK_noiseAmp,     
    MK_noiseFreq,    
    /* The following are commonly-used envelope parameters, which may be 
       supported by some MKSynthPatch classes.  Note that there are several
       alternative ways to use envelopes, among them:
       
     <ul>
       <li>Specify the desired values directly as the y values of the envelope.</li>  
       <li>Do the same, scaling by a normalized constant scaler.</li>
       <li>Do the same, adding a constant to the results.</li>
       <li>Normalize the envelope values, and multiply times a constant scaler.</li>
       <li>Do the same, adding a constant to the results.</li>
       <li>Use the envelope to interpolate between two specific values.</li>
     </ul>
      
       The MKSynthPatches provided with the MusicKit allow all of the above 
       situations for parameters which support envelopes, depending on what
       is supplied in the parameter list.  If a parameter is specified as a
       single value, that value is used.  If an envelope is supplied but no
       value, the envelope values are used directly.  If both are
       supplied, the envelope is scaled by the numeric value to produce the
       resulting values.  If two values and an envelope are supplied, the 
       resulting values are the first value plus the difference of the two 
       values times the envelope values (i.e., interpolation).  In other words
       
           <tt>frequency(t) == freq0 + (freq1 - freq0) * envelope(t)</tt>
      
       where freq0 defaults to 0, freq1 defaults to 1, and the envelope
       defaults to a constant value of 1.
      
    */ 

    MK_freqEnv,      
    MK_freq0,        
    MK_freqAtt,      
    MK_freqRel,      
    MK_ampEnv,       
    MK_amp0,         
    MK_ampAtt,       
    MK_ampRel,       
    MK_bearingEnv,   
    MK_bearing0,     
    MK_brightEnv,    
    MK_bright0,      
    MK_brightAtt,    
    MK_brightRel,    
    MK_waveformEnv,  
    MK_waveform0,    
    MK_waveformAtt,  
    MK_waveformRel,  
    /* Additional parameters needed for fm envelopes. */
    
    MK_c2AmpEnv,     
    MK_c2Amp0,       
    MK_c2AmpAtt,     
    MK_c2AmpRel,     
    MK_c3AmpEnv,     
    MK_c3Amp0,       
    MK_c3AmpAtt,     
    MK_c3AmpRel,     
    MK_m1IndEnv,     
    MK_m1Ind0,       
    MK_m1IndAtt,     
    MK_m1IndRel,     
    MK_m2IndEnv,     
    MK_m2Ind0,
    MK_m2IndAtt,    
    MK_m2IndRel,    
    MK_m3IndEnv,     /* etc. */
    MK_m3Ind0,
    MK_m3IndAtt,    
    MK_m3IndRel,    
    MK_m4IndEnv,
    MK_m4Ind0,
    MK_m4IndAtt,    
    MK_m4IndRel,

    /* Additional parameters needed when applying envelopes to vibrato */
               
    MK_svibFreqEnv,
    MK_svibFreq0,       
    MK_rvibFreqEnv,
    MK_rvibFreq0,       
    MK_indSvibFreqEnv,
    MK_indSvibFreq0,    
    MK_indRvibFreqEnv,
    MK_indRvibFreq0,    
    MK_svibAmpEnv,
    MK_svibAmp0,        
    MK_rvibAmpEnv,
    MK_rvibAmp0,        
    MK_indSvibAmpEnv,
    MK_indSvibAmp0,     
    MK_indRvibAmpEnv,
    MK_indRvibAmp0,     
    MK_noiseAmpEnv,
    MK_noiseAmp0,       
    MK_noiseAmpAtt,     
    MK_noiseAmpRel,
    MK_noiseFreqEnv,
    MK_noiseFreq0,      
    /* The following are currently not supported explicitly by any Musickit 
       class. However, by convention, they may appear in MKPart info notes to 
       associate information with a MKPart. */

    MK_synthPatch,        
    MK_synthPatchCount,   
    MK_midiChan,          
    MK_track,             
    /* The following are currently not supported explicitly by any Musickit 
       class. However, by convention, they may appear in MKScore info notes to 
       associate information with a MKScore. */

    MK_title,            
    MK_samplingRate,     
    MK_headroom,         
    MK_tempo,            
    MK_vibWaveform,      
    /* The following parameters are used primarily in reading/writing Standard 
       MIDI files. See Standard MIDI file 1.0 Specification for details. */
    MK_sequence,         
    MK_text,             
    MK_copyright,        
    MK_lyric,            
    MK_marker,           
    MK_cuePoint,         
    MK_smpteOffset,      
    MK_timeSignature,    
    MK_keySignature,     
    MK_instrumentName,   
    MK_restDur,          

    MK_alternativeSamplingRate, 
    MK_orchestraIndex,   
    MK_filename,         
    MK_privatePars,      
    MK_appPars  = 192    
  } MKPar;

/* The following synonym parameters are defined for the sake of clarity.
   When envelopes are used, the "1" suffix parameter is used to indicate
   the value when the envelope is at 1.  The "0" suffix parameter indicates
   the value when the envelope is at 0.  */
   
#define MK_freq1        MK_freq
#define MK_amp1         MK_amp
#define MK_bright1      MK_brightness
#define MK_bearing1     MK_bearing
#define MK_waveform1    MK_waveform
#define MK_c1Ratio      MK_cRatio
#define MK_c1Amp        MK_amp
#define MK_c1AmpAtt     MK_ampAtt
#define MK_c1AmpRel     MK_ampRel
#define MK_c1Waveform   MK_waveform
#define MK_c1Phase      MK_phase
#define MK_c1Amp1       MK_c1Amp
#define MK_c2Amp1       MK_c2Amp
#define MK_c3Amp1       MK_c3Amp
#define MK_m1Ind1       MK_m1Ind
#define MK_m2Ind1       MK_m2Ind
#define MK_m3Ind1       MK_m3Ind
#define MK_m4Ind1       MK_m4Ind
#define MK_svibFreq1    MK_svibFreq
#define MK_rvibFreq1    MK_rvibFreq
#define MK_indSvibFreq1 MK_indSvibFreq
#define MK_indRvibFreq1 MK_indRvibFreq
#define MK_svibAmp1     MK_svibAmp
#define MK_rvibAmp1     MK_rvibAmp
#define MK_indSvibAmp1  MK_indSvibAmp
#define MK_indRvibAmp1  MK_indRvibAmp
#define MK_noiseAmp1    MK_noiseAmp
#define MK_noiseFreq1   MK_noiseFreq

/* Some default parameter values */

#define MK_DEFAULTAMP        0.1
#define MK_DEFAULTSMOOTHING  1.0     /* Used by MKEnvelope */
#define MK_DEFAULTBRIGHT     0.5     
#define MK_DEFAULTFREQ       440.0
#define MK_DEFAULTPORTAMENTO 0.1
#define MK_DEFAULTCRATIO     1.0
#define MK_DEFAULTMRATIO     1.0
#define MK_DEFAULTINDEX      2.0
#define MK_DEFAULTSVIBFREQ   4.0
#define MK_DEFAULTSVIBAMP    0.01
#define MK_DEFAULTRVIBFREQ   15.0
#define MK_DEFAULTRVIBAMP    0.008
#define MK_DEFAULTBEARING    0.0
#define MK_DEFAULTSUSTAIN    0.0     /* Used by Pluck */
#define MK_DEFAULTDECAY      0.0     /* Used by Pluck */
#define MK_DEFAULTVELOCITY   64

typedef enum _MKMidiParVal {  /* The order of these is taken from MIDI spec. */
    MK_resetControllers = 262,
    MK_localControlModeOn, 
    MK_localControlModeOff,
    MK_allNotesOff,    
    MK_omniModeOff,
    MK_omniModeOn,
    MK_monoMode,
    MK_polyMode,
    MK_sysClock,
    MK_sysUndefined0xf9,
    MK_sysStart,
    MK_sysContinue,
    MK_sysStop,
    MK_sysUndefined0xfd,
    MK_sysActiveSensing,
    MK_sysReset
} MKMidiParVal;

#endif

---