documentation of stream transformations rotation and mirroring
Stefan Schuermans commited on 2014-01-03 13:04:40
Showing 2 changed files, with 65 additions and 0 deletions.
- doc/index.html a9cada5..9458342
- doc/transformer.html 0000000..4f4ce6d
| ... | ... |
@@ -109,6 +109,7 @@ |
| 109 | 109 |
<li><a href="ratelimiter.html">Rate Limiter</a></li> |
| 110 | 110 |
<li><a href="resizer.html">Resizer</a></li> |
| 111 | 111 |
<li><a href="scaler.html">Scaler</a></li> |
| 112 |
+ <li><a href="transformer.html">Transformer</a></li> |
|
| 112 | 113 |
<li><a href="udp4phone.html">UDP4 Phone Connector</a></li> |
| 113 | 114 |
<li><a href="udp4receiver.html">UDP4 Receiver</a></li> |
| 114 | 115 |
<li><a href="udp4sender.html">UDP4 Sender</a></li> |
| ... | ... |
@@ -0,0 +1,64 @@ |
| 1 |
+<html> |
|
| 2 |
+ <head> |
|
| 3 |
+ <title>Blinker - Transformer</title> |
|
| 4 |
+ </head> |
|
| 5 |
+ <body> |
|
| 6 |
+ <h1>Blinker - Transformer</h1> |
|
| 7 |
+ <p> |
|
| 8 |
+ The transformer module applies a transformation to each frame of a |
|
| 9 |
+ stream. The possible transformations are rotations and mirroring |
|
| 10 |
+ operations. |
|
| 11 |
+ It receives a single input stream, transforms its frames and passes it |
|
| 12 |
+ on. |
|
| 13 |
+ </p> |
|
| 14 |
+ <h2>Configuration</h2> |
|
| 15 |
+ <p> |
|
| 16 |
+ The configuration of the transformer module with name <code>NAME</code> |
|
| 17 |
+ is located in the <code>transformers/NAME</code> subdirectory. |
|
| 18 |
+ </p> |
|
| 19 |
+ <h3>Input Stream</h3> |
|
| 20 |
+ <p> |
|
| 21 |
+ The file <code>instream</code> contains the name of the stream to |
|
| 22 |
+ receive. |
|
| 23 |
+ The frames received from this stream are transformed and passed to the |
|
| 24 |
+ output stream. |
|
| 25 |
+ </p> |
|
| 26 |
+ <h3>Transformation</h3> |
|
| 27 |
+ <p> |
|
| 28 |
+ The file <code>transform</code> describes the transformation to apply. |
|
| 29 |
+ The file must contain a string from the following list: |
|
| 30 |
+ <table> |
|
| 31 |
+ <tr><td><code>none</code></td> |
|
| 32 |
+ <td width="2em"></td> |
|
| 33 |
+ <td>apply no transformation</td></tr> |
|
| 34 |
+ <tr><td><code>rotcw</code></td> |
|
| 35 |
+ <td width="2em"></td> |
|
| 36 |
+ <td>rotate 90 degrees clockwise</td></tr> |
|
| 37 |
+ <tr><td><code>rotccw</code></td> |
|
| 38 |
+ <td width="2em"></td> |
|
| 39 |
+ <td>rotate 90 degrees counter-clockwise</td></tr> |
|
| 40 |
+ <tr><td><code>rothalf</code></td> |
|
| 41 |
+ <td width="2em"></td> |
|
| 42 |
+ <td>rotate 180 degrees</td></tr> |
|
| 43 |
+ <tr><td><code>mirhor</code></td> |
|
| 44 |
+ <td width="2em"></td> |
|
| 45 |
+ <td>mirror horizontally</td></tr> |
|
| 46 |
+ <tr><td><code>mirver</code></td> |
|
| 47 |
+ <td width="2em"></td> |
|
| 48 |
+ <td>mirror vertically</td></tr> |
|
| 49 |
+ <tr><td><code>mirdiag</code></td> |
|
| 50 |
+ <td width="2em"></td> |
|
| 51 |
+ <td>mirror diagonally (\)</td></tr> |
|
| 52 |
+ <tr><td><code>mirdiag2</code></td> |
|
| 53 |
+ <td width="2em"></td> |
|
| 54 |
+ <td>mirror diagonally (/)</td></tr> |
|
| 55 |
+ </table> |
|
| 56 |
+ </p> |
|
| 57 |
+ <h3>Output Stream</h3> |
|
| 58 |
+ <p> |
|
| 59 |
+ The file <code>outstream</code> contains the name of the stream to |
|
| 60 |
+ send the transformed frames to. |
|
| 61 |
+ </p> |
|
| 62 |
+ </body> |
|
| 63 |
+</html> |
|
| 64 |
+ |
|
| 0 | 65 |