ableton-js 3.2.9 → 3.2.11

package/CHANGELOG.md

@@ -4,8 +4,22 @@ 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.2.11](https://github.com/leolabs/ableton.js/compare/v3.2.10...v3.2.11)
+
+- :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)
 
+> 14 July 2023
+
 - :sparkles: Only send the client port to Live once [`29e9443`](https://github.com/leolabs/ableton.js/commit/29e9443194294f5b55805df909d234b67e52eca2)
 - :sparkles: Send the current client port to Live every time the server port changes [`eb42ce3`](https://github.com/leolabs/ableton.js/commit/eb42ce32f4fa91bd57e4c026a7d29d961afa0a04)
 

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
@@ -51,6 +52,7 @@ class AbletonJS(ControlSurface):
             "clip": Clip(c_instance, self.socket),
         }
 
+        self._last_tick = time.time() * 1000
         self.tick()
 
         if FAST_POLLING:
@@ -60,7 +62,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/Socket.py

@@ -93,6 +93,7 @@ class Socket(object):
     def shutdown(self):
         self.log_message("Shutting down...")
         self._socket.close()
+        self._socket = None
 
     def init_socket(self, try_stored=False):
         self.log_message(
@@ -113,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:
@@ -146,14 +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 len(compressed) < limit:
+        if self._socket == None:
+            return
+
+        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)
@@ -184,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/version.py

@@ -1 +1 @@
-version = "3.2.9"
+version = "3.2.11"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ableton-js",
-  "version": "3.2.9",
+  "version": "3.2.11",
   "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",