move IT Home Base

Installation FreeSwitch

anonymous@undisclosed.example.com (Anonymous) — Fri, 29 Nov 2019 10:58:48 +0000

Installation FreeSwitch

Mit FreeSwitch können Sie die Voice-Funktion in OpenSIM nutzen um sich nicht nur über die Tastatur im Chat mit anderen Avataren zu unterhalten, sondern auch über ein Mikrofon mit Ihrer Stimme.

Erste Informationen zu FreeSwitch erhalten Sie auf der offiziellen Webseite: http://www.freeswitch.org

Linux Installation: Suse 32/64-bit

Installation und Konfiguration von Freeswitch für OpenSim unter Linux

Wichtige Links:

FreeSwitch ist eine Kommunikationsplattform die unter MLP 1.1 lizensiert ist. Der Vorteil ist der modulare Aufbau und die SIP-Funktionalität die wir hier nutzen um Voice (Sprachkommunikation) in OpenSim zu integrieren. Die native Unterstützung der gängigen Viewer ist dabei das Schmankerl. Auf die Kompilierung von FreeSwitch werde ich hier nicht näher eingehen da sie ausreichend auf der FreeSwitch Website erläutert wird. Es gibt auch je nach Distribution fertig kompilierte Pakete die sich einfacher installieren lassen. Bitte vorher alle Abhängigkeiten überprüfen damit ein reibungsloses kompilieren möglich ist. Beim installieren von FreeSwitch ist dringend auf folgende Einstellungen zu achten damit es erfolgreich funktioniert:

Herunterladen von Freeswitch

Ich empfehle die svn in folgendes Verzeichnis zu laden:

/opt/scr/

der Ordner scr muss noch angelegt werden da er meistens nicht vorhanden ist.

md scr

dann FreeSwitch herunterladen:

svn checkout http://svn.freeswitch.org/svn/freeswitch/trunk freeswitch

Der Quellcode befindet sich dann in:

/opt/scr/freeswitch

nach der Installation (make install) in:

/opt/freeswitch

Wichtige Schritte

Da FreeSwitch modular aufgebaut ist sind in der Grundkonfiguration nicht alle Module aktiviert. Manche werden auch erst nach der Aktivierung kompiliert. Für den reibungslosen Ablauf brauchen wir zwei dieser Module die nicht automatisch kompiliert werden:

codecs/mod_siren ←– siren 14 Codec (sozusagen die Sprachkomprimierung) xml_int/mod_xml_curl ←– Ein Modul um automatische Konfiguration von FreeSwitch über XML zu ermöglichen.

Nach dem Herunterladen von FreeSwitch und der Vorbereitung der Kompilierung:

./bootstrap.sh ./configure –prefix=/usr/local/freeswitch ←– entspricht dem Pfad der späteren Installierung

muss man diese Module in:

../freeswitch/conf/autoload_configs/modules.conf.xml

aktivieren indem man die „#“ vor den entsprechenden Modulen entfernt.

Danach kann man den Quellcode mit

make make install make sounds-install make moh-install make samples

kompilieren und installieren. Hat das alles soweit erfolgreich funktioniert müssen noch 3 Konfigurationsdateien angepasst werden:

../freeswitch/conf/autoload_configs/modules.conf.xml

Hier müssen die beiden Module die wir gerade kompiliert haben aktiviert werden. Dazu entfernt man einfach die Auskommentierung.

Vorher: <!– „<load module=„mod_xml_curl“/>–> <!– <load module=„mod_siren“/>/>–>

Nachher: <load module=„mod_xml_curl“/> <load module=„mod_siren“/>

Dann müssen wir noch den Codec aktivieren. Dazu müssen wir folgende XML editieren:

../ freeswitch/conf/vars.xml

In dieser XML gibt es eine Zeile

Vorher: <X-PRE-PROCESS cmd=„set“ data=„global_codec_prefs= G722,PCMU,PCMA,GSM“/> dieser fügt bitte folgendes hinzu G7221@32000h,G722

Nachher: <X-PRE-PROCESS cmd=„set“ data=„global_codec_prefs=G7221@32000h,G722,PCMU,PCMA,GSM“/>

Dann nur noch die Anbindung an OpenSim. Dazu editieren wir die XML:

