update to latest tibia changes

process1

.gitignore

@@ -1,3 +1,4 @@
 build
 node_modules
 package-lock.json
+.DS_Store

ChangeLog

@@ -1,3 +1,124 @@
+1.1.0
+-----
+  * Added new bw_cab module.
+  * Added new fx_cab and fxpp_cab examples.
+  * Added skip_sustain and always_reach_sustain parameters to bw_env_gen.
+  * Added silence_dc parameter to bw_bd_reduce.
+  * Added BW_NULL definition in bw_common and used it throughout the entire
+    codebase.
+  * Added BW_CXX_NO_ARRAY to control the inclusion of features depending on
+    C++ <array>.
+  * Relaxed sidechain APIs in bw_comp and bw_noise_gate to accept BW_NULL to
+    represent null sidechain inputs.
+  * Added setThreshLin() and setThreshDb() methods to the C++ APIs of bw_comp
+    and bw_noise_gate to fix naming typos without breaking the API.
+  * Reworked all example code and added LV2, command line application, and
+    C++/WebAssembly targets.
+  * Fixed gain compensation in bw_satur_process_multi().
+  * Fixed rounding bug in bw_phase_gen when frequency is tiny and negative.
+  * Fixed smoothing of decay parameter in bw_reverb.
+  * Fixed computation of initial states in bw_mm1 and bw_mm2.
+  * Fixed sign-related issues in bw_hash_sdbm(), bw_truncf(), bw_roundf(), and
+    bw_sqrtf() (thanks Kevin Molcard). 
+  * Replace GCC pragmas to suppress uninitalized variable warnings with
+    useless harmless statements in bw_env_gen, bw_hs2, bw_ls2, bw_one_pole, and
+    bw_peak.
+  * Fixed documentation typos in bw_ls2.
+  * Updated examples' documentation.
+
+1.0.0
+-----
+  * Removed C++ headers and moved C++ code to now-unique C/C++ headers.
+  * Added extern "C" linkage specifier to C functions declarations and
+    definitions.
+  * Added bw_*_reset_state_multi() and updated C++ APIs in this regard.
+  * Now bw_*_reset_state() take initial input values and return initial output
+    values.
+  * Added more const and BW_RESTRICT specifiers to input arguments.
+  * Added overloaded C++ functions taking C-style arrays as arguments.
+  * Added debugging code to all modules and improved existing debugging code.
+  * Removed usage of reserved identifiers and designated initializers.
+  * Now using size_t rather than BW_SIZE_T and for counting items.
+  * Improved documentation w.r.t. validity of input values and approximation
+    errors.
+  * Added pragmas to silence bogus GCC uninitialized variable warnings.
+  * Made control over inclusion of standard library headers more explicit via
+    specific preprocessor definitions.
+  * Introduced BW_NO_DEBUG and prevented useless inclusion of assert.h.
+  * Changed order of arguments to improve consistency in bw_buf.
+  * Renamed bw_min0xf() as bw_min0f() and bw_max0xf() as bw_max0f().
+  * Removed precision suffixes from function names in bw_math.
+  * New implementations for bw_min0f(), bw_max0f(), bw_minf(), bw_maxf(), and
+    bw_clipf().
+  * Fixed rounding bug in bw_roundf() when absolute value of input was in [0.5f,
+    1.f].
+  * Fixed bw_ceilf() for negative input values.
+  * Fixed bw_sqrtf() for very large input values and improved implementation.
+  * Fixed input validity ranges in bw_asinhf() and bw_acoshf().
+  * Removed redundant status member from bw_note_queue_event.
+  * Possibly improved memeory layout of bw_note_queue.
+  * Clarified ambiguity in the documentation of bw_note_queue_status.
+  * Specified that velocity can be negative in bw_voice_alloc_opts.
+  * Fixed output polarity in bw_ap1.
+  * Added bw_bd_reduce_set_sample_rate().
+  * Changed default value for gain compensation to off in bw_clip.
+  * Fixed missing smoothing filter initialization in bw_comp.
+  * Fixed missing forced coefficients' update in bw_comp_reset_coeffs().
+  * Improved and strengthened algorithm in bw_comp.
+  * Removed read() and write() from C++ API in bw_delay.
+  * Adjusted internal peak cutoff to more sensible value in bw_dist.
+  * Improved algorithm to be a bit more faithful to the original in bw_drive.
+  * bw_drywet renamed as bw_dry_wet.
+  * Renamed bw_env_gen_update_state_ctrl() as bw_env_gen_process_ctrl().
+  * Faster and more robust implementation in bw_env_gen.
+  * Improved algorithm to be a bit more faithful to the original in bw_fuzz.
+  * Added bw_gain_get_gain_lin().
+  * Renamed bw_gain_get_gain() as bw_gain_get_gain_cur().
+  * Simplified implementation to use less memory in bw_gain.
+  * Added prewarp_at_cutoff and prewarp_freq parameters in bw_ap1, bw_ap2,
+    bw_hp1, bw_hs1, bw_ls1, bw_ls2, bw_notch, and bw_peak.
+  * Fixed documentation to indicate correct default parameter values in bw_hs1,
+    bw_hs2, bw_ls1, bw_ls2, bw_notch, and bw_peak.
+  * Fixed bug when setting default parameter values in bw_hs1_init().
+  * Limited actual prewarping frequency to prevent instability in bw_lp1.
+  * Fixed missing smoothing filter initialization in bw_noise_gate.
+  * Fixed missing forced coefficients' update in bw_noise_gate_reset_coeffs().
+  * Added bw_noise_gen_reset_coeffs(), bw_noise_gen_update_coeffs_ctrl(), and
+    bw_noise_gen_update_coeffs_audio().
+  * Improved and strengthened algorithm in bw_noise_gate.
+  * Now using backward Euler rather than impulse invariant method in
+    bw_one_pole.
+  * Added coeffs argument to bw_one_pole_state_is_valid().
+  * Changed implementation topology to use less memory in bw_osc_filt.
+  * Now antialiasing should work also with negative input increments in
+    bw_osc_pulse, bw_osc_saw, and bw_osc_tri.
+  * Clearly specified validity ranges for audio-rate signals in bw_osc_pulse,
+    bw_osc_saw, bw_osc_sin, and bw_osc_tri.
+  * Added bw_osc_saw_set_sample_rate(), bw_osc_saw_reset_coeffs(),
+    bw_osc_saw_update_coeffs_ctrl(), and bw_osc_saw_update_coeffs_audio().
+  * Now using parabolic curves instead of trigonometric ones in bw_pan.
+  * Fixed smoothing coefficients update in bw_phase_gen_reset_coeffs().
+  * Removed internal limits on cutoff frequency in bw_phaser.
+  * Added bw_pink_filt_reset_coeffs(), bw_pink_filt_update_coeffs_ctrl(), and
+    bw_pink_filt_update_coeffs_audio().
+  * Fixed type of coefficient in bw_pink_filt_process1().
+  * Enforced minimum output value -600.f in bw_ppm.
+  * bw_ringmod renamed as bw_ring_mod.
+  * Fixed inverted-polarity modulation (for real this time) in bw_ring_mod.
+  * Changed default value for gain compensation to off in bw_satur.
+  * Added bw_slew_lim_process1_none().
+  * Fixed setting of default parameter values in bw_slew_lim_init().
+  * Fixed documentation of bw_slew_lim_update_coeffs_audio().
+  * Added bw_sr_reduce_set_sample_rate(), bw_sr_reduce_reset_coeffs(),
+    bw_sr_reduce_update_coeffs_ctrl(), and bw_sr_reduce_update_coeffs_audio().
+  * Removed useless computation when upsampling in bw_src.
+  * Clarified when the same buffers cannot be used for both input and output in
+    bw_src and bw_src_int.
+  * Fixed frequency response and improved speed in bw_src_int.
+  * Changed model to get positive polarity at the bandpass output in bw_svf.
+  * Limited actual prewarping frequency to prevent instability in bw_svf.
+  * Adjusted examples accordingly to changes.
+
 0.6.0
 -----
   * Added support and examples for Android and iOS.

