Tweaks to videoFilter handling

Author: Sunoo

CHANGELOG.md

@@ -2,20 +2,24 @@
 
 All notable changes to this project will be documented in this file.
 
-## v2.6.0 (2020-??-??)
+## v3.0.0 (2020-08-24)
 
 ### Changes
 
-- This plugin now includes experimental two-way audio support. Be aware that this feature is likely to be tweaked in the future, and a configuration that works now may need to be altered in the future.
+- This plugin now includes __experimental__ two-way audio support. Be aware that this feature is likely to be tweaked in the future, and a configuration that works now may need to be altered in the future.
 - Better detection of audio and video streams. There should be very few scenarios where `mapvideo` or `mapaudio` are needed anymore, as FFmpeg's stream auto-selection is now set up.
+- Default `videoFilter` can be disabled by including `none` in your comma-delimited list of filters.
+- Further reorganization of the config UI.
 
 ### Bug Fixes
 
-- Correct handling of inactive camera timeouts. You should no longer see timeout messages after cleanly closing a camera stream.
+- Corrected handling of inactive camera timeouts. You should no longer see timeout messages after cleanly closing a camera stream.
+- Fixed `forceMax` not applying to resolution in some scenarios.
 
 ### Breaking Changes
 
 - `additionalCommandline` has been replaced by `encoderOptions` to better reflect it's intended use.
+- `preserveRatio` has been removed and is now active as long as the default `videoFilter` list is active.
 
 ## v2.5.0 (2020-08-23)
 

README.md

@@ -91,21 +91,20 @@ Other users have been sharing configurations that work for them on our GitHub si
 
 ### Optional videoConfig Parameters
 
-- `returnAudioTarget`: _(EXPERIMENTAL)_ The FFmpeg output command for directing audio back to a two-way capable camera.
+- `returnAudioTarget`: _(EXPERIMENTAL - WIP)_ The FFmpeg output command for directing audio back to a two-way capable camera. This feature is still in development and a configuration that works today may not work in the future.
 - `maxStreams`: The maximum number of streams that will be allowed at once to this camera. (Default: `2`)
 - `maxWidth`: The maximum width used for video streamed to HomeKit. If set to 0, the resolution of the source is used. If not set, will use any size HomeKit requests.
 - `maxHeight`: The maximum height used for video streamed to HomeKit. If set to 0, the resolution of the source is used. If not set, will use any size HomeKit requests.
 - `maxFPS`: The maximum frame rate used for video streamed to HomeKit. If set to 0, the framerate of the source is used. If not set, will use any frame rate HomeKit requests.
 - `maxBitrate`: The maximum bitrate used for video streamed to HomeKit, in kbit/s. If not set, will use any bitrate HomeKit requests.
 - `forceMax`: If set, the settings requested by HomeKit will be overridden with any 'maximum' values defined in this config. (Default: `false`)
