UUGRN - Benutzerbeiträge [de]

RoarAudio/Vortrag/Grundlagen der digitalen Signalverarbeitung (UKW-Tagung 2013)

2013-08-18T15:14:25Z

Ph3-der-loewe: BEGIN{}

== Abstrakt ==

== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

== Vortrag ==
; Hinweis
: Dies hier ist nur eine Vorbereitung und Stichpunkt Liste. Der eigentliche Vortrag wird interaktiv an einer Tafel gehalten.

=== Das Signal ===
==== Elektrische Größen ====
In der analogen Elektrotechnik werde Signale in aller Regel durch folgende Werte angegeben:
{| class="wikitable"
! Formel
! Bedeutung
! Vorkommen
|-
| u(t)
| Amplitude in Abhängigkeit der Zeit t.
| Dies ist die gebräuchlichste Variante.
|-
| i(t)
| Strom in Abhängigkeit der Zeit t.
| Nur bei speziellen Anwendungen (z.B. Stromreglern).
|-
| U(f)
| Amplitude abhängig von der Frequenz f.
| rowspan="2" | Wir vor allem bei Filtern und Bauelementen mit Filter Eigenschaften (z.B. Verstärkern) verwendet.
|-
| Φ(f)
| Phase abhängig von der Frequenz f.
|-
| R(t)
| Widerstand abhängig von der Zeit t.
| Zum Beispiel bei Temperatur Messungen.
|-
| C(t)
| Kapazität abhängig von der Zeit t.
| Bei Kapazitiven Sensoren.
|-
| L(t)
| Induktivität abhängig von der Zeit t.
| Bei Induktiven Sensoren.
|}

==== Wandler ====
* Analog-Digital-Konverter (ADC oder A/D-Wandler) wandeln Spannungen in digitale Signalen um.
* Digital-Analog-Konverter (DAC oder D/A-Wandler) wandeln digitale Signale in Spannungen um.
* Digitale Signale sind Zeit diskret. Die Abtastfrequenz bestimmt die Bandbreite. Die maximale Bandbreite ist f<sub>max</sub> < ½ * f<sub>Abtast</sub>.
* Digitale Signale sind wertediskret. Die „Sample Breite“ bestimmt den Maximalen Rauchabstand (SNR).

==== digitale Darstellungen ====
''Dieser Bereich geht auf PCM und ähnliche Verfahren ein''

=== Arbeiten mit digitalen Signalen ===
==== Einfache Operationen ====
Wichtige Operationen:
{| class="wikitable"
! Funktion im Zeitbereich
! Funktion im Frequenzbereich
! Name
! Beschreibung
|-
| u<sub>o</sub>(t) = u<sub>i</sub>(t) + a
| U<sub>o</sub>(f) = U<sub>i</sub>(f) + h(f), h(f) = f == 0 ? a : 0
| Gleichspannungsoffset
| Erzeugt ein Gleichspannungsoffset a.
|-
| u<sub>o</sub>(t) = u<sub>i</sub>(t) * a
| U<sub>o</sub>(f) = U<sub>i</sub>(f) * a
| Verstärkung
| Verstärkt das Signal um Faktor a.
|-
| u<sub>o</sub>(t) = u<sub>i</sub>(t - a)
| Φ<sub>o</sub>(f) = Φ<sub>i</sub>(f) - 2aπf
| Translation
| Verzögerung um a.
|-
| g<sub>o</sub>(t) = e<sup>2iatπ</sup> * g<sub>i</sub>(t)
| U<sub>o</sub>(f) = U<sub>i</sub>(f - a)
| Frequenzverschiebung
| Verschiebung der Frequenz um a.
|-
| g<sub>o</sub>(t) = e<sup>ia</sup> * g<sub>i</sub>(t)
| Φ<sub>o</sub>(f) = Φ<sub>i</sub>(f) + a
| Phasenverschiebung
| Verschiebung der Phase um a.
|-
| u<sub>o</sub>(t) = -u<sub>i</sub>(t)
| Φ<sub>o</sub>(f) = Φ<sub>i</sub>(f) ± π
| Phaseninversion
| Verschiebung der Phase um π.
|-
| u<sub>o</sub>(t) = (u<sub>i</sub> * h)(t)
| G<sub>o</sub>(f) = G<sub>i</sub>(f) * H(f)
| Faltung
| Faltung des Signals mit der Funktion ''h''.
|}

==== Digitale Filter ====
''Einfache FIR und IIR Filter (Tiefpass erster Ordnung?)''

=== Ausblicke ===

==== Software Defined Radio (SDR) ====
''SDR am Beispiel von AM und FFT''

==== VAD als digitaler PTT ====
...

==== Blockschaltbilder für digitale Schaltungen ====
...

==== Darstellung von Mehrkanalsignalen ====
...

==== Bitfehler Simulation ====
...