../ freeswitch/conf/autoload_configs/xml_curl.conf.xml

Bitte ersetzt folgendes mit dem kompletten Inhalt und achtet darauf das Ihr die IP Eures OpenSim-Servers an den dafür vorgesehenen Platz einfügt.

Der Port 9000 ist natürlich auch an Eure Sim anzupassen falls dieser vom Standard abweicht. Danach könnt Ihr FreeSwitch starten.

../freeswitch/bin/./freeswitch

Der Freeswitch-Service sollte immer vor dem OpenSim-Service gestartet sein.

OpenSim Konfiguration

Hier müssen wir nur in der OpenSim.ini folgendes ergänzen:

[FreeSwitchVoice] enabled = true ;FreeSwitch server is going to contact us and ask us all ;sorts of things. freeswitch_server_user = freeswitch freeswitch_server_pass = password freeswitch_api_prefix = /api ;The IP address of your opensim voice region freeswitch_service_server = IP_Adresse_des_OpenSimServers ;the port your region is running on freeswitch_service_port = 9000 ;your freewitch IP address freeswitch_realm = IP_Adresse_des_FreeSwitch_Services freeswitch_sip_proxy = IP_Adresse_des_FreeSwitch_Services:5060 freeswitch_attempt_stun = false freeswitch_stun_server = IP_Adresse_des_FreeSwitch_Services freeswitch_echo_server = IP_Adresse_des_FreeSwitch_Services freeswitch_echo_port = 50505 freeswitch_well_known_ip = IP_Adresse_des_FreeSwitch_Services freeswitch_default_timeout = 5000 freeswitch_subscribe_retry = 120

Achtet auch hier bitte auf den Port Eurer Sim ! Danach einfach den OpenSim-Server starten.

WICHTIG

Der Freeswitch-Service ist nur in den aktuellsten Versionen von OpenSim möglich. Achtet darauf das beim starten von OpenSim im CLI ein [FreeSwitchVoice] Eintrag zu sehen ist. Dann nur noch InWorld auf der Region bei den Landeinstellungen Voice aktivieren und dann solltet Ihr diesen putzigen Punkt über dem Kopf sehen und wenn Ihr alleine auf der Region seit eine Warteschleifenmusik hören. Zum testen empfand ich diese als sehr hilfreich. Diese kann man folgendermassen ausschalten:

../ freeswitch/conf/autoload_configs/conference.conf.xml

einfach die Sounds auskommentieren:

[…] <!– File to play if you are alone in the conference –> <!– <param name=„alone-sound“ value=„conference/conf-alone.wav“/> –> […] <!– File to play when you're alone (music on hold)–> <!– <param name=„moh-sound“ value=„$${hold_music}“/> –> <!– File to play when you join the conference –> <!– <param name=„enter-sound“ value=„tone_stream:%(200,0,500,600,700)“/> [^] –> <!– File to play when you leave the conference –> <!– <param name=„exit-sound“ value=„tone_stream:%(500,0,300,200,100,50,25)“/> [^] –> <!– File to play when you ae ejected from the conference –> <!– <param name=„kicked-sound“ value=„conference/conf-kicked.wav“/> –> […]

Natürlich auch an die Firewall denken um die von FreeSwitch benötigten Ports zu öffnen:

Port(s)	Protokoll	Bezeichnung
1719	UDP	H.323 Gatekeeper RAS-Port
1720	TCP	H.323 Call Signalling
3478	UDP	STUN Service, für NAT traversal
3479	UDP	STUN Service, für NAT traversal
5002	TCP	MLP Protocol Server
5003	UDP	Neighborhood Service
5060	UDP & TCP	SIP UAS, für SIP Signalisierung (Standard SIP-Port, für default intern Profil)
5070	UDP & TCP	SIP UAS, für SIP Signalisierung (für default „NAT“ Profil)
5080	UDP & TCP	SIP UAS, für SIP Signalisierung (für default „External“ Profil)
16384-32768	UDP	RTP/RTCP Multimedia Streaming, für Audio/Video Daten in SIP und anderen Protokollen

Linux Installation: Ubuntu 32-bit

1. Vorbereitung

apt-get update

