WARNING: WORK IN PROGRESS. SOME SECTION MIGHT NOT HAVE ANY CONTENT OR ONLY A LIST WITH KEYWORDS FOR ME AS A TODO LIST.
A collection of examples & workflow tips related to the C++ library JUCE.
I started using JUCE because I wanted to make my own audio plugins and after doing a little bit research JUCE seemed to be the way to go.
Over the last couple of years, I have collected all of the resources related to JUCE that I could find. The list of bookmarked pages & code snippets have grown to quite a collection, so I decided to publish them as a cheat sheet for myself and everybody else who uses or wants to use JUCE.
I started with programming at the age of 10. C++ was my first and primary language for the first couple of years. I have since then used Python, JS & Golang. I currently studying computer science with a focus on embedded systems in Berlin.
I'm definitely not an expert in JUCE or C++. I do have a job as a C++ developer, but unfortunately not using JUCE. So if you find any problems in my examples, feel free to open an issue.
JUCE is published under a dual license, it is free for open source & small projects. You can find their license for JUCE 5 here.
All of my example code in this repository is published to the public domain under the Creative Commons CC0 1.0 license.
If you find any bugs or design problems in my examples feel free to open up an issue on GitHub.
If you want to add examples or resources to this collection you can either push a pull request directly or open up an issue first, if you have any questions. Please make sure that your topic is not already covered by one of the official JUCE tutorials. If you want to add to one of the official tutorials make sure you include a link to that page, so we can keep duplicate code as minimal as possible. Maintaining the same tutorial twice doesn't make much sense.
- JUCE >= C++14
- C++17 Features
- C++20 Features
- Focuses on Game & Graphics programming
- Good basic C++ concept videos
- CppCon, etc.
- BoostCon
- ACCU
- ...
- Inheritance
- virtual / override
- Lambdas
- Constexpr
- Smart Pointer (unique & shared)
- Container (vectors & arrays)
- noexcept where possible
- const where possible
- Visual Studio
- XCode
- Makefile
- Visual Studio Code
- CLion
- warnings are your friend
- clang from source
- cross platform different warnings
- old versions in distros
- Visual Studio
- from terminal/python script
- A must
- Pick a standard
- Visual Studio integration
- python script
Online compiler. Great for testing small code snippets. Does not currently have JUCE installed unfortunatly.
- gcc + gcov & lcov
- clang + llvm-profdata & llvm-cov
-
GCC & clang
- ASAN
- UBSAN
- MSAN
- TSAN
-
MSVC
- ASAN (32bit only)
- Makefile
- Shell scripts
- Projucer python bindings
- ConsoleApp
- GuiApp
- AudioApp
- Plugin
- Quick Setup
- Perfect IDE integration
- Hard to link external code/libraries
- Interface targets
- Binary builder
- AudioPluginHost
- IDE Integration
- git submodules
- living at head
- comments
- GitHub Pages
- Doxygen
- readthedocs
- Linux
- Dependencies
- Ubuntu
- Arch
- Fedora
- Raspberry PI
- clang-format
- clang-tidy
- Warnings
- Optimizations
- Basic Components
- Button
- Slider
- Label
- Combobox
- Projucer live build
- Tricks
- Animations
- LookAndFeel
- Colour IDs
- Override functions
- Look at JUCE implementations
- Custom components
- Look&Feel methods
- DSP module
- Gain example
- Compressor example
- AudioProcessor
- Plugins
- VST/AU
- ValueTree
- Parameters
- Undo
- Generic Editor
- Attachments
- Why
- Example
- Talk
- Record/Playback
- Sampler
- OSC
- Arduino
- Text for 3 examples
- How to use GLEW
- If not, how to get function pointers using
openglcontext.extensions.
- If not, how to get function pointers using
Small and definitely not complete list of 3rd party JUCE modules.
| Name | License | Description | Comment |
|---|---|---|---|
| ATK | BSD 3 | An audio digital processing toolbox | Haven't used yet. |
| FF Meters | BSD 3 | Plug and play component to display LED meters for JUCE audio buffers | Using it in modEQ. Love it. |
| Tracktion Engine | GPL/Commercial | A DAW framework | Haven't used yet. |
| Foleys Video Engine | GPL/Commercial | A video engine to load, play, assemble and write video | Haven't used yet. |
If you know of any other JUCE modules, fell free to open an issue so we cam add it to the list.
- How to run them in a plugin build
- Link against CMake shared code target
- Register tests
- CTest
- Download or build from source
- Run with maximum strictness (10)
- Test AU & VST
Explaining the concepts of continuous integration and continuous deployment is far out of scope for this document, but TLDR: CI helps you find problems in your code faster. Every time you push to your version control server of choice (e.g. GitHub or GitLab) builds on various platforms start up. For example in my plugin project modEQ, I have builds for Windows, macOS & Linux. Since all of the platforms are using different compilers I get different warnings on each. Fixing all those little things as you go will save you a lot of time compared to developing exclusively on one platform and then trying to release it for a additional platform at the end.
There are many CI services online for free if your project is publicly available on GitHub or other platforms. I will focus on travis-ci and appveyor because those to combined will cover all desktop platforms JUCE supports (Windows, macOS & Linux).
- basics
- install deps
- Linux fake xorg
- platform matrix
- push to gh-pages
- run pluginval
- full example
- basic example
- matrix
- full example
- docs
- app/plugin
- GitHub releases
- zip
- installer/package
- FreeBSD support (Working on it, see tobanteAudio/juce-freebsd-example)
- Build system (solved in JUCE6)
- CMake
- Multiple targets in one project
- Better Graphics API integration
- Metal (coming in JUCE6)
- Vulkan
- Read the docs
- Read the source
- Read other app written in JUCE
- modEQ
- helm
- temper
- Faust
- YouTube
std::audio