commit 15c673a5c1d36d8352b933a0bfc0d7d6b279559e
parent 78aa0e8c2fe285740431d2e443eb5743abc7ab10
Author: Alexandre Bique <bique.alexandre@gmail.com>
Date: Mon, 29 Dec 2014 13:37:42 +0100
More details for ramp events
Diffstat:
2 files changed, 29 insertions(+), 22 deletions(-)
diff --git a/spec.html b/spec.html
@@ -614,8 +614,8 @@ The data structure process regroup everything needed by the plugin:</p>
which can be:</p>
<table border="1" class="docutils">
<colgroup>
-<col width="27%" />
-<col width="73%" />
+<col width="31%" />
+<col width="69%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Status</th>
@@ -623,17 +623,20 @@ which can be:</p>
</tr>
</thead>
<tbody valign="top">
-<tr><td>CLAP_PROCESS_ERROR</td>
+<tr><td><tt class="docutils literal">CLAP_PROCESS_ERROR</tt></td>
<td>An error happened, and the buffers should be discarded</td>
</tr>
-<tr><td>CLAP_PROCESS_CONTINUE</td>
+<tr><td><tt class="docutils literal">CLAP_PROCESS_CONTINUE</tt></td>
<td>Succeed, the plugins wants to process the next block</td>
</tr>
-<tr><td>CLAP_PROCESS_STOP</td>
+<tr><td><tt class="docutils literal">CLAP_PROCESS_STOP</tt></td>
<td>Succeed, every voices terminated, wake me up on a new event</td>
</tr>
</tbody>
</table>
+<p>If <tt class="docutils literal">process()</tt> returns <tt class="docutils literal">CLAP_PROCESS_STOP</tt> and some parameters were ramping
+(see <tt class="docutils literal">CLAP_EVENT_PARAM_RAMP</tt> event), then the host must send a <tt class="docutils literal">CLAP_EVENT_PARAM_SET</tt>
+or <tt class="docutils literal">CLAP_EVENT_PARAM_RAMP</tt> for those parameters at the next call to process.</p>
<div class="section" id="audio-buffers">
<h3><a class="toc-backref" href="#id28">Audio buffers</a></h3>
<ul class="simple">
@@ -686,9 +689,10 @@ it can quickly figure which voice is playing the given key.</p>
<h4><a class="toc-backref" href="#id31">Parameters</a></h4>
<p>Parameters can be automated by the host using <tt class="docutils literal">CLAP_EVENT_PARAM_SET</tt> or
<tt class="docutils literal">CLAP_EVENT_PARAM_RAMP</tt>.</p>
-<p>When using <tt class="docutils literal">CLAP_EVENT_PARAM_RAMP</tt>, the value of the parameter has to be
-incremented by <tt class="docutils literal"><span class="pre">event->param.increment</span></tt> for each samples until an event
-<tt class="docutils literal">CLAP_EVENT_PARAM_SET</tt> or <tt class="docutils literal">CLAP_EVENT_PARAM_RAMP</tt> occur for this parameter.</p>
+<p>When using <tt class="docutils literal">CLAP_EVENT_PARAM_RAMP</tt>, the parameter is set to <tt class="docutils literal"><span class="pre">ev->param.value</span></tt>
+and has to be incremented by <tt class="docutils literal"><span class="pre">event->param.increment</span></tt> for each samples, except
+for the sample at <tt class="docutils literal"><span class="pre">ev->steady_time</span></tt>, until an event <tt class="docutils literal">CLAP_EVENT_PARAM_SET</tt> or
+<tt class="docutils literal">CLAP_EVENT_PARAM_RAMP</tt> occur for this parameter.</p>
</div>
</div>
</div>
@@ -1314,7 +1318,6 @@ big endian machine, it should load again successfully.</p>
<span class="k">struct</span> <span class="n">clap_event_midi</span> <span class="n">midi</span><span class="p">;</span>
<span class="k">struct</span> <span class="n">clap_event_control</span> <span class="n">control</span><span class="p">;</span>
<span class="k">struct</span> <span class="n">clap_event_latency</span> <span class="n">latency</span><span class="p">;</span>
- <span class="k">struct</span> <span class="n">clap_event_tempo</span> <span class="n">tempo</span><span class="p">;</span>
<span class="k">struct</span> <span class="n">clap_event_jump</span> <span class="n">jump</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">};</span>
diff --git a/spec.rst b/spec.rst
@@ -367,16 +367,19 @@ Once the processing is finished, the methods returns a process status
which can be:
-+-----------------------+-------------------------------------------------------------+
-| Status | Meaning |
-+=======================+=============================================================+
-| CLAP_PROCESS_ERROR | An error happened, and the buffers should be discarded |
-+-----------------------+-------------------------------------------------------------+
-| CLAP_PROCESS_CONTINUE | Succeed, the plugins wants to process the next block |
-+-----------------------+-------------------------------------------------------------+
-| CLAP_PROCESS_STOP | Succeed, every voices terminated, wake me up on a new event |
-+-----------------------+-------------------------------------------------------------+
-
++---------------------------+-------------------------------------------------------------+
+| Status | Meaning |
++===========================+=============================================================+
+| ``CLAP_PROCESS_ERROR`` | An error happened, and the buffers should be discarded |
++---------------------------+-------------------------------------------------------------+
+| ``CLAP_PROCESS_CONTINUE`` | Succeed, the plugins wants to process the next block |
++---------------------------+-------------------------------------------------------------+
+| ``CLAP_PROCESS_STOP`` | Succeed, every voices terminated, wake me up on a new event |
++---------------------------+-------------------------------------------------------------+
+
+If ``process()`` returns ``CLAP_PROCESS_STOP`` and some parameters were ramping
+(see ``CLAP_EVENT_PARAM_RAMP`` event), then the host must send a ``CLAP_EVENT_PARAM_SET``
+or ``CLAP_EVENT_PARAM_RAMP`` for those parameters at the next call to process.
Audio buffers
~~~~~~~~~~~~~
@@ -435,9 +438,10 @@ Parameters
Parameters can be automated by the host using ``CLAP_EVENT_PARAM_SET`` or
``CLAP_EVENT_PARAM_RAMP``.
-When using ``CLAP_EVENT_PARAM_RAMP``, the value of the parameter has to be
-incremented by ``event->param.increment`` for each samples until an event
-``CLAP_EVENT_PARAM_SET`` or ``CLAP_EVENT_PARAM_RAMP`` occur for this parameter.
+When using ``CLAP_EVENT_PARAM_RAMP``, the parameter is set to ``ev->param.value``
+and has to be incremented by ``event->param.increment`` for each samples, except
+for the sample at ``ev->steady_time``, until an event ``CLAP_EVENT_PARAM_SET`` or
+``CLAP_EVENT_PARAM_RAMP`` occur for this parameter.
Parameters
----------
