aboutsummaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..feb4643
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,38 @@
+stream - external library for streaming
+
+Momentan ein Object amp~ zur Wiedergabe von ogg-Streams.
+
+Die Idee stammt von readanysf~ (August Black), wurde aber völlig neu implementiert.
+Ein paar unwichtige Code-Schnippsel sind noch drin, werden aber auch neu geschrieben.
+
+
+Features (im Vergleich pdogg and readanysf~):
+- Mehrkanalfähigkeit
+- Genau dosierbare Pufferung
+- nur ein thread für Datenempfang und Decodierung
+- Stream-Resampling, wenn nötig
+
+
+Abhängigkeiten:
+- OGG und Vorbis
+- libsamplerate
+
+Bedienung:
+[amp~ n] erzeugt ein Objekt mit n Signal-Outlets. Der Stream kann eine andere Kanalzahl haben.
+Überzählige Stream-Kanäle werden ignoriert, überzählige Outlets haben 0~-Signale.
+
+Messages:
+[connect URI( ... Verbinde zu Server:Port/Mountpoint und starte Wiedergabe
+[disconnect( .... Stoppe Wiedergabe
+[strbuf samples ( ... Stream-Buffer-Größe in Samples (default 10000)
+[strchunk samples ( ... Samples die auf einmal vom Socket gelesen werden (default 500)
+[strthresh ratio ( ... Threshold 0...1 unter welchem Anteil der Buffer-Füllung nachgeladen wird. (default 0.95)
+
+[debug 0/1 ( .... Debug-Output zur Konsole
+
+
+Probleme:
+resampling funktioniert nicht einwandfrei
+
+LICENCE: GPL
+ see LICENCE.txt