/[svn]/doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html
ViewVC logotype

Contents of /doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3318 - (show annotations) (download) (as text)
Thu Jul 20 12:21:24 2017 UTC (4 years, 11 months ago) by schoenebeck
File MIME type: text/html
File size: 30564 byte(s)
* NKSP: Added built-in function change_sustain().

1 <html>
2 <head>
3 <meta name="author" content="Christian Schoenebeck">
4 <title>NKSP Reference</title>
5 <urlpath>Reference</urlpath>
6 <navpath>Reference Manual</navpath>
7 <meta name="description" content="Reference documentation of the NKSP real-time instrument script language.">
8 </head>
9 <body>
10 <h1>NKSP Reference</h1>
11 <p>
12 This document gives you an overview of all built-in functions and built-in
13 variables provided by the NKSP real-time instrument script language.
14 </p>
15
16 <h2>Built-In Functions</h2>
17 <p>
18 These are the built-in functions available with the NKSP real-time
19 instrument script language.
20 </p>
21
22 <h3>Core Language Functions</h3>
23 <p>
24 Most fundamental NKSP functions, independent from any purpose of being used in a sampler.
25 </p>
26 <table>
27 <tr>
28 <th>Function</th> <th>Description</th>
29 </tr>
30 <tr>
31 <td><code lang="nksp">abort()</code></td>
32 <td>Stops execution of a script callback.</td>
33 </tr>
34 <tr>
35 <td><code lang="nksp">array_equal()</code></td>
36 <td>Check whether two arrays are equal.</td>
37 </tr>
38 <tr>
39 <td><code>fork()</code></td>
40 <td>Creates new execution instances (threads).</td>
41 </tr>
42 <tr>
43 <td><code>callback_status()</code></td>
44 <td>Returns the current status of a callback (thread).</td>
45 </tr>
46 <tr>
47 <td><code lang="nksp">dec()</code></td>
48 <td>Decrements the passed integer variable by one.</td>
49 </tr>
50 <tr>
51 <td><code>inc()</code></td>
52 <td>Increments the passed integer variable by one.</td>
53 </tr>
54 <tr>
55 <td><code>in_range()</code></td>
56 <td>Checks whether a value is between two other values.</td>
57 </tr>
58 <tr>
59 <td><code lang="nksp">message()</code></td>
60 <td>Prints text to the sampler's terminal.</td>
61 </tr>
62 <tr>
63 <td><code>search()</code></td>
64 <td>Search for a certain value within an array.</td>
65 </tr>
66 <tr>
67 <td><code>sort()</code></td>
68 <td>Sort the given array.</td>
69 </tr>
70 <tr>
71 <td><code>exit()</code></td>
72 <td>Stops execution of the current event handler instance.</td>
73 </tr>
74 <tr>
75 <td><code>wait()</code></td>
76 <td>Pauses execution for a certain amount of time.</td>
77 </tr>
78 <tr>
79 <td><code>stop_wait()</code></td>
80 <td>Resumes execution of a suspended script callback.</td>
81 </tr>
82 <tr>
83 <td><code>abs()</code></td>
84 <td>Calculates the absolute value of a given value.</td>
85 </tr>
86 <tr>
87 <td><code>random()</code></td>
88 <td>Random number generator.</td>
89 </tr>
90 <tr>
91 <td><code>min()</code></td>
92 <td>Calculates the minimum value of two given values.</td>
93 </tr>
94 <tr>
95 <td><code>max()</code></td>
96 <td>Calculates the maximum value of two given values.</td>
97 </tr>
98 <tr>
99 <td><code>num_elements()</code></td>
100 <td>Returns the size of the requested array variable.</td>
101 </tr>
102 <tr>
103 <td><code>sh_left()</code></td>
104 <td>Calculates a left bit shifted value.</td>
105 </tr>
106 <tr>
107 <td><code>sh_right()</code></td>
108 <td>Calculates a right bit shifted value.</td>
109 </tr>
110 </table>
111
112 <h3>Common Sampler Functions</h3>
113 <p>
114 Basic sampler related functions, independent from a particular sampler
115 format or sampler engine.
116 </p>
117 <table>
118 <tr>
119 <th>Function</th> <th>Description</th>
120 </tr>
121 <tr>
122 <td><code>play_note()</code></td>
123 <td>Triggers a new note.</td>
124 </tr>
125 <tr>
126 <td><code>change_note()</code></td>
127 <td>Change MIDI note number of note.</td>
128 </tr>
129 <tr>
130 <td><code>change_pan()</code></td>
131 <td>Changes panning of voices (stereo balance).</td>
132 </tr>
133 <tr>
134 <td><code>change_play_pos()</code></td>
135 <td>Change the sample playback position.</td>
136 </tr>
137 <tr>
138 <td><code>change_tune()</code></td>
139 <td>Changes the tuning of voices.</td>
140 </tr>
141 <tr>
142 <td><code>change_tune_time()</code></td>
143 <td>Changes the duration of tuning changes.</td>
144 </tr>
145 <tr>
146 <td><code>change_tune_curve()</code></td>
147 <td>Changes the curve type of tuning changes.</td>
148 </tr>
149 <tr>
150 <td><code>change_vol()</code></td>
151 <td>Changes the volume of voices.</td>
152 </tr>
153 <tr>
154 <td><code>change_vol_time()</code></td>
155 <td>Changes the duration of volume changes.</td>
156 </tr>
157 <tr>
158 <td><code>change_vol_curve()</code></td>
159 <td>Changes the curve type of volume changes.</td>
160 </tr>
161 <tr>
162 <td><code>change_cutoff()</code></td>
163 <td>Changes filter cutoff frequency of voices.</td>
164 </tr>
165 <tr>
166 <td><code>change_reso()</code></td>
167 <td>Changes filter resonance of voices.</td>
168 </tr>
169 <tr>
170 <td><code>change_attack()</code></td>
171 <td>Modifies the attack time of voices.</td>
172 </tr>
173 <tr>
174 <td><code>change_decay()</code></td>
175 <td>Modifies the decay time of voices.</td>
176 </tr>
177 <tr>
178 <td><code>change_sustain()</code></td>
179 <td>Modifies the sustain level of voices.</td>
180 </tr>
181 <tr>
182 <td><code>change_release()</code></td>
183 <td>Modifies the release time of voices.</td>
184 </tr>
185 <tr>
186 <td><code>change_amp_lfo_depth()</code></td>
187 <td>Modifies the amplitude LFO depth.</td>
188 </tr>
189 <tr>
190 <td><code>change_amp_lfo_freq()</code></td>
191 <td>Modifies the amplitude LFO frequency.</td>
192 </tr>
193 <tr>
194 <td><code>change_pitch_lfo_depth()</code></td>
195 <td>Modifies the pitch LFO depth.</td>
196 </tr>
197 <tr>
198 <td><code>change_pitch_lfo_freq()</code></td>
199 <td>Modifies the pitch LFO frequency.</td>
200 </tr>
201 <tr>
202 <td><code>change_velo()</code></td>
203 <td>Change MIDI velocity of note.</td>
204 </tr>
205 <tr>
206 <td><code>event_status()</code></td>
207 <td>Checks and returns whether a particular note is still alive.</td>
208 </tr>
209 <tr>
210 <td><code>fade_in()</code></td>
211 <td>Fade the requested note in.</td>
212 </tr>
213 <tr>
214 <td><code>fade_out()</code></td>
215 <td>Fade the requested note out.</td>
216 </tr>
217 <tr>
218 <td><code>get_event_par()</code></td>
219 <td>Get the current value of a specific note parameter.</td>
220 </tr>
221 <tr>
222 <td><code>set_event_par()</code></td>
223 <td>Change the value of a specific note parameter.</td>
224 </tr>
225 <tr>
226 <td><code>set_controller()</code></td>
227 <td>Creates a MIDI control change event.</td>
228 </tr>
229 <tr>
230 <td><code>ignore_event()</code></td>
231 <td>Drops the given event.</td>
232 </tr>
233 <tr>
234 <td><code>ignore_controller()</code></td>
235 <td>Drops the given MIDI control change event.</td>
236 </tr>
237 <tr>
238 <td><code>note_off()</code></td>
239 <td>Releases the requested note.</td>
240 </tr>
241 <tr>
242 <td><code>set_event_mark()</code></td>
243 <td>Adds an event to an event group.</td>
244 </tr>
245 <tr>
246 <td><code>delete_event_mark()</code></td>
247 <td>Removes an event from some event group.</td>
248 </tr>
249 <tr>
250 <td><code>by_marks()</code></td>
251 <td>Returns all events of an event group.</td>
252 </tr>
253 </table>
254
255 <h3>GigaStudio Format Functions</h3>
256 <p>
257 Sampler format specific functions, dedicated to the individual features
258 of the GigaStudio format engine.
259 </p>
260 <table>
261 <tr>
262 <th>Function</th> <th>Description</th>
263 </tr>
264 <tr>
265 <td><code>gig_set_dim_zone()</code></td>
266 <td>Changes the currently active dimension zone.</td>
267 </tr>
268 <tr>
269 <td><code>same_region()</code></td>
270 <td>Check whether two keys are mapped to the same region.</td>
271 </tr>
272 </table>
273
274 <h2>Built-In Variables</h2>
275 <p>
276 These are the built-in variables and built-in constants available with the
277 NKSP realt-time instrument script language.
278 </p>
279
280 <h3>Core Language Variables</h3>
281 <p>
282 Most fundamental NKSP built-in variables, independent from any purpose of
283 being used in a sampler.
284 </p>
285 <table>
286 <tr>
287 <th>Variable</th> <th>Description</th>
288 </tr>
289 <tr>
290 <td><code>$CALLBACK_STATUS_QUEUE</code></td>
291 <td>Built-in constant reflecting the status of a callback to be
292 alive but suspended. See <code>callback_status()</code> for details.</td>
293 </tr>
294 <tr>
295 <td><code>$CALLBACK_STATUS_RUNNING</code></td>
296 <td>Built-in constant reflecting the status of a callback to be
297 alive and currently executing. See <code>callback_status()</code>
298 for details.</td>
299 </tr>
300 <tr>
301 <td><code>$CALLBACK_STATUS_TERMINATED</code></td>
302 <td>Built-in constant reflecting the status of a callback to be
303 not alive. See <code>callback_status()</code> for details.</td>
304 </tr>
305 <tr>
306 <td><code>$KSP_TIMER</code></td>
307 <td>Preserved for compatiblity reasons with KSP, returns the same value
308 as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
309 Note that KSP's <code>reset_ksp_timer()</code> function is not available with
310 NKSP. However when calculating time differences between two time
311 stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset
312 function is not required, because the underlying clock does not stop
313 when it reached its value limit (which happens every 71 minutes), instead the clock
314 will automatically restart from zero and the calculated time difference
315 even between such transitions will reflect correct durations.</td>
316 </tr>
317 <tr>
318 <td><code>$NKSP_PERF_TIMER</code></td>
319 <td>Returns the current performance time stamp (in microseconds) of the
320 script running. You may read this variable from time to time to take
321 time stamps which can be used to calculate the time difference
322 (in microseconds) which elapsed between them. A performance time
323 stamp is based on the script's actual CPU execution time. So the
324 internal clock which is used for generating such time stamps is only
325 running forward if the respective script is actually executed by the
326 CPU. Whenever your script is not really executed by the CPU (i.e. because
327 your script got suspended by a wait() call or got forcely suspended due to
328 real-time constraints, or when the entire sampler application got suspended
329 by the OS for other applications or OS tasks) then the underlying internal
330 clock is paused as well.
331 <note class="important">
332 You should only use this built-in variable for script development
333 purposes (i.e. for bench marking the performance of your script).
334 You should <b>not</b> use it with your final production sounds!
335 It is not appropriate for being used in a musical context, because
336 when an offline bounce is performed for instance, the musical timing
337 will be completely unrelated to the CPU execution time. Plus using
338 this variable may cause audio drop outs on some systems. In a musical
339 context you should use <code>$ENGINE_UPTIME</code> instead, which is
340 also safe for offline bounces.
341 </note>
342 <note>
343 On some systems <code>$NKSP_REAL_TIMER</code> and
344 <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
345 difference between them is not implemented for all systems at the moment.
346 </note>
347 </td>
348 </tr>
349 <tr>
350 <td><code>%NKSP_CALLBACK_CHILD_ID[]</code></td>
351 <td>
352 Reflects the callback IDs of all child threads which the current
353 script callback instance spawned by having called <code>fork()</code> before.
354 See the latter function for details about this array variable.
355 </td>
356 </tr>
357 <tr>
358 <td><code>$NKSP_CALLBACK_PARENT_ID</code></td>
359 <td>
360 If the current execution thread is a child thread spawned by a <code>fork()</code>
361 call before, then this variable reflects the callback ID of the parent
362 thread which created this child thread. Otherwise this variable is <code>0</code>.
363 See <code>fork()</code> for more details about this variable.
364 </td>
365 </tr>
366 <tr>
367 <td><code>$NKSP_REAL_TIMER</code></td>
368 <td>Returns the current time stamp in reality (in microseconds). You may
369 read this variable from time to time to take
370 time stamps which can be used to calculate the time difference
371 (in microseconds) which elapsed between them. A "real" time
372 stamp is based on an internal clock which constantly proceeds, so this
373 internal clock also continues counting while your script is either suspended
374 (i.e. because your script got suspended by a wait() call or got forcely
375 suspended due to real-time constraints) and it also continues counting
376 even if the entire sampler application got suspended by the OS (i.e. to
377 execute other applications for multi-tasking or to perform OS tasks).
378 <note class="important">
379 You should only use this built-in variable for script development
380 purposes (i.e. for bench marking the performance of your script).
381 You should <b>not</b> use it with your final production sounds!
382 It is not appropriate for being used in a musical context, because
383 when an offline bounce is performed for instance, the musical timing
384 will be completely unrelated to the CPU execution time. Plus using
385 this variable may cause audio drop outs on some systems. In a musical
386 context you should use <code>$ENGINE_UPTIME</code> instead, which is
387 also safe for offline bounces.
388 </note>
389 <note>
390 On some systems <code>$NKSP_REAL_TIMER</code> and
391 <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
392 difference between them is not implemented for all systems at the moment.
393 </note>
394 </td>
395 </tr>
396 <tr>
397 <td><code>$NI_CALLBACK_ID</code></td>
398 <td>Reflects the current event handler instance's unique callback ID.
399 For the same event type there may be more than
400 one event handler instances running. Each one of them has
401 its own callback ID. You can get the current event handler
402 instance's callback ID by reading this built-in variable.</td>
403 </tr>
404 <tr>
405 <td><code>$NI_CALLBACK_TYPE</code></td>
406 <td>Reflects the event type of the current event handler. This variable
407 may reflect one of the following built-in constants:
408 <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
409 <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
410 </tr>
411 <tr>
412 <td><code>$NI_CB_TYPE_INIT</code></td>
413 <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
414 </tr>
415 <tr>
416 <td><code>$NI_CB_TYPE_NOTE</code></td>
417 <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
418 </tr>
419 <tr>
420 <td><code>$NI_CB_TYPE_RELEASE</code></td>
421 <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
422 </tr>
423 <tr>
424 <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
425 <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
426 </tr>
427 <tr>
428 <td><code>$NKSP_IGNORE_WAIT</code></td>
429 <td>If this boolean built-in variable is <code>1</code> then all calls of your
430 event handler instance to function <code>wait()</code> will be ignored.
431 This may for example be the case if another event handler instance
432 resumed your paused script by calling <code>stop_wait()</code> and
433 passing <code>1</code> to the 2nd argument of that function.</td>
434 </tr>
435 </table>
436
437 <h3>Common Sampler Variables</h3>
438 <p>
439 Basic sampler related built-in variables and constants, independent from a
440 particular sampler format or sampler engine.
441 </p>
442 <table>
443 <tr>
444 <th>Variable</th> <th>Description</th>
445 </tr>
446 <tr>
447 <td><code>%ALL_EVENTS</code></td>
448 <td>
449 Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
450 This may be passed to many built-in functions like <code>note_off()</code>.
451 This array variable only contains IDs of notes which were launched due
452 to MIDI note-on events. This variable does not contain IDs of child notes
453 (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
454 <note>
455 In contrast to KSP this variable is an integer array type, whereas KSP's
456 pendent of this built-in variable is an integer constant (scalar) called
457 <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
458 parser warning, the behavior will be the same though.
459 </note>
460 </td>
461 </tr>
462 <tr>
463 <td><code>$CC_NUM</code></td>
464 <td>MIDI controller number that caused the <code>controller</code>
465 handler to be executed (only useful in the context of a
466 <code>controller</code> handler).</td>
467 </tr>
468 <tr>
469 <td><code>%CC[]</code></td>
470 <td>Provides access to all current MIDI controller values. This can be
471 used in any context. Use the respective MIDI controller number as
472 index to this integer array variable. For instance <code>%CC[1]</code>
473 would give you the current value of the modulation wheel.
474 </td>
475 </tr>
476 <tr>
477 <td><code>$EVENT_ID</code></td>
478 <td>ID of the event that caused the current event handler to be executed. In
479 the context of a <code>note</code> handler this would be the event
480 ID of the note, within a <code>controller</code> handler it would
481 be the controller event ID, etc.</td>
482 </tr>
483 <tr>
484 <td><code>$EVENT_NOTE</code></td>
485 <td>MIDI note number that caused a note related
486 handler to be executed (only useful in the context of a
487 <code>note</code> or <code>release</code> handler).</td>
488 </tr>
489 <tr>
490 <td><code>$EVENT_VELOCITY</code></td>
491 <td>MIDI velocity value of the note that caused that note related
492 handler to be executed (only useful in the context of a
493 <code>note</code> or <code>release</code> handler).</td>
494 </tr>
495 <tr>
496 <td><code>$EVENT_STATUS_INACTIVE</code></td>
497 <td>Constant bit flag used as possible return value by
498 <code>event_status()</code> in case the requested
499 note is not "alive".</td>
500 </tr>
501 <tr>
502 <td><code>$EVENT_STATUS_NOTE_QUEUE</code></td>
503 <td>Constant bit flag used as possible return value by
504 <code>event_status()</code> in case the requested
505 note is still "alive".</td>
506 </tr>
507 <tr>
508 <td><code>$EVENT_PAR_NOTE</code></td>
509 <td>Constant value symbolizing the "note number" parameter. See
510 <code>get_event_par()</code> and <code>set_event_par()</code>
511 for details.</td>
512 </tr>
513 <tr>
514 <td><code>$EVENT_PAR_TUNE</code></td>
515 <td>Constant value symbolizing the "tune" parameter. See
516 <code>get_event_par()</code> and <code>set_event_par()</code>
517 for details.</td>
518 </tr>
519 <tr>
520 <td><code>$EVENT_PAR_VELOCITY</code></td>
521 <td>Constant value symbolizing the "note velocity" parameter. See
522 <code>get_event_par()</code> and <code>set_event_par()</code>
523 for details.</td>
524 </tr>
525 <tr>
526 <td><code>$EVENT_PAR_VOLUME</code></td>
527 <td>Constant value symbolizing the "volume" parameter. See
528 <code>get_event_par()</code> and <code>set_event_par()</code>
529 for details.</td>
530 </tr>
531 <tr>
532 <td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td>
533 <td>Four constant values symbolizing the 4 possible user specific
534 parameters, which i.e. might be used to pass data from one script
535 (slot) to another script (slot). See <code>get_event_par()</code>
536 and <code>set_event_par()</code> for details.</td>
537 </tr>
538 <tr>
539 <td><code>%KEY_DOWN[]</code></td>
540 <td>This can be used in any context to check whether a certain MIDI
541 key is currently pressed down. Use the respective MIDI note number
542 as index to this array variable (see also <code>event_status()</code>).</td>
543 </tr>
544 <tr>
545 <td><code>$NKSP_EASE_IN_EASE_OUT</code></td>
546 <td>Used to select a fade curve with "ease in and ease out" shape.</td>
547 </tr>
548 <tr>
549 <td><code>$NKSP_LINEAR</code></td>
550 <td>Used to select a fade curve with linear shape.</td>
551 </tr>
552 <tr>
553 <td><code>$VCC_MONO_AT</code></td>
554 <td>Constant identifying the MIDI monophonic aftertouch controller (also
555 called <i title="Amount of force on held-down key.">
556 MIDI channel pressure
557 </i>). This is somewhat different than in the MIDI standard. With
558 NKSP aftertouch is handled like an additional "regular" MIDI CC controller.
559 Therefore use
560 <code>%CC[$VCC_MONO_AT]</code> to obtain the current aftertouch value
561 in the context of a <code>controller</code> event handler.
562 </td>
563 </tr>
564 <tr>
565 <td><code>$VCC_PITCH_BEND</code></td>
566 <td>Constant identifying the pitch bend wheel controller.
567 This is somewhat different than in the MIDI standard. With
568 NKSP pitch bend is handled like an additional "regular" MIDI CC controller.
569 Therefore use
570 <code>%CC[$VCC_PITCH_BEND]</code> to obtain the current pitch bend wheel value
571 in the context of a <code>controller</code> event handler.</td>
572 </tr>
573 <tr>
574 <td><code>$MARK_1</code> to <code>$MARK_28</code></td>
575 <td>Used to select one of the available 28 event groups.
576 See <code>set_event_mark()</code> for details.</td>
577 </tr>
578 <tr>
579 <td><code>$ENGINE_UPTIME</code></td>
580 <td>Returns the current time stamp (in milliseconds) for being
581 used in a musical context. You may read this variable from time to time
582 to take time stamps which can be used to calculate the time difference
583 (in milliseconds) which elapsed between them. These timing values are
584 based on the internal sample rate and thus it can safely be used to
585 perform musical timing related tasks in your scripts. Especially
586 your script will also continue to behave correctly when an offline bounce
587 of a song is performed.
588 </td>
589 </tr>
590 </table>
591
592 <h3>GigaStudio Format Variables</h3>
593 <p>
594 Sampler format specific built-in variables and constants, dedicated to the
595 individual features of the GigaStudio format engine.
596 </p>
597 <table>
598 <tr>
599 <th>Variable</th> <th>Description</th>
600 </tr>
601 <tr>
602 <td><code>$GIG_DIM_CHANNEL</code></td>
603 <td>Constant that identifies the <i>stereo dimension</i>.</td>
604 </tr>
605 <tr>
606 <td><code>$GIG_DIM_LAYER</code></td>
607 <td>Constant that identifies the <i>layer dimension</i>.</td>
608 </tr>
609 <tr>
610 <td><code>$GIG_DIM_VELOCITY</code></td>
611 <td>Constant that identifies the <i>velocity dimension</i>.</td>
612 </tr>
613 <tr>
614 <td><code>$GIG_DIM_AFTERTOUCH</code></td>
615 <td>Constant that identifies the <i>aftertouch dimension</i>.</td>
616 </tr>
617 <tr>
618 <td><code>$GIG_DIM_RELEASE</code></td>
619 <td>Constant that identifies the <i>release trigger dimension</i>.</td>
620 </tr>
621 <tr>
622 <td><code>$GIG_DIM_KEYBOARD</code></td>
623 <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
624 </tr>
625 <tr>
626 <td><code>$GIG_DIM_ROUNDROBIN</code></td>
627 <td>Constant that identifies the <i>round robin dimension</i>.</td>
628 </tr>
629 <tr>
630 <td><code>$GIG_DIM_RANDOM</code></td>
631 <td>Constant that identifies the <i>random dimension</i>.</td>
632 </tr>
633 <tr>
634 <td><code>$GIG_DIM_SMARTMIDI</code></td>
635 <td>Constant that identifies the <i>start MIDI dimension</i> (a.k.a iMIDI rules).</td>
636 </tr>
637 <tr>
638 <td><code>$GIG_DIM_ROUNDROBINKEY</code></td>
639 <td>Constant that identifies the <i>round robin key dimension</i>.</td>
640 </tr>
641 <tr>
642 <td><code>$GIG_DIM_MODWHEEL</code></td>
643 <td>Constant that identifies the <i>modulation wheel dimension</i>.</td>
644 </tr>
645 <tr>
646 <td><code>$GIG_DIM_SUSTAIN</code></td>
647 <td>Constant that identifies the <i>sustain pedal dimension</i> (a.k.a. hold pedal).</td>
648 </tr>
649 <tr>
650 <td><code>$GIG_DIM_PORTAMENTO</code></td>
651 <td>Constant that identifies the <i>portamento MIDI controller dimension</i>.</td>
652 </tr>
653 <tr>
654 <td><code>$GIG_DIM_SOSTENUTO</code></td>
655 <td>Constant that identifies the <i>sostenuto MIDI controller dimension</i>.</td>
656 </tr>
657 <tr>
658 <td><code>$GIG_DIM_SOFT</code></td>
659 <td>Constant that identifies the <i>soft pedal dimension</i>.</td>
660 </tr>
661 <tr>
662 <td><code>$GIG_DIM_BREATH</code></td>
663 <td>Constant that identifies the <i>breath controller dimension</i>.</td>
664 </tr>
665 <tr>
666 <td><code>$GIG_DIM_FOOT</code></td>
667 <td>Constant that identifies the <i>foot pedal dimension</i>.</td>
668 </tr>
669 <tr>
670 <td><code>$GIG_DIM_PORTAMENTOTIME</code></td>
671 <td>Constant that identifies the <i>portamento time controller dimension</i>.</td>
672 </tr>
673 <tr>
674 <td><code>$GIG_DIM_EFFECT1</code></td>
675 <td>Constant that identifies the <i>effect 1 MIDI controller dimension</i>.</td>
676 </tr>
677 <tr>
678 <td><code>$GIG_DIM_EFFECT2</code></td>
679 <td>Constant that identifies the <i>effect 2 MIDI controller dimension</i>.</td>
680 </tr>
681 <tr>
682 <td><code>$GIG_DIM_EFFECT1DEPTH</code></td>
683 <td>Constant that identifies the <i>effect 1 depth MIDI controller dimension</i>.</td>
684 </tr>
685 <tr>
686 <td><code>$GIG_DIM_EFFECT2DEPTH</code></td>
687 <td>Constant that identifies the <i>effect 2 depth MIDI controller dimension</i>.</td>
688 </tr>
689 <tr>
690 <td><code>$GIG_DIM_EFFECT3DEPTH</code></td>
691 <td>Constant that identifies the <i>effect 3 depth MIDI controller dimension</i>.</td>
692 </tr>
693 <tr>
694 <td><code>$GIG_DIM_EFFECT4DEPTH</code></td>
695 <td>Constant that identifies the <i>effect 4 depth MIDI controller dimension</i>.</td>
696 </tr>
697 <tr>
698 <td><code>$GIG_DIM_EFFECT5DEPTH</code></td>
699 <td>Constant that identifies the <i>effect 5 depth MIDI controller dimension</i>.</td>
700 </tr>
701 <tr>
702 <td><code>$GIG_DIM_GENPURPOSE1</code></td>
703 <td>Constant that identifies the <i>general purpose 1 MIDI controller dimension</i>.</td>
704 </tr>
705 <tr>
706 <td><code>$GIG_DIM_GENPURPOSE2</code></td>
707 <td>Constant that identifies the <i>general purpose 2 MIDI controller dimension</i>.</td>
708 </tr>
709 <tr>
710 <td><code>$GIG_DIM_GENPURPOSE3</code></td>
711 <td>Constant that identifies the <i>general purpose 3 MIDI controller dimension</i>.</td>
712 </tr>
713 <tr>
714 <td><code>$GIG_DIM_GENPURPOSE4</code></td>
715 <td>Constant that identifies the <i>general purpose 4 MIDI controller dimension</i>.</td>
716 </tr>
717 <tr>
718 <td><code>$GIG_DIM_GENPURPOSE5</code></td>
719 <td>Constant that identifies the <i>general purpose 5 MIDI controller dimension</i>.</td>
720 </tr>
721 <tr>
722 <td><code>$GIG_DIM_GENPURPOSE6</code></td>
723 <td>Constant that identifies the <i>general purpose 6 MIDI controller dimension</i>.</td>
724 </tr>
725 <tr>
726 <td><code>$GIG_DIM_GENPURPOSE7</code></td>
727 <td>Constant that identifies the <i>general purpose 7 MIDI controller dimension</i>.</td>
728 </tr>
729 <tr>
730 <td><code>$GIG_DIM_GENPURPOSE8</code></td>
731 <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>
732 </tr>
733 </table>
734
735 <h2>Built-In Preprocessor Conditions</h2>
736 <p>
737 These are the built-in preprocessor conditions available with the NKSP realt-time
738 instrument script language.
739 </p>
740
741 <h3>Core Language Preprocessor Conditions</h3>
742 <p>
743 Most fundamental NKSP built-in preprocessor conditions, independent from
744 any purpose of being used in a sampler.
745 </p>
746 <table>
747 <tr>
748 <th>Condition</th> <th>Description</th>
749 </tr>
750 <tr>
751 <td><code>NKSP_NO_MESSAGE</code></td>
752 <td>
753 By default this condition is not set. By explicitly enabling this
754 condition with <code>SET_CONDITION(NKSP_NO_MESSAGE)</code> it
755 causes all subsequent <code>message()</code> calls to be ignored
756 and filtered out on preprocessor level. See function <code>message()</code>
757 for details.
758 </td>
759 </tr>
760 </table>
761
762 </body>
763 </html>

  ViewVC Help
Powered by ViewVC