ableton-js 3.7.0 → 3.7.2

package/CHANGELOG.md

@@ -4,8 +4,25 @@ 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.7.2](https://github.com/leolabs/ableton.js/compare/v3.7.1...v3.7.2)
+
+- Fix a missing str() coercion [`#136`](https://github.com/leolabs/ableton.js/pull/136)
+- :bug: Fix issues with larger payloads not being received properly [`bed4e22`](https://github.com/leolabs/ableton.js/commit/bed4e226cb7febb448700c32979ce50a6a67ef69)
+- :zap: Always assign a new port to the Python UDP server on start and store it in the port file [`47566f9`](https://github.com/leolabs/ableton.js/commit/47566f9eb347784746f6d50093491f3b2d591c58)
+- :label: Fix types of `re_enable_automation_enabled` property [`4e547e0`](https://github.com/leolabs/ableton.js/commit/4e547e051f6df9be69ad11797479b7f5d6262ba8)
+- :mute: Reduce logging around packet processing [`c916d67`](https://github.com/leolabs/ableton.js/commit/c916d675905f4660b130e26a904ada6e9f64ac6f)
+- :wrench: Fix `ableton12:start` starting Live 11 instead [`7a0b8a3`](https://github.com/leolabs/ableton.js/commit/7a0b8a34bcee6bd3224fdfc25662363a714440db)
+
+#### [v3.7.1](https://github.com/leolabs/ableton.js/compare/v3.7.0...v3.7.1)
+
+> 9 July 2025
+
+- :sparkles: Add `reEnableAutomation` song function [`b3aa668`](https://github.com/leolabs/ableton.js/commit/b3aa668bfc1844d60722ac557b2be047c0630da8)
+
 #### [v3.7.0](https://github.com/leolabs/ableton.js/compare/v3.6.1...v3.7.0)
 
+> 16 June 2025
+
 - Add more clip and note operation features in Ableton Live 11 and above versions [`#133`](https://github.com/leolabs/ableton.js/pull/133)
 - Add new functions and fix bugs [`#130`](https://github.com/leolabs/ableton.js/pull/130)
 - adds ability to launch v12 via yarn [`#131`](https://github.com/leolabs/ableton.js/pull/131)

package/index.d.ts

@@ -96,11 +96,13 @@ export declare class Ableton extends EventEmitter implements ConnectionEventEmit
     private options?;
     private client;
     private msgMap;
+    private timeoutMap;
     private eventListeners;
     private heartbeatInterval;
     private _isConnected;
     private buffer;
     private latency;
+    private messageId;
     private serverPort;
     cache?: Cache;
     song: Song;
@@ -155,7 +157,7 @@ export declare class Ableton extends EventEmitter implements ConnectionEventEmit
      * disconnects, for example.
      */
     removeAllPropListeners(): void;
-    sendRaw(msg: string): Promise<void>;
+    sendRaw(msg: string, messageId: number): Promise<void>;
     isConnected(): boolean;
 }
 export { getPackageVersion } from "./util/package-version";

package/index.js

@@ -48,11 +48,13 @@ class Ableton extends events_1.EventEmitter {
     options;
     client;
     msgMap = new Map();
+    timeoutMap = new Map();
     eventListeners = new Map();
     heartbeatInterval;
     _isConnected = false;
     buffer = [];
     latency = 0;
+    messageId = 0;
     serverPort;
     cache;
     song = new song_1.Song(this);
@@ -266,6 +268,8 @@ class Ableton extends events_1.EventEmitter {
             const messageIndex = msg[1];
             const totalMessages = msg[2];
             const message = msg.subarray(3);
+            // Reset the timeout when receiving a new message
+            this.timeoutMap.get(messageId)?.();
             if (messageIndex === 0 && totalMessages === 1) {
                 this.handleUncompressedMessage((0, zlib_1.unzipSync)(message).toString());
                 return;
@@ -274,8 +278,7 @@ class Ableton extends events_1.EventEmitter {
                 this.buffer[messageId] = [];
             }
             this.buffer[messageId][messageIndex] = message;
-            if (!this.buffer[messageId].includes(undefined) &&
-                this.buffer[messageId].length === totalMessages) {
+            if (this.buffer[messageId].filter(Boolean).length === totalMessages) {
                 this.handleUncompressedMessage((0, zlib_1.unzipSync)(Buffer.concat(this.buffer[messageId])).toString());
                 delete this.buffer[messageId];
             }
@@ -338,9 +341,20 @@ class Ableton extends events_1.EventEmitter {
             const timeout = this.options?.commandTimeoutMs ?? 2000;
             const arg = (0, lodash_1.truncate)(JSON.stringify(command.args), { length: 100 });
             const cls = command.nsid ? `${command.ns}(${command.nsid})` : command.ns;
-            const timeoutId = setTimeout(() => {
-                rej(new TimeoutError(`The command ${cls}.${command.name}(${arg}) timed out after ${timeout} ms.`, payload));
-            }, timeout);
+            this.messageId = (this.messageId + 1) % 256;
+            let timeoutId = null;
+            const clearCurrentTimeout = () => {
+                if (timeoutId) {
+                    clearTimeout(timeoutId);
+                }
+            };
+            const startTimeout = () => {
+                clearCurrentTimeout();
+                timeoutId = setTimeout(() => {
+                    rej(new TimeoutError(`The command ${cls}.${command.name}(${arg}) timed out after ${timeout} ms.`, payload));
+                }, timeout);
+            };
+            this.timeoutMap.set(this.messageId, startTimeout);
             const currentTimestamp = Date.now();
             this.msgMap.set(msgId, {
                 res: (result) => {
@@ -352,16 +366,16 @@ class Ableton extends events_1.EventEmitter {
                         });
                     }
                     this.setPing(duration);
-                    clearTimeout(timeoutId);
+                    clearCurrentTimeout();
                     res(result);
                 },
                 rej,
                 clearTimeout: () => {
-                    clearTimeout(timeoutId);
+                    clearCurrentTimeout();
                     rej(new DisconnectError(`Live disconnected before being able to respond to ${cls}.${command.name}(${arg})`, payload));
                 },
             });
-            this.sendRaw(msg);
+            this.sendRaw(msg, this.messageId).finally(startTimeout);
         });
     }
     async sendCachedCommand(command) {
@@ -452,24 +466,29 @@ class Ableton extends events_1.EventEmitter {
     removeAllPropListeners() {
         this.eventListeners.clear();
     }
-    async sendRaw(msg) {
+    async sendRaw(msg, messageId) {
         if (!this.client || !this.serverPort) {
             throw new Error("The client hasn't been started yet. Please call start() first.");
         }
         const buffer = (0, zlib_1.deflateSync)(Buffer.from(msg));
         const byteLimit = this.client.getSendBufferSize() - 100;
-        const chunks = Math.ceil(buffer.byteLength / byteLimit);
+        const totalChunks = Math.ceil(buffer.byteLength / byteLimit);
         // Split the message into chunks if it becomes too large
-        for (let i = 0; i < chunks; i++) {
+        for (let i = 0; i < totalChunks; i++) {
             const chunk = Buffer.concat([
-                // Add a counter to the message, the last message is always 255
-                Buffer.alloc(1, i + 1 === chunks ? 255 : i),
+                // Message ID (1 byte) - identifies which message this chunk belongs to
+                Buffer.alloc(1, messageId),
+                // Chunk index (1 byte) - 0, 1, 2, ... for regular chunks
+                Buffer.alloc(1, i),
+                // Total chunks (1 byte) - number of chunks in this message
+                Buffer.alloc(1, totalChunks),
+                // Chunk data
                 buffer.subarray(i * byteLimit, i * byteLimit + byteLimit),
             ]);
             this.client.send(chunk, 0, chunk.length, this.serverPort, "127.0.0.1");
             // Add a bit of a delay between sent chunks to reduce the chance of the
             // receiving buffer filling up which would cause chunks to be discarded.
-            await new Promise((res) => setTimeout(res, 20));
+            await new Promise((res) => setTimeout(res, 1));
         }
     }
     isConnected() {

package/midi-script/Session.py

@@ -33,7 +33,7 @@ class Session(Interface):
         Sets the offset of the SessionComponent instance.
         """
         logger.info(
-            "Moving session box offset to " + str(track_offset) + " and " + scene_offset + ".")
+            "Moving session box offset to " + str(track_offset) + " and " + str(scene_offset) + ".")
 
         if hasattr(self, 'session'):
             self.session.set_offsets(track_offset, scene_offset)

package/midi-script/Socket.py

@@ -37,11 +37,14 @@ class Socket(object):
         self._last_error = ""
         self._socket = None
         self._chunk_limit = None
+        self._send_buffer = []
         self._message_id = 0
         self._receive_buffer = bytearray()
+        # Dictionary to store chunks per message: {message_id: {chunk_index: chunk_data}}
+        self._chunks = {}
 
         self.read_remote_port()
-        self.init_socket(True)
+        self.init_socket()
 
     def log_error_once(self, msg):
         if self._last_error != msg:
@@ -53,18 +56,6 @@ class Socket(object):
         self.show_message("Client connected on port " + str(port))
         self._client_addr = ("127.0.0.1", int(port))
 
-    def read_last_server_port(self):
-        try:
-            with open(server_port_path) as file:
-                port = int(file.read())
-
-            logger.info("Stored server port: " + str(port))
-            return port
-        except Exception as e:
-            logger.error("Couldn't read stored server port:")
-            logger.exception(e)
-            return None
-
     def read_remote_port(self):
         '''Reads the port our client is listening on'''
 
@@ -96,18 +87,11 @@ class Socket(object):
         self._socket.close()
         self._socket = None
 
-    def init_socket(self, try_stored=False):
-        logger.info(
-            "Initializing socket, from stored: " + str(try_stored))
+    def init_socket(self):
+        logger.info("Initializing socket")
 
         try:
-            stored_port = self.read_last_server_port()
-
-            # Try the port we used last time first
-            if try_stored and stored_port:
-                self._server_addr = ("127.0.0.1", stored_port)
-            else:
-                self._server_addr = ("127.0.0.1", 0)
+            self._server_addr = ("127.0.0.1", 0)
 
             self._socket = socket.socket(
                 socket.AF_INET, socket.SOCK_DGRAM)
@@ -123,16 +107,15 @@ class Socket(object):
 
             # Write the chosen port to a file
             try:
-                if stored_port != port:
-                    with open(server_port_path, "w") as file:
-                        file.write(str(port))
+                with open(server_port_path, "w") as file:
+                    file.write(str(port))
             except Exception as e:
                 self.log_error_once(
                     "Couldn't save port in file: " + str(e.args))
                 raise e
 
             try:
-                self.send("connect", {"port": self._server_addr[1]})
+                self.send("connect", {"port": port})
             except Exception as e:
                 logger.error("Couldn't send connect to " +
                              str(self._client_addr) + ":")
@@ -165,18 +148,16 @@ class Socket(object):
         message_id_byte = struct.pack("B", self._message_id)
 
         if len(compressed) < self._chunk_limit:
-            self._socket.sendto(
-                message_id_byte + b'\x00\x01' + compressed, self._client_addr)
+            self._send_buffer.append(
+                message_id_byte + b'\x00\x01' + compressed)
         else:
             chunks = list(split_by_n(compressed, self._chunk_limit))
             count = len(chunks)
             count_byte = struct.pack("B", count)
             for i, chunk in enumerate(chunks):
-                logger.info("Sending packet " + str(self._message_id) +
-                            " - " + str(i) + "/" + str(count))
                 packet_byte = struct.pack("B", i)
-                self._socket.sendto(
-                    message_id_byte + packet_byte + count_byte + chunk, self._client_addr)
+                self._send_buffer.append(
+                    message_id_byte + packet_byte + count_byte + chunk)
 
     def send(self, name, obj=None, uuid=None):
         def jsonReplace(o):
@@ -206,33 +187,84 @@ class Socket(object):
     def process(self):
         try:
             while 1:
+                try:
+                    # Send 5 UDP packets at a time, to avoid
+                    for i in range(5):
+                        self._socket.sendto(
+                            self._send_buffer.pop(0), self._client_addr)
+                except:
+                    pass
+
                 data = self._socket.recv(65536)
                 if len(data) and self.input_handler:
-                    self._receive_buffer.extend(data[1:])
-
-                    # \xFF for Live 10 (Python2) and 255 for Live 11 (Python3)
-                    if (data[0] == b'\xFF' or data[0] == 255):
-                        packet = self._receive_buffer
-                        self._receive_buffer = bytearray()
-
-                        # Handle Python 2/3 compatibility for zlib.decompress
-                        if sys.version_info[0] < 3:
-                            packet = str(packet)
-
-                        unzipped = zlib.decompress(packet)
-
-                        # Handle bytes to string conversion for Python 3
-                        if sys.version_info[0] >= 3 and isinstance(unzipped, bytes):
-                            unzipped = unzipped.decode('utf-8')
-
-                        payload = json.loads(unzipped)
-                        self.input_handler(payload)
+                    # Parse packet format: [messageId][chunkIndex][totalChunks][chunkData]
+                    if len(data) < 3:
+                        # Packet too short, skip it
+                        continue
+
+                    # Get message ID, chunk index, and total chunks from first 3 bytes
+                    message_id = data[0]
+                    chunk_index = data[1]
+                    total_chunks = data[2]
+
+                    # Handle Python 2/3 compatibility
+                    if isinstance(message_id, bytes):
+                        message_id = ord(message_id)
+                    if isinstance(chunk_index, bytes):
+                        chunk_index = ord(chunk_index)
+                    if isinstance(total_chunks, bytes):
+                        total_chunks = ord(total_chunks)
+
+                    chunk_data = data[3:]
+
+                    # Initialize message tracking if this is the first chunk for this message
+                    if message_id not in self._chunks:
+                        self._chunks[message_id] = {}
+
+                    # Store the chunk
+                    self._chunks[message_id][chunk_index] = chunk_data
+
+                    # Check if we have all chunks for this message
+                    if len(self._chunks[message_id]) == total_chunks:
+                        # We have all chunks! Reassemble in order
+                        packet_parts = []
+                        for i in range(total_chunks):
+                            if i in self._chunks[message_id]:
+                                packet_parts.append(
+                                    self._chunks[message_id][i])
+                            else:
+                                # Missing chunk - this shouldn't happen if total_chunks is correct
+                                logger.error(
+                                    "Missing chunk %d for message %d" % (i, message_id))
+                                break
+                        else:
+                            # All chunks present, reassemble
+                            packet = b''.join(packet_parts)
+
+                            # Remove this message from tracking
+                            del self._chunks[message_id]
+
+                            # Handle Python 2/3 compatibility for zlib.decompress
+                            if sys.version_info[0] < 3:
+                                packet = str(packet)
+
+                            unzipped = zlib.decompress(packet)
+
+                            # Handle bytes to string conversion for Python 3
+                            if sys.version_info[0] >= 3 and isinstance(unzipped, bytes):
+                                unzipped = unzipped.decode('utf-8')
+
+                            payload = json.loads(unzipped)
+                            self.input_handler(payload)
 
         except socket.error as e:
-            if (e.errno != 35 and e.errno != 10035 and e.errno != 10054):
+            if (e.errno != 35 and e.errno != 10035 and e.errno != 10054 and e.errno != 10022):
                 logger.error("Socket error:")
                 logger.exception(e)
             return
         except Exception as e:
             logger.error("Error processing request:")
             logger.exception(e)
+            # Clear chunks on error to prevent stuck state
+            # Optionally, we could clear only the problematic message_id, but for safety, clear all
+            self._chunks = {}

package/midi-script/version.py

@@ -1 +1 @@
-version = "3.7.0"
+version = "3.7.2"

package/ns/song.d.ts

@@ -35,7 +35,7 @@ export interface GettableProperties {
     overdub: boolean;
     punch_in: boolean;
     punch_out: boolean;
-    re_enable_automation_enabled: number;
+    re_enable_automation_enabled: boolean;
     record_mode: number;
     return_tracks: RawTrack[];
     root_note: number;
@@ -86,7 +86,7 @@ export interface SettableProperties {
     overdub: boolean;
     punch_in: boolean;
     punch_out: boolean;
-    re_enable_automation_enabled: number;
+    re_enable_automation_enabled: boolean;
     record_mode: number;
     return_tracks: number;
     root_note: number;
@@ -129,7 +129,7 @@ export interface ObservableProperties {
     overdub: boolean;
     punch_in: boolean;
     punch_out: boolean;
-    re_enable_automation_enabled: number;
+    re_enable_automation_enabled: boolean;
     record_mode: number;
     return_tracks: RawTrack[];
     scenes: RawScene[];
@@ -207,6 +207,7 @@ export declare class Song extends Namespace<GettableProperties, TransformedPrope
     jumpToNextCue(): Promise<any>;
     jumpToPrevCue(): Promise<any>;
     playSelection(): Promise<any>;
+    reEnableAutomation(): Promise<any>;
     redo(): Promise<any>;
     scrubBy(amount: number): Promise<any>;
     setData(key: string, value: any): Promise<any>;

package/ns/song.js

@@ -126,6 +126,9 @@ class Song extends _1.Namespace {
     async playSelection() {
         return this.sendCommand("play_selection");
     }
+    async reEnableAutomation() {
+        return this.sendCommand("re_enable_automation");
+    }
     async redo() {
         return this.sendCommand("redo");
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ableton-js",
-  "version": "3.7.0",
+  "version": "3.7.2",
   "description": "Control Ableton Live from Node",
   "main": "index.js",
   "author": "Leo Bernard <admin@leolabs.org>",
@@ -24,7 +24,7 @@
     "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",
-    "ableton12:start": "yarn ableton:kill; yarn ableton:clean && yarn ableton:copy-script && yarn ableton11:launch && yarn ableton:logs",
+    "ableton12:start": "yarn ableton:kill; yarn ableton:clean && yarn ableton:copy-script && yarn ableton12:launch && yarn ableton:logs",
     "prepublishOnly": "yarn build",
     "build:doc": "jsdoc2md --files src/**/*.ts --configure ./jsdoc2md.json > ./API.md",
     "version": "node hooks/prepublish.js && git add midi-script/version.py && auto-changelog -p -l 100 && git add CHANGELOG.md",