Merge pull request #29 from Twasi/topic-#25-toggle-filter-visibility

Topic #25 toggle filter visibility

Author: DieserMerlin

.gitignore

@@ -1,3 +1,6 @@
+# Exclude 'Main' java class
+**/Main.java
+
 # Filesystem Stuff
 **.DS_Store
 

pom.xml

@@ -6,7 +6,7 @@
     <name>obs-websocket-java</name>
     <groupId>net.twasi</groupId>
     <artifactId>obs-websocket-java</artifactId>
-    <version>1.1.0</version>
+    <version>1.2.0</version>
 
     <description>Library to connect to the OBS WebSocket interface.</description>
     <url>https://github.com/Twasi/obs-websocket-java</url>

src/main/java/net/twasi/obsremotejava/OBSCommunicator.java

@@ -4,10 +4,7 @@
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
-import net.twasi.obsremotejava.callbacks.Callback;
-import net.twasi.obsremotejava.callbacks.ErrorCallback;
-import net.twasi.obsremotejava.callbacks.StringCallback;
-import net.twasi.obsremotejava.callbacks.VoidCallback;
+import net.twasi.obsremotejava.callbacks.*;
 import net.twasi.obsremotejava.events.EventType;
 import net.twasi.obsremotejava.events.responses.*;
 import net.twasi.obsremotejava.objects.throwables.InvalidResponseTypeError;
@@ -24,6 +21,10 @@
 import net.twasi.obsremotejava.requests.GetSceneItemProperties.GetSceneItemPropertiesRequest;
 import net.twasi.obsremotejava.requests.GetSceneList.GetSceneListRequest;
 import net.twasi.obsremotejava.requests.GetSceneList.GetSceneListResponse;
+import net.twasi.obsremotejava.requests.GetSourceFilterInfo.GetSourceFilterInfoRequest;
+import net.twasi.obsremotejava.requests.GetSourceFilterInfo.GetSourceFilterInfoResponse;
+import net.twasi.obsremotejava.requests.GetSourceFilters.GetSourceFiltersRequest;
+import net.twasi.obsremotejava.requests.GetSourceFilters.GetSourceFiltersResponse;
 import net.twasi.obsremotejava.requests.GetSourceSettings.GetSourceSettingsRequest;
 import net.twasi.obsremotejava.requests.GetSourceSettings.GetSourceSettingsResponse;
 import net.twasi.obsremotejava.requests.GetStreamingStatus.GetStreamingStatusRequest;
@@ -55,6 +56,8 @@
 import net.twasi.obsremotejava.requests.SetPreviewScene.SetPreviewSceneResponse;
 import net.twasi.obsremotejava.requests.SetSceneItemProperties.SetSceneItemPropertiesRequest;
 import net.twasi.obsremotejava.requests.SetSceneItemProperties.SetSceneItemPropertiesResponse;
+import net.twasi.obsremotejava.requests.SetSourceFilterVisibility.SetSourceFilterVisibilityRequest;
+import net.twasi.obsremotejava.requests.SetSourceFilterVisibility.SetSourceFilterVisibilityResponse;
 import net.twasi.obsremotejava.requests.SetSourceSettings.SetSourceSettingsRequest;
 import net.twasi.obsremotejava.requests.SetSourceSettings.SetSourceSettingsResponse;
 import net.twasi.obsremotejava.requests.SetStudioModeEnabled.SetStudioModeEnabledRequest;
