Warning

This is still in heavy development, use this at your own risk. Many things are still not working as expected, and some of the code formatting is still off. Namely the gui module will not work in its current state.

Note

This repository is still in beta, it is not advisable to use it in production just yet.

Introduction

JUCE, a wonderful framework, a vast collection of amazing tools.
It's main focus has always been on audio, but lately evolved into much more than just for sound engineers; everyone can do almost everything with it and it constantly grows bigger and bigger.

However, it hasn't got everything and many many cool things it provides aren't that super duper great thing everyone is craving or just isn't there to begin with.
This is the reason why this module-bundle came to exist.

Jaut aims at developers that are missing that feeling of completeness and don't like to bother too much with adding more and more 3rd Party externals just to get one thing going.
All we try to accomplish is a central collection of useful stuff.

Motivation

The origin-story of this collection couldn't be any more trivial. During work on some projects, I came to realise that most of the things that flow into any of them are not unique cases.
A lot of the used stuff might be used in the next project, and the next, and the... you get the gist.

So wouldn't it be a wonderful thing if all these projects had some sort of anchor-point?
Is there a way to, such that I don't have to copy everything over and over again?
Well, I love to break it to you:
A big fat YES; the answer is a common toolset.

Structure

At first sight, it might be a bit complicated to look over this bundle's structure, however, soon you will find out it is not that big of a deal.
So let's have a deep dive into the various folders and bits this repo is comprised of.¹

Folders

This project comes with plenty of files and folders, so it's no surprise that some of them might not be that obvious to decipher, but most of them should be familiar to you.
Most of the files in the root folder are just repository description files or only relate to the tooling of the project like configuration, analysis and workflow files.

• /cmake
  Main entry point for CMake scripts the project uses, all files inside this folder will be .cmake files used by the project.

  • /
    Contains all build and project related CMake scripts like find() related module definitions, install scripts, package definitions ect.
  • /tools
    Additional CMake scripts that are not used but provided by this package; to be used on the user side of things

• /docs
  Serving all documentation related needs for this repository.

  • /doxygen
    Any Doxygen related files and scripts needed to generate the source reference of this bundle.

• /examples
  Providing a set of examples, showcasing how some of the things are used and how you can use them too the best way possible.

• /modules
  The actual source code, split across several JUCE Modules. This will be the most important folder and where to look when you need something specific code-wise.

  See: Modules

• /resources
  Assets this some of this project's tools use to function properly or provide additional features.

• /test
  Testing facilities for this bundle, you probably won't ever need to open this folder except if you want to take inspiration on how to use things if the provided examples didn't fit your needs.

Modules

Of course, there is also the main focus of this repositories, our modules.
By now you should know what JUCE Modules are, if not don't worry, you can still use them without knowing how to create them.

Module	Description	Full name
Core	Core functionality of jaut.	jaut_core
Audio	Various processing and dsp related classes.	jaut_audio
Message	Tools for simple message passing management.	jaut_message
Provider	Defines classes for advanced data management like configurations and folder management.	jaut_provider
Logger	Defines facilities to log to different outputs in different ways and formats.	jaut_logger
Gui	Gui related utils.	jaut_gui
Dummy	Jaut dummy module for unit testing purposes, you won't likely need this, sooo... just ignore it.	jaut_dummy

You will also notice that the JUCE module format defines versions for each and every module, but we will just leave them at 1.0.0 regardless.
You can just ignore them and live on as if they weren't here, as we already have the bundle versioning.

Installation

The entire bundle is backed by a CMake Module, so there is not much to do.
However, you will still need to be aware of one or the other thing.

Setup

CMake

Note

This does note yet provide an actual CMake module that you can use with CMake's find_package().
But in future this will all be settled.

Linking

It couldn't be any easier, thanks to the JUCE Module Format, all you need to do is adding this bundle as a subdirectory. (after adding JUCE)
You can then selectively link the module, you want to use, to your target:

add_subdirectory(path/to/jaut)
target_link_libraries(YourTarget
    VISIBILITY
        jaut::jaut_core
        jaut::jaut_gui
        # ect.
        )

Options

There are also a few additional options provided with this CMake module that you can use to build/configure the process.

Name	Description	Default
JAUT_BUILD_TESTS	Build unit tests for the Jaut bundle	OFF
JAUT_BUILD_EXAMPLES	Build examples for the Jaut bundle	OFF
JAUT_CLONE_JUCE	Whether JUCE should be cloned for Jaut specifically, this will majorly be used for standalone builds of the module bundle like testing or development	OFF

Projucer

Add the module of interest to the module section of the Projucer. (the little '+' in the corner of the module list)

Dependencies

JUCE

Since this repository is a juce module-bundle, it is just natural to fetch JUCE first before doing anything with it.
Learn more here:
https://github.com/juce-framework/juce

Integrated

Some of the dependencies that this module bundle requires are directly embedded into the modules. The following dependencies are hardwired into the codebase:

• FMT
  Homepage: https://github.com/fmtlib/fmt
  Path: modules/jaut_logger/detail
  Provides the logging module with additional and optional formatting capabilities.

• MS SafeInt
  Homepage: https://github.com/dcleblanc/SafeInt
  Path: modules/jaut_core/detail/
  Provides the capability of dealing with integer overflows, mainly used in the core module by the jaut::Number class.

Optionals

There is also a few optional libraries that are used to enable a subset of additional functionality. These are not necessary but needed when making use of these tools.

• yaml-cpp
  Homepage: https://github.com/jbeder/yaml-cpp
  Depends: jaut::YamlParser
  Provides the JAUT configuration tools with a yaml parser.

Usage

Since Jaut is a bigger collection of tools and utilities, it wouldn't make much sense to give details about every single thing in this section. Thankfully, this repository also provides a wiki and a reference which sheds some light on the individual parts of this toolset which both can be found here:

• Wiki
• Documentation

Also take a look at the examples and test folders for indicators on how to possibly use a tool.

Known Issues

Here is a list of major known issues with this module bundle that take some more time to fix or can't be fixed due to limitations:

Description	Comment	Issue
Module jaut_gui does not work	This is a major issue that is currently being worked on and will likely be fixed with any of the next bundle updates. For now it's best to ignore this module and focus on the other ones instead.	#2

License

Jaut

You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.

FMT & MS SafeInt

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.

Contact

If you need more information or would like to contact us, you can find us on our Discord:

Footnotes

1. Any of these things are subjects to change. It is best to keep that in mind and stay tuned. ↩