Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gesellkammer committed Nov 24, 2024
1 parent 0ca582a commit 67d7297
Show file tree
Hide file tree
Showing 7 changed files with 47 additions and 23 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Rendering in real-time using a render thread
if changed:k(kchan) == 1 then
println "Channel: %d", kchan + 1
endif
asig = {signal}
asig = pinker() * 0.2
outch kchan + 1, asig
endin
Expand Down Expand Up @@ -80,7 +80,7 @@ Render offline
if changed:k(kchan) == 1 then
println "Channel: %d", kchan + 1
endif
asig = {signal}
asig = pinker() * 0.2
outch kchan + 1, asig
endin
Expand Down
Binary file modified docs/_build/doctrees/csound7.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
3 changes: 3 additions & 0 deletions docs/_build/html/_modules/ctcsound7/api6.html
Original file line number Diff line number Diff line change
Expand Up @@ -2825,6 +2825,9 @@ <h1>Source code for ctcsound7.api6</h1><div class="highlight"><pre>
<span class="n">libcsound</span><span class="o">.</span><span class="n">csoundScoreEventAbsoluteAsync</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cs</span><span class="p">,</span> <span class="n">cchar</span><span class="p">(</span><span class="n">type_</span><span class="p">),</span> <span class="n">ptr</span><span class="p">,</span> <span class="n">numFields</span><span class="p">,</span> <span class="n">ct</span><span class="o">.</span><span class="n">c_double</span><span class="p">(</span><span class="n">timeOffset</span><span class="p">))</span></div>


<span class="k">def</span> <span class="nf">setEndMarker</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">time</span><span class="p">:</span> <span class="nb">float</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scoreEvent</span><span class="p">(</span><span class="s2">&quot;e&quot;</span><span class="p">,</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="n">time</span><span class="p">])</span>

<div class="viewcode-block" id="Csound.inputMessage">
<a class="viewcode-back" href="../../csound6.html#ctcsound7.api6.Csound.inputMessage">[docs]</a>
<span class="k">def</span> <span class="nf">inputMessage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
Expand Down
38 changes: 22 additions & 16 deletions docs/_build/html/_modules/ctcsound7/api7.html
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,8 @@ <h1>Source code for ctcsound7.api7</h1><div class="highlight"><pre>
<span class="n">DRAWGRAPHFUNC</span> <span class="o">=</span> <span class="n">ct</span><span class="o">.</span><span class="n">CFUNCTYPE</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ct</span><span class="o">.</span><span class="n">c_void_p</span><span class="p">,</span> <span class="n">ct</span><span class="o">.</span><span class="n">POINTER</span><span class="p">(</span><span class="n">Windat</span><span class="p">))</span>
<span class="n">KILLGRAPHFUNC</span> <span class="o">=</span> <span class="n">ct</span><span class="o">.</span><span class="n">CFUNCTYPE</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ct</span><span class="o">.</span><span class="n">c_void_p</span><span class="p">,</span> <span class="n">ct</span><span class="o">.</span><span class="n">POINTER</span><span class="p">(</span><span class="n">Windat</span><span class="p">))</span>
<span class="n">EXITGRAPHFUNC</span> <span class="o">=</span> <span class="n">ct</span><span class="o">.</span><span class="n">CFUNCTYPE</span><span class="p">(</span><span class="n">ct</span><span class="o">.</span><span class="n">c_int32</span><span class="p">,</span> <span class="n">ct</span><span class="o">.</span><span class="n">c_void_p</span><span class="p">)</span>
<span class="n">CSOUNDPERFTHREAD_p</span> <span class="o">=</span> <span class="n">ct</span><span class="o">.</span><span class="n">c_void_p</span>
<span class="n">PROCESSFUNC</span> <span class="o">=</span> <span class="n">ct</span><span class="o">.</span><span class="n">CFUNCTYPE</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ct</span><span class="o">.</span><span class="n">c_void_p</span><span class="p">)</span>


