Documentation: Added Projektstruktur and Codecs

Signed-off-by: Nicole Vreden <damba@mecka.net>

7 files changed, 101 insertions, 16 deletions

diff --git a/doc/asciidoc/codecs.txt b/doc/asciidoc/codecs.txt
new file mode 100644
index 0000000..b736d5e
--- /dev/null
+++ b/doc/asciidoc/codecs.txt
@@ -0,0 +1,30 @@
+Vergleich von Video-Codecs
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+Da die Grafikleistung des Samsung ARM9, welcher im OpenMoko verbaut ist, nicht
+mit Desktop-Systemen zu vergleichen ist, ist eine Wiedergabe mit voller
+Aufloesung (640 x 480) nicht moeglich. Deshalb wurden verschiedene Video-Codecs
+bei reduzierter Aufloesung getestet, um den am Besten geeigneten Codec zu
+ermitteln.
+
+Hierzu wurde mit dem MEncoder ein Video mit 25 fps mit verschiedenen Codecs
+kodiert und mit dem MPlayer auf dem OpenMoko abgespielt.
+
+Das Ergebnis ist in folgenden Tabellen ersichtlich:
+
+|============================================
+|Codec		|resolution	|frame rate	|file size
+|H264			|480 x 270	|9,6 fps		|1280kb
+|MPEG4		|480 x 270	|20 fps			|848kb
+|MSMPEG4	|480 x 270	|21 fps			|856kb
+|MSMPEG4v2|480 x 270	|21,5 fps		|856kb
+|MPEG1		|480 x 270	|25 fps			|824kb
+|MPEG2		|480 x 270	|25 fps			|808kb
+|WMV1			|480 x 270	|21,1 fps		|864kb
+|WMV2			|480 x 270	|12,3 fps		|816kb
+|HuffYUV	|480 x 270	|5,14 fps		|110768kb
+|FFVHuff	|480 x 270	|7,1 fps		|85320kb
+|Raw video|480 x 270	|15,5 fps		|142408kb
+|============================================
+
+Wie zu sehen ist, wird die volle Framerate nur mit MPEG1 und MPEG2 erreicht.
+Auf Grund der besseren Kompression wurde MPEG2 gewaehlt.
diff --git a/doc/asciidoc/developer.txt b/doc/asciidoc/developer.txt
index a221a52..d105210 100644
--- a/doc/asciidoc/developer.txt
+++ b/doc/asciidoc/developer.txt
@@ -3,9 +3,14 @@ Entwickler...
 ...duerfen den YALP-Client weiterentwickeln. Dieses Kapitel beschreibt die
 Enlightenment Foundation Libraries, sowie die Architektur des Clients.
 
+include::project.txt[]
 
+<<<
 include::efl.txt[]
 
 <<<
+include::codecs.txt[]
+
+<<<
 include::classes.txt[]
 
diff --git a/doc/asciidoc/content.txt b/doc/asciidoc/eYalp.txt
index d6022bb..e0dbdb0 100755
--- a/doc/asciidoc/content.txt
+++ b/doc/asciidoc/eYalp.txt
@@ -5,9 +5,6 @@ eYALP
 :Date:      26.02.2010
 :Revision:  1.0
 
-Projektarbeit von {author}
-
-
 <<<
 include::yalp.txt[]
 
diff --git a/doc/asciidoc/install.txt b/doc/asciidoc/install.txt
index 28dc850..c558cc3 100644
--- a/doc/asciidoc/install.txt
+++ b/doc/asciidoc/install.txt
@@ -5,14 +5,15 @@ Zuerst muss der Benutzer die...
 ...Datenbank einrichten...
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 ...indem er den Datenbank-Dump folgendermassen importiert:
-
+----
 /usr/bin/psql -U yalp -w yalp -h localhost -f yalp-db.backup
+----
 
 Der Dump wurde mit folgendem Kommando erstellt:
-
+----
 /usr/bin/pg_dump -U yalp -w yalp -h localhost -f p -C -o -v -f
 "yalp-db.backup"
-
+----
 
 Anschliessend folgt das Starten...
 
@@ -32,14 +33,15 @@ Anschliessend folgt das Starten...
 ~~~~~~~~~~~~~~~~~
 ...im yalp-Verzeichnis mit ./efl-gui.sh
 
-
+<<<
 OpenMoko einrichten
 -------------------
