Merge pull request #70 from meownoid/main

JUCE 8, ARM64 support, dependency cleanup

Author: ArdenButterfield

.gitignore

@@ -1,73 +1,69 @@
-# Juce stuff
-Maim/Builds
-Maim/JuceLibraryCode
-Maim/maim\ audiohost\ setup.filtergraph
+# Build outputs
+Builds/
+cmake-build-*/
+packaging/build/
+packaging/plugins/
 
+# IDE
+.idea/
 
-cmake-build-*
-Packages.dmg
-.idea
-packaging/build
-packaging/plugins
-**.dmg
+# Packaging artifacts
+*.dmg
 
-# Audio stuff
+# Audio assets (except bundled assets)
 **/*.wav
 **/*.mp3
 **/*.flac
 !assets/*.wav
 
-# Prerequisites
+# Compiled files
 *.d
-
-# Compiled Object files
-*.slo
-*.lo
-**/*.o
-**/*.a
+*.o
 *.obj
-
-# Precompiled Headers
-*.gch
-*.pch
-
-# Compiled Dynamic libraries
+*.lo
+*.slo
+*.la
+*.lai
+*.a
+*.lib
 *.so
 *.dylib
 *.dll
+*.exe
+*.out
+*.app
+
+# Precompiled headers
+*.gch
+*.pch
 
 # Fortran module files
 *.mod
 *.smod
 
-# Compiled Static libraries
-*.lai
-**/*.la
-**/*.a
-*.lib
+# Debug symbols
+*.dSYM
 
-# Executables
-*.exe
-*.out
-*.app
-Maim/lib/lame/frontend/lame
-Maim/lib/blade/bladeenc/bladeenc
+# LAME generated build artifacts
+lib/lame/**/Makefile
+lib/lame/**/*.Po
+lib/lame/**/*.Plo
+lib/lame/**/*.deps
+lib/lame/config.h
+lib/lame/config.log
+lib/lame/config.status
+lib/lame/libtool
+lib/lame/stamp-h1
+lib/lame/lame.spec
+lib/lame/frontend/lame
 
-# misc
-**/.DS_Store
-**/*.asd
-**/*.dSYM
-Maim/lib/blade/test
+# Blade generated build artifacts
+lib/blade/bladeenc/bladeenc
+lib/blade/test
 
-# lame stuff
-/Source/lib/lame/**/Makefile
-/Source/lib/lame/**/*.Po
-/Source/lib/lame/**/*.Plo
-Source/lib/lame/config.log
-Source/lib/lame/config.h
-Source/lib/lame/config.status
-Source/lib/lame/libtool
+# Python virtual environments
+venv/
 
-venv
-Source/lib/lame/stamp-h1
-Source/lib/lame/lame.spec
+# OS / editor noise
+.DS_Store
+*.asd

.gitmodules

@@ -8,7 +8,7 @@
 	url = https://github.com/free-audio/clap-juce-extensions.git
 	branch = main
 [submodule "opus"]
-	path = opus
+	path = lib/opus
 	url = https://github.com/xiph/opus.git
 [submodule "cmake"]
     path = "cmake"

CMakeLists.txt

@@ -38,7 +38,7 @@ project(${PROJECT_NAME} VERSION ${CURRENT_VERSION})
 
 set(LAMELIBRARYPATH "${CMAKE_CURRENT_SOURCE_DIR}/${LAME_LIB}")
 
-add_subdirectory(opus)
+add_subdirectory(lib/opus)
 
 # Couple tweaks that IMO should be JUCE defaults
 include(JUCEDefaults)
@@ -107,7 +107,7 @@ target_sources(SharedCode INTERFACE ${SourceFiles})
 target_include_directories(SharedCode
         INTERFACE
         lib/lame/include
-        ${CMAKE_SOURCE_DIR}/opus/include
+        ${CMAKE_SOURCE_DIR}/lib/opus/include
         lib/blade/bladeenc
 )
 
@@ -127,9 +127,6 @@ target_compile_definitions(SharedCode
         JUCE_USE_CURL=0     # If you set this to 1, add `NEEDS_CURL TRUE` to the `juce_add_plugin` call
         JUCE_VST3_CAN_REPLACE_VST2=0
 
-        # Uncomment if you are paying for a an Indie/Pro license or releasing under GPLv3
-        JUCE_DISPLAY_SPLASH_SCREEN=0
-
         # lets the app known if we're Debug or Release
         CMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}"
         VERSION="${CURRENT_VERSION}"