<span class="k">def</span> <span class="nf">_declareAPI</span><span class="p">(</span><span class="n">libcsound</span><span class="p">,</span> <span class="n">libcspt</span><span class="p">):</span>
Expand Down Expand Up @@ -2267,7 +2269,7 @@ <h1>Source code for ctcsound7.api7</h1><div class="highlight"><pre>

<div class="viewcode-block" id="Csound.event">
<a class="viewcode-back" href="../../csound7.html#ctcsound7.api7.Csound.event">[docs]</a>
<span class="k">def</span> <span class="nf">event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">kind</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">pfields</span><span class="p">:</span> <span class="n">_t</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">|</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">block</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">kind</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">pfields</span><span class="p">:</span> <span class="n">_t</span><span class="o">.</span><span class="n">Sequence</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">|</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">block</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Send a new event.</span>

Expand All @@ -2277,16 +2279,16 @@ <h1>Source code for ctcsound7.api7</h1><div class="highlight"><pre>
<span class="sd"> block: if True, the operation is blocking. Otherwise it is</span>
<span class="sd"> performed asynchronously</span>


<span class="sd"> .. note:: this method does not exist in csound 6. For backwards compatibility</span>
<span class="sd"> use :meth:`Csound.scoreEvent` or :meth:`Csound.scoreEventAsync`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">eventtype</span> <span class="o">=</span> <span class="n">_scoreEventToTypenum</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">kind</span><span class="p">)</span>
<span class="k">if</span> <span class="n">eventtype</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Invalid event kind, get </span><span class="si">{</span><span class="n">kind</span><span class="si">}</span><span class="s2">, expected one of </span><span class="si">{</span><span class="n">_scoreEventToTypenum</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">pfields</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">MYFLT</span><span class="p">)</span>
<span class="n">ptr</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">ctypes</span><span class="o">.</span><span class="n">data_as</span><span class="p">(</span><span class="n">ct</span><span class="o">.</span><span class="n">POINTER</span><span class="p">(</span><span class="n">MYFLT</span><span class="p">))</span>
<span class="n">n_fields</span> <span class="o">=</span> <span class="n">ct</span><span class="o">.</span><span class="n">c_int32</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">size</span><span class="p">)</span>
<span class="n">libcsound</span><span class="o">.</span><span class="n">csoundEvent</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cs</span><span class="p">,</span> <span class="n">ct</span><span class="o">.</span><span class="n">c_int32</span><span class="p">(</span><span class="n">eventtype</span><span class="p">),</span> <span class="n">ptr</span><span class="p">,</span> <span class="n">n_fields</span><span class="p">,</span>
<span class="n">ct</span><span class="o">.</span><span class="n">c_int32</span><span class="p">(</span><span class="ow">not</span> <span class="n">block</span><span class="p">))</span></div>
<span class="n">libcsound</span><span class="o">.</span><span class="n">csoundEvent</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cs</span><span class="p">,</span> <span class="n">ct</span><span class="o">.</span><span class="n">c_int32</span><span class="p">(</span><span class="n">eventtype</span><span class="p">),</span> <span class="n">ptr</span><span class="p">,</span> <span class="n">n_fields</span><span class="p">,</span> <span class="n">ct</span><span class="o">.</span><span class="n">c_int32</span><span class="p">(</span><span class="ow">not</span> <span class="n">block</span><span class="p">))</span></div>


<div class="viewcode-block" id="Csound.scoreEvent">
Expand Down Expand Up @@ -2322,6 +2324,9 @@ <h1>Source code for ctcsound7.api7</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">event</span><span class="p">(</span><span class="n">kind</span><span class="o">=</span><span class="n">kind</span><span class="p">,</span> <span class="n">pfields</span><span class="o">=</span><span class="n">pfields</span><span class="p">,</span> <span class="n">block</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div>


<span class="k">def</span> <span class="nf">setEndMarker</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">time</span><span class="p">:</span> <span class="nb">float</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scoreEvent</span><span class="p">(</span><span class="s2">&quot;e&quot;</span><span class="p">,</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="n">time</span><span class="p">])</span>

