Pixotope Store - API

./Store.exe --mode server --ip 192.168.0.1

export type DXType = "11" | "12";
export type IOType = "Input" | "Output";
export type InputType = "AJA" | "File" | "BMD" | "NDI";
export type KeyerModel = "ProjectionKeyer" | "MahalKeyer";
export type CompositingColorSpaceType = "Video" | "Linear";
export type UnitsType = "CM" | "Inches";
export type FormatType = "rgb8" | "yuv10" | "rgb10";

export interface ChromaKeyShaderParams {
  BackgroundPicks: [[number, number, number]];
  // eslint-disable-next-line no-inline-comments
  EnableCleanPlate: boolean;
  ForegroundThreshold: number;
  BackgroundThreshold: number;
  SaturationThreshold: number;
  ShadowStrength: number;
  ShadowContrast: number;
  EdgeLumaCorrection: number;
  DespillStrength: number;
  DespillCutoff: number;
  DespillHue: number;
  MaskGamma: number;
  MaskGain: number;
  LumaKeyIntensity: number;
  ErodeSize: number;
  BlurStrength: number;
  BlurSize: number;
  ColorKeyIntensityR: number;
  ColorKeyIntensityG: number;
  ColorKeyIntensityB: number;
  DetailEnhancement: number;
  Denoise: number;
}

export interface CameraSpecific {
  FilmbackWidth: number;
  FilmbackHeight: number;
  Aperture: number;
  EnableDOF: boolean;
  DistortionModel: string;
  EnableFilmback: boolean;
}
export interface InputConfig {
  ID: string; // null when camera
  TrackingProtocol: string;
  CameraSpecific: null | CameraSpecific; // null only when object
  Source: {
    Type: string;
    Value: {
      IP: string;
      Port: number;
    };
  };
  LengthUnits: string;
  AngleUnits: string;
  AxisPositives: {
    X: string;
    Y: string;
    Z: string;
  };
  RotationPositives: {
    Pan: string;
    Tilt: string;
    Roll: string;
  };
}

export interface Vector {
  X: number;
  Y: number;
  Z: number;
}

export const zeroVector = {
  X: 0,
  Y: 0,
  Z: 0,
};
export interface EulerAngles {
  Pan: number;
  Tilt: number;
  Roll: number;
}

export const zeroEulerAngles = {
  Pan: 0,
  Tilt: 0,
  Roll: 0,
};

export interface LensFileConfig {
  UseLensFile: boolean;
  LensFilePath: string;
  ZoomEncoderOut: number;
  ZoomEncoderIn: number;
  FocusEncoderNear: number;
  FocusEncoderFar: number;
  EnableDOF: boolean;
  EnableDistortion: boolean;
  EnableNodal: boolean;
  EnableFOV: boolean;
  EnableCenterOffset: boolean;
}
export interface LensOffsets {
  FieldOfView: number;
  FocusDistance: number;
  Aperture: number;
  CX: number;
  CY: number;
  NodalX: number;
  ShowCrosshair: boolean;
  K1: number;
  K2: number;
}
export interface ChainOutput {
  Name: string; // Can we omit this??
  IP: string;
  Port: number;
  TrackingProtocol: string;
}

export interface NoMountOffset {
  Type: "No mount setup";
  Value: {
    GlobalPosition: Vector;
    GlobalRotation: Vector;
    CameraRotation: EulerAngles;
  };
}

export interface ObjectOffsets {
  Type: "Object offsets";
  Value: {
    GlobalPosition: Vector;
    GlobalRotation: Vector;
  };
}

export interface TripodOffsets {
  Type: "Tripod/Dolly/Crane";
  Value: {
    GlobalPosition: Vector;
    GlobalRotation: Vector;
    CameraRotation: EulerAngles;
    MountedPosition: Vector;
    Height: number;
  };
}

export interface CraneOffsets {
  Type: "Mechanical camera crane";
  Value: {
    GlobalPosition: Vector;
    GlobalRotation: Vector;
    CameraRotation: EulerAngles;
    MountedPosition: Vector;
    Height: number;
    MainArmLength: number;
    ExtenderLength: number;
    DropLength: number;
    SwingOffset: number;
    ElevateOffset: number;
    InvertSwing: boolean;
    InvertElevate: boolean;
  };
}

export interface TimecodeSelection {
  1: string;
  2: string;
  3: string;
  4: string;
}

export const defaultTimeCodeSelection = {
  1: "Disabled",
  2: "Disabled",
  3: "Disabled",
  4: "Disabled",
};
type FrameMatchingType = "BufferSize" | "Timecode";
export interface Chain {
  Name: string;
  Ancillary:
    | {
        Fingerprint: string;
        Delay: number;
        VideoInputDelay: number;
        VideoOutputDelay: number;
        CameraType: string | null;
        AssignedCTS: string;
        Timecode: TimecodeSelection;
        FrameMatchingMethod: FrameMatchingType;
      }
    | { AssignedGroup: string; Delay: number };
  Input: InputConfig;
  PositionOffsets: NoMountOffset | ObjectOffsets | TripodOffsets | CraneOffsets;
  LensOffsets: null | LensOffsets;
  LensFileConfig: null | LensFileConfig;
  Outputs: { [key: string]: ChainOutput };
}

export interface Camera extends Chain {
  Ancillary: {
    Fingerprint: string;
    Delay: number;
    VideoInputDelay: number;
    VideoOutputDelay: number;
    CameraType: string;
    AssignedCTS: string;
    Timecode: TimecodeSelection;
    FrameMatchingMethod: FrameMatchingType;
  };
}
export interface ObjectTrackerGroup extends Chain {
  Ancillary: {
    Fingerprint: string;
    Delay: number;
    VideoInputDelay: number;
    VideoOutputDelay: number;
    CameraType: null;
    AssignedCTS: string;
    Timecode: TimecodeSelection;
    FrameMatchingMethod: FrameMatchingType;
  };
  LensOffsets: null;
  LensFileConfig: null;
}

export interface ObjectTracker extends Chain {
  Ancillary: {
    AssignedGroup: string;
    Delay: number;
  };
  LensOffsets: null;
  LensFileConfig: null;
}
export interface AudioSelection {
  Enabled: boolean;
  Delay: number;
}
export interface VideoIO {
  Fingerprint: string;
  IOType: IOType;
  Name: string;
  // eslint-disable-next-line no-inline-comments
  Camera: string; // cameraID or undefined if media input
  VideoFormat: string;
  ColorProfile: string;
  ColorSpace: string;
  Rgbrange: boolean;
  Format: FormatType;
  InputType: InputType;
  Type: string;
  BufferSize: number;
  Parent: string;
  Audio: AudioSelection;
  Chromakey: {
    Enabled: boolean;
    OutputKey: boolean;
    KeyerModel: KeyerModel;
    ShaderParams: null | ChromaKeyShaderParams;
  };
}

export interface State {
  State: {
    General: {
      DXMode: DXType;
      EditorStartupOptions: string;
      CompositingColorSpace: CompositingColorSpaceType;
    };
    Defaults: {
      Units: UnitsType;
      VideoInputFormat: string;
      VideoOutputFormat: string;
      Type: InputType;
      ColorProfile: string;
      ColorSpace: string;
    };
    Cameras: Record<string, Camera>;
    ObjectTrackerGroups: Record<string, ObjectTrackerGroup>;
    ObjectTrackers: Record<string, ObjectTracker>;
    VideoIO: Record<string, VideoIO>;
    Projects: string[];
    Version: string;
  };
}