-- `preserveRatio`: Preserves the aspect ratio of the source video. (Default: `false`)
 - `vcodec`: Set the codec used for encoding video sent to HomeKit, must be H.264-based.  You can change to a hardware accelerated video codec with this option, if one is available. (Default: `libx264`)
 - `audio`: Enables audio streaming from camera. (Default: `false`)
 - `packetSize`: If audio or video is choppy try a smaller value, should be set to a multiple of 188. (Default: `1316`)
 - `mapvideo`: Selects the stream used for video. (Default: FFmpeg [automatically selects](https://ffmpeg.org/ffmpeg.html#Automatic-stream-selection) a video stream)
 - `mapaudio`: Selects the stream used for audio. (Default: FFmpeg [automatically selects](https://ffmpeg.org/ffmpeg.html#Automatic-stream-selection) an audio stream)
-- `videoFilter`: Allows additional video filter options to be passed to FFmpeg. If set to 'none', all video filters are disabled.
-- `encoderParameters`: Options to be passed to the video encoder. (Default: `-preset ultrafast -tune zerolatency` if using libx264)
+- `videoFilter`: Comma-delimited list of additional video filters for FFmpeg to run on the video. If 'none' is included, the default video filters are disabled.
+- `encoderOptions`: Options to be passed to the video encoder. (Default: `-preset ultrafast -tune zerolatency` if using libx264)
 - `debug`: Includes debugging output from the main FFmpeg process in the Homebridge log. (Default: `false`)
 - `debugReturn`: Includes debugging output from the FFmpeg used for return audio in the Homebridge log. (Default: `false`)
 

config.schema.json

@@ -141,9 +141,9 @@
                 "description": "If your camera also provides a URL for a still image, that can be defined here with the same syntax as 'source'. If not set, the plugin will grab one frame from 'source'."
               },
               "returnAudioTarget": {
-                "title": "Return Audio Target (EXPERIMENTAL)",
+                "title": "Two-way Audio Target (EXPERIMENTAL - WIP)",
                 "type": "string",
-                "description": "The FFmpeg output command for directing audio back to a two-way capable camera."
+                "description": "The FFmpeg output command for directing audio back to a two-way capable camera. This feature is still in development and a configuration that works today may not work in the future."
               },
               "maxStreams": {
                 "title": "Maximum Concurrent Streams",
@@ -215,11 +215,11 @@
                 "description": "If audio or video is choppy try a smaller value."
               },
               "videoFilter": {
-                "title": "Additional Video Filter Options",
+                "title": "Additional Video Filters",
                 "type": "string",
-                "description": "Allows additional video filter options to be passed to FFmpeg. If set to 'none', all video filters are disabled."
+                "description": "Comma-delimited list of additional video filters for FFmpeg to run on the video. If 'none' is included, the default video filters are disabled."
               },
-              "encoderParameters": {
+              "encoderOptions": {
                 "title": "Encoder Options",
                 "type": "string",
                 "placeholder": "-preset ultrafast -tune zerolatency",
@@ -241,14 +241,14 @@
                 "description": "Enables audio streaming from camera."
               },
               "debug": {
-                "title": "Debug Logging",
+                "title": "FFmpeg Debug Logging",
                 "type": "boolean",
                 "description": "Includes debugging output from the main FFmpeg process in the Homebridge log."
               },
               "debugReturn": {
-                "title": "Return Audio Debug Logging",
+                "title": "Two-way FFmpeg Debug Logging",
                 "type": "boolean",
-                "description": "Includes debugging output from the FFmpeg used for return audio in the Homebridge log."
+                "description": "Includes debugging output from the FFmpeg process used for two-way audio in the Homebridge log."
               }
             }
           }
@@ -293,14 +293,13 @@
               "expandable": true,
               "expanded": false,
               "items": [
+                "cameras[].unbridge",
+                "cameras[].videoConfig.maxStreams",
                 "cameras[].videoConfig.maxWidth",
                 "cameras[].videoConfig.maxHeight",
                 "cameras[].videoConfig.maxFPS",
                 "cameras[].videoConfig.maxBitrate",
-                "cameras[].videoConfig.forceMax",
-                "cameras[].videoConfig.preserveRatio",
-                "cameras[].videoConfig.videoFilter",
-                "cameras[].videoConfig.additionalCommandline"
+                "cameras[].videoConfig.forceMax"
               ]
             },
             {
@@ -310,15 +309,24 @@
               "expandable": true,
               "expanded": false,
               "items": [
-                "cameras[].videoConfig.returnAudioTarget",
+                {
+                  "key": "cameras[]",
+                  "type": "section",
+                  "title": "EXPERIMENTAL - WIP",
+                  "expandable": true,
+                  "expanded": false,
+                  "items": [
+                    "cameras[].videoConfig.returnAudioTarget",
+                    "cameras[].videoConfig.debugReturn"
+                  ]
+                },
                 "cameras[].videoConfig.vcodec",
+                "cameras[].videoConfig.packetSize",
                 "cameras[].videoConfig.mapvideo",
                 "cameras[].videoConfig.mapaudio",
-                "cameras[].videoConfig.maxStreams",
-                "cameras[].videoConfig.packetSize",
-                "cameras[].unbridge",
-                "cameras[].videoConfig.debug",
-                "cameras[].videoConfig.debugReturn"
+                "cameras[].videoConfig.videoFilter",
+                "cameras[].videoConfig.encoderOptions",
+                "cameras[].videoConfig.debug"
               ]
             },
             {

package-lock.json

@@ -1,7 +1,7 @@
 {
   "displayName": "Homebridge Camera FFmpeg",
   "name": "homebridge-camera-ffmpeg",
-  "version": "2.5.0",
+  "version": "3.0.0",
   "description": "Homebridge Plugin Providing FFmpeg-based Camera Support",
   "main": "dist/index.js",
   "license": "ISC",

package.json

@@ -36,11 +36,10 @@ export type VideoConfig = {
   maxFPS: number;
   maxBitrate: number;
   forceMax: boolean;
-  preserveRatio: boolean;
   vcodec: string;
   packetSize: number;
   videoFilter: string;
-  encoderParameters: string;
+  encoderOptions: string;
   mapvideo: string;
   mapaudio: string;
   audio: boolean;

src/configTypes.ts

@@ -128,9 +128,9 @@ export class StreamingDelegate implements CameraStreamingDelegate {
     this.controller = new hap.CameraController(options);
   }
 
-  private determineResolution(request: SnapshotRequest | VideoInfo, isSnapshot = false): ResolutionInfo {
-    let width = Math.floor(request.width / 2) * 2;
-    let height = Math.floor(request.height / 2) * 2;
+  private determineResolution(request: SnapshotRequest | VideoInfo, isSnapshot: boolean): ResolutionInfo {
+    let width = request.width;
+    let height = request.height;
     if (!isSnapshot) {
       if ((this.videoConfig.forceMax && this.videoConfig.maxWidth) ||
         (request.width > this.videoConfig.maxWidth)) {
@@ -142,26 +142,29 @@ export class StreamingDelegate implements CameraStreamingDelegate {
       }
     }
 
-    const vf: Array<string> = [];
-    if (this.videoConfig.videoFilter !== 'none') {
-      if (this.videoConfig.videoFilter) {
-        vf.push(this.videoConfig.videoFilter);
-      }
+    const filters: Array<string> = this.videoConfig.videoFilter?.split(',') || [];
+    const noneFilter = filters.indexOf('none');
+    if (noneFilter >= 0) {
+      filters.splice(noneFilter, 1);
+    }
+    if (noneFilter < 0) {
       if (width > 0 || height > 0) {
-        vf.push('scale=' + (width > 0 ? '\'min(' + width + ',iw)\'' : 'iw') + ':' +
+        filters.push('scale=' + (width > 0 ? '\'min(' + width + ',iw)\'' : 'iw') + ':' +
           (height > 0 ? '\'min(' + height + ',ih)\'' : 'ih') +
-          (this.videoConfig.preserveRatio ? ':force_original_aspect_ratio=decrease' : ''));
-        if (this.videoConfig.preserveRatio) {
-          vf.push('scale=trunc(iw/2)*2:trunc(ih/2)*2'); // Force to fit encoder restrictions
-        }
+          ':force_original_aspect_ratio=decrease');
+        filters.push('scale=trunc(iw/2)*2:trunc(ih/2)*2'); // Force to fit encoder restrictions
       }
     }
 
-    return {width: width, height: height, videoFilter: vf.join(',')};
+    return {
+      width: width,
+      height: height,
+      videoFilter: filters.join(',')
+    };
   }
 
   handleSnapshotRequest(request: SnapshotRequest, callback: SnapshotRequestCallback): void {
-    const resolution = this.determineResolution(request);
+    const resolution = this.determineResolution(request, true);
 
     this.log.debug('Snapshot requested: ' + request.width + ' x ' + request.height, this.cameraName, this.videoConfig.debug);
     this.log.debug('Sending snapshot: ' + (resolution.width > 0 ? resolution.width : 'native') + ' x ' +
@@ -277,12 +280,12 @@ export class StreamingDelegate implements CameraStreamingDelegate {
     const sessionInfo = this.pendingSessions[request.sessionID];
     const vcodec = this.videoConfig.vcodec || 'libx264';
     const mtu = this.videoConfig.packetSize || 1316; // request.video.mtu is not used
-    let encoderParameters = this.videoConfig.encoderParameters;
-    if (!encoderParameters && vcodec === 'libx264') {
-      encoderParameters = '-preset ultrafast -tune zerolatency';
+    let encoderOptions = this.videoConfig.encoderOptions;
+    if (!encoderOptions && vcodec === 'libx264') {
+      encoderOptions = '-preset ultrafast -tune zerolatency';
     }
 
-    const resolution = this.determineResolution(request.video, this.videoConfig.forceMax);
+    const resolution = this.determineResolution(request.video, false);
 
     let fps = (this.videoConfig.forceMax && this.videoConfig.maxFPS) ||
       (request.video.fps > this.videoConfig.maxFPS) ?
@@ -314,7 +317,7 @@ export class StreamingDelegate implements CameraStreamingDelegate {
       ' -color_range mpeg' +
       (fps > 0 ? ' -r ' + fps : '') +
       ' -f rawvideo' +
-      (encoderParameters ? ' ' + encoderParameters : '') +
+      (encoderOptions ? ' ' + encoderOptions : '') +
       (resolution.videoFilter.length > 0 ? ' -filter:v ' + resolution.videoFilter : '') +
       (videoBitrate > 0 ? ' -b:v ' + videoBitrate + 'k' : '') +
       ' -payload_type ' + request.video.pt;
@@ -399,6 +402,7 @@ export class StreamingDelegate implements CameraStreamingDelegate {
         'm=audio ' + sessionInfo.audioReturnPort + ' RTP/AVP 110\r\n' +
         'b=AS:24\r\n' +
         'a=rtpmap:110 MPEG4-GENERIC/16000/1\r\n' +
+        'a=rtcp-mux\r\n' + // FFmpeg ignores this, but might as well
         'a=fmtp:110 ' +
           'profile-level-id=1;mode=AAC-hbr;sizelength=13;indexlength=3;indexdeltalength=3; ' +
           'config=F8F0212C00BC00\r\n' +