Add native score-to-video sync

src/CMakeLists.txt

@@ -18,6 +18,10 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
+if (MUE_BUILD_PLAYBACK_MODULE)
+    find_package(Qt6 COMPONENTS Multimedia QUIET)
+endif()
+
 # Modules must be listed in dependency order
 if (MUE_BUILD_BRAILLE_MODULE)
     add_subdirectory(braille)

src/app/configs/data/shortcuts.xml

@@ -771,6 +771,11 @@
     <seq>F12</seq>
     <autorepeat>0</autorepeat>
     </SC>
+  <SC>
+    <key>toggle-video-panel</key>
+    <seq>Ctrl+Alt+V</seq>
+    <autorepeat>0</autorepeat>
+    </SC>
   <SC>
     <key>quit</key>
     <seq>Ctrl+Q</seq>

src/app/configs/data/shortcuts_azerty.xml

@@ -812,6 +812,11 @@
     <seq>F12</seq>
     <autorepeat>0</autorepeat>
     </SC>
+  <SC>
+    <key>toggle-video-panel</key>
+    <seq>Ctrl+Alt+V</seq>
+    <autorepeat>0</autorepeat>
+    </SC>
   <SC>
     <key>quit</key>
     <seq>Ctrl+Q</seq>

src/app/configs/data/shortcuts_mac.xml

@@ -771,6 +771,11 @@
     <seq>F12</seq>
     <autorepeat>0</autorepeat>
     </SC>
+  <SC>
+    <key>toggle-video-panel</key>
+    <seq>Ctrl+Alt+V</seq>
+    <autorepeat>0</autorepeat>
+    </SC>
   <SC>
     <key>quit</key>
     <seq>Ctrl+Q</seq>

src/appshell/appshelltypes.h

@@ -42,6 +42,7 @@ static const DockName MIXER_PANEL_NAME("mixerPanel");
 static const DockName PIANO_KEYBOARD_PANEL_NAME("pianoKeyboardPanel");
 static const DockName TIMELINE_PANEL_NAME("timelinePanel");
 static const DockName PERCUSSION_PANEL_NAME("percussionPanel");
+static const DockName VIDEO_PANEL_NAME("videoPanel");
 
 // Toolbars:
 static const DockName NOTATION_TOOLBAR_NAME("notationToolBar");

src/appshell/internal/applicationuiactions.cpp

@@ -24,6 +24,7 @@
 #include "ui/view/iconcodes.h"
 #include "context/uicontext.h"
 #include "context/shortcutcontext.h"
+#include "project/iprojectvideosettings.h"
 
 #include "dockwindow/idockwindow.h"
 #include "async/notification.h"
@@ -40,6 +41,18 @@ static const ActionCode FULL_SCREEN_CODE("fullscreen");
 static const ActionCode TOGGLE_NAVIGATOR_ACTION_CODE("toggle-navigator");
 static const ActionCode TOGGLE_BRAILLE_ACTION_CODE("toggle-braille-panel");
 static const ActionCode TOGGLE_PERCUSSION_PANEL_ACTION_CODE("toggle-percussion-panel");
