Description of files included in OpenViBE

  • NB: updated for OpenViBE 1.1.0 (08.oct.2015)

This article contains a short description of all of the files contained in the distribution of the OpenViBE software. For the purpose of this article we will assume that ROOT is the folder where you have installed/unpacked the software.

Windows Installer

Folder structure

bin
Contains all of the binary files necessary to run and use the OpenViBE platform.

dependencies
This folder contains all dependencies necessary for OpenViBE, their binary and header files.

include
Files you will need to include to use some of the functions provided by OpenViBE are stored here.

share
Supporting files are stored here. This folder contains several subfolders worth mentioning.

share/openvibe/electrode_sets
Positions of electrodes using standard 10–20 system are available here. These are used by some visualisations.

share/openvibe/applications
Files, such as textures, 3D models and Gtk UI files are stored in this folder. Each application has its own subfolder.

share/openvibe/scenarios
Scenarios provided by OpenViBE are available here. Demos of BCI implementations as well as tutorials on how to use boxes are provided here. There is also a folder containing some sample signals.

$APPDATA/openvibe/
All logs and some configuration files created by OpenViBE applications are stored under this folder. Example: “C:\Users\Joe\AppData\Roaming\openvibe\log” for the log dir on Win7.

Executable files

In the main folder you will find several executable files.

openvibe-acquisition-server
Launches the Acquisition Server.

openvibe-designer
Launches the OpenViBE designer.

openvibe-id-generator
This is a small script used to create IDs for new boxes.

openvibe-plugin-inspector
This program generates the previews of the boxes and takes screenshots of them to be used in the documentation. If you develop a new box and you would like to create openvibe-like documentation then you need to run this script before running Doxygen.

openvibe-skeleton-generator
A developer tool for creating c++ code skeletons for easier development of new boxes.

openvibe-ssvep-demo-shooter
A simple game using the SSVEP paradigm. This program is called automatically by the scenarios.

openvibe-ssvep-demo-trainer
Training application for the SSVEP paradigm, called by the training scenario.

openvibe-vr-demo-handball
Example implementation of an application using the motor imagery paradigm.

openvibe-vr-demo-spaceship
The “Lift the spaceship” demonstrator. Uses scenarios relying on the beta rebound paradigm.

openvibe-vrpn-stimulator
An application made for testing VRPN connections. This application can send a number of button related events to VRPN clients (such as the VRPN Client box).

Source code distribution

The source code distribution contains the source code as well as the necessary scripts to build and run the OpenViBE software, along with some developer utilities.

Files that you would normally find in the installed version of the software can be found in the ROOT/dist folder after a successful compilation.

Folder structure

The source distribution has several differences compared to the binary one.

cmake-modules
This folder contains all CMake configuration files.

applications, common, documentation, kernel, modules, openvibe, plugins, toolkit, …
Source code of OpenViBE’s core components.

contrib
Parts of OpenViBE contributed by the community.

scripts
This folder contains scripts necessary for building OpenViBE. Their functions are described in the following section.

Script files

Most of the files are available with both linux- and win32- prefixes. Files with the same name do the same thing. We will first discuss these files

PREFIX-build
This scripts builds the OpenViBE platform according to the current settings. Prior to running the script the dependencies have to be installed.

PREFIX-clean
Cleans the build environment. Deletes all of the compiled binary files and the helper files created during the process.

PREFIX-install_dependencies
Installs the necessary dependencies needed to run OpenViBE.

Some scripts are only available on one platform.

win32-init_env_command
This file sets up the compilation toolchain and environment variables. Not needed on Linux.

win32-generate-vc-proj
Creates a Visual Studio project which can be opened afterwards in VS. This is done to make developing on Windows easier using an IDE.

win32-launch-vc
Launch Visual Studio IDE with the OpenVIBE solution. You must run win32-generate-vc-proj first.

This entry was posted in Miscellaneous manual pages. Bookmark the permalink.