Initial introduction of the yup_dsp module

Author: kunitoki

.github/workflows/build_linux.yml

@@ -8,6 +8,7 @@ on:
       - "**/cmake/**"
       - "**/examples/**"
       - "**/modules/**"
+      - "**/python/**"
       - "**/tests/**"
       - "**/thirdparty/**"
       - "!**/native/generated/**"

.github/workflows/build_macos.yml

@@ -8,6 +8,7 @@ on:
       - "**/cmake/**"
       - "**/examples/**"
       - "**/modules/**"
+      - "**/python/**"
       - "**/tests/**"
       - "**/thirdparty/**"
       - "!**/native/generated/**"

.github/workflows/build_windows.yml

@@ -8,6 +8,7 @@ on:
       - "**/cmake/**"
       - "**/examples/**"
       - "**/modules/**"
+      - "**/python/**"
       - "**/tests/**"
       - "**/thirdparty/**"
       - "!**/native/generated/**"
@@ -36,9 +37,11 @@ jobs:
     - run: cmake --build ${{ runner.workspace }}/build --config Debug --parallel 4 --target yup_tests
     - working-directory: ${{ runner.workspace }}/build/tests/Debug
       run: ./yup_tests.exe
+      shell: bash
     - run: cmake --build ${{ runner.workspace }}/build --config Release --parallel 4 --target yup_tests
     - working-directory: ${{ runner.workspace }}/build/tests/Release
       run: ./yup_tests.exe
+      shell: bash
 
   build_console:
     runs-on: windows-latest

guidelines.md CLAUDE.mdguidelines.md renamed to CLAUDE.md

@@ -296,7 +296,8 @@ TEST (ClassNameTests, StaticMethodBehavesCorrectly)
 4. **Group related tests** in test fixtures
 5. **Keep tests independent** and deterministic
 6. **Never Use C or C++ macros (like M_PI)** use yup alternatives
-7. **ALWAYS and EXCLUSIVELY use `just test`** to compile and execute tests
+7. **EXCLUSIVELY use `just test`** to compile and execute tests
+8. **NEVER start compilation or tests** unless told explicitly
 
 ### When suggesting refactoring:
 1. **Maintain existing API contracts**
@@ -358,9 +359,12 @@ Before suggesting code, verify:
 - [ ] Allman-style braces throughout
 - [ ] Consistent naming conventions
 - [ ] Proper include order and guards
-- [ ] const-correctness where applicable
+- [ ] Const-correctness whenever applicable
+- [ ] Prefer flatter code and early exits over overly indented code
+- [ ] Aim at simplifying and removing duplicated code, prefer removing rather than adding
+- [ ] When changing implementation, don't copy it and change it, adapt the existing or remove the old one once the new is in place and working
 - [ ] Platform-specific code properly guarded
-- [ ] Tests cover the new functionality
+- [ ] Proper TDD and ensure tests cover new functionality
 - [ ] No memory leaks (prefer RAII/smart pointers)
 - [ ] Thread safety considerations if applicable
 - [ ] Documentation for public APIs
