Sync with latest DNEG internal repo

Author: tedwaine

.gitignore

@@ -3,9 +3,10 @@
 ._*
 .gitignore
 .vscode/
+build_*
 __*__
 ignore/
-python/src/xstudio.egg-info/
+*.egg-info/
 python/test/xstudio.log
 docs/conf.py
 python/src/xstudio/version.py

CMakeLists.txt

@@ -22,18 +22,18 @@ option(USE_VCPKG "Use Vcpkg for package management" OFF)
 option(BUILD_PYSIDE_WIDGETS "Build xstudio player as PySide widget" OFF)
 
 if(WIN32)
-    set(USE_VCPKG ON)
-    #include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules/vcpkg.cmake)
-    set(CMAKE_CXX_FLAGS_DEBUG "/Zi /Ob0 /Od /Oy-")
-    add_compile_options($<$<CXX_COMPILER_ID:MSVC>:/MP>)
-    # enable UUID System Generator
-    add_definitions(-DUUID_SYSTEM_GENERATOR=ON)
+  set(USE_VCPKG ON)
+  #include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules/vcpkg.cmake)
+  set(CMAKE_CXX_FLAGS_DEBUG "/Zi /Ob0 /Od /Oy-")
+  add_compile_options($<$<CXX_COMPILER_ID:MSVC>:/MP>)
+  # enable UUID System Generator
+  add_definitions(-DUUID_SYSTEM_GENERATOR=ON)
 endif()
 
 set(STUDIO_PLUGINS "" CACHE STRING "Enable compilation of SITE plugins")
 
 if (("${CMAKE_GENERATOR}" MATCHES "Makefiles" OR ("${CMAKE_GENERATOR}" MATCHES "Ninja" AND NOT WIN32)) AND NOT __CHECKED_CXX_FLAGS)
-    set(__CHECKED_CXX_FLAGS TRUE CACHE INTERNAL "Whether we checked the CXX flags already")
+  set(__CHECKED_CXX_FLAGS TRUE CACHE INTERNAL "Whether we checked the CXX flags already")
 	set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} ${COMMON_GCC}" CACHE STRING "" FORCE)
 	set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} ${COMMON_GCC}" CACHE STRING "" FORCE)
 	set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} ${COMMON_GCC}" CACHE STRING "" FORCE)
@@ -295,7 +295,7 @@ if(INSTALL_XSTUDIO)
 
 endif ()
 
-if(USE_VCPKG)
+if (USE_VCPKG)
   # To provide reliable ordering, we need to make this install script happen in a subdirectory.
   # Otherwise, Qt deploy will happen before we have the rest of the application deployed.
   add_subdirectory("scripts/qt_install")
@@ -343,11 +343,11 @@ if (WIN32)
       WriteRegStr HKCR 'XStudioSession\\\\DefaultIcon' \\\\
                         '' '$INSTDIR\\\\bin\\\\xstudio.exe,0'
       WriteRegStr HKCR 'XStudioSession\\\\shell\\\\open\\\\command' \\\\
-                        '' '$INSTDIR\\\\bin\\\\xstudio.exe \\"%1\\"'
+                        '' '$INSTDIR\\\\bin\\\\xstudio.exe \\\"%1\\\"'
       WriteRegStr HKCR 'XStudioSession\\\\shell\\\\edit' \\\\
                         '' 'Edit xSTUDIO Session File'
       WriteRegStr HKCR 'XStudioSession\\\\shell\\\\edit\\\\command' \\\\
-                        '' '$INSTDIR\\\\bin\\\\xstudio.exe \\"%1\\"'
+                        '' '$INSTDIR\\\\bin\\\\xstudio.exe \\\"%1\\\"'
       System::Call \\\\
         'Shell32::SHChangeNotify(i 0x8000000, i 0, i 0, i 0)'
       ")

docs/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "xStudio"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "1.1.0"
+PROJECT_NUMBER         = "0.0.0"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

docs/conf.py

@@ -76,9 +76,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.1.0'
+version = '0.0.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.1.0'
+release = '0.0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

extern/otio/OpenTimelineIO

