path: root/lv2/worker/worker.ttl
diff options
authorDavid Robillard <d@drobilla.net>2020-03-22 16:36:44 +0100
committerDavid Robillard <d@drobilla.net>2020-04-10 19:46:04 +0200
commit430284545345539c9ffb31df889debac1d3888b5 (patch)
treedc9bb1f32f0d6fe34a7339221389048e199f14a5 /lv2/worker/worker.ttl
parentc4514483da1ab4f49148f9c4fe4ff5b559323217 (diff)
Move documentation to metadata files and convert it to Markdown
Diffstat (limited to 'lv2/worker/worker.ttl')
1 files changed, 7 insertions, 37 deletions
diff --git a/lv2/worker/worker.ttl b/lv2/worker/worker.ttl
index 3889877..30976a7 100644
--- a/lv2/worker/worker.ttl
+++ b/lv2/worker/worker.ttl
@@ -8,48 +8,18 @@
a owl:Ontology ,
lv2:Specification ;
+ rdfs:label "LV2 Worker" ;
+ rdfs:comment "Support for doing non-realtime work in plugins." ;
rdfs:seeAlso <worker.h> ,
- <worker.meta.ttl> ;
- lv2:documentation """
-<p>This extension allows plugins to schedule work that must be performed in
-another thread. Plugins can use this interface to safely perform work that is
-not real-time safe, and receive the result in the run context. The details of
-threading are managed by the host, allowing plugins to be simple and portable
-while using resources more efficiently.</p>
-<p>This interface is designed to gracefully support single-threaded synchronous
-execution, which allows the same code to work with sample accuracy for offline
-rendering. For example, a sampler plugin may schedule a sample to be loaded
-from disk in another thread. During live execution, the host will call the
-plugin's work method from another thread, and deliver the result to the audio
-thread when it is finished. However, during offline export, the
-<q>scheduled</q> load would be executed immediately in the same thread. This
-enables reproducible offline rendering, where any changes affect the output
-immediately regardless of how long the work takes to execute.</p>
-""" .
+ <worker.meta.ttl> .
a lv2:ExtensionData ;
- lv2:documentation """
-<p>The work interface provided by a plugin, LV2_Worker_Interface.</p>
-<pre class="turtle-code">
-@prefix work: &lt;http://lv2plug.in/ns/ext/worker#&gt; .
- a lv2:Plugin ;
- lv2:extensionData work:interface .
-""" .
+ rdfs:label "work interface" ;
+ rdfs:comment "The work interface provided by a plugin." .
a lv2:Feature ;
- lv2:documentation """
-<p>The work scheduling feature provided by a host, LV2_Worker_Schedule.</p>
-<p>If the host passes this feature to LV2_Descriptor::instantiate, the plugin
-MAY use it to schedule work in the audio thread, and MUST NOT call it in any
-other context. Hosts MAY pass this feature to other functions as well, in
-which case the plugin MAY use it to schedule work in the calling context. The
-plugin MUST NOT assume any relationship between different schedule
-features.</p> """ .
+ rdfs:label "work schedule" ;
+ rdfs:comment "The work scheduling feature provided by a host." .