ableton-js 2.3.3 → 2.5.0

package/CHANGELOG.md

@@ -4,8 +4,30 @@ 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.5.0](https://github.com/leolabs/ableton.js/compare/v2.4.0...v2.5.0)
+
+- adds support for getting the group_track property from a Track object [`#46`](https://github.com/leolabs/ableton.js/pull/46)
+- Forward requested midi cc and note messages [`#48`](https://github.com/leolabs/ableton.js/pull/48)
+- add Track's `duplicate_clip_to_arrangement` method [`#49`](https://github.com/leolabs/ableton.js/pull/49)
+- Create LICENSE [`3f42141`](https://github.com/leolabs/ableton.js/commit/3f42141f33fc5b13eea2c46675c72182ec691bfb)
+
+#### [v2.4.0](https://github.com/leolabs/ableton.js/compare/v2.3.4...v2.4.0)
+
+> 21 May 2022
+
+- :wrench: Use ports 39031 and 39041 to avoid collisions with other applications [`e3bd84c`](https://github.com/leolabs/ableton.js/commit/e3bd84cadf92af5d648533fd656c90722f5d8ab2)
+- :sparkles: Run the heartbeat check once after initializing the class [`8db0bd6`](https://github.com/leolabs/ableton.js/commit/8db0bd66f5dec534f38c1319cacd2cc91da89f6a)
+
+#### [v2.3.4](https://github.com/leolabs/ableton.js/compare/v2.3.3...v2.3.4)
+
+> 1 May 2022
+
+- :sparkles: Return the start and end time of clips in the raw clip [`1862efe`](https://github.com/leolabs/ableton.js/commit/1862efe6c6e8bc4d894cdce9b376e1fde93c8c7b)
+
 #### [v2.3.3](https://github.com/leolabs/ableton.js/compare/v2.3.2...v2.3.3)
 
+> 30 April 2022
+
 - :sparkles: Add set_or_delete_cue, undo, and redo commands [`41d5ef7`](https://github.com/leolabs/ableton.js/commit/41d5ef7a2461fea95b125de13e18285beb47a2d6)
 
 #### [v2.3.2](https://github.com/leolabs/ableton.js/compare/v2.3.1...v2.3.2)

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Leo Bernard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/index.d.ts

@@ -3,6 +3,7 @@ import { EventEmitter } from "events";
 import { Song } from "./ns/song";
 import { Internal } from "./ns/internal";
 import { Application } from "./ns/application";
+import { Midi } from "./ns/midi";
 interface Command {
     uuid: string;
     ns: string;
@@ -45,6 +46,7 @@ export declare class Ableton extends EventEmitter implements ConnectionEventEmit
     song: Song;
     application: Application;
     internal: Internal;
+    midi: Midi;
     constructor(host?: string, sendPort?: number, listenPort?: number, heartbeatInterval?: number);
     close(): void;
     /**

package/index.js

@@ -68,6 +68,7 @@ var zlib_1 = require("zlib");
 var song_1 = require("./ns/song");
 var internal_1 = require("./ns/internal");
 var application_1 = require("./ns/application");
+var midi_1 = require("./ns/midi");
 var package_version_1 = require("./util/package-version");
 var TimeoutError = /** @class */ (function (_super) {
     __extends(TimeoutError, _super);
@@ -84,8 +85,8 @@ var Ableton = /** @class */ (function (_super) {
     __extends(Ableton, _super);
     function Ableton(host, sendPort, listenPort, heartbeatInterval) {
         if (host === void 0) { host = "127.0.0.1"; }
-        if (sendPort === void 0) { sendPort = 9041; }
-        if (listenPort === void 0) { listenPort = 9031; }
+        if (sendPort === void 0) { sendPort = 39041; }
+        if (listenPort === void 0) { listenPort = 39031; }
         if (heartbeatInterval === void 0) { heartbeatInterval = 2000; }
         var _this = _super.call(this) || this;
         _this.host = host;
@@ -100,10 +101,11 @@ var Ableton = /** @class */ (function (_super) {
         _this.song = new song_1.Song(_this);
         _this.application = new application_1.Application(_this);
         _this.internal = new internal_1.Internal(_this);
-        _this.client = dgram_1.default.createSocket({ type: "udp4", reuseAddr: true });
+        _this.midi = new midi_1.Midi(_this);
+        _this.client = dgram_1.default.createSocket({ type: "udp4" });
         _this.client.bind(_this.listenPort, host);
         _this.client.addListener("message", _this.handleIncoming.bind(_this));
-        _this.heartbeatInterval = setInterval(function () { return __awaiter(_this, void 0, void 0, function () {
+        var heartbeat = function () { return __awaiter(_this, void 0, void 0, function () {
             var e_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
@@ -133,7 +135,9 @@ var Ableton = /** @class */ (function (_super) {
                     case 4: return [2 /*return*/];
                 }
             });
-        }); }, heartbeatInterval);
+        }); };
+        _this.heartbeatInterval = setInterval(heartbeat, heartbeatInterval);
+        heartbeat();
         _this.internal
             .get("version")
             .then(function (v) {

package/midi-script/AbletonJS.py

@@ -14,6 +14,7 @@ from .Track import Track
 from .Internal import Internal
 from .ClipSlot import ClipSlot
 from .Clip import Clip
+from .Midi import Midi
 from _Framework.ControlSurface import ControlSurface
 import Live
 
@@ -21,6 +22,7 @@ import Live
 class AbletonJS(ControlSurface):
     def __init__(self, c_instance):
         super(AbletonJS, self).__init__(c_instance)
+        self.tracked_midi = set()
 
         Socket.set_log(self.log_message)
         Socket.set_message(self.show_message)
@@ -37,7 +39,8 @@ class AbletonJS(ControlSurface):
             "song-view": SongView(c_instance, self.socket),
             "track": Track(c_instance, self.socket),
             "clip_slot": ClipSlot(c_instance, self.socket),
-            "clip": Clip(c_instance, self.socket)
+            "clip": Clip(c_instance, self.socket),
+            "midi": Midi(c_instance, self.socket, self.tracked_midi, self.request_rebuild_midi_map)
         }
 
         self.recv_loop = Live.Base.Timer(
@@ -47,6 +50,17 @@ class AbletonJS(ControlSurface):
 
         self.socket.send("connect")
 
+    def build_midi_map(self, midi_map_handle):
+        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])
+            elif midi[0] == "note":
+                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)
+
     def disconnect(self):
         self.log_message("Disconnecting")
         self.recv_loop.stop()

package/midi-script/Clip.py

@@ -15,6 +15,8 @@ class Clip(Interface):
             "color": clip.color,
             "is_audio_clip": clip.is_audio_clip,
             "is_midi_clip": clip.is_midi_clip,
+            "start_time": clip.start_time,
+            "end_time": clip.end_time,
         }
 
     def __init__(self, c_instance, socket):

package/midi-script/Internal.py

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

package/midi-script/Midi.py

@@ -0,0 +1,55 @@
+from __future__ import absolute_import
+
+from .Interface import Interface
+
+
+class Midi(Interface):
+    event_id = None
+
+    def __init__(self, c_instance, socket, tracked_midi, update_midi_callback):
+        super(Midi, self).__init__(c_instance, socket)
+        self.outputs = set()
+        self.tracked_midi = tracked_midi
+        self.update_midi = update_midi_callback
+
+    def get_ns(self, nsid):
+        return self
+
+    def set_midi_outputs(self, ns, outputs):
+        self.outputs.clear()
+        for output in outputs:
+            try:
+                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")))
+            except ValueError as e:
+                self.log_message(e)
+            except:
+                self.log_message("invalid midi output requested: " + str(output))
+
+    def remove_midi_listener(self, fn):
+        self.event_id = None
+        self.tracked_midi.clear()
+        self.update_midi()
+
+    def add_listener(self, ns, prop, eventId, nsid="Default"):
+        if prop != "midi":
+            raise Exception("Listener " + str(prop) + " does not exist.")
+
+        if self.event_id is not None:
+            self.log_message("midi listener already exists")
+            return self.event_id
+
+        self.log_message("Attaching midi listener")
+
+        self.tracked_midi.clear()
+        self.tracked_midi.update(self.outputs)
+        self.update_midi()
+        self.event_id = eventId
+
+        return eventId
+
+    def send_midi(self, midi_bytes):
+        if self.event_id is not None:
+            self.socket.send(self.event_id, {"bytes": midi_bytes})

package/midi-script/Socket.py

@@ -22,10 +22,11 @@ class Socket(object):
     def set_message(func):
         Socket.show_message = func
 
-    def __init__(self, handler, remotehost='127.0.0.1', remoteport=9031, localhost='127.0.0.1', localport=9041):
+    def __init__(self, handler, remotehost='127.0.0.1', remoteport=39031, localhost='127.0.0.1', localport=39041):
         self.input_handler = handler
 
-        self._socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+        self._socket = socket.socket(
+            socket.AF_INET, socket.SOCK_DGRAM)
         self._socket.setblocking(0)
 
         self._local_addr = (localhost, localport)

package/midi-script/Track.py

@@ -25,3 +25,10 @@ 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)
+
+    def duplicate_clip_to_arrangement(self, ns, clip_id, time):
+        return ns.duplicate_clip_to_arrangement(self.get_obj(clip_id), time)

package/ns/clip.d.ts

@@ -132,6 +132,8 @@ export interface RawClip {
     color: number;
     is_audio_clip: boolean;
     is_midi_clip: boolean;
+    start_time: number;
+    end_time: number;
 }
 /**
  * This class represents an entry in Live's Session view matrix.

package/ns/midi.d.ts

@@ -0,0 +1,63 @@
+import { Namespace } from "./index";
+import { Ableton } from "../index";
+export declare enum MidiCommand {
+    NoteOn = 128,
+    NoteOff = 144,
+    AfterTouch = 160,
+    ControlChange = 176,
+    PatchChange = 192,
+    ChannelPressure = 208,
+    PitchBend = 224,
+    SysExStart = 240,
+    MidiTimeCodeQuarterFrame = 241,
+    SongPositionPointer = 242,
+    SongSelect = 243,
+    TuneRequest = 246,
+    SysExEnd = 247,
+    TimingClock = 248,
+    Start = 250,
+    Continue = 251,
+    Stop = 252,
+    ActiveSensing = 254,
+    SystemReset = 255
+}
+export interface MidiMapping {
+    type: "cc" | "note";
+    channel: number;
+    target: number;
+}
+export interface MidiNote {
+    command: MidiCommand.NoteOn | MidiCommand.NoteOff;
+    key: number;
+    velocity: number;
+}
+export interface MidiCC {
+    command: MidiCommand.ControlChange;
+    controller: number;
+    value: number;
+}
+export declare class MidiMessage {
+    command: MidiCommand;
+    parameter1: number | null;
+    parameter2: number | null;
+    constructor(raw: RawMidiMessage);
+    toCC(): MidiCC;
+    toNote(): MidiNote;
+}
+export interface RawMidiMessage {
+    bytes: number[];
+}
+export interface GettableProperties {
+}
+export interface TransformedProperties {
+    midi: MidiMessage;
+}
+export interface SettableProperties {
+    midi_outputs: MidiMapping[];
+}
+export interface ObservableProperties {
+    midi: RawMidiMessage;
+}
+export declare class Midi extends Namespace<GettableProperties, TransformedProperties, SettableProperties, ObservableProperties> {
+    constructor(ableton: Ableton);
+}

package/ns/midi.js

@@ -0,0 +1,100 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Midi = exports.MidiMessage = exports.MidiCommand = void 0;
+var index_1 = require("./index");
+var MidiCommand;
+(function (MidiCommand) {
+    MidiCommand[MidiCommand["NoteOn"] = 128] = "NoteOn";
+    MidiCommand[MidiCommand["NoteOff"] = 144] = "NoteOff";
+    MidiCommand[MidiCommand["AfterTouch"] = 160] = "AfterTouch";
+    MidiCommand[MidiCommand["ControlChange"] = 176] = "ControlChange";
+    MidiCommand[MidiCommand["PatchChange"] = 192] = "PatchChange";
+    MidiCommand[MidiCommand["ChannelPressure"] = 208] = "ChannelPressure";
+    MidiCommand[MidiCommand["PitchBend"] = 224] = "PitchBend";
+    MidiCommand[MidiCommand["SysExStart"] = 240] = "SysExStart";
+    MidiCommand[MidiCommand["MidiTimeCodeQuarterFrame"] = 241] = "MidiTimeCodeQuarterFrame";
+    MidiCommand[MidiCommand["SongPositionPointer"] = 242] = "SongPositionPointer";
+    MidiCommand[MidiCommand["SongSelect"] = 243] = "SongSelect";
+    MidiCommand[MidiCommand["TuneRequest"] = 246] = "TuneRequest";
+    MidiCommand[MidiCommand["SysExEnd"] = 247] = "SysExEnd";
+    MidiCommand[MidiCommand["TimingClock"] = 248] = "TimingClock";
+    MidiCommand[MidiCommand["Start"] = 250] = "Start";
+    MidiCommand[MidiCommand["Continue"] = 251] = "Continue";
+    MidiCommand[MidiCommand["Stop"] = 252] = "Stop";
+    MidiCommand[MidiCommand["ActiveSensing"] = 254] = "ActiveSensing";
+    MidiCommand[MidiCommand["SystemReset"] = 255] = "SystemReset";
+})(MidiCommand = exports.MidiCommand || (exports.MidiCommand = {}));
+var MidiMessage = /** @class */ (function () {
+    function MidiMessage(raw) {
+        this.parameter1 = null;
+        this.parameter2 = null;
+        switch (raw.bytes.length) {
+            case 0:
+                throw "bytes missing from midi message";
+            case 3:
+                this.parameter1 = raw.bytes[1];
+                this.parameter2 = raw.bytes[2];
+                break;
+            case 2:
+                this.parameter1 = raw.bytes[1];
+                break;
+            case 1:
+                break;
+            default:
+                throw "invalid midi message length: " + raw.bytes.length;
+        }
+        if (!(raw.bytes[0] in MidiCommand)) {
+            throw "invalid midi command: " + raw.bytes[0];
+        }
+        this.command = raw.bytes[0];
+    }
+    MidiMessage.prototype.toCC = function () {
+        if (this.command !== MidiCommand.ControlChange) {
+            throw "not a midi CC message";
+        }
+        return {
+            command: this.command,
+            controller: this.parameter1,
+            value: this.parameter2
+        };
+    };
+    MidiMessage.prototype.toNote = function () {
+        if (this.command !== MidiCommand.NoteOn && this.command !== MidiCommand.NoteOff) {
+            throw "not a midi note message";
+        }
+        return {
+            command: this.command,
+            key: this.parameter1,
+            velocity: this.parameter2
+        };
+    };
+    return MidiMessage;
+}());
+exports.MidiMessage = MidiMessage;
+var Midi = /** @class */ (function (_super) {
+    __extends(Midi, _super);
+    function Midi(ableton) {
+        var _this = _super.call(this, ableton, "midi") || this;
+        _this.transformers = {
+            midi: function (msg) { return new MidiMessage(msg); }
+        };
+        return _this;
+    }
+    return Midi;
+}(index_1.Namespace));
+exports.Midi = Midi;

package/ns/track.d.ts

@@ -120,4 +120,5 @@ export interface RawTrack {
 export declare class Track extends Namespace<GettableProperties, TransformedProperties, SettableProperties, ObservableProperties> {
     raw: RawTrack;
     constructor(ableton: Ableton, raw: RawTrack);
+    duplicateClipToArrangement(clipID: number, time: number): Promise<any>;
 }

package/ns/track.js

@@ -38,6 +38,12 @@ var Track = /** @class */ (function (_super) {
         };
         return _this;
     }
+    Track.prototype.duplicateClipToArrangement = function (clipID, time) {
+        return this.sendCommand("duplicate_clip_to_arrangement", {
+            clip_id: clipID,
+            time: time
+        });
+    };
     return Track;
 }(_1.Namespace));
 exports.Track = Track;

package/package.json

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