add types for decoder/encoder stats

medooze · Aug 7, 2024 · 6a7832e · 6a7832e
1 parent eb5c545
commit 6a7832e
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -1,8 +1,9 @@
 export * from "./build/types/VideoCodecs";
 
 export type VideoDecoder = import("./build/types/VideoDecoder");
+export type { VideoDecoderStats } from "./build/types/VideoDecoder";
 export type VideoEncoder = import("./build/types/VideoEncoder");
-export type { CodecParams } from "./build/types/VideoEncoder";
+export type { VideoEncoderStats, CodecParams } from "./build/types/VideoEncoder";
 export type VideoEncoderIncomingStreamTrack = import("./build/types/VideoEncoderIncomingStreamTrack");
 
 export type {

diff --git a/lib/VideoCodecs.js b/lib/VideoCodecs.js
@@ -15,6 +15,12 @@ LFSR.prototype._defaultSeed = function(/** @type {number} */ n) {
 
 /** @typedef {import("./Properties").Properties} Properties */
 
+/**
+ * @typedef {Object} TimeStats
+ * @property {number} max
+ * @property {number} avg
+ */
+
 /** @namespace */
 const VideoCodecs = {};
 

diff --git a/lib/VideoDecoder.js b/lib/VideoDecoder.js
@@ -2,6 +2,18 @@ const Native		= require("./Native");
 const SharedPointer	= require("./SharedPointer");
 const Emitter		= require("medooze-event-emitter");
 
+/** @typedef {import("./VideoCodecs").TimeStats} TimeStats */
+
+/**
+ * @typedef {Object} VideoDecoderStats
+ * @property {Date} timestamp
+ * @property {number} totalDecodedFrames
+ * @property {number} fps
+ * @property {TimeStats} decodingTime
+ * @property {TimeStats} waitingFrameTime
+ * @property {TimeStats} deinterlacingTime
+ */
+
 /**
  * @typedef {Object} VideoDecoderEvents
  * @property {(self: VideoDecoder) => void} stopped
@@ -33,6 +45,9 @@ class VideoDecoder extends Emitter
 		};
 	}
 
+	/**
+	 * @returns {VideoDecoderStats | null}
+	 */
 	getStats()
 	{
 		//Get stats from 

diff --git a/lib/VideoEncoder.js b/lib/VideoEncoder.js
@@ -10,6 +10,18 @@ const parseInt = /** @type {(x: number) => number} */ (global.parseInt);
 //@ts-expect-error
 const parseFloat = /** @type {(x: number) => number} */ (global.parseFloat);
 
+/** @typedef {import("./VideoCodecs").TimeStats} TimeStats */
+
+/**
+ * @typedef {Object} VideoEncoderStats
+ * @property {Date} timestamp
+ * @property {number} totalEncodedFrames
+ * @property {number} fps
+ * @property {number} bitrate
+ * @property {TimeStats} encodingTime
+ * @property {TimeStats} capturingTime
+ */
+
 /**
  * @typedef {Object} CodecParams
  * @property {number} [width] (integer)
@@ -84,6 +96,9 @@ class VideoEncoder extends Emitter
 		this.pipe.SetMaxDelay(delayms);
 	}
 
+	/**
+	 * @returns {VideoEncoderStats | null}
+	 */
 	getStats()
 	{
 		//Get stats from