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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2732 by schoenebeck, Sun Apr 26 20:54:00 2015 UTC revision 3265 by schoenebeck, Thu Jun 1 00:31:12 2017 UTC
# Line 15  Line 15 
15    
16      <h2>Built-In Functions</h2>      <h2>Built-In Functions</h2>
17      <p>      <p>
18        These are the built-in functions available with the NKSP realt-time        These are the built-in functions available with the NKSP real-time
19        instrument script language.        instrument script language.
20      </p>      </p>
21    
# Line 28  Line 28 
28          <th>Function</th> <th>Description</th>          <th>Function</th> <th>Description</th>
29        </tr>        </tr>
30        <tr>        <tr>
31          <td><code>message()</code></td>          <td><code lang="nksp">array_equal()</code></td>
32            <td>Check whether two arrays are equal.</td>
33          </tr>
34          <tr>
35            <td><code lang="nksp">dec()</code></td>
36            <td>Decrements the passed integer variable by one.</td>
37          </tr>
38          <tr>
39            <td><code>inc()</code></td>
40            <td>Increments the passed integer variable by one.</td>
41          </tr>
42          <tr>
43            <td><code>in_range()</code></td>
44            <td>Checks whether a value is between two other values.</td>
45          </tr>
46          <tr>
47            <td><code lang="nksp">message()</code></td>
48          <td>Prints text to the sampler's terminal.</td>          <td>Prints text to the sampler's terminal.</td>
49        </tr>        </tr>
50        <tr>        <tr>
51            <td><code>search()</code></td>
52            <td>Search for a certain value within an array.</td>
53          </tr>
54          <tr>
55            <td><code>sort()</code></td>
56            <td>Sort the given array.</td>
57          </tr>
58          <tr>
59          <td><code>exit()</code></td>          <td><code>exit()</code></td>
60          <td>Stops execution of the current event handler instance.</td>          <td>Stops execution of the current event handler instance.</td>
61        </tr>        </tr>
# Line 40  Line 64 
64          <td>Pauses execution for a certain amount of time.</td>          <td>Pauses execution for a certain amount of time.</td>
65        </tr>        </tr>
66        <tr>        <tr>
67            <td><code>stop_wait()</code></td>
68            <td>Resumes execution of a suspended script callback.</td>
69          </tr>
70          <tr>
71          <td><code>abs()</code></td>          <td><code>abs()</code></td>
72          <td>Calculates the absolute value of a given value.</td>          <td>Calculates the absolute value of a given value.</td>
73        </tr>        </tr>
# Line 48  Line 76 
76          <td>Random number generator.</td>          <td>Random number generator.</td>
77        </tr>        </tr>
78        <tr>        <tr>
79            <td><code>min()</code></td>
80            <td>Calculates the minimum value of two given values.</td>
81          </tr>
82          <tr>
83            <td><code>max()</code></td>
84            <td>Calculates the maximum value of two given values.</td>
85          </tr>
86          <tr>
87          <td><code>num_elements()</code></td>          <td><code>num_elements()</code></td>
88          <td>Returns the size of the requested array variable.</td>          <td>Returns the size of the requested array variable.</td>
89        </tr>        </tr>
90          <tr>
91            <td><code>sh_left()</code></td>
92            <td>Calculates a left bit shifted value.</td>
93          </tr>
94          <tr>
95            <td><code>sh_right()</code></td>
96            <td>Calculates a right bit shifted value.</td>
97          </tr>
98      </table>      </table>
99            
100      <h3>Common Sampler Functions</h3>      <h3>Common Sampler Functions</h3>
# Line 67  Line 111 
111          <td>Triggers a new note.</td>          <td>Triggers a new note.</td>
112        </tr>        </tr>
113        <tr>        <tr>
114            <td><code>change_note()</code></td>
115            <td>Change MIDI note number of note.</td>
116          </tr>
117          <tr>
118            <td><code>change_pan()</code></td>
119            <td>Changes panning of voices (stereo balance).</td>
120          </tr>
121          <tr>
122            <td><code>change_play_pos()</code></td>
123            <td>Change the sample playback position.</td>
124          </tr>
125          <tr>
126            <td><code>change_tune()</code></td>
127            <td>Changes the tuning of voices.</td>
128          </tr>
129          <tr>
130            <td><code>change_tune_time()</code></td>
131            <td>Changes the duration of tuning changes.</td>
132          </tr>
133          <tr>
134            <td><code>change_tune_curve()</code></td>
135            <td>Changes the curve type of tuning changes.</td>
136          </tr>
137          <tr>
138            <td><code>change_vol()</code></td>
139            <td>Changes the volume of voices.</td>
140          </tr>
141          <tr>
142            <td><code>change_vol_time()</code></td>
143            <td>Changes the duration of volume changes.</td>
144          </tr>
145          <tr>
146            <td><code>change_vol_curve()</code></td>
147            <td>Changes the curve type of volume changes.</td>
148          </tr>
149          <tr>
150            <td><code>change_cutoff()</code></td>
151            <td>Changes filter cutoff frequency of voices.</td>
152          </tr>
153          <tr>
154            <td><code>change_reso()</code></td>
155            <td>Changes filter resonance of voices.</td>
156          </tr>
157          <tr>
158            <td><code>change_attack()</code></td>
159            <td>Modifies the attack time of voices.</td>
160          </tr>
161          <tr>
162            <td><code>change_decay()</code></td>
163            <td>Modifies the decay time of voices.</td>
164          </tr>
165          <tr>
166            <td><code>change_release()</code></td>
167            <td>Modifies the release time of voices.</td>
168          </tr>
169          <tr>
170            <td><code>change_amp_lfo_depth()</code></td>
171            <td>Modifies the amplitude LFO depth.</td>
172          </tr>
173          <tr>
174            <td><code>change_amp_lfo_freq()</code></td>
175            <td>Modifies the amplitude LFO frequency.</td>
176          </tr>
177          <tr>
178            <td><code>change_pitch_lfo_depth()</code></td>
179            <td>Modifies the pitch LFO depth.</td>
180          </tr>
181          <tr>
182            <td><code>change_pitch_lfo_freq()</code></td>
183            <td>Modifies the pitch LFO frequency.</td>
184          </tr>
185          <tr>
186            <td><code>change_velo()</code></td>
187            <td>Change MIDI velocity of note.</td>
188          </tr>
189          <tr>
190            <td><code>event_status()</code></td>
191            <td>Checks and returns whether a particular note is still alive.</td>
192          </tr>
193          <tr>
194            <td><code>fade_in()</code></td>
195            <td>Fade the requested note in.</td>
196          </tr>
197          <tr>
198            <td><code>fade_out()</code></td>
199            <td>Fade the requested note out.</td>
200          </tr>
201          <tr>
202            <td><code>get_event_par()</code></td>
203            <td>Get the current value of a specific note parameter.</td>
204          </tr>
205          <tr>
206            <td><code>set_event_par()</code></td>
207            <td>Change the value of a specific note parameter.</td>
208          </tr>
209          <tr>
210          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
211          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
212        </tr>        </tr>
# Line 109  Line 249 
249          <td><code>gig_set_dim_zone()</code></td>          <td><code>gig_set_dim_zone()</code></td>
250          <td>Changes the currently active dimension zone.</td>          <td>Changes the currently active dimension zone.</td>
251        </tr>        </tr>
252          <tr>
253            <td><code>same_region()</code></td>
254            <td>Check whether two keys are mapped to the same region.</td>
255          </tr>
256      </table>      </table>
257    
258      <h2>Built-In Variables</h2>      <h2>Built-In Variables</h2>
# Line 116  Line 260 
260        These are the built-in variables and built-in constants available with the        These are the built-in variables and built-in constants available with the
261        NKSP realt-time instrument script language.        NKSP realt-time instrument script language.
262      </p>      </p>
263        
264        <h3>Core Language Variables</h3>
265        <p>
266          Most fundamental NKSP built-in variables, independent from any purpose of
267          being used in a sampler.
268        </p>
269        <table>
270          <tr>
271            <th>Variable</th> <th>Description</th>
272          </tr>
273          <tr>
274            <td><code>$KSP_TIMER</code></td>
275            <td>Preserved for compatiblity reasons with KSP, returns the same value
276               as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
277               Note that KSP's <code>reset_ksp_timer()</code> function is not available with
278               NKSP. However when calculating time differences between two time
279               stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset
280               function is not required, because the underlying clock does not stop
281               when it reached its value limit (which happens every 71 minutes), instead the clock
282               will automatically restart from zero and the calculated time difference
283               even between such transitions will reflect correct durations.</td>
284          </tr>
285          <tr>
286            <td><code>$NKSP_PERF_TIMER</code></td>
287            <td>Returns the current performance time stamp (in microseconds) of the
288                script running. You may read this variable from time to time to take
289                time stamps which can be used to calculate the time difference
290                (in microseconds) which elapsed between them. A performance time
291                stamp is based on the script's actual CPU execution time. So the
292                internal clock which is used for generating such time stamps is only
293                running forward if the respective script is actually executed by the
294                CPU. Whenever your script is not really executed by the CPU (i.e. because
295                your script got suspended by a wait() call or got forcely suspended due to
296                real-time constraints, or when the entire sampler application got suspended
297                by the OS for other applications or OS tasks) then the underlying internal
298                clock is paused as well.
299                <note class="important">
300                  You should only use this built-in variable for script development
301                  purposes (i.e. for bench marking the performance of your script).
302                  You should <b>not</b> use it with your final production sounds!
303                  It is not appropriate for being used in a musical context, because
304                  when an offline bounce is performed for instance, the musical timing
305                  will be completely unrelated to the CPU execution time. Plus using
306                  this variable may cause audio drop outs on some systems. In a musical
307                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
308                  also safe for offline bounces.
309                </note>
310                <note>
311                  On some systems <code>$NKSP_REAL_TIMER</code> and
312                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
313                  difference between them is not implemented for all systems at the moment.
314                </note>
315            </td>
316          </tr>
317          <tr>
318            <td><code>$NKSP_REAL_TIMER</code></td>
319            <td>Returns the current time stamp in reality (in microseconds). You may
320                read this variable from time to time to take
321                time stamps which can be used to calculate the time difference
322                (in microseconds) which elapsed between them. A "real" time
323                stamp is based on an internal clock which constantly proceeds, so this
324                internal clock also continues counting while your script is either suspended
325                (i.e. because your script got suspended by a wait() call or got forcely
326                suspended due to real-time constraints) and it also continues counting
327                even if the entire sampler application got suspended by the OS (i.e. to
328                execute other applications for multi-tasking or to perform OS tasks).
329                <note class="important">
330                  You should only use this built-in variable for script development
331                  purposes (i.e. for bench marking the performance of your script).
332                  You should <b>not</b> use it with your final production sounds!
333                  It is not appropriate for being used in a musical context, because
334                  when an offline bounce is performed for instance, the musical timing
335                  will be completely unrelated to the CPU execution time. Plus using
336                  this variable may cause audio drop outs on some systems. In a musical
337                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
338                  also safe for offline bounces.
339                </note>
340                <note>
341                  On some systems <code>$NKSP_REAL_TIMER</code> and
342                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
343                  difference between them is not implemented for all systems at the moment.
344                </note>
345            </td>
346          </tr>
347          <tr>
348            <td><code>$NI_CALLBACK_ID</code></td>
349            <td>Reflects the current event handler instance's unique callback ID.
350                For the same event type there may be more than
351                one event handler instances running. Each one of them has
352                its own callback ID. You can get the current event handler
353                instance's callback ID by reading this built-in variable.</td>
354          </tr>
355          <tr>
356            <td><code>$NI_CALLBACK_TYPE</code></td>
357            <td>Reflects the event type of the current event handler. This variable
358                may reflect one of the following built-in constants:
359                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
360                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
361          </tr>
362          <tr>
363            <td><code>$NI_CB_TYPE_INIT</code></td>
364            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
365          </tr>
366          <tr>
367            <td><code>$NI_CB_TYPE_NOTE</code></td>
368            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
369          </tr>
370          <tr>
371            <td><code>$NI_CB_TYPE_RELEASE</code></td>
372            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
373          </tr>
374          <tr>
375            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
376            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
377          </tr>
378          <tr>
379            <td><code>$NKSP_IGNORE_WAIT</code></td>
380            <td>If this boolean built-in variable is <code>1</code> then all calls of your
381                event handler instance to function <code>wait()</code> will be ignored.
382                This may for example be the case if another event handler instance
383                resumed your paused script by calling <code>stop_wait()</code> and
384                passing <code>1</code> to the 2nd argument of that function.</td>
385          </tr>
386        </table>
387    
388      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
389      <p>      <p>
390        Basic sampler related built-in variables and constants, independent from a        Basic sampler related built-in variables and constants, independent from a
# Line 127  Line 395 
395          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
396        </tr>        </tr>
397        <tr>        <tr>
398            <td><code>%ALL_EVENTS</code></td>
399            <td>
400              Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
401              This may be passed to many built-in functions like <code>note_off()</code>.
402              This array variable only contains IDs of notes which were launched due
403              to MIDI note-on events. This variable does not contain IDs of child notes
404              (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
405              <note>
406                In contrast to KSP this variable is an integer array type, whereas KSP's
407                pendent of this built-in variable is an integer constant (scalar) called
408                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
409                parser warning, the behavior will be the same though.
410              </note>
411            </td>
412          </tr>
413          <tr>
414          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
415          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
416              handler to be executed (only useful in the context of a              handler to be executed (only useful in the context of a
# Line 160  Line 444 
444              <code>note</code> or <code>release</code> handler).</td>              <code>note</code> or <code>release</code> handler).</td>
445        </tr>        </tr>
446        <tr>        <tr>
447            <td><code>$EVENT_STATUS_INACTIVE</code></td>
448            <td>Constant bit flag used as possible return value by
449                <code>event_status()</code> in case the requested
450                note is not "alive".</td>
451          </tr>
452          <tr>
453            <td><code>$EVENT_STATUS_NOTE_QUEUE</code></td>
454            <td>Constant bit flag used as possible return value by
455                <code>event_status()</code> in case the requested
456                note is still "alive".</td>
457          </tr>
458          <tr>
459            <td><code>$EVENT_PAR_NOTE</code></td>
460            <td>Constant value symbolizing the "note number" parameter. See
461                <code>get_event_par()</code> and <code>set_event_par()</code>
462                for details.</td>
463          </tr>
464          <tr>
465            <td><code>$EVENT_PAR_TUNE</code></td>
466            <td>Constant value symbolizing the "tune" parameter. See
467                <code>get_event_par()</code> and <code>set_event_par()</code>
468                for details.</td>
469          </tr>
470          <tr>
471            <td><code>$EVENT_PAR_VELOCITY</code></td>
472            <td>Constant value symbolizing the "note velocity" parameter. See
473                <code>get_event_par()</code> and <code>set_event_par()</code>
474                for details.</td>
475          </tr>
476          <tr>
477            <td><code>$EVENT_PAR_VOLUME</code></td>
478            <td>Constant value symbolizing the "volume" parameter. See
479                <code>get_event_par()</code> and <code>set_event_par()</code>
480                for details.</td>
481          </tr>
482          <tr>
483            <td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td>
484            <td>Four constant values symbolizing the 4 possible user specific
485                parameters, which i.e. might be used to pass data from one script
486                (slot) to another script (slot). See  <code>get_event_par()</code>
487                and <code>set_event_par()</code> for details.</td>
488          </tr>
489          <tr>
490          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
491          <td>This can be used in any context to check whether a certain MIDI          <td>This can be used in any context to check whether a certain MIDI
492              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
493              as index to this array variable.</td>              as index to this array variable (see also <code>event_status()</code>).</td>
494          </tr>
495          <tr>
496            <td><code>$NKSP_EASE_IN_EASE_OUT</code></td>
497            <td>Used to select a fade curve with "ease in and ease out" shape.</td>
498          </tr>
499          <tr>
500            <td><code>$NKSP_LINEAR</code></td>
501            <td>Used to select a fade curve with linear shape.</td>
502        </tr>        </tr>
503        <tr>        <tr>
504          <td><code>$VCC_MONO_AT</code></td>          <td><code>$VCC_MONO_AT</code></td>
# Line 183  Line 518 
518              This is somewhat different than in the MIDI standard. With              This is somewhat different than in the MIDI standard. With
519              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.
520              Therefore use              Therefore use
521              <code>%CC[$VCC_PITCH_BEND]</code> to obtain the current aftertouch value              <code>%CC[$VCC_PITCH_BEND]</code> to obtain the current pitch bend wheel value
522              in the context of a <code>controller</code> event handler.</td>              in the context of a <code>controller</code> event handler.</td>
523        </tr>        </tr>
524        <tr>        <tr>
# Line 191  Line 526 
526          <td>Used to select one of the available 28 event groups.          <td>Used to select one of the available 28 event groups.
527          See <code>set_event_mark()</code> for details.</td>          See <code>set_event_mark()</code> for details.</td>
528        </tr>        </tr>
529          <tr>
530            <td><code>$ENGINE_UPTIME</code></td>
531            <td>Returns the current time stamp (in milliseconds) for being
532                used in a musical context. You may read this variable from time to time
533                to take time stamps which can be used to calculate the time difference
534                (in milliseconds) which elapsed between them. These timing values are
535                based on the internal sample rate and thus it can safely be used to
536                perform musical timing related tasks in your scripts. Especially
537                your script will also continue to behave correctly when an offline bounce
538                of a song is performed.
539            </td>
540          </tr>
541      </table>      </table>
542    
543      <h3>GigaStudio Format Variables</h3>      <h3>GigaStudio Format Variables</h3>
# Line 227  Line 574 
574          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
575        </tr>        </tr>
576        <tr>        <tr>
577          <td><code>$GIG_DIM_ROUNDROBIN"</code></td>          <td><code>$GIG_DIM_ROUNDROBIN</code></td>
578          <td>Constant that identifies the <i>round robin dimension</i>.</td>          <td>Constant that identifies the <i>round robin dimension</i>.</td>
579        </tr>        </tr>
580        <tr>        <tr>
Legend:
Removed from v.2732  
changed lines
  Added in v.3265
  ViewVC Help
Powered by ViewVC