/[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 2742 by schoenebeck, Wed Apr 29 00:22:59 2015 UTC revision 3121 by schoenebeck, Fri Apr 21 19:45:29 2017 UTC
# 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">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>in_range()</code></td>
40            <td>Checks whether a value is between two other values.</td>
41          </tr>
42          <tr>
43          <td><code lang="nksp">message()</code></td>          <td><code lang="nksp">message()</code></td>
44          <td>Prints text to the sampler's terminal.</td>          <td>Prints text to the sampler's terminal.</td>
45        </tr>        </tr>
# Line 40  Line 52 
52          <td>Pauses execution for a certain amount of time.</td>          <td>Pauses execution for a certain amount of time.</td>
53        </tr>        </tr>
54        <tr>        <tr>
55            <td><code>stop_wait()</code></td>
56            <td>Resumes execution of a suspended script callback.</td>
57          </tr>
58          <tr>
59          <td><code>abs()</code></td>          <td><code>abs()</code></td>
60          <td>Calculates the absolute value of a given value.</td>          <td>Calculates the absolute value of a given value.</td>
61        </tr>        </tr>
# Line 48  Line 64 
64          <td>Random number generator.</td>          <td>Random number generator.</td>
65        </tr>        </tr>
66        <tr>        <tr>
67            <td><code>min()</code></td>
68            <td>Calculates the minimum value of two given values.</td>
69          </tr>
70          <tr>
71            <td><code>max()</code></td>
72            <td>Calculates the maximum value of two given values.</td>
73          </tr>
74          <tr>
75          <td><code>num_elements()</code></td>          <td><code>num_elements()</code></td>
76          <td>Returns the size of the requested array variable.</td>          <td>Returns the size of the requested array variable.</td>
77        </tr>        </tr>
78          <tr>
79            <td><code>sh_left()</code></td>
80            <td>Calculates a left bit shifted value.</td>
81          </tr>
82          <tr>
83            <td><code>sh_right()</code></td>
84            <td>Calculates a right bit shifted value.</td>
85          </tr>
86      </table>      </table>
87            
88      <h3>Common Sampler Functions</h3>      <h3>Common Sampler Functions</h3>
# Line 67  Line 99 
99          <td>Triggers a new note.</td>          <td>Triggers a new note.</td>
100        </tr>        </tr>
101        <tr>        <tr>
102            <td><code>change_pan()</code></td>
103            <td>Changes panning of voices (stereo balance).</td>
104          </tr>
105          <tr>
106            <td><code>change_tune()</code></td>
107            <td>Changes the tuning of voices.</td>
108          </tr>
109          <tr>
110            <td><code>change_vol()</code></td>
111            <td>Changes the volume of voices.</td>
112          </tr>
113          <tr>
114            <td><code>change_cutoff()</code></td>
115            <td>Changes filter cutoff frequency of voices.</td>
116          </tr>
117          <tr>
118            <td><code>change_reso()</code></td>
119            <td>Changes filter resonance of voices.</td>
120          </tr>
121          <tr>
122            <td><code>change_attack()</code></td>
123            <td>Modifies the attack time of voices.</td>
124          </tr>
125          <tr>
126            <td><code>change_decay()</code></td>
127            <td>Modifies the decay time of voices.</td>
128          </tr>
129          <tr>
130            <td><code>change_release()</code></td>
131            <td>Modifies the release time of voices.</td>
132          </tr>
133          <tr>
134            <td><code>change_amp_lfo_depth()</code></td>
135            <td>Modifies the amplitude LFO depth.</td>
136          </tr>
137          <tr>
138            <td><code>change_amp_lfo_freq()</code></td>
139            <td>Modifies the amplitude LFO frequency.</td>
140          </tr>
141          <tr>
142            <td><code>change_pitch_lfo_depth()</code></td>
143            <td>Modifies the pitch LFO depth.</td>
144          </tr>
145          <tr>
146            <td><code>change_pitch_lfo_freq()</code></td>
147            <td>Modifies the pitch LFO frequency.</td>
148          </tr>
149          <tr>
150            <td><code>event_status()</code></td>
151            <td>Checks and returns whether a particular note is still alive.</td>
152          </tr>
153          <tr>
154          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
155          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
156        </tr>        </tr>
# Line 116  Line 200 
200        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
201        NKSP realt-time instrument script language.        NKSP realt-time instrument script language.
202      </p>      </p>
203        
204        <h3>Core Language Variables</h3>
205        <p>
206          Most fundamental NKSP built-in variables, independent from any purpose of
207          being used in a sampler.
208        </p>
209        <table>
210          <tr>
211            <th>Variable</th> <th>Description</th>
212          </tr>
213          <tr>
214            <td><code>$KSP_TIMER</code></td>
215            <td>Preserved for compatiblity reasons with KSP, returns the same value
216               as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
217               Note that KSP's <code>reset_ksp_timer()</code> function is not available with
218               NKSP. However when calculating time differences between two time
219               stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset
220               function is not required, because the underlying clock does not stop
221               when it reached its value limit (which happens every 71 minutes), instead the clock
222               will automatically restart from zero and the calculated time difference
223               even between such transitions will reflect correct durations.</td>
224          </tr>
225          <tr>
226            <td><code>$NKSP_PERF_TIMER</code></td>
227            <td>Returns the current performance time stamp (in microseconds) of the
228                script running. You may read this variable from time to time to take
229                time stamps which can be used to calculate the time difference
230                (in microseconds) which elapsed between them. A performance time
231                stamp is based on the script's actual CPU execution time. So the
232                internal clock which is used for generating such time stamps is only
233                running forward if the respective script is actually executed by the
234                CPU. Whenever your script is not really executed by the CPU (i.e. because
235                your script got suspended by a wait() call or got forcely suspended due to
236                real-time constraints, or when the entire sampler application got suspended
237                by the OS for other applications or OS tasks) then the underlying internal
238                clock is paused as well.
239                <note class="important">
240                  You should only use this built-in variable for script development
241                  purposes (i.e. for bench marking the performance of your script).
242                  You should <b>not</b> use it with your final production sounds!
243                  It is not appropriate for being used in a musical context, because
244                  when an offline bounce is performed for instance, the musical timing
245                  will be completely unrelated to the CPU execution time. Plus using
246                  this variable may cause audio drop outs on some systems. In a musical
247                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
248                  also safe for offline bounces.
249                </note>
250                <note>
251                  On some systems <code>$NKSP_REAL_TIMER</code> and
252                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
253                  difference between them is not implemented for all systems at the moment.
254                </note>
255            </td>
256          </tr>
257          <tr>
258            <td><code>$NKSP_REAL_TIMER</code></td>
259            <td>Returns the current time stamp in reality (in microseconds). You may
260                read this variable from time to time to take
261                time stamps which can be used to calculate the time difference
262                (in microseconds) which elapsed between them. A "real" time
263                stamp is based on an internal clock which constantly proceeds, so this
264                internal clock also continues counting while your script is either suspended
265                (i.e. because your script got suspended by a wait() call or got forcely
266                suspended due to real-time constraints) and it also continues counting
267                even if the entire sampler application got suspended by the OS (i.e. to
268                execute other applications for multi-tasking or to perform OS tasks).
269                <note class="important">
270                  You should only use this built-in variable for script development
271                  purposes (i.e. for bench marking the performance of your script).
272                  You should <b>not</b> use it with your final production sounds!
273                  It is not appropriate for being used in a musical context, because
274                  when an offline bounce is performed for instance, the musical timing
275                  will be completely unrelated to the CPU execution time. Plus using
276                  this variable may cause audio drop outs on some systems. In a musical
277                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
278                  also safe for offline bounces.
279                </note>
280                <note>
281                  On some systems <code>$NKSP_REAL_TIMER</code> and
282                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
283                  difference between them is not implemented for all systems at the moment.
284                </note>
285            </td>
286          </tr>
287          <tr>
288            <td><code>$NI_CALLBACK_ID</code></td>
289            <td>Reflects the current event handler instance's unique callback ID.
290                For the same event type there may be more than
291                one event handler instances running. Each one of them has
292                its own callback ID. You can get the current event handler
293                instance's callback ID by reading this built-in variable.</td>
294          </tr>
295          <tr>
296            <td><code>$NI_CALLBACK_TYPE</code></td>
297            <td>Reflects the event type of the current event handler. This variable
298                may reflect one of the following built-in constants:
299                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
300                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
301          </tr>
302          <tr>
303            <td><code>$NI_CB_TYPE_INIT</code></td>
304            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
305          </tr>
306          <tr>
307            <td><code>$NI_CB_TYPE_NOTE</code></td>
308            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
309          </tr>
310          <tr>
311            <td><code>$NI_CB_TYPE_RELEASE</code></td>
312            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
313          </tr>
314          <tr>
315            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
316            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
317          </tr>
318          <tr>
319            <td><code>$NKSP_IGNORE_WAIT</code></td>
320            <td>If this boolean built-in variable is <code>1</code> then all calls of your
321                event handler instance to function <code>wait()</code> will be ignored.
322                This may for example be the case if another event handler instance
323                resumed your paused script by calling <code>stop_wait()</code> and
324                passing <code>1</code> to the 2nd argument of that function.</td>
325          </tr>
326        </table>
327    
328      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
329      <p>      <p>
330        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 335 
335          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
336        </tr>        </tr>
337        <tr>        <tr>
338            <td><code>%ALL_EVENTS</code></td>
339            <td>
340              Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
341              This may be passed to many built-in functions like <code>note_off()</code>.
342              This array variable only contains IDs of notes which were launched due
343              to MIDI note-on events. This variable does not contain IDs of child notes
344              (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
345              <note>
346                In contrast to KSP this variable is an integer array type, whereas KSP's
347                pendent of this built-in variable is an integer constant (scalar) called
348                <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
349                parser warning, the behavior will be the same though.
350              </note>
351            </td>
352          </tr>
353          <tr>
354          <td><code>$CC_NUM</code></td>          <td><code>$CC_NUM</code></td>
355          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
356              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 384 
384              <code>note</code> or <code>release</code> handler).</td>              <code>note</code> or <code>release</code> handler).</td>
385        </tr>        </tr>
386        <tr>        <tr>
387            <td><code>$EVENT_STATUS_INACTIVE</code></td>
388            <td>Constant bit flag used as possible return value by
389                <code>event_status()</code> in case the requested
390                note is not "alive".</td>
391          </tr>
392          <tr>
393            <td><code>$EVENT_STATUS_NOTE_QUEUE</code></td>
394            <td>Constant bit flag used as possible return value by
395                <code>event_status()</code> in case the requested
396                note is still "alive".</td>
397          </tr>
398          <tr>
399          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
400          <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
401              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
402              as index to this array variable.</td>              as index to this array variable (see also <code>event_status()</code>).</td>
403        </tr>        </tr>
404        <tr>        <tr>
405          <td><code>$VCC_MONO_AT</code></td>          <td><code>$VCC_MONO_AT</code></td>
# Line 183  Line 419 
419              This is somewhat different than in the MIDI standard. With              This is somewhat different than in the MIDI standard. With
420              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.
421              Therefore use              Therefore use
422              <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
423              in the context of a <code>controller</code> event handler.</td>              in the context of a <code>controller</code> event handler.</td>
424        </tr>        </tr>
425        <tr>        <tr>
# Line 191  Line 427 
427          <td>Used to select one of the available 28 event groups.          <td>Used to select one of the available 28 event groups.
428          See <code>set_event_mark()</code> for details.</td>          See <code>set_event_mark()</code> for details.</td>
429        </tr>        </tr>
430          <tr>
431            <td><code>$ENGINE_UPTIME</code></td>
432            <td>Returns the current time stamp (in milliseconds) for being
433                used in a musical context. You may read this variable from time to time
434                to take time stamps which can be used to calculate the time difference
435                (in milliseconds) which elapsed between them. These timing values are
436                based on the internal sample rate and thus it can safely be used to
437                perform musical timing related tasks in your scripts. Especially
438                your script will also continue to behave correctly when an offline bounce
439                of a song is performed.
440            </td>
441          </tr>
442      </table>      </table>
443    
444      <h3>GigaStudio Format Variables</h3>      <h3>GigaStudio Format Variables</h3>
Legend:
Removed from v.2742  
changed lines
  Added in v.3121
  ViewVC Help
Powered by ViewVC