From 3d8a2bef05f69eff154ad350db4be897f6d3edfa Mon Sep 17 00:00:00 2001 From: David Robillard Date: Thu, 9 Feb 2012 06:40:45 +0000 Subject: Add message extension. --- lv2/lv2plug.in/ns/ext/message/ext.pc.in | 1 + lv2/lv2plug.in/ns/ext/message/manifest.ttl | 9 + lv2/lv2plug.in/ns/ext/message/message.h | 47 ++++ lv2/lv2plug.in/ns/ext/message/message.ttl | 334 +++++++++++++++++++++++++++++ lv2/lv2plug.in/ns/ext/message/waf | 1 + lv2/lv2plug.in/ns/ext/message/wscript | 1 + 6 files changed, 393 insertions(+) create mode 120000 lv2/lv2plug.in/ns/ext/message/ext.pc.in create mode 100644 lv2/lv2plug.in/ns/ext/message/manifest.ttl create mode 100644 lv2/lv2plug.in/ns/ext/message/message.h create mode 100644 lv2/lv2plug.in/ns/ext/message/message.ttl create mode 120000 lv2/lv2plug.in/ns/ext/message/waf create mode 120000 lv2/lv2plug.in/ns/ext/message/wscript (limited to 'lv2/lv2plug.in') diff --git a/lv2/lv2plug.in/ns/ext/message/ext.pc.in b/lv2/lv2plug.in/ns/ext/message/ext.pc.in new file mode 120000 index 0000000..03dd044 --- /dev/null +++ b/lv2/lv2plug.in/ns/ext/message/ext.pc.in @@ -0,0 +1 @@ +../../../../../ext.pc.in \ No newline at end of file diff --git a/lv2/lv2plug.in/ns/ext/message/manifest.ttl b/lv2/lv2plug.in/ns/ext/message/manifest.ttl new file mode 100644 index 0000000..3708bd9 --- /dev/null +++ b/lv2/lv2plug.in/ns/ext/message/manifest.ttl @@ -0,0 +1,9 @@ +@prefix lv2: . +@prefix rdfs: . + + + a lv2:Specification ; + lv2:minorVersion 0 ; + lv2:microVersion 1 ; + rdfs:seeAlso . + diff --git a/lv2/lv2plug.in/ns/ext/message/message.h b/lv2/lv2plug.in/ns/ext/message/message.h new file mode 100644 index 0000000..9c03713 --- /dev/null +++ b/lv2/lv2plug.in/ns/ext/message/message.h @@ -0,0 +1,47 @@ +/* + Copyright 2012 David Robillard + + Permission to use, copy, modify, and/or distribute this software for any + purpose with or without fee is hereby granted, provided that the above + copyright notice and this permission notice appear in all copies. + + THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +*/ + +/** + @file message.h C header for the LV2 Message extension + . + + The message extension is purely data, this header merely defines URIs + for convenience. +*/ + +#ifndef LV2_MESSAGE_H +#define LV2_MESSAGE_H + +#define LV2_MESSAGE_URI "http://lv2plug.in/ns/ext/message" + +#define LV2_MESSAGE_Ack LV2_MESSAGE_URI "#Ack" +#define LV2_MESSAGE_Delete LV2_MESSAGE_URI "#Delete" +#define LV2_MESSAGE_Error LV2_MESSAGE_URI "#Error" +#define LV2_MESSAGE_Get LV2_MESSAGE_URI "#Get" +#define LV2_MESSAGE_Message LV2_MESSAGE_URI "#Message" +#define LV2_MESSAGE_Move LV2_MESSAGE_URI "#Move" +#define LV2_MESSAGE_Patch LV2_MESSAGE_URI "#Patch" +#define LV2_MESSAGE_Post LV2_MESSAGE_URI "#Post" +#define LV2_MESSAGE_Put LV2_MESSAGE_URI "#Put" +#define LV2_MESSAGE_Request LV2_MESSAGE_URI "#Request" +#define LV2_MESSAGE_Response LV2_MESSAGE_URI "#Response" +#define LV2_MESSAGE_Set LV2_MESSAGE_URI "#Set" + +#define LV2_MESSAGE_add LV2_MESSAGE_URI "#add" +#define LV2_MESSAGE_body LV2_MESSAGE_URI "#body" +#define LV2_MESSAGE_cause LV2_MESSAGE_URI "#cause" + +#endif /* LV2_MESSAGE_H */ diff --git a/lv2/lv2plug.in/ns/ext/message/message.ttl b/lv2/lv2plug.in/ns/ext/message/message.ttl new file mode 100644 index 0000000..a22dea3 --- /dev/null +++ b/lv2/lv2plug.in/ns/ext/message/message.ttl @@ -0,0 +1,334 @@ +# LV2 Message Extension +# Copyright 2012 David Robillard +# +# Permission to use, copy, modify, and/or distribute this software for any +# purpose with or without fee is hereby granted, provided that the above +# copyright notice and this permission notice appear in all copies. +# +# THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +@prefix doap: . +@prefix foaf: . +@prefix lv2: . +@prefix msg: . +@prefix owl: . +@prefix rdf: . +@prefix rdfs: . +@prefix xsd: . + + + a lv2:Specification ; + doap:license ; + doap:maintainer [ + a foaf:Person ; + rdfs:seeAlso ; + foaf:homepage ; + foaf:name "David Robillard" + ] ; + doap:name "LV2 Message" ; + doap:release [ + doap:created "2012-02-08" ; + doap:revision "0.1" + ] ; + doap:shortdesc "Messages for accessing and manipulating properties." ; + lv2:documentation """ +

