Merging Phazerville-Relabi with Main Phazerville

.github/workflows/custom.yml

@@ -0,0 +1,69 @@
+name: Custom Build
+
+on:
+  discussion_comment:
+    types: [created]
+
+jobs:
+  build:
+    name: Build Custom Firmware
+    if: contains(github.event.comment.body, '/buildthis')
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        ref: phazerville
+
+    - name: Setup env
+      env:
+        GH_COMMENT: ${{ github.event.comment.body }}
+      run: |
+        echo "OC_ARTIFACT_TAG=custom_${GITHUB_ACTOR}-$(software/o_c_REV/resources/oc_build_tag.sh)" | tr '/' '_' >> $GITHUB_ENV
+        echo "CUSTOM_BUILD_FLAGS=$(python software/o_c_REV/resources/parse_build_request.py)" >> $GITHUB_ENV
+
+    - name: Cache PlatformIO
+      uses: actions/cache@v3
+      with:
+        path: ~/.platformio
+        key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+        cache: 'pip'
+        cache-dependency-path: '**/requirements.txt'
+
+    - run: |
+        pip3 install --upgrade pip
+        pip3 install -r .github/workflows/requirements.txt
+
+    - name: Build firmware
+      working-directory: software/o_c_REV/
+      run: |
+        pio run -e custom
+
+    - name: Copy artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: o_C-${{env.OC_ARTIFACT_TAG}}
+        path: software/o_c_REV/.pio/build/*/*.hex
+
+# TODO: this will only work with Issues or Pull Requests...
+#    - name: Add follow-up comment to discussion
+#      uses: actions/github-script@v6
+#      if: always()
+#      with:
+#        script: |
+#          const name = '${{ github.workflow   }}';
+#          const url = '${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}';
+#          const success = '${{ job.status }}' === 'success';
+#          const body = `${name}: ${success ? 'succeeded ✅' : 'failed ❌'}\n${url}`;
+#
+#          await github.rest.issues.createComment({
+#            issue_number: context.issue.number,
+#            owner: context.repo.owner,
+#            repo: context.repo.repo,
+#            body: body
+#          })

.github/workflows/firmware.yml

@@ -0,0 +1,45 @@
+name: PlatformIO CI
+
+on:
+  push:
+    paths:
+      - 'software/o_c_REV/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup env
+      run: |
+        echo "OC_ARTIFACT_TAG=${GITHUB_REF_NAME}-$(software/o_c_REV/resources/oc_build_tag.sh)" | tr '/' '_' >> $GITHUB_ENV
+
+    - name: Cache PlatformIO
+      uses: actions/cache@v3
+      with:
+        path: ~/.platformio
+        key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+        cache: 'pip'
+        cache-dependency-path: '**/requirements.txt'
+
+    - run: |
+        pip3 install --upgrade pip
+        pip3 install -r .github/workflows/requirements.txt
+
+    - name: Build firmware
+      working-directory: software/o_c_REV/
+      run: |
+        pio run
+
+    - name: Copy artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: o_C-${{env.OC_ARTIFACT_TAG}}
+        path: software/o_c_REV/.pio/build/*/*.hex

.github/workflows/requirements.txt

@@ -0,0 +1 @@
+platformio

.gitignore

@@ -20,3 +20,4 @@ shelved/
 Hemisphere\ Suite.cpp
 builds
 .pio
+.vscode

API-notes.md

@@ -0,0 +1,79 @@
+API Notes
+===
+
+### Basics
+
+The o_C firmware operates with several "concurrent" threads.
+(really they interrupt each other I guess)
+
+There is a main _loop_ as well as an _ISR_ that fires from a timer.
+The _loop_ acts as a watchdog while the _ISR_ does all the work.
+UI events are on a seperate _ISR_ timer.
+The display driver and input polling are also on independent interrupts.
+So that's at least 4? separate processes happening in a cascade
+for every cycle, which is 60us (nanoseconds) or 16.666khz
+
+That's the general idea.
+
+Anyway, we have top-level *Apps* and then there are *Applets* as implemented
+in the _Hemisphere_ *App*. An *Applet* inherits the base class _HemisphereApplet_
+and gains the superpowers necessary to live on half of your module's screen.
+
+### Base Classes
+
+The two primary interfaces in the Hemisphere API are _HSApplication_ and _HemisphereApplet_.
+They both have many similarly named methods for I/O and graphics, with 
+_HemisphereApplet_ taking extra considerations for offsetting both in the right side.
+
+All of the hardware details are neatly abstracted under these two interfaces. If you
+simply want to make an applet that does some stuff, these APIs are your starting point.
+
+### Applets
+
+There are a few different things an Applet must do:
+* Controller - the main logic computed every tick (every time the ISR fires)
+* View - draw the pixels on the screen (there are many helpful _gfx*_ functions)
+* UI Event Handling:
+  * OnButtonPress - what to do when the encoder button is pressed
+  * OnEncoderMove - what to do when the encoder rotated
+* OnDataRequest / OnDataReceive - how to save / load state
+
+There is also a `Start()` function for initializing things at runtime,
+plus some Help text. That's about it.
+
+You can easily try it out by copying the `HEM_Boilerplate.ino.txt` file into place,
+and then adding your computations to its skeleton.
+
+### Applet Functions
+
+Function? or Method? Either way, this is how you do the things.
+
+#### I/O Functions
+The main argument of each is the channel to operate on - each half of the
+screen gets 2 channels. So _n_ is typically either 0 or 1.
+
+**Input**:
+* Clock(n) - has the digital input received a new clock pulse?
+* Gate(n) - is the digital input held high?
+* In(n) - Raw value of the CV input
+* DetentedIn(n) - this one reads 0 until it's past a threshold ~ a quartertone
+
+**Output**:
+* ClockOut(n) - hold the output high for a pulse length
+* GateOut(n, on_off) - set the output high or low
+* Out(n, raw) - set the output to an explicit value
+
+I've added a standard case function for modulating a parameter with a certain input.
+* Modulate(param, n, min, max) - automatically scales the input and modifies param
+
+#### gfx Functions
+There are many strategies for drawing things on the screen, and therefore, many
+graphics related functions. You can see them for yourself in `HemisphereApplet.h`
+All of them typically take _x_ and _y_ coordinates for the first two arguments,
+followed by _width_ and _height_, or another _x,y_ pair.
+_x_ is how many pixels from the left edge of the screen.
+_y_ is how many pixels from the top edge of the screen.
+
+Some essentials: *gfxPrint*, *gfxPixel*, *gfxLine*, *gfxCursor*,
+                *gfxFrame*, *gfxBitmap*, *gfxInvert*
+

README.md

@@ -1,42 +1,37 @@
-Welcome to Benisphere Suite
-===
-
-## An active fork expanding upon Hemisphere Suite.
-
-To download and install the latest release, head to [releases](https://github.com/benirose/O_C-BenisphereSuite/releases).
+[![PlatformIO CI](https://github.com/djphazer/O_C-BenisphereSuite/actions/workflows/firmware.yml/badge.svg)](https://github.com/djphazer/O_C-BenisphereSuite/actions/workflows/firmware.yml)
 
-To learn more about what makes this fork different than the original Hemisphere Suite, head to [the wiki](https://github.com/benirose/O_C-BenisphereSuite/wiki).
-
-Benisphere takes the Hemisphere Suite in a new direction, adding new applets and some enhancements to existing ones, while also removing o_C style apps to make space for these changes.
+Phazerville Suite with Relabi - an active o_C firmware fork
+===
+[![SynthDad's video overview](http://img.youtube.com/vi/XRGlAmz3AKM/0.jpg)](http://www.youtube.com/watch?v=XRGlAmz3AKM "Phazerville; newest firmware for Ornament and Crime. Tutorial and patch ideas")
 
-### An alternate firmware to an alternate firmware??
+Watch SynthDad's **video overview** (above) or check the [**Wiki**](https://github.com/djphazer/O_C-BenisphereSuite/wiki) for more info. [Download it here](https://github.com/djphazer/O_C-BenisphereSuite/releases).
 
-Yes! This fork was an opportunity for me add stuff I wanted to see on my o_C without having to worry about running up against any legacy issues for other Hemipshere users. When I shared some of the progress I was making in my fork, people seemed excited and interested in trying it out, so I have made it an official fork rather than just my own personal project. I try to give back any improvements I make to the [main Hemispheres repo](https://github.com/Chysn/O_C-HemisphereSuite) when possible, but 1) it is not clear if that repo is still active and 2) there is barely any room remaining on the Teensy for improvements. By deciding that this version of the suite will only contain Hemisphere applets I was able to make room for new applets and other improvements. I do accept feature request issues and pull request, but the things that will make it in to this fork are still largely up to my discression.
+## An active fork expanding upon Hemisphere Suite.
 
-### Ok, so what's changed?
+This is a fork of djphazer's Phazerville Suite which is a fork of Benisphere which is a fork of Hemisphere! The code is firmware for the Ornament & Crime, a Eurorack synth module that can act as many different modules as selected by the user. This firmware ads the Relabi app that generates chaotic but deterministic control voltage. In addition, it adds a function to the HSVectorOscillator.h file and provides a controller file that allows two Relabi apps to be linked, providing four related chaotic LFOs.
 
-As of v1.0, I have added two new applets inspired by very popular modules ([Mutable Instruments Grids](https://mutable-instruments.net/modules/grids/) and [Noise Engineering Mimetic Digitalis](https://noiseengineering.us/products/mimetic-digitalis)) as well as some minor improvements to existing apps. I've also removed all of the full-width o_C style apps to make space for these changes. To see all of the changes in detail, visit the [wiki](https://github.com/benirose/O_C-BenisphereSuite/wiki).
+Read more about the suite [here](https://github.com/djphazer/O_C-Phazerville). Please, go there and read about all the people who have contributed code.
 
-### How do I try it?
+## What is Relabi.
 
-Head over to the [releases](https://github.com/benirose/O_C-BenisphereSuite/releases) section and download the latest release. Follow the ["Method A" instructions](https://ornament-and-cri.me/firmware/#method_a) from the Ornament and Crime website, except use the hex file you downloaded from the releases section.
+Relabi is an alternative method of defining musical time. While rhythm is concerned with recurring pulses, relabi always slips the pulse. You can read all about the concept in [John Berndt's essay]((https://johnberndt.org/relabi/).
 
-Alternatively, you can follow instructions in [this video](https://www.youtube.com/watch?v=dg_acylaMZU).
 
-Note: you can reload any other previous firmware you had installed (stock o_C or Hemisphere Suite) just as easily.
 
-### How do I build it?
 
-You can download this repo and build the code following the ["Method B" instruction](https://ornament-and-cri.me/firmware/#method_b) from the Ornament and Crime website. Very specific legacy versions of the Arduino IDE and Teensyduino add-on are required to build, and are not installable on 64-bit only systems, like Mac OS. You must use an older version (Mojave or before) or a VM to install these versions.
+### How To Get It
 
-### What's with the name?
+Check the [Releases](https://github.com/djphazer/O_C-BenisphereSuite/releases) section for a .hex file (to be used with the Teensy loader app), or clone the repository and build it yourself! I think the beauty of this module is the fact that it's relatively easy to modify and build the source code to reprogram it. You are free to customize the firmware, similar to how you've no doubt already selected a custom set of physical modules.
 
-Beta tester [@jroo](https://github.com/jroo) jokingly called it that, and it kind of stuck! It's supposed to be a bit tongue in cheek, so I hope it's not taken too seriously! Also it has a nicer ringer than "Hemisphere Suite BR Fork".
+### How To Change It
 
-### Credits
+This firmware fork is built using Platform IO, a Python-based build toolchain, available as either a [standalone CLI](https://docs.platformio.org/en/latest/core/installation/methods/installer-script.html) or a [full-featured IDE](https://platformio.org/install/ide), as well as a plugin for VSCode and other existing IDEs.
 
-This is a fork of [Hemisphere Suite](https://github.com/Chysn/O_C-HemisphereSuite) by Jason Justian (aka chysn). I could not have built Hemisphere Suite, so a million thanks to Jason for doing the true hard work and keeping it open source.
+The project lives within the `software/o_c_REV` directory. From there, you can Build the desired configuration and Upload via USB to your module:
+```
+pio run -e oc_stock2_flipped -t upload
+```
+Have a look inside `platformio.ini` for alternative build environment configurations - VOR, Buchla, flipped screen, etc. To build all the defaults consecutively, simply use `pio run`
 
-ornament**s** & crime**s** is a collaborative project by Patrick Dowling (aka pld), mxmxmx and Tim Churches (aka bennelong.bicyclist) (though mostly by pld and bennelong.bicyclist). it **(considerably) extends** the original firmware for the o_C / ASR eurorack module, designed by mxmxmx.
+_**Pro-tip**_: If you decide to fork the project, and enable GitHub Actions on your own repo, GitHub will build the files for you... ;)
 
-http://ornament-and-cri.me/

TODO.md

@@ -0,0 +1,34 @@
+TODO
+===
+
+* Auto-tuner floor/ceiling detection (fail gracefully)
+* Move calibration routines to a proper App
+* Runtime filtering/hiding of Applets
+* Flexible input remapping for Hemisphere
+  - generalize applet params for assignment
+* global quantizer settings in Hemisphere Config
+* applet with modal interchange (CV modulation of scale)
+* Subharmonicon app/applets
+* Update Boilerplates
+* add swing/shuffle to internal clock
+* Automatic stop for internal Clock?
+* Polyphonic MIDI input tracking
+* MIDI output for all apps?
+
+[APP IDEAS]
+* QUADRANTS
+* Two Spheres
+* Snake Game
+
+[DONE]
+* Add auto-tuner to Calibr8or
+* ProbMeloD - alternate melody on 2nd output
+* Fix FLIP_180 calibration
+* Add Clock Setup to Calibr8or
+* Calibr8or screensaver
+* Pull in Automatonnetz
+* Sync-Start for internal Clock
+* General Config screen (long-press right button)
+* better MIDI input message delegation (event listeners?)
+* import alternative grids_resources patterns for DrumMap2
+* Add Root Note to DualTM