|
| 1 | +################################################################################ |
| 2 | +# About |
| 3 | +################################################################################ |
| 4 | + |
| 5 | +Fusion is a modular daemon designed to facilitate rapid prototyping of multimodal user interfaces. |
| 6 | +It was initially written for the Natural User Interface Group as part of Google Summer of Code 2011. |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | +################################################################################ |
| 11 | +# Features |
| 12 | +################################################################################ |
| 13 | + |
| 14 | +* Cross-Platform |
| 15 | +Fusion is fully cross-platform. It runs on Windows, Linux, MacOSX and FreeBSD. |
| 16 | +The same configurations and models apply across platforms, so if your application is |
| 17 | +cross-platform, we support it. |
| 18 | + |
| 19 | +* Daemon |
| 20 | +Fusion runs as a daemon process. That means you can |
| 21 | +launch it on a different headless computer if you want (although currently some things |
| 22 | +depend on the daemon running on localhost, and responsiveness could be an issue). |
| 23 | + |
| 24 | +* Threading |
| 25 | +With Fusion, you have the ability to enable threading for any module you want. |
| 26 | +That means you are finally able to use your Core 2 Duo / Quad Core to its full |
| 27 | +potential. Obviously, you can still use non-threaded mode. |
| 28 | + |
| 29 | +* Remote API |
| 30 | +Fusion has a JSON API to control all its settings and adjust your pipeline remotely |
| 31 | +and on the fly. Interaction events are also served as JSON objects. |
| 32 | + |
| 33 | +* HTML5 Administration |
| 34 | +Fusion's web interface makes use of the most recent developments in web |
| 35 | +programming with open standards like HTML5. All that is required is a compatible |
| 36 | +HTML5 web browser. As of today, Firefox 3.6, Safari and Chromium have successfully |
| 37 | +run the web interface. |
| 38 | + |
| 39 | + |
| 40 | + |
| 41 | + |
| 42 | +################################################################################ |
| 43 | +# Compiling Fusion |
| 44 | +################################################################################ |
| 45 | + |
| 46 | +Fusion uses the SCons build system (http://www.scons.org/). Quoting the website: |
| 47 | +"""SCons is a software construction tool -- that is, a superior alternative to the |
| 48 | +classic "Make" build tool that we all know and love.""" |
| 49 | + |
| 50 | +This means you have to install SCons to be able to compile Fusion. |
| 51 | +The platform specific compile notes below include instruction on how to install |
| 52 | +SCons. Once you have SCons installed open a command line in the Fusion directory |
| 53 | +(the one with this README in it) and run the following command: |
| 54 | + |
| 55 | +To build fusion (and dependencies if needed) run: |
| 56 | +scons |
| 57 | + |
| 58 | +To clean fusion (remove any intermediate files, output libs and executables): |
| 59 | +scons -c (or 'scons --clean') |
| 60 | + |
| 61 | +To also clean the dependencies built in contrib: |
| 62 | +scons -c --clean-contrib |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | +For more info about SCons, other options, or how to install it on any system, |
| 67 | +you can check the SCons user guide at: |
| 68 | +http://www.scons.org/doc/production/HTML/scons-user.html |
| 69 | + |
| 70 | + |
| 71 | + |
| 72 | ++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| 73 | ++ Linux Compile Notes |
| 74 | ++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| 75 | + |
| 76 | +The following instructions are for Ubuntu/Debian. |
| 77 | +They should be easily transferable to other linux distributions. |
| 78 | +Building from source on these distributions is really easy. |
| 79 | + |
| 80 | +First, you have to install git and the build-tools: |
| 81 | +sudo apt-get install git-core build-essential scons |
| 82 | + |
| 83 | +Then, you get the current development version of Fusion: |
| 84 | +git clone git://github.com/shalstvedt/Fusion.git |
| 85 | + |
| 86 | +Afterwards, we change to the Fusion repo you just cloned: |
| 87 | +cd Fusion |
| 88 | + |
| 89 | +It is time to compile, let's run scons! |
| 90 | +scons |
| 91 | + |
| 92 | +Now you should be able to use fusion already. Try the ballworld demo: |
| 93 | +./fusion -l config/ballworld/ballworld.cfg |
| 94 | + |
| 95 | +Now that the daemon is running, you can simply open your webbrowser |
| 96 | +(needs to be Firefox 3.6 or some other browser with HTML5 and support for |
| 97 | +the canvas object. Javascript has to be enabled.) and navigate to the admin interface: |
| 98 | +http://127.0.0.1:7500/ |
| 99 | + |
| 100 | + |
| 101 | ++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| 102 | ++ Windows Compile Notes |
| 103 | ++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| 104 | + |
| 105 | +To build fusion, you will have to install a couple of things first. |
| 106 | +You will need Visual C++ 2010 and scons (which also requires python) |
| 107 | + |
| 108 | +1. install Visual C++ Express 2010 (not needed if you have Visual Studio 2010) |
| 109 | +not: must be 2010 version! you can download a free version here (select language to start download): |
| 110 | +http://www.microsoft.com/express/Downloads/#2010-Visual-CPP |
| 111 | + |
| 112 | +2. install Python and scons |
| 113 | +download and run the following files: |
| 114 | +http://python.org/ftp/python/2.7/python-2.7.msi |
| 115 | +http://prdownloads.sourceforge.net/scons/scons-2.0.1.win32.exe |
| 116 | + |
| 117 | +OK, you're ready to build. If you installed everything to default locations just run: |
| 118 | +scons |
| 119 | + |
| 120 | +If scons command is not found, try: |
| 121 | + |
| 122 | +C:\Python2.7\Scripts\scons |
| 123 | + |
| 124 | +Now you should be able to start fusion. Just double click the fusion executable or run it from the command line to use a config: |
| 125 | +fusion -l config/ballworld/ballworld.cfg |
| 126 | + |
| 127 | +Now that the daemon is running, you can simply open your browser |
| 128 | +(needs to be Firefox 3.6 or some other browser with HTML5 and support for |
| 129 | +the canvas object. Javascript has to be enabled.) and navigate to the admin interface: |
| 130 | +http://127.0.0.1:7500/ |
| 131 | + |
| 132 | + |
| 133 | ++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| 134 | ++ OSX Compile Notes |
| 135 | ++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| 136 | + |
| 137 | +1. installl scons |
| 138 | +download the follwoing file: |
| 139 | +http://prdownloads.sourceforge.net/scons/scons-2.0.1.zip |
| 140 | + |
| 141 | +2. unzip the file, open a terminal and navigate to that directory: |
| 142 | +cd scons-2.0.1 |
| 143 | +python setup.py install |
| 144 | + |
| 145 | +You're ready to build, just run: |
| 146 | +scons |
| 147 | + |
| 148 | + |
| 149 | +Note: If you need to build moved as 32bit, you can do so by forcing the -m32 flag on the compilers for both moved and all libs in contrib by running: |
| 150 | +CC='gcc -m32' CXX='g++ -m32' scons |
| 151 | + |
| 152 | +Now you should be able to use fusion already. Try the simple-video preset: |
| 153 | +./fusion -l config/ballworld/ballworld.cfg |
| 154 | + |
| 155 | +Now that the daemon is running, you can simply open your browser |
| 156 | +(needs to be Firefox 3.6 or some other browser with HTML5 and support for |
| 157 | +the canvas object. Javascript has to be enabled.) and navigate to the admin interface: |
| 158 | +http://127.0.0.1:7500/ |
| 159 | + |
| 160 | + |
| 161 | +******************************************************************************** |
| 162 | +Fusion incorporates components and ideas from the Movid project. Please see |
| 163 | +below for license information on that project. |
| 164 | +******************************************************************************** |
| 165 | + |
| 166 | +################################################################################ |
| 167 | +# License |
| 168 | +################################################################################ |
| 169 | +Movid Copyright (C) 2010 Movid Authors (see AUTHORS file). All rights reserved. |
| 170 | +Movid may be used and distributed under the terms of the Q Public License as |
| 171 | +appearing in the LICENSE file distributed with this software. |
0 commit comments