aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Hanspeter Portner <dev@open-music-kontrollers.ch>2017-05-16 23:11:02 +0200
committerGravatar Hanspeter Portner <dev@open-music-kontrollers.ch>2017-05-16 23:11:02 +0200
commit9e79635c0a66d2274a45ef903277f108fb9469d7 (patch)
tree10b38b56c1f717c73b172c5bfe860f3d1c3d4fd5
parenteca106992ab751466f2fd32710fe5b8e60fc502e (diff)
downloadmoony.lv2-9e79635c0a66d2274a45ef903277f108fb9469d7.zip
moony.lv2-9e79635c0a66d2274a45ef903277f108fb9469d7.tar.gz
moony.lv2-9e79635c0a66d2274a45ef903277f108fb9469d7.tar.bz2
moony.lv2-9e79635c0a66d2274a45ef903277f108fb9469d7.tar.xz
manual: small fixes.
-rw-r--r--VERSION2
-rw-r--r--manual/manual.html.in237
2 files changed, 121 insertions, 118 deletions
diff --git a/VERSION b/VERSION
index e50034b..57aa841 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-0.21.393
+0.21.395
diff --git a/manual/manual.html.in b/manual/manual.html.in
index 09db5e8..92ce642 100644
--- a/manual/manual.html.in
+++ b/manual/manual.html.in
@@ -353,9 +353,9 @@ pre {
<p>A scripting language seems to be ideal for these cases, where the user can write an event filter on a higher level of abstraction on-the-fly. The scripting language needs to be realtime safe, though, which restricts the choices dramatically.</p>
- <p>One such scripting language is Lua. It is small, fast, easily embeddable and realtime-safe if coupled to a realtime-safe memory allocator like TLSF.</p>
+ <p>One such scripting language is <a href="https://lua.org">Lua</a>. It is small, fast, easily embeddable and realtime-safe if coupled to a realtime-safe memory allocator like TLSF.</p>
- <p>The Moony plugins can handle LV2 control and atom event ports, only. They do not handle LV2 audio ports. They may eventually handle LV2 control-voltage ports in the future, though. Control port values are internally handled as simple floating point numbers, whereas the atom event ports build on top of the LV2 atom and atom forge C headers.</p>
+ <p>The Moony plugins can handle LV2 control and atom event ports, only. They do not handle LV2 audio ports. Control port values are internally handled as simple floating point numbers, whereas the atom event ports build on top of the LV2 <a href="http://lv2plug.in/doc/html/group__atom.html">atom</a> and <a href="http://lv2plug.in/doc/html/group__forge.html">atom forge</a> C headers.</p>
</div>
<div class="api-section">
@@ -617,8 +617,8 @@ end</code></pre>
Such a temporary serialized state can later be deserialized via
<a href="#callbacks-apply">apply</a>.</p>
- <p>The <b>stash</b> function is directly called before parsing and loading
- the new script code.</p>
+ <p>The <b>stash</b> function is directly called before switching to the new
+ script code.</p>
<dl>
<dt class="func">function stash(forge)</dt>
@@ -652,8 +652,8 @@ end</code></pre>
arbitrary state previously serialized by <a href="#callbacks-stash">stash</a>
can be deserialized from temporary memory.</p>
- <p>The <b>apply</b> function is directly called after parsing and loading
- the new script code.</p>
+ <p>The <b>apply</b> function is directly called after switching to the new
+ script code.</p>
<dl>
<dt class="func">function apply(atom)</dt>
@@ -761,6 +761,9 @@ end</code></pre>
but instead of deserializing from temporary memory after a script code reload,
<b>restore</b> deserializes from disk upon a state reload request issued by the host.</p>
+ <p>If defined, the function is called upon each code reload with the most recently
+ saved state directly after <b>apply</b> and before <b>once</b> or <b>run</b>.</p>
+
<dl>
<dt class="func">function restore(atom)</dt>
<dt>atom (userdata)</dt>
@@ -820,8 +823,8 @@ end</code></pre>
<p>Moony directly mirrors mapping and unmapping of the underlying low-level
implementation, but additionally caches every newly queried URI or URID
- for faster lookup inside script code. Cached URIs and URIDs are preserved
- across script code updates.</p>
+ for faster lookup inside script code. Cached URIs and URIDs are not preserved
+ across script code updates, though.</p>
</div>
<div class="api-section">
@@ -2679,12 +2682,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">atom.__tostring | tostring(atom)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">atom.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -2695,6 +2692,12 @@ end</code></pre>
<dt class="ret">(string)</dt>
<dd>raw byte string of atom body</dd>
</dl>
+
+ <dl>
+ <dt class="func">atom.__tostring | tostring(atom)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
</div>
<!-- Atom Primitive -->
@@ -2716,12 +2719,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">nil.__tostring | tostring(nil)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">nil.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -2733,6 +2730,12 @@ end</code></pre>
<dd>atom body as Lua nil</dd>
</dl>
+ <dl>
+ <dt class="func">nil.__tostring | tostring(nil)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
<pre><code data-ref="atom-nil">-- Atom Nil
-- serialize
@@ -2760,12 +2763,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">bool.__tostring | tostring(bool)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">bool.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -2777,6 +2774,12 @@ end</code></pre>
<dd>atom body as Lua boolean</dd>
</dl>
+ <dl>
+ <dt class="func">bool.__tostring | tostring(bool)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
<pre><code data-ref="atom-bool">-- Atom Bool
-- serialize
@@ -2805,12 +2808,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">int.__tostring | tostring(int)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">int.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -2822,6 +2819,12 @@ end</code></pre>
<dd>atom body as Lua integer</dd>
</dl>
+ <dl>
+ <dt class="func">int.__tostring | tostring(int)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
<pre><code data-ref="atom-int">-- Atom Int
-- serialize
@@ -2850,12 +2853,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">long.__tostring | tostring(long)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">long.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -2867,6 +2864,12 @@ end</code></pre>
<dd>atom body as Lua integer</dd>
</dl>
+ <dl>
+ <dt class="func">long.__tostring | tostring(long)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
<pre><code data-ref="atom-long">-- Atom Long
-- serialize
@@ -2895,12 +2898,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">float.__tostring | tostring(float)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">float.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -2912,6 +2909,12 @@ end</code></pre>
<dd>atom body as Lua number</dd>
</dl>
+ <dl>
+ <dt class="func">float.__tostring | tostring(float)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
<pre><code data-ref="atom-float">-- Atom Float
-- serialize
@@ -2940,12 +2943,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">double.__tostring | tostring(double)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">double.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -2957,6 +2954,12 @@ end</code></pre>
<dd>atom body as Lua number</dd>
</dl>
+ <dl>
+ <dt class="func">double.__tostring | tostring(double)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
<pre><code data-ref="atom-double">-- Atom Double
-- serialize
@@ -2985,12 +2988,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">urid.__tostring | tostring(urid)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">urid.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -3002,6 +2999,12 @@ end</code></pre>
<dd>atom body as Lua integer</dd>
</dl>
+ <dl>
+ <dt class="func">urid.__tostring | tostring(urid)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
<pre><code data-ref="atom-urid">-- Atom URID
local urid = Map['urn:uuid:6d82e244-ee66-403f-aea1-26b3d9823820#foo']
@@ -3033,12 +3036,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">uri.__tostring | tostring(uri)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">uri.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -3050,6 +3047,12 @@ end</code></pre>
<dd>atom body as Lua string</dd>
</dl>
+ <dl>
+ <dt class="func">uri.__tostring | tostring(uri)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
<pre><code data-ref="atom-uri">-- Atom URI
local uri = 'urn:uuid:022ec18a-0a02-4a19-ad7a-a10403a0c4c3#foo'
@@ -3081,12 +3084,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">string.__tostring | tostring(string)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">string.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -3098,6 +3095,12 @@ end</code></pre>
<dd>atom body as Lua string</dd>
</dl>
+ <dl>
+ <dt class="func">string.__tostring | tostring(string)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
<pre><code data-ref="atom-string">-- Atom String
local str = 'hello world'
@@ -3129,12 +3132,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">path.__tostring | tostring(path)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">path.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -3146,6 +3143,12 @@ end</code></pre>
<dd>atom body as Lua string</dd>
</dl>
+ <dl>
+ <dt class="func">path.__tostring | tostring(path)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
<pre><code data-ref="atom-path">-- Atom Path
local tmp = '/tmp/xyz'
@@ -3178,12 +3181,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">literal.__tostring | tostring(literal)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">literal.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -3208,6 +3205,12 @@ end</code></pre>
</dl>
<dl>
+ <dt class="func">literal.__tostring | tostring(literal)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
+ <dl>
<dt class="func">literal:unpack()</dt>
<dt class="ret">(string, integer, integer)</dt>
<dd>atom body as Lua string, URID of data type, URID of language</dd>
@@ -3255,12 +3258,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">chunk.__tostring | tostring(chunk)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">chunk.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -3273,6 +3270,12 @@ end</code></pre>
</dl>
<dl>
+ <dt class="func">chunk.__tostring | tostring(chunk)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
+ <dl>
<dt class="func">chunk:unpack(from=1, to=#chunk)</dt>
<dt>from (nil | integer)</dt>
<dd>start byte position to unpack from, defaults to 1</dd>
@@ -3333,12 +3336,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">midi.__tostring | tostring(midi)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">midi.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -3351,6 +3348,12 @@ end</code></pre>
</dl>
<dl>
+ <dt class="func">midi.__tostring | tostring(midi)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
+ <dl>
<dt class="func">midi:unpack(from=1, to=#midi)</dt>
<dt>from (nil | integer)</dt>
<dd>start byte position to unpack from, defaults to 1</dd>
@@ -3418,12 +3421,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">seq.__tostring | tostring(seq)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">seq.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -3436,6 +3433,12 @@ end</code></pre>
</dl>
<dl>
+ <dt class="func">seq.__tostring | tostring(seq)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
+ <dl>
<dt class="func">seq:foreach()</dt>
<dt class="ret">(integer | number, userdata)</dt>
<dd>iterates over all atom events returning frame or beat time and event atom.</dd>
@@ -3499,18 +3502,18 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">tup.__tostring | tostring(tup)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">tup.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
</dl>
<dl>
+ <dt class="func">tup.__tostring | tostring(tup)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
+ <dl>
<dt class="func">tup:unpack(from=1, to=#tup)</dt>
<dt>from (nil | integer)</dt>
<dd>start position to unpack from, defaults to 1</dd>
@@ -3579,12 +3582,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">obj.__tostring | tostring(obj)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">obj.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -3603,6 +3600,12 @@ end</code></pre>
</dl>
<dl>
+ <dt class="func">obj.__tostring | tostring(obj)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
+ <dl>
<dt class="func">obj:foreach()</dt>
<dt class="ret">(integer, userdata, integer)</dt>
<dd>iterates over all properties returning property key, atom and context.</dd>
@@ -3662,12 +3665,6 @@ end</code></pre>
</dl>
<dl>
- <dt class="attr">vec.__tostring | tostring(vec)</dt>
- <dt class="ret">(string)</dt>
- <dd>string representation of atom</dd>
- </dl>
-
- <dl>
<dt class="attr">vec.type</dt>
<dt class="ret">(integer)</dt>
<dd>URID of atom type</dd>
@@ -3686,6 +3683,12 @@ end</code></pre>
</dl>
<dl>
+ <dt class="func">vec.__tostring | tostring(vec)</dt>
+ <dt class="ret">(string)</dt>
+ <dd>string representation of atom</dd>
+ </dl>
+
+ <dl>
<dt class="func">vec:unpack(from=1, to=#vec)</dt>
<dt>from (nil | integer)</dt>
<dd>start position to unpack from, defaults to 1</dd>
@@ -4793,7 +4796,7 @@ assert(Lua.lang == ctx.lua.lang)</code></pre>
<div class="api-section">
<h1 id="license">License</h1>
- <p>Copyright &copy; 2015-2016 Hanspeter Portner
+ <p>Copyright &copy; 2015-2017 Hanspeter Portner
(<a href="mailto:dev@open-music-kontrollers.ch">dev@open-music-kontrollers.ch</a>)</p>
<p>This is free software: you can redistribute it and/or modify