Some useful feature extensions for Python API

Signed-off-by: Ted Waine <[email protected]>

Author: tedwaine

CMakeLists.txt

@@ -197,7 +197,7 @@ if (USE_VCPKG)
     message(FATAL_ERROR "Failed to ensurepip.")
   else()
     execute_process(
-      COMMAND "${Python_EXECUTABLE}" -m pip install setuptools sphinx breathe sphinx-rtd-theme OpenTimelineIO OpenTimelineIO-Plugins importlib_metadata zipp
+      COMMAND "${Python_EXECUTABLE}" -m pip install setuptools sphinx breathe sphinx-rtd-theme OpenTimelineIO-Plugins importlib_metadata zipp
       RESULT_VARIABLE PIP_RESULT
     )
     if(PIP_RESULT)

CMakePresets.json

@@ -7,7 +7,7 @@
       "binaryDir": "${sourceDir}/build",
       "cacheVariables": {
         "CMAKE_TOOLCHAIN_FILE": "${sourceDir}/../vcpkg/scripts/buildsystems/vcpkg.cmake",
-        "Qt6_DIR": "C:/Qt6/6.5.3/msvc2019_64/lib/cmake/Qt6",
+        "Qt6_DIR": "/Users/tedwaine/Qt6/6.5.3/macos/lib/cmake/Qt6",
         "CMAKE_INSTALL_PREFIX": "xstudio_install",
         "X_VCPKG_APPLOCAL_DEPS_INSTALL": "ON",
         "BUILD_DOCS": "OFF",

docs/python_api/core.rst

@@ -101,12 +101,6 @@ Uuid
    :members:
    :undoc-members:
 
-UuidVec
-=======
-.. autoclass:: xstudio.core.__pybind_xstudio.UuidVec
-   :members:
-   :undoc-members:
-
 absolute_receive_timeout
 ========================
 .. autoclass:: xstudio.core.__pybind_xstudio.absolute_receive_timeout

docs/python_api/sync.rst

@@ -8,10 +8,14 @@ xSTUDIO User Guide
     IMPORANT: These docs are out of date and refer to the v0.X release series of xSTUDIO.
     Updated documentation for v1.X is work-in-progress and will be available August 2025.
 
+
+
 .. image:: ./images/xstudio-logo.png
    :scale: 80 %
    :align: center
 
+
+
 .. note::
      The screenshots included in this user guide show visual content from the 'Meridian' title, part of the `Netflix Open Content <https://opencontent.netflix.com/>`_ media data set. 
 

docs/user_docs/index.rst

@@ -4,10 +4,16 @@ set(OTIO_INSTALL_PYTHON_MODULES ON)
 set(OTIO_INSTALL_COMMANDLINE_TOOLS OFF)
 set(OTIO_FIND_IMATH ON)
 set(OTIO_PYTHON_INSTALL_DIR python)
-set(CMAKE_INSTALL_PREFIX "bin/python")
+
+if (APPLE)
+    #install directly into VCPKG pythin installation. This gets copied into xSTUDIO.app installation
+    set(CMAKE_INSTALL_PREFIX "${VCPKG_INSTALLED_DIR}/${VCPKG_TARGET_TRIPLET}/lib/${PYTHONVP}/site-packages")
+else()
+    set(CMAKE_INSTALL_PREFIX "bin/python")
+endif()
 
 # Build options
-set(OTIO_SHARED_LIBS OFF)
+set(OTIO_SHARED_LIBS ON)
 set(OTIO_AUTOMATIC_SUBMODULES ON)
 
 find_package(Python COMPONENTS Interpreter Development)

extern/otio/CMakeLists.txt

@@ -558,6 +558,8 @@ CAF_BEGIN_TYPE_ID_BLOCK(xstudio_plugin_atoms,  FIRST_CUSTOM_ID + (200 * 3))
     CAF_ADD_ATOM(xstudio_plugin_atoms, xstudio::conform, conform_tasks_atom)
     CAF_ADD_ATOM(xstudio_plugin_atoms, xstudio::media_hook, get_clip_hook_atom)
 
+    CAF_ADD_ATOM(xstudio_plugin_atoms, xstudio::plugin, plugin_events_group_atom)    
+
 CAF_END_TYPE_ID_BLOCK(xstudio_plugin_atoms)
 
 
@@ -862,6 +864,9 @@ CAF_BEGIN_TYPE_ID_BLOCK(xstudio_ui_atoms,  FIRST_CUSTOM_ID + (200 * 6))
 
     CAF_ADD_ATOM(xstudio_ui_atoms, xstudio::ui, set_clipboard_atom)
 
+    CAF_ADD_ATOM(xstudio_ui_atoms, xstudio::ui::viewport, annotation_atom)
+
+
 CAF_END_TYPE_ID_BLOCK(xstudio_ui_atoms)
 
 // clang-format on

include/xstudio/atoms.hpp

@@ -206,6 +206,10 @@ namespace plugin {
 
         void remove_bookmark(const utility::Uuid &bookmark_id);
 
+        /* Get the (unique) name of the current, active viewport in xSTUDIO's
+        main UI window. */
+        std::string active_viewport_name() const;
+
         /* set playback state for playhead attached to the named viewport */
         void start_stop_playback(const std::string viewport_name, bool play);
 
@@ -228,6 +232,10 @@ namespace plugin {
         on_playhead_playing_changed callbacks. */
         void listen_to_playhead_events(const bool listen = true);
 
+        /* Access the plugin events group to broadcast events to other entities
+        that may want to interact with the plugin*/
+        caf::actor & plugin_events_group() { return plugin_events_; }
+
       private:
         // re-implement to receive callback when the on-screen media changes. To
         void on_screen_media_changed(caf::actor media) override;
@@ -247,6 +255,7 @@ namespace plugin {
         caf::actor_addr playhead_media_events_group_;
         caf::actor bookmark_manager_;
         caf::actor playhead_events_actor_;
+        caf::actor plugin_events_;
         bool joined_playhead_events_ = {false};
         std::map<std::string, utility::Uuid> last_source_uuid_;
 

include/xstudio/plugin_manager/plugin_base.hpp

@@ -301,6 +301,7 @@ namespace timeline {
         }
 
         void resolve_and_request_clip_frames(
+            const timebase::flicks timeline_start,
             caf::actor &helper,
             std::vector<bool> &filled_frames,
             const timebase::flicks ref_time,

include/xstudio/timeline/item.hpp

@@ -121,7 +121,7 @@ namespace ui {
                 float softness,
                 float opacity);
             void start_erase_stroke(float thickness);
-            void update_stroke(const Imath::V2f &pt);
+            void update_stroke(const Imath::V2f &pt, const float size = -1.0f);
             // Delete the strokes when reaching 0 opacity.
             bool fade_all_strokes(float opacity);