Implement proper user settings.

Author: ajboni

.config.yaml

@@ -0,0 +1,3 @@
+# Add here the settings you wish to override
+INPUT_L: "PulseAudio JACK Sink:front-left"
+INPUT_MODE: "stereo"

README.md

@@ -5,7 +5,8 @@ Calvo is a [jalv](http://drobilla.net/software/jalv) based LV2 plugin browser an
 ![calvo](static/img/2020-07-27.png)
 ![connections](static/img/2020-07-27-connections.gif)
 
-# Features 
+# Features
+
 - Runs entirely on the terminal.
 - Suports launching multiple instances of jalv and eventually calvo.
 - Category based plugin browser.
@@ -15,16 +16,17 @@ Calvo is a [jalv](http://drobilla.net/software/jalv) based LV2 plugin browser an
 - Load plugin presets.
 - Move plugins order.
 - Alpha
-  
+
 # Limitations
+
 - No GUI customization is loaded, any plugin which has a UI based workflow won't work properly.
 - Only works with mono or stereo inputs/outputs.
 - Monitoring is best effort and should not be taken too seriously.
 
 ### Roadmap to 1.0: [Milestone](https://github.com/ajboni/calvo/milestone/1)
 
-
 # Dependencies
+
 It uses:
 
 - [jalv](http://drobilla.net/software/jalv) to host plugins
@@ -33,7 +35,8 @@ It uses:
 - nodejs to glue all together
 
 # Settings
-Modify `settings.js` with your settings, more info [in the docs](https://ajboni.github.io/calvo/module-settings.html).
+
+Modify `.config.yaml` with your settings, more info [in the docs](https://ajboni.github.io/calvo/module-settings.html).
 
 # Keyboard shortcuts
 
@@ -49,12 +52,13 @@ Modify `settings.js` with your settings, more info [in the docs](https://ajboni.
 - `CTRL + up/down` Swap plugins up/down
 
 ### Plugin parameters widget
+
 - `up/down / TAB` Cycle through each parameter.
 - `left/right` Change parameter value by default step.
 - `SHIFT + left/right` Change parameter value by small step.
 - `CTRL + left/right` Change parameter value by big step.
 - `page_up/page_down` Change parameter value by 1/5 of the maximum allowed
-  
+
 # DEV
 
 Still need to figure out a way to distribute this.
@@ -74,6 +78,7 @@ npm start
 Dev Documentation is available at: https://ajboni.github.io/calvo/
 
 To build doc locally:
+
 ```
 npm run document
 ```

package-lock.json

@@ -23,6 +23,7 @@
   "dependencies": {
     "blessed": "^0.1.81",
     "blessed-contrib": "^4.8.20",
+    "js-yaml": "^3.14.0",
     "nanoid": "^3.1.10",
     "neo-blessed": "^0.2.0",
     "pubsub-js": "^1.8.0"

package.json

@@ -1,5 +1,5 @@
 /**
- * User configurable settings to alter how the app works.
+ * Default settings.
  * @module settings
  */
 
@@ -16,22 +16,21 @@ const settings = {
   /** @type {string} Location where to scan folders. */
   LV2_PLUGINS_FOLDER: "/user/lib/lv2",
   /** @type {boolean} If false, it will not scan for plugins on startup (use with caution). */
-  SCAN_PLUGINS: false,
+  SCAN_PLUGINS: true,
   /** @type {number} Ammount to scroll when using page up or page dow keys. */
   SCROLL_AMMOUNT: 10,
   /** @type {"mono"|"stereo"} Define what the default input mode will be.*/
-  DEFAULT_INPUT_MODE: "mono",
+  INPUT_MODE: "mono",
   /** @type {string} Define what the default left input port mode will be. (jack port name: ex: system:capture_1*/
-  DEFAULT_INPUT_L: "PulseAudio JACK Sink:front-left",
-  //   DEFAULT_INPUT_L: "system:capture_1",
+  INPUT_L: "system:capture_1",
   /** @type {string} Define what the default right input port mode will be. (jack port name: ex: system:capture_1*/
-  DEFAULT_INPUT_R: "system:capture_2",
+  INPUT_R: "system:capture_2",
   /** @type {"mono"|"stereo"} Define what the default output mode will be.*/
-  DEFAULT_OUTPUT_MODE: "stereo",
+  OUTPUT_MODE: "stereo",
   /** @type {string} Left Channel for the master output. Last plug	in will connect to this. */
-  DEFAULT_OUTPUT_L: "system:playback_1",
+  OUTPUT_L: "system:playback_1",
   /** @type {string} Right Channel for the master output. Last plugin will connect to this. */
-  DEFAULT_OUTPUT_R: "system:playback_2",
+  OUTPUT_R: "system:playback_2",
   /** @type {boolean} Each time a plugin is added its connected to the previous and to the master output. Setting this to false will leave connections to the user. */
   AUTO_CONNECT: true,
   /** @type {boolean} Whether to reconnect all plugins or not automatically after significant changes. If false, user will have to manually reconnect with the button */

settings.js

@@ -16,6 +16,7 @@ const screen = blessed.screen({
 });
 
 try {
+  store.loadUserSettings();
   LV2.init();
   Jack.init();
 
@@ -36,12 +37,12 @@ Jack.poll();
 // Set up polling
 let jackPoll = setInterval(() => {
   Jack.poll();
-}, settings.JACK_POLLING_RATE);
+}, store.app.SETTINGS.JACK_POLLING_RATE);
 
 let uiPoll = setInterval(() => {
   store.notifySubscribers();
   screen.render();
-}, settings.UI_UPDATE_RATE);
+}, store.app.SETTINGS.UI_UPDATE_RATE);
 
 function exit() {
   store.clearRack();

src/app.js

@@ -151,12 +151,12 @@ async function connectPorts(
  * @param {boolean} [addToQueue=false] If true, add it to the 'connectPlugins' queue instead of inmediately firing. Queue should be processed manually after.
  */
 function connectPlugins(src, dst, disconnect = false, addToQueue = false) {
-  const il = store.getJackStatus().CONNECTIONS.inputLeft;
-  const ir = store.getJackStatus().CONNECTIONS.inputRight;
-  const im = store.getJackStatus().CONNECTIONS.inputMode;
-  const ol = store.getJackStatus().CONNECTIONS.outputLeft;
-  const or = store.getJackStatus().CONNECTIONS.outputRight;
-  const om = store.getJackStatus().CONNECTIONS.outputMode;
+  const il = store.app.SETTINGS.INPUT_L;
+  const ir = store.app.SETTINGS.INPUT_R;
+  const im = store.app.SETTINGS.INPUT_MODE;
+  const ol = store.app.SETTINGS.OUTPUT_L;
+  const or = store.app.SETTINGS.OUTPUT_R;
+  const om = store.app.SETTINGS.OUTPUT_MODE;
   const instanceName = `calvo_${store.app.APP_ID}`;
 
   //   Direct Monitor not supported right now (It may conflict on multi instance mode.)

src/jack_client.js

@@ -104,7 +104,7 @@ async function spawn_plugin(plugin, rackIndex) {
   plugin.process = process;
   plugin.info.processQueueInterval = setInterval(
     () => processQueue(plugin),
-    settings.JALV_POLLING_RATE
+    store.app.SETTINGS.JALV_POLLING_RATE
   );
 
   return process;
@@ -156,7 +156,10 @@ async function processQueue(plugin) {
     store.notifySubscribers("pluginControlsChanged", plugin);
   } else {
     // At last, if nothing else is printing output, we can now get some monitor info.
-    if (settings.JALV_MONITORING && plugin.ports.control.output.length > 0) {
+    if (
+      store.app.SETTINGS.JALV_MONITORING &&
+      plugin.ports.control.output.length > 0
+    ) {
       const result = await writeWait(plugin.process, "monitors");
       // Sometimes we cannot get info and we get corrupted result, lets use the previous value for now.
       if (result) {

src/jalv.js

@@ -16,7 +16,7 @@ const Layout = require("./layout");
 function init() {
   if (
     existsSync(path.join(__dirname, "pluginCatalog.json")) &&
-    !settings.SCAN_PLUGINS
+    !store.app.SETTINGS.SCAN_PLUGINS
   ) {
     console.log("Loading plugins cache...");
     store.loadCache();