This extension defines messages which can be used to access and manipulate +property-based data. It is designed to provide a powerful dynamic control +interface for LV2 plugins, but is useful for RDF-like systems in general.

+ +

The main feature of this design is that requests and responses are +themselves completely described in RDF. Thus, the complete protocol can +be expressed wherever RDF can without imposing additional implementation +burdens like a new syntax or binary formats. In particular, messages can be +serialised in Turtle, or as an LV2 Object.

+ +

This set of message types is deliberately small to avoid an explosion of +messages that all implementations would have to explicitly support. Instead, +the idea is to achieve control via manipulating properties rather than defining +custom commands. However, this is conceptual; there is no requirement that the +receiver actually implement a store of resources with properties.

+ +

For example, consider an object that can blink. Rather than define a +specific interface to control this (e.g. obj.start_blinking(); +obj.stop_blinking()), set a blinking property to true or false to +achieve the desired behaviour. One benefit of this approach is that a +persistent state model is available for free: simply serialise the +blinking property.

+ +

Because changes are described in terms of properties, important +functionality like undo stacks or revision control are simple to implement +generically. Accordingly, plugins are strongly encouraged to use these +property-based messages rather than defining custom methods for every action +they require (or worse, defining entirely new formats for messages).

+ +

These methods are deliberately very similar to HTTP methods, but defined +specifically for property-based resources. The properties used here are +RDF properties, thus predicates from any of the countless pre-existing +vocabularies may be used.

+""" . + +msg:Ack + a rdfs:Class ; + rdfs:subClassOf msg:Response ; + rdfs:label "Ack" ; + lv2:documentation """ +

An acknowledgement that a request has been successfully processed. This is +returned as a reply when a specific reply type is not necessary or +appropriate.

+""" . + +msg:Delete + a rdfs:Class ; + rdfs:subClassOf msg:Request ; + rdfs:label "Delete" ; + lv2:documentation """ +

Request the subject(s) be deleted.

+""" . + +msg:Error + a rdfs:Class ; + rdfs:subClassOf msg:Response ; + rdfs:label "Error" ; + lv2:documentation """ +

A response indicating an error processing a request.

+""" . + +msg:Get + a rdfs:Class ; + rdfs:subClassOf msg:Request ; + rdfs:label "Get" ; + lv2:documentation """ +

Request a description of the subject.

+ +

The detail of the response is not specified, it may be a flat description of +all the properties of the subject, or a more expressive description with +several subjects. A good choice is a concise bounded description, +i.e. a description which recursively includes all properties with blank node +values.

+ +

The response should have the same msg:subject property as the request, and +a msg:body that is a description of that subject. For example:

+
+<get-request>
+    a msg:Get ;
+    msg:subject <something> .
+
+ +

Could result in:

+
+[]
+    a msg:Response ;
+    msg:cause <get-request> ;
+    msg:subject <something> ;
+    msg:body [
+        eg:name "Something" ;
+        eg:ratio 1.6180339887 ;
+    ] .
+
+ +

Note the use of blank nodes is not required; the value of msg:body may be +the actual resource node. Depending on the transport and syntax used this may +be preferable. However, the msg:subject property is required regardless. For +example, the same response could be written:

+ +
+<something>
+    eg:name "Something" ;
+    eg:ratio 1.6180339887 .
+
+[]
+    a msg:Response ;
+    msg:cause <get-request> ;
+    msg:subject <something> ;
+    msg:body <something> .
+
+""" . + +msg:Insert + a rdfs:Class ; + rdfs:subClassOf msg:Request ; + rdfs:label "Insert" ; + rdfs:subClassOf [ + a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty msg:subject + ] ; + lv2:documentation """ +

Insert the msg:body at msg:subject. If the subject does not exist, it is +created. If the subject does already exist, it is added to. This request only +adds properties, it never removes them. The user must take care that multiple +values are not set for properties which should only have one value.

