# Jahshaka RC2 Release Notes

1. About
2. Download
3. Installation
4. Building Jahshaka from source
5. Whats new in this release
6. Known issues and bug reporing
7. FAQ

## 1. About

Welcome to Jahshaka. The worlds first Open Source realtime editing and effects system - powering the new Hollywood

Jahshaka is free open-source software, released under the GPL. Jahshaka development is a true community effort and anyone is welcome to participate. You can become involved in the project in many ways, all of which will help make Jahshaka into the tool you really want. So join the revolution! Get involved as a code developer, or by contributing comments and suggestions in the jahsjaka forums or by simply reporting faults via bugzilla.

This note is the release notes accompanying the Jahshaka RC2 release, Nov 05. We appologise for naming this version "RC2" as the actual status of Jahshaka is beta and not a Release Candidate. We have had to follow the naming convention of our predecessors in order not to confuse everyone. Confused? Yeah we know - sorry

back to top

## 2. Download

Jahshaka is avaialable for download both as binary installers or as source code. Installers for Windows and for many Linux distributions can be found on the Jahshaka web site http://www.jahshaka.org and from SourceForge http://www.sourceforge.net/projects/jahshaka If you can't find an installer for your distribution, then please use the src rpm or a tarball.

Source: source code tarballs are available from the Jahshaka SourceForge web site http://www.sourceforge.net/projects/jahshaka.

Jahshaka depends on other projects. You can download each dependent project's source code from the Jahshaka website or from each project's website or CVS respository.

Alternatively, the source code for the OpenLibraries and Jahshaka can also be downloaded from the CVS repository:

1. cvs -z3 -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/openlibraries login
2. cvs -z3 -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/openlibraries co -P -r OPENLIBRARIES_0_1_0 openlibraries
3. cvs -z3 -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/openlibraries co -P -r OPENLIBRARIES_0_1_0 dependencies
4. cvs -z3 -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/jahshakafx login
5. cvs -z3 -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/jahshakafx co -P -r JAHSHAKA_2_0_RC2 jahshaka

or, if running on Windows, with a CVS client such as TortoiseCVS which you can download free from www.tortoisecvs.org.

If you plan to compile from the source code, make sure you read the section "Building Jahshaka from source".

back to top

## 3. Installation:

### Installation on Windows

Simply download and run Jahshaka's windows installer which can be found at http://www.jahshaka.org
Note: This installs both Jahshaka and the openlibraries on which Jahshaka depends.

### Installation on Linux

If you run one of the supported distributions, you can use the RPM packages provided. Just make sure you download the ones built for your distribution. Then read the section "Binary RPM packages" below.

If you run a distribution for which there are no RPM packages provided, you can either create RPM packages for your distribution from source RPMs (.src.rpm) (see "Source RPM packages" section below) or, as a last resource, compile from source (see "Building Jahshaka from source" section below).

Once you've decided which way to go (which files to use), download the files for Jahshaka and its dependencies from either the website or the SourceForge.net Jahshaka project page.

#### Binary RPM packages

To install the binary RPM packages, you must have root access. If you prefer, try and use one of the GUI frontends for handling RPMs. For example, in Fedora Core 4 (and possibly other distributions based on or supporting GNOME 2.x), you can use the built-in file manager for GNOME -Nautilus- and double click on each .rpm file to install it (if you have the nautilus-rpm extension). Otherwise, read on for command-line instructions.

Open a terminal and switch user to root:

    $ su -

As root, go to the directory in which your .rpm files reside.

    # cd {directory_containing_the_downloaded_rpm_files}

Then type:

    # rpm -Uvh {package_files}

For example (note that this is a single line):

    # rpm -Uvh olib-glew-1.3.3-1.i386.rpm olib-boost-1_33_1-1.i386.rpm openlibraries-0.1-1.i386.rpm openlibraries-media-0.1-1.i386.rpm olib-faac-18102004-1.i386.rpm olib-lame-3.97-1.i386.rpm olib-ffmpeg-0.0.0-1.i386.rpm
    olib-mlt-0.2.1-2.i386.rpm olib-mlt++-0.2.1-2.i386.rpm jahshaka-2.0_RC2-1.i386.rpm

Please note that the order in which the package files are specified should not be important, as the rpm tool will figure out the order in which they should be installed (see "Order of dependencies" for more information).

If everything goes well, you'll see the installation for all the packages succeed.

#### Source RPM packages

In order to compile each package from source, you need to build and then install each of the packages in the order specified in the section "Order of dependencies". Before compiling the packages, make sure you set up your environment as described in Setting up the environment".

Just make sure you compile each .src.rpm package, then install the {packagename} and {packagename}-devel packages before trying to compile the next one.

For example, you could do something like this:

    # rpmbuild --rebuild olib-glew-1.3.3-1.src.rpm
    # rpm -Uvh /usr/src/redhat/RPMS/i386/olib-glew-1.3.3-1.i386.rpm /usr/src/redhat/RPMS/i386/olib-glew-devel-1.3.3-1.i386.rpm
    # rpmbuild --rebuild olib-boost-1_33_1-1.src.rpm
    # rpm -Uvh /usr/src/redhat/RPMS/i386/olib-boost-1_33_1-1.i386.rpm /usr/src/redhat/RPMS/i386/olib-boost-devel-1_33_1-1.i386.rpm
    (...)

And so on until you've compiled and installed all of the packages.

