Merge branch 'release/0.10.0'

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.9.0
+current_version = 0.10.0
 
 [bumpversion:file:setup.cfg]
 

.github/FUNDING.yml

@@ -1,2 +1,4 @@
 github: Wasted-Audio
 patreon: WastedAudio
+ko_fi: wastedaudio
+liberapay: WastedAudio

.github/workflows/build.yml

@@ -8,10 +8,10 @@ on:
 jobs:
   build:
 
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
 
     steps:
       - uses: actions/checkout@v3

CHANGELOG.md

@@ -1,6 +1,22 @@
 CHANGELOG
 =====
 
+0.10.0
+-----
+
+* Objects: `[bang~]`
+* Object improvements: support `[clear(` message for `[delwrite~]`
+* Documentation fixes/additions
+* Daisy: ability to set samplerate and blocksize
+* Daisy: adding midirealtimein, polytouchin/out, midiin (midiout WIP)
+* Daisy: use `libdaisy_path` in meta config; both string/path and int/depth possible
+* DPF: enum for UI parameter IDs
+* DPF bugfixes: correct input PortGroup names; correct UI slider updates; midiout reimplementation
+* Wwise: complete rewrite/refactor - now uses SDK build tools - thanks to @eu-ch !!
+* Bugfix: correct alignment in AVX pow~ implementation
+* Cleanup: remove deprecated build.json
+* Deprecate py37, enable py312
+
 0.9.0
 -----
 

README.md

