Skip to content

Latest commit

 

History

History
90 lines (63 loc) · 4.07 KB

README.md

File metadata and controls

90 lines (63 loc) · 4.07 KB

BRLN

A Free Software Synthesizer

Coverage Status License: GPL v3 Lines of Code GitHub issues GitHub issues-closed Average time to resolve an issue

Introduction

brln is a free software synthesizer published under the GPL v3 license. brln is implemented in C++14 and makes use of several libraries and frameworks such as libpd, pure-data, and rtaudio for the audio generation, Qt for the graphical user interface, and googletest for unit testing. This project makes use of CMake to insure a consistent development experience for developers on Windows, MacOS, and Linux for building, testing and packaging the software. Also, this project follows the Google's C++ style guide.

An image of the brln software synthesizer

brln started at the beginning of 2020 and is therefore still a very young project. Nevertheless the foundation is set for developing a fun synthesizer. The first version brln-0.1.0 consists of an application with a graphical user interface showing a knob which can change the output frequency of its pure-data patch. Feel free to contribute to the project by making pull requests e.g., raising issues or even making your own fork of the project. The project is primarily a fun project for educational purpose.

Building from Source

Prerequisites

In order to build from source you need to install some prerequisites on your machine such as Qt and potentially some audio libraries.

Install Qt

This project makes use of the Qt-framework so therefore you need to have Qt installed on your machine in order to build the project.

  • Ubuntu

    sudo apt-get install qt5-default
    
  • MacOS/Windows

    For installing Qt on your MacOS or Windows machine please go to the Official Qt Download.

Install ALSA/Jack on Ubuntu
sudo apt-get update -y
sudo apt-get install -y libjack-dev libasound2-dev
Install Jack on MacOS
brew install jack

Build the Project

After you have installed the prerequisites for your machine we can download the repository from the GitHub server and build it.

git clone https://github.com/etk70182/brln.git

Change the directory and make a new build directory in it so we can build out of source.

cd brln
mkdir build
cd build

As a next step configure the project depending on your machine, compiler, and build tool.

cmake ..

Afterwards compile it.

cmake --build .

Author

Credits

  • Pure Data by Miller Puckette and others
  • libpd by the Peter Brinkmann, Dan Wilcox and others
  • RtAudio by Gary P. Scavone and others
  • googletest by Google LLC
  • Qt by Digia
  • CMake by Andy Cedilnik, Bill Hoffman, Brad King, Ken Martin, Alexander Neundorf