@its-c10/dis-codec 0.2.1 → 0.3.0

package/dist/binary/BinaryWriter.d.ts

@@ -7,6 +7,8 @@ export declare class BinaryWriter {
     getOffset(): number;
     /** Returns a copy of written bytes as ArrayBuffer. */
     toArrayBuffer(): ArrayBuffer;
+    /** Overwrite a uint8 at the given offset (does not advance write position). Used to patch data length fields. */
+    patchUint8(offset: number, value: number): void;
     /** Overwrite a uint16 at the given offset (does not advance write position). Used to patch PDU length. */
     patchUint16(offset: number, value: number): void;
     private ensureWritable;

package/dist/binary/BinaryWriter.js

@@ -14,6 +14,13 @@ export class BinaryWriter {
         new Uint8Array(out).set(this.buf.subarray(0, this.offset));
         return out;
     }
+    /** Overwrite a uint8 at the given offset (does not advance write position). Used to patch data length fields. */
+    patchUint8(offset, value) {
+        if (offset < 0 || offset + 1 > this.offset) {
+            throw new RangeError(`BinaryWriter.patchUint8: offset ${offset} out of range [0, ${this.offset - 1}]`);
+        }
+        this.view.setUint8(offset, value);
+    }
     /** Overwrite a uint16 at the given offset (does not advance write position). Used to patch PDU length. */
     patchUint16(offset, value) {
         if (offset < 0 || offset + 2 > this.offset) {

package/dist/core/entityId.d.ts

@@ -12,3 +12,5 @@ export interface EntityId {
 }
 export declare function decodeEntityId(reader: BinaryReader): EntityId;
 export declare function encodeEntityId(writer: BinaryWriter, value: EntityId): void;
+export declare function decodeSimulationAddress(reader: BinaryReader): SimulationAddress;
+export declare function encodeSimulationAddress(writer: BinaryWriter, value: SimulationAddress): void;

package/dist/core/entityId.js

@@ -12,3 +12,13 @@ export function encodeEntityId(writer, value) {
     writer.writeUint16(value.simulationAddress.application);
     writer.writeUint16(value.entity);
 }
+export function decodeSimulationAddress(reader) {
+    return {
+        site: reader.readUint16(),
+        application: reader.readUint16(),
+    };
+}
+export function encodeSimulationAddress(writer, value) {
+    writer.writeUint16(value.site);
+    writer.writeUint16(value.application);
+}

package/dist/dis7/constants.d.ts

@@ -21,8 +21,12 @@ export declare const PDU_TYPE_STOP_FREEZE = 14;
 export declare const PDU_TYPE_ELECTROMAGNETIC_EMISSION = 23;
 /** PDU type: Transmitter. */
 export declare const PDU_TYPE_TRANSMITTER = 25;
+/** PDU type: Point Object State. */
+export declare const PDU_TYPE_POINT_OBJECT_STATE = 43;
 /** Electromagnetic Emission protocol family. */
 export declare const PROTOCOL_FAMILY_ELECTROMAGNETIC_EMISSION = 6;
+/** Distributed Emissions Regeneration protocol family. */
+export declare const PROTOCOL_FAMILY_DISTRIBUTED_EMISSIONS_REGENERATION = 9;
 /** Radio Communications protocol family. */
 export declare const PROTOCOL_FAMILY_RADIO_COMMUNICATIONS = 4;
 /** Start/Resume PDU total length on wire (bytes). */
@@ -39,3 +43,5 @@ export declare const ENTITY_STATE_PDU_FIXED_LENGTH = 144;
 export declare const ENTITY_STATE_VARIABLE_PARAMETER_RECORD_LENGTH = 16;
 /** Transmitter PDU fixed portion in bytes (104). Total = 104 + M + A + sum of variable record sizes. */
 export declare const TRANSMITTER_PDU_FIXED_LENGTH = 104;
+/** Point Object State PDU total length on wire (bytes). */
+export declare const POINT_OBJECT_STATE_PDU_LENGTH = 88;

package/dist/dis7/constants.js

@@ -21,8 +21,12 @@ export const PDU_TYPE_STOP_FREEZE = 14;
 export const PDU_TYPE_ELECTROMAGNETIC_EMISSION = 23;
 /** PDU type: Transmitter. */
 export const PDU_TYPE_TRANSMITTER = 25;
+/** PDU type: Point Object State. */
+export const PDU_TYPE_POINT_OBJECT_STATE = 43;
 /** Electromagnetic Emission protocol family. */
 export const PROTOCOL_FAMILY_ELECTROMAGNETIC_EMISSION = 6;
+/** Distributed Emissions Regeneration protocol family. */
+export const PROTOCOL_FAMILY_DISTRIBUTED_EMISSIONS_REGENERATION = 9;
 /** Radio Communications protocol family. */
 export const PROTOCOL_FAMILY_RADIO_COMMUNICATIONS = 4;
 /** Start/Resume PDU total length on wire (bytes). */
@@ -39,3 +43,5 @@ export const ENTITY_STATE_PDU_FIXED_LENGTH = 144;
 export const ENTITY_STATE_VARIABLE_PARAMETER_RECORD_LENGTH = 16;
 /** Transmitter PDU fixed portion in bytes (104). Total = 104 + M + A + sum of variable record sizes. */
 export const TRANSMITTER_PDU_FIXED_LENGTH = 104;
+/** Point Object State PDU total length on wire (bytes). */
+export const POINT_OBJECT_STATE_PDU_LENGTH = 88;

package/dist/dis7/electromagneticEmissionPdu.d.ts

@@ -21,7 +21,8 @@ export interface BeamDataGroup {
 }
 /** Beam data record (repeats M_i times per emitter system). */
 export interface BeamData {
-    beamDataLength: number;
+    /** Length in octets of beam data (beamNumber through beamStatus). Set automatically during encode. */
+    beamDataLength?: number;
     beamNumber: number;
     beamParameterIndex: number;
     fundamentalParameterData: FundamentalParameterData;
@@ -45,7 +46,8 @@ export interface Location {
 }
 /** One emitter system: fixed fields plus M beams. */
 export interface EmitterSystemData {
-    systemDataLength: number;
+    /** Length in octets of emitter system data (numberOfBeams through beams). Set automatically during encode. */
+    systemDataLength?: number;
     numberOfBeams: number;
     padding: number;
     emitterSystem: EmitterSystemRecord;

package/dist/dis7/electromagneticEmissionPdu.js

@@ -47,7 +47,8 @@ function decodeBeamData(reader) {
     };
 }
 function encodeBeamData(writer, beam) {
-    writer.writeUint8(beam.beamDataLength);
+    const lengthOffset = writer.getOffset();
+    writer.writeUint8(0); // placeholder; patched below
     writer.writeUint8(beam.beamNumber);
     writer.writeUint16(beam.beamParameterIndex);
     encodeFundamentalParameterData(writer, beam.fundamentalParameterData);
@@ -56,6 +57,7 @@ function encodeBeamData(writer, beam) {
     writer.writeUint8(beam.numberOfTargets);
     writer.writeUint8(beam.highDensityTrackJam);
     writer.writeUint8(beam.beamStatus);
+    writer.patchUint8(lengthOffset, writer.getOffset() - lengthOffset - 1);
 }
 function decodeEmitterSystemData(reader) {
     const systemDataLength = reader.readUint8();
@@ -85,7 +87,8 @@ function decodeEmitterSystemData(reader) {
     };
 }
 function encodeEmitterSystemData(writer, sys) {
-    writer.writeUint8(sys.systemDataLength);
+    const lengthOffset = writer.getOffset();
+    writer.writeUint8(0); // placeholder; patched below
     writer.writeUint8(sys.numberOfBeams);
     writer.writeUint16(sys.padding);
     writer.writeUint16(sys.emitterSystem.emitterName);
@@ -97,6 +100,7 @@ function encodeEmitterSystemData(writer, sys) {
     for (const beam of sys.beams) {
         encodeBeamData(writer, beam);
     }
+    writer.patchUint8(lengthOffset, writer.getOffset() - lengthOffset - 1);
 }
 export function decodeElectromagneticEmissionPdu(reader) {
     const header = decodePduHeader(reader);

package/dist/dis7/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * DIS 7 codecs and constants. Version is in the path; names stay clean for dis8/ etc.
  */
-export { PROTOCOL_VERSION, PROTOCOL_FAMILY_ENTITY_INFORMATION, PROTOCOL_FAMILY_SIMULATION_MANAGEMENT, PROTOCOL_FAMILY_ELECTROMAGNETIC_EMISSION, PDU_TYPE_ENTITY_STATE, PDU_TYPE_CREATE_ENTITY, PDU_TYPE_REMOVE_ENTITY, PDU_TYPE_START_RESUME, PDU_TYPE_STOP_FREEZE, PDU_TYPE_ELECTROMAGNETIC_EMISSION, PDU_TYPE_TRANSMITTER, PROTOCOL_FAMILY_RADIO_COMMUNICATIONS, START_RESUME_PDU_LENGTH, STOP_FREEZE_PDU_LENGTH, CREATE_ENTITY_PDU_LENGTH, REMOVE_ENTITY_PDU_LENGTH, ENTITY_STATE_PDU_FIXED_LENGTH, ENTITY_STATE_VARIABLE_PARAMETER_RECORD_LENGTH, TRANSMITTER_PDU_FIXED_LENGTH, } from "./constants.js";
+export { PROTOCOL_VERSION, PROTOCOL_FAMILY_ENTITY_INFORMATION, PROTOCOL_FAMILY_SIMULATION_MANAGEMENT, PROTOCOL_FAMILY_ELECTROMAGNETIC_EMISSION, PDU_TYPE_ENTITY_STATE, PDU_TYPE_CREATE_ENTITY, PDU_TYPE_REMOVE_ENTITY, PDU_TYPE_START_RESUME, PDU_TYPE_STOP_FREEZE, PDU_TYPE_ELECTROMAGNETIC_EMISSION, PDU_TYPE_TRANSMITTER, PDU_TYPE_POINT_OBJECT_STATE, PROTOCOL_FAMILY_RADIO_COMMUNICATIONS, PROTOCOL_FAMILY_DISTRIBUTED_EMISSIONS_REGENERATION, START_RESUME_PDU_LENGTH, STOP_FREEZE_PDU_LENGTH, CREATE_ENTITY_PDU_LENGTH, REMOVE_ENTITY_PDU_LENGTH, ENTITY_STATE_PDU_FIXED_LENGTH, ENTITY_STATE_VARIABLE_PARAMETER_RECORD_LENGTH, TRANSMITTER_PDU_FIXED_LENGTH, POINT_OBJECT_STATE_PDU_LENGTH, } from "./constants.js";
 export { type PduHeader, decodePduHeader, encodePduHeader, } from "./pduHeader.js";
 export { type EntityStatePdu, type EntityType, type Vector3Float, type Vector3Double, type Orientation, type DeadReckoningParameters, type EntityMarking, type VariableParameter, decodeEntityStatePdu, encodeEntityStatePdu, } from "./entityStatePdu.js";
 export { type CreateEntityPdu, decodeCreateEntityPdu, encodeCreateEntityPdu, } from "./createEntityPdu.js";
@@ -10,3 +10,4 @@ export { type StartResumePdu, decodeStartResumePdu, encodeStartResumePdu, } from
 export { type StopFreezePdu, decodeStopFreezePdu, encodeStopFreezePdu, } from "./stopFreezePdu.js";
 export { type ElectromagneticEmissionPdu, type EmitterSystemData, type BeamData, type FundamentalParameterData, type BeamDataGroup, type EmitterSystemRecord, type Location, decodeElectromagneticEmissionPdu, encodeElectromagneticEmissionPdu, } from "./electromagneticEmissionPdu.js";
 export { type TransmitterPdu, type RadioType, type ModulationType, type BeamAntennaPattern, type VariableTransmitterParameter, BEAM_ANTENNA_PATTERN_LENGTH, decodeTransmitterPdu, encodeTransmitterPdu, } from "./transmitterPdu.js";
+export { type PointObjectStatePdu, type PointObjectType, decodePointObjectStatePdu, encodePointObjectStatePdu, } from "./pointObjectStatePdu.js";

package/dist/dis7/index.js

@@ -1,7 +1,7 @@
 /**
  * DIS 7 codecs and constants. Version is in the path; names stay clean for dis8/ etc.
  */
-export { PROTOCOL_VERSION, PROTOCOL_FAMILY_ENTITY_INFORMATION, PROTOCOL_FAMILY_SIMULATION_MANAGEMENT, PROTOCOL_FAMILY_ELECTROMAGNETIC_EMISSION, PDU_TYPE_ENTITY_STATE, PDU_TYPE_CREATE_ENTITY, PDU_TYPE_REMOVE_ENTITY, PDU_TYPE_START_RESUME, PDU_TYPE_STOP_FREEZE, PDU_TYPE_ELECTROMAGNETIC_EMISSION, PDU_TYPE_TRANSMITTER, PROTOCOL_FAMILY_RADIO_COMMUNICATIONS, START_RESUME_PDU_LENGTH, STOP_FREEZE_PDU_LENGTH, CREATE_ENTITY_PDU_LENGTH, REMOVE_ENTITY_PDU_LENGTH, ENTITY_STATE_PDU_FIXED_LENGTH, ENTITY_STATE_VARIABLE_PARAMETER_RECORD_LENGTH, TRANSMITTER_PDU_FIXED_LENGTH, } from "./constants.js";
+export { PROTOCOL_VERSION, PROTOCOL_FAMILY_ENTITY_INFORMATION, PROTOCOL_FAMILY_SIMULATION_MANAGEMENT, PROTOCOL_FAMILY_ELECTROMAGNETIC_EMISSION, PDU_TYPE_ENTITY_STATE, PDU_TYPE_CREATE_ENTITY, PDU_TYPE_REMOVE_ENTITY, PDU_TYPE_START_RESUME, PDU_TYPE_STOP_FREEZE, PDU_TYPE_ELECTROMAGNETIC_EMISSION, PDU_TYPE_TRANSMITTER, PDU_TYPE_POINT_OBJECT_STATE, PROTOCOL_FAMILY_RADIO_COMMUNICATIONS, PROTOCOL_FAMILY_DISTRIBUTED_EMISSIONS_REGENERATION, START_RESUME_PDU_LENGTH, STOP_FREEZE_PDU_LENGTH, CREATE_ENTITY_PDU_LENGTH, REMOVE_ENTITY_PDU_LENGTH, ENTITY_STATE_PDU_FIXED_LENGTH, ENTITY_STATE_VARIABLE_PARAMETER_RECORD_LENGTH, TRANSMITTER_PDU_FIXED_LENGTH, POINT_OBJECT_STATE_PDU_LENGTH, } from "./constants.js";
 export { decodePduHeader, encodePduHeader, } from "./pduHeader.js";
 export { decodeEntityStatePdu, encodeEntityStatePdu, } from "./entityStatePdu.js";
 export { decodeCreateEntityPdu, encodeCreateEntityPdu, } from "./createEntityPdu.js";
@@ -10,3 +10,4 @@ export { decodeStartResumePdu, encodeStartResumePdu, } from "./startResumePdu.js
 export { decodeStopFreezePdu, encodeStopFreezePdu, } from "./stopFreezePdu.js";
 export { decodeElectromagneticEmissionPdu, encodeElectromagneticEmissionPdu, } from "./electromagneticEmissionPdu.js";
 export { BEAM_ANTENNA_PATTERN_LENGTH, decodeTransmitterPdu, encodeTransmitterPdu, } from "./transmitterPdu.js";
+export { decodePointObjectStatePdu, encodePointObjectStatePdu, } from "./pointObjectStatePdu.js";

package/dist/dis7/pointObjectStatePdu.d.ts

@@ -0,0 +1,48 @@
+import type { BinaryReader } from "../binary/BinaryReader.js";
+import type { BinaryWriter } from "../binary/BinaryWriter.js";
+import type { EntityId } from "../core/entityId.js";
+import type { SimulationAddress } from "../core/entityId.js";
+import type { PduHeader } from "./pduHeader.js";
+import type { Vector3Double, Orientation } from "./entityStatePdu.js";
+/** Object type (32 bits): domain, objectKind, category, subcategory. */
+export interface PointObjectType {
+    /** 8-bit enumeration. */
+    domain: number;
+    /** 8-bit enumeration. */
+    objectKind: number;
+    /** 8-bit enumeration. */
+    category: number;
+    /** 8-bit enumeration. */
+    subcategory: number;
+}
+/**
+ * Point Object State PDU (704 bits). Tables 192–193.
+ * PDU Type = 43, Protocol Family = 9.
+ */
+export interface PointObjectStatePdu {
+    header: PduHeader;
+    /** Object ID (same layout as EntityId; entity field holds object number). */
+    objectId: EntityId;
+    /** Referenced Object ID. */
+    referencedObjectId: EntityId;
+    updateNumber: number;
+    /** 8-bit enumeration. */
+    forceId: number;
+    /** 8-bit enumeration. */
+    modifications: number;
+    objectType: PointObjectType;
+    objectLocation: Vector3Double;
+    objectOrientation: Orientation;
+    /** 32-bit record. */
+    specificObjectAppearance: number;
+    /** 16-bit record. */
+    generalObjectAppearance: number;
+    /** 16-bit padding. */
+    padding: number;
+    requesterSimulationId: SimulationAddress;
+    receivingSimulationId: SimulationAddress;
+    /** 32-bit padding. */
+    padding2: number;
+}
+export declare function decodePointObjectStatePdu(reader: BinaryReader): PointObjectStatePdu;
+export declare function encodePointObjectStatePdu(writer: BinaryWriter, pdu: PointObjectStatePdu): void;

package/dist/dis7/pointObjectStatePdu.js

@@ -0,0 +1,92 @@
+import { decodeEntityId, encodeEntityId, decodeSimulationAddress, encodeSimulationAddress, } from "../core/entityId.js";
+import { decodePduHeader, encodePduHeader } from "./pduHeader.js";
+function decodeVector3Double(reader) {
+    return {
+        x: reader.readFloat64(),
+        y: reader.readFloat64(),
+        z: reader.readFloat64(),
+    };
+}
+function encodeVector3Double(writer, v) {
+    writer.writeFloat64(v.x);
+    writer.writeFloat64(v.y);
+    writer.writeFloat64(v.z);
+}
+function decodeOrientation(reader) {
+    return {
+        psi: reader.readFloat32(),
+        theta: reader.readFloat32(),
+        phi: reader.readFloat32(),
+    };
+}
+function encodeOrientation(writer, o) {
+    writer.writeFloat32(o.psi);
+    writer.writeFloat32(o.theta);
+    writer.writeFloat32(o.phi);
+}
+function decodePointObjectType(reader) {
+    return {
+        domain: reader.readUint8(),
+        objectKind: reader.readUint8(),
+        category: reader.readUint8(),
+        subcategory: reader.readUint8(),
+    };
+}
+function encodePointObjectType(writer, t) {
+    writer.writeUint8(t.domain);
+    writer.writeUint8(t.objectKind);
+    writer.writeUint8(t.category);
+    writer.writeUint8(t.subcategory);
+}
+export function decodePointObjectStatePdu(reader) {
+    const header = decodePduHeader(reader);
+    const objectId = decodeEntityId(reader);
+    const referencedObjectId = decodeEntityId(reader);
+    const updateNumber = reader.readUint16();
+    const forceId = reader.readUint8();
+    const modifications = reader.readUint8();
+    const objectType = decodePointObjectType(reader);
+    const objectLocation = decodeVector3Double(reader);
+    const objectOrientation = decodeOrientation(reader);
+    const specificObjectAppearance = reader.readUint32();
+    const generalObjectAppearance = reader.readUint16();
+    const padding = reader.readUint16();
+    const requesterSimulationId = decodeSimulationAddress(reader);
+    const receivingSimulationId = decodeSimulationAddress(reader);
+    const padding2 = reader.readUint32();
+    return {
+        header,
+        objectId,
+        referencedObjectId,
+        updateNumber,
+        forceId,
+        modifications,
+        objectType,
+        objectLocation,
+        objectOrientation,
+        specificObjectAppearance,
+        generalObjectAppearance,
+        padding,
+        requesterSimulationId,
+        receivingSimulationId,
+        padding2,
+    };
+}
+export function encodePointObjectStatePdu(writer, pdu) {
+    encodePduHeader(writer, pdu.header);
+    encodeEntityId(writer, pdu.objectId);
+    encodeEntityId(writer, pdu.referencedObjectId);
+    writer.writeUint16(pdu.updateNumber);
+    writer.writeUint8(pdu.forceId);
+    writer.writeUint8(pdu.modifications);
+    encodePointObjectType(writer, pdu.objectType);
+    encodeVector3Double(writer, pdu.objectLocation);
+    encodeOrientation(writer, pdu.objectOrientation);
+    writer.writeUint32(pdu.specificObjectAppearance);
+    writer.writeUint16(pdu.generalObjectAppearance);
+    writer.writeUint16(pdu.padding);
+    encodeSimulationAddress(writer, pdu.requesterSimulationId);
+    encodeSimulationAddress(writer, pdu.receivingSimulationId);
+    writer.writeUint32(pdu.padding2);
+    writer.patchUint16(8, writer.getOffset());
+}

package/dist/dis7/transmitterPdu.d.ts

@@ -62,8 +62,8 @@ export interface BeamAntennaPattern {
 export interface VariableTransmitterParameter {
     /** 32-bit enumeration. */
     recordType: number;
-    /** Record length in octets (6 + K + P). */
-    recordLength: number;
+    /** Record length in octets (6 + data.length). Set automatically during encode. */
+    recordLength?: number;
     /** Record-specific fields + padding (recordLength - 6 octets). */
     data: Uint8Array;
 }
@@ -98,8 +98,8 @@ export interface TransmitterPdu {
     cryptoSystem: number;
     /** 16-bit record. */
     cryptoKeyId: number;
-    /** Length of modulation parameters in octets (M). */
-    lengthOfModulationParameters: number;
+    /** Length of modulation parameters in octets (M). Set automatically during encode. */
+    lengthOfModulationParameters?: number;
     /** Modulation parameters (M octets). */
     modulationParameters: Uint8Array;
     /** Antenna pattern (e.g. Beam Antenna Pattern, Table 31). */

package/dist/dis7/transmitterPdu.js

@@ -111,8 +111,9 @@ function decodeVariableTransmitterParameter(reader) {
     };
 }
 function encodeVariableTransmitterParameter(writer, v) {
+    const recordLength = 6 + v.data.byteLength;
     writer.writeUint32(v.recordType);
-    writer.writeUint16(v.recordLength);
+    writer.writeUint16(recordLength);
     if (v.data.length > 0) {
         writer.writeBytes(v.data);
     }
@@ -188,7 +189,7 @@ export function encodeTransmitterPdu(writer, pdu) {
     encodeModulationType(writer, pdu.modulationType);
     writer.writeUint16(pdu.cryptoSystem);
     writer.writeUint16(pdu.cryptoKeyId);
-    writer.writeUint8(pdu.lengthOfModulationParameters);
+    writer.writeUint8(pdu.modulationParameters.byteLength);
     writer.writeUint8(0); // padding
     writer.writeUint16(0); // padding
     writer.writeBytes(pdu.modulationParameters);

package/package.json

@@ -1,9 +1,17 @@
 {
   "name": "@its-c10/dis-codec",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Spec-accurate Distributed Interactive Simulation (DIS) encode/decode library in TypeScript",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/its-c10/dis-codec.git"
+  },
+  "homepage": "https://github.com/its-c10/dis-codec#readme",
+  "bugs": {
+    "url": "https://github.com/its-c10/dis-codec/issues"
+  },
   "scripts": {
     "build": "tsc",
     "dev": "tsc -w",