camstreamerlib 1.9.1 → 2.0.0

package/CameraVapix.js

@@ -10,28 +10,36 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CameraVapix = void 0;
-const WebSocket = require("ws");
 const prettifyXml = require("prettify-xml");
 const xml2js_1 = require("xml2js");
 const eventemitter2_1 = require("eventemitter2");
-const Digest_1 = require("./Digest");
-const RtspClient_1 = require("./RtspClient");
-const HTTPRequest_1 = require("./HTTPRequest");
+const WsClient_1 = require("./WsClient");
+const HttpRequest_1 = require("./HttpRequest");
 class CameraVapix extends eventemitter2_1.EventEmitter2 {
     constructor(options) {
         var _a, _b, _c, _d, _e;
         super();
-        this.rtsp = null;
         this.ws = null;
         this.tls = (_a = options === null || options === void 0 ? void 0 : options.tls) !== null && _a !== void 0 ? _a : false;
-        if ((options === null || options === void 0 ? void 0 : options.tls) === undefined && (options === null || options === void 0 ? void 0 : options.protocol) !== undefined) {
-            this.tls = options.protocol === 'https';
-        }
         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.auth = (_e = options === null || options === void 0 ? void 0 : options.auth) !== null && _e !== void 0 ? _e : '';
     }
+    vapixGet(path, noWaitForData = false) {
+        const options = this.getBaseVapixConnectionParams();
+        options.path = encodeURI(path);
+        return (0, HttpRequest_1.httpRequest)(options, undefined, noWaitForData);
+    }
+    vapixPost(path, data, contentType) {
+        const options = this.getBaseVapixConnectionParams();
+        options.method = 'POST';
+        options.path = path;
+        if (contentType != null) {
+            options.headers = { 'Content-Type': contentType };
+        }
+        return (0, HttpRequest_1.httpRequest)(options, data);
+    }
     getParameterGroup(groupNames) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = (yield this.vapixGet(`/axis-cgi/param.cgi?action=list&group=${encodeURIComponent(groupNames)}`));
@@ -143,6 +151,14 @@ class CameraVapix extends eventemitter2_1.EventEmitter2 {
             });
         }));
     }
