Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
_MKLeafUGStructThe MKLeafUGStruct struct represents the DSP statistics of a "leaf" MKUnitGenerator class. That is, it contains the information specific to a particular memory space combination. Its fields should not be altered. Their meaning is as follows:
_MKMsgStructMKMsgStruct is the structure that represents a message the MKConductor will send to an object
_MKOrchAddrStructThis struct fully-specifies an MKOrchestra (DSP) memory address
_MKOrchMemStructThis struct specifies the memory segments required for a MKUnitGenerator. It is also used to specify the relocation of a MKUnitGenerator. The fields are as follows:
_MKUGArgStructMKUGArgStruct is the structure that represents each DSP unit generator memory argument. All fields are private and should not be altered. The meaning of the fields is as follows:
Add2UGAdd2UG adds two patchpoints
Allpass1UGAllpass1UG is a first-order all-pass filter, useful for phase modifications
ArielProPortDSPSerialPortDevice subclass that corresponds to the Ariel ProPort ADC/DAC interface
ArielQPThe Ariel QuintProcessor is a board that fits into the NeXT cube. It features four "satellite" ("slave") DSPs with 16 or 32K of static RAM (SRAM), a hub DSP with 8K of SRAM, a bank of dynamic RAM (DRAM) a set of serial ports, two per DSP, and a SCSI chip. The Music Kit supports the DSPs, the DSP ports, and the DRAM. It does not currently support the SCSI
ArielQPMixMultiple DSP operation with the Ariel QuintProcessor board
ArielQPSatThe ArieQPSat objects are used to represent the QuintProcessor's satellite DSPs, one per instance of ArielQPSat. The satellite DSPs can either be used individually, sending their sound out their serial port (by sending the message setSerialSoundOut:YES) or they can be used as a group, sending their sound to the hub DSP (by sending the message setHubSoundOut:YES.) These two modes cannot be combined. Sending one message, automatically disables the other
AsympenvUGAsympenvUG is similar to AsympUG, except that it loads the entire envelope down to the DSP, providing better real-time performance
AsympUGAsympUG handles an MKEnvelope, passing it to the DSP one segment at a time and implementing asymptotic envelope segments
BiquadUGBiquadUG is a two-pole, two-zero filter useful for adding resonances
ConstantUGConstantUG simply writes a constant to its output patchpoint
DBFm1viLike Fm1vi, but supports the Timbre Data Base
DBWave1vLike Wave1v, but with access to the Timbre Data Base
DBWave1viLike Wave1vi, but with access to the Timbre Data Base
DBWave2viLike Wave1vi, but with two wavetables and interpolation between them
DelamyUGDelaymUG is similar to DelayUG, but it uses "modulo memory" and is more efficient than DelayUG
DelayqpUGDelayqpUG is similar to DelayUG, but it uses the Ariel QuintProcessor's DRAM memory to produce the delay
DelayUGDelayUG delays its input patchpoint signal by some amount, then writes it to its output patchpoint
DSPSerialPortDeviceCorresponds to a device that plugs into the DSP serial port. Instantiating an instance of the DSPSerialPortDevice class itself provides you with a serial port protocol that is used by many devices such as the Ariel Digital Microphone and the Metaresearch Digital Ears. For other devices that don't follow that protocol, or for access to "customization" commands, you may instantiate an instance of a subclass of DSPSerialPortDevice. The Music Kit provides a number of such subclasses:
DswitchtUGDswitchtUG is similar to DswitchUG, but its time is constrained to be a multiple of the tick size
DswitchUGDswitchUG switches between two inputs after a certain amount of time
EnvFollowUGEnvFollowUG derives an amplitude envelope from an input signal
Fm1Like Fm1i but with a non-interpolating (drop-sample) oscillator
Fm1iFM with arbitrary waveforms for carrier and modulator and an interpolating oscillator for the carrier
Fm1vLike Fm1vi but with a non-interpolating osc
Fm1viFM synthesis with 1 modulator, vibrato, interpolating carrier and arbitrary waveforms for carrier and modulator
Fm2cnviLike Fm2cvi, but with an additional noise modulator
Fm2cviLike Fm1vi, but has 2 modulators in cascade, vibrato, and interpolating carrier
Fm2pnviLike Fm2pvi, but with an additional noise modulator
Fm2pviLike Fm1vi, but has 2 modulators in parallel, vibrato, and interpolating carrier
In1aUGIn1aUG reads sound from the left channel of DSP serial port and writes it to its output patchpoint
In1bUGIn1bUG reads sound from the right channel of DSP serial port and writes it to its output patchpoint
In1qpUGIn1qpUG is useful when using the Ariel QuintProcessor - it provides the "hub" DSP with the signals from the "satellite" DSPs
InterpUGInterpUG does linear interpolation between two patchpoints, based on the value of a third patchpoint
MKConductorDefines the mechanism that controls the timing of a MusicKit performance
MKEnvelopeBasic support for creating line segment functions
MKFilePerformerDuring a Music Kit performance, a MKFilePerformer reads and performs time-ordered music data from a file on the disk. An abstract class, MKFilePerformer provides common functionality and declares subclass responsibilities for its one subclass, MKScorefilePerformer
MKFileWriterA MKFileWriter is an MKInstrument that realizes MKNotes by writing them to a file on the disk. An abstract class, MKFileWriter provides common functionality for the MusicKit subclasses such as MKScorefileWriter (currently the only subclass of MKFileWriter)
MKInstrumentMKInstrument is an abstract class that defines the general mechanism for receiving and realizing MKNotes during a MusicKit performance
MKMDRawEventEach raw event consists of a MIDI message byte and a time stamp
MKMidiA MKMidi object lets you communicate with a MIDI synthesizer by providing a simple interface to the MIDI device driver
MKMixerInstrumentMKMixerInstrument mixes soundfiles based on a score description of the mix
MKMTCPerformerMKMTCPerformer is used to generate MKNotes with MIDI time code parameters
MKNoteA MKNote object represents a musical sound or event by describing its attributes
MKNoteFilterMKNoteFilter is an abstract class that combines the functionality it inherits from MKInstrument with the protocol defined in the MKPerformer class
MKNoteReceiverMKNoteReceiver is an auxilliary class that completes the implementation of MKInstrument
MKNoteSenderMKNoteSender is an auxilliary class that completes the implementation of MKPerformer
MKOrchestraThis is the allocator and manager of DSP resources
MKPartA MKPart is a timeTag-ordered collection of MKNotes that can be edited performed, and realized. MKParts are typically grouped together in an MKScore
MKPartialsLets you define a sound waveform by adding together a number of sine wave components
MKPartPerformerA MKPartPerformer object performs the MKNotes in a particular MKPart
MKPartRecorderA MKPartRecorder is an MKInstrument that realizes MKNotes by adding copies of them to a MKPart
MKPatchEach MKPatch is an abstracted superclass of synthesis patch descriptions independent of the mechanism used to synthesize. Therefore, it holds synthesis independent patch methods, such as patch loading from bundles
MKPatchTemplateA MKPatchTemplate is a recipe for building a MKSynthPatch object. It contains specifications for the MKUnitGenerator and MKSynthData objects that are needed and instructions for connecting these objects together
MKPerformerMKPerformer is an abstract class that defines a mechanism for performing MKNotes during a MusicKit performance
MKPerformerDelegateThe following methods may be implemented by the delegate. The messages get sent, if the delegate responds to them, after the MKPerformer's status has changed
MKSamplesA MKSamples object represents one complete cycle of a sound waveform as a series of samples
MKScoreA MKScore is a collection of MKPart objects. MKScores can be read from and written to a scorefile or midifile, performed with a MKScorePerformer, and can be used to record MKNotes from a MKScoreRecorder
MKScorefilePerformerMKScorefilePerformers are used to perform scorefiles
MKScorefileWriterA MKScorefileWriter is an MKInstrument that realizes MKNotes by writing them to a scorefile
MKScorePerformerA MKScorePerformer performs a MKScore object by creating a group of MKPartPerformers, one for each MKPart in the MKScore, and controlling the group's performance
MKScoreRecorderA MKScoreRecorder is a pseudo-MKInstrument that adds MKNotes to the MKParts in a given MKScore
MKSynthDataMKSynthData objects represent DSP memory that's used in music synthesis
MKSynthInstrumentAn MKSynthInstrument realizes MKNotes by synthesizing them on the DSP
MKSynthPatchA MKSynthPatch contains a configuration of MKUnitGenerators that work as a sound synthesis module
MKTimbreThe MusicKit supports a Timbre Data Base. Each element in the data base is a MKTimbre
MKTuningSystemA MKTuningSystem object represents a musical tuning system by mapping key numbers to frequencies
MKUnitGeneratorMKUnitGenerators are the building blocks of DSP music synthesis
MKWaveTableA MKWaveTable represents a single period of a sound waveform as a series of samples
Mul1add2UGMul1add2UG adds two patchpoints and multiplies the result by a third
Mul2UGMul2UG multiplies two patchpoints
OnepoleUGOnepoleUG is a simple one-pole (recursive) filter, useful for low and high-pass filter
OnezeroUGOnezeroUG is a one-zero (FIR) fiter useful for mild low and high-pass filtering
OscgafiUGOscgafiUG is the same as OscgafUG, but it implements a high-quality interpolating oscillator
OscgafUGOscgafUG is similar to OscgUG, but supports patchpoints for frequency and amplitude
OscgafUGsOscgafUGs is the superclass for OscgafUG and OscgafiUG oscillators
OscgUGOscgUG is the basic oscillator and supports amplitude and frequency as memory arguments
Out1aUGOut1aUG simply writes its input patchpoint to the left channel
Out1bUGOut1bUG simply writes its input patchpoint to the right channel
Out1nUGOut1nUG may be used for quadraphonic and other multi-channel output
Out2sumUGOut2sumUG sends its monaural input patchpoint to a stereo output stream, panning the sound as indicated by its memory arguments
PluckPlucked string synthesis
ScaleUGScaleUG multiplies a patchpoint by a value that is specified in its memory argument
Scl1add2UGScl1add2UG multiplies the first input by a scale factor, and adds it to the second input patchpoint to produce a third
Scl2add2UGScale2add2 multiplies two input patchpoints times scalers then adds them together
ShapeWaveshaping synthesis, with index control and amplitude envelope
ShapevSame as Shape but with periodic and random vibrato
SimpSingle-oscillator wavetable producing periodic waveforms using a non-interpolating oscillator
SndThe Snd object encapsulates a sounds format parameters and it's sample data. It supports reading and writing to a soundfile, playback of sound, recording of sampled sound, conversion among various sampled formats, basic editing of the sound, and name and storage management for sounds
SndAudioBufferAn in-memory audio buffer
SndAudioBufferQueueAbstraction of the producer / consumer buffer queue operation found inside the SndStreamClients, which have both an input and output SndAudioBufferQueue. Provides thread safe buffer exchange and blocking operations
SndAudioFaderAn object providing basic amplitude and balance controls on incoming audio buffers. "Fader" movements can be scheduled for arbitrary times in the future
SndAudioProcessorA VST-like audio FX processing module base class
SndAudioProcessorChainHolds a collection of serially "chained" SndAudioProcessors with a final SndAudioFader at the end of the chain
SndAudioProcessorDelayA delay processor
SndAudioProcessorDistortionA distortion/limiter processor
SndAudioProcessorFlangerA flanger/dual choruser processor
SndAudioProcessorInspectorAn inspector window for SndAudioProcessors
SndAudioProcessorNoiseGateA Noisegate processor
SndAudioProcessorRecorderRecords the FX audio stream to disk
SndAudioProcessorReverbA reverb processor
SndAudioProcessorToneGeneratorA tone generator processor
SndAudioUnitControllerResponsible for receiving user interface messages from the Cocoa or Carbon Audio Unit views and passing them down to the Audio Unit (which is wrapped within the SndAudioUnitProcessor). Receives buttons for bypassing an effect
SndAudioUnitProcessorWraps an audio unit and it's signal processing behaviour
SndBreakpointA simple storage class allowing SndEnvelope breakpoint information to be stored in NSArrays
SndDisplayDataFor internal use of the SndView
SndDisplayDataListMaintain a sorted list of cached display data for SndViews
SndEnvelopeProvide enveloping data for audio streams
< SndEnveloping >Declares a formal protocol for objects to be used as envelopes
SndFormatDefines a structure for holding sound describing parameters, but no sample data itself
SndMeterNot ready for operation just yet!
SndMP3SndMP3 is a subclass of Snd for reading MP3 files
SndOnDiskExperimental Snd class. USE WITH EXTREME CAUTION. _ONLY_ use SndOnDisk for solo playback at present
SndPerformanceHolds the state associated with each sounding (or soon to be) Snd
SndPlayerSndPlayer is the basic sound playing, streaming synthesizer. It simply maintains a queue of to-be-played and playing sounds, and mixes the active sounds down to its output buffer
SndRecorderSndRecorder records to one (or more?) Snd instances. It simply maintains a queue of to-be-played and playing sounds, and mixes the active sounds down to its output buffer
SndSoundStructEach raw event consists of a MIDI message byte and a time stamp
SndStreamArchitectureViewView showing the current layout of Snd streaming components (rudimentary)
SNDStreamBufferDescribes the format and the data in a limited length buffer used for operating on a stream
SndStreamClientA stream client is responsible for audio streaming, signal processing and synthesis
< SndStreamClientDelegate >Informal protocol for a SndStreamClient delegate
SndStreamManagerProvides client connection and stream mixing services, and acts as the gateway to the lowlevel MKPerformSndMIDI C functions
SndStreamMixerStream mixer and effects processor
SndStreamRecorderATTENTION!!! Presumptions made to get this class off the ground quickly: The incoming stream is made of 32-bit floats, and the saved file is made of 16-bit ints!
< SndStreamRecorderDelegate >Protocol for an SndStreamRecorder delegate
SndStretchableScrollerA subclass of NSScroller that adds two handles that allows stretching the scroller, signalling that the enclosed scrollable object should be resized, typically changing magnification
SndViewSndView is responsible for displaying a amplitude/time plot of Snd data
SnoiseUGSnoiseUG produces sample-and-hold noise at the tick rate
SSAD64xThe SSAD64x class is a DSPSerialPortDevice subclass that corresponds to the Singular Solutions AD64x ADC & DAT interface
StealthDAI2400DSPSerialPortDevice subclass that corresponds to the Stealth DAI2400 DAT interface
TablookiUGTablookiUG does interpolated table lookup, using its input as an index into the table
UnoiseUGUnoiseUG produces white noise at the sampling rate
Wave1Wavetable synthesis with 1 non-interpolating (drop-sample) oscillator
Wave1iWavetable synthesis with 1 interpolating (high-quality) oscillator
Wave1vWavetable synthesis with 1 non-interpolating (drop-sample) oscillator and random and periodic vibrato
Wave1viWavetable synthesis with 1 interpolating osc. and random and periodic vibrato

Generated on Sat Dec 5 17:01:14 2009 for MusicKit by  doxygen 1.5.6