Vinnie's Multipurpose Library (That Uses JUCE)
C C++
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 2 commits ahead, 9 commits behind vinniefalco:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
AppConfigTemplate
Builds
modules
tags
.gitignore
COPYRIGHT
Doxyfile
README.md

README.md

VFLib: A multipurpose library built on JUCE.

Version 1.1

Copyright (C) 2008 by Vinnie Falco <vinnie.falco@gmail.com> (e-mail)

VFLib is a source code collection of individual modules containing functionality for a variety of applications, with an emphasis on building concurrent systems. VFLib requires JUCE (Jules' Utility Class Extensions), available from Raw Material Software. JUCE is available under both the GNU General Public License and a commercial license. Other than JUCE, VFLib has no external dependencies.

VFLib is hosted on Github at https://github.com/vinniefalco/VFLib

The online documentation is at http://vinniefalco.github.com/VFLib

Platforms

All platforms supported by JUCE are also supported by VFLib. Currently these platforms include:

  • Windows: Applications and VST/RTAS/NPAPI/ActiveX plugins can be built using MS Visual Studio. The results are all fully compatible with Windows XP, Vista or Windows 7.

  • Mac OS X: Applications and VST/AudioUnit/RTAS/NPAPI plugins with Xcode.

  • GNU/Linux: Applications and plugins can be built for any kernel 2.6 or later.

  • iOS: Native iPhone and iPad apps.

  • Android: Supported.

Prerequisites

This documentation assumes that the reader has a working knowledge of JUCE. Some modules built on external libraries assume that the reader understands the operation of those external libraries. Certain modules assume that the reader understands additional domain-specific information. Modules with additional prerequisites are marked in the documentation.

External Modules

Some modules bring in functionality provided by external libraries. For example, the vf_bzip2 module provides the compression and decompression algorithms in bZip2. Usage of these external library modules is optional. They come with complete source code, as well as options for using either system or user provided variants of the external libraries: it is not necessary to download additional source code packages to use these modules.

External code incorporated into VFLib is covered by separate licenses. See the licensing information and notes in the corresponding source files for copyright information and terms of use.

Integration

VFLib requires recent versions of JUCE. It won't work with versions 1.53 or earlier. To use the library it is necessary to first download JUCE to a location where your development environment can find it. Or, you can use your existing installation of JUCE.

This library uses the same modularized organizational structure as JUCE. To use a module, first add a path to the list of includes searched by your development environment or project, which points to the VFLib directory. Then, add the single corresponding .c or .cpp file to your existing project which already uses JUCE. For example, to use the vf_core module, add the file vf_core.cpp to your project. Some modules depend on other modules.

To use a module, include the appropriate header from within your source code. For example, to access classes in the vf_concurrent module, use this:

#include "modules/vf_concurrent/vf_concurrent.h"

Then add the corresponding file vf_concurrent.cpp to your build.

AppConfig

Some VFLib features can be controlled at compilation time through preprocessor directives. The available choices of compilation options are described in AppConfig.h, located in the AppConfigTemplate directory. Copy the provided settings into your existing AppConfig.h (a file used by JUCE convention).

License

This library contains portions of other open source products covered by separate licenses. Please see the corresponding source files for specific terms.

VFLib is provided under the terms of The MIT License (MIT):

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Some files contain portions of these external projects, licensed separately: