Installation from sources on Linux

Basic installation. Before installing OpenVIP, please check the following dependencies:

Table 1.3. Requirements

SoftwareTested with version
UPF0.1.6
Python2.5.1
wxPython2.8.6.1 Unicode
FFmpegrevision 10461
ImageMagick5.4.9
libxml22.4.30
Freetype2.1.4
libiconv1.11

UPF 0.1.6 is available at Sourceforge and can be downloaded from the CVS repository using the command

cvs -z3 -d:pserver:anonymous@openvip.cvs.sourceforge.net:/cvsroot/openvip co -P upf

Python, wxPython, ImageMagick, libxml2, Freetype, and libiconv are already included in most Linux distributions. Please use only stable releases of wxPython (series A.B, where B is an even number); do not use version 2.8.7.1. We recommend to use the Unicode version of wxPython; with the ANSI version, you won't be able to process files with non-ASCII (e.g. Czech, German, Chinese ...) filenames.

The FFmpeg sources can be downloaded using Subversion. OpenVIP has been tested with FFmpeg revision 10461 (11th September 2007); you can use the command

svn checkout -r10461 svn://svn.mplayerhq.hu/ffmpeg/trunk ffmpeg

to obtain exactly the same version. You have to build shared libraries (--enable-shared) including swscale (--enable-swscaler). Also enable all external libraries (mp3lame, xvid, etc.) that you want to use.

We now proceed by downloading OpenVIP sources from the CVS repository:

cvs -z3 -d:pserver:anonymous@openvip.cvs.sourceforge.net:/cvsroot/openvip co -P openvip 

Please check the file Jam-config (in OpenVIP top level directory) and update the values of UPF_PATH, PYTHON_ROOT and PYTHON_VERSION in the UNIX section to match your system settings.

To compile the sources you need the Boost Jam tool and gcc 3.2.x or later. Simply run

bjam

from the top level directory. The compiled binaries are copied to the bin subdirectory. One of the files produced is the libopenvip_hl.so library, which must be visible to the dynamic linker. For example, you might add the bin directory to /etc/ld.so.conf file (and run /sbin/ldconfig as root) or include it in the LD_LIBRARY_PATH environment variable.

If you don't run OpenVIP programs from this directory, you have to set the OPENVIP_HOME environment variable. For example, if you compiled OpenVIP in usr/local/src/openvip, you can type either

cd /usr/local/src/openvip/bin
openvip-gui.py

or

export OPENVIP_HOME=/usr/local/src/openvip/bin
$OPENVIP_HOME/openvip-gui.py

to start the OpenVIP editor.

If everything works and you don't need the sources any more, you may delete all subdirectories other than bin. You can also copy the contents of bin somewhere else, e.g. to /usr/local/share/openvip. Don't forget to set OPENVIP_HOME and LD_LIBRARY_PATH accordingly.

Documentation. OpenVIP documentation is written in the Docbook format. If you want to use the builtin help, go to the doc subdirectory and run

make htmlhelp

(this requires xmllint and xsltproc to be installed). Compiled help files will be copied to the bin directory. Alternatively you can use the online documentation from SourceForge.

Optional features. You can optionally install the following software:

Table 1.4. Optional requirements

SoftwareTested with version
libxml2-python2.4.30
FFTW3.0.1
Python Imaging Library (PIL)1.1.2
Graphviz2.6

libxml2-python is not required, but it is highly recommended.

Without FFTW you won't be able to compile the BandPass and Equalizer audio plugins.

The PIL is necessary for running thumbnail.py, a Python script for generating thumbnails from a video file.

You need the dot program from the Graphviz package to process files created by visualize.py, a script for visualization of OpenVIP network files.