camstreamerlib 1.8.0 → 1.8.2

package/CamOverlayAPI.d.ts

@@ -10,7 +10,7 @@ export declare type CamOverlayOptions = {
     auth?: string;
     serviceName?: string;
     serviceID?: number;
-    camera?: number;
+    camera?: number | number[];
 };
 export declare type Field = {
     field_name: string;
@@ -44,11 +44,15 @@ export declare type Service = {
     schedule: string;
     name: string;
     identifier: string;
-    camera: number;
+    cameraList: number[];
 };
 export declare type ServiceList = {
     services: Service[];
 };
+export declare enum ImageType {
+    PNG = 0,
+    JPEG = 1
+}
 export declare class CamOverlayAPI extends EventEmitter {
     private tls;
     private tlsInsecure;
@@ -57,7 +61,7 @@ export declare class CamOverlayAPI extends EventEmitter {
     private auth;
     private serviceName;
     private serviceID;
-    private camera;
+    private cameraList;
     private callId;
     private sendMessages;
     private ws;
@@ -73,17 +77,20 @@ export declare class CamOverlayAPI extends EventEmitter {
     showCairoImage(cairoImage: string, posX: number, posY: number): Promise<CairoResponse>;
     showCairoImageAbsolute(cairoImage: string, posX: number, posY: number, width: number, height: number): Promise<CairoResponse>;
     removeImage(): Promise<CairoResponse>;
-    sendMessage(msgJson: Message): Promise<CairoResponse | CairoCreateResponse | UploadImageResponse>;
-    reportMsg(msg: string): void;
-    reportErr(err: Error): void;
-    reportClose(): void;
+    private sendMessage;
+    private sendBinaryMessage;
+    private reportMsg;
+    private reportErr;
+    private reportClose;
     updateCGText(fields: Field[]): Promise<void>;
     private formCoordinates;
     updateCGImage(path: string, coordinates?: string, x?: number, y?: number): Promise<void>;
+    updateCGImageFromData(imageType: ImageType, imageData: Buffer, coordinates?: string, x?: number, y?: number): Promise<void>;
     updateCGImagePos(coordinates?: string, x?: number, y?: number): Promise<void>;
-    promiseCGUpdate(action: string, params: string): Promise<void>;
+    promiseCGUpdate(action: string, params: string, contentType?: string, data?: Buffer): Promise<void>;
     updateInfoticker(text: string): Promise<void>;
     setEnabled(enabled: boolean): Promise<void>;
     isEnabled(): Promise<boolean>;
     private getBaseVapixConnectionParams;
+    private compareCameraList;
 }

package/CamOverlayAPI.js

@@ -9,14 +9,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CamOverlayAPI = void 0;
+exports.CamOverlayAPI = exports.ImageType = void 0;
 const WebSocket = require("ws");
 const EventEmitter = require("events");
 const Digest_1 = require("./Digest");
 const HTTPRequest_1 = require("./HTTPRequest");
+var ImageType;
+(function (ImageType) {
+    ImageType[ImageType["PNG"] = 0] = "PNG";
+    ImageType[ImageType["JPEG"] = 1] = "JPEG";
+})(ImageType = exports.ImageType || (exports.ImageType = {}));
 class CamOverlayAPI extends EventEmitter {
     constructor(options) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+        var _a, _b, _c, _d, _e, _f, _g;
         super();
         this.ws = null;
         this.tls = (_a = options === null || options === void 0 ? void 0 : options.tls) !== null && _a !== void 0 ? _a : false;
@@ -25,11 +30,17 @@ class CamOverlayAPI extends EventEmitter {
         }
         this.tlsInsecure = (_b = options === null || options === void 0 ? void 0 : options.tlsInsecure) !== null && _b !== void 0 ? _b : false;
         this.ip = (_c = options === null || options === void 0 ? void 0 : options.ip) !== null && _c !== void 0 ? _c : '127.0.0.1';
-        this.port = ((_d = options === null || options === void 0 ? void 0 : options.port) !== null && _d !== void 0 ? _d : this.tls) ? 443 : 80;
+        this.port = (_d = options === null || options === void 0 ? void 0 : options.port) !== null && _d !== void 0 ? _d : (this.tls ? 443 : 80);
         this.auth = (_e = options === null || options === void 0 ? void 0 : options.auth) !== null && _e !== void 0 ? _e : '';
         this.serviceName = (_f = options === null || options === void 0 ? void 0 : options.serviceName) !== null && _f !== void 0 ? _f : '';
         this.serviceID = (_g = options === null || options === void 0 ? void 0 : options.serviceID) !== null && _g !== void 0 ? _g : -1;
-        this.camera = (_h = options === null || options === void 0 ? void 0 : options.camera) !== null && _h !== void 0 ? _h : 0;
+        this.cameraList = [0];
+        if (Array.isArray(options === null || options === void 0 ? void 0 : options.camera)) {
+            this.cameraList = options.camera;
+        }
+        else if (typeof (options === null || options === void 0 ? void 0 : options.camera) === 'number') {
+            this.cameraList = [options.camera];
+        }
         this.callId = 0;
         this.sendMessages = {};
         EventEmitter.call(this);
@@ -37,7 +48,7 @@ class CamOverlayAPI extends EventEmitter {
     connect() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                if (this.serviceID == -1) {
+                if (this.serviceID === -1) {
                     this.serviceID = yield this.createService();
                 }
                 yield this.openWebsocket();
@@ -70,14 +81,14 @@ class CamOverlayAPI extends EventEmitter {
                 if (s.id > maxID) {
                     maxID = s.id;
                 }
-                if (s.identifier == this.serviceName && s.name == 'scripter') {
+                if (s.identifier === this.serviceName && s.name === 'scripter') {
                     service = s;
                     break;
                 }
             }
-            if (service != null) {
-                if (service.camera == undefined || service.camera != this.camera) {
-                    service.camera = this.camera;
+            if (service !== null) {
+                if (service.cameraList === undefined || !this.compareCameraList(service.cameraList)) {
+                    service.cameraList = this.cameraList;
                     yield this.updateServices(servicesJson);
                     return service.id;
                 }
@@ -93,7 +104,7 @@ class CamOverlayAPI extends EventEmitter {
                     schedule: '',
                     name: 'scripter',
                     identifier: this.serviceName,
-                    camera: this.camera,
+                    cameraList: this.cameraList,
                 };
                 servicesJson.services.push(service);
                 yield this.updateServices(servicesJson);
@@ -119,10 +130,11 @@ class CamOverlayAPI extends EventEmitter {
                 rejectUnauthorized: !this.tlsInsecure,
                 headers: {},
             };
-            if (digestHeader != undefined) {
+            if (digestHeader !== undefined) {
                 options.headers['Authorization'] = Digest_1.Digest.getAuthHeader(userPass[0], userPass[1], 'GET', '/local/camoverlay/ws', digestHeader);
             }
             this.ws = new WebSocket(addr, 'cairo-api', options);
+            this.ws.binaryType = 'arraybuffer';
             this.ws.on('open', () => {
                 this.reportMsg('Websocket opened');
                 resolve();
@@ -142,7 +154,7 @@ class CamOverlayAPI extends EventEmitter {
                 }
             });
             this.ws.on('unexpected-response', (req, res) => __awaiter(this, void 0, void 0, function* () {
-                if (res.statusCode == 401 && res.headers['www-authenticate'] != undefined)
+                if (res.statusCode === 401 && res.headers['www-authenticate'] !== undefined)
                     this.openWebsocket(res.headers['www-authenticate']).then(resolve, reject);
                 else {
                     reject('Error: status code: ' + res.statusCode + ', ' + res.data);
@@ -165,16 +177,16 @@ class CamOverlayAPI extends EventEmitter {
         return this.sendMessage({ command: 'write_text', params: params });
     }
     uploadImageData(imgBuffer) {
-        return this.sendMessage({
+        return this.sendBinaryMessage({
             command: 'upload_image_data',
-            params: [imgBuffer.toString('base64')],
-        });
+            params: [],
+        }, imgBuffer);
     }
     uploadFontData(fontBuffer) {
-        return this.sendMessage({
+        return this.sendBinaryMessage({
             command: 'upload_font_data',
             params: [fontBuffer.toString('base64')],
-        });
+        }, fontBuffer);
     }
     showCairoImage(cairoImage, posX, posY) {
         return this.sendMessage({
@@ -203,6 +215,24 @@ class CamOverlayAPI extends EventEmitter {
             }
         });
     }
+    sendBinaryMessage(msgJson, data) {
+        return new Promise((resolve, reject) => {
+            try {
+                this.sendMessages[this.callId] = { resolve, reject };
+                msgJson['call_id'] = this.callId++;
+                const jsonBuffer = Buffer.from(JSON.stringify(msgJson));
+                const header = new ArrayBuffer(5);
+                const headerView = new DataView(header);
+                headerView.setInt8(0, 1);
+                headerView.setInt32(1, jsonBuffer.byteLength);
+                const msgBuffer = Buffer.concat([Buffer.from(header), jsonBuffer, data]);
+                this.ws.send(msgBuffer);
+            }
+            catch (err) {
+                this.reportErr(new Error(`Send binary message error: ${err}`));
+            }
+        });
+    }
     reportMsg(msg) {
         this.emit('msg', msg);
     }
@@ -213,6 +243,10 @@ class CamOverlayAPI extends EventEmitter {
         this.emit('close');
     }
     reportClose() {
+        for (const callId in this.sendMessages) {
+            this.sendMessages[callId].reject(new Error('Connection lost'));
+        }
+        this.sendMessages = {};
         this.emit('close');
     }
     updateCGText(fields) {
@@ -220,30 +254,38 @@ class CamOverlayAPI extends EventEmitter {
         for (let field of fields) {
             const name = field.field_name;
             field_specs += `&${name}=${field.text}`;
-            if (field.color != undefined) {
+            if (field.color !== undefined) {
                 field_specs += `&${name}_color=${field.color}`;
             }
         }
         return this.promiseCGUpdate('update_text', field_specs);
     }
     formCoordinates(coordinates, x, y) {
-        return coordinates != '' ? `&coord_system=${coordinates}&pos_x=${x}&pos_y=${y}` : '';
+        return coordinates !== '' ? `&coord_system=${coordinates}&pos_x=${x}&pos_y=${y}` : '';
     }
     updateCGImage(path, coordinates = '', x = 0, y = 0) {
         const coord = this.formCoordinates(coordinates, x, y);
         const update = `&image=${path}`;
         return this.promiseCGUpdate('update_image', update + coord);
     }
+    updateCGImageFromData(imageType, imageData, coordinates = '', x = 0, y = 0) {
+        const coord = this.formCoordinates(coordinates, x, y);
+        const contentType = imageType === ImageType.PNG ? 'image/png' : 'image/jpeg';
+        return this.promiseCGUpdate('update_image', coord, contentType, imageData);
+    }
     updateCGImagePos(coordinates = '', x = 0, y = 0) {
         const coord = this.formCoordinates(coordinates, x, y);
         return this.promiseCGUpdate('update_image', coord);
     }
-    promiseCGUpdate(action, params) {
+    promiseCGUpdate(action, params, contentType, data) {
         return __awaiter(this, void 0, void 0, function* () {
             const options = this.getBaseVapixConnectionParams();
             options.method = 'POST';
             options.path = encodeURI(`/local/camoverlay/api/customGraphics.cgi?action=${action}&service_id=${this.serviceID}${params}`);
-            yield (0, HTTPRequest_1.httpRequest)(options, '');
+            if (contentType && data) {
+                options.headers = { 'Content-Type': contentType };
+            }
+            yield (0, HTTPRequest_1.httpRequest)(options, data);
         });
     }
     updateInfoticker(text) {
@@ -251,7 +293,7 @@ class CamOverlayAPI extends EventEmitter {
             const options = this.getBaseVapixConnectionParams();
             options.method = 'GET';
             options.path = `/local/camoverlay/api/infoticker.cgi?service_id=${this.serviceID}&text=${text}`;
-            yield (0, HTTPRequest_1.httpRequest)(options, '');
+            yield (0, HTTPRequest_1.httpRequest)(options);
         });
     }
     setEnabled(enabled) {
@@ -259,7 +301,7 @@ class CamOverlayAPI extends EventEmitter {
             const options = this.getBaseVapixConnectionParams();
             options.method = 'POST';
             options.path = encodeURI(`/local/camoverlay/api/enabled.cgi?id_${this.serviceID}=${enabled ? 1 : 0}`);
-            yield (0, HTTPRequest_1.httpRequest)(options, '');
+            yield (0, HTTPRequest_1.httpRequest)(options);
         });
     }
     isEnabled() {
@@ -267,11 +309,11 @@ class CamOverlayAPI extends EventEmitter {
             const options = this.getBaseVapixConnectionParams();
             options.method = 'GET';
             options.path = '/local/camoverlay/api/services.cgi?action=get';
-            const response = (yield (0, HTTPRequest_1.httpRequest)(options, ''));
+            const response = (yield (0, HTTPRequest_1.httpRequest)(options));
             const data = JSON.parse(response);
             for (let service of data.services) {
-                if (service.id == this.serviceID) {
-                    return service.enabled == 1;
+                if (service.id === this.serviceID) {
+                    return service.enabled === 1;
                 }
             }
             throw new Error('Service not found.');
@@ -286,5 +328,9 @@ class CamOverlayAPI extends EventEmitter {
             rejectUnauthorized: !this.tlsInsecure,
         };
     }
+    compareCameraList(cameraList) {
+        return (this.cameraList.length === cameraList.length &&
+            this.cameraList.every((element, index) => element === cameraList[index]));
+    }
 }
 exports.CamOverlayAPI = CamOverlayAPI;

package/HTTPRequest.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import * as http from 'http';
 export declare type HttpRequestOptions = {
     method?: string;
@@ -13,4 +14,4 @@ export declare type HttpRequestOptions = {
     };
     rejectUnauthorized?: boolean;
 };
-export declare function httpRequest(options: HttpRequestOptions, postData?: string, noWaitForData?: boolean): Promise<string | http.IncomingMessage>;
+export declare function httpRequest(options: HttpRequestOptions, postData?: Buffer | string, noWaitForData?: boolean): Promise<string | http.IncomingMessage>;

package/README.md

@@ -197,7 +197,7 @@ Module for easy control of CamOverlay drawing API. For more details on supported
 
 ### methods
 #### CameraVapix(options)
-Options parameter contains access to the camera, service name, service ID and camera. If service ID is not specified, service is automatically created/selected based on serviceName. Specify video channel using parameter camera (in which View Area overlay will be shown). If omitted the default value camera=0 is used.
+Options parameter contains access to the camera, service name, service ID and camera. If service ID is not specified, service is automatically created/selected based on serviceName. Specify video channel using parameter camera (in which View Area overlay will be shown). If you need to specify multiple video channels, you can use an array: `camera=[0,1]`. If omitted the default value `camera=0` is used.
 ```javascript
 options = {
   'ip': '127.0.0.1',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "camstreamerlib",
-  "version": "1.8.0",
+  "version": "1.8.2",
   "description": "Helper library for CamStreamer ACAP applications.",
   "prettier": "@camstreamer/prettier-config",
   "dependencies": {