/[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 3603 - (show annotations) (download) (as text)
Tue Sep 17 17:21:13 2019 UTC (6 months, 2 weeks ago) by schoenebeck
File MIME type: text/html
File size: 34573 byte(s)
Introducing first auto links.

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

  ViewVC Help
Powered by ViewVC