/[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 2954 - (show annotations) (download) (as text)
Sat Jul 16 11:44:04 2016 UTC (6 years, 6 months ago) by schoenebeck
File MIME type: text/html
File size: 22111 byte(s)
* NKSP: Added built-in functions change_attack(), change_decay() and
  change_release().

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

  ViewVC Help
Powered by ViewVC