ableton-js 3.6.0 → 3.7.0

package/CHANGELOG.md

@@ -4,8 +4,23 @@ 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.0](https://github.com/leolabs/ableton.js/compare/v3.6.1...v3.7.0)
+
+- 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)
+
+#### [v3.6.1](https://github.com/leolabs/ableton.js/compare/v3.6.0...v3.6.1)
+
+> 12 March 2025
+
+- :bug: Fix zlib expecting a string on Python 2 (Live 10) [`8480ab4`](https://github.com/leolabs/ableton.js/commit/8480ab4a5b6c253a905e1ba61de53d6728c68411)
+- :bug: Fix ableton-js not working with Live 10 anymore, due to syntax that Python 2 doesn't support [`04ba830`](https://github.com/leolabs/ableton.js/commit/04ba8309a4b7912c022aa604a90fed47a7a56ed9)
+
 #### [v3.6.0](https://github.com/leolabs/ableton.js/compare/v3.5.0...v3.6.0)
 
+> 16 January 2025
+
 - :label: Mark all raw object state as readonly [`ace0efd`](https://github.com/leolabs/ableton.js/commit/ace0efde39e5b598dd0a2878e0e29ecffedd495a)
 - :sparkles: Add options to override the caching mechanism [`85405d4`](https://github.com/leolabs/ableton.js/commit/85405d4be89bdc052f53bb862c5fe904620c554a)
 

package/midi-script/Clip.py

@@ -27,6 +27,39 @@ class Clip(Interface):
     def get_notes(self, ns, from_time=0, from_pitch=0, time_span=99999999999999, pitch_span=128):
         return ns.get_notes(from_time, from_pitch, time_span, pitch_span)
 
+    def get_notes_extended(self, ns, from_time=0, from_pitch=0, time_span=99999999999999, pitch_span=128):
+        midi_note_vector = ns.get_notes_extended(from_pitch, pitch_span, from_time, time_span)
+        return [
+            {
+                "duration": note.duration,
+                "mute": note.mute,
+                "note_id": note.note_id,
+                "pitch": note.pitch,
+                "probability": note.probability,
+                "release_velocity": note.release_velocity,
+                "start_time": note.start_time,
+                "velocity": note.velocity,
+                "velocity_deviation": note.velocity_deviation
+            }
+            for note in midi_note_vector
+        ]
+        
+    def apply_note_modifications(self, ns, notes):
+        existing_notes = ns.get_notes_extended(0, 128, 0, 99999999999999)
+        existing_notes_map = {note.note_id: note for note in existing_notes}
+        
+        for modified_note_data in notes:
+            note_id = modified_note_data.get("note_id")
+            if note_id is None:
+                raise ValueError("The note_id parameter is required to modify the note.")
+            if note_id in existing_notes_map:
+                note_to_update = existing_notes_map[note_id]
+                for key, value in modified_note_data.items():
+                    if key != "note_id" and hasattr(note_to_update, key):
+                        setattr(note_to_update, key, value)
+        
+        return ns.apply_note_modifications(existing_notes)
+
     def get_warp_markers(self, ns):
         dict_markers = []
         for warp_marker in ns.warp_markers:
@@ -41,3 +74,4 @@ class Clip(Interface):
 
     def replace_selected_notes(self, ns, notes):
         return ns.replace_selected_notes(tuple(notes))
+        

package/midi-script/Session.py

@@ -21,7 +21,7 @@ class Session(Interface):
         """
         with self.controlSurface.component_guard():
             logger.info(
-                f"Setting up session box with {num_tracks} tracks and {num_scenes} scenes.")
+                "Setting up session box with " + str(num_tracks) + " tracks and " + str(num_scenes) + " scenes.")
             self.session = self.sessionComponent(num_tracks, num_scenes)
             self.session.set_offsets(0, 0)
             self.controlSurface.set_highlighting_session_component(
@@ -33,7 +33,7 @@ class Session(Interface):
         Sets the offset of the SessionComponent instance.
         """
         logger.info(
-            f"Moving session box offset to {track_offset} and {scene_offset}.")
+            "Moving session box offset to " + str(track_offset) + " and " + scene_offset + ".")
 
         if hasattr(self, 'session'):
             self.session.set_offsets(track_offset, scene_offset)

package/midi-script/Socket.py

@@ -4,6 +4,7 @@ import struct
 import zlib
 import os
 import tempfile
+import sys
 
 from .Logging import logger
 
@@ -87,7 +88,8 @@ class Socket(object):
                     if self._socket:
                         self.send("connect", {"port": self._server_addr[1]})
         except Exception as e:
-            self.log_error_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):
         logger.info("Shutting down...")
@@ -125,13 +127,15 @@ class Socket(object):
                     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))
+                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:
-                logger.error("Couldn't send connect to " + str(self._client_addr) + ":")
+                logger.error("Couldn't send connect to " +
+                             str(self._client_addr) + ":")
                 logger.exception(e)
 
             self.show_message("Started server on port " + str(port))