apt-get install -y autoconf automake libtool build-essential subversion libxml2 apt-get install -y libxml2-dev libtiff4 libtiff4-dev php5 php5-cli apt-get install -y php5-common php5-mcrypt php5-mysql php5-gd php5-pgsql php-pear php-db apt-get install -y libmysqlclient15-dev curl sox libssl-dev libncurses5-dev bison apt-get install -y libaudiofile-dev libnewt-dev libcurl4-gnutls-dev apt-get install -y libnet-ssleay-perl openssl ssl-cert libauthen-pam-perl apt-get install -y libio-pty-perl libmd5-perl apt-get install -y libpg-perl libdbd-pg-perl sqlite3 apt-get install -y libsqlite3-dev openssl ssl-cert apt-get install -y libapache2-mod-php5 libmcrypt-dev

mkdir /home/opensim/freeswitch cd /home/opensim/freeswitch

2. FreeSwitch Installation

svn checkout http://svn.freeswitch.org/svn/freeswitch/trunk freeswitch

cd freeswitch cd build cp modules.conf.in modules.conf

vi modules.conf

Suchen Sie die Zeile:

#codecs/mod_siren

und entfernen Sie das # Zeichen.

Suchen Sie die Zeile:

#xml_int/mod_xml_curl

und entfernen Sie das # Zeichen.

Speichern Sie die Datei.

cd .. AUTOCONF=/usr/bin/autoconf ./bootstrap.sh

Warten Sie bis die Operationen abgeschlossen sind, dann weiter mit:

./configure –prefix=/usr/local/freeswitch

Warten Sie wieder bis alles abgeschlossen ist, dann weiter mit:

make

Warten Sie wiederrum bis alles abgeschlossen ist, dann weiter mit:

make install make mod_siren-install

make mod_xml_curl-install make sounds-install

make sounds-install

make moh-install make moh-install

Bitte beachten Sie das die obige Wiederholung des Kommandos kein Fehler ist ! Dann weiter mit:

make samples

3. FreeSwitch Konfiguration für OpenSIM

Wir nehmen bei der folgenden Konfiguration folgendes an. Bei Abweichungen auf Ihrem Computer und Netzwerk müssen Sie entsprechend anders konfigurieren. Dies ist quasi nur ein Beispiel von vielen möglichen Konfigurationen:

der Server ist direkt an das Internet angeschlossen und verfügt über die öffentliche IP-Adresse 192.111.222.33
es gibt keine Firewall die den ein- und ausgehenden Datenfluss irgendwie einschränkt
OpenSIM läuft auf dem TCP-Port 9000 und ist auf demselben Computer installiert wie FreeSwitch

Geben Sie nun folgendes ein:

cd /usr/local/freeswitch/conf/autoload_configs/

vi modules.conf.xml

Suchen Sie die Zeile:

<!– <load module=„mod_xml_curl“/> –>

und ändern Sie diese in:

Suchen Sie die Zeile:

<!–<load module=„mod_siren“/>–>

und ändern Sie diese in:

Speichern Sie die Datei. Weiter mit:

cd /usr/local/freeswitch/conf/autoload_configs

vi xml_curl.conf.xml

Gehen Sie eine Zeile unter diese:

und tauschen die dort noch vorhandene Beispiel-Konfiguration mit Ihrer Konfiguration:

Tauschen Sie die oben verwendete Beispiel IP-Adresse 192.111.222.33 mit Ihrer eigenen öffentlichen IP-Adresse aus. Falls Sie einen anderen Port als den Standard-Port 9000 verwenden, passen Sie auch diesen an den bei Ihnen verwendeten Port an.

Speichern Sie die Datei. Weiter geht es mit:

cd /usr/local/freeswitch/conf/

vi vars.xml

Suchen Sie die Zeile:

<X-PRE-PROCESS cmd=„set“ data=„global_codec_prefs=G722,PCMU,PCMA,GSM“/>

und ändern Sie diese in:

<X-PRE-PROCESS cmd=„set“ data=„global_codec_prefs=G7221@32000h,G722,PCMU,PCMA,GSM“/>

4. Starten von FreeSwitch

screen -S voice

cd /usr/local/freeswitch/bin/ ./freeswitch

Ignorieren Sie die rot markierten Fehlermeldungen und Warnungen. Weiter mit:

