From 9f6611d293d47d296f113b492cc138209efc23a7 Mon Sep 17 00:00:00 2001
From: Kevin Larke <kevin@larke.org>
Date: Sun, 8 Feb 2015 08:58:59 -0800
Subject: [PATCH] doc/notes.txt : Added performance editor design notes.

---
 doc/notes.txt | 97 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 97 insertions(+)

diff --git a/doc/notes.txt b/doc/notes.txt
index 25e9347..08bf9b2 100644
--- a/doc/notes.txt
+++ b/doc/notes.txt
@@ -597,6 +597,103 @@ E5,G33,A#2,C#1 212-218 Marker 36
 E3             185     Marker 37
 F5,C#4,G#5     986     Marker-Down 204     
 
+=============================================================================
+Sequence Editor Design
+
+1) Performance pre-processing:
+  For each annotated performance section align the performance to the score.
+  and fill in the 
+   sectionArray :
+   [
+     section :
+     {
+       seq    : 1           // time-line this section resides in   
+       marker : 12          // time-line id of this sections begin marker 
+     
+       eventArray :
+       [
+         event : 
+         {
+
+	   // score tracking status
+	   // aligned   = event matches a score location (scloc is valid)
+	   // inserted  = inserted note that does not match the score (scloc is not valid)
+	   // pitch_err = matches score with the wrong pitch (scloc is valid)
+	   // order_err = matches score but not is out of order (scloc is valid)
+	   status: aligned | inserted | pitch_err | order_err
+
+	   // score location this event is associated with
+	   // or -1 if the note does not match a score event
+           scloc:    154      
+
+	   // performance sample index as an offset into the time-line sequence
+	   smpIdx:   134689   
+
+	   // performance event duration
+	   durtn:    234567  
+	   
+	   // optional note event information
+	   note : 
+	   {
+	     pitch: 60
+	     vel:   110
+	   }
+
+	   // optional pedal event information
+	   pedal :
+	   {
+	     label: quiet, sust, damp
+	     down : true
+	   }
+         }      
+       ]
+     }
+   ]
+ 
+2) Create a new sequence by combining sections:
+
+  a. Load the section array file created in step 1).
+  b. Select a set of sections to form the basis of the new sequence.
+  c. Resolve overlapping notes by disabling extra notes that share the
+     same score location.
+  d. Insert missing notes by selecting a note(s) from the score.
+  e. Increase or decrease the inter-onset interval between two notes.
+     (this will adjust the absolute time offset of all subsequent notes)
+  f. Edit the velocity of a note.
+  g. Shift the position of a pedal down or up event.
+  h. Insert a pedal event.
+  i. Write the sequence to a file.
+  j. Load a sequence from a file.
+
+3) User Interface:
+  Two Views:
+  a. Single Frame View: 
+     Display score bars and sections (same as score window) and overlay 
+     section boxes. Select sections to include in a new sequence.
+     Select Edit | Create Sequence.
+
+  b. Single Frame View: 
+     The begin marker of each frame includes the section label.
+     Selecting the begin section marker selects all events in the section.  
+       (this does not have to be done explicitely)
+     Each note in each section is displayed piano-roll style.
+        The notes are colored according to their 'status'.
+	Overlapping notes are shown in red.
+	Disabled notes are shown as hollow boxes.
+     A strip at the bottom shows the pedal state.
+     
+
+     Menu:
+       Show/Hide selected events / sections.
+       Enable/Disable selected events.
+        
+     
+ 
+
+
+
+=============================================================================
+
 -------------------------------------------------------------------------------
 OSX - Install Notes
 -------------------------------------------------------------------------------