@@ -157,6 +154,7 @@ target_link_libraries(SharedCode
         "${LAMELIBRARYPATH}"
         opus
         blade_library
+        juce_audio_formats
         juce_audio_utils
         juce_audio_processors
         juce_dsp

Docs/BUILDING.md

@@ -8,32 +8,44 @@ We figured out the steps, so you don't have to.
 ### Prerequisites:
 * [CMake version >= 3.24.1](https://cmake.org/download/) (This link actually takes you to the latest version)
 * ninja
-* ccache (Ensure that ccache is actually on the path: `which g++ gcc` should return `/usr/lib/ccache/g++ /usr/lib/ccache/gcc`.)
+* pkg-config (`sudo apt-get install pkg-config`)
+* JUCE's Linux dependencies:
+  ```sh
+  sudo apt-get install libasound2-dev libfontconfig1-dev libfreetype6-dev \
+    libx11-dev libxcomposite-dev libxcursor-dev libxinerama-dev libxrandr-dev \
+    libgl1-mesa-dev
+  ```
 
 ### Steps:
 
 1. Clone the repository, making sure to use `--recurse-submodules` to clone JUCE as well.
 
 ```sh
 git clone --recurse-submodules https://github.com/ArdenButterfield/Maim
+cd Maim
 ```
 
 2. Build Lame. This project includes a quirked up version of [LAME](https://lame.sourceforge.io/), 
-3. so even if you have LAME installed already, you still need to do this step.
+so even if you have LAME installed already, you still need to do this step.
 
 ```sh
-cd Maim/Source/lib/lame/
-./configure CFLAGS="-fPIC"  --disable-frontend --enable-expopt=full --disable-shared --enable-static
+cd lib/lame/
+./configure CFLAGS="-fPIC" --disable-frontend --enable-expopt=full --disable-shared --enable-static
 make
-cd ../../..
+cd ../..
 ```
 
+If `./configure` fails to detect your system type, add an explicit build triplet:
+
+- x86_64: `--build=x86_64-linux-gnu`
+- ARM64: `--build=aarch64-linux-gnu`
+
 Optionally, add `--enable-debug` to the `configure` command, to compile with `-g`.
 
 3. Build the plugin. You can change `Release` to `Debug` in both lines to change the build configuration to one without optimization.
 
 ```sh
-cmake -B Builds -G Ninja -DLAME_LIB=Source/lib/lame/libmp3lame/.libs/libmp3lame.a -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64"
+cmake -B Builds -G Ninja -DLAME_LIB=lib/lame/libmp3lame/.libs/libmp3lame.a -DCMAKE_BUILD_TYPE=Release
 cmake --build Builds --config Release
 ```
 
@@ -47,30 +59,44 @@ Note that the configure command when building Lame is slightly different from in
 ### Prerequisites:
 * [CMake version >= 3.24.1](https://cmake.org/download/) (This link actually takes you to the latest version)
 * ninja
-* ccache (Ensure that ccache is actually on the path: `which g++ gcc` should return `/usr/local/opt/ccache/libexec/g++ /usr/local/opt/ccache/libexec/gcc
-  `, or something similar.)
 
 ### Steps:
 
 1. Clone the repository, making sure to use `--recurse-submodules` to clone JUCE as well.
 
 ```sh
 git clone --recurse-submodules https://github.com/ArdenButterfield/Maim
+cd Maim
 ```
 
 2. Build Lame. This project includes a quirked up version of [LAME](https://lame.sourceforge.io/), so even if you have LAME installed already, you still need to do this step.
 
+For an Apple Silicon-only build:
+
 ```sh
-cd Maim/Source/lib/lame/
-./configure CFLAGS="-arch x86_64 -arch arm64 -fPIC"  --disable-frontend --enable-expopt=full --disable-shared --enable-static
+cd lib/lame/
+./configure CFLAGS="-fPIC -mmacosx-version-min=11.0" \
+  --disable-frontend --enable-expopt=full --disable-shared --enable-static
 make
-cd ../../..
+cd ../..
 ```
 
+If you want a universal binary for both `arm64` and `x86_64`, build LAME with universal flags instead:
+
+```sh
+./configure CFLAGS="-arch x86_64 -arch arm64 -fPIC -mmacosx-version-min=10.13" \
+  --disable-frontend --enable-expopt=full --disable-shared --enable-static
+make
+```
+
+Then use `-DCMAKE_OSX_ARCHITECTURES="arm64;x86_64"` in the CMake command below.
+
+Optionally, add `--enable-debug` to the `configure` command, to compile with `-g`.
+
 3. Build the plugin. You can change `Release` to `Debug` in both lines to change the build configuration to one without optimization.
 
 ```sh
-cmake -B Builds -G Ninja -DLAME_LIB=Source/lib/lame/libmp3lame/.libs/libmp3lame.a -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64"
+cmake -B Builds -G Ninja -DLAME_LIB=lib/lame/libmp3lame/.libs/libmp3lame.a -DCMAKE_BUILD_TYPE=Release -DCMAKE_OSX_ARCHITECTURES=arm64
 cmake --build Builds --config Release
 ```
 
@@ -96,23 +122,23 @@ curl --output oneapi.exe https://registrationcenter-download.intel.com/akdlm/irc
 
 2. Clone the repo with `git clone --recurse-submodules https://github.com/ArdenButterfield/Maim` (Recursive to make sure git clone also hits JUCE).
 
-3. Inside your local project, navigate to `Source/lib/lame`. (This is a quirked up version of [LAME](https://lame.sourceforge.io/) included in the project, so even if you have LAME already installed, you still need to do this step.)
+3. Inside your local project, navigate to `lib/lame`. (This is a quirked up version of [LAME](https://lame.sourceforge.io/) included in the project, so even if you have LAME already installed, you still need to do this step.)
 
 4. Copy the file called `configMS.h` into `libmp3lame/config.h` (you would presumably copy one of the other config files if you were on a different OS).
 
 5. Launch the command window `x64 Native Tools Command Prompt for VS 2022` which you can find from the start menu if you have Build Tools for Visual Studio 2022 installed.
 
-6. Inside the command window, run `cd [Path to root directotry of local project]/Source/lib/lame`.
+6. Inside the command window, run `cd [Path to root directory of local project]\lib\lame`.
 
 7. Then run `nmake dll -f Makefile.MSVC comp=msvc asm=n`.
 
-8. Hopefully the build should succeed, and you can now see the built file `Source/lib/lame/output/libmp3lame-static.lib`.
+8. Hopefully the build should succeed, and you can now see the built file `lib/lame/output/libmp3lame-static.lib`.
 
 9. Before we open up the project in CLion, there's even more hoops we need to jump through. (Isn't that what you wanted to hear?) CLion must be run with administrator privileges to install the VST file correctly. If you installed CLion yourself, then you can probably right-click, "Run as Administrator". If you installed CLion through JetBrains Toolbox, click on the vertical dots next to CLion in the list, click "Settings" in the dropdown, the click on "Configuration". Toggle "Run as administrator".
 
 10. Open up the project in CLion. It's gonna start trying to load the CMake project and there's going to be errors because we need to change the CMake settings first.
 
-11. Go to `File | Settings | Build, Execution, Deployment | CMake`. In the `CMake options:` field, place in `-DLAME_LIB=Source\lib\lame\output\libmp3lame-static.lib`, the path to our built file.
+11. Go to `File | Settings | Build, Execution, Deployment | CMake`. In the `CMake options:` field, place in `-DLAME_LIB=lib\lame\output\libmp3lame-static.lib`, the path to our built file.
 
 12. Now reload the CMake project.
 
@@ -127,4 +153,4 @@ curl --output oneapi.exe https://registrationcenter-download.intel.com/akdlm/irc
 
 ### Notes:
 
-* If the build fails and you get a message like `file INSTALL cannot set permissions on "C:\Program Files\Common File/VSt3/Maim.vst3": Permission denied.`, it might be for two reasons. The first is that you didn't follow my instructions on giving the build adminsitrator privileges. The second is because your audio workstation is currently using the previously built VST file. You have to close it to rebuild.
+* If the build fails and you get a message like `file INSTALL cannot set permissions on "C:\Program Files\Common File/VSt3/Maim.vst3": Permission denied.`, it might be for two reasons. The first is that you didn't follow my instructions on giving the build administrator privileges. The second is because your audio workstation is currently using the previously built VST file. You have to close it to rebuild.