[CTRL][A][D]

5. OpenSIM-Konfiguration

Editieren Sie die OpenSIM-Konfigurationsdatei und fügen Sie am Ende der Datei folgende Zeilen ein:

[FreeSwitchVoice]
   enabled = true
   ;FreeSwitch server is going to contact us and ask us all
   ;sorts of things.
   freeswitch_server_user = freeswitch
   freeswitch_server_pass = password
   freeswitch_api_prefix = /api
   ;The  IP address of your opensim voice region
   freeswitch_service_server = IP_Adresse_des_OpenSimServers
   ;the port your region is running on
   freeswitch_service_port = 9000 
   ;your freewitch IP address
   freeswitch_realm = IP_Adresse_des_FreeSwitch_Services
   freeswitch_sip_proxy = IP_Adresse_des_FreeSwitch_Services:5060
   freeswitch_attempt_stun = false
   freeswitch_stun_server = IP_Adresse_des_FreeSwitch_Services
   freeswitch_echo_server = IP_Adresse_des_FreeSwitch_Services
   freeswitch_echo_port = 50505
   freeswitch_well_known_ip = IP_Adresse_des_FreeSwitch_Services
   freeswitch_default_timeout = 5000
   freeswitch_subscribe_retry = 120

Starten Sie jetzt den OpenSIM-Server. Ab diesem Moment ist Voice in OpenSIM grundsätzlich möglich. Um aber Voice nutzen zu können muß in den Estate-Einstellungen und den Region-Einstellungen auch Voice aktiviert werden. Ausserdem müssen die Avatare einen 3D-Viewer ab Version 1.22 oder später benutzen.

Sollte es dennoch nicht funktionieren haben Sie möglicherweise eine zu alte OpenSIM-Server Version. Voice wird derzeit nur in sehr aktuellen Trunk-Versionen unterstützt.

Natürlich auch an die Firewall denken um die von FreeSwitch benötigten Ports zu öffnen:

Port(s)	Protokoll	Bezeichnung
1719	UDP	H.323 Gatekeeper RAS-Port
1720	TCP	H.323 Call Signalling
3478	UDP	STUN Service, für NAT traversal
3479	UDP	STUN Service, für NAT traversal
5002	TCP	MLP Protocol Server
5003	UDP	Neighborhood Service
5060	UDP & TCP	SIP UAS, für SIP Signalisierung (Standard SIP-Port, für default intern Profil)
5070	UDP & TCP	SIP UAS, für SIP Signalisierung (für default „NAT“ Profil)
5080	UDP & TCP	SIP UAS, für SIP Signalisierung (für default „External“ Profil)
16384-32768	UDP	RTP/RTCP Multimedia Streaming, für Audio/Video Daten in SIP und anderen Protokollen

Performance

anonymous@undisclosed.example.com (Anonymous) — Fri, 29 Nov 2019 10:58:50 +0000

Performance

Hardwareseitige Performance-Beeinflussungen

Um die Geschwindigkeit des OpenSIM-Servers zu erhöhen sind folgende Punkte mit am wichtigsten:

Viel Arbeitsspeicher (RAM)

Optimal ist DDR2-RAM ab 2 GB, mehr ist auch nicht verkehrt. OpenSIM verbraucht im laufenden Betrieb locker hundert und mehr Megabyte RAM (je nach Konfiguration von OpenSIM), daher ist viel RAM eines der wichtigsten Punkte. Als absoluter Mindestwert kann man kurzzeitig 512 MB RAM verwenden, wesentlich besser läuft es bereits mit 1 GB, optimal ab 2 GB RAM. Es hängt allerdings auch davon ab welches Betriebssystem man einsetzt, denn nicht jedes Betriebssystem verbraucht gleichviel RAM. Da die RAM-Preise momentan sehr niedrig liegen sollte man mit RAM nicht geizen und reinpacken was an freien Slots vorhanden ist.

Schneller Prozessor (CPU)

