#import <MKPatchTemplate.h>
Public Member Functions | |
| (id) | - init |
| Initializes a new MKPatchTemplate and returns self. | |
| (id) | - copyWithZone: |
| Returns a copy of the MKPatchTemplate. | |
| (id) | - to:sel:arg: |
| Specifies a connection between the MKUnitGenerator identified by objInt1 and the MKSynthData identified by objInt2. | |
| (unsigned) | - addUnitGenerator:ordered: |
| Adds a MKUnitGenerator specification to the receiver. | |
| (unsigned) | - addUnitGenerator: |
| Adds an ordered MKUnitGenerator specification to the receiver. | |
| (unsigned) | - addSynthData:length: |
| Adds a MKSynthData specification to the receiver. | |
| (unsigned) | - addPatchpoint: |
| Adds a patchpoint (MKSynthData) specification to the receiver. | |
| (unsigned) | - synthElementCount |
| Returns the number of MKUnitGenerator and MKSynthData specifications (including patchpoints) that have been added to the receiver. | |
MKPatchTemplate's addUnitGenerator:ordered: and addSynthData:length: methods describe the objects that make up the MKSynthPatch. It's important to keep in mind that these methods don't add actual objects to the MKPatchTemplate. Instead, they specify the types of objects that will be created when the MKSynthPatch is constructed by the MKOrchestra.
A MKPatchTemplate's MKUnitGenerators are specified by their class, given as the first argument to the addUnitGenerator:ordered: method. The argument should be a MKUnitGenerator leaf class, not a master class (leaf and master classes are explained in the MKUnitGenerator class description).
The MKUnitGenerator is further described as being ordered or unordered, as the argument to the ordered: keyword is YES or NO. Ordered MKUnitGenerators are executed (on the DSP) in the order that they're added to the MKPatchTemplate; unordered MKUnitGenerators are executed in an undetermined order. Usually, the order in which MKUnitGenerators are executed is significant; for example, if the output of MKUnitGenerator A is read by MKUnitGenerator B, then A must be executed before B if no delay is to be incurred. As a convenience, the addUnitGenerator: method is provided to add MKUnitGenerators that are automatically declared as ordered. The advantage of unordered MKUnitGenerators is that their allocation is less constrained.
MKSynthDatas are specified by a DSP memory segment and a length. The memory segment is given as the first argument to addSynthData:length:. This can be either MK_xData, for x data memory, or MK_yData, for y data memory. Which memory segment to specify depends on where the MKUnitGenerators that access it expects it to be. The argument to the length: keyword specifies the size of the MKSynthData, or how much DSP memory it represents, and is given as DSPDatum (24-bit) words.
A typical use of a MKSynthData is to create a location called a patchpoint that's written to by one MKUnitGenerator and then read by another. A patchpoint, which is always 8 words long, is ordinarily the only way that two MKUnitGenerators can communicate. The addPatchPoint: method is provided as a convenient way to add MKSynthDatas that are used as patchpoints. The argument to this method is either MK_xPatch or MK_yPatch, for x and y patchpoint memory, respectively.
The object-adding methods each return a unique integer that identifies the added MKUnitGenerator or MKSynthData.
Once you have added the requisite synthesis elements to a MKPatchTemplate, you can specify how they are connected. This is done through invocations of the to:sel:arg: method. The first argument is an integer that identifies a MKUnitGenerator (such as returned by addUnitGenerator:), the last argument is an integer that identifies a MKSynthData (or patchpoint). The argument to the sel: keyword is a selector that's implemented by the MKUnitGenerator and that takes a MKSynthData object as its only argument. Typical selectors are setInput: (the MKUnitGenerator reads from the MKSynthData) and setOuput: (it writes to the MKSynthData). Notice that you can't connect a MKUnitGenerator directly to another MKUnitGenerator.
| - (id) init |
| - (id) copyWithZone: | (NSZone *) | zone |
| - (id) to: | (unsigned) | anObjInt | ||
| sel: | (SEL) | aSelector | ||
| arg: | (unsigned) | anArgInt | ||
Specifies a connection between the MKUnitGenerator identified by objInt1 and the MKSynthData identified by objInt2.
The means of the connection are specified in the method aSelector, to which the MKUnitGenerator must respond. objInt1 and objInt2 are identifying integers returned by MKPatchTemplate's add methods. If either of these arguments are invalid identifiers, the method returns nil, otherwise it returns the receiver.
| anObjInt | is an unsigned. | |
| aSelector | is a SEL. | |
| anArgInt | is an unsigned. |
| - (unsigned) addUnitGenerator: | (id) | aUGClass | ||
| ordered: | (BOOL) | isOrdered | ||
Adds a MKUnitGenerator specification to the receiver.
The MKUnitGenerator is an instance of aUGClass, a MKUnitGenerator leaf class. If isOrdered is YES, then the order in which the specification is added (in relation to the receiver's other MKUnitGenerators) is the order in which the MKUnitGenerator, once created, is executed on the DSP.
| aUGClass | is an id. | |
| isOrdered | is a BOOL. |
| - (unsigned) addUnitGenerator: | (id) | aUGClass |
Adds an ordered MKUnitGenerator specification to the receiver.
Implemented as [self addUnitGenerator: aUGClass ordered: YES].
| aUGClass | is an id. |
| - (unsigned) addSynthData: | (MKOrchMemSegment) | segment | ||
| length: | (unsigned) | len | ||
Adds a MKSynthData specification to the receiver.
The MKSynthData has a length of len DSPDatum words and is allocated from the DSP segment segment, which should be either MK_xData or MK_yData.
| segment | is a MKOrchMemSegment. | |
| len | is an unsigned. |
| - (unsigned) addPatchpoint: | (MKOrchMemSegment) | segment |
Adds a patchpoint (MKSynthData) specification to the receiver.
segment is the DSP memory segment from which the patchpoint is allocated. It can be either MK_xPatch or MK_yPatch. Returns an integer that identifies the patchpoint specification.
| segment | is a MKOrchMemSegment. |
| - (unsigned) synthElementCount |
Returns the number of MKUnitGenerator and MKSynthData specifications (including patchpoints) that have been added to the receiver.
1.5.6