README.md

@@ -6,20 +6,18 @@ You can find information and documentation [on the official web page](https://ww
 
 ## Subfolders
 
-* examples: synth and an effect examples in VST3, Web Audio, and Daisy Seed formats;
-* include: header files.
+* `examples`: synth and an effect examples in VST3, LV2, Web Audio, Daisy Seed, Android app, iOS app, and command line program formats;
+* `include`: header files.
 
 ## Legal
 
-Copyright (C) 2021-2023 Orastron Srl unipersonale.
+Copyright (C) 2021-2024 Orastron Srl unipersonale.
 
 Authors: Stefano D'Angelo, Paolo Marrone.
 
-All the code in the repo is released under GPLv3. See the LICENSE file. Alternatively, we offer a commercial license that doesn't restrict usage with respect to time, projects, or developers involved. More details [on the official web page](https://www.orastron.com/brickworks#license-pricing).
+All the code in the repo is released under GPLv3. See the `LICENSE` file. Alternatively, we offer a commercial license that doesn't restrict usage with respect to time, projects, or developers involved. More details [on the official web page](https://www.orastron.com/brickworks#license-pricing).
 
-The file examples/common/vst3/plugin.cpp contains code from sse2neon (https://github.com/DLTcollab/sse2neon/), which was released under the MIT license. Details in said file.
-
-The file include/bw\_rand.h contains code from https://nullprogram.com/blog/2017/09/21/, which was released into the public domain by its author.
+The `include/bw_rand.h` file contains code from https://nullprogram.com/blog/2017/09/21/, which was released into the public domain by its author.
 
 VST is a registered trademark of Steinberg Media Technologies GmbH.
 

THANKS.md

@@ -0,0 +1,17 @@
+We wish to thank and give credit to:
+- the adopters of this software, of which at the moment we can publicly mention, in alphabetical order:
+  - [Elk Audio](https://www.elk.audio/);
+  - [Faselunare](http://faselunare.com/);
+- Kevin Molcard for finding compilation warnings that needed fixing in Brickworks 1.0.0;
+- users participating to [this thread on the KVR Audio forum](https://www.kvraudio.com/forum/viewtopic.php?f=33&t=589519) for providing useful feedback;
+- [Mads Kjeldgaard](https://madskjeldgaard.dk/) for publishing [instructions to build for the Daisy Seed and uploading the firmware](https://madskjeldgaard.dk/posts/daisy-setup/);
+- [Hereket](https://hereket.github.io/) for providing instructions on [how to build an Android app without Android Studio or Gradle](https://hereket.github.io/posts/android_from_command_line/);
+- the authors of the following publications, which some algorithms in this software are based on:
+  - J. Dattorro, "Effect Design, Part 1: Reverberator and Other Filters", J. Audio Eng. Soc., vol. 45, no. 9, pp. 660-684, September 1997;
+  - J. Dattorro, "Effect Design, Part 2: Delay-Line Modulation and Chorus", J. Audio Eng. Soc., vol. 45, no. 10, pp. 764-788, October 1997;
+  - V. Valimaki and A. Huovilainen, "Antialiasing Oscillators in Subtractive Synthesis", IEEE Signal Processing Magazine, vol. 24, no. 2, pp. 116-125, March 2007;
+  - M. E. O'Neill, "PCG: A Family of Simple Fast Space-Efficient Statistically Good Algorithms for Random Number Generation", September 2014, available at <https://www.cs.hmc.edu/tr/hmc-cs-2014-0905.pdf>;
+  - J. D. Parker, V. Zavalishin, and E. Le Bivic, "Reducing the Aliasing of Nonlinear Waveshaping Using Continuous-Time Convolution", Proc. 19th Intl. Conf. Digital Audio Effects (DAFx-16), pp. 137-144, Brno, Czech Republic, September 2016.
+  - C. Wellons, "Finding the Best 64-bit Simulation PRNG", September 2017, available at <https://nullprogram.com/blog/2017/09/21/>;
+  - M. Holters and J. D. Parker, "A Combined Model for a Bucket Brigade Device and its Input and Output Filters", 21st Intl. Conf. Digital Audio Effects (DAFx-18), Aveiro, Portugal, September 2018;
+  - P. P. La Pastina and S. D'Angelo, "Optimal Integer Order Approximation of Fractional Order Filters", Proc. 24th Intl. Conf. Digital Audio Effects (DAFx20in21), pp. 89-96, Vienna, Austria, September 2021.

TODO

@@ -1,104 +0,0 @@
-1.0.0
------
-
-code:
-* debugging
-* check all examples again
-* osc post filter (and one pole init, slew rate, etc.) val from input? set state instead?
-* audio rate optional pulse width/slope inputs?
-* should rather use backward Euler in bw_onepole?
-* one pole process const input? (return also if const out)
-* check const restrict etc.
-* define BW_RESTRICT to __restrict or similar when the compiler supports it
-* empty functions etc. to keep consistency and forward compatibility?
-* float in [-1,1] for velocity, pitch bend, mod wheel
-* should clip slope in triangle?
-* common smoothing policy (as control rate as possible?) - smoothing control?
-* svf bandpass out polarity too confusing (inverted in mm2)?
-* better common config.h (less stuff maybe, or more stuff - decide)
-* pan process with no out: should just reset coeffs?
-* get_y_z1, common strategy?
-* sqrt(0) and corner cases, common strategy?
-* use BW_SIZE_T, check constant types
-* bw_satur gain compensation to divide by actual gain (derivative) rather than gain parameter?
-* cite papers, thank authors
-* add initial state (x0) to reset state of lp1, ap1, mm1, hs1, ls1, others? all?
-* bw_comb: should also modulate feedback?
-* bw_comb: integer target delay values?
-* bw_svf/lp1 automatically limited (max) prewarp frequency to avoid instability?
-* prewarp control in all derived filtering modules
-* bw_math: review types
-* src inside distortions? w/ control from outside?
-* bw_fuzz gain compensation?
-* remove union value = {.f = v};? (std c++ latest) - C++ compound literals...
-* make gain of distortions homogeneous?
-* max_delay -> set sample rate? see reverb
-* revise typedef style (see https://stackoverflow.com/questions/54752861/using-an-anonymous-struct-vs-a-named-struct-with-typedef)
-* x_y vs xy var names
-* don't use reserved identifiers (https://devblogs.microsoft.com/oldnewthing/20230109-00/?p=107685)
-* update state ctrl -> process ctrl?
-* mem req -> return value of set sample rate?
-* peak gain + Q ???
-* bwpp -> bwxx
-* sr_reduce reset_coeffs? update_coeffs? process_multi?
-* fix definitions leading to X ** -> const X ** error https://isocpp.org/wiki/faq/const-correctness#constptrptr-conversion, fix fx_balance, fx_pan, synth_poly
-* drywet -> dry_wet, ringmod -> ring_mod, etc?
-* allow nullptr in C++ wrappers where process_multi arg can be NULL
-* better src filter
-* bw_env_gen process_multi gate const?
-* c++ get coeffs/state? or public? src nIn/OutSamples case (array vs single value), delay read/write, process1? process single?
-* bw_buf invert src dest order?
-* check unititialized warnings
-* voice alloc mode -> voice alloc priority
-* should remove bw_config?
-* use custom NDEBUG?
-* NULL (C) vs BW_SIZE_T (non-C)...?
-* clearly specify that state is tied to a particular set of coeffs (1:N)
-* modulation vs process (multi) no update (post 1.0.0)???
-
-build system:
-* single header generation (vs modules in bwp... to think about)
-
-post 1.0.0
-----------
-
-code:
-* blep etc in a module?
-* optimize triangle generation for constant pulse width
-* compute bit depth reduction only when input changes? (state, option?)
-* avoid "force" in coeffs update by using inline functions?
-* csch for bw_peak bandwidth -> Q, inv sqrt ls2 hs2
-* separate tests and examples?
-* define common midi CCs for examples
-* MEM_REQ_ROUGH() macro?
-* web examples: need to export memset?
-* check unused param warning visual studio
-* float -> double, etc. ?
-* bw_buf_copy (to be used in bw_slew_lim)?
-* src post filt?
-* web examples construction/destruction
-* web effect mono->stereo and stereo->mono inputs? or display "input needs to be n channels"?
-* fix vst3 mapped values (visible in Ableton Live) and short names
-* polish examples (ranges, etc.)
-* dump data structures (see note queue) and indicate error precisely
-* process (multi) no update
-* examples cpu usage
-
-build system:
-* make makefiles handle paths with spaces etc
-* can run su on windows? (system-wide install)
-* make autodependencies (.d?) - https://make.mad-scientist.net/papers/advanced-auto-dependency-generation/
-* make from... directories
-* recursive make?
-* make hashdeps (https://github.com/olipratt/hashdeps)?
-* VC, XCode, etc project files?
-* single header(s)
-* cross compile (rpi etc.)
-* better use of xcodegen (see xcode warnings) and/or consider tuist (https://tuist.io/), bazel (https://bazel.build/), pants (https://www.pantsbuild.org/), buck (https://buck2.build/), please (https://please.build/index.html) for mobile apps
-* homogenize android and ios common code (e.g., same index)
-
---
-
-code:
-* sample rate-constant coeffs? (pan case)
-* sr-dependent vs cr-dependent coeffs? see synth poly example

examples/README.md

@@ -1,34 +1,61 @@
 # Examples
 
-Each subfolder contains an example application, except the `common` folder, which contains common code for all examples.
+## Premise
 
-In order to build an example just `cd` to `*example*/*platofrm*` and use the following platform-specific instructions.
+Each of these examples consists of a common part of code, shared by all examples, which contains all necessary boilerplate code and is not Brickworks-related, and a specific part which actually implements the audio engine. The common code is copied/generated by an external tool called [Tibia](https://git.orastron.com/orastron/tibia), which you first need to [run as outlined below](#tibia).
 
-Building for any platform requires a recent enough version of [GNU Make](https://www.gnu.org/software/make/) installed.
+Each subfolder contains an example, except the `common` folder, which contains a good deal of common code and common Tibia-related metadata. In order to build an example just `cd` to <code>*example*/*platform*</code> and use the following platform-specific instructions. Building for any platform requires a recent enough version of [GNU Make](https://www.gnu.org/software/make/) installed.
 
+## Tibia
+
+### Prerequisites
+
+You need [Node.js](https://nodejs.org/en) and [npm](https://www.npmjs.com/) to be installed.
+
+### Usage
+
+Get [Tibia 0.0.4](https://git.orastron.com/orastron/tibia/releases/tag/v0.0.4), place it in the same directory as the Brickworks folder, and rename it as `tibia`. Then either `cd` to the Tibia folder and `npm install dot`, or install the [dot npm package](https://www.npmjs.com/package/dot) globally and make sure that the `NODE_PATH` environment variable is corretly set to find it.
+
+Now you can `cd` to the `examples` folder and run `./tibia_gen.sh` to copy/generate files for all examples, or otherwise run `./tibia_gen.sh common` to only copy/generate files in `examples/common` or <code>./tibia\_gen.sh *example*</code> to do the same for files in <code>examples/*example*</code>.
+
+If you want to remove all files copied/generated by Tibia, and thus restore the `examples` directory as it would appear in the official repository, run `./tibia_clean.sh` from the `examples` directory.
 ## VST3
 
 ### Prerequisites
 
 Windows (via [MSYS2/Mingw-w64](https://www.msys2.org/)), macOS, and Linux OSes are supported. Building tested with [GCC](https://gcc.gnu.org/), probably also works with [Clang](https://clang.llvm.org/).
 
-You also need to download the [VST3 SDK](https://www.steinberg.net/developers/) and place it in the same folder as the Brickworks folder, or otherwise edit `common/vst3/vst3.mk` and change the `VST3_SDK_DIR` variable to point to the correct directory.
+You also need to download or clone the [VST3 C API](https://github.com/steinbergmedia/vst3_c_api) and place it in the same folder as the Brickworks folder, or otherwise edit `common/src/vst3-make.json` and change `cflags` to point to the correct directory then finally [run Tibia](#tibia), or invoke `make` with appropriate `CFLAGS` straight from the command line.
 
 ### Build
 
-In order to build just type `make`. You'll find the resulting VST3 directory in `build/example.vst3`.
+In order to build just type `make`. You'll find the resulting VST3 directory in <code>build/bw\_example\_*example*.vst3</code>.
 
 ### Installation