IAEM-iARS project File: README Description: The ReadMe file including general info and installation for LINUX and Windows. Created: 26.5.2003 Author: Christopher Frauenberger, Winfried Ritsch Copyright (C) Institut for Electronic Music and Acoustic, Graz Graz 2003-2005 see LICENSE.txt ************************************************************************** 0. Introduction: ======================= iARS (internet Audio Rendering System) is a browser plugin which enables a browser to receive audio streams and play them using the real-time music Program "Pure Data". It allows to define a user interface to any audio rendering algorithms. These UIs will be drawn in the browser window and provide real-time mixing of internet streams. This program was developed as part of the IAEM (Internet Archive of Electronic Music) project (http://iaem.at) at the Institute of Electronic Music and Acoustic, Grazs, Graz. 1. Installation ======================= The plugin is based on the QT Netscape plugin extension and therefore only available for Netscape or Netscape based browsers (Mozilla, Galleon, Firefox, ...). We recommend to use the Firefox browser. Download at: http://www.mozilla.org/products/firefox/ The easiest way to use the plugin is to use the pre-compiled shared library coming with the package. To make the plugin available to your browser you need the following: Pre-requisits: * Pure Data http://pd.iem.at * zzip library http://zziplib.sourceforge.net/ (also available as debian package) * zlib http://www.gzip.org/zlib/ * Qt Runtime Libraries http://trolltech.com * Qwt Library http://qwt.sourceforge.net/ Optional, for the stream external: * vorbis http://www.vorbis.com * vorbisenc * vorbisfile * samplerate http://www.mega-nerd.com/SRC/ Note: For your convenience the Windows package is coming with all dlls so you wont need anything except Pd and a Browser. For installing do the following: 1 Download the Package 2 unpack UNIX: 3 do a ./configure; make; make install; 4 check your configuration in ~/.iARS/ WINDOWS: 3 copy the following files into your plugin directory npiARS10.dll qt-mt230nc.dll qwt041.dll zlib1.dll zzip-1.dll (e.g. C:\Programms\Mozilla Firefox\plugins\) Note: you could use the iARS-pd.zip package instead of the next two steps. It includes a full featured Pd with all libraries and externals needed for running iARS (just copy it somewhere and adjust the pd\bin\startpd.bat file). If not, you need to customise your pd with: 4 copy the MSVCP60D.dll and MSVCRTD.dll into the Pd\bin directory (e.g. C:\pd\bin\) 5 copy the Pd externals and dlls into the Pd extra folder stream.dll xmlrpc.dll xmlrpc-init.pd (e.g. C:\Pd\extras\) 6 copy the sample configuration file in your home directory (e.g. C:\Documents\user\) 7 Edit your config file as shown in the sample file PD_EXEC = /path/to/pd-startup-script PD_XMLRPC_INIT = /path/to/the/xmlrpc-init.pd PD_EXTRAS = /path/to/pd/extra/ PD_HOST = HostOfXmlRpcServer PD_PORT = PortOfXmlRpcServer PD_GUI = no The last two must be the same as specified in the xmlrpc-init.pd file (ditributed with the xmlrpc external)!! (by default localhost - 8000) The plugin will look for your config file in your home directory ($HOME/.iARS/iARS.conf on LINUX and HOMEPATH\iARS\iARS.conf for Windows) first and for UNIX also in the system /etc/iARS.conf. For Linux default installation the Pd externals (xmlrpc and stream) are installed in the configuration directory (e.g. ~/.iARS/pd/) along with the xmlrpc-init.pd. Test your installation by examining the test pages at the IAEM portal (http://iem.iaem.at/collab/iARS/) 2. Compilation ================== 1.1 Prerequisits ------------------ To compile this plugin you will need to get the following: * Pure Data http://pd.iem.at * QT (>3.2) Unix http://www.trolltech.com (QT 2.3.0 Non Commercial for Windows ftp://ftp.trolltech.no/pub/qt/non-commercial/) * Qwt (> 0.4.1) http://qwt.sourceforge.net/ * Netscape Plugin SDK http://wp.netscape.com/comprod/development_partners/plugin_api/index.html * gcc (> 3.x) http://www.gnu.org (Microsoft cl compiler > 12.0 - MS Studio > 6.0) * zzip library http://zziplib.sourceforge.net/ (also available as debian package) * zlib http://www.gzip.org/zlib/ For Windows you also need * PSAPI (part of PlatformSDK) http://msdn.microsoft.com (psapi.h and psapi.lib) 1.2 QT ------- If you have Qt installed and using Linux you can skip this step. Compile QT and build the nsplugin extension of the library. Follow these instructions http://doc.trolltech.com/3.1/nsplugin.html and examine the examples to make sure the library is working. 1.4 libiARS library -------------------- LINUX: - run ./configure to check dependencies - edit install.paths to your needs - make; make install; WINDOWS: - Build the Pd Externals manually in their directories using nmake -f Makefile.win - Build the xmlrpc++ library manually in its dir using the nmake -f Makefile.win - make sure the qwt libs are available - make sure that QT_DIR is set and tmake is available from the console - take a look at the iARS.pro file and adjust paths if necessary - tmake iARS.pro -o Makefile - nmake -f Makefile and proceed with copying the files like stated in the first section. 1.5 Pure Data ----------------- Build Pure Data as described in the approperiate INSTALL file. The two externals need to be copied to locations where pd finds it without the necissity of providing the full path name (e.g. the default external dir). 2. Licensing ====================== This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA IEM - Institute of Electronic Music and Acoustic, Grazs, Graz Inffeldgasse 10/3, 8010 Graz, Austria http://iem.at Good Luck! Enjoy!