+static const ActionCode VIDEO_TIMECODE_OFF_CODE("video-timecode-off");
+static const ActionCode VIDEO_TIMECODE_ABOVE_CODE("video-timecode-above-bars");
+static const ActionCode VIDEO_TIMECODE_BELOW_CODE("video-timecode-below-bars");
+
+static ActionCodeList videoTimecodeActionCodes()
+{
+    return {
+        VIDEO_TIMECODE_OFF_CODE,
+        VIDEO_TIMECODE_ABOVE_CODE,
+        VIDEO_TIMECODE_BELOW_CODE
+    };
+}
 
 const UiActionList ApplicationUiActions::m_actions = {
     UiAction("quit",
@@ -200,6 +213,34 @@ const UiActionList ApplicationUiActions::m_actions = {
              TranslatableString("action", "Show/hide piano keyboard"),
              Checkable::Yes
              ),
+    UiAction("toggle-video-panel",
+             mu::context::UiCtxProjectOpened,
+             mu::context::CTX_ANY,
+             TranslatableString("action", "&Video"),
+             TranslatableString("action", "Show/hide video panel"),
+             Checkable::Yes
+             ),
+    UiAction(VIDEO_TIMECODE_OFF_CODE,
+             mu::context::UiCtxProjectOpened,
+             mu::context::CTX_ANY,
+             TranslatableString("action", "&Off"),
+             TranslatableString("action", "Hide video timecode"),
+             Checkable::Yes
+             ),
+    UiAction(VIDEO_TIMECODE_ABOVE_CODE,
+             mu::context::UiCtxProjectOpened,
+             mu::context::CTX_ANY,
+             TranslatableString("action", "&Above bars"),
+             TranslatableString("action", "Show video timecode above bars"),
+             Checkable::Yes
+             ),
+    UiAction(VIDEO_TIMECODE_BELOW_CODE,
+             mu::context::UiCtxProjectOpened,
+             mu::context::CTX_ANY,
+             TranslatableString("action", "&Below bars"),
+             TranslatableString("action", "Show video timecode below bars"),
+             Checkable::Yes
+             ),
     UiAction(TOGGLE_PERCUSSION_PANEL_ACTION_CODE,
              mu::context::UiCtxProjectOpened,
              mu::context::CTX_NOTATION_OPENED,
@@ -253,6 +294,13 @@ void ApplicationUiActions::init()
     dockWindowProvider()->windowChanged().onNotify(this, [this]() {
         listenOpenedDocksChanged(dockWindowProvider()->window());
     });
+
+    globalContext()->currentProjectChanged().onNotify(this, [this]() {
+        listenCurrentProjectVideoSettings();
+        m_actionCheckedChanged.send(videoTimecodeActionCodes());
+    });
+
+    listenCurrentProjectVideoSettings();
 }
 
 void ApplicationUiActions::listenOpenedDocksChanged(IDockWindow* window)
@@ -294,6 +342,24 @@ bool ApplicationUiActions::actionChecked(const UiAction& act) const
         return mainWindow()->isFullScreen();
     }
 
+    if (act.code == VIDEO_TIMECODE_OFF_CODE || act.code == VIDEO_TIMECODE_ABOVE_CODE || act.code == VIDEO_TIMECODE_BELOW_CODE) {
+        project::INotationProjectPtr project = globalContext()->currentProject();
+        project::IProjectVideoSettingsPtr settings = project ? project->videoSettings() : nullptr;
+        const project::VideoTimecodeDisplayMode mode = settings
+                                                       ? settings->attachment().timecodeDisplayMode
+                                                       : project::VideoTimecodeDisplayMode::Off;
+
+        if (act.code == VIDEO_TIMECODE_OFF_CODE) {
+            return mode == project::VideoTimecodeDisplayMode::Off;
+        }
+
+        if (act.code == VIDEO_TIMECODE_ABOVE_CODE) {
+            return mode == project::VideoTimecodeDisplayMode::AboveBars;
+        }
+
+        return mode == project::VideoTimecodeDisplayMode::BelowBars;
+    }
+
     QMap<ActionCode, DockName> toggleDockActions = ApplicationUiActions::toggleDockActions();
     DockName dockName = toggleDockActions.value(act.code, DockName());
 
@@ -323,6 +389,19 @@ muse::async::Channel<ActionCodeList> ApplicationUiActions::actionCheckedChanged(
     return m_actionCheckedChanged;
 }
 
+void ApplicationUiActions::listenCurrentProjectVideoSettings()
+{
+    project::INotationProjectPtr project = globalContext()->currentProject();
+    project::IProjectVideoSettingsPtr settings = project ? project->videoSettings() : nullptr;
+    if (!settings) {
+        return;
+    }
+
+    settings->settingsChanged().onNotify(this, [this]() {
+        m_actionCheckedChanged.send(videoTimecodeActionCodes());
+    }, Asyncable::Mode::SetReplace);
+}
+
 const QMap<ActionCode, DockName>& ApplicationUiActions::toggleDockActions()
 {
     static const QMap<ActionCode, DockName> actionsMap {
@@ -341,6 +420,7 @@ const QMap<ActionCode, DockName>& ApplicationUiActions::toggleDockActions()
         { "toggle-timeline", TIMELINE_PANEL_NAME },
         { "toggle-mixer", MIXER_PANEL_NAME },
         { "toggle-piano-keyboard", PIANO_KEYBOARD_PANEL_NAME },
+        { "toggle-video-panel", VIDEO_PANEL_NAME },
         { TOGGLE_PERCUSSION_PANEL_ACTION_CODE, PERCUSSION_PANEL_NAME },
 
         { "toggle-statusbar", NOTATION_STATUSBAR_NAME },

src/appshell/internal/applicationuiactions.h

@@ -28,6 +28,7 @@
 #include "async/asyncable.h"
 #include "ui/imainwindow.h"
 #include "braille/ibrailleconfiguration.h"
+#include "context/iglobalcontext.h"
 
 #include "dockwindow/idockwindowprovider.h"
 
@@ -38,6 +39,7 @@ class ApplicationUiActions : public muse::ui::IUiActionsModule, public muse::Con
 {
     muse::GlobalInject<braille::IBrailleConfiguration> brailleConfiguration;
     muse::ContextInject<IAppShellState> appShellState = { this };
+    muse::ContextInject<context::IGlobalContext> globalContext = { this };
     muse::ContextInject<muse::ui::IMainWindow> mainWindow = { this };
     muse::ContextInject<muse::dock::IDockWindowProvider> dockWindowProvider = { this };
 
@@ -58,6 +60,7 @@ class ApplicationUiActions : public muse::ui::IUiActionsModule, public muse::Con
 
 private:
     void listenOpenedDocksChanged(muse::dock::IDockWindow* window);
+    void listenCurrentProjectVideoSettings();
 
     static const muse::ui::UiActionList m_actions;
 

src/appshell/qml/MuseScore/AppShell/NotationPage/NotationPage.qml

@@ -565,6 +565,37 @@ DockPage {
                     }
                 }
             }
+        },
+
+        DockPanel {
+            id: videoPanel
+
+            objectName: root.pageModel.videoPanelName()
+            title: qsTrc("appshell", "Video")
+
+            height: 360
+            minimumHeight: root.horizontalPanelMinHeight
+            maximumHeight: root.horizontalPanelMaxHeight
+
+            minimumWidth: root.panelMinDimension
+            maximumWidth: root.panelMaxDimension
+
+            groupName: root.horizontalPanelsGroup
+
+            //! NOTE: hidden by default
+            visible: false
+
+            location: Location.Bottom
+
+            dropDestinations: root.horizontalPanelDropDestinations
+
+            navigationSection: root.navigationPanelSec(videoPanel.location)
+
+            VideoPanelLoader {
+                anchors.fill: parent
+                navigationSection: videoPanel.navigationSection
+                contentNavigationPanelOrderStart: videoPanel.contentNavigationPanelOrderStart
+            }
         }
     ]
 