@@ -1,6 +1,8 @@
 # Heavy Compiler Collection (hvcc)
 
 [![Build Status](https://github.com/Wasted-Audio/hvcc/actions/workflows/build.yml/badge.svg)](https://github.com/Wasted-Audio/hvcc/actions)
+[![pypi](https://img.shields.io/pypi/v/hvcc.svg)](https://pypi.python.org/pypi/hvcc)
+[![python](https://img.shields.io/pypi/pyversions/hvcc.svg)](https://pypi.python.org/pypi/hvcc)
 
 `hvcc` is a python-based dataflow audio programming language compiler that generates C/C++ code and a variety of specific framework wrappers.
 
@@ -12,9 +14,36 @@ The goal was to leverage Pure Data as a design interface and statically interpre
 
 It has since then been expanded to provide further support for many different platforms and frameworks, targeting game audio design, daw plugins and embedded production tools. In 2021 Wasted Audio took over maintenance of the project.
 
+## Documentation
+
+* [Introduction](/docs/01.introduction.md)
+  * [What is heavy?](/docs/01.introduction.md#what-is-heavy)
+  * [Supported patch formats](/docs/01.introduction.md#supported-patch-formats)
+  * [Supported platforms](/docs/01.introduction.md#supported-platforms)
+  * [Supported frameworks](/docs/01.introduction.md#supported-frameworks)
+  * [Licensing](/docs/01.introduction.md#licensing)
+* [Getting Started](/docs/02.getting_started.md)
+* [Generators](/docs/03.generators.md)
+* [MIDI](/docs/04.midi.md)
+* [C API](/docs/05.c.md)
+* [C++ API](/docs/06.cpp.md)
+* [Heavy Lang Info](/docs/07.heavy_lang.md)
+* [Heavy IR Info](/docs/08.heavy_ir_lang.md)
+* [Supported vanilla objects](/docs/09.supported_vanilla_objects.md)
+* [Unsupported vanilla objects](/docs/10.unsupported_vanilla_objects.md)
+
+## Integrations
+
+hvcc has been integrated into several projects and services. This allows to easily compile patches without having to install hvcc manually.
+
+* [plugdata](https://plugdata.org/) - a new way to use Pure Data. Includes a full toolchain and targets Daisy, DPF and pd externals.
+* [mod-cloud-builder](https://github.com/moddevices/mod-cloud-builder) - An online service for building LV2 plugins for the MOD platform.
+* [OWL Patch Library](https://www.rebeltech.org/patch-library) - An online service for building OWL plugins (uses an old fork).
+
 ## Requirements
 
-* python 3.7 or higher
+python 3.8 until 3.12
+
   * `jinja2` (for generator templating)
   * `importlib_resources` (for reading static resources)
   * `json2daisy` (for daisy integration)
@@ -113,24 +142,6 @@ This can be changed with `--copyright` parameter
 
 Displays all the available parameters and options for hvcc.
 
-## Documentation
-
-* [Introduction](/docs/01.introduction.md)
-  * [What is heavy?](/docs/01.introduction.md#what-is-heavy)
-  * [Supported patch formats](/docs/01.introduction.md#supported-patch-formats)
-  * [Supported platforms](/docs/01.introduction.md#supported-platforms)
-  * [Supported frameworks](/docs/01.introduction.md#supported-frameworks)
-  * [Licensing](/docs/01.introduction.md#licensing)
-* [Getting Started](/docs/02.getting_started.md)
-* [Generators](/docs/03.generators.md)
-* [MIDI](/docs/04.midi.md)
-* [C API](/docs/05.c.md)
-* [C++ API](/docs/06.cpp.md)
-* [Heavy Lang Info](/docs/07.heavy_lang.md)
-* [Heavy IR Info](/docs/08.heavy_ir_lang.md)
-* [Supported vanilla objects](/docs/09.supported_vanilla_objects.md)
-* [Unsupported vanilla objects](/docs/10.unsupported_vanilla_objects.md)
-
 ## Contact
 
 There are several places where heavy/hvcc conversation is happening:

docs/01.introduction.md

@@ -25,7 +25,7 @@ Heavy can interpret and convert a subset of features from Pure Data patches:
 
 ## Supported Platforms
 
-* Windows 8, 10 and WSA
+* Windows 10, 11 and WSA
 * Mac OSX
 * Linux
 * PS4

docs/02.getting_started.md

@@ -80,9 +80,24 @@ Heavy will also perform patch analysis to look for common mistakes and inconsite
 
 If you experience any problems or have some thoughts on how to improve heavy make sure to browse and contribute to our [public issue tracker](https://github.com/Wasted-Audio/hvcc/issues).
 
+## Tips and Tricks
+
+Just because pd-vanilla can run your patch, does not mean it will behave exactly the same using Heavy. Extra care needs to be taken when dealing with control messages and certain PD object features.
+
+* Make sure to go over the [known limitations](#known-limitations) to see if you are using objects incorrectly.
+* Try to move as much of your patch into the signal domain as you can. Heavy is optimized for signal processing and every control rate operation can introduce interruptions and additional delay. Use control logic at the very beginning or the very end of the dataflow if possible.
+* Make sure the order in your control flow works as intended. Use `[t]`/trigger objects to force the correct order of operations.
+* When using Daisy the receive objects continuously output control messages, which can potentially interrupt your intended behavior.
+* If you run into problems with a patch try to reduce it in order to localize the problem to a specific object or use-case before reporting an issue.
+
 ## Known Limitations
 
+This list will be continuously epanded to document differences in object behavior between PD and Heavy.
+
+* Many objects do not take control signals on their left inlet. `[osc~]` for instance always requires the use of `[sig~]` before connecting a value.
+* Heavy does not support symbols in `[pack]`. e.g. `[pack s f]`.
 * Heavy does not support numbers in `[unpack]`, e.g. `[unpack 0 0]` gives `Heavy only supports arguments 'f' and 's' to unpack.` Workaround is to use `f` instead, e.g. `[unpack f f]`, and if necessary prime the default values with a `[loadbang]` and `[0 0(`.
+* Sliders and number inputs are converted to `[f ]` and thus do not store send/receive/initialization/etc. settings.
 * Heavy does not accept arguments and control connections to: `[rzero~]`, `[rzero_rev~]`, `[czero~]`, `[czero_rev~]`. In Heavy, these objects accept only signal inputs. Arguments and control connections are ignored.
 * On the `[select]` object it is currently not possible to set the arguments via the right inlet (internally a hardcoded switch_case is used).
 * `[metro]` and `[timer]` objects do not accept tempo messages or unit arguments.

docs/03.gen.daisy.md

@@ -2,15 +2,15 @@
 
 Daisy is an embedded platform for music. It features everything you need for creating high fidelity audio hardware devices.
 
-This Generator is typically it is used in combination with [pd2dsy](https://github.com/electro-smith/pd2dsy).
-
 Currently daisy platform is supported for:
 
-* `field`
 * `seed`
 * `pod`
 * `petal`
 * `patch`
+* `patch_init`
+* `patch_sm`
+* `field`
 
 Which can be configured using the `-m` metadata.json `daisy.board` setting:
 
@@ -34,6 +34,26 @@ The custom layout can be passed on via the meta.json as such:
 }
 ```
 
+You can also set a custom path to your libDaisy directory. This can either be a string to the full or relative path or a number indicating the levels deep this directory is compared to the output directory. The default value for this is `2`.
+
+```json
+{
+    "daisy": {
+        "libdaisy_path": "/somewhere/libdaisy/"
+    }
+}
+```
+
+Or the level:
+
+```json
+{
+    "daisy": {
+        "libdaisy_path": 5
+    }
+}
+```
+
 ## MIDI
 
 Board files that have `OOPSY_TARGET_HAS_MIDI_INPUT` configured will automatically set up UART MIDI on the default USART1 Rx and Tx pins of the Daisy (D13/14).
@@ -50,6 +70,8 @@ Additionally `usb_midi`, running on the onboard micro-usb, can be enabled separa
 
 At the moment all midi messages will be merged between USB and UART MIDI interfaces. In the future it will likely be possible to assign additional UART pins and group them under a specific PD midi "port".
 
+Currently supported MIDI messages are: Note On/Off, Poly Aftertouch, Control Change, Program Change, Channel Pressure, Pitch Bend, and Midi Realtime messages.
+
 ## [print] object
 
 Printing to serial console can be enabled using the `debug_printing` flag in the meta.json:
@@ -63,3 +85,33 @@ Printing to serial console can be enabled using the `debug_printing` flag in the
 ```
 
 This will increase the program size with a few kb and will disable `usb_midi` as we currently do not have composite USB device yet.
+
+## Custom samplerate and blocksize
+
+This can be done by adding either to the meta.json:
+
+```json
+{
+    "daisy": {
+        "samplerate": 96000,
+        "blocksize": 128
+    }
+}
+```
+
+Do note that the samplerate will be automatically set to either 16k, 32k, 48k, or 96k. Blocksize will need to be 256 or less and is automatically capped.
+
+## Custom Linker script and Bootloader APP_TYPE
+
+Using the Daisy bootloader you can flash the program to other parts of the Daisy memory. Read the [libDaisy documentation](https://github.com/electro-smith/libDaisy/blob/master/doc/md/_a7_Getting-Started-Daisy-Bootloader.md) for more information.
+
+The linker and `APP_TYPE` can be set in the json metadata accordingly:
+
+```json
+{
+    "daisy": {
+        "linker_script": <path_to_lds_file>,
+        "bootloader": <APP_TYPE>
+    }
+}
+```