Am besten leistungsstarke Dual-Core oder Quad-Core Prozessoren ab 2 GHz Taktfrequenz pro Prozessorkern. Die Geschwindigkeit der CPU ist für OpenSIM sehr entscheidend. Als absoluter Mindestwert kann man kurzzeitig eine CPU mit 1 GHz einsetzen, die dann aber im Betrieb möglicherweise extrem ausgelastet sein wird und OpenSIM träge macht. Wesentlich besser sieht es mit doppelt soviel CPU-Power aus. Leistungsstarke Quad-Core Prozessoren wie man Sie in richtigen Servern findet sind für OpenSIM der Idealfall. Allerdings geht das ziemlich auf die Stromrechnung Nicht empfehlenswert sind abgespeckte, leistungsschwache CPU´s wie sie in manchen Notebooks oder billigen PC´s verbaut werden und die auf Stromsparen optimiert worden sind und nicht auf Geschwindigkeit.

Schnelle Festplatte

SCSI-Festplatten mit RAID-5 (ab 3 Stück) haben mehr Datendurchsatz als eine Single-IDE oder SATA-Festplatte. Dazu kommt noch daß viele Consumer-Festplatten die in den PC stecken nicht für den Dauerbetrieb ausgelegt sind. Moderne PC haben aber normalerweise ausreichend Festplatten-Datendurchsatz, sodaß dieser Punkt nicht allzu kritisch ist. Planen Sie bei der Festplattengrösse nicht zu knapp. Wenn OpenSIM auf der selben Festplatten-Partition wie das Betriebssystem installiert ist nehmen Sie mindestens 100 GB, mehr sind nie verkehrt. Wenn Sie den Datendurchsatz steigern möchten, dann installieren Sie die Datenbank von OpenSIM auf einer separaten Festplatte mit eigener Partition, damit gleichzeitig ablaufende Festplattenzugriffe durch das Betriebssystem nicht störende Auswirkungen haben.

Und wo wir schon beim Thema Festplatte sind: regelmäßig Datensicherungen (Backups) machen nicht vergessen ! Totalverlust aller Daten ist immer sehr ärgerlich und lässt sich nur durch konsequentes Datensichern auf externen Medien verhindern. Merke: auch Festplatten können mal kaputtgehen und insbesonders ständig laufende Festplatten wie beim Serverbetrieb mit der OpenSIM-Software, die aber nicht für den Dauerbetrieb ausgelegt sind, verabschieden sich häufig mit einem sehr nachhaltigen Erlebnis.

Wir zählen mittlerweile ganze Stapel von defekten, externen USB-Festplatten die erstens in den Metallgehäusen viel zu schlecht gekühlt waren (wenn man eine Passivkühlung durch das Ableiten der Wärme überhaupt als richtige Kühlung ansehen darf), zweitens oft miserabel konstruierte Controller enthielten die gerne schnell defekt gehen und drittens sich gerne mal nach ein paar Wochen Dauerbetrieb mit einem lauten „Klack“ (Headcrash) für immer verabschiedet haben. Wenn da dann wichtige Datensicherungen drauf waren …

Schnelle Datenbank

Eine mySQL-Datenbank ist SQLite zu bevorzugen. Die Performance der verwendeten Datenbank ist aber erst mit steigender Anzahl der Avatare kritisch, da viele gleichzeitige Operationen ausgeführt werden müssen und eine SQLite-Datenbank damit auch mal gerne überfordert sein kann. Für viele gleichzeitige Datenbankzugriffe ist die kostenlose mySQL-Datenbank am besten geeignet. Wer sich mit mySQL gut auskennt und mehr als die Standard-Konfiguration haben möchte, verwendet die im WWW sehr zahlreich zu lesenden Tricks um aus einer mySQL-Datenbank das maximale Potential herauszuholen. Viele Einstellungen lassen sich sehr einfach in der mySQL-Konfigurationsdatei vornehmen.

Schnelle Internetanbindung

Je mehr Avatare sich auf der eigenen Sim einloggen möchten, umso mehr Internetbandbreite wird benötigt. Kleine Gruppen lassen sich möglicherweise noch auf dem heimischen PC verwalten. Bei grösseren Gruppen wird es nötig werden entweder seinen Server bei einem grossen Hoster mit grosser Internetanbindung unterzustellen, oder einen Root-Server bei einem Hoster zu mieten (Preise ab ca. 80 Euro/Monat). Wer OpenSIM bei sich zuhause betreiben möchte, sollte einen Upstream von mindestens 1 MBit haben, also etwa ADSL mit 16.000 kBit/sec. aufwärts. Je höher der Upstream, desto besser. Ideal und vom Kosten-/Nutzen-Verhältnis am sinnvollsten ist derzeit VDSL mit 50 MBit Downstream und 10 MBit Upstream.