@@ -393,4 +397,11 @@ void processText (const yup::String& text);
 // Use std::string only when interfacing with non-YUP code
 ```
 
+## Differences with JUCE
+
+- We use American english in YUP, so it's `center` and not `centred`, or `Color` and not `Colour`
+- Always check the available API in the Graphics class, don't assume we use JUCE Graphics classes
+- Graphics primitives have a template `.to<float>` method not `toFloat`
+- Fonts are obtained via ApplicationTheme, don't try to instantiate fonts inline
+
 This document should be referenced for every code generation, review, and suggestion task in the YUP project.

README.md

@@ -1,15 +1,26 @@
 # YUP: Cross-Platform Application And Plugin Development Library
 
-<p float="left">
+<div style="display: flex; width: 100%; flex-wrap: nowrap;">
   <a href="https://kunitoki.github.io/yup/demos/web_render_0/" title="UI courtesy from https://www.drywestdesign.com/">
-    <img src="./docs/demos/web_render_0.png" width="99%" /></a>
-<p>
-
-<p float="left">
-  <a href="https://kunitoki.github.io/yup/demos/web_render_1/"><img src="./docs/demos/web_render_1.png" width="24%" /></a>
-  <a href="https://kunitoki.github.io/yup/demos/web_render_2/"><img src="./docs/demos/web_render_2.png" width="24%" /></a>
-  <a href="https://kunitoki.github.io/yup/demos/web_render_3/"><img src="./docs/demos/web_render_3.png" width="24%" /></a>
-  <a href="https://kunitoki.github.io/yup/demos/web_render_4/"><img src="./docs/demos/web_render_4.png" width="23%" /></a>
+    <img src="./docs/demos/web_render_0.png" style="width:100%" /></a>
+</div>
+
+<div style="display: flex; width: 100%; flex-wrap: nowrap;">
+  <a href="https://kunitoki.github.io/yup/demos/web_render_1/"><img src="./docs/demos/web_render_1.png" style="width:24.25%;" /></a>
+  <a href="https://kunitoki.github.io/yup/demos/web_render_2/"><img src="./docs/demos/web_render_2.png" style="width:24.25%;" /></a>
+  <a href="https://kunitoki.github.io/yup/demos/web_render_3/"><img src="./docs/demos/web_render_3.png" style="width:24.25%;" /></a>
+  <a href="https://kunitoki.github.io/yup/demos/web_render_4/"><img src="./docs/demos/web_render_4.png" style="width:24.25%;" /></a>
+</div>
+
+<div style="display: flex; width: 100%; flex-wrap: nowrap;">
+  <a href="./examples/graphics/source/examples/FilterDemo.h"><img src="./docs/images/yup_dsp_filter_rbj.png" style="width:27%;" /></a>
+  <a href="./examples/graphics/source/examples/FilterDemo.h"><img src="./docs/images/yup_dsp_filter_butter.png" style="width:27%;" /></a>
+  <a href="./examples/graphics/source/examples/CrossoverDemo.h"><img src="./docs/images/yup_dsp_crossover.png" style="width:44%;" /></a>
+</div>
+
+<div style="display: flex; width: 100%; flex-wrap: nowrap;">
+  <a href="./examples/graphics/source/examples/SpectrumAnalyzer.h"><img src="./docs/images/yup_dsp_spectrum_fill.png" style="width:100%;" /></a>
+  <a href="./examples/graphics/source/examples/SpectrumAnalyzer.h"><img src="./docs/images/yup_dsp_spectrum_line.png" style="width:100%;" /></a>
 </p>
 
 Example Rive animation display ([source code](./examples/render/source/main.cpp)):
@@ -35,6 +46,10 @@ YUP is an open-source library dedicated to empowering developers with advanced t
 > The project is still in embryonic stage, use it at your own risk!
 
 
+> [!IMPORTANT]
+> We are looking for collaborators to bring forward the framework!
+
+
 ## Features
 YUP brings a suite of powerful features, including:
 - **High-Performance Rendering:** From intricate visualizations to high-speed gaming graphics, YUP handles it all with ease and efficiency, relying on the open source [Rive](https://rive.app/) Renderer, backed by Metal, Direct3D, OpenGL, Vulkan and WebGPU.
@@ -320,9 +335,6 @@ For full documentation, including more detailed tutorials and comprehensive API
 Join our growing community and contribute to the YUP project. Connect with us and other YUP developers:
 - **GitHub:** [YUP Repository](https://github.com/kunitoki/yup)
 
-> [!IMPORTANT]
-> We are looking for collaborators to bring forward the framework!
-
 
 ## License
 YUP is distributed under the ISC License, supporting both personal and commercial use, modification, and distribution without restrictions.

cmake/yup_dependencies.cmake

@@ -142,3 +142,26 @@ macro (_yup_fetch_python use_static_libs modules)
         find_package (Python REQUIRED COMPONENTS ${modules})
     endif()
 endmacro()
+
+#==============================================================================
+
+function (_yup_find_fftw3 target_name)
+    if (TARGET PkgConfig::FFTW AND TARGET FFTW::Float)
+    else()
+        find_package (PkgConfig REQUIRED)
+        pkg_check_modules (FFTW IMPORTED_TARGET REQUIRED fftw3)
+        find_library (FFTWF_LIB NAMES "fftw3f" PATHS ${PKG_FFTW_LIBRARY_DIRS} ${LIB_INSTALL_DIR})
+
+        if (FFTWF_LIB)
+            add_library (FFTW::Float INTERFACE IMPORTED)
+            set_target_properties (FFTW::Float
+                PROPERTIES INTERFACE_INCLUDE_DIRECTORIES "${FFTW_INCLUDE_DIRS}"
+                INTERFACE_LINK_LIBRARIES "${FFTWF_LIB}")
+        else()
+            _yup_message (FATAL_ERROR "FFTW3 library not found")
+        endif()
+    endif()
+
+    target_include_directories (${target_name} PRIVATE PkgConfig::FFTW)
+    target_link_libraries (${target_name} PRIVATE FFTW::Float)
+endfunction()

cmake/yup_modules.cmake

@@ -67,7 +67,7 @@ function (_yup_module_collect_sources folder output_variable)
     set (base_path "${folder}/${module_name}")
     set (all_module_sources "")
 
-    foreach (extension ${source_extensions})
+    foreach (extension IN LISTS source_extensions)
         file (GLOB found_source_files "${base_path}*${extension}")
 
         if (NOT YUP_PLATFORM_MSFT)
@@ -118,7 +118,7 @@ function (_yup_module_collect_sources folder output_variable)
     endforeach()
 
     set (module_sources "")
-    foreach (module_source ${all_module_sources})
+    foreach (module_source IN LISTS all_module_sources)
         if (APPLE)
             if (module_source MATCHES "^.*\.(cc|cxx|cpp)$")
                 get_filename_component (source_directory ${module_source} DIRECTORY)
@@ -146,11 +146,11 @@ endfunction()
 
 function (_yup_module_prepare_frameworks frameworks weak_frameworks output_variable)
     set (temp_frameworks "")
-    foreach (framework ${frameworks})
+    foreach (framework IN LISTS frameworks)
         list (APPEND temp_frameworks "-framework ${framework}")
     endforeach()
 
-    foreach (framework ${weak_frameworks})
+    foreach (framework IN LISTS weak_frameworks)
         list (APPEND temp_frameworks "-weak_framework ${framework}")
     endforeach()
 
@@ -345,7 +345,7 @@ function (yup_add_module module_path modules_definitions module_group)
     set (platform_properties "^(.*)Deps$|^(.*)Defines$|^(.*)Libs$|^(.*)Frameworks$|^(.*)WeakFrameworks$|^(.*)Options$|^(.*)LinkOptions$|^(.*)Packages$|^(.*)Searchpaths$|^(.*)CppStandard$")
 
     set (parsed_config "")
-    foreach (module_config ${module_configs})
+    foreach (module_config IN LISTS module_configs)
         string (REGEX REPLACE "^(.+):[ \t\r\n]+(.+)$" "\\1;\\2" parsed_config ${module_config})
         list (GET parsed_config 0 key)
         list (LENGTH parsed_config parsed_config_len)
@@ -452,7 +452,7 @@ function (yup_add_module module_path modules_definitions module_group)
         list (APPEND module_link_options ${module_linuxLinkOptions})
         _yup_resolve_variable_paths ("${module_linuxSearchpaths}" module_linuxSearchpaths)
         list (APPEND module_searchpaths ${module_linuxSearchpaths})
-        foreach (package ${module_linuxPackages})
+        foreach (package IN LISTS module_linuxPackages)
             _yup_get_package_config_libs ("${package}" package_libs)
             list (APPEND module_libs ${package_libs})
         endforeach()
@@ -505,15 +505,15 @@ function (yup_add_module module_path modules_definitions module_group)
     endif()
 
     # ==== Add module definitions
-    foreach (module_definition ${modules_definitions})
+    foreach (module_definition IN LISTS modules_definitions)
         list (APPEND module_defines ${module_definition})
     endforeach()
 
     # ==== Prepare include paths
     get_filename_component (module_include_path ${module_path} DIRECTORY)
     list (APPEND module_include_paths "${module_include_path}")
 
-    foreach (searchpath ${module_searchpaths})
+    foreach (searchpath IN LISTS module_searchpaths)
         if (EXISTS "${searchpath}")
             list (APPEND module_include_paths "${searchpath}")
         elseif (EXISTS "${module_path}/${searchpath}")
@@ -619,30 +619,47 @@ macro (yup_add_default_modules modules_path)
     yup_add_module (${modules_path}/thirdparty/rive_decoders "${modules_definitions}" ${thirdparty_group})
     yup_add_module (${modules_path}/thirdparty/rive_renderer "${modules_definitions}" ${thirdparty_group})
     yup_add_module (${modules_path}/thirdparty/oboe_library "${modules_definitions}" ${thirdparty_group})
+    yup_add_module (${modules_path}/thirdparty/pffft_library "${modules_definitions}" ${thirdparty_group})
+    yup_add_module (${modules_path}/thirdparty/dr_libs "${modules_definitions}" ${thirdparty_group})
 
     # ==== Yup modules
     set (modules_group "Modules")
     yup_add_module (${modules_path}/modules/yup_core "${modules_definitions}" ${modules_group})
     add_library (yup::yup_core ALIAS yup_core)
+
     yup_add_module (${modules_path}/modules/yup_events "${modules_definitions}" ${modules_group})
     add_library (yup::yup_events ALIAS yup_events)
+
     yup_add_module (${modules_path}/modules/yup_data_model "${modules_definitions}" ${modules_group})
     add_library (yup::yup_data_model ALIAS yup_data_model)
+
+    yup_add_module (${modules_path}/modules/yup_dsp "${modules_definitions}" ${modules_group})
+    add_library (yup::yup_dsp ALIAS yup_dsp)
+
+    yup_add_module (${modules_path}/modules/yup_graphics "${modules_definitions}" ${modules_group})
+    add_library (yup::yup_graphics ALIAS yup_graphics)
+
+    yup_add_module (${modules_path}/modules/yup_gui "${modules_definitions}" ${modules_group})
+    add_library (yup::yup_gui ALIAS yup_gui)
+
     yup_add_module (${modules_path}/modules/yup_audio_basics "${modules_definitions}" ${modules_group})
     add_library (yup::yup_audio_basics ALIAS yup_audio_basics)
+
     yup_add_module (${modules_path}/modules/yup_audio_devices "${modules_definitions}" ${modules_group})
     add_library (yup::yup_audio_devices ALIAS yup_audio_devices)
+
+    yup_add_module (${modules_path}/modules/yup_audio_formats "${modules_definitions}" ${modules_group})
+    add_library (yup::yup_audio_formats ALIAS yup_audio_formats)
+
     yup_add_module (${modules_path}/modules/yup_audio_processors "${modules_definitions}" ${modules_group})
     add_library (yup::yup_audio_processors ALIAS yup_audio_processors)
-    yup_add_module (${modules_path}/modules/yup_audio_plugin_client "${modules_definitions}" ${modules_group})
-    add_library (yup::yup_audio_plugin_client ALIAS yup_audio_plugin_client)
-    yup_add_module (${modules_path}/modules/yup_graphics "${modules_definitions}" ${modules_group})
-    add_library (yup::yup_graphics ALIAS yup_graphics)
-    yup_add_module (${modules_path}/modules/yup_gui "${modules_definitions}" ${modules_group})
-    add_library (yup::yup_gui ALIAS yup_gui)
+
     yup_add_module (${modules_path}/modules/yup_audio_gui "${modules_definitions}" ${modules_group})
     add_library (yup::yup_audio_gui ALIAS yup_audio_gui)
 
+    yup_add_module (${modules_path}/modules/yup_audio_plugin_client "${modules_definitions}" ${modules_group})
+    add_library (yup::yup_audio_plugin_client ALIAS yup_audio_plugin_client)
+
     if (YUP_ARG_ENABLE_PYTHON)
         if (NOT YUP_BUILD_WHEEL)
             set (python_modules "Interpreter;Development.Embed")

cmake/yup_python.cmake

@@ -35,19 +35,34 @@ function (yup_prepare_python_stdlib target_name python_tools_path output_variabl
 
     set (python_standard_library "${CMAKE_CURRENT_BINARY_DIR}/python${Python_VERSION_MAJOR}${Python_VERSION_MINOR}.zip")
 
+    if (YUP_PLATFORM_WINDOWS)
+        set (python_version_string "${Python_VERSION_MAJOR}.${Python_VERSION_MINOR}.${Python_VERSION_PATCH}")
+        set (python_embeddable_url "https://www.python.org/ftp/python/${python_version_string}/python-${python_version_string}-embed-amd64.zip")
+        FetchContent_Declare (python_embed_env URL ${python_embeddable_url})
+        if (NOT python_embed_env_POPULATED)
+            FetchContent_Populate(python_embed_env)
+        endif()
+
+        get_filename_component (python_root_path "${python_embed_env_SOURCE_DIR}" REALPATH)
+    else()
+        get_filename_component (python_root_path "${Python_LIBRARY_DIRS}" REALPATH)
+    endif()
+
     _yup_message (STATUS "Executing python stdlib archive generator tool")
     _yup_message (STATUS " * CMAKE_CURRENT_BINARY_DIR: ${CMAKE_CURRENT_BINARY_DIR}")
     _yup_message (STATUS " * Python_EXECUTABLE: ${Python_EXECUTABLE}")
     _yup_message (STATUS " * Python_LIBRARY_DIRS: ${Python_LIBRARY_DIRS}")
     _yup_message (STATUS " * Python_VERSION_MAJOR: ${Python_VERSION_MAJOR}")
     _yup_message (STATUS " * Python_VERSION_MINOR: ${Python_VERSION_MINOR}")
+    _yup_message (STATUS " * Python_VERSION_PATCH: ${Python_VERSION_PATCH}")
+    _yup_message (STATUS " * python_root_path: ${python_root_path}")
     _yup_message (STATUS " * python_tools_path: ${python_tools_path}")
     _yup_message (STATUS " * ignored_library_patterns: ${ignored_library_patterns}")
 
     execute_process (
         COMMAND
             "${Python_EXECUTABLE}" "${python_tools_path}/ArchivePythonStdlib.py"
-                -l "${Python_LIBRARY_DIRS}" -o "${CMAKE_CURRENT_BINARY_DIR}" -M "${Python_VERSION_MAJOR}" -m "${Python_VERSION_MINOR}"
+                -r "${python_root_path}" -o "${CMAKE_CURRENT_BINARY_DIR}" -M "${Python_VERSION_MAJOR}" -m "${Python_VERSION_MINOR}"
                 -x "\"${ignored_library_patterns}\""
         COMMAND_ECHO STDOUT
         COMMAND_ERROR_IS_FATAL ANY)