ableton-js 3.3.3 → 3.3.4

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.4](https://github.com/leolabs/ableton.js/compare/v3.3.3...v3.3.4)
+
+- :sparkles: Add support for the Track View class [`3ff5980`](https://github.com/leolabs/ableton.js/commit/3ff5980e5e5f407bc6b767a5329b54774ca10534)
+- :sparkles: Add a `safeStopPlaying` function that only stops playback when Live is currently playing to prevent accidental jumps to the beginning of the timeline [`a7b84e2`](https://github.com/leolabs/ableton.js/commit/a7b84e2146a69ab00cc75f83a4eedd5d91495eda)
+- :art: Fix formatting [`f06d3d0`](https://github.com/leolabs/ableton.js/commit/f06d3d0cde4632612b1db8ea04e85f1276eb8bb6)
+
 #### [v3.3.3](https://github.com/leolabs/ableton.js/compare/v3.3.2...v3.3.3)
 
+> 10 September 2023
+
 - :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)

package/midi-script/AbletonJS.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import
 import time
 
+
 from .version import version
 from .Config import DEBUG, FAST_POLLING
 from .Logging import logger
@@ -18,6 +19,7 @@ from .Scene import Scene
 from .Song import Song
 from .SongView import SongView
 from .Track import Track
+from .TrackView import TrackView
 from .Internal import Internal
 from .ClipSlot import ClipSlot
 from .Clip import Clip
@@ -52,6 +54,7 @@ class AbletonJS(ControlSurface):
             "song": Song(c_instance, self.socket),
             "song-view": SongView(c_instance, self.socket),
             "track": Track(c_instance, self.socket),
+            "track-view": TrackView(c_instance, self.socket),
             "clip_slot": ClipSlot(c_instance, self.socket),
             "clip": Clip(c_instance, self.socket),
         }
@@ -69,8 +72,8 @@ class AbletonJS(ControlSurface):
         tick_time = time.time() * 1000
 
         if tick_time - self._last_tick > 200:
-            logger.warn("UDP tick is lagging, delta: " +
-                        str(round(tick_time - self._last_tick)) + "ms")
+            logger.warning("UDP tick is lagging, delta: " +
+                           str(round(tick_time - self._last_tick)) + "ms")
 
         self._last_tick = tick_time
         self.socket.process()
@@ -78,8 +81,8 @@ class AbletonJS(ControlSurface):
         process_time = time.time() * 1000
 
         if process_time - tick_time > 100:
-            logger.warn("UDP processing is taking long, delta: " +
-                        str(round(tick_time - process_time)) + "ms")
+            logger.warning("UDP processing is taking long, delta: " +
+                           str(round(tick_time - process_time)) + "ms")
 
         self.schedule_message(1, self.tick)
 

package/midi-script/Midi.py

@@ -40,10 +40,10 @@ class Midi(Interface):
             raise Exception("Listener " + str(prop) + " does not exist.")
 
         if self.event_id is not None:
-            logger.warn("midi listener already exists")
+            logger.warning("MIDI listener already exists")
             return self.event_id
 
-        logger.info("Attaching midi listener")
+        logger.info("Attaching MIDI listener")
 
         self.tracked_midi.clear()
         self.tracked_midi.update(self.outputs)

package/midi-script/Socket.py

@@ -46,7 +46,7 @@ class Socket(object):
             logger.error(msg)
 
     def set_client_port(self, port):
-        logger.info("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))
 

package/midi-script/Song.py

@@ -4,17 +4,12 @@ from .CuePoint import CuePoint
 from .Device import Device
 from .Scene import Scene
 from .Track import Track
-import Live
 
-INSERT_MODES = {'default':Live.Track.DeviceInsertMode.default, 
- 'left':Live.Track.DeviceInsertMode.selected_left, 
- 'right':Live.Track.DeviceInsertMode.selected_right}
 
 class Song(Interface):
     def __init__(self, c_instance, socket):
         super(Song, self).__init__(c_instance, socket)
         self.song = self.ableton.song()
-        self._insert_mode = INSERT_MODES['default']
 
     def get_ns(self, nsid):
         return self.song
@@ -66,6 +61,9 @@ class Song(Interface):
     def set_appointed_device(self, ns, device_id):
         ns.appointed_device = Interface.get_obj(device_id)
 
-    def set_insert_mode(self,ns, args):
-        self._insert_mode = INSERT_MODES.get(str(args), INSERT_MODES['default'])
-        self.song.view.selected_track.view.device_insert_mode = self._insert_mode
+    def safe_stop_playing(self, ns):
+        if self.song.is_playing:
+            self.song.stop_playing()
+            return True
+
+        return False

package/midi-script/TrackView.py

@@ -0,0 +1,24 @@
+from __future__ import absolute_import
+from .Interface import Interface
+from .Device import Device
+
+import Live
+
+INSERT_MODES = {'default': Live.Track.DeviceInsertMode.default,
+                'left': Live.Track.DeviceInsertMode.selected_left,
+                'right': Live.Track.DeviceInsertMode.selected_right}
+
+
+class TrackView(Interface):
+    def __init__(self, c_instance, socket):
+        super(TrackView, self).__init__(c_instance, socket)
+
+    def get_ns(self, nsid):
+        return Interface.obj_ids[nsid].view
+
+    def get_selected_device(self, ns):
+        return Device.serialize_device(ns.selected_device)
+
+    def set_device_insert_mode(self, ns, name):
+        mode = INSERT_MODES.get(str(name), INSERT_MODES['default'])
+        ns.device_insert_mode = mode

package/midi-script/version.py

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

package/ns/song.d.ts

@@ -61,11 +61,6 @@ export interface TransformedProperties {
     visible_tracks: Track[];
     scenes: Scene[];
 }
-export declare enum DeviceInsertMode {
-    default = "default",
-    left = "left",
-    right = "right"
-}
 export interface SettableProperties {
     appointed_device: string;
     arrangement_overdub: boolean;
@@ -76,7 +71,6 @@ export interface SettableProperties {
     exclusive_arm: number;
     exclusive_solo: number;
     groove_amount: number;
-    insert_mode: DeviceInsertMode;
     is_counting_in: boolean;
     is_playing: boolean;
     last_event_time: number;
@@ -217,7 +211,7 @@ export declare class Song extends Namespace<GettableProperties, TransformedPrope
     startPlaying(): Promise<any>;
     stopAllClips(): Promise<any>;
     stopPlaying(): Promise<any>;
+    safeStopPlaying(): Promise<any>;
     tapTempo(): Promise<any>;
     undo(): Promise<any>;
-    set_insert_mode(args: DeviceInsertMode): Promise<any>;
 }

package/ns/song.js

@@ -1,17 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Song = exports.RecordingQuantization = exports.Quantization = exports.TimeFormat = exports.DeviceInsertMode = void 0;
+exports.Song = exports.RecordingQuantization = exports.Quantization = exports.TimeFormat = void 0;
 const _1 = require(".");
 const track_1 = require("./track");
 const cue_point_1 = require("./cue-point");
 const song_view_1 = require("./song-view");
 const scene_1 = require("./scene");
-var DeviceInsertMode;
-(function (DeviceInsertMode) {
-    DeviceInsertMode["default"] = "default";
-    DeviceInsertMode["left"] = "left";
-    DeviceInsertMode["right"] = "right";
-})(DeviceInsertMode || (exports.DeviceInsertMode = DeviceInsertMode = {}));
 var TimeFormat;
 (function (TimeFormat) {
     TimeFormat[TimeFormat["MsTime"] = 0] = "MsTime";
@@ -149,14 +143,14 @@ class Song extends _1.Namespace {
     async stopPlaying() {
         return this.sendCommand("stop_playing");
     }
+    async safeStopPlaying() {
+        return this.sendCommand("safe_stop_playing");
+    }
     async tapTempo() {
         return this.sendCommand("tap_tempo");
     }
     async undo() {
         return this.sendCommand("undo");
     }
-    async set_insert_mode(args) {
-        return this.sendCommand("set_insert_mode", { args });
-    }
 }
 exports.Song = Song;

package/ns/track-view.d.ts

@@ -0,0 +1,30 @@
+import { Ableton } from "..";
+import { Namespace } from ".";
+import { Device, RawDevice } from "./device";
+export declare enum DeviceInsertMode {
+    Default = "default",
+    Left = "left",
+    Right = "right"
+}
+export interface GettableProperties {
+    is_collapsed: boolean;
+    selected_device: RawDevice;
+}
+export interface TransformedProperties {
+    selected_device: Device;
+}
+export interface SettableProperties {
+    device_insert_mode: DeviceInsertMode;
+    is_collapsed: boolean;
+}
+export interface ObservableProperties {
+    is_collapsed: boolean;
+    selected_device: RawDevice;
+}
+export declare class TrackView extends Namespace<GettableProperties, TransformedProperties, SettableProperties, ObservableProperties> {
+    constructor(ableton: Ableton, nsid: string);
+    /**
+     * Selects the track's instrument if it has one.
+     */
+    selectInstrument(): Promise<any>;
+}

package/ns/track-view.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrackView = exports.DeviceInsertMode = void 0;
+const _1 = require(".");
+const device_1 = require("./device");
+var DeviceInsertMode;
+(function (DeviceInsertMode) {
+    DeviceInsertMode["Default"] = "default";
+    DeviceInsertMode["Left"] = "left";
+    DeviceInsertMode["Right"] = "right";
+})(DeviceInsertMode || (exports.DeviceInsertMode = DeviceInsertMode = {}));
+class TrackView extends _1.Namespace {
+    constructor(ableton, nsid) {
+        super(ableton, "track-view", nsid);
+        this.transformers = {
+            selected_device: (device) => new device_1.Device(ableton, device),
+        };
+        this.cachedProps = {
+            selected_device: true,
+        };
+    }
+    /**
+     * Selects the track's instrument if it has one.
+     */
+    async selectInstrument() {
+        return this.sendCommand("select_instrument");
+    }
+}
+exports.TrackView = TrackView;

package/ns/track.d.ts

@@ -5,6 +5,7 @@ import { ClipSlot, RawClipSlot } from "./clip-slot";
 import { MixerDevice, RawMixerDevice } from "./mixer-device";
 import { Clip, RawClip } from "./clip";
 import { Color } from "../util/color";
+import { TrackView } from "./track-view";
 export declare enum RoutingLayout {
     Mono = 1,
     Stereo = 2
@@ -149,6 +150,7 @@ export interface RawTrack {
 }
 export declare class Track extends Namespace<GettableProperties, TransformedProperties, SettableProperties, ObservableProperties> {
     raw: RawTrack;
+    view: TrackView;
     constructor(ableton: Ableton, raw: RawTrack);
     /**
      * Duplicates the given clip into the arrangement of this track at the provided destination time and returns it.

package/ns/track.js

@@ -7,6 +7,7 @@ const clip_slot_1 = require("./clip-slot");
 const mixer_device_1 = require("./mixer-device");
 const clip_1 = require("./clip");
 const color_1 = require("../util/color");
+const track_view_1 = require("./track-view");
 var RoutingLayout;
 (function (RoutingLayout) {
     RoutingLayout[RoutingLayout["Mono"] = 1] = "Mono";
@@ -25,9 +26,11 @@ var RoutingCategory;
 })(RoutingCategory || (exports.RoutingCategory = RoutingCategory = {}));
 class Track extends _1.Namespace {
     raw;
+    view;
     constructor(ableton, raw) {
         super(ableton, "track", raw.id);
         this.raw = raw;
+        this.view = new track_view_1.TrackView(this.ableton, raw.id);
         this.transformers = {
             arrangement_clips: (clips) => clips.map((clip) => new clip_1.Clip(ableton, clip)),
             color: (c) => new color_1.Color(c),

package/package.json

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