[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio PlayList Daemon/Protokoll

2012-05-24T08:14:44Z

Ph3-der-loewe: /* Fehler Codes */ +NFPROERR

Auf dieser Seite wird auf das ''simple'' Protokoll des [[RoarAudio PlayList Daemon]] eingegangen. Andere durch den rpld unterstützte Protokolle werden hier ignoriert. Die Spezifikationen zu diesen sind bei den entsprechenden Herstellern zu finden beziehungsweise zu erfragen.

== Rahmen Protokoll ==
Das Protokoll besteht aus einer Sequenz von Befehl-Antwort-Paaren. Dabei Sendet der Klient einen Befehl als abgeschlossene Zeile (Terminiert mit ''line feed'', 0x0A, '\n') an den Server und dieser Beantwortet dies dann mit einem Datenbereich gefolgt von einer Status Zeile. Der Datenbereich wird durch eine Zeile die ausschließlich aus einem Punkt besteht Beendet. Sollte eine Zeile im Datenbereich vorkommen die ausschließlich aus einem oder Mehren Punkten besteht so wird ein Punkt vor gehängt um Eindeutigkeit der Ende Sequenz zu garantieren.

Die Statuszeile besteht aus drei oder vier Teilen:
* Dem Vorsatz '>',
* dem Fehler Code,
* dem Fehler Text
* und optional einer Fehlerbeschreibung in Klammern ('(...)').

Die Felder sind jeweils dusch Leerzeichen getrennt.

Beispiel:
C: NOOP
S: .
S: > 0 OK

C: HELP
S: Commands:
S: HELP
S: NOOP
S: PLAY
...
S: .
S: > 0 OK

Implementierungen '''dürfen nur''' die obigen Zeilenenden senden '''solten''' aber auch anderen gängige Zeilenumbrüche Akzeptieren.

== Fehler Codes ==
Folgende Tabelle zeigt die definierten Fehler Codes:

{| class="wikitable"
! Symbolischer Name
! Numerischer Wert
! Versionen
! Fehler Text
! Fehler beschreibung
|-
! OK
| 0
| ab 0.1beta0
| OK
| Der Befehl wurde erfolgreich abgearbeitet.
|-
! ERROR
| 1
| ab 0.1beta0
| Error
| Bei der Abarbeitung des Befehls ist ein Fehler aufgetreten.
|-
! INPROC
| 2
| ab 0.1beta0
| In Process
| Die Abarbeitung wurde wird im Hintergrund fortgesetzt.
|-
! YES
| 3
| ab 0.1beta0
| Yes
| Die Antwort auf die Anfrage ist: Wahr
|-
! NO
| 4
| ab 0.1beta0
| No
| Die Antwort auf die Anfrage ist: Falsch
|-
! PROERR
| 5
| ab 0.1beta0
| Protocol Error
| Es ist ein Protokollfehler aufgetreten. Die Verbindung kann vom Server zurück gesetzt werden.
|-
! GOODBYE
| 6
| ab 0.1beta0
| GoodBye
| Antwort auf den ''QUIT'' Befehl. Die Verbindung wird vom Server zurück gesetzt.
|-
! NOTPERM
| 7
| ab 0.1rc0
| Not Permitted
| Die Operation wird verweigert da sie nicht erlaubt ist mit den Rechten des Klienten
|-
! NFPROERR
| 8
| ab 0.1rc8
| Nicht Fataler Protokollfehler. Normalerweise syntaktischer Fehler.
|-
|}

== Befehle ==
=== Befehle zur Verbindungs-Steuerung ===
==== NOOP ====
Dieser Befehl führt keine Aktion aus sondern bestätigt nur das die Verbindung noch besteht.

==== QUIT ====
Dieser Befehl beendet die Verbindung.

==== HELP ====
Dieser Befehl gibt einen Hilfe-Text zu den Befehlen aus.

==== SETPLAYLIST ====
Dieser Befehl Setzt die aktuelle Wiedergabeliste.

Syntax:
SETPLAYLIST {"Name"|ID}

==== AUTH ====
AUTH [TO AUTHLEV {n|"name"}] USING authtype...
==== UNAUTH ====
Dieser Befehl setzt das ''AccessLevel'' (''ACCLEV'') auf einen gewünschten Wert herunter.

Syntax:
UNAUTH [ACCLEV] {BY n|TO {n|"name"}}

Beispiel:
UNAUTH TO "guest"

=== Befehle zur Steuerung des Abspielvorgangs ===
==== PLAY ====
Dieser Befehl startet den Abspielvorgang.

==== STOP ====
Dieser Befehl beendet hält den Abspielvorgang an.

==== PAUSE ====
Unterbricht das Abspielen oder setzt es fort.

Syntax:
PAUSE {TRUE|FALSE|TOGGLE}

==== NEXT ====
Dieser Befehl wechselt zum nächsten Titel.

==== PREV ====
Dieser Befehl wechselt zum zuletzt gespielten Titel.

==== ISPLAYING ====
Dieser Befehl kann verwendet werden um in Erfahrung zu bringen ob gerade etwas abgespielt wird.

==== SHOWPLYING ====
Dieser Befehl zeigt den aktuellen zustand an. Sollte etwas abgespielt werden so werden weitere Daten zurückgegeben:

Beispiel Ausgabe:
<pre>
STATE RUNNING
LONGGTN long:0xE1D9000000000067
SHORTGTN short:0xE10000BE
UUID uuid:0eafd00b-0b06-4805-a61f-66dc6427b181
META TITLE "Kuschel.FM - Das Kuschelradio!"
MDUC 1
RATE 44100
CHANNELS 2
BITS 16
TIME 196090280 S (2223.246s)
</pre>

{| class="wikitable"
! Feldname
! Feldbedeutung
! Mögliche Werte
|-
! STATE
| Der aktuelle Abspielstatus.
| STOPPED, PAUSE, RUNNING
|-
! LONGGTN
| Lange Globale Titel Nummer
| GTN
|-
! SHORTGTN
| Kurtze Globale Titel Nummer
| GTN
|-
! UUID
| Eindeutiger Identifikator für den Titel
| UUID
|-
! META n
| Meta Datum des Types n
| Zeichenkette
|-
! MDUC
| Meta Daten Aktualisierungs Zähler
| Zahl
|-
! RATE
| Abtastrate
| Zahl
|-
! CHANNELS
| Kanal Anzahl
| Zahl
|-
! BITS
| Abtastbreite
| Zahl
|-
! TIME
| Zeit
| Zahl in Abtastwerten und in Sekunden
|-
|}

==== SHOWIDENTIFIER ====
Zeigt eine Zeichenkette an welche den aktuell abgespielten Titel auf der nächst tieferen Ebene repräsentierte. Dabei kann es sich um eine RoarAudio StreamID, eine Geräte Datei, eine UUID oder ein beliebig geformte andere Zeichenkette handeln. Es ist nicht Garantiert das diese keine Stimmbrüche beinhaltet oder 7-Bit Sauber ist. Die Bedeutung ist nicht weiter im Protokoll Spezifiziert und wird ausschließlich vom Daemon weitergereicht.

Syntax:
SHOWIDENTIFIER

=== Befehle der Lautstärke Steuerung ===
==== SETVOLUME ====
Setzt die Lautstärke.

Syntax:
SETVOLUME new-volume

''new-volume'' kann entweder im Format 'n%' mit n einem Prozentualen Wert von 0..100 sein, oder ein planer Integer im Bereich 0..65535.

==== SHOWVOLUME ====
Zeigt die Aktuelle Lautstärke an.

Ausgabe Beispiel:
VOLUME 65535/65535 100%

=== Befehle zur Steuerung der Haupt Wiedergabewarteschlagen-Spielliste ===
==== LISTQ ====
Zeigt den Inhalt der Haupt Wiedergabewarteschlagen-Spielliste oder einer anderen Wiedergabeliste an.

Syntax:
LISTQ [{"Name"|ID}]

==== FLUSHQ ====
Löscht den Inhalt der Haupt Wiedergabewarteschlagen-Spielliste.

==== SHOWCUR ====
Dieser Befehlt Zeigt den obersten Eintrag in der Haupt Wiedergabewarteschlagen-Spielliste an. Zur Anzeige was gerade gespielt wird ist dieser Befehl nicht geeignet. Dazu muss ''SHOWPLYING'' verwendet werden.

=== Befehle zur Wiedergabelisten Verwaltung ===
==== LISTPLAYLISTS ====
Listet alle Wiedergabelisten auf.

==== SHOWLIST ====
Zeigt die Aktuelle oder eine andere Wiedergabeliste an.

Syntax:
SHOWLIST [{"Name"|ID}]

==== ADDPLAYLIST ====
Fügt eine neue Wiedergabeliste hinzu.

Syntax:
ADDPLAYLIST "Name"

==== DELPLAYLIST ====
Löcht eine Wiedergabeliste.

Syntax:
DELPLAYLIST [{"Name"|ID}]

==== FLUSHPLAYLIST ====
Leert den Inhalt einer Wiedergabeliste.

Syntax:
FLUSHPLAYLIST [{"Name"|ID}]

==== SETPARENTLIST ====
Setzt die Eltern Liste der Aktuellen oder einer anderen Wiedergabeliste.

Syntax:
SETPARENTLIST [OF {"Name"|ID}] [TO] {"Name"|ID}

==== IMPORT ====
Importiert eine Wiedergabeliste aus einer Datei oder vom Aktuellen Datenstrom in die Aktuelle oder eine andere Wiedergabeliste.

Syntax:
IMPORT [{"Name"|ID}] FROM {STDIN|"Filename"} [AS {RPLD|PLS|M3U|VCLT|PLAIN}]

==== EXPORT ====
Exportiert die Aktuelle oder eine andere Wiedergabeliste in eine Datei oder gibt sie über den aktuellen Datenstrom aus.

Syntax:
EXPORT [{"Name"|ID}] TO {STDOUT|"Filename"} [AS {RPLD|PLS|M3U|VCLT|PLAIN}]

=== Befehle zur Wiedergabelisten Eintrags Verwaltung ===
Bei den folgenden Befehlen steht ''PLE'' immer für "''PlayList Entry''" (Wiedergabelisten Eintrag).

==== LISTPLE ====
Zeigt alle Einträge in einer Wiedergabeliste an.
Es werden entweder wie Einträge der aktuellen Liste oder der angegebenen Angezeigt.

Syntax:
LISTPLE [{"Name"|ID}]

==== SHOWPLE ====
Dieser Befehl zeigt einen bestimmten Eintrag an.
Es wird entweder in der aktuellen Liste, in der angegebenen oder in allen Listen gesucht.

Syntax:
SHOWPLE {long:0xLongID|0xLongID|short:0xShortID|uuid:UUID|pointer:name} [FROM {"Name"|ID|ANY}]

==== COPYPLE ====
Dieser Befehl kopiert einen Eintrag aus der aktuellen, einer angegebenen Liste oder einen aus allen Listen gesuchten Eintrag in eine andere Liste.
Eine Position an welcher er in der neuen Liste stehen soll kann optional angegeben werden.
Der neue Eintrag erhält eine neue ''Global Track Number'' sowie ''Short Global Track Number''.

Syntax:
COPYPLE {long:0xLongID|0xLongID|short:0xShortID|uuid:UUID|pointer:name} [FROM {"Name"|ID|ANY}] TO {"Name"|ID} [AT POSITION]

==== MOVEPLE ====
Gleich der Funktion ''COPYPLE'' nur das diese Funktion den Eintrag nicht kopiert sondern verschiebt. Die ''Global Track Number'' sowie ''Short Global Track Number'' bleibt erhalten.

Syntax:
MOVEPLE {long:0xLongID|0xLongID|short:0xShortID|uuid:UUID|pointer:name} [FROM {"Name"|ID|ANY}] TO {"Name"|ID} [AT POSITION]

==== DELPLE ====
Diese Funktion löscht einen Eintrag aus der aktuellen oder einer angegebenen Liste.

Syntax:
DELPLE {long:0xLongID|0xLongID|short:0xShortID|uuid:UUID|pointer:name} [FROM {"Name"|ID}]

==== QUEUEPLE ====
Dieser Befehl ist eine Kurzform des ''COPYPLE'' Befehls bei dem die Ziehlliste immer die Haupt Wiedergabewarteschlagen-Spielliste.

Syntax:
QUEUEPLE {long:0xLongID|0xLongID|short:0xShortID|uuid:UUID|pointer:name} [FROM {"Name"|ID|ANY}] [AT POSITION]

=== Befehle zur Zeigerverwaltung ===
==== SETPOINTER ====
Setzt den angegebenen Wiedergabelistenzeiger auf einen angegebenen Wiedergabelisten Eintrag.

Syntax:
SETPOINTER {CURRENT|DEFAULT|STARTUP|TEMP} {long:0xLongID|0xLongID|short:0xShortID|uuid:UUID|pointer:name} [FROM {"Name"|ID|ANY}]

===== Bedeutungen der Einzelnen Zeiger =====
{| class="wikitable"
! Zeigername
! Gültigkeit
! Zeiger Beschreibung
|-
! CURRENT
| Global
| Sollte die Haupt Wiedergabewarteschlagen-Spielliste leer laufen so wird der Titel auf den dieser Zeiger verweist automatisch in die Spielliste kopiert und dieser Zeiger einen Eintrag weiter geschoben in der Wiedergabeliste in der sich der Eintrag auf den er Zeigt befindet. Auf diese Weise kann eine ''Spiele alles ab hier'' Funktion implementiert werden wie sie viele andere Wiedergabe-Programme besitzen.
|-
! DEFAULT
| Global
| Sollte der ''CURRENT''-Zeiger bei einer Weiterschiebe-Operation an das Ende der Wiedergabeliste stoßen so wird er erneut mit dem Inhalt dieses Zeigers initialisiert. Auf diese weise kann ein ''Wenn am Ende dann beginn vom Neuen'' Funktion wie es viele Wiedergabe-Programme besitzen implementiert werden. Diese Zeiger Logik kann aber auch zur Implementierung höheren Funktionen verwendet werden, wie dem automatischen Wechsel zwischen verschiedenen Listen.
|-
! STARTUP
| Global
| Der Wiedergabelisten Eintrag auf den dieser Zeiger verweist wird beim Starten des Daemons automatisch abgespielt. Dies gescheit bevor die normale Abarbeitung der restlichen Titel in der Haupt Wiedergabewarteschlagen-Spielliste beginnt.
|-
! TEMP
| Klient Verbindung
| Dieser Zeiger ist rein für die Benutzung in einer Klient Applikation bestimmt. Diese könnte ihn zum Beispiel auf den Aktuell in einem [[GUI]] ausgewählten Listeneintrag verwiesen lassen.
|-
|}

==== SHOWPOINTER ====
Zeigt alle oder nur den angebenden Wiedergabelistenzeiger an.

Syntax:
SHOWPOINTER [{CURRENT|DEFAULT|STARTUP|TEMP}]

=== Befehle zur Permanent Speicherung ===
==== STORE ====
Dieser Befehl lässt den Daemon seinen Aktuellen Zustand Speichern.
Dieser kann zum Beispiel vor dem Beenden genutzt werden um den zustand dann wiederherstellen zu können beim nächsten Start. Je nach Parameter wird dieser Befehl vom Daemon beim Beenden eigenständig durchgeführt.

Syntax:
STORE

==== RESTORE ====
Stellt den Zustand wie er mit ''STORE'' gespeichert wurde wieder her.
Dies kann als Beispiel beim Starten des Daemons verwendet werden um den Zustand wieder her zu stellen der beim beenden herrschte. Je nach Parameter wird dieser Befehl vom Daemon selbstständig beim Starten ausgeführt.

''Wichtig:'' Ein mehrfaches verwenden dieses Befehls kann zu Duplikaten führen.

Syntax:
RESTORE

=== Veraltete Befehle ===
Die folgenden Befehle sind veraltet. Sie werden mit Version 0.1.0 voraussichtlich entfernt werden.
Sie sollten auf keinen Fall Verwendung finden.

Syntax:
ADD2Q entry
DELFQ identifier

=== Andere Befehle und geplante Befehle ===
Die folgenden Befehle sind in diesem Dokument nicht beschreiben, oder noch in Planung. Sie sollten aktuell nicht verwendet werden.

SEARCHPLE {"search string"|0xdiscid|uuid} [{AS|IN} {ALL|TITLE|ARTIST|VERSION|FILENAME|DISCID|UUID|TAG:"Tagname"}] [FROM {"Name"|ID|ANY}]
UPDATE [{"Name"|ID|ANY}] {TO|FROM} {STDIN|STDOUT|"Filename"} [AS {RPLD|PLS|M3U|VCLT|XSPF|PLAIN}] USING {ALL|TITLE|ARTIST|VERSION|FILENAME|DISCID|UUID|TAG:"Tagname"} [AND ...] [POLICY {DEFAULT|OLD|NEW} {KEEP|DELETE}]

== Weblinks ==
{{Homepage|roaraudio.keep-cool.org}}

[[Kategorie:RoarAudio]]
[[Kategorie:Software]]
[[Kategorie:Sound]]
{{Stub}}

RoarAudio/Installation und Einrichtung

2012-03-31T01:00:21Z

Ph3-der-loewe: /* ROAR_OPTIONS */ +workaround:no-slp

'''RoarAudio''' ist ein mächtiger Multi Plattform Soundserver. Im folgenden Artikel sollen Installations- und Konfigurations-Hinweise gegeben werden. Für eine Beschreibung der Software siehe Artikel [[RoarAudio]].

Weitere Informationen finden sich auf der Homepage unter [http://roaraudio.keep-cool.org/docs.html Documentation and Wikis]. Hier Gibt es auch ein englisch sprachiges Handbuch.

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Installation ==
=== Installation aus den Sourcen heraus ===
Als erstes sollte man auf die [http://roaraudio.keep-cool.org Homepage] gehen und sich die aktuellen Sources herunterladen. Von dort kann man sich zum Beispiel mittels [[wget]] die Sourcen herunterladen:
$ wget http://roaraudio.keep-cool.org/dl/roaraudio-0.4beta0.tar.gz

Danach muss das Archiv mittels [[tar]] entpackt werden:
$ tar -xzvf roaraudio-0.4beta0.tar.gz

Dann wechselt man in das neue RoarAudio Verzeichnis und führt 'configure' aus:
$ ./configure

Die Übersetzung kann nun erfolgen:
$ [[make]]

Im nächsten Schritt wird das frisch gebackene [[Binary]] nun im System installiert.
$ [[su]]
# make install
beziehungsweise vereinfacht mittels [[sudo]]:
$ [[sudo]] make install

Aufräumen ...
$ make clean

=== archlinux ===
...
=== OpenBSD ===
...
=== Debian ===
Unter Debian stehen Pakete zur Verfügung. Diese können einfach wie folgt installiert werden:
# apt-get install roaraudio roaraudio-extra libroar-compat0

Entwickler sollten weiterhin die Entwiklungspakete installieren:
# apt-get install libroar-dev roaraudio-dbg

== Konfigurieren ==
=== Allgemein ===
Allgemein gesprochen gibt es keine Konfigurationsdateien oder Ähnliches für RoarAudio. Der Daemon wird mittels seiner [[Kommandozeile]]n Parameter konfiguriert. Die Clients mittels deren Konfigurations Dialogen und den Umgebungsvariablen (siehe Unten) sowie deren Kommandozeilen Parametern.

==== Globaler Standard Server Definieren ====

Die Einzige Ausnahme ist die Datei /etc/roarserver. Bei ihr handelt es sich um einen Symlink welcher auf den Globalen Standard Server verweist.

Beispiele:
# ln -s /tmp/.otherroar /etc/roarserver
# ln -s remote.address.example.com /etc/roarserver

==== OpenSLP (ZeroConf) ====
Damit RoarAudio Clients ihren Server im Netzwerk automatisch finden können muss bei diesem OpenSLP aktiviert sein. Dazu reicht es in der Regel schon aus ''--slp'' dem roard mit zu übergeben. Es muss allerdings darauf geachtet werden das für die öffentlichen Listen Sockets mittels --bind eine echte Adresse angegeben ist. Diese kann natürlich auch ein Hostname sein.

Im weiteren kann es Sinn ergeben einen ''slpd'' zu installieren.

==== Server seitige EsounD Emulation ====
Server seitige EsounD Emulation kann aktiviert werden durch das erzeugen eines zusätzlichen Listen Sockets mit der korrekten Protokoll Kennung. Dies gescheit mittels ''--new-sock'' und ''--proto''. Es muss eine andere Adresse und/oder Port für diesen verwendet werden. Dies gescheit mittels der Standard Optionen ''--port'', ''--bind'' und ''--sock''.

Beispiele:
# roard [...] --new-sock --proto esd --sock /tmp/.esd/socket
# roard [...] --new-sock --proto esd --bind 0.0.0.0 --port 16001

=== archlinux ===
...

=== Debian und Debian basierende Systeme ===
Auf Debian Basierenden Systemen gibt es eine Datei namens /etc/default/roaraudio. Sie Beinhaltet alle gängig Einstellmöglichkeiten und ist gut kommentiert.

==== OpenSLP (ZeroConf) ====
Zum einschalten von OpenSLP muss unter Debian und Debian basierenden Systmen nur folgender Eintrag in der Konfigurationsdatei gemacht werden:
ROARD_SLP='YES'

Weiterhin muss wie oben beschreiben ein echter Hostname gesetzt werden, Dies gescheit mittels:
ROARD_HOST='myserver.name'

==== Server seitige EsounD Emulation ====
Zur Verwendung der Server seitigen EsounD Emulation muss unter Debian nur der Parameter ''ROARD_EMUL_ESD_AF'' gesetzt werden.

Beispiele:
ROARD_EMUL_ESD_AF='TCP'
ROARD_EMUL_ESD_AF='UNIX'
ROARD_EMUL_ESD_AF='DECnet'

== Benutzen ==
=== Plugins ===
==== libao ====
Nach der erfolgreichen Installation sollte das libao Plugin 'roar' zur Verfuegung stehen.
Um es als Standard Ausgabe zu benutzen muss folgendes in die Datei /etc/libao.conf geschrieben werden:
default_driver=roar

==== XMMS ====
Ist das XMMS Plugin installiert so lässt es sich unter XMMS einfach in den Plugin Einstellungen auswählen: Man drückt Strg+P und kann es dann unter ''Output Plugin'' finden. Nach dem Klicken auf ''OK'' einfach den laufenden Titel neu starten und das Plugin sollte verwendet werden.

Findet XMMS das Plugin nicht sollte überprüft werden ob roard läuft und XMMS muß gegebenfalls nach dem Starten von roard neu gestartet werden da XMMS dazu neigt, Plugins für nicht beim Start laufende Ausgaben zu verstecken.

Da das Plugin noch keinen Optionen Dialog hat muss der Server gegeben falls wie in Abschnitt [[#Server_ohne_Optionen_des_Players_ausw.C3.A4hlen|Server ohne Optionen des Players auswählen]] gezeigt eingestellt werden.

==== Audacious ====
Zum einrichten des Audacious kann die Anleitung für das XMMS Plugin hergenommen werden. Die aus zu führenden schritte sind die selben.



=== Programme ohne Plugins ===
==== Audacity ====
Audacity kann mittels roarify verwendet werden:
$ roarify audacity

==== GNOME Mixer ====
Der GNOME Mixer sollte von sich aus wunderbar funktionieren sofern das gstreamer Plugin installiert ist. Anderenfalls kann er auch mittels roarify gestartet werden:
$ roarify gnome-volume-control

==== Amarok ====
Amarok funktioniert mittels beider EsounD emulationen (Server seitig oder Client seitig) unter Benutzung der XINE Engine. Diese Muss dazu ausgewählt werden im Konfigurations Dialog. Danach auf den Treiber 'esd' umstellen.

Bei Verwendung der gstreamer Engine kann entweder das RoarAUdio Plugin verwendet werden oder das EsounD Plugin.

==== GNOME ====
GNOME bassirt heute auf gstreamer. Für dieses gibt es ein Plugin das empfohlen wird.

==== KDE ====
Je nach KDE Version kann aRtsd dazu konfiguriert werden EsounD als backend zu benutzen oder in neueren KDE versionen kann ein passendes Phonon Backend eingestellt werden.

==== MPD ====
MPD lässt sich mittels roarify starten wenn der OSS Treiber geladen ist. Der libao Treiber scheint eine macke zu haben und mpd lässt sich gar nicht starten.

MPD lässt sich durch den [[RoarAudio PlayList Daemon]] ersetzen. Dieser ist von hause aus voll mit RoarAudio integriert.

==== MPlayer ====
MPlayer funktioniert wunderbar mittels EsounD Emulation (Client + Server). Ansonsten gibt es ein experimentelles Plugin für MPlayer.

==== Wine ====
Wine kann die Server Seitige EsounD emulation benutzen. Dazu muss ein weiteres Plugin installiert werden. Dies kann dann mittels ''winecfg'' aktiviert werden.

=== Basis Tools ===
RoarAudio kommt mit diversen Basis Tools welche dazu genutzt werden können Dateien abzuspielen, Webradio zu hören und die gemischten Audio Daten wieder weiter zu verwenden.

==== Musik abspielen ====

Audio Dateien (nicht nur RIFF/WAVE) lassen sich am einfachsten mittels ''roarcatplay'' abspielen:
$ roarcatplay foo.wav

Für Ogg/Vorbis Dateien gibt es ein weiteres Programm namens ''roarvorbis'' welches auch Meta Informationen anzeigt:
$ roarvorbis bar.ogg

Zum Abspielen von Musik im Hintergrund ohne einen Player im Vordergrund zu benötigen benutzt man ''roarradio'':
$ roarradio http://www.mein-webradio.org/blubb.ogg

==== Musik speichern und streamen ====
RoarAudio kann Musik nicht nur an Soundcards schicken sondern auch in Dateien oder zu einem [[icecast]] oder ähnlichen Streaming-Server.

Zum Speichern und Auslesen von Musik kann das Programm ''roarmon'' eingesetzt werden:
$ roarmon --codec vorbis output.ogg

''roarmon'' kann auch in Pipes eingesetzt werden:
$ roarmon | myenc -o bla.ext -

Zum Streamen mittels libshout kann ''roarshout'' eingesetzt werden.
$ roarshout myserver.de 8000 hackme /roar.ogg

Die Parameter sind mit denen von [[oggfwd]] kompatibel und lassen sich mittels ''--help'' nachschlagen.

Auch ist es möglich das ''roard'' selbst einen Streaming-Server mittels libshout ansprechen kann:
$ roard -oN -o shout -O http://source:hackme@myserver.de:8000/roar.ogg

Hier erzeugt das -oN ein neues Output ('''o'''utput '''N'''ew) mit dem Treiber ''shout''. Die URL gibt die Adresse des Servers an. Der Eintrag ist gleichbedeutend mit dem aus dem Beispiel von ''roarshout''. Das Wort '''source''' ist hier der Benutzername, er wird bei ''roarshout'' nicht angeben da er der Standard Wert ist muss hier aber angegeben werden Grunds der syntaktischen Korrektheit.

==== Steuerung mittels roarctl ====
===== Server Status =====
Der Server lässt sich mittels folgendem Befehlen beenden:
$ roarctl exit # Sofort beenden
$ roarctl terminate # Beenden sobald alle Clients disconnected sind (Bei vielen Playern: Nach dem aktuellen Titel)

Auserdem kann der Server in den Standby Mode versetzt werden:
$ roarctl standby # oder..
$ roarctl off # In den Standby gehen
$ roarctl resume # oder ...
$ roarctl on # In den normal Modus gehen

Abgefragt werden kann der aktuelle Status mittels des Befehls ''standbymode'':
$ roarctl standbymode

===== Client und Stream Informationen Auslesen =====
Mit dem Befehl ''allinfo'' lassen sich nahe zu alle Informationen über Clients und Streams ausgeben:
$ roarctl allinfo

Es gibt auch spezialisiertere Befehle:
$ roarctl serveroinfo # Informationen über des Servers Mischer
$ roarctl listclients # Informationen über die Clients (Player)
$ roarctl liststreams # Informationen über die Streams

Die Befehle lassen sich mit dem Parameter ''-v'' (verbose - Erweiterte Anzeige) kombinieren.

===== Clients und Streams Manipulieren =====
Es gibt mehrere Manipulation die zur Laufzeit erfolgen können. Eine der wichtigsten ist es einen Client oder Stream zu kicken:

$ roarctl kick client 123
$ roarctl kick stream 123

Weitere Optionen können für Streams verändert werden. Eine weitere wichtige ist die Lautstärke. Sie lässt sich mittels ''volume'' verstellen:

$ roarctl volume 123 mono 50%

Dieser Befehl setzt die Lautstärke auf 50% für den Stream 123. Zu beachten ist hier das ''mono''. Es gibt an das man die Lautstärke für einen Kanal setzen will. Wenn der Stream mehr Kanäle hat, meist 2 für Stereo, so versucht ''roarctl'' sinnvoll fortzusetzen: in diesem Falle wird die Lautstärke für alle Kanäle gesetzt.

Möchte man den Pegel für den rechten und linken Kanal getrennt steuern so kann man das Schlüsselwort ''stereo'' verwenden:

$ roarctl volume 123 stereo 80% 30%

Dies setzt die Lautstärke auf 80% Links und 30% Rechts. Hat man mehr als 2 Kanäle kann man auch die Anzahl der Kanäle explizit angeben. In diesem Falle muss die Anzahl der weiteren Parametern exakt der Kanalanzahl entsprechen, zum Beispiel:

$ roarctl volume 123 4 20% 40% 60% 80%

Anstatt prozentualer Angaben können auch absolute gemacht werden. Die Skala reicht von 0 bis 65535 (inklusive):

$ roarctl volume 123 mono 8192

Weiterhin ist es mit Neueren Versionen auch möglich angaben in dB zu benutzen sofern Unterstützung für die Standard Mathematik Bibliothek mit einkompiliert wurde:

$ roarctl volume 123 mono -12dB

==== Zwei Soundserver miteinander verbinden ====
RoarAudio kann zwei Soundserver mit einander in verschiedensten weisen Koppeln. Hierzu dient das Tool roarinterconnect.

Um dies zu tun muss man die Adressen der Server angeben und Informationen über den Type der Verbindung.
Sollten keine Server angegeben werden wird als lokaler Server der default Server benutzt und der entfernte Server wird versucht via OpenSLP auf zu lösen.

===== Typen =====
Die Typenangabe ist in zwei teile aufgeteilt: der Server Type (Protokoll) und der Verbindungs Type (Stream Type).
Die Folgenden Server Typen gibt es im Moment:
* '''roar''' für RoarAudio Server
* '''esd''' für [[EsounD]] Server
* '''simple''' für PulseAudio ''simple'' Protokoll
* '''oss''' für [[OSS]] Geräte Dateien

Die Verbindungs Typen sind die folgenden:
* '''bidir''' für eine bidirektionale Verbindung (nur RoarAudio, default)
* '''filter''' um einen Soundserver als Filter für den Anderen zu verwenden
* '''transmit''' um lediglich die Lokale Ausgabe auf den entfernten Server zu spiegeln
* '''receive''' um die Ausgabe des entfernten Servers auf den lokalen zu spiegeln

===== Beispiele =====
$ roarinterconnect --type transmit --remote stereoanlage.local

===== Einschränkungen =====
Der als lokaler Server angegebene Server muss die Fähigkeit haben ''Background Streams'' zu verwenden und es muss ich um einen RoarAudio Server handeln. Andere Protokolle sind hier nicht unterstützt.

=== Kompatibilitäts Layer ===
{{Minimal Version|0.2beta3|RoarAudio}}
Mittels des Tools ''roarify'' können Kompatibilitäts Bibliotheken geladen sowie Kompatibilitäts Binarys ausgeführt werden. Dazu wird roarify einfach der Name des Programms über geben welches mit den Kompatibilitäts Bibliotheken geladen werden soll, beziehungsweise das Programm welches emuliert werden soll:

$ roarify myplayer
$ roarify mplayer -ao esd bla.ogg
$ roarify aucat ...
$ roarify esd
$ roarify artsplay ...

==== Liste der Kompatibilitäts Biblotheken ====
{| class="wikitable"
! Name
! Kompatibel zu
! Ab Version
! Beschreibung
|-
| libroaresd
| Enlightened Sound Daemon
| 0.1
| Client seitige Binär kompatible EsounD Emulation. Nahezu alle Applikationen funktionieren mit dieser einwandfrei.
|-
| libroarpulse-simple
| PulseAudio<br>Simple API
| 0.1
| Client seitige Binär kompatible PulseAudio Emulation. Hierbei handelt es sich um eine Emulation der ''Simple API''. Nicht alle Clients laufen damit. (Name bei Version 0.3beta5 geändert.)
|-
| libroarpulse
| PulseAudio<br>Asynchrone API
| 0.3beta5
| Client seitige Binär kompatible PulseAudio Emulation. Hierbei handelt es sich um die Haupt API. Diese wird zum teil unterstützt. Einige Programme laufen damit.
|-
| libroararts
| aRts - KDE Sound System
| 0.1
| Eine Cleint seitige binär kompatible aRtsc Emulation. Die meisten Programme laufen mit ihr. Die meisten die nicht mit ihr laufen haben höchst fragwürdige aRtsc Plugins weswegen viele Distributoren die besagten Plugins aus den Paketen entfernt haben.
|-
| libroaryiff
| YIFF Sound System
| 0.1beta2
| Eine binär kompatible Emulation der YIFF Sound System API. Die Emulation umfasst alle dokumentierten teile der API inklusive der Teile welche durch die original Bibliothek nicht implementiert sind. Einige Veränderungen wurden durchgeführt um eklatante Sicherheitslöcher zu schließen. Diese Änderungen sollten die meisten Applikationen nicht beeinträchtigen. Genaue Tests liegen aber nicht vor aufgrund des mangels an Applikationen welche das YIFF Sound System benutzen.
|-
| libroarsndio
| OpenBSD sndio
| 0.2beta3
| Eine Emulation des aktuellen OpenBSD Sound Interfaces (sndio). Sie ist auch auf nicht OpenBSD Systemen funktionsfähig und kann als Portierungshilfe verwendet werden. Sie ist nahezu vollständig und wir unter stetiger Kommunikation mit dem OpenBSD sndio Team entwickelt.
|-
| libroaross
| Open Sound System (OSS)
| 0.3beta3
| Hierbei handelt es sich um eine preload Bibliothek welche das Open Sound System emuliert. Die meiste Software läuft mit dieser Emulation einwandfrei. Es handelt sich um eine der besten OSS Emulationen gemessen an der menge der Software welche damit läuft.
|-
| libroaross
| DMX4Linux
| 0.3beta4
| DMX4Linux Emulation. Derzeit nur schreib Support. Lese Support kann mittels dmx Treiber emulirt werden.
|-
| libroarrsound
| RSound
| 0.3beta5
| Eine binär kompatible Emulation des der librsound des RSound Sound Systems. Da das RSound Sound System noch extrem jung ist herrscht hier noch eine gewissen Instabilität.
|}

==== Liste der Kompatibilitäts Binarys ====
{{Minimal Version|0.3beta2|RoarAudio}}
{| class="wikitable"
! Sound Systen Name
! Ab Version
! Beinhaltete Tools
|-
| EsounD
| 0.3beta2
| esd esdcat esdfilt esdmon esdplay (''ab 0.3beta5:'') esddsp
|-
| aRts
| 0.3beta3
| artsd artscat artsplay (''ab 0.3beta5:'') artsdsp
|-
| NAS
| 0.3beta3
| auplay (''ab 0.3beta5:'') audial audiooss*
|-
| YIFF Sound System
| 0.3beta3
| yiff yplay yshutdown
|-
| PulseAudio
| 0.3beta3
| pacat paplay (''ab 0.3beta5:'') padsp
|-
| dtmfdial
| 0.3beta5
| dtmfdial
|-
| RSound
| 0.3beta6
| ross rsd
|-
|}

* = ''audiooss'' ist ein externes Paket und gehört nicht zu NAS direkt dazu. Es wird aber von offizieller Seite auf audiooss verwiesen.

==== Liste der unterstützten Protokolle ====
{| class="wikitable"
! Protokoll Name
! Ab Version
! Beschreibung/Kommentare
|-
| RoarAudio (nativ)
| 0.1
| Das native RoarAudio Protokoll.
|-
| EsounD
| 0.3beta0
| Eine nahe zu komplette EsounD Emulation auf Server Seite. Nahe zu alle Applikationen funktioniren mit dieser Emulation unter Verwendung der original Client Bibliothek.
|-
| Simple
| 0.3beta4
| Das PulseAudio Simple Protokoll. Alle nötigen Parameter können mittels der ''--proto-*'' Optionen gesetzt werden. Der Standardwert liegt auf Playback-Stream und den nativen Audio Parametern des roards.
|-
| RSound
| 0.3beta5
| Das Protokoll der RSound Netzwerk-Sound Abstraktionsebene (''schlanker Sound Server'').
|-
| RPlay
| 0.3beta7
| Emulation eines Subsets des Protokolls des RPlay sound servers
|-
|}

=== Umgebungsvariablen ===
==== Übersicht ====
Diese Übersicht zeigt die wichtigsten Umgebungsvariablen auf. Weitere werden durch die Kompatibilitäts Layer verwendet.

{| class="wikitable"
! Variable
! Beispiel
! Beschreibung
|-
| HOME
| /home/phi
| Heimatverzeichnis des Benutzers
|-
| USER
| phi
| Aktueller Benutzername
|-
| TERM
| xterm
| Aktueller [[Terminal]] Type
|-
| DISPLAY
| :0
| Adresse des benutzen [[X11]] Servers
|-
| ROAR_SERVER
| remote.example.com
| Adresse des Daemons
|-
| ROAR_OPTIONS
| workaround:use-execed
| Optionen für libroar
|-
| CDDA_DEVICE
| /dev/cdrom
| Device Name für [[CDDA]] (Audio CDs) Zugriff
|-
| ROAR_PROXY
| ssh
| Zu verwendeter Proxy Type
|-
| http_proxy
| http://localhost:8118/
| Adresse des [[HTTP]] Proxys
|-
| socks_proxy
| localhost:1080
| Adresse des [[SOCKS]] Proxys
|-
| ssh_proxy
| myserver.remote.network
| Adresse des [[SSH]] Servers der als Proxy dienen soll
|-
|}

==== ROAR_OPTIONS ====
Die Umgebungsvariable ''$ROAR_OPTIONS'' besteht aus durch Leerzeichen getrennten Options Zeichenketten.

{| class="wikitable"
! Parameter
! Unter-Parameter
! Beispiel
! Beschreibung
|-
| #/Leer-Option
| (keine)
| #Ein_Kommentar
| Leere Optionen und Optionen welche mit einem # beginnen werden ignoriert.
|-
| workaround
| (mehrere)
| workaround:use-execed
| Steuert die Verwendung von Workarounds.
|-
| workaround
| use-execed
| workaround:use-execed
| Setzt das benutzen des use-execed-Workarounds. Dieser kann helfen wenn sich ein NAT-Gateway zwischen Server und Client befindet.
|-
| workaround
| no-slp
| workaround:no-slp
| Schaltet die Verwendung von OpenSLP aus.
|-
| warning/warn
| (mehrere)
| warn:sysio
| Steuert die Verwendung von Warnungen.
|-
| warning/warn
| sysio
| warn:sysio
| Schaltet Warnungen ein die auf sysio verwendenden Code hinweisen. Dies kann Entwicklern bei schreiben Portabler Software helfen.
|-
| warning/warn
| obsolete
| warn:obsolete
| Warnt bei Aufruf von Funktionen die als ''veraltet'' makeirt sind. Dies soll Entwicklern helfen ihre Software auf einem aktuellen stand zu halten und ''Faild to build from source''-Fehlern vor zu beugen.
|-
| warning/warn
| all
| warn:all
| Schaltet alle Warnungen ein.
|-
| force-rate
| (keine)
| force-rate:44100
| Erzwingt die eine bestimmte Abtastrate bei allen Streams.
|-
| force-bits
| (keine)
| force-bits:16
| Erzwingt die eine bestimmte Anzahl von Bits pro Abtastwert bei allen Streams.
|-
| force-channels
| (keine)
| force-channels:2
| Erzwingt die eine bestimmte Anzahl von Kanälen bei allen Streams.
|-
| force-codec
| (keine)
| force-codec:pcm_s_be
| Erzwingt die einen bestimmten [[Codec]] bei allen Streams.
|-
| codec
| (mehrere)
| codec:vorbis:q:1
| Setzt Optionen für Codecs.
|-
| codec
| quality/q
| codec:vorbis:q:1
| Setzt den Qualitätswert für einen Codec.
|-
| codec
| complexity
| codec:roar_speex:complexity:8
| Setzt die Komplexität mit welcher der Codec arbeiten soll.
|-
| codec
| dtx
| codec:roar_speex:dtx:true
| Setzt das DTX Flag eines Codecs.
|-
| codec
| cc-max
| codec:roar_celt:cc-max:80
| Setzt die Größe des CC-Puffers eines Codecs.
|-
| codec
| vbr
| codec:vorbis:vbr:true
| Setzt das VBR Flag eines Codecs.
|-
| codec
| mode
| codec:roar_speex:mode:wb
| Setzt den den Modus für einen Codec. (Werte für Speex: nb, wb, uwb)
|-
| set-server
| (keine)
| set-server:/tmp/otherserver
| Setzt den libroar/Applications Standard Server. Dies sollte nur unter seltenen Umständen getan werden. ''$ROAR_SERVER'' sollte in den allermeisten fällen Verwendung finden.
|-
| set-authfile
| (keine)
| set-authfile:/home/phi/.roarauth
| Setzt die Datei mit den Authentifikations-Cookies.
|-
| x11-display
| (keine)
| x11-display::4
| Setzt das X11 Display, überschreibt $DISPLAY.
|-
| trap-policy
| (keine)
| trap-policy:warn
| Setzt die default Aktion die bei einem Trap ausgeführt werden soll. Mögliche Parameter sind: ignore, warn, abort, kill, stop und die. Nicht alle Parameter sind auf allen Plattformen verfügbar.
|-
| daemonimage
| (keine)
| daemonimage:/home/phi/bin/roard
| Setzt das Standard Image (Programmdatei) des Servers für die Verwendung von Adressen im +fork-Namensraum.
|-
| serverflags
| (mehrere)
| serverflags:nonblock
| Setzt Flags für den Verbindungsaufbau.
|-
| serverflags
| nonblock
| serverflags:nonblock
| Verbietet das Verwenden von Langsamen Verbindungsverfahren (Nicht alle Server werden gefunden wenn diese Option gesetzt ist).
|-
| serverflags
| hardnonblock
| serverflags:hardnonblock
| Verbietet das Verwenden von Langsamen Verbindungsverfahren und ist strenger als nonblock (Nicht alle Server werden gefunden wenn diese Option gesetzt ist).
|-
| serverflags
| localonly
| serverflags:localonly
| Verbietet das Verbinden mit nicht lokalen Servern. Da nicht immer erkannt werden kann ob ein Server Lokal ist kann bei Verwendung dieser Option weder garantiert werden das nur Lokale Server angesprochen werden noch das alle lokalen Server gefunden werden.
|-
| protocolversion
| (keine)
| protocolversion:2
| Setzt die Standard Protokoll Version. Sollte nur in Ausnahmefällen verwendet werden.
|-
|}

==== Liste der Umgebungsvariablen der Kompatibilitäts Layer ====
Diese Übersicht zeigt die Umgebungsvariablen der Kompatibilitäts Layer auf.

{| class="wikitable"
! Variable
! Layer
! Beispiel
! Beschreibung
|-
| ESPEAKER
| libroaresd
| some.remote.server
| Server Name des RoarAudio Servers auf den verbunden werden soll.
|-
| PULSE_SERVER
| libroarpulse
| some.remote.server
| Server Name des RoarAudio Servers auf den verbunden werden soll.
|-
| AUDIODEVICE
| libroarsndio
| aucat:0
| Server Name, RoarAudio Server Adresse oder sndio Device Name für Waveform (PCM) Daten
|-
| MIDIDEVICE
| libroarsndio
| rmidi:0
| Server Name, RoarAudio Server Adresse oder sndio Device Name für MIDI Daten
|-
| ROAR_OSS_KEEP_SESSION
| libroaross
| (keine oder beliebiger Inhalt)
| Hält die Verbindung zum RoarAudio Server offen auch wenn alle Audio Devices geschlossen sind. Kann bei einigen (verbugten) Applikation die Performance stark verbessern.
|-
| ROAR_OSS_CLIENT_NAME
| libroaross
| MyPlayer
| Name der für den Client verwendet werden soll.
|-
| RSD_SERVER
| libroarrsound
| some-server
| Server Name, RoarAudio Server Adresse.
|-
|}



=== Server Adresse ===
Die Adresse des Server muss in bestimmter Form vorliegen je nach Protokoll. Die Tabelle listet Alle Formate auf.

{| class="wikitable"
! Protokoll
! Format
! Beispiel
! Standard Werte
! Beschreibung
|-
| [[UNIX]]
| /pfad
| /home/phi/.roar
| ~/.roar, /tmp/roar
| Pfad zum UNIX Socket.
|-
| [[IPv4]]
| host[:port]
| myserver.local:16002
| localhost:16002
| Hostname und gegebenenfalls Port des Servers.
|-
| [[DECnet]]
| [node]::[object]
| remnod::
| localnode::roar
| Node Name und gegebenenfalls Objekt Name des Servers.
|-
| Spezial
| +fork
| +fork
| ''(keiner)''
| [[Fork]]et für den Prozess eine eigenen Instanz des Sound Daemons.
|-
| Spezial
| +slp
| +slp
| +slp
| Sucht nach dem Sound Daemon explizit mittels [[OpenSLP]]. Dies ist dann nötig wenn sich unter den Standard Adressen ein laufender roard befindet und OpenSLP explizit benutzt werden soll.
|-
| Spezial/[[UNIX]]
| +abstract
| +abstract
| +abstract
| Verwendet einen UNIX Domain Socket im Abstrakten Namensraum. Dieser ist von allen Prozessen des Systems aus gleichermaßen erreichbar. Dies gilt auch für Prozesse innerhalb einer [[chroot|chroot(2)]] Umgebung.
|-
|}

== Tips und Tricks ==
=== Server ohne Optionen des Players auswählen ===
Einige Player haben keine Möglichkeit einen Server einzustellen oder man möchte eine globale Einstellung treffen. Hierzu gibt es zwei Möglichkeiten:

Zum einen lässt sich global ein Server einstellen in dem man ein [[symlink]] mit dem Namen ''/etc/roarserver'' erstellt der auf den Server zeigt. Hier ein paar Beispiele:
$ ln -s /tmp/roarsock /etc/roarserver
$ ln -s remote.host.name /etc/roarserver
$ ln -s mynode:: /etc/roarserver

Die andere Möglichkeit ist es die [[Umgebungsvariable]] ROAR_SERVER zu setzen:
$ ROAR_SERVER=remote.host.name myplayer ...
$ export ROAR_SERVER=remote.host.name # bash
% setenv ROAR_SERVER remote.host.name # csh
$ myplayer ...

== Siehe auch ==
* [[RoarAudio]]

== Weblinks ==
* [http://roaraudio.keep-cool.org/ RoarAudio Homepage]

[[Kategorie:RoarAudio]]
[[Kategorie:Software]]
[[Kategorie:Sound]]
{{Stub}}

RoarAudio/Installation und Einrichtung

2012-03-31T00:58:00Z

Ph3-der-loewe: /* ROAR_OPTIONS */ update: +protocolversion, serverflags und daemonimage.

'''RoarAudio''' ist ein mächtiger Multi Plattform Soundserver. Im folgenden Artikel sollen Installations- und Konfigurations-Hinweise gegeben werden. Für eine Beschreibung der Software siehe Artikel [[RoarAudio]].

Weitere Informationen finden sich auf der Homepage unter [http://roaraudio.keep-cool.org/docs.html Documentation and Wikis]. Hier Gibt es auch ein englisch sprachiges Handbuch.

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Installation ==
=== Installation aus den Sourcen heraus ===
Als erstes sollte man auf die [http://roaraudio.keep-cool.org Homepage] gehen und sich die aktuellen Sources herunterladen. Von dort kann man sich zum Beispiel mittels [[wget]] die Sourcen herunterladen:
$ wget http://roaraudio.keep-cool.org/dl/roaraudio-0.4beta0.tar.gz

Danach muss das Archiv mittels [[tar]] entpackt werden:
$ tar -xzvf roaraudio-0.4beta0.tar.gz

Dann wechselt man in das neue RoarAudio Verzeichnis und führt 'configure' aus:
$ ./configure

Die Übersetzung kann nun erfolgen:
$ [[make]]

Im nächsten Schritt wird das frisch gebackene [[Binary]] nun im System installiert.
$ [[su]]
# make install
beziehungsweise vereinfacht mittels [[sudo]]:
$ [[sudo]] make install

Aufräumen ...
$ make clean

=== archlinux ===
...
=== OpenBSD ===
...
=== Debian ===
Unter Debian stehen Pakete zur Verfügung. Diese können einfach wie folgt installiert werden:
# apt-get install roaraudio roaraudio-extra libroar-compat0

Entwickler sollten weiterhin die Entwiklungspakete installieren:
# apt-get install libroar-dev roaraudio-dbg

== Konfigurieren ==
=== Allgemein ===
Allgemein gesprochen gibt es keine Konfigurationsdateien oder Ähnliches für RoarAudio. Der Daemon wird mittels seiner [[Kommandozeile]]n Parameter konfiguriert. Die Clients mittels deren Konfigurations Dialogen und den Umgebungsvariablen (siehe Unten) sowie deren Kommandozeilen Parametern.

==== Globaler Standard Server Definieren ====

Die Einzige Ausnahme ist die Datei /etc/roarserver. Bei ihr handelt es sich um einen Symlink welcher auf den Globalen Standard Server verweist.

Beispiele:
# ln -s /tmp/.otherroar /etc/roarserver
# ln -s remote.address.example.com /etc/roarserver

==== OpenSLP (ZeroConf) ====
Damit RoarAudio Clients ihren Server im Netzwerk automatisch finden können muss bei diesem OpenSLP aktiviert sein. Dazu reicht es in der Regel schon aus ''--slp'' dem roard mit zu übergeben. Es muss allerdings darauf geachtet werden das für die öffentlichen Listen Sockets mittels --bind eine echte Adresse angegeben ist. Diese kann natürlich auch ein Hostname sein.

Im weiteren kann es Sinn ergeben einen ''slpd'' zu installieren.

==== Server seitige EsounD Emulation ====
Server seitige EsounD Emulation kann aktiviert werden durch das erzeugen eines zusätzlichen Listen Sockets mit der korrekten Protokoll Kennung. Dies gescheit mittels ''--new-sock'' und ''--proto''. Es muss eine andere Adresse und/oder Port für diesen verwendet werden. Dies gescheit mittels der Standard Optionen ''--port'', ''--bind'' und ''--sock''.

Beispiele:
# roard [...] --new-sock --proto esd --sock /tmp/.esd/socket
# roard [...] --new-sock --proto esd --bind 0.0.0.0 --port 16001

=== archlinux ===
...

=== Debian und Debian basierende Systeme ===
Auf Debian Basierenden Systemen gibt es eine Datei namens /etc/default/roaraudio. Sie Beinhaltet alle gängig Einstellmöglichkeiten und ist gut kommentiert.

==== OpenSLP (ZeroConf) ====
Zum einschalten von OpenSLP muss unter Debian und Debian basierenden Systmen nur folgender Eintrag in der Konfigurationsdatei gemacht werden:
ROARD_SLP='YES'

Weiterhin muss wie oben beschreiben ein echter Hostname gesetzt werden, Dies gescheit mittels:
ROARD_HOST='myserver.name'

==== Server seitige EsounD Emulation ====
Zur Verwendung der Server seitigen EsounD Emulation muss unter Debian nur der Parameter ''ROARD_EMUL_ESD_AF'' gesetzt werden.

Beispiele:
ROARD_EMUL_ESD_AF='TCP'
ROARD_EMUL_ESD_AF='UNIX'
ROARD_EMUL_ESD_AF='DECnet'

== Benutzen ==
=== Plugins ===
==== libao ====
Nach der erfolgreichen Installation sollte das libao Plugin 'roar' zur Verfuegung stehen.
Um es als Standard Ausgabe zu benutzen muss folgendes in die Datei /etc/libao.conf geschrieben werden:
default_driver=roar

==== XMMS ====
Ist das XMMS Plugin installiert so lässt es sich unter XMMS einfach in den Plugin Einstellungen auswählen: Man drückt Strg+P und kann es dann unter ''Output Plugin'' finden. Nach dem Klicken auf ''OK'' einfach den laufenden Titel neu starten und das Plugin sollte verwendet werden.

Findet XMMS das Plugin nicht sollte überprüft werden ob roard läuft und XMMS muß gegebenfalls nach dem Starten von roard neu gestartet werden da XMMS dazu neigt, Plugins für nicht beim Start laufende Ausgaben zu verstecken.

Da das Plugin noch keinen Optionen Dialog hat muss der Server gegeben falls wie in Abschnitt [[#Server_ohne_Optionen_des_Players_ausw.C3.A4hlen|Server ohne Optionen des Players auswählen]] gezeigt eingestellt werden.

==== Audacious ====
Zum einrichten des Audacious kann die Anleitung für das XMMS Plugin hergenommen werden. Die aus zu führenden schritte sind die selben.



=== Programme ohne Plugins ===
==== Audacity ====
Audacity kann mittels roarify verwendet werden:
$ roarify audacity

==== GNOME Mixer ====
Der GNOME Mixer sollte von sich aus wunderbar funktionieren sofern das gstreamer Plugin installiert ist. Anderenfalls kann er auch mittels roarify gestartet werden:
$ roarify gnome-volume-control

==== Amarok ====
Amarok funktioniert mittels beider EsounD emulationen (Server seitig oder Client seitig) unter Benutzung der XINE Engine. Diese Muss dazu ausgewählt werden im Konfigurations Dialog. Danach auf den Treiber 'esd' umstellen.

Bei Verwendung der gstreamer Engine kann entweder das RoarAUdio Plugin verwendet werden oder das EsounD Plugin.

==== GNOME ====
GNOME bassirt heute auf gstreamer. Für dieses gibt es ein Plugin das empfohlen wird.

==== KDE ====
Je nach KDE Version kann aRtsd dazu konfiguriert werden EsounD als backend zu benutzen oder in neueren KDE versionen kann ein passendes Phonon Backend eingestellt werden.

==== MPD ====
MPD lässt sich mittels roarify starten wenn der OSS Treiber geladen ist. Der libao Treiber scheint eine macke zu haben und mpd lässt sich gar nicht starten.

MPD lässt sich durch den [[RoarAudio PlayList Daemon]] ersetzen. Dieser ist von hause aus voll mit RoarAudio integriert.

==== MPlayer ====
MPlayer funktioniert wunderbar mittels EsounD Emulation (Client + Server). Ansonsten gibt es ein experimentelles Plugin für MPlayer.

==== Wine ====
Wine kann die Server Seitige EsounD emulation benutzen. Dazu muss ein weiteres Plugin installiert werden. Dies kann dann mittels ''winecfg'' aktiviert werden.

=== Basis Tools ===
RoarAudio kommt mit diversen Basis Tools welche dazu genutzt werden können Dateien abzuspielen, Webradio zu hören und die gemischten Audio Daten wieder weiter zu verwenden.

==== Musik abspielen ====

Audio Dateien (nicht nur RIFF/WAVE) lassen sich am einfachsten mittels ''roarcatplay'' abspielen:
$ roarcatplay foo.wav

Für Ogg/Vorbis Dateien gibt es ein weiteres Programm namens ''roarvorbis'' welches auch Meta Informationen anzeigt:
$ roarvorbis bar.ogg

Zum Abspielen von Musik im Hintergrund ohne einen Player im Vordergrund zu benötigen benutzt man ''roarradio'':
$ roarradio http://www.mein-webradio.org/blubb.ogg

==== Musik speichern und streamen ====
RoarAudio kann Musik nicht nur an Soundcards schicken sondern auch in Dateien oder zu einem [[icecast]] oder ähnlichen Streaming-Server.

Zum Speichern und Auslesen von Musik kann das Programm ''roarmon'' eingesetzt werden:
$ roarmon --codec vorbis output.ogg

''roarmon'' kann auch in Pipes eingesetzt werden:
$ roarmon | myenc -o bla.ext -

Zum Streamen mittels libshout kann ''roarshout'' eingesetzt werden.
$ roarshout myserver.de 8000 hackme /roar.ogg

Die Parameter sind mit denen von [[oggfwd]] kompatibel und lassen sich mittels ''--help'' nachschlagen.

Auch ist es möglich das ''roard'' selbst einen Streaming-Server mittels libshout ansprechen kann:
$ roard -oN -o shout -O http://source:hackme@myserver.de:8000/roar.ogg

Hier erzeugt das -oN ein neues Output ('''o'''utput '''N'''ew) mit dem Treiber ''shout''. Die URL gibt die Adresse des Servers an. Der Eintrag ist gleichbedeutend mit dem aus dem Beispiel von ''roarshout''. Das Wort '''source''' ist hier der Benutzername, er wird bei ''roarshout'' nicht angeben da er der Standard Wert ist muss hier aber angegeben werden Grunds der syntaktischen Korrektheit.

==== Steuerung mittels roarctl ====
===== Server Status =====
Der Server lässt sich mittels folgendem Befehlen beenden:
$ roarctl exit # Sofort beenden
$ roarctl terminate # Beenden sobald alle Clients disconnected sind (Bei vielen Playern: Nach dem aktuellen Titel)

Auserdem kann der Server in den Standby Mode versetzt werden:
$ roarctl standby # oder..
$ roarctl off # In den Standby gehen
$ roarctl resume # oder ...
$ roarctl on # In den normal Modus gehen

Abgefragt werden kann der aktuelle Status mittels des Befehls ''standbymode'':
$ roarctl standbymode

===== Client und Stream Informationen Auslesen =====
Mit dem Befehl ''allinfo'' lassen sich nahe zu alle Informationen über Clients und Streams ausgeben:
$ roarctl allinfo

Es gibt auch spezialisiertere Befehle:
$ roarctl serveroinfo # Informationen über des Servers Mischer
$ roarctl listclients # Informationen über die Clients (Player)
$ roarctl liststreams # Informationen über die Streams

Die Befehle lassen sich mit dem Parameter ''-v'' (verbose - Erweiterte Anzeige) kombinieren.

===== Clients und Streams Manipulieren =====
Es gibt mehrere Manipulation die zur Laufzeit erfolgen können. Eine der wichtigsten ist es einen Client oder Stream zu kicken:

$ roarctl kick client 123
$ roarctl kick stream 123

Weitere Optionen können für Streams verändert werden. Eine weitere wichtige ist die Lautstärke. Sie lässt sich mittels ''volume'' verstellen:

$ roarctl volume 123 mono 50%

Dieser Befehl setzt die Lautstärke auf 50% für den Stream 123. Zu beachten ist hier das ''mono''. Es gibt an das man die Lautstärke für einen Kanal setzen will. Wenn der Stream mehr Kanäle hat, meist 2 für Stereo, so versucht ''roarctl'' sinnvoll fortzusetzen: in diesem Falle wird die Lautstärke für alle Kanäle gesetzt.

Möchte man den Pegel für den rechten und linken Kanal getrennt steuern so kann man das Schlüsselwort ''stereo'' verwenden:

$ roarctl volume 123 stereo 80% 30%

Dies setzt die Lautstärke auf 80% Links und 30% Rechts. Hat man mehr als 2 Kanäle kann man auch die Anzahl der Kanäle explizit angeben. In diesem Falle muss die Anzahl der weiteren Parametern exakt der Kanalanzahl entsprechen, zum Beispiel:

$ roarctl volume 123 4 20% 40% 60% 80%

Anstatt prozentualer Angaben können auch absolute gemacht werden. Die Skala reicht von 0 bis 65535 (inklusive):

$ roarctl volume 123 mono 8192

Weiterhin ist es mit Neueren Versionen auch möglich angaben in dB zu benutzen sofern Unterstützung für die Standard Mathematik Bibliothek mit einkompiliert wurde:

$ roarctl volume 123 mono -12dB

==== Zwei Soundserver miteinander verbinden ====
RoarAudio kann zwei Soundserver mit einander in verschiedensten weisen Koppeln. Hierzu dient das Tool roarinterconnect.

Um dies zu tun muss man die Adressen der Server angeben und Informationen über den Type der Verbindung.
Sollten keine Server angegeben werden wird als lokaler Server der default Server benutzt und der entfernte Server wird versucht via OpenSLP auf zu lösen.

===== Typen =====
Die Typenangabe ist in zwei teile aufgeteilt: der Server Type (Protokoll) und der Verbindungs Type (Stream Type).
Die Folgenden Server Typen gibt es im Moment:
* '''roar''' für RoarAudio Server
* '''esd''' für [[EsounD]] Server
* '''simple''' für PulseAudio ''simple'' Protokoll
* '''oss''' für [[OSS]] Geräte Dateien

Die Verbindungs Typen sind die folgenden:
* '''bidir''' für eine bidirektionale Verbindung (nur RoarAudio, default)
* '''filter''' um einen Soundserver als Filter für den Anderen zu verwenden
* '''transmit''' um lediglich die Lokale Ausgabe auf den entfernten Server zu spiegeln
* '''receive''' um die Ausgabe des entfernten Servers auf den lokalen zu spiegeln

===== Beispiele =====
$ roarinterconnect --type transmit --remote stereoanlage.local

===== Einschränkungen =====
Der als lokaler Server angegebene Server muss die Fähigkeit haben ''Background Streams'' zu verwenden und es muss ich um einen RoarAudio Server handeln. Andere Protokolle sind hier nicht unterstützt.

=== Kompatibilitäts Layer ===
{{Minimal Version|0.2beta3|RoarAudio}}
Mittels des Tools ''roarify'' können Kompatibilitäts Bibliotheken geladen sowie Kompatibilitäts Binarys ausgeführt werden. Dazu wird roarify einfach der Name des Programms über geben welches mit den Kompatibilitäts Bibliotheken geladen werden soll, beziehungsweise das Programm welches emuliert werden soll:

$ roarify myplayer
$ roarify mplayer -ao esd bla.ogg
$ roarify aucat ...
$ roarify esd
$ roarify artsplay ...

==== Liste der Kompatibilitäts Biblotheken ====
{| class="wikitable"
! Name
! Kompatibel zu
! Ab Version
! Beschreibung
|-
| libroaresd
| Enlightened Sound Daemon
| 0.1
| Client seitige Binär kompatible EsounD Emulation. Nahezu alle Applikationen funktionieren mit dieser einwandfrei.
|-
| libroarpulse-simple
| PulseAudio<br>Simple API
| 0.1
| Client seitige Binär kompatible PulseAudio Emulation. Hierbei handelt es sich um eine Emulation der ''Simple API''. Nicht alle Clients laufen damit. (Name bei Version 0.3beta5 geändert.)
|-
| libroarpulse
| PulseAudio<br>Asynchrone API
| 0.3beta5
| Client seitige Binär kompatible PulseAudio Emulation. Hierbei handelt es sich um die Haupt API. Diese wird zum teil unterstützt. Einige Programme laufen damit.
|-
| libroararts
| aRts - KDE Sound System
| 0.1
| Eine Cleint seitige binär kompatible aRtsc Emulation. Die meisten Programme laufen mit ihr. Die meisten die nicht mit ihr laufen haben höchst fragwürdige aRtsc Plugins weswegen viele Distributoren die besagten Plugins aus den Paketen entfernt haben.
|-
| libroaryiff
| YIFF Sound System
| 0.1beta2
| Eine binär kompatible Emulation der YIFF Sound System API. Die Emulation umfasst alle dokumentierten teile der API inklusive der Teile welche durch die original Bibliothek nicht implementiert sind. Einige Veränderungen wurden durchgeführt um eklatante Sicherheitslöcher zu schließen. Diese Änderungen sollten die meisten Applikationen nicht beeinträchtigen. Genaue Tests liegen aber nicht vor aufgrund des mangels an Applikationen welche das YIFF Sound System benutzen.
|-
| libroarsndio
| OpenBSD sndio
| 0.2beta3
| Eine Emulation des aktuellen OpenBSD Sound Interfaces (sndio). Sie ist auch auf nicht OpenBSD Systemen funktionsfähig und kann als Portierungshilfe verwendet werden. Sie ist nahezu vollständig und wir unter stetiger Kommunikation mit dem OpenBSD sndio Team entwickelt.
|-
| libroaross
| Open Sound System (OSS)
| 0.3beta3
| Hierbei handelt es sich um eine preload Bibliothek welche das Open Sound System emuliert. Die meiste Software läuft mit dieser Emulation einwandfrei. Es handelt sich um eine der besten OSS Emulationen gemessen an der menge der Software welche damit läuft.
|-
| libroaross
| DMX4Linux
| 0.3beta4
| DMX4Linux Emulation. Derzeit nur schreib Support. Lese Support kann mittels dmx Treiber emulirt werden.
|-
| libroarrsound
| RSound
| 0.3beta5
| Eine binär kompatible Emulation des der librsound des RSound Sound Systems. Da das RSound Sound System noch extrem jung ist herrscht hier noch eine gewissen Instabilität.
|}

==== Liste der Kompatibilitäts Binarys ====
{{Minimal Version|0.3beta2|RoarAudio}}
{| class="wikitable"
! Sound Systen Name
! Ab Version
! Beinhaltete Tools
|-
| EsounD
| 0.3beta2
| esd esdcat esdfilt esdmon esdplay (''ab 0.3beta5:'') esddsp
|-
| aRts
| 0.3beta3
| artsd artscat artsplay (''ab 0.3beta5:'') artsdsp
|-
| NAS
| 0.3beta3
| auplay (''ab 0.3beta5:'') audial audiooss*
|-
| YIFF Sound System
| 0.3beta3
| yiff yplay yshutdown
|-
| PulseAudio
| 0.3beta3
| pacat paplay (''ab 0.3beta5:'') padsp
|-
| dtmfdial
| 0.3beta5
| dtmfdial
|-
| RSound
| 0.3beta6
| ross rsd
|-
|}

* = ''audiooss'' ist ein externes Paket und gehört nicht zu NAS direkt dazu. Es wird aber von offizieller Seite auf audiooss verwiesen.

==== Liste der unterstützten Protokolle ====
{| class="wikitable"
! Protokoll Name
! Ab Version
! Beschreibung/Kommentare
|-
| RoarAudio (nativ)
| 0.1
| Das native RoarAudio Protokoll.
|-
| EsounD
| 0.3beta0
| Eine nahe zu komplette EsounD Emulation auf Server Seite. Nahe zu alle Applikationen funktioniren mit dieser Emulation unter Verwendung der original Client Bibliothek.
|-
| Simple
| 0.3beta4
| Das PulseAudio Simple Protokoll. Alle nötigen Parameter können mittels der ''--proto-*'' Optionen gesetzt werden. Der Standardwert liegt auf Playback-Stream und den nativen Audio Parametern des roards.
|-
| RSound
| 0.3beta5
| Das Protokoll der RSound Netzwerk-Sound Abstraktionsebene (''schlanker Sound Server'').
|-
| RPlay
| 0.3beta7
| Emulation eines Subsets des Protokolls des RPlay sound servers
|-
|}

=== Umgebungsvariablen ===
==== Übersicht ====
Diese Übersicht zeigt die wichtigsten Umgebungsvariablen auf. Weitere werden durch die Kompatibilitäts Layer verwendet.

{| class="wikitable"
! Variable
! Beispiel
! Beschreibung
|-
| HOME
| /home/phi
| Heimatverzeichnis des Benutzers
|-
| USER
| phi
| Aktueller Benutzername
|-
| TERM
| xterm
| Aktueller [[Terminal]] Type
|-
| DISPLAY
| :0
| Adresse des benutzen [[X11]] Servers
|-
| ROAR_SERVER
| remote.example.com
| Adresse des Daemons
|-
| ROAR_OPTIONS
| workaround:use-execed
| Optionen für libroar
|-
| CDDA_DEVICE
| /dev/cdrom
| Device Name für [[CDDA]] (Audio CDs) Zugriff
|-
| ROAR_PROXY
| ssh
| Zu verwendeter Proxy Type
|-
| http_proxy
| http://localhost:8118/
| Adresse des [[HTTP]] Proxys
|-
| socks_proxy
| localhost:1080
| Adresse des [[SOCKS]] Proxys
|-
| ssh_proxy
| myserver.remote.network
| Adresse des [[SSH]] Servers der als Proxy dienen soll
|-
|}

==== ROAR_OPTIONS ====
Die Umgebungsvariable ''$ROAR_OPTIONS'' besteht aus durch Leerzeichen getrennten Options Zeichenketten.

{| class="wikitable"
! Parameter
! Unter-Parameter
! Beispiel
! Beschreibung
|-
| #/Leer-Option
| (keine)
| #Ein_Kommentar
| Leere Optionen und Optionen welche mit einem # beginnen werden ignoriert.
|-
| workaround
| (mehrere)
| workaround:use-execed
| Steuert die Verwendung von Workarounds.
|-
| workaround
| use-execed
| workaround:use-execed
| Setzt das benutzen des use-execed-Workarounds. Dieser kann helfen wenn sich ein NAT-Gateway zwischen Server und Client befindet.
|-
| warning/warn
| (mehrere)
| warn:sysio
| Steuert die Verwendung von Warnungen.
|-
| warning/warn
| sysio
| warn:sysio
| Schaltet Warnungen ein die auf sysio verwendenden Code hinweisen. Dies kann Entwicklern bei schreiben Portabler Software helfen.
|-
| warning/warn
| obsolete
| warn:obsolete
| Warnt bei Aufruf von Funktionen die als ''veraltet'' makeirt sind. Dies soll Entwicklern helfen ihre Software auf einem aktuellen stand zu halten und ''Faild to build from source''-Fehlern vor zu beugen.
|-
| warning/warn
| all
| warn:all
| Schaltet alle Warnungen ein.
|-
| force-rate
| (keine)
| force-rate:44100
| Erzwingt die eine bestimmte Abtastrate bei allen Streams.
|-
| force-bits
| (keine)
| force-bits:16
| Erzwingt die eine bestimmte Anzahl von Bits pro Abtastwert bei allen Streams.
|-
| force-channels
| (keine)
| force-channels:2
| Erzwingt die eine bestimmte Anzahl von Kanälen bei allen Streams.
|-
| force-codec
| (keine)
| force-codec:pcm_s_be
| Erzwingt die einen bestimmten [[Codec]] bei allen Streams.
|-
| codec
| (mehrere)
| codec:vorbis:q:1
| Setzt Optionen für Codecs.
|-
| codec
| quality/q
| codec:vorbis:q:1
| Setzt den Qualitätswert für einen Codec.
|-
| codec
| complexity
| codec:roar_speex:complexity:8
| Setzt die Komplexität mit welcher der Codec arbeiten soll.
|-
| codec
| dtx
| codec:roar_speex:dtx:true
| Setzt das DTX Flag eines Codecs.
|-
| codec
| cc-max
| codec:roar_celt:cc-max:80
| Setzt die Größe des CC-Puffers eines Codecs.
|-
| codec
| vbr
| codec:vorbis:vbr:true
| Setzt das VBR Flag eines Codecs.
|-
| codec
| mode
| codec:roar_speex:mode:wb
| Setzt den den Modus für einen Codec. (Werte für Speex: nb, wb, uwb)
|-
| set-server
| (keine)
| set-server:/tmp/otherserver
| Setzt den libroar/Applications Standard Server. Dies sollte nur unter seltenen Umständen getan werden. ''$ROAR_SERVER'' sollte in den allermeisten fällen Verwendung finden.
|-
| set-authfile
| (keine)
| set-authfile:/home/phi/.roarauth
| Setzt die Datei mit den Authentifikations-Cookies.
|-
| x11-display
| (keine)
| x11-display::4
| Setzt das X11 Display, überschreibt $DISPLAY.
|-
| trap-policy
| (keine)
| trap-policy:warn
| Setzt die default Aktion die bei einem Trap ausgeführt werden soll. Mögliche Parameter sind: ignore, warn, abort, kill, stop und die. Nicht alle Parameter sind auf allen Plattformen verfügbar.
|-
| daemonimage
| (keine)
| daemonimage:/home/phi/bin/roard
| Setzt das Standard Image (Programmdatei) des Servers für die Verwendung von Adressen im +fork-Namensraum.
|-
| serverflags
| (mehrere)
| serverflags:nonblock
| Setzt Flags für den Verbindungsaufbau.
|-
| serverflags
| nonblock
| serverflags:nonblock
| Verbietet das Verwenden von Langsamen Verbindungsverfahren (Nicht alle Server werden gefunden wenn diese Option gesetzt ist).
|-
| serverflags
| hardnonblock
| serverflags:hardnonblock
| Verbietet das Verwenden von Langsamen Verbindungsverfahren und ist strenger als nonblock (Nicht alle Server werden gefunden wenn diese Option gesetzt ist).
|-
| serverflags
| localonly
| serverflags:localonly
| Verbietet das Verbinden mit nicht lokalen Servern. Da nicht immer erkannt werden kann ob ein Server Lokal ist kann bei Verwendung dieser Option weder garantiert werden das nur Lokale Server angesprochen werden noch das alle lokalen Server gefunden werden.
|-
| protocolversion
| (keine)
| protocolversion:2
| Setzt die Standard Protokoll Version. Sollte nur in Ausnahmefällen verwendet werden.
|-
|}

==== Liste der Umgebungsvariablen der Kompatibilitäts Layer ====
Diese Übersicht zeigt die Umgebungsvariablen der Kompatibilitäts Layer auf.

{| class="wikitable"
! Variable
! Layer
! Beispiel
! Beschreibung
|-
| ESPEAKER
| libroaresd
| some.remote.server
| Server Name des RoarAudio Servers auf den verbunden werden soll.
|-
| PULSE_SERVER
| libroarpulse
| some.remote.server
| Server Name des RoarAudio Servers auf den verbunden werden soll.
|-
| AUDIODEVICE
| libroarsndio
| aucat:0
| Server Name, RoarAudio Server Adresse oder sndio Device Name für Waveform (PCM) Daten
|-
| MIDIDEVICE
| libroarsndio
| rmidi:0
| Server Name, RoarAudio Server Adresse oder sndio Device Name für MIDI Daten
|-
| ROAR_OSS_KEEP_SESSION
| libroaross
| (keine oder beliebiger Inhalt)
| Hält die Verbindung zum RoarAudio Server offen auch wenn alle Audio Devices geschlossen sind. Kann bei einigen (verbugten) Applikation die Performance stark verbessern.
|-
| ROAR_OSS_CLIENT_NAME
| libroaross
| MyPlayer
| Name der für den Client verwendet werden soll.
|-
| RSD_SERVER
| libroarrsound
| some-server
| Server Name, RoarAudio Server Adresse.
|-
|}



=== Server Adresse ===
Die Adresse des Server muss in bestimmter Form vorliegen je nach Protokoll. Die Tabelle listet Alle Formate auf.

{| class="wikitable"
! Protokoll
! Format
! Beispiel
! Standard Werte
! Beschreibung
|-
| [[UNIX]]
| /pfad
| /home/phi/.roar
| ~/.roar, /tmp/roar
| Pfad zum UNIX Socket.
|-
| [[IPv4]]
| host[:port]
| myserver.local:16002
| localhost:16002
| Hostname und gegebenenfalls Port des Servers.
|-
| [[DECnet]]
| [node]::[object]
| remnod::
| localnode::roar
| Node Name und gegebenenfalls Objekt Name des Servers.
|-
| Spezial
| +fork
| +fork
| ''(keiner)''
| [[Fork]]et für den Prozess eine eigenen Instanz des Sound Daemons.
|-
| Spezial
| +slp
| +slp
| +slp
| Sucht nach dem Sound Daemon explizit mittels [[OpenSLP]]. Dies ist dann nötig wenn sich unter den Standard Adressen ein laufender roard befindet und OpenSLP explizit benutzt werden soll.
|-
| Spezial/[[UNIX]]
| +abstract
| +abstract
| +abstract
| Verwendet einen UNIX Domain Socket im Abstrakten Namensraum. Dieser ist von allen Prozessen des Systems aus gleichermaßen erreichbar. Dies gilt auch für Prozesse innerhalb einer [[chroot|chroot(2)]] Umgebung.
|-
|}

== Tips und Tricks ==
=== Server ohne Optionen des Players auswählen ===
Einige Player haben keine Möglichkeit einen Server einzustellen oder man möchte eine globale Einstellung treffen. Hierzu gibt es zwei Möglichkeiten:

Zum einen lässt sich global ein Server einstellen in dem man ein [[symlink]] mit dem Namen ''/etc/roarserver'' erstellt der auf den Server zeigt. Hier ein paar Beispiele:
$ ln -s /tmp/roarsock /etc/roarserver
$ ln -s remote.host.name /etc/roarserver
$ ln -s mynode:: /etc/roarserver

Die andere Möglichkeit ist es die [[Umgebungsvariable]] ROAR_SERVER zu setzen:
$ ROAR_SERVER=remote.host.name myplayer ...
$ export ROAR_SERVER=remote.host.name # bash
% setenv ROAR_SERVER remote.host.name # csh
$ myplayer ...

== Siehe auch ==
* [[RoarAudio]]

== Weblinks ==
* [http://roaraudio.keep-cool.org/ RoarAudio Homepage]

[[Kategorie:RoarAudio]]
[[Kategorie:Software]]
[[Kategorie:Sound]]
{{Stub}}

RoarAudio/Vortrag/RoarAudio und der RoarAudio PlayList Daemon

2012-02-27T21:33:02Z

Ph3-der-loewe: /* Die Protokolle */

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Abstrakt ==
PlayList Daemon ist ein Playlisten Verwalter der auf dieses Sound System aufsetzt und quasi als Player arbeitet. Er hat dabei ein anderes Konzept als andere Player und soll in diesem Vortrag vorgestellt werden. Auf die Grundlagen des Soundsystems wird im Rahmen des Vortrags nur soweit eingegangen in wie weit es noetig ist fuer das Verstaendnis.

Den Abschluss bildet eine Vorfuerung und Disskussion sowie Workshop in kleinerer Runde sofern gewuenscht.

== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).
Im Moment studiert er Elektrotechnik/Automatisierungstechnik.

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und Digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

In seiner Freizeit beschäftigt er sich außerdem intensiv mit Großkatzen.

== Vortrag ==
=== Was ist RoarAudio? ===
RoarAudio ist ein so genanntes Sound System. Es ist die Software welche zwischen einer Applikation des Benutzers, zum Beispiel eine Player, und dem Treiber sich befindet.

Das Sound System, und so auch RoarAudio, sorgt dafür das sich mehre Programme die vorhandene Hardware teilen können. Es sorgt dafür das einzelne Programme nicht gegenseitig sich den Zugang zu den Resourcen der Soundkarte versperren.

Auch fügt das Sound System zusätzliche Funktionalitäten hinzu. Hierzu zählen zum Beispiel getrennte Lautstärke Regelung für verschiedene Programme.

RoarAudio ist besonders auf die Produktion von Radio in Echtzeit ausgelegt. Es ist Netzwerktransparent. Das heißt das Programme auch über das Netzwerk Zugriff nehmen können.

Neben seiner guten Netzwerkfähigkeit hebt sich RoarAudio auch durch die gute Unterstützung von Komprimierten Audio Übertragungen und der Unterstützung für Meta Daten hervor.

=== Der RoarAudio PlayList Daemon ===
==== Was ist der RoarAudio PlayList Daemon? ====
Der RoarAudio PlayList Daemon (kurtz: rpld) ist wie der Name schon sagt ein Wiedergabelisten Verwalter. Für den Benutzer sieht dieser etwa wie ein Player aus, auch wenn wesentliche Teile in andere instantzen ausgelagert sind.

Seine Hauptaufgaben sind:
* Verwalten von Wiedergabeliste‎n,
* Verwalten von einer Queue der Aktuell zu spielenden Titel,
* Abspielen der Einträge in der Queue,
* IO Abstraktion (mittels DSTR).

==== Wiedergabeliste‎n ====
Im Gegensatz zu vielen anderen Playern kann rpld eine reihe von Wiedergabeliste‎n parallel vorhalten. Zum Beispiel kann eine Wiedergabeliste‎n per Medium oder Album angelegt werden. Wiedergabeliste‎n haben einen Namen und können eine hierarchische Struktur haben. Zwischen den Listen können Titel kopiert und Verschoben werden. Auch können neue Titel erzeugt und gelöscht werden.

Jeder Titel in einer Wiedergabeliste‎ hält seine Metadaten (Titel, Interpret, ...) vor.

==== Die Queue und History ====
Neben den anderen Wiedergabeliste‎n ist die Queue eine spezielle Liste. Was in ihr gespeichert wird abgespielt und dann in die History verschoben. Abgesehen von dieser Eigenschaft ist die Queue beziehungsweise die History eine normale Wiedergabeliste‎.

==== Die Pointer ====
==== In und Export ====
Der Daemon kann verschiedene Wiedergabeliste‎n Formate In- und Exportieren. Die Folgende Tabelle gibt eine Übersicht:
{| class="wikitable"
! Format
! Dateinamenserweiterung
! Import
! Export
! Kommentar
|-
| rpld
| .rpldpl
| Ja
| Ja
| Veraltet
|-
| vclt
| .vclt
| Ja
| Ja
| Empfohlenes Format
|-
| pls
| .pls
| Nein
| Ja
| Nicht zu verwechseln mit dem Format '''plain'''. Viele Verwenden ".pls" für dieses.
|-
| m3u
| .m3u
| Ja
| Ja
| -
|-
| xspf
| .xspf
| Nein
| Ja
| -
|-
| plain
| -
| Ja
| Ja
| Dummy Format. Jede Zeile ein Dateiname
|}

==== Die Protokolle ====
Der Daemon verwendet ein eigenes Protokoll. Dieses ist Befehlszeilen orientiertes Protokoll. Es ist in der Lage Daten in-line mit den Befehlen zu übertragen. Durch seine hohe Konsistenz ist es weiterhin leicht zu erlernen.

Weiterhin kann der Daemon auch teile des MPD Protokolls. Weitere werden in Zukunft möglicherweise hinzugefügt.

==== Titel Identifikation ====

=== Zusammenfassung ===
== Vorführung, Fragen, Anregungen, Feedback, Workshop ==
Nach Abschluss des eigentlichen Vortrages findet eine Vorführung statt. Danach gibt es Fragen und Feedback und falls gewünscht ein Workshop im Anschluss.

[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio/Vortrag/RoarAudio und der RoarAudio PlayList Daemon

2012-02-27T21:18:51Z

Ph3-der-loewe: /* In und Export */ Infos (liste aus code entnommen)

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Abstrakt ==
PlayList Daemon ist ein Playlisten Verwalter der auf dieses Sound System aufsetzt und quasi als Player arbeitet. Er hat dabei ein anderes Konzept als andere Player und soll in diesem Vortrag vorgestellt werden. Auf die Grundlagen des Soundsystems wird im Rahmen des Vortrags nur soweit eingegangen in wie weit es noetig ist fuer das Verstaendnis.

Den Abschluss bildet eine Vorfuerung und Disskussion sowie Workshop in kleinerer Runde sofern gewuenscht.

== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).
Im Moment studiert er Elektrotechnik/Automatisierungstechnik.

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und Digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

In seiner Freizeit beschäftigt er sich außerdem intensiv mit Großkatzen.

== Vortrag ==
=== Was ist RoarAudio? ===
RoarAudio ist ein so genanntes Sound System. Es ist die Software welche zwischen einer Applikation des Benutzers, zum Beispiel eine Player, und dem Treiber sich befindet.

Das Sound System, und so auch RoarAudio, sorgt dafür das sich mehre Programme die vorhandene Hardware teilen können. Es sorgt dafür das einzelne Programme nicht gegenseitig sich den Zugang zu den Resourcen der Soundkarte versperren.

Auch fügt das Sound System zusätzliche Funktionalitäten hinzu. Hierzu zählen zum Beispiel getrennte Lautstärke Regelung für verschiedene Programme.

RoarAudio ist besonders auf die Produktion von Radio in Echtzeit ausgelegt. Es ist Netzwerktransparent. Das heißt das Programme auch über das Netzwerk Zugriff nehmen können.

Neben seiner guten Netzwerkfähigkeit hebt sich RoarAudio auch durch die gute Unterstützung von Komprimierten Audio Übertragungen und der Unterstützung für Meta Daten hervor.

=== Der RoarAudio PlayList Daemon ===
==== Was ist der RoarAudio PlayList Daemon? ====
Der RoarAudio PlayList Daemon (kurtz: rpld) ist wie der Name schon sagt ein Wiedergabelisten Verwalter. Für den Benutzer sieht dieser etwa wie ein Player aus, auch wenn wesentliche Teile in andere instantzen ausgelagert sind.

Seine Hauptaufgaben sind:
* Verwalten von Wiedergabeliste‎n,
* Verwalten von einer Queue der Aktuell zu spielenden Titel,
* Abspielen der Einträge in der Queue,
* IO Abstraktion (mittels DSTR).

==== Wiedergabeliste‎n ====
Im Gegensatz zu vielen anderen Playern kann rpld eine reihe von Wiedergabeliste‎n parallel vorhalten. Zum Beispiel kann eine Wiedergabeliste‎n per Medium oder Album angelegt werden. Wiedergabeliste‎n haben einen Namen und können eine hierarchische Struktur haben. Zwischen den Listen können Titel kopiert und Verschoben werden. Auch können neue Titel erzeugt und gelöscht werden.

Jeder Titel in einer Wiedergabeliste‎ hält seine Metadaten (Titel, Interpret, ...) vor.

==== Die Queue und History ====
Neben den anderen Wiedergabeliste‎n ist die Queue eine spezielle Liste. Was in ihr gespeichert wird abgespielt und dann in die History verschoben. Abgesehen von dieser Eigenschaft ist die Queue beziehungsweise die History eine normale Wiedergabeliste‎.

==== Die Pointer ====
==== In und Export ====
Der Daemon kann verschiedene Wiedergabeliste‎n Formate In- und Exportieren. Die Folgende Tabelle gibt eine Übersicht:
{| class="wikitable"
! Format
! Dateinamenserweiterung
! Import
! Export
! Kommentar
|-
| rpld
| .rpldpl
| Ja
| Ja
| Veraltet
|-
| vclt
| .vclt
| Ja
| Ja
| Empfohlenes Format
|-
| pls
| .pls
| Nein
| Ja
| Nicht zu verwechseln mit dem Format '''plain'''. Viele Verwenden ".pls" für dieses.
|-
| m3u
| .m3u
| Ja
| Ja
| -
|-
| xspf
| .xspf
| Nein
| Ja
| -
|-
| plain
| -
| Ja
| Ja
| Dummy Format. Jede Zeile ein Dateiname
|}

==== Die Protokolle ====
==== Titel Identifikation ====

=== Zusammenfassung ===
== Vorführung, Fragen, Anregungen, Feedback, Workshop ==
Nach Abschluss des eigentlichen Vortrages findet eine Vorführung statt. Danach gibt es Fragen und Feedback und falls gewünscht ein Workshop im Anschluss.

[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio/Vortrag/RoarAudio und der RoarAudio PlayList Daemon

2012-02-27T20:21:10Z

Ph3-der-loewe: /* Die Queue */ bissel text

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Abstrakt ==
PlayList Daemon ist ein Playlisten Verwalter der auf dieses Sound System aufsetzt und quasi als Player arbeitet. Er hat dabei ein anderes Konzept als andere Player und soll in diesem Vortrag vorgestellt werden. Auf die Grundlagen des Soundsystems wird im Rahmen des Vortrags nur soweit eingegangen in wie weit es noetig ist fuer das Verstaendnis.

Den Abschluss bildet eine Vorfuerung und Disskussion sowie Workshop in kleinerer Runde sofern gewuenscht.

== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).
Im Moment studiert er Elektrotechnik/Automatisierungstechnik.

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und Digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

In seiner Freizeit beschäftigt er sich außerdem intensiv mit Großkatzen.

== Vortrag ==
=== Was ist RoarAudio? ===
RoarAudio ist ein so genanntes Sound System. Es ist die Software welche zwischen einer Applikation des Benutzers, zum Beispiel eine Player, und dem Treiber sich befindet.

Das Sound System, und so auch RoarAudio, sorgt dafür das sich mehre Programme die vorhandene Hardware teilen können. Es sorgt dafür das einzelne Programme nicht gegenseitig sich den Zugang zu den Resourcen der Soundkarte versperren.

Auch fügt das Sound System zusätzliche Funktionalitäten hinzu. Hierzu zählen zum Beispiel getrennte Lautstärke Regelung für verschiedene Programme.

RoarAudio ist besonders auf die Produktion von Radio in Echtzeit ausgelegt. Es ist Netzwerktransparent. Das heißt das Programme auch über das Netzwerk Zugriff nehmen können.

Neben seiner guten Netzwerkfähigkeit hebt sich RoarAudio auch durch die gute Unterstützung von Komprimierten Audio Übertragungen und der Unterstützung für Meta Daten hervor.

=== Der RoarAudio PlayList Daemon ===
==== Was ist der RoarAudio PlayList Daemon? ====
Der RoarAudio PlayList Daemon (kurtz: rpld) ist wie der Name schon sagt ein Wiedergabelisten Verwalter. Für den Benutzer sieht dieser etwa wie ein Player aus, auch wenn wesentliche Teile in andere instantzen ausgelagert sind.

Seine Hauptaufgaben sind:
* Verwalten von Wiedergabeliste‎n,
* Verwalten von einer Queue der Aktuell zu spielenden Titel,
* Abspielen der Einträge in der Queue,
* IO Abstraktion (mittels DSTR).

==== Wiedergabeliste‎n ====
Im Gegensatz zu vielen anderen Playern kann rpld eine reihe von Wiedergabeliste‎n parallel vorhalten. Zum Beispiel kann eine Wiedergabeliste‎n per Medium oder Album angelegt werden. Wiedergabeliste‎n haben einen Namen und können eine hierarchische Struktur haben. Zwischen den Listen können Titel kopiert und Verschoben werden. Auch können neue Titel erzeugt und gelöscht werden.

Jeder Titel in einer Wiedergabeliste‎ hält seine Metadaten (Titel, Interpret, ...) vor.

==== Die Queue und History ====
Neben den anderen Wiedergabeliste‎n ist die Queue eine spezielle Liste. Was in ihr gespeichert wird abgespielt und dann in die History verschoben. Abgesehen von dieser Eigenschaft ist die Queue beziehungsweise die History eine normale Wiedergabeliste‎.

==== Die Pointer ====
==== In und Export ====
==== Die Protokolle ====
==== Titel Identifikation ====

=== Zusammenfassung ===
== Vorführung, Fragen, Anregungen, Feedback, Workshop ==
Nach Abschluss des eigentlichen Vortrages findet eine Vorführung statt. Danach gibt es Fragen und Feedback und falls gewünscht ein Workshop im Anschluss.

[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio/Vortrag/RoarAudio und der RoarAudio PlayList Daemon

2012-02-27T18:52:07Z

Ph3-der-loewe: /* Wiedergabeliste‎n */ bissel text

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Abstrakt ==
PlayList Daemon ist ein Playlisten Verwalter der auf dieses Sound System aufsetzt und quasi als Player arbeitet. Er hat dabei ein anderes Konzept als andere Player und soll in diesem Vortrag vorgestellt werden. Auf die Grundlagen des Soundsystems wird im Rahmen des Vortrags nur soweit eingegangen in wie weit es noetig ist fuer das Verstaendnis.

Den Abschluss bildet eine Vorfuerung und Disskussion sowie Workshop in kleinerer Runde sofern gewuenscht.

== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).
Im Moment studiert er Elektrotechnik/Automatisierungstechnik.

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und Digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

In seiner Freizeit beschäftigt er sich außerdem intensiv mit Großkatzen.

== Vortrag ==
=== Was ist RoarAudio? ===
RoarAudio ist ein so genanntes Sound System. Es ist die Software welche zwischen einer Applikation des Benutzers, zum Beispiel eine Player, und dem Treiber sich befindet.

Das Sound System, und so auch RoarAudio, sorgt dafür das sich mehre Programme die vorhandene Hardware teilen können. Es sorgt dafür das einzelne Programme nicht gegenseitig sich den Zugang zu den Resourcen der Soundkarte versperren.

Auch fügt das Sound System zusätzliche Funktionalitäten hinzu. Hierzu zählen zum Beispiel getrennte Lautstärke Regelung für verschiedene Programme.

RoarAudio ist besonders auf die Produktion von Radio in Echtzeit ausgelegt. Es ist Netzwerktransparent. Das heißt das Programme auch über das Netzwerk Zugriff nehmen können.

Neben seiner guten Netzwerkfähigkeit hebt sich RoarAudio auch durch die gute Unterstützung von Komprimierten Audio Übertragungen und der Unterstützung für Meta Daten hervor.

=== Der RoarAudio PlayList Daemon ===
==== Was ist der RoarAudio PlayList Daemon? ====
Der RoarAudio PlayList Daemon (kurtz: rpld) ist wie der Name schon sagt ein Wiedergabelisten Verwalter. Für den Benutzer sieht dieser etwa wie ein Player aus, auch wenn wesentliche Teile in andere instantzen ausgelagert sind.

Seine Hauptaufgaben sind:
* Verwalten von Wiedergabeliste‎n,
* Verwalten von einer Queue der Aktuell zu spielenden Titel,
* Abspielen der Einträge in der Queue,
* IO Abstraktion (mittels DSTR).

==== Wiedergabeliste‎n ====
Im Gegensatz zu vielen anderen Playern kann rpld eine reihe von Wiedergabeliste‎n parallel vorhalten. Zum Beispiel kann eine Wiedergabeliste‎n per Medium oder Album angelegt werden. Wiedergabeliste‎n haben einen Namen und können eine hierarchische Struktur haben. Zwischen den Listen können Titel kopiert und Verschoben werden. Auch können neue Titel erzeugt und gelöscht werden.

Jeder Titel in einer Wiedergabeliste‎ hält seine Metadaten (Titel, Interpret, ...) vor.

==== Die Queue ====
==== Die Pointer ====
==== In und Export ====
==== Die Protokolle ====
==== Titel Identifikation ====

=== Zusammenfassung ===
== Vorführung, Fragen, Anregungen, Feedback, Workshop ==
Nach Abschluss des eigentlichen Vortrages findet eine Vorführung statt. Danach gibt es Fragen und Feedback und falls gewünscht ein Workshop im Anschluss.

[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio/Vortrag/RoarAudio und der RoarAudio PlayList Daemon

2012-02-27T13:47:48Z

Ph3-der-loewe: /* Was ist der RoarAudio PlayList Daemon? */ generell infos, teilweise aus RoarAudio_PlayList_Daemon uebernommen

RoarAudio/Vortrag/RoarAudio und der RoarAudio PlayList Daemon

2012-02-27T13:35:05Z

Ph3-der-loewe: /* Vorführung, Fragen, Anregungen, Feedback, Workshop */ bissel infos

RoarAudio/Vortrag/RoarAudio und der RoarAudio PlayList Daemon

2012-02-27T13:33:28Z

Ph3-der-loewe: /* Was ist der RoarAudio PlayList Daemon? */ Bissel Struktur

RoarAudio/Vortrag/RoarAudio und der RoarAudio PlayList Daemon

2012-02-27T11:50:10Z

Ph3-der-loewe: /* Was ist RoarAudio? */ bissel was von RoarAudio/Vortrag/Was_ist_RoarAudio uebernommen.

RoarAudio/Vortrag/RoarAudio und der RoarAudio PlayList Daemon

2012-02-27T11:12:04Z

Ph3-der-loewe: /* Abstrakt */ text aus mail

RoarAudio/Vortrag/RoarAudio und der RoarAudio PlayList Daemon

2012-02-27T11:07:50Z

Ph3-der-loewe: BEGIN{}

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Abstrakt ==
== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).
Im Moment studiert er Elektrotechnik/Automatisierungstechnik.

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und Digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

In seiner Freizeit beschäftigt er sich außerdem intensiv mit Großkatzen.

== Vortrag ==
=== Was ist RoarAudio? ===
=== Was ist der RoarAudio PlayList Daemon? ===
=== Zusammenfassung ===
== Vorführung, Fragen, Anregungen, Feedback, Workshop ==
[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio/Vortrag/Grundlagen der digitalen Signalverarbeitung

2011-11-01T02:32:50Z

Ph3-der-loewe: /* Ausblicke */ bissel mehr

RoarAudio/Vortrag/Grundlagen der digitalen Signalverarbeitung

2011-10-30T22:15:25Z

Ph3-der-loewe: /* Einfache Operationen */ syntax mit handout gleichsetzen

RoarAudio/Vortrag/Grundlagen der digitalen Signalverarbeitung

2011-10-18T10:06:36Z

Ph3-der-loewe: /* Wandler */ Infos zu wandlern, direkt aus handout

RoarAudio/Vortrag/Grundlagen der digitalen Signalverarbeitung

2011-10-18T09:58:55Z

Ph3-der-loewe: /* Das Signal */ bissel mehr

RoarAudio/Vortrag/Grundlagen der digitalen Signalverarbeitung

2011-10-18T09:55:40Z

Ph3-der-loewe: update des TOC

RoarAudio/Vortrag/Grundlagen der digitalen Signalverarbeitung

2011-09-05T19:27:41Z

Ph3-der-loewe: /* Einfache Operationen */ Selbstnotiz entfernen

RoarAudio/Vortrag/Grundlagen der digitalen Signalverarbeitung

2011-09-05T19:26:48Z

Ph3-der-loewe: /* Einfache Operationen */ basis transformationen

RoarAudio/Vortrag/Grundlagen der digitalen Signalverarbeitung

2011-09-05T14:24:46Z

Ph3-der-loewe: /* Zeit und Frequenzbereich */ Bereich geloecht da er im vorherigen Bereich abgehandelt wird.

RoarAudio/Vortrag/Grundlagen der digitalen Signalverarbeitung

2011-09-05T12:58:06Z

Ph3-der-loewe: /* Elektrische Größen */ Verschiedene Darstellungen von Signalen

RoarAudio/Vortrag/Grundlagen der digitalen Signalverarbeitung

2011-09-05T12:25:17Z

Ph3-der-loewe: /* Vortrag */ Hinweis ueber die hier niedergeschriebenen inhalte.

RoarAudio/Vortrag/Grundlagen der digitalen Signalverarbeitung

2011-09-04T20:12:01Z

Ph3-der-loewe: /* Vortrag */ infos was in die einzelnen Bereiche gehen soll

RoarAudio/Vortrag/Grundlagen der digitalen Signalverarbeitung

2011-09-04T20:01:05Z

Ph3-der-loewe: BEGIN{}

RoarAudio/Vortrag/Was ist RoarAudio

2011-04-09T08:28:33Z

Ph3-der-loewe: /* aroarfw und SCRSI */ typo

<div style="background:#fee846;text-align:left; color: #000;font-weight:bold;font-size:125%;margin: 0px 5px 0px 0; padding: 4px 4px 4px 14px;">Was ist RoarAudio?</div>
<div style="margin: 0 5px 5px 0; padding: 1em 1em 1em 1em; border: 1px solid #fee846; background-color:#fffdf5;">
; Ziel : ein Vortrag über das [[RoarAudio]] Projekt vor einem Unixpublikum mit keinem oder geringem Vorwissen zum Thema.
</div>

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Abstrakt ==
Der Vortag "Was ist RoarAudio?" soll kurz das RoarAudio Projekt vorstellen. Er bewegt sich auf einer nicht-technischen Ebene und ist für alle Arten von Zuhörern geeignet.

== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).
Im Moment studiert er Elektrotechnik/Automatisierungstechnik.

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und Digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

In seiner Freizeit beschäftigt er sich außerdem intensiv mit Großkatzen.

== Vortrag ==
=== Was ist RoarAudio? ===
RoarAudio ist ein so genanntes Sound System. Es ist die Software welche zwischen einer Applikation des Benutzers, zum Beispiel eine Player, und dem Treiber sich befindet.

Das Sound System, und so auch RoarAudio, sorgt dafür das sich mehre Programme die vorhandene Hardware teilen können. Es sorgt dafür das einzelne Programme nicht gegenseitig sich den Zugang zu den Resourcen der Soundkarte versperren.

Auch fügt das Sound System zusätzliche Funktionalitäten hinzu. Hierzu zählen zum Beispiel getrennte Lautstärke Regelung für verschiedene Programme.

RoarAudio ist besonders auf die Produktion von Radio in Echtzeit ausgelegt. Es ist Netzwerktransparent. Das heißt das Programme auch über das Netzwerk Zugriff nehmen können. Auch kann man mit roard -- Was das ist Später -- direkt beispielsweise Internet Radio senden.

Neben seiner guten Netzwerkfähigkeit hebt sich RoarAudio auch durch die gute Unterstützung von Komprimierten Audio Übertragungen und der Unterstützung für Meta Daten hervor.

=== Audio Stack unter UNIX und GNU/Linux ===
Unter UNIX und auch unter GNU/Linux greifen Programme niemals direkt auf Hardware zu. Selbiges gilt auch für die Audio Ausgabe. Im allgemeinen Falle durchlaufen sie drei Schichten:
* Die Interne Schicht des Programms das etwas abspielen will,
* Das Sound System,
* Die Audio Treiber im Kernel.

In einigen fällen sind die Audio Treiber im Kernel und das Sound System das selbe. Dies ist beispielsweise bei OSS, dem Open Sound System, und ALSA, der Advanced Linux Sound Architecture. Oft ist dies aber auch getrennt. Diese beiden Treiber Pakete sind die wohl bekanntesten, auch wenn OSS entgegen landläufiger Meinung auf keinem aktuellen Betriebssystem als Standard Treiber vorkommt. OSS wird heute faktisch nur noch Emuliert.

=== RoarAudio Projektziele ===
Das RoarAudio Projekt hat sich zum Ziel gesetzt ein Sound System zu entwickeln das folgende Eigenschaften hat:
* Es soll den POSIX Philosophien weitestgehend gerecht werden.
* Besonders hervorzuheben ist die starke Anlehnung an das POSIX Ein-/Ausgabekonzept.
* Auch hervorzuheben ist die Portabilität: RoarAudio ist verfügbar für 8-Bit µ-Controllern bis hin zu Großrechnern mit OpenVMS, GNU/Linux, Alle arten von BSDs und Win32 eingeschlossen.
* Echte Netzwerkstransparenz. Daraus resultiert unmittelbar ein Server-Klient Konzept. Optimierungen für den häufigen Fall das Klient und Server auf dem Selben Rechner sind existieren.
* Funktionalität für die Radio Produktion.
* Funktionalität für den Einsatz im Bühnen und Lautraum Bereich.

Aus den obigen Überlegungen wurde klar das es sinnvoll ist keine klassische Software Entwicklung zu betreiben sondern viel mehr ein Protokoll zu entwickeln und eine Referenz Implementierung an zu bieten. Dies gescheit auch in der Praxis auf diesem Wege. Mehr dazu später.

=== Produkte ===
Das Projekt arbeitet an mehren Produkten gleichzeitig. Dazu gehören das Besagte Protokoll im Mittelpunkt und die angegliederten Implementierungen. Neben den direkt auf das Protokoll Bezug nehmenden Produkten werden auch einige nicht unmittelbar damit zusammenhängenden Software Pakete gepflegt die aber im Umfeld von RoarAudio nützlich sind.

Im folgenden werden nun ein paar dieser Produkte kurz vorgestellt.

==== Protokolle ====
Wie bereits erwähnt ist der Kern des Projekts das RoarAudio Protokoll.

Dieses wird unabhängig von der Software entwickelt. Es wird bei der Entwicklung keinerlei Rücksicht auf die spätere Implementierung genommen so das eine Implementierungs unabhängige und saubere Struktur entsteht.

Neben dem RoarAudio Protokoll ist noch erwähnenswert das ein zweites Protokoll namens Tantalos entwickelt wird: Dabei handelt es such um ein Protokoll zum automatischen finden von Kontent wie Musik im Netzwerk.

===== Status =====
Grundlegende Protokoll Entwicklung ist abgeschlossen. Es sind aber noch viele interessante Zusatz Funktionalitäten auf der Zu-Bearbeiten-Liste.

==== Haupt Paket ====
Das Haupt Paket ("roaraudio") ist ein versuch das Protokoll Referenz zu implementieren. Aber auch diese Implementierung ist unvollständig (primär bedingt durch die Zeit die es braucht die neuen Spezifikationen um zu setzen).

Das Paket besteht aus ''roard'', dem Sound Server, ''libroar und freunden'' welche die Klient seitige Schnittstelle liefern und einigen Hilfsprogrammen so wie so genannten ''Kompatibilitäts Layern''. ''roard'' kann neben dem RoarAudio Protokoll auch verschiedene Protokolle anderer Sound Systeme. Die ''Kompatibilitäts Layern'' dienen dazu Software die für andere Sound Systeme geschrieben sind mit RoarAudio Unterstützung so zu sagen ''nach zu rüsten''. Es handelt sich hierbei nicht nur um eine OSS Emulation.

===== Status =====
Das Haupt Paket ist in einem gut Benutzbarem Stadium und in mehren GNU/Linux Distributionen vorhanden.


==== µRoar und µRoarD ====
Neben der Implementierung durch das Haupt Paket entstanden im Laufe der Zeit weitere Implementierungen des Protokolls. Die wichtigsten zwei sind µRoar und µRoarD.

Bei µRoar handelt es sich um eine Klient Bibliothek unter der LGPL Version 3. Diese wurde ursprünglich entwickelt um unter Win32 proprietären Programmen den Zugriff auf RoarAudio Server zu ermöglichen.

µRoarD hingegen ist ein zweiter RoarAudio Server. Er ist bei weitem nicht so vollständig wie roard dafür aber wie der Name schon erraten lässt deutlich schlanker.

===== Status =====
µRoar wird seit langem als Stabil angesehen.
µRoarD ist in aktiver Entwicklung gilt allgemein als Stabil.
Beide sind in mehren GNU/Linux Distributionen vorhanden.

==== RoarAudio PlayList Daemon ====
Beim RoarAudio PlayList Daemon handelt es sich um eine Wiedergabelisten Verwaltungs Software. Er dient dazu Wiedergabelisten zu verwalten und Einträge daraus ab zu spielen. Zusammen mit einem RoarAudio Server und einer GUI (zum Beispiel App::RPLD::GUI) erscheint er fast wie ein gewöhnlicher Player. Im Gegensatz zu diesen hat er aber keine Logik für den Umgang mit den Audiodaten und lässt diese ausschließlich durch den RoarAudio Server verwalten.

Im Zusammenhang mit dem RoarAudio PlayList Daemon oder kurz ''RPLD'' gibt es verschieden weitere Pakete wie dem Perl Modul Audio::RPLD zum steuern, App::RPLD::GUI -- einer GUI --, Romie -- einem Webfrondend -- oder auch vclt-tools -- einem Paket zum erstellen von Wiedergabelisten.

===== Status =====
Der RoarAudio PlayList Daemon erreicht bald seine Stabile Phase und befindet sich derzeit in einem gut benutzbaren Zustand. Er ist in mehren GNU/Linux Distributionen vorhanden.

==== aroarfw und SCRSI ====
Zu guter Letzt gibt es noch verschiedene Produkte für den Eingebetteten und teilweise Eingebetteten Einsatz:

aroarfw ist einen Hardware und System unabhäniges Framework zur Entwicklung von Software die RoarAudio verwendet. Es ist vor allem für Kleinst-Rechner wie µ-Controllern gedacht.

Bei SCRSI handelt es sich um eine Schnittstelle die zwischen das eigentliche Programm und die Schnittstelle zu RoarAudio eingefügt wird. Dies dient vor allem zum einbetten von µRoarD in andere Applikationen.

===== Status =====
Sowohl aroarfw als auch SCRSI stehen unter aktiver Entwicklung und sind in einem verwendbaren Zustand. Kontakt mit den Entwicklern wird aber empfohlen.
aroarfw findet sich in mehren GNU/Linux Distributionen.

=== Zusammenfassung ===
Mittlerweile ist RoarAudio zu einer echten Alternative zu anderen Sound Systemen geworden. Gerade im Bereich der Radio und Web-Radio Produktion, aber auch beim Versand von Audio durch das Lokale Netzwerk ist es ein gutes Mittel.

Durch die Allgemein sehr Standard freundliche Einstellung des Projekts ist die Software zu vielem anderen gut Kompatibel.

Auch die Kompatibilitäts Layer sind auf jeden Fall ein großes Plus da so fast alle Software, auch ohne native RoarAudio Unterstützung, mit RoarAudio zusammenarbeiten kann.

[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio/Vortrag/Was ist RoarAudio

2011-04-09T01:55:07Z

Ph3-der-loewe: /* Zusammenfassung */ +bissel blabla

<div style="background:#fee846;text-align:left; color: #000;font-weight:bold;font-size:125%;margin: 0px 5px 0px 0; padding: 4px 4px 4px 14px;">Was ist RoarAudio?</div>
<div style="margin: 0 5px 5px 0; padding: 1em 1em 1em 1em; border: 1px solid #fee846; background-color:#fffdf5;">
; Ziel : ein Vortrag über das [[RoarAudio]] Projekt vor einem Unixpublikum mit keinem oder geringem Vorwissen zum Thema.
</div>

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Abstrakt ==
Der Vortag "Was ist RoarAudio?" soll kurz das RoarAudio Projekt vorstellen. Er bewegt sich auf einer nicht-technischen Ebene und ist für alle Arten von Zuhörern geeignet.

== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).
Im Moment studiert er Elektrotechnik/Automatisierungstechnik.

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und Digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

In seiner Freizeit beschäftigt er sich außerdem intensiv mit Großkatzen.

== Vortrag ==
=== Was ist RoarAudio? ===
RoarAudio ist ein so genanntes Sound System. Es ist die Software welche zwischen einer Applikation des Benutzers, zum Beispiel eine Player, und dem Treiber sich befindet.

Das Sound System, und so auch RoarAudio, sorgt dafür das sich mehre Programme die vorhandene Hardware teilen können. Es sorgt dafür das einzelne Programme nicht gegenseitig sich den Zugang zu den Resourcen der Soundkarte versperren.

Auch fügt das Sound System zusätzliche Funktionalitäten hinzu. Hierzu zählen zum Beispiel getrennte Lautstärke Regelung für verschiedene Programme.

RoarAudio ist besonders auf die Produktion von Radio in Echtzeit ausgelegt. Es ist Netzwerktransparent. Das heißt das Programme auch über das Netzwerk Zugriff nehmen können. Auch kann man mit roard -- Was das ist Später -- direkt beispielsweise Internet Radio senden.

Neben seiner guten Netzwerkfähigkeit hebt sich RoarAudio auch durch die gute Unterstützung von Komprimierten Audio Übertragungen und der Unterstützung für Meta Daten hervor.

=== Audio Stack unter UNIX und GNU/Linux ===
Unter UNIX und auch unter GNU/Linux greifen Programme niemals direkt auf Hardware zu. Selbiges gilt auch für die Audio Ausgabe. Im allgemeinen Falle durchlaufen sie drei Schichten:
* Die Interne Schicht des Programms das etwas abspielen will,
* Das Sound System,
* Die Audio Treiber im Kernel.

In einigen fällen sind die Audio Treiber im Kernel und das Sound System das selbe. Dies ist beispielsweise bei OSS, dem Open Sound System, und ALSA, der Advanced Linux Sound Architecture. Oft ist dies aber auch getrennt. Diese beiden Treiber Pakete sind die wohl bekanntesten, auch wenn OSS entgegen landläufiger Meinung auf keinem aktuellen Betriebssystem als Standard Treiber vorkommt. OSS wird heute faktisch nur noch Emuliert.

=== RoarAudio Projektziele ===
Das RoarAudio Projekt hat sich zum Ziel gesetzt ein Sound System zu entwickeln das folgende Eigenschaften hat:
* Es soll den POSIX Philosophien weitestgehend gerecht werden.
* Besonders hervorzuheben ist die starke Anlehnung an das POSIX Ein-/Ausgabekonzept.
* Auch hervorzuheben ist die Portabilität: RoarAudio ist verfügbar für 8-Bit µ-Controllern bis hin zu Großrechnern mit OpenVMS, GNU/Linux, Alle arten von BSDs und Win32 eingeschlossen.
* Echte Netzwerkstransparenz. Daraus resultiert unmittelbar ein Server-Klient Konzept. Optimierungen für den häufigen Fall das Klient und Server auf dem Selben Rechner sind existieren.
* Funktionalität für die Radio Produktion.
* Funktionalität für den Einsatz im Bühnen und Lautraum Bereich.

Aus den obigen Überlegungen wurde klar das es sinnvoll ist keine klassische Software Entwicklung zu betreiben sondern viel mehr ein Protokoll zu entwickeln und eine Referenz Implementierung an zu bieten. Dies gescheit auch in der Praxis auf diesem Wege. Mehr dazu später.

=== Produkte ===
Das Projekt arbeitet an mehren Produkten gleichzeitig. Dazu gehören das Besagte Protokoll im Mittelpunkt und die angegliederten Implementierungen. Neben den direkt auf das Protokoll Bezug nehmenden Produkten werden auch einige nicht unmittelbar damit zusammenhängenden Software Pakete gepflegt die aber im Umfeld von RoarAudio nützlich sind.

Im folgenden werden nun ein paar dieser Produkte kurz vorgestellt.

==== Protokolle ====
Wie bereits erwähnt ist der Kern des Projekts das RoarAudio Protokoll.

Dieses wird unabhängig von der Software entwickelt. Es wird bei der Entwicklung keinerlei Rücksicht auf die spätere Implementierung genommen so das eine Implementierungs unabhängige und saubere Struktur entsteht.

Neben dem RoarAudio Protokoll ist noch erwähnenswert das ein zweites Protokoll namens Tantalos entwickelt wird: Dabei handelt es such um ein Protokoll zum automatischen finden von Kontent wie Musik im Netzwerk.

===== Status =====
Grundlegende Protokoll Entwicklung ist abgeschlossen. Es sind aber noch viele interessante Zusatz Funktionalitäten auf der Zu-Bearbeiten-Liste.

==== Haupt Paket ====
Das Haupt Paket ("roaraudio") ist ein versuch das Protokoll Referenz zu implementieren. Aber auch diese Implementierung ist unvollständig (primär bedingt durch die Zeit die es braucht die neuen Spezifikationen um zu setzen).

Das Paket besteht aus ''roard'', dem Sound Server, ''libroar und freunden'' welche die Klient seitige Schnittstelle liefern und einigen Hilfsprogrammen so wie so genannten ''Kompatibilitäts Layern''. ''roard'' kann neben dem RoarAudio Protokoll auch verschiedene Protokolle anderer Sound Systeme. Die ''Kompatibilitäts Layern'' dienen dazu Software die für andere Sound Systeme geschrieben sind mit RoarAudio Unterstützung so zu sagen ''nach zu rüsten''. Es handelt sich hierbei nicht nur um eine OSS Emulation.

===== Status =====
Das Haupt Paket ist in einem gut Benutzbarem Stadium und in mehren GNU/Linux Distributionen vorhanden.


==== µRoar und µRoarD ====
Neben der Implementierung durch das Haupt Paket entstanden im Laufe der Zeit weitere Implementierungen des Protokolls. Die wichtigsten zwei sind µRoar und µRoarD.

Bei µRoar handelt es sich um eine Klient Bibliothek unter der LGPL Version 3. Diese wurde ursprünglich entwickelt um unter Win32 proprietären Programmen den Zugriff auf RoarAudio Server zu ermöglichen.

µRoarD hingegen ist ein zweiter RoarAudio Server. Er ist bei weitem nicht so vollständig wie roard dafür aber wie der Name schon erraten lässt deutlich schlanker.

===== Status =====
µRoar wird seit langem als Stabil angesehen.
µRoarD ist in aktiver Entwicklung gilt allgemein als Stabil.
Beide sind in mehren GNU/Linux Distributionen vorhanden.

==== RoarAudio PlayList Daemon ====
Beim RoarAudio PlayList Daemon handelt es sich um eine Wiedergabelisten Verwaltungs Software. Er dient dazu Wiedergabelisten zu verwalten und Einträge daraus ab zu spielen. Zusammen mit einem RoarAudio Server und einer GUI (zum Beispiel App::RPLD::GUI) erscheint er fast wie ein gewöhnlicher Player. Im Gegensatz zu diesen hat er aber keine Logik für den Umgang mit den Audiodaten und lässt diese ausschließlich durch den RoarAudio Server verwalten.

Im Zusammenhang mit dem RoarAudio PlayList Daemon oder kurz ''RPLD'' gibt es verschieden weitere Pakete wie dem Perl Modul Audio::RPLD zum steuern, App::RPLD::GUI -- einer GUI --, Romie -- einem Webfrondend -- oder auch vclt-tools -- einem Paket zum erstellen von Wiedergabelisten.

===== Status =====
Der RoarAudio PlayList Daemon erreicht bald seine Stabile Phase und befindet sich derzeit in einem gut benutzbaren Zustand. Er ist in mehren GNU/Linux Distributionen vorhanden.

==== aroarfw und SCRSI ====
Zu guter Letzt gibt es noch verschiedene Produkte für den Eingebetteten und teilweise Eingebetteten Einsatz:

aroarfw ist einen Hardware und System unabhäniges Framework zur Entwicklung von Software die RoarAudio verwendet. Es ist vor allem für Kleinst-Rechner wie µ-Controllern gedacht.

Bei SCRSI handelt es sich um eine Schnittstelle die zwischen die das eigentliche Programm und die Schnittstelle zu RoarAudio eingefügt wird. Dies dient vor allem zum einbetten von µRoarD in andere Applikationen.

===== Status =====
Sowohl aroarfw als auch SCRSI stehen unter aktiver Entwicklung und sind in einem verwendbaren Zustand. Kontakt mit den Entwicklern wird aber empfohlen.
aroarfw findet sich in mehren GNU/Linux Distributionen.

=== Zusammenfassung ===
Mittlerweile ist RoarAudio zu einer echten Alternative zu anderen Sound Systemen geworden. Gerade im Bereich der Radio und Web-Radio Produktion, aber auch beim Versand von Audio durch das Lokale Netzwerk ist es ein gutes Mittel.

Durch die Allgemein sehr Standard freundliche Einstellung des Projekts ist die Software zu vielem anderen gut Kompatibel.

Auch die Kompatibilitäts Layer sind auf jeden Fall ein großes Plus da so fast alle Software, auch ohne native RoarAudio Unterstützung, mit RoarAudio zusammenarbeiten kann.

[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio/Vortrag/Was ist RoarAudio

2011-04-09T01:44:19Z

Ph3-der-loewe: /* Produkte */ +Status infos

RoarAudio/Vortrag/Was ist RoarAudio

2011-04-09T01:29:56Z

Ph3-der-loewe: /* RoarAudio PlayList Daemon */ + bissel Inhalt

RoarAudio PlayList Daemon/Protokoll

2011-04-09T01:21:42Z

Ph3-der-loewe: /* Liste zuer Steuerung der Haupt Wiedergabewarteschlagen-Spielliste */ typo

Auf dieser Seite wird auf das ''simple'' Protokoll des [[RoarAudio PlayList Daemon]] eingegangen. Andere durch den rpld unterstützte Protokolle werden hier ignoriert. Die Spezifikationen zu diesen sind bei den entsprechenden Herstellern zu finden beziehungsweise zu erfragen.

== Rahmen Protokoll ==
Das Protokoll besteht aus einer Sequenz von Befehl-Antwort-Paaren. Dabei Sendet der Klient einen Befehl als abgeschlossene Zeile (Terminiert mit ''line feed'', 0x0A, '\n') an den Server und dieser Beantwortet dies dann mit einem Datenbereich gefolgt von einer Status Zeile. Der Datenbereich wird durch eine Zeile die ausschließlich aus einem Punkt besteht Beendet. Sollte eine Zeile im Datenbereich vorkommen die ausschließlich aus einem oder Mehren Punkten besteht so wird ein Punkt vor gehängt um Eindeutigkeit der Ende Sequenz zu garantieren.

Die Statuszeile besteht aus drei oder vier Teilen:
* Dem Vorsatz '>',
* dem Fehler Code,
* dem Fehler Text
* und optional einer Fehlerbeschreibung in Klammern ('(...)').

Die Felder sind jeweils dusch Leerzeichen getrennt.

Beispiel:
C: NOOP
S: .
S: > 0 OK

C: HELP
S: Commands:
S: HELP
S: NOOP
S: PLAY
...
S: .
S: > 0 OK

Implementierungen '''dürfen nur''' die obigen Zeilenenden senden '''solten''' aber auch anderen gängige Zeilenumbrüche Akzeptieren.

== Fehler Codes ==
Folgende Tabelle zeigt die definierten Fehler Codes:

{| class="wikitable"
! Symbolischer Name
! Numerischer Wert
! Versionen
! Fehler Text
! Fehler beschreibung
|-
! OK
| 0
| ab 0.1beta0
| OK
| Der Befehl wurde erfolgreich abgearbeitet.
|-
! ERROR
| 1
| ab 0.1beta0
| Error
| Bei der Abarbeitung des Befehls ist ein Fehler aufgetreten.
|-
! INPROC
| 2
| ab 0.1beta0
| In Process
| Die Abarbeitung wurde wird im Hintergrund fortgesetzt.
|-
! YES
| 3
| ab 0.1beta0
| Yes
| Die Antwort auf die Anfrage ist: Wahr
|-
! NO
| 4
| ab 0.1beta0
| No
| Die Antwort auf die Anfrage ist: Falsch
|-
! PROERR
| 5
| ab 0.1beta0
| Protocol Error
| Es ist ein Protokollfehler aufgetreten. Die Verbindung kann vom Server zurück gesetzt werden.
|-
! GOODBYE
| 6
| ab 0.1beta0
| GoodBye
| Antwort auf den ''QUIT'' Befehl. Die Verbindung wird vom Server zurück gesetzt.
|-
! NOTPERM
| 7
| ab 0.1rc0
| Not Permitted
| Die Operation wird verweigert da sie nicht erlaubt ist mit den Rechten des Klienten
|-
|}

== Befehle ==
=== Befehle zur Verbindungs-Steuerung ===
==== NOOP ====
Dieser Befehl führt keine Aktion aus sondern bestätigt nur das die Verbindung noch besteht.

==== QUIT ====
Dieser Befehl beendet die Verbindung.

==== HELP ====
Dieser Befehl gibt einen Hilfe-Text zu den Befehlen aus.

==== SETPLAYLIST ====
Dieser Befehl Setzt die aktuelle Wiedergabeliste.

Syntax:
SETPLAYLIST {"Name"|ID}

==== AUTH ====
AUTH [TO AUTHLEV {n|"name"}] USING authtype...
==== UNAUTH ====
Dieser Befehl setzt das ''AccessLevel'' (''ACCLEV'') auf einen gewünschten Wert herunter.

Syntax:
UNAUTH [ACCLEV] {BY n|TO {n|"name"}}

Beispiel:
UNAUTH TO "guest"

=== Befehle zur Steuerung des Abspielvorgangs ===
==== PLAY ====
Dieser Befehl startet den Abspielvorgang.

==== STOP ====
Dieser Befehl beendet hält den Abspielvorgang an.

==== PAUSE ====
Unterbricht das Abspielen oder setzt es fort.

Syntax:
PAUSE {TRUE|FALSE|TOGGLE}

==== NEXT ====
Dieser Befehl wechselt zum nächsten Titel.

==== PREV ====
Dieser Befehl wechselt zum zuletzt gespielten Titel.

==== ISPLAYING ====
Dieser Befehl kann verwendet werden um in Erfahrung zu bringen ob gerade etwas abgespielt wird.

==== SHOWPLYING ====
Dieser Befehl zeigt den aktuellen zustand an. Sollte etwas abgespielt werden so werden weitere Daten zurückgegeben:

Beispiel Ausgabe:
<pre>
STATE RUNNING
LONGGTN long:0xE1D9000000000067
SHORTGTN short:0xE10000BE
UUID uuid:0eafd00b-0b06-4805-a61f-66dc6427b181
META TITLE "Kuschel.FM - Das Kuschelradio!"
MDUC 1
RATE 44100
CHANNELS 2
BITS 16
TIME 196090280 S (2223.246s)
</pre>

{| class="wikitable"
! Feldname
! Feldbedeutung
! Mögliche Werte
|-
! STATE
| Der aktuelle Abspielstatus.
| STOPPED, PAUSE, RUNNING
|-
! LONGGTN
| Lange Globale Titel Nummer
| GTN
|-
! SHORTGTN
| Kurtze Globale Titel Nummer
| GTN
|-
! UUID
| Eindeutiger Identifikator für den Titel
| UUID
|-
! META n
| Meta Datum des Types n
| Zeichenkette
|-
! MDUC
| Meta Daten Aktualisierungs Zähler
| Zahl
|-
! RATE
| Abtastrate
| Zahl
|-
! CHANNELS
| Kanal Anzahl
| Zahl
|-
! BITS
| Abtastbreite
| Zahl
|-
! TIME
| Zeit
| Zahl in Abtastwerten und in Sekunden
|-
|}

==== SHOWIDENTIFIER ====
Zeigt eine Zeichenkette an welche den aktuell abgespielten Titel auf der nächst tieferen Ebene repräsentierte. Dabei kann es sich um eine RoarAudio StreamID, eine Geräte Datei, eine UUID oder ein beliebig geformte andere Zeichenkette handeln. Es ist nicht Garantiert das diese keine Stimmbrüche beinhaltet oder 7-Bit Sauber ist. Die Bedeutung ist nicht weiter im Protokoll Spezifiziert und wird ausschließlich vom Daemon weitergereicht.

Syntax:
SHOWIDENTIFIER

=== Befehle der Lautstärke Steuerung ===
==== SETVOLUME ====
Setzt die Lautstärke.

Syntax:
SETVOLUME new-volume

''new-volume'' kann entweder im Format 'n%' mit n einem Prozentualen Wert von 0..100 sein, oder ein planer Integer im Bereich 0..65535.

==== SHOWVOLUME ====
Zeigt die Aktuelle Lautstärke an.

Ausgabe Beispiel:
VOLUME 65535/65535 100%

=== Befehle zur Steuerung der Haupt Wiedergabewarteschlagen-Spielliste ===
==== LISTQ ====
Zeigt den Inhalt der Haupt Wiedergabewarteschlagen-Spielliste oder einer anderen Wiedergabeliste an.

Syntax:
LISTQ [{"Name"|ID}]

==== FLUSHQ ====
Löscht den Inhalt der Haupt Wiedergabewarteschlagen-Spielliste.

==== SHOWCUR ====
Dieser Befehlt Zeigt den obersten Eintrag in der Haupt Wiedergabewarteschlagen-Spielliste an. Zur Anzeige was gerade gespielt wird ist dieser Befehl nicht geeignet. Dazu muss ''SHOWPLYING'' verwendet werden.

=== Befehle zur Wiedergabelisten Verwaltung ===
==== LISTPLAYLISTS ====
Listet alle Wiedergabelisten auf.

==== SHOWLIST ====
Zeigt die Aktuelle oder eine andere Wiedergabeliste an.

Syntax:
SHOWLIST [{"Name"|ID}]

==== ADDPLAYLIST ====
Fügt eine neue Wiedergabeliste hinzu.

Syntax:
ADDPLAYLIST "Name"

==== DELPLAYLIST ====
Löcht eine Wiedergabeliste.

Syntax:
DELPLAYLIST [{"Name"|ID}]

==== FLUSHPLAYLIST ====
Leert den Inhalt einer Wiedergabeliste.

Syntax:
FLUSHPLAYLIST [{"Name"|ID}]

==== SETPARENTLIST ====
Setzt die Eltern Liste der Aktuellen oder einer anderen Wiedergabeliste.

Syntax:
SETPARENTLIST [OF {"Name"|ID}] [TO] {"Name"|ID}

==== IMPORT ====
Importiert eine Wiedergabeliste aus einer Datei oder vom Aktuellen Datenstrom in die Aktuelle oder eine andere Wiedergabeliste.

Syntax:
IMPORT [{"Name"|ID}] FROM {STDIN|"Filename"} [AS {RPLD|PLS|M3U|VCLT|PLAIN}]

==== EXPORT ====
Exportiert die Aktuelle oder eine andere Wiedergabeliste in eine Datei oder gibt sie über den aktuellen Datenstrom aus.

Syntax:
EXPORT [{"Name"|ID}] TO {STDOUT|"Filename"} [AS {RPLD|PLS|M3U|VCLT|PLAIN}]

=== Befehle zur Wiedergabelisten Eintrags Verwaltung ===
Bei den folgenden Befehlen steht ''PLE'' immer für "''PlayList Entry''" (Wiedergabelisten Eintrag).

==== LISTPLE ====
Zeigt alle Einträge in einer Wiedergabeliste an.
Es werden entweder wie Einträge der aktuellen Liste oder der angegebenen Angezeigt.

Syntax:
LISTPLE [{"Name"|ID}]

==== SHOWPLE ====
Dieser Befehl zeigt einen bestimmten Eintrag an.
Es wird entweder in der aktuellen Liste, in der angegebenen oder in allen Listen gesucht.

Syntax:
SHOWPLE {long:0xLongID|0xLongID|short:0xShortID|uuid:UUID|pointer:name} [FROM {"Name"|ID|ANY}]

==== COPYPLE ====
Dieser Befehl kopiert einen Eintrag aus der aktuellen, einer angegebenen Liste oder einen aus allen Listen gesuchten Eintrag in eine andere Liste.
Eine Position an welcher er in der neuen Liste stehen soll kann optional angegeben werden.
Der neue Eintrag erhält eine neue ''Global Track Number'' sowie ''Short Global Track Number''.

Syntax:
COPYPLE {long:0xLongID|0xLongID|short:0xShortID|uuid:UUID|pointer:name} [FROM {"Name"|ID|ANY}] TO {"Name"|ID} [AT POSITION]

==== MOVEPLE ====
Gleich der Funktion ''COPYPLE'' nur das diese Funktion den Eintrag nicht kopiert sondern verschiebt. Die ''Global Track Number'' sowie ''Short Global Track Number'' bleibt erhalten.

Syntax:
MOVEPLE {long:0xLongID|0xLongID|short:0xShortID|uuid:UUID|pointer:name} [FROM {"Name"|ID|ANY}] TO {"Name"|ID} [AT POSITION]

==== DELPLE ====
Diese Funktion löscht einen Eintrag aus der aktuellen oder einer angegebenen Liste.

Syntax:
DELPLE {long:0xLongID|0xLongID|short:0xShortID|uuid:UUID|pointer:name} [FROM {"Name"|ID}]

==== QUEUEPLE ====
Dieser Befehl ist eine Kurzform des ''COPYPLE'' Befehls bei dem die Ziehlliste immer die Haupt Wiedergabewarteschlagen-Spielliste.

Syntax:
QUEUEPLE {long:0xLongID|0xLongID|short:0xShortID|uuid:UUID|pointer:name} [FROM {"Name"|ID|ANY}] [AT POSITION]

=== Befehle zur Zeigerverwaltung ===
==== SETPOINTER ====
Setzt den angegebenen Wiedergabelistenzeiger auf einen angegebenen Wiedergabelisten Eintrag.

Syntax:
SETPOINTER {CURRENT|DEFAULT|STARTUP|TEMP} {long:0xLongID|0xLongID|short:0xShortID|uuid:UUID|pointer:name} [FROM {"Name"|ID|ANY}]

===== Bedeutungen der Einzelnen Zeiger =====
{| class="wikitable"
! Zeigername
! Gültigkeit
! Zeiger Beschreibung
|-
! CURRENT
| Global
| Sollte die Haupt Wiedergabewarteschlagen-Spielliste leer laufen so wird der Titel auf den dieser Zeiger verweist automatisch in die Spielliste kopiert und dieser Zeiger einen Eintrag weiter geschoben in der Wiedergabeliste in der sich der Eintrag auf den er Zeigt befindet. Auf diese Weise kann eine ''Spiele alles ab hier'' Funktion implementiert werden wie sie viele andere Wiedergabe-Programme besitzen.
|-
! DEFAULT
| Global
| Sollte der ''CURRENT''-Zeiger bei einer Weiterschiebe-Operation an das Ende der Wiedergabeliste stoßen so wird er erneut mit dem Inhalt dieses Zeigers initialisiert. Auf diese weise kann ein ''Wenn am Ende dann beginn vom Neuen'' Funktion wie es viele Wiedergabe-Programme besitzen implementiert werden. Diese Zeiger Logik kann aber auch zur Implementierung höheren Funktionen verwendet werden, wie dem automatischen Wechsel zwischen verschiedenen Listen.
|-
! STARTUP
| Global
| Der Wiedergabelisten Eintrag auf den dieser Zeiger verweist wird beim Starten des Daemons automatisch abgespielt. Dies gescheit bevor die normale Abarbeitung der restlichen Titel in der Haupt Wiedergabewarteschlagen-Spielliste beginnt.
|-
! TEMP
| Klient Verbindung
| Dieser Zeiger ist rein für die Benutzung in einer Klient Applikation bestimmt. Diese könnte ihn zum Beispiel auf den Aktuell in einem [[GUI]] ausgewählten Listeneintrag verwiesen lassen.
|-
|}

==== SHOWPOINTER ====
Zeigt alle oder nur den angebenden Wiedergabelistenzeiger an.

Syntax:
SHOWPOINTER [{CURRENT|DEFAULT|STARTUP|TEMP}]

=== Befehle zur Permanent Speicherung ===
==== STORE ====
Dieser Befehl lässt den Daemon seinen Aktuellen Zustand Speichern.
Dieser kann zum Beispiel vor dem Beenden genutzt werden um den zustand dann wiederherstellen zu können beim nächsten Start. Je nach Parameter wird dieser Befehl vom Daemon beim Beenden eigenständig durchgeführt.

Syntax:
STORE

==== RESTORE ====
Stellt den Zustand wie er mit ''STORE'' gespeichert wurde wieder her.
Dies kann als Beispiel beim Starten des Daemons verwendet werden um den Zustand wieder her zu stellen der beim beenden herrschte. Je nach Parameter wird dieser Befehl vom Daemon selbstständig beim Starten ausgeführt.

''Wichtig:'' Ein mehrfaches verwenden dieses Befehls kann zu Duplikaten führen.

Syntax:
RESTORE

=== Veraltete Befehle ===
Die folgenden Befehle sind veraltet. Sie werden mit Version 0.1.0 voraussichtlich entfernt werden.
Sie sollten auf keinen Fall Verwendung finden.

Syntax:
ADD2Q entry
DELFQ identifier

=== Andere Befehle und geplante Befehle ===
Die folgenden Befehle sind in diesem Dokument nicht beschreiben, oder noch in Planung. Sie sollten aktuell nicht verwendet werden.

SEARCHPLE {"search string"|0xdiscid|uuid} [{AS|IN} {ALL|TITLE|ARTIST|VERSION|FILENAME|DISCID|UUID|TAG:"Tagname"}] [FROM {"Name"|ID|ANY}]
UPDATE [{"Name"|ID|ANY}] {TO|FROM} {STDIN|STDOUT|"Filename"} [AS {RPLD|PLS|M3U|VCLT|XSPF|PLAIN}] USING {ALL|TITLE|ARTIST|VERSION|FILENAME|DISCID|UUID|TAG:"Tagname"} [AND ...] [POLICY {DEFAULT|OLD|NEW} {KEEP|DELETE}]

== Weblinks ==
{{Homepage|roaraudio.keep-cool.org}}

[[Kategorie:RoarAudio]]
[[Kategorie:Software]]
[[Kategorie:Sound]]
{{Stub}}

RoarAudio/Vortrag/Was ist RoarAudio

2011-04-09T01:16:10Z

Ph3-der-loewe: /* Produkte */ + ne menge Inhalt...

RoarAudio/Vortrag/Was ist RoarAudio

2011-04-09T00:46:55Z

Ph3-der-loewe: /* RoarAudio Projektziele */ +Inhalt

RoarAudio/Vortrag/Was ist RoarAudio

2011-04-09T00:37:14Z

Ph3-der-loewe: /* Audio Stack unter UNIX und GNU/Linux */ +Inhalt

RoarAudio/Vortrag/Was ist RoarAudio

2011-04-09T00:29:39Z

Ph3-der-loewe: /* Was ist RoarAudio? */ +Inhalt

RoarAudio/Vortrag/Was ist RoarAudio

2011-04-09T00:16:38Z

Ph3-der-loewe: /* Vortrag */ +TOC

RoarAudio/Vortrag/Was ist RoarAudio

2011-04-09T00:13:04Z

Ph3-der-loewe: BEGIN{}

RoarAudio/Programmieren/Intro

2011-04-08T11:52:04Z

Ph3-der-loewe: /* libroar */ typo

Dies ist eine minimale Einleitung zur Programmierung mittels der [[RoarAudio]] Standard Bibliotheken.

Diese Anleitung setzt grundlegendes Verständnis zur Funktionsweise von RoarAudio voraus.

Dieses Dokument beschreibt die Standard API. Für sehr einfache Programme mag es angebracht sein die [[RoarAudio/Programmieren/Simple|Simple API]] oder die [[RoarAudio/Programmieren/VS|Very Simple API]] zu verwenden.

== Header Dateien ==
Um die RoarAudio API verwenden zu können müssen als erstes die richtigen Header eingebunden werden.
In aller Regel reicht es den Standard Header ein zu binden, welcher die meisten nötigen Header wiederum selbst einbindet:
#include <roaraudio.h>

Zur Verwendung von libroardsp, libroarlight, libroarmidi und libroareio müssen weiterhin folgende Header entsprechend eingebunden werden:
#include <libroardsp/libroardsp.h>
#include <libroarlight/libroarlight.h>
#include <libroarmidi/libroarmidi.h>
#include <libroareio/libroareio.h>

Weiterhin gibt es noch einen speziellen Header zur Verwendung von Einheiten:
#include <roaraudio/units.h>

== Verbindung zum Server ==
In aller Regel muss zu Beginn eine Verbindung zum Server aufgenommen werden. Dazu wird ein Objekt für die Verbindung angelegt und dies dann mit dem Server verbunden. Ist die Arbeit getan so wird die Verbindung wieder Beendet. Die Verbindung sollte aber offen gehalten werden sofern in absehbarer Zeit sonst eine neue Verbindung aufgebaut werden müsste. (Etwa sollte sie nicht bei einem Lied Wechsel in einem Player erst abgebaut und dann erneut Aufgebaut werden, sondern bestehen bleiben solange der Player nicht beendet wird durch den Benutzer).

Öffnen eines Steuerkanals:
struct roar_connection con; // Steuer Verbindung

if ( roar_simple_connect(&con, NULL, "Klient Name")) == -1 ) {
return -1;
}

In diesem Beispiel wird ein Objekt names ''con'' erzeugt und mit dem Standard Server (NULL) verbunden.
Wird anstatt ''NULL'' ein String übergeben so wird dieser als Server Name/Adresse verwendet. Das letzte Argument ist der Name des neuen Klienten. Dieser wird beispielsweise durch ''roarctl'' angezeigt.

Ist die Arbeit getan so kann die Verbindung einfach durch ''roar_disconnect()'' wieder geschlossen werden:

roar_disconnect(&con);

== Erstellen eines Streams ==
Ist die Verbindung zum Server aufgebaut so wird in aller Regel eine Datenverbindung ''Stream'' aufgebaut. Der der Einfachkeit wegen werden in diesem Dokument nur Streams behandelt die direkt durch die Bibliothek verbunden werden.

Um einen Stream zu öffnen benötigt man nun zwei weitere Objekte: Das Stream Objekt welches die Informationen über den Stream selbst beinhaltet und das VIO Objekt welches uns die Möglichkeit bietet Daten mit dem Stream aus zu tauchen.

struct roar_stream stream; // Stream Objekt
struct roar_vio_calls vio; // VIO Objekt

Nachdem beide Objekte erstellt sind öffnen wir nun eine Daten Verbindung zum ''Abspielen von Waveform Daten''. Dies sind Streams zum abspielen von ''normaler'' Musik ([[PCM]] und PCM ähnliche Formate, kein [[MIDI]]).

if ( roar_vio_simple_new_stream_obj(&vio,
&con,
&stream,
rate, channels, bits,
ROAR_CODEC_DEFAULT, ROAR_DIR_PLAY
) == -1 ) {
return -1;
}

Hierbei expandiert ROAR_CODEC_DEFAULT zu dem nativen PCM Format der aktuellen Maschine. ROAR_DIR_PLAY gibt an das wir Audio Daten abspielen möchten. rate, channels, bits sind entsprechend von der Applikation zu setzen entsprechend der aktuellen Daten. Übliche werte sind hier als Beispiel rate=44100Hz, channels=2, bits=16.

Sollen keine weiteren Informationen auf dem Stream gesetzt werden (Mixer Einstellungen, Meta Daten oder ähnliches) so kann das Stream Objekt ignoriert werden. Diese Einleitung tut dies, anderen Anleitungen mögen auf dieses Objekt detahierter eingehen.

Wollen wir nun Daten an den Server schicken so verwenden wir die VIO API. In unserem falle die Funktion ''roar_vio_write()'':

ret = roar_vio_write(&vio, buffer, len);

Die Funktion erwartet einen Datenpuffer sowie dessen Größe. Sie liefert die Anzahl der geschriebenen Byte zurück. Siehe auch write(2).

Erreicht unsere Applikation das Ende der Daten (zum Beispiel das Dateiende der Quell-Datei) so schließen wir das VIO Objeckt mittels ''roar_vio_close()'':

roar_vio_close(&vio);

Der Stream wird auf Seite des Servers beendet sobald dieser einen internen Puffer vollständig geleert hat. Dies kann je nach verwendetem Codec durchaus mehre Sekunden dauern. bei PCM Daten sollte dies allerdings im Milisekunden Bereich liegen und kann ignoriert werden.

Das Stream Objekt (''stream'') das wir oben angelegt haben verliert mit diesem Ereignis seine Gültigkeit. Aus diesem Grunde kann es ab dem Zeitpunkt zu dem wir das VIO Objekt geschlossen haben als ungültig angesehen werden.

== Themen Liste ==
=== libroar ===
; [[RoarAudio/Programmieren/Simple|Simple API]]
: API um simple Streams auf zu bauen.
; [[RoarAudio/Programmieren/Stream|Stream API]]
: API zur Steuerung von Streams.
; [[RoarAudio/Programmieren/Control|Control API]]
: API zur Steuerung des Servers.
; [[RoarAudio/Programmieren/VIO|Virtuelle IO (VIO)]]
: API für IO Handling.
; [[RoarAudio/Programmieren/VIO DSTR|VIO DSTR API]]
: API für das öffnen von VIO Objekten anhand von Beschreibenden Strings (z.B. URLs)
; [[RoarAudio/Programmieren/VIO Typen|VIO Typen Liste]]
: Liste von möglichen VIO Typen.
; [[RoarAudio/Programmieren/Buffer|Memory Puffer]]
: API zur komfortablen Verwaltung von Memory Puffern.
; [[RoarAudio/Programmieren/MemMgr|Memory Management API]]
: API zur Memory Verwaltung.
; [[RoarAudio/Programmieren/roardl|RoarAudio Dynamic Library API]]
: API zum dynamischen Laden von Bibliotheken (z.B. Plugins)

=== libroardsp ===
; [[RoarAudio/Programmieren/Filter|Filter]]
: Verwenden von Signal Filtern.
; [[RoarAudio/Programmieren/Fader|Fader]]
: Überblend-Efeckte.
; [[RoarAudio/Programmieren/Transcode|Transcode]]
: Signal En-/De-/Transcoder.
; [[RoarAudio/Programmieren/Andere DSP Funktionen|Andere DSP Funktionen]]
: Andere Signalverarbeitungs Funktionen.

=== libroarlight ===
; [[RoarAudio/Programmieren/RoarDMX|RoarDMX]]
: RoarDMX Licht Steuerungs Codec

=== libroarmidi ===
; [[RoarAudio/Programmieren/MIDI|MIDI]]
: Umgang mit MIDI Signalen.

=== libroareio ===
; [[RoarAudio/Programmieren/CDriver|CDriver]]
: Klient seitige Treiber.

== Siehe Auch ==
* [[RoarAudio]]

== Weblinks ==
{{Homepage|roaraudio.keep-cool.org}}

[[Kategorie:RoarAudio]]
[[Kategorie:Software]]
[[Kategorie:Sound]]
[[Kategorie:Programmierung]]
{{Stub}}

RoarAudio/Vortrag/Programmieren mit RoarAudio VS

2011-04-07T14:43:49Z

Ph3-der-loewe: /* Warten auf Stream Ende */ +Inhalt

<div style="background:#fee846;text-align:left; color: #000;font-weight:bold;font-size:125%;margin: 0px 5px 0px 0; padding: 4px 4px 4px 14px;">Was ist RoarAudio?</div>
<div style="margin: 0 5px 5px 0; padding: 1em 1em 1em 1em; border: 1px solid #fee846; background-color:#fffdf5;">
; Ziel : ein Vortrag über [[RoarAudio]]s VS API vor einem Unixpublikum mit geringem Vorwissen zum Thema. Nach ende des Vortags sollen die Hörer in der Lage sein einfache Programme mit der VS API zu schreiben.
</div>

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Abstrakt ==
Der Vortrag soll eine Einführung in die Programmierung mit der VS API aus libroar liefern. Im laufe des Vortrags werden die grundlegenden API Funktionen vorgestellt und mit Code Beispielen erläutert. Am Ende des Vortrags sollten die Zuhörer in der Lage sein einfache Programme mit der VS API zu schreiben.

Als Vorwissen empfiehlt es sich einen der Einführenden Vorträge besucht zu haben.

== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).
Im Moment studiert er Elektrotechnik/Automatisierungstechnik.

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und Digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

In seiner Freizeit beschäftigt er sich außerdem intensiv mit Großkatzen.

== Vortrag ==
=== Was ist die VS API? ===
Die VS API (von engl. "'''V'''ery '''S'''imple '''API'''") ist eine Schnittstelle auf hoher Ebene welche durch libroar angeboten wird. Sie ist stark an OpenBSD's sndio, aRtsc (KDE 2.x und 3.x) und pulsesimple angelehnt. Sie ist entwikelt worden um neuen Entwicklern und Entwicklern die mit den anderen Systemen zu tun hatten den Umstieg zu erleichtern.

Die VS API bedient nur einen sehr kleinen Bereich von RoarAudios Fähigkeiten. Sie ist auch nur für das Abspielen und Aufnehmen von Streams geeignet und hat keine allgemeinen Steuer Funktionen. Sie kann aber, anders als bei ähnlichen ähnlichen Implementierungen der anderen Sound Systeme, beliebig mit der Haupt API kombiniert werden.

=== Theorie ===
==== Schichten ====
Die VS API ist die im Moment höchste Schicht in libroar. Sie Abstrahiert mehre darunter liegenden Schichten wie die Simple API und VIO/DSTR.

==== OOP ====
Die VS API ist wie fast alles rund um RoarAudio Objekt Orientiert. Sie verwendet primär das so genannte VSS (von engl. "VS State") Objekt das sowohl Steuer-, Daten-, Datei-Verbindung Objekte sowie alle Puffer und Speicher Objekte die intern verwendet werden enthält.

=== Streaming Modus ===
Der Streaming Mode ist der '''native''' Modus. Hier wird das VS Objeckt (VSS) geöffnet und dann mittels Schreibe- und Lese-Befehlen die Audio Daten zum Server geschickt beziehungsweise von dort abgeholt. Ist man Fertig so wird das VS Objekt wieder geschlossen.

Zum öffnen gibt es zwei Funktionen: roar_vs_new_simple() und roar_vs_new_playback(). Letztere ist lediglich ein Aufruf auf die erstere und übergibt beim Richtungs und Subsystem Parameter (engl. "stream direction") den wert ROAR_DIR_PLAY. Da oft nur Wiedergabe gewünscht ist, ist diese Funktion viel zu finden.

Im zweiten Schritt werden Audio Daten gelesen oder geschrieben. Dies geschieht mittels roar_vs_read() beziehungsweise roar_vs_write().

Im letzten Schritt wird das Objekt wieder freigegeben und die Verbindungen geschlossen. Dies gescheit mittels roar_vs_close().

Sollten Meta Daten oder andere Steuerinformationen (Siehe weiter am Ende des Vortrags) gesetzt werden sollten diese vor dem ersten Aufruf von roar_vs_read() beziehungsweise roar_vs_write() gesetzt werden.

Beispiel:
<nowiki>roar_vs_t * vss = roar_vs_new_simple(server, "MyApp", rate, channels, codec, bits, ROAR_DIR_PLAY, &err);

while (alive) { // main loop...
// ...
ret = roar_vs_write(vss, buf, len, &err);
}

ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

In diesem Beispiel wurde ein Stream zum Server ''server'' aufgebaut, Die Audio Parameter finden sich in ''rate'', ''channels'', ''codec'' und ''bits''. Er ist zur Wiedergabe (ROAR_DIR_PLAY).
Die Variablen ''ret'' und ''err' werden im nächsten Kapitel erläutert.

Der Parameter ''server'' kann (und sollte meistens auch) den Wert NULL haben. Dies steht für das verbinden zum Default Server.

Auch ist der Applikationsname (hier: "''MyApp''") angegeben. Dieser sollte einen Sprechenden Namen für das Produkt beinhalten. Normalerweise das was man auf der Packung oder der CD Hülle in großen Lettern erwartet.

Folgendes sollte nicht verwendet werden:
* Versionen (ggf. noch ''major releases''),
* Datei Namen ("myapp.bin", "myapp.exe"),
* Pfad Namen ("/usr/bin/player").

Auf die Audio Parameter soll hier nicht weiter eingegangen werden als diese Grundlagen Wissen sind den Zeitrahmen sprengen würden.

Der Richtungs und Subsystem Parameter hat im oberen Beispiel den Wert ROAR_DIR_PLAY. Andere Werte sind als Beispiel ROAR_DIR_RECORD, ROAR_DIR_MONITOR oder auch ROAR_DIR_MIDI_IN. Genaueres sollte aus passenden Tabellen entnommen werden.

Der zweite Parameter bei der Funktion roar_vs_close() (hier ROAR_VS_FALSE) gibt an ob beim Schließen des Objekts auch auf Server Seite der Stream direkt beendet werden soll (ROAR_VS_TRUE) oder nicht (ROAR_VS_FALSE). Im Falle das er nicht direkt beendet werden soll (Normalfall) wird noch zu Ende gespielt bis alle Puffer leer sind. Dies macht vor allem bei komprimierten Codecs wie Ogg Vorbis (ROAR_CODEC_OGG_VORBIS) einen unterschied der Teilweise im Sekunden Bereich liegt.

=== Fehler Behandlung ===
* Die meisten Aufraufe werfen -1 zurück im Fehlerfall. Ausnahmen sind beispielsweise Funktionen welche einen Pointer zurückgeben. Diese werfen NULL.
* IO Funktionen können "short reads" bzw. "short writes" erzeugen.
* Die Fehlervariable (&err) beinhaltet ''im Fehlerfall'' einen Fehler Code. Dieser kann mittels roar_vs_strerr(err) in eine Zeichenkette gewandelt werden.

<nowiki>int err;
ssize_t ret = roar_vs_write(vss, buf, len, &err);
if ( ret == -1 ) {
fprintf(stderr, "Fehler beim schreiben: %s\n", roar_vs_strerr(err));
} else if ( ret < (ssize_t)len) {
fprintf(stderr, "\"Short write\", nur %zi von %zu Bytes geschieben\n", ret, len);
}</nowiki>

=== Datei Modus ===
Die VS API besitzt einen Datei Modus (engl. "file mode") in dem sie direkt Dateien aber auch Streams abspielen kann. Dazu wird die Verbindung mittels roar_vs_new_from_file() geöffnet. Anschließend wird mittels roar_vs_run() oder roar_vs_iterate() der Datenstrom zum Server geschrieben. Am Schluss wird das Objekt normal mittels roar_vs_close() geschlossen.

Sollten Meta Daten, Lautstärke oder ähnliches gesetzt werden so sollte dies vor dem Aufruf von roar_vs_run() beziehungsweise vor dem ersten Aufruf von roar_vs_iterate() gesehen.

Beispiel:
<nowiki>roar_vs_t * vss = roar_vs_new_from_file(server, "MyApp", filename, &err);
ret = roar_vs_run(vss, &err);
ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

Im obigen Beispiel wird zum Server '''server''' (sollte normalerweise NULL sein) verbunden. Der Klient Name ist "'''MyApp'''". Als Dateiname wird '''filename''' verwendet. Danach wird roar_vs_run() aufgerufen was bis zum Dateiende (EOF) die Datei abspielt. Am ende wird ganz normal mittels roar_vs_close() die Verbindung geschlossen.

Da roar_vs_run() so lange läuft bis es das Dateiende erreicht oder ein Fehler auftritt ist blockt ist es nicht (trivial) möglich im selben Kontext weitere Dinge parallel aus zu führen. Da viele Programme aber ohne hin einen eigenen Thread für die Tonausgabe verwenden ist dies eine geringe Einschränkung. Für alle anderen Felle gibt es roar_vs_iterate() wie das folgende Beispiel zeigt:

<nowiki>roar_vs_t * vss = roar_vs_new_from_file(server, "MyApp", filename, &err);

while (alive) { /* main loop */
// ...
ret = roar_vs_iterate(vss, ROAR_VS_WAIT, &err);
}

ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

=== Gepufferter Modus ===
Viele Applikationen erwarten einen Gepufferten Modus vor zu finden in dem sie einen Ring Puffer mit sehr definiertem zustand vor finden in den sie Arbeiten können. Dieses Vorgehen ist nur mit einem Lokalen Ringpuffer möglich der recht groß ist und viele Nachteile in sich birgt. Aus diesem Grunde wird dieser Modus nicht Empfohlen.

An dieser Stelle soll auch nur Kurz erwähnt sein das dieser Existiert und mit der Funktion roar_vs_buffer() zu steuern ist. Weitere Informationen finden sich in der Dokumentation.

Um nicht weiter zu Verwirren direkt zum Nächsten Kapitel...

=== Meta Daten ===
Derzeit stellt die VS API zwei Meta Daten Schnittstellen zur Verfügung: Titel Meta Daten und Stream Rolle.

==== Titel Meta Daten ====
Die Titel Meta Daten (Normalerweise nur "Meta Daten) sind Informationen über den Aktuellen Titel: Künstler, Titel, Album, Genre, Version, Titelnummer, RPG, und viele mehr.

Diese werden mit der Funktion roar_vs_meta() gesetzt

<nowiki>struct roar_keyval kv[3] = {
{"TITEL", "Test Titel"},
{"ARTIST", "Irgendwer"},
{"VERSION", "Vortrags Remix"}
};
ret = roar_vs_meta(vss, kv, 3 /* Anzahl der Datensätze */, &err);</nowiki>

==== Stream Rolle ====
Die Stream Rolle (engl. "stream role") gibt die Funktion des Streams an: Musik, Video, Ereignisse (z.B. Fehlermeldungs Töne), Spiel, Hintergrund Musik, Telephon,...

Diese wird mit der Funktion roar_vs_role() gesetzt:

<nowiki>ret = roar_vs_role(vss, ROAR_ROLE_MUSIC, &err);</nowiki>

=== Lautstärkesteuerung ===
Zur Lautstärkesteuerung stehen in der VS API drei Funktionen zur Verfügung: roar_vs_volume_mono(), roar_vs_volume_stereo() und roar_vs_volume_get().

Die beiden Ersetzen setzen die Lautstärke, jeweils im Mono oder im Stereo Modus. Das heißt sollte eine Datenstrom eine andere Anzahl von Kanälen haben so rechnen diese Funktionen automatisch um.

Die Lautstärke Skala geht vom 0 bis 1 (inklusive).

Im folgenden Beispiel wird die Lautstärke auf 50% (-6dB) eingestellt:
<nowiki>float c = 0.5; /* 50% */
ret = roar_vs_volume_mono(vss, c, &err);</nowiki>

Im zweiten Beispiel wird der Linke Kanal auf 50% (-6dB) und der Rechte Kanal auf 25% (-12dB) eingestellt:
<nowiki>float l = 0.5, r = 0.25;
ret = roar_vs_volume_stereo(vss, l, r, &err);</nowiki>

Die Lautstärke lässt sich mittels roar_vs_volume_get() wie folgt auslesen:
<nowiki>float l, r;
ret = roar_vs_volume_get(vss, &l, &r, &err);</nowiki>

Sollte die Mono-Lautstärke und nicht die L/R-Lautstärke gewünscht sein:
<nowiki>float c = (l + r)/2.0;</nowiki>

''Zum Stumm schalten sollte die Lautstärke nicht geändert werden sondern das Mute-Flag verwendet werden (Nächste Folie).''

=== Flags ===
Aktuell unterstützt die VS die beiden Flags "Mute" und "Pause".

Das Mute Flag schaltet die Ausgabe des Tons ab, der Stream läuft aber weiterhin. Das Flag Pause hält den Stream an so das er später fortgesetzt werden kann.

Die Flags werden mit den Funktionen roar_vs_pause() und roar_vs_mute() gesetzt:

<nowiki>ret = roar_vs_mute(vss, ROAR_VS_TRUE, &err);</nowiki>
Beziehungsweise:
<nowiki>ret = roar_vs_pause(vss, ROAR_VS_TRUE, &err);</nowiki>

Anstatt ROAR_VS_TRUE (zum setzen) kann natuerlich auch ROAR_VS_FALSE (zum rücksetzen) und ROAR_VS_TOGGLE (zum kippen) verwendet werden.

Mittels ROAR_VS_ASK kann der zustand angefragt werden.

== Optionales ==
=== Nicht Blockender Zugriffsmodus ===
Wie auf normalen Filehandles in der UNIX Welt kann auch auf VS Objekten ein Nicht-Blockender Modus verwendet werden. Das heißt das Lese- und Schreibbefehle nicht blockieren sondern nur im internen Puffer operieren und somit schneller zurückkehren. Der Nachteil ist das dabei so genannte "short reads" beziehungsweise "short writes" häufiger passieren.

Der Nicht Blockierende Modus kann mittels der Funktion roar_vs_blocking() verwendet werden wie im folgenden Beispiel gezeigt:
<nowiki>ret = roar_vs_blocking(vss, ROAR_VS_TRUE, &err);</nowiki>

Der zweite Parameter gibt dabei an ob der Modus gesetzt werden soll (ROAR_VS_TRUE) oder zurückgesetzt (ROAR_VS_FALSE). Natürlich kann er auch gekippt (ROAR_VS_TOGGLE) oder Abgefragt werden (ROAR_VS_ASK).

=== Warten auf Stream Ende ===
Mit der Funktion roar_vs_sync() kann man auf das Ende des Streams warten.

Beispiel:
<nowiki>ret = roar_vs_write(vss, buf, len, &err); // letzter Schreibzugriff
ret = roar_vs_sync(vss, ROAR_VS_WAIT, &err);
// am Stream-Ende
ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

Es sollte nach dem Aufruf von roar_vs_sync() entweder direkt der Stream geschlossen werden oder erneut geschrieben. In letzterem Fall wird ein Knacken oder ähnliches zu hören sein durch die Unterlaufs bedingte Unterbrechung (engl. "underrun").

=== Interface zur Haupt API ===
...

[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio/Vortrag/Programmieren mit RoarAudio VS

2011-04-07T14:38:18Z

Ph3-der-loewe: /* Non-Blocking */ +Inhalt

<div style="background:#fee846;text-align:left; color: #000;font-weight:bold;font-size:125%;margin: 0px 5px 0px 0; padding: 4px 4px 4px 14px;">Was ist RoarAudio?</div>
<div style="margin: 0 5px 5px 0; padding: 1em 1em 1em 1em; border: 1px solid #fee846; background-color:#fffdf5;">
; Ziel : ein Vortrag über [[RoarAudio]]s VS API vor einem Unixpublikum mit geringem Vorwissen zum Thema. Nach ende des Vortags sollen die Hörer in der Lage sein einfache Programme mit der VS API zu schreiben.
</div>

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Abstrakt ==
Der Vortrag soll eine Einführung in die Programmierung mit der VS API aus libroar liefern. Im laufe des Vortrags werden die grundlegenden API Funktionen vorgestellt und mit Code Beispielen erläutert. Am Ende des Vortrags sollten die Zuhörer in der Lage sein einfache Programme mit der VS API zu schreiben.

Als Vorwissen empfiehlt es sich einen der Einführenden Vorträge besucht zu haben.

== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).
Im Moment studiert er Elektrotechnik/Automatisierungstechnik.

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und Digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

In seiner Freizeit beschäftigt er sich außerdem intensiv mit Großkatzen.

== Vortrag ==
=== Was ist die VS API? ===
Die VS API (von engl. "'''V'''ery '''S'''imple '''API'''") ist eine Schnittstelle auf hoher Ebene welche durch libroar angeboten wird. Sie ist stark an OpenBSD's sndio, aRtsc (KDE 2.x und 3.x) und pulsesimple angelehnt. Sie ist entwikelt worden um neuen Entwicklern und Entwicklern die mit den anderen Systemen zu tun hatten den Umstieg zu erleichtern.

Die VS API bedient nur einen sehr kleinen Bereich von RoarAudios Fähigkeiten. Sie ist auch nur für das Abspielen und Aufnehmen von Streams geeignet und hat keine allgemeinen Steuer Funktionen. Sie kann aber, anders als bei ähnlichen ähnlichen Implementierungen der anderen Sound Systeme, beliebig mit der Haupt API kombiniert werden.

=== Theorie ===
==== Schichten ====
Die VS API ist die im Moment höchste Schicht in libroar. Sie Abstrahiert mehre darunter liegenden Schichten wie die Simple API und VIO/DSTR.

==== OOP ====
Die VS API ist wie fast alles rund um RoarAudio Objekt Orientiert. Sie verwendet primär das so genannte VSS (von engl. "VS State") Objekt das sowohl Steuer-, Daten-, Datei-Verbindung Objekte sowie alle Puffer und Speicher Objekte die intern verwendet werden enthält.

=== Streaming Modus ===
Der Streaming Mode ist der '''native''' Modus. Hier wird das VS Objeckt (VSS) geöffnet und dann mittels Schreibe- und Lese-Befehlen die Audio Daten zum Server geschickt beziehungsweise von dort abgeholt. Ist man Fertig so wird das VS Objekt wieder geschlossen.

Zum öffnen gibt es zwei Funktionen: roar_vs_new_simple() und roar_vs_new_playback(). Letztere ist lediglich ein Aufruf auf die erstere und übergibt beim Richtungs und Subsystem Parameter (engl. "stream direction") den wert ROAR_DIR_PLAY. Da oft nur Wiedergabe gewünscht ist, ist diese Funktion viel zu finden.

Im zweiten Schritt werden Audio Daten gelesen oder geschrieben. Dies geschieht mittels roar_vs_read() beziehungsweise roar_vs_write().

Im letzten Schritt wird das Objekt wieder freigegeben und die Verbindungen geschlossen. Dies gescheit mittels roar_vs_close().

Sollten Meta Daten oder andere Steuerinformationen (Siehe weiter am Ende des Vortrags) gesetzt werden sollten diese vor dem ersten Aufruf von roar_vs_read() beziehungsweise roar_vs_write() gesetzt werden.

Beispiel:
<nowiki>roar_vs_t * vss = roar_vs_new_simple(server, "MyApp", rate, channels, codec, bits, ROAR_DIR_PLAY, &err);

while (alive) { // main loop...
// ...
ret = roar_vs_write(vss, buf, len, &err);
}

ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

In diesem Beispiel wurde ein Stream zum Server ''server'' aufgebaut, Die Audio Parameter finden sich in ''rate'', ''channels'', ''codec'' und ''bits''. Er ist zur Wiedergabe (ROAR_DIR_PLAY).
Die Variablen ''ret'' und ''err' werden im nächsten Kapitel erläutert.

Der Parameter ''server'' kann (und sollte meistens auch) den Wert NULL haben. Dies steht für das verbinden zum Default Server.

Auch ist der Applikationsname (hier: "''MyApp''") angegeben. Dieser sollte einen Sprechenden Namen für das Produkt beinhalten. Normalerweise das was man auf der Packung oder der CD Hülle in großen Lettern erwartet.

Folgendes sollte nicht verwendet werden:
* Versionen (ggf. noch ''major releases''),
* Datei Namen ("myapp.bin", "myapp.exe"),
* Pfad Namen ("/usr/bin/player").

Auf die Audio Parameter soll hier nicht weiter eingegangen werden als diese Grundlagen Wissen sind den Zeitrahmen sprengen würden.

Der Richtungs und Subsystem Parameter hat im oberen Beispiel den Wert ROAR_DIR_PLAY. Andere Werte sind als Beispiel ROAR_DIR_RECORD, ROAR_DIR_MONITOR oder auch ROAR_DIR_MIDI_IN. Genaueres sollte aus passenden Tabellen entnommen werden.

Der zweite Parameter bei der Funktion roar_vs_close() (hier ROAR_VS_FALSE) gibt an ob beim Schließen des Objekts auch auf Server Seite der Stream direkt beendet werden soll (ROAR_VS_TRUE) oder nicht (ROAR_VS_FALSE). Im Falle das er nicht direkt beendet werden soll (Normalfall) wird noch zu Ende gespielt bis alle Puffer leer sind. Dies macht vor allem bei komprimierten Codecs wie Ogg Vorbis (ROAR_CODEC_OGG_VORBIS) einen unterschied der Teilweise im Sekunden Bereich liegt.

=== Fehler Behandlung ===
* Die meisten Aufraufe werfen -1 zurück im Fehlerfall. Ausnahmen sind beispielsweise Funktionen welche einen Pointer zurückgeben. Diese werfen NULL.
* IO Funktionen können "short reads" bzw. "short writes" erzeugen.
* Die Fehlervariable (&err) beinhaltet ''im Fehlerfall'' einen Fehler Code. Dieser kann mittels roar_vs_strerr(err) in eine Zeichenkette gewandelt werden.

<nowiki>int err;
ssize_t ret = roar_vs_write(vss, buf, len, &err);
if ( ret == -1 ) {
fprintf(stderr, "Fehler beim schreiben: %s\n", roar_vs_strerr(err));
} else if ( ret < (ssize_t)len) {
fprintf(stderr, "\"Short write\", nur %zi von %zu Bytes geschieben\n", ret, len);
}</nowiki>

=== Datei Modus ===
Die VS API besitzt einen Datei Modus (engl. "file mode") in dem sie direkt Dateien aber auch Streams abspielen kann. Dazu wird die Verbindung mittels roar_vs_new_from_file() geöffnet. Anschließend wird mittels roar_vs_run() oder roar_vs_iterate() der Datenstrom zum Server geschrieben. Am Schluss wird das Objekt normal mittels roar_vs_close() geschlossen.

Sollten Meta Daten, Lautstärke oder ähnliches gesetzt werden so sollte dies vor dem Aufruf von roar_vs_run() beziehungsweise vor dem ersten Aufruf von roar_vs_iterate() gesehen.

Beispiel:
<nowiki>roar_vs_t * vss = roar_vs_new_from_file(server, "MyApp", filename, &err);
ret = roar_vs_run(vss, &err);
ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

Im obigen Beispiel wird zum Server '''server''' (sollte normalerweise NULL sein) verbunden. Der Klient Name ist "'''MyApp'''". Als Dateiname wird '''filename''' verwendet. Danach wird roar_vs_run() aufgerufen was bis zum Dateiende (EOF) die Datei abspielt. Am ende wird ganz normal mittels roar_vs_close() die Verbindung geschlossen.

Da roar_vs_run() so lange läuft bis es das Dateiende erreicht oder ein Fehler auftritt ist blockt ist es nicht (trivial) möglich im selben Kontext weitere Dinge parallel aus zu führen. Da viele Programme aber ohne hin einen eigenen Thread für die Tonausgabe verwenden ist dies eine geringe Einschränkung. Für alle anderen Felle gibt es roar_vs_iterate() wie das folgende Beispiel zeigt:

<nowiki>roar_vs_t * vss = roar_vs_new_from_file(server, "MyApp", filename, &err);

while (alive) { /* main loop */
// ...
ret = roar_vs_iterate(vss, ROAR_VS_WAIT, &err);
}

ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

=== Gepufferter Modus ===
Viele Applikationen erwarten einen Gepufferten Modus vor zu finden in dem sie einen Ring Puffer mit sehr definiertem zustand vor finden in den sie Arbeiten können. Dieses Vorgehen ist nur mit einem Lokalen Ringpuffer möglich der recht groß ist und viele Nachteile in sich birgt. Aus diesem Grunde wird dieser Modus nicht Empfohlen.

An dieser Stelle soll auch nur Kurz erwähnt sein das dieser Existiert und mit der Funktion roar_vs_buffer() zu steuern ist. Weitere Informationen finden sich in der Dokumentation.

Um nicht weiter zu Verwirren direkt zum Nächsten Kapitel...

=== Meta Daten ===
Derzeit stellt die VS API zwei Meta Daten Schnittstellen zur Verfügung: Titel Meta Daten und Stream Rolle.

==== Titel Meta Daten ====
Die Titel Meta Daten (Normalerweise nur "Meta Daten) sind Informationen über den Aktuellen Titel: Künstler, Titel, Album, Genre, Version, Titelnummer, RPG, und viele mehr.

Diese werden mit der Funktion roar_vs_meta() gesetzt

<nowiki>struct roar_keyval kv[3] = {
{"TITEL", "Test Titel"},
{"ARTIST", "Irgendwer"},
{"VERSION", "Vortrags Remix"}
};
ret = roar_vs_meta(vss, kv, 3 /* Anzahl der Datensätze */, &err);</nowiki>

==== Stream Rolle ====
Die Stream Rolle (engl. "stream role") gibt die Funktion des Streams an: Musik, Video, Ereignisse (z.B. Fehlermeldungs Töne), Spiel, Hintergrund Musik, Telephon,...

Diese wird mit der Funktion roar_vs_role() gesetzt:

<nowiki>ret = roar_vs_role(vss, ROAR_ROLE_MUSIC, &err);</nowiki>

=== Lautstärkesteuerung ===
Zur Lautstärkesteuerung stehen in der VS API drei Funktionen zur Verfügung: roar_vs_volume_mono(), roar_vs_volume_stereo() und roar_vs_volume_get().

Die beiden Ersetzen setzen die Lautstärke, jeweils im Mono oder im Stereo Modus. Das heißt sollte eine Datenstrom eine andere Anzahl von Kanälen haben so rechnen diese Funktionen automatisch um.

Die Lautstärke Skala geht vom 0 bis 1 (inklusive).

Im folgenden Beispiel wird die Lautstärke auf 50% (-6dB) eingestellt:
<nowiki>float c = 0.5; /* 50% */
ret = roar_vs_volume_mono(vss, c, &err);</nowiki>

Im zweiten Beispiel wird der Linke Kanal auf 50% (-6dB) und der Rechte Kanal auf 25% (-12dB) eingestellt:
<nowiki>float l = 0.5, r = 0.25;
ret = roar_vs_volume_stereo(vss, l, r, &err);</nowiki>

Die Lautstärke lässt sich mittels roar_vs_volume_get() wie folgt auslesen:
<nowiki>float l, r;
ret = roar_vs_volume_get(vss, &l, &r, &err);</nowiki>

Sollte die Mono-Lautstärke und nicht die L/R-Lautstärke gewünscht sein:
<nowiki>float c = (l + r)/2.0;</nowiki>

''Zum Stumm schalten sollte die Lautstärke nicht geändert werden sondern das Mute-Flag verwendet werden (Nächste Folie).''

=== Flags ===
Aktuell unterstützt die VS die beiden Flags "Mute" und "Pause".

Das Mute Flag schaltet die Ausgabe des Tons ab, der Stream läuft aber weiterhin. Das Flag Pause hält den Stream an so das er später fortgesetzt werden kann.

Die Flags werden mit den Funktionen roar_vs_pause() und roar_vs_mute() gesetzt:

<nowiki>ret = roar_vs_mute(vss, ROAR_VS_TRUE, &err);</nowiki>
Beziehungsweise:
<nowiki>ret = roar_vs_pause(vss, ROAR_VS_TRUE, &err);</nowiki>

Anstatt ROAR_VS_TRUE (zum setzen) kann natuerlich auch ROAR_VS_FALSE (zum rücksetzen) und ROAR_VS_TOGGLE (zum kippen) verwendet werden.

Mittels ROAR_VS_ASK kann der zustand angefragt werden.

== Optionales ==
=== Nicht Blockender Zugriffsmodus ===
Wie auf normalen Filehandles in der UNIX Welt kann auch auf VS Objekten ein Nicht-Blockender Modus verwendet werden. Das heißt das Lese- und Schreibbefehle nicht blockieren sondern nur im internen Puffer operieren und somit schneller zurückkehren. Der Nachteil ist das dabei so genannte "short reads" beziehungsweise "short writes" häufiger passieren.

Der Nicht Blockierende Modus kann mittels der Funktion roar_vs_blocking() verwendet werden wie im folgenden Beispiel gezeigt:
<nowiki>ret = roar_vs_blocking(vss, ROAR_VS_TRUE, &err);</nowiki>

Der zweite Parameter gibt dabei an ob der Modus gesetzt werden soll (ROAR_VS_TRUE) oder zurückgesetzt (ROAR_VS_FALSE). Natürlich kann er auch gekippt (ROAR_VS_TOGGLE) oder Abgefragt werden (ROAR_VS_ASK).

=== Warten auf Stream Ende ===
...

=== Interface zur Haupt API ===
...

[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio/Vortrag/Programmieren mit RoarAudio VS

2011-04-07T14:02:55Z

Ph3-der-loewe: /* Optionales */ + nen paar kapittel

<div style="background:#fee846;text-align:left; color: #000;font-weight:bold;font-size:125%;margin: 0px 5px 0px 0; padding: 4px 4px 4px 14px;">Was ist RoarAudio?</div>
<div style="margin: 0 5px 5px 0; padding: 1em 1em 1em 1em; border: 1px solid #fee846; background-color:#fffdf5;">
; Ziel : ein Vortrag über [[RoarAudio]]s VS API vor einem Unixpublikum mit geringem Vorwissen zum Thema. Nach ende des Vortags sollen die Hörer in der Lage sein einfache Programme mit der VS API zu schreiben.
</div>

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Abstrakt ==
Der Vortrag soll eine Einführung in die Programmierung mit der VS API aus libroar liefern. Im laufe des Vortrags werden die grundlegenden API Funktionen vorgestellt und mit Code Beispielen erläutert. Am Ende des Vortrags sollten die Zuhörer in der Lage sein einfache Programme mit der VS API zu schreiben.

Als Vorwissen empfiehlt es sich einen der Einführenden Vorträge besucht zu haben.

== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).
Im Moment studiert er Elektrotechnik/Automatisierungstechnik.

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und Digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

In seiner Freizeit beschäftigt er sich außerdem intensiv mit Großkatzen.

== Vortrag ==
=== Was ist die VS API? ===
Die VS API (von engl. "'''V'''ery '''S'''imple '''API'''") ist eine Schnittstelle auf hoher Ebene welche durch libroar angeboten wird. Sie ist stark an OpenBSD's sndio, aRtsc (KDE 2.x und 3.x) und pulsesimple angelehnt. Sie ist entwikelt worden um neuen Entwicklern und Entwicklern die mit den anderen Systemen zu tun hatten den Umstieg zu erleichtern.

Die VS API bedient nur einen sehr kleinen Bereich von RoarAudios Fähigkeiten. Sie ist auch nur für das Abspielen und Aufnehmen von Streams geeignet und hat keine allgemeinen Steuer Funktionen. Sie kann aber, anders als bei ähnlichen ähnlichen Implementierungen der anderen Sound Systeme, beliebig mit der Haupt API kombiniert werden.

=== Theorie ===
==== Schichten ====
Die VS API ist die im Moment höchste Schicht in libroar. Sie Abstrahiert mehre darunter liegenden Schichten wie die Simple API und VIO/DSTR.

==== OOP ====
Die VS API ist wie fast alles rund um RoarAudio Objekt Orientiert. Sie verwendet primär das so genannte VSS (von engl. "VS State") Objekt das sowohl Steuer-, Daten-, Datei-Verbindung Objekte sowie alle Puffer und Speicher Objekte die intern verwendet werden enthält.

=== Streaming Modus ===
Der Streaming Mode ist der '''native''' Modus. Hier wird das VS Objeckt (VSS) geöffnet und dann mittels Schreibe- und Lese-Befehlen die Audio Daten zum Server geschickt beziehungsweise von dort abgeholt. Ist man Fertig so wird das VS Objekt wieder geschlossen.

Zum öffnen gibt es zwei Funktionen: roar_vs_new_simple() und roar_vs_new_playback(). Letztere ist lediglich ein Aufruf auf die erstere und übergibt beim Richtungs und Subsystem Parameter (engl. "stream direction") den wert ROAR_DIR_PLAY. Da oft nur Wiedergabe gewünscht ist, ist diese Funktion viel zu finden.

Im zweiten Schritt werden Audio Daten gelesen oder geschrieben. Dies geschieht mittels roar_vs_read() beziehungsweise roar_vs_write().

Im letzten Schritt wird das Objekt wieder freigegeben und die Verbindungen geschlossen. Dies gescheit mittels roar_vs_close().

Sollten Meta Daten oder andere Steuerinformationen (Siehe weiter am Ende des Vortrags) gesetzt werden sollten diese vor dem ersten Aufruf von roar_vs_read() beziehungsweise roar_vs_write() gesetzt werden.

Beispiel:
<nowiki>roar_vs_t * vss = roar_vs_new_simple(server, "MyApp", rate, channels, codec, bits, ROAR_DIR_PLAY, &err);

while (alive) { // main loop...
// ...
ret = roar_vs_write(vss, buf, len, &err);
}

ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

In diesem Beispiel wurde ein Stream zum Server ''server'' aufgebaut, Die Audio Parameter finden sich in ''rate'', ''channels'', ''codec'' und ''bits''. Er ist zur Wiedergabe (ROAR_DIR_PLAY).
Die Variablen ''ret'' und ''err' werden im nächsten Kapitel erläutert.

Der Parameter ''server'' kann (und sollte meistens auch) den Wert NULL haben. Dies steht für das verbinden zum Default Server.

Auch ist der Applikationsname (hier: "''MyApp''") angegeben. Dieser sollte einen Sprechenden Namen für das Produkt beinhalten. Normalerweise das was man auf der Packung oder der CD Hülle in großen Lettern erwartet.

Folgendes sollte nicht verwendet werden:
* Versionen (ggf. noch ''major releases''),
* Datei Namen ("myapp.bin", "myapp.exe"),
* Pfad Namen ("/usr/bin/player").

Auf die Audio Parameter soll hier nicht weiter eingegangen werden als diese Grundlagen Wissen sind den Zeitrahmen sprengen würden.

Der Richtungs und Subsystem Parameter hat im oberen Beispiel den Wert ROAR_DIR_PLAY. Andere Werte sind als Beispiel ROAR_DIR_RECORD, ROAR_DIR_MONITOR oder auch ROAR_DIR_MIDI_IN. Genaueres sollte aus passenden Tabellen entnommen werden.

Der zweite Parameter bei der Funktion roar_vs_close() (hier ROAR_VS_FALSE) gibt an ob beim Schließen des Objekts auch auf Server Seite der Stream direkt beendet werden soll (ROAR_VS_TRUE) oder nicht (ROAR_VS_FALSE). Im Falle das er nicht direkt beendet werden soll (Normalfall) wird noch zu Ende gespielt bis alle Puffer leer sind. Dies macht vor allem bei komprimierten Codecs wie Ogg Vorbis (ROAR_CODEC_OGG_VORBIS) einen unterschied der Teilweise im Sekunden Bereich liegt.

=== Fehler Behandlung ===
* Die meisten Aufraufe werfen -1 zurück im Fehlerfall. Ausnahmen sind beispielsweise Funktionen welche einen Pointer zurückgeben. Diese werfen NULL.
* IO Funktionen können "short reads" bzw. "short writes" erzeugen.
* Die Fehlervariable (&err) beinhaltet ''im Fehlerfall'' einen Fehler Code. Dieser kann mittels roar_vs_strerr(err) in eine Zeichenkette gewandelt werden.

<nowiki>int err;
ssize_t ret = roar_vs_write(vss, buf, len, &err);
if ( ret == -1 ) {
fprintf(stderr, "Fehler beim schreiben: %s\n", roar_vs_strerr(err));
} else if ( ret < (ssize_t)len) {
fprintf(stderr, "\"Short write\", nur %zi von %zu Bytes geschieben\n", ret, len);
}</nowiki>

=== Datei Modus ===
Die VS API besitzt einen Datei Modus (engl. "file mode") in dem sie direkt Dateien aber auch Streams abspielen kann. Dazu wird die Verbindung mittels roar_vs_new_from_file() geöffnet. Anschließend wird mittels roar_vs_run() oder roar_vs_iterate() der Datenstrom zum Server geschrieben. Am Schluss wird das Objekt normal mittels roar_vs_close() geschlossen.

Sollten Meta Daten, Lautstärke oder ähnliches gesetzt werden so sollte dies vor dem Aufruf von roar_vs_run() beziehungsweise vor dem ersten Aufruf von roar_vs_iterate() gesehen.

Beispiel:
<nowiki>roar_vs_t * vss = roar_vs_new_from_file(server, "MyApp", filename, &err);
ret = roar_vs_run(vss, &err);
ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

Im obigen Beispiel wird zum Server '''server''' (sollte normalerweise NULL sein) verbunden. Der Klient Name ist "'''MyApp'''". Als Dateiname wird '''filename''' verwendet. Danach wird roar_vs_run() aufgerufen was bis zum Dateiende (EOF) die Datei abspielt. Am ende wird ganz normal mittels roar_vs_close() die Verbindung geschlossen.

Da roar_vs_run() so lange läuft bis es das Dateiende erreicht oder ein Fehler auftritt ist blockt ist es nicht (trivial) möglich im selben Kontext weitere Dinge parallel aus zu führen. Da viele Programme aber ohne hin einen eigenen Thread für die Tonausgabe verwenden ist dies eine geringe Einschränkung. Für alle anderen Felle gibt es roar_vs_iterate() wie das folgende Beispiel zeigt:

<nowiki>roar_vs_t * vss = roar_vs_new_from_file(server, "MyApp", filename, &err);

while (alive) { /* main loop */
// ...
ret = roar_vs_iterate(vss, ROAR_VS_WAIT, &err);
}

ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

=== Gepufferter Modus ===
Viele Applikationen erwarten einen Gepufferten Modus vor zu finden in dem sie einen Ring Puffer mit sehr definiertem zustand vor finden in den sie Arbeiten können. Dieses Vorgehen ist nur mit einem Lokalen Ringpuffer möglich der recht groß ist und viele Nachteile in sich birgt. Aus diesem Grunde wird dieser Modus nicht Empfohlen.

An dieser Stelle soll auch nur Kurz erwähnt sein das dieser Existiert und mit der Funktion roar_vs_buffer() zu steuern ist. Weitere Informationen finden sich in der Dokumentation.

Um nicht weiter zu Verwirren direkt zum Nächsten Kapitel...

=== Meta Daten ===
Derzeit stellt die VS API zwei Meta Daten Schnittstellen zur Verfügung: Titel Meta Daten und Stream Rolle.

==== Titel Meta Daten ====
Die Titel Meta Daten (Normalerweise nur "Meta Daten) sind Informationen über den Aktuellen Titel: Künstler, Titel, Album, Genre, Version, Titelnummer, RPG, und viele mehr.

Diese werden mit der Funktion roar_vs_meta() gesetzt

<nowiki>struct roar_keyval kv[3] = {
{"TITEL", "Test Titel"},
{"ARTIST", "Irgendwer"},
{"VERSION", "Vortrags Remix"}
};
ret = roar_vs_meta(vss, kv, 3 /* Anzahl der Datensätze */, &err);</nowiki>

==== Stream Rolle ====
Die Stream Rolle (engl. "stream role") gibt die Funktion des Streams an: Musik, Video, Ereignisse (z.B. Fehlermeldungs Töne), Spiel, Hintergrund Musik, Telephon,...

Diese wird mit der Funktion roar_vs_role() gesetzt:

<nowiki>ret = roar_vs_role(vss, ROAR_ROLE_MUSIC, &err);</nowiki>

=== Lautstärkesteuerung ===
Zur Lautstärkesteuerung stehen in der VS API drei Funktionen zur Verfügung: roar_vs_volume_mono(), roar_vs_volume_stereo() und roar_vs_volume_get().

Die beiden Ersetzen setzen die Lautstärke, jeweils im Mono oder im Stereo Modus. Das heißt sollte eine Datenstrom eine andere Anzahl von Kanälen haben so rechnen diese Funktionen automatisch um.

Die Lautstärke Skala geht vom 0 bis 1 (inklusive).

Im folgenden Beispiel wird die Lautstärke auf 50% (-6dB) eingestellt:
<nowiki>float c = 0.5; /* 50% */
ret = roar_vs_volume_mono(vss, c, &err);</nowiki>

Im zweiten Beispiel wird der Linke Kanal auf 50% (-6dB) und der Rechte Kanal auf 25% (-12dB) eingestellt:
<nowiki>float l = 0.5, r = 0.25;
ret = roar_vs_volume_stereo(vss, l, r, &err);</nowiki>

Die Lautstärke lässt sich mittels roar_vs_volume_get() wie folgt auslesen:
<nowiki>float l, r;
ret = roar_vs_volume_get(vss, &l, &r, &err);</nowiki>

Sollte die Mono-Lautstärke und nicht die L/R-Lautstärke gewünscht sein:
<nowiki>float c = (l + r)/2.0;</nowiki>

''Zum Stumm schalten sollte die Lautstärke nicht geändert werden sondern das Mute-Flag verwendet werden (Nächste Folie).''

=== Flags ===
Aktuell unterstützt die VS die beiden Flags "Mute" und "Pause".

Das Mute Flag schaltet die Ausgabe des Tons ab, der Stream läuft aber weiterhin. Das Flag Pause hält den Stream an so das er später fortgesetzt werden kann.

Die Flags werden mit den Funktionen roar_vs_pause() und roar_vs_mute() gesetzt:

<nowiki>ret = roar_vs_mute(vss, ROAR_VS_TRUE, &err);</nowiki>
Beziehungsweise:
<nowiki>ret = roar_vs_pause(vss, ROAR_VS_TRUE, &err);</nowiki>

Anstatt ROAR_VS_TRUE (zum setzen) kann natuerlich auch ROAR_VS_FALSE (zum rücksetzen) und ROAR_VS_TOGGLE (zum kippen) verwendet werden.

Mittels ROAR_VS_ASK kann der zustand angefragt werden.

== Optionales ==
=== Non-Blocking ===
...

=== Warten auf Stream Ende ===
...

=== Interface zur Haupt API ===
...

[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio/Vortrag/Programmieren mit RoarAudio VS

2011-04-07T13:55:05Z

Ph3-der-loewe: /* Gepufferter Modus */ +Absichtlicher Stub

<div style="background:#fee846;text-align:left; color: #000;font-weight:bold;font-size:125%;margin: 0px 5px 0px 0; padding: 4px 4px 4px 14px;">Was ist RoarAudio?</div>
<div style="margin: 0 5px 5px 0; padding: 1em 1em 1em 1em; border: 1px solid #fee846; background-color:#fffdf5;">
; Ziel : ein Vortrag über [[RoarAudio]]s VS API vor einem Unixpublikum mit geringem Vorwissen zum Thema. Nach ende des Vortags sollen die Hörer in der Lage sein einfache Programme mit der VS API zu schreiben.
</div>

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Abstrakt ==
Der Vortrag soll eine Einführung in die Programmierung mit der VS API aus libroar liefern. Im laufe des Vortrags werden die grundlegenden API Funktionen vorgestellt und mit Code Beispielen erläutert. Am Ende des Vortrags sollten die Zuhörer in der Lage sein einfache Programme mit der VS API zu schreiben.

Als Vorwissen empfiehlt es sich einen der Einführenden Vorträge besucht zu haben.

== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).
Im Moment studiert er Elektrotechnik/Automatisierungstechnik.

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und Digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

In seiner Freizeit beschäftigt er sich außerdem intensiv mit Großkatzen.

== Vortrag ==
=== Was ist die VS API? ===
Die VS API (von engl. "'''V'''ery '''S'''imple '''API'''") ist eine Schnittstelle auf hoher Ebene welche durch libroar angeboten wird. Sie ist stark an OpenBSD's sndio, aRtsc (KDE 2.x und 3.x) und pulsesimple angelehnt. Sie ist entwikelt worden um neuen Entwicklern und Entwicklern die mit den anderen Systemen zu tun hatten den Umstieg zu erleichtern.

Die VS API bedient nur einen sehr kleinen Bereich von RoarAudios Fähigkeiten. Sie ist auch nur für das Abspielen und Aufnehmen von Streams geeignet und hat keine allgemeinen Steuer Funktionen. Sie kann aber, anders als bei ähnlichen ähnlichen Implementierungen der anderen Sound Systeme, beliebig mit der Haupt API kombiniert werden.

=== Theorie ===
==== Schichten ====
Die VS API ist die im Moment höchste Schicht in libroar. Sie Abstrahiert mehre darunter liegenden Schichten wie die Simple API und VIO/DSTR.

==== OOP ====
Die VS API ist wie fast alles rund um RoarAudio Objekt Orientiert. Sie verwendet primär das so genannte VSS (von engl. "VS State") Objekt das sowohl Steuer-, Daten-, Datei-Verbindung Objekte sowie alle Puffer und Speicher Objekte die intern verwendet werden enthält.

=== Streaming Modus ===
Der Streaming Mode ist der '''native''' Modus. Hier wird das VS Objeckt (VSS) geöffnet und dann mittels Schreibe- und Lese-Befehlen die Audio Daten zum Server geschickt beziehungsweise von dort abgeholt. Ist man Fertig so wird das VS Objekt wieder geschlossen.

Zum öffnen gibt es zwei Funktionen: roar_vs_new_simple() und roar_vs_new_playback(). Letztere ist lediglich ein Aufruf auf die erstere und übergibt beim Richtungs und Subsystem Parameter (engl. "stream direction") den wert ROAR_DIR_PLAY. Da oft nur Wiedergabe gewünscht ist, ist diese Funktion viel zu finden.

Im zweiten Schritt werden Audio Daten gelesen oder geschrieben. Dies geschieht mittels roar_vs_read() beziehungsweise roar_vs_write().

Im letzten Schritt wird das Objekt wieder freigegeben und die Verbindungen geschlossen. Dies gescheit mittels roar_vs_close().

Sollten Meta Daten oder andere Steuerinformationen (Siehe weiter am Ende des Vortrags) gesetzt werden sollten diese vor dem ersten Aufruf von roar_vs_read() beziehungsweise roar_vs_write() gesetzt werden.

Beispiel:
<nowiki>roar_vs_t * vss = roar_vs_new_simple(server, "MyApp", rate, channels, codec, bits, ROAR_DIR_PLAY, &err);

while (alive) { // main loop...
// ...
ret = roar_vs_write(vss, buf, len, &err);
}

ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

In diesem Beispiel wurde ein Stream zum Server ''server'' aufgebaut, Die Audio Parameter finden sich in ''rate'', ''channels'', ''codec'' und ''bits''. Er ist zur Wiedergabe (ROAR_DIR_PLAY).
Die Variablen ''ret'' und ''err' werden im nächsten Kapitel erläutert.

Der Parameter ''server'' kann (und sollte meistens auch) den Wert NULL haben. Dies steht für das verbinden zum Default Server.

Auch ist der Applikationsname (hier: "''MyApp''") angegeben. Dieser sollte einen Sprechenden Namen für das Produkt beinhalten. Normalerweise das was man auf der Packung oder der CD Hülle in großen Lettern erwartet.

Folgendes sollte nicht verwendet werden:
* Versionen (ggf. noch ''major releases''),
* Datei Namen ("myapp.bin", "myapp.exe"),
* Pfad Namen ("/usr/bin/player").

Auf die Audio Parameter soll hier nicht weiter eingegangen werden als diese Grundlagen Wissen sind den Zeitrahmen sprengen würden.

Der Richtungs und Subsystem Parameter hat im oberen Beispiel den Wert ROAR_DIR_PLAY. Andere Werte sind als Beispiel ROAR_DIR_RECORD, ROAR_DIR_MONITOR oder auch ROAR_DIR_MIDI_IN. Genaueres sollte aus passenden Tabellen entnommen werden.

Der zweite Parameter bei der Funktion roar_vs_close() (hier ROAR_VS_FALSE) gibt an ob beim Schließen des Objekts auch auf Server Seite der Stream direkt beendet werden soll (ROAR_VS_TRUE) oder nicht (ROAR_VS_FALSE). Im Falle das er nicht direkt beendet werden soll (Normalfall) wird noch zu Ende gespielt bis alle Puffer leer sind. Dies macht vor allem bei komprimierten Codecs wie Ogg Vorbis (ROAR_CODEC_OGG_VORBIS) einen unterschied der Teilweise im Sekunden Bereich liegt.

=== Fehler Behandlung ===
* Die meisten Aufraufe werfen -1 zurück im Fehlerfall. Ausnahmen sind beispielsweise Funktionen welche einen Pointer zurückgeben. Diese werfen NULL.
* IO Funktionen können "short reads" bzw. "short writes" erzeugen.
* Die Fehlervariable (&err) beinhaltet ''im Fehlerfall'' einen Fehler Code. Dieser kann mittels roar_vs_strerr(err) in eine Zeichenkette gewandelt werden.

<nowiki>int err;
ssize_t ret = roar_vs_write(vss, buf, len, &err);
if ( ret == -1 ) {
fprintf(stderr, "Fehler beim schreiben: %s\n", roar_vs_strerr(err));
} else if ( ret < (ssize_t)len) {
fprintf(stderr, "\"Short write\", nur %zi von %zu Bytes geschieben\n", ret, len);
}</nowiki>

=== Datei Modus ===
Die VS API besitzt einen Datei Modus (engl. "file mode") in dem sie direkt Dateien aber auch Streams abspielen kann. Dazu wird die Verbindung mittels roar_vs_new_from_file() geöffnet. Anschließend wird mittels roar_vs_run() oder roar_vs_iterate() der Datenstrom zum Server geschrieben. Am Schluss wird das Objekt normal mittels roar_vs_close() geschlossen.

Sollten Meta Daten, Lautstärke oder ähnliches gesetzt werden so sollte dies vor dem Aufruf von roar_vs_run() beziehungsweise vor dem ersten Aufruf von roar_vs_iterate() gesehen.

Beispiel:
<nowiki>roar_vs_t * vss = roar_vs_new_from_file(server, "MyApp", filename, &err);
ret = roar_vs_run(vss, &err);
ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

Im obigen Beispiel wird zum Server '''server''' (sollte normalerweise NULL sein) verbunden. Der Klient Name ist "'''MyApp'''". Als Dateiname wird '''filename''' verwendet. Danach wird roar_vs_run() aufgerufen was bis zum Dateiende (EOF) die Datei abspielt. Am ende wird ganz normal mittels roar_vs_close() die Verbindung geschlossen.

Da roar_vs_run() so lange läuft bis es das Dateiende erreicht oder ein Fehler auftritt ist blockt ist es nicht (trivial) möglich im selben Kontext weitere Dinge parallel aus zu führen. Da viele Programme aber ohne hin einen eigenen Thread für die Tonausgabe verwenden ist dies eine geringe Einschränkung. Für alle anderen Felle gibt es roar_vs_iterate() wie das folgende Beispiel zeigt:

<nowiki>roar_vs_t * vss = roar_vs_new_from_file(server, "MyApp", filename, &err);

while (alive) { /* main loop */
// ...
ret = roar_vs_iterate(vss, ROAR_VS_WAIT, &err);
}

ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

=== Gepufferter Modus ===
Viele Applikationen erwarten einen Gepufferten Modus vor zu finden in dem sie einen Ring Puffer mit sehr definiertem zustand vor finden in den sie Arbeiten können. Dieses Vorgehen ist nur mit einem Lokalen Ringpuffer möglich der recht groß ist und viele Nachteile in sich birgt. Aus diesem Grunde wird dieser Modus nicht Empfohlen.

An dieser Stelle soll auch nur Kurz erwähnt sein das dieser Existiert und mit der Funktion roar_vs_buffer() zu steuern ist. Weitere Informationen finden sich in der Dokumentation.

Um nicht weiter zu Verwirren direkt zum Nächsten Kapitel...

=== Meta Daten ===
Derzeit stellt die VS API zwei Meta Daten Schnittstellen zur Verfügung: Titel Meta Daten und Stream Rolle.

==== Titel Meta Daten ====
Die Titel Meta Daten (Normalerweise nur "Meta Daten) sind Informationen über den Aktuellen Titel: Künstler, Titel, Album, Genre, Version, Titelnummer, RPG, und viele mehr.

Diese werden mit der Funktion roar_vs_meta() gesetzt

<nowiki>struct roar_keyval kv[3] = {
{"TITEL", "Test Titel"},
{"ARTIST", "Irgendwer"},
{"VERSION", "Vortrags Remix"}
};
ret = roar_vs_meta(vss, kv, 3 /* Anzahl der Datensätze */, &err);</nowiki>

==== Stream Rolle ====
Die Stream Rolle (engl. "stream role") gibt die Funktion des Streams an: Musik, Video, Ereignisse (z.B. Fehlermeldungs Töne), Spiel, Hintergrund Musik, Telephon,...

Diese wird mit der Funktion roar_vs_role() gesetzt:

<nowiki>ret = roar_vs_role(vss, ROAR_ROLE_MUSIC, &err);</nowiki>

=== Lautstärkesteuerung ===
Zur Lautstärkesteuerung stehen in der VS API drei Funktionen zur Verfügung: roar_vs_volume_mono(), roar_vs_volume_stereo() und roar_vs_volume_get().

Die beiden Ersetzen setzen die Lautstärke, jeweils im Mono oder im Stereo Modus. Das heißt sollte eine Datenstrom eine andere Anzahl von Kanälen haben so rechnen diese Funktionen automatisch um.

Die Lautstärke Skala geht vom 0 bis 1 (inklusive).

Im folgenden Beispiel wird die Lautstärke auf 50% (-6dB) eingestellt:
<nowiki>float c = 0.5; /* 50% */
ret = roar_vs_volume_mono(vss, c, &err);</nowiki>

Im zweiten Beispiel wird der Linke Kanal auf 50% (-6dB) und der Rechte Kanal auf 25% (-12dB) eingestellt:
<nowiki>float l = 0.5, r = 0.25;
ret = roar_vs_volume_stereo(vss, l, r, &err);</nowiki>

Die Lautstärke lässt sich mittels roar_vs_volume_get() wie folgt auslesen:
<nowiki>float l, r;
ret = roar_vs_volume_get(vss, &l, &r, &err);</nowiki>

Sollte die Mono-Lautstärke und nicht die L/R-Lautstärke gewünscht sein:
<nowiki>float c = (l + r)/2.0;</nowiki>

''Zum Stumm schalten sollte die Lautstärke nicht geändert werden sondern das Mute-Flag verwendet werden (Nächste Folie).''

=== Flags ===
Aktuell unterstützt die VS die beiden Flags "Mute" und "Pause".

Das Mute Flag schaltet die Ausgabe des Tons ab, der Stream läuft aber weiterhin. Das Flag Pause hält den Stream an so das er später fortgesetzt werden kann.

Die Flags werden mit den Funktionen roar_vs_pause() und roar_vs_mute() gesetzt:

<nowiki>ret = roar_vs_mute(vss, ROAR_VS_TRUE, &err);</nowiki>
Beziehungsweise:
<nowiki>ret = roar_vs_pause(vss, ROAR_VS_TRUE, &err);</nowiki>

Anstatt ROAR_VS_TRUE (zum setzen) kann natuerlich auch ROAR_VS_FALSE (zum rücksetzen) und ROAR_VS_TOGGLE (zum kippen) verwendet werden.

Mittels ROAR_VS_ASK kann der zustand angefragt werden.

== Optionales ==
=== Interface zur Haupt API ===
...

[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio/Vortrag/Programmieren mit RoarAudio VS

2011-04-07T13:45:39Z

Ph3-der-loewe: /* Was ist die VS API? */

<div style="background:#fee846;text-align:left; color: #000;font-weight:bold;font-size:125%;margin: 0px 5px 0px 0; padding: 4px 4px 4px 14px;">Was ist RoarAudio?</div>
<div style="margin: 0 5px 5px 0; padding: 1em 1em 1em 1em; border: 1px solid #fee846; background-color:#fffdf5;">
; Ziel : ein Vortrag über [[RoarAudio]]s VS API vor einem Unixpublikum mit geringem Vorwissen zum Thema. Nach ende des Vortags sollen die Hörer in der Lage sein einfache Programme mit der VS API zu schreiben.
</div>

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Abstrakt ==
Der Vortrag soll eine Einführung in die Programmierung mit der VS API aus libroar liefern. Im laufe des Vortrags werden die grundlegenden API Funktionen vorgestellt und mit Code Beispielen erläutert. Am Ende des Vortrags sollten die Zuhörer in der Lage sein einfache Programme mit der VS API zu schreiben.

Als Vorwissen empfiehlt es sich einen der Einführenden Vorträge besucht zu haben.

== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).
Im Moment studiert er Elektrotechnik/Automatisierungstechnik.

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und Digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

In seiner Freizeit beschäftigt er sich außerdem intensiv mit Großkatzen.

== Vortrag ==
=== Was ist die VS API? ===
Die VS API (von engl. "'''V'''ery '''S'''imple '''API'''") ist eine Schnittstelle auf hoher Ebene welche durch libroar angeboten wird. Sie ist stark an OpenBSD's sndio, aRtsc (KDE 2.x und 3.x) und pulsesimple angelehnt. Sie ist entwikelt worden um neuen Entwicklern und Entwicklern die mit den anderen Systemen zu tun hatten den Umstieg zu erleichtern.

Die VS API bedient nur einen sehr kleinen Bereich von RoarAudios Fähigkeiten. Sie ist auch nur für das Abspielen und Aufnehmen von Streams geeignet und hat keine allgemeinen Steuer Funktionen. Sie kann aber, anders als bei ähnlichen ähnlichen Implementierungen der anderen Sound Systeme, beliebig mit der Haupt API kombiniert werden.

=== Theorie ===
==== Schichten ====
Die VS API ist die im Moment höchste Schicht in libroar. Sie Abstrahiert mehre darunter liegenden Schichten wie die Simple API und VIO/DSTR.

==== OOP ====
Die VS API ist wie fast alles rund um RoarAudio Objekt Orientiert. Sie verwendet primär das so genannte VSS (von engl. "VS State") Objekt das sowohl Steuer-, Daten-, Datei-Verbindung Objekte sowie alle Puffer und Speicher Objekte die intern verwendet werden enthält.

=== Streaming Modus ===
Der Streaming Mode ist der '''native''' Modus. Hier wird das VS Objeckt (VSS) geöffnet und dann mittels Schreibe- und Lese-Befehlen die Audio Daten zum Server geschickt beziehungsweise von dort abgeholt. Ist man Fertig so wird das VS Objekt wieder geschlossen.

Zum öffnen gibt es zwei Funktionen: roar_vs_new_simple() und roar_vs_new_playback(). Letztere ist lediglich ein Aufruf auf die erstere und übergibt beim Richtungs und Subsystem Parameter (engl. "stream direction") den wert ROAR_DIR_PLAY. Da oft nur Wiedergabe gewünscht ist, ist diese Funktion viel zu finden.

Im zweiten Schritt werden Audio Daten gelesen oder geschrieben. Dies geschieht mittels roar_vs_read() beziehungsweise roar_vs_write().

Im letzten Schritt wird das Objekt wieder freigegeben und die Verbindungen geschlossen. Dies gescheit mittels roar_vs_close().

Sollten Meta Daten oder andere Steuerinformationen (Siehe weiter am Ende des Vortrags) gesetzt werden sollten diese vor dem ersten Aufruf von roar_vs_read() beziehungsweise roar_vs_write() gesetzt werden.

Beispiel:
<nowiki>roar_vs_t * vss = roar_vs_new_simple(server, "MyApp", rate, channels, codec, bits, ROAR_DIR_PLAY, &err);

while (alive) { // main loop...
// ...
ret = roar_vs_write(vss, buf, len, &err);
}

ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

In diesem Beispiel wurde ein Stream zum Server ''server'' aufgebaut, Die Audio Parameter finden sich in ''rate'', ''channels'', ''codec'' und ''bits''. Er ist zur Wiedergabe (ROAR_DIR_PLAY).
Die Variablen ''ret'' und ''err' werden im nächsten Kapitel erläutert.

Der Parameter ''server'' kann (und sollte meistens auch) den Wert NULL haben. Dies steht für das verbinden zum Default Server.

Auch ist der Applikationsname (hier: "''MyApp''") angegeben. Dieser sollte einen Sprechenden Namen für das Produkt beinhalten. Normalerweise das was man auf der Packung oder der CD Hülle in großen Lettern erwartet.

Folgendes sollte nicht verwendet werden:
* Versionen (ggf. noch ''major releases''),
* Datei Namen ("myapp.bin", "myapp.exe"),
* Pfad Namen ("/usr/bin/player").

Auf die Audio Parameter soll hier nicht weiter eingegangen werden als diese Grundlagen Wissen sind den Zeitrahmen sprengen würden.

Der Richtungs und Subsystem Parameter hat im oberen Beispiel den Wert ROAR_DIR_PLAY. Andere Werte sind als Beispiel ROAR_DIR_RECORD, ROAR_DIR_MONITOR oder auch ROAR_DIR_MIDI_IN. Genaueres sollte aus passenden Tabellen entnommen werden.

Der zweite Parameter bei der Funktion roar_vs_close() (hier ROAR_VS_FALSE) gibt an ob beim Schließen des Objekts auch auf Server Seite der Stream direkt beendet werden soll (ROAR_VS_TRUE) oder nicht (ROAR_VS_FALSE). Im Falle das er nicht direkt beendet werden soll (Normalfall) wird noch zu Ende gespielt bis alle Puffer leer sind. Dies macht vor allem bei komprimierten Codecs wie Ogg Vorbis (ROAR_CODEC_OGG_VORBIS) einen unterschied der Teilweise im Sekunden Bereich liegt.

=== Fehler Behandlung ===
* Die meisten Aufraufe werfen -1 zurück im Fehlerfall. Ausnahmen sind beispielsweise Funktionen welche einen Pointer zurückgeben. Diese werfen NULL.
* IO Funktionen können "short reads" bzw. "short writes" erzeugen.
* Die Fehlervariable (&err) beinhaltet ''im Fehlerfall'' einen Fehler Code. Dieser kann mittels roar_vs_strerr(err) in eine Zeichenkette gewandelt werden.

<nowiki>int err;
ssize_t ret = roar_vs_write(vss, buf, len, &err);
if ( ret == -1 ) {
fprintf(stderr, "Fehler beim schreiben: %s\n", roar_vs_strerr(err));
} else if ( ret < (ssize_t)len) {
fprintf(stderr, "\"Short write\", nur %zi von %zu Bytes geschieben\n", ret, len);
}</nowiki>

=== Datei Modus ===
Die VS API besitzt einen Datei Modus (engl. "file mode") in dem sie direkt Dateien aber auch Streams abspielen kann. Dazu wird die Verbindung mittels roar_vs_new_from_file() geöffnet. Anschließend wird mittels roar_vs_run() oder roar_vs_iterate() der Datenstrom zum Server geschrieben. Am Schluss wird das Objekt normal mittels roar_vs_close() geschlossen.

Sollten Meta Daten, Lautstärke oder ähnliches gesetzt werden so sollte dies vor dem Aufruf von roar_vs_run() beziehungsweise vor dem ersten Aufruf von roar_vs_iterate() gesehen.

Beispiel:
<nowiki>roar_vs_t * vss = roar_vs_new_from_file(server, "MyApp", filename, &err);
ret = roar_vs_run(vss, &err);
ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

Im obigen Beispiel wird zum Server '''server''' (sollte normalerweise NULL sein) verbunden. Der Klient Name ist "'''MyApp'''". Als Dateiname wird '''filename''' verwendet. Danach wird roar_vs_run() aufgerufen was bis zum Dateiende (EOF) die Datei abspielt. Am ende wird ganz normal mittels roar_vs_close() die Verbindung geschlossen.

Da roar_vs_run() so lange läuft bis es das Dateiende erreicht oder ein Fehler auftritt ist blockt ist es nicht (trivial) möglich im selben Kontext weitere Dinge parallel aus zu führen. Da viele Programme aber ohne hin einen eigenen Thread für die Tonausgabe verwenden ist dies eine geringe Einschränkung. Für alle anderen Felle gibt es roar_vs_iterate() wie das folgende Beispiel zeigt:

<nowiki>roar_vs_t * vss = roar_vs_new_from_file(server, "MyApp", filename, &err);

while (alive) { /* main loop */
// ...
ret = roar_vs_iterate(vss, ROAR_VS_WAIT, &err);
}

ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

=== Gepufferter Modus ===
...

=== Meta Daten ===
Derzeit stellt die VS API zwei Meta Daten Schnittstellen zur Verfügung: Titel Meta Daten und Stream Rolle.

==== Titel Meta Daten ====
Die Titel Meta Daten (Normalerweise nur "Meta Daten) sind Informationen über den Aktuellen Titel: Künstler, Titel, Album, Genre, Version, Titelnummer, RPG, und viele mehr.

Diese werden mit der Funktion roar_vs_meta() gesetzt

<nowiki>struct roar_keyval kv[3] = {
{"TITEL", "Test Titel"},
{"ARTIST", "Irgendwer"},
{"VERSION", "Vortrags Remix"}
};
ret = roar_vs_meta(vss, kv, 3 /* Anzahl der Datensätze */, &err);</nowiki>

==== Stream Rolle ====
Die Stream Rolle (engl. "stream role") gibt die Funktion des Streams an: Musik, Video, Ereignisse (z.B. Fehlermeldungs Töne), Spiel, Hintergrund Musik, Telephon,...

Diese wird mit der Funktion roar_vs_role() gesetzt:

<nowiki>ret = roar_vs_role(vss, ROAR_ROLE_MUSIC, &err);</nowiki>

=== Lautstärkesteuerung ===
Zur Lautstärkesteuerung stehen in der VS API drei Funktionen zur Verfügung: roar_vs_volume_mono(), roar_vs_volume_stereo() und roar_vs_volume_get().

Die beiden Ersetzen setzen die Lautstärke, jeweils im Mono oder im Stereo Modus. Das heißt sollte eine Datenstrom eine andere Anzahl von Kanälen haben so rechnen diese Funktionen automatisch um.

Die Lautstärke Skala geht vom 0 bis 1 (inklusive).

Im folgenden Beispiel wird die Lautstärke auf 50% (-6dB) eingestellt:
<nowiki>float c = 0.5; /* 50% */
ret = roar_vs_volume_mono(vss, c, &err);</nowiki>

Im zweiten Beispiel wird der Linke Kanal auf 50% (-6dB) und der Rechte Kanal auf 25% (-12dB) eingestellt:
<nowiki>float l = 0.5, r = 0.25;
ret = roar_vs_volume_stereo(vss, l, r, &err);</nowiki>

Die Lautstärke lässt sich mittels roar_vs_volume_get() wie folgt auslesen:
<nowiki>float l, r;
ret = roar_vs_volume_get(vss, &l, &r, &err);</nowiki>

Sollte die Mono-Lautstärke und nicht die L/R-Lautstärke gewünscht sein:
<nowiki>float c = (l + r)/2.0;</nowiki>

''Zum Stumm schalten sollte die Lautstärke nicht geändert werden sondern das Mute-Flag verwendet werden (Nächste Folie).''

=== Flags ===
Aktuell unterstützt die VS die beiden Flags "Mute" und "Pause".

Das Mute Flag schaltet die Ausgabe des Tons ab, der Stream läuft aber weiterhin. Das Flag Pause hält den Stream an so das er später fortgesetzt werden kann.

Die Flags werden mit den Funktionen roar_vs_pause() und roar_vs_mute() gesetzt:

<nowiki>ret = roar_vs_mute(vss, ROAR_VS_TRUE, &err);</nowiki>
Beziehungsweise:
<nowiki>ret = roar_vs_pause(vss, ROAR_VS_TRUE, &err);</nowiki>

Anstatt ROAR_VS_TRUE (zum setzen) kann natuerlich auch ROAR_VS_FALSE (zum rücksetzen) und ROAR_VS_TOGGLE (zum kippen) verwendet werden.

Mittels ROAR_VS_ASK kann der zustand angefragt werden.

== Optionales ==
=== Interface zur Haupt API ===
...

[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio/Vortrag/Programmieren mit RoarAudio VS

2011-04-07T13:37:17Z

Ph3-der-loewe: /* Streaming Modus */ +Inhalt

<div style="background:#fee846;text-align:left; color: #000;font-weight:bold;font-size:125%;margin: 0px 5px 0px 0; padding: 4px 4px 4px 14px;">Was ist RoarAudio?</div>
<div style="margin: 0 5px 5px 0; padding: 1em 1em 1em 1em; border: 1px solid #fee846; background-color:#fffdf5;">
; Ziel : ein Vortrag über [[RoarAudio]]s VS API vor einem Unixpublikum mit geringem Vorwissen zum Thema. Nach ende des Vortags sollen die Hörer in der Lage sein einfache Programme mit der VS API zu schreiben.
</div>

[[Bild:RoarAudio-Logo-0.0.3.png|thumb|right|RoarAudio Logo]]

== Abstrakt ==
Der Vortrag soll eine Einführung in die Programmierung mit der VS API aus libroar liefern. Im laufe des Vortrags werden die grundlegenden API Funktionen vorgestellt und mit Code Beispielen erläutert. Am Ende des Vortrags sollten die Zuhörer in der Lage sein einfache Programme mit der VS API zu schreiben.

Als Vorwissen empfiehlt es sich einen der Einführenden Vorträge besucht zu haben.

== Über den Referent ==
Philipp 'ph3-der-loewe' Schafft schreibt seit etwa 10 Jahren Software (primär in C und Perl).
Im Moment studiert er Elektrotechnik/Automatisierungstechnik.

Besondere Interessen liegen in dem Bereich der Netzwerke und Bus Systeme, Mikrocontrollern, Kryptographie und Digitaler Audio Verarbeitung sowie Entwicklung kreativer Lösungen für Mathematik und Logik Rätseln und Übungen.

In seiner Freizeit beschäftigt er sich außerdem intensiv mit Großkatzen.

== Vortrag ==
=== Was ist die VS API? ===
...

=== Theorie ===
==== Schichten ====
Die VS API ist die im Moment höchste Schicht in libroar. Sie Abstrahiert mehre darunter liegenden Schichten wie die Simple API und VIO/DSTR.

==== OOP ====
Die VS API ist wie fast alles rund um RoarAudio Objekt Orientiert. Sie verwendet primär das so genannte VSS (von engl. "VS State") Objekt das sowohl Steuer-, Daten-, Datei-Verbindung Objekte sowie alle Puffer und Speicher Objekte die intern verwendet werden enthält.

=== Streaming Modus ===
Der Streaming Mode ist der '''native''' Modus. Hier wird das VS Objeckt (VSS) geöffnet und dann mittels Schreibe- und Lese-Befehlen die Audio Daten zum Server geschickt beziehungsweise von dort abgeholt. Ist man Fertig so wird das VS Objekt wieder geschlossen.

Zum öffnen gibt es zwei Funktionen: roar_vs_new_simple() und roar_vs_new_playback(). Letztere ist lediglich ein Aufruf auf die erstere und übergibt beim Richtungs und Subsystem Parameter (engl. "stream direction") den wert ROAR_DIR_PLAY. Da oft nur Wiedergabe gewünscht ist, ist diese Funktion viel zu finden.

Im zweiten Schritt werden Audio Daten gelesen oder geschrieben. Dies geschieht mittels roar_vs_read() beziehungsweise roar_vs_write().

Im letzten Schritt wird das Objekt wieder freigegeben und die Verbindungen geschlossen. Dies gescheit mittels roar_vs_close().

Sollten Meta Daten oder andere Steuerinformationen (Siehe weiter am Ende des Vortrags) gesetzt werden sollten diese vor dem ersten Aufruf von roar_vs_read() beziehungsweise roar_vs_write() gesetzt werden.

Beispiel:
<nowiki>roar_vs_t * vss = roar_vs_new_simple(server, "MyApp", rate, channels, codec, bits, ROAR_DIR_PLAY, &err);

while (alive) { // main loop...
// ...
ret = roar_vs_write(vss, buf, len, &err);
}

ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

In diesem Beispiel wurde ein Stream zum Server ''server'' aufgebaut, Die Audio Parameter finden sich in ''rate'', ''channels'', ''codec'' und ''bits''. Er ist zur Wiedergabe (ROAR_DIR_PLAY).
Die Variablen ''ret'' und ''err' werden im nächsten Kapitel erläutert.

Der Parameter ''server'' kann (und sollte meistens auch) den Wert NULL haben. Dies steht für das verbinden zum Default Server.

Auch ist der Applikationsname (hier: "''MyApp''") angegeben. Dieser sollte einen Sprechenden Namen für das Produkt beinhalten. Normalerweise das was man auf der Packung oder der CD Hülle in großen Lettern erwartet.

Folgendes sollte nicht verwendet werden:
* Versionen (ggf. noch ''major releases''),
* Datei Namen ("myapp.bin", "myapp.exe"),
* Pfad Namen ("/usr/bin/player").

Auf die Audio Parameter soll hier nicht weiter eingegangen werden als diese Grundlagen Wissen sind den Zeitrahmen sprengen würden.

Der Richtungs und Subsystem Parameter hat im oberen Beispiel den Wert ROAR_DIR_PLAY. Andere Werte sind als Beispiel ROAR_DIR_RECORD, ROAR_DIR_MONITOR oder auch ROAR_DIR_MIDI_IN. Genaueres sollte aus passenden Tabellen entnommen werden.

Der zweite Parameter bei der Funktion roar_vs_close() (hier ROAR_VS_FALSE) gibt an ob beim Schließen des Objekts auch auf Server Seite der Stream direkt beendet werden soll (ROAR_VS_TRUE) oder nicht (ROAR_VS_FALSE). Im Falle das er nicht direkt beendet werden soll (Normalfall) wird noch zu Ende gespielt bis alle Puffer leer sind. Dies macht vor allem bei komprimierten Codecs wie Ogg Vorbis (ROAR_CODEC_OGG_VORBIS) einen unterschied der Teilweise im Sekunden Bereich liegt.

=== Fehler Behandlung ===
* Die meisten Aufraufe werfen -1 zurück im Fehlerfall. Ausnahmen sind beispielsweise Funktionen welche einen Pointer zurückgeben. Diese werfen NULL.
* IO Funktionen können "short reads" bzw. "short writes" erzeugen.
* Die Fehlervariable (&err) beinhaltet ''im Fehlerfall'' einen Fehler Code. Dieser kann mittels roar_vs_strerr(err) in eine Zeichenkette gewandelt werden.

<nowiki>int err;
ssize_t ret = roar_vs_write(vss, buf, len, &err);
if ( ret == -1 ) {
fprintf(stderr, "Fehler beim schreiben: %s\n", roar_vs_strerr(err));
} else if ( ret < (ssize_t)len) {
fprintf(stderr, "\"Short write\", nur %zi von %zu Bytes geschieben\n", ret, len);
}</nowiki>

=== Datei Modus ===
Die VS API besitzt einen Datei Modus (engl. "file mode") in dem sie direkt Dateien aber auch Streams abspielen kann. Dazu wird die Verbindung mittels roar_vs_new_from_file() geöffnet. Anschließend wird mittels roar_vs_run() oder roar_vs_iterate() der Datenstrom zum Server geschrieben. Am Schluss wird das Objekt normal mittels roar_vs_close() geschlossen.

Sollten Meta Daten, Lautstärke oder ähnliches gesetzt werden so sollte dies vor dem Aufruf von roar_vs_run() beziehungsweise vor dem ersten Aufruf von roar_vs_iterate() gesehen.

Beispiel:
<nowiki>roar_vs_t * vss = roar_vs_new_from_file(server, "MyApp", filename, &err);
ret = roar_vs_run(vss, &err);
ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

Im obigen Beispiel wird zum Server '''server''' (sollte normalerweise NULL sein) verbunden. Der Klient Name ist "'''MyApp'''". Als Dateiname wird '''filename''' verwendet. Danach wird roar_vs_run() aufgerufen was bis zum Dateiende (EOF) die Datei abspielt. Am ende wird ganz normal mittels roar_vs_close() die Verbindung geschlossen.

Da roar_vs_run() so lange läuft bis es das Dateiende erreicht oder ein Fehler auftritt ist blockt ist es nicht (trivial) möglich im selben Kontext weitere Dinge parallel aus zu führen. Da viele Programme aber ohne hin einen eigenen Thread für die Tonausgabe verwenden ist dies eine geringe Einschränkung. Für alle anderen Felle gibt es roar_vs_iterate() wie das folgende Beispiel zeigt:

<nowiki>roar_vs_t * vss = roar_vs_new_from_file(server, "MyApp", filename, &err);

while (alive) { /* main loop */
// ...
ret = roar_vs_iterate(vss, ROAR_VS_WAIT, &err);
}

ret = roar_vs_close(vss, ROAR_VS_FALSE, &err);</nowiki>

=== Gepufferter Modus ===
...

=== Meta Daten ===
Derzeit stellt die VS API zwei Meta Daten Schnittstellen zur Verfügung: Titel Meta Daten und Stream Rolle.

==== Titel Meta Daten ====
Die Titel Meta Daten (Normalerweise nur "Meta Daten) sind Informationen über den Aktuellen Titel: Künstler, Titel, Album, Genre, Version, Titelnummer, RPG, und viele mehr.

Diese werden mit der Funktion roar_vs_meta() gesetzt

<nowiki>struct roar_keyval kv[3] = {
{"TITEL", "Test Titel"},
{"ARTIST", "Irgendwer"},
{"VERSION", "Vortrags Remix"}
};
ret = roar_vs_meta(vss, kv, 3 /* Anzahl der Datensätze */, &err);</nowiki>

==== Stream Rolle ====
Die Stream Rolle (engl. "stream role") gibt die Funktion des Streams an: Musik, Video, Ereignisse (z.B. Fehlermeldungs Töne), Spiel, Hintergrund Musik, Telephon,...

Diese wird mit der Funktion roar_vs_role() gesetzt:

<nowiki>ret = roar_vs_role(vss, ROAR_ROLE_MUSIC, &err);</nowiki>

=== Lautstärkesteuerung ===
Zur Lautstärkesteuerung stehen in der VS API drei Funktionen zur Verfügung: roar_vs_volume_mono(), roar_vs_volume_stereo() und roar_vs_volume_get().

Die beiden Ersetzen setzen die Lautstärke, jeweils im Mono oder im Stereo Modus. Das heißt sollte eine Datenstrom eine andere Anzahl von Kanälen haben so rechnen diese Funktionen automatisch um.

Die Lautstärke Skala geht vom 0 bis 1 (inklusive).

Im folgenden Beispiel wird die Lautstärke auf 50% (-6dB) eingestellt:
<nowiki>float c = 0.5; /* 50% */
ret = roar_vs_volume_mono(vss, c, &err);</nowiki>

Im zweiten Beispiel wird der Linke Kanal auf 50% (-6dB) und der Rechte Kanal auf 25% (-12dB) eingestellt:
<nowiki>float l = 0.5, r = 0.25;
ret = roar_vs_volume_stereo(vss, l, r, &err);</nowiki>

Die Lautstärke lässt sich mittels roar_vs_volume_get() wie folgt auslesen:
<nowiki>float l, r;
ret = roar_vs_volume_get(vss, &l, &r, &err);</nowiki>

Sollte die Mono-Lautstärke und nicht die L/R-Lautstärke gewünscht sein:
<nowiki>float c = (l + r)/2.0;</nowiki>

''Zum Stumm schalten sollte die Lautstärke nicht geändert werden sondern das Mute-Flag verwendet werden (Nächste Folie).''

=== Flags ===
Aktuell unterstützt die VS die beiden Flags "Mute" und "Pause".

Das Mute Flag schaltet die Ausgabe des Tons ab, der Stream läuft aber weiterhin. Das Flag Pause hält den Stream an so das er später fortgesetzt werden kann.

Die Flags werden mit den Funktionen roar_vs_pause() und roar_vs_mute() gesetzt:

<nowiki>ret = roar_vs_mute(vss, ROAR_VS_TRUE, &err);</nowiki>
Beziehungsweise:
<nowiki>ret = roar_vs_pause(vss, ROAR_VS_TRUE, &err);</nowiki>

Anstatt ROAR_VS_TRUE (zum setzen) kann natuerlich auch ROAR_VS_FALSE (zum rücksetzen) und ROAR_VS_TOGGLE (zum kippen) verwendet werden.

Mittels ROAR_VS_ASK kann der zustand angefragt werden.

== Optionales ==
=== Interface zur Haupt API ===
...

[[Kategorie:RoarAudio]]
[[Kategorie:Vortrag]]
[[Kategorie:Software]]
[[Kategorie:Sound]]

RoarAudio/Vortrag/Programmieren mit RoarAudio VS

2011-04-07T11:32:26Z

Ph3-der-loewe: /* Vortrag */ + /* Was ist die VS API? */

RoarAudio/Vortrag/Programmieren mit RoarAudio VS

2011-04-07T11:28:17Z

Ph3-der-loewe: /* Schichten */ bissel text

RoarAudio/Vortrag/Programmieren mit RoarAudio VS

2011-04-07T11:11:18Z

Ph3-der-loewe: /* OOP */ bissel text

RoarAudio/Vortrag/Programmieren mit RoarAudio VS

2011-04-07T11:01:25Z

Ph3-der-loewe: /* Datei Modus */ +Inhalt

RoarAudio/Vortrag/Programmieren mit RoarAudio VS

2011-04-07T10:27:57Z

Ph3-der-loewe: /* Lautstärkesteuerung */ +Inhalt

RoarAudio/Vortrag/Programmieren mit RoarAudio VS

2011-04-07T10:16:14Z

Ph3-der-loewe: /* Flags */ + Inhalt