Add mouse socket listener

BlankSourceCode · BlankSourceCode · commit 4c5cae6f60a1 · 2023-12-05T15:48:57.000-08:00
diff --git a/obs-zoom-to-mouse.lua b/obs-zoom-to-mouse.lua
@@ -9,6 +9,10 @@ local ffi = require("ffi")
 local VERSION = "1.0"
 local CROP_FILTER_NAME = "obs-zoom-to-mouse-crop"
 
+local socket_available, socket = pcall(require, "ljsocket")
+local socket_server = nil
+local socket_mouse = nil
+
 local source_name = ""
 local source = nil
 local sceneitem = nil
@@ -63,6 +67,9 @@ local monitor_override_sx = 0
 local monitor_override_sy = 0
 local monitor_override_dw = 0
 local monitor_override_dh = 0
+local use_socket = false
+local socket_port = 0
+local socket_poll = 1000
 local debug_logs = false
 
 local ZoomState = {
@@ -149,27 +156,32 @@ end
 function get_mouse_pos()
     local mouse = { x = 0, y = 0 }
 
-    if ffi.os == "Windows" then
-        if win_point and ffi.C.GetCursorPos(win_point) ~= 0 then
-            mouse.x = win_point[0].x
-            mouse.y = win_point[0].y
-        end
-    elseif ffi.os == "Linux" then
-        if x11_lib ~= nil and x11_display ~= nil and x11_root ~= nil and x11_mouse ~= nil then
-            if x11_lib.XQueryPointer(x11_display, x11_root, x11_mouse.root_win, x11_mouse.child_win, x11_mouse.root_x, x11_mouse.root_y, x11_mouse.win_x, x11_mouse.win_y, x11_mouse.mask) ~= 0 then
-                mouse.x = tonumber(x11_mouse.win_x[0])
-                mouse.y = tonumber(x11_mouse.win_y[0])
+    if socket_mouse ~= nil then
+        mouse.x = socket_mouse.x
+        mouse.y = socket_mouse.y
+    else
+        if ffi.os == "Windows" then
+            if win_point and ffi.C.GetCursorPos(win_point) ~= 0 then
+                mouse.x = win_point[0].x
+                mouse.y = win_point[0].y
             end
-        end
-    elseif ffi.os == "OSX" then
-        if osx_lib ~= nil and osx_nsevent ~= nil and osx_mouse_location ~= nil then
-            local point = osx_mouse_location(osx_nsevent.class, osx_nsevent.sel)
-            mouse.x = point.x
-            if monitor_info ~= nil then
-                if monitor_info.display_height > 0 then
-                    mouse.y = monitor_info.display_height - point.y
-                else
-                    mouse.y = monitor_info.height - point.y
+        elseif ffi.os == "Linux" then
+            if x11_lib ~= nil and x11_display ~= nil and x11_root ~= nil and x11_mouse ~= nil then
+                if x11_lib.XQueryPointer(x11_display, x11_root, x11_mouse.root_win, x11_mouse.child_win, x11_mouse.root_x, x11_mouse.root_y, x11_mouse.win_x, x11_mouse.win_y, x11_mouse.mask) ~= 0 then
+                    mouse.x = tonumber(x11_mouse.win_x[0])
+                    mouse.y = tonumber(x11_mouse.win_y[0])
+                end
+            end
+        elseif ffi.os == "OSX" then
+            if osx_lib ~= nil and osx_nsevent ~= nil and osx_mouse_location ~= nil then
+                local point = osx_mouse_location(osx_nsevent.class, osx_nsevent.sel)
+                mouse.x = point.x
+                if monitor_info ~= nil then
+                    if monitor_info.display_height > 0 then
+                        mouse.y = monitor_info.display_height - point.y
+                    else
+                        mouse.y = monitor_info.height - point.y
+                    end
                 end
             end
         end
@@ -978,6 +990,56 @@ function on_timer()
     end
 end
 
+function on_socket_timer()
+    if not socket_server then
+        return
+    end
+
+    repeat
+        local data, status = socket_server:receive_from()
+        if data then
+            local sx, sy = data:match("(-?%d+) (-?%d+)")
+            if sx and sy then
+                local x = tonumber(sx, 10)
+                local y = tonumber(sy, 10)
+                if not socket_mouse then
+                    log("Socket server client connected")
+                    socket_mouse = { x = x, y = y }
+                else
+                    socket_mouse.x = x
+                    socket_mouse.y = y
+                end
+            end
+        elseif status ~= "timeout" then
+            error(status)
+        end
+    until data == nil
+end
+
+function start_server()
+    if socket_available then
+        local address = socket.find_first_address("*", socket_port)
+
+        socket_server = socket.create("inet", "dgram", "udp")
+        if socket_server ~= nil then
+            socket_server:set_option("reuseaddr", 1)
+            socket_server:set_blocking(false)
+            socket_server:bind(address, socket_port)
+            obs.timer_add(on_socket_timer, socket_poll)
+            log("Socket server listening on port " .. socket_port .. "...")
+        end
+    end
+end
+
+function stop_server()
+    if socket_server ~= nil then
+        log("Socket server stopped")
+        socket_server:close()
+        socket_server = nil
+        socket_mouse = nil
+    end
+end
+
 function set_crop_settings(crop)
     if crop_filter ~= nil and crop_filter_settings ~= nil then
         -- Call into OBS to update our crop filter with the new settings
@@ -1018,6 +1080,7 @@ function on_settings_modified(props, prop, settings)
     -- Show/Hide the settings based on if the checkbox is checked or not
     if name == "use_monitor_override" then
         local visible = obs.obs_data_get_bool(settings, "use_monitor_override")
+        obs.obs_property_set_visible(obs.obs_properties_get(props, "monitor_override_label"), not visible)
         obs.obs_property_set_visible(obs.obs_properties_get(props, "monitor_override_x"), visible)
         obs.obs_property_set_visible(obs.obs_properties_get(props, "monitor_override_y"), visible)
         obs.obs_property_set_visible(obs.obs_properties_get(props, "monitor_override_w"), visible)
@@ -1027,6 +1090,12 @@ function on_settings_modified(props, prop, settings)
         obs.obs_property_set_visible(obs.obs_properties_get(props, "monitor_override_dw"), visible)
         obs.obs_property_set_visible(obs.obs_properties_get(props, "monitor_override_dh"), visible)
         return true
+    elseif name == "use_socket" then
+        local visible = obs.obs_data_get_bool(settings, "use_socket")
+        obs.obs_property_set_visible(obs.obs_properties_get(props, "socket_label"), not visible)
+        obs.obs_property_set_visible(obs.obs_properties_get(props, "socket_port"), visible)
+        obs.obs_property_set_visible(obs.obs_properties_get(props, "socket_poll"), visible)
+        return true
     elseif name == "allow_all_sources" then
         local sources_list = obs.obs_properties_get(props, "source")
         populate_zoom_sources(sources_list)
@@ -1061,6 +1130,9 @@ function log_current_settings()
         monitor_override_sy = monitor_override_sy,
         monitor_override_dw = monitor_override_dw,
         monitor_override_dh = monitor_override_dh,
+        use_socket = use_socket,
+        socket_port = socket_port,
+        socket_poll = socket_poll,
         debug_logs = debug_logs
     }
 
