sonic-pi-akai-apc-mini 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd279db408994ddf67942a34f1576feb382b7fedafdcaeeeb227f447b6b1073c
-  data.tar.gz: 628d1d73459b6e01f7554317e53db308967b17753cc94c2e48845d9c909bd485
+  metadata.gz: 4e22ca44cac58f96c92d2685b033e3bbb8ace73a5dd575122b2d4c87225f1cd0
+  data.tar.gz: f2273913fb975c228dcfeaec78688d5f2a01796923e16b8742831a8a3ca41511
 SHA512:
-  metadata.gz: dd0673065b74993754899a449a1129ecfcce6b252fb93834ac8be33d148cff04f13a1361417ee9682117cd4bf9a41cd8d4d89a83347479335dcadbaaa9d99d35
-  data.tar.gz: 20d6cc379e57eda32090cd3cae0b70fab1c18946d9f17ffe79cbb34eac12d7aa556eee4065c5abd28fdd2ce7cc87a5ca5648a610c37b24a1da0cdd6f72069eee
+  metadata.gz: 2dce12edb6302ba1684359557cc7b58762ad170be9f6e4f01d5e714d4e42d331c6d43809840c6a0879cd6d2db03bb719ae8434ca8f34fded24d9c20c36dd9be2
+  data.tar.gz: 51a3b9d32f674ece955a83f420ae1a3bb0b61527169a59a8a3d23f5df26d4655311357d9350be2073243130764d5e43419a22fe72a4106935e1c7867ea145701

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.3.0] - 2022-02-10
+
+### Added 
+
+- This CHANGELOG ;)
+- `set_fader` method
+
+### Other
+
+- Integration specs for fader related methods
+
+## [0.2.0] - 2022-01-29
+
+### Added
+
+- Experimental support for APC Key 25
+- `example.rb`
+
+### Changed
+
+- The `initialize_akai` method now requires the model name (`:apc_mini` or
+  `:apc_key_25`) as argument.
+
+### Other
+
+- `init_dev.rb` helper to work on development
+- Some unit specs (grid mapping logic)
+
+## [0.1.0] - 2022-01-09
+
+Initial release.
+
+[unreleased]: https://github.com/porras/sonic-pi-akai-apc-mini/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/porras/sonic-pi-akai-apc-mini/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/porras/sonic-pi-akai-apc-mini/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/porras/sonic-pi-akai-apc-mini/releases/tag/v0.1.0

data/Gemfile

@@ -3,8 +3,10 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in sonic-pi-akai-apc-mini.gemspec
 gemspec
 
+gem 'byebug'
 gem 'rake'
 gem 'rspec'
 gem 'rubocop'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
+gem 'simplecov'

data/Gemfile.lock

@@ -1,36 +1,38 @@
 PATH
   remote: .
   specs:
