Download
From Olympus
Contents |
Prerequisites
The current version of the Olympus architecture runs under Windows (current development is taking place under Windows XP and Vista, but the system should also work under Windows 2000). We are in the process of porting Olympus to Linux; contact Benjamin Frisch for more information.
The Olympus code base contains C++, Perl and Java, as well as shell scripts. Everything is kept in a Subversion repository, so you'll need a Subversion client to access it. TortoiseSVN and SmartSVN are two possibilities.
The C++ components only compile with Visual Studio .NET 2005 with Visual Studio .NET Service Pack 1. Note that because of a lack of backward compatibility you will not be able to open the source code projects using earlier versions of Visual Studio. Also, we currently do not support Visual Studio 2008 so Olympus will probably not compile with it or any newer versions. We are working on it though so expect it to work soon... Even if you do not plan to make changes to the code base, you might still need some Visual Studio specific DLLs to run the executables for the various Olympus components.
You should get the most recent versions of the following. You will need to install these in the order noted:
- Java SE Development Kit (you may need to set an environment variable JAVA_HOME to the root of the JDK installation).
- JDK Runtime Environment
- NetBeans
If you are experiencing difficulties, see if the problem is due to incorrect paths in a build script; your Windows installation could be different from ours.
You need a current version of perl. We've been happy with ActivePerl for Windows from ActiveState. We currently use version 5.10. You will need additional modules, specifically Win32::API. Do this by using ActivePerl's Perl Package Manager, or get it directly from the CPAN repository.
Finally, you need a speech synthesizer. Olympus provides an interface to several synthesizers. It can use any SAPI 5.1-compliant synthesizer. To use a SAPI compliant synthesizer you need to install the SAPI SDK. Olympus currently expects SAPI 5.1; however it is no longer supported by Microsoft. You may still be able to find it; we found one here.
The current SDK version is 5.3 and has been incorporated into the Windows Server 2008 Platform Software Development Kit (which you can find at here though you should probably should just do a search for "Microsoft® Windows® Software Development Kit for Windows Server 2008™". Note that the Olympus 2.2 build process still checks for some 5.1 components, but this is fixed on the Olympus trunk.
Olympus also supports Cepstral Swift's proprietary API. NB: Swift also supports SAPI but at least some versions work slower through SAPI than the Cepstral API. The development version of Olympus has an interface to the Flite open source TTS engine.
Additional Materials
The Olympus build system is being transitioned to CMake (which is OS-neutral). If you plan on building the Olympus trunk, you will also need to install CMake.
License
The complete RavenClaw/Olympus distribution falls under the following free software licence. Some parts of the distribution may fall under different copyright holders but their licenses fall into the same free class as this.
Copyright (c) 1998-2008 Carnegie Mellon University. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
This work was supported in part by funding from the Defense Advanced Research Projects Agency and the National Science Foundation of the United States of America, and the CMU Sphinx Speech Consortium.
THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Downloading and Building
- Please read the licensing agreement, and download and install any prerequisites you might need.
- The latest version of the full source code for Olympus is available through Subversion. First, you need to download the core Olympus architecture, which can be found in the Subversion repository. We recommend you get the latest stable version (2.2) from:
- http://trac.speech.cs.cmu.edu/repos/olympus/branches/2.2
The current development version (likely to be unstable!!) is available at:
- http://trac.speech.cs.cmu.edu/repos/olympus/trunk. - Execute the Perl file OlympusBuild.pl, which can be found in the root Olympus directory. This will build all the core Olympus agents and libraries and define the environment variable OLYMPUS_ROOT to contain the path to the Olympus directory.
- Then you should download either the tutorials, which can be found on the Documentation page, or an example system. Example systems can also be found at http://trac.speech.cs.cmu.edu/repos/olympus/example-systems in the Olympus SVN repository. Once you've downloaded a system, you need to build it using its own "SystemBuild.pl" batch file, which is in the root of branch of the example system that is identical to your Olympus branch. To test the system, execute SystemRun.bat in the root of branch of the example system that is identical to your Olympus branch.
Documentation
The documentation page is under construction but contains or will contain soon a complete tutorial on how to build systems with Olympus, as well as a number of reference pages for different parts of the architecture and pages on advanced topics for experienced developers. See Documentation.
Questions and Problems
For additional information, as well as answers to specific questions, email the developers mailing list (olympus-developers@cs.cmu.edu).