src/appshell/qml/MuseScore/AppShell/appmenumodel.cpp

@@ -43,6 +43,9 @@ using namespace muse::actions;
 using namespace muse::extensions;
 
 static const ActionCode TOGGLE_UNDO_HISTORY_PANEL_CODE = "toggle-undo-history-panel";
+static const ActionCode APP_MENU_VIDEO_TIMECODE_OFF_CODE = "video-timecode-off";
+static const ActionCode APP_MENU_VIDEO_TIMECODE_ABOVE_CODE = "video-timecode-above-bars";
+static const ActionCode APP_MENU_VIDEO_TIMECODE_BELOW_CODE = "video-timecode-below-bars";
 static const QString VIEW_TOGGLE_UNDO_HISTORY_PANEL_ITEM_ID = "view/toggle-undo-history-panel";
 
 static QString makeId(const ActionCode& actionCode, int itemIndex)
@@ -145,6 +148,22 @@ void AppMenuModel::setupConnections()
 
         updateUndoRedoItems();
     });
+
+    globalContext()->currentProjectChanged().onNotify(this, [this]() {
+        updateTimecodeItems();
+
+        project::INotationProjectPtr project = globalContext()->currentProject();
+        project::IProjectVideoSettingsPtr settings = project ? project->videoSettings() : nullptr;
+        if (!settings) {
+            return;
+        }
+
+        settings->settingsChanged().onNotify(this, [this]() {
+            updateTimecodeItems();
+        }, Asyncable::Mode::SetReplace);
+    });
+
+    updateTimecodeItems();
 }
 
 void AppMenuModel::onActionsStateChanges(const muse::actions::ActionCodeList& codes)
