Merge pull request #23 from BlankSourceCode/remote

BlankSourceCode · web-flow · commit 781b2d021b52 · 2024-02-07T13:56:07.000-08:00
Add basic dual machine support
diff --git a/obs-zoom-to-mouse.lua b/obs-zoom-to-mouse.lua
@@ -6,9 +6,13 @@
 
 local obs = obslua
 local ffi = require("ffi")
-local VERSION = "1.0"
+local VERSION = "1.0.2"
 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 is_obs_loaded = false
 local is_script_loaded = false
@@ -153,27 +160,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
@@ -984,6 +996,57 @@ 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")
+        obs.timer_remove(on_socket_timer)
+        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
@@ -1042,6 +1105,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)
@@ -1051,6 +1115,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)
@@ -1085,7 +1155,11 @@ function log_current_settings()
         monitor_override_sy = monitor_override_sy,
         monitor_override_dw = monitor_override_dw,
         monitor_override_dh = monitor_override_dh,
-        debug_logs = debug_logs
+        use_socket = use_socket,
+        socket_port = socket_port,
+        socket_poll = socket_poll,
+        debug_logs = debug_logs,
+        version = VERSION
     }
 
     log("OBS Version: " .. string.format("%.1f", major) .. "." .. minor)
@@ -1118,7 +1192,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, see: https://github.com/BlankSourceCode/obs-zoom-to-mouse-remote\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"
 
@@ -1171,24 +1254,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,
@@ -1198,6 +1304,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)
@@ -1207,6 +1314,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)
 
@@ -1216,6 +1324,11 @@ end
 function script_load(settings)
     sceneitem_info_orig = nil
 
+    -- Workaround for detecting if OBS is already loaded and we were reloaded using "Reload Scripts"
+    local current_scene = obs.obs_frontend_get_current_scene()
+    is_obs_loaded = current_scene ~= nil -- Current scene is nil on first OBS load
+    obs.obs_source_release(current_scene)
+
     -- Add our hotkey
     hotkey_zoom_id = obs.obs_hotkey_register_frontend("toggle_zoom_hotkey", "Toggle zoom to mouse",
         on_toggle_zoom)
@@ -1251,6 +1364,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)
@@ -1277,6 +1393,7 @@ function script_load(settings)
     end
 
     source_name = ""
+    use_socket = false
     is_script_loaded = true
 end
 
@@ -1305,6 +1422,10 @@ function script_unload()
         x11_display = nil
         x11_lib = nil
     end
+
+    if socket_server ~= nil then
+        stop_server()
+    end
 end
 
 function script_defaults(settings)
@@ -1327,6 +1448,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
 
@@ -1356,6 +1480,9 @@ 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
+    local old_poll = socket_poll
 
     -- Update the settings
     source_name = obs.obs_data_get_string(settings, "source")
@@ -1377,6 +1504,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
@@ -1399,6 +1529,17 @@ function script_update(settings)
             monitor_info = get_monitor_info(source)
         end
     end
+
+    if old_socket ~= use_socket then
+        if use_socket then
+            start_server()
+        else
+            stop_server()
+        end
+    elseif use_socket and (old_poll ~= socket_poll or old_port ~= socket_port) then
+        stop_server()
+        start_server()
+    end
 end
 
 function populate_zoom_sources(list)
diff --git a/readme.md b/readme.md
@@ -66,6 +66,14 @@ Inspired by [tryptech](https://github.com/tryptech)'s [obs-zoom-and-follow](http
    * 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*)
 
+### Dual Machine Support
+1. The script also has some **basic** dual machine setup support. By using my related project [obs-zoom-to-mouse-remote](https://github.com/BlankSourceCode/obs-zoom-to-mouse-remote) you will be able to track the mouse on your second machine
+1. When 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)
+
 ### More information on how mouse tracking works
 When you press the `Toggle zoom` hotkey the script will use the current mouse position as the center of the zoom. The script will then animate the width/height values of a crop/pan filter so it appears to zoom into that location. If you have `Auto follow mouse` turned on, then the x/y values of the filter will also change to keep the mouse in view as it is animating the zoom. Once the animation is complete, the script gives you a "safe zone" to move your cursor in without it moving the "camera". The idea was that you'd want to zoom in somewhere and move your mouse around to highlight code or whatever, without the screen moving so it would be easier to read text in the video.
 