@@ -59,6 +59,7 @@ namespace bookmark {
     class AnnotationBase;
     struct BookmarkDetail;
     struct BookmarkAndAnnotation;
+    typedef std::shared_ptr<const AnnotationBase> AnnotationBasePtr;
     typedef std::shared_ptr<const BookmarkAndAnnotation> BookmarkAndAnnotationPtr;
 } // namespace bookmark
 
@@ -183,7 +184,7 @@ CAF_ALLOW_UNSAFE_MESSAGE_TYPE(httplib::Response)
 CAF_ALLOW_UNSAFE_MESSAGE_TYPE(std::shared_ptr<const xstudio::module::Attribute>)
 CAF_ALLOW_UNSAFE_MESSAGE_TYPE(xstudio::utility::BlindDataObjectPtr)
 CAF_ALLOW_UNSAFE_MESSAGE_TYPE(xstudio::utility::BlindDataObjectPtrVec)
-CAF_ALLOW_UNSAFE_MESSAGE_TYPE(std::shared_ptr<xstudio::bookmark::AnnotationBase>)
+CAF_ALLOW_UNSAFE_MESSAGE_TYPE(xstudio::bookmark::AnnotationBasePtr)
 CAF_ALLOW_UNSAFE_MESSAGE_TYPE(std::shared_ptr<xstudio::colour_pipeline::ColourPipeline>)
 CAF_ALLOW_UNSAFE_MESSAGE_TYPE(std::shared_ptr<xstudio::media::AVFrameID>)
 CAF_ALLOW_UNSAFE_MESSAGE_TYPE(std::shared_ptr<xstudio::media_reader::AudioBuffer>)
@@ -331,7 +332,8 @@ CAF_BEGIN_TYPE_ID_BLOCK(xstudio_complex_types, FIRST_CUSTOM_ID + 200)
     CAF_ADD_TYPE_ID(xstudio_complex_types, (std::shared_ptr<const xstudio::module::Attribute>))
     CAF_ADD_TYPE_ID(xstudio_complex_types, (xstudio::utility::BlindDataObjectPtr))
     CAF_ADD_TYPE_ID(xstudio_complex_types, (xstudio::utility::BlindDataObjectPtrVec))
-    CAF_ADD_TYPE_ID(xstudio_complex_types, (std::shared_ptr<xstudio::bookmark::AnnotationBase>))
+    CAF_ADD_TYPE_ID(xstudio_complex_types, (xstudio::bookmark::AnnotationBasePtr))
+    CAF_ADD_TYPE_ID(xstudio_complex_types, (std::vector<xstudio::bookmark::AnnotationBasePtr>))
     CAF_ADD_TYPE_ID(xstudio_complex_types, (std::shared_ptr<xstudio::colour_pipeline::ColourPipeline>))
     CAF_ADD_TYPE_ID(xstudio_complex_types, (std::shared_ptr<xstudio::media::AVFrameID>))
     CAF_ADD_TYPE_ID(xstudio_complex_types, (std::shared_ptr<xstudio::media_reader::AudioBuffer>))
@@ -592,6 +594,7 @@ CAF_BEGIN_TYPE_ID_BLOCK(xstudio_session_atoms, FIRST_CUSTOM_ID + (200 * 4))
     CAF_ADD_ATOM(xstudio_session_atoms, xstudio::bookmark, build_annotation_atom)
     CAF_ADD_ATOM(xstudio_session_atoms, xstudio::bookmark, default_category_atom)
     CAF_ADD_ATOM(xstudio_session_atoms, xstudio::bookmark, get_annotation_atom)
+    CAF_ADD_ATOM(xstudio_session_atoms, xstudio::bookmark, annotation_data_atom)
     CAF_ADD_ATOM(xstudio_session_atoms, xstudio::bookmark, get_bookmark_atom)
     CAF_ADD_ATOM(xstudio_session_atoms, xstudio::bookmark, get_bookmarks_atom)
     CAF_ADD_ATOM(xstudio_session_atoms, xstudio::bookmark, remove_bookmark_atom)
@@ -619,7 +622,9 @@ CAF_BEGIN_TYPE_ID_BLOCK(xstudio_session_atoms, FIRST_CUSTOM_ID + (200 * 4))
     CAF_ADD_ATOM(xstudio_session_atoms, xstudio::media, relink_atom)
     CAF_ADD_ATOM(xstudio_session_atoms, xstudio::media, rescan_atom)
     CAF_ADD_ATOM(xstudio_session_atoms, xstudio::media, source_offset_frames_atom)
