Downloading and Installing the Distribution
The MusicKit can be installed from a binary distribution package or compiled from the source code distribution tarball. In either case, certain libraries must be preinstalled for the MusicKit to operate.
Installing Supporting Libraries
The following libraries need to be installed prior to compiling the MusicKit source or before attempting to link against the MusicKit frameworks. These supporting libraries may be installable using fink, or they can be individually downloaded and compiled as described below. Certain libraries may be optionally omitted (reducing functionality of the MusicKit) if necessary. These are noted below.
 | If installing on GNUstep, be sure that
|
- libogg-1.0.tar.gz. Status:
optional - disables
SndAudioProcessorMP3Encoderif omitted., libvorbis-1.0.tar.gz. Status: optional - disablesSndAudioProcessorMP3Encoderif omitted. The Ogg/Vorbis libraries provide patent-free Vorbis encoding/decoding of PCM audio to and from Ogg format bitstreams for use by libshout. Newer versions than 1.0 for Ogg and 1.0 for Vorbis will probably just work.
Install the library using:
- libsndfile-1.0.11.tar.gz. Status: Required.
The libsndfile sound file I/O library provides sound file format conversion. Newer versions than 1.0.11 will probably just work.
Install the library using:
- lame-3.93.1.tar.gz. Status:
optional - disables
SndAudioProcessorMP3Encoderif omitted. The LAME library provides MP3 encoding/decoding capability. Newer versions than 3.93.1 will probably just work.
Install the library using:
- libshout-2.0.tar.gz. Status:
optional - disables
SndAudioProcessorMP3Encoderif omitted. The libshout library (part of the IceS distribution) of the icecast project provides the capability to stream MP3 or Ogg/Vorbis encoded audio to a broadcast server.
Install the library using:
- pa_snapshot_v19.tar.gz. Status: Needs to be installed on Windows, Linux and other Unixen except for MacOS X, OpenStep/NeXTStep systems.
At the moment, the portaudio CVS repository version is the only version that works on MinGW and so MKPerformSndMIDI_portaudio uses the upcoming V19 release. Either fetch the CVS snapshot, or using CVS, checkout the portaudio version 19 development branch. On Linux/BSD/SGI etc do:
cvs -d:pserver:anonymous@www.portaudio.com:/home/cvs co -r v19-devel portaudio cd portaudio ./configure --libdir=$GNUSTEP_SYSTEM_ROOT/Libraries --includedir=$GNUSTEP_SYSTEM_ROOT/Local/Libraries/Headers sudo make install
On Windows XP do:
- libmp3hip-0.4pre1.tar.gz. Status:
optional - disables
SndMP3if omitted. The libmp3hip library of the LAME project provides the MP3 decoding
Install the library using:
Installing MusicKit Binaries
Binaries for the compiled frameworks for various operating systems reside on sourceforge as tar'ed .pkg (Apple/NeXT), or .rpm (Linux) packages. The files include the version number, choose the most recent release:
- MK-5.5.2.b.MOX.pkg.tar
The MacOS X frameworks (including the SndKit), applications, command line tools and documentation.
- ZilogSCCMIDI.b.tar.gz
The MacOS X-Server V1.2 MIDI driver binary for SCC UARTs in 8500/8600/9500/9600/G3/G4 PowerMacs.
This driver is not needed and will not work on MacOS X, only MacOS X-Server V1.2.
Installation Locations
The Installer program will let you choose a directory in which to place the binaries. If you are on a stand-alone machine, you should be logged in (or running Installer) as root and choose “/” for the installation directory (the default).
The frameworks and applications are installed into the appropriate platform locations given in Table 2.
Table 2. MusicKit Install locations
| Platform | Frameworks install location | Applications install location |
|---|---|---|
| OpenStep 4.2 (m68k,ix86) | /LocalLibrary/Frameworks | /LocalApps |
| MacOS X-Server V1.0-1.2 | /Local/Library/Frameworks | /Local/Apps |
| MacOS X | /Library/Frameworks | /Applications |
| GNUStep (on Unixen) | /usr/GNUstep/Local/Library/Frameworks | /usr/GNUstep/Local/Applications |
| GNUStep (on Windows) | C:\GNUstep\Local\Library\Frameworks | C:\GNUstep\Local\Applications |
Command line tools and manual pages will install into the /usr/local hierarchy on Unix type machines, specifically /usr/local/bin. Locations for command line Windows tools have yet to be determined.
If you are the system administrator for a NFS shared network, you probably want to choose a local directory which can be exported and create symbolic links into that directory on the networked machines. Alternatively, if you have a single server that exports /Local* and /usr/local, simply install the package there and you're done.
Installing From The Source Tarball
The source distribution is located at:
- MK-5.5.2.s.tar.gz
The source to MusicKit, SndKit, MKDSP, MKPerformSndMIDI, MKUnitGenerators and MKSynthPatches frameworks and all utilites, applications, documentation and example code.
This is the most recent revision and patch. Some older revisions are located at the sourceforge site for regression testing.
- ZilogSCCMIDI.s.tar.gz
The MacOS X-Server V1.0-1.2 MIDI driver source.
This is not needed for MacOS X.
- DriverKitHeadersForMOXS_V1.2.tar.gz
NeXTStep V3.3 headers required to compile the driver on MacOS X-Server V1.2.
This is not needed for MacOS X.
Retrieving Sources From The CVS Repository
The bleeding edge source is obtainable from the CVS repository on sourceforge and is described in detail by this sourceforge page.
Compiling The Sources
The MusicKit installation process is the now nearly the same as most autoconf configured software. Trivially, the following commands will compile and install the MusicKit.
There are a couple of subtle variations to this. On GNUstep systems, make will build the MusicKit sources as expected. On MacOS X, to benefit from the Xcode IDE (the IDE, plus zero-linking), make will just run the xcodebuild command line tool which does the actual building using the MusicKit.xcode project. If configure determined some libraries were unavailable, they will be omitted when xcodebuild is run. Since xcodebuild install builds and then installs, the sudo make install suffices, typing a preceding make is not actually necessary.
The MusicKit project can also be built within the Xcode IDE GUI. However configure must be run before building with Xcode, in order to configure headers to selectively compile sources based on library availability. In addition, the default configuration is to assume if the Xcode GUI is being used, then the MusicKit is being developed, not just installed and that all libraries have been installed. If all of the libraries are not available, the build setting CONFIGURED_LIBS must be changed for the SndKit to remove those libraries which are not installed. In practice, the user must manually modify CONFIGURED_LIBS build setting in the SndKit target to match the setting in Makefile.
The MKUnitGenerators and MKSynthPatches frameworks won't compile on platforms other than OpenStep or NeXTStep because the Motorola asm56000 and lnk56000 tools are missing.
Installing a MIDI driver
If necessary, compile and install an appropriate MIDI driver.
To compile the MacOS X-Server V1.2 Zilog SCC MIDI driver, some header files are missing. You can get them from the Darwin distribution of the SoundKit, copy them from a NeXTStep 3.3/OpenStep 4.2 system, or as a convience, they are made available for download.
MacOS X Developer release includes source for a generic USB MIDI driver at /Developer/Examples/CoreAudio/MIDI/SampleUSBDriver. There is also a driver binary for the MIDIMan MIDISPORT™ USB interfaces for MacOS X available for download from MIDIMan's web page and other vendors may well have drivers available for their hardware.