@@ -107,6 +110,7 @@ public class OBSCommunicator {
 
     private Callback<GetVersionResponse> onConnect;
     private VoidCallback onDisconnect;
+    private CloseCallback onClose;
     private StringCallback onConnectionFailed;
     private ErrorCallback onError;
 
@@ -125,6 +129,7 @@ public class OBSCommunicator {
     private Callback<TransitionListChangedResponse> onTransitionListChanged;
     private Callback<TransitionBeginResponse> onTransitionBegin;
     private Callback<TransitionEndResponse> onTransitionEnd;
+    private Callback<SourceFilterVisibilityChangedResponse> onSourceFilterVisibilityChanged;
 
     private GetVersionResponse versionInfo;
 
@@ -155,12 +160,9 @@ public void onError(Session session, Throwable throwable) {
     @OnWebSocketClose
     public void onClose(int statusCode, String reason) {
         log.info(String.format("Connection closed: %d - %s%n", statusCode, reason));
+        runOnDisconnect();
         this.closeLatch.countDown(); // trigger latch
-        try {
-            this.onDisconnect.run();
-        } catch (Throwable t) {
-            log.error("Unable to disconnect OBS Client", t);
-        }
+        runOnClosed(statusCode, reason);
     }
 
     @OnWebSocketConnect
@@ -191,6 +193,7 @@ public void onMessage(String msg) {
                 // Response
                 ResponseBase responseBase = new Gson().fromJson(msg, ResponseBase.class);
                 Class type = messageTypes.get(responseBase.getMessageId());
+                log.trace(String.format("Trying to deserialize response with type %s and message '%s'", type, msg));
                 responseBase = (ResponseBase) new Gson().fromJson(msg, type);
 
                 try {
@@ -292,6 +295,11 @@ private void processIncomingEvent(String msg, EventType eventType) {
                     onScenesChanged.run(new Gson().fromJson(msg, ScenesChangedResponse.class));
                 }
                 break;
+            case SourceFilterVisibilityChanged:
+                if(onSourceFilterVisibilityChanged != null) {
+                    onSourceFilterVisibilityChanged.run(new Gson().fromJson(msg, SourceFilterVisibilityChangedResponse.class));
+                }
+                break;
             case SwitchTransition:
                 if (onSwitchTransition != null) {
                     onSwitchTransition.run(new Gson().fromJson(msg, SwitchTransitionResponse.class));
@@ -379,6 +387,8 @@ public void registerOnDisconnect(VoidCallback onDisconnect) {
         this.onDisconnect = onDisconnect;
     }
 
+    public void registerOnClose(CloseCallback closeCallback) { this.onClose = closeCallback; }
+
     public void registerOnConnectionFailed(StringCallback onConnectionFailed) {
         this.onConnectionFailed = onConnectionFailed;
     }
@@ -407,6 +417,10 @@ public void registerOnScenesChanged(Callback<ScenesChangedResponse> onScenesChan
         this.onScenesChanged = onScenesChanged;
     }
 
+    public void registerOnSourceFilterVisibilityChanged(Callback<SourceFilterVisibilityChangedResponse> onSourceFilterVisibilityChanged) {
+        this.onSourceFilterVisibilityChanged = onSourceFilterVisibilityChanged;
+    }
+
     public void registerOnSwitchTransition(Callback<SwitchTransitionResponse> onSwitchTransition) {
         this.onSwitchTransition = onSwitchTransition;
     }
@@ -493,6 +507,24 @@ public void setSourceSettings(String sourceName, Map<String, Object> settings, C
         callbacks.put(SetSourceSettingsResponse.class, callback);
     }
 
+    public void getSourceFilters(String sourceName, Callback<GetSourceFiltersResponse> callback) {
+        GetSourceFiltersRequest request = new GetSourceFiltersRequest(sourceName);
+        session.getRemote().sendStringByFuture(new Gson().toJson(request));
+        callbacks.put(GetSourceFiltersResponse.class, callback);
+    }
+
+    public void getSourceFilterInfo(String sourceName, String filterName, Callback<GetSourceFilterInfoResponse> callback) {
+        GetSourceFilterInfoRequest request = new GetSourceFilterInfoRequest(sourceName, filterName);
+        session.getRemote().sendStringByFuture(new Gson().toJson(request));
+        callbacks.put(GetSourceFilterInfoResponse.class, callback);
+    }
+
+    public void setSourceFilterVisibility(String sourceName, String filterName, boolean filterEnabled, Callback<SetSourceFilterVisibilityResponse> callback) {
+        SetSourceFilterVisibilityRequest request = new SetSourceFilterVisibilityRequest(sourceName, filterName, filterEnabled);
+        session.getRemote().sendStringByFuture(new Gson().toJson(request));
+        callbacks.put(SetSourceFilterVisibilityResponse.class, callback);
+    }
+
     public void startRecording(Callback<StartRecordingResponse> callback) {
         StartRecordingRequest request = new StartRecordingRequest(this);
 
@@ -692,4 +724,34 @@ private void runOnConnect(GetVersionResponse versionInfo) {
             log.error("Unable to run OnConnect callback", t);
         }
     }
+
+    void runOnDisconnect() {
+        log.debug("Running onDisconnect");
+        if (onDisconnect == null) {
+            log.debug("No onDisconnect callback was registered");
+            return;
+        }
+
+        try {
+            onDisconnect.run();
+        } catch (Throwable t) {
+            log.error("Unable to run OnDisconnect callback", t);
+        }
+    }
+
+
+    private void runOnClosed(int statusCode, String reason) {
+        log.debug("Running onClose with statusCode " + statusCode + " and reason: " + reason);
+
+        if(this.onClose == null) {
+            log.debug("No onClose was registered.");
+            return;
+        }
+
+        try {
+            onClose.run(statusCode, reason);
+        } catch (Throwable t) {
+            log.error("Unable to run onClose callback", t);
+        }
+    }
 }

src/main/java/net/twasi/obsremotejava/OBSRemoteController.java

@@ -1,15 +1,17 @@
 package net.twasi.obsremotejava;
 
-import net.twasi.obsremotejava.callbacks.Callback;
-import net.twasi.obsremotejava.callbacks.ErrorCallback;
-import net.twasi.obsremotejava.callbacks.StringCallback;
-import net.twasi.obsremotejava.callbacks.VoidCallback;
+import com.google.gson.Gson;
+import net.twasi.obsremotejava.callbacks.*;
 import net.twasi.obsremotejava.events.responses.*;
 import net.twasi.obsremotejava.objects.throwables.OBSResponseError;
 import net.twasi.obsremotejava.requests.GetCurrentProfile.GetCurrentProfileResponse;
 import net.twasi.obsremotejava.requests.GetCurrentScene.GetCurrentSceneResponse;
 import net.twasi.obsremotejava.requests.GetPreviewScene.GetPreviewSceneResponse;
 import net.twasi.obsremotejava.requests.GetSceneList.GetSceneListResponse;
+import net.twasi.obsremotejava.requests.GetSourceFilterInfo.GetSourceFilterInfoRequest;
+import net.twasi.obsremotejava.requests.GetSourceFilterInfo.GetSourceFilterInfoResponse;
+import net.twasi.obsremotejava.requests.GetSourceFilters.GetSourceFiltersRequest;
+import net.twasi.obsremotejava.requests.GetSourceFilters.GetSourceFiltersResponse;
 import net.twasi.obsremotejava.requests.GetSourceSettings.GetSourceSettingsResponse;
 import net.twasi.obsremotejava.requests.GetStreamingStatus.GetStreamingStatusResponse;
 import net.twasi.obsremotejava.requests.GetStudioModeEnabled.GetStudioModeEnabledResponse;
@@ -25,6 +27,8 @@
 import net.twasi.obsremotejava.requests.SetMute.SetMuteResponse;
 import net.twasi.obsremotejava.requests.SetPreviewScene.SetPreviewSceneResponse;
 import net.twasi.obsremotejava.requests.SetSceneItemProperties.SetSceneItemPropertiesResponse;
+import net.twasi.obsremotejava.requests.SetSourceFilterVisibility.SetSourceFilterVisibilityRequest;
+import net.twasi.obsremotejava.requests.SetSourceFilterVisibility.SetSourceFilterVisibilityResponse;
 import net.twasi.obsremotejava.requests.SetSourceSettings.SetSourceSettingsResponse;
 import net.twasi.obsremotejava.requests.SetStudioModeEnabled.SetStudioModeEnabledResponse;
 import net.twasi.obsremotejava.requests.SetTransitionDuration.SetTransitionDurationResponse;
@@ -114,7 +118,7 @@ public void connect() {
     }
 
     public void disconnect() {
-        // wait for closed socket connection
+        // trigger the latch
         try {
             if (debug) {
                 log.debug("Closing connection.");
@@ -124,6 +128,7 @@ public void disconnect() {
             runOnError("Error during closing websocket connection", e);
         }
 
+        // stop the client if it isn't already stopped or stopping
         if (!client.isStopped() && !client.isStopping()) {
             try {
                 if (debug) {
@@ -162,6 +167,10 @@ public void registerConnectionFailedCallback(StringCallback onConnectionFailed)
         communicator.registerOnConnectionFailed(onConnectionFailed);
     }
 
+    public void registerCloseCallback(CloseCallback closeCallback) {
+        communicator.registerOnClose(closeCallback);
+    }
+
     public void registerRecordingStartedCallback(VoidCallback onRecordingStarted) {
         communicator.registerOnRecordingStarted(onRecordingStarted);
     }
@@ -218,6 +227,10 @@ public void registerTransitionEndCallback(Callback<TransitionEndResponse> onTran
         communicator.registerOnTransitionEnd(onTransitionEnd);
     }
 
+    public void registerSourceFilterVisibilityChangedCallback(Callback<SourceFilterVisibilityChangedResponse> onSourceVisibilityChanged) {
+        communicator.registerOnSourceFilterVisibilityChanged(onSourceVisibilityChanged);
+    }
+
     public void await() throws InterruptedException {
         communicator.await();
     }
@@ -248,6 +261,22 @@ public void getSceneItemProperties(String scene, String source, Callback<SetScen
         communicator.getSceneItemProperties(scene, source, callback);
     }
 
+    public void getSourceProperties(String scene, String source, Callback<SetSceneItemPropertiesResponse> callback) {
+        getSceneItemProperties(scene, source, callback);
+    }
+
+    public void getSourceFilters(String sourceName, Callback<GetSourceFiltersResponse> callback) {
+        communicator.getSourceFilters(sourceName, callback);
+    }
+
+    public void getSourceFilterInfo(String sourceName, String filterName, Callback<GetSourceFilterInfoResponse> callback) {
+        communicator.getSourceFilterInfo(sourceName, filterName, callback);
+    }
+
+    public void setSourceFilterVisibility(String sourceName, String filterName, boolean filterEnabled, Callback<SetSourceFilterVisibilityResponse> callback) {
+        communicator.setSourceFilterVisibility(sourceName, filterName, filterEnabled, callback);
+    }
+
     public void getTransitionList(Callback<GetTransitionListResponse> callback) {
         communicator.getTransitionList(callback);
     }
@@ -377,4 +406,5 @@ private void runOnConnectionFailed(String message, Throwable throwable) {
             log.error("Unable to run OnConnectionFailed callback", e);
         }
     }
+
 }

src/main/java/net/twasi/obsremotejava/callbacks/CloseCallback.java

@@ -0,0 +1,5 @@
+package net.twasi.obsremotejava.callbacks;
+
+public interface CloseCallback {
+    void run(int statusCode, String reason);
+}

src/main/java/net/twasi/obsremotejava/events/EventType.java

@@ -11,6 +11,7 @@ public enum EventType {
     StreamStopped,
     SwitchScenes,
     ScenesChanged,
+    SourceFilterVisibilityChanged,
     SwitchTransition,
     TransitionListChanged,
     TransitionBegin,

src/main/java/net/twasi/obsremotejava/events/responses/SourceFilterVisibilityChangedResponse.java

@@ -0,0 +1,21 @@
+package net.twasi.obsremotejava.events.responses;
+
+import net.twasi.obsremotejava.requests.ResponseBase;
+
+public class SourceFilterVisibilityChangedResponse extends ResponseBase {
+    private String sourceName;
+    private String filterName;
+    private boolean filterEnabled;
+
+    public String getSourceName() {
+        return sourceName;
+    }
+
+    public String getFilterName() {
+        return filterName;
+    }
+
+    public boolean isFilterEnabled() {
+        return filterEnabled;
+    }
+}

src/main/java/net/twasi/obsremotejava/objects/SourceFilterInfo.java

@@ -0,0 +1,27 @@
+package net.twasi.obsremotejava.objects;
+
+import java.util.Map;
+
+public class SourceFilterInfo {
+
+    private boolean filterStatus; // whether the filter is visible or not
+    private String type;
+    private String name;
+    private Map<String, String> settings;
+
+    public boolean isFilterVisible() {
+        return filterStatus;
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public Map<String, String> getSettings() {
+        return settings;
+    }
+}

src/main/java/net/twasi/obsremotejava/objects/SourceFilterSettings.java

@@ -0,0 +1,19 @@
+package net.twasi.obsremotejava.objects;
+
+import java.util.Collection;
+import java.util.Map;
+
+public class SourceFilterSettings {
+    private Collection<Map<String,String>> map;
+
+    public Collection<Map<String, String>> getMap() {
+        return map;
+    }
+
+    @Override
+    public String toString() {
+        return "SourceFilterSettings{" +
+                map +
+                '}';
+    }
+}

src/main/java/net/twasi/obsremotejava/requests/GetSourceFilterInfo/GetSourceFilterInfoRequest.java

@@ -0,0 +1,16 @@
+package net.twasi.obsremotejava.requests.GetSourceFilterInfo;
+
+import net.twasi.obsremotejava.requests.BaseRequest;
+import net.twasi.obsremotejava.requests.RequestType;
+
+public class GetSourceFilterInfoRequest extends BaseRequest {
+    private final String sourceName;
+    private final String filterName;
+
+    public GetSourceFilterInfoRequest(String sourceName, String filterName) {
+        super(RequestType.GetSourceFilterInfo);
+        this.sourceName = sourceName;
+        this.filterName = filterName;
+    }
+
+}