ableton-js 3.2.10 → 3.3.0

package/CHANGELOG.md

@@ -4,8 +4,24 @@ 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).
 
+#### [v3.3.0](https://github.com/leolabs/ableton.js/compare/v3.2.11...v3.3.0)
+
+- Browsing and loading functionalities [`bc48c7c`](https://github.com/leolabs/ableton.js/commit/bc48c7c46c55c54baca42c58003865596370afe3)
+- :art: Improve formatting [`6e2e22b`](https://github.com/leolabs/ableton.js/commit/6e2e22b102cf560d39c07e60ae1afd7e2ecc851b)
+- :sparkles: Turn the browser into a singleton [`6d0152b`](https://github.com/leolabs/ableton.js/commit/6d0152b4610683460256951801ada08f8598abeb)
+
+#### [v3.2.11](https://github.com/leolabs/ableton.js/compare/v3.2.10...v3.2.11)
+
+> 15 July 2023
+
+- :loud_sound: Warn when the UDP tick is lagging or when processing UDP takes too long to finish [`c419afc`](https://github.com/leolabs/ableton.js/commit/c419afc96de5b5834ae2807baf8fc4b3fb9c21ba)
+- :sparkles: Use larger buffer sizes if possible for sending responses from Live [`ae480cb`](https://github.com/leolabs/ableton.js/commit/ae480cb6e86fcbbb4e0417b0869a5a78d43511c6)
+- :memo: Update docs to reflect that chunks now have a dynamic size [`83afbb6`](https://github.com/leolabs/ableton.js/commit/83afbb6431a28883fdc459e31081b94bd9c6b54a)
+
 #### [v3.2.10](https://github.com/leolabs/ableton.js/compare/v3.2.9...v3.2.10)
 
+> 15 July 2023
+
 - :sparkles: Remove the socket after closing it to avoid dangling event listeners trying to send messages after the plugin has been shut down [`54278f2`](https://github.com/leolabs/ableton.js/commit/54278f2b4ccb6efe34592fc108cd10c35e404e58)
 
 #### [v3.2.9](https://github.com/leolabs/ableton.js/compare/v3.2.8...v3.2.9)

package/README.md

@@ -103,11 +103,11 @@ port in a local file so the other side knows which port to send messages to.
 ### Compression and Chunking
 
 To allow sending large JSON payloads, requests to and responses from the MIDI
-Script are compressed using gzip and chunked every 7500 bytes. The first byte of
-every message contains the chunk index (0x00-0xFF) followed by the gzipped
-chunk. The last chunk always has the index 0xFF. This indicates to the JS
-library that the previous received messages should be stiched together,
-unzipped, and processed.
+Script are compressed using gzip and chunked to fit into the maximum allowed
+package size. The first byte of every message chunk contains the chunk index
+(0x00-0xFF) followed by the gzipped chunk. The last chunk always has the index
+0xFF. This indicates to the JS library that the previous received messages
+should be stiched together, unzipped, and processed.
 
 ### Caching
 

package/index.js

@@ -434,9 +434,7 @@ class Ableton extends events_1.EventEmitter {
             throw new Error("The client hasn't been started yet. Please call start() first.");
         }
         const buffer = (0, zlib_1.deflateSync)(Buffer.from(msg));
-        // Based on this thread, 7500 bytes seems like a safe value
-        // https://stackoverflow.com/questions/22819214/udp-message-too-long
-        const byteLimit = 7500;
+        const byteLimit = this.client.getSendBufferSize() - 1;
         const chunks = Math.ceil(buffer.byteLength / byteLimit);
         // Split the message into chunks if it becomes too large
         for (let i = 0; i < chunks; i++) {

package/midi-script/AbletonJS.py

@@ -1,4 +1,5 @@
 from __future__ import absolute_import
+import time
 
 from .version import version
 from .Config import DEBUG, FAST_POLLING
@@ -6,6 +7,8 @@ from .Socket import Socket
 from .Interface import Interface
 from .Application import Application
 from .ApplicationView import ApplicationView
+from .Browser import Browser
+from .BrowserItem import BrowserItem
 from .CuePoint import CuePoint
 from .Device import Device
 from .DeviceParameter import DeviceParameter
@@ -37,6 +40,8 @@ class AbletonJS(ControlSurface):
         self.handlers = {
             "application": Application(c_instance, self.socket, self.application()),
             "application-view": ApplicationView(c_instance, self.socket, self.application()),
+            "browser": Browser(c_instance, self.socket, self.application()),
+            "browser-item": BrowserItem(c_instance, self.socket),
             "cue-point": CuePoint(c_instance, self.socket),
             "device": Device(c_instance, self.socket),
             "device-parameter": DeviceParameter(c_instance, self.socket),
@@ -51,6 +56,7 @@ class AbletonJS(ControlSurface):
             "clip": Clip(c_instance, self.socket),
         }
 
+        self._last_tick = time.time() * 1000
         self.tick()
 
         if FAST_POLLING:
@@ -60,7 +66,21 @@ class AbletonJS(ControlSurface):
             self.recv_loop.start()
 
     def tick(self):
+        tick_time = time.time() * 1000
+
+        if tick_time - self._last_tick > 200:
+            self.log_message("UDP tick is lagging, delta: " +
+                             str(round(tick_time - self._last_tick)) + "ms")
+
+        self._last_tick = tick_time
         self.socket.process()
+
+        process_time = time.time() * 1000
+
+        if process_time - tick_time > 100:
+            self.log_message("UDP processing is taking long, delta: " +
+                             str(round(tick_time - process_time)) + "ms")
+
         self.schedule_message(1, self.tick)
 
     def build_midi_map(self, midi_map_handle):

package/midi-script/Browser.py

@@ -0,0 +1,66 @@
+from __future__ import absolute_import
+from .Interface import Interface
+from .BrowserItem import BrowserItem
+
+
+class Browser(Interface):
+    def __init__(self, c_instance, socket, application):
+        super(Browser, self).__init__(c_instance, socket)
+        self.application = application
+
+    def get_ns(self, nsid=None):
+        return self.application.browser
+
+    def get_audio_effects(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.audio_effects.children)
+
+    def get_clips(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.clips.children)
+
+    def get_colors(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.colors)
+
+    def get_current_project(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.current_project.children)
+
+    def get_drums(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.drums.children)
+
+    def get_instruments(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.instruments.children)
+
+    def get_max_for_live(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.max_for_live.children)
+
+    def get_midi_effects(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.midi_effects.children)
+
+    def get_packs(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.packs.children)
+
+    def get_plugins(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.plugins.children)
+
+    def get_samples(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.samples.children)
+
+    def get_sounds(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.sounds.children)
+
+    def get_user_folders(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.user_folders)
+
+    def get_user_library(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.user_library.children)
+
+    def get_hotswap_target(self, ns):
+        return BrowserItem.serialize_browser_item(ns.hotswap_target)
+
+    def load_item(self, ns, id):
+        return ns.load_item(self.get_obj(id))
+
+    def preview_item(self, ns, id):
+        return ns.preview_item(self.get_obj(id))
+
+    def stop_preview(self, ns):
+        return ns.stop_preview()

package/midi-script/BrowserItem.py

@@ -0,0 +1,26 @@
+from __future__ import absolute_import
+from .Interface import Interface
+
+
+class BrowserItem(Interface):
+    @staticmethod
+    def serialize_browser_item(browser_item):
+        if browser_item is None:
+            return None
+        browser_item_id = Interface.save_obj(browser_item)
+        return {
+            "id": browser_item_id,
+            "name": browser_item.name,
+            "is_loadable": browser_item.is_loadable,
+            "is_selected": browser_item.is_selected,
+            "is_device": browser_item.is_device,
+            "is_folder": browser_item.is_folder,
+            "source": browser_item.source,
+            "uri": browser_item.uri,
+        }
+
+    def __init__(self, c_instance, socket):
+        super(BrowserItem, self).__init__(c_instance, socket)
+
+    def get_children(self, ns):
+        return map(BrowserItem.serialize_browser_item, ns.children)

package/midi-script/Socket.py

@@ -114,6 +114,12 @@ class Socket(object):
             self._socket.bind(self._server_addr)
             port = self._socket.getsockname()[1]
 
+            # Get the chunk limit of the socket, minus 1 for the ordering byte
+            self._chunk_limit = self._socket.getsockopt(
+                socket.SOL_SOCKET, socket.SO_SNDBUF) - 1
+
+            self.log_message("Chunk limit: " + str(self._chunk_limit))
+
             # Write the chosen port to a file
             try:
                 if stored_port != port:
@@ -147,17 +153,14 @@ class Socket(object):
     def _sendto(self, msg):
         '''Send a raw message to the client, compressed and chunked, if necessary'''
         compressed = zlib.compress(msg.encode("utf8")) + b'\n'
-        # Based on this thread, 7500 bytes seems like a safe value
-        # https://stackoverflow.com/questions/22819214/udp-message-too-long
-        limit = 7500
 
         if self._socket == None:
             return
 
-        if len(compressed) < limit:
+        if len(compressed) < self._chunk_limit:
             self._socket.sendto(b'\xFF' + compressed, self._client_addr)
         else:
-            chunks = list(split_by_n(compressed, limit))
+            chunks = list(split_by_n(compressed, self._chunk_limit))
             count = len(chunks)
             for i, chunk in enumerate(chunks):
                 count_byte = struct.pack("B", i if i + 1 < count else 255)
@@ -188,7 +191,7 @@ class Socket(object):
             buffer = bytes()
             num_messages = 0
             while 1:
-                data = self._socket.recv(8192)
+                data = self._socket.recv(65536)
                 if len(data) and self.input_handler:
                     buffer += data[1:]
                     num_messages += 1

package/midi-script/Song.py

@@ -4,12 +4,17 @@ from .CuePoint import CuePoint
 from .Device import Device
 from .Scene import Scene
 from .Track import Track
+import Live
 
+INSERT_MODES = {'default':Live.Track.DeviceInsertMode.default, 
+ 'left':Live.Track.DeviceInsertMode.selected_left, 
+ 'right':Live.Track.DeviceInsertMode.selected_right}
 
 class Song(Interface):
     def __init__(self, c_instance, socket):
         super(Song, self).__init__(c_instance, socket)
         self.song = self.ableton.song()
+        self._insert_mode = INSERT_MODES['default']
 
     def get_ns(self, nsid):
         return self.song
@@ -60,3 +65,7 @@ class Song(Interface):
 
     def set_appointed_device(self, ns, device_id):
         ns.appointed_device = Interface.get_obj(device_id)
+
+    def set_insert_mode(self,ns, args):
+        self._insert_mode = INSERT_MODES.get(str(args), INSERT_MODES['default'])
+        self.song.view.selected_track.view.device_insert_mode = self._insert_mode

package/midi-script/version.py

@@ -1 +1 @@
-version = "3.2.10"
+version = "3.3.0"

package/ns/application.d.ts

@@ -1,6 +1,7 @@
 import { Ableton } from "..";
 import { Namespace } from ".";
 import { ApplicationView } from "./application-view";
+import { Browser, RawBrowser } from "./browser";
 export interface GettableProperties {
     bugfix_version: number;
     major_version: number;
@@ -9,8 +10,10 @@ export interface GettableProperties {
     current_dialog_button_count: number;
     current_dialog_message: string;
     open_dialog_count: number;
+    browser: RawBrowser;
 }
 export interface TransformedProperties {
+    browser: Browser;
 }
 export interface SettableProperties {
 }
@@ -19,6 +22,7 @@ export interface ObservableProperties {
 }
 export declare class Application extends Namespace<GettableProperties, TransformedProperties, SettableProperties, ObservableProperties> {
     constructor(ableton: Ableton);
+    browser: Browser;
     view: ApplicationView;
     pressCurrentDialogButton(index: number): Promise<any>;
 }

package/ns/application.js

@@ -3,10 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Application = void 0;
 const _1 = require(".");
 const application_view_1 = require("./application-view");
+const browser_1 = require("./browser");
 class Application extends _1.Namespace {
     constructor(ableton) {
         super(ableton, "application");
     }
+    browser = new browser_1.Browser(this.ableton);
     view = new application_view_1.ApplicationView(this.ableton);
     async pressCurrentDialogButton(index) {
         return this.sendCommand("press_current_dialog_button", [index]);

package/ns/browser-item.d.ts

@@ -0,0 +1,34 @@
+import { Ableton } from "..";
+import { Namespace } from ".";
+export interface RawBrowserItem {
+    id: string;
+    children: RawBrowserItem[];
+    name: string;
+    is_loadable: boolean;
+    is_selected: boolean;
+    is_device: boolean;
+    is_folder: boolean;
+    source: string;
+    uri: string;
+}
+export interface GettableProperties {
+    children: RawBrowserItem[];
+    is_device: boolean;
+    is_folder: boolean;
+    is_loadable: boolean;
+    is_selected: boolean;
+    name: string;
+    source: string;
+    uri: string;
+}
+export interface TransformedProperties {
+    children: BrowserItem[];
+}
+export interface SettableProperties {
+}
+export interface ObservableProperties {
+}
+export declare class BrowserItem extends Namespace<GettableProperties, TransformedProperties, SettableProperties, ObservableProperties> {
+    raw: RawBrowserItem;
+    constructor(ableton: Ableton, raw: RawBrowserItem);
+}

package/ns/browser-item.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowserItem = void 0;
+const _1 = require(".");
+class BrowserItem extends _1.Namespace {
+    raw;
+    constructor(ableton, raw) {
+        super(ableton, "browser-item", raw.id);
+        this.raw = raw;
+        this.transformers = {
+            children: (children) => children.map((c) => new BrowserItem(ableton, c)),
+        };
+        this.cachedProps = {
+            children: true,
+            is_device: true,
+            is_folder: true,
+            is_loadable: false,
+            is_selected: false,
+            name: true,
+            source: true,
+            uri: true,
+        };
+    }
+}
+exports.BrowserItem = BrowserItem;

package/ns/browser.d.ts

@@ -0,0 +1,55 @@
+import { Ableton } from "..";
+import { Namespace } from ".";
+import { BrowserItem, RawBrowserItem } from "./browser-item";
+export interface GettableProperties {
+    audio_effects: RawBrowserItem[];
+    clips: RawBrowserItem[];
+    colors: RawBrowserItem[];
+    current_project: RawBrowserItem[];
+    drums: RawBrowserItem[];
+    instruments: RawBrowserItem[];
+    max_for_live: RawBrowserItem[];
+    midi_effects: RawBrowserItem[];
+    packs: RawBrowserItem[];
+    plugins: RawBrowserItem[];
+    samples: RawBrowserItem[];
+    sounds: RawBrowserItem[];
+    user_library: RawBrowserItem[];
+    user_folders: RawBrowserItem[];
+    hotswap_target: RawBrowserItem;
+}
+export interface TransformedProperties {
+    audio_effects: BrowserItem[];
+    clips: BrowserItem[];
+    colors: BrowserItem[];
+    current_project: BrowserItem[];
+    drums: BrowserItem[];
+    instruments: BrowserItem[];
+    max_for_live: BrowserItem[];
+    midi_effects: BrowserItem[];
+    packs: BrowserItem[];
+    plugins: BrowserItem[];
+    samples: BrowserItem[];
+    sounds: BrowserItem[];
+    user_library: BrowserItem[];
+    user_folders: BrowserItem[];
+    hotswap_target: BrowserItem;
+}
+export interface SettableProperties {
+}
+export interface ObservableProperties {
+    filter_type: never;
+    hotswap_target: BrowserItem;
+}
+export interface RawBrowser {
+    id: string;
+}
+export declare class Browser extends Namespace<GettableProperties, TransformedProperties, SettableProperties, ObservableProperties> {
+    constructor(ableton: Ableton);
+    /** Loads the provided browser item. */
+    loadItem(item: BrowserItem): Promise<any>;
+    /** Previews the provided browser item. */
+    previewItem(item: BrowserItem): Promise<any>;
+    /** Stops the current preview. */
+    stopPreview(): Promise<any>;
+}

package/ns/browser.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Browser = void 0;
+const _1 = require(".");
+const browser_item_1 = require("./browser-item");
+class Browser extends _1.Namespace {
+    constructor(ableton) {
+        super(ableton, "browser");
+        const makeBrowserItems = (items) => items.map((item) => new browser_item_1.BrowserItem(ableton, item));
+        this.transformers = {
+            audio_effects: makeBrowserItems,
+            clips: makeBrowserItems,
+            colors: makeBrowserItems,
+            current_project: makeBrowserItems,
+            drums: makeBrowserItems,
+            instruments: makeBrowserItems,
+            max_for_live: makeBrowserItems,
+            midi_effects: makeBrowserItems,
+            packs: makeBrowserItems,
+            plugins: makeBrowserItems,
+            samples: makeBrowserItems,
+            sounds: makeBrowserItems,
+            user_library: makeBrowserItems,
+            user_folders: makeBrowserItems,
+            hotswap_target: (t) => new browser_item_1.BrowserItem(ableton, t),
+        };
+        this.cachedProps = {
+            audio_effects: true,
+            clips: true,
+            colors: true,
+            current_project: true,
+            drums: true,
+            instruments: true,
+            max_for_live: true,
+            midi_effects: true,
+            packs: true,
+            plugins: true,
+            samples: true,
+            sounds: true,
+            user_library: true,
+            user_folders: true,
+            hotswap_target: true,
+        };
+    }
+    /** Loads the provided browser item. */
+    async loadItem(item) {
+        return this.sendCommand("load_item", { id: item.raw.id });
+    }
+    /** Previews the provided browser item. */
+    async previewItem(item) {
+        return this.sendCommand("preview_item", { id: item.raw.id });
+    }
+    /** Stops the current preview. */
+    async stopPreview() {
+        return this.sendCommand("stop_preview");
+    }
+}
+exports.Browser = Browser;

package/ns/song.d.ts

@@ -61,6 +61,11 @@ export interface TransformedProperties {
     visible_tracks: Track[];
     scenes: Scene[];
 }
+export declare enum DeviceInsertMode {
+    default = "default",
+    left = "left",
+    right = "right"
+}
 export interface SettableProperties {
     appointed_device: string;
     arrangement_overdub: boolean;
@@ -71,6 +76,7 @@ export interface SettableProperties {
     exclusive_arm: number;
     exclusive_solo: number;
     groove_amount: number;
+    insert_mode: DeviceInsertMode;
     is_counting_in: boolean;
     is_playing: boolean;
     last_event_time: number;
@@ -213,4 +219,5 @@ export declare class Song extends Namespace<GettableProperties, TransformedPrope
     stopPlaying(): Promise<any>;
     tapTempo(): Promise<any>;
     undo(): Promise<any>;
+    set_insert_mode(args: DeviceInsertMode): Promise<any>;
 }

package/ns/song.js

@@ -1,11 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Song = exports.RecordingQuantization = exports.Quantization = exports.TimeFormat = void 0;
+exports.Song = exports.RecordingQuantization = exports.Quantization = exports.TimeFormat = exports.DeviceInsertMode = void 0;
 const _1 = require(".");
 const track_1 = require("./track");
 const cue_point_1 = require("./cue-point");
 const song_view_1 = require("./song-view");
 const scene_1 = require("./scene");
+var DeviceInsertMode;
+(function (DeviceInsertMode) {
+    DeviceInsertMode["default"] = "default";
+    DeviceInsertMode["left"] = "left";
+    DeviceInsertMode["right"] = "right";
+})(DeviceInsertMode || (exports.DeviceInsertMode = DeviceInsertMode = {}));
 var TimeFormat;
 (function (TimeFormat) {
     TimeFormat[TimeFormat["MsTime"] = 0] = "MsTime";
@@ -149,5 +155,8 @@ class Song extends _1.Namespace {
     async undo() {
         return this.sendCommand("undo");
     }
+    async set_insert_mode(args) {
+        return this.sendCommand("set_insert_mode", { args });
+    }
 }
 exports.Song = Song;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ableton-js",
-  "version": "3.2.10",
+  "version": "3.3.0",
   "description": "Control Ableton Live from Node",
   "main": "index.js",
   "author": "Leo Bernard <admin@leolabs.org>",
@@ -19,7 +19,7 @@
     "ableton:copy-script": "set -- ~/Music/Ableton/User\\ Library/Remote\\ Scripts && mkdir -p \"$1\" && rm -rf \"$1/AbletonJS\" && cp -r \"$(pwd)/midi-script\" \"$1/AbletonJS\" && rm -rf \"$1/AbletonJS/_Framework\"",
     "ableton10:launch": "set -- /Applications/Ableton*10* && open \"$1\"",
     "ableton11:launch": "set -- /Applications/Ableton*11* && open \"$1\"",
-    "ableton:logs": "tail -n 50 -f ~/Library/Preferences/Ableton/*/Log.txt | grep -i -e RemoteScriptError -e RemoteScriptMessage",
+    "ableton:logs": "tail -n 50 -f ~/Library/Preferences/Ableton/*/Log.txt | grep --line-buffered -i -e RemoteScriptError -e RemoteScriptMessage | sed 's/info: RemoteScriptMessage: (AbletonJS) //'",
     "ableton:kill": "pkill -KILL -f \"Ableton Live\"",
     "ableton10:start": "yarn ableton:kill; yarn ableton:clean && yarn ableton:copy-script && yarn ableton10:launch && yarn ableton:logs",
     "ableton11:start": "yarn ableton:kill; yarn ableton:clean && yarn ableton:copy-script && yarn ableton11:launch && yarn ableton:logs",