more documentation
Stefan Schuermans commited on 2011-11-19 20:40:28
Showing 5 changed files, with 174 additions and 1 deletions.
- doc/canvas.html 0000000..179e8bf
- doc/index.html 8beb6cd..dc550b1
- doc/player.html 0000000..2d2ea06
- doc/printer.html 0000000..bbf8ef3
- doc/udp4sender.html 0000000..f89ac71
| ... | ... |
@@ -0,0 +1,75 @@ |
| 1 |
+<html> |
|
| 2 |
+ <head> |
|
| 3 |
+ <title>Blinker - Canvas</title> |
|
| 4 |
+ </head> |
|
| 5 |
+ <body> |
|
| 6 |
+ <h1>Blinker - Canvas</h1> |
|
| 7 |
+ <p> |
|
| 8 |
+ The canvas module allows to merge several streams into one. |
|
| 9 |
+ It works lie a canvas, onto which rectangular sections of |
|
| 10 |
+ different streams are drawn. |
|
| 11 |
+ The result obtained on the canvas is then sent to a single output |
|
| 12 |
+ stream. |
|
| 13 |
+ </p> |
|
| 14 |
+ <h2>Configuration</h2> |
|
| 15 |
+ <p> |
|
| 16 |
+ The configuration of the canvas module with name <code>NAME</code> |
|
| 17 |
+ is located in the <code>canvas/NAME</code> subdirectory. |
|
| 18 |
+ </p> |
|
| 19 |
+ <h3>Format</h3> |
|
| 20 |
+ <p> |
|
| 21 |
+ The file <code>format</code> describes the format of the canvas, |
|
| 22 |
+ i.e. its dimensions, the number of channels and the color depth on |
|
| 23 |
+ each channel. |
|
| 24 |
+ The file must contain a string |
|
| 25 |
+ <code><width>x<height>-<channels>/<colors></code>, |
|
| 26 |
+ e.g. <code>18x8-1/256</code> for 18 pixels width, 8 pixels height |
|
| 27 |
+ in 256 grayscales. |
|
| 28 |
+ </p> |
|
| 29 |
+ <h3>Input List</h3> |
|
| 30 |
+ <p> |
|
| 31 |
+ The inputs to be drawn onto the canvas are contained in the |
|
| 32 |
+ <code>inputs</code> subdirectory. |
|
| 33 |
+ Each input is configured in an own subdirectory in <code>inputs</code>. |
|
| 34 |
+ E.g. the configurations for inputs with names <code>top</code> |
|
| 35 |
+ and <code>bottom</code> reside in subdirectories <code>inputs/top</code> |
|
| 36 |
+ and <code>inputs/bottom</code> respectively. |
|
| 37 |
+ All inputs are drawn to the canvas in alphanumerical order, i.e. |
|
| 38 |
+ <code>top</code> is painted over <code>bottom</code> on overlapping |
|
| 39 |
+ pixels. |
|
| 40 |
+ </p> |
|
| 41 |
+ <p> |
|
| 42 |
+ The configuration inside an input subdirectory consists of the following |
|
| 43 |
+ settings: |
|
| 44 |
+ </p> |
|
| 45 |
+ <h4>Input Stream</h4> |
|
| 46 |
+ <p> |
|
| 47 |
+ The file <code>instream</code> contains the name of the stream to |
|
| 48 |
+ read for this input. |
|
| 49 |
+ </p> |
|
| 50 |
+ <h4>Source Position</h4> |
|
| 51 |
+ <p> |
|
| 52 |
+ The file <code>srcpos</code> defines the top-left corner of the |
|
| 53 |
+ recangular section to be taken from the stream. |
|
| 54 |
+ The file must contain a string <code><x>x<y></code>. |
|
| 55 |
+ </p> |
|
| 56 |
+ <h4>Size</h4> |
|
| 57 |
+ <p> |
|
| 58 |
+ The file <code>size</code> defines the size of the |
|
| 59 |
+ recangular section to be taken from the stream. |
|
| 60 |
+ The file must contain a string <code><width>x<height></code>. |
|
| 61 |
+ </p> |
|
| 62 |
+ <h4>Destination Position</h4> |
|
| 63 |
+ <p> |
|
| 64 |
+ The file <code>destpos</code> defines the top-left corner of the |
|
| 65 |
+ recangular section on the canvas to draw to. |
|
| 66 |
+ The file must contain a string <code><x>x<y></code>. |
|
| 67 |
+ </p> |
|
| 68 |
+ <h3>Output Stream</h3> |
|
| 69 |
+ <p> |
|
| 70 |
+ The file <code>outstream</code> contains the name of the stream to |
|
| 71 |
+ send the frames to. |
|
| 72 |
+ </p> |
|
| 73 |
+ </body> |
|
| 74 |
+</html> |
|
| 75 |
+ |
| ... | ... |
@@ -84,7 +84,10 @@ |
| 84 | 84 |
<p> |
| 85 | 85 |
The following module types are available for instantiation: |
| 86 | 86 |
<ul> |
| 87 |
- <li>TODO</li> |
|
| 87 |
+ <li><a href="canvas.html">Canvas</a></li> |
|
| 88 |
+ <li><a href="player.html">Player</a></li> |
|
| 89 |
+ <li><a href="printer.html">Printer</a></li> |
|
| 90 |
+ <li><a href="udp4sender.html">UDP4 Sender</a></li> |
|
| 88 | 91 |
</ul> |
| 89 | 92 |
</p> |
| 90 | 93 |
<h2>Copyright / Copyleft</h2> |
| ... | ... |
@@ -0,0 +1,28 @@ |
| 1 |
+<html> |
|
| 2 |
+ <head> |
|
| 3 |
+ <title>Blinker - Player</title> |
|
| 4 |
+ </head> |
|
| 5 |
+ <body> |
|
| 6 |
+ <h1>Blinker - Player</h1> |
|
| 7 |
+ <p> |
|
| 8 |
+ The player module plays Blinken movies from a playlist. |
|
| 9 |
+ </p> |
|
| 10 |
+ <h2>Configuration</h2> |
|
| 11 |
+ <p> |
|
| 12 |
+ The configuration of the player module with name <code>NAME</code> |
|
| 13 |
+ is located in the <code>players/NAME</code> subdirectory. |
|
| 14 |
+ </p> |
|
| 15 |
+ <h3>Playlist</h3> |
|
| 16 |
+ <p> |
|
| 17 |
+ The playlist contains all movies in the subdirectory |
|
| 18 |
+ <code>playlist</code>. |
|
| 19 |
+ The movies are played in alphanumerical order. |
|
| 20 |
+ </p> |
|
| 21 |
+ <h3>Output Stream</h3> |
|
| 22 |
+ <p> |
|
| 23 |
+ The file <code>outstream</code> contains the name of the stream to |
|
| 24 |
+ send the frames to. |
|
| 25 |
+ </p> |
|
| 26 |
+ </body> |
|
| 27 |
+</html> |
|
| 28 |
+ |
| ... | ... |
@@ -0,0 +1,24 @@ |
| 1 |
+<html> |
|
| 2 |
+ <head> |
|
| 3 |
+ <title>Blinker - Printer</title> |
|
| 4 |
+ </head> |
|
| 5 |
+ <body> |
|
| 6 |
+ <h1>Blinker - Printer</h1> |
|
| 7 |
+ <p> |
|
| 8 |
+ The printer module is primary intended for debugging purposes. |
|
| 9 |
+ It receives a stream and prints received frames to standard output. |
|
| 10 |
+ </p> |
|
| 11 |
+ <h2>Configuration</h2> |
|
| 12 |
+ <p> |
|
| 13 |
+ The configuration of the printer module with name <code>NAME</code> |
|
| 14 |
+ is located in the <code>printers/NAME</code> subdirectory. |
|
| 15 |
+ </p> |
|
| 16 |
+ <h3>Input Stream</h3> |
|
| 17 |
+ <p> |
|
| 18 |
+ The file <code>instream</code> contains the name of the stream to |
|
| 19 |
+ read. |
|
| 20 |
+ The frames received from this stream are written to standard output. |
|
| 21 |
+ </p> |
|
| 22 |
+ </body> |
|
| 23 |
+</html> |
|
| 24 |
+ |
| ... | ... |
@@ -0,0 +1,43 @@ |
| 1 |
+<html> |
|
| 2 |
+ <head> |
|
| 3 |
+ <title>Blinker - UDPv4 Sender</title> |
|
| 4 |
+ </head> |
|
| 5 |
+ <body> |
|
| 6 |
+ <h1>Blinker - UDPv4 Sender</h1> |
|
| 7 |
+ <p> |
|
| 8 |
+ The UDPv4 sender module sends a stream using UDP version 4 across |
|
| 9 |
+ a network. |
|
| 10 |
+ It supports the static and dynamic variants of the BLP, EBLP and MCUF |
|
| 11 |
+ protocols. |
|
| 12 |
+ </p> |
|
| 13 |
+ <h2>Configuration</h2> |
|
| 14 |
+ <p> |
|
| 15 |
+ The configuration of the UDPv4 senderr module with name <code>NAME</code> |
|
| 16 |
+ is located in the <code>udp4senders/NAME</code> subdirectory. |
|
| 17 |
+ </p> |
|
| 18 |
+ <h3>Input Stream</h3> |
|
| 19 |
+ <p> |
|
| 20 |
+ The file <code>instream</code> contains the name of the stream to |
|
| 21 |
+ read. |
|
| 22 |
+ The frames received from this stream are sent over the network. |
|
| 23 |
+ </p> |
|
| 24 |
+ <h3>Bind Address</h3> |
|
| 25 |
+ <p> |
|
| 26 |
+ The file <code>bind</code> contains the local address to bind to. |
|
| 27 |
+ It must contain the IP address and the port, i.e. a string |
|
| 28 |
+ <code><IP>:<port></code> (hostnames are not supported). |
|
| 29 |
+ If the local address should be determined automatically, the file |
|
| 30 |
+ can contain <code>0.0.0.0:0</code>. |
|
| 31 |
+ </p> |
|
| 32 |
+ <h3>Static Destinations</h3> |
|
| 33 |
+ <p> |
|
| 34 |
+ Static destinations to suplly with a network stream in BLP, EBLP |
|
| 35 |
+ or MCUF protocol can be configured in the subdirectories |
|
| 36 |
+ <code>blp</code>, <code>eblp</code> and <code>mcuf</code> respectively. |
|
| 37 |
+ Each file in those directories contains the address of a static |
|
| 38 |
+ destination as a string <code><IP>:<port></code> |
|
| 39 |
+ (hostnames are not supported). |
|
| 40 |
+ </p> |
|
| 41 |
+ </body> |
|
| 42 |
+</html> |
|
| 43 |
+ |
|
| 0 | 44 |