Reformat code, add config access and duplicate source

Author: upgradeQ

README.md

@@ -1,89 +1,89 @@
-import obspython as obs
+import obspython as S
 from contextlib import contextmanager
 from random import randint
 
 # auto release context managers
 @contextmanager
 def source_ar(source_name):
-    source = obs.obs_get_source_by_name(source_name)
+    source = S.obs_get_source_by_name(source_name)
     try:
         yield source
     finally:
-        obs.obs_source_release(source)
+        S.obs_source_release(source)
 
 
 @contextmanager
 def source_create_ar(id, source_name, settings):
     try:
-        _source = obs.obs_source_create(id, source_name, settings, None)
+        _source = S.obs_source_create(id, source_name, settings, None)
         yield _source
     finally:
-        obs.obs_source_release(_source)
+        S.obs_source_release(_source)
 
 
 @contextmanager
 def scene_create_ar(name):
     try:
-        _scene = obs.obs_scene_create(name)
+        _scene = S.obs_scene_create(name)
         yield _scene
     finally:
-        obs.obs_scene_release(_scene)
+        S.obs_scene_release(_scene)
 
 
 @contextmanager
 def data_ar(source_settings=None):
     if not source_settings:
-        settings = obs.obs_data_create()
+        settings = S.obs_data_create()
     if source_settings:
-        settings = obs.obs_source_get_settings(source_settings)
+        settings = S.obs_source_get_settings(source_settings)
     try:
         yield settings
     finally:
-        obs.obs_data_release(settings)
+        S.obs_data_release(settings)
 
 
 @contextmanager
 def scene_from_source_ar(source):
-    source = obs.obs_scene_from_source(source)
+    source = S.obs_scene_from_source(source)
     try:
         yield source
     finally:
-        obs.obs_scene_release(source)
+        S.obs_scene_release(source)
 
 
 def add_random_text_source(scene):
     r = " random text # " + str(randint(0, 10))
     with data_ar() as settings:
-        obs.obs_data_set_string(settings, "text", f"random text value {r}")
+        S.obs_data_set_string(settings, "text", f"random text value {r}")
         with source_create_ar("text_ft2_source", f"random text{r}", settings) as source:
-            pos = obs.vec2()
+            pos = S.vec2()
             pos.x = randint(0, 1920)
             pos.y = randint(0, 1080)
-            scene_item = obs.obs_scene_add(scene, source)
-            obs.obs_sceneitem_set_pos(scene_item, pos)
+            scene_item = S.obs_scene_add(scene, source)
+            S.obs_sceneitem_set_pos(scene_item, pos)
 
 
 def add_scene_with_sources():
-    current_scene_source = obs.obs_frontend_get_current_scene()
+    current_scene_source = S.obs_frontend_get_current_scene()
     with scene_from_source_ar(current_scene_source) as scene_source:
         with scene_create_ar("_nested_scene") as _scene:
-            py_scene_source = obs.obs_scene_get_source(_scene)
+            py_scene_source = S.obs_scene_get_source(_scene)
 
             with scene_from_source_ar(py_scene_source) as scene:
                 add_random_text_source(scene)
                 add_random_text_source(scene)
                 add_random_text_source(scene)
 
             # add created scene to current scene ( nested scene)
-            _scene_source = obs.obs_scene_get_source(scene)
-            obs.obs_scene_add(scene_source, _scene_source)
+            _scene_source = S.obs_scene_get_source(scene)
+            S.obs_scene_add(scene_source, _scene_source)
 
 
 def callback(*p):
     add_scene_with_sources()
 
 
 def script_properties():
-    props = obs.obs_properties_create()
-    obs.obs_properties_add_button(props, "button1", "add to current scene", callback)
+    props = S.obs_properties_create()
+    S.obs_properties_add_button(props, "button1", "add to current scene", callback)
     return props

src/add_nested.py

@@ -1,16 +1,16 @@
-import obspython as obs
+import obspython as S
 from contextlib import contextmanager
 
 G = lambda: ...
 
 
 @contextmanager
 def source_auto_release(source_name):
-    source = obs.obs_get_source_by_name(source_name)
+    source = S.obs_get_source_by_name(source_name)
     try:
         yield source
     finally:
-        obs.obs_source_release(source)
+        S.obs_source_release(source)
 
 
 def get_modifiers(key_modifiers):
@@ -24,27 +24,27 @@ def get_modifiers(key_modifiers):
     modifiers = 0
 
     if shift:
-        modifiers |= obs.INTERACT_SHIFT_KEY
+        modifiers |= S.INTERACT_SHIFT_KEY
     if control:
-        modifiers |= obs.INTERACT_CONTROL_KEY
+        modifiers |= S.INTERACT_CONTROL_KEY
     if alt:
-        modifiers |= obs.INTERACT_ALT_KEY
+        modifiers |= S.INTERACT_ALT_KEY
     if command:
-        modifiers |= obs.INTERACT_COMMAND_KEY
+        modifiers |= S.INTERACT_COMMAND_KEY
     return modifiers
 
 
 def send_hotkey_to_browser(source, obs_htk_id, key_modifiers=None, key_up=False):
 
