ableton-js 3.3.2 → 3.3.3

package/CHANGELOG.md

@@ -4,8 +4,16 @@ 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.3](https://github.com/leolabs/ableton.js/compare/v3.3.2...v3.3.3)
+
+- :mute: Fix every message being logged twice [`3a2571f`](https://github.com/leolabs/ableton.js/commit/3a2571f0a4ad61fdf751a0dfbb5da00b6def8508)
+- :wastebasket: Deprecate `removeNotes` and add `removeNotesExtended` as a replacement [`ac02271`](https://github.com/leolabs/ableton.js/commit/ac022718f0b16317d8fdf70ff1c8d77eaaa0f384)
+- :bug: Address a hang in newer versions of Live when the UDP port is already being used [`5caeaeb`](https://github.com/leolabs/ableton.js/commit/5caeaebc172fc819693c988643071c565e4dbcd3)
+
 #### [v3.3.2](https://github.com/leolabs/ableton.js/compare/v3.3.1...v3.3.2)
 
+> 27 July 2023
+
 - :package: Add lodash as a dependency, fixes #104 [`#104`](https://github.com/leolabs/ableton.js/issues/104)
 
 #### [v3.3.1](https://github.com/leolabs/ableton.js/compare/v3.3.0...v3.3.1)

package/midi-script/AbletonJS.py

@@ -3,6 +3,7 @@ import time
 
 from .version import version
 from .Config import DEBUG, FAST_POLLING
+from .Logging import logger
 from .Socket import Socket
 from .Interface import Interface
 from .Application import Application
@@ -29,11 +30,10 @@ import Live
 class AbletonJS(ControlSurface):
     def __init__(self, c_instance):
         super(AbletonJS, self).__init__(c_instance)
-        self.log_message("Starting AbletonJS " + version + "...")
+        logger.info("Starting AbletonJS " + version + "...")
 
         self.tracked_midi = set()
 
-        Socket.set_log(self.log_message)
         Socket.set_message(self.show_message)
         self.socket = Socket(self.command_handler)
 
@@ -69,8 +69,8 @@ class AbletonJS(ControlSurface):
         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")
+            logger.warn("UDP tick is lagging, delta: " +
+                        str(round(tick_time - self._last_tick)) + "ms")
 
         self._last_tick = tick_time
         self.socket.process()
@@ -78,8 +78,8 @@ class AbletonJS(ControlSurface):
         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")
+            logger.warn("UDP processing is taking long, delta: " +
+                        str(round(tick_time - process_time)) + "ms")
 
         self.schedule_message(1, self.tick)
 
@@ -97,7 +97,7 @@ class AbletonJS(ControlSurface):
         self.handlers["midi"].send_midi(midi_bytes)
 
     def disconnect(self):
-        self.log_message("Disconnecting")
+        logger.info("Disconnecting")
         if FAST_POLLING:
             self.recv_loop.stop()
         self.socket.send("disconnect")
@@ -110,7 +110,7 @@ class AbletonJS(ControlSurface):
 
         # Don't clutter the logs
         if not (namespace == "internal" and payload["name"] == "get_prop" and payload["args"]["prop"] == "ping") and DEBUG:
-            self.log_message("Received command: " + str(payload))
+            logger.debug("Received command: " + str(payload))
 
         if namespace in self.handlers:
             handler = self.handlers[namespace]

package/midi-script/Application.py

@@ -6,7 +6,6 @@ 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

package/midi-script/Interface.py

@@ -2,6 +2,7 @@ import hashlib
 import json
 
 from .Config import DEBUG
+from .Logging import logger
 
 
 class Interface(object):
@@ -25,11 +26,10 @@ class Interface(object):
     def __init__(self, c_instance, socket):
         self.ableton = c_instance
         self.socket = socket
-        self.log_message = c_instance.log_message
 
     def log_debug(self, message):
         if DEBUG:
-            self.log_message(message)
+            logger.debug(message)
 
     def get_ns(self, nsid):
         return Interface.obj_ids[nsid]
@@ -78,7 +78,7 @@ class Interface(object):
                 self.socket.send("error", "Function call failed: " + payload["name"] +
                                  " doesn't exist or isn't callable", uuid)
         except Exception as e:
-            self.log_message("Handler Error: " + str(e.args))
+            logger.error("Handler Error: " + str(e.args))
             self.socket.send("error", str(e.args[0]), uuid)
 
     def add_listener(self, ns, prop, eventId, nsid="Default"):

package/midi-script/Logging.py

@@ -0,0 +1,3 @@
+import logging
+
+logger = logging.getLogger("AbletonJS")

package/midi-script/Midi.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import
 
 from .Interface import Interface
+from .Logging import logger
 
 
 class Midi(Interface):
@@ -22,11 +23,12 @@ class Midi(Interface):
                 midi_type = output.get("type")
                 if midi_type != "cc" and midi_type != "note":
                     raise ValueError("invalid midi type " + str(midi_type))
-                self.outputs.add((midi_type, output.get("channel"), output.get("target")))
+                self.outputs.add((midi_type, output.get(
+                    "channel"), output.get("target")))
             except ValueError as e:
-                self.log_message(e)
+                logger.error(e)
             except:
-                self.log_message("invalid midi output requested: " + str(output))
+                logger.error("invalid midi output requested: " + str(output))
 
     def remove_midi_listener(self, fn):
         self.event_id = None
@@ -38,10 +40,10 @@ class Midi(Interface):
             raise Exception("Listener " + str(prop) + " does not exist.")
 
         if self.event_id is not None:
-            self.log_message("midi listener already exists")
+            logger.warn("midi listener already exists")
             return self.event_id
 
-        self.log_message("Attaching midi listener")
+        logger.info("Attaching midi listener")
 
         self.tracked_midi.clear()
         self.tracked_midi.update(self.outputs)

package/midi-script/Socket.py

@@ -4,7 +4,8 @@ import struct
 import zlib
 import os
 import tempfile
-from threading import Timer
+
+from .Logging import logger
 
 import Live
 
@@ -24,11 +25,6 @@ client_port_path = os.path.join(tempfile.gettempdir(), client_port_file)
 
 
 class Socket(object):
-
-    @staticmethod
-    def set_log(func):
-        Socket.log_message = func
-
     @staticmethod
     def set_message(func):
         Socket.show_message = func
@@ -39,17 +35,18 @@ class Socket(object):
         self._client_addr = ("127.0.0.1", 39031)
         self._last_error = ""
         self._socket = None
+        self._chunk_limit = None
 
         self.read_remote_port()
         self.init_socket(True)
 
-    def log_once(self, msg):
+    def log_error_once(self, msg):
         if self._last_error != msg:
             self._last_error = msg
-            self.log_message(msg)
+            logger.error(msg)
 
     def set_client_port(self, port):
-        self.log_message("Setting client port: ", str(port))
+        logger.info("Setting client port: ", str(port))
         self.show_message("Client connected on port " + str(port))
         self._client_addr = ("127.0.0.1", int(port))
 
@@ -58,10 +55,10 @@ class Socket(object):
             with open(server_port_path) as file:
                 port = int(file.read())
 
-            self.log_message("Stored server port: " + str(port))
+            logger.info("Stored server port: " + str(port))
             return port
         except Exception as e:
-            self.log_message(
+            logger.info(
                 "Couldn't read stored server port: " + str(e.args))
             return None
 
@@ -71,7 +68,8 @@ class Socket(object):
         try:
             os.stat(client_port_path)
         except Exception as e:
-            self.log_once("Couldn't stat remote port file: " + str(e.args))
+            self.log_error_once(
+                "Couldn't stat remote port file: " + str(e.args))
             return
 
         try:
@@ -81,22 +79,23 @@ class Socket(object):
                 port = int(file.read())
 
                 if port != old_port:
-                    self.log_message("[" + str(id(self)) + "] Client port changed from " +
-                                     str(old_port) + " to " + str(port))
+                    logger.info("[" + str(id(self)) + "] Client port changed from " +
+                                str(old_port) + " to " + str(port))
                     self._client_addr = ("127.0.0.1", port)
 
                     if self._socket:
                         self.send("connect", {"port": self._server_addr[1]})
         except Exception as e:
-            self.log_once("Couldn't read remote port file: " + str(e.args))
+            self.log_error_once(
+                "Couldn't read remote port file: " + str(e.args))
 
     def shutdown(self):
-        self.log_message("Shutting down...")
+        logger.info("Shutting down...")
         self._socket.close()
         self._socket = None
 
     def init_socket(self, try_stored=False):
-        self.log_message(
+        logger.info(
             "Initializing socket, from stored: " + str(try_stored))
 
         try:
@@ -118,7 +117,7 @@ class Socket(object):
             self._chunk_limit = self._socket.getsockopt(
                 socket.SOL_SOCKET, socket.SO_SNDBUF) - 1
 
-            self.log_message("Chunk limit: " + str(self._chunk_limit))
+            logger.info("Chunk limit: " + str(self._chunk_limit))
 
             # Write the chosen port to a file
             try:
@@ -126,35 +125,37 @@ class Socket(object):
                     with open(server_port_path, "w") as file:
                         file.write(str(port))
             except Exception as e:
-                self.log_once("Couldn't save port in file: " + str(e.args))
+                self.log_error_once(
+                    "Couldn't save port in file: " + str(e.args))
                 raise e
 
             try:
                 self.send("connect", {"port": self._server_addr[1]})
             except Exception as e:
-                self.log_message("Couldn't send connect to " +
-                                 str(self._client_addr) + ": " + str(e.args))
+                logger.info("Couldn't send connect to " +
+                            str(self._client_addr) + ": " + str(e.args))
 
             self.show_message("Started server on port " + str(port))
 
-            self.log_message('Started server on: ' + str(self._socket.getsockname()) +
-                             ', client addr: ' + str(self._client_addr))
+            logger.info('Started server on: ' + str(self._socket.getsockname()) +
+                        ', client addr: ' + str(self._client_addr))
         except Exception as e:
             msg = 'ERROR: Cannot bind to ' + \
                 str(self._server_addr) + ': ' + \
                 str(e.args) + ', trying again. ' + \
                 'If this keeps happening, try restarting your computer.'
-            self.log_once(msg + "(Client address: " +
-                          str(self._client_addr) + ")")
+            self.log_error_once(msg + "(Client address: " +
+                                str(self._client_addr) + ")")
             self.show_message(msg)
-            t = Timer(5, self.init_socket)
+            t = Live.Base.Timer(
+                callback=self.init_socket, interval=5000, repeat=False)
             t.start()
 
     def _sendto(self, msg):
         '''Send a raw message to the client, compressed and chunked, if necessary'''
         compressed = zlib.compress(msg.encode("utf8")) + b'\n'
 
-        if self._socket == None:
+        if self._socket == None or self._chunk_limit == None:
             return
 
         if len(compressed) < self._chunk_limit:
@@ -179,12 +180,12 @@ class Socket(object):
                 {"event": name, "data": obj, "uuid": uuid}, default=jsonReplace, ensure_ascii=False)
             self._sendto(data)
         except socket.error as e:
-            self.log_message("Socket error: " + str(e.args) + ", server: " + str(self._server_addr) +
-                             ", client: " + str(self._client_addr) + ", socket: " + str(self._socket))
-            self.log_message("Data:" + data)
+            logger.info("Socket error: " + str(e.args) + ", server: " + str(self._server_addr) +
+                        ", client: " + str(self._client_addr) + ", socket: " + str(self._socket))
+            logger.info("Data:" + data)
         except Exception as e:
             error = str(type(e).__name__) + ': ' + str(e.args)
-            self.log_message("Error " + name + "(" + str(uuid) + "): " + error)
+            logger.info("Error " + name + "(" + str(uuid) + "): " + error)
 
     def process(self):
         try:
@@ -204,8 +205,8 @@ class Socket(object):
                         buffer = bytes()
                         num_messages = 0
         except socket.error as e:
-            if (e.errno != 35):
-                self.log_message("Socket error: " + str(e.args))
+            if (e.errno != 35 and e.errno != 10035 and e.errno != 10054):
+                logger.info("Socket error: " + str(e.args))
             return
         except Exception as e:
-            self.log_message("Error while processing: " + str(e.args))
+            logger.info("Error while processing: " + str(e.args))

package/midi-script/version.py

@@ -1 +1 @@
-version = "3.3.2"
+version = "3.3.3"

package/ns/clip.d.ts

@@ -218,8 +218,14 @@ export declare class Clip extends Namespace<GettableProperties, TransformedPrope
     quantizePitch(pitch: number, grid: number, amount: number): Promise<void>;
     /**
      * Deletes all notes that start in the given area.
+     *
+     * @deprecated starting with Live 11, use `removeNotesExtended` instead
      */
     removeNotes(fromTime: number, fromPitch: number, timeSpan: number, pitchSpan: number): Promise<any>;
+    /**
+     * Deletes all notes that start in the given area.
+     */
+    removeNotesExtended(fromTime: number, fromPitch: number, timeSpan: number, pitchSpan: number): Promise<any>;
     /**
      * Replaces selected notes with an array of new notes.
      */

package/ns/clip.js

@@ -155,6 +155,8 @@ class Clip extends _1.Namespace {
     }
     /**
      * Deletes all notes that start in the given area.
+     *
+     * @deprecated starting with Live 11, use `removeNotesExtended` instead
      */
     removeNotes(fromTime, fromPitch, timeSpan, pitchSpan) {
         return this.sendCommand("remove_notes", [
@@ -164,6 +166,17 @@ class Clip extends _1.Namespace {
             pitchSpan,
         ]);
     }
+    /**
+     * Deletes all notes that start in the given area.
+     */
+    removeNotesExtended(fromTime, fromPitch, timeSpan, pitchSpan) {
+        return this.sendCommand("remove_notes_extended", [
+            fromTime,
+            fromPitch,
+            timeSpan,
+            pitchSpan,
+        ]);
+    }
     /**
      * Replaces selected notes with an array of new notes.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ableton-js",
-  "version": "3.3.2",
+  "version": "3.3.3",
   "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 --line-buffered -i -e RemoteScriptError -e RemoteScriptMessage | sed 's/info: RemoteScriptMessage: (AbletonJS) //'",
+    "ableton:logs": "tail -n 50 -f ~/Library/Preferences/Ableton/*/Log.txt | grep --line-buffered -i -e 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",