feat: Update OBS capture window after finding/starting game instance

Author: cetteup

BF2AutoSpectator/common/config.py

@@ -28,6 +28,7 @@ class Config(metaclass=Singleton):
     __controller_base_uri: str
     __control_obs: bool
     __obs_url: str
+    __obs_source_name: str
 
     __resolution: str
     __debug_screenshot: bool
@@ -42,7 +43,7 @@ class Config(metaclass=Singleton):
 
     def set_options(self, player_name: str, player_pass: str, server_ip: str, server_port: str, server_pass: str,
                     server_mod: str, game_path: str, tesseract_path: str, limit_rtl: bool, instance_rtl: int, map_load_delay: int,
-                    use_controller: bool, controller_base_uri: str, control_obs: bool, obs_url: str,
+                    use_controller: bool, controller_base_uri: str, control_obs: bool, obs_url: str, obs_source_name: str,
                     resolution: str, debug_screenshot: bool,
                     min_iterations_on_player: int, max_iterations_on_player: int,
                     max_iterations_on_default_camera_view: int, lockup_iterations_on_spawn_menu: int):
@@ -63,6 +64,7 @@ def set_options(self, player_name: str, player_pass: str, server_ip: str, server
         self.__controller_base_uri = controller_base_uri
         self.__control_obs = control_obs
         self.__obs_url = obs_url
+        self.__obs_source_name = obs_source_name
 
         self.__resolution = resolution
 
@@ -139,6 +141,9 @@ def control_obs(self) -> bool:
     def get_obs_url(self) -> str:
         return self.__obs_url
 
+    def get_obs_source_name(self) -> str:
+        return self.__obs_source_name
+
     def get_resolution(self) -> str:
         return self.__resolution
 

BF2AutoSpectator/remote/obs_client.py

@@ -1,9 +1,11 @@
+from dataclasses import dataclass
 from typing import Optional
 from urllib.parse import urlparse
 
 import obsws_python as obs
 
 from BF2AutoSpectator.common.exceptions import ClientNotConnectedException
+from BF2AutoSpectator.common.logger import logger
 
 
 class OBSClient:
@@ -46,6 +48,26 @@ def stop_stream(self) -> None:
 
         self.obs.stop_stream()
 
+    def set_capture_window(self, input_name: str, executable: str, title: str) -> None:
+        self.__ensure_connected()
+
+        resp = self.__try_get_input_settings(input_name)
+        if resp is not None and resp.input_settings.get('capture_mode') == 'window':
+            self.obs.set_input_settings(input_name, {
+                'window': self.__format_window_title(executable, title)
+            }, True)
+
+    def __try_get_input_settings(self, input_name: str) -> Optional[dataclass]:
+        try:
+            return self.obs.get_input_settings(input_name)
+        except obs.reqs.OBSSDKRequestError as e:
+            logger.error(f'Failed to get input settings: {e}')
+
     def __ensure_connected(self) -> None:
         if not hasattr(self, 'obs'):
             raise ClientNotConnectedException('OBSClient is not connected')
+
+    @staticmethod
+    def __format_window_title(executable: str, title: str) -> str:
+        escaped = title.replace(':', '#3A')
+        return f'{escaped}:{escaped}:{executable}'

BF2AutoSpectator/spectate.py

@@ -46,6 +46,7 @@ def run():
     parser.add_argument('--controller-base-uri', help='Base uri of web controller', type=str)
     parser.add_argument('--control-obs', dest='control_obs', action='store_true')
     parser.add_argument('--obs-url', help='OBS WebSocket URL in format "ws://:password@hostname:port"', type=str)
+    parser.add_argument('--obs-source-name', help='OBS game source name', type=str, default='Battlefield 2')
     parser.add_argument('--no-rtl-limit', dest='limit_rtl', action='store_false')
     parser.add_argument('--debug-log', dest='debug_log', action='store_true')
     parser.add_argument('--debug-screenshot', dest='debug_screenshot', action='store_true')
@@ -72,6 +73,7 @@ def run():
         controller_base_uri=args.controller_base_uri,
         control_obs=args.control_obs,
         obs_url=args.obs_url,
+        obs_source_name=args.obs_source_name,
         resolution=args.game_res,
         debug_screenshot=args.debug_screenshot,
         min_iterations_on_player=args.min_iterations_on_player,
@@ -128,8 +130,10 @@ def run():
     logger.info('Looking for an existing game instance')
     got_instance, correct_params, *_ = gim.find_instance(config.get_server_mod())
 
-    # Schedule restart if no instance was started/found
-    if not got_instance:
+    if got_instance and config.control_obs():
+        logger.debug('Found existing game window, updating OBS capture window')
+        obsc.set_capture_window(config.get_obs_source_name(), constants.BF2_EXE, gim.game_window.title)
+    elif not got_instance:
         logger.info('Did not find any existing game instance, will launch a new one')
         gis.set_error_restart_required(True)
     elif not correct_params:
@@ -342,7 +346,10 @@ def run():
                 logger.warning(f'Game restart itself with a different mod, updating config')
                 config.set_server_mod(running_mod)
 
-            if not got_instance:
+            if got_instance and correct_params and config.control_obs():
+                logger.debug('Game instance launched, updating OBS capture window')
+                obsc.set_capture_window(config.get_obs_source_name(), constants.BF2_EXE, gim.game_window.title)
+            elif not got_instance:
                 logger.error('Game instance was not launched, retrying')
                 continue
             elif not correct_params: