DBOX2-Modul

Aus TuxBoxWIKI
Wechseln zu: Navigation, Suche


Bodenwellen-klein.png ACHTUNG: Zu diesem Artikel gibt es unter Plugins:Tutorial einen Artikel mit ähnlichen Inhalt. Diese Artikel sollten der Übersicht halber zusammengeführt werden.

Wenn du Lust hast, beteilige dich daran und entferne diesen Baustein, wenn du die Artikel zusammengeführt hast.

Allgemeines

Um nicht zu viel zu sagen: Ein Plugin ist eine Erweiterung zu einem vorhandenen Programm und hat folgende Attribute:

  • Erweiterung
  • dynamisch ladbar/entladbar
  • Plugins können/werden unabhängig vom Ladeprogramm (Hauptprogramm) produziert
  • Plugins sind abhängig vom Hauptprogramm
  • durch bestimmte bereitgestellte Funktionen (Schnittstellen) können Plugins untereinander kommunizieren


Plugins können durch bestimmte Mechanismen in das Programm eingebunden (verbunden) werden (auch als linken bezeichnet).


Bevor ein Plugin (wie oben schon erwähnt) eingebunden werden kann, wird durch bestimmte Mechanismen versucht alle nicht gebundenen (nicht gelinkten) Symbole zu binden.
Bei Unix-System haben Module/Plugins oftmals die Erweiterung so (shared object) und bei Windows dll (dynamic linked library). Beide Systeme können Plugins dynamisch laden und entladen. Es gibt kein einheitliches Aussehen eines Plugins. Eintrittspunkte, Funktionen die bei bestimmten Events aufgerufen werden, sind oftmals in den Programmen nicht gleich. Fehler, die in Plugins vorkommen, können zu Abstürzen führen (Programm, OS)


Die Implementierung eines Plugins

Die Implementierung eines Plugins sollte erst nach einer ausführlichen Planung kommen. Die Planung beschreibt das Aussehen des Plugins, bzw. die verwendeten Funktionen und deren späteren Programmierung. Während dieser Phase sollten alle wichtigen Eigenschaften des Hostes Hauptprogramm eingeholt bzw. berücksichtigt werden. Fehlerhafte Planungen können spätere Fehler in den Programmen bedeuten.


Interface eines Modules

Jedes Programm, das erweiterbar ist, benutzt eine Schnittstelle (oder mehrere), auch als Interface bezeichnet. Es gibt nur wenige Standards, z.B. VST (Musikbranche). Man sollte mit diesen Schnittstellen arbeiten, um einen Ablauf ohne Fehler zu garantieren.


Ein Plugin

(ergänzen bzw. ändern) Ein C-Programm hat einen Eintrittspunkt und zwar main. Main ist sozusagen die Hauptfunktion eines C-Programmes. Jedes mal wenn man ein Programm aufrufen, das in C geschrieben wurde, dann wird diese Funktion aufgerufen. Wenn man die Funktion beenden, wird auch das Programm beendet. Der Unterschied zu Plugins dabei ist, dass diese meistens keine Hauptfunktion haben, sondern nur Funktionen, die bei bestimmten Events gerufen werden. Stellt man sich das Plugin als einen Stecker vor, den man in eine Buchse steckt, dann verbindet man dabei die Kontakte der Buchse mit dem Stecker und es besteht eine Verbindung. Bei Plugins ist das genauso, der Stecker ist dabei sozusagen das Plugin und die Buchse die Schnittstelle. Bei der DBox2 hat ein Plugin eine Methode/Funktion die vom Lader aufgerufen wird, wenn man es lädt. Diese Funktion heißt plugin_exec. Der Funktion wird zusätzlich ein Argument übergeben, und zwar eine Struktur: Sie ist vom Typ _PluginParam. Eine Struktur hat mehrere Felder, die man während des Programmierens/Laufzeit ansprechen kann.


Die Struktur PluginParam hat folgende Elemente:

  • id:
ist ein Character-Pointer und wird verwendet, um den Wert in val zu identifizieren.
  • val:
ist ein Character-Pointer. val beinhaltet den Wert. Er kann z.B. ein FD (File Descriptor, Handles) für eine Datei, z.B. lcd oder fb (frame buffer) sein. Achtung, bevor man den Character-Pointer verwenden kann, muss man ihn in ein Integer umwandeln.
  • next:
next ist vom Typ PluginParam. Er kann weitere der oben genannten Informationen enthalten


Die DBox2 bietet folgende Interfaces

FX2

FX2 (nach dem Author) ist eine Bibliothek (Library, kurz. lib, deshalb wird diese Bibliothek auch als libfx2 genannt) mit der man graphische Operationen durchführen können. Ein weiteres Feature der Library sind Remote-Control-Operationen.

Folgende graphische Operationen werden verwendet:

  • Zeichnen von horizontalen und vertikalen Linien
  • Zeichnen von Buchstaben
  • Verschieben von Bildinhalten
  • Kopieren von Bildinhalten
  • Zeichnen von ungefüllten und gefüllten Rechtecken
  • Pixel-Operationen


Enigma-Widgets

Enigma bietet Widgets für Programme an.


Stop hand.png An dieser Stelle muss noch Text rein.


Kernel

Module können genauso auf Schnittstellen zugreifen, wie andere Programme. Sie sind also nicht auf die bereitgestellten Funktionen des Hauptprogrammes eingeschränkt.


Wie erstellt man denn nun Plugins ? (Ausbauphauphase)

Der Absatz befindet sich noch im Aufbau, bitte verwenden Sie Plugins:Tutorial, statt diesem Abschnitt.

Voraussetzung für dieses Tutorial sollten Kentnisse in C/C++ sein. Ein CDK, welches funktioniert, ist klar.


VT

Als erstes fangen wir mit den Grundlagen an. Der nachfolgende Code gibt lediglich eine Hallo-Welt! Message aus.


Der Quelltext

#include <stdio.h>
#include <plugin.h>

plugin_exec (PluginParam * strc)
{
   printf ("Hallo-Welt!");
   return 0;
}


Aufbau des Quelltextes

In Zeile 4 implementieren wir die Funktion plugin_exec. In dieser Funktion wird mittels printf ein String "Hallo-Welt!" ausgegeben. In Zeile 6 wird die Funktion beendet und das Plugin wird entladen.


Stop hand.png An dieser Stelle muss noch Text rein.

TODO: Erstellung einer Makefile.am, Modifizieren der Makefile.am bzw. configure.ac.

TODO: Testen


LIBFX2

Als nächstes widmen wir uns der LIBFX2. Mit ihr wollen wir ein Beispielprogramm erzeugen, das lediglich eine horizontale Linie mit einem Rechteck darunter und einer vertikalen Line daneben (mittels FB) ausgibt.


Stop hand.png An dieser Stelle muss noch Text rein.


Enigma


Stop hand.png An dieser Stelle muss noch Text rein.



Review-KandidatDieser Artikel befindet sich derzeit im Reviewprozess. Hilf mit, ihn zu verbessern! Falls du bei weiteren Artikeln helfen willst, findest du hier eine Auswahl offener Artikel.


Abgerufen von „https://wiki.tuxbox-neutrino.org/w/index.php?title=DBOX2-Modul&oldid=5418“