-    sonic-pi-akai-apc-mini (0.2.0)
+    sonic-pi-akai-apc-mini (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    byebug (11.1.3)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     parallel (1.21.0)
     parser (3.1.0.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.2.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.24.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.25.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
@@ -41,20 +43,28 @@ GEM
       parser (>= 3.0.1.1)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.7.0)
+    rubocop-rspec (2.8.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
     unicode-display_width (2.1.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  byebug
   rake
   rspec
   rubocop
   rubocop-rake
   rubocop-rspec
+  simplecov
   sonic-pi-akai-apc-mini!
 
 BUNDLED WITH

data/README.md

@@ -71,7 +71,7 @@ Finally, it is possible to use the same fader for two different things, with two
 play :c4, amp: fader(0, (0.8..1.5)), pan: fader(0, :pan)
 ```
 
-\*In reallity, `(0..0.999)`. The reason is that there are many parameters with range [0, 1), that is, between 0 and 1 but **not** 1, for example a synth's `res` (resonance). This weird default helps with this case while making no difference for the normal case. If you **really** need to be able to get to 1, then pass `(0..1)` explicitly.
+\*In reality, `(0..0.999)`. The reason is that there are many parameters with range [0, 1), that is, between 0 and 1 but **not** 1, for example a synth's `res` (resonance). This weird default helps with this case while making no difference for the normal case. If you **really** need to be able to get to 1, then pass `(0..1)` explicitly.
 
 #### `attach_fader(n, node, property, [target-values])`
 
@@ -94,20 +94,28 @@ live_loop :drums do
 end
 ```
 
-In this case, at the moment it is not possible to attach the same fader to two different controls. But you can combine **one** `attach_fader` with as many `fader` as you want.
-
 `attach_fader` uses `control` under the hood, which means:
 
 * The property needs to be one that can be changed while the sound is playing. Refer to the documentation of each synth and fx.
 * It will be affected by the corresponding `_slide` options. It could be said that _it doesn't play very well with any non-zero value in the corresponding `_slide` option_, but in reality pretty cool effects can be created by mixing them.
 
-#### Important note about faders
+#### `set_fader(n, [target-values]) { |value| ... }`
+
+There is another variant, lower level, which can be used for anything, but the most typical use case is to connect the fader to some general option like `set_volume!` or `set_mixer_control!`.
 
-Because MIDI works with events, it is not possible for Sonic Pi to know the initial position of a fader until it is moved and its new value is sent. Until then, it is assumed it is set to zero. So, two little advices:
+```
+set_fader(8) { |v| set_volume! v }
+```
+
+#### Important notes about faders
+
+1. Because MIDI works with events, it is not possible for Sonic Pi to know the initial position of a fader until it is moved and its new value is sent. Until then, it is assumed it is set to zero. So, two little advices:
 
 * Start your performances with the faders physically set to zero, to match that assumption. Move them to the desired position _before_ evaluating the code that will read them.
 * The lights above the faders are used as a hint to avoid this problem: they will be off when Sonic Pi _thinks_ they're set at zero, and on when it _thinks_ they're set at non-zero. If you see a fader physically not at zero but with the light off, move it slightly, so that Sonic Pi learns where it is :)
 
+2. At the moment it is not possible to apply `attach_fader`/`set_fader` to the same fader twice (the second definition _wins_). But you can combine **one** `attach_fader`/`set_fader` with as many `fader` as you want.
+
 ### Switches
 
 Each button in the grid can be used as a boolean switch, for any purpose (typically, triggering a sound or not). You could use a fader to map `amp` (and set it to zero when you don't want to hear it), but faders are scarce and there are 64 buttons in the grid :)
@@ -224,9 +232,7 @@ If you want to remove a free play mapping (so that the buttons are again availab
 
 * A `selector` that actually works
 * Free play with samples
-* Improvements to `attach_fader` so that a couple of things that are currently not possible, are:
-  * Using it to control the mixer (`set_mixer_control!`, etc.)
-  * Attaching the same fader to different nodes, or different properties of the same node
+* Make it possible to attach/set the same fader more than once
 * Better performance and stability in general
 
 ## Contributing

data/init_dev.rb

@@ -1,5 +1,5 @@
-# Script to be used in development. Instead of `require '.../init.rb'` from
-# sonic pi, `load '.../init_dev.rb'` and code will be reloaded on each Alt+R.
+# Script to be used in development. Instead of `require '.../init'` from
+# SonicPi, `load '.../init_dev.rb'` and code will be reloaded on each Alt+R.
 
 dir = File.join(__dir__, 'lib', 'sonic-pi-akai-apc-mini')
 

data/lib/sonic-pi-akai-apc-mini/api.rb

@@ -8,7 +8,9 @@ module SonicPiAkaiApcMini
     # [0,1) as range and throw an error when passed 1 (e.g. tb303 synth's res).
     # It's not the most common usecase, but for the common use case it makes no
     # difference so I think it's a good default.
-    def fader(n, target = (0..0.999), _options = {})
+    DEFAULT_TARGET = (0..0.999).freeze
+
+    def fader(n, target = DEFAULT_TARGET)
       # TODO: Try to optimize speed, there is some latency because the
       # controller send a lot of events (too much granularity). It is in theory
       # possible to save some of it by `get`ting the value directly instead of
@@ -17,9 +19,21 @@ module SonicPiAkaiApcMini
       Helpers.normalize(value, target)
     end
 
-    def attach_fader(n, node, property, target = (0..0.999))
-      control node, property => fader(n, target)
-      set "attached_fader_#{n}", node: node, property: property, target: target
+    def attach_fader(n, node, property, target = DEFAULT_TARGET)
+      set_fader(n, target) do |value|
+        control node, property => value
+      end
+    end
+
+    def set_fader(n, target = DEFAULT_TARGET, &block)
+      # first we just call the block with the current value, or 0
+      block.call(Helpers.normalize(get("fader_#{n}", 0), target))
+      # and set a loop that will cal it again on every change
+      live_loop "global_fader_#{n}" do
+        use_real_time
+        value = sync("fader_#{n}")
+        block.call(Helpers.normalize(value, target))
+      end
     end
 
     def loop_rows(duration, rows)
@@ -86,16 +100,14 @@ module SonicPiAkaiApcMini
       # and the corresponding light is turned on/off.
       live_loop :faders do
         use_real_time
-        n, value = sync(Controller.model.midi_event(:control_change))
-        set "fader_#{n - Controller.model.fader_offset}", value
+        note_number, value = sync(Controller.model.midi_event(:control_change))
+        fader_number = note_number - Controller.model.fader_offset
+        set "fader_#{fader_number}", value
         if Controller.model.fader_light_offset
-          midi_note_on n + Controller.model.fader_light_offset,
+          light_note_number = note_number + Controller.model.fader_light_offset
+          midi_note_on light_note_number,
                        value.zero? ? Controller.model.light_off : Controller.model.light_red
         end
-        if attachment = get("attached_fader_#{n - Controller.model.fader_offset}")
-          normalized_value = Helpers.normalize(value, attachment[:target])
-          control attachment[:node], attachment[:property] => normalized_value
-        end
       end
 
       # Manages the buttons in the grid, both as switches, selectors, and to
@@ -132,5 +144,3 @@ module SonicPiAkaiApcMini
     end
   end
 end
-
-include SonicPiAkaiApcMini::API

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonic-pi-akai-apc-mini
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sergio Gil
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-29 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -21,6 +21,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock