aes70 1.6.2 → 2.0.0

package/src/controller/ControlClasses/OcaWorker.js

@@ -1,9 +1,11 @@
 import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
 import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
+import { OcaIODirection } from '../../OCP1/OcaIODirection.js';
 import { OcaList } from '../../OCP1/OcaList.js';
+import { OcaMap } from '../../OCP1/OcaMap.js';
 import { OcaPort } from '../../OCP1/OcaPort.js';
+import { OcaPortClockMapEntry } from '../../OCP1/OcaPortClockMapEntry.js';
 import { OcaPortID } from '../../OCP1/OcaPortID.js';
-import { OcaPortMode } from '../../OCP1/OcaPortMode.js';
 import { OcaString } from '../../OCP1/OcaString.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
 import { make_control_class } from '../make_control_class.js';
@@ -19,12 +21,12 @@ export const OcaWorker = make_control_class(
   'OcaWorker',
   2,
   '\u0001\u0001',
-  2,
+  3,
   OcaRoot,
   [
     ['GetEnabled', 2, 1, [], [OcaBoolean]],
     ['SetEnabled', 2, 2, [OcaBoolean], []],
-    ['AddPort', 2, 3, [OcaString, OcaPortMode], [OcaPortID]],
+    ['AddPort', 2, 3, [OcaString, OcaIODirection], [OcaPortID]],
     ['DeletePort', 2, 4, [OcaPortID], []],
     ['GetPorts', 2, 5, [], [OcaList(OcaPort)]],
     ['GetPortName', 2, 6, [OcaPortID], [OcaString]],
@@ -35,28 +37,40 @@ export const OcaWorker = make_control_class(
     ['GetLatency', 2, 11, [], [OcaFloat32]],
     ['SetLatency', 2, 12, [OcaFloat32], []],
     ['GetPath', 2, 13, [], [OcaList(OcaString), OcaList(OcaUint32)]],
+    ['GetPortClockMap', 2, 14, [], [OcaMap(OcaPortID, OcaPortClockMapEntry)]],
+    ['SetPortClockMap', 2, 15, [OcaMap(OcaPortID, OcaPortClockMapEntry)], []],
+    ['GetPortClockMapEntry', 2, 16, [OcaPortID], [OcaPortClockMapEntry]],
+    ['SetPortClockMapEntry', 2, 17, [OcaPortID, OcaPortClockMapEntry], []],
+    ['DeletePortClockMapEntry', 2, 18, [OcaPortID], []],
   ],
   [
     ['Enabled', [OcaBoolean], 2, 1, false, false, null],
     ['Ports', [OcaList(OcaPort)], 2, 2, false, false, null],
     ['Label', [OcaString], 2, 3, false, false, null],
-    ['Owner', [OcaUint32], 2, 4, false, false, null],
+    ['Owner', [OcaUint32], 2, 4, true, false, null],
     ['Latency', [OcaFloat32], 2, 5, false, false, null],
+    [
+      'PortClockMap',
+      [OcaMap(OcaPortID, OcaPortClockMapEntry)],
+      2,
+      6,
+      false,
+      false,
+      null,
+    ],
   ],
   []
 );
 
 /**
- * Gets the value of the Enabled property. The return value indicates whether
- * the property was successfully retrieved.
+ * Gets the value of the Enabled property.
  *
  * @method OcaWorker#GetEnabled
  * @returns {Promise<boolean>}
  *   A promise which resolves to a single value of type ``boolean``.
  */
 /**
- * Sets the value of the Enabled property. The return value indicates whether
- * the property was successfully set.
+ * Sets the value of the Enabled property.
  *
  * @method OcaWorker#SetEnabled
  * @param {boolean} enabled
@@ -64,19 +78,17 @@ export const OcaWorker = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Adds an input or output port.. The return value indicates whether the port
- * was successfully added.
+ * Adds an input or output port..
  *
  * @method OcaWorker#AddPort
- * @param {string} Label
- * @param {IOcaPortMode} Mode
+ * @param {string} Name
+ * @param {IOcaIODirection} Mode
  *
  * @returns {Promise<OcaPortID>}
  *   A promise which resolves to a single value of type :class:`OcaPortID`.
  */
 /**
- * Deletes an input or output port.. The return value indicates whether the port
- * was successfully deleted.
+ * Deletes an input or output port..
  *
  * @method OcaWorker#DeletePort
  * @param {IOcaPortID} ID
@@ -84,16 +96,14 @@ export const OcaWorker = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the list of ports owned by the Worker object. The return value indicates
- * whether the list was successfully retrieved.
+ * Gets the list of ports owned by the Worker object.
  *
  * @method OcaWorker#GetPorts
  * @returns {Promise<OcaPort[]>}
  *   A promise which resolves to a single value of type :class:`OcaPort[]`.
  */
 /**
- * Gets the name of the designated port. The return value indicates whether the
- * name was successfully retrieved.
+ * Gets the name of the designated port.
  *
  * @method OcaWorker#GetPortName
  * @param {IOcaPortID} PortID
@@ -102,26 +112,23 @@ export const OcaWorker = make_control_class(
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Sets the name of the designated port. The return value indicates whether the
- * name was successfully set.
+ * Sets the name of the designated port.
  *
  * @method OcaWorker#SetPortName
- * @param {IOcaPortID} PortID
+ * @param {IOcaPortID} ID
  * @param {string} Name
  *
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the Label property. The return value indicates whether the
- * property was successfully retrieved.
+ * Gets the value of the Label property.
  *
  * @method OcaWorker#GetLabel
  * @returns {Promise<string>}
  *   A promise which resolves to a single value of type ``string``.
  */
 /**
- * Sets the value of the Label property. The return value indicates whether the
- * property was successfully set.
+ * Sets the value of the Label property.
  *
  * @method OcaWorker#SetLabel
  * @param {string} label
@@ -129,24 +136,21 @@ export const OcaWorker = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Gets the value of the Owner property. The return value indicates whether the
- * property was successfully retrieved.
+ * Gets the value of the Owner property.
  *
  * @method OcaWorker#GetOwner
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Gets the value of the Latency property. The return value indicates whether
- * the property was successfully retrieved.
+ * Gets the value of the Latency property.
  *
  * @method OcaWorker#GetLatency
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Sets the value of the Latency property. The return value indicates whether
- * the property was successfully set.
+ * Sets the value of the Latency property.
  *
  * @method OcaWorker#SetLatency
  * @param {number} latency
@@ -154,23 +158,65 @@ export const OcaWorker = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns path from the given object down to root. The return value indicates
- * whether the operation succeeded. Added in version 2.
+ * Returns Role Path and ONo Path from the Root Block to this object. The return
+ * value indicates whether the operation succeeded.
  * The return values of this method are
  *
- * - NamePath of type ``string[]``
+ * - RolePath of type ``string[]``
  * - ONoPath of type ``number[]``
  *
  * @method OcaWorker#GetPath
  * @returns {Promise<Arguments<string[],number[]>>}
  */
+/**
+ * Gets the value of the PortClockMap property.
+ *
+ * @method OcaWorker#GetPortClockMap
+ * @returns {Promise<Map<OcaPortID, OcaPortClockMapEntry>>}
+ *   A promise which resolves to a single value of type ``Map<OcaPortID, OcaPortClockMapEntry>``.
+ */
+/**
+ * Sets the value of the PortClockMap property.
+ *
+ * @method OcaWorker#SetPortClockMap
+ * @param {Map<IOcaPortID, IOcaPortClockMapEntry>} Map
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Gets the value of the PortClockMap entry identified by the given PortID.
+ *
+ * @method OcaWorker#GetPortClockMapEntry
+ * @param {IOcaPortID} ID
+ *
+ * @returns {Promise<OcaPortClockMapEntry>}
+ *   A promise which resolves to a single value of type :class:`OcaPortClockMapEntry`.
+ */
+/**
+ * Sets an entry in the PortClockMap property. Adds entry if none already exists
+ * for the given port; replaces entry if it does already exist.
+ *
+ * @method OcaWorker#SetPortClockMapEntry
+ * @param {IOcaPortID} PortID
+ * @param {IOcaPortClockMapEntry} Entry
+ *
+ * @returns {Promise<void>}
+ */
+/**
+ * Deletes PortClockMap entry identified by the given ID.
+ *
+ * @method OcaWorker#DeletePortClockMapEntry
+ * @param {IOcaPortID} ID
+ *
+ * @returns {Promise<void>}
+ */
 /**
  * This event is emitted when the property ``Enabled`` changes in the remote object.
  * The property ``Enabled`` is described in the AES70 standard as follows.
  * Read/write property that indicates whether the worker object is enabled in
  * the device. If an object is disabled it cannot be used by the application.
  * Note that the behavior of a disabled object depends on the object itself
- * (e.g. a disabled chime generator is silent, a disabled equalizer is flat,
+ * (e.g. a disabled signal generator is silent, a disabled equalizer is flat,
  * etc.).
  *
  * @member {PropertyEvent<boolean>} OcaWorker#OnEnabledChanged
@@ -179,7 +225,7 @@ export const OcaWorker = make_control_class(
  * This event is emitted when the property ``Ports`` changes in the remote object.
  * The property ``Ports`` is described in the AES70 standard as follows.
  * The list of (input and output) OCA ports the worker object has. Note that a
- * worker object can have no ports (in which case the list is empty).
+ * worker object can have no ports, in which case the list is empty.
  *
  * @member {PropertyEvent<OcaPort[]>} OcaWorker#OnPortsChanged
  */
@@ -191,13 +237,6 @@ export const OcaWorker = make_control_class(
  *
  * @member {PropertyEvent<string>} OcaWorker#OnLabelChanged
  */
-/**
- * This event is emitted when the property ``Owner`` changes in the remote object.
- * The property ``Owner`` is described in the AES70 standard as follows.
- * Object number of block that contains this worker.
- *
- * @member {PropertyEvent<number>} OcaWorker#OnOwnerChanged
- */
 /**
  * This event is emitted when the property ``Latency`` changes in the remote object.
  * The property ``Latency`` is described in the AES70 standard as follows.
@@ -206,3 +245,14 @@ export const OcaWorker = make_control_class(
  *
  * @member {PropertyEvent<number>} OcaWorker#OnLatencyChanged
  */
+/**
+ * This event is emitted when the property ``PortClockMap`` changes in the remote object.
+ * The property ``PortClockMap`` is described in the AES70 standard as follows.
+ * **Optional property.** Map that connects OcaMediaClock3 object numbers to
+ * input and output OcaPorts and specifies sampling rate converters, if any.
+ * OcaPortID = {mode,index}, where mode = Input or Output. Map entries with
+ * index=0 are default values, to be used when no entry is found for a given
+ * port.
+ *
+ * @member {PropertyEvent<Map<OcaPortID, OcaPortClockMapEntry>>} OcaWorker#OnPortClockMapChanged
+ */

package/src/controller/base_event.js

@@ -1,5 +1,32 @@
 import { OcaEvent } from '../types/OcaEvent.js';
 
+class EventSubscriber {
+  constructor(callback, error_callback) {
+    this.callback = callback;
+    this.failure_callback = error_callback;
+  }
+
+  emit(ctx, results) {
+    try {
+      this.callback.apply(ctx, results);
+    } catch (error) {
+      console.error('Exception thrown by event handler: ', error);
+    }
+  }
+
+  emit_error(ctx, error) {
+    if (this.error_callback) {
+      try {
+        this.error_callback.call(ctx, error);
+      } catch (e) {
+        console.error('Exception thrown by error event handler: ', e);
+      }
+    } else {
+      console.warn('No handler for error', error);
+    }
+  }
+}
+
 /**
  * Base class for all events.
  */
@@ -7,11 +34,28 @@ export class BaseEvent {
   constructor(object, id, argumentTypes) {
     this.object = object;
     this.id = id;
-    this.handlers = new Set();
+    this.subscribers = [];
     this.result = null;
     this.argumentTypes = argumentTypes;
   }
 
+  has_subscribers() {
+    return this.subscribers.length > 0;
+  }
+
+  emit(results) {
+    this.subscribers.forEach((subscriber) => {
+      subscriber.emit(this.object, results);
+    });
+  }
+
+  emit_error(error) {
+    this.subscribers.forEach((subscriber) => {
+      subscriber.emit_error(this.object, error);
+    });
+    this.subscribers.splice(0, this.subscribers.length);
+  }
+
   GetOcaEvent() {
     return new OcaEvent(this.object.ObjectNumber, this.id);
   }
@@ -19,42 +63,46 @@ export class BaseEvent {
   do_subscribe() {}
   do_unsubscribe() {}
 
+  _remove_subscriber(index) {
+    this.subscribers.splice(index, 1);
+
+    if (!this.subscribers.length) this.do_unsubscribe();
+  }
+
   /**
    * Subscribe to this event.
    * @param {function} callback
    */
-  subscribe(callback) {
-    this.handlers.add(callback);
-
-    if (this.handlers.size === 1)
-      return (this.result = this.do_subscribe().then(() => {
-        this.result = null;
-        return true;
-      }));
+  subscribe(callback, failure_callback) {
+    const subscriber = new EventSubscriber(callback, failure_callback);
+    this.subscribers.push(subscriber);
 
-    if (this.result !== null) return this.result;
+    if (this.subscribers.length === 1) {
+      this.do_subscribe();
+    }
 
-    return Promise.resolve(true);
+    return () => {
+      const index = this.subscribers.indexOf(subscriber);
+      if (index === -1) return;
+      this._remove_subscriber(index);
+    };
   }
 
   /**
    * Unsubscribe from this event.
    * @param {function} callback
+   * @deprecated Use the cleanup handler returned from
+   *  subscriber() instead.
    */
   unsubscribe(callback) {
-    this.handlers.delete(callback);
+    const index = this.subscribers.findIndex(
+      (subscriber) => subscriber.callback == callback
+    );
 
-    if (!this.handlers.size) this.do_unsubscribe().catch(function () {});
-
-    return Promise.resolve(true);
-  }
-
-  /**
-   * Unsubscribe all event handlers.
-   */
-  Dipose() {
-    if (this.handlers.size) this.do_unsubscribe().catch(function () {});
+    if (index === -1) {
+      throw new Error('Subscriber does not exist.');
+    }
 
-    this.handlers.clear();
+    this._remove_subscriber(index);
   }
 }

package/src/controller/client_connection.d.ts

@@ -2,6 +2,32 @@ import { IConnectionOptions, Connection } from '../connection';
 
 export type IClientConnectionOptions = IConnectionOptions;
 
+export interface PendingCommand {
+  /**
+   * Name of the method being called. The format is
+   * Class.Method.
+   */
+  name: string;
+
+  /**
+   * If stack debug was enabled on the corresponding
+   * RemoteDevice, this property contains the stack
+   * where the method was called from.
+   */
+  stack: Error['stack'] | null;
+
+  /**
+   * The command pdu.
+   */
+  command: unknown;
+
+  /**
+   * If available, returns the arguments of this
+   * remote method call.
+   */
+  get_arguments(): unknwon[] | undefined;
+}
+
 /**
  * A generic base class for all client connections.
  */

package/src/controller/client_connection.js

@@ -1,26 +1,38 @@
 import { RemoteError } from './remote_error.js';
 import { Connection } from '../connection.js';
 import { Response } from '../OCP1/response.js';
+import { CommandRrq } from '../OCP1/commandrrq.js';
 import { KeepAlive } from '../OCP1/keepalive.js';
 import { Notification } from '../OCP1/notification.js';
+import { Notification2 } from '../OCP1/notification2.js';
 import { Arguments } from './arguments.js';
 import { OcaStatus } from '../types/OcaStatus.js';
+import { EncodedArguments } from '../OCP1/encoded_arguments.js';
 
 class PendingCommand {
   get handle() {
     return this.command.handle;
   }
 
-  constructor(resolve, reject, returnTypes, command, stack) {
+  constructor(resolve, reject, returnTypes, command, stack, name) {
     this.resolve = resolve;
     this.reject = reject;
     this.returnTypes = returnTypes;
     this.command = command;
     this.stack = stack;
+    this.name = name;
     this.lastSent = 0;
     this.retries = 0;
   }
 
+  get_arguments() {
+    const parameters = this.command.parameters;
+
+    if (parameters && parameters instanceof EncodedArguments) {
+      return parameters.data;
+    }
+  }
+
   handleError(error) {
     if (this.stack && error instanceof Error) error.stack = this.stack;
     this.reject(error);
@@ -82,14 +94,19 @@ export class ClientConnection extends Connection {
 
   cleanup() {
     super.cleanup();
+    const subscribers = this._subscribers;
     this._subscribers = null;
-
     const pendingCommands = this._pendingCommands;
     this._pendingCommands = null;
+
     const e = new Error('closed');
     pendingCommands.forEach((pendingCommand, id) => {
       pendingCommand.handleError(structuredClone(e));
     });
+
+    subscribers.forEach((cb) => {
+      cb(false, e);
+    });
   }
 
   _addSubscriber(event, callback) {
@@ -102,6 +119,7 @@ export class ClientConnection extends Connection {
   }
 
   _removeSubscriber(event) {
+    if (this.is_closed()) return;
     const key = eventToKey(event);
     const subscribers = this._subscribers;
 
@@ -130,7 +148,19 @@ export class ClientConnection extends Connection {
     return this._now();
   }
 
-  send_command(command, returnTypes, callback, stack) {
+  find_pending_command(pdu) {
+    const pendingCommands = this._pendingCommands;
+
+    if (pdu instanceof CommandRrq) {
+      return pendingCommands.get(pdu.handle);
+    } else if (pdu instanceof Response) {
+      return pendingCommands.get(pdu.handle);
+    } else {
+      throw new Error(`Expected command or response.`);
+    }
+  }
+
+  send_command(command, returnTypes, callback, stack, name) {
     const executor = (resolve, reject) => {
       const handle = this._getNextCommandHandle();
 
@@ -141,7 +171,8 @@ export class ClientConnection extends Connection {
         reject,
         returnTypes,
         command,
-        stack
+        stack,
+        name
       );
 
       this._pendingCommands.set(handle, pendingCommand);
@@ -179,7 +210,7 @@ export class ClientConnection extends Connection {
       }
 
       const o = pdus[i];
-      //log("INCOMING", o);
+      this.emit('receive', o);
       if (o instanceof Response) {
         const pendingCommand = this._removePendingCommand(o.handle);
 
@@ -193,7 +224,7 @@ export class ClientConnection extends Connection {
         }
 
         pendingCommand.response(o);
-      } else if (o instanceof Notification) {
+      } else if (o instanceof Notification || o instanceof Notification2) {
         const subscribers = this._subscribers;
         const key = eventToKey(o.event);
 
@@ -202,8 +233,9 @@ export class ClientConnection extends Connection {
         if (!cb) {
           // NOTE: this is legal
           continue;
+        } else {
+          cb(true, o);
         }
-        cb(o);
       } else if (o instanceof KeepAlive) {
         if (!(o.time > 0)) {
           throw new Error('Bad keepalive timeout.');

package/src/controller/event.js

@@ -1,5 +1,5 @@
 import { BaseEvent } from './base_event.js';
-import { error } from '../log.js';
+import { NotificationError } from './notification_error.js';
 
 const emptyBuffer = new ArrayBuffer();
 
@@ -11,8 +11,18 @@ const emptyBuffer = new ArrayBuffer();
 export class Event extends BaseEvent {
   constructor(object, id, argumentTypes) {
     super(object, id, argumentTypes);
-    this.callback = (notification) => {
-      if (!this.handlers.size) return;
+    this.callback = (ok, notification) => {
+      if (!ok) {
+        this.emit_error(notification);
+        return;
+      }
+
+      if (!this.has_subscribers()) return;
+
+      if (notification.exception) {
+        this.emit_error(new NotificationError(notification));
+        return;
+      }
 
       const args = new Array(argumentTypes.length);
       // Events without arguments have parameters = null
@@ -23,28 +33,15 @@ export class Event extends BaseEvent {
         [pos, tmp] = argumentTypes[i].decodeFrom(data, pos);
         args[i] = tmp;
       }
-      const object = this.object;
-      this.handlers.forEach(function (callback) {
-        try {
-          callback.apply(object, args);
-        } catch (e) {
-          error(e);
-        }
-      });
+      this.emit(args);
     };
   }
 
   do_subscribe() {
-    return this.object.device.add_subscription(
-      this.GetOcaEvent(),
-      this.callback
-    );
+    this.object.device.add_subscription(this.GetOcaEvent(), this.callback);
   }
 
-  do_unsubscribe(callback) {
-    return this.object.device.remove_subscription(
-      this.GetOcaEvent(),
-      this.callback
-    );
+  do_unsubscribe() {
+    this.object.device.remove_subscription(this.GetOcaEvent(), this.callback);
   }
 }

package/src/controller/make_control_class.js

@@ -58,6 +58,8 @@ function implement_method(cls, method) {
 
   const [name, level, index, argumentTypes, returnTypes, aliases] = method;
 
+  const debugName = `${cls.ClassName}.${name}`;
+
   cls.prototype[name] = function (...args) {
     const argumentCount = argumentTypes.length;
     let callback = null;
@@ -86,7 +88,7 @@ function implement_method(cls, method) {
       argumentCount,
       new EncodedArguments(argumentTypes, args)
     );
-    return this.device.send_command(cmd, returnTypes, callback);
+    return this.device.send_command(cmd, returnTypes, callback, debugName);
   };
 
   if (aliases) {

package/src/controller/notification_error.d.ts

@@ -0,0 +1,40 @@
+export class OcaNotificationExceptionType {
+  static Unspecified: OcaNotificationExceptionType;
+  // Device canceled subscription
+  static CanceledByDevice: OcaNotificationExceptionType;
+  // Object was deleted
+  static ObjectDeleted: OcaNotificationExceptionType;
+  // Something went wrong in the Device.
+  static DeviceError: OcaNotificationExceptionType;
+
+  /**
+   * Returns the numeric value of this enum entry.
+   */
+  valueOf(): number;
+
+  /**
+   * Returns the string representation of this enum entry.
+   */
+  toString(): string;
+
+  /**
+   * Returns the name of an enum entry.
+   */
+  static getName(value: number): string;
+
+  /**
+   * Returns the value of an enum entry name.
+   */
+  static getValue(name: string): number;
+}
+
+export declare class NotificationError extends Error {
+  notification: unknown;
+  type: OcaNotificationExceptionType;
+  try_again: boolean;
+  data: ArrayBuffer | null;
+
+  constructor(notification: unknown);
+
+  is_object_deleted(): boolean;
+}