@@ -1093,7 +1165,16 @@ function on_print_help()
         "Scale X: The x scale factor to apply to the mouse position if the source size is not 1:1 (useful for cloned sources)\n" ..
         "Scale Y: The y scale factor to apply to the mouse position if the source size is not 1:1 (useful for cloned sources)\n" ..
         "Monitor Width: The width of the monitor that is showing the source (in pixels)\n" ..
-        "Monitor Height: The height of the monitor that is showing the source (in pixels)\n" ..
+        "Monitor Height: The height of the monitor that is showing the source (in pixels)\n"
+
+    if socket_available then
+        help = help ..
+            "Enable remote mouse listener: True to start a UDP socket server that will listen for mouse position messages from a remote client\n" ..
+            "Port: The port number to use for the socket server\n" ..
+            "Poll Delay: The time between updating the mouse position (in milliseconds)\n"
+    end
+
+    help = help ..
         "More Info: Show this text in the script log\n" ..
         "Enable debug logging: Show additional debug information in the script log\n\n"
 
@@ -1146,24 +1227,47 @@ function script_properties()
     obs.obs_property_set_long_description(allow_all, "Enable to allow selecting any source as the Zoom Source\n" ..
         "You MUST set manual source position for non-display capture sources")
 
-    local override = obs.obs_properties_add_bool(props, "use_monitor_override", "Set manual source position ")
-    obs.obs_property_set_long_description(override,
+    local override_props = obs.obs_properties_create();
+    local override_label = obs.obs_properties_add_text(override_props, "monitor_override_label", "", obs.OBS_TEXT_INFO)
+    local override_x = obs.obs_properties_add_int(override_props, "monitor_override_x", "X", -10000, 10000, 1)
+    local override_y = obs.obs_properties_add_int(override_props, "monitor_override_y", "Y", -10000, 10000, 1)
+    local override_w = obs.obs_properties_add_int(override_props, "monitor_override_w", "Width", 0, 10000, 1)
+    local override_h = obs.obs_properties_add_int(override_props, "monitor_override_h", "Height", 0, 10000, 1)
+    local override_sx = obs.obs_properties_add_float(override_props, "monitor_override_sx", "Scale X ", 0, 100, 0.01)
+    local override_sy = obs.obs_properties_add_float(override_props, "monitor_override_sy", "Scale Y ", 0, 100, 0.01)
+    local override_dw = obs.obs_properties_add_int(override_props, "monitor_override_dw", "Monitor Width ", 0, 10000, 1)
+    local override_dh = obs.obs_properties_add_int(override_props, "monitor_override_dh", "Monitor Height ", 0, 10000, 1)
+    local override = obs.obs_properties_add_group(props, "use_monitor_override", "Set manual source position ",
+        obs.OBS_GROUP_CHECKABLE, override_props)
+
+    obs.obs_property_set_long_description(override_label,
         "When enabled the specified size/position settings will be used for the zoom source instead of the auto-calculated ones")
-
-    local override_x = obs.obs_properties_add_int(props, "monitor_override_x", "X", -10000, 10000, 1)
-    local override_y = obs.obs_properties_add_int(props, "monitor_override_y", "Y", -10000, 10000, 1)
-    local override_w = obs.obs_properties_add_int(props, "monitor_override_w", "Width", 0, 10000, 1)
-    local override_h = obs.obs_properties_add_int(props, "monitor_override_h", "Height", 0, 10000, 1)
-    local override_sx = obs.obs_properties_add_float(props, "monitor_override_sx", "Scale X ", 0, 100, 0.01)
-    local override_sy = obs.obs_properties_add_float(props, "monitor_override_sy", "Scale Y ", 0, 100, 0.01)
-    local override_dw = obs.obs_properties_add_int(props, "monitor_override_dw", "Monitor Width ", 0, 10000, 1)
-    local override_dh = obs.obs_properties_add_int(props, "monitor_override_dh", "Monitor Height ", 0, 10000, 1)
-
     obs.obs_property_set_long_description(override_sx, "Usually 1 - unless you are using a scaled source")
     obs.obs_property_set_long_description(override_sy, "Usually 1 - unless you are using a scaled source")
     obs.obs_property_set_long_description(override_dw, "X resolution of your montior")
     obs.obs_property_set_long_description(override_dh, "Y resolution of your monitor")
 
+    if socket_available then
+        local socket_props = obs.obs_properties_create();
+        local r_label = obs.obs_properties_add_text(socket_props, "socket_label", "", obs.OBS_TEXT_INFO)
+        local r_port = obs.obs_properties_add_int(socket_props, "socket_port", "Port ", 1024, 65535, 1)
+        local r_poll = obs.obs_properties_add_int(socket_props, "socket_poll", "Poll Delay (ms) ", 0, 1000, 1)
+        local socket = obs.obs_properties_add_group(props, "use_socket", "Enable remote mouse listener ",
+            obs.OBS_GROUP_CHECKABLE, socket_props)
+
+        obs.obs_property_set_long_description(r_label,
+            "When enabled a UDP socket server will listen for mouse position messages from a remote client")
+        obs.obs_property_set_long_description(r_port,
+            "You must restart the server after changing the port (Uncheck then re-check 'Enable remote mouse listener')")
+        obs.obs_property_set_long_description(r_poll,
+            "You must restart the server after changing the poll delay (Uncheck then re-check 'Enable remote mouse listener')")
+
+        obs.obs_property_set_visible(r_label, not use_socket)
+        obs.obs_property_set_visible(r_port, use_socket)
+        obs.obs_property_set_visible(r_poll, use_socket)
+        obs.obs_property_set_modified_callback(socket, on_settings_modified)
+    end
+
     -- Add a button for more information
     local help = obs.obs_properties_add_button(props, "help_button", "More Info", on_print_help)
     obs.obs_property_set_long_description(help,
@@ -1173,6 +1277,7 @@ function script_properties()
     obs.obs_property_set_long_description(debug,
         "When enabled the script will output diagnostics messages to the script log (useful for debugging/github issues)")
 
+    obs.obs_property_set_visible(override_label, not use_monitor_override)
     obs.obs_property_set_visible(override_x, use_monitor_override)
     obs.obs_property_set_visible(override_y, use_monitor_override)
     obs.obs_property_set_visible(override_w, use_monitor_override)
@@ -1182,6 +1287,7 @@ function script_properties()
     obs.obs_property_set_visible(override_dw, use_monitor_override)
     obs.obs_property_set_visible(override_dh, use_monitor_override)
     obs.obs_property_set_modified_callback(override, on_settings_modified)
+
     obs.obs_property_set_modified_callback(allow_all, on_settings_modified)
     obs.obs_property_set_modified_callback(debug, on_settings_modified)
 
@@ -1226,6 +1332,9 @@ function script_load(settings)
     monitor_override_sy = obs.obs_data_get_double(settings, "monitor_override_sy")
     monitor_override_dw = obs.obs_data_get_int(settings, "monitor_override_dw")
     monitor_override_dh = obs.obs_data_get_int(settings, "monitor_override_dh")
+    use_socket = obs.obs_data_get_bool(settings, "use_socket")
+    socket_port = obs.obs_data_get_int(settings, "socket_port")
+    socket_poll = obs.obs_data_get_int(settings, "socket_poll")
     debug_logs = obs.obs_data_get_bool(settings, "debug_logs")
 
     obs.obs_frontend_add_event_callback(on_frontend_event)
@@ -1250,6 +1359,9 @@ function script_load(settings)
         log("ERROR: Could not get X11 Display for Linux\n" ..
             "Mouse position will be incorrect.")
     end
+
+    source_name = ""
+    use_socket = false
 end
 
 function script_unload()
@@ -1272,6 +1384,12 @@ function script_unload()
 
     if x11_lib ~= nil and x11_display ~= nil then
         x11_lib.XCloseDisplay(x11_display)
+        x11_display = nil
+        x11_lib = nil
+    end
+
+    if socket_server ~= nil then
+        stop_server()
     end
 end
 
@@ -1295,6 +1413,9 @@ function script_defaults(settings)
     obs.obs_data_set_default_double(settings, "monitor_override_sy", 1)
     obs.obs_data_set_default_int(settings, "monitor_override_dw", 1920)
     obs.obs_data_set_default_int(settings, "monitor_override_dh", 1080)
+    obs.obs_data_set_default_bool(settings, "use_socket", false)
+    obs.obs_data_set_default_int(settings, "socket_port", 12345)
+    obs.obs_data_set_default_int(settings, "socket_poll", 10)
     obs.obs_data_set_default_bool(settings, "debug_logs", false)
 end
 
@@ -1324,6 +1445,8 @@ function script_update(settings)
     local old_sy = monitor_override_sy
     local old_dw = monitor_override_dw
     local old_dh = monitor_override_dh
+    local old_socket = use_socket
+    local old_port = socket_port
 
     -- Update the settings
     source_name = obs.obs_data_get_string(settings, "source")
@@ -1345,6 +1468,9 @@ function script_update(settings)
     monitor_override_sy = obs.obs_data_get_double(settings, "monitor_override_sy")
     monitor_override_dw = obs.obs_data_get_int(settings, "monitor_override_dw")
     monitor_override_dh = obs.obs_data_get_int(settings, "monitor_override_dh")
+    use_socket = obs.obs_data_get_bool(settings, "use_socket")
+    socket_port = obs.obs_data_get_int(settings, "socket_port")
+    socket_poll = obs.obs_data_get_int(settings, "socket_poll")
     debug_logs = obs.obs_data_get_bool(settings, "debug_logs")
 
     -- Only do the expensive refresh if the user selected a new source
@@ -1365,6 +1491,14 @@ function script_update(settings)
         monitor_override_h ~= old_dh then
         monitor_info = get_monitor_info(source)
     end
+
+    if old_socket ~= use_socket then
+        if use_socket then
+            start_server()
+        else
+            stop_server()
+        end
+    end
 end
 
 function populate_zoom_sources(list)
diff --git a/readme.md b/readme.md
@@ -62,6 +62,12 @@ Inspired by [tryptech](https://github.com/tryptech)'s [obs-zoom-and-follow](http
    * **More Info**: Show this text in the script log
    * **Enable debug logging**: Show additional debug information in the script log
 
+1. If you have [ljsocket.lua](https://github.com/BlankSourceCode/obs-zoom-to-mouse-remote) in the same directory as `obs-zoom-to-mouse.lua`, the following settings will also be available:
+   * **Enable remote mouse listener**: True to start a UDP socket server that will listen for mouse position messages from a remote client
+   * **Port**: The port number to use for the socket server
+   * **Poll Delay**: The time between updating the mouse position (in milliseconds)
+   * For more information see [obs-zoom-to-mouse-remote](https://github.com/BlankSourceCode/obs-zoom-to-mouse-remote)
+
 1. In OBS, open File -> Settings -> Hotkeys 
    * Add a hotkey for `Toggle zoom to mouse` to zoom in and out
    * Add a hotkey for `Toggle follow mouse during zoom` to turn mouse tracking on and off (*Optional*)