@@ -311,11 +330,13 @@ MenuItem* AppMenuModel::makeViewMenu()
         makeMenuItem("toggle-timeline"),
         makeMenuItem("toggle-mixer"),
         makeMenuItem("toggle-piano-keyboard"),
+        makeMenuItem("toggle-video-panel"),
         makeMenuItem("toggle-percussion-panel"),
         makeMenuItem("command://playback/show-playback-setup"),
         //makeMenuItem("toggle-scorecmp-tool"), // not implemented
         makeSeparator(),
-        makeMenu(TranslatableString("appshell/menu/view", "&Toolbars"), makeToolbarsItems(), "menu-toolbars")
+        makeMenu(TranslatableString("appshell/menu/view", "&Toolbars"), makeToolbarsItems(), "menu-toolbars"),
+        makeMenu(TranslatableString("appshell/menu/view", "Video &timecode"), makeTimecodeItems(), "menu-video-timecode")
     };
 
 #ifdef MUSE_MODULE_WORKSPACE
@@ -794,6 +815,36 @@ MenuItemList AppMenuModel::makeToolbarsItems()
     return items;
 }
 
+MenuItemList AppMenuModel::makeTimecodeItems()
+{
+    project::INotationProjectPtr project = globalContext()->currentProject();
+    project::IProjectVideoSettingsPtr settings = project ? project->videoSettings() : nullptr;
+    const VideoTimecodeDisplayMode mode = settings
+                                          ? settings->attachment().timecodeDisplayMode
+                                          : VideoTimecodeDisplayMode::Off;
+
+    auto makeTimecodeItem = [this, mode](const ActionCode& actionCode, VideoTimecodeDisplayMode itemMode) {
+        MenuItem* item = makeMenuItem(actionCode);
+        item->setSelectable(true);
+        item->setSelected(mode == itemMode);
+        return item;
+    };
+
+    return {
+        makeTimecodeItem(APP_MENU_VIDEO_TIMECODE_OFF_CODE, VideoTimecodeDisplayMode::Off),
+        makeTimecodeItem(APP_MENU_VIDEO_TIMECODE_ABOVE_CODE, VideoTimecodeDisplayMode::AboveBars),
+        makeTimecodeItem(APP_MENU_VIDEO_TIMECODE_BELOW_CODE, VideoTimecodeDisplayMode::BelowBars)
+    };
+}
+
+void AppMenuModel::updateTimecodeItems()
+{
+    MenuItem& timecodeMenu = findMenu("menu-video-timecode");
+    if (timecodeMenu.isValid()) {
+        timecodeMenu.setSubitems(makeTimecodeItems());
+    }
+}
+
 MenuItemList AppMenuModel::makeShowItems()
 {
     MenuItemList items {

src/appshell/qml/MuseScore/AppShell/appmenumodel.h

@@ -32,6 +32,7 @@
 #include "context/iglobalcontext.h"
 #include "extensions/iextensionsprovider.h"
 #include "global/iglobalconfiguration.h"
+#include "project/iprojectvideosettings.h"
 #ifdef MUSE_MODULE_MUSESAMPLER
 #include "musesampler/imusesamplerinfo.h"
 #endif
@@ -87,6 +88,7 @@ class AppMenuModel : public muse::uicomponents::AbstractMenuModel
     void setupConnections();
 
     void onActionsStateChanges(const muse::actions::ActionCodeList& codes) override;
+    void updateTimecodeItems();
 
     bool isMuseSamplerModuleAdded() const;
 
@@ -120,6 +122,7 @@ class AppMenuModel : public muse::uicomponents::AbstractMenuModel
     muse::uicomponents::MenuItemList makeLinesItems();
     muse::uicomponents::MenuItemList makeChordAndFretboardDiagramsItems();
     muse::uicomponents::MenuItemList makeToolbarsItems();
+    muse::uicomponents::MenuItemList makeTimecodeItems();
     muse::uicomponents::MenuItemList makeWorkspacesItems();
     muse::uicomponents::MenuItemList makeShowItems();
     muse::uicomponents::MenuItemList makePluginsItems();