ableton-js 2.1.8 → 2.3.0

package/CHANGELOG.md

@@ -4,8 +4,31 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v2.3.0](https://github.com/leolabs/ableton.js/compare/v2.2.1-0...v2.3.0)
+
+- :sparkles: Add the clip's name as an observable property [`78c9969`](https://github.com/leolabs/ableton.js/commit/78c99694e8e230ad4ecb022316ebed731994fc6f)
+
+#### [v2.2.1-0](https://github.com/leolabs/ableton.js/compare/v2.2.0...v2.2.1-0)
+
+> 26 March 2022
+
+- :sparkles: Implement basic Application interface to fetch live version and dialog information [`5aba86f`](https://github.com/leolabs/ableton.js/commit/5aba86f811ff36d43a99a657a2789e3d9ac59cce)
+- :white_check_mark: Add tests for the application namespace [`9954cdf`](https://github.com/leolabs/ableton.js/commit/9954cdf724a41d8705a62fa50ac5cb06b162e1f1)
+- :sparkles: Add support for listing clips in arrangement view [`e7df690`](https://github.com/leolabs/ableton.js/commit/e7df69060ccc7e098b1b4f5d418a79a60d57c4ce)
+
+#### [v2.2.0](https://github.com/leolabs/ableton.js/compare/v2.1.8...v2.2.0)
+
+> 18 March 2022
+
+- :memo: Fix details in readme [`#36`](https://github.com/leolabs/ableton.js/pull/36)
+- :bug: Fix errors on quick disconnect/connect [`#42`](https://github.com/leolabs/ableton.js/pull/42)
+- :bug: Fix connected status on load of Ableton class [`#40`](https://github.com/leolabs/ableton.js/pull/40)
+- :wrench: Add GitHub repo to NPM page [`#39`](https://github.com/leolabs/ableton.js/pull/39)
+
 #### [v2.1.8](https://github.com/leolabs/ableton.js/compare/v2.1.7...v2.1.8)
 
+> 18 February 2022
+
 - :sparkles: Add observable props for quantization [`ffd192d`](https://github.com/leolabs/ableton.js/commit/ffd192d1590f33cdd18c2e01dbf66a0bc67878e4)
 
 #### [v2.1.7](https://github.com/leolabs/ableton.js/compare/v2.1.6...v2.1.7)

package/README.md

@@ -22,8 +22,7 @@ get an overview of the current of your set.
 
 To use this library, you'll need to install and activate the MIDI Remote Script
 in Ableton.js. To do that, copy the `midi-script` folder of this repo to
-Ableton's Remote Scripts folder. If you prefer, you can rename it to something
-like `AbletonJS` for better identification. The MIDI Remote Scripts folder is
+Ableton's Remote Scripts folder and rename it to `AbletonJS`. The MIDI Remote Scripts folder is
 usually located at:
 
 - **Windows:** {path to Ableton}\Resources\MIDI\Remote Scripts
@@ -55,8 +54,8 @@ const test = async () => {
   ableton.song.addListener("is_playing", (p) => console.log("Playing:", p));
   ableton.song.addListener("tempo", (t) => console.log("Tempo:", t));
 
-  const cues = await ableton.get("cue_points");
-  console.log(cues.map((c) => c.raw));
+  const tempo = await ableton.song.get("tempo");
+  console.log(tempo);
 };
 
 test();

package/index.d.ts

@@ -2,6 +2,7 @@
 import { EventEmitter } from "events";
 import { Song } from "./ns/song";
 import { Internal } from "./ns/internal";
+import { Application } from "./ns/application";
 interface Command {
     uuid: string;
     ns: string;
@@ -42,6 +43,7 @@ export declare class Ableton extends EventEmitter implements ConnectionEventEmit
     private buffer;
     private latency;
     song: Song;
+    application: Application;
     internal: Internal;
     constructor(host?: string, sendPort?: number, listenPort?: number, heartbeatInterval?: number);
     close(): void;

package/index.js

@@ -67,6 +67,7 @@ var semver_1 = __importDefault(require("semver"));
 var zlib_1 = require("zlib");
 var song_1 = require("./ns/song");
 var internal_1 = require("./ns/internal");
+var application_1 = require("./ns/application");
 var package_version_1 = require("./util/package-version");
 var TimeoutError = /** @class */ (function (_super) {
     __extends(TimeoutError, _super);
@@ -92,11 +93,12 @@ var Ableton = /** @class */ (function (_super) {
         _this.listenPort = listenPort;
         _this.msgMap = new Map();
         _this.eventListeners = new Map();
-        _this._isConnected = true;
+        _this._isConnected = false;
         _this.cancelConnectionEvent = false;
         _this.buffer = [];
         _this.latency = 0;
         _this.song = new song_1.Song(_this);
+        _this.application = new application_1.Application(_this);
         _this.internal = new internal_1.Internal(_this);
         _this.client = dgram_1.default.createSocket({ type: "udp4", reuseAddr: true });
         _this.client.bind(_this.listenPort, host);
@@ -123,6 +125,7 @@ var Ableton = /** @class */ (function (_super) {
                         if (this._isConnected && !this.cancelConnectionEvent) {
                             this._isConnected = false;
                             this.eventListeners.clear();
+                            this.msgMap.forEach(function (msg) { return msg.clearTimeout(); });
                             this.msgMap.clear();
                             this.emit("disconnect", "heartbeat");
                         }
@@ -188,8 +191,9 @@ var Ableton = /** @class */ (function (_super) {
             return functionCallback.rej(new Error(data.data));
         }
         if (data.event === "disconnect") {
-            this.msgMap.clear();
             this.eventListeners.clear();
+            this.msgMap.forEach(function (msg) { return msg.clearTimeout(); });
+            this.msgMap.clear();
             if (this._isConnected === true) {
                 this._isConnected = false;
                 this.cancelConnectionEvent = true;
@@ -236,7 +240,7 @@ var Ableton = /** @class */ (function (_super) {
                             rej(new TimeoutError([
                                 "The command " + cls + "." + name + "(" + arg + ") timed out after " + timeout + " ms.",
                                 "Please make sure that Ableton is running and that you have the latest",
-                                "version of AbletonJS' midi script installed, listening on port",
+                                "version of AbletonJS' midi script installed and renamed to \"AbletonJS\", listening on port",
                                 _this.sendPort + " and sending on port " + _this.listenPort + ".",
                             ].join(" "), payload));
                         }, timeout);
@@ -248,6 +252,9 @@ var Ableton = /** @class */ (function (_super) {
                                 res(data);
                             },
                             rej: rej,
+                            clearTimeout: function () {
+                                clearTimeout(timeoutId);
+                            },
                         });
                         _this.sendRaw(msg);
                     })];

package/midi-script/AbletonJS.py

@@ -3,6 +3,7 @@ import sys
 
 from .Socket import Socket
 from .Interface import Interface
+from .Application import Application
 from .CuePoint import CuePoint
 from .Device import Device
 from .DeviceParameter import DeviceParameter
@@ -14,6 +15,7 @@ from .Internal import Internal
 from .ClipSlot import ClipSlot
 from .Clip import Clip
 from _Framework.ControlSurface import ControlSurface
+from Live.Base import Timer
 
 
 class AbletonJS(ControlSurface):
@@ -25,6 +27,7 @@ class AbletonJS(ControlSurface):
         self.socket = Socket(self.command_handler)
 
         self.handlers = {
+            "application": Application(c_instance, self.socket, self.application()),
             "internal": Internal(c_instance, self.socket),
             "cue-point": CuePoint(c_instance, self.socket),
             "device": Device(c_instance, self.socket),
@@ -37,21 +40,21 @@ class AbletonJS(ControlSurface):
             "clip": Clip(c_instance, self.socket)
         }
 
-        self.parse()
+        self.recv_loop = Timer(
+            callback=self.socket.process, interval=10, repeat=True)
+
+        self.recv_loop.start()
 
         self.socket.send("connect")
 
     def disconnect(self):
         self.log_message("Disconnecting")
+        self.recv_loop.stop()
         self.socket.send("disconnect")
         self.socket.shutdown()
         Interface.listeners.clear()
         super(AbletonJS, self).disconnect()
 
-    def parse(self):
-        self.socket.process()
-        self.schedule_message(1, self.parse)
-
     def command_handler(self, payload):
         self.log_message("Received command: " + str(payload))
         namespace = payload["ns"]

package/midi-script/Application.py

@@ -0,0 +1,26 @@
+from __future__ import absolute_import
+from .Interface import Interface
+
+import Live
+
+
+class Application(Interface):
+    def __init__(self, c_instance, socket, application):
+        super(Application, self).__init__(c_instance, socket)
+        self.application = application
+        self.log_message("Version: " + self.get_version(self.get_ns()))
+
+    def get_ns(self, nsid=None):
+        return self.application
+
+    def get_major_version(self, ns):
+        return ns.get_major_version()
+
+    def get_minor_version(self, ns):
+        return ns.get_minor_version()
+
+    def get_bugfix_version(self, ns):
+        return ns.get_bugfix_version()
+
+    def get_version(self, ns):
+        return str(ns.get_major_version()) + "." + str(ns.get_minor_version()) + "." + str(ns.get_bugfix_version())

package/midi-script/Clip.py

@@ -11,6 +11,7 @@ class Clip(Interface):
         clip_id = Interface.save_obj(clip)
         return {
             "id": clip_id,
+            "name": clip.name,
             "color": clip.color,
             "is_audio_clip": clip.is_audio_clip,
             "is_midi_clip": clip.is_midi_clip,

package/midi-script/Internal.py

@@ -10,4 +10,4 @@ class Internal(Interface):
         return self
 
     def get_version(self, ns):
-        return "2.1.8"
+        return "2.3.0"

package/midi-script/Socket.py

@@ -82,19 +82,23 @@ class Socket(object):
     def process(self):
         try:
             buffer = bytes()
+            num_messages = 0
             while 1:
-                data = self._socket.recv(65536)
+                data = self._socket.recv(8192)
                 if len(data) and self.input_handler:
                     buffer += data[1:]
+                    num_messages += 1
 
                     # \xFF for Live 10 (Python2) and 255 for Live 11 (Python3)
                     if(data[0] == b'\xFF' or data[0] == 255):
                         unzipped = zlib.decompress(buffer)
                         payload = json.loads(unzipped)
 
-                        self.log_message("Receiving: " + str(payload))
+                        self.log_message(
+                            "Receiving from " + str(num_messages) + " messages, " + str(len(buffer)) + " bytes: " + str(payload))
                         self.input_handler(payload)
                         buffer = bytes()
+                        num_messages = 0
         except socket.error as e:
             return
         except Exception as e:

package/midi-script/Track.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import
 from .Interface import Interface
 from .Device import Device
+from .Clip import Clip
 from .ClipSlot import ClipSlot
 
 
@@ -16,6 +17,9 @@ class Track(Interface):
     def __init__(self, c_instance, socket):
         super(Track, self).__init__(c_instance, socket)
 
+    def get_arrangement_clips(self, ns):
+        return list(map(Clip.serialize_clip, ns.arrangement_clips))
+
     def get_devices(self, ns):
         return list(map(Device.serialize_device, ns.devices))
 

package/ns/application.d.ts

@@ -0,0 +1,22 @@
+import { Ableton } from "..";
+import { Namespace } from ".";
+export interface GettableProperties {
+    bugfix_version: number;
+    major_version: number;
+    minor_version: number;
+    version: string;
+    current_dialog_button_count: number;
+    current_dialog_message: string;
+    open_dialog_count: number;
+}
+export interface TransformedProperties {
+}
+export interface SettableProperties {
+}
+export interface ObservableProperties {
+    open_dialog_count: number;
+}
+export declare class Application extends Namespace<GettableProperties, TransformedProperties, SettableProperties, ObservableProperties> {
+    constructor(ableton: Ableton);
+    pressCurrentDialogButton(index: number): Promise<any>;
+}

package/ns/application.js

@@ -0,0 +1,70 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Application = void 0;
+var _1 = require(".");
+var Application = /** @class */ (function (_super) {
+    __extends(Application, _super);
+    function Application(ableton) {
+        return _super.call(this, ableton, "application") || this;
+    }
+    Application.prototype.pressCurrentDialogButton = function (index) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.sendCommand("press_current_dialog_button", [index])];
+            });
+        });
+    };
+    return Application;
+}(_1.Namespace));
+exports.Application = Application;

package/ns/application.spec.d.ts

@@ -0,0 +1 @@
+import "jest-extended";

package/ns/application.spec.js

@@ -0,0 +1,70 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var tests_1 = require("../util/tests");
+require("jest-extended");
+var gettableProps = [
+    "major_version",
+    "minor_version",
+    "bugfix_version",
+    "version",
+    "open_dialog_count",
+    "current_dialog_message",
+    "current_dialog_button_count",
+];
+describe("Application", function () {
+    it("should be able to read all properties without erroring", function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, tests_1.withAbleton(function (ab) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            switch (_a.label) {
+                                case 0: return [4 /*yield*/, Promise.all(gettableProps.map(function (p) { return ab.application.get(p); }))];
+                                case 1:
+                                    _a.sent();
+                                    return [2 /*return*/];
+                            }
+                        });
+                    }); })];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});

package/ns/clip.d.ts

@@ -115,6 +115,7 @@ export interface ObservableProperties {
     is_recording: boolean;
     loop_end: number;
     loop_start: number;
+    name: string;
     pitch_coarse: number;
     pitch_fine: number;
     playing_position: number;
@@ -127,6 +128,7 @@ export interface ObservableProperties {
 }
 export interface RawClip {
     id: number;
+    name: string;
     color: number;
     is_audio_clip: boolean;
     is_midi_clip: boolean;

package/ns/song.spec.js

@@ -143,7 +143,7 @@ describe("Song", function () {
                             switch (_a.label) {
                                 case 0:
                                     largeArray = [];
-                                    for (i = 0; i < 10000; i++) {
+                                    for (i = 0; i < 100000; i++) {
                                         largeArray.push(i);
                                     }
                                     return [4 /*yield*/, ab.song.setData("abletonjs_test", largeArray)];

package/ns/track.d.ts

@@ -2,9 +2,11 @@ import { Ableton } from "..";
 import { Namespace } from ".";
 import { Device, RawDevice } from "./device";
 import { ClipSlot, RawClipSlot } from "./clip-slot";
+import { Clip, RawClip } from "./clip";
 import { Color } from "../util/color";
 export interface GettableProperties {
     arm: boolean;
+    arrangement_clips: RawClip[];
     can_be_armed: boolean;
     can_be_frozen: boolean;
     can_show_chains: boolean;
@@ -48,6 +50,7 @@ export interface TransformedProperties {
     color: Color;
     devices: Device[];
     clip_slots: ClipSlot[];
+    arrangement_clips: Clip[];
 }
 export interface SettableProperties {
     arm: boolean;
@@ -77,6 +80,7 @@ export interface SettableProperties {
 }
 export interface ObservableProperties {
     arm: number;
+    arrangement_clips: RawClip[];
     clip_slots: RawClipSlot[];
     color_index: number;
     color: number;

package/ns/track.js

@@ -19,6 +19,7 @@ exports.Track = void 0;
 var _1 = require(".");
 var device_1 = require("./device");
 var clip_slot_1 = require("./clip-slot");
+var clip_1 = require("./clip");
 var color_1 = require("../util/color");
 var Track = /** @class */ (function (_super) {
     __extends(Track, _super);
@@ -26,10 +27,13 @@ var Track = /** @class */ (function (_super) {
         var _this = _super.call(this, ableton, "track", raw.id) || this;
         _this.raw = raw;
         _this.transformers = {
+            arrangement_clips: function (clips) {
+                return clips.map(function (clip) { return new clip_1.Clip(ableton, clip); });
+            },
             color: function (c) { return new color_1.Color(c); },
-            devices: function (devices) { return devices.map(function (d) { return new device_1.Device(_this.ableton, d); }); },
+            devices: function (devices) { return devices.map(function (d) { return new device_1.Device(ableton, d); }); },
             clip_slots: function (clip_slots) {
-                return clip_slots.map(function (c) { return new clip_slot_1.ClipSlot(_this.ableton, c); });
+                return clip_slots.map(function (c) { return new clip_slot_1.ClipSlot(ableton, c); });
             },
         };
         return _this;

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "ableton-js",
-  "version": "2.1.8",
+  "version": "2.3.0",
   "description": "Control Ableton Live from Node",
   "main": "index.js",
   "author": "Leo Bernard <admin@leolabs.org>",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/leolabs/ableton-js.git"
+  },
   "files": [
     "**/*.js",
     "**/*.d.ts",
@@ -16,7 +20,7 @@
     "ableton10:launch": "set -- /Applications/Ableton*10* && open \"$1\"",
     "ableton11:copy-script": "set -- /Applications/Ableton*11*/Contents/App-Resources/MIDI\\ Remote\\ Scripts && rm -rf \"$1/AbletonJS\" && cp -r \"$(pwd)/midi-script\" \"$1/AbletonJS\" && rm -rf \"$1/AbletonJS/_Framework\"",
     "ableton11:launch": "set -- /Applications/Ableton*11* && open \"$1\"",
-    "ableton:logs": "tail -f ~/Library/Preferences/Ableton/*/Log.txt | grep -i -e RemoteScriptError -e RemoteScriptMessage | grep -i -e AbletonJS",
+    "ableton:logs": "tail -f ~/Library/Preferences/Ableton/*/Log.txt | grep -i -e RemoteScriptError -e RemoteScriptMessage",
     "ableton:kill": "pkill -KILL -f \"Ableton Live\"",
     "ableton10:start": "yarn ableton:kill; yarn ableton:clean && yarn ableton10:copy-script && yarn ableton10:launch && yarn ableton:logs",
     "ableton11:start": "yarn ableton:kill; yarn ableton:clean && yarn ableton11:copy-script && yarn ableton11:launch && yarn ableton:logs",