+    getCameraImage(camera, compression, resolution, outputStream) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const path = `/axis-cgi/jpg/image.cgi?resolution=${resolution}&compression=${compression}&camera=${camera}`;
+            const res = (yield this.vapixGet(path, true));
+            res.pipe(outputStream);
+            return outputStream;
+        });
+    }
     getEventDeclarations() {
         return __awaiter(this, void 0, void 0, function* () {
             const data = '<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope">' +
@@ -155,173 +171,73 @@ class CameraVapix extends eventemitter2_1.EventEmitter2 {
             return prettifyXml(declarations);
         });
     }
-    isReservedEventName(eventName) {
-        return eventName == 'eventsConnect' || eventName == 'eventsDisconnect';
-    }
-    eventsConnect(channel = 'RTSP') {
+    eventsConnect() {
         if (this.ws != null) {
             throw new Error('Websocket is already opened.');
         }
-        if (this.rtsp != null) {
-            throw new Error('RTSP is already opened.');
-        }
-        if (channel == 'RTSP') {
-            this.rtspConnect();
-        }
-        else if (channel == 'websocket') {
-            this.websocketConnect();
-        }
-        else {
-            throw new Error('Unknown channel.');
-        }
-    }
-    eventsDisconnect() {
-        if (this.rtsp != null) {
-            this.rtsp.disconnect();
-        }
-        if (this.ws != null) {
-            this.ws.close();
-        }
-    }
-    rtspConnect() {
-        this.rtsp = new RtspClient_1.RtspClient({
+        const options = {
+            tls: this.tls,
+            tlsInsecure: this.tlsInsecure,
+            auth: this.auth,
             ip: this.ip,
             port: this.port,
-            auth: this.auth,
-        });
-        this.rtsp.on('connect', () => {
-            this.emit('eventsConnect');
-        });
-        this.rtsp.on('disconnect', (err) => {
-            this.emit('eventsDisconnect', new Error(err));
-            this.rtsp = null;
-        });
-        this.rtsp.on('event', (event) => {
+            address: '/vapix/ws-data-stream?sources=events',
+        };
+        this.ws = new WsClient_1.WsClient(options);
+        this.ws.on('open', () => {
+            const topics = [];
             const eventNames = this.eventNames();
             for (let i = 0; i < eventNames.length; i++) {
                 if (!this.isReservedEventName(eventNames[i])) {
-                    let name = eventNames[i];
-                    while (name[name.length - 1] == '.' || name[name.length - 1] == '/') {
-                        name = name.substring(0, name.length - 1);
-                    }
-                    if (event.indexOf(name) != -1) {
-                        (0, xml2js_1.parseString)(event, (err, eventJson) => {
-                            if (err != null) {
-                                this.eventsDisconnect();
-                                return;
-                            }
-                            this.emit(eventNames[i], eventJson);
-                        });
-                        break;
-                    }
+                    const topic = {
+                        topicFilter: eventNames[i],
+                    };
+                    topics.push(topic);
                 }
             }
+            const topicFilter = {
+                apiVersion: '1.0',
+                method: 'events:configure',
+                params: {
+                    eventFilterList: topics,
+                },
+            };
+            this.ws.send(JSON.stringify(topicFilter));
         });
-        let eventTopicFilter = '';
-        const eventNames = this.eventNames();
-        for (let i = 0; i < eventNames.length; i++) {
-            if (!this.isReservedEventName(eventNames[i])) {
-                if (eventTopicFilter.length != 0) {
-                    eventTopicFilter += '|';
+        this.ws.on('message', (data) => {
+            const dataJSON = JSON.parse(data.toString());
+            if (dataJSON.method === 'events:configure') {
+                if (dataJSON.error === undefined) {
+                    this.emit('eventsConnect');
                 }
-                let topic = eventNames[i].replace(/tns1/g, 'onvif');
-                topic = topic.replace(/tnsaxis/g, 'axis');
-                eventTopicFilter += topic;
-            }
-        }
-        this.rtsp.connect(eventTopicFilter);
-    }
-    websocketConnect(digestHeader) {
-        var _a;
-        const protocol = this.tls ? 'wss' : 'ws';
-        const address = `${protocol}://${this.ip}:${this.port}/vapix/ws-data-stream?sources=events`;
-        const options = {
-            auth: this.auth,
-            rejectUnauthorized: !this.tlsInsecure,
-            headers: {},
-        };
-        if (digestHeader != undefined) {
-            const userPass = this.auth.split(':');
-            (_a = options['headers']) !== null && _a !== void 0 ? _a : (options['headers'] = {});
-            options['headers']['Authorization'] = Digest_1.Digest.getAuthHeader(userPass[0], userPass[1], 'GET', '/vapix/ws-data-stream?sources=events', digestHeader);
-        }
-        return new Promise((resolve, reject) => {
-            this.ws = new WebSocket(address, options);
-            this.ws.on('open', () => {
-                const topics = [];
-                const eventNames = this.eventNames();
-                for (let i = 0; i < eventNames.length; i++) {
-                    if (!this.isReservedEventName(eventNames[i])) {
-                        const topic = {
-                            topicFilter: eventNames[i],
-                        };
-                        topics.push(topic);
-                    }
-                }
-                const topicFilter = {
-                    apiVersion: '1.0',
-                    method: 'events:configure',
-                    params: {
-                        eventFilterList: topics,
-                    },
-                };
-                this.ws.send(JSON.stringify(topicFilter));
-            });
-            this.ws.on('unexpected-response', (req, res) => __awaiter(this, void 0, void 0, function* () {
-                if (res.statusCode == 401 && res.headers['www-authenticate'] != undefined)
-                    this.websocketConnect(res.headers['www-authenticate']).then(resolve, reject);
                 else {
-                    reject('Error: status code: ' + res.statusCode + ', ' + res.data);
+                    this.emit('eventsDisconnect', dataJSON.error);
+                    this.eventsDisconnect();
                 }
-            }));
-            this.ws.on('message', (data) => {
-                const dataJSON = JSON.parse(data);
-                if (dataJSON.method === 'events:configure') {
-                    if (dataJSON.error === undefined) {
-                        this.emit('eventsConnect');
-                    }
-                    else {
-                        this.emit('eventsDisconnect', dataJSON.error);
-                        this.eventsDisconnect();
-                    }
-                    return;
-                }
-                const eventName = dataJSON.params.notification.topic;
-                this.emit(eventName, dataJSON);
-            });
-            this.ws.on('error', (error) => {
-                this.emit('eventsDisconnect', error);
-                this.ws = null;
-            });
-            this.ws.on('close', () => {
-                if (this.ws !== null) {
-                    this.emit('websocketDisconnect');
-                }
-                this.ws = null;
-            });
+                return;
+            }
+            const eventName = dataJSON.params.notification.topic;
+            this.emit(eventName, dataJSON);
         });
-    }
-    vapixGet(path, noWaitForData = false) {
-        const options = this.getBaseVapixConnectionParams();
-        options.path = encodeURI(path);
-        return (0, HTTPRequest_1.httpRequest)(options, undefined, noWaitForData);
-    }
-    getCameraImage(camera, compression, resolution, outputStream) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const path = `/axis-cgi/jpg/image.cgi?resolution=${resolution}&compression=${compression}&camera=${camera}`;
-            const res = (yield this.vapixGet(path, true));
-            res.pipe(outputStream);
-            return outputStream;
+        this.ws.on('error', (error) => {
+            this.emit('eventsDisconnect', error);
+            this.ws = null;
+        });
+        this.ws.on('close', () => {
+            if (this.ws !== null) {
+                this.emit('eventsClose');
+            }
+            this.ws = null;
         });
+        this.ws.open();
     }
-    vapixPost(path, data, contentType) {
-        const options = this.getBaseVapixConnectionParams();
-        options.method = 'POST';
-        options.path = path;
-        if (contentType != null) {
-            options.headers = { 'Content-Type': contentType };
+    eventsDisconnect() {
+        if (this.ws != null) {
+            this.ws.close();
         }
-        return (0, HTTPRequest_1.httpRequest)(options, data);
+    }
+    isReservedEventName(eventName) {
+        return eventName == 'eventsConnect' || eventName == 'eventsDisconnect' || eventName == 'websocketDisconnect';
     }
     getBaseVapixConnectionParams() {
         return {

package/README.md

@@ -16,7 +16,8 @@ npm install camstreamerlib
 -   [HttpServer](doc/HttpServer.md) is a module for processing HTTP requests in your scripts. It also automatically serves up the content from html directory or you can register paths which you can process by your own (e.g. http://$CAMERA_IP/local/camscripter/proxy/$MY_PACKAGE_NAME/control.cgi).
 -   [CameraVapix](doc/CameraVapix.md) is a module to access Axis camera VAPIX interface.
 -   [CamStreamerAPI](doc/CamStreamerAPI.md) is a module for easy control of video streaming in the CamStreamer ACAP application (RTMP, HLS, SRT and MPEG-TS protocols).
--   [CamOverlayAPI](doc/CamOverlayAPI.md) is a module for easy control of CamOverlay drawing API. For more details on supported video overlay drawing functions see https://camstreamer.com/camoverlay-api1
+-   [CamOverlayAPI](doc/CamOverlayAPI.md) is a module to access CamOverlay HTTP interface.
+-   [CamOverlayDrawingAPI](doc/CamOverlayDrawingAPI.md) is a module for easy control of CamOverlay drawing API. For more details on supported video overlay drawing functions see https://camstreamer.com/camoverlay-api1
 -   [CamScripterAPICameraEventsGenerator](doc/CamScripterAPICameraEventsGenerator.md) is a module which allows generating events on an Axis camera. These events can be used for triggers in the Axis camera rule engine (events/actions). It is also an easy way how to integrate events and metadata in VMS systems which support Axis camera events.
 
 ## For Developers
@@ -54,3 +55,15 @@ If you need to exclude a file or directory add `-exlude` or `-e` parameter with
     "create-package": "node node_modules/camstreamerlib/CreatePackage.js -i -e=react"
 }
 ```
+
+### Breaking changes when moving from version 1.\*.* to 2.\*.*
+
+- Renamed file HTTPRequest.ts to HttpRequest.ts
+- Removed deprecated protocol attribute from all options objects (use tls instead).
+- Removed RTSP
+  > Previously CameraVapix.ts supported both WebSocket and RTSP.
+  > Starting with version 2.0.0, it supports WebSocket only.
+- ServiceID shouldn't be passed to CamOverlayAPI by the options object. Pass it as a parameter.
+- Renamed CamOverlayDrawingAPI event msg to message.
+- Drawing services extracted from CamOverlayAPI.ts to a separate file.
+  > Please read [CamOverlayAPI](doc/CamOverlayAPI.md) and [CamOverlayDrawingAPI](doc/CamOverlayDrawingAPI.md) for more information.

package/WsClient.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import * as EventEmitter from 'events';
+import { Options } from './common';
+export type WsClientOptions = Options & {
+    address: string;
+    headers?: object;
+    pingInterval?: number;
+    protocol?: string;
+};
+export declare class WsClient extends EventEmitter {
+    private userPass;
+    private address;
+    private protocol;
+    private pingInterval;
+    private wsOptions;
+    private digestAddress;
+    private isAlive;
+    private pingTimer;
+    private ws;
+    constructor(options?: WsClientOptions);
+    open(digestHeader?: string): void;
+    send(data: Buffer | string): void;
+    close(): void;
+    private handleCloseEvent;
+}

package/WsClient.js

@@ -0,0 +1,104 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WsClient = void 0;
+const EventEmitter = require("events");
+const WebSocket = require("ws");
+const Digest_1 = require("./Digest");
+class WsClient extends EventEmitter {
+    constructor(options) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        super();
+        this.isAlive = true;
+        this.pingTimer = null;
+        this.ws = null;
+        const tls = (_a = options === null || options === void 0 ? void 0 : options.tls) !== null && _a !== void 0 ? _a : false;
+        const tlsInsecure = (_b = options === null || options === void 0 ? void 0 : options.tlsInsecure) !== null && _b !== void 0 ? _b : false;
+        const ip = (_c = options === null || options === void 0 ? void 0 : options.ip) !== null && _c !== void 0 ? _c : '127.0.0.1';
+        const port = (_d = options === null || options === void 0 ? void 0 : options.port) !== null && _d !== void 0 ? _d : (tls ? 443 : 80);
+        const auth = (_e = options === null || options === void 0 ? void 0 : options.auth) !== null && _e !== void 0 ? _e : '';
+        const protocol = tls ? 'wss' : 'ws';
+        this.address = `${protocol}://${ip}:${port}${options.address}`;
+        this.digestAddress = options.address;
+        this.pingInterval = (_f = options.pingInterval) !== null && _f !== void 0 ? _f : 30000;
+        this.protocol = options.protocol;
+        this.userPass = auth.split(':');
+        this.wsOptions = {
+            auth: options.auth,
+            rejectUnauthorized: !tlsInsecure,
+            headers: (_g = options.headers) !== null && _g !== void 0 ? _g : {},
+        };
+    }
+    open(digestHeader) {
+        if (this.protocol == undefined) {
+            this.ws = new WebSocket(this.address, this.wsOptions);
+        }
+        else {
+            this.ws = new WebSocket(this.address, this.protocol, this.wsOptions);
+        }
+        this.ws.binaryType = 'arraybuffer';
+        this.isAlive = true;
+        this.pingTimer = setInterval(() => {
+            if (this.ws.readyState !== this.ws.OPEN || this.isAlive === false) {
+                this.emit('error', new Error('Connection timeout'));
+                this.close();
+            }
+            else {
+                this.isAlive = false;
+                this.ws.ping();
+            }
+        }, this.pingInterval);
+        this.ws.on('pong', () => {
+            this.isAlive = true;
+        });
+        if (digestHeader !== undefined) {
+            this.wsOptions.headers['Authorization'] = Digest_1.Digest.getAuthHeader(this.userPass[0], this.userPass[1], 'GET', this.digestAddress, digestHeader);
+        }
+        this.ws.on('unexpected-response', (req, res) => __awaiter(this, void 0, void 0, function* () {
+            if (res.statusCode === 401 && res.headers['www-authenticate'] !== undefined) {
+                this.open(res.headers['www-authenticate']);
+            }
+            else {
+                const e = new Error('Error: status code: ' + res.statusCode + ', ' + res.data);
+                this.emit('error', e);
+            }
+        }));
+        this.ws.on('open', () => this.emit('open'));
+        this.ws.on('message', (data) => this.emit('message', data));
+        this.ws.on('error', (error) => this.emit('error', error));
+        this.ws.on('close', () => this.emit('close'));
+    }
+    send(data) {
+        if (this.ws.readyState === this.ws.OPEN) {
+            this.ws.send(data);
+        }
+    }
+    close() {
+        try {
+            this.handleCloseEvent();
+            this.ws.close();
+        }
+        catch (err) {
+            this.emit('error', err);
+        }
+        setTimeout(() => {
+            if (this.ws.readyState == this.ws.OPEN || this.ws.readyState == this.ws.CLOSING) {
+                this.ws.terminate();
+            }
+        }, 5000);
+    }
+    handleCloseEvent() {
+        this.ws.removeAllListeners();
+        clearInterval(this.pingTimer);
+        this.emit('close');
+    }
+}
+exports.WsClient = WsClient;

package/common.d.ts

@@ -0,0 +1,7 @@
+export type Options = {
+    ip?: string;
+    port?: number;
+    auth?: string;
+    tls?: boolean;
+    tlsInsecure?: boolean;
+};

package/common.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "camstreamerlib",
-  "version": "1.9.1",
+  "version": "2.0.0",
   "description": "Helper library for CamStreamer ACAP applications.",
   "prettier": "@camstreamer/prettier-config",
   "dependencies": {
@@ -28,8 +28,8 @@
     "build": "npm-run-all clean tsc copyPackage",
     "tsc": "tsc",
     "copyPackage": "cp -f LICENSE dist/ && cp -f README.md dist/ && cp -f package.json dist/",
-    "pretty": "prettier --write \"./src/*.{ts,tsx}\"",
-    "pretty:check": "prettier --check \"./src/*.{ts,tsx}\"",
+    "pretty": "prettier --write \"./{src,doc}/*.{ts,tsx,md}\"",
+    "pretty:check": "prettier --check \"./{src,doc}/*.{ts,tsx,md}\"",
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
   },
   "files": [

package/RtspClient.d.ts

@@ -1,48 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import * as EventEmitter from 'events';
-export type RtspClientOptions = {
-    ip?: string;
-    port?: number;
-    auth?: string;
-};
-export declare class RtspClient extends EventEmitter {
-    private ip;
-    private port;
-    private auth;
-    private authorizationType;
-    private wwwAuthenticateHeader;
-    private sessioncookie;
-    private clientGet;
-    private clientPost;
-    private inputBuffer;
-    private state;
-    private rtspPath;
-    private rtspCSeq;
-    private control;
-    private session;
-    private authorizationSent;
-    private keepAliveTimer;
-    private disconnected;
-    private rtpMsgBuffer;
-    constructor(options?: RtspClientOptions);
-    connect(eventTopicFilter: string): void;
-    disconnect(): void;
-    closeConnection(reason: string): void;
-    processGetMessage(data: any): void;
-    parseRtspMessage(): {
-        statusLine: Buffer;
-        headers: {};
-        headersRaw: Buffer;
-        body: Buffer;
-    };
-    parseRtpMessage(): {
-        channel: number;
-        body: Buffer;
-    };
-    getInitializationMessageGet(): string;
-    getInitializationMessagePost(): string;
-    getRtspMessage(): string;
-    getAuthHeader(method: string, path: string): string;
-    sendRtspMessage(message: string): void;
-}