Skip to content

mirhahn/vbcrender

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VbcRender -- Video Rendering for Visualization of Branch Cut Algorithms

VbcRender is a simple command line tool that allows users to render videos from VBCTOOL files. It is designed to have a relatively small memory footprint for large trees.

Getting Started

VbcRender is currently experimental and does not have any binary release packages. This section explains how to check out the Github repository and build the code.

Prerequisites

VbcRender makes extensive use of the Cairo, GLib, and GStreamer libraries for drawing and video encoding. For input, command line argument parsing, and path manipulations, the Boost libraries Filesystem, Iostreams, and Program Options are required. CMake is used as a build system. VBCTOOL is required to build VbcRender and will automatically be downloaded using Wget during the build process.

The required library and program versions are:

Boost >= 1.46
Cairo >= 1.2
CMake >= 3.1
GLib >= 2.0
GStreamer >= 1.0

Installing

This section explains step by step how to build VbcRender. This guide assumes a GNU/Linux system and GNU make as the standard build system for CMake.

First, we clone the latest state of the repository.

git clone https://github.com/mirhahn/vbcrender.git

Then we change into the new working copy's root directory and create a subdirectory called build.

cd vbcrender
mkdir build

Next, we generate build files inside the build directory. For most purposes, it is desirable to build an optimized version without debugging symbols.

cd build
cmake -DCMAKE_BUILD_TYPE=Release ..

For development purposes, it may be preferrable to build a version with debugging symbols and additional debugging code.

cd build
cmake -DCMAKE_BUILD_TYPE=Debug ..

Finally, we invoke make to build vbcrender.

make

This should generate a standalone executable ./vbcrender that can be moved to a different directory without any repercussions. To see a list of command line arguments, type

./vbcrender --help

Built With

Authors

  • Mirko Hahn - Initial developer - mirhahn

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU General Public License v3 or later - see the LICENSE.md file for details

Acknowledgments

About

Renders videos from VBC files.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published