-    key = obs.obs_key_from_name(obs_htk_id)
-    vk = obs.obs_key_to_virtual_key(key)
-    event = obs.obs_key_event()
+    key = S.obs_key_from_name(obs_htk_id)
+    vk = S.obs_key_to_virtual_key(key)
+    event = S.obs_key_event()
     event.native_vkey = vk
     event.modifiers = get_modifiers(key_modifiers)
     event.native_modifiers = event.modifiers  # https://doc.qt.io/qt-5/qkeyevent.html
     event.native_scancode = vk
     event.text = ""
-    obs.obs_source_send_key_click(source, event, key_up)
+    S.obs_source_send_key_click(source, event, key_up)
 
 
 def press_tab(*p):
@@ -63,16 +63,16 @@ def send_mouse_click_to_browser(
     source,
     x=0,
     y=0,
-    button_type=obs.MOUSE_LEFT,
+    button_type=S.MOUSE_LEFT,
     mouse_up=False,
     click_count=1,
     key_modifiers=None,
 ):
-    event = obs.obs_mouse_event()
+    event = S.obs_mouse_event()
     event.modifiers = get_modifiers(key_modifiers)
     event.x = x
     event.y = y
-    obs.obs_source_send_mouse_click(source, event, button_type, mouse_up, click_count)
+    S.obs_source_send_mouse_click(source, event, button_type, mouse_up, click_count)
 
 
 def send_mouse_move_to_browser(
@@ -81,11 +81,11 @@ def send_mouse_move_to_browser(
     y=0,
     key_modifiers=None,
 ):
-    event = obs.obs_mouse_event()
+    event = S.obs_mouse_event()
     event.modifiers = get_modifiers(key_modifiers)
     event.x = x
     event.y = y
-    obs.obs_source_send_mouse_move(source, event, False)  # do not leave
+    S.obs_source_send_mouse_move(source, event, False)  # do not leave
 
 
 def move_mouse0(*p):
@@ -105,30 +105,30 @@ def click_at(*p):
 
 
 def script_update(settings):
-    G.source_name = obs.obs_data_get_string(settings, "source")
+    G.source_name = S.obs_data_get_string(settings, "source")
 
 
 def script_properties():  # ui
-    props = obs.obs_properties_create()
-    p = obs.obs_properties_add_list(
+    props = S.obs_properties_create()
+    p = S.obs_properties_add_list(
         props,
         "source",
         "Browser source",
-        obs.OBS_COMBO_TYPE_EDITABLE,
-        obs.OBS_COMBO_FORMAT_STRING,
+        S.OBS_COMBO_TYPE_EDITABLE,
+        S.OBS_COMBO_FORMAT_STRING,
     )
-    obs.obs_properties_add_button(props, "button1", "Press tab", press_tab)
-    obs.obs_properties_add_button(props, "button2", "Press shift+tab", press_shift_tab)
-    obs.obs_properties_add_button(props, "button3", "Send LMB at [100,200]", click_at)
-    obs.obs_properties_add_button(props, "button4", "Move to 0,0 ", move_mouse0)
-    obs.obs_properties_add_button(props, "button5", "Move to 100,200 ", move_mouse1)
-    sources = obs.obs_enum_sources()
+    S.obs_properties_add_button(props, "button1", "Press tab", press_tab)
+    S.obs_properties_add_button(props, "button2", "Press shift+tab", press_shift_tab)
+    S.obs_properties_add_button(props, "button3", "Send LMB at [100,200]", click_at)
+    S.obs_properties_add_button(props, "button4", "Move to 0,0 ", move_mouse0)
+    S.obs_properties_add_button(props, "button5", "Move to 100,200 ", move_mouse1)
+    sources = S.obs_enum_sources()
     if sources is not None:
         for source in sources:
-            source_id = obs.obs_source_get_unversioned_id(source)
+            source_id = S.obs_source_get_unversioned_id(source)
             if source_id == "browser_source":
-                name = obs.obs_source_get_name(source)
-                obs.obs_property_list_add_string(p, name, name)
+                name = S.obs_source_get_name(source)
+                S.obs_property_list_add_string(p, name, name)
 
-        obs.source_list_release(sources)
+        S.source_list_release(sources)
     return props

src/browser_source_interaction.py

@@ -1,18 +1,18 @@
-import obspython as obs
+import obspython as S
 import threading
 from time import sleep
 
 
 def hook(obs_htk_id, htk_id, callback):
     json_data = '{"%s":[{"key":"%s"}]}' % (htk_id, obs_htk_id)
-    s = obs.obs_data_create_from_json(json_data)
+    s = S.obs_data_create_from_json(json_data)
 
-    a = obs.obs_data_get_array(s, htk_id)
-    h = obs.obs_hotkey_register_frontend(htk_id, obs_htk_id, callback)
-    obs.obs_hotkey_load(h, a)
+    a = S.obs_data_get_array(s, htk_id)
+    h = S.obs_hotkey_register_frontend(htk_id, obs_htk_id, callback)
+    S.obs_hotkey_load(h, a)
 
-    obs.obs_data_array_release(a)
-    obs.obs_data_release(s)
+    S.obs_data_array_release(a)
+    S.obs_data_release(s)
 
 
 data = lambda: ...
@@ -42,6 +42,6 @@ def busy_thread():
 
 print('Press the "~" to toggle on/off')
 hook("OBS_KEY_ASCIITILDE", "id_", callback)
-obs.timer_add(lambda: print(data.status), 500)
+S.timer_add(lambda: print(data.status), 500)
 t = threading.Thread(target=busy_thread)
 t.start()