+""" . + +msg:Message + a rdfs:Class ; + rdfs:label "Message" . + +msg:Move + a rdfs:Class ; + rdfs:subClassOf msg:Request ; + rdfs:label "Move" ; + rdfs:subClassOf [ + a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty msg:subject ; + ] , [ + a owl:Restriction ; + owl:cardinality 1 ; + owl:onProperty msg:destination ; + ] ; + lv2:documentation """ +

Move the msg:subject to msg:destination. After this, msg:destination has +the description msg:subject had prior to this request's execution, and +msg:subject does not exist any more.It is an error if the subject does not +exist or the destination already exists.

+""" . + +msg:Patch + a rdfs:Class ; + rdfs:subClassOf msg:Request , [ + a owl:Restriction ; + owl:minCardinality 1 ; + owl:onProperty msg:subject + ] , [ + a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty msg:add + ] , [ + a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty msg:remove + ] ; + lv2:documentation """ +

A method for modifying the properties of an object.

+ +

This method always has at least one msg:subject, and exactly one msg:add +and msg:remove property. The value of msg:add and msg:remove are nodes +which have the properties to add or remove from the subject(s), respectively. +The special value msg:wildcard may be used as the value of a remove property +to remove all properties with the given predicate. For example:

+ +
+[]
+    a msg:Patch ;
+    msg:subject <something> ;
+    msg:add [
+        eg:name "New name" ;
+        eg:age 42 ;
+    ] ;
+    msg:remove [
+        eg:name "Old name" ;
+        eg:age msg:wildcard ;  # Remove all old eg:age properties
+    ] .
+
+""" . + +msg:Put + a rdfs:Class ; + rdfs:subClassOf msg:Request ; + rdfs:label "Put" ; + rdfs:subClassOf [ + a owl:Restriction ; + owl:maxCardinality 1 ; + owl:onProperty msg:subject + ] ; + lv2:documentation """ +

Put the msg:body as the msg:subject. If the subject does not already exist, +it is created. If the subject does already exist, the msg:body is considered +an updated version of it, and the previous version is replaced.

+""" . + +msg:Request + a rdfs:Class ; + rdfs:label "Request" ; + rdfs:subClassOf msg:Message ; + lv2:documentation """ +

A request. A request may have a msg:subject property, which indicates which +resource the request applies to. The subject may be omitted in contexts where +it is implicit (e.g. the recipient is the subject).

+""" . + +msg:Response + a rdfs:Class ; + rdfs:subClassOf msg:Message ; + rdfs:label "Response" ; + lv2:documentation """ +

A response to a method.

+""" . + +msg:Set + a rdfs:Class ; + rdfs:subClassOf msg:Request , [ + a owl:Restriction ; + owl:cardinality 1 ; + owl:onProperty msg:body + ] ; + lv2:documentation """ +

A method for setting properties of an object to unique values.

+ +

This is a simplified version of msg:Patch which only makes sense for +properties which have at most one value. This method always has at least one +msg:subject, and exactly one msg:add property. All the properties of the +value of msg:add are set on the subject, with all old values for those +properties removed. For example:

+ +
+[]
+    a msg:Set ;
+    msg:subject <something> ;
+    msg:body [
+        eg:name "New name" ;
+        eg:age 42 ;
+    ] .
+
+ +

This method is equivalent to a msg:Patch where the msg:remove value has +every property of msg:add but with wildcard values. For example, the above +message is equivalent to:

+
+[]
+    a msg:Patch ;
+    msg:subject <something> ;
+    msg:add [
+        eg:name "New name" ;
+        eg:age 42 ;
+    ] ;
+    msg:remove [
+        eg:name msg:wildcare ;
+        eg:age msg:wildcard ;
+    ] ;
+
+""" . + +msg:add + a rdf:Property , + owl:ObjectProperty ; + rdfs:domain msg:Method . + +msg:body + a rdf:Property , + owl:ObjectProperty ; + rdfs:domain msg:Message ; + lv2:documentation """ +

The body of a message.

+ +

The details of this property's value depend on the type of message it is a +part of.

+""" . + +msg:cause + a rdf:Property , + owl:ObjectProperty ; + rdfs:domain msg:Response ; + rdfs:range msg:Request ; + lv2:documentation """ +

The request this is a response to.

+""" . \ No newline at end of file diff --git a/lv2/lv2plug.in/ns/ext/message/waf b/lv2/lv2plug.in/ns/ext/message/waf new file mode 120000 index 0000000..5235032 --- /dev/null +++ b/lv2/lv2plug.in/ns/ext/message/waf @@ -0,0 +1 @@ +../../../../../waf \ No newline at end of file diff --git a/lv2/lv2plug.in/ns/ext/message/wscript b/lv2/lv2plug.in/ns/ext/message/wscript new file mode 120000 index 0000000..7e2c01b --- /dev/null +++ b/lv2/lv2plug.in/ns/ext/message/wscript @@ -0,0 +1 @@ +../../../../../ext.wscript \ No newline at end of file -- cgit v1.2.1