Grafikkarte

Die verwendete Grafikkarte im OpenSIM-Server ist hingegen völlig nebensächlich wenn dieser Computer nur als Server dient und nicht gleichzeitig auf diesem auch noch ein 3D-Viewer zum einloggen ausgeführt wird. Da wir davon ausgehen daß Sie nur einen Server betreiben, gehen wir auf den Punkt Grafikkarte nicht weiter ein.

Softwareseitige Performance-Beeinflussungen

Softwareseitig sind extrem viele, unterschiedliche OpenSIM-Werte an der vom Avatar „gefühlten“ Geschwindigkeit der Sim beteiligt. Hauptsächlich sind dies die Menge der auf einer Sim gleichzeitig eingeloggten Avatare, die auf einer Sim laufenden Scripts und physische Prims, neben einer ganzen Reihe anderer Faktoren.

Performance-Messung Inworld OpenSIM

Mit der Tastenfolge STRG-SHIFT-1 die Statusanzeige einschalten.

Time Dilation: sollte möglichst bei 1.0 liegen (Echtzeitbetrieb). Je niedriger der Wert umso zeitversetzter läuft alles ab. Ab einem Wert von 0.7 wird es extrem träge.

Sim FPS: FPS = Frames per Second (Bilder pro Sekunde). Maximal 45 sind möglich, 30 ist gut, unter 20 ruckelt es heftigst.

Time: sagt genau warum die beiden Werte oben evtl. schlecht sind. Eine Sim erreicht maximal 45 FPS, d.h. pro Frame 1/45 = 22ms Zeit.

Total Frame Time: sollte am besten bei 12 ms, möglichst aber noch unter 22 ms liegen. Steigt die Zeit pro Frame darüber, wird der Frame eben länger, und es kommt zu Lags, Time Dilation sinkt und natürlich analog der Sim FPS-Wert. Die Total Frame Time setzt sich zusammen aus verschiedenen Unterzeiten:

Sim Time (Physics): Wenn jemand tausende von fliegenden physischen Würfeln rezzt, braucht der Simulator irsinnig lange, um das in Havok4 alles zu berechnen, dann geht die Zeit extrem hoch. → Physics Lag
Script Time: sollte möglichst unter 12 ms sein. Wenn sehr viele Scripte laufen und richtig was tun, dann geht diese Zeit hoch. Script-Lag ist tückisch, weil er sich gar nicht so in der Time Dilation und Sim FPS ablesen lässt. Seit Havok4 funktionieren physische Bewegungen trotz Script-Lag oft noch recht gut, aber die Scripte werden sehr langsam. Kann man fast nur an diesem Wert ablesen.
Agent Time: Weiter oben unter Simulator gibts die „Main Agents“. Viele Avatare in der Sim bedeuten hohe Agent Time (viel Lag). Child Agents sind diejenigen die aus einer Nachbar-Region oder Sim theoretischen Sichtkontakt haben. Viele Child Agents stören aber kaum.

Performance-Optimierungen

Wie schon geschildert gibt es Inworld eine Menge Potential die Performance einer Sim zu verbessern. Dazu gehören zum Beispiel:

- animierte Bäume und Pflanzen nur sparsam einsetzen, denn diese verringern die Simulator Framerate (Bilder pro Sekunde) und machen die Sim auch träger (Ping-Wert verschlechtert sich).

- auch Scripte schlucken - je nach Art und Programmierung des Scripts - durch die benötigte Rechenzeit einiges an Performance und sollten nicht übermäßig stark eingesetzt werden.

Fazit

Passende PC für OpenSIM bekommt man ab etwa 300 Euro zu kaufen, z.B. über diesen Online-Shop mit sehr preiswerten Angeboten. Wer zukunftsweisend einkaufen möchte achtet insbesondere auf die verwendete CPU und das RAM und investiert lieber etwas mehr, bekommt dafür aber auch mehr Leistung.