/[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 2944 by schoenebeck, Wed Jul 13 16:52:58 2016 UTC revision 3362 by schoenebeck, Fri Oct 27 21:26:26 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 lang="nksp">abort()</code></td>
32            <td>Stops execution of a script callback.</td>
33          </tr>
34          <tr>
35            <td><code lang="nksp">array_equal()</code></td>
36            <td>Check whether two arrays are equal.</td>
37          </tr>
38          <tr>
39            <td><code>fork()</code></td>
40            <td>Creates new execution instances (threads).</td>
41          </tr>
42          <tr>
43            <td><code>callback_status()</code></td>
44            <td>Returns the current status of a callback (thread).</td>
45          </tr>
46          <tr>
47            <td><code lang="nksp">dec()</code></td>
48            <td>Decrements the passed integer variable by one.</td>
49          </tr>
50          <tr>
51            <td><code>inc()</code></td>
52            <td>Increments the passed integer variable by one.</td>
53          </tr>
54          <tr>
55            <td><code>in_range()</code></td>
56            <td>Checks whether a value is between two other values.</td>
57          </tr>
58          <tr>
59          <td><code lang="nksp">message()</code></td>          <td><code lang="nksp">message()</code></td>
60          <td>Prints text to the sampler's terminal.</td>          <td>Prints text to the sampler's terminal.</td>
61        </tr>        </tr>
62        <tr>        <tr>
63            <td><code>search()</code></td>
64            <td>Search for a certain value within an array.</td>
65          </tr>
66          <tr>
67            <td><code>sort()</code></td>
68            <td>Sort the given array.</td>
69          </tr>
70          <tr>
71          <td><code>exit()</code></td>          <td><code>exit()</code></td>
72          <td>Stops execution of the current event handler instance.</td>          <td>Stops execution of the current event handler instance.</td>
73        </tr>        </tr>
# Line 40  Line 76 
76          <td>Pauses execution for a certain amount of time.</td>          <td>Pauses execution for a certain amount of time.</td>
77        </tr>        </tr>
78        <tr>        <tr>
79            <td><code>stop_wait()</code></td>
80            <td>Resumes execution of a suspended script callback.</td>
81          </tr>
82          <tr>
83          <td><code>abs()</code></td>          <td><code>abs()</code></td>
84          <td>Calculates the absolute value of a given value.</td>          <td>Calculates the absolute value of a given value.</td>
85        </tr>        </tr>
# Line 48  Line 88 
88          <td>Random number generator.</td>          <td>Random number generator.</td>
89        </tr>        </tr>
90        <tr>        <tr>
91            <td><code>min()</code></td>
92            <td>Calculates the minimum value of two given values.</td>
93          </tr>
94          <tr>
95            <td><code>max()</code></td>
96            <td>Calculates the maximum value of two given values.</td>
97          </tr>
98          <tr>
99          <td><code>num_elements()</code></td>          <td><code>num_elements()</code></td>
100          <td>Returns the size of the requested array variable.</td>          <td>Returns the size of the requested array variable.</td>
101        </tr>        </tr>
102          <tr>
103            <td><code>sh_left()</code></td>
104            <td>Calculates a left bit shifted value.</td>
105          </tr>
106          <tr>
107            <td><code>sh_right()</code></td>
108            <td>Calculates a right bit shifted value.</td>
109          </tr>
110      </table>      </table>
111            
112      <h3>Common Sampler Functions</h3>      <h3>Common Sampler Functions</h3>
# Line 67  Line 123 
123          <td>Triggers a new note.</td>          <td>Triggers a new note.</td>
124        </tr>        </tr>
125        <tr>        <tr>
126            <td><code>change_note()</code></td>
127            <td>Change MIDI note number of note.</td>
128          </tr>
129          <tr>
130          <td><code>change_pan()</code></td>          <td><code>change_pan()</code></td>
131          <td>Changes panning of voices (stereo balance).</td>          <td>Changes panning of voices (stereo balance).</td>
132        </tr>        </tr>
133        <tr>        <tr>
134            <td><code>change_pan_time()</code></td>
135            <td>Changes the duration of panning (stereo balance) changes.</td>
136          </tr>
137          <tr>
138            <td><code>change_pan_curve()</code></td>
139            <td>Changes the curve type of panning (stereo balance) changes.</td>
140          </tr>
141          <tr>
142            <td><code>change_play_pos()</code></td>
143            <td>Change the sample playback position.</td>
144          </tr>
145          <tr>
146          <td><code>change_tune()</code></td>          <td><code>change_tune()</code></td>
147          <td>Changes the tuning of voices.</td>          <td>Changes the tuning of voices.</td>
148        </tr>        </tr>
149        <tr>        <tr>
150            <td><code>change_tune_time()</code></td>
151            <td>Changes the duration of tuning changes.</td>
152          </tr>
153          <tr>
154            <td><code>change_tune_curve()</code></td>
155            <td>Changes the curve type of tuning changes.</td>
156          </tr>
157          <tr>
158          <td><code>change_vol()</code></td>          <td><code>change_vol()</code></td>
159          <td>Changes the volume of voices.</td>          <td>Changes the volume of voices.</td>
160        </tr>        </tr>
161        <tr>        <tr>
162            <td><code>change_vol_time()</code></td>
163            <td>Changes the duration of volume changes.</td>
164          </tr>
165          <tr>
166            <td><code>change_vol_curve()</code></td>
167            <td>Changes the curve type of volume changes.</td>
168          </tr>
169          <tr>
170          <td><code>change_cutoff()</code></td>          <td><code>change_cutoff()</code></td>
171          <td>Changes filter cutoff frequency of voices.</td>          <td>Changes filter cutoff frequency of voices.</td>
172        </tr>        </tr>
# Line 87  Line 175 
175          <td>Changes filter resonance of voices.</td>          <td>Changes filter resonance of voices.</td>
176        </tr>        </tr>
177        <tr>        <tr>
178            <td><code>change_attack()</code></td>
179            <td>Modifies the amplitude attack time of voices.</td>
180          </tr>
181          <tr>
182            <td><code>change_decay()</code></td>
183            <td>Modifies the amplitude decay time of voices.</td>
184          </tr>
185          <tr>
186            <td><code>change_sustain()</code></td>
187            <td>Modifies the amplitude sustain level of voices.</td>
188          </tr>
189          <tr>
190            <td><code>change_release()</code></td>
191            <td>Modifies the amplitude release time of voices.</td>
192          </tr>
193    
194          <tr>
195            <td><code>change_cutoff_attack()</code></td>
196            <td>Modifies the filter cutoff attack time of voices.</td>
197          </tr>
198          <tr>
199            <td><code>change_cutoff_decay()</code></td>
200            <td>Modifies the filter cutoff decay time of voices.</td>
201          </tr>
202          <tr>
203            <td><code>change_cutoff_sustain()</code></td>
204            <td>Modifies the filter cutoff sustain level of voices.</td>
205          </tr>
206          <tr>
207            <td><code>change_cutoff_release()</code></td>
208            <td>Modifies the filter cutoff release time of voices.</td>
209          </tr>
210    
211          <tr>
212            <td><code>change_amp_lfo_depth()</code></td>
213            <td>Modifies the amplitude LFO depth.</td>
214          </tr>
215          <tr>
216            <td><code>change_amp_lfo_freq()</code></td>
217            <td>Modifies the amplitude LFO frequency.</td>
218          </tr>
219    
220          <tr>
221            <td><code>change_cutoff_lfo_depth()</code></td>
222            <td>Modifies the filter cutoff LFO depth.</td>
223          </tr>
224          <tr>
225            <td><code>change_cutoff_lfo_freq()</code></td>
226            <td>Modifies the filter cutoff LFO frequency.</td>
227          </tr>
228    
229          <tr>
230            <td><code>change_pitch_lfo_depth()</code></td>
231            <td>Modifies the pitch LFO depth.</td>
232          </tr>
233          <tr>
234            <td><code>change_pitch_lfo_freq()</code></td>
235            <td>Modifies the pitch LFO frequency.</td>
236          </tr>
237          <tr>
238            <td><code>change_velo()</code></td>
239            <td>Change MIDI velocity of note.</td>
240          </tr>
241          <tr>
242          <td><code>event_status()</code></td>          <td><code>event_status()</code></td>
243          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
244        </tr>        </tr>
245        <tr>        <tr>
246            <td><code>fade_in()</code></td>
247            <td>Fade the requested note in.</td>
248          </tr>
249          <tr>
250            <td><code>fade_out()</code></td>
251            <td>Fade the requested note out.</td>
252          </tr>
253          <tr>
254            <td><code>get_event_par()</code></td>
255            <td>Get the current value of a specific note parameter.</td>
256          </tr>
257          <tr>
258            <td><code>set_event_par()</code></td>
259            <td>Change the value of a specific note parameter.</td>
260          </tr>
261          <tr>
262          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
263          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
264        </tr>        </tr>
# Line 133  Line 301 
301          <td><code>gig_set_dim_zone()</code></td>          <td><code>gig_set_dim_zone()</code></td>
302          <td>Changes the currently active dimension zone.</td>          <td>Changes the currently active dimension zone.</td>
303        </tr>        </tr>
304          <tr>
305            <td><code>same_region()</code></td>
306            <td>Check whether two keys are mapped to the same region.</td>
307          </tr>
308      </table>      </table>
309    
310      <h2>Built-In Variables</h2>      <h2>Built-In Variables</h2>
# Line 151  Line 323 
323          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
324        </tr>        </tr>
325        <tr>        <tr>
326            <td><code>$CALLBACK_STATUS_QUEUE</code></td>
327            <td>Built-in constant reflecting the status of a callback to be
328                alive but suspended. See <code>callback_status()</code> for details.</td>
329          </tr>
330          <tr>
331            <td><code>$CALLBACK_STATUS_RUNNING</code></td>
332            <td>Built-in constant reflecting the status of a callback to be
333                alive and currently executing. See <code>callback_status()</code>
334                for details.</td>
335          </tr>
336          <tr>
337            <td><code>$CALLBACK_STATUS_TERMINATED</code></td>
338            <td>Built-in constant reflecting the status of a callback to be
339                not alive. See <code>callback_status()</code> for details.</td>
340          </tr>
341          <tr>
342          <td><code>$KSP_TIMER</code></td>          <td><code>$KSP_TIMER</code></td>
343          <td>Preserved for compatiblity reasons with KSP, returns the same value          <td>Preserved for compatiblity reasons with KSP, returns the same value
344             as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).             as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
# Line 195  Line 383 
383          </td>          </td>
384        </tr>        </tr>
385        <tr>        <tr>
386            <td><code>%NKSP_CALLBACK_CHILD_ID[]</code></td>
387            <td>
388              Reflects the callback IDs of all child threads which the current
389              script callback instance spawned by having called <code>fork()</code> before.
390              See the latter function for details about this array variable.
391            </td>
392          </tr>
393          <tr>
394            <td><code>$NKSP_CALLBACK_PARENT_ID</code></td>
395            <td>
396              If the current execution thread is a child thread spawned by a <code>fork()</code>
397              call before, then this variable reflects the callback ID of the parent
398              thread which created this child thread. Otherwise this variable is <code>0</code>.
399              See <code>fork()</code> for more details about this variable.
400            </td>
401          </tr>
402          <tr>
403          <td><code>$NKSP_REAL_TIMER</code></td>          <td><code>$NKSP_REAL_TIMER</code></td>
404          <td>Returns the current time stamp in reality (in microseconds). You may          <td>Returns the current time stamp in reality (in microseconds). You may
405              read this variable from time to time to take              read this variable from time to time to take
# Line 224  Line 429 
429              </note>              </note>
430          </td>          </td>
431        </tr>        </tr>
432          <tr>
433            <td><code>$NI_CALLBACK_ID</code></td>
434            <td>Reflects the current event handler instance's unique callback ID.
435                For the same event type there may be more than
436                one event handler instances running. Each one of them has
437                its own callback ID. You can get the current event handler
438                instance's callback ID by reading this built-in variable.</td>
439          </tr>
440          <tr>
441            <td><code>$NI_CALLBACK_TYPE</code></td>
442            <td>Reflects the event type of the current event handler. This variable
443                may reflect one of the following built-in constants:
444                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
445                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
446          </tr>
447          <tr>
448            <td><code>$NI_CB_TYPE_INIT</code></td>
449            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
450          </tr>
451          <tr>
452            <td><code>$NI_CB_TYPE_NOTE</code></td>
453            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
454          </tr>
455          <tr>
456            <td><code>$NI_CB_TYPE_RELEASE</code></td>
457            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
458          </tr>
459          <tr>
460            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
461            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
462          </tr>
463          <tr>
464            <td><code>$NKSP_IGNORE_WAIT</code></td>
465            <td>If this boolean built-in variable is <code>1</code> then all calls of your
466                event handler instance to function <code>wait()</code> will be ignored.
467                This may for example be the case if another event handler instance
468                resumed your paused script by calling <code>stop_wait()</code> and
469                passing <code>1</code> to the 2nd argument of that function.</td>
470          </tr>
471      </table>      </table>
472    
473      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
# Line 236  Line 480 
480          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
481        </tr>        </tr>
482        <tr>        <tr>
483            <td><code>%ALL_EVENTS</code></td>
484            <td>
485              Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
486              This may be passed to many built-in functions like <code>note_off()</code>.
487              This array variable only contains IDs of notes which were launched due
488              to MIDI note-on events. This variable does not contain IDs of child notes
489              (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
490              <note>
491                In contrast to KSP this variable is an integer array type, whereas KSP's
492                pendent of this built-in variable is an integer constant (scalar) called
493                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
494                parser warning, the behavior will be the same though.
495              </note>
496            </td>
497          </tr>
498          <tr>
499          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
500          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
501              handler to be executed (only useful in the context of a              handler to be executed (only useful in the context of a
# Line 281  Line 541 
541              note is still "alive".</td>              note is still "alive".</td>
542        </tr>        </tr>
543        <tr>        <tr>
544            <td><code>$EVENT_PAR_NOTE</code></td>
545            <td>Constant value symbolizing the "note number" parameter. See
546                <code>get_event_par()</code> and <code>set_event_par()</code>
547                for details.</td>
548          </tr>
549          <tr>
550            <td><code>$EVENT_PAR_TUNE</code></td>
551            <td>Constant value symbolizing the "tune" parameter. See
552                <code>get_event_par()</code> and <code>set_event_par()</code>
553                for details.</td>
554          </tr>
555          <tr>
556            <td><code>$EVENT_PAR_VELOCITY</code></td>
557            <td>Constant value symbolizing the "note velocity" parameter. See
558                <code>get_event_par()</code> and <code>set_event_par()</code>
559                for details.</td>
560          </tr>
561          <tr>
562            <td><code>$EVENT_PAR_VOLUME</code></td>
563            <td>Constant value symbolizing the "volume" parameter. See
564                <code>get_event_par()</code> and <code>set_event_par()</code>
565                for details.</td>
566          </tr>
567          <tr>
568            <td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td>
569            <td>Four constant values symbolizing the 4 possible user specific
570                parameters, which i.e. might be used to pass data from one script
571                (slot) to another script (slot). See  <code>get_event_par()</code>
572                and <code>set_event_par()</code> for details.</td>
573          </tr>
574          <tr>
575          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
576          <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
577              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
578              as index to this array variable (see also <code>event_status()</code>).</td>              as index to this array variable (see also <code>event_status()</code>).</td>
579        </tr>        </tr>
580        <tr>        <tr>
581            <td><code>$NKSP_EASE_IN_EASE_OUT</code></td>
582            <td>Used to select a fade curve with "ease in and ease out" shape.</td>
583          </tr>
584          <tr>
585            <td><code>$NKSP_LINEAR</code></td>
586            <td>Used to select a fade curve with linear shape.</td>
587          </tr>
588          <tr>
589          <td><code>$VCC_MONO_AT</code></td>          <td><code>$VCC_MONO_AT</code></td>
590          <td>Constant identifying the MIDI monophonic aftertouch controller (also          <td>Constant identifying the MIDI monophonic aftertouch controller (also
591              called <i title="Amount of force on held-down key.">              called <i title="Amount of force on held-down key.">
# Line 360  Line 659 
659          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
660        </tr>        </tr>
661        <tr>        <tr>
662          <td><code>$GIG_DIM_ROUNDROBIN"</code></td>          <td><code>$GIG_DIM_ROUNDROBIN</code></td>
663          <td>Constant that identifies the <i>round robin dimension</i>.</td>          <td>Constant that identifies the <i>round robin dimension</i>.</td>
664        </tr>        </tr>
665        <tr>        <tr>
# Line 468  Line 767 
767          <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>          <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>
768        </tr>        </tr>
769      </table>      </table>
770    
771            <h2>Built-In Preprocessor Conditions</h2>
772        <p>
773          These are the built-in preprocessor conditions available with the NKSP realt-time
774          instrument script language.
775        </p>
776            
777        <h3>Core Language Preprocessor Conditions</h3>
778        <p>
779          Most fundamental NKSP built-in preprocessor conditions, independent from
780          any purpose of being used in a sampler.
781        </p>
782        <table>
783          <tr>
784            <th>Condition</th> <th>Description</th>
785          </tr>
786          <tr>
787            <td><code>NKSP_NO_MESSAGE</code></td>
788            <td>
789              By default this condition is not set. By explicitly enabling this
790              condition with <code>SET_CONDITION(NKSP_NO_MESSAGE)</code> it
791              causes all subsequent <code>message()</code> calls to be ignored
792              and filtered out on preprocessor level. See function <code>message()</code>
793              for details.
794            </td>
795          </tr>
796        </table>
797    
798    </body>    </body>
799  </html>  </html>
Legend:
Removed from v.2944  
changed lines
  Added in v.3362
  ViewVC Help
Powered by ViewVC