refactor: rename target_latency to target_latency_secs

bastidest · bastidest · commit 1b2bc7b1adcf · 2022-07-10T22:00:56.000+02:00
BREAKING CHANGES: renamed target_latency to target_latency_secs in
configuration file
diff --git a/README.md b/README.md
@@ -82,7 +82,7 @@ A complete description of the JSON schema can be found in `src/server/ConfigPars
 - type: `string`
 - required: `true`
 
-**`.sources[].target_latency`**
+**`.sources[].target_latency_secs`**
 - description: Total end to end latency that the browser tries to maintain. If set too low the browser buffers often. Can be changed temporarily in the fronted.
 - type: `number`
 - required: `false`
diff --git a/config.json b/config.json
@@ -3,56 +3,56 @@
   "sources": [
     {
       "id": "traffic",
-      "target_latency": 10,
+      "target_latency_secs": 10,
       "rtsp": {
         "url": "rtsp://211.132.61.124:554/axis-media/media.amp?videocodec=h264&resolution=1280x720&videoformat-hdtv"
       }
     },
     {
       "id": "norway",
-      "target_latency": 10,
+      "target_latency_secs": 10,
       "rtsp": {
         "url": "rtsp://77.110.246.1:554/axis-media/media.amp?videocodec=h264&resolution=1280x720&videoformat-hdtv"
       }
     },
     {
       "id": "tree",
-      "target_latency": 10,
+      "target_latency_secs": 10,
       "rtsp": {
         "url": "rtsp://50.194.64.66:554/axis-media/media.amp?videocodec=h264&resolution=1280x720&videoformat-hdtv"
       }
     },
     {
       "id": "norway2",
-      "target_latency": 10,
+      "target_latency_secs": 10,
       "rtsp": {
         "url": "rtsp://79.161.235.219:554/axis-media/media.amp?videocodec=h264&camera=1&resolution=1920x1080&videoformat-hdtv"
       }
     },
     {
       "id": "us-traffic",
-      "target_latency": 10,
+      "target_latency_secs": 10,
       "rtsp": {
         "url": "rtsp://96.91.10.218:554/axis-media/media.amp?videocodec=h264&camera=1&resolution=1920x1080&videoformat-hdtv"
       }
     },
     {
       "id": "us-traffic2",
-      "target_latency": 10,
+      "target_latency_secs": 10,
       "rtsp": {
         "url": "rtsp://96.91.10.219:554/axis-media/media.amp?videocodec=h264&camera=1&resolution=1920x1080&videoformat-hdtv"
       }
     },
     {
       "id": "test",
-      "target_latency": 10,
+      "target_latency_secs": 10,
       "rtsp": {
         "url": "rtsp://demo:demo@ipvmdemo.dyndns.org:5541/onvif-media/media.amp?profile=profile_1_h264&sessiontimeout=60&streamtype=unicast"
       }
     },
     {
       "id": "church",
-      "target_latency": 20,
+      "target_latency_secs": 20,
       "rtsp": {
         "url": "rtsp://217.41.42.231:8554/axis-media/media.amp?videocodec=h264&resolution=1280x720&videoformat-hdtv"
       }
diff --git a/ffmpeg-wrapper.sh b/ffmpeg-wrapper.sh
@@ -3,14 +3,14 @@ set -eo pipefail
 
 FFMPEG="ffmpeg"
 MKDIR=0
-TARGET_LATENCY=4
+TARGET_LATENCY_SECS=4
 CLEAN_ON_EXIT=0
 
 function print_usage() {
-    echo "usage: ffmpeg-wrapper.sh [--use-docker] [--mkdir] [--target-latency seconds] [--clean-on-exit] RTSP_URL OUTPUT_PATH"
+    echo "usage: ffmpeg-wrapper.sh [--use-docker] [--mkdir] [--target-latency-secs seconds] [--clean-on-exit] RTSP_URL OUTPUT_PATH"
 }
 
-TEMP=$(getopt -o '' --long 'use-docker,mkdir,target-latency:,clean-on-exit' -n 'ffmpeg-wrapper.sh' -- "$@")
+TEMP=$(getopt -o '' --long 'use-docker,mkdir,target-latency-secs:,clean-on-exit' -n 'ffmpeg-wrapper.sh' -- "$@")
 if [[ $? -ne 0 ]] ; then
     echo "failed to parse command line arguments" >&2
     exit 1
@@ -30,11 +30,11 @@ while true; do
             shift
             continue
             ;;
-        '--target-latency')
-            TARGET_LATENCY="$2"
+        '--target-latency-secs')
+            TARGET_LATENCY_SECS="$2"
             shift 2
 
-            if [[ "$TARGET_LATENCY" -lt 3 || "$TARGET_LATENCY" -gt 3600 ]] ; then
+            if [[ "$TARGET_LATENCY_SECS" -lt 3 || "$TARGET_LATENCY_SECS" -gt 3600 ]] ; then
                 echo 'target latency should be in the range [3,3600]' >&2
                 exit 1
             fi
@@ -133,7 +133,7 @@ function stream() {
             -window_size 60 \
             -frag_type none \
             -tune zerolatency \
-            -target_latency "${TARGET_LATENCY}" \
+            -target_latency "${TARGET_LATENCY_SECS}" \
             -format_options "movflags=cmaf" \
             -export_side_data prft -write_prft 1 \
             "${OUTPUT_PATH}/manifest.mpd" &
diff --git a/src/server/ConfigParser.ts b/src/server/ConfigParser.ts
@@ -18,7 +18,7 @@ export interface IRtspSource {
 
 export interface IStreamSource {
   id: string;
-  target_latency?: number;
+  target_latency_secs?: number;
   onvif?: IOnvifSource;
   rtsp?: IRtspSource;
 }
@@ -90,7 +90,7 @@ const StreamSourceSchema: JSONSchemaType<IStreamSource> = {
       type: "object",
       $ref: "./RtspSource.json",
     },
-    target_latency: {
+    target_latency_secs: {
       type: "number",
       nullable: true,
     },
diff --git a/src/server/FfmpegStreamer.ts b/src/server/FfmpegStreamer.ts
@@ -34,9 +34,9 @@ export class FfmpegStreamer {
 
     const args = ["--mkdir", "--clean-on-exit"];
 
-    if (this._camera.config.target_latency) {
+    if (this._camera.config.target_latency_secs) {
       args.push("--target-latency");
-      args.push(`${this._camera.config.target_latency}`);
+      args.push(`${this._camera.config.target_latency_secs}`);
     }
 
     const streamUrl = this._camera.streamUrl;
diff --git a/src/server/index.ts b/src/server/index.ts
@@ -107,7 +107,7 @@ function getStateForClient(streamers: FfmpegStreamer[]): IStateForClient {
   const sources = () =>
     streamers.map((s) => ({
       id: s.camera.id,
-      latency: s.camera.config.target_latency,
+      latency: s.camera.config.target_latency_secs,
     }));
 
   app.get("/", (req, res) => {
@@ -146,22 +146,22 @@ function getStateForClient(streamers: FfmpegStreamer[]): IStateForClient {
           const stateJson: string = JSON.stringify(state);
           socket.send(Buffer.from(stateJson, "utf8"));
           break;
-        case "target_latency": {
+        case "target_latency_secs": {
           const streamer: FfmpegStreamer | undefined = streamers.find(
             (s) => s.camera.id === msg.stream_id
           );
           if (streamer) {
-            streamer.camera.config.target_latency = msg.value;
+            streamer.camera.config.target_latency_secs = msg.value;
             console.log(
-              `set ${streamer.camera.id} latency = ${streamer.camera.config.target_latency}`
+              `set ${streamer.camera.id} latency = ${streamer.camera.config.target_latency_secs}`
             );
 
             wss.clients.forEach((client) => {
               if (client === socket) return;
               const msg = {
-                type: "target_latency",
+                type: "target_latency_secs",
                 id: streamer.camera.id,
-                value: streamer.camera.config.target_latency,
+                value: streamer.camera.config.target_latency_secs,
               };
               client.send(Buffer.from(JSON.stringify(msg), "utf8"));
             });
diff --git a/src/server/static/StreamSource.js b/src/server/static/StreamSource.js
@@ -147,7 +147,7 @@ export class StreamSource {
       this.appendLog(eventObject.entry.content);
       return;
     }
-    if (eventObject.type === "target_latency") {
+    if (eventObject.type === "target_latency_secs") {
       this.onTargetLatencyUpdate(eventObject.value);
     }
   }
@@ -170,7 +170,7 @@ export class StreamSource {
     // only local target latency change for now
     // this.socket.send(
     //   JSON.stringify({
-    //     type: "target_latency",
+    //     type: "target_latency_secs",
     //     stream_id: this.streamId,
     //     value: newLatency,
     //   })

Original file line number	Diff line number	Diff line change
`@@ -3,56 +3,56 @@`
`3`	`3`	`"sources": [`
`4`	`4`	`{`
`5`	`5`	`"id": "traffic",`
`6`		`- "target_latency": 10,`
	`6`	`+ "target_latency_secs": 10,`
`7`	`7`	`"rtsp": {`
`8`	`8`	`"url": "rtsp://211.132.61.124:554/axis-media/media.amp?videocodec=h264&resolution=1280x720&videoformat-hdtv"`
`9`	`9`	`}`
`10`	`10`	`},`
`11`	`11`	`{`
`12`	`12`	`"id": "norway",`
`13`		`- "target_latency": 10,`
	`13`	`+ "target_latency_secs": 10,`
`14`	`14`	`"rtsp": {`
`15`	`15`	`"url": "rtsp://77.110.246.1:554/axis-media/media.amp?videocodec=h264&resolution=1280x720&videoformat-hdtv"`
`16`	`16`	`}`
`17`	`17`	`},`
`18`	`18`	`{`
`19`	`19`	`"id": "tree",`
`20`		`- "target_latency": 10,`
	`20`	`+ "target_latency_secs": 10,`
`21`	`21`	`"rtsp": {`
`22`	`22`	`"url": "rtsp://50.194.64.66:554/axis-media/media.amp?videocodec=h264&resolution=1280x720&videoformat-hdtv"`
`23`	`23`	`}`
`24`	`24`	`},`
`25`	`25`	`{`
`26`	`26`	`"id": "norway2",`
`27`		`- "target_latency": 10,`
	`27`	`+ "target_latency_secs": 10,`
`28`	`28`	`"rtsp": {`
`29`	`29`	`"url": "rtsp://79.161.235.219:554/axis-media/media.amp?videocodec=h264&camera=1&resolution=1920x1080&videoformat-hdtv"`
`30`	`30`	`}`
`31`	`31`	`},`
`32`	`32`	`{`
`33`	`33`	`"id": "us-traffic",`
`34`		`- "target_latency": 10,`
	`34`	`+ "target_latency_secs": 10,`
`35`	`35`	`"rtsp": {`
`36`	`36`	`"url": "rtsp://96.91.10.218:554/axis-media/media.amp?videocodec=h264&camera=1&resolution=1920x1080&videoformat-hdtv"`
`37`	`37`	`}`
`38`	`38`	`},`
`39`	`39`	`{`
`40`	`40`	`"id": "us-traffic2",`
`41`		`- "target_latency": 10,`
	`41`	`+ "target_latency_secs": 10,`
`42`	`42`	`"rtsp": {`
`43`	`43`	`"url": "rtsp://96.91.10.219:554/axis-media/media.amp?videocodec=h264&camera=1&resolution=1920x1080&videoformat-hdtv"`
`44`	`44`	`}`
`45`	`45`	`},`
`46`	`46`	`{`
`47`	`47`	`"id": "test",`
`48`		`- "target_latency": 10,`
	`48`	`+ "target_latency_secs": 10,`
`49`	`49`	`"rtsp": {`
`50`	`50`	`"url": "rtsp://demo:[email protected]:5541/onvif-media/media.amp?profile=profile_1_h264&sessiontimeout=60&streamtype=unicast"`
`51`	`51`	`}`
`52`	`52`	`},`
`53`	`53`	`{`
`54`	`54`	`"id": "church",`
`55`		`- "target_latency": 20,`
	`55`	`+ "target_latency_secs": 20,`
`56`	`56`	`"rtsp": {`
`57`	`57`	`"url": "rtsp://217.41.42.231:8554/axis-media/media.amp?videocodec=h264&resolution=1280x720&videoformat-hdtv"`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,9 +34,9 @@ export class FfmpegStreamer {`
`34`	`34`
`35`	`35`	`const args = ["--mkdir", "--clean-on-exit"];`
`36`	`36`
`37`		`- if (this._camera.config.target_latency) {`
	`37`	`+ if (this._camera.config.target_latency_secs) {`
`38`	`38`	`args.push("--target-latency");`
`39`		- args.push(`${this._camera.config.target_latency}`);
	`39`	+ args.push(`${this._camera.config.target_latency_secs}`);
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`const streamUrl = this._camera.streamUrl;`
Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ export class StreamSource {`
`147`	`147`	`this.appendLog(eventObject.entry.content);`
`148`	`148`	`return;`
`149`	`149`	`}`
`150`		`- if (eventObject.type === "target_latency") {`
	`150`	`+ if (eventObject.type === "target_latency_secs") {`
`151`	`151`	`this.onTargetLatencyUpdate(eventObject.value);`
`152`	`152`	`}`
`153`	`153`	`}`
`@@ -170,7 +170,7 @@ export class StreamSource {`
`170`	`170`	`// only local target latency change for now`
`171`	`171`	`// this.socket.send(`
`172`	`172`	`// JSON.stringify({`
`173`		`- // type: "target_latency",`
	`173`	`+ // type: "target_latency_secs",`
`174`	`174`	`// stream_id: this.streamId,`
`175`	`175`	`// value: newLatency,`
`176`	`176`	`// })`