Adding viewpoints » History » Version 9

Marcus Pearce, 2013-07-15 03:19 PM

1 1 Marcus Pearce
h1. Adding Viewpoints
2 1 Marcus Pearce
3 1 Marcus Pearce
h2. Basic viewpoints
4 1 Marcus Pearce
5 4 Marcus Pearce
# Add the viewpoint definition to <code>basic-viewpoints.lisp</code> in the directory <code>viewpoints</code>:
6 5 Marcus Pearce
<pre>
7 4 Marcus Pearce
;; Note ornaments (0 = no ornament; 1 = accacciatura; 2 = mordent; 3 =
8 4 Marcus Pearce
;; trill
9 1 Marcus Pearce
(define-basic-viewpoint ornament (events)
10 4 Marcus Pearce
  (md:ornament (last-element events)))
11 5 Marcus Pearce
</pre>
12 4 Marcus Pearce
# Add a column to the mtp-event table in the database
13 1 Marcus Pearce
<pre> 
14 1 Marcus Pearce
(clsql:execute-command "ALTER TABLE mtp_event ADD ornament INT DEFAULT '0';")
15 1 Marcus Pearce
</pre>
16 4 Marcus Pearce
# In <code>events/events.lisp</code>: 
17 4 Marcus Pearce
add the slot definition <code>(ornament :initarg :ornament :accessor %mtp-ornament)</code> to the class definition for <code>music-event</code>
18 4 Marcus Pearce
# In <code>events/music-db.lisp</code>: 
19 4 Marcus Pearce
add <code>[ornament]</code> to the obvious places in the variable <code>*event-attributes*</code>.
20 4 Marcus Pearce
# Export the new viewpoint from the <code>music-data</code> package. In <code>event/package.lisp</code> add <code>"ornament"</code> to the list of exported symbols.
21 9 Marcus Pearce
# If you want the basic viewpoint to be instantiated in imported or exported data, then you will have to edit the import and export functions in <code>database/data-import</code> and <code>database/data-export</code>.
22 1 Marcus Pearce
23 1 Marcus Pearce
h2. Derived viewpoints
24 1 Marcus Pearce
25 9 Marcus Pearce
The procedure for adding derived viewpoints is to add the viewpoint definition to one of the files in <code>viewpoints/derived-viewpoints/</code> using the macro <code>define-viewpoint</code> which has the following signature:
26 1 Marcus Pearce
27 2 Marcus Pearce
<pre>(define-viewpoint (viewpoint-name viewpoint-type (type-set)) (events element) :function viewpoint-function :function* inverse-function)</pre>
28 1 Marcus Pearce
29 1 Marcus Pearce
* _viewpoint-name_: a symbol naming the viewpoint 
30 1 Marcus Pearce
* _viewpoint-type_: a symbol giving the type of the derived viewpoint (<code>derived</code> for primitive derived; <code>test</code> for test; <code>threaded</code> for threaded)
31 1 Marcus Pearce
* _type-set_: a list of basic viewpoints that this viewpoint is derived from and, therefore, capable of predicting
32 1 Marcus Pearce
* _events_: a symbol denoting the first argument to ''viewpoint-function'' and ''inverse-function''
33 1 Marcus Pearce
* _element_: a symbol denoting the second argument to ''inverse-function''
34 1 Marcus Pearce
* _viewpoint-function_: a function of arity 1, which accepts a list of events, the <code>events</code> symbol above, representing a melody and returns a value from the domain of the viewpoint being defined or the <code>+undefined+</code> symbol
35 1 Marcus Pearce
* _inverse-function_: a function of arity 2, accepting a list of events and an element from the domain of the viewpoint, which returns the element from the domain of the basic viewpoint which would generate the supplied element if applied to the supplied event list with the last element removed (implemented for purposes of efficiency only and not required).
36 1 Marcus Pearce
37 1 Marcus Pearce
h3. Example
38 1 Marcus Pearce
39 1 Marcus Pearce
Define a viewpoint <code>cpint</code> returning the pitch interval in semitones between the final two notes in a melodic sequence given a basic viewpoint <code>cpitch</code> which encodes chromatic pitch in semitones as midi note numbers:
40 1 Marcus Pearce
41 1 Marcus Pearce
<pre>
42 1 Marcus Pearce
(define-viewpoint (cpint derived (cpitch))
43 1 Marcus Pearce
    (events element) 
44 1 Marcus Pearce
  :function (multiple-value-bind (e1 e2)
45 1 Marcus Pearce
                (values-list (last events 2))
46 1 Marcus Pearce
              (if (or (null e1) (null e2)) +undefined+
47 1 Marcus Pearce
                  (let ((cpitch1 (cpitch (list e1)))
48 1 Marcus Pearce
                        (cpitch2 (cpitch (list e2))))
49 1 Marcus Pearce
                    (if (undefined-p cpitch1 cpitch2) +undefined+
50 1 Marcus Pearce
                        (- cpitch2 cpitch1)))))
51 1 Marcus Pearce
  :function* (list (+ element (cpitch (list (penultimate-element events))))))
52 1 Marcus Pearce
</pre>