ableton-js 2.5.3 → 2.6.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).
 
+#### [v2.6.0](https://github.com/leolabs/ableton.js/compare/v2.5.4...v2.6.0)
+
+- :sparkles: Make IDs stable over the lifespan of Live [`0bfcf90`](https://github.com/leolabs/ableton.js/commit/0bfcf904b54d42377877a2e9fab0796986f6aa1a)
+- :sparkles: Add create_track methods [`a7dd6bc`](https://github.com/leolabs/ableton.js/commit/a7dd6bc53e2f49fb133b2eea2a1fe6eb1ff0aac6)
+
+#### [v2.5.4](https://github.com/leolabs/ableton.js/compare/v2.5.3...v2.5.4)
+
+> 19 October 2022
+
+- :sparkles: Restart the socket when a message can't be sent due to a socket error [`91294c3`](https://github.com/leolabs/ableton.js/commit/91294c3cf195afacd22cbf1863e244bc231c9a33)
+- :sparkles: Send the UUID back with the error if a requested namespace handler doesn't exist [`8a96a99`](https://github.com/leolabs/ableton.js/commit/8a96a996b8b65c8485d90ac98293ccd605497784)
+- :memo: Add an example for setting a value [`f334983`](https://github.com/leolabs/ableton.js/commit/f334983a8755eab8415383aae7aff1ecff6e23e2)
+
 #### [v2.5.3](https://github.com/leolabs/ableton.js/compare/v2.5.2...v2.5.3)
 
+> 30 August 2022
+
 - :memo: Fix some typos in the readme [`10c8566`](https://github.com/leolabs/ableton.js/commit/10c8566758bc1a7e7ab6bc20fa269d38474e1d96)
 - :sparkles: Add support for observing the `muted` prop of clips [`ecb604a`](https://github.com/leolabs/ableton.js/commit/ecb604a2b25aa3a064ffe5d199d44cfca0c12144)
 

package/README.md

@@ -51,11 +51,16 @@ import { Ableton } from "ableton-js";
 const ableton = new Ableton();
 
 const test = async () => {
+  // Observe the current playback state and tempo
   ableton.song.addListener("is_playing", (p) => console.log("Playing:", p));
   ableton.song.addListener("tempo", (t) => console.log("Tempo:", t));
 
+  // Get the current tempo
   const tempo = await ableton.song.get("tempo");
   console.log(tempo);
+  
+  // Set the tempo
+  await ableton.song.set("tempo", 85);
 };
 
 test();

package/index.d.ts

@@ -7,7 +7,7 @@ import { Midi } from "./ns/midi";
 interface Command {
     uuid: string;
     ns: string;
-    nsid?: number;
+    nsid?: string;
     name: string;
     args?: {
         [k: string]: any;
@@ -61,11 +61,11 @@ export declare class Ableton extends EventEmitter implements ConnectionEventEmit
      * Sends a raw command to Ableton. Usually, you won't need this.
      * A good starting point in general is the `song` prop.
      */
-    sendCommand(ns: string, nsid: number | undefined, name: string, args?: Record<string, any> | any[], timeout?: number): Promise<any>;
-    getProp(ns: string, nsid: number | undefined, prop: string): Promise<any>;
-    setProp(ns: string, nsid: number | undefined, prop: string, value: any): Promise<any>;
-    addPropListener(ns: string, nsid: number | undefined, prop: string, listener: (data: any) => any): Promise<() => Promise<boolean | undefined>>;
-    removePropListener(ns: string, nsid: number | undefined, prop: string, eventId: string, listener: (data: any) => any): Promise<boolean | undefined>;
+    sendCommand(ns: string, nsid: string | undefined, name: string, args?: Record<string, any> | any[], timeout?: number): Promise<any>;
+    getProp(ns: string, nsid: string | undefined, prop: string): Promise<any>;
+    setProp(ns: string, nsid: string | undefined, prop: string, value: any): Promise<any>;
+    addPropListener(ns: string, nsid: string | undefined, prop: string, listener: (data: any) => any): Promise<() => Promise<boolean | undefined>>;
+    removePropListener(ns: string, nsid: string | undefined, prop: string, eventId: string, listener: (data: any) => any): Promise<boolean | undefined>;
     /**
      * Removes all event listeners that were attached to properties.
      * This is useful for clearing all listeners when Live

package/midi-script/AbletonJS.py

@@ -54,9 +54,11 @@ class AbletonJS(ControlSurface):
         script_handle = self._c_instance.handle()
         for midi in self.tracked_midi:
             if midi[0] == "cc":
-                Live.MidiMap.forward_midi_cc(script_handle, midi_map_handle, midi[1], midi[2])
+                Live.MidiMap.forward_midi_cc(
+                    script_handle, midi_map_handle, midi[1], midi[2])
             elif midi[0] == "note":
-                Live.MidiMap.forward_midi_note(script_handle, midi_map_handle, midi[1], midi[2])
+                Live.MidiMap.forward_midi_note(
+                    script_handle, midi_map_handle, midi[1], midi[2])
 
     def receive_midi(self, midi_bytes):
         self.handlers["midi"].send_midi(midi_bytes)
@@ -77,4 +79,5 @@ class AbletonJS(ControlSurface):
             handler = self.handlers[namespace]
             handler.handle(payload)
         else:
-            self.socket.send("error", "No handler for NS " + str(namespace))
+            self.socket.send("error", "No handler for namespace " +
+                             str(namespace), payload["uuid"])

package/midi-script/Interface.py

@@ -4,7 +4,11 @@ class Interface(object):
 
     @staticmethod
     def save_obj(obj):
-        obj_id = id(obj)
+        try:
+            obj_id = "live_" + str(obj._live_ptr)
+        except:
+            obj_id = "id_" + str(id(obj))
+
         Interface.obj_ids[obj_id] = obj
         return obj_id
 

package/midi-script/Internal.py

@@ -10,4 +10,4 @@ class Internal(Interface):
         return self
 
     def get_version(self, ns):
-        return "2.5.3"
+        return "2.6.0"

package/midi-script/Socket.py

@@ -24,16 +24,20 @@ class Socket(object):
 
     def __init__(self, handler, remotehost='127.0.0.1', remoteport=39031, localhost='127.0.0.1', localport=39041):
         self.input_handler = handler
+        self._local_addr = (localhost, localport)
+        self._remote_addr = (remotehost, remoteport)
+        self.init_socket()
 
+    def init_socket(self):
         self._socket = socket.socket(
             socket.AF_INET, socket.SOCK_DGRAM)
         self._socket.setblocking(0)
 
-        self._local_addr = (localhost, localport)
-        self._remote_addr = (remotehost, remoteport)
-
         self.bind()
 
+    def shutdown(self):
+        self._socket.close()
+
     def bind(self):
         try:
             self._socket.bind(self._local_addr)
@@ -70,15 +74,14 @@ class Socket(object):
         try:
             self._sendto(json.dumps(
                 {"event": name, "data": obj, "uuid": uuid}, default=jsonReplace, ensure_ascii=False))
+        except socket.error as e:
+            self.log_message("Socket error: " + str(e.args))
+            self.log_message("Restarting socket...")
+            self.shutdown()
+            self.init_socket()
         except Exception as e:
             error = str(type(e).__name__) + ': ' + str(e.args)
-            self._sendto(json.dumps(
-                {"event": "error", "data": error, "uuid": uuid}, default=jsonReplace, ensure_ascii=False))
-            self.log_message("Socket Error " + name +
-                             "(" + str(uuid) + "): " + str(e))
-
-    def shutdown(self):
-        self._socket.close()
+            self.log_message("Error " + name + "(" + str(uuid) + "): " + error)
 
     def process(self):
         try:
@@ -91,12 +94,9 @@ class Socket(object):
                     num_messages += 1
 
                     # \xFF for Live 10 (Python2) and 255 for Live 11 (Python3)
-                    if(data[0] == b'\xFF' or data[0] == 255):
+                    if (data[0] == b'\xFF' or data[0] == 255):
                         unzipped = zlib.decompress(buffer)
                         payload = json.loads(unzipped)
-
-                        self.log_message(
-                            "Receiving from " + str(num_messages) + " messages, " + str(len(buffer)) + " bytes: " + str(payload))
                         self.input_handler(payload)
                         buffer = bytes()
                         num_messages = 0

package/midi-script/Song.py

@@ -8,9 +8,19 @@ from .Track import Track
 class Song(Interface):
     def __init__(self, c_instance, socket):
         super(Song, self).__init__(c_instance, socket)
+        self.song = self.ableton.song()
 
     def get_ns(self, nsid):
-        return self.ableton.song()
+        return self.song
+
+    def create_audio_track(self, ns, index):
+        return Track.serialize_track(ns.create_audio_track(index))
+
+    def create_midi_track(self, ns, index):
+        return Track.serialize_track(ns.create_midi_track(index))
+
+    def create_return_track(self, ns):
+        return Track.serialize_track(ns.create_return_track())
 
     def get_clip_trigger_quantization(self, ns):
         return str(ns.clip_trigger_quantization)

package/midi-script/Track.py

@@ -26,7 +26,6 @@ class Track(Interface):
     def get_clip_slots(self, ns):
         return list(map(ClipSlot.serialize_clip_slot, ns.clip_slots))
 
-
     def get_group_track(self, ns):
         return Track.serialize_track(ns.group_track)
 

package/ns/clip-slot.d.ts

@@ -39,7 +39,7 @@ export interface ObservableProperties {
     playing_status: PlayingStatus;
 }
 export interface RawClipSlot {
-    id: number;
+    id: string;
     color: number;
     has_clip: boolean;
     is_playing: boolean;

package/ns/clip.d.ts

@@ -128,7 +128,7 @@ export interface ObservableProperties {
     warping: boolean;
 }
 export interface RawClip {
-    id: number;
+    id: string;
     name: string;
     color: number;
     is_audio_clip: boolean;

package/ns/cue-point.d.ts

@@ -13,7 +13,7 @@ export interface ObservableProperties {
     time: number;
 }
 export interface RawCuePoint {
-    id: number;
+    id: string;
     name: string;
     time: number;
 }

package/ns/device-parameter.d.ts

@@ -25,7 +25,7 @@ export interface ObservableProperties {
     value: number;
 }
 export interface RawDeviceParameter {
-    id: number;
+    id: string;
     name: string;
     value: number;
     is_quantized: boolean;

package/ns/device.d.ts

@@ -24,7 +24,7 @@ export interface ObservableProperties {
     parameters: string;
 }
 export interface RawDevice {
-    id: number;
+    id: string;
     name: string;
     type: DeviceType;
     class_name: string;

package/ns/index.d.ts

@@ -2,8 +2,8 @@ import { Ableton } from "..";
 export declare class Namespace<GP, TP, SP, OP> {
     protected ableton: Ableton;
     protected ns: string;
-    protected nsid?: number | undefined;
-    constructor(ableton: Ableton, ns: string, nsid?: number | undefined);
+    protected nsid?: string | undefined;
+    constructor(ableton: Ableton, ns: string, nsid?: string | undefined);
     protected transformers: Partial<{
         [T in Extract<keyof GP, keyof TP>]: (val: GP[T]) => TP[T];
     }>;

package/ns/scene.d.ts

@@ -29,7 +29,7 @@ export interface ObservableProperties {
 }
 export interface RawScene {
     color: number;
-    id: number;
+    id: string;
     name: string;
 }
 export declare class Scene extends Namespace<GettableProperties, TransformedProperties, SettableProperties, ObservableProperties> {

package/ns/track.d.ts

@@ -111,7 +111,7 @@ export interface ObservableProperties {
     solo: boolean;
 }
 export interface RawTrack {
-    id: number;
+    id: string;
     name: string;
     color: number;
     is_foldable: boolean;

package/ns/track.js

@@ -41,7 +41,7 @@ var Track = /** @class */ (function (_super) {
     Track.prototype.duplicateClipToArrangement = function (clipID, time) {
         return this.sendCommand("duplicate_clip_to_arrangement", {
             clip_id: clipID,
-            time: time
+            time: time,
         });
     };
     return Track;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ableton-js",
-  "version": "2.5.3",
+  "version": "2.6.0",
   "description": "Control Ableton Live from Node",
   "main": "index.js",
   "author": "Leo Bernard <admin@leolabs.org>",