/[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 2949 by schoenebeck, Fri Jul 15 15:33:43 2016 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 67  Line 79 
79          <td>Triggers a new note.</td>          <td>Triggers a new note.</td>
80        </tr>        </tr>
81        <tr>        <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>event_status()</code></td>
103            <td>Checks and returns whether a particular note is still alive.</td>
104          </tr>
105          <tr>
106          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
107          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
108        </tr>        </tr>
# Line 116  Line 152 
152        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
153        NKSP realt-time instrument script language.        NKSP realt-time instrument script language.
154      </p>      </p>
155        
156        <h3>Core Language Variables</h3>
157        <p>
158          Most fundamental NKSP built-in variables, independent from any purpose of
159          being used in a sampler.
160        </p>
161        <table>
162          <tr>
163            <th>Variable</th> <th>Description</th>
164          </tr>
165          <tr>
166            <td><code>$KSP_TIMER</code></td>
167            <td>Preserved for compatiblity reasons with KSP, returns the same value
168               as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
169               Note that KSP's <code>reset_ksp_timer()</code> function is not available with
170               NKSP. However when calculating time differences between two time
171               stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset
172               function is not required, because the underlying clock does not stop
173               when it reached its value limit (which happens every 71 minutes), instead the clock
174               will automatically restart from zero and the calculated time difference
175               even between such transitions will reflect correct durations.</td>
176          </tr>
177          <tr>
178            <td><code>$NKSP_PERF_TIMER</code></td>
179            <td>Returns the current performance time stamp (in microseconds) of the
180                script running. You may read this variable from time to time to take
181                time stamps which can be used to calculate the time difference
182                (in microseconds) which elapsed between them. A performance time
183                stamp is based on the script's actual CPU execution time. So the
184                internal clock which is used for generating such time stamps is only
185                running forward if the respective script is actually executed by the
186                CPU. Whenever your script is not really executed by the CPU (i.e. because
187                your script got suspended by a wait() call or got forcely suspended due to
188                real-time constraints, or when the entire sampler application got suspended
189                by the OS for other applications or OS tasks) then the underlying internal
190                clock is paused as well.
191                <note class="important">
192                  You should only use this built-in variable for script development
193                  purposes (i.e. for bench marking the performance of your script).
194                  You should <b>not</b> use it with your final production sounds!
195                  It is not appropriate for being used in a musical context, because
196                  when an offline bounce is performed for instance, the musical timing
197                  will be completely unrelated to the CPU execution time. Plus using
198                  this variable may cause audio drop outs on some systems. In a musical
199                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
200                  also safe for offline bounces.
201                </note>
202                <note>
203                  On some systems <code>$NKSP_REAL_TIMER</code> and
204                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
205                  difference between them is not implemented for all systems at the moment.
206                </note>
207            </td>
208          </tr>
209          <tr>
210            <td><code>$NKSP_REAL_TIMER</code></td>
211            <td>Returns the current time stamp in reality (in microseconds). You may
212                read this variable from time to time to take
213                time stamps which can be used to calculate the time difference
214                (in microseconds) which elapsed between them. A "real" time
215                stamp is based on an internal clock which constantly proceeds, so this
216                internal clock also continues counting while your script is either suspended
217                (i.e. because your script got suspended by a wait() call or got forcely
218                suspended due to real-time constraints) and it also continues counting
219                even if the entire sampler application got suspended by the OS (i.e. to
220                execute other applications for multi-tasking or to perform OS tasks).
221                <note class="important">
222                  You should only use this built-in variable for script development
223                  purposes (i.e. for bench marking the performance of your script).
224                  You should <b>not</b> use it with your final production sounds!
225                  It is not appropriate for being used in a musical context, because
226                  when an offline bounce is performed for instance, the musical timing
227                  will be completely unrelated to the CPU execution time. Plus using
228                  this variable may cause audio drop outs on some systems. In a musical
229                  context you should use <code>$ENGINE_UPTIME</code> instead, which is
230                  also safe for offline bounces.
231                </note>
232                <note>
233                  On some systems <code>$NKSP_REAL_TIMER</code> and
234                  <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
235                  difference between them is not implemented for all systems at the moment.
236                </note>
237            </td>
238          </tr>
239          <tr>
240            <td><code>$NI_CALLBACK_ID</code></td>
241            <td>Reflects the current event handler instance's unique callback ID.
242                For the same event type there may be more than
243                one event handler instances running. Each one of them has
244                its own callback ID. You can get the current event handler
245                instance's callback ID by reading this built-in variable.</td>
246          </tr>
247          <tr>
248            <td><code>$NI_CALLBACK_TYPE</code></td>
249            <td>Reflects the event type of the current event handler. This variable
250                may reflect one of the following built-in constants:
251                <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
252                <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
253          </tr>
254          <tr>
255            <td><code>$NI_CB_TYPE_INIT</code></td>
256            <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
257          </tr>
258          <tr>
259            <td><code>$NI_CB_TYPE_NOTE</code></td>
260            <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
261          </tr>
262          <tr>
263            <td><code>$NI_CB_TYPE_RELEASE</code></td>
264            <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
265          </tr>
266          <tr>
267            <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
268            <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
269          </tr>
270          <tr>
271            <td><code>$NKSP_IGNORE_WAIT</code></td>
272            <td>If this boolean built-in variable is <code>1</code> then all calls of your
273                event handler instance to function <code>wait()</code> will be ignored.
274                This may for example be the case if another event handler instance
275                resumed your paused script by calling <code>stop_wait()</code> and
276                passing <code>1</code> to the 2nd argument of that function.</td>
277          </tr>
278        </table>
279    
280      <h3>Common Sampler Variables</h3>      <h3>Common Sampler Variables</h3>
281      <p>      <p>
282        Basic sampler related built-in variables and constants, independent from a        Basic sampler related built-in variables and constants, independent from a
# Line 160  Line 320 
320              <code>note</code> or <code>release</code> handler).</td>              <code>note</code> or <code>release</code> handler).</td>
321        </tr>        </tr>
322        <tr>        <tr>
323            <td><code>$EVENT_STATUS_INACTIVE</code></td>
324            <td>Constant bit flag used as possible return value by
325                <code>event_status()</code> in case the requested
326                note is not "alive".</td>
327          </tr>
328          <tr>
329            <td><code>$EVENT_STATUS_NOTE_QUEUE</code></td>
330            <td>Constant bit flag used as possible return value by
331                <code>event_status()</code> in case the requested
332                note is still "alive".</td>
333          </tr>
334          <tr>
335          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
336          <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
337              key is currently pressed down. Use the respective MIDI note number              key is currently pressed down. Use the respective MIDI note number
338              as index to this array variable.</td>              as index to this array variable (see also <code>event_status()</code>).</td>
339        </tr>        </tr>
340        <tr>        <tr>
341          <td><code>$VCC_MONO_AT</code></td>          <td><code>$VCC_MONO_AT</code></td>
# Line 183  Line 355 
355              This is somewhat different than in the MIDI standard. With              This is somewhat different than in the MIDI standard. With
356              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.              NKSP pitch bend is handled like an additional "regular" MIDI CC controller.
357              Therefore use              Therefore use
358              <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
359              in the context of a <code>controller</code> event handler.</td>              in the context of a <code>controller</code> event handler.</td>
360        </tr>        </tr>
361        <tr>        <tr>
# Line 191  Line 363 
363          <td>Used to select one of the available 28 event groups.          <td>Used to select one of the available 28 event groups.
364          See <code>set_event_mark()</code> for details.</td>          See <code>set_event_mark()</code> for details.</td>
365        </tr>        </tr>
366          <tr>
367            <td><code>$ENGINE_UPTIME</code></td>
368            <td>Returns the current time stamp (in milliseconds) for being
369                used in a musical context. You may read this variable from time to time
370                to take time stamps which can be used to calculate the time difference
371                (in milliseconds) which elapsed between them. These timing values are
372                based on the internal sample rate and thus it can safely be used to
373                perform musical timing related tasks in your scripts. Especially
374                your script will also continue to behave correctly when an offline bounce
375                of a song is performed.
376            </td>
377          </tr>
378      </table>      </table>
379    
380      <h3>GigaStudio Format Variables</h3>      <h3>GigaStudio Format Variables</h3>
Legend:
Removed from v.2742  
changed lines
  Added in v.2949
  ViewVC Help
Powered by ViewVC