|
|
| (27 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This document describes how to build BCI2000, i.e. how to create the BCI2000 executables from their source code.
| | The process of building BCI2000 from source differs between Windows and non-Windows (macOS, Linux) systems. |
|
| |
|
| == Why to build ==
| | There are step-by-step tutorials for each: |
| Typically, you will install BCI2000 from its binary distribution, and do not need to build BCI2000, unless
| | * [[Programming Howto:Building and Customizing BCI2000|Building and Customizing BCI2000 for Windows systems]], |
| *you want to always use its most current SVN version,
| | * [[Programming Howto:Non:Building and Customizing BCI2000 on Non-Windows Platforms|Building and Customizing BCI2000 for macOS and Linux]]. |
| *you want to use code from the [[Contributions:Contents|Contributions]] section, | |
| *you create your own module by modifying an existing one, or create a new one from scratch.
| |
|
| |
|
| == Tools required ==
| | <!-- This document describes how to build BCI2000, i.e. how to create the BCI2000 executables from their source code. |
| As of BCI2000 version 2.0, building all parts of BCI2000 requires Borland's C++ Builder 6, or a more recent version.
| |
| The operator GUI and Application modules currently require the Borland VCL library.
| |
| Non-GUI related parts of BCI2000 can be built using the freely available Borland C++ compiler:
| |
| *[[User Reference:Command Line Processing|Command line tools]]
| |
| *[[Matlab mex files]]
| |
|
| |
|
| Matlab mex files can also be built on platforms other than Win32. Please use the src/tools/mex/buildmex.m Matlab script (tested with gcc).
| | ==Prerequisites== |
| | #A C++ compiler. Currently, MSVC 2017 and 2019 are supported. |
| | #To build GUI-related parts of BCI2000, a recent version of Qt5 is required. Use Qt's maintenance tool to select and install a version of Qt that matches your C++ compiler. |
| | #CMake 3.11 or newer. Choose "add to path for all users" when prompted by the installer. |
|
| |
|
| ==How to build== | | ==How to build== |
| ===Building BCI2000 from the command line=== | | ===1. Start CMake=== |
| Command-line builds require a working installation of Borland C++ Builder 6.
| | In the BCI2000 build directory, double-click '''Configure.sh.bat'''. |
| # Open a Windows cmd shell, e.g. by choosing "Run..." from the Start Menu and entering "cmd".
| | ===2. If using Qt on Windows, point CMake to it=== |
| # Change to the "src" directory where this document resides.
| | #In the CMake GUI, click "Add Entry". |
| # Execute "make" from the command prompt. | | #Under Name, enter "Qt5_DIR" (case matters), and set "Type" to "PATH". |
| # If you updated or edited any of the source files, and experience linker errors or other unexpected behavior, execute "make clean && make all".
| | #Under Value, enter the path to your Qt distribution's <tt>lib/cmake/Qt5</tt> directory. |
| # For build versioning, execute "make build" rather than "make" or "make all". This will update the build information visible in the BCI2000 "Version" parameters, and in the "About" boxes of BCI2000 GUI applications. | | E.g., if your Qt distribution for MSVC 2019, 64 bit, is located under <tt>D:/Qt/5.10.1/msvc2019_64</tt>, the "Qt5_DIR" CMake variable should point to <tt>D:/Qt/5.10.1/msvc2019_64/lib/cmake/Qt5</tt>. |
|
| |
| ===Building BCI2000 using the Borland C++ Builder 6 IDE===
| |
| # Open the file "BCI2000.bpg" with the IDE by double-clicking it.
| |
| # Make sure the "ProjectManager" view is visible to the left. | |
| # Right-click the topmost project (located immediately below the line reading "BCI2000"), and choose "Make all from here".
| |
| # To get rid of possible inconsistencies from earlier builds, choose "Build all from here" rather than "Make all from here".
| |
|
| |
|
| ===Starting up BCI2000=== | | ===3. Click "Configure"=== |
| # After compilation, a desired configuration of BCI2000 may be started by executing an appropriate batch file from the top level "batch" directory. Once a particular configuration of BCI2000 is started, simply load a parameter file with the same name as the batch file from the "parms" directory.
| | From the list of compilers, choose the compiler that you would like to use. |
| # If you need a configuration for which no batch file exists, just modify a copy of a batch file that is close to your needs.
| | If using Qt, the compiler must match the Qt distribution chosen above. |
|
| |
|
| ===Compiling BCI2000 with Borland C++ Builder 2006/2007=== | | ===4. Choose build options=== |
| # Open the file "BCI2000.bpg" from within Borland Developer Studio. This will import all existing projects into BDS project files. | | #Make sure that "Grouped" is checked in the GUI, and "Advanced" is unchecked. |
| # In the project manager (at the top right), right-click the topmost project and choose "Make all from here".
| | #Under the "BUILD" section, you may choose which parts of BCI2000 to build. Typically, you will want to have "BUILD_CONTRIB" checked. |
| # To get rid of possible inconsistencies from earlier builds, choose "Build all from here" rather than "Make all from here". | | #Under "EXTENSIONS", choose which extensions to include into the build. |
| # Command-line builds cannot be done with Borland C++ Builder 2007 because it lacks a project-to-makefile conversion utility. Still, [[User Reference:Command Line Processing|Command line tools]] and [[Matlab mex files]] may be compiled from the command line as described in their documentation.
| | ===5. Click "Generate"=== |
| # When using BCB2006, you may experience "invalid property" errors when running BCI2000. This may be due to imperfect import of *.dfm files. Make sure to install all available updates, then import a clean version of the BCI2000 source tree. If this doesn't help, consider updating to BCB2007. | | A project/solution file will be created inside the BCI2000 build directory. Double-click it to open it in the IDE. |
| | | ===6. Build BCI2000 in full, or partially=== |
| ===Building Contributions=== | | In the IDE, choose which projects to build. You may right-click individual projects, or groups of projects, and choose "build" from the context menu. |
| ====From the command line====
| | --> |
| After building BCI2000 from the command line, the <tt>.makefiles</tt> file in the <tt>src</tt> directory contains a full list of subprojects.
| | [[Category:Howto]][[Category:Development]] |
| Those from the contribution section are commented out with a # character in front. When you remove the # character, and do a "make all" or "make build", the additional project will be included into the build.
| |
| Likewise, you may speed up builds by commenting out parts of the core distribution that you don't need.
| |
| ====From the IDE==== | |
| Open the contrib project group in the <tt>src/contrib</tt> directory, and build the contributions you want.
| |