@@ -143,7 +147,8 @@ class Socket(object):
                 str(self._server_addr) + ': ' + \
                 str(e.args) + ', trying again. ' + \
                 'If this keeps happening, try restarting your computer.'
-            self.log_error_once(msg + " (Client address: " + str(self._client_addr) + ")")
+            self.log_error_once(
+                msg + " (Client address: " + str(self._client_addr) + ")")
             self.show_message(msg)
             t = Live.Base.Timer(
                 callback=self.init_socket, interval=5000, repeat=False)
@@ -160,15 +165,18 @@ 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._socket.sendto(
+                message_id_byte + b'\x00\x01' + compressed, self._client_addr)
         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))
+                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._socket.sendto(
+                    message_id_byte + packet_byte + count_byte + chunk, self._client_addr)
 
     def send(self, name, obj=None, uuid=None):
         def jsonReplace(o):
@@ -188,7 +196,8 @@ class Socket(object):
         except socket.error as e:
             logger.error("Socket error:")
             logger.exception(e)
-            logger.error("Server: " + str(self._server_addr) + ", client: " + str(self._client_addr) + ", socket: " + str(self._socket))
+            logger.error("Server: " + str(self._server_addr) + ", client: " +
+                         str(self._client_addr) + ", socket: " + str(self._socket))
             logger.error("Data:" + data)
         except Exception as e:
             logger.error("Error " + name + "(" + str(uuid) + "):")
@@ -205,7 +214,17 @@ class Socket(object):
                     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)
 

package/midi-script/Track.py

@@ -78,4 +78,8 @@ class Track(Interface):
         return MixerDevice.serialize_mixer_device(ns.mixer_device)
 
     def duplicate_clip_to_arrangement(self, ns, clip_id, time):
-        return ns.duplicate_clip_to_arrangement(self.get_obj(clip_id), time)
+        clip = ns.duplicate_clip_to_arrangement(self.get_obj(clip_id), time)
+        return Clip.serialize_clip(clip)
+
+    def delete_clip(self, ns, clip_id):
+        return ns.delete_clip(self.get_obj(clip_id))

package/midi-script/version.py

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

package/ns/clip.d.ts

@@ -2,7 +2,7 @@ import { Ableton } from "..";
 import { Namespace } from ".";
 import { Color } from "../util/color";
 import { DeviceParameter } from "./device-parameter";
