Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/colinsullivan/supercollider-redux
State synchronization between a replica SuperCollider state store and a primary Redux state store.
https://github.com/colinsullivan/supercollider-redux
nodejs redux supercollider supercollider-language-interpreter
Last synced: 17 days ago
JSON representation
State synchronization between a replica SuperCollider state store and a primary Redux state store.
- Host: GitHub
- URL: https://github.com/colinsullivan/supercollider-redux
- Owner: colinsullivan
- License: mit
- Created: 2017-04-30T00:57:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T18:32:26.000Z (over 1 year ago)
- Last Synced: 2024-04-14T21:49:23.457Z (7 months ago)
- Topics: nodejs, redux, supercollider, supercollider-language-interpreter
- Language: JavaScript
- Size: 1.17 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# supercollider-redux
[](https://travis-ci.com/colinsullivan/supercollider-redux)
[](https://coveralls.io/github/colinsullivan/supercollider-redux?branch=master)
A library for state synchronization between SuperCollider and Node.js using the [Flux design pattern](https://facebook.github.io/flux/docs/in-depth-overview/). State flows from a primary state store in Node.js to a replica in SuperCollider which can dispatch actions back to the Node.js store.
## How it works
Intended for use with a primary state store in Node.js implemented with [Redux](http://redux.js.org/). Provides `StateStore`, a replica state store in [SuperCollider](http://supercollider.github.io/) which leverages [supercolliderjs](https://github.com/crucialfelix/supercolliderjs) and the [API quark](https://github.com/supercollider-quarks/API) to receive state changes.
The Node.js class `SCStoreController` forwards state updates to a replica running in sclang and receives actions dispatched from it using a separate OSC channel.
When actions are dispatched from sclang to the replica `StateStore` instance, they are passed up to the primary Node.js store via OSC, any reducers written in Node.js can update the state which will then be forwarded back to the replica. The primary / replica design promotes all state changes written as reducers in Redux, centralizing the state in the Node.js process.
## SuperCollider API
All SuperCollider code is included in a [quark](http://doc.sccode.org/Guides/UsingQuarks.html) inside the `quarks/supercollider-redux` directory.
### `SCReduxStore`
Implements the state store replica in SuperCollider. Usage:
```supercollider
var store = SCReduxStore.getInstance();
// Subscribing to state changes
store.subscribe({
var state = store.getState();
// This method is called whenever state changes.
});
// Dispatching a message to the Node.js store
store.dispatch((
type: MyActionTypes['HELLO_WORLD'],
payload: (
hello: "world"
)
));
```
Other classes:
* `SCRedux`: Used as a namespace for storing constants like actionTypes.
* `SCReduxTempoClockController`: A wrapper for TempoClock which will take a tempo from the Redux store.
## Node.js API
### `reducer`
A reducer is provided to store the ready states of the SCReduxStore, sclang, and scsynth:
```javascript
import SCRedux from 'supercollider-redux';
const rootReducer = combineReducers({
[SCRedux.DEFAULT_MOUNT_POINT]: SCRedux.reducer,
...
});
```
### `SCReduxController`
A controller class that starts sclang and initializes the SCReduxStore.
```javascript
import SCRedux from 'supercollider-redux';
const scReduxController = new SCRedux.SCReduxController(store);
scReduxController.boot().then(() => {
...
}).catch((err) => {
...
});
```
Parameters may be passed:
* `scStateSelector`: An optional selector (intended use with [reselect](https://github.com/reduxjs/reselect)) to control which portion of the state tree is passed to `SCReduxStore` in SuperCollider. This will be an important performance consideration in any application.
* `interpretOnLangBoot`: A string containing SuperCollider code for sclang to interpret immediately on boot. This is important to, for example, indicate which audio device to use.
```javascript
const controller = new SCReduxController(store, {
interpretOnLangBoot: `
s.options.inDevice = "JackRouter";
s.options.outDevice = "JackRouter";
`,
scStateSelector: mySCStateSelector
});
```
### Constants
#### `READY_STATES`
An enum with the possible values for the ready states of `scStoreReadyState`, `scLangReadyState`, `scSynthReadyState`.
## Browser API
The browser API exposes the subset of the functionality of supercollider-redux that may be relevant to a browser UI, the actions, reducers, and constants. As a browser cannot spawn a SuperCollider process, the controller class is not exposed.
## Example Projects
* [Transdimensional Audio Workstation](https://colin-sullivan.net/main/2016/transdimensional-audio-workstation/)
* [Touch UI to Generative Music Sequencer in SuperCollider](https://colin-sullivan.net/main/2019/performance-environment/)