/[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 2936 by schoenebeck, Sun Jul 10 14:44:04 2016 UTC revision 3075 by schoenebeck, Thu Jan 5 16:36:16 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 lang="nksp">message()</code></td>          <td><code lang="nksp">message()</code></td>
40          <td>Prints text to the sampler's terminal.</td>          <td>Prints text to the sampler's terminal.</td>
41        </tr>        </tr>
# Line 40  Line 48 
48          <td>Pauses execution for a certain amount of time.</td>          <td>Pauses execution for a certain amount of time.</td>
49        </tr>        </tr>
50        <tr>        <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>          <td><code>abs()</code></td>
56          <td>Calculates the absolute value of a given value.</td>          <td>Calculates the absolute value of a given value.</td>
57        </tr>        </tr>
# Line 48  Line 60 
60          <td>Random number generator.</td>          <td>Random number generator.</td>
61        </tr>        </tr>
62        <tr>        <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>          <td><code>num_elements()</code></td>
72          <td>Returns the size of the requested array variable.</td>          <td>Returns the size of the requested array variable.</td>
73        </tr>        </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>      </table>
83            
84      <h3>Common Sampler Functions</h3>      <h3>Common Sampler Functions</h3>
# Line 87  Line 115 
115          <td>Changes filter resonance of voices.</td>          <td>Changes filter resonance of voices.</td>
116        </tr>        </tr>
117        <tr>        <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>          <td><code>event_status()</code></td>
131          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
132        </tr>        </tr>
# Line 140  Line 180 
180        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
181        NKSP realt-time instrument script language.        NKSP realt-time instrument script language.
182      </p>      </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>      <h3>Common Sampler Variables</h3>
309      <p>      <p>
310        Basic sampler related built-in variables and constants, independent from a        Basic sampler related built-in variables and constants, independent from a
# Line 151  Line 315 
315          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
316        </tr>        </tr>
317        <tr>        <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</code>. 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>          <td><code>$CC_NUM</code></td>
332          <td>MIDI controller number that caused the <code>controller</code>          <td>MIDI controller number that caused the <code>controller</code>
333              handler to be executed (only useful in the context of a              handler to be executed (only useful in the context of a
# Line 184  Line 361 
361              <code>note</code> or <code>release</code> handler).</td>              <code>note</code> or <code>release</code> handler).</td>
362        </tr>        </tr>
363        <tr>        <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>          <td><code>%KEY_DOWN[]</code></td>
377          <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
378              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
# Line 215  Line 404 
404          <td>Used to select one of the available 28 event groups.          <td>Used to select one of the available 28 event groups.
405          See <code>set_event_mark()</code> for details.</td>          See <code>set_event_mark()</code> for details.</td>
406        </tr>        </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>      </table>
420    
421      <h3>GigaStudio Format Variables</h3>      <h3>GigaStudio Format Variables</h3>
Legend:
Removed from v.2936  
changed lines
  Added in v.3075
  ViewVC Help
Powered by ViewVC