/[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 3074 - (show annotations) (download) (as text)
Thu Jan 5 16:18:19 2017 UTC (4 years, 5 months ago) by schoenebeck
File MIME type: text/html
File size: 23228 byte(s)
* NKSP reference: Added built-in array variable %ALL_EVENTS.

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 realt-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">dec()</code></td>
32 <td>Decrements the passed integer variable by one.</td>
33 </tr>
34 <tr>
35 <td><code>inc()</code></td>
36 <td>Increments the passed integer variable by one.</td>
37 </tr>
38 <tr>
39 <td><code lang="nksp">message()</code></td>
40 <td>Prints text to the sampler's terminal.</td>
41 </tr>
42 <tr>
43 <td><code>exit()</code></td>
44 <td>Stops execution of the current event handler instance.</td>
45 </tr>
46 <tr>
47 <td><code>wait()</code></td>
48 <td>Pauses execution for a certain amount of time.</td>
49 </tr>
50 <tr>
51 <td><code>stop_wait()</code></td>
52 <td>Resumes execution of a suspended script callback.</td>
53 </tr>
54 <tr>
55 <td><code>abs()</code></td>
56 <td>Calculates the absolute value of a given value.</td>
57 </tr>
58 <tr>
59 <td><code>random()</code></td>
60 <td>Random number generator.</td>
61 </tr>
62 <tr>
63 <td><code>min()</code></td>
64 <td>Calculates the minimum value of two given values.</td>
65 </tr>
66 <tr>
67 <td><code>max()</code></td>
68 <td>Calculates the maximum value of two given values.</td>
69 </tr>
70 <tr>
71 <td><code>num_elements()</code></td>
72 <td>Returns the size of the requested array variable.</td>
73 </tr>
74 <tr>
75 <td><code>sh_left()</code></td>
76 <td>Calculates a left bit shifted value.</td>
77 </tr>
78 <tr>
79 <td><code>sh_right()</code></td>
80 <td>Calculates a right bit shifted value.</td>
81 </tr>
82 </table>
83
84 <h3>Common Sampler Functions</h3>
85 <p>
86 Basic sampler related functions, independent from a particular sampler
87 format or sampler engine.
88 </p>
89 <table>
90 <tr>
91 <th>Function</th> <th>Description</th>
92 </tr>
93 <tr>
94 <td><code>play_note()</code></td>
95 <td>Triggers a new note.</td>
96 </tr>
97 <tr>
98 <td><code>change_pan()</code></td>
99 <td>Changes panning of voices (stereo balance).</td>
100 </tr>
101 <tr>
102 <td><code>change_tune()</code></td>
103 <td>Changes the tuning of voices.</td>
104 </tr>
105 <tr>
106 <td><code>change_vol()</code></td>
107 <td>Changes the volume of voices.</td>
108 </tr>
109 <tr>
110 <td><code>change_cutoff()</code></td>
111 <td>Changes filter cutoff frequency of voices.</td>
112 </tr>
113 <tr>
114 <td><code>change_reso()</code></td>
115 <td>Changes filter resonance of voices.</td>
116 </tr>
117 <tr>
118 <td><code>change_attack()</code></td>
119 <td>Modifies the attack time of voices.</td>
120 </tr>
121 <tr>
122 <td><code>change_decay()</code></td>
123 <td>Modifies the decay time of voices.</td>
124 </tr>
125 <tr>
126 <td><code>change_release()</code></td>
127 <td>Modifies the release time of voices.</td>
128 </tr>
129 <tr>
130 <td><code>event_status()</code></td>
131 <td>Checks and returns whether a particular note is still alive.</td>
132 </tr>
133 <tr>
134 <td><code>set_controller()</code></td>
135 <td>Creates a MIDI control change event.</td>
136 </tr>
137 <tr>
138 <td><code>ignore_event()</code></td>
139 <td>Drops the given event.</td>
140 </tr>
141 <tr>
142 <td><code>ignore_controller()</code></td>
143 <td>Drops the given MIDI control change event.</td>
144 </tr>
145 <tr>
146 <td><code>note_off()</code></td>
147 <td>Releases the requested note.</td>
148 </tr>
149 <tr>
150 <td><code>set_event_mark()</code></td>
151 <td>Adds an event to an event group.</td>
152 </tr>
153 <tr>
154 <td><code>delete_event_mark()</code></td>
155 <td>Removes an event from some event group.</td>
156 </tr>
157 <tr>
158 <td><code>by_marks()</code></td>
159 <td>Returns all events of an event group.</td>
160 </tr>
161 </table>
162
163 <h3>GigaStudio Format Functions</h3>
164 <p>
165 Sampler format specific functions, dedicated to the individual features
166 of the GigaStudio format engine.
167 </p>
168 <table>
169 <tr>
170 <th>Function</th> <th>Description</th>
171 </tr>
172 <tr>
173 <td><code>gig_set_dim_zone()</code></td>
174 <td>Changes the currently active dimension zone.</td>
175 </tr>
176 </table>
177
178 <h2>Built-In Variables</h2>
179 <p>
180 These are the built-in variables and built-in constants available with the
181 NKSP realt-time instrument script language.
182 </p>
183
184 <h3>Core Language Variables</h3>
185 <p>
186 Most fundamental NKSP built-in variables, independent from any purpose of
187 being used in a sampler.
188 </p>
189 <table>
190 <tr>
191 <th>Variable</th> <th>Description</th>
192 </tr>
193 <tr>
194 <td><code>$KSP_TIMER</code></td>
195 <td>Preserved for compatiblity reasons with KSP, returns the same value
196 as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
197 Note that KSP's <code>reset_ksp_timer()</code> function is not available with
198 NKSP. However when calculating time differences between two time
199 stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset
200 function is not required, because the underlying clock does not stop
201 when it reached its value limit (which happens every 71 minutes), instead the clock
202 will automatically restart from zero and the calculated time difference
203 even between such transitions will reflect correct durations.</td>
204 </tr>
205 <tr>
206 <td><code>$NKSP_PERF_TIMER</code></td>
207 <td>Returns the current performance time stamp (in microseconds) of the
208 script running. You may read this variable from time to time to take
209 time stamps which can be used to calculate the time difference
210 (in microseconds) which elapsed between them. A performance time
211 stamp is based on the script's actual CPU execution time. So the
212 internal clock which is used for generating such time stamps is only
213 running forward if the respective script is actually executed by the
214 CPU. Whenever your script is not really executed by the CPU (i.e. because
215 your script got suspended by a wait() call or got forcely suspended due to
216 real-time constraints, or when the entire sampler application got suspended
217 by the OS for other applications or OS tasks) then the underlying internal
218 clock is paused as well.
219 <note class="important">
220 You should only use this built-in variable for script development
221 purposes (i.e. for bench marking the performance of your script).
222 You should <b>not</b> use it with your final production sounds!
223 It is not appropriate for being used in a musical context, because
224 when an offline bounce is performed for instance, the musical timing
225 will be completely unrelated to the CPU execution time. Plus using
226 this variable may cause audio drop outs on some systems. In a musical
227 context you should use <code>$ENGINE_UPTIME</code> instead, which is
228 also safe for offline bounces.
229 </note>
230 <note>
231 On some systems <code>$NKSP_REAL_TIMER</code> and
232 <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
233 difference between them is not implemented for all systems at the moment.
234 </note>
235 </td>
236 </tr>
237 <tr>
238 <td><code>$NKSP_REAL_TIMER</code></td>
239 <td>Returns the current time stamp in reality (in microseconds). You may
240 read this variable from time to time to take
241 time stamps which can be used to calculate the time difference
242 (in microseconds) which elapsed between them. A "real" time
243 stamp is based on an internal clock which constantly proceeds, so this
244 internal clock also continues counting while your script is either suspended
245 (i.e. because your script got suspended by a wait() call or got forcely
246 suspended due to real-time constraints) and it also continues counting
247 even if the entire sampler application got suspended by the OS (i.e. to
248 execute other applications for multi-tasking or to perform OS tasks).
249 <note class="important">
250 You should only use this built-in variable for script development
251 purposes (i.e. for bench marking the performance of your script).
252 You should <b>not</b> use it with your final production sounds!
253 It is not appropriate for being used in a musical context, because
254 when an offline bounce is performed for instance, the musical timing
255 will be completely unrelated to the CPU execution time. Plus using
256 this variable may cause audio drop outs on some systems. In a musical
257 context you should use <code>$ENGINE_UPTIME</code> instead, which is
258 also safe for offline bounces.
259 </note>
260 <note>
261 On some systems <code>$NKSP_REAL_TIMER</code> and
262 <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
263 difference between them is not implemented for all systems at the moment.
264 </note>
265 </td>
266 </tr>
267 <tr>
268 <td><code>$NI_CALLBACK_ID</code></td>
269 <td>Reflects the current event handler instance's unique callback ID.
270 For the same event type there may be more than
271 one event handler instances running. Each one of them has
272 its own callback ID. You can get the current event handler
273 instance's callback ID by reading this built-in variable.</td>
274 </tr>
275 <tr>
276 <td><code>$NI_CALLBACK_TYPE</code></td>
277 <td>Reflects the event type of the current event handler. This variable
278 may reflect one of the following built-in constants:
279 <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
280 <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
281 </tr>
282 <tr>
283 <td><code>$NI_CB_TYPE_INIT</code></td>
284 <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
285 </tr>
286 <tr>
287 <td><code>$NI_CB_TYPE_NOTE</code></td>
288 <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
289 </tr>
290 <tr>
291 <td><code>$NI_CB_TYPE_RELEASE</code></td>
292 <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
293 </tr>
294 <tr>
295 <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
296 <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
297 </tr>
298 <tr>
299 <td><code>$NKSP_IGNORE_WAIT</code></td>
300 <td>If this boolean built-in variable is <code>1</code> then all calls of your
301 event handler instance to function <code>wait()</code> will be ignored.
302 This may for example be the case if another event handler instance
303 resumed your paused script by calling <code>stop_wait()</code> and
304 passing <code>1</code> to the 2nd argument of that function.</td>
305 </tr>
306 </table>
307
308 <h3>Common Sampler Variables</h3>
309 <p>
310 Basic sampler related built-in variables and constants, independent from a
311 particular sampler format or sampler engine.
312 </p>
313 <table>
314 <tr>
315 <th>Variable</th> <th>Description</th>
316 </tr>
317 <tr>
318 <td><code>%ALL_EVENTS</code></td>
319 <td>
320 Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
321 This may be passed to many built-in functions like <code>note_off()</code>.
322 <note>
323 In contrast to KSP this variable is an integer array type, whereas KSP's
324 pendent of this built-in variable is an integer constant (scalar) called
325 <code>$ALL_EVENTS<note>. Using the latter with NKSP will cause a
326 parser warning, the behavior will be the same though.
327 </note>
328 </td>
329 </tr>
330 <tr>
331 <td><code>$CC_NUM</code></td>
332 <td>MIDI controller number that caused the <code>controller</code>
333 handler to be executed (only useful in the context of a
334 <code>controller</code> handler).</td>
335 </tr>
336 <tr>
337 <td><code>%CC[]</code></td>
338 <td>Provides access to all current MIDI controller values. This can be
339 used in any context. Use the respective MIDI controller number as
340 index to this integer array variable. For instance <code>%CC[1]</code>
341 would give you the current value of the modulation wheel.
342 </td>
343 </tr>
344 <tr>
345 <td><code>$EVENT_ID</code></td>
346 <td>ID of the event that caused the current event handler to be executed. In
347 the context of a <code>note</code> handler this would be the event
348 ID of the note, within a <code>controller</code> handler it would
349 be the controller event ID, etc.</td>
350 </tr>
351 <tr>
352 <td><code>$EVENT_NOTE</code></td>
353 <td>MIDI note number that caused a note related
354 handler to be executed (only useful in the context of a
355 <code>note</code> or <code>release</code> handler).</td>
356 </tr>
357 <tr>
358 <td><code>$EVENT_VELOCITY</code></td>
359 <td>MIDI velocity value of the note that caused that note related
360 handler to be executed (only useful in the context of a
361 <code>note</code> or <code>release</code> handler).</td>
362 </tr>
363 <tr>
364 <td><code>$EVENT_STATUS_INACTIVE</code></td>
365 <td>Constant bit flag used as possible return value by
366 <code>event_status()</code> in case the requested
367 note is not "alive".</td>
368 </tr>
369 <tr>
370 <td><code>$EVENT_STATUS_NOTE_QUEUE</code></td>
371 <td>Constant bit flag used as possible return value by
372 <code>event_status()</code> in case the requested
373 note is still "alive".</td>
374 </tr>
375 <tr>
376 <td><code>%KEY_DOWN[]</code></td>
377 <td>This can be used in any context to check whether a certain MIDI
378 key is currently pressed down. Use the respective MIDI note number
379 as index to this array variable (see also <code>event_status()</code>).</td>
380 </tr>
381 <tr>
382 <td><code>$VCC_MONO_AT</code></td>
383 <td>Constant identifying the MIDI monophonic aftertouch controller (also
384 called <i title="Amount of force on held-down key.">
385 MIDI channel pressure
386 </i>). This is somewhat different than in the MIDI standard. With
387 NKSP aftertouch is handled like an additional "regular" MIDI CC controller.
388 Therefore use
389 <code>%CC[$VCC_MONO_AT]</code> to obtain the current aftertouch value
390 in the context of a <code>controller</code> event handler.
391 </td>
392 </tr>
393 <tr>
394 <td><code>$VCC_PITCH_BEND</code></td>
395 <td>Constant identifying the pitch bend wheel controller.
396 This is somewhat different than in the MIDI standard. With
397 NKSP pitch bend is handled like an additional "regular" MIDI CC controller.
398 Therefore use
399 <code>%CC[$VCC_PITCH_BEND]</code> to obtain the current pitch bend wheel value
400 in the context of a <code>controller</code> event handler.</td>
401 </tr>
402 <tr>
403 <td><code>$MARK_1</code> to <code>$MARK_28</code></td>
404 <td>Used to select one of the available 28 event groups.
405 See <code>set_event_mark()</code> for details.</td>
406 </tr>
407 <tr>
408 <td><code>$ENGINE_UPTIME</code></td>
409 <td>Returns the current time stamp (in milliseconds) for being
410 used in a musical context. You may read this variable from time to time
411 to take time stamps which can be used to calculate the time difference
412 (in milliseconds) which elapsed between them. These timing values are
413 based on the internal sample rate and thus it can safely be used to
414 perform musical timing related tasks in your scripts. Especially
415 your script will also continue to behave correctly when an offline bounce
416 of a song is performed.
417 </td>
418 </tr>
419 </table>
420
421 <h3>GigaStudio Format Variables</h3>
422 <p>
423 Sampler format specific built-in variables and constants, dedicated to the
424 individual features of the GigaStudio format engine.
425 </p>
426 <table>
427 <tr>
428 <th>Variable</th> <th>Description</th>
429 </tr>
430 <tr>
431 <td><code>$GIG_DIM_CHANNEL</code></td>
432 <td>Constant that identifies the <i>stereo dimension</i>.</td>
433 </tr>
434 <tr>
435 <td><code>$GIG_DIM_LAYER</code></td>
436 <td>Constant that identifies the <i>layer dimension</i>.</td>
437 </tr>
438 <tr>
439 <td><code>$GIG_DIM_VELOCITY</code></td>
440 <td>Constant that identifies the <i>velocity dimension</i>.</td>
441 </tr>
442 <tr>
443 <td><code>$GIG_DIM_AFTERTOUCH</code></td>
444 <td>Constant that identifies the <i>aftertouch dimension</i>.</td>
445 </tr>
446 <tr>
447 <td><code>$GIG_DIM_RELEASE</code></td>
448 <td>Constant that identifies the <i>release trigger dimension</i>.</td>
449 </tr>
450 <tr>
451 <td><code>$GIG_DIM_KEYBOARD</code></td>
452 <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
453 </tr>
454 <tr>
455 <td><code>$GIG_DIM_ROUNDROBIN"</code></td>
456 <td>Constant that identifies the <i>round robin dimension</i>.</td>
457 </tr>
458 <tr>
459 <td><code>$GIG_DIM_RANDOM</code></td>
460 <td>Constant that identifies the <i>random dimension</i>.</td>
461 </tr>
462 <tr>
463 <td><code>$GIG_DIM_SMARTMIDI</code></td>
464 <td>Constant that identifies the <i>start MIDI dimension</i> (a.k.a iMIDI rules).</td>
465 </tr>
466 <tr>
467 <td><code>$GIG_DIM_ROUNDROBINKEY</code></td>
468 <td>Constant that identifies the <i>round robin key dimension</i>.</td>
469 </tr>
470 <tr>
471 <td><code>$GIG_DIM_MODWHEEL</code></td>
472 <td>Constant that identifies the <i>modulation wheel dimension</i>.</td>
473 </tr>
474 <tr>
475 <td><code>$GIG_DIM_SUSTAIN</code></td>
476 <td>Constant that identifies the <i>sustain pedal dimension</i> (a.k.a. hold pedal).</td>
477 </tr>
478 <tr>
479 <td><code>$GIG_DIM_PORTAMENTO</code></td>
480 <td>Constant that identifies the <i>portamento MIDI controller dimension</i>.</td>
481 </tr>
482 <tr>
483 <td><code>$GIG_DIM_SOSTENUTO</code></td>
484 <td>Constant that identifies the <i>sostenuto MIDI controller dimension</i>.</td>
485 </tr>
486 <tr>
487 <td><code>$GIG_DIM_SOFT</code></td>
488 <td>Constant that identifies the <i>soft pedal dimension</i>.</td>
489 </tr>
490 <tr>
491 <td><code>$GIG_DIM_BREATH</code></td>
492 <td>Constant that identifies the <i>breath controller dimension</i>.</td>
493 </tr>
494 <tr>
495 <td><code>$GIG_DIM_FOOT</code></td>
496 <td>Constant that identifies the <i>foot pedal dimension</i>.</td>
497 </tr>
498 <tr>
499 <td><code>$GIG_DIM_PORTAMENTOTIME</code></td>
500 <td>Constant that identifies the <i>portamento time controller dimension</i>.</td>
501 </tr>
502 <tr>
503 <td><code>$GIG_DIM_EFFECT1</code></td>
504 <td>Constant that identifies the <i>effect 1 MIDI controller dimension</i>.</td>
505 </tr>
506 <tr>
507 <td><code>$GIG_DIM_EFFECT2</code></td>
508 <td>Constant that identifies the <i>effect 2 MIDI controller dimension</i>.</td>
509 </tr>
510 <tr>
511 <td><code>$GIG_DIM_EFFECT1DEPTH</code></td>
512 <td>Constant that identifies the <i>effect 1 depth MIDI controller dimension</i>.</td>
513 </tr>
514 <tr>
515 <td><code>$GIG_DIM_EFFECT2DEPTH</code></td>
516 <td>Constant that identifies the <i>effect 2 depth MIDI controller dimension</i>.</td>
517 </tr>
518 <tr>
519 <td><code>$GIG_DIM_EFFECT3DEPTH</code></td>
520 <td>Constant that identifies the <i>effect 3 depth MIDI controller dimension</i>.</td>
521 </tr>
522 <tr>
523 <td><code>$GIG_DIM_EFFECT4DEPTH</code></td>
524 <td>Constant that identifies the <i>effect 4 depth MIDI controller dimension</i>.</td>
525 </tr>
526 <tr>
527 <td><code>$GIG_DIM_EFFECT5DEPTH</code></td>
528 <td>Constant that identifies the <i>effect 5 depth MIDI controller dimension</i>.</td>
529 </tr>
530 <tr>
531 <td><code>$GIG_DIM_GENPURPOSE1</code></td>
532 <td>Constant that identifies the <i>general purpose 1 MIDI controller dimension</i>.</td>
533 </tr>
534 <tr>
535 <td><code>$GIG_DIM_GENPURPOSE2</code></td>
536 <td>Constant that identifies the <i>general purpose 2 MIDI controller dimension</i>.</td>
537 </tr>
538 <tr>
539 <td><code>$GIG_DIM_GENPURPOSE3</code></td>
540 <td>Constant that identifies the <i>general purpose 3 MIDI controller dimension</i>.</td>
541 </tr>
542 <tr>
543 <td><code>$GIG_DIM_GENPURPOSE4</code></td>
544 <td>Constant that identifies the <i>general purpose 4 MIDI controller dimension</i>.</td>
545 </tr>
546 <tr>
547 <td><code>$GIG_DIM_GENPURPOSE5</code></td>
548 <td>Constant that identifies the <i>general purpose 5 MIDI controller dimension</i>.</td>
549 </tr>
550 <tr>
551 <td><code>$GIG_DIM_GENPURPOSE6</code></td>
552 <td>Constant that identifies the <i>general purpose 6 MIDI controller dimension</i>.</td>
553 </tr>
554 <tr>
555 <td><code>$GIG_DIM_GENPURPOSE7</code></td>
556 <td>Constant that identifies the <i>general purpose 7 MIDI controller dimension</i>.</td>
557 </tr>
558 <tr>
559 <td><code>$GIG_DIM_GENPURPOSE8</code></td>
560 <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>
561 </tr>
562 </table>
563
564 </body>
565 </html>

  ViewVC Help
Powered by ViewVC