/[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 3312 - (show annotations) (download) (as text)
Sat Jul 15 17:04:05 2017 UTC (4 months ago) by schoenebeck
File MIME type: text/html
File size: 30439 byte(s)
* NKSP: Updated docs for built-in preprocessor condition "NKSP_NO_MESSAGE".

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

  ViewVC Help
Powered by ViewVC