+    CAF_ADD_ATOM(xstudio_session_atoms, xstudio::media, rotation_atom)
     CAF_ADD_ATOM(xstudio_session_atoms, xstudio::media, pixel_aspect_atom)
+    CAF_ADD_ATOM(xstudio_session_atoms, xstudio::media, transform_matrix_atom)
     CAF_ADD_ATOM(xstudio_session_atoms, xstudio::media_metadata, get_metadata_atom)
     CAF_ADD_ATOM(xstudio_session_atoms, xstudio::playlist, add_media_atom)
     CAF_ADD_ATOM(xstudio_session_atoms, xstudio::playlist, add_media_with_subsets_atom)

include/xstudio/atoms.hpp

@@ -3,6 +3,7 @@
 
 #include <chrono>
 
+#include "xstudio/audio/enums.hpp"
 #include "xstudio/media_reader/media_reader.hpp"
 #include "xstudio/module/module.hpp"
 #include "xstudio/utility/chrono.hpp"
@@ -13,6 +14,43 @@ namespace xstudio::audio {
 
 enum AudioBehaviourOnSilence { StopPushingSamplesOnSilence, ContinuePushingSamplesOnSilence };
 
+
+static inline std::map<std::string, ScrubBehaviour> scrubBehaviourMap = {
+    {"1 Frame", OneFrame},
+    {"1.25 Frames", OnePt25Frames},
+    {"1.5 Frames", OnePt5Frames},
+    {"2 Frames", TwoFrames},
+    {"3 Frames", ThreeFrames},
+    {"1/24th Sec", OneFrameAt24Fps},
+    {"1/30th Sec", OneFrameAt30Fps},
+    {"1/60th Sec", OneFrameAt60Fps},
+    {"Custom Duration", Custom},
+};
+
+struct ScrubHelper {
+
+    ScrubHelper() = default;
+
+    void set_custom_duration_ms(const int ms) { 
+        scrub_window_millisecs_ = ms; 
+    }
+    void set_behaviour(const std::string &behaviour) { 
+        const auto p = scrubBehaviourMap.find(behaviour);
+        if (p != scrubBehaviourMap.end()) scrub_behaviour_= p->second;
+        else scrub_behaviour_ = ScrubBehaviour::OneFrame;
+    }
+
+    timebase::flicks scrub_duration(const utility::FrameRate & media_rate) const;
+    double scrub_duration_secs(const utility::FrameRate & media_rate) const {
+        return timebase::to_seconds(scrub_duration(media_rate));
+    }
+
+    private:
+    int scrub_window_millisecs_        = {50};
+    ScrubBehaviour scrub_behaviour_    = {OneFrame};
+
+};
+
 /**
  *  @brief Class for delivering audio to soundcard by maintaining a smoothed
  *  measurment of the playhead position and re-sampling audio sources as
@@ -22,6 +60,8 @@ enum AudioBehaviourOnSilence { StopPushingSamplesOnSilence, ContinuePushingSampl
 class AudioOutputControl {
 
   public:
+
+
     /**
      *  @brief Constructor
      *
@@ -55,13 +95,14 @@ class AudioOutputControl {
      *  @brief The audio volume (range is 0-100)
      */
     [[nodiscard]] float volume() const {
-        return override_volume_ == -1.0f ? volume_ : override_volume_;
+        return (override_volume_ == -1.0f ? volume_ : override_volume_) * playhead_volume_ /
+               100.0f;
     }
 
     /**
      *  @brief The audio volume muted
      */
-    [[nodiscard]] bool muted() const { return muted_; }
+    [[nodiscard]] bool muted() const { return override_volume_ == -1.0f ? muted_ : false; }
 
     /**
      *   @brief Queue audio buffer for streaming to the soundcard
@@ -81,6 +122,8 @@ class AudioOutputControl {
      */
     void playhead_position_changed(
         const timebase::flicks playhead_position,
+        const timebase::flicks playhead_loop_in,
+        const timebase::flicks playhead_loop_out,
         const bool forward,
         const float velocity,
         const bool playing,
@@ -101,11 +144,15 @@ class AudioOutputControl {
         const float volume,
         const bool muted,
         const bool audio_repitch,
-        const bool audio_scrubbing) {
-        volume_          = volume;
-        muted_           = muted;
-        audio_repitch_   = audio_repitch;
-        audio_scrubbing_ = audio_scrubbing;
+        const bool audio_scrubbing,
+        const std::string & scrub_behaviour,
+        const int scrub_window_millisecs) {
+        volume_                 = volume;
+        muted_                  = muted;
+        audio_repitch_          = audio_repitch;
+        audio_scrubbing_        = audio_scrubbing;
+        scrub_helper_.set_behaviour(scrub_behaviour);
+        scrub_helper_.set_custom_duration_ms(scrub_window_millisecs);
     }
 
     void set_override_volume(const float override_volume) {
@@ -138,6 +185,8 @@ class AudioOutputControl {
     int fade_in_out_ = {NoFade};
 
     timebase::flicks playhead_position_;
+    timebase::flicks playhead_loop_in_ = {timebase::flicks(std::numeric_limits<timebase::flicks::rep>::lowest())};
+    timebase::flicks playhead_loop_out_ = {timebase::flicks(std::numeric_limits<timebase::flicks::rep>::max())};
     bool playing_forward_ = {true};
     utility::time_point playhead_position_update_tp_;
     timebase::flicks last_buffer_pts_;
@@ -148,8 +197,11 @@ class AudioOutputControl {
     bool muted_                        = {false};
     bool playing_                      = {false};
     float override_volume_             = {-1.0f};
+    float playhead_volume_             = {100.0f};
     float last_volume_                 = {100.0f};
     float scrub_chunk_duration_frames_ = {1.0f};
     bool apply_global_volume_          = {true};
+
+    ScrubHelper scrub_helper_;
 };
 } // namespace xstudio::audio

include/xstudio/audio/audio_output.hpp

@@ -250,7 +250,10 @@ class GlobalAudioOutputActor : public caf::event_based_actor, module::Module {
     module::BooleanAttribute *audio_scrubbing_;
     module::FloatAttribute *volume_;
     module::BooleanAttribute *muted_;
+    module::StringAttribute *scrub_behaviour_;
+    module::IntegerAttribute *scrub_window_millisecs_;
     utility::Uuid mute_hotkey_;
+    utility::Uuid audio_scrubbing_hotkey_;
     std::map<utility::Uuid, caf::actor> independent_outputs_;
 };
 

include/xstudio/audio/audio_output_actor.hpp

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: Apache-2.0
+#pragma once
+
+namespace xstudio {
+namespace audio {
+// maps to options in preference /core/audio/audio_scrub_duration
+enum ScrubBehaviour { 
+    OneFrame, 
+    OnePt25Frames,
+    OnePt5Frames,
+    TwoFrames,
+    ThreeFrames,
+    OneFrameAt24Fps,
+    OneFrameAt30Fps,
+    OneFrameAt60Fps,
+    Custom
+ };
+} // namespace audio
+} // namespace xstudio

include/xstudio/audio/enums.hpp

@@ -31,13 +31,15 @@ namespace bookmark {
         }
         utility::Uuid bookmark_uuid_;
 
+        virtual const void * user_data() const { return nullptr; }
+
         virtual size_t hash() const { return 0; }
 
       private:
         utility::JsonStore store_;
     };
 
-    typedef std::shared_ptr<AnnotationBase> AnnotationBasePtr;
+    typedef std::shared_ptr<const AnnotationBase> AnnotationBasePtr;
 
     class Note {
       public:
@@ -335,15 +337,15 @@ namespace bookmark {
         utility::sys_time_point created_{utility::sysclock::now()};
 
         std::shared_ptr<Note> note_{nullptr};
-        std::shared_ptr<AnnotationBase> annotation_{nullptr};
+        AnnotationBasePtr annotation_;
     };
 
     /* This struct is used by Playhead classes as a convenient way to maintain
     a record of bookmarks, attached annotation data and a logical frame range*/
     struct BookmarkAndAnnotation {
 
         BookmarkDetail detail_;
-        std::shared_ptr<AnnotationBase> annotation_;
+        AnnotationBasePtr annotation_;
         int start_frame_ = 0;
         int end_frame_   = 240;
     };