-
Notifications
You must be signed in to change notification settings - Fork 1
/
BBOSCPlugInSender.m
219 lines (176 loc) · 6.42 KB
/
BBOSCPlugInSender.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
//
// BBOSCPlugInSender.m
// BBOSC
//
// Created by Jonathan del Strother on 08/09/2009.
// Copyright (c) 2009 Best Before Media Ltd. All rights reserved.
//
/* It's highly recommended to use CGL macros instead of changing the current context for plug-ins that perform OpenGL rendering */
#import <OpenGL/CGLMacro.h>
#import "OSCExtensions.h"
#import "BBOSCViewController.h"
#import "BBOSCPlugInSender.h"
#import "NSArrayExtensions.h"
#import "BBOSCManager.h"
#define kQCPlugIn_Name @"BBOSC Sender"
#define kQCPlugIn_Description @"Best Before Open Sound Control sender plugin"
@interface BBOSCPlugInSender ()
@property (nonatomic, readwrite, retain) OSCOutPort *oscPort;
@property (nonatomic, readwrite, retain) NSArray* oscParameters;
@end
@implementation BBOSCPlugInSender
@synthesize oscPort, oscParameters;
@dynamic inputBroadcastPort, inputBroadcastPath, inputBroadcastAddress;
+ (NSDictionary*) attributes
{
/*
Return a dictionary of attributes describing the plug-in (QCPlugInAttributeNameKey, QCPlugInAttributeDescriptionKey...).
*/
return [NSDictionary dictionaryWithObjectsAndKeys:kQCPlugIn_Name, QCPlugInAttributeNameKey, kQCPlugIn_Description, QCPlugInAttributeDescriptionKey, nil];
}
+ (NSDictionary*) attributesForPropertyPortWithKey:(NSString*)key {
if ([key isEqualToString:@"inputBroadcastAddress"]) {
return [NSDictionary dictionaryWithObjectsAndKeys:@"Broadcast Address", QCPortAttributeNameKey,
@"0.0.0.0", QCPortAttributeDefaultValueKey, nil];
}
if ([key isEqualToString:@"inputBroadcastPort"]) {
return [NSDictionary dictionaryWithObjectsAndKeys:@"Broadcast Port", QCPortAttributeNameKey,
[NSNumber numberWithInt:60000], QCPortAttributeDefaultValueKey, nil];
}
if ([key isEqualToString:@"inputBroadcastPath"]) {
return [NSDictionary dictionaryWithObjectsAndKeys:@"Broadcast Path", QCPortAttributeNameKey,
@"/test", QCPortAttributeDefaultValueKey, nil];
}
return nil;
}
+ (QCPlugInExecutionMode) executionMode
{
/*
Return the execution mode of the plug-in: kQCPlugInExecutionModeProvider, kQCPlugInExecutionModeProcessor, or kQCPlugInExecutionModeConsumer.
*/
return kQCPlugInExecutionModeConsumer;
}
+ (QCPlugInTimeMode) timeMode
{
/*
Return the time dependency mode of the plug-in: kQCPlugInTimeModeNone, kQCPlugInTimeModeIdle or kQCPlugInTimeModeTimeBase.
*/
return kQCPlugInTimeModeNone;
}
- (id) init
{
if(self = [super init]) {
/*
Allocate any permanent resource required by the plug-in.
*/
self.oscParameters = [NSArray array];
}
return self;
}
- (void) finalize
{
/*
Release any non garbage collected resources created in -init.
*/
[super finalize];
}
- (void) dealloc
{
[oscPort release];
[super dealloc];
}
- (QCPlugInViewController*) createViewController
{
return [[BBOSCViewController alloc] initWithPlugIn:self
viewNibName:@"BBOSCSettings"];
}
+ (NSArray*) plugInKeys {
return [NSArray arrayWithObjects:@"oscParameters", nil];
}
-(void)setOscParameters:(NSArray*)params {
NSArray* originalPortKeys = [oscParameters map:^(id port){ return [port objectForKey:BBOSCPortKey]; }];
[self willChangeValueForKey:@"oscParameters"];
[oscParameters release];
oscParameters = [params retain];
[self didChangeValueForKey:@"oscParameters"];
// Bleh, just trash all the original input ports
for(NSString* portKey in originalPortKeys) {
[self removeInputPortForKey:portKey];
}
for(NSDictionary* port in oscParameters) {
NSString* key = [port objectForKey:BBOSCPortKey];
NSNumber* oscType = [port objectForKey:BBOSCTypeKey];
NSString* name = [NSString stringWithFormat:@"OSC-%@", [[BBOSCTypeToStringTransformer transformer] transformedValue:oscType]];
NSDictionary* attributes = [NSDictionary dictionaryWithObjectsAndKeys:name, QCPortAttributeNameKey, nil];
[self addInputPortWithType:QCTypeForOSCType([oscType intValue]) forKey:key withAttributes:attributes];
}
}
@end
@implementation BBOSCPlugInSender (Execution)
- (BOOL) startExecution:(id<QCPlugInContext>)context
{
/*
Called by Quartz Composer when rendering of the composition starts: perform any required setup for the plug-in.
Return NO in case of fatal failure (this will prevent rendering of the composition to start).
*/
return YES;
}
- (void) enableExecution:(id<QCPlugInContext>)context
{
/*
Called by Quartz Composer when the plug-in instance starts being used by Quartz Composer.
*/
}
- (BOOL) execute:(id<QCPlugInContext>)context atTime:(NSTimeInterval)time withArguments:(NSDictionary*)arguments
{
/*
Called by Quartz Composer whenever the plug-in instance needs to execute.
Only read from the plug-in inputs and produce a result (by writing to the plug-in outputs or rendering to the destination OpenGL context) within that method and nowhere else.
Return NO in case of failure during the execution (this will prevent rendering of the current frame to complete).
The OpenGL context for rendering can be accessed and defined for CGL macros using:
CGLContextObj cgl_ctx = [context CGLContextObj];
*/
BOOL inputsChanged = NO;
if ([self didValueForInputKeyChange:@"inputBroadcastAddress"] || [self didValueForInputKeyChange:@"inputBroadcastPort"]) {
if (self.oscPort)
[[BBOSCManager sharedManager] removeOutput:self.oscPort];
self.oscPort = [[BBOSCManager sharedManager] createNewOutputToAddress:self.inputBroadcastAddress atPort:self.inputBroadcastPort withLabel:@"BB OSC"];
if (!self.oscPort)
NSLog(@"Failed to created output port");
inputsChanged = YES;
}
for(NSDictionary* port in oscParameters) {
NSString* key = [port objectForKey:BBOSCPortKey];
if ([self didValueForInputKeyChange:key]) {
inputsChanged = YES;
break;
}
}
if ([self didValueForInputKeyChange:@"inputBroadcastPath"])
inputsChanged = YES;
if (!inputsChanged)
return YES;
OSCMessage* message = [OSCMessage createWithAddress:self.inputBroadcastPath];
for(NSDictionary* port in oscParameters) {
NSString* key = [port objectForKey:BBOSCPortKey];
id value = [self valueForInputKey:key];
BBOSCType oscType = [[port objectForKey:BBOSCTypeKey] intValue];
[message addNSValue:value withBias:oscType];
}
[self.oscPort sendThisMessage:message];
return YES;
}
- (void) disableExecution:(id<QCPlugInContext>)context
{
if (self.oscPort) {
[[BBOSCManager sharedManager] removeOutput:self.oscPort];
self.oscPort = nil;
}
}
- (void) stopExecution:(id<QCPlugInContext>)context
{
/*
Called by Quartz Composer when rendering of the composition stops: perform any required cleanup for the plug-in.
*/
}
@end