From: PHO <pho@cielonegro.org>
Date: Wed, 20 Jul 2011 22:17:11 +0000 (+0900)
Subject: diagram of wvparse
X-Git-Url: https://git.cielonegro.org/gitweb.cgi?a=commitdiff_plain;h=2e2959dcb2d780e58433e4892126f864b0efae26;p=soundpipes.git

diagram of wvparse
---

diff --git a/docs/components.rst b/docs/components.rst
index 5770f63..5f86f3f 100644
--- a/docs/components.rst
+++ b/docs/components.rst
@@ -15,12 +15,18 @@ Diagram::
             |         |
             `---------'
 
+Input
+~~~~~
+
 control event
     * Open FilePath
     * Seek SeekMode Integer
     * Read Int
     * Close
 
+Output
+~~~~~~
+
 octet stream event
     ByteString (response for the "Read" event)
 
@@ -28,6 +34,72 @@ reactive state value
     * Open Integer Integer -- size and the current position
     * Closed
 
+
+-------
+wvparse
+-------
+
+Diagram::
+
+    parser ctl
+    -----------.
+                v
+    wv stream  ,---------. wv ctrl
+    ---------->|         |---------->
+    wvc stream |         | wv blocks
+    ---------->| wvparse |---------->
+               |         | wvc ctrl
+               |         |---------->
+               `---------' wvc blocks
+                    | | `----------->
+                    | | media tags
+                    | `------------->
+                    | state
+                    `--------------->
+
+Input
+~~~~~
+
+parser control event
+    SeekableParserCtrl
+        * GetNext
+        * FindTags
+        * Seek Integer -- sample index
+
+    NonSeekableParserCtrl
+        * GetNext
+
+wv stream event
+    ByteString
+
+wvc stream event
+    Maybe ByteString
+
+Output
+~~~~~~
+
+wv/wvc control event
+    Seekable
+        * Seek SeekMode Integer
+        * Read Int
+
+    NonSeekable
+        * Read Int
+
+wv block event
+    WavPack.Block
+
+wvc block event
+    Maybe WavPack.Block
+
+reactive media tags
+    Map Text Text
+
+reactive state value
+    * Active
+    * Inactive
+
+
 -----
 wvdec
 -----