History

prep / some refactor for .dump() and .apropos() for all objects

Ge Wang committed 5 years ago

Commit a013b4c1 parent 8d5762c16 files · +1274 −1016Browse files

Unified · Split

16 files
  1. src/core/chuck_emit.cpp +2 −2
  2. src/core/chuck_io.cpp +19 −22
  3. src/core/chuck_lang.cpp +117 −88
  4. src/core/chuck_lang.h +2 −0
  5. src/core/chuck_oo.cpp +25 −0
  6. src/core/chuck_oo.h +9 −1
  7. src/core/chuck_scan.cpp +4 −4
  8. src/core/chuck_type.cpp +240 −0
  9. src/core/chuck_type.h +31 −79
  10. src/core/uana_xform.cpp +6 −6
  11. src/core/ugen_filter.cpp +62 −62
  12. src/core/ugen_osc.cpp +40 −39
  13. src/core/ugen_stk.cpp +600 −600
  14. src/core/ugen_xxx.cpp +88 −83
  15. src/core/ulib_opsc.cpp +1 −1
  16. src/core/ulib_std.cpp +28 −29
src/core/chuck_emit.cpp+2−2
@@ -3731,7 +3731,7 @@ t_CKBOOL emit_engine_emit_exp_dot_member( Chuck_Emitter * emit, · 3730 unmodified lines
37313731 // make sure that the base type is object
37323732 assert( t_base->info != NULL );
37333733
3734− // if base is static
3734+ // if base is static?
37353735 if( !base_static )
37363736 {
37373737 // if is a func
@@ -3810,7 +3810,7 @@ t_CKBOOL emit_engine_emit_exp_dot_member( Chuck_Emitter * emit, · 72 unmodified lines
38103810 // emit the type
38113811 // commented out so built-in static member variables don't have an
38123812 // extra thing on the stack - spencer
3813− //emit->append( new Chuck_Instr_Reg_Push_Imm( (t_CKUINT)t_base ) );
3813+ // emit->append( new Chuck_Instr_Reg_Push_Imm( (t_CKUINT)t_base ) );
38143814
38153815 // if is a func
38163816 if( isfunc( emit->env, member->self->type ) )
src/core/chuck_io.cpp+19−22
@@ -90,7 +90,7 @@ t_CKBOOL init_class_io( Chuck_Env * env, Chuck_Type * type ) · 89 unmodified lines
9090 Chuck_DL_Func * func = NULL;
9191
9292 // log
93− EM_log( CK_LOG_SEVERE, "class 'io'" );
93+ EM_log( CK_LOG_SEVERE, "class 'IO'" );
9494
9595 // init as base class
9696 // TODO: ctor/dtor?
@@ -230,7 +230,7 @@ t_CKBOOL init_class_fileio( Chuck_Env * env, Chuck_Type * type ) · 133 unmodified lines
230230 Chuck_DL_Func * func = NULL;
231231
232232 // log
233− EM_log( CK_LOG_SEVERE, "class 'fileio'" );
233+ EM_log( CK_LOG_SEVERE, "class 'FileIO'" );
234234
235235 // init as base class
236236 // TODO: ctor/dtor?
@@ -4108,7 +4108,7 @@ t_CKBOOL init_class_serialio( Chuck_Env * env ) · 3871 unmodified lines
41084108 // log
41094109 EM_log( CK_LOG_SEVERE, "class 'SerialIO'" );
41104110
4111− std::string doc = "Handles reading and writing for serial input/output devices, such as Arduino.";
4111+ std::string doc = "serial input/output. popularly used to communicate with systems like Arduino.";
41124112
41134113 Chuck_Type * type = type_engine_import_class_begin( env, "SerialIO", "IO",
41144114 env->global(), serialio_ctor, serialio_dtor, doc.c_str() );
@@ -4121,14 +4121,14 @@ t_CKBOOL init_class_serialio( Chuck_Env * env ) · 6 unmodified lines
41214121
41224122 // add list()
41234123 func = make_new_sfun( "string[]", "list", serialio_list );
4124− func->doc = "Return list of available serial devices.";
4124+ func->doc = "get list of available serial devices.";
41254125 if( !type_engine_import_sfun( env, func ) ) goto error;
41264126
41274127 func = make_new_mfun("int", "open", serialio_open);
41284128 func->add_arg("int", "i");
41294129 func->add_arg("int", "baud");
41304130 func->add_arg("int", "mode");
4131− func->doc = "Open serial device i with specified baud rate and mode (binary or ASCII).";
4131+ func->doc = "open serial device i with specified baud rate and mode (binary or ASCII).";
41324132 if( !type_engine_import_mfun( env, func ) ) goto error;
41334133
41344134 func = make_new_mfun("void", "close", serialio_close);
@@ -4144,78 +4144,78 @@ t_CKBOOL init_class_serialio( Chuck_Env * env ) · 9 unmodified lines
41444144
41454145 // add onLine
41464146 func = make_new_mfun("SerialIO", "onLine", serialio_onLine);
4147− func->doc = "Wait for one line (ASCII mode only).";
4147+ func->doc = "wait for one line (ASCII mode only).";
41484148 if( !type_engine_import_mfun( env, func ) ) goto error;
41494149
41504150 // add onByte
41514151 func = make_new_mfun("SerialIO", "onByte", serialio_onByte);
4152− func->doc = "Wait for one byte (binary mode only).";
4152+ func->doc = "wait for one byte (binary mode only).";
41534153 if( !type_engine_import_mfun( env, func ) ) goto error;
41544154
41554155 // add onBytes
41564156 func = make_new_mfun("SerialIO", "onBytes", serialio_onBytes);
41574157 func->add_arg("int", "num");
4158− func->doc = "Wait for requested number of bytes (binary mode only).";
4158+ func->doc = "wait for requested number of bytes (binary mode only).";
41594159 if( !type_engine_import_mfun( env, func ) ) goto error;
41604160
41614161 // add onInts
41624162 func = make_new_mfun("SerialIO", "onInts", serialio_onInts);
41634163 func->add_arg("int", "num");
4164− func->doc = "Wait for requested number of ints (ASCII or binary mode).";
4164+ func->doc = "wait for requested number of ints (ASCII or binary mode).";
41654165 if( !type_engine_import_mfun( env, func ) ) goto error;
41664166
41674167 // add onInts
41684168 func = make_new_mfun("SerialIO", "onFloats", serialio_onFloats);
41694169 func->add_arg("int", "num");
4170− func->doc = "Wait for requested number of floats (ASCII or binary mode).";
4170+ func->doc = "wait for requested number of floats (ASCII or binary mode).";
41714171 if( !type_engine_import_mfun( env, func ) ) goto error;
41724172
41734173 // add getLine
41744174 func = make_new_mfun("string", "getLine", serialio_getLine);
4175− func->doc = "Get next requested line.";
4175+ func->doc = "get next requested line.";
41764176 if( !type_engine_import_mfun( env, func ) ) goto error;
41774177
41784178 // add getByte
41794179 func = make_new_mfun("int", "getByte", serialio_getByte);
4180− func->doc = "Get next requested byte. ";
4180+ func->doc = "get next requested byte. ";
41814181 if( !type_engine_import_mfun( env, func ) ) goto error;
41824182
41834183 // add getBytes
41844184 func = make_new_mfun("int[]", "getBytes", serialio_getBytes);
4185− func->doc = "Get next requested number of bytes. ";
4185+ func->doc = "get next requested number of bytes. ";
41864186 if( !type_engine_import_mfun( env, func ) ) goto error;
41874187
41884188 // add getInts
41894189 func = make_new_mfun("int[]", "getInts", serialio_getInts);
4190− func->doc = "Get next requested number of integers. ";
4190+ func->doc = "get next requested number of integers. ";
41914191 if( !type_engine_import_mfun( env, func ) ) goto error;
41924192
41934193 // add writeByte
41944194 func = make_new_mfun("void", "writeByte", serialio_writeByte);
41954195 func->add_arg("int", "b");
4196− func->doc = "Write a single byte.";
4196+ func->doc = "write a single byte.";
41974197 if( !type_engine_import_mfun( env, func ) ) goto error;
41984198
41994199 // add writeBytes
42004200 func = make_new_mfun("void", "writeBytes", serialio_writeBytes);
42014201 func->add_arg("int[]", "b");
4202− func->doc = "Write array of bytes.";
4202+ func->doc = "write array of bytes.";
42034203 if( !type_engine_import_mfun( env, func ) ) goto error;
42044204
42054205 // add setBaudRate
42064206 func = make_new_mfun("int", "baudRate", serialio_setBaudRate);
42074207 func->add_arg("int", "r");
4208− func->doc = "Set baud rate.";
4208+ func->doc = "set baud rate.";
42094209 if( !type_engine_import_mfun( env, func ) ) goto error;
42104210
42114211 // add getBaudRate
42124212 func = make_new_mfun("int", "baudRate", serialio_getBaudRate);
4213− func->doc = "Get current baud rate.";
4213+ func->doc = "get current baud rate.";
42144214 if( !type_engine_import_mfun( env, func ) ) goto error;
42154215
42164216 // add getBaudRate
42174217 func = make_new_mfun("void", "flush", serialio_flush);
4218− func->doc = "Flush the IO buffer.";
4218+ func->doc = "flush the IO buffer.";
42194219 if( !type_engine_import_mfun( env, func ) ) goto error;
42204220
42214221 // add can_wait
@@ -4458,6 +4458,3 @@ CK_DLL_MFUN(serialio_canWait) · 236 unmodified lines
44584458 }
44594459
44604460 #endif // __DISABLE_SERIAL__
4461−
4462−
4463−
src/core/chuck_lang.cpp+117−88
@@ -63,9 +63,9 @@ t_CKBOOL init_class_object( Chuck_Env * env, Chuck_Type * type ) · 62 unmodified lines
6363 Chuck_DL_Func * func = NULL;
6464
6565 // log
66− EM_log( CK_LOG_SEVERE, "class 'object'" );
66+ EM_log( CK_LOG_SEVERE, "class 'Object'" );
6767
68− const char * doc = "Base class for all class types in ChucK.";
68+ const char * doc = "base class for all class types in ChucK.";
6969
7070 // init as base class
7171 if( !type_engine_import_class_begin( env, type, env->global(), object_ctor, object_dtor, doc ) )
@@ -77,7 +77,17 @@ t_CKBOOL init_class_object( Chuck_Env * env, Chuck_Type * type ) · 5 unmodified lines
7777
7878 // add toString()
7979 func = make_new_mfun( "string", "toString", object_toString );
80− func->doc = "Return a textual description of this object.";
80+ func->doc = "get a textual description of this object.";
81+ if( !type_engine_import_mfun( env, func ) ) goto error;
82+
83+ // add dump()
84+ func = make_new_mfun( "void", "dump", object_dump );
85+ func->doc = "output current state of the object as text.";
86+ if( !type_engine_import_mfun( env, func ) ) goto error;
87+
88+ // add api()
89+ func = make_new_mfun( "void", "apropos", object_apropos );
90+ func->doc = "output information about the object's type.";
8191 if( !type_engine_import_mfun( env, func ) ) goto error;
8292
8393 // end the class import
@@ -104,7 +114,7 @@ t_CKBOOL init_class_ugen( Chuck_Env * env, Chuck_Type * type ) · 20 unmodified lines
104114 {
105115 Chuck_DL_Func * func = NULL;
106116
107− EM_log( CK_LOG_SEVERE, "class 'ugen'" );
117+ EM_log( CK_LOG_SEVERE, "class 'UGen'" );
108118
109119 // add ugen info
110120 type->ugen_info = new Chuck_UGen_Info;
@@ -113,7 +123,7 @@ t_CKBOOL init_class_ugen( Chuck_Env * env, Chuck_Type * type ) · 2 unmodified lines
113123 type->ugen_info->num_ins = 1;
114124 type->ugen_info->num_outs = 1;
115125
116− const char * doc = "Base class for all UGen types in ChucK.";
126+ const char * doc = "base class for all unit generator (UGen) types in ChucK.";
117127
118128 // init as base class
119129 // TODO: ctor/dtor, ugen's sometimes created internally?
@@ -123,10 +133,10 @@ t_CKBOOL init_class_ugen( Chuck_Env * env, Chuck_Type * type ) · 3 unmodified lines
123133 // gain
124134 func = make_new_mfun( "float", "gain", ugen_gain );
125135 func->add_arg( "float", "val" );
126− func->doc = "Set the gain of the ugen.";
136+ func->doc = "set the gain of the unit generator.";
127137 if( !type_engine_import_mfun( env, func ) ) goto error;
128138 func = make_new_mfun( "float", "gain", ugen_cget_gain );
129− func->doc = "Return the gain of the ugen.";
139+ func->doc = "get the gain of the unit generator.";
130140 if( !type_engine_import_mfun( env, func ) ) goto error;
131141
132142 /* // next
@@ -138,46 +148,46 @@ t_CKBOOL init_class_ugen( Chuck_Env * env, Chuck_Type * type ) · 5 unmodified lines
138148 */
139149 // last
140150 func = make_new_mfun( "float", "last", ugen_last );
141− func->doc = "Return the last sample value of the unit generator.";
151+ func->doc = "get the last sample value of the unit generator.";
142152 if( !type_engine_import_mfun( env, func ) ) goto error;
143153
144154 // op
145155 func = make_new_mfun( "int", "op", ugen_op );
146156 func->add_arg( "int", "val" );
147− func->doc = "Set the ugen's operation mode. Accepted values are: 1 (sum inputs), 2 (take difference between first input and subsequent inputs), 3 (multiply inputs), 4 (divide first input by subsequent inputs), 0 (do not synthesize audio, output 0) or -1 (passthrough inputs to output).";
157+ func->doc = "set the unit generator's operation mode. Accepted values are: 1 (sum inputs), 2 (take difference between first input and subsequent inputs), 3 (multiply inputs), 4 (divide first input by subsequent inputs), 0 (do not synthesize audio, output 0) or -1 (passthrough inputs to output).";
148158 if( !type_engine_import_mfun( env, func ) ) goto error;
149159 func = make_new_mfun( "int", "op", ugen_cget_op );
150− func->doc = "Return the ugen's operation mode.";
160+ func->doc = "get the unit generator's operation mode.";
151161 if( !type_engine_import_mfun( env, func ) ) goto error;
152162
153163 // add numChannels
154164 func = make_new_mfun( "int", "channels", ugen_numChannels );
155165 func->add_arg( "int", "num" );
156− func->doc = "Set number of channels. (Not currently supported.)";
166+ func->doc = "set number of channels. (currently NOT supported)";
157167 if( !type_engine_import_mfun( env, func ) ) goto error;
158168 func = make_new_mfun( "int", "channels", ugen_cget_numChannels );
159− func->doc = "Return number of channels.";
169+ func->doc = "get number of channels.";
160170 if( !type_engine_import_mfun( env, func ) ) goto error;
161171
162172 // add chan
163173 func = make_new_mfun( "UGen", "chan", ugen_chan );
164174 func->add_arg( "int", "num" );
165− func->doc = "Return channel at specified index.";
175+ func->doc = "get channel (as a UGen) at specified index.";
166176 if( !type_engine_import_mfun( env, func ) ) goto error;
167177
168178 // add isConnectedTo
169179 func = make_new_mfun( "int", "isConnectedTo", ugen_connected );
170180 func->add_arg( "UGen", "right" );
171− func->doc = "Return true if this ugen's output is connected to the input of the argument. Return false otherwise. ";
181+ func->doc = "return true if this UGen's output is connected to the input of the argument; return false otherwise.";
172182 if( !type_engine_import_mfun( env, func ) ) goto error;
173183
174184 // add buffered
175185 func = make_new_mfun( "int", "buffered", ugen_buffered );
176186 func->add_arg( "int", "val" );
177− func->doc = "Set the ugen's buffered operation mode. If true, the ugen stores a buffer of its most recent samples, which can be fetched using global variables in the host language.";
187+ func->doc = "set the unit generator's buffered operation mode, typically used externally from hosts that embed ChucK as a component. If true, the UGen stores a buffer of its most recent samples, which can be fetched using global variables in the host language.";
178188 if( !type_engine_import_mfun( env, func ) ) goto error;
179189 func = make_new_mfun( "int", "buffered", ugen_cget_buffered );
180− func->doc = "Return the ugen's buffered operation mode.";
190+ func->doc = "get the ugen's buffered operation mode.";
181191 if( !type_engine_import_mfun( env, func ) ) goto error;
182192
183193 // end
@@ -206,7 +216,7 @@ t_CKBOOL init_class_uana( Chuck_Env * env, Chuck_Type * type ) · 22 unmodified lines
206216 {
207217 Chuck_DL_Func * func = NULL;
208218
209− EM_log( CK_LOG_SEVERE, "class 'uana'" );
219+ EM_log( CK_LOG_SEVERE, "class 'UAna'" );
210220
211221 // add uana info
212222 type->ugen_info = new Chuck_UGen_Info;
@@ -215,7 +225,7 @@ t_CKBOOL init_class_uana( Chuck_Env * env, Chuck_Type * type ) · 2 unmodified lines
215225 type->ugen_info->num_ins = 1;
216226 type->ugen_info->num_outs = 1;
217227
218− const char * doc = "Base class from which all unit analyzers (UAnae) inherit; UAnae (note plural form) can be interconnected via => (standard chuck operator) or via =^ (upchuck operator), specify the the types of and when data is passed between UAnae and UGens. When .upchuck() is invoked on a given UAna, the UAna-chain (UAnae connected via =^) is traversed backwards from the upchucked UAna, and analysis is performed at each UAna along the chain; the updated analysis results are stored in UAnaBlobs.";
228+ const char * doc = "base class from which all unit analyzer (UAna) type inherit; UAnae (note plural form) can be interconnected using => (standard chuck operator) or using =^ (upchuck operator), specify the the types of and when data is passed between UAnae and UGens. When .upchuck() is invoked on a given UAna, the UAna-chain (UAnae connected via =^) is traversed backwards from the upchucked UAna, and analysis is performed at each UAna along the chain; the updated analysis results are stored in UAnaBlobs.";
219229
220230 // init as base class, type should already know the parent type
221231 // TODO: ctor/dtor, ugen's sometimes created internally?
@@ -228,35 +238,35 @@ t_CKBOOL init_class_uana( Chuck_Env * env, Chuck_Type * type ) · 6 unmodified lines
228238
229239 // add upchuck
230240 func = make_new_mfun( "UAnaBlob", "upchuck", uana_upchuck );
231− func->doc = "Initiate analysis at the UAna; returns result.";
241+ func->doc = "initiate analysis at the UAna and return result.";
232242 if( !type_engine_import_mfun( env, func ) ) goto error;
233243
234244 // add fvals
235245 func = make_new_mfun( "float[]", "fvals", uana_fvals );
236− func->doc = "Get blob's float array.";
246+ func->doc = "get blob's float array.";
237247 if( !type_engine_import_mfun( env, func ) ) goto error;
238248
239249 // add cvals
240250 func = make_new_mfun( "complex[]", "cvals", uana_cvals );
241− func->doc = "Get blob's complex array.";
251+ func->doc = "get blob's complex array.";
242252 if( !type_engine_import_mfun( env, func ) ) goto error;
243253
244254 // add fval
245255 func = make_new_mfun( "float", "fval", uana_fval );
246256 func->add_arg( "int", "index" );
247− func->doc = "Get blob's float value at index.";
257+ func->doc = "get blob's float value at index.";
248258 if( !type_engine_import_mfun( env, func ) ) goto error;
249259
250260 // add cval
251261 func = make_new_mfun( "complex", "cval", uana_cval );
252262 func->add_arg( "int", "index" );
253− func->doc = "Get blob's complex value at index.";
263+ func->doc = "get blob's complex value at index.";
254264 if( !type_engine_import_mfun( env, func ) ) goto error;
255265
256266 // add isUpConnectedTo
257267 func = make_new_mfun( "int", "isUpConnectedTo", uana_connected );
258268 func->add_arg( "UAna", "right" );
259− func->doc = "Is connected to another uana via =^?";
269+ func->doc = "is connected to another uana via =^?";
260270 if( !type_engine_import_mfun( env, func ) ) goto error;
261271
262272 // TODO: add nonchuck
@@ -297,9 +307,9 @@ t_CKBOOL init_class_blob( Chuck_Env * env, Chuck_Type * type ) · 34 unmodified lines
297307 // Chuck_Value * value = NULL;
298308
299309 // log
300− EM_log( CK_LOG_SEVERE, "class 'uanablob'" );
310+ EM_log( CK_LOG_SEVERE, "class 'UAnaBlob'" );
301311
302− const char * doc = "This object contains results associated with UAna analysis. There is a UAnaBlob associated with every UAna. As a UAna is upchucked, the result is stored in the UAnaBlob's floating point vector and/or complex vector. The intended interpretation of the results depends on the specific UAna.";
312+ const char * doc = "contains results associated with UAna analysis. There is a UAnaBlob associated with every UAna. As a UAna is upchucked, the result is stored in the UAnaBlob's floating point vector and/or complex vector. The intended interpretation of the results depends on the specific UAna.";
303313
304314 // init class
305315 // TODO: ctor/dtor
@@ -316,29 +326,29 @@ t_CKBOOL init_class_blob( Chuck_Env * env, Chuck_Type * type ) · 10 unmodified lines
316326
317327 // add when
318328 func = make_new_mfun( "time", "when", uanablob_when );
319− func->doc = "Get the time when blob was last upchucked.";
329+ func->doc = "get the time when blob was last upchucked.";
320330 if( !type_engine_import_mfun( env, func ) ) goto error;
321331
322332 // add fvals
323333 func = make_new_mfun( "float[]", "fvals", uanablob_fvals );
324− func->doc = "Get blob's float array.";
334+ func->doc = "get blob's float array.";
325335 if( !type_engine_import_mfun( env, func ) ) goto error;
326336
327337 // add cvals
328338 func = make_new_mfun( "complex[]", "cvals", uanablob_cvals );
329− func->doc = "Get blob's complex array.";
339+ func->doc = "get blob's complex array.";
330340 if( !type_engine_import_mfun( env, func ) ) goto error;
331341
332342 // add fval
333343 func = make_new_mfun( "float", "fval", uanablob_fval );
334344 func->add_arg( "int", "index" );
335− func->doc = "Get blob's float value at index.";
345+ func->doc = "get blob's float value at index.";
336346 if( !type_engine_import_mfun( env, func ) ) goto error;
337347
338348 // add cval
339349 func = make_new_mfun( "complex", "cval", uanablob_cval );
340350 func->add_arg( "int", "index" );
341− func->doc = "Get blob's complex value at index.";
351+ func->doc = "get blob's complex value at index.";
342352 if( !type_engine_import_mfun( env, func ) ) goto error;
343353
344354 // end class import
@@ -370,9 +380,9 @@ t_CKBOOL init_class_event( Chuck_Env * env, Chuck_Type * type ) · 25 unmodified lines
370380 Chuck_Value * value = NULL;
371381
372382 // log
373− EM_log( CK_LOG_SEVERE, "class 'event'" );
383+ EM_log( CK_LOG_SEVERE, "class 'Event'" );
374384
375− const char *doc = "The Event class allows exact synchronization across an arbitrary number of shreds.";
385+ const char *doc = "a mechanism for precise synchronization across shreds.";
376386
377387 // init as base class
378388 // TODO: ctor/dtor?
@@ -381,23 +391,23 @@ t_CKBOOL init_class_event( Chuck_Env * env, Chuck_Type * type ) · 2 unmodified lines
381391
382392 // add signal()
383393 func = make_new_mfun( "void", "signal", event_signal );
384− func->doc = "Signal one shred that is waiting on this event. ";
394+ func->doc = "signal one shred that is waiting on this event.";
385395 if( !type_engine_import_mfun( env, func ) ) goto error;
386396
387397 // add broadcast()
388398 func = make_new_mfun( "void", "broadcast", event_broadcast );
389− func->doc = "Signal all shreds that are waiting on this event.";
399+ func->doc = "signal all shreds that are waiting on this event.";
390400 if( !type_engine_import_mfun( env, func ) ) goto error;
391401
392402 // add wait()
393403 func = make_new_mfun( "void", "wait", event_wait );
394404 func->add_arg( "Shred", "me" );
395− func->doc = "(Currently unsupported.)";
405+ func->doc = "(currently unsupported)";
396406 if( !type_engine_import_mfun( env, func ) ) goto error;
397407
398408 // add can_wait()
399409 func = make_new_mfun( "int", "can_wait", event_can_wait );
400− func->doc = "Whether or not the event can be waited on. Currently always returns true.";
410+ func->doc = "can the event can be waited on? Currently always returns true.";
401411 if( !type_engine_import_mfun( env, func ) ) goto error;
402412
403413 // end the class import
@@ -434,9 +444,9 @@ t_CKBOOL init_class_shred( Chuck_Env * env, Chuck_Type * type ) · 30 unmodified lines
434444 Chuck_DL_Func * func = NULL;
435445
436446 // log
437− EM_log( CK_LOG_SEVERE, "class 'shred'" );
447+ EM_log( CK_LOG_SEVERE, "class 'Shred'" );
438448
439− const char *doc = "Shred facilitates various operations and interactions with shreds running in the ChucK virtual machine.";
449+ const char *doc = "a strongly-timed ChucK thread of execution.";
440450
441451 // init as base class
442452 // TODO: ctor/dtor?
@@ -449,7 +459,7 @@ t_CKBOOL init_class_shred( Chuck_Env * env, Chuck_Type * type ) · 6 unmodified lines
449459 // add fromId()
450460 func = make_new_sfun( "Shred", "fromId", shred_fromId );
451461 func->add_arg( "int", "id" );
452− func->doc = "Return a Shred object corresponding to the provided shred ID.";
462+ func->doc = "get Shred corresponding to a Shred ID.";
453463 if( !type_engine_import_sfun( env, func ) ) goto error;
454464
455465 // add clone()
@@ -458,27 +468,27 @@ t_CKBOOL init_class_shred( Chuck_Env * env, Chuck_Type * type ) · 2 unmodified lines
458468
459469 // add exit()
460470 func = make_new_mfun( "void", "exit", shred_exit );
461− func->doc = "Immediately halt the shred's operation and remove it from the virtual machine.";
471+ func->doc = "halt the shred's operation and remove it from the virtual machine.";
462472 if( !type_engine_import_mfun( env, func ) ) goto error;
463473
464474 // add id()
465475 func = make_new_mfun( "int", "id", shred_id );
466− func->doc = "Return the unique numeric id of the shred.";
476+ func->doc = "get the unique numeric id of the Shred.";
467477 if( !type_engine_import_mfun( env, func ) ) goto error;
468478
469479 // add yield()
470480 func = make_new_mfun( "void", "yield", shred_yield );
471− func->doc = "Cause the shred to temporarily stop processing, allowing other scheduled shreds to run as needed.";
481+ func->doc = "cause the current Shred to temporarily suspend without advancing time, allowing other simultaneously schreduled shreds to run as needed. NOTE: yield() is equivalent to '0::second +=> now;'";
472482 if( !type_engine_import_mfun( env, func ) ) goto error;
473483
474484 // add running()
475485 func = make_new_mfun( "int", "running", shred_running );
476− func->doc = "Return true if the shred is currently running; false otherwise.";
486+ func->doc = "is the Shred currently running?";
477487 if( !type_engine_import_mfun( env, func ) ) goto error;
478488
479489 // add done()
480490 func = make_new_mfun( "int", "done", shred_done );
481− func->doc = "Return true if the shred is done processing; false otherwise.";
491+ func->doc = "is the Shred done running?";
482492 if( !type_engine_import_mfun( env, func ) ) goto error;
483493
484494 // add nargs()
@@ -487,7 +497,7 @@ t_CKBOOL init_class_shred( Chuck_Env * env, Chuck_Type * type ) · 2 unmodified lines
487497
488498 // add nargs()
489499 func = make_new_mfun( "int", "args", shred_numArgs );
490− func->doc = "Return the number of arguments provided to the shred.";
500+ func->doc = "get the number of arguments provided to the Shred.";
491501 if( !type_engine_import_mfun( env, func ) ) goto error;
492502
493503 // add arg()
@@ -498,33 +508,33 @@ t_CKBOOL init_class_shred( Chuck_Env * env, Chuck_Type * type ) · 4 unmodified lines
498508 // add arg()
499509 func = make_new_mfun( "string", "arg", shred_getArg );
500510 func->add_arg( "int", "index" );
501− func->doc = "Return the argument at the specified index.";
511+ func->doc = "get the Shred argument at the specified index.";
502512 if( !type_engine_import_mfun( env, func ) ) goto error;
503513
504514 // add sourcePath() (added 1.3.0.0)
505515 func = make_new_mfun( "string", "sourcePath", shred_sourcePath );
506− func->doc = "Return the path of the source code file from which this shred's code is derived.";
516+ func->doc = "get the path of the source file from which this Shred's code is derived (same as .path()).";
507517 if( !type_engine_import_mfun( env, func ) ) goto error;
508518
509519 // add path() (added 1.3.2.0)
510520 func = make_new_mfun( "string", "path", shred_sourcePath );
511− func->doc = "Return the file path of the source code file from which this shred's code is derived (same as .sourcePath()).";
521+ func->doc = "get the path of the source file from which this Shred's code is derived (same as .sourcePath()).";
512522 if( !type_engine_import_mfun( env, func ) ) goto error;
513523
514524 // add sourceDir() (added 1.3.0.0)
515525 func = make_new_mfun( "string", "sourceDir", shred_sourceDir );
516− func->doc = "Return the enclosing directory of the source code file from which this shred's code is derived.";
526+ func->doc = "get the enclosing directory of the source file from which this Shred's code is derived (same as .dir()).";
517527 if( !type_engine_import_mfun( env, func ) ) goto error;
518528
519529 // add dir() (added 1.3.2.0)
520530 func = make_new_mfun( "string", "dir", shred_sourceDir );
521− func->doc = "Return the enclosing directory of the source code file from which this shred's code is derived (same as .sourceDir()).";
531+ func->doc = "get the enclosing directory of the source file from which this Shred's code is derived (same as .sourceDir()).";
522532 if( !type_engine_import_mfun( env, func ) ) goto error;
523533
524534 // add dir() (added 1.3.2.0, ge)
525535 func = make_new_mfun( "string", "dir", shred_sourceDir2 );
526536 func->add_arg( "int", "levelsUp" );
527− func->doc = "Return the enclosing directory, the specified number of parent directories up.";
537+ func->doc = "get the enclosing directory, the specified number of parent directories up.";
528538 if( !type_engine_import_mfun( env, func ) ) goto error;
529539
530540 // end the class import
@@ -556,7 +566,7 @@ t_CKBOOL init_class_vec3( Chuck_Env * env, Chuck_Type * type ) · 25 unmodified lines
556566 EM_log( CK_LOG_SEVERE, "class 'vec3' (primitive)" );
557567
558568 // document
559− const char *doc = "vec3 is a primitive type for a 3-dimensional vector; potentially useful for 3D coordinates, RGB color, or as a value/goal/slew interpolator.";
569+ const char *doc = "a primitive type for a 3-dimensional vector; potentially useful for 3D coordinate, RGB color, or as a value/goal/slew interpolator.";
560570
561571 // init as base class
562572 if( !type_engine_import_class_begin( env, type, env->global(), NULL, NULL, doc ) )
@@ -646,7 +656,7 @@ t_CKBOOL init_class_vec4( Chuck_Env * env, Chuck_Type * type ) · 83 unmodified lines
646656 EM_log( CK_LOG_SEVERE, "class 'vec4' (primitive)" );
647657
648658 // document
649− const char *doc = "vec4 is a primitive type for a 4-dimensional vector; potentially useful for 4D coordinatesm and RGBA color.";
659+ const char *doc = "a primitive type for a 4-dimensional vector; potentially useful for 4D coordinate and RGBA color.";
650660
651661 // init as base class
652662 if( !type_engine_import_class_begin( env, type, env->global(), NULL, NULL, doc ) )
@@ -700,7 +710,7 @@ t_CKBOOL init_class_string( Chuck_Env * env, Chuck_Type * type ) · 47 unmodified lines
700710 // log
701711 EM_log( CK_LOG_SEVERE, "class 'string'" );
702712
703− const char * doc = "The string class holds textual data as a sequence of characters, and provides a number of functions for manipulating text.";
713+ const char * doc = "textual data as a sequence of characters, along with functions for manipulating text.";
704714
705715 // init as base class
706716 // TODO: ctor/dtor
@@ -709,32 +719,32 @@ t_CKBOOL init_class_string( Chuck_Env * env, Chuck_Type * type ) · 2 unmodified lines
709719
710720 // add length()
711721 func = make_new_mfun( "int", "length", string_length );
712− func->doc = "Return the number of characters of the string.";
722+ func->doc = "get the number of characters of the string.";
713723 if( !type_engine_import_mfun( env, func ) ) goto error;
714724
715725 // add upper()
716726 func = make_new_mfun( "string", "upper", string_upper );
717− func->doc = "Return a new string in which the lowercase characters of the original string have been converted to uppercase.";
727+ func->doc = "get a new string in which the lowercase characters of the original string have been converted to uppercase.";
718728 if( !type_engine_import_mfun( env, func ) ) goto error;
719729
720730 // add lower()
721731 func = make_new_mfun( "string", "lower", string_lower );
722− func->doc = "Return a new string in which the uppercase characters of the original string have been converted to lowercase.";
732+ func->doc = "get a new string in which the uppercase characters of the original string have been converted to lowercase.";
723733 if( !type_engine_import_mfun( env, func ) ) goto error;
724734
725735 // add ltrim()
726736 func = make_new_mfun( "string", "ltrim", string_ltrim );
727− func->doc = "Return a new string in which leading whitespace has been removed.";
737+ func->doc = "get a new string in which leading whitespace has been removed.";
728738 if( !type_engine_import_mfun( env, func ) ) goto error;
729739
730740 // add rtrim()
731741 func = make_new_mfun( "string", "rtrim", string_rtrim );
732− func->doc = "Return a new string in which trailing whitespace has been removed.";
742+ func->doc = "get a new string in which trailing whitespace has been removed.";
733743 if( !type_engine_import_mfun( env, func ) ) goto error;
734744
735745 // add trim()
736746 func = make_new_mfun( "string", "trim", string_trim );
737− func->doc = "Return a new string in which leading and trailing whitespace has been removed.";
747+ func->doc = "get a new string in which leading and trailing whitespace has been removed.";
738748 if( !type_engine_import_mfun( env, func ) ) goto error;
739749
740750 // add toString()
@@ -744,41 +754,41 @@ t_CKBOOL init_class_string( Chuck_Env * env, Chuck_Type * type ) · 3 unmodified lines
744754 // add charAt()
745755 func = make_new_mfun( "int", "charAt", string_charAt );
746756 func->add_arg("int", "index");
747− func->doc = "Return a character at the specified index.";
757+ func->doc = "get a character at the specified index.";
748758 if( !type_engine_import_mfun( env, func ) ) goto error;
749759
750760 // add setCharAt()
751761 func = make_new_mfun( "int", "setCharAt", string_setCharAt );
752762 func->add_arg("int", "index");
753763 func->add_arg("int", "theChar");
754− func->doc = "Set the character at the specified index.";
764+ func->doc = "set the character at the specified index.";
755765 if( !type_engine_import_mfun( env, func ) ) goto error;
756766
757767 // add substring()
758768 func = make_new_mfun( "string", "substring", string_substring );
759769 func->add_arg("int", "start");
760− func->doc = "Return a new string containing the substring from the start index to the end of the string.";
770+ func->doc = "get a new string containing the substring from the start index to the end of the string.";
761771 if( !type_engine_import_mfun( env, func ) ) goto error;
762772
763773 // add substring()
764774 func = make_new_mfun( "string", "substring", string_substringN );
765775 func->add_arg("int", "start");
766776 func->add_arg("int", "length");
767− func->doc = "Return a new string containing the substring from the start index of the specified length.";
777+ func->doc = "get a new string containing the substring from the start index of the specified length.";
768778 if( !type_engine_import_mfun( env, func ) ) goto error;
769779
770780 // add insert()
771781 func = make_new_mfun( "void", "insert", string_insert );
772782 func->add_arg("int", "position");
773783 func->add_arg("string", "str");
774− func->doc = "Insert str at the specified position.";
784+ func->doc = "insert a string at the specified position.";
775785 if( !type_engine_import_mfun( env, func ) ) goto error;
776786
777787 // add replace()
778788 func = make_new_mfun( "void", "replace", string_replace );
779789 func->add_arg( "int", "position" );
780790 func->add_arg( "string", "str" );
781− func->doc = "Replace characters from the start position to the end of the string with str.";
791+ func->doc = "get characters from the start position to the end of the string with str.";
782792 if( !type_engine_import_mfun( env, func ) ) goto error;
783793
784794 // add replace()
@@ -786,71 +796,71 @@ t_CKBOOL init_class_string( Chuck_Env * env, Chuck_Type * type ) · 1 unmodified line
786796 func->add_arg( "int", "position" );
787797 func->add_arg( "int", "length" );
788798 func->add_arg( "string", "str" );
789− func->doc = "Replace length characters from the start position with str.";
799+ func->doc = "get length characters from the start position with str.";
790800 if( !type_engine_import_mfun( env, func ) ) goto error;
791801
792802 // add find()
793803 func = make_new_mfun( "int", "find", string_find );
794804 func->add_arg( "int", "theChar" );
795− func->doc = "Return the index of the first occurence of theChar, or -1 if theChar is not found.";
805+ func->doc = "get the index of the first occurence of theChar, or -1 if theChar is not found.";
796806 if( !type_engine_import_mfun( env, func ) ) goto error;
797807
798808 // add find()
799809 func = make_new_mfun( "int", "find", string_findStart );
800810 func->add_arg( "int", "theChar" );
801811 func->add_arg( "int", "start" );
802− func->doc = "Return the index of the first occurence of theChar at or after the start position, or -1 if theChar is not found.";
812+ func->doc = "get the index of the first occurence of theChar at or after the start position, or -1 if theChar is not found.";
803813 if( !type_engine_import_mfun( env, func ) ) goto error;
804814
805815 // add find()
806816 func = make_new_mfun( "int", "find", string_findStr );
807817 func->add_arg( "string", "str" );
808− func->doc = "Return the index of the first occurence of str, or -1 if str is not found.";
818+ func->doc = "get the index of the first occurence of str, or -1 if str is not found.";
809819 if( !type_engine_import_mfun( env, func ) ) goto error;
810820
811821 // add find()
812822 func = make_new_mfun( "int", "find", string_findStrStart );
813823 func->add_arg( "string", "str" );
814824 func->add_arg( "int", "start" );
815− func->doc = "Return the index of the first occurence of str at or after the start position, or -1 if str is not found.";
825+ func->doc = "get the index of the first occurence of str at or after the start position, or -1 if str is not found.";
816826 if( !type_engine_import_mfun( env, func ) ) goto error;
817827
818828 // add rfind()
819829 func = make_new_mfun( "int", "rfind", string_rfind );
820830 func->add_arg( "int", "theChar" );
821− func->doc = "Return the index of the last occurence of theChar, or -1 if theChar is not found.";
831+ func->doc = "get the index of the last occurence of theChar, or -1 if theChar is not found.";
822832 if( !type_engine_import_mfun( env, func ) ) goto error;
823833
824834 // add rfind()
825835 func = make_new_mfun( "int", "rfind", string_rfindStart );
826836 func->add_arg( "int", "theChar" );
827837 func->add_arg( "int", "start" );
828− func->doc = "Return the index of the last occurence of theChar at or before the start position, or -1 if theChar is not found.";
838+ func->doc = "get the index of the last occurence of theChar at or before the start position, or -1 if theChar is not found.";
829839 if( !type_engine_import_mfun( env, func ) ) goto error;
830840
831841 // add rfind()
832842 func = make_new_mfun( "int", "rfind", string_rfindStr );
833843 func->add_arg( "string", "str" );
834− func->doc = "Return the index of the last occurence of str, or -1 if str is not found.";
844+ func->doc = "get the index of the last occurence of str, or -1 if str is not found.";
835845 if( !type_engine_import_mfun( env, func ) ) goto error;
836846
837847 // add rfind()
838848 func = make_new_mfun( "int", "rfind", string_rfindStrStart );
839849 func->add_arg( "string", "str" );
840850 func->add_arg( "int", "start" );
841− func->doc = "Return the index of the last occurence of str at or before the start position, or -1 if str is not found.";
851+ func->doc = "get the index of the last occurence of str at or before the start position, or -1 if str is not found.";
842852 if( !type_engine_import_mfun( env, func ) ) goto error;
843853
844854 // add erase()
845855 func = make_new_mfun( "void", "erase", string_erase );
846856 func->add_arg( "int", "start" );
847857 func->add_arg( "int", "length" );
848− func->doc = "Erase length characters of the string from start position.";
858+ func->doc = "erase length characters of the string from start position.";
849859 if( !type_engine_import_mfun( env, func ) ) goto error;
850860
851861 // add toInt()
852862 func = make_new_mfun( "int", "toInt", string_toInt );
853− func->doc = "Attempt to convert the contents of the string to an integer and return the result, or 0 if conversion failed.";
863+ func->doc = "attemp to convert the contents of the string to an integer and return the result, or 0 if conversion failed.";
854864 if( !type_engine_import_mfun( env, func ) ) goto error;
855865
856866 // add toFloat()
@@ -910,38 +920,38 @@ t_CKBOOL init_class_array( Chuck_Env * env, Chuck_Type * type ) · 53 unmodified lines
910920
911921 // init as base class
912922 // TODO: ctor/dtor?
913− const char *doc = "The array class is used to store linear sequences of data, also providing capabilities for stack and map data structures.";
914− if( !type_engine_import_class_begin( env, type, env->global(), NULL, NULL, doc ) )
923+ string doc = "storage construct for sequential data of the same type; can also be used as a stack or a map data structure.";
924+ if( !type_engine_import_class_begin( env, type, env->global(), NULL, NULL, doc.c_str() ) )
915925 return FALSE;
916926
917927 // add clear()
918928 func = make_new_mfun( "void", "clear", array_clear );
919− func->doc = "Clear the contents of the array.";
929+ func->doc = "clear the contents of the array.";
920930 if( !type_engine_import_mfun( env, func ) ) goto error;
921931
922932 // add reset()
923933 func = make_new_mfun( "void", "reset", array_reset );
924− func->doc = "Reset array to original state; clears the array and sets capacity to 8.";
934+ func->doc = "reset array to original state; clears the array and sets capacity to 8.";
925935 if( !type_engine_import_mfun( env, func ) ) goto error;
926936
927937 // add popBack()
928938 func = make_new_mfun( "void", "popBack", array_pop_back );
929− func->doc = "Remove the last item of the array";
939+ func->doc = "remove the last item of the array";
930940 if( !type_engine_import_mfun( env, func ) ) goto error;
931941
932942 // add size()
933943 func = make_new_mfun( "int", "size", array_get_size );
934− func->doc = "Return the number of elements in the array.";
944+ func->doc = "get the number of elements in the array.";
935945 if( !type_engine_import_mfun( env, func ) ) goto error;
936946 // add size()
937947 func = make_new_mfun( "int", "size", array_set_size );
938948 func->add_arg( "int", "newSize" );
939− func->doc = "Set the size of the array. If the new size is less than the current size, elements will be deleted from the end; if the new size is larger than the current size, 0 or null elements will be added to the end.";
949+ func->doc = "set the size of the array. If the new size is less than the current size, elements will be deleted from the end; if the new size is larger than the current size, 0 or null elements will be added to the end.";
940950 if( !type_engine_import_mfun( env, func ) ) goto error;
941951
942952 // add cap()
943953 func = make_new_mfun( "int", "cap", array_get_capacity_hack );
944− func->doc = "Return current capacity of the array (number of elements that can be held without reallocating internal buffer). ";
954+ func->doc = "get current capacity of the array (number of elements that can be held without reallocating internal buffer).";
945955 if( !type_engine_import_mfun( env, func ) ) goto error;
946956
947957 // add capacity()
@@ -954,13 +964,13 @@ t_CKBOOL init_class_array( Chuck_Env * env, Chuck_Type * type ) · 6 unmodified lines
954964 // add find()
955965 func = make_new_mfun( "int", "find", array_find );
956966 func->add_arg( "string", "key" );
957− func->doc = "Return number of elements with the specified key. ";
967+ func->doc = "get number of elements with the specified key. ";
958968 if( !type_engine_import_mfun( env, func ) ) goto error;
959969
960970 // add erase()
961971 func = make_new_mfun( "int", "erase", array_erase );
962972 func->add_arg( "string", "key" );
963− func->doc = "Erase all elements with the specified key. ";
973+ func->doc = "erase all elements with the specified key. ";
964974 if( !type_engine_import_mfun( env, func ) ) goto error;
965975
966976 // add examples
@@ -1047,6 +1057,25 @@ CK_DLL_MFUN( object_toString ) · 80 unmodified lines
10471057 RETURN->v_object = str;
10481058 }
10491059
1060+// dump
1061+CK_DLL_MFUN( object_dump )
1062+{
1063+ // get object
1064+ Chuck_Object * me = SELF;
1065+ // call dump
1066+ me->dump();
1067+}
1068+
1069+// apropos
1070+CK_DLL_MFUN( object_apropos )
1071+{
1072+ // get object
1073+ Chuck_Object * me = SELF;
1074+ // call dump
1075+ me->apropos();
1076+}
1077+
1078+
10501079
10511080 // ctor
10521081 CK_DLL_CTOR( ugen_ctor )
src/core/chuck_lang.h+2−0
@@ -72,6 +72,8 @@ CK_DLL_MFUN( object_equals ); · 71 unmodified lines
7272 CK_DLL_MFUN( object_getType );
7373 CK_DLL_MFUN( object_hashCode );
7474 CK_DLL_MFUN( object_toString );
75+CK_DLL_MFUN( object_dump );
76+CK_DLL_MFUN( object_apropos );
7577
7678
7779 //-----------------------------------------------------------------------------
src/core/chuck_oo.cpp+25−0
@@ -343,6 +343,31 @@ Chuck_Object::~Chuck_Object() · 342 unmodified lines
343343
344344
345345
346+//-----------------------------------------------------------------------------
347+// name: dump()
348+// desc: output current state (can be overridden)
349+//-----------------------------------------------------------------------------
350+void Chuck_Object::dump()
351+{
352+ // TODO: implement!
353+}
354+
355+
356+
357+
358+//-----------------------------------------------------------------------------
359+// name: apropos()
360+// desc: output interface (can be overriden; but probably shouldn't be)
361+//-----------------------------------------------------------------------------
362+void Chuck_Object::apropos()
363+{
364+ // apropos on type
365+ this->type_ref->apropos();
366+}
367+
368+
369+
370+
346371 //-----------------------------------------------------------------------------
347372 // name: Chuck_Array4()
348373 // desc: constructor
src/core/chuck_oo.h+9−1
@@ -174,6 +174,14 @@ public: · 173 unmodified lines
174174 Chuck_Object();
175175 virtual ~Chuck_Object();
176176
177+public:
178+ // output current state (can be overridden)
179+ virtual void dump();
180+
181+public:
182+ // output type info (can be overriden; but probably shouldn't be)
183+ virtual void apropos();
184+
177185 public:
178186 // virtual table
179187 Chuck_VTable * vtable;
@@ -221,7 +229,7 @@ public: · 41 unmodified lines
221229 virtual t_CKINT erase( const std::string & key ) = 0; // erase
222230 virtual void clear( ) = 0; // clear
223231
224− Chuck_Type *m_array_type;
232+ Chuck_Type * m_array_type;
225233 };
226234
227235
src/core/chuck_scan.cpp+4−4
@@ -2499,6 +2499,8 @@ t_CKBOOL type_engine_scan2_func_def( Chuck_Env * env, a_Func_Def f ) · 2498 unmodified lines
24992499 func = env->context->new_Chuck_Func();
25002500 // set the name
25012501 func->name = func_name;
2502+ // set the base name (i.e., without designations); 1.4.0.2
2503+ func->base_name = orig_name;
25022504 // reference the function definition
25032505 func->def = f;
25042506 // note whether the function is marked as member
@@ -2677,15 +2679,13 @@ t_CKBOOL type_engine_scan2_func_def( Chuck_Env * env, a_Func_Def f ) · 172 unmodified lines
26772679 // enter the name into the function table
26782680 env->curr->func.add( func->name, func );
26792681
2680− // add for orig name
2682+ // if not overload, add entries for orig name
26812683 if( !overload )
26822684 {
26832685 env->curr->value.add( orig_name, value );
26842686 env->curr->func.add( orig_name, func );
26852687 }
2686−
2687− // if overload
2688− if( overload )
2688+ else // if overload (changed from separate if statement 1.4.0.2)
26892689 {
26902690 // make sure returns are equal
26912691 if( *(f->ret_type) != *(overload->func_ref->def->ret_type) )
src/core/chuck_type.cpp+240−0
@@ -40,6 +40,7 @@ · 39 unmodified lines
4040 #include "util_string.h"
4141 #include "ugen_xxx.h"
4242
43+#include <strstream>
4344 using namespace std;
4445
4546
@@ -6373,6 +6374,8 @@ void escape_table( ) · 6327 unmodified lines
63736374 }
63746375
63756376
6377+
6378+
63766379 //-----------------------------------------------------------------------------
63776380 // name: escape_str()
63786381 // desc: ...
@@ -6470,6 +6473,13 @@ t_CKBOOL escape_str( char * str_lit, int linepos ) · 91 unmodified lines
64706473 return TRUE;
64716474 }
64726475
6476+
6477+
6478+
6479+//-----------------------------------------------------------------------------
6480+// name: str2char
6481+// desc: handle escape characters
6482+//-----------------------------------------------------------------------------
64736483 t_CKINT str2char( const char * c, int linepos )
64746484 {
64756485 if(c[0] == '\\')
@@ -6497,3 +6507,233 @@ t_CKINT str2char( const char * c, int linepos ) · 21 unmodified lines
64976507 return c[0];
64986508 }
64996509 }
6510+
6511+
6512+
6513+
6514+//-----------------------------------------------------------------------------
6515+// name: Chuck_Type()
6516+// desc: constructor
6517+//-----------------------------------------------------------------------------
6518+Chuck_Type::Chuck_Type( Chuck_Env * env, te_Type _id, const std::string & _n,
6519+ Chuck_Type * _p, t_CKUINT _s )
6520+{
6521+ m_env = env;
6522+ xid = _id; name = _n; parent = _p; size = _s; owner = NULL;
6523+ array_type = NULL; array_depth = 0; obj_size = 0;
6524+ info = NULL; func = NULL; def = NULL; is_copy = FALSE;
6525+ ugen_info = NULL; is_complete = TRUE; has_constructor = FALSE;
6526+ has_destructor = FALSE;
6527+ allocator = NULL;
6528+}
6529+
6530+
6531+
6532+
6533+//-----------------------------------------------------------------------------
6534+// name: ~Chuck_Type()
6535+// desc: destructor
6536+//-----------------------------------------------------------------------------
6537+Chuck_Type::~Chuck_Type()
6538+{
6539+ // reset
6540+ reset();
6541+}
6542+
6543+
6544+
6545+
6546+//-----------------------------------------------------------------------------
6547+// name: reset()
6548+// desc: reset this type struct
6549+//-----------------------------------------------------------------------------
6550+void Chuck_Type::reset()
6551+{
6552+ // CK_FPRINTF_STDERR( "type: %s %i\n", c_name(), (t_CKUINT)this );
6553+ xid = te_void;
6554+ size = array_depth = obj_size = 0;
6555+ is_copy = FALSE;
6556+
6557+ // free only if not locked: to prevent garbage collection after exit
6558+ if( !this->m_locked )
6559+ {
6560+ // TODO: uncomment this, fix it to behave correctly
6561+ // release references
6562+ // SAFE_RELEASE(parent);
6563+ // SAFE_RELEASE(array_type);
6564+ SAFE_RELEASE(info);
6565+ // SAFE_RELEASE(owner);
6566+ // SAFE_RELEASE(func);
6567+ // SAFE_RELEASE(ugen_info);
6568+ }
6569+}
6570+
6571+
6572+
6573+
6574+//-----------------------------------------------------------------------------
6575+// name: operator =
6576+// desc: assignment operator; this does not touch the Chuck_VM_Object
6577+//-----------------------------------------------------------------------------
6578+const Chuck_Type & Chuck_Type::operator =( const Chuck_Type & rhs )
6579+{
6580+ // release first
6581+ this->reset();
6582+
6583+ // copy
6584+ this->xid = rhs.xid;
6585+ this->name = rhs.name;
6586+ this->parent = rhs.parent;
6587+ this->obj_size = rhs.obj_size;
6588+ this->size = rhs.size;
6589+ this->def = rhs.def;
6590+ this->is_copy = TRUE;
6591+ this->array_depth = rhs.array_depth;
6592+ this->array_type = rhs.array_type; // SAFE_ADD_REF(this->array_type);
6593+ this->func = rhs.func; // SAFE_ADD_REF(this->func);
6594+ this->info = rhs.info; SAFE_ADD_REF(this->info);
6595+ this->owner = rhs.owner; // SAFE_ADD_REF(this->owner);
6596+
6597+ return *this;
6598+}
6599+
6600+
6601+
6602+
6603+//-----------------------------------------------------------------------------
6604+// name: copy()
6605+// desc: create a copy of this type struct
6606+//-----------------------------------------------------------------------------
6607+Chuck_Type * Chuck_Type::copy( Chuck_Env * env ) const
6608+{
6609+ // allocate new instance
6610+ Chuck_Type * n = env->context->new_Chuck_Type( env );
6611+ // invoke = operator
6612+ *n = *this;
6613+ // return new instance
6614+ return n;
6615+}
6616+
6617+
6618+
6619+
6620+//-----------------------------------------------------------------------------
6621+// name: str()
6622+// desc: get a string of this type
6623+//-----------------------------------------------------------------------------
6624+const std::string & Chuck_Type::str()
6625+{
6626+ // start with base name
6627+ ret = name;
6628+ // add array levels as needed
6629+ for( t_CKUINT i = 0; i < array_depth; i++ )
6630+ ret += std::string("[]");
6631+ // return it
6632+ return ret;
6633+}
6634+
6635+
6636+
6637+
6638+//-----------------------------------------------------------------------------
6639+// name: c_name()
6640+// desc: return this->str() as C string
6641+//-----------------------------------------------------------------------------
6642+const char * Chuck_Type::c_name()
6643+{
6644+ return str().c_str();
6645+}
6646+
6647+
6648+
6649+
6650+//-----------------------------------------------------------------------------
6651+// name: apropos()
6652+// desc: dump info to string
6653+//-----------------------------------------------------------------------------
6654+void Chuck_Type::apropos( std::string & output )
6655+{
6656+ // reset
6657+ output = "";
6658+ // make a string output stream
6659+ ostringstream sout;
6660+ // type
6661+ Chuck_Type * type = this;
6662+ // line prefix
6663+ string PREFIX = ""; // [chuck]: ";
6664+
6665+ // delimiter
6666+ sout << PREFIX;
6667+ for( int i = 0; i < str().length(); i++ ) sout << "-";
6668+ sout << endl;
6669+ // type name
6670+ sout << PREFIX << str() << (this->ugen_info ? " (unit generator)" : "") << endl;
6671+ // delimiter
6672+ sout << PREFIX;
6673+ for( int i = 0; i < str().length(); i++ ) sout << "-";
6674+ sout << endl;
6675+ // inheritance
6676+ if( type->parent != NULL )
6677+ {
6678+ sout << PREFIX << " |- inherits";
6679+ while( type->parent != NULL )
6680+ {
6681+ // move up
6682+ type = type->parent;
6683+ // print
6684+ sout << " -> " << type->str() << "";
6685+ }
6686+ sout << endl;
6687+ // set back to this
6688+ type = this;
6689+ }
6690+ // description
6691+ if( this->doc != "" )
6692+ sout << PREFIX << " |- description: " << this->doc << "" << endl;
6693+
6694+// // storage for functions in type
6695+// vector<Chuck_Func *> funcs;
6696+// // get functions from type info
6697+// type->parent->parent->info->get_funcs( funcs );
6698+// // print functions
6699+// for( t_CKUINT i = 0; i < funcs.size(); i++ )
6700+// {
6701+// // sout << funcs[i]->base_name << endl;
6702+// }
6703+
6704+ // // storage for values in type
6705+ // vector<Chuck_Value *> values;
6706+ // // get values from type info
6707+ // type->parent->parent->parent->info->get_values( values );
6708+ // // print values
6709+ // for( t_CKUINT i = 0; i < values.size(); i++ )
6710+ // {
6711+ // CK_STDCERR << values[i]->name << CK_STDENDL;
6712+ // }
6713+ //
6714+ // CK_STDCERR << funcs.size() << " " << values.size() << CK_STDENDL;
6715+
6716+ sout << PREFIX;
6717+ for( int i = 0; i < str().length(); i++ ) sout << "-";
6718+ sout << endl;
6719+
6720+ // done
6721+ output = sout.str();
6722+}
6723+
6724+
6725+
6726+
6727+//-----------------------------------------------------------------------------
6728+// name: apropos()
6729+// desc: dump info to console
6730+//-----------------------------------------------------------------------------
6731+void Chuck_Type::apropos()
6732+{
6733+ // the info
6734+ string output;
6735+ // get it
6736+ this->apropos( output );
6737+ // print it
6738+ CK_STDCERR << output << CK_STDENDL;
6739+}
src/core/chuck_type.h+31−79
@@ -626,89 +626,40 @@ struct Chuck_Type : public Chuck_VM_Object · 625 unmodified lines
626626 // example files
627627 std::vector<std::string> examples;
628628
629+ // reference to environment RE-FACTOR 2017
630+ Chuck_Env * m_env;
631+
629632 public:
630633 // constructor
631− Chuck_Type( Chuck_Env * env, te_Type _id = te_null, const std::string & _n = "",
632− Chuck_Type * _p = NULL, t_CKUINT _s = 0 )
633− {
634− m_env = env;
635− xid = _id; name = _n; parent = _p; size = _s; owner = NULL;
636− array_type = NULL; array_depth = 0; obj_size = 0;
637− info = NULL; func = NULL; def = NULL; is_copy = FALSE;
638− ugen_info = NULL; is_complete = TRUE; has_constructor = FALSE;
639− has_destructor = FALSE;
640− allocator = NULL;
641− }
642−
634+ Chuck_Type( Chuck_Env * env,
635+ te_Type _id = te_null,
636+ const std::string & _n = "",
637+ Chuck_Type * _p = NULL,
638+ t_CKUINT _s = 0 );
643639 // destructor
644− virtual ~Chuck_Type() { reset(); }
645−
646− // reset
647− void reset()
648− {
649− // CK_FPRINTF_STDERR( "type: %s %i\n", c_name(), (t_CKUINT)this );
650− xid = te_void;
651− size = array_depth = obj_size = 0;
652− is_copy = FALSE;
653−
654− // free only if not locked: to prevent garbage collection after exit
655− if( !this->m_locked )
656− {
657− // TODO: uncomment this, fix it to behave correctly
658− // release references
659− // SAFE_RELEASE(parent);
660− // SAFE_RELEASE(array_type);
661− SAFE_RELEASE(info);
662− // SAFE_RELEASE(owner);
663− // SAFE_RELEASE(func);
664− // SAFE_RELEASE(ugen_info);
665− }
666− }
667−
640+ virtual ~Chuck_Type();
641+ // reset
642+ void reset();
668643 // assignment - this does not touch the Chuck_VM_Object
669− const Chuck_Type & operator =( const Chuck_Type & rhs )
670− {
671− // release first
672− this->reset();
673−
674− // copy
675− this->xid = rhs.xid;
676− this->name = rhs.name;
677− this->parent = rhs.parent;
678− this->obj_size = rhs.obj_size;
679− this->size = rhs.size;
680− this->def = rhs.def;
681− this->is_copy = TRUE;
682− this->array_depth = rhs.array_depth;
683− this->array_type = rhs.array_type;
684− // SAFE_ADD_REF(this->array_type);
685− this->func = rhs.func;
686− // SAFE_ADD_REF(this->func);
687− this->info = rhs.info;
688− SAFE_ADD_REF(this->info);
689− this->owner = rhs.owner;
690− // SAFE_ADD_REF(this->owner);
691−
692− return *this;
693− }
644+ const Chuck_Type & operator =( const Chuck_Type & rhs );
645+ // make a copy of this type struct
646+ Chuck_Type * copy( Chuck_Env * env ) const;
694647
695− // copy
696− Chuck_Type * copy( Chuck_Env * env ) const
697− { Chuck_Type * n = env->context->new_Chuck_Type( env );
698− *n = *this; return n; }
699−
648+public:
700649 // to string
701− std::string ret;
702− const std::string & str()
703− { ret = name;
704− for( t_CKUINT i = 0; i < array_depth; i++ ) ret += std::string("[]");
705− return ret; }
706− // to c
707− const char * c_name()
708− { return str().c_str(); }
650+ const std::string & str();
651+ // to c string
652+ const char * c_name();
709653
710− //ref
711− Chuck_Env * m_env;
654+protected:
655+ // this for str() and c_name() use only
656+ std::string ret;
657+
658+public:
659+ // dump info to string
660+ void apropos( std::string & output );
661+ // dump info to console
662+ void apropos();
712663 };
713664
714665
@@ -789,8 +740,10 @@ struct Chuck_Value : public Chuck_VM_Object · 74 unmodified lines
789740 //-----------------------------------------------------------------------------
790741 struct Chuck_Func : public Chuck_VM_Object
791742 {
792− // name
743+ // name (actual in VM name, e.g., "dump@0@Object")
793744 std::string name;
745+ // base name (without the designation, e.g., "dump"); 1.4.0.2
746+ std::string base_name;
794747 // func def from parser
795748 a_Func_Def def;
796749 // code (included imported)
@@ -940,8 +893,7 @@ const char * howmuch2str( te_HowMuch how_much ); · 143 unmodified lines
940893 t_CKBOOL escape_str( char * str_lit, int linepos );
941894 t_CKINT str2char( const char * char_lit, int linepos );
942895
943−// REFACTOR-2017: exile! now stored in env
944−// default types
896+// REFACTOR-2017: exile! these default types now stored in env
945897 //extern Chuck_Type t_void;
946898 //extern Chuck_Type t_int;
947899 //extern Chuck_Type t_float;
src/core/uana_xform.cpp+6−6
@@ -171,7 +171,7 @@ DLL_QUERY xform_query( Chuck_DL_Query * QUERY ) · 170 unmodified lines
171171 // init as base class: FFT
172172 //---------------------------------------------------------------------
173173
174− doc = "This UAna computes the Fast Fourier Transform on incoming audio samples, and outputs the result via its UAnaBlob as both the complex spectrum and the magnitude spectrum. A buffering mechanism maintains the previous FFTsize # of samples, allowing FFT's to be taken at any point in time, on demand (via .upchuck() or by upchucking a downstream UAna. The window size (along with an arbitry window shape) is controlled via the .window method. The hop size is complete dynamic, and is throttled by how time is advanced. ";
174+ doc = "computes the Fast Fourier Transform on incoming audio samples, and outputs the result via its UAnaBlob as both the complex spectrum and the magnitude spectrum. A buffering mechanism maintains the previous FFTsize # of samples, allowing FFT's to be taken at any point in time, on demand (via .upchuck() or by upchucking a downstream UAna. The window size (along with an arbitry window shape) is controlled via the .window method. The hop size is complete dynamic, and is throttled by how time is advanced.";
175175
176176 if( !type_engine_import_uana_begin( env, "FFT", "UAna", env->global(),
177177 FFT_ctor, FFT_dtor,
@@ -224,7 +224,7 @@ DLL_QUERY xform_query( Chuck_DL_Query * QUERY ) · 46 unmodified lines
224224 // init as base class: IFFT
225225 //---------------------------------------------------------------------
226226
227− doc = "This UAna computes the inverse Fast Fourier Transform on incoming spectral frames (on demand), and overlap-adds the results into its internal buffer, ready to be sent to other UGen's connected via =>. The window size (along with an arbitry window shape) is controlled via the .window method.";
227+ doc = "computes the inverse Fast Fourier Transform on incoming spectral frames (on demand), and overlap-adds the results into its internal buffer, ready to be sent to other UGen's connected via =>. The window size (along with an arbitry window shape) is controlled via the .window method.";
228228
229229 if( !type_engine_import_uana_begin( env, "IFFT", "UAna", env->global(),
230230 IFFT_ctor, IFFT_dtor,
@@ -315,7 +315,7 @@ DLL_QUERY xform_query( Chuck_DL_Query * QUERY ) · 84 unmodified lines
315315 // init as base class: Flip
316316 //---------------------------------------------------------------------
317317
318− doc = "Turns audio samples into frames in the UAna domain.";
318+ doc = "turns audio samples into frames in the UAna domain.";
319319
320320 if( !type_engine_import_uana_begin( env, "Flip", "UAna", env->global(),
321321 Flip_ctor, Flip_dtor,
@@ -368,7 +368,7 @@ DLL_QUERY xform_query( Chuck_DL_Query * QUERY ) · 46 unmodified lines
368368 // init as base class: pilF
369369 //---------------------------------------------------------------------
370370
371− doc = "Turns UAna frames into audio samples, via overlap add.";
371+ doc = "turns UAna frames into audio samples, via overlap add.";
372372
373373 if( !type_engine_import_uana_begin( env, "pilF", "UAna", env->global(),
374374 UnFlip_ctor, UnFlip_dtor,
@@ -420,7 +420,7 @@ DLL_QUERY xform_query( Chuck_DL_Query * QUERY ) · 45 unmodified lines
420420 // init as base class: DCT
421421 //---------------------------------------------------------------------
422422
423− doc = "This UAna computes the Discrete Cosine Transform on incoming audio samples, and outputs the result via its UAnaBlob as real values in the D.C. spectrum. A buffering mechanism maintains the previous DCT size # of samples, allowing DCT to be taken at any point in time, on demand (via .upchuck() or by upchucking a downstream UAna; see UAna documentation). The window size (along with an arbitry window shape) is controlled via the .window method. The hop size is complete dynamic, and is throttled by how time is advanced.";
423+ doc = "computes the Discrete Cosine Transform on incoming audio samples, and outputs the result via its UAnaBlob as real values in the D.C. spectrum. A buffering mechanism maintains the previous DCT size # of samples, allowing DCT to be taken at any point in time, on demand (via .upchuck() or by upchucking a downstream UAna; see UAna documentation). The window size (along with an arbitry window shape) is controlled via the .window method. The hop size is complete dynamic, and is throttled by how time is advanced.";
424424
425425 if( !type_engine_import_uana_begin( env, "DCT", "UAna", env->global(),
426426 DCT_ctor, DCT_dtor,
@@ -473,7 +473,7 @@ DLL_QUERY xform_query( Chuck_DL_Query * QUERY ) · 46 unmodified lines
473473 // init as base class: IDCT
474474 //---------------------------------------------------------------------
475475
476− doc = " This UAna computes the inverse Discrete Cosine Transform on incoming spectral frames (on demand), and overlap-adds the results into its internal buffer, ready to be sent to other UGen's connected via =>. The window size (along with an arbitry window shape) is controlled via the .window method.";
476+ doc = "computes the inverse Discrete Cosine Transform on incoming spectral frames (on demand), and overlap-adds the results into its internal buffer, ready to be sent to other UGen's connected via =>. The window size (along with an arbitry window shape) is controlled via the .window method.";
477477
478478 if( !type_engine_import_uana_begin( env, "IDCT", "UAna", env->global(),
479479 IDCT_ctor, IDCT_dtor,
src/core/ugen_filter.cpp+62−62
@@ -80,7 +80,7 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 79 unmodified lines
8080 //---------------------------------------------------------------------
8181 // init as base class: FilterBasic
8282 //---------------------------------------------------------------------
83− doc = "Filter base class.";
83+ doc = "base class for basic filters with a notion of center/cutoff frequency and Q.";
8484 if( !type_engine_import_ugen_begin( env, "FilterBasic", "UGen", env->global(),
8585 FilterBasic_ctor, FilterBasic_dtor,
8686 FilterBasic_tick, FilterBasic_pmsg,
@@ -94,26 +94,26 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 7 unmodified lines
9494 // freq
9595 func = make_new_mfun( "float", "freq", FilterBasic_ctrl_freq );
9696 func->add_arg( "float", "val" );
97− func->doc = "Set filter cutoff/center frequency.";
97+ func->doc = "set filter cutoff/center frequency.";
9898 if( !type_engine_import_mfun( env, func ) ) goto error;
9999 func = make_new_mfun( "float", "freq", FilterBasic_cget_freq );
100− func->doc = "Get filter cutoff/center frequency.";
100+ func->doc = "get filter cutoff/center frequency.";
101101 if( !type_engine_import_mfun( env, func ) ) goto error;
102102
103103 // Q
104104 func = make_new_mfun( "float", "Q", FilterBasic_ctrl_Q );
105105 func->add_arg( "float", "val" );
106− func->doc = "Set filter resonance.";
106+ func->doc = "set filter resonance.";
107107 if( !type_engine_import_mfun( env, func ) ) goto error;
108108 func = make_new_mfun( "float", "Q", FilterBasic_cget_Q );
109− func->doc = "Get filter resonance.";
109+ func->doc = "get filter resonance.";
110110 if( !type_engine_import_mfun( env, func ) ) goto error;
111111
112112 // set
113113 func = make_new_mfun( "void", "set", FilterBasic_ctrl_set );
114114 func->add_arg( "float", "freq" );
115115 func->add_arg( "float", "Q" );
116− func->doc = "Set filter frequency and resonance at the same time.";
116+ func->doc = "set filter frequency and resonance at the same time.";
117117 if( !type_engine_import_mfun( env, func ) ) goto error;
118118
119119 // end the class import
@@ -161,7 +161,7 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 41 unmodified lines
161161 //---------------------------------------------------------------------
162162 // init class: BPF
163163 //---------------------------------------------------------------------
164− doc = "Bandpass filter (2nd order Butterworth).";
164+ doc = "a bandpass filter (2nd order Butterworth).";
165165 if( !type_engine_import_ugen_begin( env, "BPF", "FilterBasic", env->global(),
166166 BPF_ctor, NULL, BPF_tick, BPF_pmsg, doc.c_str() ) )
167167 return FALSE;
@@ -171,26 +171,26 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
171171 // freq
172172 func = make_new_mfun( "float", "freq", BPF_ctrl_freq );
173173 func->add_arg( "float", "val" );
174− func->doc = "Set filter center frequency.";
174+ func->doc = "set filter center frequency.";
175175 if( !type_engine_import_mfun( env, func ) ) goto error;
176176 func = make_new_mfun( "float", "freq", BPF_cget_freq );
177− func->doc = "Set filter center frequency.";
177+ func->doc = "set filter center frequency.";
178178 if( !type_engine_import_mfun( env, func ) ) goto error;
179179
180180 // Q
181181 func = make_new_mfun( "float", "Q", BPF_ctrl_Q );
182182 func->add_arg( "float", "val" );
183− func->doc = "Set filter resonance.";
183+ func->doc = "set filter resonance.";
184184 if( !type_engine_import_mfun( env, func ) ) goto error;
185185 func = make_new_mfun( "float", "Q", BPF_cget_Q );
186− func->doc = "Get filter resonance.";
186+ func->doc = "get filter resonance.";
187187 if( !type_engine_import_mfun( env, func ) ) goto error;
188188
189189 // set
190190 func = make_new_mfun( "void", "set", BPF_ctrl_set );
191191 func->add_arg( "float", "freq" );
192192 func->add_arg( "float", "Q" );
193− func->doc = "Set filter frequency and resonance at the same time.";
193+ func->doc = "get filter frequency and resonance at the same time.";
194194 if( !type_engine_import_mfun( env, func ) ) goto error;
195195
196196 // end the class import
@@ -200,7 +200,7 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
200200 //---------------------------------------------------------------------
201201 // init class: BRF
202202 //---------------------------------------------------------------------
203− doc = "Band-reject filter (2nd order Butterworth).";
203+ doc = "a band-reject filter (2nd order Butterworth).";
204204 if( !type_engine_import_ugen_begin( env, "BRF", "FilterBasic", env->global(),
205205 BRF_ctor, NULL, BRF_tick, BRF_pmsg, doc.c_str() ) )
206206 return FALSE;
@@ -210,26 +210,26 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
210210 // freq
211211 func = make_new_mfun( "float", "freq", BRF_ctrl_freq );
212212 func->add_arg( "float", "val" );
213− func->doc = "Set filter center frequency.";
213+ func->doc = "set filter center frequency.";
214214 if( !type_engine_import_mfun( env, func ) ) goto error;
215215 func = make_new_mfun( "float", "freq", BRF_cget_freq );
216− func->doc = "Get filter center frequency.";
216+ func->doc = "get filter center frequency.";
217217 if( !type_engine_import_mfun( env, func ) ) goto error;
218218
219219 // Q
220220 func = make_new_mfun( "float", "Q", BRF_ctrl_Q );
221221 func->add_arg( "float", "val" );
222− func->doc = "Set filter resonance.";
222+ func->doc = "set filter resonance.";
223223 if( !type_engine_import_mfun( env, func ) ) goto error;
224224 func = make_new_mfun( "float", "Q", BRF_cget_Q );
225− func->doc = "Get filter resonance.";
225+ func->doc = "get filter resonance.";
226226 if( !type_engine_import_mfun( env, func ) ) goto error;
227227
228228 // set
229229 func = make_new_mfun( "void", "set", BRF_ctrl_set );
230230 func->add_arg( "float", "freq" );
231231 func->add_arg( "float", "Q" );
232− func->doc = "Set filter frequency and resonance at the same time.";
232+ func->doc = "set filter frequency and resonance at the same time.";
233233 if( !type_engine_import_mfun( env, func ) ) goto error;
234234
235235 // end the class import
@@ -239,7 +239,7 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
239239 //---------------------------------------------------------------------
240240 // init class: RLPF
241241 //---------------------------------------------------------------------
242− doc = "Resonant low-pass filter (2nd order Butterworth).";
242+ doc = "a resonant low-pass filter (2nd order Butterworth).";
243243 if( !type_engine_import_ugen_begin( env, "LPF", "FilterBasic", env->global(),
244244 RLPF_ctor, NULL, RLPF_tick, RLPF_pmsg, doc.c_str() ) )
245245 return FALSE;
@@ -249,26 +249,26 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
249249 // freq
250250 func = make_new_mfun( "float", "freq", RLPF_ctrl_freq );
251251 func->add_arg( "float", "val" );
252− func->doc = "Set filter cutoff frequency.";
252+ func->doc = "set filter cutoff frequency.";
253253 if( !type_engine_import_mfun( env, func ) ) goto error;
254254 func = make_new_mfun( "float", "freq", RLPF_cget_freq );
255− func->doc = "Get filter cutoff frequency.";
255+ func->doc = "get filter cutoff frequency.";
256256 if( !type_engine_import_mfun( env, func ) ) goto error;
257257
258258 // Q
259259 func = make_new_mfun( "float", "Q", RLPF_ctrl_Q );
260260 func->add_arg( "float", "val" );
261− func->doc = "Set filter resonance.";
261+ func->doc = "set filter resonance.";
262262 if( !type_engine_import_mfun( env, func ) ) goto error;
263263 func = make_new_mfun( "float", "Q", RLPF_cget_Q );
264− func->doc = "Get filter resonance.";
264+ func->doc = "get filter resonance.";
265265 if( !type_engine_import_mfun( env, func ) ) goto error;
266266
267267 // set
268268 func = make_new_mfun( "void", "set", RLPF_ctrl_set );
269269 func->add_arg( "float", "freq" );
270270 func->add_arg( "float", "Q" );
271− func->doc = "Set filter frequency and resonance at the same time.";
271+ func->doc = "set filter frequency and resonance at the same time.";
272272 if( !type_engine_import_mfun( env, func ) ) goto error;
273273
274274 // end the class import
@@ -278,7 +278,7 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
278278 //---------------------------------------------------------------------
279279 // init class: RHPF
280280 //---------------------------------------------------------------------
281− doc = "Resonant high-pass filter (2nd order Butterworth).";
281+ doc = "a resonant high-pass filter (2nd order Butterworth).";
282282 if( !type_engine_import_ugen_begin( env, "HPF", "FilterBasic", env->global(),
283283 RHPF_ctor, NULL, RHPF_tick, RHPF_pmsg, doc.c_str() ) )
284284 return FALSE;
@@ -288,26 +288,26 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
288288 // freq
289289 func = make_new_mfun( "float", "freq", RHPF_ctrl_freq );
290290 func->add_arg( "float", "val" );
291− func->doc = "Set filter cutoff frequency.";
291+ func->doc = "set filter cutoff frequency.";
292292 if( !type_engine_import_mfun( env, func ) ) goto error;
293293 func = make_new_mfun( "float", "freq", RHPF_cget_freq );
294− func->doc = "Get filter cutoff frequency.";
294+ func->doc = "get filter cutoff frequency.";
295295 if( !type_engine_import_mfun( env, func ) ) goto error;
296296
297297 // Q
298298 func = make_new_mfun( "float", "Q", RHPF_ctrl_Q );
299299 func->add_arg( "float", "val" );
300− func->doc = "Set filter resonance.";
300+ func->doc = "set filter resonance.";
301301 if( !type_engine_import_mfun( env, func ) ) goto error;
302302 func = make_new_mfun( "float", "Q", RHPF_cget_Q );
303− func->doc = "Get filter resonance.";
303+ func->doc = "get filter resonance.";
304304 if( !type_engine_import_mfun( env, func ) ) goto error;
305305
306306 // set
307307 func = make_new_mfun( "void", "set", RHPF_ctrl_set );
308308 func->add_arg( "float", "freq" );
309309 func->add_arg( "float", "Q" );
310− func->doc = "Set filter frequency and resonance at the same time.";
310+ func->doc = "set filter frequency and resonance at the same time.";
311311 if( !type_engine_import_mfun( env, func ) ) goto error;
312312
313313 // end the class import
@@ -317,7 +317,7 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
317317 //---------------------------------------------------------------------
318318 // init class: ResonZ
319319 //---------------------------------------------------------------------
320− doc = "Resonant filter. BiQuad with equal-gain zeros, keeps gain under control independent of frequency.";
320+ doc = "a resonance filter with equal-gain zeros; keeps gain under control independent of frequency.";
321321 if( !type_engine_import_ugen_begin( env, "ResonZ", "FilterBasic", env->global(),
322322 ResonZ_ctor, NULL, ResonZ_tick, ResonZ_pmsg, doc.c_str() ) )
323323 return FALSE;
@@ -327,26 +327,26 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
327327 // freq
328328 func = make_new_mfun( "float", "freq", ResonZ_ctrl_freq );
329329 func->add_arg( "float", "val" );
330− func->doc = "Set filter center frequency.";
330+ func->doc = "set filter center frequency.";
331331 if( !type_engine_import_mfun( env, func ) ) goto error;
332332 func = make_new_mfun( "float", "freq", ResonZ_cget_freq );
333− func->doc = "Get filter center frequency.";
333+ func->doc = "get filter center frequency.";
334334 if( !type_engine_import_mfun( env, func ) ) goto error;
335335
336336 // reson
337337 func = make_new_mfun( "float", "Q", ResonZ_ctrl_Q );
338338 func->add_arg( "float", "val" );
339− func->doc = "Set filter resonance.";
339+ func->doc = "set filter resonance.";
340340 if( !type_engine_import_mfun( env, func ) ) goto error;
341341 func = make_new_mfun( "float", "Q", ResonZ_cget_Q );
342− func->doc = "Get filter resonance.";
342+ func->doc = "get filter resonance.";
343343 if( !type_engine_import_mfun( env, func ) ) goto error;
344344
345345 // set
346346 func = make_new_mfun( "void", "set", ResonZ_ctrl_set );
347347 func->add_arg( "float", "freq" );
348348 func->add_arg( "float", "Q" );
349− func->doc = "Set filter frequency and resonance at the same time.";
349+ func->doc = "set filter frequency and resonance at the same time.";
350350 if( !type_engine_import_mfun( env, func ) ) goto error;
351351
352352 // end the class import
@@ -356,7 +356,7 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
356356 //---------------------------------------------------------------------
357357 // init as base class: BiQuad
358358 //---------------------------------------------------------------------
359− doc = "STK biquad (two-pole, two-zero) filter class. A method is provided for creating a resonance in the frequency response while maintaining a constant filter gain.";
359+ doc = "a BiQuad (two-pole, two-zero) filter section from STK. A method is provided for creating a resonance in the frequency response while maintaining a constant filter gain.";
360360 if( !type_engine_import_ugen_begin( env, "BiQuad", "UGen", env->global(),
361361 biquad_ctor, biquad_dtor, biquad_tick, NULL, doc.c_str() ) )
362362 return FALSE;
@@ -368,115 +368,115 @@ DLL_QUERY filter_query( Chuck_DL_Query * QUERY ) · 5 unmodified lines
368368 // pfreq
369369 func = make_new_mfun ( "float", "pfreq", biquad_ctrl_pfreq );
370370 func->add_arg ( "float", "freq" );
371− func->doc = "Set resonance frequency (poles).";
371+ func->doc = "set resonance frequency (poles).";
372372 if( !type_engine_import_mfun( env, func ) ) goto error;
373373 func = make_new_mfun ( "float", "pfreq", biquad_cget_pfreq );
374− func->doc = "Get resonance frequency (poles).";
374+ func->doc = "get resonance frequency (poles).";
375375 if( !type_engine_import_mfun( env, func ) ) goto error;
376376
377377 // prad
378378 func = make_new_mfun ( "float", "prad", biquad_ctrl_prad );
379379 func->add_arg ( "float", "value" );
380− func->doc = "Set Pole radius (values greater than 1 will be unstable).";
380+ func->doc = "set Pole radius (values greater than 1 will be unstable).";
381381 if( !type_engine_import_mfun( env, func ) ) goto error;
382382 func = make_new_mfun ( "float", "prad", biquad_cget_prad );
383− func->doc = "Get pole radius.";
383+ func->doc = "get pole radius.";
384384 if( !type_engine_import_mfun( env, func ) ) goto error;
385385
386386 // zfreq
387387 func = make_new_mfun ( "float", "zfreq", biquad_ctrl_zfreq );
388388 func->add_arg ( "float", "freq" );
389− func->doc = "Set notch frequency.";
389+ func->doc = "set notch frequency.";
390390 if( !type_engine_import_mfun( env, func ) ) goto error;
391391 func = make_new_mfun ( "float", "zfreq", biquad_cget_zfreq );
392− func->doc = "Get notch frequency.";
392+ func->doc = "get notch frequency.";
393393 if( !type_engine_import_mfun( env, func ) ) goto error;
394394
395395 // zrad
396396 func = make_new_mfun ( "float", "zrad", biquad_ctrl_zrad );
397397 func->add_arg ( "float", "value" );
398− func->doc = "Set zero radius.";
398+ func->doc = "set zero radius.";
399399 if( !type_engine_import_mfun( env, func ) ) goto error;
400400 func = make_new_mfun ( "float", "zrad", biquad_cget_zrad );
401− func->doc = "Get zero radius.";
401+ func->doc = "get zero radius.";
402402 if( !type_engine_import_mfun( env, func ) ) goto error;
403403
404404 // norm
405405 func = make_new_mfun ( "int", "norm", biquad_ctrl_norm );
406406 func->add_arg ( "int", "value" );
407− func->doc = "Toggle normalization.";
407+ func->doc = "toggle normalization.";
408408 if( !type_engine_import_mfun( env, func ) ) goto error;
409409 func = make_new_mfun ( "int", "norm", biquad_cget_norm );
410− func->doc = "Get normalization.";
410+ func->doc = "get normalization setting.";
411411 if( !type_engine_import_mfun( env, func ) ) goto error;
412412
413413 // pregain
414414 func = make_new_mfun ( "float", "pregain", biquad_ctrl_pregain );
415415 func->add_arg ( "float", "level" );
416− func->doc = "Set pregain.";
416+ func->doc = "set pregain.";
417417 if( !type_engine_import_mfun( env, func ) ) goto error;
418418 func = make_new_mfun ( "float", "pregain", biquad_cget_pregain );
419− func->doc = "Get pregain.";
419+ func->doc = "get pregain.";
420420 if( !type_engine_import_mfun( env, func ) ) goto error;
421421
422422 // eqzs
423423 func = make_new_mfun ( "int", "eqzs", biquad_ctrl_eqzs );
424424 func->add_arg ( "int", "value" );
425− func->doc = "Toggle equal-gain zeroes. ";
425+ func->doc = "enable equal-gain zeroes.";
426426 if( !type_engine_import_mfun( env, func ) ) goto error;
427427
428428 // b0
429429 func = make_new_mfun ( "float", "b0", biquad_ctrl_b0 );
430430 func->add_arg ( "float", "value" );
431− func->doc = "Set filter coefficient.";
431+ func->doc = "set filter coefficient.";
432432 if( !type_engine_import_mfun( env, func ) ) goto error;
433433 func = make_new_mfun ( "float", "b0", biquad_cget_b0 );
434− func->doc = "Get filter coefficient.";
434+ func->doc = "get filter coefficient.";
435435 if( !type_engine_import_mfun( env, func ) ) goto error;
436436
437437 // b1
438438 func = make_new_mfun ( "float", "b1", biquad_ctrl_b1 );
439439 func->add_arg ( "float", "value" );
440− func->doc = "Set filter coefficient.";
440+ func->doc = "set filter coefficient.";
441441 if( !type_engine_import_mfun( env, func ) ) goto error;
442442 func = make_new_mfun ( "float", "b1", biquad_cget_b1 );
443− func->doc = "Get filter coefficient.";
443+ func->doc = "get filter coefficient.";
444444 if( !type_engine_import_mfun( env, func ) ) goto error;
445445
446446 // b2
447447 func = make_new_mfun ( "float", "b2", biquad_ctrl_b2 );
448448 func->add_arg ( "float", "value" );
449− func->doc = "Set filter coefficient.";
449+ func->doc = "set filter coefficient.";
450450 if( !type_engine_import_mfun( env, func ) ) goto error;
451451 func = make_new_mfun ( "float", "b2", biquad_cget_b2 );
452− func->doc = "Get filter coefficient.";
452+ func->doc = "get filter coefficient.";
453453 if( !type_engine_import_mfun( env, func ) ) goto error;
454454
455455 // a0
456456 func = make_new_mfun ( "float", "a0", biquad_ctrl_a0 );
457457 func->add_arg ( "float", "value" );
458− func->doc = "Set filter coefficient.";
458+ func->doc = "set filter coefficient.";
459459 if( !type_engine_import_mfun( env, func ) ) goto error;
460460 func = make_new_mfun ( "float", "a0", biquad_cget_a0 );
461− func->doc = "Get filter coefficient.";
461+ func->doc = "get filter coefficient.";
462462 if( !type_engine_import_mfun( env, func ) ) goto error;
463463
464464 // a1
465465 func = make_new_mfun ( "float", "a1", biquad_ctrl_a1 );
466466 func->add_arg ( "float", "value" );
467− func->doc = "Set filter coefficient.";
467+ func->doc = "set filter coefficient.";
468468 if( !type_engine_import_mfun( env, func ) ) goto error;
469469 func = make_new_mfun ( "float", "a1", biquad_cget_a1 );
470− func->doc = "Get filter coefficient.";
470+ func->doc = "get filter coefficient.";
471471 if( !type_engine_import_mfun( env, func ) ) goto error;
472472
473473 // a2
474474 func = make_new_mfun ( "float", "a2", biquad_ctrl_a2 );
475475 func->add_arg ( "float", "value" );
476− func->doc = "Set filter coefficient.";
476+ func->doc = "set filter coefficient.";
477477 if( !type_engine_import_mfun( env, func ) ) goto error;
478478 func = make_new_mfun ( "float", "a2", biquad_cget_a2 );
479− func->doc = "Get filter coefficient.";
479+ func->doc = "get filter coefficient.";
480480 if( !type_engine_import_mfun( env, func ) ) goto error;
481481
482482 // end the class import
src/core/ugen_osc.cpp+40−39
@@ -71,7 +71,7 @@ DLL_QUERY osc_query( Chuck_DL_Query * QUERY ) · 70 unmodified lines
7171 //---------------------------------------------------------------------
7272 // init as base class: osc
7373 //---------------------------------------------------------------------
74− doc = "Base class for simple oscillator unit generators.";
74+ doc = "base class for simple oscillator unit generators.";
7575 if( !type_engine_import_ugen_begin( env, "Osc", "UGen", env->global(),
7676 osc_ctor, osc_dtor, osc_tick, osc_pmsg,
7777 doc.c_str() ) )
@@ -84,42 +84,43 @@ DLL_QUERY osc_query( Chuck_DL_Query * QUERY ) · 6 unmodified lines
8484 // add ctrl: freq
8585 func = make_new_mfun( "float", "freq", osc_ctrl_freq );
8686 func->add_arg( "float", "hz" );
87− func->doc = "Frequency of oscillator in Hertz (cycles per second).";
87+ func->doc = "set frequency of oscillator in Hertz; maintains phase.";
8888 if( !type_engine_import_mfun( env, func ) ) goto error;
8989 func = make_new_mfun( "float", "freq", osc_cget_freq );
90− func->doc = "Frequency of oscillator in Hertz (cycles per second).";
90+ func->doc = "get frequency of oscillator in Hertz.";
9191 if( !type_engine_import_mfun( env, func ) ) goto error;
9292
9393 // add ctrl: period
9494 func = make_new_mfun( "dur", "period", osc_ctrl_period );
9595 func->add_arg( "dur", "value" );
96− func->doc = "Period of oscillator (inverse of frequency).";
96+ func->doc = "set period of oscillator (inverse of frequency).";
9797 if( !type_engine_import_mfun( env, func ) ) goto error;
9898 func = make_new_mfun( "dur", "period", osc_cget_period );
99− func->doc = "Period of oscillator (inverse of frequency).";
99+ func->doc = "get period of oscillator (inverse of frequency).";
100100 if( !type_engine_import_mfun( env, func ) ) goto error;
101101
102102 // add ctrl: sfreq ( == freq )
103103 func = make_new_mfun( "float", "sfreq", osc_ctrl_freq );
104104 func->add_arg( "float", "hz" );
105+ func->doc = "set frequency of oscillator in Hertz; resets phase to 0.";
105106 if( !type_engine_import_mfun( env, func ) ) goto error;
106107
107108 // add ctrl: phase
108109 func = make_new_mfun( "float", "phase", osc_ctrl_phase );
109110 func->add_arg( "float", "phase" );
110− func->doc = "Oscillator phase, in range [0,1). ";
111+ func->doc = "set oscillator phase, in range [0,1).";
111112 if( !type_engine_import_mfun( env, func ) ) goto error;
112113 func = make_new_mfun( "float", "phase", osc_cget_phase );
113− func->doc = "Oscillator phase, in range [0,1). ";
114+ func->doc = "get oscillator phase, in range [0,1).";
114115 if( !type_engine_import_mfun( env, func ) ) goto error;
115116
116117 // add ctrl: sync
117118 func = make_new_mfun( "int", "sync", osc_ctrl_sync );
118119 func->add_arg( "int", "type" );
119− func->doc = "Mode for input (if any). 0: sync frequency to input, 1: sync phase to input, 2: frequency modulation (add input to set frequency)";
120+ func->doc = "choose how to interpret input: (0) sync frequency to input; (1) sync phase to input; (2) frequency modulation (add input to internal frequency).";
120121 if( !type_engine_import_mfun( env, func ) ) goto error;
121122 func = make_new_mfun( "int", "sync", osc_cget_sync );
122− func->doc = "Mode for input (if any). 0: sync frequency to input, 1: sync phase to input, 2: frequency modulation (add input to set frequency)";
123+ func->doc = "get current interpretation of input: (0) sync frequency to input; (1) sync phase to input; (2) frequency modulation (add input to internal frequency).";
123124 if( !type_engine_import_mfun( env, func ) ) goto error;
124125
125126 // end the class import
@@ -129,7 +130,7 @@ DLL_QUERY osc_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
129130 //---------------------------------------------------------------------
130131 // phasor
131132 //---------------------------------------------------------------------
132− doc = "Phasor oscillator. Linearly rises from 0 to 1. Can be used as a phase control.";
133+ doc = "a phasor oscillator; linearly rises from 0 to 1; can be used as a phase control.";
133134 if( !type_engine_import_ugen_begin( env, "Phasor", "Osc", env->global(),
134135 NULL, NULL, osc_tick, NULL,
135136 doc.c_str() ) )
@@ -141,7 +142,7 @@ DLL_QUERY osc_query( Chuck_DL_Query * QUERY ) · 5 unmodified lines
141142 //---------------------------------------------------------------------
142143 // sinosc
143144 //---------------------------------------------------------------------
144− doc = "Sine wave oscillator.";
145+ doc = "a sine wave oscillator.";
145146 if( !type_engine_import_ugen_begin( env, "SinOsc", "Osc", env->global(),
146147 NULL, NULL, sinosc_tick, NULL,
147148 doc.c_str() ) )
@@ -156,7 +157,7 @@ DLL_QUERY osc_query( Chuck_DL_Query * QUERY ) · 8 unmodified lines
156157 //---------------------------------------------------------------------
157158 // triosc - triangle oscillator
158159 //---------------------------------------------------------------------
159− doc = "Triangle wave oscillator.";
160+ doc = "a triangle wave oscillator.";
160161 if( !type_engine_import_ugen_begin( env, "TriOsc", "Osc", env->global(),
161162 NULL, NULL, triosc_tick, NULL,
162163 doc.c_str() ) )
@@ -164,11 +165,11 @@ DLL_QUERY osc_query( Chuck_DL_Query * QUERY ) · 1 unmodified line
164165
165166 func = make_new_mfun( "float", "width", osc_ctrl_width );
166167 func->add_arg( "float", "width" );
167− func->doc = "Width of triangle wave (ratio of rise time to fall time).";
168+ func->doc = "set width of triangle wave (ratio of rise time to fall time).";
168169 if( !type_engine_import_mfun( env, func ) ) goto error;
169170
170171 func = make_new_mfun( "float", "width", osc_cget_width );
171− func->doc = "Width of triangle wave (ratio of rise time to fall time).";
172+ func->doc = "get width of triangle wave (ratio of rise time to fall time).";
172173 if( !type_engine_import_mfun( env, func ) ) goto error;
173174
174175 // end the class import
@@ -178,7 +179,7 @@ DLL_QUERY osc_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
178179 //---------------------------------------------------------------------
179180 // sawosc - sawtooth oscillator ( 0 | 1 triangle wave )
180181 //---------------------------------------------------------------------
181− doc = "Sawtooth wave oscillator.";
182+ doc = "sawtooth wave oscillator.";
182183 if( !type_engine_import_ugen_begin( env, "SawOsc", "TriOsc", env->global(),
183184 sawosc_ctor, NULL, NULL, NULL,
184185 doc.c_str() ) )
@@ -186,11 +187,11 @@ DLL_QUERY osc_query( Chuck_DL_Query * QUERY ) · 1 unmodified line
186187
187188 func = make_new_mfun( "float", "width", sawosc_ctrl_width );
188189 func->add_arg( "float", "width" );
189− func->doc = "Whether falling sawtooth wave (0) or rising sawtooth wave (1).";
190+ func->doc = "whether sawtooth wave is to fall (0) or rise (1).";
190191 if( !type_engine_import_mfun( env, func ) ) goto error;
191192
192193 func = make_new_mfun( "float", "width", osc_cget_width );
193− func->doc = "Whether falling sawtooth wave (0) or rising sawtooth wave (1).";
194+ func->doc = "whether sawtooth wave is to fall (0) or rise (1).";
194195 if( !type_engine_import_mfun( env, func ) ) goto error;
195196
196197 // end the class import
@@ -200,7 +201,7 @@ DLL_QUERY osc_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
200201 //---------------------------------------------------------------------
201202 // pulseosc - pulse-width oscillator
202203 //---------------------------------------------------------------------
203− doc = "Pulse width oscillator.";
204+ doc = "a pulse width oscillator.";
204205 if( !type_engine_import_ugen_begin( env, "PulseOsc", "Osc", env->global(),
205206 NULL, NULL, pulseosc_tick, NULL,
206207 doc.c_str() ) )
@@ -208,11 +209,11 @@ DLL_QUERY osc_query( Chuck_DL_Query * QUERY ) · 1 unmodified line
208209
209210 func = make_new_mfun( "float", "width", osc_ctrl_width );
210211 func->add_arg( "float", "width" );
211− func->doc = "Length of duty cycle [0,1).";
212+ func->doc = "set width of duty cycle [0,1).";
212213 if( !type_engine_import_mfun( env, func ) ) goto error;
213214
214215 func = make_new_mfun( "float", "width", osc_cget_width );
215− func->doc = "Length of duty cycle [0,1).";
216+ func->doc = "get width of duty cycle [0,1)/";
216217 if( !type_engine_import_mfun( env, func ) ) goto error;
217218
218219 // end the class import
@@ -222,14 +223,14 @@ DLL_QUERY osc_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
222223 //---------------------------------------------------------------------
223224 // sqrosc - square_wave oscillator ( 0.5 pulse )
224225 //---------------------------------------------------------------------
225− doc = "Square wave oscillator (pulse with 0.5 duty cycle).";
226+ doc = "a square wave oscillator (same as PulseOsc with 0.5 duty cycle).";
226227 if( !type_engine_import_ugen_begin( env, "SqrOsc", "PulseOsc", env->global(),
227228 sqrosc_ctor, NULL, NULL, NULL,
228229 doc.c_str() ) )
229230 return FALSE;
230231
231232 func = make_new_mfun( "float", "width", sqrosc_ctrl_width );
232− func->doc = "Length of duty cycle (always 0.5)";
233+ func->doc = "set width of duty cycle (always 0.5).";
233234 if( !type_engine_import_mfun( env, func ) ) goto error;
234235
235236 // end the class import
@@ -916,7 +917,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 680 unmodified lines
916917 std::string doc;
917918 Chuck_DL_Func * func = NULL;
918919
919− doc = "Ported from rtcmix. See <a href=\"http://www.music.columbia.edu/cmix/makegens.html\">\
920+ doc = "ported from rtcmix. See <a href=\"http://www.music.columbia.edu/cmix/makegens.html\">\
920921 http://www.music.columbia.edu/cmix/makegens.html</a> \
921922 for more information on the GenX family of UGens. Currently coefficients past \
922923 the 100th are ignored.\
@@ -940,12 +941,12 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 17 unmodified lines
940941
941942 func = make_new_mfun( "float", "lookup", genX_lookup ); //lookup table value
942943 func->add_arg( "float", "which" );
943− func->doc = "Returns lookup table value at index i [ -1, 1 ]. Absolute value is used in the range [ -1, 0 ).";
944+ func->doc = "get lookup table value at index i [ -1, 1 ]; absolute value is used in the range [ -1, 0 )";
944945 if( !type_engine_import_mfun( env, func ) ) goto error;
945946
946947 func = make_new_mfun( "float[]", "coefs", genX_coeffs ); //load table
947948 func->add_arg( "float", "v[]" );
948− func->doc = "Set lookup table coefficients. Meaning is dependent on subclass.";
949+ func->doc = "set lookup table coefficients; meaning is dependent on subclass";
949950 if( !type_engine_import_mfun( env, func ) ) goto error;
950951
951952 // end the class import
@@ -955,7 +956,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
955956 //---------------------------------------------------------------------
956957 // gen5
957958 //---------------------------------------------------------------------
958− doc = "Constructs a lookup table composed of sequential exponential curves. "
959+ doc = "constructs a lookup table composed of sequential exponential curves. "
959960 "For a table with N curves, starting value of y', and value yn for lookup "
960961 "index xn, set the coefficients to [ y', y0, x0, ..., yN-1, xN-1 ]. "
961962 "Note that there must be an odd number of coefficients. "
@@ -969,7 +970,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 7 unmodified lines
969970
970971 func = make_new_mfun( "float[]", "coefs", gen5_coeffs ); //load table
971972 func->add_arg( "float", "v[]" );
972− func->doc = "Set lookup table coefficients.";
973+ func->doc = "set lookup table coefficients.";
973974 if( !type_engine_import_mfun( env, func ) ) goto error;
974975
975976 // end the class import
@@ -980,7 +981,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 4 unmodified lines
980981 //---------------------------------------------------------------------
981982 // gen7
982983 //---------------------------------------------------------------------
983− doc = "Constructs a lookup table composed of sequential line segments. "
984+ doc = "constructs a lookup table composed of sequential line segments. "
984985 "For a table with N lines, starting value of y', and value yn for lookup"
985986 "index xn, set the coefficients to [ y', y0, x0, ..., yN-1, xN-1 ]. "
986987 "Note that there must be an odd number of coefficients. "
@@ -993,7 +994,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 6 unmodified lines
993994
994995 func = make_new_mfun( "float[]", "coefs", gen7_coeffs ); //load table
995996 func->add_arg( "float", "v[]" );
996− func->doc = "Set lookup table coefficients.";
997+ func->doc = "set lookup table coefficients.";
997998 if( !type_engine_import_mfun( env, func ) ) goto error;
998999
9991000 // end the class import
@@ -1003,7 +1004,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
10031004 //---------------------------------------------------------------------
10041005 // gen9
10051006 //---------------------------------------------------------------------
1006− doc = "Constructs a lookup table of partials with specified amplitudes, "
1007+ doc = "constructs a lookup table of partials with specified amplitudes, "
10071008 "phases, and harmonic ratios to the fundamental. "
10081009 "Coefficients are specified in triplets of [ ratio, amplitude, phase ] "
10091010 "arranged in a single linear array.";
@@ -1014,7 +1015,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 4 unmodified lines
10141015
10151016 func = make_new_mfun( "float[]", "coefs", gen9_coeffs ); //load table
10161017 func->add_arg( "float", "v[]" );
1017− func->doc = "Set lookup table coefficients.";
1018+ func->doc = "set lookup table coefficients.";
10181019 if( !type_engine_import_mfun( env, func ) ) goto error;
10191020
10201021 // end the class import
@@ -1025,7 +1026,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 4 unmodified lines
10251026 //---------------------------------------------------------------------
10261027 // gen10
10271028 //---------------------------------------------------------------------
1028− doc = "Constructs a lookup table of harmonic partials with specified "
1029+ doc = "constructs a lookup table of harmonic partials with specified "
10291030 "amplitudes. The amplitude of partial n is specified by the nth element of "
10301031 "the coefficients. For example, setting coefs to [ 1 ] will produce a sine wave.";
10311032
@@ -1035,7 +1036,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
10351036
10361037 func = make_new_mfun( "float[]", "coefs", gen10_coeffs ); //load table
10371038 func->add_arg( "float", "v[]" );
1038− func->doc = "Set lookup table coefficients.";
1039+ func->doc = "set lookup table coefficients.";
10391040 if( !type_engine_import_mfun( env, func ) ) goto error;
10401041
10411042 // end the class import
@@ -1045,7 +1046,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
10451046 //---------------------------------------------------------------------
10461047 // gen17
10471048 //---------------------------------------------------------------------
1048− doc = "Constructs a Chebyshev polynomial wavetable with harmonic partials "
1049+ doc = "constructs a Chebyshev polynomial wavetable with harmonic partials "
10491050 "of specified weights. The weight of partial n is specified by the nth "
10501051 "element of the coefficients. Primarily used for waveshaping, driven by a "
10511052 "SinOsc instead of a Phasor. See "
@@ -1060,7 +1061,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 8 unmodified lines
10601061
10611062 func = make_new_mfun( "float[]", "coefs", gen17_coeffs ); //load table
10621063 func->add_arg( "float", "v[]" );
1063− func->doc = "Set lookup table coefficients.";
1064+ func->doc = "set lookup table coefficients.";
10641065 if( !type_engine_import_mfun( env, func ) ) goto error;
10651066
10661067 // end the class import
@@ -1069,7 +1070,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 2 unmodified lines
10691070 //---------------------------------------------------------------------
10701071 // Curve
10711072 //---------------------------------------------------------------------
1072− doc = "Constructs a wavetable composed of segments of variable times, "
1073+ doc = "constructs a wavetable composed of segments of variable times, "
10731074 "values, and curvatures. Coefficients are specified as a single linear "
10741075 "array of triplets of [ time, value, curvature ] followed by a final duple "
10751076 "of [ time, value ] to specify the final value of the table. time values "
@@ -1083,7 +1084,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 7 unmodified lines
10831084
10841085 func = make_new_mfun( "float[]", "coefs", curve_coeffs ); //load table
10851086 func->add_arg( "float", "v[]" );
1086− func->doc = "Set lookup table coefficients.";
1087+ func->doc = "set lookup table coefficients.";
10871088 if( !type_engine_import_mfun( env, func ) ) goto error;
10881089
10891090 // end the class import
@@ -1092,7 +1093,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 2 unmodified lines
10921093 //---------------------------------------------------------------------
10931094 // Warp
10941095 //---------------------------------------------------------------------
1095− doc = "";
1096+ doc = "...";
10961097
10971098 if( !type_engine_import_ugen_begin( env, "WarpTable", "GenX", env->global(),
10981099 NULL, NULL, genX_tick, NULL, doc.c_str() ) )
@@ -1100,7 +1101,7 @@ DLL_QUERY genX_query( Chuck_DL_Query * QUERY ) · 1 unmodified line
11001101
11011102 func = make_new_mfun( "float[]", "coefs", warp_coeffs ); //load table
11021103 func->add_arg( "float", "v[]" );
1103− func->doc = "Set lookup table coefficients.";
1104+ func->doc = "set lookup table coefficients.";
11041105 if( !type_engine_import_mfun( env, func ) ) goto error;
11051106
11061107 /*
src/core/ugen_stk.cpp+600−600
@@ -1256,10 +1256,10 @@ DLL_QUERY stk_query( Chuck_DL_Query * QUERY ) · 1255 unmodified lines
12561256 //! \section stk - instruments
12571257
12581258 //------------------------------------------------------------------------
1259− // begin Instrmnt ugen
1259+ // begin StkInstrument UGen
12601260 //------------------------------------------------------------------------
12611261
1262− doc = "Super-class for STK instruments.";
1262+ doc = "base class for STK instruments.";
12631263
12641264 if( !type_engine_import_ugen_begin( env, "StkInstrument", "UGen", env->global(),
12651265 Instrmnt_ctor, NULL, Instrmnt_tick, Instrmnt_pmsg,
@@ -1270,27 +1270,27 @@ DLL_QUERY stk_query( Chuck_DL_Query * QUERY ) · 4 unmodified lines
12701270
12711271 func = make_new_mfun( "float", "noteOn", Instrmnt_ctrl_noteOn ); //! note on
12721272 func->add_arg( "float", "value" );
1273− func->doc = "Trigger note on.";
1273+ func->doc = "trigger note on.";
12741274 if( !type_engine_import_mfun( env, func ) ) goto error;
12751275
12761276 func = make_new_mfun( "float", "noteOff", Instrmnt_ctrl_noteOff ); //! note off
12771277 func->add_arg( "float", "value" );
1278− func->doc = "Trigger note off.";
1278+ func->doc = "trigger note off.";
12791279 if( !type_engine_import_mfun( env, func ) ) goto error;
12801280
12811281 func = make_new_mfun( "float", "freq", Instrmnt_ctrl_freq ); //! frequency
12821282 func->add_arg( "float", "value" );
1283− func->doc = "Set frequency.";
1283+ func->doc = "set frequency.";
12841284 if( !type_engine_import_mfun( env, func ) ) goto error;
12851285
12861286 func = make_new_mfun( "float", "freq", Instrmnt_cget_freq ); //! frequency
1287− func->doc = "Get frequency.";
1287+ func->doc = "get frequency.";
12881288 if( !type_engine_import_mfun( env, func ) ) goto error;
12891289
12901290 func = make_new_mfun( "void", "controlChange", Instrmnt_ctrl_controlChange ); //! control change
12911291 func->add_arg( "int", "ctrl" );
12921292 func->add_arg( "float", "value" );
1293− func->doc = "Assert control change; numbers are instrument specific, value range: [0.0 - 128.0]";
1293+ func->doc = "assert control change; numbers are instrument specific, value range: [0.0 - 127.0]";
12941294 if( !type_engine_import_mfun( env, func ) ) goto error;
12951295
12961296 // end the class import
@@ -1301,7 +1301,7 @@ DLL_QUERY stk_query( Chuck_DL_Query * QUERY ) · 4 unmodified lines
13011301 // begin BandedWG ugen
13021302 //------------------------------------------------------------------------
13031303
1304− doc = "This class uses banded waveguide techniques to model a variety of sounds, including bowed bars, glasses, and bowls. For more information, see Essl, G. and Cook, P. 'Banded Waveguides: Towards Physical Modelling of Bar Percussion Instruments', Proceedings of the 1999 International Computer Music Conference.\n\
1304+ doc = "a banded waveguide model for generating a variety of sounds, including bowed bars, glasses, and bowls. For more information, see Essl and Cook 'Banded Waveguides: Towards Physical Modelling of Bar Percussion Instruments', In Proceedings of the 1999 International Computer Music Conference.\n\
13051305 \n\
13061306 Control Change Numbers:\n\
13071307 \n\
@@ -1334,80 +1334,80 @@ Modified for Stk 4.0 by Gary Scavone."; · 26 unmodified lines
13341334
13351335 func = make_new_mfun( "float", "pluck", BandedWG_ctrl_pluck ); //! pluck waveguide
13361336 func->add_arg( "float", "value" );
1337− func->doc = "Pluck instrument, [0.0-1.0].";
1337+ func->doc = "pluck instrument, [0.0-1.0].";
13381338 if( !type_engine_import_mfun( env, func ) ) goto error;
13391339
13401340 func = make_new_mfun( "float", "startBowing", BandedWG_ctrl_startBowing ); //! startBowing
13411341 func->add_arg( "float", "value" );
1342− func->doc = "Start bowing, [0.0-1.0].";
1342+ func->doc = "start bowing, [0.0-1.0].";
13431343 if( !type_engine_import_mfun( env, func ) ) goto error;
13441344
13451345 func = make_new_mfun( "float", "stopBowing", BandedWG_ctrl_stopBowing ); //! stopBowing
13461346 func->add_arg( "float", "value" );
1347− func->doc = "Stop bowing, [0.0-1.0].";
1347+ func->doc = "stop bowing, [0.0-1.0].";
13481348 if( !type_engine_import_mfun( env, func ) ) goto error;
13491349
13501350 func = make_new_mfun( "float", "bowRate", BandedWG_ctrl_bowRate ); //! strike bowRate
13511351 func->add_arg( "float", "value" );
1352− func->doc = "Set bowing rate (seconds).";
1352+ func->doc = "set bowing rate (seconds).";
13531353 if( !type_engine_import_mfun( env, func ) ) goto error;
13541354
13551355 func = make_new_mfun( "float", "bowRate", BandedWG_cget_bowRate ); //! strike bowRate
1356− func->doc = "Get bowing rate (seconds).";
1356+ func->doc = "get bowing rate (seconds).";
13571357 if( !type_engine_import_mfun( env, func ) ) goto error;
13581358
13591359 func = make_new_mfun( "float", "bowPressure", BandedWG_ctrl_bowPressure ); //! bowPressure
13601360 func->add_arg( "float", "value" );
1361− func->doc = "Set bow pressure, [0.0-1.0].";
1361+ func->doc = "set bow pressure, [0.0-1.0].";
13621362 if( !type_engine_import_mfun( env, func ) ) goto error;
13631363
13641364 func = make_new_mfun( "float", "bowPressure", BandedWG_cget_bowPressure ); //! bowPressure
1365− func->doc = "Get bow pressure, [0.0-1.0].";
1365+ func->doc = "get bow pressure, [0.0-1.0].";
13661366 if( !type_engine_import_mfun( env, func ) ) goto error;
13671367
13681368 func = make_new_mfun( "float", "bowMotion", BandedWG_ctrl_bowMotion ); //! bowMotion
13691369 func->add_arg( "float", "value" );
1370− func->doc = "Set bow motion, [0.0-1.0].";
1370+ func->doc = "set bow motion, [0.0-1.0].";
13711371 if( !type_engine_import_mfun( env, func ) ) goto error;
13721372
13731373 func = make_new_mfun( "float", "bowMotion", BandedWG_cget_bowMotion ); //! bowMotion
1374− func->doc = "Get bow motion, [0.0-1.0].";
1374+ func->doc = "get bow motion, [0.0-1.0].";
13751375 if( !type_engine_import_mfun( env, func ) ) goto error;
13761376
13771377 func = make_new_mfun( "float", "integrationConstant", BandedWG_ctrl_vibratoFreq ); //! vibratoFreq
13781378 func->add_arg( "float", "value" );
1379− func->doc = "Set integration constant, vibrato frequency.";
1379+ func->doc = "set integration constant, vibrato frequency.";
13801380 if( !type_engine_import_mfun( env, func ) ) goto error;
13811381
13821382 func = make_new_mfun( "float", "integrationConstant", BandedWG_cget_vibratoFreq ); //! vibratoFreq
1383− func->doc = "Get integration constant, vibrato frequency.";
1383+ func->doc = "get integration constant, vibrato frequency.";
13841384 if( !type_engine_import_mfun( env, func ) ) goto error;
13851385
13861386 func = make_new_mfun( "float", "modesGain", BandedWG_ctrl_modesGain ); //! modesGain
13871387 func->add_arg( "float", "value" );
1388− func->doc = "Set amplitude for modes.";
1388+ func->doc = "set amplitude for modes.";
13891389 if( !type_engine_import_mfun( env, func ) ) goto error;
13901390
13911391 func = make_new_mfun( "float", "modesGain", BandedWG_cget_modesGain ); //! modesGain
1392− func->doc = "Get amplitude for modes.";
1392+ func->doc = "get amplitude for modes.";
13931393 if( !type_engine_import_mfun( env, func ) ) goto error;
13941394
13951395 func = make_new_mfun( "int", "preset", BandedWG_ctrl_preset ); //! preset
13961396 func->add_arg( "int", "value" );
1397− func->doc = "Set instrument preset, (0-3, see above).";
1397+ func->doc = "set instrument preset, (0-3, see above).";
13981398 if( !type_engine_import_mfun( env, func ) ) goto error;
13991399
14001400 func = make_new_mfun( "int", "preset", BandedWG_cget_preset ); //! preset
1401− func->doc = "Get instrument preset, (0-3, see above).";
1401+ func->doc = "get instrument preset, (0-3, see above).";
14021402 if( !type_engine_import_mfun( env, func ) ) goto error;
14031403
14041404 func = make_new_mfun( "float", "strikePosition", BandedWG_ctrl_strikePosition ); //! strike Position
14051405 func->add_arg( "float", "value" );
1406− func->doc = "Set strike position, [0.0-1.0].";
1406+ func->doc = "set strike position, [0.0-1.0].";
14071407 if( !type_engine_import_mfun( env, func ) ) goto error;
14081408
14091409 func = make_new_mfun( "float", "strikePosition", BandedWG_cget_strikePosition ); //! strike Position
1410− func->doc = "Get strike position, [0.0-1.0].";
1410+ func->doc = "get strike position, [0.0-1.0].";
14111411 if( !type_engine_import_mfun( env, func ) ) goto error;
14121412
14131413 // end the class import
@@ -1418,7 +1418,7 @@ Modified for Stk 4.0 by Gary Scavone."; · 4 unmodified lines
14181418 // begin BlowBotl ugen
14191419 //------------------------------------------------------------------------
14201420
1421− doc = "This class implements a helmholtz resonator (biquad filter) with a polynomial jet excitation (a la Cook).\n\
1421+ doc = "a helmholtz resonator (BiQuad filter) with a polynomial jet excitation (a la Cook).\n\
14221422 \n\
14231423 Control Change Numbers:\n\
14241424 \n\
@@ -1442,57 +1442,57 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002"; · 17 unmodified lines
14421442
14431443 func = make_new_mfun( "float", "startBlowing", BlowBotl_ctrl_startBlowing ); //! note on
14441444 func->add_arg( "float", "value" );
1445− func->doc = "Start blowing, [0.0-1.0].";
1445+ func->doc = "start blowing, [0.0-1.0].";
14461446 if( !type_engine_import_mfun( env, func ) ) goto error;
14471447
14481448 func = make_new_mfun( "float", "stopBlowing", BlowBotl_ctrl_stopBlowing ); //! note on
14491449 func->add_arg( "float", "value" );
1450− func->doc = "Stop blowing, [0.0-1.0].";
1450+ func->doc = "stop blowing, [0.0-1.0].";
14511451 if( !type_engine_import_mfun( env, func ) ) goto error;
14521452
14531453 func = make_new_mfun( "float", "rate", BlowBotl_ctrl_rate ); //! attack rate
14541454 func->add_arg( "float", "value" );
1455− func->doc = "Set rate of attack";
1455+ func->doc = "set rate of attack";
14561456 if( !type_engine_import_mfun( env, func ) ) goto error;
14571457
14581458 func = make_new_mfun( "float", "rate", BlowBotl_cget_rate ); //! attack rate
1459− func->doc = "Get rate of attack";
1459+ func->doc = "get rate of attack";
14601460 if( !type_engine_import_mfun( env, func ) ) goto error;
14611461
14621462 func = make_new_mfun( "float", "noiseGain", BlowBotl_ctrl_noiseGain ); //! noiseGain
14631463 func->add_arg( "float", "value" );
1464− func->doc = "Set noise component gain, [0.0-1.0].";
1464+ func->doc = "set noise component gain, [0.0-1.0].";
14651465 if( !type_engine_import_mfun( env, func ) ) goto error;
14661466
14671467 func = make_new_mfun( "float", "noiseGain", BlowBotl_cget_noiseGain ); //! noiseGain
1468− func->doc = "Get noise component gain, [0.0-1.0].";
1468+ func->doc = "get noise component gain, [0.0-1.0].";
14691469 if( !type_engine_import_mfun( env, func ) ) goto error;
14701470
14711471 func = make_new_mfun( "float", "vibratoFreq", BlowBotl_ctrl_vibratoFreq ); //! vibratoFreq
14721472 func->add_arg( "float", "value" );
1473− func->doc = "Set vibrato frequency (Hz).";
1473+ func->doc = "set vibrato frequency (Hz).";
14741474 if( !type_engine_import_mfun( env, func ) ) goto error;
14751475
14761476 func = make_new_mfun( "float", "vibratoFreq", BlowBotl_cget_vibratoFreq ); //! vibratoFreq
1477− func->doc = "Get vibrato frequency (Hz).";
1477+ func->doc = "get vibrato frequency (Hz).";
14781478 if( !type_engine_import_mfun( env, func ) ) goto error;
14791479
14801480 func = make_new_mfun( "float", "vibratoGain", BlowBotl_ctrl_vibratoGain ); //! vibratoGain
14811481 func->add_arg( "float", "value" );
1482− func->doc = "Set vibrato gain, [0.0-1.0].";
1482+ func->doc = "set vibrato gain, [0.0-1.0].";
14831483 if( !type_engine_import_mfun( env, func ) ) goto error;
14841484
14851485 func = make_new_mfun( "float", "vibratoGain", BlowBotl_cget_vibratoGain ); //! vibratoGain
1486− func->doc = "Get vibrato gain, [0.0-1.0].";
1486+ func->doc = "get vibrato gain, [0.0-1.0].";
14871487 if( !type_engine_import_mfun( env, func ) ) goto error;
14881488
14891489 func = make_new_mfun( "float", "volume", BlowBotl_ctrl_volume ); //! volume
14901490 func->add_arg( "float", "value" );
1491− func->doc = "Set volume, [0.0-1.0].";
1491+ func->doc = "set volume, [0.0-1.0].";
14921492 if( !type_engine_import_mfun( env, func ) ) goto error;
14931493
14941494 func = make_new_mfun( "float", "volume", BlowBotl_cget_volume ); //! volume
1495− func->doc = "Get volume, [0.0-1.0].";
1495+ func->doc = "get volume, [0.0-1.0].";
14961496 if( !type_engine_import_mfun( env, func ) ) goto error;
14971497
14981498 // end the class import
@@ -1504,9 +1504,9 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002"; · 5 unmodified lines
15041504 // begin BlowHole ugen
15051505 //------------------------------------------------------------------------
15061506
1507− doc = "This class is based on the clarinet model, with the addition of a two-port register hole and a three-port dynamic tonehole implementation, as discussed by Scavone and Cook (1998).\n\
1507+ doc = "based on the clarinet model, with the addition of a two-port register hole and a three-port dynamic tonehole implementation, as discussed by Scavone and Cook (1998).\n\
15081508 \n\
1509−In this implementation, the distances between the reed/register hole and tonehole/bell are fixed. As a result, both the tonehole and register hole will have variable influence on the playing frequency, which is dependent on the length of the air column. In addition, the highest playing freqeuency is limited by these fixed lengths. This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.\n\
1509+In this implementation, the distances between the reed/register hole and tonehole/bell are fixed. As a result, both the tonehole and register hole will have variable influence on the playing frequency, which is dependent on the length of the air column. In addition, the highest playing freqeuency is limited by these fixed lengths. This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.\n\
15101510 \n\
15111511 Control Change Numbers:\n\
15121512 \n\
@@ -1531,66 +1531,66 @@ Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 18 unmodified lines
15311531
15321532 func = make_new_mfun( "float", "startBlowing", BlowHole_ctrl_startBlowing ); //! note on
15331533 func->add_arg( "float", "value" );
1534− func->doc = "Start blowing, [0.0-1.0]";
1534+ func->doc = "start blowing, [0.0-1.0]";
15351535 if( !type_engine_import_mfun( env, func ) ) goto error;
15361536
15371537 func = make_new_mfun( "float", "stopBlowing", BlowHole_ctrl_stopBlowing ); //! note on
15381538 func->add_arg( "float", "value" );
1539− func->doc = "Stop blowing, [0.0-1.0]";
1539+ func->doc = "stop blowing, [0.0-1.0]";
15401540 if( !type_engine_import_mfun( env, func ) ) goto error;
15411541
15421542 func = make_new_mfun( "float", "vent", BlowHole_ctrl_vent ); //! vent frequency
15431543 func->add_arg( "float", "value" );
1544− func->doc = "Set vent frequency, [0.0-1.0].";
1544+ func->doc = "set vent frequency, [0.0-1.0].";
15451545 if( !type_engine_import_mfun( env, func ) ) goto error;
15461546
15471547 func = make_new_mfun( "float", "vent", BlowHole_cget_vent ); //! vent frequency
1548− func->doc = "Get vent frequency, [0.0-1.0].";
1548+ func->doc = "get vent frequency, [0.0-1.0].";
15491549 if( !type_engine_import_mfun( env, func ) ) goto error;
15501550
15511551 func = make_new_mfun( "float", "tonehole", BlowHole_ctrl_tonehole ); //! tonehole size
15521552 func->add_arg( "float", "value" );
1553− func->doc = "Set tonehole size, [0.0-1.0].";
1553+ func->doc = "set tonehole size, [0.0-1.0].";
15541554 if( !type_engine_import_mfun( env, func ) ) goto error;
15551555
15561556 func = make_new_mfun( "float", "tonehole", BlowHole_cget_tonehole ); //! tonehole size
1557− func->doc = "Get tonehole size, [0.0-1.0].";
1557+ func->doc = "get tonehole size, [0.0-1.0].";
15581558 if( !type_engine_import_mfun( env, func ) ) goto error;
15591559
15601560 func = make_new_mfun( "float", "reed", BlowHole_ctrl_reed ); //! reed stiffness
15611561 func->add_arg( "float", "value" );
1562− func->doc = "Set reed stiffness, [0.0-1.0].";
1562+ func->doc = "set reed stiffness, [0.0-1.0].";
15631563 if( !type_engine_import_mfun( env, func ) ) goto error;
15641564
15651565 func = make_new_mfun( "float", "reed", BlowHole_cget_reed ); //! reed stiffness
1566− func->doc = "Get reed stiffness, [0.0-1.0].";
1566+ func->doc = "get reed stiffness, [0.0-1.0].";
15671567 if( !type_engine_import_mfun( env, func ) ) goto error;
15681568
15691569 func = make_new_mfun( "float", "rate", BlowHole_ctrl_rate ); //! attack rate
15701570 func->add_arg( "float", "value" );
1571− func->doc = "Set rate of attack, [0.0-1.0].";
1571+ func->doc = "set rate of attack, [0.0-1.0].";
15721572 if( !type_engine_import_mfun( env, func ) ) goto error;
15731573
15741574 func = make_new_mfun( "float", "rate", BlowHole_cget_rate ); //! attack rate
1575− func->doc = "Get rate of attack, [0.0-1.0].";
1575+ func->doc = "get rate of attack, [0.0-1.0].";
15761576 if( !type_engine_import_mfun( env, func ) ) goto error;
15771577
15781578 func = make_new_mfun( "float", "noiseGain", BlowHole_ctrl_noiseGain ); //! noise gain
15791579 func->add_arg( "float", "value" );
1580− func->doc = "Set noise component gain, [0.0-1.0].";
1580+ func->doc = "set noise component gain, [0.0-1.0].";
15811581 if( !type_engine_import_mfun( env, func ) ) goto error;
15821582
15831583 func = make_new_mfun( "float", "noiseGain", BlowHole_cget_noiseGain ); //! noise gain
1584− func->doc = "Get noise component gain, [0.0-1.0].";
1584+ func->doc = "get noise component gain, [0.0-1.0].";
15851585 if( !type_engine_import_mfun( env, func ) ) goto error;
15861586
15871587 func = make_new_mfun( "float", "pressure", BlowHole_ctrl_pressure ); //! breath pressure
15881588 func->add_arg( "float", "value" );
1589− func->doc = "Set pressure, [0.0-1.0].";
1589+ func->doc = "set pressure, [0.0-1.0].";
15901590 if( !type_engine_import_mfun( env, func ) ) goto error;
15911591
15921592 func = make_new_mfun( "float", "pressure", BlowHole_cget_pressure ); //! breath pressure
1593− func->doc = "Get pressure, [0.0-1.0].";
1593+ func->doc = "get pressure, [0.0-1.0].";
15941594 if( !type_engine_import_mfun( env, func ) ) goto error;
15951595
15961596 // end the class import
@@ -1601,7 +1601,7 @@ Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
16011601 // begin Bowed ugen
16021602 //------------------------------------------------------------------------
16031603
1604− doc = "This class implements a bowed string model, a la Smith (1986), after McIntyre, Schumacher, Woodhouse (1983).\n\
1604+ doc = "a bowed string model, a la Smith (1986), after McIntyre, Schumacher, Woodhouse (1983).\n\
16051605 \n\
16061606 This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.\n\
16071607 \n\
@@ -1628,57 +1628,57 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 20 unmodified lines
16281628
16291629 func = make_new_mfun( "float", "startBowing", Bowed_ctrl_startBowing ); //! begin bowing instrument
16301630 func->add_arg( "float", "value" );
1631− func->doc = "Start bowing, [0.0-1.0].";
1631+ func->doc = "start bowing, [0.0-1.0].";
16321632 if( !type_engine_import_mfun( env, func ) ) goto error;
16331633
16341634 func = make_new_mfun( "float", "stopBowing", Bowed_ctrl_stopBowing ); //! stop bowing
16351635 func->add_arg( "float", "value" );
1636− func->doc = "Stop bowing, [0.0-1.0].";
1636+ func->doc = "stop bowing, [0.0-1.0].";
16371637 if( !type_engine_import_mfun( env, func ) ) goto error;
16381638
16391639 func = make_new_mfun( "float", "bowPressure", Bowed_ctrl_bowPressure ); //! bowPressure
16401640 func->add_arg( "float", "value" );
1641− func->doc = "Set bow pressure, [0.0-1.0]";
1641+ func->doc = "set bow pressure, [0.0-1.0]";
16421642 if( !type_engine_import_mfun( env, func ) ) goto error;
16431643
16441644 func = make_new_mfun( "float", "bowPressure", Bowed_cget_bowPressure ); //! bowPressure
1645− func->doc = "Get bow pressure, [0.0-1.0]";
1645+ func->doc = "get bow pressure, [0.0-1.0]";
16461646 if( !type_engine_import_mfun( env, func ) ) goto error;
16471647
16481648 func = make_new_mfun( "float", "bowPosition", Bowed_ctrl_bowPos ); //! bowPos
16491649 func->add_arg( "float", "value" );
1650− func->doc = "Set bow position, [0.0-1.0]";
1650+ func->doc = "set bow position, [0.0-1.0]";
16511651 if( !type_engine_import_mfun( env, func ) ) goto error;
16521652
16531653 func = make_new_mfun( "float", "bowPosition", Bowed_cget_bowPos ); //! bowPos
1654− func->doc = "Get bow position, [0.0-1.0]";
1654+ func->doc = "get bow position, [0.0-1.0]";
16551655 if( !type_engine_import_mfun( env, func ) ) goto error;
16561656
16571657 func = make_new_mfun( "float", "vibratoFreq", Bowed_ctrl_vibratoFreq ); //! vibratoFreq
16581658 func->add_arg( "float", "value" );
1659− func->doc = "Set vibrato frequency (Hz).";
1659+ func->doc = "set vibrato frequency (Hz).";
16601660 if( !type_engine_import_mfun( env, func ) ) goto error;
16611661
16621662 func = make_new_mfun( "float", "vibratoFreq", Bowed_cget_vibratoFreq ); //! vibratoFreq
1663− func->doc = "Get vibrato frequency (Hz).";
1663+ func->doc = "get vibrato frequency (Hz).";
16641664 if( !type_engine_import_mfun( env, func ) ) goto error;
16651665
16661666 func = make_new_mfun( "float", "vibratoGain", Bowed_ctrl_vibratoGain ); //! vibratoGain
16671667 func->add_arg( "float", "value" );
1668− func->doc = "Set vibrato gain, [0.0-1.0].";
1668+ func->doc = "set vibrato gain, [0.0-1.0].";
16691669 if( !type_engine_import_mfun( env, func ) ) goto error;
16701670
16711671 func = make_new_mfun( "float", "vibratoGain", Bowed_cget_vibratoGain ); //! vibratoGain
1672− func->doc = "Get vibrato gain, [0.0-1.0].";
1672+ func->doc = "get vibrato gain, [0.0-1.0].";
16731673 if( !type_engine_import_mfun( env, func ) ) goto error;
16741674
16751675 func = make_new_mfun( "float", "volume", Bowed_ctrl_volume ); //! volume
16761676 func->add_arg( "float", "value" );
1677− func->doc = "Set volume, [0.0-1.0].";
1677+ func->doc = "set volume, [0.0-1.0].";
16781678 if( !type_engine_import_mfun( env, func ) ) goto error;
16791679
16801680 func = make_new_mfun( "float", "volume", Bowed_cget_volume ); //! volume
1681− func->doc = "Get volume, [0.0-1.0].";
1681+ func->doc = "get volume, [0.0-1.0].";
16821682 if( !type_engine_import_mfun( env, func ) ) goto error;
16831683
16841684 // end the class import
@@ -1689,7 +1689,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
16891689 // begin Brass ugen
16901690 //------------------------------------------------------------------------
16911691
1692− doc = "This class implements a simple brass instrument waveguide model, a la Cook (TBone, HosePlayer).\n\
1692+ doc = "a simple brass instrument waveguide model, a la Cook (TBone, HosePlayer).\n\
16931693 \n\
16941694 This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.\n\
16951695 \n\
@@ -1716,71 +1716,71 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 20 unmodified lines
17161716
17171717 func = make_new_mfun( "float", "clear", Brass_ctrl_clear ); //! clear instrument
17181718 func->add_arg( "float", "value" );
1719− func->doc = "Clear instrument.";
1719+ func->doc = "clear instrument.";
17201720 if( !type_engine_import_mfun( env, func ) ) goto error;
17211721
17221722 func = make_new_mfun( "float", "startBlowing", Brass_ctrl_startBlowing ); //! note on
17231723 func->add_arg( "float", "value" );
1724− func->doc = "Start blowing, [0.0-1.0].";
1724+ func->doc = "start blowing, [0.0-1.0].";
17251725 if( !type_engine_import_mfun( env, func ) ) goto error;
17261726
17271727 func = make_new_mfun( "float", "stopBlowing", Brass_ctrl_stopBlowing ); //! note on
17281728 func->add_arg( "float", "value" );
1729− func->doc = "Stop blowing, [0.0-1.0].";
1729+ func->doc = "stop blowing, [0.0-1.0].";
17301730 if( !type_engine_import_mfun( env, func ) ) goto error;
17311731
17321732 func = make_new_mfun( "float", "lip", Brass_ctrl_lip ); //! lip stiffness
17331733 func->add_arg( "float", "value" );
1734− func->doc = "Set lip tension, [0.0-1.0].";
1734+ func->doc = "set lip tension, [0.0-1.0].";
17351735 if( !type_engine_import_mfun( env, func ) ) goto error;
17361736
17371737 func = make_new_mfun( "float", "lip", Brass_cget_lip ); //! lip stiffness
1738− func->doc = "Get lip tension, [0.0-1.0].";
1738+ func->doc = "get lip tension, [0.0-1.0].";
17391739 if( !type_engine_import_mfun( env, func ) ) goto error;
17401740
17411741 func = make_new_mfun( "float", "slide", Brass_ctrl_slide ); //! slide
17421742 func->add_arg( "float", "value" );
1743− func->doc = "Set slide length, [0.0-1.0].";
1743+ func->doc = "set slide length, [0.0-1.0].";
17441744 if( !type_engine_import_mfun( env, func ) ) goto error;
17451745
17461746 func = make_new_mfun( "float", "slide", Brass_cget_slide ); //! slide
1747− func->doc = "Get slide length, [0.0-1.0].";
1747+ func->doc = "get slide length, [0.0-1.0].";
17481748 if( !type_engine_import_mfun( env, func ) ) goto error;
17491749
17501750 func = make_new_mfun( "float", "vibratoFreq", Brass_ctrl_vibratoFreq ); //! vibratoFreq
17511751 func->add_arg( "float", "value" );
1752− func->doc = "Set vibrato frequency (Hz).";
1752+ func->doc = "set vibrato frequency (Hz).";
17531753 if( !type_engine_import_mfun( env, func ) ) goto error;
17541754
17551755 func = make_new_mfun( "float", "vibratoFreq", Brass_cget_vibratoFreq ); //! vibratoFreq
1756− func->doc = "Get vibrato frequency (Hz).";
1756+ func->doc = "get vibrato frequency (Hz).";
17571757 if( !type_engine_import_mfun( env, func ) ) goto error;
17581758
17591759 func = make_new_mfun( "float", "vibratoGain", Brass_ctrl_vibratoGain ); //! vibratoGain
17601760 func->add_arg( "float", "value" );
1761− func->doc = "Set vibrato gain, [0.0-1.0].";
1761+ func->doc = "set vibrato gain, [0.0-1.0].";
17621762 if( !type_engine_import_mfun( env, func ) ) goto error;
17631763
17641764 func = make_new_mfun( "float", "vibratoGain", Brass_cget_vibratoGain ); //! vibratoGain
1765− func->doc = "Get vibrato gain, [0.0-1.0].";
1765+ func->doc = "get vibrato gain, [0.0-1.0].";
17661766 if( !type_engine_import_mfun( env, func ) ) goto error;
17671767
17681768 func = make_new_mfun( "float", "volume", Brass_ctrl_volume ); //! volume
17691769 func->add_arg( "float", "value" );
1770− func->doc = "Set volume, [0.0-1.0].";
1770+ func->doc = "set volume, [0.0-1.0].";
17711771 if( !type_engine_import_mfun( env, func ) ) goto error;
17721772
17731773 func = make_new_mfun( "float", "volume", Brass_cget_volume ); //! volume
1774− func->doc = "Get volume, [0.0-1.0].";
1774+ func->doc = "get volume, [0.0-1.0].";
17751775 if( !type_engine_import_mfun( env, func ) ) goto error;
17761776
17771777 func = make_new_mfun( "float", "rate", Brass_ctrl_rate ); //! attack rate
17781778 func->add_arg( "float", "value" );
1779− func->doc = "Set rate of attack (seconds).";
1779+ func->doc = "set rate of attack (seconds).";
17801780 if( !type_engine_import_mfun( env, func ) ) goto error;
17811781
17821782 func = make_new_mfun( "float", "rate", Brass_cget_rate ); //! attack rate
1783− func->doc = "Get rate of attack (seconds).";
1783+ func->doc = "get rate of attack (seconds).";
17841784 if( !type_engine_import_mfun( env, func ) ) goto error;
17851785
17861786 // end the class import
@@ -1791,7 +1791,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
17911791 // begin Clarinet ugen
17921792 //------------------------------------------------------------------------
17931793
1794− doc = "This class implements a simple clarinet physical model, as discussed by Smith (1986), McIntyre, Schumacher, Woodhouse (1983), and others.\n\
1794+ doc = "a simple clarinet physical model, as discussed by Smith (1986), McIntyre, Schumacher, Woodhouse (1983), and others.\n\
17951795 \n\
17961796 This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.\n\
17971797 \n\
@@ -1818,71 +1818,71 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 20 unmodified lines
18181818
18191819 func = make_new_mfun( "float", "clear", Clarinet_ctrl_clear ); //! note on
18201820 func->add_arg( "float", "value" );
1821− func->doc = "Clear instrument.";
1821+ func->doc = "clear instrument.";
18221822 if( !type_engine_import_mfun( env, func ) ) goto error;
18231823
18241824 func = make_new_mfun( "float", "startBlowing", Clarinet_ctrl_startBlowing ); //! note on
18251825 func->add_arg( "float", "value" );
1826− func->doc = "Start blowing, [0.0-1.0].";
1826+ func->doc = "start blowing, [0.0-1.0].";
18271827 if( !type_engine_import_mfun( env, func ) ) goto error;
18281828
18291829 func = make_new_mfun( "float", "stopBlowing", Clarinet_ctrl_stopBlowing ); //! note on
18301830 func->add_arg( "float", "value" );
1831− func->doc = "Stop blowing, [0.0-1.0].";
1831+ func->doc = "stop blowing, [0.0-1.0].";
18321832 if( !type_engine_import_mfun( env, func ) ) goto error;
18331833
18341834 func = make_new_mfun( "float", "rate", Clarinet_ctrl_rate ); //! attack rate
18351835 func->add_arg( "float", "value" );
1836− func->doc = "Set rate of attack (seconds).";
1836+ func->doc = "set rate of attack (seconds).";
18371837 if( !type_engine_import_mfun( env, func ) ) goto error;
18381838
18391839 func = make_new_mfun( "float", "rate", Clarinet_cget_rate ); //! attack rate
1840− func->doc = "Get rate of attack (seconds).";
1840+ func->doc = "get rate of attack (seconds).";
18411841 if( !type_engine_import_mfun( env, func ) ) goto error;
18421842
18431843 func = make_new_mfun( "float", "reed", Clarinet_ctrl_reed); //! reed
18441844 func->add_arg( "float", "value" );
1845− func->doc = "Set reed stiffness, [0.0-1.0].";
1845+ func->doc = "set reed stiffness, [0.0-1.0].";
18461846 if( !type_engine_import_mfun( env, func ) ) goto error;
18471847
18481848 func = make_new_mfun( "float", "reed", Clarinet_cget_reed); //! reed
1849− func->doc = "Get reed stiffness, [0.0-1.0].";
1849+ func->doc = "get reed stiffness, [0.0-1.0].";
18501850 if( !type_engine_import_mfun( env, func ) ) goto error;
18511851
18521852 func = make_new_mfun( "float", "noiseGain", Clarinet_ctrl_noiseGain ); //! noiseGain
18531853 func->add_arg( "float", "value" );
1854− func->doc = "Set noise component gain, [0.0-1.0].";
1854+ func->doc = "set noise component gain, [0.0-1.0].";
18551855 if( !type_engine_import_mfun( env, func ) ) goto error;
18561856
18571857 func = make_new_mfun( "float", "noiseGain", Clarinet_cget_noiseGain ); //! noiseGain
1858− func->doc = "Get noise component gain, [0.0-1.0].";
1858+ func->doc = "get noise component gain, [0.0-1.0].";
18591859 if( !type_engine_import_mfun( env, func ) ) goto error;
18601860
18611861 func = make_new_mfun( "float", "vibratoFreq", Clarinet_ctrl_vibratoFreq ); //! rvibratoFreq
18621862 func->add_arg( "float", "value" );
1863− func->doc = "Set vibrato frequency (Hz).";
1863+ func->doc = "set vibrato frequency (Hz).";
18641864 if( !type_engine_import_mfun( env, func ) ) goto error;
18651865
18661866 func = make_new_mfun( "float", "vibratoFreq", Clarinet_cget_vibratoFreq ); //! rvibratoFreq
1867− func->doc = "Get vibrato frequency (Hz).";
1867+ func->doc = "get vibrato frequency (Hz).";
18681868 if( !type_engine_import_mfun( env, func ) ) goto error;
18691869
18701870 func = make_new_mfun( "float", "vibratoGain", Clarinet_ctrl_vibratoGain ); //! vibratoGain
18711871 func->add_arg( "float", "value" );
1872− func->doc = "Set vibrato gain, [0.0-1.0].";
1872+ func->doc = "set vibrato gain, [0.0-1.0].";
18731873 if( !type_engine_import_mfun( env, func ) ) goto error;
18741874
18751875 func = make_new_mfun( "float", "vibratoGain", Clarinet_cget_vibratoGain ); //! vibratoGain
1876− func->doc = "Get vibrato gain, [0.0-1.0].";
1876+ func->doc = "get vibrato gain, [0.0-1.0].";
18771877 if( !type_engine_import_mfun( env, func ) ) goto error;
18781878
18791879 func = make_new_mfun( "float", "pressure", Clarinet_ctrl_pressure ); //! pressure
18801880 func->add_arg( "float", "value" );
1881− func->doc = "Set pressure, [0.0-1.0].";
1881+ func->doc = "set pressure, [0.0-1.0].";
18821882 if( !type_engine_import_mfun( env, func ) ) goto error;
18831883
18841884 func = make_new_mfun( "float", "pressure", Clarinet_cget_pressure ); //! pressure
1885− func->doc = "Get pressure, [0.0-1.0].";
1885+ func->doc = "get pressure, [0.0-1.0].";
18861886 if( !type_engine_import_mfun( env, func ) ) goto error;
18871887
18881888 // end the class import
@@ -1893,7 +1893,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
18931893 // begin Flute ugen
18941894 //------------------------------------------------------------------------
18951895
1896− doc = "This class implements a simple flute physical model, as discussed by Karjalainen, Smith, Waryznyk, etc. The jet model uses a polynomial, a la Cook.\n\
1896+ doc = "a simple flute physical model, as discussed by Karjalainen, Smith, Waryznyk, etc. The jet model uses a polynomial, a la Cook.\n\
18971897 \n\
18981898 This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.\n\
18991899 \n\
@@ -1919,89 +1919,89 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 19 unmodified lines
19191919
19201920 func = make_new_mfun( "float", "clear", Flute_ctrl_clear ); //! clear
19211921 func->add_arg( "float", "value" );
1922− func->doc = "Clear instrument.";
1922+ func->doc = "clear instrument.";
19231923 if( !type_engine_import_mfun( env, func ) ) goto error;
19241924
19251925 func = make_new_mfun( "float", "startBlowing", Flute_ctrl_startBlowing ); //! startBlowing
19261926 func->add_arg( "float", "value" );
1927− func->doc = "Start blowing, [0.0-1.0].";
1927+ func->doc = "start blowing, [0.0-1.0].";
19281928 if( !type_engine_import_mfun( env, func ) ) goto error;
19291929
19301930 func = make_new_mfun( "float", "stopBlowing", Flute_ctrl_stopBlowing ); //! stopBlowing
19311931 func->add_arg( "float", "value" );
1932− func->doc = "Stop blowing, [0.0-1.0].";
1932+ func->doc = "stop blowing, [0.0-1.0].";
19331933 if( !type_engine_import_mfun( env, func ) ) goto error;
19341934
19351935 func = make_new_mfun( "float", "rate", Flute_ctrl_rate ); //! attack rate
19361936 func->add_arg( "float", "value" );
1937− func->doc = "Set rate of attack (seconds).";
1937+ func->doc = "set rate of attack (seconds).";
19381938 if( !type_engine_import_mfun( env, func ) ) goto error;
19391939
19401940 func = make_new_mfun( "float", "rate", Flute_cget_rate ); //! attack rate
1941− func->doc = "Get rate of attack (seconds).";
1941+ func->doc = "get rate of attack (seconds).";
19421942 if( !type_engine_import_mfun( env, func ) ) goto error;
19431943
19441944 func = make_new_mfun( "float", "jetReflection", Flute_ctrl_jetReflection ); //! jet reflection
19451945 func->add_arg( "float", "value" );
1946− func-> doc = "Set jet reflection.";
1946+ func-> doc = "set jet reflection.";
19471947 if( !type_engine_import_mfun( env, func ) ) goto error;
19481948
19491949 func = make_new_mfun( "float", "jetReflection", Flute_cget_jetReflection ); //! jet reflection
1950− func-> doc = "Get jet reflection.";
1950+ func-> doc = "get jet reflection.";
19511951 if( !type_engine_import_mfun( env, func ) ) goto error;
19521952
19531953 func = make_new_mfun( "float", "jetDelay", Flute_ctrl_jetDelay ); //! jet delay
19541954 func->add_arg( "float", "value" );
1955− func->doc = "Set jet delay.";
1955+ func->doc = "set jet delay.";
19561956 if( !type_engine_import_mfun( env, func ) ) goto error;
19571957
19581958 func = make_new_mfun( "float", "jetDelay", Flute_cget_jetDelay ); //! jet delay
1959− func->doc = "Get jet delay.";
1959+ func->doc = "get jet delay.";
19601960 if( !type_engine_import_mfun( env, func ) ) goto error;
19611961
19621962 func = make_new_mfun( "float", "endReflection", Flute_ctrl_endReflection ); //! end reflection
19631963 func->add_arg( "float", "value" );
1964− func->doc = "Set end reflection.";
1964+ func->doc = "set end reflection.";
19651965 if( !type_engine_import_mfun( env, func ) ) goto error;
19661966
19671967 func = make_new_mfun( "float", "endReflection", Flute_cget_endReflection ); //! end reflection
1968− func->doc = "Get end reflection.";
1968+ func->doc = "get end reflection.";
19691969 if( !type_engine_import_mfun( env, func ) ) goto error;
19701970
19711971 func = make_new_mfun( "float", "noiseGain", Flute_ctrl_noiseGain ); //! noiseGain
19721972 func->add_arg( "float", "value" );
1973− func->doc = "Set noise component gain, [0.0-1.0].";
1973+ func->doc = "set noise component gain, [0.0-1.0].";
19741974 if( !type_engine_import_mfun( env, func ) ) goto error;
19751975
19761976 func = make_new_mfun( "float", "noiseGain", Flute_cget_noiseGain ); //! noiseGain
1977− func->doc = "Get noise component gain, [0.0-1.0].";
1977+ func->doc = "get noise component gain, [0.0-1.0].";
19781978 if( !type_engine_import_mfun( env, func ) ) goto error;
19791979
19801980 func = make_new_mfun( "float", "vibratoFreq", Flute_ctrl_vibratoFreq ); //! vibratoFreq
19811981 func->add_arg( "float", "value" );
1982− func->doc = "Set vibrato frequency (Hz).";
1982+ func->doc = "set vibrato frequency (Hz).";
19831983 if( !type_engine_import_mfun( env, func ) ) goto error;
19841984
19851985 func = make_new_mfun( "float", "vibratoFreq", Flute_cget_vibratoFreq ); //! vibratoFreq
1986− func->doc = "Get vibrato frequency (Hz).";
1986+ func->doc = "get vibrato frequency (Hz).";
19871987 if( !type_engine_import_mfun( env, func ) ) goto error;
19881988
19891989 func = make_new_mfun( "float", "vibratoGain", Flute_ctrl_vibratoGain ); //! vibratoGain
19901990 func->add_arg( "float", "value" );
1991− func->doc = "Set vibrato gain, [0.0-1.0].";
1991+ func->doc = "set vibrato gain, [0.0-1.0].";
19921992 if( !type_engine_import_mfun( env, func ) ) goto error;
19931993
19941994 func = make_new_mfun( "float", "vibratoGain", Flute_cget_vibratoGain ); //! vibratoGain
1995− func->doc = "Get vibrato gain, [0.0-1.0].";
1995+ func->doc = "get vibrato gain, [0.0-1.0].";
19961996 if( !type_engine_import_mfun( env, func ) ) goto error;
19971997
19981998 func = make_new_mfun( "float", "pressure", Flute_ctrl_pressure ); //! pressure
19991999 func->add_arg( "float", "value" );
2000− func->doc = "Set pressure, [0.0-1.0].";
2000+ func->doc = "set pressure, [0.0-1.0].";
20012001 if( !type_engine_import_mfun( env, func ) ) goto error;
20022002
20032003 func = make_new_mfun( "float", "pressure", Flute_cget_pressure ); //! pressure
2004− func->doc = "Get pressure, [0.0-1.0].";
2004+ func->doc = "get pressure, [0.0-1.0].";
20052005 if( !type_engine_import_mfun( env, func ) ) goto error;
20062006
20072007 // end the class import
@@ -2012,9 +2012,9 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
20122012 // begin Mandolin ugen
20132013 //------------------------------------------------------------------------
20142014
2015− doc = "This class inherits from PluckTwo and uses 'commuted synthesis' techniques to model a mandolin instrument.\n\
2015+ doc = "inherits from PluckTwo and uses 'commuted synthesis' techniques to model a mandolin instrument.\n\
20162016 \n\
2017−This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others. Commuted Synthesis, in particular, is covered by patents, granted, pending, and/or applied-for. All are assigned to the Board of Trustees, Stanford University. For information, contact the Office of Technology Licensing, Stanford University.\n\
2017+This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others. Commuted Synthesis, in particular, is covered by patents, granted, pending, and/or applied-for. All are assigned to the Board of Trustees, Stanford University. For information, contact the Office of Technology Licensing, Stanford University.\n\
20182018 \n\
20192019 Control Change Numbers:\n\
20202020 \n\
@@ -2041,57 +2041,57 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 20 unmodified lines
20412041
20422042 func = make_new_mfun( "float", "pluck", Mandolin_ctrl_pluck ); //! pluck string with given amplitude
20432043 func->add_arg( "float", "value" );
2044− func->doc = "Pluck instrument, [0.0-1.0].";
2044+ func->doc = "pluck the instrument, [0.0-1.0].";
20452045 if( !type_engine_import_mfun( env, func ) ) goto error;
20462046
20472047 func = make_new_mfun( "float", "pluckPos", Mandolin_ctrl_pluckPos ); //! set pluck position ( 0-1) along string
20482048 func->add_arg( "float", "value" );
2049− func->doc = "Set pluck position, [0.0-1.0].";
2049+ func->doc = "set pluck position, [0.0-1.0].";
20502050 if( !type_engine_import_mfun( env, func ) ) goto error;
20512051
20522052 func = make_new_mfun( "float", "pluckPos", Mandolin_cget_pluckPos ); //! get pluck position ( 0-1) along string
2053− func->doc = "Get pluck position, [0.0-1.0].";
2053+ func->doc = "get pluck position, [0.0-1.0].";
20542054 if( !type_engine_import_mfun( env, func ) ) goto error;
20552055
20562056 func = make_new_mfun( "float", "bodySize", Mandolin_ctrl_bodySize ); //! modify instrument size
20572057 func->add_arg( "float", "value" );
2058− func->doc = "Set body size (percentage).";
2058+ func->doc = "set body size (percentage).";
20592059 if( !type_engine_import_mfun( env, func ) ) goto error;
20602060
20612061 func = make_new_mfun( "float", "bodySize", Mandolin_cget_bodySize ); //! modify instrument size
2062− func->doc = "Get body size (percentage).";
2062+ func->doc = "get body size (percentage).";
20632063 if( !type_engine_import_mfun( env, func ) ) goto error;
20642064
20652065 func = make_new_mfun( "float", "stringDamping", Mandolin_ctrl_stringDamping ); //! control string damping
20662066 func->add_arg( "float", "value" );
2067− func->doc = "Set string damping, [0.0-1.0].";
2067+ func->doc = "set string damping, [0.0-1.0].";
20682068 if( !type_engine_import_mfun( env, func ) ) goto error;
20692069
20702070 func = make_new_mfun( "float", "stringDamping", Mandolin_cget_stringDamping ); //! control string damping
2071− func->doc = "Get string damping, [0.0-1.0].";
2071+ func->doc = "get string damping, [0.0-1.0].";
20722072 if( !type_engine_import_mfun( env, func ) ) goto error;
20732073
20742074 func = make_new_mfun( "float", "stringDetune", Mandolin_ctrl_stringDetune ); //! control detuning of string pair
20752075 func->add_arg( "float", "value" );
2076− func->doc = "Set detuning of string pair, [0.0-1.0].";
2076+ func->doc = "set detuning of string pair, [0.0-1.0].";
20772077 if( !type_engine_import_mfun( env, func ) ) goto error;
20782078
20792079 func = make_new_mfun( "float", "stringDetune", Mandolin_cget_stringDetune ); //! control detuning of string pair
2080− func->doc = "Get detuning of string pair, [0.0-1.0].";
2080+ func->doc = "get detuning of string pair, [0.0-1.0].";
20812081 if( !type_engine_import_mfun( env, func ) ) goto error;
20822082
20832083 func = make_new_mfun( "float", "afterTouch", Mandolin_ctrl_afterTouch ); //! aftertouch
20842084 func->add_arg( "float", "value" );
2085− func->doc = "Set aftertouch (currently unsupported).";
2085+ func->doc = "set aftertouch (currently unsupported).";
20862086 if( !type_engine_import_mfun( env, func ) ) goto error;
20872087
20882088 func = make_new_mfun( "string", "bodyIR", Mandolin_ctrl_bodyIR ); //! read body impulse response
20892089 func->add_arg( "string", "path" );
2090− func->doc = "Set body impulse response.";
2090+ func->doc = "set body impulse response.";
20912091 if( !type_engine_import_mfun( env, func ) ) goto error;
20922092
20932093 func = make_new_mfun( "string", "bodyIR", Mandolin_cget_bodyIR ); //! get path
2094− func->doc = "Get body impulse response.";
2094+ func->doc = "get body impulse response.";
20952095 if( !type_engine_import_mfun( env, func ) ) goto error;
20962096
20972097 // end the class import
@@ -2102,7 +2102,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
21022102 // begin ModalBar ugen
21032103 //------------------------------------------------------------------------
21042104
2105− doc = "This class implements a number of different struck bar instruments. It inherits from the Modal class.\n\
2105+ doc = "a suite of struck bar instruments. It inherits from the Modal class.\n\
21062106 \n\
21072107 Control Change Numbers:\n\
21082108 \n\
@@ -2139,125 +2139,125 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 30 unmodified lines
21392139
21402140 func = make_new_mfun( "float", "strike", ModalBar_ctrl_strike ); //! strike bar
21412141 func->add_arg( "float", "value" );
2142− func->doc = "Strike bar, [0.0-1.0].";
2142+ func->doc = "strike bar, [0.0-1.0].";
21432143 if( !type_engine_import_mfun( env, func ) ) goto error;
21442144
21452145 func = make_new_mfun( "float", "damp", ModalBar_ctrl_damp ); //! damp bar
21462146 func->add_arg( "float", "value" );
2147− func->doc = "Damp bar, [0.0-1.0].";
2147+ func->doc = "damp bar, [0.0-1.0].";
21482148 if( !type_engine_import_mfun( env, func ) ) goto error;
21492149
21502150 func = make_new_mfun( "float", "clear", ModalBar_ctrl_clear ); //! clear
21512151 func->add_arg( "float", "value" );
2152− func->doc = "Clear instrument.";
2152+ func->doc = "clear instrument.";
21532153 if( !type_engine_import_mfun( env, func ) ) goto error;
21542154
21552155 func = make_new_mfun( "int", "preset", ModalBar_ctrl_preset ); //! choose preset
21562156 func->add_arg( "int", "value" );
2157− func->doc = "Set preset (see above).";
2157+ func->doc = "set preset (see above).";
21582158 if( !type_engine_import_mfun( env, func ) ) goto error;
21592159
21602160 func = make_new_mfun( "int", "preset", ModalBar_cget_preset ); //! choose preset
2161− func->doc = "Get preset.";
2161+ func->doc = "get preset.";
21622162 if( !type_engine_import_mfun( env, func ) ) goto error;
21632163
21642164 func = make_new_mfun( "float", "stickHardness", ModalBar_ctrl_stickHardness ); //! set stickHardness
21652165 func->add_arg( "float", "value" );
2166− func->doc = "Set stick hardness, [0.0-1.0].";
2166+ func->doc = "set stick hardness, [0.0-1.0].";
21672167 if( !type_engine_import_mfun( env, func ) ) goto error;
21682168
21692169 func = make_new_mfun( "float", "stickHardness", ModalBar_cget_stickHardness ); //! set stickHardness
2170− func->doc = "Get stick hardness, [0.0-1.0]";
2170+ func->doc = "get stick hardness, [0.0-1.0]";
21712171 if( !type_engine_import_mfun( env, func ) ) goto error;
21722172
21732173 func = make_new_mfun( "float", "strikePosition", ModalBar_ctrl_strikePosition ); //! set strikePosition
21742174 func->add_arg( "float", "value" );
2175− func->doc = "Set strike position, [0.0-1.0].";
2175+ func->doc = "set strike position, [0.0-1.0].";
21762176 if( !type_engine_import_mfun( env, func ) ) goto error;
21772177
21782178 func = make_new_mfun( "float", "strikePosition", ModalBar_cget_strikePosition ); //! set strikePosition
2179− func->doc = "Get strike position, [0.0-1.0].";
2179+ func->doc = "get strike position, [0.0-1.0].";
21802180 if( !type_engine_import_mfun( env, func ) ) goto error;
21812181
21822182 func = make_new_mfun( "float", "vibratoGain", ModalBar_ctrl_vibratoGain ); //! set vibratoGain
21832183 func->add_arg( "float", "value" );
2184− func->doc = "Set vibrato gain, [0.0-1.0].";
2184+ func->doc = "set vibrato gain, [0.0-1.0].";
21852185 if( !type_engine_import_mfun( env, func ) ) goto error;
21862186
21872187 func = make_new_mfun( "float", "vibratoGain", ModalBar_cget_vibratoGain ); //! set vibratoGain
2188− func->doc = "Get vibrato gain, [0.0-1.0].";
2188+ func->doc = "get vibrato gain, [0.0-1.0].";
21892189 if( !type_engine_import_mfun( env, func ) ) goto error;
21902190
21912191 func = make_new_mfun( "float", "vibratoFreq", ModalBar_ctrl_vibratoFreq ); //! set vibratoFreq
21922192 func->add_arg( "float", "value" );
2193− func->doc = "Set vibrato frequency (Hz).";
2193+ func->doc = "set vibrato frequency (Hz).";
21942194 if( !type_engine_import_mfun( env, func ) ) goto error;
21952195
21962196 func = make_new_mfun( "float", "vibratoFreq", ModalBar_cget_vibratoFreq ); //! set vibratoFreq
2197− func->doc = "Get vibrato frequency (Hz).";
2197+ func->doc = "get vibrato frequency (Hz).";
21982198 if( !type_engine_import_mfun( env, func ) ) goto error;
21992199
22002200 func = make_new_mfun( "float", "directGain", ModalBar_ctrl_directGain ); //! set directGain
22012201 func->add_arg( "float", "value" );
2202− func->doc = "Set direct gain, [0.0-1.0].";
2202+ func->doc = "set direct gain, [0.0-1.0].";
22032203 if( !type_engine_import_mfun( env, func ) ) goto error;
22042204
22052205 func = make_new_mfun( "float", "directGain", ModalBar_cget_directGain ); //! set directGain
2206− func->doc = "Get direct gain, [0.0-1.0].";
2206+ func->doc = "get direct gain, [0.0-1.0].";
22072207 if( !type_engine_import_mfun( env, func ) ) goto error;
22082208
22092209 func = make_new_mfun( "float", "masterGain", ModalBar_ctrl_masterGain ); //! set masterGain
22102210 func->add_arg( "float", "value" );
2211− func->doc = "Set master gain, [0.0-1.0].";
2211+ func->doc = "set master gain, [0.0-1.0].";
22122212 if( !type_engine_import_mfun( env, func ) ) goto error;
22132213
22142214 func = make_new_mfun( "float", "masterGain", ModalBar_cget_masterGain ); //! set masterGain
2215− func->doc = "Get master gain, [0.0-1.0].";
2215+ func->doc = "get master gain, [0.0-1.0].";
22162216 if( !type_engine_import_mfun( env, func ) ) goto error;
22172217
22182218 func = make_new_mfun( "int", "mode", ModalBar_ctrl_mode ); //! choose mode
22192219 func->add_arg( "int", "value" );
2220− func->doc = "Set mode.";
2220+ func->doc = "set mode.";
22212221 if( !type_engine_import_mfun( env, func ) ) goto error;
22222222
22232223 func = make_new_mfun( "int", "mode", ModalBar_cget_mode ); //! choose mode
2224− func->doc = "Get mode.";
2224+ func->doc = "get mode.";
22252225 if( !type_engine_import_mfun( env, func ) ) goto error;
22262226
22272227 func = make_new_mfun( "float", "modeRatio", ModalBar_ctrl_modeRatio ); //! mode edit (modeRatio)
22282228 func->add_arg( "float", "value" );
2229− func->doc = "Set ratio for selected mode.";
2229+ func->doc = "set ratio for selected mode.";
22302230 if( !type_engine_import_mfun( env, func ) ) goto error;
22312231
22322232 func = make_new_mfun( "float", "modeRatio", ModalBar_cget_modeRatio ); //! mode edit (modeRatio)
2233− func->doc = "Get ratio for selected mode.";
2233+ func->doc = "get ratio for selected mode.";
22342234 if( !type_engine_import_mfun( env, func ) ) goto error;
22352235
22362236 func = make_new_mfun( "float", "modeRadius", ModalBar_ctrl_modeRadius ); //! mode edit (modeRadius)
22372237 func->add_arg( "float", "value" );
2238− func->doc = "Set radius for selected mode, [0.0-1.0].";
2238+ func->doc = "set radius for selected mode, [0.0-1.0].";
22392239 if( !type_engine_import_mfun( env, func ) ) goto error;
22402240
22412241 func = make_new_mfun( "float", "modeRadius", ModalBar_cget_modeRadius ); //! mode edit (modeRadius)
2242− func->doc = "Get radius for selected mode, [0.0-1.0].";
2242+ func->doc = "get radius for selected mode, [0.0-1.0].";
22432243 if( !type_engine_import_mfun( env, func ) ) goto error;
22442244
22452245 func = make_new_mfun( "float", "modeGain", ModalBar_ctrl_modeGain ); //! mode edit (modeGain)
22462246 func->add_arg( "float", "value" );
2247− func->doc = "Set gain for selected mode, [0.0-1.0].";
2247+ func->doc = "set gain for selected mode, [0.0-1.0].";
22482248 if( !type_engine_import_mfun( env, func ) ) goto error;
22492249
22502250 func = make_new_mfun( "float", "modeGain", ModalBar_cget_modeGain ); //! mode edit (modeGain)
2251− func->doc = "Get gain for selected mode, [0.0-1.0].";
2251+ func->doc = "get gain for selected mode, [0.0-1.0].";
22522252 if( !type_engine_import_mfun( env, func ) ) goto error;
22532253
22542254 func = make_new_mfun( "float", "volume", ModalBar_ctrl_volume ); //! volume
22552255 func->add_arg( "float", "value" );
2256− func->doc = "Set volume, [0.0-1.0].";
2256+ func->doc = "set volume, [0.0-1.0].";
22572257 if( !type_engine_import_mfun( env, func ) ) goto error;
22582258
22592259 func = make_new_mfun( "float", "volume", ModalBar_cget_volume ); //! volume
2260− func->doc = "Get volume, [0.0-1.0].";
2260+ func->doc = "get volume, [0.0-1.0].";
22612261 if( !type_engine_import_mfun( env, func ) ) goto error;
22622262
22632263 // end the class import
@@ -2268,7 +2268,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
22682268 // begin Moog ugen
22692269 //------------------------------------------------------------------------
22702270
2271− doc = "This instrument uses one attack wave, one looped wave, and an ADSR envelope (inherited from the Sampler class) and adds two sweepable formant (FormSwep) filters.\n\
2271+ doc = "a Moog instrument modeled using one attack wave, one looped wave, and an ADSR envelope (inherited from the Sampler class) and adds two sweepable formant (FormSwep) filters.\n\
22722272 \n\
22732273 Control Change Numbers:\n\
22742274 \n\
@@ -2295,88 +2295,88 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 20 unmodified lines
22952295
22962296 func = make_new_mfun( "float", "lfoSpeed", Moog_ctrl_modSpeed ); //! modulation speed
22972297 func->add_arg( "float", "value" );
2298− func->doc = "Set LFO modulation speed.";
2298+ func->doc = "set LFO modulation speed.";
22992299 if( !type_engine_import_mfun( env, func ) ) goto error;
23002300
23012301 func = make_new_mfun( "float", "lfoSpeed", Moog_cget_modSpeed ); //! modulation speed
2302− func->doc = "Get LFO modulation speed.";
2302+ func->doc = "get LFO modulation speed.";
23032303 if( !type_engine_import_mfun( env, func ) ) goto error;
23042304
23052305 func = make_new_mfun( "float", "lfoDepth", Moog_ctrl_modDepth ); //! modulation depth
23062306 func->add_arg( "float", "value" );
2307− func->doc = "Set LFO modulation depth.";
2307+ func->doc = "set LFO modulation depth.";
23082308 if( !type_engine_import_mfun( env, func ) ) goto error;
23092309
23102310 func = make_new_mfun( "float", "lfoDepth", Moog_cget_modDepth ); //! modulation depth
2311− func->doc = "Get LFO modulation depth.";
2311+ func->doc = "get LFO modulation depth.";
23122312 if( !type_engine_import_mfun( env, func ) ) goto error;
23132313
23142314 func = make_new_mfun( "float", "modSpeed", Moog_ctrl_modSpeed ); //! modulation speed
23152315 func->add_arg( "float", "value" );
2316− func->doc = "Set modulation speed.";
2316+ func->doc = "set modulation speed.";
23172317 if( !type_engine_import_mfun( env, func ) ) goto error;
23182318
23192319 func = make_new_mfun( "float", "modSpeed", Moog_cget_modSpeed ); //! modulation speed
2320− func->doc = "Get modulation speed.";
2320+ func->doc = "get modulation speed.";
23212321 if( !type_engine_import_mfun( env, func ) ) goto error;
23222322
23232323 func = make_new_mfun( "float", "modDepth", Moog_ctrl_modDepth ); //! modulation depth
23242324 func->add_arg( "float", "value" );
2325− func->doc = "Set modulation depth.";
2325+ func->doc = "set modulation depth.";
23262326 if( !type_engine_import_mfun( env, func ) ) goto error;
23272327
23282328 func = make_new_mfun( "float", "modDepth", Moog_cget_modDepth ); //! modulation depth
2329− func->doc = "Get modulation depth.";
2329+ func->doc = "get modulation depth.";
23302330 if( !type_engine_import_mfun( env, func ) ) goto error;
23312331
23322332 func = make_new_mfun( "float", "filterQ", Moog_ctrl_filterQ ); //! filter Q value
23332333 func->add_arg( "float", "value" );
2334− func->doc = "Set filter Q value, [0.0-1.0].";
2334+ func->doc = "set filter Q value, [0.0-1.0].";
23352335 if( !type_engine_import_mfun( env, func ) ) goto error;
23362336
23372337 func = make_new_mfun( "float", "filterQ", Moog_cget_filterQ ); //! filter Q value
2338− func->doc = "Get filter Q value, [0.0-1.0].";
2338+ func->doc = "get filter Q value, [0.0-1.0].";
23392339 if( !type_engine_import_mfun( env, func ) ) goto error;
23402340
23412341 func = make_new_mfun( "float", "filterSweepRate", Moog_ctrl_filterSweepRate ); //! filter sweep rate
23422342 func->add_arg( "float", "value" );
2343− func->doc = "Set filter sweep rate, [0.0-1.0].";
2343+ func->doc = "set filter sweep rate, [0.0-1.0].";
23442344 if( !type_engine_import_mfun( env, func ) ) goto error;
23452345
23462346 func = make_new_mfun( "float", "filterSweepRate", Moog_cget_filterSweepRate ); //! filter sweep rate
2347− func->doc = "Get filter sweep rate, [0.0-1.0].";
2347+ func->doc = "get filter sweep rate, [0.0-1.0].";
23482348 if( !type_engine_import_mfun( env, func ) ) goto error;
23492349
23502350 func = make_new_mfun( "float", "afterTouch", Moog_ctrl_afterTouch ); // aftertouch
23512351 func->add_arg( "float", "value" );
2352− func->doc = "Set aftertouch, [0.0-1.0].";
2352+ func->doc = "set aftertouch, [0.0-1.0].";
23532353 if( !type_engine_import_mfun( env, func ) ) goto error;
23542354
23552355 func = make_new_mfun( "float", "volume", Moog_ctrl_volume ); //! volume
23562356 func->add_arg( "float", "value" );
2357− func->doc = "Set volume.";
2357+ func->doc = "set volume.";
23582358 if( !type_engine_import_mfun( env, func ) ) goto error;
23592359
23602360 func = make_new_mfun( "float", "volume", Moog_cget_volume ); //! volume
2361− func->doc = "Get volume.";
2361+ func->doc = "get volume.";
23622362 if( !type_engine_import_mfun( env, func ) ) goto error;
23632363
23642364 func = make_new_mfun( "float", "vibratoFreq", Moog_ctrl_vibratoFreq ); //! vibrato frequency
23652365 func->add_arg( "float", "value" );
2366− func->doc = "Set vibrato frequency (Hz).";
2366+ func->doc = "set vibrato frequency (Hz).";
23672367 if( !type_engine_import_mfun( env, func ) ) goto error;
23682368
23692369 func = make_new_mfun( "float", "vibratoFreq", Moog_cget_vibratoFreq ); //! vibrato frequency
2370− func->doc = "Get vibrato frequency (Hz).";
2370+ func->doc = "get vibrato frequency (Hz).";
23712371 if( !type_engine_import_mfun( env, func ) ) goto error;
23722372
23732373 func = make_new_mfun( "float", "vibratoGain", Moog_ctrl_vibratoGain ); //! vibrato gain
23742374 func->add_arg( "float", "value" );
2375− func->doc = "Set vibrato gain, [0.0-1.0].";
2375+ func->doc = "set vibrato gain, [0.0-1.0].";
23762376 if( !type_engine_import_mfun( env, func ) ) goto error;
23772377
23782378 func = make_new_mfun( "float", "vibratoGain", Moog_cget_vibratoGain ); //! vibrato gain
2379− func->doc = "Get vibrato gain, [0.0-1.0].";
2379+ func->doc = "get vibrato gain, [0.0-1.0].";
23802380 if( !type_engine_import_mfun( env, func ) ) goto error;
23812381
23822382 // end the class import
@@ -2387,7 +2387,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
23872387 // begin Saxofony ugen
23882388 //------------------------------------------------------------------------
23892389
2390− doc = "This class implements a 'hybrid' digital waveguide instrument that can generate a variety of wind-like sounds. It has also been referred to as the 'blowed string' model. The waveguide section is essentially that of a string, with one rigid and one lossy termination. The non-linear function is a reed table. The string can be 'blown' at any point between the terminations, though just as with strings, it is impossible to excite the system at either end. If the excitation is placed at the string mid-point, the sound is that of a clarinet. At points closer to the 'bridge', the sound is closer to that of a saxophone. See Scavone (2002) for more details.\n\
2390+ doc = "a 'hybrid' digital waveguide instrument that can generate a variety of wind-like sounds. It has also been referred to as the 'blowed string' model. The waveguide section is essentially that of a string, with one rigid and one lossy termination. The non-linear function is a reed table. The string can be 'blown' at any point between the terminations, though just as with strings, it is impossible to excite the system at either end. If the excitation is placed at the string mid-point, the sound is that of a clarinet. At points closer to the 'bridge', the sound is closer to that of a saxophone. See Scavone (2002) for more details.\n\
23912391 \n\
23922392 This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.\n\
23932393 \n\
@@ -2415,89 +2415,89 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 21 unmodified lines
24152415
24162416 func = make_new_mfun( "float", "clear", Saxofony_ctrl_clear ); //! clear instrument
24172417 func->add_arg( "float", "value" );
2418− func->doc = "Clear instrument.";
2418+ func->doc = "clear instrument.";
24192419 if( !type_engine_import_mfun( env, func ) ) goto error;
24202420
24212421 func = make_new_mfun( "float", "startBlowing", Saxofony_ctrl_startBlowing ); //! note on
24222422 func->add_arg( "float", "value" );
2423− func->doc = "Start blowing, [0.0-1.0].";
2423+ func->doc = "start blowing, [0.0-1.0].";
24242424 if( !type_engine_import_mfun( env, func ) ) goto error;
24252425
24262426 func = make_new_mfun( "float", "stopBlowing", Saxofony_ctrl_stopBlowing ); //! note on
24272427 func->add_arg( "float", "value" );
2428− func->doc = "Stop blowing, [0.0-1.0].";
2428+ func->doc = "stop blowing, [0.0-1.0].";
24292429 if( !type_engine_import_mfun( env, func ) ) goto error;
24302430
24312431 func = make_new_mfun( "float", "rate", Saxofony_ctrl_rate ); //! rate
24322432 func->add_arg( "float", "value" );
2433− func->doc = "Set rate of attack (seconds).";
2433+ func->doc = "set rate of attack (seconds).";
24342434 if( !type_engine_import_mfun( env, func ) ) goto error;
24352435
24362436 func = make_new_mfun( "float", "rate", Saxofony_cget_rate ); //! rate
2437− func->doc = "Get rate of attack (seconds).";
2437+ func->doc = "get rate of attack (seconds).";
24382438 if( !type_engine_import_mfun( env, func ) ) goto error;
24392439
24402440 func = make_new_mfun( "float", "stiffness", Saxofony_ctrl_reed ); //! stiffness
24412441 func->add_arg( "float", "value" );
2442− func->doc = "Set reed stiffness, [0.0-1.0].";
2442+ func->doc = "set reed stiffness, [0.0-1.0].";
24432443 if( !type_engine_import_mfun( env, func ) ) goto error;
24442444
24452445 func = make_new_mfun( "float", "stiffness", Saxofony_cget_reed ); //! stiffness
2446− func->doc = "Get reed stiffness, [0.0-1.0].";
2446+ func->doc = "get reed stiffness, [0.0-1.0].";
24472447 if( !type_engine_import_mfun( env, func ) ) goto error;
24482448
24492449 func = make_new_mfun( "float", "aperture", Saxofony_ctrl_aperture ); //! aperture
24502450 func->add_arg( "float", "value" );
2451− func->doc = "Set reed aperture, [0.0-1.0].";
2451+ func->doc = "set reed aperture, [0.0-1.0].";
24522452 if( !type_engine_import_mfun( env, func ) ) goto error;
24532453
24542454 func = make_new_mfun( "float", "aperture", Saxofony_cget_aperture ); //! aperture
2455− func->doc = "Get reed aperture, [0.0-1.0].";
2455+ func->doc = "get reed aperture, [0.0-1.0].";
24562456 if( !type_engine_import_mfun( env, func ) ) goto error;
24572457
24582458 func = make_new_mfun( "float", "noiseGain", Saxofony_ctrl_noiseGain ); //! noiseGain
24592459 func->add_arg( "float", "value" );
2460− func->doc = "Set noise component gain, [0.0-1.0].";
2460+ func->doc = "set noise component gain, [0.0-1.0].";
24612461 if( !type_engine_import_mfun( env, func ) ) goto error;
24622462
24632463 func = make_new_mfun( "float", "noiseGain", Saxofony_cget_noiseGain ); //! noiseGain
2464− func->doc = "Get noise component gain, [0.0-1.0].";
2464+ func->doc = "get noise component gain, [0.0-1.0].";
24652465 if( !type_engine_import_mfun( env, func ) ) goto error;
24662466
24672467 func = make_new_mfun( "float", "vibratoGain", Saxofony_ctrl_vibratoGain ); //! vibratoGain
24682468 func->add_arg( "float", "value" );
2469− func->doc = "Set vibrato gain, [0.0-1.0].";
2469+ func->doc = "set vibrato gain, [0.0-1.0].";
24702470 if( !type_engine_import_mfun( env, func ) ) goto error;
24712471
24722472 func = make_new_mfun( "float", "vibratoGain", Saxofony_cget_vibratoGain ); //! vibratoGain
2473− func->doc = "Get vibrato gain, [0.0-1.0].";
2473+ func->doc = "get vibrato gain, [0.0-1.0].";
24742474 if( !type_engine_import_mfun( env, func ) ) goto error;
24752475
24762476 func = make_new_mfun( "float", "vibratoFreq", Saxofony_ctrl_vibratoFreq ); //! vibratoFreq
24772477 func->add_arg( "float", "value" );
2478− func->doc = "Set vibrato frequency (Hz).";
2478+ func->doc = "set vibrato frequency (Hz).";
24792479 if( !type_engine_import_mfun( env, func ) ) goto error;
24802480
24812481 func = make_new_mfun( "float", "vibratoFreq", Saxofony_cget_vibratoFreq ); //! vibratoFreq
2482− func->doc = "Get vibrato frequency (Hz).";
2482+ func->doc = "get vibrato frequency (Hz).";
24832483 if( !type_engine_import_mfun( env, func ) ) goto error;
24842484
24852485 func = make_new_mfun( "float", "blowPosition", Saxofony_ctrl_blowPosition ); //! blowPosition
24862486 func->add_arg( "float", "value" );
2487− func->doc = "Set lip stiffness, [0.0-1.0].";
2487+ func->doc = "set lip stiffness, [0.0-1.0].";
24882488 if( !type_engine_import_mfun( env, func ) ) goto error;
24892489
24902490 func = make_new_mfun( "float", "blowPosition", Saxofony_cget_blowPosition ); //! blowPosition
2491− func->doc = "Get lip stiffness, [0.0-1.0].";
2491+ func->doc = "get lip stiffness, [0.0-1.0].";
24922492 if( !type_engine_import_mfun( env, func ) ) goto error;
24932493
24942494 func = make_new_mfun( "float", "pressure", Saxofony_ctrl_pressure ); //! pressure
24952495 func->add_arg( "float", "value" );
2496− func->doc = "Set pressure, [0.0-1.0]";
2496+ func->doc = "set pressure, [0.0-1.0]";
24972497 if( !type_engine_import_mfun( env, func ) ) goto error;
24982498
24992499 func = make_new_mfun( "float", "pressure", Saxofony_cget_pressure ); //! pressure
2500− func->doc = "Get pressure, [0.0-1.0]";
2500+ func->doc = "get pressure, [0.0-1.0]";
25012501 if( !type_engine_import_mfun( env, func ) ) goto error;
25022502
25032503 // end the class import
@@ -2560,66 +2560,66 @@ by Perry R. Cook, 1996 - 1999."; · 56 unmodified lines
25602560
25612561 func = make_new_mfun( "int", "which", Shakers_ctrl_which ); //! select instrument
25622562 func->add_arg( "int", "value" );
2563− func->doc = "Set instrument, [0-22] (see above).";
2563+ func->doc = "set instrument, [0-22] (see above).";
25642564 if( !type_engine_import_mfun( env, func ) ) goto error;
25652565
25662566 func = make_new_mfun( "int", "which", Shakers_cget_which ); //! select instrument
2567− func->doc = "Get instrument, [0-22] (see above).";
2567+ func->doc = "get instrument, [0-22] (see above).";
25682568 if( !type_engine_import_mfun( env, func ) ) goto error;
25692569
25702570 func = make_new_mfun( "int", "preset", Shakers_ctrl_which ); //! select instrument
25712571 func->add_arg( "int", "value" );
2572− func->doc = "Set instrument, [0-22] (see above).";
2572+ func->doc = "set instrument, [0-22] (see above).";
25732573 if( !type_engine_import_mfun( env, func ) ) goto error;
25742574
25752575 func = make_new_mfun( "int", "preset", Shakers_cget_which ); //! select instrument
2576− func->doc = "Get instrument, [0-22] (see above).";
2576+ func->doc = "get instrument, [0-22] (see above).";
25772577 if( !type_engine_import_mfun( env, func ) ) goto error;
25782578
25792579 func = make_new_mfun( "float", "energy", Shakers_ctrl_energy ); //! energy
25802580 func->add_arg( "float", "value" );
2581− func->doc = "Set shake energy, [0.0-1.0].";
2581+ func->doc = "set shake energy, [0.0-1.0].";
25822582 if( !type_engine_import_mfun( env, func ) ) goto error;
25832583
25842584 func = make_new_mfun( "float", "energy", Shakers_cget_energy ); //! energy
2585− func->doc = "Get shake energy, [0.0-1.0].";
2585+ func->doc = "get shake energy, [0.0-1.0].";
25862586 if( !type_engine_import_mfun( env, func ) ) goto error;
25872587
25882588 func = make_new_mfun( "float", "decay", Shakers_ctrl_decay ); //! decay
25892589 func->add_arg( "float", "value" );
2590− func->doc = "Set system decay, [0.0-1.0].";
2590+ func->doc = "set system decay, [0.0-1.0].";
25912591 if( !type_engine_import_mfun( env, func ) ) goto error;
25922592
25932593 func = make_new_mfun( "float", "decay", Shakers_cget_decay ); //! decay
2594− func->doc = "Get system decay, [0.0-1.0].";
2594+ func->doc = "get system decay, [0.0-1.0].";
25952595 if( !type_engine_import_mfun( env, func ) ) goto error;
25962596
25972597 func = make_new_mfun( "float", "objects", Shakers_ctrl_objects ); //! objects
25982598 func->add_arg( "float", "value" );
2599− func->doc = "Set number of objects, [0.0-128.0].";
2599+ func->doc = "set number of objects, [0.0-128.0].";
26002600 if( !type_engine_import_mfun( env, func ) ) goto error;
26012601
26022602 func = make_new_mfun( "float", "objects", Shakers_cget_objects ); //! objects
2603− func->doc = "Get number of objects, [0.0-128.0].";
2603+ func->doc = "get number of objects, [0.0-128.0].";
26042604 if( !type_engine_import_mfun( env, func ) ) goto error;
26052605
26062606 func = make_new_mfun( "float", "freq", Shakers_ctrl_freq ); //! frequency
26072607 func->add_arg( "float", "value" );
2608− func->doc = "Set frequency (Hz).";
2608+ func->doc = "set frequency (Hz).";
26092609 if( !type_engine_import_mfun( env, func ) ) goto error;
26102610
26112611 func = make_new_mfun( "float", "freq", Shakers_cget_freq ); //! frequency
2612− func->doc = "Get frequency (Hz).";
2612+ func->doc = "get frequency (Hz).";
26132613 if( !type_engine_import_mfun( env, func ) ) goto error;
26142614
26152615 func = make_new_mfun( "float", "noteOn", Shakers_ctrl_noteOn ); //! note on
26162616 func->add_arg( "float", "value" );
2617− func->doc = "Trigger note on.";
2617+ func->doc = "trigger note on.";
26182618 if( !type_engine_import_mfun( env, func ) ) goto error;
26192619
26202620 func = make_new_mfun( "float", "noteOff", Shakers_ctrl_noteOff ); //! note off
26212621 func->add_arg( "float", "value" );
2622− func->doc = "Trigger note off.";
2622+ func->doc = "trigger note off.";
26232623 if( !type_engine_import_mfun( env, func ) ) goto error;
26242624
26252625 // end the class import
@@ -2630,7 +2630,7 @@ by Perry R. Cook, 1996 - 1999."; · 4 unmodified lines
26302630 // begin Sitar ugen
26312631 //------------------------------------------------------------------------
26322632
2633− doc = "This class implements a sitar plucked string physical model based on the Karplus-Strong algorithm.\n\
2633+ doc = "a sitar plucked string physical model based on the Karplus-Strong algorithm.\n\
26342634 \n\
26352635 This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others. There exist at least two patents, assigned to Stanford, bearing the names of Karplus and/or Strong.\n\
26362636 \n\
@@ -2648,12 +2648,12 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 11 unmodified lines
26482648
26492649 func = make_new_mfun( "float", "pluck", Sitar_ctrl_pluck ); //! pluck
26502650 func->add_arg( "float", "value" );
2651− func->doc = "Pluck string.";
2651+ func->doc = "pluck string.";
26522652 if( !type_engine_import_mfun( env, func ) ) goto error;
26532653
26542654 func = make_new_mfun( "float", "clear", Sitar_ctrl_clear );
26552655 func->add_arg( "float", "value" );
2656− func->doc = "Clear instrument.";
2656+ func->doc = "clear instrument.";
26572657 if( !type_engine_import_mfun( env, func ) ) goto error;
26582658
26592659 // end the class import
@@ -2664,7 +2664,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
26642664 // begin StifKarp ugen
26652665 //------------------------------------------------------------------------
26662666
2667− doc = "This class implements a simple plucked string algorithm (Karplus Strong) with enhancements (Jaffe-Smith, Smith, and others), including string stiffness and pluck position controls. The stiffness is modeled with allpass filters.\n\
2667+ doc = "a simple plucked string algorithm (Karplus Strong) with enhancements (Jaffe-Smith, Smith, and others), including string stiffness and pluck position controls. The stiffness is modeled with allpass filters.\n\
26682668 \n\
26692669 This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.\n\
26702670 \n\
@@ -2690,48 +2690,48 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 19 unmodified lines
26902690
26912691 func = make_new_mfun( "float", "pluck", StifKarp_ctrl_pluck ); //! pluck
26922692 func->add_arg( "float", "value" );
2693− func->doc = "Pluck string.";
2693+ func->doc = "pluck string.";
26942694 if( !type_engine_import_mfun( env, func ) ) goto error;
26952695
26962696 func = make_new_mfun( "float", "clear", StifKarp_ctrl_clear );
26972697 func->add_arg( "float", "value" );
2698− func->doc = "Clear instrument.";
2698+ func->doc = "clear instrument.";
26992699 if( !type_engine_import_mfun( env, func ) ) goto error;
27002700
27012701 func = make_new_mfun( "float", "pickupPosition", StifKarp_ctrl_pickupPosition );
27022702 func->add_arg( "float", "value" );
2703− func->doc = "Set pickup position, [0.0-1.0].";
2703+ func->doc = "set pickup position, [0.0-1.0].";
27042704 if( !type_engine_import_mfun( env, func ) ) goto error;
27052705
27062706 func = make_new_mfun( "float", "pickupPosition", StifKarp_cget_pickupPosition );
2707− func->doc = "Get pickup position, [0.0-1.0].";
2707+ func->doc = "get pickup position, [0.0-1.0].";
27082708 if( !type_engine_import_mfun( env, func ) ) goto error;
27092709
27102710 func = make_new_mfun( "float", "stretch", StifKarp_ctrl_stretch );
27112711 func->add_arg( "float", "value" );
2712− func->doc = "Set string strech, [0.0-1.0].";
2712+ func->doc = "set string strech, [0.0-1.0].";
27132713 if( !type_engine_import_mfun( env, func ) ) goto error;
27142714
27152715 func = make_new_mfun( "float", "stretch", StifKarp_cget_stretch );
2716− func->doc = "Get string strech, [0.0-1.0].";
2716+ func->doc = "get string strech, [0.0-1.0].";
27172717 if( !type_engine_import_mfun( env, func ) ) goto error;
27182718
27192719 func = make_new_mfun( "float", "sustain", StifKarp_ctrl_sustain );
27202720 func->add_arg( "float", "value" );
2721− func->doc = "Set string sustain, [0.0-1.0].";
2721+ func->doc = "set string sustain, [0.0-1.0].";
27222722 if( !type_engine_import_mfun( env, func ) ) goto error;
27232723
27242724 func = make_new_mfun( "float", "sustain", StifKarp_cget_sustain );
2725− func->doc = "Get string sustain, [0.0-1.0].";
2725+ func->doc = "get string sustain, [0.0-1.0].";
27262726 if( !type_engine_import_mfun( env, func ) ) goto error;
27272727
27282728 func = make_new_mfun( "float", "baseLoopGain", StifKarp_ctrl_baseLoopGain );
27292729 func->add_arg( "float", "value" );
2730− func->doc = "Set base loop gain, [0.0-1.0].";
2730+ func->doc = "set base loop gain, [0.0-1.0].";
27312731 if( !type_engine_import_mfun( env, func ) ) goto error;
27322732
27332733 func = make_new_mfun( "float", "baseLoopGain", StifKarp_cget_baseLoopGain );
2734− func->doc = "Get base loop gain, [0.0-1.0].";
2734+ func->doc = "get base loop gain, [0.0-1.0].";
27352735 if( !type_engine_import_mfun( env, func ) ) goto error;
27362736
27372737
@@ -2743,7 +2743,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 5 unmodified lines
27432743 // begin VoicForm ugen
27442744 //------------------------------------------------------------------------
27452745
2746− doc = "This instrument contains an excitation singing wavetable (looping wave with random and periodic vibrato, smoothing on frequency, etc.), excitation noise, and four sweepable complex resonances.\n\
2746+ doc = "an instrument containing an excitation singing wavetable (looping wave with random and periodic vibrato, smoothing on frequency, etc.), excitation noise, and four sweepable complex resonances.\n\
27472747 \n\
27482748 Measured formant data is included, and enough data is there to support either parallel or cascade synthesis. In the floating point case cascade synthesis is the most natural so that's what you'll find here.\n\
27492749 \n\
@@ -2780,93 +2780,93 @@ Phoneme Names:\n\ · 30 unmodified lines
27802780
27812781 func = make_new_mfun( "string", "phoneme", VoicForm_ctrl_phoneme ); //! select phoneme ( above )
27822782 func->add_arg( "string", "value" );
2783− func->doc = "Set phoneme (see above).";
2783+ func->doc = "set phoneme (see above).";
27842784 if( !type_engine_import_mfun( env, func ) ) goto error;
27852785
27862786 func = make_new_mfun( "string", "phoneme", VoicForm_cget_phoneme ); //! select phoneme ( above )
2787− func->doc = "Get phoneme (see above).";
2787+ func->doc = "get phoneme (see above).";
27882788 if( !type_engine_import_mfun( env, func ) ) goto error;
27892789
27902790 func = make_new_mfun( "float", "speak", VoicForm_ctrl_speak ); //! start singing
27912791 func->add_arg( "float", "value" );
2792− func->doc = "Start singing, [0.0-1.0].";
2792+ func->doc = "start singing, [0.0-1.0].";
27932793 if( !type_engine_import_mfun( env, func ) ) goto error;
27942794
27952795 func = make_new_mfun( "float", "quiet", VoicForm_ctrl_quiet ); //! stop singing
27962796 func->add_arg( "float", "value" );
2797− func->doc = "Stop singing, [0.0-1.0].";
2797+ func->doc = "stop singing, [0.0-1.0].";
27982798 if( !type_engine_import_mfun( env, func ) ) goto error;
27992799
28002800 func = make_new_mfun( "float", "voiced", VoicForm_ctrl_voiced ); //! set mix for voiced component
28012801 func->add_arg( "float", "value" );
2802− func->doc = "Set mix for voiced component, [0.0 - 1.0].";
2802+ func->doc = "set mix for voiced component, [0.0 - 1.0].";
28032803 if( !type_engine_import_mfun( env, func ) ) goto error;
28042804
28052805 func = make_new_mfun( "float", "voiced", VoicForm_cget_voiced ); //! set mix for voiced component
2806− func->doc = "Get mix for voiced component, [0.0 - 1.0].";
2806+ func->doc = "get mix for voiced component, [0.0 - 1.0].";
28072807 if( !type_engine_import_mfun( env, func ) ) goto error;
28082808
28092809 func = make_new_mfun( "float", "unVoiced", VoicForm_ctrl_unVoiced ); //! set mix for unvoiced component
28102810 func->add_arg( "float", "value" );
2811− func->doc = "Set mix for unvoiced component, [0.0 - 1.0].";
2811+ func->doc = "set mix for unvoiced component, [0.0 - 1.0].";
28122812 if( !type_engine_import_mfun( env, func ) ) goto error;
28132813
28142814 func = make_new_mfun( "float", "unVoiced", VoicForm_cget_unVoiced ); //! set mix for unvoiced component
2815− func->doc = "Get mix for unvoiced component, [0.0 - 1.0].";
2815+ func->doc = "get mix for unvoiced component, [0.0 - 1.0].";
28162816 if( !type_engine_import_mfun( env, func ) ) goto error;
28172817
28182818 func = make_new_mfun( "float", "pitchSweepRate", VoicForm_ctrl_pitchSweepRate ); //! pitch sweep
28192819 func->add_arg( "float", "value" );
2820− func->doc = "Set rate of pitch sweep, [0.0-1.0].";
2820+ func->doc = "set rate of pitch sweep, [0.0-1.0].";
28212821 if( !type_engine_import_mfun( env, func ) ) goto error;
28222822
28232823 func = make_new_mfun( "float", "pitchSweepRate", VoicForm_cget_pitchSweepRate ); //! pitch sweep
2824− func->doc = "Get rate of pitch sweep, [0.0-1.0].";
2824+ func->doc = "get rate of pitch sweep, [0.0-1.0].";
28252825 if( !type_engine_import_mfun( env, func ) ) goto error;
28262826
28272827 func = make_new_mfun( "float", "voiceMix", VoicForm_ctrl_voiceMix ); //! voiced/unvoiced mix
28282828 func->add_arg( "float", "value" );
2829− func->doc = "Set voiced/unvoiced mix, [0.0-1.0].";
2829+ func->doc = "set voiced/unvoiced mix, [0.0-1.0].";
28302830 if( !type_engine_import_mfun( env, func ) ) goto error;
28312831
28322832 func = make_new_mfun( "float", "voiceMix", VoicForm_cget_voiceMix ); //! voiced/unvoiced mix
2833− func->doc = "Get voiced/unvoiced mix, [0.0-1.0].";
2833+ func->doc = "get voiced/unvoiced mix, [0.0-1.0].";
28342834 if( !type_engine_import_mfun( env, func ) ) goto error;
28352835
28362836 func = make_new_mfun( "int", "phonemeNum", VoicForm_ctrl_selPhoneme ); //! select phoneme by number
28372837 func->add_arg( "int", "value" );
2838− func->doc = "Set phoneme by number, [0.0-128.0].";
2838+ func->doc = "set phoneme by number, [0.0-128.0].";
28392839 if( !type_engine_import_mfun( env, func ) ) goto error;
28402840
28412841 func = make_new_mfun( "int", "phonemeNum", VoicForm_cget_selPhoneme ); //! select phoneme by number
2842− func->doc = "Get phoneme by number, [0.0-128.0].";
2842+ func->doc = "get phoneme by number, [0.0-128.0].";
28432843 if( !type_engine_import_mfun( env, func ) ) goto error;
28442844
28452845 func = make_new_mfun( "float", "vibratoFreq", VoicForm_ctrl_vibratoFreq );//! vibrato
28462846 func->add_arg( "float", "value" );
2847− func->doc = "Set vibrato frequency (Hz).";
2847+ func->doc = "set vibrato frequency (Hz).";
28482848 if( !type_engine_import_mfun( env, func ) ) goto error;
28492849
28502850 func = make_new_mfun( "float", "vibratoFreq", VoicForm_cget_vibratoFreq );//! vibrato
2851− func->doc = "Get vibrato frequency (Hz).";
2851+ func->doc = "get vibrato frequency (Hz).";
28522852 if( !type_engine_import_mfun( env, func ) ) goto error;
28532853
28542854 func = make_new_mfun( "float", "vibratoGain", VoicForm_ctrl_vibratoGain );//! vibrato depth
2855− func->doc = "Set vibrato gain (Hz), [0.0-1.0].";
2855+ func->doc = "set vibrato gain (Hz), [0.0-1.0].";
28562856 func->add_arg( "float", "value" );
28572857 if( !type_engine_import_mfun( env, func ) ) goto error;
28582858
28592859 func = make_new_mfun( "float", "vibratoGain", VoicForm_cget_vibratoGain );//! vibrato depth
2860− func->doc = "Get vibrato gain (Hz), [0.0-1.0].";
2860+ func->doc = "get vibrato gain (Hz), [0.0-1.0].";
28612861 if( !type_engine_import_mfun( env, func ) ) goto error;
28622862
28632863 func = make_new_mfun( "float", "loudness", VoicForm_ctrl_loudness ); //! 'loudness' of voicee
28642864 func->add_arg( "float", "value" );
2865− func->doc = "Set 'loudness' of voice, [0.0-1.0].";
2865+ func->doc = "set 'loudness' of voice, [0.0-1.0].";
28662866 if( !type_engine_import_mfun( env, func ) ) goto error;
28672867
28682868 func = make_new_mfun( "float", "loudness", VoicForm_cget_loudness ); //! 'loudness' of voicee
2869− func->doc = "Get 'loudness' of voice, [0.0-1.0].";
2869+ func->doc = "get 'loudness' of voice, [0.0-1.0].";
28702870 if( !type_engine_import_mfun( env, func ) ) goto error;
28712871
28722872 // end the class import
@@ -2880,7 +2880,7 @@ Phoneme Names:\n\ · 7 unmodified lines
28802880 // begin FM ugen
28812881 //------------------------------------------------------------------------
28822882
2883− doc = "This class controls an arbitrary number of waves and envelopes, determined via a constructor argument.\n\
2883+ doc = "this class controls an arbitrary number of waves and envelopes, determined via a constructor argument.\n\
28842884 \n\
28852885 Control Change Numbers:\n\
28862886 \n\
@@ -2909,47 +2909,47 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 22 unmodified lines
29092909
29102910 func = make_new_mfun( "float", "lfoDepth", FM_ctrl_modDepth ); //!modulation Depth
29112911 func->add_arg( "float", "value" );
2912− func->doc = "Set modulation depth, [0.0-1.0].";
2912+ func->doc = "set modulation depth, [0.0-1.0].";
29132913 if( !type_engine_import_mfun( env, func ) ) goto error;
29142914
29152915 func = make_new_mfun( "float", "lfoDepth", FM_cget_modDepth ); //!modulation Depth
2916− func->doc = "Get modulation depth, [0.0-1.0].";
2916+ func->doc = "get modulation depth, [0.0-1.0].";
29172917 if( !type_engine_import_mfun( env, func ) ) goto error;
29182918
29192919 func = make_new_mfun( "float", "lfoSpeed", FM_ctrl_modSpeed ); //!modulation Speed
29202920 func->add_arg( "float", "value" );
2921− func->doc = "Set modulation speed (Hz).";
2921+ func->doc = "set modulation speed (Hz).";
29222922 if( !type_engine_import_mfun( env, func ) ) goto error;
29232923
29242924 func = make_new_mfun( "float", "lfoSpeed", FM_cget_modSpeed ); //!modulation Speed
2925− func->doc = "Get modulation speed (Hz).";
2925+ func->doc = "get modulation speed (Hz).";
29262926 if( !type_engine_import_mfun( env, func ) ) goto error;
29272927
29282928 func = make_new_mfun( "float", "afterTouch", FM_ctrl_afterTouch ); //!aftertouch
29292929 func->add_arg( "float", "value" );
2930− func->doc = "Set aftertouch, [0.0-1.0].";
2930+ func->doc = "set aftertouch, [0.0-1.0].";
29312931 if( !type_engine_import_mfun( env, func ) ) goto error;
29322932
29332933 func = make_new_mfun( "float", "afterTouch", FM_cget_afterTouch ); //!aftertouch
2934− func->doc = "Get aftertouch, [0.0-1.0].";
2934+ func->doc = "get aftertouch, [0.0-1.0].";
29352935 if( !type_engine_import_mfun( env, func ) ) goto error;
29362936
29372937 func = make_new_mfun( "float", "controlOne", FM_ctrl_control1 ); //! FM control 1
29382938 func->add_arg( "float", "value" );
2939− func->doc = "Set control one [instrument specific].";
2939+ func->doc = "set control one [instrument specific].";
29402940 if( !type_engine_import_mfun( env, func ) ) goto error;
29412941
29422942 func = make_new_mfun( "float", "controlOne", FM_cget_control1 ); //! FM control 1
2943− func->doc = "Get control one [instrument specific].";
2943+ func->doc = "get control one [instrument specific].";
29442944 if( !type_engine_import_mfun( env, func ) ) goto error;
29452945
29462946 func = make_new_mfun( "float", "controlTwo", FM_ctrl_control2 ); //! FM control 2
29472947 func->add_arg( "float", "value" );
2948− func->doc = "Set control two [instrument specific].";
2948+ func->doc = "set control two [instrument specific].";
29492949 if( !type_engine_import_mfun( env, func ) ) goto error;
29502950
29512951 func = make_new_mfun( "float", "controlTwo", FM_cget_control2 ); //! FM control 2
2952− func->doc = "Get control two [instrument specific].";
2952+ func->doc = "get control two [instrument specific].";
29532953 if( !type_engine_import_mfun( env, func ) ) goto error;
29542954
29552955 // end the class import
@@ -2960,7 +2960,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
29602960 // begin BeeThree ugen
29612961 //------------------------------------------------------------------------
29622962
2963− doc = " This class implements a simple 4 operator topology, also referred to as algorithm 8 of the TX81Z.\n\
2963+ doc = "a simple 4-operator FM topology, also referred to as algorithm 8 of the TX81Z.\n\
29642964 \n\
29652965 Algorithm 8 is :\n\
29662966 \n\
@@ -2994,7 +2994,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 27 unmodified lines
29942994 // begin FMVoices ugen
29952995 //------------------------------------------------------------------------
29962996
2997− doc = "This class implements 3 carriers and a common modulator, also referred to as algorithm 6 of the TX81Z.\n\
2997+ doc = "a FM instrument with 3 carriers and a common modulator, also referred to as algorithm 6 of the TX81Z.\n\
29982998 \n\
29992999 Algorithm 6 is :\n\
30003000 \n\
@@ -3020,29 +3020,29 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 19 unmodified lines
30203020
30213021 func = make_new_mfun( "float", "vowel", FMVoices_ctrl_vowel ); //!select vowel
30223022 func->add_arg( "float", "value" );
3023− func->doc = "Set vowel, [0.0-1.0].";
3023+ func->doc = "set vowel, [0.0-1.0].";
30243024 if( !type_engine_import_mfun( env, func ) ) goto error;
30253025
30263026 func = make_new_mfun( "float", "vowel", FMVoices_cget_vowel ); //!select vowel
3027− func->doc = "Get vowel, [0.0-1.0].";
3027+ func->doc = "get vowel, [0.0-1.0].";
30283028 if( !type_engine_import_mfun( env, func ) ) goto error;
30293029
30303030 func = make_new_mfun( "float", "spectralTilt", FMVoices_ctrl_spectralTilt ); //! spectral tilt
30313031 func->add_arg( "float", "value" );
3032− func->doc = "Set spectral tilt, [0.0-1.0].";
3032+ func->doc = "set spectral tilt, [0.0-1.0].";
30333033 if( !type_engine_import_mfun( env, func ) ) goto error;
30343034
30353035 func = make_new_mfun( "float", "spectralTilt", FMVoices_cget_spectralTilt ); //! spectral tilt
3036− func->doc = "Get spectral tilt, [0.0-1.0].";
3036+ func->doc = "get spectral tilt, [0.0-1.0].";
30373037 if( !type_engine_import_mfun( env, func ) ) goto error;
30383038
30393039 func = make_new_mfun( "float", "adsrTarget", FMVoices_ctrl_adsrTarget ); //!adsr targets
30403040 func->add_arg( "float", "value" );
3041− func->doc = "Set ADSR targets, [0.0-1.0].";
3041+ func->doc = "set ADSR targets, [0.0-1.0].";
30423042 if( !type_engine_import_mfun( env, func ) ) goto error;
30433043
30443044 func = make_new_mfun( "float", "adsrTarget", FMVoices_cget_adsrTarget ); //!adsr targets
3045− func->doc = "Get ADSR targets, [0.0-1.0].";
3045+ func->doc = "get ADSR targets, [0.0-1.0].";
30463046 if( !type_engine_import_mfun( env, func ) ) goto error;
30473047
30483048 // end the class import
@@ -3053,7 +3053,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
30533053 // begin HevyMetl ugen
30543054 //------------------------------------------------------------------------
30553055
3056− doc = "This class implements 3 cascade operators with feedback modulation, also referred to as algorithm 3 of the TX81Z.\n\
3056+ doc = "a FM instrument containing 3 cascade operators with feedback modulation, also referred to as algorithm 3 of the TX81Z.\n\
30573057 \n\
30583058 Algorithm 3 is :\n\
30593059 \n\
@@ -3084,7 +3084,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 24 unmodified lines
30843084 // begin PercFlut ugen
30853085 //------------------------------------------------------------------------
30863086
3087− doc = "This class implements algorithm 4 of the TX81Z.\n\
3087+ doc = "a FM instrument corresponding to algorithm 4 of the TX81Z.\n\
30883088 \n\
30893089 Algorithm 4 is :\n\
30903090 \n\
@@ -3115,7 +3115,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 24 unmodified lines
31153115 // begin Rhodey ugen
31163116 //------------------------------------------------------------------------
31173117
3118− doc = " This class implements two simple FM Pairs summed together, also referred to as algorithm 5 of the TX81Z.\n\
3118+ doc = "two simple FM Pairs summed together, also referred to as algorithm 5 of the TX81Z.\n\
31193119 \n\
31203120 Algorithm 5 is :\n\
31213121 \n\
@@ -3150,7 +3150,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 28 unmodified lines
31503150 // begin TubeBell ugen
31513151 //------------------------------------------------------------------------
31523152
3153− doc = "This class implements two simple FM Pairs summed together, also referred to as algorithm 5 of the TX81Z.\n\
3153+ doc = "two simple FM Pairs summed together, also referred to as algorithm 5 of the TX81Z.\n\
31543154 \n\
31553155 Algorithm 5 is :\n\
31563156 \n\
@@ -3182,7 +3182,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 25 unmodified lines
31823182 // begin Wurley ugen
31833183 //------------------------------------------------------------------------
31843184
3185− doc = "This class implements two simple FM Pairs summed together, also referred to as algorithm 5 of the TX81Z.\n\
3185+ doc = "two simple FM Pairs summed together, also referred to as algorithm 5 of the TX81Z.\n\
31863186 \n\
31873187 Algorithm 5 is :\n\
31883188 \n\
@@ -3222,7 +3222,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 33 unmodified lines
32223222 // begin Delay ugen
32233223 //------------------------------------------------------------------------
32243224
3225− doc = "This protected Filter subclass implements a non-interpolating digital delay-line. A fixed maximum length of 4095 and a delay of zero is set using the default constructor. Alternatively, the delay and maximum length can be set during instantiation with an overloaded constructor.\n\
3225+ doc = "a non-interpolating digital delay-line. A fixed maximum length of 4095 and a delay of zero is set using the default constructor. Alternatively, the delay and maximum length can be set during instantiation with an overloaded constructor.\n\
32263226 \n\
32273227 A non-interpolating delay line is typically used in fixed delay-length applications, such as for reverberation.\n\
32283228 \n\
@@ -3238,24 +3238,24 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 9 unmodified lines
32383238 if( Delay_offset_data == CK_INVALID_OFFSET ) goto error;
32393239 func = make_new_mfun( "dur", "delay", Delay_ctrl_delay ); //! length of delay
32403240 func->add_arg( "dur", "value" );
3241− func->doc = "Set length of delay.";
3241+ func->doc = "set length of delay.";
32423242 if( !type_engine_import_mfun( env, func ) ) goto error;
32433243
32443244 func = make_new_mfun( "dur", "delay", Delay_cget_delay ); //! length of delay
3245− func->doc = "Get length of delay.";
3245+ func->doc = "get length of delay.";
32463246 if( !type_engine_import_mfun( env, func ) ) goto error;
32473247
32483248 func = make_new_mfun( "dur", "max", Delay_ctrl_max ); //! max delay (buffer size)
32493249 func->add_arg( "dur", "value" );
3250− func->doc = "Set max delay (buffer size).";
3250+ func->doc = "set max delay (buffer size).";
32513251 if( !type_engine_import_mfun( env, func ) ) goto error;
32523252
32533253 func = make_new_mfun( "dur", "max", Delay_cget_max ); //! max delay (buffer size)
3254− func->doc = "Get max delay (buffer size).";
3254+ func->doc = "get max delay (buffer size).";
32553255 if( !type_engine_import_mfun( env, func ) ) goto error;
32563256
32573257 func = make_new_mfun( "void", "clear", Delay_clear ); //! clear delay
3258− func->doc = "Clear delay line.";
3258+ func->doc = "clear delay line.";
32593259 if( !type_engine_import_mfun( env, func ) ) goto error;
32603260
32613261 // delay 'subs' not actually extending .
@@ -3268,7 +3268,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
32683268 // begin DelayA ugen
32693269 //------------------------------------------------------------------------
32703270
3271− doc = "This Delay subclass implements a fractional-length digital delay-line using a first-order allpass filter. A fixed maximum length of 4095 and a delay of 0.5 is set using the default constructor. Alternatively, the delay and maximum length can be set during instantiation with an overloaded constructor.\n\
3271+ doc = "a fractional-length digital delay-line using a first-order allpass filter. A fixed maximum length of 4095 and a delay of 0.5 is set using the default constructor. Alternatively, the delay and maximum length can be set during instantiation with an overloaded constructor.\n\
32723272 \n\
32733273 An allpass filter has unity magnitude gain but variable phase delay properties, making it useful in achieving fractional delays without affecting a signal's frequency magnitude response. In order to achieve a maximally flat phase delay response, the minimum delay possible in this implementation is limited to a value of 0.5.\n\
32743274 \n\
@@ -3282,24 +3282,24 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 7 unmodified lines
32823282 if( DelayA_offset_data == CK_INVALID_OFFSET ) goto error;
32833283 func = make_new_mfun( "dur", "delay", DelayA_ctrl_delay ); //! length of delay
32843284 func->add_arg( "dur", "value" );
3285− func->doc = "Set length of delay.";
3285+ func->doc = "set length of delay.";
32863286 if( !type_engine_import_mfun( env, func ) ) goto error;
32873287
32883288 func = make_new_mfun( "dur", "delay", DelayA_cget_delay ); //! length of delay
3289− func->doc = "Get length of delay.";
3289+ func->doc = "get length of delay.";
32903290 if( !type_engine_import_mfun( env, func ) ) goto error;
32913291
32923292 func = make_new_mfun( "dur", "max", DelayA_ctrl_max ); //! max delay ( buffer size )
32933293 func->add_arg( "dur", "value" );
3294− func->doc = "Set max delay (buffer size).";
3294+ func->doc = "set max delay (buffer size).";
32953295 if( !type_engine_import_mfun( env, func ) ) goto error;
32963296
32973297 func = make_new_mfun( "dur", "max", DelayA_cget_max ); //! max delay ( buffer size )
3298− func->doc = "Get max delay (buffer size).";
3298+ func->doc = "get max delay (buffer size).";
32993299 if( !type_engine_import_mfun( env, func ) ) goto error;
33003300
33013301 func = make_new_mfun( "void", "clear", DelayA_clear ); //! clear delay
3302− func->doc = "Clear delay line.";
3302+ func->doc = "clear delay line.";
33033303 if( !type_engine_import_mfun( env, func ) ) goto error;
33043304
33053305 // end the class import
@@ -3310,7 +3310,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
33103310 // begin DelayL ugen
33113311 //------------------------------------------------------------------------
33123312
3313− doc = "This Delay subclass implements a fractional-length digital delay-line using first-order linear interpolation. A fixed maximum length of 4095 and a delay of zero is set using the default constructor. Alternatively, the delay and maximum length can be set during instantiation with an overloaded constructor.\n\
3313+ doc = "a fractional-length digital delay-line using first-order linear interpolation. A fixed maximum length of 4095 and a delay of zero is set using the default constructor. Alternatively, the delay and maximum length can be set during instantiation with an overloaded constructor.\n\
33143314 \n\
33153315 Linear interpolation is an efficient technique for achieving fractional delay lengths, though it does introduce high-frequency signal attenuation to varying degrees depending on the fractional delay setting. The use of higher order Lagrange interpolators can typically improve (minimize) this attenuation characteristic.\n\
33163316 \n\
@@ -3329,24 +3329,24 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 12 unmodified lines
33293329 if( DelayL_offset_data == CK_INVALID_OFFSET ) goto error;
33303330 func = make_new_mfun( "dur", "delay", DelayL_ctrl_delay ); //! length of delay
33313331 func->add_arg( "dur", "value" );
3332− func->doc = "Set length of delay.";
3332+ func->doc = "set length of delay.";
33333333 if( !type_engine_import_mfun( env, func ) ) goto error;
33343334
33353335 func = make_new_mfun( "dur", "delay", DelayL_cget_delay ); //! length of delay
3336− func->doc = "Get length of delay.";
3336+ func->doc = "get length of delay.";
33373337 if( !type_engine_import_mfun( env, func ) ) goto error;
33383338
33393339 func = make_new_mfun( "dur", "max", DelayL_ctrl_max ); //! max delay ( buffer size )
33403340 func->add_arg( "dur", "value" );
3341− func->doc = "Set max delay (buffer size).";
3341+ func->doc = "set max delay (buffer size).";
33423342 if( !type_engine_import_mfun( env, func ) ) goto error;
33433343
33443344 func = make_new_mfun( "dur", "max", DelayL_cget_max ); //! max delay ( buffer size )
3345− func->doc = "Get max delay (buffer size).";
3345+ func->doc = "get max delay (buffer size).";
33463346 if( !type_engine_import_mfun( env, func ) ) goto error;
33473347
33483348 func = make_new_mfun( "void", "clear", DelayL_clear ); //! clear delay
3349− func->doc = "Clear delay line.";
3349+ func->doc = "clear delay line.";
33503350 if( !type_engine_import_mfun( env, func ) ) goto error;
33513351
33523352 // end the class import
@@ -3357,7 +3357,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
33573357 // begin Echo ugen
33583358 //------------------------------------------------------------------------
33593359
3360− doc = "This class implements a echo effect.\n\
3360+ doc = "an echo effect.\n\
33613361 \n\
33623362 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
33633363
@@ -3372,29 +3372,29 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 8 unmodified lines
33723372 if( Echo_offset_data == CK_INVALID_OFFSET ) goto error;
33733373 func = make_new_mfun( "dur", "delay", Echo_ctrl_delay ); //! length of echo
33743374 func->add_arg( "dur", "value" );
3375− func->doc = "Set length of echo.";
3375+ func->doc = "set length of echo.";
33763376 if( !type_engine_import_mfun( env, func ) ) goto error;
33773377
33783378 func = make_new_mfun( "dur", "delay", Echo_cget_delay ); //! length of echo
3379− func->doc = "Get length of echo.";
3379+ func->doc = "get length of echo.";
33803380 if( !type_engine_import_mfun( env, func ) ) goto error;
33813381
33823382 func = make_new_mfun( "dur", "max", Echo_ctrl_max ); //! max delay
33833383 func->add_arg( "dur", "value" );
3384− func->doc = "Set max delay (buffer size).";
3384+ func->doc = "set max delay (buffer size).";
33853385 if( !type_engine_import_mfun( env, func ) ) goto error;
33863386
33873387 func = make_new_mfun( "dur", "max", Echo_cget_max ); //! max delay
3388− func->doc = "Get max delay (buffer size).";
3388+ func->doc = "get max delay (buffer size).";
33893389 if( !type_engine_import_mfun( env, func ) ) goto error;
33903390
33913391 func = make_new_mfun( "float", "mix", Echo_ctrl_mix ); //! mix level ( wet/dry )
33923392 func->add_arg( "float", "value" );
3393− func->doc = "Set mix level (wet/dry).";
3393+ func->doc = "set mix level (wet/dry).";
33943394 if( !type_engine_import_mfun( env, func ) ) goto error;
33953395
33963396 func = make_new_mfun( "float", "mix", Echo_cget_mix ); //! mix level ( wet/dry )
3397− func->doc = "Get mix level (wet/dry).";
3397+ func->doc = "get mix level (wet/dry).";
33983398 if( !type_engine_import_mfun( env, func ) ) goto error;
33993399
34003400 // end the class import
@@ -3407,7 +3407,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
34073407 //------------------------------------------------------------------------
34083408 // begin Envelope ugen
34093409 //------------------------------------------------------------------------
3410− doc = "This class implements a simple envelope generator which is capable of ramping to a target value by a specified rate. It also responds to simple `keyOn` and `keyOff` messages, ramping to 1.0 on `keyOn` and to 0.0 on `keyOff`.\n\
3410+ doc = "a simple envelope generator which is capable of ramping to a target value by a specified rate. It also responds to simple `keyOn` and `keyOff` messages, ramping to 1.0 on `keyOn` and to 0.0 on `keyOff`.\n\
34113411 \n\
34123412 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
34133413
@@ -3423,66 +3423,66 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 9 unmodified lines
34233423 if( Envelope_offset_data == CK_INVALID_OFFSET ) goto error;
34243424
34253425 func = make_new_mfun( "int", "keyOn", Envelope_ctrl_keyOn0 ); //! ramp to 1.0
3426− func->doc = "Get keyOn state.";
3426+ func->doc = "get keyOn state.";
34273427 if( !type_engine_import_mfun( env, func ) ) goto error;
34283428
34293429 func = make_new_mfun( "int", "keyOn", Envelope_ctrl_keyOn ); //! ramp to 1.0
34303430 func->add_arg( "int", "value" );
3431− func->doc = "Ramp to 1.0.";
3431+ func->doc = "ramp to 1.0.";
34323432 if( !type_engine_import_mfun( env, func ) ) goto error;
34333433
34343434 func = make_new_mfun( "int", "keyOff", Envelope_ctrl_keyOff0 ); //! ramp to 0.0
3435− func->doc = "Get keyOff state.";
3435+ func->doc = "get keyOff state.";
34363436 if( !type_engine_import_mfun( env, func ) ) goto error;
34373437
34383438 func = make_new_mfun( "int", "keyOff", Envelope_ctrl_keyOff ); //! ramp to 0.0
34393439 func->add_arg( "int", "value" );
3440− func->doc = "Ramp to 0.0.";
3440+ func->doc = "ramp to 0.0.";
34413441 if( !type_engine_import_mfun( env, func ) ) goto error;
34423442
34433443 func = make_new_mfun( "float", "target", Envelope_ctrl_target ); //! ramp to arbitrary value.
34443444 func->add_arg( "float", "value" );
3445− func->doc = "Set value to ramp to.";
3445+ func->doc = "set value to ramp to.";
34463446 if( !type_engine_import_mfun( env, func ) ) goto error;
34473447
34483448 func = make_new_mfun( "float", "target", Envelope_cget_target ); //! ramp to arbitrary value.
3449− func->doc = "Get value to ramp to.";
3449+ func->doc = "get value to ramp to.";
34503450 if( !type_engine_import_mfun( env, func ) ) goto error;
34513451
34523452 func = make_new_mfun( "float", "time", Envelope_ctrl_time ); //! time to reach target
34533453 func->add_arg( "float", "value" );
3454− func->doc = "Set time to reach target (in seconds).";
3454+ func->doc = "set time to reach target (in seconds).";
34553455 if( !type_engine_import_mfun( env, func ) ) goto error;
34563456
34573457 func = make_new_mfun( "float", "time", Envelope_cget_time ); //! time to reach target
3458− func->doc = "Get time to reach target (in seconds).";
3458+ func->doc = "get time to reach target (in seconds).";
34593459 if( !type_engine_import_mfun( env, func ) ) goto error;
34603460
34613461 func = make_new_mfun( "dur", "duration", Envelope_ctrl_duration ); //! time to reach target
34623462 func->add_arg( "dur", "value" );
3463− func->doc = "Set duration to reach target.";
3463+ func->doc = "set duration to reach target.";
34643464 if( !type_engine_import_mfun( env, func ) ) goto error;
34653465
34663466 func = make_new_mfun( "dur", "duration", Envelope_cget_duration ); //! time to reach target
3467− func->doc = "Get duration to reach target.";
3467+ func->doc = "get duration to reach target.";
34683468 if( !type_engine_import_mfun( env, func ) ) goto error;
34693469
34703470 func = make_new_mfun( "float", "rate", Envelope_ctrl_rate ); //! attack rate
34713471 func->add_arg( "float", "value" );
3472− func->doc = "Set rate of change.";
3472+ func->doc = "set rate of change.";
34733473 if( !type_engine_import_mfun( env, func ) ) goto error;
34743474
34753475 func = make_new_mfun( "float", "rate", Envelope_cget_rate ); //! attack rate
3476− func->doc = "Get rate of change.";
3476+ func->doc = "get rate of change.";
34773477 if( !type_engine_import_mfun( env, func ) ) goto error;
34783478
34793479 func = make_new_mfun( "float", "value", Envelope_ctrl_value ); //! set immediate value
34803480 func->add_arg( "float", "value" );
3481− func->doc = "Set immediate value.";
3481+ func->doc = "set immediate value.";
34823482 if( !type_engine_import_mfun( env, func ) ) goto error;
34833483
34843484 func = make_new_mfun( "float", "value", Envelope_cget_value ); //! set immediate value
3485− func->doc = "Get immediate value.";
3485+ func->doc = "get immediate value.";
34863486 if( !type_engine_import_mfun( env, func ) ) goto error;
34873487
34883488
@@ -3494,7 +3494,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 5 unmodified lines
34943494 // begin ADSR ugen
34953495 //------------------------------------------------------------------------
34963496
3497− doc = "This Envelope subclass implements a traditional ADSR (Attack, Decay, Sustain, Release) envelope. It responds to simple `keyOn` and `keyOff` messages, keeping track of its state.\n\
3497+ doc = "a traditional ADSR (Attack, Decay, Sustain, Release) envelope. It responds to simple `keyOn` and `keyOff` messages, keeping track of its state.\n\
34983498 \n\
34993499 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
35003500
@@ -3507,65 +3507,65 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
35073507
35083508 func = make_new_mfun( "dur", "attackTime", ADSR_ctrl_attackTime ); //! attack time
35093509 func->add_arg( "dur", "value" );
3510− func->doc = "Set attack time.";
3510+ func->doc = "set attack time.";
35113511 if( !type_engine_import_mfun( env, func ) ) goto error;
35123512
35133513 func = make_new_mfun( "dur", "attackTime", ADSR_cget_attackTime ); //! attack time
3514− func->doc = "Get attack time.";
3514+ func->doc = "get attack time.";
35153515 if( !type_engine_import_mfun( env, func ) ) goto error;
35163516
35173517 func = make_new_mfun( "float", "attackRate", ADSR_ctrl_attackRate ); //! attack rate
35183518 func->add_arg( "float", "value" );
3519− func->doc = "Set attack rate.";
3519+ func->doc = "set attack rate.";
35203520 if( !type_engine_import_mfun( env, func ) ) goto error;
35213521
35223522 func = make_new_mfun( "float", "attackRate", ADSR_cget_attackRate ); //! attack rate
3523− func->doc = "Get attack rate.";
3523+ func->doc = "get attack rate.";
35243524 if( !type_engine_import_mfun( env, func ) ) goto error;
35253525
35263526 func = make_new_mfun( "dur", "decayTime", ADSR_ctrl_decayTime ); //! decay time
35273527 func->add_arg( "dur", "value" );
3528− func->doc = "Set decay time.";
3528+ func->doc = "set decay time.";
35293529 if( !type_engine_import_mfun( env, func ) ) goto error;
35303530
35313531 func = make_new_mfun( "dur", "decayTime", ADSR_cget_decayTime ); //! decay time
3532− func->doc = "Get decay time.";
3532+ func->doc = "get decay time.";
35333533 if( !type_engine_import_mfun( env, func ) ) goto error;
35343534
35353535 func = make_new_mfun( "float", "decayRate", ADSR_ctrl_decayRate ); //! decay rate
35363536 func->add_arg( "float", "value" );
3537− func->doc = "Set decay rate.";
3537+ func->doc = "set decay rate.";
35383538 if( !type_engine_import_mfun( env, func ) ) goto error;
35393539
35403540 func = make_new_mfun( "float", "decayRate", ADSR_cget_decayRate ); //! decay rate
3541− func->doc = "Get decay rate.";
3541+ func->doc = "get decay rate.";
35423542 if( !type_engine_import_mfun( env, func ) ) goto error;
35433543
35443544 func = make_new_mfun( "float", "sustainLevel", ADSR_ctrl_sustainLevel ); //! sustain level
35453545 func->add_arg( "float", "value" );
3546− func->doc = "Set sustain level.";
3546+ func->doc = "set sustain level.";
35473547 if( !type_engine_import_mfun( env, func ) ) goto error;
35483548
35493549 func = make_new_mfun( "float", "sustainLevel", ADSR_cget_sustainLevel ); //! sustain level
3550− func->doc = "Get sustain level.";
3550+ func->doc = "get sustain level.";
35513551 if( !type_engine_import_mfun( env, func ) ) goto error;
35523552
35533553 func = make_new_mfun( "dur", "releaseTime", ADSR_ctrl_releaseTime ); //! release time
35543554 func->add_arg( "dur", "value" );
3555− func->doc = "Set release time.";
3555+ func->doc = "set release time.";
35563556 if( !type_engine_import_mfun( env, func ) ) goto error;
35573557
35583558 func = make_new_mfun( "dur", "releaseTime", ADSR_cget_releaseTime ); //! release time
3559− func->doc = "Get release time.";
3559+ func->doc = "get release time.";
35603560 if( !type_engine_import_mfun( env, func ) ) goto error;
35613561
35623562 func = make_new_mfun( "float", "releaseRate", ADSR_ctrl_releaseRate ); //! release rate
35633563 func->add_arg( "float", "value" );
3564− func->doc = "Set release rate.";
3564+ func->doc = "set release rate.";
35653565 if( !type_engine_import_mfun( env, func ) ) goto error;
35663566
35673567 func = make_new_mfun( "float", "releaseRate", ADSR_cget_releaseRate ); //! release rate
3568− func->doc = "Get release rate.";
3568+ func->doc = "get release rate.";
35693569 if( !type_engine_import_mfun( env, func ) ) goto error;
35703570
35713571 func = make_new_mfun( "void", "set", ADSR_ctrl_set ); //! set
@@ -3573,7 +3573,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 1 unmodified line
35733573 func->add_arg( "float", "decayTime" );
35743574 func->add_arg( "float", "sustainLevel" );
35753575 func->add_arg( "float", "releaseTime" );
3576− func->doc = "Set attack, decay, sustain, and release all at once (in seconds).";
3576+ func->doc = "set attack, decay, sustain, and release all at once (in seconds).";
35773577 if( !type_engine_import_mfun( env, func ) ) goto error;
35783578
35793579 func = make_new_mfun( "void", "set", ADSR_ctrl_set2 ); //! set
@@ -3581,11 +3581,11 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 1 unmodified line
35813581 func->add_arg( "dur", "decayDuration" );
35823582 func->add_arg( "float", "sustainLevel" );
35833583 func->add_arg( "dur", "releaseDuration" );
3584− func->doc = "Set attack, decay, sustain, and release all at once.";
3584+ func->doc = "set attack, decay, sustain, and release all at once.";
35853585 if( !type_engine_import_mfun( env, func ) ) goto error;
35863586
35873587 func = make_new_mfun( "int", "state", ADSR_cget_state ); //! attack=0, decay=1 , sustain=2, release=3, done=4
3588− func->doc = "Get state; attack=0, decay=1, sustain=2, release=3, done=4";
3588+ func->doc = "get state; attack=0, decay=1, sustain=2, release=3, done=4";
35893589 if( !type_engine_import_mfun( env, func ) ) goto error;
35903590
35913591 if( !type_engine_import_svar( env, "int", "ATTACK", TRUE, (t_CKUINT) &ADSR_state_ATTACK) ) goto error;
@@ -3718,7 +3718,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 126 unmodified lines
37183718 // begin OnePole ugen
37193719 //------------------------------------------------------------------------
37203720
3721− doc = "This protected Filter subclass implements a one-pole digital filter. A method is provided for setting the pole position along the real axis of the z-plane while maintaining a constant peak filter gain.\n\
3721+ doc = "a one-pole digital filter. A method is provided for setting the pole position along the real axis of the z-plane while maintaining a constant peak filter gain.\n\
37223722 \n\
37233723 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
37243724
@@ -3732,29 +3732,29 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 7 unmodified lines
37323732
37333733 func = make_new_mfun( "float", "a1", OnePole_ctrl_a1 ); //! filter coefficient
37343734 func->add_arg( "float", "value" );
3735− func->doc = "Set filter coefficient.";
3735+ func->doc = "set filter coefficient.";
37363736 if( !type_engine_import_mfun( env, func ) ) goto error;
37373737
37383738 func = make_new_mfun( "float", "a1", OnePole_cget_a1 ); //! filter coefficient
3739− func->doc = "Get filter coefficient.";
3739+ func->doc = "get filter coefficient.";
37403740 if( !type_engine_import_mfun( env, func ) ) goto error;
37413741
37423742 func = make_new_mfun( "float", "b0", OnePole_ctrl_b0 ); //! filter coefficient
37433743 func->add_arg( "float", "value" );
3744− func->doc = "Set filter coefficient.";
3744+ func->doc = "set filter coefficient.";
37453745 if( !type_engine_import_mfun( env, func ) ) goto error;
37463746
37473747 func = make_new_mfun( "float", "b0", OnePole_cget_b0 ); //! filter coefficient
3748− func->doc = "Get filter coefficient.";
3748+ func->doc = "get filter coefficient.";
37493749 if( !type_engine_import_mfun( env, func ) ) goto error;
37503750
37513751 func = make_new_mfun( "float", "pole", OnePole_ctrl_pole ); //! set pole position along real axis of z-plane
37523752 func->add_arg( "float", "value" );
3753− func->doc = "Set pole position along real axis of z-plane.";
3753+ func->doc = "set pole position along real axis of z-plane.";
37543754 if( !type_engine_import_mfun( env, func ) ) goto error;
37553755
37563756 func = make_new_mfun( "float", "pole", OnePole_cget_pole ); //! set pole position along real axis of z-plane
3757− func->doc = "Get pole position along real axis of z-plane.";
3757+ func->doc = "get pole position along real axis of z-plane.";
37583758 if( !type_engine_import_mfun( env, func ) ) goto error;
37593759
37603760
@@ -3765,7 +3765,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
37653765 //------------------------------------------------------------------------
37663766 // begin TwoPole ugen
37673767 //------------------------------------------------------------------------
3768− doc = "This protected Filter subclass implements a two-pole digital filter. A method is provided for creating a resonance in the frequency response while maintaining a nearly constant filter gain.\n\
3768+ doc = "a two-pole digital filter. A method is provided for creating a resonance in the frequency response while maintaining a nearly constant filter gain.\n\
37693769 \n\
37703770 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
37713771
@@ -3780,56 +3780,56 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 8 unmodified lines
37803780 if( TwoPole_offset_data == CK_INVALID_OFFSET ) goto error;
37813781 func = make_new_mfun( "float", "a1", TwoPole_ctrl_a1 ); //! filter coefficient
37823782 func->add_arg( "float", "value" );
3783− func->doc = "Set filter coefficient.";
3783+ func->doc = "set filter coefficient.";
37843784 if( !type_engine_import_mfun( env, func ) ) goto error;
37853785
37863786 func = make_new_mfun( "float", "a1", TwoPole_cget_a1 ); //! filter coefficient
3787− func->doc = "Get filter coefficient.";
3787+ func->doc = "get filter coefficient.";
37883788 if( !type_engine_import_mfun( env, func ) ) goto error;
37893789
37903790 func = make_new_mfun( "float", "a2", TwoPole_ctrl_a2 ); //! filter coefficient
37913791 func->add_arg( "float", "value" );
3792− func->doc = "Set filter coefficient.";
3792+ func->doc = "set filter coefficient.";
37933793 if( !type_engine_import_mfun( env, func ) ) goto error;
37943794
37953795 func = make_new_mfun( "float", "a2", TwoPole_cget_a2 ); //! filter coefficient
3796− func->doc = "Get filter coefficient.";
3796+ func->doc = "get filter coefficient.";
37973797 if( !type_engine_import_mfun( env, func ) ) goto error;
37983798
37993799 func = make_new_mfun( "float", "b0", TwoPole_ctrl_b0 ); //! filter coefficient
38003800 func->add_arg( "float", "value" );
3801− func->doc = "Set filter coefficient.";
3801+ func->doc = "set filter coefficient.";
38023802 if( !type_engine_import_mfun( env, func ) ) goto error;
38033803
38043804 func = make_new_mfun( "float", "b0", TwoPole_cget_b0 ); //! filter coefficient
3805− func->doc = "Get filter coefficient.";
3805+ func->doc = "get filter coefficient.";
38063806 if( !type_engine_import_mfun( env, func ) ) goto error;
38073807
38083808 func = make_new_mfun( "float", "freq", TwoPole_ctrl_freq ); //! filter resonance frequency
38093809 func->add_arg( "float", "value" );
3810− func->doc = "Set filter resonance frequency.";
3810+ func->doc = "set filter resonance frequency.";
38113811 if( !type_engine_import_mfun( env, func ) ) goto error;
38123812
38133813 func = make_new_mfun( "float", "freq", TwoPole_cget_freq ); //! filter resonance frequency
3814− func->doc = "Get filter resonance frequency.";
3814+ func->doc = "get filter resonance frequency.";
38153815 if( !type_engine_import_mfun( env, func ) ) goto error;
38163816
38173817 func = make_new_mfun( "float", "radius", TwoPole_ctrl_radius ); //! filter resonance radius
38183818 func->add_arg( "float", "value" );
3819− func->doc = "Set filter radius resonance.";
3819+ func->doc = "set filter radius resonance.";
38203820 if( !type_engine_import_mfun( env, func ) ) goto error;
38213821
38223822 func = make_new_mfun( "float", "radius", TwoPole_cget_radius ); //! filter resonance radius
3823− func->doc = "Get filter radius resonance.";
3823+ func->doc = "get filter radius resonance.";
38243824 if( !type_engine_import_mfun( env, func ) ) goto error;
38253825
38263826 func = make_new_mfun( "int", "norm", TwoPole_ctrl_norm ); //! toggle filter normalization
38273827 func->add_arg( "int", "value" );
3828− func->doc = "Set filter normalization";
3828+ func->doc = "set filter normalization.";
38293829 if( !type_engine_import_mfun( env, func ) ) goto error;
38303830
38313831 func = make_new_mfun( "int", "norm", TwoPole_cget_norm ); //! toggle filter normalization
3832− func->doc = "Get filter normalization";
3832+ func->doc = "get filter normalization.";
38333833 if( !type_engine_import_mfun( env, func ) ) goto error;
38343834
38353835
@@ -3840,7 +3840,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
38403840 //------------------------------------------------------------------------
38413841 // begin OneZero ugen
38423842 //------------------------------------------------------------------------
3843− doc = " This protected Filter subclass implements a one-zero digital filter. A method is provided for setting the zero position along the real axis of the z-plane while maintaining a constant filter gain.\n\
3843+ doc = "a one-zero digital filter. A method is provided for setting the zero position along the real axis of the z-plane while maintaining a constant filter gain.\n\
38443844 \n\
38453845 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
38463846
@@ -3853,29 +3853,29 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
38533853 if( OneZero_offset_data == CK_INVALID_OFFSET ) goto error;
38543854 func = make_new_mfun( "float", "zero", OneZero_ctrl_zero ); //! set zero position
38553855 func->add_arg( "float", "value" );
3856− func->doc = "Set zero position";
3856+ func->doc = "set zero position.";
38573857 if( !type_engine_import_mfun( env, func ) ) goto error;
38583858
38593859 func = make_new_mfun( "float", "zero", OneZero_cget_zero ); //! set zero position
3860− func->doc = "Get zero position";
3860+ func->doc = "get zero position.";
38613861 if( !type_engine_import_mfun( env, func ) ) goto error;
38623862
38633863 func = make_new_mfun( "float", "b0", OneZero_ctrl_b0 ); //! filter coefficient
38643864 func->add_arg( "float", "value" );
3865− func->doc = "Set filter coefficient.";
3865+ func->doc = "set filter coefficient.";
38663866 if( !type_engine_import_mfun( env, func ) ) goto error;
38673867
38683868 func = make_new_mfun( "float", "b0", OneZero_cget_b0 ); //! filter coefficient
3869− func->doc = "Get filter coefficient.";
3869+ func->doc = "get filter coefficient.";
38703870 if( !type_engine_import_mfun( env, func ) ) goto error;
38713871
38723872 func = make_new_mfun( "float", "b1", OneZero_ctrl_b1 ); //! filter coefficient
38733873 func->add_arg( "float", "value" );
3874− func->doc = "Set filter coefficient.";
3874+ func->doc = "set filter coefficient.";
38753875 if( !type_engine_import_mfun( env, func ) ) goto error;
38763876
38773877 func = make_new_mfun( "float", "b1", OneZero_cget_b1 ); //! filter coefficient
3878− func->doc = "Get filter coefficient.";
3878+ func->doc = "get filter coefficient.";
38793879 if( !type_engine_import_mfun( env, func ) ) goto error;
38803880
38813881
@@ -3887,7 +3887,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 5 unmodified lines
38873887 // begin TwoZero ugen
38883888 //------------------------------------------------------------------------
38893889
3890− doc = "This protected Filter subclass implements a two-zero digital filter. A method is provided for creating a 'notch' in the frequency response while maintaining a constant filter gain.\n\
3890+ doc = "a two-zero digital filter. A method is provided for creating a 'notch' in the frequency response while maintaining a constant filter gain.\n\
38913891 \n\
38923892 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
38933893
@@ -3900,47 +3900,47 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
39003900 if( TwoZero_offset_data == CK_INVALID_OFFSET ) goto error;
39013901 func = make_new_mfun( "float", "b0", TwoZero_ctrl_b0 ); //! filter coefficient
39023902 func->add_arg( "float", "value" );
3903− func->doc = "Set filter coefficient.";
3903+ func->doc = "set filter coefficient.";
39043904 if( !type_engine_import_mfun( env, func ) ) goto error;
39053905
39063906 func = make_new_mfun( "float", "b0", TwoZero_cget_b0 ); //! filter coefficient
3907− func->doc = "Get filter coefficient.";
3907+ func->doc = "get filter coefficient.";
39083908 if( !type_engine_import_mfun( env, func ) ) goto error;
39093909
39103910 func = make_new_mfun( "float", "b1", TwoZero_ctrl_b1 ); //! filter coefficient
39113911 func->add_arg( "float", "value" );
3912− func->doc = "Set filter coefficient.";
3912+ func->doc = "set filter coefficient.";
39133913 if( !type_engine_import_mfun( env, func ) ) goto error;
39143914
39153915 func = make_new_mfun( "float", "b1", TwoZero_cget_b1 ); //! filter coefficient
3916− func->doc = "Get filter coefficient.";
3916+ func->doc = "get filter coefficient.";
39173917 if( !type_engine_import_mfun( env, func ) ) goto error;
39183918
39193919 func = make_new_mfun( "float", "b2", TwoZero_ctrl_b2 ); //! filter coefficient
39203920 func->add_arg( "float", "value" );
3921− func->doc = "Set filter coefficient.";
3921+ func->doc = "set filter coefficient.";
39223922 if( !type_engine_import_mfun( env, func ) ) goto error;
39233923
39243924 func = make_new_mfun( "float", "b2", TwoZero_cget_b2 ); //! filter coefficient
3925− func->doc = "Get filter coefficient.";
3925+ func->doc = "get filter coefficient.";
39263926 if( !type_engine_import_mfun( env, func ) ) goto error;
39273927
39283928 func = make_new_mfun( "float", "freq", TwoZero_ctrl_freq ); //! filter notch frequency
39293929 func->add_arg( "float", "value" );
3930− func->doc = "Set filter notch frequency.";
3930+ func->doc = "set filter notch frequency.";
39313931 if( !type_engine_import_mfun( env, func ) ) goto error;
39323932
39333933 func = make_new_mfun( "float", "freq", TwoZero_cget_freq ); //! filter notch frequency
3934− func->doc = "Get filter notch frequency.";
3934+ func->doc = "get filter notch frequency.";
39353935 if( !type_engine_import_mfun( env, func ) ) goto error;
39363936
39373937 func = make_new_mfun( "float", "radius", TwoZero_ctrl_radius ); //! filter notch radius
39383938 func->add_arg( "float", "value" );
3939− func->doc = "Set filter notch radius.";
3939+ func->doc = "set filter notch radius.";
39403940 if( !type_engine_import_mfun( env, func ) ) goto error;
39413941
39423942 func = make_new_mfun( "float", "radius", TwoZero_cget_radius ); //! filter notch radius
3943− func->doc = "Get filter notch radius.";
3943+ func->doc = "get filter notch radius.";
39443944 if( !type_engine_import_mfun( env, func ) ) goto error;
39453945
39463946
@@ -3952,7 +3952,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 5 unmodified lines
39523952 // begin PoleZero ugen
39533953 //------------------------------------------------------------------------
39543954
3955− doc = "This protected Filter subclass implements a one-pole, one-zero digital filter. A method is provided for creating an allpass filter with a given coefficient. Another method is provided to create a DC blocking filter.\n\
3955+ doc = "a one-pole, one-zero digital filter. A method is provided for creating an allpass filter with a given coefficient. Another method is provided to create a DC blocking filter.\n\
39563956 \n\
39573957 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
39583958
@@ -3965,47 +3965,47 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
39653965 if( PoleZero_offset_data == CK_INVALID_OFFSET ) goto error;
39663966 func = make_new_mfun( "float", "a1", PoleZero_ctrl_a1 ); //! filter coefficient
39673967 func->add_arg( "float", "value" );
3968− func->doc = "Set filter coefficient.";
3968+ func->doc = "set filter coefficient.";
39693969 if( !type_engine_import_mfun( env, func ) ) goto error;
39703970
39713971 func = make_new_mfun( "float", "a1", PoleZero_cget_a1 ); //! filter coefficient
3972− func->doc = "Get filter coefficient.";
3972+ func->doc = "get filter coefficient.";
39733973 if( !type_engine_import_mfun( env, func ) ) goto error;
39743974
39753975 func = make_new_mfun( "float", "b0", PoleZero_ctrl_b0 ); //! filter coefficient
39763976 func->add_arg( "float", "value" );
3977− func->doc = "Set filter coefficient.";
3977+ func->doc = "set filter coefficient.";
39783978 if( !type_engine_import_mfun( env, func ) ) goto error;
39793979
39803980 func = make_new_mfun( "float", "b0", PoleZero_cget_b0 ); //! filter coefficient
3981− func->doc = "Get filter coefficient.";
3981+ func->doc = "get filter coefficient.";
39823982 if( !type_engine_import_mfun( env, func ) ) goto error;
39833983
39843984 func = make_new_mfun( "float", "b1", PoleZero_ctrl_b1 ); //! filter coefficient
39853985 func->add_arg( "float", "value" );
3986− func->doc = "Set filter coefficient.";
3986+ func->doc = "set filter coefficient.";
39873987 if( !type_engine_import_mfun( env, func ) ) goto error;
39883988
39893989 func = make_new_mfun( "float", "b1", PoleZero_cget_b1 ); //! filter coefficient
3990− func->doc = "Get filter coefficient.";
3990+ func->doc = "get filter coefficient.";
39913991 if( !type_engine_import_mfun( env, func ) ) goto error;
39923992
39933993 func = make_new_mfun( "float", "blockZero", PoleZero_ctrl_blockZero ); //! DC blocking filter with given pole position
39943994 func->add_arg( "float", "value" );
3995− func->doc = "Set DC blocking filter with given pole position.";
3995+ func->doc = "set DC blocking filter with given pole position.";
39963996 if( !type_engine_import_mfun( env, func ) ) goto error;
39973997
39983998 func = make_new_mfun( "float", "blockZero", PoleZero_cget_blockZero ); //! DC blocking filter with given pole position
3999− func->doc = "Get DC blocking filter with given pole position.";
3999+ func->doc = "get DC blocking filter with given pole position.";
40004000 if( !type_engine_import_mfun( env, func ) ) goto error;
40014001
40024002 func = make_new_mfun( "float", "allpass", PoleZero_ctrl_allpass ); //!allpass filter with given coefficient
40034003 func->add_arg( "float", "value" );
4004− func->doc = "Set allpass filter with given coefficient.";
4004+ func->doc = "set allpass filter with given coefficient.";
40054005 if( !type_engine_import_mfun( env, func ) ) goto error;
40064006
40074007 func = make_new_mfun( "float", "allpass", PoleZero_cget_allpass ); //!allpass filter with given coefficient
4008− func->doc = "Get allpass filter with given coefficient.";
4008+ func->doc = "get allpass filter with given coefficient.";
40094009 if( !type_engine_import_mfun( env, func ) ) goto error;
40104010
40114011 // end the class import
@@ -4021,7 +4021,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 9 unmodified lines
40214021 // begin JCRev ugen
40224022 //------------------------------------------------------------------------
40234023
4024− doc = "John Chowning's reverberator class. This class is derived from the CLM NRev function, which is based on the use of networks of simple allpass and comb delay filters. This particular arrangement consists of 6 comb filters in parallel, followed by 3 allpass filters, a lowpass filter, and another allpass in series, followed by two allpass filters in parallel with corresponding right and left outputs.\n\
4024+ doc = "John Chowning's reverberator class. This class is derived from the CLM NRev function, which is based on the use of networks of simple allpass and comb delay filters. This particular arrangement consists of 6 comb filters in parallel, followed by 3 allpass filters, a lowpass filter, and another allpass in series, followed by two allpass filters in parallel with corresponding right and left outputs.\n\
40254025 \n\
40264026 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
40274027
@@ -4034,11 +4034,11 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
40344034 if( JCRev_offset_data == CK_INVALID_OFFSET ) goto error;
40354035 func = make_new_mfun( "float", "mix", JCRev_ctrl_mix ); //! mix level
40364036 func->add_arg( "float", "value" );
4037− func->doc = "Set mix level.";
4037+ func->doc = "set mix level.";
40384038 if( !type_engine_import_mfun( env, func ) ) goto error;
40394039
40404040 func = make_new_mfun( "float", "mix", JCRev_cget_mix ); //! mix level
4041− func->doc = "Get mix level.";
4041+ func->doc = "get mix level.";
40424042 if( !type_engine_import_mfun( env, func ) ) goto error;
40434043
40444044
@@ -4050,7 +4050,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 5 unmodified lines
40504050 // begin NRev ugen
40514051 //------------------------------------------------------------------------
40524052
4053− doc = "CCRMA's NRev reverberator class. This class is derived from the CLM NRev function, which is based on the use of networks of simple allpass and comb delay filters. This particular arrangement consists of 6 comb filters in parallel, followed by 3 allpass filters, a lowpass filter, and another allpass in series, followed by two allpass filters in parallel with corresponding rightand left outputs.\n\
4053+ doc = "CCRMA's NRev reverberator class. This class is derived from the CLM NRev function, which is based on the use of networks of simple allpass and comb delay filters. This particular arrangement consists of 6 comb filters in parallel, followed by 3 allpass filters, a lowpass filter, and another allpass in series, followed by two allpass filters in parallel with corresponding rightand left outputs.\n\
40544054 \n\
40554055 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
40564056
@@ -4063,11 +4063,11 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
40634063 if( NRev_offset_data == CK_INVALID_OFFSET ) goto error;
40644064 func = make_new_mfun( "float", "mix", NRev_ctrl_mix ); // set effect mix
40654065 func->add_arg( "float", "value" );
4066− func->doc = "Set mix level.";
4066+ func->doc = "set mix level.";
40674067 if( !type_engine_import_mfun( env, func ) ) goto error;
40684068
40694069 func = make_new_mfun( "float", "mix", NRev_cget_mix ); // set effect mix
4070− func->doc = "Get mix level.";
4070+ func->doc = "get mix level.";
40714071 if( !type_engine_import_mfun( env, func ) ) goto error;
40724072
40734073 // end the class import
@@ -4078,7 +4078,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
40784078 // begin PRCRev ugen
40794079 //------------------------------------------------------------------------
40804080
4081− doc = "Perry's simple reverberator class. This class is based on some of the famous Stanford/CCRMA reverbs (NRev, KipRev), which were based on the Chowning/Moorer/Schroeder reverberators using networks of simple allpass and comb delay filters. This class implements two series allpass units and two parallel comb filters.\n\
4081+ doc = "Perry's simple reverberator class. This class is based on some of the famous Stanford/CCRMA reverbs (NRev, KipRev), which were based on the Chowning/Moorer/Schroeder reverberators using networks of simple allpass and comb delay filters. This class implements two series allpass units and two parallel comb filters.\n\
40824082 \n\
40834083 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
40844084
@@ -4091,11 +4091,11 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
40914091 if( PRCRev_offset_data == CK_INVALID_OFFSET ) goto error;
40924092 func = make_new_mfun( "float", "mix", PRCRev_ctrl_mix ); //! mix level
40934093 func->add_arg( "float", "value" );
4094− func->doc = "Set mix level.";
4094+ func->doc = "set mix level.";
40954095 if( !type_engine_import_mfun( env, func ) ) goto error;
40964096
40974097 func = make_new_mfun( "float", "mix", PRCRev_cget_mix ); //! mix level
4098− func->doc = "Get mix level.";
4098+ func->doc = "get mix level.";
40994099 if( !type_engine_import_mfun( env, func ) ) goto error;
41004100
41014101 // end the class import
@@ -4107,7 +4107,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 5 unmodified lines
41074107 // begin Chorus ugen
41084108 //------------------------------------------------------------------------
41094109
4110− doc = "Implements a chorus effect.\n\
4110+ doc = "a chorus effect.\n\
41114111 \n\
41124112 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
41134113
@@ -4120,38 +4120,38 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
41204120 if( Chorus_offset_data == CK_INVALID_OFFSET ) goto error;
41214121 func = make_new_mfun( "float", "modFreq", Chorus_ctrl_modFreq ); //! modulation frequency
41224122 func->add_arg( "float", "value" );
4123− func->doc = "Set modulation frequency.";
4123+ func->doc = "set modulation frequency.";
41244124 if( !type_engine_import_mfun( env, func ) ) goto error;
41254125
41264126 func = make_new_mfun( "float", "modFreq", Chorus_cget_modFreq ); //! modulation frequency
4127− func->doc = "Get modulation frequency.";
4127+ func->doc = "get modulation frequency.";
41284128 if( !type_engine_import_mfun( env, func ) ) goto error;
41294129
41304130 func = make_new_mfun( "float", "modDepth", Chorus_ctrl_modDepth ); //! modulation depth
41314131 func->add_arg( "float", "value" );
4132− func->doc = "Set modulation depth.";
4132+ func->doc = "set modulation depth.";
41334133 if( !type_engine_import_mfun( env, func ) ) goto error;
41344134
41354135 func = make_new_mfun( "float", "modDepth", Chorus_cget_modDepth ); //! modulation depth
4136− func->doc = "Get modulation depth.";
4136+ func->doc = "get modulation depth.";
41374137 if( !type_engine_import_mfun( env, func ) ) goto error;
41384138
41394139 func = make_new_mfun( "dur", "baseDelay", Chorus_ctrl_baseDelay ); //! base delay
41404140 func->add_arg( "dur", "value" );
4141− func->doc = "Set base delay.";
4141+ func->doc = "set base delay.";
41424142 if( !type_engine_import_mfun( env, func ) ) goto error;
41434143
41444144 func = make_new_mfun( "dur", "baseDelay", Chorus_cget_baseDelay ); //! base delay
4145− func->doc = "Get base delay.";
4145+ func->doc = "get base delay.";
41464146 if( !type_engine_import_mfun( env, func ) ) goto error;
41474147
41484148 func = make_new_mfun( "float", "mix", Chorus_ctrl_mix ); //! effect mix
41494149 func->add_arg( "float", "value" );
4150− func->doc = "Set effect mix.";
4150+ func->doc = "set effect mix.";
41514151 if( !type_engine_import_mfun( env, func ) ) goto error;
41524152
41534153 func = make_new_mfun( "float", "mix", Chorus_cget_mix ); //! effect mix
4154− func->doc = "Get effect mix.";
4154+ func->doc = "get effect mix.";
41554155 if( !type_engine_import_mfun( env, func ) ) goto error;
41564156
41574157 func = make_new_mfun( "void", "max", Chorus_ctrl_set );
@@ -4168,7 +4168,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 10 unmodified lines
41684168 // begin Modulate ugen
41694169 //------------------------------------------------------------------------
41704170
4171− doc = "This class combines random and periodic modulations to give a nice, natural human modulation function.\n\
4171+ doc = "combines random and periodic modulations to give a nice, natural human modulation function.\n\
41724172 \n\
41734173 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
41744174
@@ -4181,29 +4181,29 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
41814181 if( Modulate_offset_data == CK_INVALID_OFFSET ) goto error;
41824182 func = make_new_mfun( "float", "vibratoRate", Modulate_ctrl_vibratoRate ); //! set rate of vibrato
41834183 func->add_arg( "float", "value" );
4184− func->doc = "Set rate for vibrato.";
4184+ func->doc = "set rate for vibrato.";
41854185 if( !type_engine_import_mfun( env, func ) ) goto error;
41864186
41874187 func = make_new_mfun( "float", "vibratoRate", Modulate_cget_vibratoRate ); //! set rate of vibrato
4188− func->doc = "Get rate for vibrato.";
4188+ func->doc = "get rate for vibrato.";
41894189 if( !type_engine_import_mfun( env, func ) ) goto error;
41904190
41914191 func = make_new_mfun( "float", "vibratoGain", Modulate_ctrl_vibratoGain ); //! gain for vibrato
41924192 func->add_arg( "float", "value" );
4193− func->doc = "Set gain for vibrato.";
4193+ func->doc = "set gain for vibrato.";
41944194 if( !type_engine_import_mfun( env, func ) ) goto error;
41954195
41964196 func = make_new_mfun( "float", "vibratoGain", Modulate_cget_vibratoGain ); //! gain for vibrato
4197− func->doc = "Get gain for vibrato.";
4197+ func->doc = "get gain for vibrato.";
41984198 if( !type_engine_import_mfun( env, func ) ) goto error;
41994199
42004200 func = make_new_mfun( "float", "randomGain", Modulate_ctrl_randomGain ); //! gain for random contribution
42014201 func->add_arg( "float", "value" );
4202− func->doc = "Set gain for random contribution";
4202+ func->doc = "set gain for random contribution.";
42034203 if( !type_engine_import_mfun( env, func ) ) goto error;
42044204
42054205 func = make_new_mfun( "float", "randomGain", Modulate_cget_randomGain ); //! gain for random contribution
4206− func->doc = "Get gain for random contribution";
4206+ func->doc = "get gain for random contribution.";
42074207 if( !type_engine_import_mfun( env, func ) ) goto error;
42084208
42094209
@@ -4215,7 +4215,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 5 unmodified lines
42154215 // begin PitShift ugen
42164216 //------------------------------------------------------------------------
42174217
4218− doc = "This class implements a simple pitch shifter using delay lines.\n\
4218+ doc = "a simple pitch shifter using delay lines.\n\
42194219 \n\
42204220 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
42214221
@@ -4228,30 +4228,30 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
42284228 if( PitShift_offset_data == CK_INVALID_OFFSET ) goto error;
42294229 func = make_new_mfun( "float", "shift", PitShift_ctrl_shift ); //! degree of pitch shifting
42304230 func->add_arg( "float", "value" );
4231− func->doc = "Set degree of pitch shifting";
4231+ func->doc = "set degree of pitch shifting";
42324232 if( !type_engine_import_mfun( env, func ) ) goto error;
42334233
42344234 func = make_new_mfun( "float", "shift", PitShift_cget_shift ); //! degree of pitch shifting
4235− func->doc = "Get degree of pitch shifting";
4235+ func->doc = "get degree of pitch shifting";
42364236 if( !type_engine_import_mfun( env, func ) ) goto error;
42374237
42384238 func = make_new_mfun( "float", "mix", PitShift_ctrl_effectMix ); //! mix level
42394239 func->add_arg( "float", "value" );
4240− func->doc = "Set mix level";
4240+ func->doc = "set mix level";
42414241 if( !type_engine_import_mfun( env, func ) ) goto error;
42424242
42434243 func = make_new_mfun( "float", "mix", PitShift_cget_effectMix ); //! mix level
4244− func->doc = "Get mix level";
4244+ func->doc = "get mix level";
42454245 if( !type_engine_import_mfun( env, func ) ) goto error;
42464246
42474247 func = make_new_mfun( "float", "effectMix", PitShift_ctrl_effectMix ); //! mix level
4248− func->doc = "Set effect mix level";
4248+ func->doc = "set effect mix level";
42494249 func->add_arg( "float", "value" );
42504250
42514251 if( !type_engine_import_mfun( env, func ) ) goto error;
42524252
42534253 func = make_new_mfun( "float", "effectMix", PitShift_cget_effectMix ); //! mix level
4254− func->doc = "Get effect mix level";
4254+ func->doc = "get effect mix level";
42554255 if( !type_engine_import_mfun( env, func ) ) goto error;
42564256
42574257
@@ -4263,7 +4263,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 5 unmodified lines
42634263 // begin SubNoise ugen
42644264 //------------------------------------------------------------------------
42654265
4266− doc = "Generates a new random number every 'rate' ticks using the C `rand()` function. The quality of the r`and()` function varies from one OS to another.\n\
4266+ doc = "generates a new random number every 'rate' ticks using the C `rand()` function. The quality of the r`and()` function varies from one OS to another.\n\
42674267 \n\
42684268 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.";
42694269
@@ -4276,11 +4276,11 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
42764276 if( SubNoise_offset_data == CK_INVALID_OFFSET ) goto error;
42774277 func = make_new_mfun( "int", "rate", SubNoise_ctrl_rate ); //! subsampling rate
42784278 func->add_arg( "int", "value" );
4279− func->doc = "Set subsampling rate";
4279+ func->doc = "set subsampling rate";
42804280 if( !type_engine_import_mfun( env, func ) ) goto error;
42814281
42824282 func = make_new_mfun( "int", "rate", SubNoise_cget_rate ); //! subsampling rate
4283− func->doc = "Get subsampling rate";
4283+ func->doc = "get subsampling rate";
42844284 if( !type_engine_import_mfun( env, func ) ) goto error;
42854285
42864286 // end the class import
@@ -4293,7 +4293,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
42934293 // begin WvIn ugen
42944294 //------------------------------------------------------------------------
42954295
4296− doc = "This class provides input support for various audio file formats. It also serves as a base class for 'realtime' streaming subclasses.\n\
4296+ doc = "input support for various audio file formats. It also serves as a base class for 'realtime' streaming subclasses.\n\
42974297 \n\
42984298 WvIn loads the contents of an audio file for subsequent output. Linear interpolation is used for fractional 'read rates'.\n\
42994299 \n\
@@ -4312,20 +4312,20 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 12 unmodified lines
43124312 if( WvIn_offset_data == CK_INVALID_OFFSET ) goto error;
43134313 func = make_new_mfun( "float", "rate", WvIn_ctrl_rate ); //! playback rate
43144314 func->add_arg( "float", "value" );
4315− func->doc = "Set playback rate.";
4315+ func->doc = "set playback rate.";
43164316 if( !type_engine_import_mfun( env, func ) ) goto error;
43174317
43184318 func = make_new_mfun( "float", "rate", WvIn_cget_rate ); //! playback rate
4319− func->doc = "Get playback rate.";
4319+ func->doc = "get playback rate.";
43204320 if( !type_engine_import_mfun( env, func ) ) goto error;
43214321
43224322 func = make_new_mfun( "string", "path", WvIn_ctrl_path ); //! specifies file to be played
43234323 func->add_arg( "string", "value" );
4324− func->doc = "Set file to be played.";
4324+ func->doc = "set file to be played.";
43254325 if( !type_engine_import_mfun( env, func ) ) goto error;
43264326
43274327 func = make_new_mfun( "string", "path", WvIn_cget_path ); //! specifies file to be played
4328− func->doc = "Get file to be played.";
4328+ func->doc = "get file to be played.";
43294329 if( !type_engine_import_mfun( env, func ) ) goto error;
43304330
43314331
@@ -4337,7 +4337,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 5 unmodified lines
43374337 // begin WaveLoop ugen
43384338 //------------------------------------------------------------------------
43394339
4340− doc = "This class inherits from WvIn and provides audio file looping functionality.\n\
4340+ doc = "inherits from WvIn and provides audio file looping functionality.\n\
43414341 \n\
43424342 WaveLoop supports multi-channel data in interleaved format. It is important to distinguish the `tick()` methods, which return samples produced by averaging across sample frames, from the `tickFrame()` methods, which return pointers to multi-channel sample frames. For single-channel data, these methods return equivalent values.\n\
43434343 \n\
@@ -4350,29 +4350,29 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 6 unmodified lines
43504350
43514351 func = make_new_mfun( "float", "freq", WaveLoop_ctrl_freq ); //! set frequency of playback ( loops / second )
43524352 func->add_arg( "float", "value" );
4353− func->doc = "Set frequency of playback (loops/second).";
4353+ func->doc = "set frequency of playback (loops/second).";
43544354 if( !type_engine_import_mfun( env, func ) ) goto error;
43554355
43564356 func = make_new_mfun( "float", "freq", WaveLoop_cget_freq ); //! set frequency of playback ( loops / second )
4357− func->doc = "Get frequency of playback (loops/second).";
4357+ func->doc = "get frequency of playback (loops/second).";
43584358 if( !type_engine_import_mfun( env, func ) ) goto error;
43594359
43604360 func = make_new_mfun( "float", "addPhase", WaveLoop_ctrl_phase ); //! offset by phase
43614361 func->add_arg( "float", "value" );
4362− func->doc = "Set offset by phase.";
4362+ func->doc = "set offset by phase.";
43634363 if( !type_engine_import_mfun( env, func ) ) goto error;
43644364
43654365 func = make_new_mfun( "float", "addPhase", WaveLoop_cget_phase ); //! offset by phase
4366− func->doc = "Get offset by phase.";
4366+ func->doc = "get offset by phase.";
43674367 if( !type_engine_import_mfun( env, func ) ) goto error;
43684368
43694369 func = make_new_mfun( "float", "addPhaseOffset", WaveLoop_ctrl_phaseOffset ); //! set phase offset
43704370 func->add_arg( "float", "value" );
4371− func->doc = "Set phase offset.";
4371+ func->doc = "set phase offset.";
43724372 if( !type_engine_import_mfun( env, func ) ) goto error;
43734373
43744374 func = make_new_mfun( "float", "addPhaseOffset", WaveLoop_cget_phaseOffset ); //! set phase offset
4375− func->doc = "Get phase offset.";
4375+ func->doc = "get phase offset.";
43764376 if( !type_engine_import_mfun( env, func ) ) goto error;
43774377
43784378 // end the class import
@@ -4384,11 +4384,11 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 5 unmodified lines
43844384 // begin WvOut ugen
43854385 //------------------------------------------------------------------------
43864386
4387− doc = "This class provides output support for various audio file formats. It also serves as a base class for 'realtime' streaming subclasses.\n\
4387+ doc = "output support for various audio file formats. It also serves as a base class for 'realtime' streaming subclasses.\n\
43884388 \n\
4389−WvOut writes samples to an audio file. It supports multi-channel data in interleaved format. It is important to distinguish the `tick()` methods, which output single samples to all channels in a sample frame, from the `tickFrame()` method, which takes a pointer to multi-channel sample frame data.\n\
4389+WvOut writes samples to an audio file. It supports multi-channel data in interleaved format. It is important to distinguish the `tick()` methods, which output single samples to all channels in a sample frame, from the `tickFrame()` method, which takes a pointer to multi-channel sample frame data.\n\
43904390 \n\
4391−WvOut currently supports WAV, AIFF, AIFC, SND (AU), MAT-file (Matlab), and STK RAW file formats. Signed integer (8-, 16-, and 32-bit) and floating- point (32- and 64-bit) data types are supported. STK RAW files use 16-bit integers by definition. MAT-files will always be written as 64-bit floats. If a data type specification does not match the specified file type, the data type will automatically be modified. Uncompressed data types are not supported.\n\
4391+WvOut currently supports WAV, AIFF, AIFC, SND (AU), MAT-file (Matlab), and STK RAW file formats. Signed integer (8-, 16-, and 32-bit) and floating- point (32- and 64-bit) data types are supported. STK RAW files use 16-bit integers by definition. MAT-files will always be written as 64-bit floats. If a data type specification does not match the specified file type, the data type will automatically be modified. Uncompressed data types are not supported.\n\
43924392 \n\
43934393 Currently, WvOut is non-interpolating and the output rate is always `Stk::sampleRate()`.\n\
43944394 \n\
@@ -4404,67 +4404,67 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 9 unmodified lines
44044404
44054405 func = make_new_mfun( "string", "matFilename", WvOut_ctrl_matFilename ); //!open matlab file for writing
44064406 func->add_arg( "string", "value" );
4407− func->doc = "Open MatLab file for writing.";
4407+ func->doc = "open MATLAB file for writing.";
44084408 if( !type_engine_import_mfun( env, func ) ) goto error;
44094409
44104410 func = make_new_mfun( "string", "sndFilename", WvOut_ctrl_sndFilename ); //!open snd file for writing
44114411 func->add_arg( "string", "value" );
4412− func->doc = "Open SND file for writing.";
4412+ func->doc = "open SND file for writing.";
44134413 if( !type_engine_import_mfun( env, func ) ) goto error;
44144414
44154415 func = make_new_mfun( "string", "wavFilename", WvOut_ctrl_wavFilename ); //!open WAVE file for writing
44164416 func->add_arg( "string", "value" );
4417− func->doc = "Open WAVE file for writing.";
4417+ func->doc = "open WAVE file for writing.";
44184418 if( !type_engine_import_mfun( env, func ) ) goto error;
44194419
44204420 func = make_new_mfun( "string", "rawFilename", WvOut_ctrl_rawFilename ); //!open raw file for writing
44214421 func->add_arg( "string", "value" );
4422− func->doc = "Open a raw file for writing.";
4422+ func->doc = "open a raw file for writing.";
44234423 if( !type_engine_import_mfun( env, func ) ) goto error;
44244424
44254425 func = make_new_mfun( "string", "aifFilename", WvOut_ctrl_aifFilename ); //!open AIFF file for writing
44264426 func->add_arg( "string", "value" );
4427− func->doc = "Open an AIFF file for writing.";
4427+ func->doc = "open an AIFF file for writing.";
44284428 if( !type_engine_import_mfun( env, func ) ) goto error;
44294429
44304430 func = make_new_mfun( "string", "filename", WvOut_cget_filename ); //!get filename
4431− func->doc = "Get filename.";
4431+ func->doc = "get filename.";
44324432 if( !type_engine_import_mfun( env, func ) ) goto error;
44334433
44344434 func = make_new_mfun( "int", "record", WvOut_ctrl_record ); // !start/stop output
44354435 func->add_arg( "int", "value" );
4436− func->doc = "Start/stop output.";
4436+ func->doc = "start/stop output.";
44374437 if( !type_engine_import_mfun( env, func ) ) goto error;
44384438
44394439 func = make_new_mfun( "int", "record", WvOut_cget_record ); // !start/stop output
4440− func->doc = "Start/stop output.";
4440+ func->doc = "start/stop output.";
44414441 if( !type_engine_import_mfun( env, func ) ) goto error;
44424442
44434443 func = make_new_mfun( "string", "closeFile", WvOut_ctrl_closeFile ); //! close file properly
44444444 func->add_arg( "string", "value" );
4445− func->doc = "Close the file properly.";
4445+ func->doc = "close the file properly.";
44464446 if( !type_engine_import_mfun( env, func ) ) goto error;
44474447
44484448 func = make_new_mfun( "string", "closeFile", WvOut_ctrl_closeFile ); //! close file properly
4449− func->doc = "Close the file properly.";
4449+ func->doc = "close the file properly.";
44504450 if( !type_engine_import_mfun( env, func ) ) goto error;
44514451
44524452 func = make_new_mfun( "string", "autoPrefix", WvOut_ctrl_autoPrefix ); //! set/get auto prefix string
44534453 func->add_arg( "string", "value" );
4454− func->doc = "Set auto prefix string.";
4454+ func->doc = "set auto prefix string.";
44554455 if( !type_engine_import_mfun( env, func ) ) goto error;
44564456
44574457 func = make_new_mfun( "string", "autoPrefix", WvOut_cget_autoPrefix ); //! set/get auto prefix string
4458− func->doc = "Get auto prefix string.";
4458+ func->doc = "get auto prefix string.";
44594459 if( !type_engine_import_mfun( env, func ) ) goto error;
44604460
44614461 func = make_new_mfun( "float", "fileGain", WvOut_ctrl_fileGain ); //! set/get auto prefix string
44624462 func->add_arg( "float", "value" );
4463− func->doc = "Set file gain.";
4463+ func->doc = "set file gain.";
44644464 if( !type_engine_import_mfun( env, func ) ) goto error;
44654465
44664466 func = make_new_mfun( "float", "fileGain", WvOut_cget_fileGain ); //! set/get auto prefix string
4467− func->doc = "Get file gain.";
4467+ func->doc = "get file gain.";
44684468 if( !type_engine_import_mfun( env, func ) ) goto error;
44694469
44704470 // end the class import
@@ -4504,7 +4504,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 33 unmodified lines
45044504 // begin BLT (BandLtd)
45054505 //------------------------------------------------------------------------
45064506
4507− doc = "Super-class for band-limited oscillators.";
4507+ doc = "super-class for band-limited oscillators.";
45084508
45094509 if( !type_engine_import_ugen_begin( env, "BLT", "UGen", env->global(),
45104510 BLT_ctor, BLT_dtor,
@@ -4520,29 +4520,29 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 9 unmodified lines
45204520
45214521 func = make_new_mfun( "float", "phase", BLT_ctrl_phase ); //!set phase
45224522 func->add_arg( "float", "value" );
4523− func->doc = "Set phase.";
4523+ func->doc = "set phase.";
45244524 if( !type_engine_import_mfun( env, func ) ) goto error;
45254525
45264526 func = make_new_mfun( "float", "phase", BLT_cget_phase ); //!get phase
4527− func->doc = "Get phase.";
4527+ func->doc = "get phase.";
45284528 if( !type_engine_import_mfun( env, func ) ) goto error;
45294529
45304530 func = make_new_mfun( "float", "freq", BLT_ctrl_freq ); //!set freq
45314531 func->add_arg( "float", "value" );
4532− func->doc = "Set frequency.";
4532+ func->doc = "set frequency.";
45334533 if( !type_engine_import_mfun( env, func ) ) goto error;
45344534
45354535 func = make_new_mfun( "float", "freq", BLT_cget_freq ); //!get freq
4536− func->doc = "Set frequency.";
4536+ func->doc = "set frequency.";
45374537 if( !type_engine_import_mfun( env, func ) ) goto error;
45384538
45394539 func = make_new_mfun( "int", "harmonics", BLT_ctrl_harmonics ); //!set harmonics
45404540 func->add_arg( "int", "value" );
4541− func->doc = "Set harmonics.";
4541+ func->doc = "set harmonics.";
45424542 if( !type_engine_import_mfun( env, func ) ) goto error;
45434543
45444544 func = make_new_mfun( "int", "harmonics", BLT_cget_harmonics ); //!get harmonics
4545− func->doc = "Get harmonics.";
4545+ func->doc = "get harmonics.";
45464546 if( !type_engine_import_mfun( env, func ) ) goto error;
45474547
45484548 // end the class import
@@ -4553,7 +4553,7 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2002."; · 4 unmodified lines
45534553 // begin Blit
45544554 //------------------------------------------------------------------------
45554555
4556− doc = "This class generates a band-limited impulse train using a closed-form algorithm reported by Stilson and Smith in 'Alias-Free Digital Synthesis of Classic Analog Waveforms', 1996. The user can specify both the fundamental frequency of the impulse train and the number of harmonics contained in the resulting signal.\n\
4556+ doc = "a band-limited impulse train using a closed-form algorithm reported by Stilson and Smith in 'Alias-Free Digital Synthesis of Classic Analog Waveforms', 1996. The user can specify both the fundamental frequency of the impulse train and the number of harmonics contained in the resulting signal.\n\
45574557 \n\
45584558 The signal is normalized so that the peak value is +/-1.0.\n\
45594559 \n\
@@ -4575,7 +4575,7 @@ Revisions by Gary Scavone for STK, 2005."; · 15 unmodified lines
45754575 // begin BlitSaw
45764576 //------------------------------------------------------------------------
45774577
4578− doc = "This class generates a band-limited sawtooth waveform using a closed-form algorithm reported by Stilson and Smith in 'Alias-Free Digital Synthesis of Classic Analog Waveforms', 1996. The user can specify both the fundamental frequency of the sawtooth and the number of harmonics contained in the resulting signal.\n\
4578+ doc = "a band-limited sawtooth waveform using a closed-form algorithm reported by Stilson and Smith in 'Alias-Free Digital Synthesis of Classic Analog Waveforms', 1996. The user can specify both the fundamental frequency of the sawtooth and the number of harmonics contained in the resulting signal.\n\
45794579 \n\
45804580 If `nHarmonics` is 0, then the signal will contain all harmonics up to half the sample rate. Note, however, that this setting may produce aliasing in the signal when the frequency is changing (no automatic modification of the number of harmonics is performed by the `setFrequency()` function).\n\
45814581 \n\
@@ -4593,7 +4593,7 @@ Modified algorithm code by Gary Scavone, 2005."; · 11 unmodified lines
45934593 // begin BlitSquare
45944594 //------------------------------------------------------------------------
45954595
4596− doc = "This class generates a band-limited square wave signal. It is derived in part from the approach reported by Stilson and Smith in 'Alias-Free Digital Synthesis of Classic Analog Waveforms', 1996. The algorithm implemented in this class uses a SincM function with an even M value to achieve a bipolar bandlimited impulse train. This signal is then integrated to achieve a square waveform. The integration process has an associated DC offset but that is subtracted off the output signal.\n\
4596+ doc = "a band-limited square wave signal. It is derived in part from the approach reported by Stilson and Smith in 'Alias-Free Digital Synthesis of Classic Analog Waveforms', 1996. The algorithm implemented in this class uses a SincM function with an even M value to achieve a bipolar bandlimited impulse train. This signal is then integrated to achieve a square waveform. The integration process has an associated DC offset but that is subtracted off the output signal.\n\
45974597 \n\
45984598 The user can specify both the fundamental frequency of the waveform and the number of harmonics contained in the resulting signal.\n\
45994599 \n\
@@ -4828,22 +4828,22 @@ struct SKINISpec skini_msgs[__SK_MaxMsgTypes_] = · 228 unmodified lines
48284828 /* type is the message type sent back from the SKINI line parser. */
48294829 /* data<n> is either */
48304830 /* NOPE : field not used, specifically, there aren't going */
4831−/* to be any more fields on this line. So if there */
4831+/* to be any more fields on this line. So if there */
48324832 /* is is NOPE in data2, data3 won't even be checked */
48334833 /* SK_INT : byte (actually scanned as 32 bit signed integer) */
48344834 /* If it's a MIDI data field which is required to */
48354835 /* be an integer, like a controller number, it's */
4836−/* 0-127. Otherwise) get creative with SK_INTs */
4837−/* SK_DBL : double precision floating point. SKINI uses these */
4836+/* 0-127. Otherwise) get creative with SK_INTs */
4837+/* SK_DBL : double precision floating point. SKINI uses these */
48384838 /* in the MIDI context for note numbers with micro */
48394839 /* tuning, velocities, controller values, etc. */
4840−/* SK_STR : only valid in final field. This allows (nearly) */
4840+/* SK_STR : only valid in final field. This allows (nearly) */
48414841 /* arbitrary message types to be supported by simply */
48424842 /* scanning the string to EndOfLine and then passing */
4843−/* it to a more intellegent handler. For example, */
4843+/* it to a more intellegent handler. For example, */
48444844 /* MIDI SYSEX (system exclusive) messages of up to */
48454845 /* 256bytes can be read as space-delimited integers */
4846−/* into the 1K SK_STR buffer. Longer bulk dumps, */
4846+/* into the 1K SK_STR buffer. Longer bulk dumps, */
48474847 /* soundfiles, etc. should be handled as a new */
48484848 /* message type pointing to a FileName stored in the */
48494849 /* SK_STR field, or as a new type of multi-line */
@@ -4858,7 +4858,7 @@ struct SKINISpec skini_msgs[__SK_MaxMsgTypes_] = · 8 unmodified lines
48584858
48594859 This Envelope subclass implements a
48604860 traditional ADSR (Attack, Decay,
4861− Sustain, Release) envelope. It
4861+ Sustain, Release) envelope. It
48624862 responds to simple keyOn and keyOff
48634863 messages, keeping track of its state.
48644864 The \e state = ADSR::DONE after the
@@ -5033,7 +5033,7 @@ void ADSR :: setValue(MY_FLOAT aValue) · 168 unmodified lines
50335033 target = aValue;
50345034 value = aValue;
50355035 this->setSustainLevel(aValue);
5036− rate = (MY_FLOAT) 0.0;
5036+ rate = (MY_FLOAT)0.0;
50375037 }
50385038
50395039 int ADSR :: getState(void) const
@@ -5107,7 +5107,7 @@ MY_FLOAT *ADSR :: tick(MY_FLOAT *vec, unsigned int vectorSize) · 67 unmodified lines
51075107
51085108 This class uses banded waveguide techniques to
51095109 model a variety of sounds, including bowed
5110− bars, glasses, and bowls. For more
5110+ bars, glasses, and bowls. For more
51115111 information, see Essl, G. and Cook, P. "Banded
51125112 Waveguides: Towards Physical Modelling of Bar
51135113 Percussion Instruments", Proceedings of the
@@ -5321,7 +5321,7 @@ void BandedWG :: setFrequency(MY_FLOAT frequency) · 207 unmodified lines
53215321 }
53225322 // CK_STDCERR << CK_STDENDL;
53235323
5324− // Set the bandpass filter resonances
5324+ // set the bandpass filter resonances
53255325 radius = 1.0 - ONE_PI * 32 / Stk::sampleRate(); //freakency * modes[i] / Stk::sampleRate()/32;
53265326 if ( radius < 0.0 ) radius = 0.0;
53275327 bandpass[i].setResonance(freakency * modes[i], radius, true);
@@ -5528,7 +5528,7 @@ void BandedWG :: controlChange(int number, MY_FLOAT value) · 200 unmodified lines
55285528
55295529 The basic Chowning/Stanford FM patent expired
55305530 in 1995, but there exist follow-on patents,
5531− mostly assigned to Yamaha. If you are of the
5531+ mostly assigned to Yamaha. If you are of the
55325532 type who should worry about this (making
55335533 money) worry away.
55345534
@@ -5611,7 +5611,7 @@ MY_FLOAT BeeThree :: tick() · 76 unmodified lines
56115611 \brief STK biquad (two-pole, two-zero) filter class.
56125612
56135613 This protected Filter subclass implements a
5614− two-pole, two-zero digital filter. A method
5614+ two-pole, two-zero digital filter. A method
56155615 is provided for creating a resonance in the
56165616 frequency response while maintaining a constant
56175617 filter gain.
@@ -5737,14 +5737,14 @@ MY_FLOAT *BiQuad :: tick(MY_FLOAT *vec, unsigned int vectorSize) · 119 unmodified lines
57375737
57385738 This class generates a band-limited impulse train using a
57395739 closed-form algorithm reported by Stilson and Smith in "Alias-Free
5740− Digital Synthesis of Classic Analog Waveforms", 1996. The user
5740+ Digital Synthesis of Classic Analog Waveforms", 1996. The user
57415741 can specify both the fundamental frequency of the impulse train
57425742 and the number of harmonics contained in the resulting signal.
57435743
57445744 The signal is normalized so that the peak value is +/-1.0.
57455745
57465746 If nHarmonics is 0, then the signal will contain all harmonics up
5747− to half the sample rate. Note, however, that this setting may
5747+ to half the sample rate. Note, however, that this setting may
57485748 produce aliasing in the signal when the frequency is changing (no
57495749 automatic modification of the number of harmonics is performed by
57505750 the setFrequency() function).
@@ -5844,12 +5844,12 @@ MY_FLOAT Blit :: tick( void ) · 93 unmodified lines
58445844
58455845 This class generates a band-limited sawtooth waveform using a
58465846 closed-form algorithm reported by Stilson and Smith in "Alias-Free
5847− Digital Synthesis of Classic Analog Waveforms", 1996. The user
5847+ Digital Synthesis of Classic Analog Waveforms", 1996. The user
58485848 can specify both the fundamental frequency of the sawtooth and the
58495849 number of harmonics contained in the resulting signal.
58505850
58515851 If nHarmonics is 0, then the signal will contain all harmonics up
5852− to half the sample rate. Note, however, that this setting may
5852+ to half the sample rate. Note, however, that this setting may
58535853 produce aliasing in the signal when the frequency is changing (no
58545854 automatic modification of the number of harmonics is performed by
58555855 the setFrequency() function).
@@ -5896,11 +5896,11 @@ void BlitSaw :: setHarmonics( unsigned int nHarmonics ) · 40 unmodified lines
58965896 this->updateHarmonics();
58975897
58985898 // I found that the initial DC offset could be minimized with an
5899− // initial state setting as given below. This initialization should
5899+ // initial state setting as given below. This initialization should
59005900 // only happen before starting the oscillator for the first time
59015901 // (but after setting the frequency and number of harmonics). I
59025902 // struggled a bit to decide where best to put this and finally
5903− // settled on here. In general, the user shouldn't be messing with
5903+ // settled on here. In general, the user shouldn't be messing with
59045904 // the number of harmonics once the oscillator is running because
59055905 // this is automatically taken care of in the setFrequency()
59065906 // function. (GPS - 1 October 2005)
@@ -5928,10 +5928,10 @@ MY_FLOAT BlitSaw :: tick( void ) · 21 unmodified lines
59285928 {
59295929 // The code below implements the BLIT algorithm of Stilson and
59305930 // Smith, followed by a summation and filtering operation to produce
5931− // a sawtooth waveform. After experimenting with various approaches
5931+ // a sawtooth waveform. After experimenting with various approaches
59325932 // to calculate the average value of the BLIT over one period, I
59335933 // found that an estimate of C2_ = 1.0 / period (in samples) worked
5934− // most consistently. A "leaky integrator" is then applied to the
5934+ // most consistently. A "leaky integrator" is then applied to the
59355935 // difference of the BLIT output and C2_. (GPS - 1 October 2005)
59365936
59375937 // A fully optimized version of this code would replace the two sin
@@ -5966,12 +5966,12 @@ MY_FLOAT BlitSaw :: tick( void ) · 28 unmodified lines
59665966 /*! \class BlitSquare
59675967 \brief STK band-limited square wave class.
59685968
5969− This class generates a band-limited square wave signal. It is
5969+ This class generates a band-limited square wave signal. It is
59705970 derived in part from the approach reported by Stilson and Smith in
59715971 "Alias-Free Digital Synthesis of Classic Analog Waveforms", 1996.
59725972 The algorithm implemented in this class uses a SincM function with
59735973 an even M value to achieve a bipolar bandlimited impulse train.
5974− This signal is then integrated to achieve a square waveform. The
5974+ This signal is then integrated to achieve a square waveform. The
59755975 integration process has an associated DC offset but that is
59765976 subtracted off the output signal.
59775977
@@ -5980,7 +5980,7 @@ MY_FLOAT BlitSaw :: tick( void ) · 2 unmodified lines
59805980 signal.
59815981
59825982 If nHarmonics is 0, then the signal will contain all harmonics up
5983− to half the sample rate. Note, however, that this setting may
5983+ to half the sample rate. Note, however, that this setting may
59845984 produce aliasing in the signal when the frequency is changing (no
59855985 automatic modification of the number of harmonics is performed by
59865986 the setFrequency() function).
@@ -6017,7 +6017,7 @@ void BlitSquare :: setFrequency( MY_FLOAT frequency ) · 30 unmodified lines
60176017 #endif
60186018
60196019 // By using an even value of the parameter M, we get a bipolar blit
6020− // waveform at half the blit frequency. Thus, we need to scale the
6020+ // waveform at half the blit frequency. Thus, we need to scale the
60216021 // frequency value here by 0.5. (GPS, 2006).
60226022 p_ = 0.5 * Stk::sampleRate() / frequency;
60236023 rate_ = ONE_PI / p_;
@@ -6283,10 +6283,10 @@ void BlowBotl :: controlChange(int number, MY_FLOAT value) · 259 unmodified lines
62836283
62846284 In this implementation, the distances between
62856285 the reed/register hole and tonehole/bell are
6286− fixed. As a result, both the tonehole and
6286+ fixed. As a result, both the tonehole and
62876287 register hole will have variable influence on
62886288 the playing frequency, which is dependent on
6289− the length of the air column. In addition,
6289+ the length of the air column. In addition,
62906290 the highest playing freqeuency is limited by
62916291 these fixed lengths.
62926292 This is a digital waveguide model, making its
@@ -6599,12 +6599,12 @@ MY_FLOAT BowTabl :: tick(MY_FLOAT input) · 306 unmodified lines
65996599 MY_FLOAT sample;
66006600 sample = input + offSet; // add bias to input
66016601 sample *= slope; // then scale it
6602− lastOutput = (MY_FLOAT) fabs((double) sample) + (MY_FLOAT) 0.75;
6603− lastOutput = (MY_FLOAT) pow( lastOutput,(MY_FLOAT) -4.0 );
6602+ lastOutput = (MY_FLOAT)fabs((double) sample) + (MY_FLOAT) 0.75;
6603+ lastOutput = (MY_FLOAT)pow( lastOutput,(MY_FLOAT) -4.0 );
66046604
6605− // Set minimum friction to 0.0
6605+ // set minimum friction to 0.0
66066606 //if (lastOutput < 0.0 ) lastOutput = 0.0;
6607− // Set maximum friction to 1.0.
6607+ // set maximum friction to 1.0.
66086608 if (lastOutput > 1.0 ) lastOutput = (MY_FLOAT) 1.0;
66096609
66106610 return lastOutput;
@@ -7515,16 +7515,16 @@ MY_FLOAT *Delay :: tick(MY_FLOAT *vec, unsigned int vectorSize) · 904 unmodified lines
75157515
75167516 This Delay subclass implements a fractional-
75177517 length digital delay-line using a first-order
7518− allpass filter. A fixed maximum length
7518+ allpass filter. A fixed maximum length
75197519 of 4095 and a delay of 0.5 is set using the
7520− default constructor. Alternatively, the
7520+ default constructor. Alternatively, the
75217521 delay and maximum length can be set during
75227522 instantiation with an overloaded constructor.
75237523
75247524 An allpass filter has unity magnitude gain but
75257525 variable phase delay properties, making it useful
75267526 in achieving fractional delays without affecting
7527− a signal's frequency magnitude response. In
7527+ a signal's frequency magnitude response. In
75287528 order to achieve a maximally flat phase delay
75297529 response, the minimum delay possible in this
75307530 implementation is limited to a value of 0.5.
@@ -7664,9 +7664,9 @@ MY_FLOAT DelayA :: tick(MY_FLOAT sample) · 133 unmodified lines
76647664
76657665 This Delay subclass implements a fractional-
76667666 length digital delay-line using first-order
7667− linear interpolation. A fixed maximum length
7667+ linear interpolation. A fixed maximum length
76687668 of 4095 and a delay of zero is set using the
7669− default constructor. Alternatively, the
7669+ default constructor. Alternatively, the
76707670 delay and maximum length can be set during
76717671 instantiation with an overloaded constructor.
76727672
@@ -7674,7 +7674,7 @@ MY_FLOAT DelayA :: tick(MY_FLOAT sample) · 1 unmodified line
76747674 for achieving fractional delay lengths, though
76757675 it does introduce high-frequency signal
76767676 attenuation to varying degrees depending on the
7677− fractional delay setting. The use of higher
7677+ fractional delay setting. The use of higher
76787678 order Lagrange interpolators can typically
76797679 improve (minimize) this attenuation characteristic.
76807680
@@ -7794,9 +7794,9 @@ MY_FLOAT DelayL :: tick(MY_FLOAT sample) · 113 unmodified lines
77947794
77957795 This class implements a drum sampling
77967796 synthesizer using WvIn objects and one-pole
7797− filters. The drum rawwave files are sampled
7797+ filters. The drum rawwave files are sampled
77987798 at 22050 Hz, but will be appropriately
7799− interpolated for other sample rates. You can
7799+ interpolated for other sample rates. You can
78007800 specify the maximum polyphony (maximum number
78017801 of simultaneous voices) via a #define in the
78027802 Drummer.h.
@@ -7807,7 +7807,7 @@ MY_FLOAT DelayL :: tick(MY_FLOAT sample) · 4 unmodified lines
78077807
78087808 #include <math.h>
78097809
7810−// Not really General MIDI yet. Coming soon.
7810+// Not really General MIDI yet. Coming soon.
78117811 unsigned char genMIDIMap[128] =
78127812 { 0,0,0,0,0,0,0,0, // 0-7
78137813 0,0,0,0,0,0,0,0, // 8-15
@@ -8207,7 +8207,7 @@ MY_FLOAT Envelope :: lastOut(void) const · 393 unmodified lines
82078207
82088208 The basic Chowning/Stanford FM patent expired
82098209 in 1995, but there exist follow-on patents,
8210− mostly assigned to Yamaha. If you are of the
8210+ mostly assigned to Yamaha. If you are of the
82118211 type who should worry about this (making
82128212 money) worry away.
82138213
@@ -8436,7 +8436,7 @@ void FM :: controlChange(int number, MY_FLOAT value) · 222 unmodified lines
84368436
84378437 The basic Chowning/Stanford FM patent expired
84388438 in 1995, but there exist follow-on patents,
8439− mostly assigned to Yamaha. If you are of the
8439+ mostly assigned to Yamaha. If you are of the
84408440 type who should worry about this (making
84418441 money) worry away.
84428442
@@ -8618,7 +8618,7 @@ void FMVoices :: controlChange(int number, MY_FLOAT value) · 175 unmodified lines
86188618
86198619 The \e gain parameter is applied at the filter
86208620 input and does not affect the coefficient values.
8621− The default gain value is 1.0. This structure
8621+ The default gain value is 1.0. This structure
86228622 results in one extra multiply per computed sample,
86238623 but allows easy control of the overall filter gain.
86248624
@@ -8849,7 +8849,7 @@ MY_FLOAT *FilterStk :: tick(MY_FLOAT *vec, unsigned int vectorSize) · 224 unmodified lines
88498849
88508850 This class implements a simple flute
88518851 physical model, as discussed by Karjalainen,
8852− Smith, Waryznyk, etc. The jet model uses
8852+ Smith, Waryznyk, etc. The jet model uses
88538853 a polynomial, a la Cook.
88548854
88558855 This is a digital waveguide model, making its
@@ -9103,7 +9103,7 @@ FormSwep :: FormSwep() : BiQuad() · 247 unmodified lines
91039103 deltaGain = (MY_FLOAT) 0.0;
91049104 deltaFrequency = (MY_FLOAT) 0.0;
91059105 deltaRadius = (MY_FLOAT) 0.0;
9106− sweepState = (MY_FLOAT) 0.0;
9106+ sweepState = (MY_FLOAT) 0.0;
91079107 sweepRate = (MY_FLOAT) 0.002;
91089108 dirty = false;
91099109 this->clear();
@@ -9215,7 +9215,7 @@ MY_FLOAT *FormSwep :: tick(MY_FLOAT *vec, unsigned int vectorSize) · 105 unmodified lines
92159215
92169216 The basic Chowning/Stanford FM patent expired
92179217 in 1995, but there exist follow-on patents,
9218− mostly assigned to Yamaha. If you are of the
9218+ mostly assigned to Yamaha. If you are of the
92199219 type who should worry about this (making
92209220 money) worry away.
92219221
@@ -9369,7 +9369,7 @@ void Instrmnt :: controlChange(int number, MY_FLOAT value) · 147 unmodified lines
93699369 This class is derived from the CLM JCRev
93709370 function, which is based on the use of
93719371 networks of simple allpass and comb delay
9372− filters. This class implements three series
9372+ filters. This class implements three series
93739373 allpass units, followed by four parallel comb
93749374 filters, and two decorrelation delay lines in
93759375 parallel at the output.
@@ -9537,7 +9537,7 @@ MY_FLOAT JetTabl :: tick( MY_FLOAT input ) · 161 unmodified lines
95379537 // Perform "table lookup" using a polynomial
95389538 // calculation (x^3 - x), which approximates
95399539 // the jet sigmoid behavior.
9540− lastOutput = input * (input * input - (MY_FLOAT) 1.0);
9540+ lastOutput = input * (input * input - (MY_FLOAT)1.0);
95419541
95429542 // Saturate at +/- 1.0.
95439543 if (lastOutput > 1.0)
@@ -9568,8 +9568,8 @@ MY_FLOAT *JetTabl :: tick(MY_FLOAT *vec, unsigned int vectorSize) · 24 unmodified lines
95689568 Stanford University, Yamaha, and others.
95699569 Commuted Synthesis, in particular, is covered
95709570 by patents, granted, pending, and/or
9571− applied-for. All are assigned to the Board of
9572− Trustees, Stanford University. For
9571+ applied-for. All are assigned to the Board of
9572+ Trustees, Stanford University. For
95739573 information, contact the Office of Technology
95749574 Licensing, Stanford University.
95759575
@@ -9758,7 +9758,7 @@ void Mandolin :: controlChange(int number, MY_FLOAT value) · 182 unmodified lines
97589758
97599759 This class implements a rectilinear,
97609760 two-dimensional digital waveguide mesh
9761− structure. For details, see Van Duyne and
9761+ structure. For details, see Van Duyne and
97629762 Smith, "Physical Modeling with the 2-D Digital
97639763 Waveguide Mesh", Proceedings of the 1993
97649764 International Computer Music Conference.
@@ -10041,7 +10041,7 @@ MY_FLOAT Mesh2D :: tick0() · 276 unmodified lines
1004110041 }
1004210042
1004310043 // Loop over velocity-junction boundary faces, update edge
10044− // reflections, with filtering. We're only filtering on one x and y
10044+ // reflections, with filtering. We're only filtering on one x and y
1004510045 // edge here and even this could be made much sparser.
1004610046 for (y=0; y<NY-1; y++) {
1004710047 vxp1[0][y] = filterY[y]->tick(vxm[0][y]);
@@ -10052,9 +10052,9 @@ MY_FLOAT Mesh2D :: tick0() · 4 unmodified lines
1005210052 vym1[x][NY-1] = vyp[x][NY-1];
1005310053 }
1005410054
10055− // Output = sum of outgoing waves at far corner. Note that the last
10055+ // Output = sum of outgoing waves at far corner. Note that the last
1005610056 // index in each coordinate direction is used only with the other
10057− // coordinate indices at their next-to-last values. This is because
10057+ // coordinate indices at their next-to-last values. This is because
1005810058 // the "unit strings" attached to each velocity node to terminate
1005910059 // the mesh are not themselves connected together.
1006010060 outsamp = vxp[NX-1][NY-2] + vyp[NX-2][NY-1];
@@ -10092,7 +10092,7 @@ MY_FLOAT Mesh2D :: tick1() · 31 unmodified lines
1009210092 }
1009310093
1009410094 // Loop over velocity-junction boundary faces, update edge
10095− // reflections, with filtering. We're only filtering on one x and y
10095+ // reflections, with filtering. We're only filtering on one x and y
1009610096 // edge here and even this could be made much sparser.
1009710097 for (y=0; y<NY-1; y++) {
1009810098 vxp[0][y] = filterY[y]->tick(vxm1[0][y]);
@@ -10375,7 +10375,7 @@ MY_FLOAT Modal :: tick() · 276 unmodified lines
1037510375 \brief STK resonant bar instrument class.
1037610376
1037710377 This class implements a number of different
10378− struck bar instruments. It inherits from the
10378+ struck bar instruments. It inherits from the
1037910379 Modal class.
1038010380
1038110381 Control Change Numbers:
@@ -10461,9 +10461,9 @@ void ModalBar :: setStrikePosition(MY_FLOAT position) · 79 unmodified lines
1046110461 this->setModeGain(0, 0.12 * temp);
1046210462
1046310463 temp = sin(0.05 + (3.9 * temp2));
10464− this->setModeGain(1,(MY_FLOAT) -0.03 * temp);
10464+ this->setModeGain(1, (MY_FLOAT)-0.03 * temp);
1046510465
10466− temp = (MY_FLOAT) sin(-0.05 + (11 * temp2));
10466+ temp = (MY_FLOAT)sin(-0.05 + (11 * temp2));
1046710467 this->setModeGain(2,(MY_FLOAT) 0.11 * temp);
1046810468 }
1046910469
@@ -10606,7 +10606,7 @@ Modulate :: ~Modulate() · 136 unmodified lines
1060610606
1060710607 void Modulate :: reset()
1060810608 {
10609− lastOutput = (MY_FLOAT) 0.0;
10609+ lastOutput = (MY_FLOAT)0.0;
1061010610 }
1061110611
1061210612 void Modulate :: setVibratoRate(MY_FLOAT aRate)
@@ -10821,7 +10821,7 @@ void Moog :: controlChange(int number, MY_FLOAT value) · 208 unmodified lines
1082110821 This class is derived from the CLM NRev
1082210822 function, which is based on the use of
1082310823 networks of simple allpass and comb delay
10824− filters. This particular arrangement consists
10824+ filters. This particular arrangement consists
1082510825 of 6 comb filters in parallel, followed by 3
1082610826 allpass filters, a lowpass filter, and another
1082710827 allpass in series, followed by two allpass
@@ -10944,7 +10944,7 @@ MY_FLOAT NRev :: tick(MY_FLOAT input) · 116 unmodified lines
1094410944 \brief STK noise generator.
1094510945
1094610946 Generic random number generation using the
10947− C rand() function. The quality of the rand()
10947+ C rand() function. The quality of the rand()
1094810948 function varies from one OS to another.
1094910949
1095010950 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
@@ -11005,7 +11005,7 @@ MY_FLOAT Noise :: lastOut() const · 54 unmodified lines
1100511005 \brief STK one-pole filter class.
1100611006
1100711007 This protected Filter subclass implements
11008− a one-pole digital filter. A method is
11008+ a one-pole digital filter. A method is
1100911009 provided for setting the pole position along
1101011010 the real axis of the z-plane while maintaining
1101111011 a constant peak filter gain.
@@ -11034,7 +11034,7 @@ OnePole :: OnePole(MY_FLOAT thePole) : FilterStk() · 22 unmodified lines
1103411034 B = (MY_FLOAT) (1.0 + thePole);
1103511035
1103611036 A[1] = -thePole;
11037− FilterStk::setCoefficients( 1, &B, 2, A );
11037+ FilterStk::setCoefficients( 1, &B, 2, A );
1103811038 }
1103911039
1104011040 OnePole :: ~OnePole()
@@ -11106,7 +11106,7 @@ MY_FLOAT *OnePole :: tick(MY_FLOAT *vec, unsigned int vectorSize) · 65 unmodified lines
1110611106 \brief STK one-zero filter class.
1110711107
1110811108 This protected Filter subclass implements
11109− a one-zero digital filter. A method is
11109+ a one-zero digital filter. A method is
1111011110 provided for setting the zero position
1111111111 along the real axis of the z-plane while
1111211112 maintaining a constant filter gain.
@@ -11207,7 +11207,7 @@ MY_FLOAT *OneZero :: tick(MY_FLOAT *vec, unsigned int vectorSize) · 94 unmodified lines
1120711207 Stanford/CCRMA reverbs (NRev, KipRev), which
1120811208 were based on the Chowning/Moorer/Schroeder
1120911209 reverberators using networks of simple allpass
11210− and comb delay filters. This class implements
11210+ and comb delay filters. This class implements
1121111211 two series allpass units and two parallel comb
1121211212 filters.
1121311213
@@ -11323,7 +11323,7 @@ MY_FLOAT PRCRev :: tick(MY_FLOAT input) · 109 unmodified lines
1132311323
1132411324 The basic Chowning/Stanford FM patent expired
1132511325 in 1995, but there exist follow-on patents,
11326− mostly assigned to Yamaha. If you are of the
11326+ mostly assigned to Yamaha. If you are of the
1132711327 type who should worry about this (making
1132811328 money) worry away.
1132911329
@@ -11503,7 +11503,7 @@ const MY_FLOAT Phonemes :: phonemeParameters[32][4][3] = · 173 unmodified lines
1150311503 { 895, 0.900, -3},
1150411504 {2556, 0.950, -17},
1150511505 {3070, 0.910, -20}},
11506− { { 637, 0.910, 0}, // ohh (bone) NOTE:: same as aww (bought)
11506+ { { 637, 0.910, 0}, // ohh (bone) NOTE: same as aww (bought)
1150711507 { 895, 0.900, -3},
1150811508 {2556, 0.950, -17},
1150911509 {3070, 0.910, -20}},
@@ -11793,7 +11793,7 @@ MY_FLOAT *PitShift :: tick(MY_FLOAT *vec, unsigned int vectorSize) · 283 unmodified lines
1179311793 Smith, and others.
1179411794
1179511795 PluckTwo is an abstract class, with no excitation
11796− specified. Therefore, it can't be directly
11796+ specified. Therefore, it can't be directly
1179711797 instantiated.
1179811798
1179911799 This is a digital waveguide model, making its
@@ -12040,9 +12040,9 @@ MY_FLOAT Plucked :: tick() · 240 unmodified lines
1204012040 \brief STK one-pole, one-zero filter class.
1204112041
1204212042 This protected Filter subclass implements
12043− a one-pole, one-zero digital filter. A
12043+ a one-pole, one-zero digital filter. A
1204412044 method is provided for creating an allpass
12045− filter with a given coefficient. Another
12045+ filter with a given coefficient. Another
1204612046 method is provided to create a DC blocking filter.
1204712047
1204812048 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
@@ -12435,7 +12435,7 @@ bool Reverb :: isPrime(int number) · 386 unmodified lines
1243512435
1243612436 The basic Chowning/Stanford FM patent expired
1243712437 in 1995, but there exist follow-on patents,
12438− mostly assigned to Yamaha. If you are of the
12438+ mostly assigned to Yamaha. If you are of the
1243912439 type who should worry about this (making
1244012440 money) worry away.
1244112441
@@ -12528,7 +12528,7 @@ MY_FLOAT Rhodey :: tick() · 86 unmodified lines
1252812528 \brief STK SKINI parsing class
1252912529
1253012530 This class parses SKINI formatted text
12531− messages. It can be used to parse individual
12531+ messages. It can be used to parse individual
1253212532 messages or it can be passed an entire file.
1253312533 The file specification is Perry's and his
1253412534 alone, but it's all text so it shouldn't be to
@@ -12537,7 +12537,7 @@ MY_FLOAT Rhodey :: tick() · 2 unmodified lines
1253712537 SKINI (Synthesis toolKit Instrument Network
1253812538 Interface) is like MIDI, but allows for
1253912539 floating-point control changes, note numbers,
12540− etc. The following example causes a sharp
12540+ etc. The following example causes a sharp
1254112541 middle C to be played with a velocity of 111.132:
1254212542
1254312543 noteOn 60.01 111.13
@@ -12552,7 +12552,7 @@ MY_FLOAT Rhodey :: tick() · 8 unmodified lines
1255212552 #include <stdlib.h>
1255312553
1255412554 // Constructor for use when parsing SKINI strings (coming over socket
12555−// for example. Use parseThis() method with string pointer.
12555+// for example. Use parseThis() method with string pointer.
1255612556 SKINI :: SKINI()
1255712557 {
1255812558 }
@@ -12938,19 +12938,19 @@ MY_FLOAT Sampler :: tick() · 379 unmodified lines
1293812938
1293912939 This class implements a "hybrid" digital
1294012940 waveguide instrument that can generate a
12941− variety of wind-like sounds. It has also been
12942− referred to as the "blowed string" model. The
12941+ variety of wind-like sounds. It has also been
12942+ referred to as the "blowed string" model. The
1294312943 waveguide section is essentially that of a
1294412944 string, with one rigid and one lossy
12945− termination. The non-linear function is a
12946− reed table. The string can be "blown" at any
12945+ termination. The non-linear function is a
12946+ reed table. The string can be "blown" at any
1294712947 point between the terminations, though just as
1294812948 with strings, it is impossible to excite the
12949− system at either end. If the excitation is
12949+ system at either end. If the excitation is
1295012950 placed at the string mid-point, the sound is
12951− that of a clarinet. At points closer to the
12951+ that of a clarinet. At points closer to the
1295212952 "bridge", the sound is closer to that of a
12953− saxophone. See Scavone (2002) for more details.
12953+ saxophone. See Scavone (2002) for more details.
1295412954
1295512955 This is a digital waveguide model, making its
1295612956 use possibly subject to patents held by Stanford
@@ -13167,7 +13167,7 @@ void Saxofony :: controlChange(int number, MY_FLOAT value) · 210 unmodified lines
1316713167 PhISEM (Physically Informed Stochastic Event
1316813168 Modeling) is an algorithmic approach for
1316913169 simulating collisions of multiple independent
13170− sound producing objects. This class is a
13170+ sound producing objects. This class is a
1317113171 meta-model that can simulate a Maraca, Sekere,
1317213172 Cabasa, Bamboo Wind Chimes, Water Drops,
1317313173 Tambourine, Sleighbells, and a Guiro.
@@ -13175,7 +13175,7 @@ void Saxofony :: controlChange(int number, MY_FLOAT value) · 1 unmodified line
1317513175 PhOLIES (Physically-Oriented Library of
1317613176 Imitated Environmental Sounds) is a similar
1317713177 approach for the synthesis of environmental
13178− sounds. This class implements simulations of
13178+ sounds. This class implements simulations of
1317913179 breaking sticks, crunchy snow (or not), a
1318013180 wrench, sandpaper, and more.
1318113181
@@ -13298,11 +13298,11 @@ MY_FLOAT noise_tick() // Return random MY_FLOAT float between -1.0 and 1.0 · 116 unmodified lines
1329813298 #define WUTR_SYSTEM_DECAY 0.996
1329913299 #define WUTR_GAIN 1.0
1330013300 #define WUTR_NUM_SOURCES 10
13301−#define WUTR_CENTER_FREQ0 450.0
13302−#define WUTR_CENTER_FREQ1 600.0
13303−#define WUTR_CENTER_FREQ2 750.0
13304−#define WUTR_RESON 0.9985
13305−#define WUTR_FREQ_SWEEP 1.0001
13301+#define WUTR_CENTER_FREQ0 450.0
13302+#define WUTR_CENTER_FREQ1 600.0
13303+#define WUTR_CENTER_FREQ2 750.0
13304+#define WUTR_RESON 0.9985
13305+#define WUTR_FREQ_SWEEP 1.0001
1330613306
1330713307 // Tambourine
1330813308 #define TAMB_SOUND_DECAY 0.95
@@ -13312,7 +13312,7 @@ MY_FLOAT noise_tick() // Return random MY_FLOAT float between -1.0 and 1.0 · 3 unmodified lines
1331213312 #define TAMB_SHELL_FREQ 2300
1331313313 #define TAMB_SHELL_GAIN 0.1
1331413314 #define TAMB_SHELL_RESON 0.96
13315−#define TAMB_CYMB_FREQ1 5600
13315+#define TAMB_CYMB_FREQ1 5600
1331613316 #define TAMB_CYMB_FREQ2 8100
1331713317 #define TAMB_CYMB_RESON 0.99
1331813318
@@ -13332,18 +13332,18 @@ MY_FLOAT noise_tick() // Return random MY_FLOAT float between -1.0 and 1.0 · 13 unmodified lines
1333213332 #define GUIR_SOUND_DECAY 0.95
1333313333 #define GUIR_GAIN 10.0
1333413334 #define GUIR_NUM_PARTS 128
13335−#define GUIR_GOURD_FREQ 2500.0
13335+#define GUIR_GOURD_FREQ 2500.0
1333613336 #define GUIR_GOURD_RESON 0.97
13337−#define GUIR_GOURD_FREQ2 4000.0
13337+#define GUIR_GOURD_FREQ2 4000.0
1333813338 #define GUIR_GOURD_RESON2 0.97
1333913339
1334013340 // Wrench
1334113341 #define WRENCH_SOUND_DECAY 0.95
1334213342 #define WRENCH_GAIN 5
1334313343 #define WRENCH_NUM_PARTS 128
13344−#define WRENCH_FREQ 3200.0
13344+#define WRENCH_FREQ 3200.0
1334513345 #define WRENCH_RESON 0.99
13346−#define WRENCH_FREQ2 8000.0
13346+#define WRENCH_FREQ2 8000.0
1334713347 #define WRENCH_RESON2 0.992
1334813348
1334913349 // Cokecan
@@ -13352,7 +13352,7 @@ MY_FLOAT noise_tick() // Return random MY_FLOAT float between -1.0 and 1.0 · 2 unmodified lines
1335213352 #define COKECAN_GAIN 0.8
1335313353 #define COKECAN_NUM_PARTS 48
1335413354 #define COKECAN_HELMFREQ 370
13355−#define COKECAN_HELM_RES 0.99
13355+#define COKECAN_HELM_RES 0.99
1335613356 #define COKECAN_METLFREQ0 1025
1335713357 #define COKECAN_METLFREQ1 1424
1335813358 #define COKECAN_METLFREQ2 2149
@@ -14441,9 +14441,9 @@ void Simple :: controlChange(int number, MY_FLOAT value) · 1082 unmodified lines
1444114441
1444214442 This class contains all that is needed to make
1444314443 a pitched musical sound, like a simple voice
14444− or violin. In general, it will not be used
14444+ or violin. In general, it will not be used
1444514445 alone because of munchkinification effects
14446− from pitch shifting. It will be used as an
14446+ from pitch shifting. It will be used as an
1444714447 excitation source for other instruments.
1444814448
1444914449 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
@@ -15021,7 +15021,7 @@ void StifKarp :: controlChange(int number, MY_FLOAT value) · 571 unmodified lines
1502115021
1502215022 Nearly all STK classes inherit from this class.
1502315023 The global sample rate can be queried and
15024− modified via Stk. In addition, this class
15024+ modified via Stk. In addition, this class
1502515025 provides error handling and byte-swapping
1502615026 functions.
1502715027
@@ -15177,7 +15177,7 @@ void StkError :: printMessage(void) · 149 unmodified lines
1517715177 \brief STK sub-sampled noise generator.
1517815178
1517915179 Generates a new random number every "rate" ticks
15180− using the C rand() function. The quality of the
15180+ using the C rand() function. The quality of the
1518115181 rand() function varies from one OS to another.
1518215182
1518315183 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
@@ -15220,7 +15220,7 @@ MY_FLOAT SubNoise :: tick() · 36 unmodified lines
1522015220
1522115221 This class loads a table of floating-point
1522215222 doubles, which are assumed to be in big-endian
15223− format. Linear interpolation is performed for
15223+ format. Linear interpolation is performed for
1522415224 fractional lookup indexes.
1522515225
1522615226 An StkError will be thrown if the table file
@@ -15343,7 +15343,7 @@ MY_FLOAT *Table :: tick(MY_FLOAT *vec, unsigned int vectorSize) · 116 unmodified lines
1534315343
1534415344 The basic Chowning/Stanford FM patent expired
1534515345 in 1995, but there exist follow-on patents,
15346− mostly assigned to Yamaha. If you are of the
15346+ mostly assigned to Yamaha. If you are of the
1534715347 type who should worry about this (making
1534815348 money) worry away.
1534915349
@@ -15427,7 +15427,7 @@ MY_FLOAT TubeBell :: tick() · 77 unmodified lines
1542715427 \brief STK two-pole filter class.
1542815428
1542915429 This protected Filter subclass implements
15430− a two-pole digital filter. A method is
15430+ a two-pole digital filter. A method is
1543115431 provided for creating a resonance in the
1543215432 frequency response while maintaining a nearly
1543315433 constant filter gain.
@@ -15526,7 +15526,7 @@ MY_FLOAT *TwoPole :: tick(MY_FLOAT *vec, unsigned int vectorSize) · 92 unmodified lines
1552615526 \brief STK two-zero filter class.
1552715527
1552815528 This protected Filter subclass implements
15529− a two-zero digital filter. A method is
15529+ a two-zero digital filter. A method is
1553015530 provided for creating a "notch" in the
1553115531 frequency response while maintaining a
1553215532 constant filter gain.
@@ -15699,7 +15699,7 @@ void Vector3D :: setZ(double aval) · 166 unmodified lines
1569915699
1570015700 Measured formant data is included, and enough
1570115701 data is there to support either parallel or
15702− cascade synthesis. In the floating point case
15702+ cascade synthesis. In the floating point case
1570315703 cascade synthesis is the most natural so
1570415704 that's what you'll find here.
1570515705
@@ -15955,14 +15955,14 @@ void VoicForm :: controlChange(int number, MY_FLOAT value) · 249 unmodified lines
1595515955 \brief STK voice manager class.
1595615956
1595715957 This class can be used to manage a group of
15958− STK instrument classes. Individual voices can
15958+ STK instrument classes. Individual voices can
1595915959 be controlled via unique note tags.
1596015960 Instrument groups can be controlled by channel
1596115961 number.
1596215962
1596315963 A previously constructed STK instrument class
1596415964 is linked with a voice manager using the
15965− addInstrument() function. An optional channel
15965+ addInstrument() function. An optional channel
1596615966 number argument can be specified to the
1596715967 addInstrument() function as well (default
1596815968 channel = 0). The voice manager does not
@@ -15971,10 +15971,10 @@ void VoicForm :: controlChange(int number, MY_FLOAT value) · 2 unmodified lines
1597115971 deallocate all instruments.
1597215972
1597315973 The tick() function returns the mix of all
15974− sounding voices. Each noteOn returns a unique
15974+ sounding voices. Each noteOn returns a unique
1597515975 tag (credits to the NeXT MusicKit), so you can
1597615976 send control changes to specific voices within
15977− an ensemble. Alternately, control changes can
15977+ an ensemble. Alternately, control changes can
1597815978 be sent to all voices on a given channel.
1597915979
1598015980 by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
@@ -16223,7 +16223,7 @@ MY_FLOAT Voicer :: lastOutRight() const · 242 unmodified lines
1622316223 audio file looping functionality.
1622416224
1622516225 WaveLoop supports multi-channel data in
16226− interleaved format. It is important to
16226+ interleaved format. It is important to
1622716227 distinguish the tick() methods, which return
1622816228 samples produced by averaging across sample
1622916229 frames, from the tickFrame() methods, which
@@ -16546,7 +16546,7 @@ MY_FLOAT Whistle :: tick() · 316 unmodified lines
1654616546 temp = -temp; // We know (hope) it's inside, just how much??
1654716547 if (temp < (PEA_RADIUS * 1.25)) {
1654816548 pea->getVelocity(tempVector); // This is the can/pea collision
16549− tempX = tempVectorP->getX(); // calculation. Could probably
16549+ tempX = tempVectorP->getX(); // calculation. Could probably
1655016550 tempY = tempVectorP->getY(); // simplify using tables, etc.
1655116551 phi = -atan2(tempY,tempX);
1655216552 cosphi = cos(phi);
@@ -16649,7 +16649,7 @@ void Whistle :: controlChange(int number, MY_FLOAT value) · 96 unmodified lines
1664916649
1665016650 The basic Chowning/Stanford FM patent expired
1665116651 in 1995, but there exist follow-on patents,
16652− mostly assigned to Yamaha. If you are of the
16652+ mostly assigned to Yamaha. If you are of the
1665316653 type who should worry about this (making
1665416654 money) worry away.
1665516655
@@ -16762,24 +16762,24 @@ void Wurley :: controlChange( int which, MY_FLOAT value ) · 106 unmodified lines
1676216762 \brief STK audio data input base class.
1676316763
1676416764 This class provides input support for various
16765− audio file formats. It also serves as a base
16765+ audio file formats. It also serves as a base
1676616766 class for "realtime" streaming subclasses.
1676716767
1676816768 WvIn loads the contents of an audio file for
16769− subsequent output. Linear interpolation is
16769+ subsequent output. Linear interpolation is
1677016770 used for fractional "read rates".
1677116771
1677216772 WvIn supports multi-channel data in interleaved
16773− format. It is important to distinguish the
16773+ format. It is important to distinguish the
1677416774 tick() methods, which return samples produced
1677516775 by averaging across sample frames, from the
1677616776 tickFrame() methods, which return pointers to
16777− multi-channel sample frames. For single-channel
16777+ multi-channel sample frames. For single-channel
1677816778 data, these methods return equivalent values.
1677916779
1678016780 Small files are completely read into local memory
16781− during instantiation. Large files are read
16782− incrementally from disk. The file size threshold
16781+ during instantiation. Large files are read
16782+ incrementally from disk. The file size threshold
1678316783 and the increment size values are defined in
1678416784 WvIn.h.
1678516785
@@ -16787,7 +16787,7 @@ void Wurley :: controlChange( int which, MY_FLOAT value ) · 1 unmodified line
1678716787 MAT-file (Matlab), and STK RAW file formats.
1678816788 Signed integer (8-, 16-, and 32-bit) and floating-
1678916789 point (32- and 64-bit) data types are supported.
16790− Uncompressed data types are not supported. If
16790+ Uncompressed data types are not supported. If
1679116791 using MAT-files, data should be saved in an array
1679216792 with each data channel filling a matrix row.
1679316793
@@ -17319,7 +17319,7 @@ if( little_endian ) · 525 unmodified lines
1731917319 if( little_endian )
1732017320 swap16((unsigned char *)&temp);
1732117321
17322− // Get file sample rate from the header. For AIFF files, this value
17322+ // Get file sample rate from the header. For AIFF files, this value
1732317323 // is stored in a 10-byte, IEEE Standard 754 floating point number,
1732417324 // so we need to convert it first.
1732517325 unsigned char srate[10];
@@ -17794,12 +17794,12 @@ MY_FLOAT *WvIn :: tickFrame(MY_FLOAT *frameVector, unsigned int frames) · 468 unmodified lines
1779417794 \brief STK audio data output base class.
1779517795
1779617796 This class provides output support for various
17797− audio file formats. It also serves as a base
17797+ audio file formats. It also serves as a base
1779817798 class for "realtime" streaming subclasses.
1779917799
17800− WvOut writes samples to an audio file. It
17800+ WvOut writes samples to an audio file. It
1780117801 supports multi-channel data in interleaved
17802− format. It is important to distinguish the
17802+ format. It is important to distinguish the
1780317803 tick() methods, which output single samples
1780417804 to all channels in a sample frame, from the
1780517805 tickFrame() method, which takes a pointer
@@ -17807,14 +17807,14 @@ MY_FLOAT *WvIn :: tickFrame(MY_FLOAT *frameVector, unsigned int frames) · 1 unmodified line
1780717807
1780817808 WvOut currently supports WAV, AIFF, AIFC, SND
1780917809 (AU), MAT-file (Matlab), and STK RAW file
17810− formats. Signed integer (8-, 16-, and 32-bit)
17810+ formats. Signed integer (8-, 16-, and 32-bit)
1781117811 and floating- point (32- and 64-bit) data types
17812− are supported. STK RAW files use 16-bit
17813− integers by definition. MAT-files will always
17814− be written as 64-bit floats. If a data type
17812+ are supported. STK RAW files use 16-bit
17813+ integers by definition. MAT-files will always
17814+ be written as 64-bit floats. If a data type
1781517815 specification does not match the specified file
1781617816 type, the data type will automatically be
17817− modified. Uncompressed data types are not
17817+ modified. Uncompressed data types are not
1781817818 supported.
1781917819
1782017820 Currently, WvOut is non-interpolating and the
@@ -18442,7 +18442,7 @@ bool WvOut :: setMatFile( const char *fileName ) · 621 unmodified lines
1844218442 // 3. Array Name
1844318443 // We'll use fileName for the matlab array name (as well as the file name).
1844418444 // If fileName is 4 characters or less, we have to use a compressed data element
18445− // format for the array name data element. Otherwise, the array name must
18445+ // format for the array name data element. Otherwise, the array name must
1844618446 // be formatted in 8-byte increments (up to 31 characters + NULL).
1844718447 SINT32 namelength = (SINT32) strlen(fileName);
1844818448 if (strstr(fileName, ".mat")) namelength -= 4;
@@ -18664,7 +18664,7 @@ void WvOut :: tickFrame(const MY_FLOAT *frameVector, unsigned int frames) · 215 unmodified lines
1866418664
1866518665 This class can be used to read events from a standard MIDI file.
1866618666 Event bytes are copied to a C++ vector and must be subsequently
18667− interpreted by the user. The function getNextMidiEvent() skips
18667+ interpreted by the user. The function getNextMidiEvent() skips
1866818668 meta and sysex events, returning only MIDI channel messages.
1866918669 Event delta-times are returned in the form of "ticks" and a
1867018670 function is provided to determine the current "seconds per tick".
@@ -18755,9 +18755,9 @@ MidiFileIn :: MidiFileIn( std::string fileName ) · 84 unmodified lines
1875518755 tickrate = (double) (*data & 0x7FFF); // ticks per quarter note
1875618756 }
1875718757
18758− // Now locate the track offsets and lengths. If not using time
18758+ // Now locate the track offsets and lengths. If not using time
1875918759 // code, we can initialize the "tick time" using a default tempo of
18760− // 120 beats per minute. We will then check for tempo meta-events
18760+ // 120 beats per minute. We will then check for tempo meta-events
1876118761 // afterward.
1876218762 unsigned int i;
1876318763 for ( i=0; i<nTracks_; i++ ) {
@@ -18882,8 +18882,8 @@ unsigned long MidiFileIn :: getNextEvent( std::vector<unsigned char> *event, uns · 118 unmodified lines
1888218882 {
1888318883 // Fill the user-provided vector with the next event in the
1888418884 // specified track (default = 0) and return the event delta time in
18885− // ticks. This function assumes that the stored track pointer is
18886− // positioned at the start of a track event. If the track has
18885+ // ticks. This function assumes that the stored track pointer is
18886+ // positioned at the start of a track event. If the track has
1888718887 // reached its end, the event vector size will be zero.
1888818888 //
1888918889 // If we have a format 0 or 2 file and we're not using timecode, we
@@ -19002,7 +19002,7 @@ unsigned long MidiFileIn :: getNextMidiEvent( std::vector<unsigned char> *midiEv · 112 unmodified lines
1900219002 {
1900319003 // Fill the user-provided vector with the next MIDI event in the
1900419004 // specified track (default = 0) and return the event delta time in
19005− // ticks. Meta-Events preceeding this event are skipped and ignored.
19005+ // ticks. Meta-Events preceeding this event are skipped and ignored.
1900619006 if ( track >= nTracks_ ) {
1900719007 CK_STDCOUT << "MidiFileIn::getNextMidiEvent: invalid track argument (" << track << ").";
1900819008 handleError( "", StkError::WARNING ); return 0;
@@ -19024,7 +19024,7 @@ unsigned long MidiFileIn :: getNextMidiEvent( std::vector<unsigned char> *midiEv · 15 unmodified lines
1902419024 bool MidiFileIn :: readVariableLength( unsigned long *value )
1902519025 {
1902619026 // It is assumed that this function is called with the file read
19027− // pointer positioned at the start of a variable-length value. The
19027+ // pointer positioned at the start of a variable-length value. The
1902819028 // function returns "true" if the value is successfully parsed and
1902919029 // "false" otherwise.
1903019030 *value = 0;
@@ -25025,7 +25025,7 @@ CK_DLL_CTRL( Moog_ctrl_filterQ ) · 5994 unmodified lines
2502525025 Moog * m = (Moog *)OBJ_MEMBER_UINT(SELF, Instrmnt_offset_data);
2502625026 t_CKFLOAT f = GET_NEXT_FLOAT(ARGS);
2502725027 m->controlChange( __SK_FilterQ_, f * 128.0 );
25028− RETURN->v_float = (t_CKFLOAT) 10.0 * ( m->filterQ - 0.80 );
25028+ RETURN->v_float = (t_CKFLOAT)10.0 * ( m->filterQ - 0.80 );
2502925029 }
2503025030
2503125031
@@ -25036,7 +25036,7 @@ CK_DLL_CTRL( Moog_ctrl_filterQ ) · 4 unmodified lines
2503625036 CK_DLL_CGET( Moog_cget_filterQ )
2503725037 {
2503825038 Moog * m = (Moog *)OBJ_MEMBER_UINT(SELF, Instrmnt_offset_data);
25039− RETURN->v_float = (t_CKFLOAT) 10.0 * ( m->filterQ - 0.80 );
25039+ RETURN->v_float = (t_CKFLOAT)10.0 * ( m->filterQ - 0.80 );
2504025040 }
2504125041
2504225042
@@ -25049,7 +25049,7 @@ CK_DLL_CTRL( Moog_ctrl_filterSweepRate ) · 6 unmodified lines
2504925049 Moog * m = (Moog *)OBJ_MEMBER_UINT(SELF, Instrmnt_offset_data);
2505025050 t_CKFLOAT f = GET_NEXT_FLOAT(ARGS);
2505125051 m->controlChange( __SK_FilterSweepRate_, f * 128.0 );
25052− RETURN->v_float = (t_CKFLOAT) m->filterRate * 5000;
25052+ RETURN->v_float = (t_CKFLOAT)m->filterRate * 5000;
2505325053 }
2505425054
2505525055
@@ -25060,7 +25060,7 @@ CK_DLL_CTRL( Moog_ctrl_filterSweepRate ) · 4 unmodified lines
2506025060 CK_DLL_CGET( Moog_cget_filterSweepRate )
2506125061 {
2506225062 Moog * m = (Moog *)OBJ_MEMBER_UINT(SELF, Instrmnt_offset_data);
25063− RETURN->v_float = (t_CKFLOAT) m->filterRate * 5000;
25063+ RETURN->v_float = (t_CKFLOAT)m->filterRate * 5000;
2506425064 }
2506525065
2506625066
@@ -25109,7 +25109,7 @@ CK_DLL_CTRL( Moog_ctrl_vibratoGain ) · 42 unmodified lines
2510925109 Moog * m = (Moog *)OBJ_MEMBER_UINT(SELF, Instrmnt_offset_data);
2511025110 t_CKFLOAT f = GET_NEXT_FLOAT(ARGS);
2511125111 m->controlChange( __SK_ModWheel_, f * 128.0 );
25112− RETURN->v_float = (t_CKFLOAT) m->m_vibratoGain;
25112+ RETURN->v_float = (t_CKFLOAT)m->m_vibratoGain;
2511325113 }
2511425114
2511525115
@@ -25120,7 +25120,7 @@ CK_DLL_CTRL( Moog_ctrl_vibratoGain ) · 4 unmodified lines
2512025120 CK_DLL_CGET( Moog_cget_vibratoGain )
2512125121 {
2512225122 Moog * m = (Moog *)OBJ_MEMBER_UINT(SELF, Instrmnt_offset_data);
25123− RETURN->v_float = (t_CKFLOAT) m->m_vibratoGain;
25123+ RETURN->v_float = (t_CKFLOAT)m->m_vibratoGain;
2512425124 }
2512525125
2512625126
@@ -25133,7 +25133,7 @@ CK_DLL_CTRL( Moog_ctrl_volume ) · 6 unmodified lines
2513325133 Moog * m = (Moog *)OBJ_MEMBER_UINT(SELF, Instrmnt_offset_data);
2513425134 t_CKFLOAT f = GET_NEXT_FLOAT(ARGS);
2513525135 m->controlChange( __SK_AfterTouch_Cont_, f * 128.0 );
25136− RETURN->v_float = (t_CKFLOAT) m->m_volume;
25136+ RETURN->v_float = (t_CKFLOAT)m->m_volume;
2513725137 }
2513825138
2513925139
@@ -25144,7 +25144,7 @@ CK_DLL_CTRL( Moog_ctrl_volume ) · 4 unmodified lines
2514425144 CK_DLL_CGET( Moog_cget_volume )
2514525145 {
2514625146 Moog * m = (Moog *)OBJ_MEMBER_UINT(SELF, Instrmnt_offset_data);
25147− RETURN->v_float = (t_CKFLOAT) m->m_volume;
25147+ RETURN->v_float = (t_CKFLOAT)m->m_volume;
2514825148 }
2514925149
2515025150
@@ -25274,7 +25274,7 @@ CK_DLL_CTRL( PitShift_ctrl_shift ) · 123 unmodified lines
2527425274 PitShift * p = (PitShift *)OBJ_MEMBER_UINT(SELF, PitShift_offset_data);
2527525275 t_CKFLOAT f = GET_NEXT_FLOAT(ARGS);
2527625276 p->setShift( f );
25277− RETURN->v_float = (t_CKFLOAT) 1.0 - p->rate;
25277+ RETURN->v_float = (t_CKFLOAT)1.0 - p->rate;
2527825278 }
2527925279
2528025280
@@ -25285,7 +25285,7 @@ CK_DLL_CTRL( PitShift_ctrl_shift ) · 4 unmodified lines
2528525285 CK_DLL_CGET( PitShift_cget_shift )
2528625286 {
2528725287 PitShift * p = (PitShift *)OBJ_MEMBER_UINT(SELF, PitShift_offset_data);
25288− RETURN->v_float = (t_CKFLOAT) 1.0 - p->rate;
25288+ RETURN->v_float = (t_CKFLOAT)1.0 - p->rate;
2528925289 }
2529025290
2529125291
@@ -25298,7 +25298,7 @@ CK_DLL_CTRL( PitShift_ctrl_effectMix ) · 6 unmodified lines
2529825298 PitShift * p = (PitShift *)OBJ_MEMBER_UINT(SELF, PitShift_offset_data);
2529925299 t_CKFLOAT f = GET_NEXT_FLOAT(ARGS);
2530025300 p->setEffectMix( f );
25301− RETURN->v_float = (t_CKFLOAT) p->effectMix;
25301+ RETURN->v_float = (t_CKFLOAT)p->effectMix;
2530225302 }
2530325303
2530425304
@@ -25309,7 +25309,7 @@ CK_DLL_CTRL( PitShift_ctrl_effectMix ) · 4 unmodified lines
2530925309 CK_DLL_CGET( PitShift_cget_effectMix )
2531025310 {
2531125311 PitShift * p = (PitShift *)OBJ_MEMBER_UINT(SELF, PitShift_offset_data);
25312− RETURN->v_float = (t_CKFLOAT) p->effectMix;
25312+ RETURN->v_float = (t_CKFLOAT)p->effectMix;
2531325313 }
2531425314
2531525315
src/core/ugen_xxx.cpp+88−83
@@ -128,18 +128,18 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 127 unmodified lines
128128 //-------------------------------------------------------------------------
129129 // init as base class: Subgraph
130130 //-------------------------------------------------------------------------
131− doc = "Base class for chubgraph-based user unit generators. ";
131+ doc = "base class for subgraph-based user-created in-language unit generators.";
132132 if( !type_engine_import_ugen_begin( env, "Chugraph", "UGen", env->global(),
133133 subgraph_ctor, NULL, NULL, NULL, 1, 1, doc.c_str() ) )
134134 return FALSE;
135135
136− if( !type_engine_import_add_ex( env, "extend/chubgraph.ck" ) ) goto error;
136+ if( !type_engine_import_add_ex( env, "extend/chugraph.ck" ) ) goto error;
137137
138− doc = "Terminal for sources chucked into this ugen. ";
138+ doc = "terminal for sources chucked into this ugen.";
139139 subgraph_offset_inlet = type_engine_import_mvar( env, "UGen", "inlet", TRUE, doc.c_str() );
140140 if( subgraph_offset_inlet == CK_INVALID_OFFSET ) goto error;
141141
142− doc = "Terminal for the output of this ugen. ";
142+ doc = "terminal for the output of this ugen.";
143143 subgraph_offset_outlet = type_engine_import_mvar( env, "UGen", "outlet", TRUE, doc.c_str() );
144144 if( subgraph_offset_outlet == CK_INVALID_OFFSET ) goto error;
145145
@@ -151,9 +151,10 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 5 unmodified lines
151151 //-------------------------------------------------------------------------
152152 // init as base class: FooGen
153153 //-------------------------------------------------------------------------
154− doc = "Base class for chugen-based user unit generators.";
154+ doc = "base class for user-created in-language unit generators.";
155155 if( !type_engine_import_ugen_begin( env, "Chugen", "UGen", env->global(),
156− foogen_ctor, foogen_dtor, foogen_tick, NULL, 1, 1, doc.c_str() ) )
156+ foogen_ctor, foogen_dtor, foogen_tick, NULL, 1, 1,
157+ doc.c_str() ) )
157158 return FALSE;
158159
159160 if( !type_engine_import_add_ex( env, "extend/chugen.ck" ) ) goto error;
@@ -169,7 +170,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 9 unmodified lines
169170 //-------------------------------------------------------------------------
170171 // init as base class: UGen_Multi
171172 //-------------------------------------------------------------------------
172− doc = "Base class for multi-channel unit generators.";
173+ doc = "base class for multi-channel unit generators.";
173174 if( !type_engine_import_ugen_begin( env, "UGen_Multi", "UGen", env->global(),
174175 multi_ctor, (f_dtor)NULL, (f_tick)NULL, (f_pmsg)NULL, 0, 0, doc.c_str() ) )
175176 return FALSE;
@@ -177,7 +178,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 1 unmodified line
177178 // add chan
178179 func = make_new_mfun( "UGen", "chan", multi_cget_chan );
179180 func->add_arg( "int", "which" );
180− func->doc = "Returns the ugen representing a specific channel of this ugen, or null if no such channel is available.";
181+ func->doc = "get UGen representing a specific channel of this UGen, or null if no such channel is available.";
181182 if( !type_engine_import_mfun( env, func ) ) goto error;
182183
183184 // add pan
@@ -195,18 +196,18 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 11 unmodified lines
195196 //---------------------------------------------------------------------
196197 // init as base class: UGen_Stereo
197198 //---------------------------------------------------------------------
198− doc = "Base class for stereo unit generators.";
199+ doc = "base class for stereo unit generators.";
199200 if( !type_engine_import_ugen_begin( env, "UGen_Stereo", "UGen_Multi", env->global(),
200201 stereo_ctor, NULL, NULL, NULL, 2, 2, doc.c_str() ) )
201202 return FALSE;
202203
203204 // add left
204− doc = "Left channel (same as .chan(0)).";
205+ doc = "left channel (same as .chan(0)).";
205206 stereo_offset_left = type_engine_import_mvar( env, "UGen", "left", FALSE, doc.c_str() );
206207 if( stereo_offset_left == CK_INVALID_OFFSET ) goto error;
207208
208209 // add right
209− doc = "Right channel (same as .chan(1)).";
210+ doc = "right channel (same as .chan(1)).";
210211 stereo_offset_right = type_engine_import_mvar( env, "UGen", "right", FALSE, doc.c_str() );
211212 if( stereo_offset_right == CK_INVALID_OFFSET ) goto error;
212213
@@ -217,10 +218,10 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 4 unmodified lines
217218 // add pan
218219 func = make_new_mfun( "float", "pan", stereo_ctrl_pan );
219220 func->add_arg( "float", "val" );
220− func->doc = "Panning between left and right channels, in range [-1,1], with -1 being far-left, 1 far-right, and 0 centered.";
221+ func->doc = "pan between left and right channels, in range [-1,1], with -1 being far-left, 1 far-right, and 0 centered.";
221222 if( !type_engine_import_mfun( env, func ) ) goto error;
222223 func = make_new_mfun( "float", "pan", stereo_cget_pan );
223− func->doc = "Panning between left and right channels, in range [-1,1], with -1 being far-left, 1 far-right, and 0 centered.";
224+ func->doc = "pan between left and right channels, in range [-1,1], with -1 being far-left, 1 far-right, and 0 centered.";
224225 if( !type_engine_import_mfun( env, func ) ) goto error;
225226
226227 // end import
@@ -234,7 +235,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 7 unmodified lines
234235 // init as base class: dac
235236 //---------------------------------------------------------------------
236237 if( !(env->t_dac = type_engine_import_ugen_begin( env, "DAC", "UGen_Stereo", env->global(),
237− NULL, NULL, NULL, NULL, 2, 2 )) )
238+ NULL, NULL, NULL, NULL, 2, 2 )) )
238239 return FALSE;
239240
240241 // end import
@@ -248,7 +249,8 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 7 unmodified lines
248249 // init as base class: adc
249250 //---------------------------------------------------------------------
250251 if( !(env->t_adc = type_engine_import_ugen_begin( env, "ADC", "UGen_Stereo", env->global(),
251− (f_ctor)NULL, (f_dtor)NULL, (f_tick)NULL, (f_pmsg)NULL, 0, 2 )) )
252+ (f_ctor)NULL, (f_dtor)NULL, (f_tick)NULL,
253+ (f_pmsg)NULL, 0, 2 )) )
252254 return FALSE;
253255
254256 // end import
@@ -258,7 +260,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 3 unmodified lines
258260 //---------------------------------------------------------------------
259261 // init as base class: pan2
260262 //---------------------------------------------------------------------
261− doc = "Spread mono signal to stereo.";
263+ doc = "a mono-to-stereo unit generator for stereo panning.";
262264 if( !type_engine_import_ugen_begin( env, "Pan2", "UGen_Stereo", env->global(),
263265 NULL, NULL, NULL, NULL, 2, 2, doc.c_str() ) )
264266 return FALSE;
@@ -272,7 +274,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 7 unmodified lines
272274 //---------------------------------------------------------------------
273275 // init as base class: mix2
274276 //---------------------------------------------------------------------
275− doc = "Unit generator for mixing stereo signal source to mono.";
277+ doc = "a stereo-to-mono unit generator for mixing stereo signal to mono.";
276278 if( !type_engine_import_ugen_begin( env, "Mix2", "UGen_Stereo", env->global(),
277279 NULL, NULL, NULL, NULL, 2, 2, doc.c_str() ) )
278280 return FALSE;
@@ -304,7 +306,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 25 unmodified lines
304306 //---------------------------------------------------------------------
305307 // init as base class: gain
306308 //---------------------------------------------------------------------
307− doc = "Gain control. (Note: all unit generators can themselves change their gain. This is a way to add multiple outputs together and scale them.)";
309+ doc = "a gain control unit generator. (All unit generators can already change their own gain; this is an explicit way to add multiple outputs together and scale them.)";
308310 if( !type_engine_import_ugen_begin( env, "Gain", "UGen", env->global(),
309311 NULL, NULL, NULL, NULL, doc.c_str() ) )
310312 return FALSE;
@@ -329,7 +331,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 18 unmodified lines
329331 //---------------------------------------------------------------------
330332 // init as base class: noise
331333 //---------------------------------------------------------------------
332− doc = "White noise generator.";
334+ doc = "a white noise generator.";
333335 if( !type_engine_import_ugen_begin( env, "Noise", "UGen", env->global(),
334336 NULL, NULL, noise_tick, NULL, doc.c_str() ) )
335337 return FALSE;
@@ -351,7 +353,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 15 unmodified lines
351353 //---------------------------------------------------------------------
352354 // init as base class: cnoise
353355 //---------------------------------------------------------------------
354− doc = "Noise generator with multiple noise synthesis modes. ";
356+ doc = "a noise generator with multiple noise synthesis modes.";
355357 if( !type_engine_import_ugen_begin( env, "CNoise", "UGen", env->global(),
356358 cnoise_ctor, cnoise_dtor, cnoise_tick, NULL, doc.c_str() ) )
357359 return FALSE;
@@ -403,7 +405,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 45 unmodified lines
403405 //---------------------------------------------------------------------
404406 // init as base class: impulse
405407 //---------------------------------------------------------------------
406− doc = "Pulse generator - can set the value of the current sample. Default for each sample is 0 if not set.";
408+ doc = "a impulse generator. Can be used to set the value of the next sample; default for each sample is 0 if not set. Additionally, this can be used to generate a digial signal, one sample at a time.";
407409 if( !type_engine_import_ugen_begin( env, "Impulse", "UGen", env->global(),
408410 impulse_ctor, impulse_dtor, impulse_tick, NULL, doc.c_str() ) )
409411 return FALSE;
@@ -423,11 +425,11 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 13 unmodified lines
423425 // add ctrl: next
424426 func = make_new_mfun( "float", "next", impulse_ctrl_next );
425427 func->add_arg( "float", "next" );
426− func->doc = "Value of next sample to be generated. (Note: if you are using the UGen.last method to read the output of the impulse, the value set by Impulse.next does not appear as the output until after the next sample boundary. In this case, there is a consistent 1::samp offset between setting .next and reading that value using .last.)";
428+ func->doc = "set the value of next sample. (Note: if you are using the UGen.last() method to read the output of the impulse, the value set by Impulse.next() does not appear as the output until after the next sample boundary. In this case, there is a consistent 1::samp offset between setting .next(...) and reading that value using .last().)";
427429 if( !type_engine_import_mfun( env, func ) ) goto error;
428430 // add cget: next
429431 func = make_new_mfun( "float", "next", impulse_cget_next );
430− func->doc = "Value of next sample to be generated.";
432+ func->doc = "get value of next sample to be generated.";
431433 if( !type_engine_import_mfun( env, func ) ) goto error;
432434
433435 // end import
@@ -457,7 +459,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 23 unmodified lines
457459 //---------------------------------------------------------------------
458460 // init as base class: step
459461 //---------------------------------------------------------------------
460− doc = "Step generator - like Impulse, but once a value is set, it is held for all following samples, until value is set again.";
462+ doc = "a step generator. Step behaves like Impulse, except that once a next value is set, that value is held for all following samples, until a different value is set.";
461463 if( !type_engine_import_ugen_begin( env, "Step", "UGen", env->global(),
462464 step_ctor, step_dtor, step_tick, NULL, doc.c_str() ) )
463465 return FALSE;
@@ -479,11 +481,11 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 15 unmodified lines
479481 // add ctrl: next
480482 func = make_new_mfun( "float", "next", step_ctrl_next );
481483 func->add_arg( "float", "next" );
482− func->doc = "The step value.";
484+ func->doc = "set the next step value.";
483485 if( !type_engine_import_mfun( env, func ) ) goto error;
484486 // add cget: next
485487 func = make_new_mfun( "float", "next", step_cget_next );
486− func->doc = "The step value.";
488+ func->doc = "get the next step value.";
487489 if( !type_engine_import_mfun( env, func ) ) goto error;
488490
489491 // end import
@@ -499,7 +501,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 9 unmodified lines
499501 //---------------------------------------------------------------------
500502 // init as base class: halfrect
501503 //---------------------------------------------------------------------
502− doc = "Half wave rectifier.";
504+ doc = "a half wave rectifier.";
503505 if( !type_engine_import_ugen_begin( env, "HalfRect", "UGen", env->global(),
504506 NULL, NULL, halfrect_tick, NULL, doc.c_str() ) )
505507 return FALSE;
@@ -517,7 +519,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 11 unmodified lines
517519 //---------------------------------------------------------------------
518520 // init as base class: fullrect
519521 //---------------------------------------------------------------------
520− doc = "Full wave rectifier.";
522+ doc = "a full wave rectifier.";
521523 if( !type_engine_import_ugen_begin( env, "FullRect", "UGen", env->global(),
522524 NULL, NULL, fullrect_tick, NULL, doc.c_str() ) )
523525 return FALSE;
@@ -633,7 +635,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 109 unmodified lines
633635 //---------------------------------------------------------------------
634636 // init as base class: sndbuf
635637 //---------------------------------------------------------------------
636− doc = "Interpolating sound buffer with single-channel output. Reads from a variety of uncompressed formats.";
638+ doc = "an interpolating sound buffer/player with single-channel output; can read audio data from a variety of uncompressed formats.";
637639 if( !type_engine_import_ugen_begin( env, "SndBuf", "UGen", env->global(),
638640 sndbuf_ctor, sndbuf_dtor,
639641 sndbuf_tick, NULL, 1, 1, doc.c_str() ) )
@@ -648,7 +650,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 8 unmodified lines
648650 // add ctrl: read
649651 func = make_new_mfun( "string", "read", sndbuf_ctrl_read );
650652 func->add_arg( "string", "read" );
651− func->doc = "Load file for reading.";
653+ func->doc = "read file for reading.";
652654 if( !type_engine_import_mfun( env, func ) ) goto error;
653655 // add cget: read // area
654656 //func = make_new_mfun( "string", "read", sndbuf_cget_read );
@@ -657,7 +659,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 2 unmodified lines
657659 // add ctrl: write
658660 func = make_new_mfun( "string", "write", sndbuf_ctrl_write );
659661 func->add_arg( "string", "read" );
660− func->doc = "Set file for writing (currently unsupported).";
662+ func->doc = "set file for writing (currently unsupported).";
661663 if( !type_engine_import_mfun( env, func ) ) goto error;
662664 // add cget: write
663665 //func = make_new_mfun( "string", "write", sndbuf_cget_write );
@@ -666,87 +668,87 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 2 unmodified lines
666668 // add ctrl: pos
667669 func = make_new_mfun( "int", "pos", sndbuf_ctrl_pos );
668670 func->add_arg( "int", "pos" );
669− func->doc = "Set position (between 0 and number of samples).";
671+ func->doc = "set play position (between 0 and number of samples).";
670672 if( !type_engine_import_mfun( env, func ) ) goto error;
671673 // add cget: pos
672674 func = make_new_mfun( "int", "pos", sndbuf_cget_pos );
673− func->doc = "Current position (between 0 and number of samples).";
675+ func->doc = "get play position (between 0 and number of samples).";
674676 if( !type_engine_import_mfun( env, func ) ) goto error;
675677
676678 // add ctrl: loop
677679 func = make_new_mfun( "int", "loop", sndbuf_ctrl_loop );
678680 func->add_arg( "int", "loop" );
679− func->doc = "Toggle for looping file playback.";
681+ func->doc = "toggle looping file playback.";
680682 if( !type_engine_import_mfun( env, func ) ) goto error;
681683 // add cget: loop
682684 func = make_new_mfun( "int", "loop", sndbuf_cget_loop );
683− func->doc = "Toggle for looping file playback.";
685+ func->doc = "get whether file playback is set to loop.";
684686 if( !type_engine_import_mfun( env, func ) ) goto error;
685687
686688 // add ctrl: interp
687689 func = make_new_mfun( "int", "interp", sndbuf_ctrl_interp );
688690 func->add_arg( "int", "interp" );
689− func->doc = "Interpolation mode. 0: drop sample, 1: linear interpolation, 2: sinc interpolation";
691+ func->doc = "set interpolation mode: (0) drop sample; (1) linear interpolation; (2) sinc interpolation.";
690692 if( !type_engine_import_mfun( env, func ) ) goto error;
691693 // add cget: interp
692694 func = make_new_mfun( "int", "interp", sndbuf_cget_interp );
693− func->doc = "Interpolation mode. 0: drop sample, 1: linear interpolation, 2: sinc interpolation";
695+ func->doc = "get interpolation mode: (0) drop sample; (1) linear interpolation; (2) sinc interpolation.";
694696 if( !type_engine_import_mfun( env, func ) ) goto error;
695697
696698 // add ctrl: rate
697699 func = make_new_mfun( "float", "rate", sndbuf_ctrl_rate );
698700 func->add_arg( "float", "rate" );
699− func->doc = "Playback rate (relative to file's natural speed). For example, 0.5 is half speed and 2 is twice as fast.";
701+ func->doc = "set playback rate (relative to file's natural speed). For example, 1.0 is 'normal', 0.5 is half speed, and 2 is twice as fast.";
700702 if( !type_engine_import_mfun( env, func ) ) goto error;
701703 // add cget: rate
702704 func = make_new_mfun( "float", "rate", sndbuf_cget_rate );
703− func->doc = "Playback rate (relative to file's natural speed). For example, 0.5 is half speed and 2 is twice as fast.";
705+ func->doc = "get playback rate (relative to file's natural speed). For example, 1.0 is 'normal', 0.5 is half speed, and 2 is twice as fast.";
704706 if( !type_engine_import_mfun( env, func ) ) goto error;
705707
706708 // add ctrl: play
707709 func = make_new_mfun( "float", "play", sndbuf_ctrl_rate );
708710 func->add_arg( "float", "play" );
709− func->doc = "Same as .rate. ";
711+ func->doc = "(same as .rate)";
710712 if( !type_engine_import_mfun( env, func ) ) goto error;
711713 // add cget: play // good
712714 func = make_new_mfun( "float", "play", sndbuf_cget_rate );
713− func->doc = "Same as .rate. ";
715+ func->doc = "(same as .rate)";
714716 if( !type_engine_import_mfun( env, func ) ) goto error;
715717
716718 // add ctrl: freq
717719 func = make_new_mfun( "float", "freq", sndbuf_ctrl_freq );
718720 func->add_arg( "float", "freq" );
719− func->doc = "Loop rate (in file loops per second).";
721+ func->doc = "set loop rate (in file loops per second).";
720722 if( !type_engine_import_mfun( env, func ) ) goto error;
721723 // add cget: freq
722724 func = make_new_mfun( "float", "freq", sndbuf_cget_freq );
723− func->doc = "Loop rate (in file loops per second).";
725+ func->doc = "get loop rate (in file loops per second).";
724726 if( !type_engine_import_mfun( env, func ) ) goto error;
725727
726728 // add ctrl: phase
727729 func = make_new_mfun( "float", "phase", sndbuf_ctrl_phase );
728730 func->add_arg( "float", "phase" );
729− func->doc = "Phase position, normalized to [0,1).";
731+ func->doc = "set phase position, normalized to [0,1).";
730732 if( !type_engine_import_mfun( env, func ) ) goto error;
731733 // add cget: phase
732734 func = make_new_mfun( "float", "phase", sndbuf_cget_phase );
733− func->doc = "Phase position, normalized to [0,1).";
735+ func->doc = "get phase position, normalized to [0,1).";
734736 if( !type_engine_import_mfun( env, func ) ) goto error;
735737
736738 // add ctrl: channel
737739 func = make_new_mfun( "int", "channel", sndbuf_ctrl_channel );
738740 func->add_arg( "int", "channel" );
739− func->doc = "If the sound file contains more than one channel of audio, select which channel to play.";
741+ func->doc = "for sound file containing more than one channel of audio, select the channel to play.";
740742 if( !type_engine_import_mfun( env, func ) ) goto error;
741743 // add cget: channel
742744 func = make_new_mfun( "int", "channel", sndbuf_cget_channel );
743− func->doc = "If the sound file contains more than one channel of audio, the selected channel to play.";
745+ func->doc = "get the selected chanel of audio this buffer is playing.";
744746 if( !type_engine_import_mfun( env, func ) ) goto error;
745747
746748 // add ctrl: phase_offset
747749 func = make_new_mfun( "float", "phaseOffset", sndbuf_ctrl_phase_offset );
748750 func->add_arg( "float", "value" );
749− func->doc = "Advance the playhead by the specified phase offset in [0,1), where 0 is no advance and 1 advance the entire length of the file.";
751+ func->doc = "advance the playhead by the specified phase offset in [0,1), where 0 is no advance and 1 advance the entire length of the file.";
750752 if( !type_engine_import_mfun( env, func ) ) goto error;
751753 // add cget: phase_offset
752754 // func = make_new_mfun( "float", "phaseOffset", sndbuf_cget_phase_offset );
@@ -755,32 +757,32 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 2 unmodified lines
755757 // add ctrl: chunks
756758 func = make_new_mfun( "int", "chunks", sndbuf_ctrl_chunks );
757759 func->add_arg( "int", "frames" );
758− func->doc = "Chunk size, in frames, for loading the file from disk. Set to 0 to disable chunking.";
760+ func->doc = "set chunk size, in frames, for loading the file from disk. Set to 0 to disable chunking.";
759761 if( !type_engine_import_mfun( env, func ) ) goto error;
760762 // add cget: chunks
761763 func = make_new_mfun( "int", "chunks", sndbuf_cget_chunks );
762− func->doc = "Chunk size, in frames, for loading the file from disk. 0 indicates that chunking is disabled.";
764+ func->doc = "get chunk size, in frames, for loading the file from disk. 0 indicates that chunking is disabled.";
763765 if( !type_engine_import_mfun( env, func ) ) goto error;
764766
765767 // add cget: samples
766768 func = make_new_mfun( "int", "samples", sndbuf_cget_samples );
767− func->doc = "Total number of sample frames in the file.";
769+ func->doc = "get total number of sample frames in the file.";
768770 if( !type_engine_import_mfun( env, func ) ) goto error;
769771
770772 // add cget: length
771773 func = make_new_mfun( "dur", "length", sndbuf_cget_length );
772− func->doc = "Total length of the file.";
774+ func->doc = "get total length of the file as a duration.";
773775 if( !type_engine_import_mfun( env, func ) ) goto error;
774776
775777 // add cget: channels
776778 func = make_new_mfun( "int", "channels", sndbuf_cget_channels );
777− func->doc = "Number of channels available in the sound file.";
779+ func->doc = "get number of channels available in the sound file.";
778780 if( !type_engine_import_mfun( env, func ) ) goto error;
779781
780782 // add cget: valueAt
781783 func = make_new_mfun( "float", "valueAt", sndbuf_cget_valueAt );
782784 func->add_arg( "int", "pos" );
783− func->doc = "Sample value at given position (in samples). ";
785+ func->doc = "get sample value at given position (in samples). ";
784786 if( !type_engine_import_mfun( env, func ) ) goto error;
785787
786788 // end import
@@ -791,7 +793,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 4 unmodified lines
791793 //---------------------------------------------------------------------
792794 // init as base class: SndBuf2
793795 //---------------------------------------------------------------------
794− doc = "Interpolating sound buffer with two-channel output. Reads from a variety of uncompressed formats.";
796+ doc = "a interpolating sound buffer with two-channel output. Reads from a variety of uncompressed formats.";
795797 if( !type_engine_import_ugen_begin( env, "SndBuf2", "SndBuf", env->global(),
796798 NULL, NULL,
797799 NULL, sndbuf_tickf, NULL, 2, 2, doc.c_str() ) )
@@ -807,7 +809,7 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 9 unmodified lines
807809 //---------------------------------------------------------------------
808810 // init as base class: Dyno
809811 //---------------------------------------------------------------------
810− doc = "Dynamics processor. Includes limiter, compressor, expander, noise gate, and ducker presets. ";
812+ doc = "a dynamics processor. Includes presets for limiter, compressor, expander, noise gate, and ducker.";
811813 if( !type_engine_import_ugen_begin( env, "Dyno", "UGen", env->global(),
812814 dyno_ctor, dyno_dtor, dyno_tick, NULL, doc.c_str() ) )
813815 return FALSE;
@@ -823,119 +825,119 @@ DLL_QUERY xxx_query( Chuck_DL_Query * QUERY ) · 9 unmodified lines
823825 // add ctrl: limit
824826 func = make_new_mfun( "void", "limit", dyno_ctrl_limit );
825827 //func->add_arg( "string", "mode" );
826− func->doc = "Set parameters to default limiter values. slopeAbove = 0.1, slopeBelow = 1.0, thresh = 0.5, attackTime = 5 ms, releaseTime = 300 ms, externalSideInput = 0 (false)";
828+ func->doc = "set parameters to default limiter values: slopeAbove = 0.1, slopeBelow = 1.0, thresh = 0.5, attackTime = 5 ms, releaseTime = 300 ms, externalSideInput = 0 (false)";
827829 if( !type_engine_import_mfun( env, func ) ) goto error;
828830
829831 // add ctrl: compress
830832 func = make_new_mfun( "void", "compress", dyno_ctrl_compress );
831833 //func->add_arg( "string", "mode" );
832− func->doc = "Set parameters to default compressor values.";
834+ func->doc = "set parameters to default compressor values.";
833835 if( !type_engine_import_mfun( env, func ) ) goto error;
834836
835837 // add ctrl: gate
836838 func = make_new_mfun( "void", "gate", dyno_ctrl_gate );
837839 //func->add_arg( "string", "mode" );
838− func->doc = "Set parameters to default noise gate values.";
840+ func->doc = "set parameters to default noise gate values.";
839841 if( !type_engine_import_mfun( env, func ) ) goto error;
840842
841843 // add ctrl: expand
842844 func = make_new_mfun( "void", "expand", dyno_ctrl_expand );
843845 //func->add_arg( "string", "mode" );
844− func->doc = "Set parameters to default expander values.";
846+ func->doc = "set parameters to default expander values.";
845847 if( !type_engine_import_mfun( env, func ) ) goto error;
846848
847849 // add ctrl: duck
848850 func = make_new_mfun( "void", "duck", dyno_ctrl_duck );
849851 //func->add_arg( "string", "mode" );
850− func->doc = "Set parameters ot default ducker values. ";
852+ func->doc = "set parameters ot default ducker values.";
851853 if( !type_engine_import_mfun( env, func ) ) goto error;
852854
853855 //add ctrl: thresh
854856 func = make_new_mfun( "float", "thresh", dyno_ctrl_thresh );
855857 func->add_arg( "float", "thresh" );
856− func->doc = "Threshold above which to stop using slopeBelow and start using slopeAbove to determine output gain vs input gain. ";
858+ func->doc = "set threshold, above which to stop using slopeBelow and start using slopeAbove to determine output gain vs input gain.";
857859 if( !type_engine_import_mfun( env, func ) ) goto error;
858860
859861 // add cget: thresh
860862 func = make_new_mfun( "float", "thresh", dyno_cget_thresh );
861− func->doc = "Threshold above which to stop using slopeBelow and start using slopeAbove to determine output gain vs input gain. ";
863+ func->doc = "get threshold, above which to stop using slopeBelow and start using slopeAbove to determine output gain vs input gain.";
862864 if( !type_engine_import_mfun( env, func ) ) goto error;
863865
864866 //add ctrl: attackTime
865867 func = make_new_mfun( "dur", "attackTime", dyno_ctrl_attackTime );
866868 func->add_arg( "dur", "aTime" );
867− func->doc = "Duration for the envelope to move linearly from current value to the absolute value of the signal's amplitude.";
869+ func->doc = "set duration for the envelope to move linearly from current value to the absolute value of the signal's amplitude.";
868870 if( !type_engine_import_mfun( env, func ) ) goto error;
869871
870872 //add cget: attackTime
871873 func = make_new_mfun( "dur", "attackTime", dyno_cget_attackTime );
872− func->doc = "Duration for the envelope to move linearly from current value to the absolute value of the signal's amplitude.";
874+ func->doc = "get duration for the envelope to move linearly from current value to the absolute value of the signal's amplitude.";
873875 if( !type_engine_import_mfun( env, func ) ) goto error;
874876
875877 //add ctrl: releaseTime
876878 func = make_new_mfun( "dur", "releaseTime", dyno_ctrl_releaseTime );
877879 func->add_arg( "dur", "rTime" );
878− func->doc = "Duration for the envelope to decay down to around 1/10 of its current amplitude, if not brought back up by the signal.";
880+ func->doc = "set duration for the envelope to decay down to around 1/10 of its current amplitude, if not brought back up by the signal.";
879881 if( !type_engine_import_mfun( env, func ) ) goto error;
880882
881883 //add ctrl: releaseTime
882884 func = make_new_mfun( "dur", "releaseTime", dyno_cget_releaseTime );
883− func->doc = "Duration for the envelope to decay down to around 1/10 of its current amplitude, if not brought back up by the signal.";
885+ func->doc = "get duration for the envelope to decay down to around 1/10 of its current amplitude, if not brought back up by the signal.";
884886 if( !type_engine_import_mfun( env, func ) ) goto error;
885887
886888 //add ctrl: ratio
887889 func = make_new_mfun( "float", "ratio", dyno_ctrl_ratio );
888890 func->add_arg( "float", "ratio" );
889− func->doc = "Alternate way of setting slopeAbove and slopeBelow; sets slopeBelow to 1.0 and slopeAbove to 1.0 / ratio.";
891+ func->doc = "an alternate way of setting slopeAbove and slopeBelow; sets slopeBelow to 1.0 and slopeAbove to 1.0 / ratio.";
890892 if( !type_engine_import_mfun( env, func ) ) goto error;
891893
892894 //add cget: ratio
893895 func = make_new_mfun( "float", "ratio", dyno_cget_ratio );
894− func->doc = "Alternate way of setting slopeAbove and slopeBelow; sets slopeBelow to 1.0 and slopeAbove to 1.0 / ratio.";
896+ func->doc = "get the ratio set by .ratio(float); slopeBelow to 1.0 and slopeAbove to 1.0 / ratio.";
895897 if( !type_engine_import_mfun( env, func ) ) goto error;
896898
897899 //add ctrl: slopeBelow
898900 func = make_new_mfun( "float", "slopeBelow", dyno_ctrl_slopeBelow );
899901 func->add_arg( "float", "slopeBelow" );
900− func->doc = "Determines the slope of the output gain vs the input envelope's level when the envelope is below thresh. ";
902+ func->doc = "set the slope of the output gain vs the input envelope's level when the envelope is below thresh.";
901903 if( !type_engine_import_mfun( env, func ) ) goto error;
902904
903905 //add cget: slopeBelow
904906 func = make_new_mfun( "float", "slopeBelow", dyno_cget_slopeBelow );
905− func->doc = "Determines the slope of the output gain vs the input envelope's level when the envelope is below thresh. ";
907+ func->doc = "get the slope of the output gain vs the input envelope's level when the envelope is below thresh.";
906908 if( !type_engine_import_mfun( env, func ) ) goto error;
907909
908910 //add ctrl: slopeAbove
909911 func = make_new_mfun( "float", "slopeAbove", dyno_ctrl_slopeAbove );
910912 func->add_arg( "float", "slopeAbove" );
911− func->doc = "Determines the slope of the output gain vs the input envelope's level when the envelope is above thresh. ";
913+ func->doc = "set the slope of the output gain vs the input envelope's level when the envelope is above thresh.";
912914 if( !type_engine_import_mfun( env, func ) ) goto error;
913915
914916 //add cget: slopeAbove
915917 func = make_new_mfun( "float", "slopeAbove", dyno_cget_slopeAbove );
916− func->doc = "Determines the slope of the output gain vs the input envelope's level when the envelope is above thresh. ";
918+ func->doc = "get the slope of the output gain vs the input envelope's level when the envelope is above thresh.";
917919 if( !type_engine_import_mfun( env, func ) ) goto error;
918920
919921 //add ctrl: sideInput
920922 func = make_new_mfun( "float", "sideInput", dyno_ctrl_sideInput );
921923 func->add_arg( "float", "sideInput" );
922− func->doc = "If externalSideInput is set to true, replaces the signal being processed as the input to the amplitude envelope.";
924+ func->doc = "if externalSideInput is set to true, replace the signal being processed as the input to the amplitude envelope.";
923925 if( !type_engine_import_mfun( env, func ) ) goto error;
924926
925927 //add cget: sideInput
926928 func = make_new_mfun( "float", "sideInput", dyno_cget_sideInput );
927− func->doc = "If externalSideInput is set to true, replaces the signal being processed as the input to the amplitude envelope.";
929+ func->doc = "if externalSideInput is set to true, replaces the signal being processed as the input to the amplitude envelope.";
928930 if( !type_engine_import_mfun( env, func ) ) goto error;
929931
930932 //add ctrl: externalSideInput
931933 func = make_new_mfun( "int", "externalSideInput", dyno_ctrl_externalSideInput );
932934 func->add_arg( "int", "externalSideInput" );
933− func->doc = "Set to true to cue the amplitude envelope off of sideInput instead of the input signal. Note that this means you will need to manually set sideInput every so often. ";
935+ func->doc = "set to true to cue the amplitude envelope off of sideInput instead of the input signal. Note that this means you will need to manually set sideInput every so often.";
934936 if( !type_engine_import_mfun( env, func ) ) goto error;
935937
936938 //add cget: externalSideInput
937939 func = make_new_mfun( "int", "externalSideInput", dyno_cget_externalSideInput );
938− func->doc = "Set to true to cue the amplitude envelope off of sideInput instead of the input signal. Note that this means you will need to manually set sideInput every so often. ";
940+ func->doc = "get externalSideInput state. if set to true, the amplitude envelope will be cued off of sideInput instead of the input signal. Note that this means you will need to manually set sideInput every so often.";
939941 if( !type_engine_import_mfun( env, func ) ) goto error;
940942
941943 // end import
@@ -978,12 +980,13 @@ DLL_QUERY lisa_query( Chuck_DL_Query * QUERY ) · 36 unmodified lines
978980 // - probably don't need the others anymore....
979981 // author: Dan Trueman (dan /at/ music.princeton.edu)
980982 //---------------------------------------------------------------------
981−
983+ string doc = "a (li)ve (sa)mpling unit generator; also popularly used for granular synthesis.";
982984
985+ // begin UGen definition
983986 if( !type_engine_import_ugen_begin( env, "LiSa", "UGen", env->global(),
984987 LiSaMulti_ctor, LiSaMulti_dtor,
985988 LiSaMulti_tick, NULL,
986− LiSaMulti_pmsg, 1, 1 ))
989+ LiSaMulti_pmsg, 1, 1, doc.c_str() ) )
987990 return FALSE;
988991
989992 // set/get buffer size
@@ -1230,12 +1233,14 @@ DLL_QUERY lisa_query( Chuck_DL_Query * QUERY ) · 240 unmodified lines
12301233
12311234 // end the class import
12321235 type_engine_import_class_end( env );
1233−
1236+
1237+ // description
1238+ doc = "a (li)ve (sa)mpling unit generator (multi-channel edition); also popularly used for granular synthesis.";
12341239 // multichannel
12351240 if( !type_engine_import_ugen_begin( env, "LiSa10", "LiSa", env->global(),
1236− LiSaMulti_ctor, LiSaMulti_dtor,
1237− NULL, LiSaMulti_tickf,
1238− LiSaMulti_pmsg, 1, LiSa_channels ))
1241+ LiSaMulti_ctor, LiSaMulti_dtor,
1242+ NULL, LiSaMulti_tickf,
1243+ LiSaMulti_pmsg, 1, LiSa_channels, doc.c_str() ) )
12391244 return FALSE;
12401245
12411246 type_engine_import_class_end( env );
src/core/ulib_opsc.cpp+1−1
@@ -1511,9 +1511,9 @@ CK_DLL_MFUN( osc_address_next_string ) { · 1510 unmodified lines
15111511 }
15121512
15131513
1514−// OscRecv functions
15151514
15161515
1516+// OscRecv functions
15171517 //----------------------------------------------
15181518 // name : osc_recv_ctor
15191519 // desc : CTOR function
src/core/ulib_std.cpp+28−29
@@ -166,146 +166,145 @@ DLL_QUERY libstd_query( Chuck_DL_Query * QUERY ) · 165 unmodified lines
166166
167167 // begin class
168168 QUERY->begin_class( QUERY, "Std", "Object" );
169− QUERY->doc_class( QUERY, "Std is a standard library in ChucK, which includes utility functions for random number generation, unit conversions, and absolute value." );
169+ QUERY->doc_class( QUERY, "a standard library in ChucK, which includes utility functions for random number generation, unit conversions, and absolute value." );
170170
171171 // add abs
172172 QUERY->add_sfun( QUERY, abs_impl, "int", "abs" );
173173 QUERY->add_arg( QUERY, "int", "value" );
174− QUERY->doc_func( QUERY, "Return absolute value of integer. " );
174+ QUERY->doc_func( QUERY, "compute the absolute value of an integer." );
175175
176176 // add fabs
177177 QUERY->add_sfun( QUERY, fabs_impl, "float", "fabs" );
178178 QUERY->add_arg( QUERY, "float", "value" );
179− QUERY->doc_func( QUERY, "Return absolute value of float. " );
179+ QUERY->doc_func( QUERY, "compute the absolute value of a float." );
180180
181181 // add rand
182182 QUERY->add_sfun( QUERY, rand_impl, "int", "rand"); //! return int between 0 and RAND_MAX
183− QUERY->doc_func( QUERY, "Generates random integer between 0 and Std.RAND_MAX. (NOTE: soon-to-be-deprecated; use Math.random2())." );
183+ QUERY->doc_func( QUERY, "generate a random integer between 0 and Std.RAND_MAX. (NOTE: this is deprecated; use Math.random())." );
184184
185185 // add rand2
186186 QUERY->add_sfun( QUERY, rand2_impl, "int", "rand2" ); //! integer between [min,max]
187187 QUERY->add_arg( QUERY, "int", "min" );
188188 QUERY->add_arg( QUERY, "int", "max" );
189− QUERY->doc_func( QUERY, "Generates random integer in range [min, max]. (NOTE: soon-to-be-deprecated; use Math.random2())." );
189+ QUERY->doc_func( QUERY, "generate a random integer in range [min, max]. (NOTE: this is deprecated; use Math.random2())." );
190190
191191 // add rand
192192 QUERY->add_sfun( QUERY, randf_impl, "float", "randf" ); //! rand between -1.0,1.0
193− QUERY->doc_func( QUERY, "Generates random floating point number in the range [-1, 1]. (Note: soon-to-be-deprecated; use Math.randomf())" );
193+ QUERY->doc_func( QUERY, "generates a random floating point number in the range [-1, 1]. (Note: this is deprecated; use Math.randomf())" );
194194
195195 // add rand2
196196 QUERY->add_sfun( QUERY, rand2f_impl, "float", "rand2f" ); //! rand between min and max
197197 QUERY->add_arg( QUERY, "float", "min" );
198198 QUERY->add_arg( QUERY, "float", "max" );
199− QUERY->doc_func( QUERY, "Generates random floating point number in the range [min, max]. (NOTE: soon-to-be-deprecated; use Math.random2f())" );
199+ QUERY->doc_func( QUERY, "generate random floating point number in the range [min, max]. (NOTE: this is deprecated; use Math.random2f())" );
200200
201201 // add srand
202202 QUERY->add_sfun( QUERY, srand_impl, "void", "srand" );
203203 QUERY->add_arg( QUERY, "int", "seed" );
204− QUERY->doc_func( QUERY, "Provide a seed to the random function. Different seeds will generate very different sequences of random numbers even if the seeds are close together. "
205− "Alternatively, a sequence of random numbers can be repeated by setting the same seed. " );
204+ QUERY->doc_func( QUERY, "seed the random number generator. Different seeds will likely generate different sequences of random numbers even if the seeds are close together; alternatively, a sequence of random numbers can be repeated by setting the same seed." );
206205
207206 // add sgn
208207 QUERY->add_sfun( QUERY, sgn_impl, "float", "sgn" ); //! return sign of value (-1, 0, 1)
209208 QUERY->add_arg( QUERY, "float", "value" );
210− QUERY->doc_func( QUERY, "Computes the sign of the input as -1.0 (negative), 0 (zero), or 1.0 (positive)." );
209+ QUERY->doc_func( QUERY, "compute the sign of the input as -1.0 (negative), 0 (zero), or 1.0 (positive)." );
211210
212211 // add system
213212 //! see \example std.ck
214213 QUERY->add_sfun( QUERY, system_impl, "int", "system" ); //! issue system command
215214 QUERY->add_arg( QUERY, "string", "cmd" );
216− QUERY->doc_func( QUERY, "Pass a command to be executed in the shell (requires --caution-to-the-wind command-line flag)." );
215+ QUERY->doc_func( QUERY, "pass a command to be executed in the shell (requires --caution-to-the-wind flag to be set)." );
217216
218217 // add atoi
219218 QUERY->add_sfun( QUERY, atoi_impl, "int", "atoi" ); //! string to integer
220219 QUERY->add_arg( QUERY, "string", "value" );
221− QUERY->doc_func( QUERY, "Converts ascii (string) to integer (int)." );
220+ QUERY->doc_func( QUERY, "convert ascii (string) to integer (int)." );
222221
223222 // add atof
224223 QUERY->add_sfun( QUERY, atof_impl, "float", "atof" ); //! string to float
225224 QUERY->add_arg( QUERY, "string", "value" );
226− QUERY->doc_func( QUERY, "Converts ascii (string) to floating point value (float)." );
225+ QUERY->doc_func( QUERY, "converts ascii (string) to floating point value (float)." );
227226
228227 // add itoa
229228 QUERY->add_sfun( QUERY, itoa_impl, "string", "itoa" ); //! int to string
230229 QUERY->add_arg( QUERY, "int", "i" );
231− QUERY->doc_func( QUERY, "Converts integer (int) to ascii (string)." );
230+ QUERY->doc_func( QUERY, "converts integer (int) to ascii (string)." );
232231
233232 // add ftoa
234233 QUERY->add_sfun( QUERY, ftoa_impl, "string", "ftoa" ); //! float to string
235234 QUERY->add_arg( QUERY, "float", "f" );
236235 QUERY->add_arg( QUERY, "int", "precision" );
237− QUERY->doc_func( QUERY, "Converts floating point value (float) to ascii (string) with specified precision (number of decimal digits)." );
236+ QUERY->doc_func( QUERY, "converts floating point value (float) to ascii (string) with specified precision (number of decimal digits)." );
238237
239238 // add ftoi
240239 QUERY->add_sfun( QUERY, ftoi_impl, "int", "ftoi" ); //! float to int
241240 QUERY->add_arg( QUERY, "float", "f" );
242− QUERY->doc_func( QUERY, "Convert float to int. " );
241+ QUERY->doc_func( QUERY, "convert float to integer. " );
243242
244243 // add getenv
245244 QUERY->add_sfun( QUERY, getenv_impl, "string", "getenv" ); //! fetch environment variable
246245 QUERY->add_arg( QUERY, "string", "value" );
247− QUERY->doc_func( QUERY, "Returns the value of an environment variable, such as of PATH." );
246+ QUERY->doc_func( QUERY, "get the value of an environment variable (e.g., PATH)." );
248247
249248 // add setenv
250249 QUERY->add_sfun( QUERY, setenv_impl, "int", "setenv" ); //! set environment variable
251250 QUERY->add_arg( QUERY, "string", "key" );
252251 QUERY->add_arg( QUERY, "string", "value" );
253− QUERY->doc_func( QUERY, "Set value of environment variable named key to value." );
252+ QUERY->doc_func( QUERY, "set the value of environment variable named 'key'" );
254253
255254 // add mtof
256255 //! see \example mand-o-matic.ck
257256 QUERY->add_sfun( QUERY, mtof_impl, "float", "mtof" ); //! midi note to frequency
258257 QUERY->add_arg( QUERY, "float", "value" );
259− QUERY->doc_func( QUERY, "Converts a MIDI note number to frequency (Hz). Note the input value is of type float (supports fractional note number)." );
258+ QUERY->doc_func( QUERY, "convert a MIDI note number to frequency (Hz). MIDI note 60 is Middle C; each whole number is one semitone; the input type is float and supports fractional note numbers." );
260259
261260 // add ftom
262261 QUERY->add_sfun( QUERY, ftom_impl, "float", "ftom" ); //! frequency to midi note
263262 QUERY->add_arg( QUERY, "float", "value" );
264− QUERY->doc_func( QUERY, "Converts frequency (Hz) to MIDI note number space." );
263+ QUERY->doc_func( QUERY, "convert frequency (Hz) to corresponding MIDI note number." );
265264
266265 // add powtodb
267266 QUERY->add_sfun( QUERY, powtodb_impl, "float", "powtodb" ); //! linear power to decibel
268267 QUERY->add_arg( QUERY, "float", "value" );
269− QUERY->doc_func( QUERY, "Converts signal power ratio to decibels (dB)." );
268+ QUERY->doc_func( QUERY, "convert signal power ratio to decibels (dB)." );
270269
271270 // add rmstodb
272271 QUERY->add_sfun( QUERY, rmstodb_impl, "float", "rmstodb" ); //! rms to decibel
273272 QUERY->add_arg( QUERY, "float", "value" );
274− QUERY->doc_func( QUERY, "Converts rms to decibels (dB)." );
273+ QUERY->doc_func( QUERY, "converts rms to decibels (dB)." );
275274
276275 // add dbtopow
277276 QUERY->add_sfun( QUERY, dbtopow_impl, "float", "dbtopow" ); //! decibel to linear
278277 QUERY->add_arg( QUERY, "float", "value" );
279− QUERY->doc_func( QUERY, "Converts decibels (dB) to signal power ratio." );
278+ QUERY->doc_func( QUERY, "converts decibels (dB) to signal power ratio." );
280279
281280 // add dbtorms
282281 QUERY->add_sfun( QUERY, dbtorms_impl, "float", "dbtorms" ); //! decibel to rms
283282 QUERY->add_arg( QUERY, "float", "value" );
284− QUERY->doc_func( QUERY, "Convert " );
283+ QUERY->doc_func( QUERY, "convert decibles (dB) to RMS." );
285284
286285 // add dbtolin
287286 QUERY->add_sfun( QUERY, dbtolin_impl, "float", "dbtolin" ); //! decibel to linear
288287 QUERY->add_arg( QUERY, "float", "value" );
289− QUERY->doc_func( QUERY, "" );
288+ QUERY->doc_func( QUERY, "convert decibels (dB) to linear." );
290289
291290 // add lintodb
292291 QUERY->add_sfun( QUERY, lintodb_impl, "float", "lintodb" ); //! linear to decibel
293292 QUERY->add_arg( QUERY, "float", "value" );
294− QUERY->doc_func( QUERY, "" );
293+ QUERY->doc_func( QUERY, "convert linear to decibels (dB)." );
295294
296295 // add clamp
297296 QUERY->add_sfun( QUERY, clamp_impl, "int", "clamp" ); //! clamp to range (int)
298297 QUERY->add_arg( QUERY, "int", "value" );
299298 QUERY->add_arg( QUERY, "int", "min" );
300299 QUERY->add_arg( QUERY, "int", "max" );
301− QUERY->doc_func( QUERY, "" );
300+ QUERY->doc_func( QUERY, "clamp an integer to range [min,max]." );
302301
303302 // add clampf
304303 QUERY->add_sfun( QUERY, clampf_impl, "float", "clampf" ); //! clamp to range (float)
305304 QUERY->add_arg( QUERY, "float", "value" );
306305 QUERY->add_arg( QUERY, "float", "min" );
307306 QUERY->add_arg( QUERY, "float", "max" );
308− QUERY->doc_func( QUERY, "" );
307+ QUERY->doc_func( QUERY, "clamp a float to range [min,max]." );
309308
310309 // add scalef
311310 QUERY->add_sfun( QUERY, scalef_impl, "float", "scalef" ); //! scale from source range to dest range (float)
@@ -314,7 +313,7 @@ DLL_QUERY libstd_query( Chuck_DL_Query * QUERY ) · 2 unmodified lines
314313 QUERY->add_arg( QUERY, "float", "srcmax" );
315314 QUERY->add_arg( QUERY, "float", "dstmin" );
316315 QUERY->add_arg( QUERY, "float", "dstmax" );
317− QUERY->doc_func( QUERY, "" );
316+ QUERY->doc_func( QUERY, "scale from a source range to a destination range." );
318317
319318 // finish class
320319 QUERY->end_class( QUERY );

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t