<div class="viewcode-block" id="Csound.inputMessage">
<a class="viewcode-back" href="../../csound7.html#ctcsound7.api7.Csound.inputMessage">[docs]</a>
<span class="k">def</span> <span class="nf">inputMessage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
Expand Down Expand Up @@ -2476,8 +2481,13 @@ <h1>Source code for ctcsound7.api7</h1><div class="highlight"><pre>
<span class="k">def</span> <span class="nf">scoreTime</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Returns the current score time.</span>

<span class="sd"> Returns:</span>
<span class="sd"> current time, in seconds</span>

<span class="sd"> The return value is the time in seconds since the beginning of</span>
<span class="sd"> performance.</span>
<span class="sd"> performance. This can be used to schedule events at absolute times</span>

<span class="sd"> .. seealso:: :meth:`Csound.currentTimeSamples`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">libcsound</span><span class="o">.</span><span class="n">csoundGetScoreTime</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cs</span><span class="p">)</span></div>

Expand All @@ -2487,9 +2497,9 @@ <h1>Source code for ctcsound7.api7</h1><div class="highlight"><pre>
<span class="k">def</span> <span class="nf">isScorePending</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Tells whether Csound score events are performed or not.</span>

<span class="sd"> Independently of real-time MIDI events (see set_score_pending()).</span>
<span class="sd"> Independently of real-time MIDI events (see :py:meth:`setScorePending`).</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">libcsound</span><span class="o">.</span><span class="n">csoundIsScorePending</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cs</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">0</span></div>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">libcsound</span><span class="o">.</span><span class="n">csoundIsScorePending</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cs</span><span class="p">))</span></div>


<div class="viewcode-block" id="Csound.setScorePending">
Expand Down Expand Up @@ -2540,7 +2550,7 @@ <h1>Source code for ctcsound7.api7</h1><div class="highlight"><pre>
<span class="k">def</span> <span class="nf">rewindScore</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Rewinds a compiled Csound score.</span>

<span class="sd"> It is rewinded to the time specified with set_score_offset_seconds().</span>
<span class="sd"> It is rewinded to the time specified with :py:meth:`setScoreOffsetSeconds()`.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">libcsound</span><span class="o">.</span><span class="n">csoundRewindScore</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cs</span><span class="p">)</span></div>

Expand Down Expand Up @@ -2844,13 +2854,6 @@ <h1>Source code for ctcsound7.api7</h1><div class="highlight"><pre>





<span class="n">CSOUNDPERFTHREAD_p</span> <span class="o">=</span> <span class="n">ct</span><span class="o">.</span><span class="n">c_void_p</span>
<span class="n">PROCESSFUNC</span> <span class="o">=</span> <span class="n">ct</span><span class="o">.</span><span class="n">CFUNCTYPE</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">ct</span><span class="o">.</span><span class="n">c_void_p</span><span class="p">)</span>



<div class="viewcode-block" id="CsoundPerformanceThread">
<a class="viewcode-back" href="../../csound7.html#ctcsound7.api7.CsoundPerformanceThread">[docs]</a>
<span class="k">class</span> <span class="nc">CsoundPerformanceThread</span><span class="p">:</span>
Expand Down Expand Up @@ -3043,7 +3046,10 @@ <h1>Source code for ctcsound7.api7</h1><div class="highlight"><pre>
<span class="sd"> (pause, send score event, etc.)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">libcspt</span><span class="o">.</span><span class="n">csoundPerformanceThreadFlushMessageQueue</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cpt</span><span class="p">)</span></div>
</div>


<span class="k">def</span> <span class="nf">setEndMarker</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">time</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <span class="n">absolute</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">scoreEvent</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">absolute</span><span class="p">),</span> <span class="s2">&quot;e&quot;</span><span class="p">,</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="n">time</span><span class="p">])</span></div>



Expand Down
Loading

0 comments on commit 67d7297

Please sign in to comment.