-import { Note, NoteTuple } from "../util/note";
+import { Note, NoteExtended, NoteTuple } from "../util/note";
 export declare enum WarpMode {
     Beats = 0,
     Tones = 1,
@@ -201,8 +201,18 @@ export declare class Clip extends Namespace<GettableProperties, TransformedPrope
     fire(): Promise<void>;
     /**
      * Returns all notes that match the given range.
+     * @deprecated starting with Live 11, use `getNotesExtended` instead
      */
     getNotes(fromTime: number, fromPitch: number, timeSpan: number, pitchSpan: number): Promise<Note[]>;
+    /**
+     * Returns all notes matching the given range with extended properties.
+     * Compared to getNotes, this method returns additional note information.
+     */
+    getNotesExtended(fromTime: number, fromPitch: number, timeSpan: number, pitchSpan: number): Promise<NoteExtended[]>;
+    /**
+     *  Available since Live 11.0. Replaces modifying notes with remove_notes followed by set_notes.
+     */
+    applyNoteModifications(notes: NoteExtended[]): Promise<any>;
     /**
      * Jump forward or backward by the specified relative amount in beats.
      * Will do nothing if the clip is not playing.
@@ -226,6 +236,11 @@ export declare class Clip extends Namespace<GettableProperties, TransformedPrope
      * Deletes all notes that start in the given area.
      */
     removeNotesExtended(fromTime: number, fromPitch: number, timeSpan: number, pitchSpan: number): Promise<any>;
+    /**
+     * Remove notes by given note ids.
+     * Available since Live 11.0.
+     */
+    removeNotesById(ids: number[]): Promise<any>;
     /**
      * Replaces selected notes with an array of new notes.
      */

package/ns/clip.js

@@ -124,6 +124,7 @@ class Clip extends _1.Namespace {
     }
     /**
      * Returns all notes that match the given range.
+     * @deprecated starting with Live 11, use `getNotesExtended` instead
      */
     async getNotes(fromTime, fromPitch, timeSpan, pitchSpan) {
         const notes = await this.sendCommand("get_notes", {
@@ -134,6 +135,24 @@ class Clip extends _1.Namespace {
         });
         return notes.map(note_1.tupleToNote);
     }
+    /**
+     * Returns all notes matching the given range with extended properties.
+     * Compared to getNotes, this method returns additional note information.
+     */
+    async getNotesExtended(fromTime, fromPitch, timeSpan, pitchSpan) {
+        return this.sendCommand("get_notes_extended", {
+            from_pitch: fromPitch,
+            pitch_span: pitchSpan,
+            from_time: fromTime,
+            time_span: timeSpan,
+        });
+    }
+    /**
+     *  Available since Live 11.0. Replaces modifying notes with remove_notes followed by set_notes.
+     */
+    applyNoteModifications(notes) {
+        return this.sendCommand("apply_note_modifications", { notes });
+    }
     /**
      * Jump forward or backward by the specified relative amount in beats.
      * Will do nothing if the clip is not playing.
@@ -171,12 +190,19 @@ class Clip extends _1.Namespace {
      */
     removeNotesExtended(fromTime, fromPitch, timeSpan, pitchSpan) {
         return this.sendCommand("remove_notes_extended", [
-            fromTime,
             fromPitch,
-            timeSpan,
             pitchSpan,
+            fromTime,
+            timeSpan,
         ]);
     }
+    /**
+     * Remove notes by given note ids.
+     * Available since Live 11.0.
+     */
+    removeNotesById(ids) {
+        return this.sendCommand("remove_notes_by_id", [ids]);
+    }
     /**
      * Replaces selected notes with an array of new notes.
      */

package/ns/track.d.ts

@@ -158,5 +158,19 @@ export declare class Track extends Namespace<GettableProperties, TransformedProp
      * Duplicates the given clip into the arrangement of this track at the provided destination time and returns it.
      * When the type of the clip and the type of the track are incompatible, a runtime error is raised.
      */
-    duplicateClipToArrangement(clipOrId: Clip | string, time: number): Promise<any>;
+    duplicateClipToArrangement(clipOrId: Clip | string, time: number): Promise<Clip>;
+    /**
+     * Deletes the given clip from the arrangement of this track.
+     * Raises a runtime error when the clip belongs to another track
+     */
+    deleteClip(clipOrId: Clip | string): Promise<any>;
+    /**
+     * Delete a device identified by the index in the 'devices' list of current track
+     */
+    deleteDevice(index: number): Promise<any>;
+    /**
+     * Given an absolute path to a valid audio file in a supported format, creates an audio clip that references the file in the clip slot.
+     * Throws an error if the clip slot doesn't belong to an audio track or if the track is frozen.
+     */
+    createAudioClip(filePath: string, position: number): Promise<any>;
 }

package/ns/track.js

@@ -48,11 +48,34 @@ class Track extends _1.Namespace {
      * Duplicates the given clip into the arrangement of this track at the provided destination time and returns it.
      * When the type of the clip and the type of the track are incompatible, a runtime error is raised.
      */
-    duplicateClipToArrangement(clipOrId, time) {
-        return this.sendCommand("duplicate_clip_to_arrangement", {
+    async duplicateClipToArrangement(clipOrId, time) {
+        const rawClip = await this.sendCommand("duplicate_clip_to_arrangement", {
             clip_id: typeof clipOrId === "string" ? clipOrId : clipOrId.raw.id,
             time: time,
         });
+        return new clip_1.Clip(this.ableton, rawClip);
+    }
+    /**
+     * Deletes the given clip from the arrangement of this track.
+     * Raises a runtime error when the clip belongs to another track
+     */
+    deleteClip(clipOrId) {
+        return this.sendCommand("delete_clip", {
+            clip_id: typeof clipOrId === "string" ? clipOrId : clipOrId.raw.id,
+        });
+    }
+    /**
+     * Delete a device identified by the index in the 'devices' list of current track
+     */
+    deleteDevice(index) {
+        return this.sendCommand("delete_device", [index]);
+    }
+    /**
+     * Given an absolute path to a valid audio file in a supported format, creates an audio clip that references the file in the clip slot.
+     * Throws an error if the clip slot doesn't belong to an audio track or if the track is frozen.
+     */
+    createAudioClip(filePath, position) {
+        return this.sendCommand("create_audio_clip", [filePath, position]);
     }
 }
 exports.Track = Track;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ableton-js",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "description": "Control Ableton Live from Node",
   "main": "index.js",
   "author": "Leo Bernard <admin@leolabs.org>",
@@ -19,10 +19,12 @@
     "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\"",
+    "ableton12:launch": "set -- /Applications/Ableton*12* && open \"$1\"",
     "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",
+    "ableton12:start": "yarn ableton:kill; yarn ableton:clean && yarn ableton:copy-script && yarn ableton11: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",

package/util/note.d.ts

@@ -12,5 +12,16 @@ export interface Note {
     velocity: number;
     muted: boolean;
 }
+export interface NoteExtended {
+    note_id: number;
+    duration: number;
+    mute: boolean;
+    pitch: number;
+    probability: number;
+    release_velocity: number;
+    start_time: number;
+    velocity: number;
+    velocity_deviation: number;
+}
 export declare const tupleToNote: (tuple: NoteTuple) => Note;
 export declare const noteToTuple: (note: Note) => NoteTuple;