MKSamples.h

/*
  $Id: MKSamples.h 3449 2009-04-04 16:52:47Z leighsmith $
  Defined In: The MusicKit

  Description:
    A MKSamples object is a type of MKWaveTable that uses a Snd object (from
    the SndKit) as its data.  The Snd itself can only contain sampled
    data; each sample in the Snd corresponds to an array entry in the
    MKSamples object.  The Snd object can be set directly by invoking the
    method setSound:, or you can read it from a soundfile, through the
    readSoundfile: method.
   
    Note that the MKSamples object currently does not resample (except in
    one special case, when the sound is evenly divisible by the access
    length). Except in this special case, the length of the sound must be
    the same as the length you ask for with the access methods.
   
    Note also that for use with the MusicKit oscillator unit generators,
    the length must be a power of 2 and must fit in DSP memory (1024 or
    less is a good length).

   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 Stanford University.
   Portions Copyright (c) 1999-2001, The MusicKit Project.
*/
#ifndef __MK_Samples_H___
#define __MK_Samples_H___

#import "MKWaveTable.h"
#import <SndKit/SndKit.h>

@interface MKSamples : MKWaveTable
{
    Snd *sound;
    NSString *soundfile;
    SndAudioProcessorChain *audioProcessorChain;
    int tableType;
    int curLoc;
    double amplitude;
    double panBearing;
    unsigned int startSampleLoc;
    unsigned int lastSampleLoc;
}


- init;

 /* Frees the receiver and its instance variables.
  */
- (void) dealloc;

- copyWithZone: (NSZone *) zone;

- (BOOL) setSound: (Snd *) aSound; 

- (BOOL) readSoundfile: (NSString *) aSoundfile;

- (Snd *) sound;

- (NSString *) soundfile;

- writeScorefileStream: (NSMutableData *) aStream;
 /* 
  * A
  * MKSamples object is written by the name of the soundfile from which its
  * Snd was read, surrounded by braces:
  * 
  *   { "soundfileName" }
  * 
  */

- (void) encodeWithCoder: (NSCoder *) aCoder;

- (id) initWithCoder: (NSCoder *) aDecoder;

- (int) tableType;

- (void) setProcessingStartSample: (unsigned int) sampleNum;

- (unsigned int) processingStartSample;

- (void) setProcessingEndSample: (unsigned int) sampleNum;

- (unsigned int) processingEndSample;

- (unsigned int) currentSample;

- (void) setCurrentSample: (unsigned int) sampleNum;

- (double) amplitude;

- (void) setAmplitude: (double) amp;

- (void) setPanBearing: (double) newBearing;

- (double) panBearing;

- (SndAudioProcessorChain *) audioProcessorChain;

- setAudioProcessorChain: (SndAudioProcessorChain *) anAudioProcessorChain;

/* Private method that supports both OscTable and ExcitationTable */
- _fillTableLength: (int) aLength scale: (double) aScaling ;

@end

@interface MKSamples(OscTable)

- (DSPDatum *) dataDSPAsOscTableLength: (int) aLength;
 
- (double *) dataDoubleAsOscTableLength: (int) aLength;
 
 /* The following methods are minor variations of 
    dataDoubleAsOscTableScaling:length: and
    dataDSPAsOscTableScaling:length: and are implemented in terms 
    of them. They use default or previously specified length, scaling or both. 

    Same as corresponding superclass methods.
*/
- (DSPDatum *) dataDSPAsOscTable;

- (double *) dataDoubleAsOscTable;

- fillOscTableLength: (int) aLength scale: (double) aScaling;

- fillTableLength: (int) aLength scale:(double)aScaling ;

@end

@interface MKSamples(ExcitationTable)

- (DSPDatum *) dataDSPAsExcitationTableLength: (unsigned int) aLength scale: (double) aScaling;
 
- (double *) dataDoubleAsExcitationTableLength: (unsigned int) aLength scale: (double) aScaling;
 
 /* The following methods are minor variations of 
    dataDoubleAsExcitationTableScaling:length: and
    dataDSPAsExcitationTableScaling:length: and are implemented in terms 
    of them. They use default or previously specified length, scaling or both. 
    */

- (DSPDatum *) dataDSPAsExcitationTable;

- (DSPDatum *) dataDSPAsExcitationTableLength: (int) aLength;

- (DSPDatum *) dataDSPAsExcitationTableScale: (double) aScaling;

- (double *) dataDoubleAsExcitationTable;

- (double *) dataDoubleAsExcitationTableLength: (int) aLength;

- (double *) dataDoubleAsExcitationTableScale: (double) aScaling;

- fillExcitationTableLength: (int) aLength scale: (double) aScaling;

@end


#endif

---