-Das SHR-Projekt stellt Images zur Verfuegung welche alle benoetigten
-Komponenten beinhalten. (http://build.shr-project.org)
+Das http://build.shr-project.org[SHR-Projekt] stellt Images zur Verfuegung
+welche alle benoetigten Komponenten beinhalten.
 
-http://shr-project.org/trac/wiki/Install[Die SHR-Project Homepage] beschreibt 
-die Installation des SHR-Images auf dem OpenMoko
+Die SHR-Project Homepage beschreibt die
+http://shr-project.org/trac/wiki/Install[Installation] des SHR-Images auf dem
+OpenMoko
 
 OpenMoko per USB mit Linux-PC verbinden. OpenMoko meldet sich als
 Ethernet-Gadget:
diff --git a/doc/asciidoc/project.txt b/doc/asciidoc/project.txt
new file mode 100644
index 0000000..839cf2e
--- /dev/null
+++ b/doc/asciidoc/project.txt
@@ -0,0 +1,48 @@
+Projektstruktur
+~~~~~~~~~~~~~~~
+
+Yalp besteht aus der zentralen Komponente YalpServer an dem sich verschiedene
+Plugins registrieren:
+
+* InputPlugins: stellen Yalp Medien zur Verfuegung, z.B. Dateisystem, YouTube,
+ ...
+* OutputPlugins: transferieren Medien in verschiedene Formate, z.B. Streams,
+ zip-Archive, ...
+* AuthPlugins (optional): dienen zur Authentifizierung von Usern, z.B.
+ Datenbank, OpenLDAP, ...
+
+Momentan sind folgende Plugins realisiert:
+
+* VlcTelnetOutput: erstellt Streams
+* PGSQLInput: in einer Datenbank werden Medien welche sich auf einem
+ Filesystem befinden verwaltet
+* PGSQLAuth: in einer PostGreSQL-Datenbank koennen Benutzer und Passwoerter
+ verwaltet werden
+
+Der eYalp-Client unterstuetzt momentan das VlcTelnetOutput- und das
+PGSQLInput-Plugin.
+
+Die Yalp-Entwicklung findet derzeit in einem privaten git-Repository statt.
+Eine aktuelle Kopie des Repositories befindet sich auf der CD-ROM.
+
+Die Skripte build-java.sh und build-python.sh dienen zum Kompilieren aller
+Komponenten. Mit ./build-java.sh doc wird eine Java-Dokumentation fuer die
+Server-Komponenten erzeugt.
+
+Unter doc liegen alle automatisch generierten Dokumentationen sowie unter
+doc/asciidoc selbsterstelle Dokumentation.
+
+In img liegen die Yalp-Logos.
+
+In lib liegen die Java-Abhaengigkeiten.
+
+Der Source-Code befindet sich in src, die Plugins, sowie diverse Clients sind in
+Unterordner strukturiert. Der Source-Code zu eYalp befindet sich unter
+src/Yalp/Clients/EflClient.
+
+src/yalp.idl ist die CORBA-Schnittstellen-Definition, ueber die alle
+Komponenten miteinander kommunizieren.
+
+Mit dem Kommando "git log" kann die Projekthistorie eingesehen werden.
+Mit "git show <commithash>" wird die Aenderung eines einzelnen Commits
+angezeigt.
diff --git a/doc/asciidoc/user.txt b/doc/asciidoc/user.txt
index e192d79..491f16d 100644
--- a/doc/asciidoc/user.txt
+++ b/doc/asciidoc/user.txt
@@ -42,4 +42,4 @@ Moechte der Benutzer den...
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 ...kann er dies tun indem er den "Stopp"-Button anklickt.
 
-image::img/gui.png[]
+image::img/blubb.png[width=300]
diff --git a/doc/asciidoc/yalp.txt b/doc/asciidoc/yalp.txt
index 72754b8..d76b6f4 100644
--- a/doc/asciidoc/yalp.txt
+++ b/doc/asciidoc/yalp.txt
@@ -26,12 +26,15 @@ Der YALP-Client
 ~~~~~~~~~~~~~~~
 ...folgende Installationen:
 
-python2.5: Download von
-http://www.python.org/download/releases/2.5.5/[der Python-Homepage]
+python2.5: Download von der
+http://www.python.org/download/releases/2.5.5/[Python-Homepage]
 
-EFL-Bindings: Download von
-http://packages.enlightenment.org/[der Enlightenment-Homepage]
+EFL-Bindings: Download von der
+http://packages.enlightenment.org/[Enlightenment-Homepage]
 
+omniORB CORBA Request Broker mit omniPy-Python-Bindings:
+Download von der
+http://omniorb.sourceforge.net/releases/[OmniOrb-Homepage]
 
 ...wurde entwickelt...
 ~~~~~~~~~~~~~~~~~~~~~~