Please note that you don't have to be root to compile from source, just to install each package once it has been compiled.

##### Order of dependencies

For your reference, the packages should be installed (either by rpm or manually by you) in this order:

- olib-glew
- olib-boost
- openlibraries
- openlibraries-media
- olib-faac
- olib-lame
- olib-ffmpeg
- olib-mlt
- olib-mlt++
- jahshaka

### Installation on Macintosh

Currently there is no means to install Jahshaka.

back to top

## 4. Building Jahshaka from source:

To build Jahshaka, Visual Studio solution files, and .configure scripts are provided depending on your platform.

### Build on Windows

Prerequisites:

1. Microsoft Development environment 2003 (V7.1)
2. TrollTech QT 3.x built with 'gif' support
   Note: Jahshaka V2.0.RC2 was developed using QT 3.3.3, but should work with 3.3.4 and 3.3.5.
3. The OpenGL Extension Wrangler Library needs to reside somewhere where the compiler can find it - i.e. The header files need to reside in a subfolder, 'GL', of a folder in the system include path and the library file needs to reside in a folder in the system library path. This can be achieved by copying wglew.h & glew.h into C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\include\GL and glew32.lib into C:\Program Files\Microsoft Visual Studio .NET 2003\Vc7\lib.
   Please visit http://glew.sourceforge.net to obtain these files.
4. The OpenGL Utility Toolkit. As with the OpenGL Extension Wrangler, copy glut.h and glut.lib to the relevant libraries described above.
   http://freeglut.sourceforge.net/
5. Boost. Download the windows zip file for the boost source code from http://www.boost.org. Unzip into any convenient location then download the windows binary of the boost-jam tool. Simply copy bjam.exe into the top level of the main boost folder and start the build via command line: bjam "-sTOOLS=vc-7_1" install. Ignore the warning about Python, it only affects the python binding. By default Boost installs to c:\boost, which is where Jahshaka will expect to find it.

Build:

1. Ensure all perquisites are satisfied.
2. Install the openlibraries. http://www.openlibraries.org
3. Using a CVS client (such as TortoiseCVS or Ecilpse) checkout the jahshaka source code to any convenient location.
4. Open the plugins_vc71.sln located in the plugins folder and build it.
5. Open the jahshaka_vc71.sln located in the root of the checked out source folder and build.

### Build on Linux

Please note that the source has to be compiled in the right order to satisfy each project's dependencies (see "Order of dependencies").

#### Setting up the environment

To compile from the source tarballs, CVS or the source RPMs, you have to set up your environment to include the non-standard paths on which all the packages are/will be installed.

For example, the default locations for the RPMs use:

    export PKG_CONFIG_PATH="/usr/olib/0.1/lib/pkgconfig:$PKG_CONFIG_PATH"
    export PATH="/usr/olib/0.1/bin:$PATH"

If you compile from CVS or the source tarballs, you need to modify these to match paths inside your {prefix} location.

#### From source tarballs

Just run the classic:

    # ./configure {options} && make

#### From CVS

To compile the OpenLibraries from CVS, run:

    $ ./bootstrap && ./configure {options} && make

Then, as root:

    # make install

To compile Jahshaka from CVS, run:

    $ ./configure {options} jahshaka && make

Then, as root:

    # make install

back to top

## 5. What's new in this release:

The big added extras to the RC2 release are the addition of our new OpenObjectLib technology which gives a new level of support for 3D scene files generated by other applications. X3D and OBJ files containing GLSL shaders can now be imported and used in Jahshaka giving a whole new level of creative possibilities. RC2 also adds editing support for Mac plus many usability and stability improvements as listed below.

### Jahshaka 2.0 RC2 Includes:

1. New level of support for 3D scene files using OpenObjectLib
2. X3D and OBJ scene file support for 3D scenes exported by Maya, 3DSMax, Blender etc. including embedded GLSL shader support
3. Key color selection by eye dropper tool in keyer module
4. Color Corrector module now has full primary color correction capabilities in HSV color space with color wheel GUI for tint adjustments
5. Improved GPU support for ATI graphics cards
6. Tracker module - motion tracking and analysis plus image stabilize function
7. Scopes: live histogram display of luma, red, green, blue or RGB parade display
8. Encoding to many formats from editor and from encoding module
9. Smooth playback in player. Player now uses openGL for hardware assisted smooth playback and low CPU usage
10. Filmstrip UI in desktop and player. Video sequences can be displayed as a filmstrip to help visualize assets better on the desktop
11. Non linear editing support on Mac. Previously only supported on Linux
12. Detailed labeling of effect controls and parameter sliders
13. Import / append effects feature in animation module. This allows a saved effect sequence to be reused
14. New GPU zoom/stretch/crop effect

back to top

## 6. Known issues and bug reporting

We keep an up-to-date track of all bug reports and feature requests via Bugzilla. These are taken seriously and followed up regularly. There is no excuse for not reporting a bug. If something doesn't work, please tell us using our Bugzilla bug tracking system at bugs.jahshaka.org or via the Jahshaka web site forums. (prefer Bugzilla).

back to top

## 7. FAQ

1. What's the relationship between Jahshaka and OpenLibraries?

### What's the relationship between Jahshaka and the OpenLibraries?:

We're it! The OpenLibraries project forms the technological foundation for Jahshaka.

Thanks for reading, we hope you enjoy Jahshaka! The Team The Jahshaka Project

Document version 1.0, November 2005

back to top