Add a shortcut to hide the VUI (#1636)

As suggested here: https://forum.shotcut.org/t/need-a-button-to-disable-the-frame-on-some-filters/46913 --------- Co-authored-by: Dan Dennedy <[email protected]>
mltframework · Feb 27, 2025 · 4f9ab6f · 4f9ab6f
1 parent 5437715
commit 4f9ab6f
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 1 deletion.
diff --git a/src/mainwindow.cpp b/src/mainwindow.cpp
@@ -335,6 +335,7 @@ void MainWindow::setupAndConnectPlayerWidget()
     ui->menuPlayer->addAction(Actions["playerSetInAction"]);
     ui->menuPlayer->addAction(Actions["playerSetOutAction"]);
     ui->menuPlayer->addAction(Actions["playerSetPositionAction"]);
+    ui->menuPlayer->addAction(Actions["playerToggleVui"]);
     ui->menuPlayer->addAction(Actions["playerSwitchSourceProgramAction"]);
 }
 
@@ -962,6 +963,7 @@ void MainWindow::connectVideoWidgetSignals()
             &FilterController::currentFilterChanged,
             videoWidget,
             &Mlt::VideoWidget::setCurrentFilter);
+    connect(m_player, &Player::toggleVuiRequested, videoWidget, &Mlt::VideoWidget::toggleVuiDisplay);
 }
 
 void MainWindow::onFocusWindowChanged(QWindow *) const

diff --git a/src/player.cpp b/src/player.cpp
@@ -802,6 +802,11 @@ void Player::setupActions()
     action->setProperty(Actions.hardKeyProperty, "Shift+Esc");
     connect(action, &QAction::triggered, this, [&]() { setFocus(); });
     Actions.add("playerFocus", action, tr("Player"));
+
+    action = new QAction(tr("Toggle Filter Overlay"), this);
+    action->setShortcut(QKeySequence(Qt::CTRL | Qt::SHIFT | Qt::Key_Q));
+    connect(action, &QAction::triggered, this, [&]() { emit toggleVuiRequested(); });
+    Actions.add("playerToggleVui", action, tr("Player"));
 }
 
 void Player::setIn(int pos)

diff --git a/src/player.h b/src/player.h
@@ -86,6 +86,7 @@ class Player : public QWidget
     void trimIn();
     void trimOut();
     void loopChanged(int start, int end);
+    void toggleVuiRequested();
 
 public slots:
     void play(double speed = 1.0);

diff --git a/src/videowidget.cpp b/src/videowidget.cpp
@@ -45,6 +45,7 @@ VideoWidget::VideoWidget(QObject *parent)
     , m_snapToGrid(true)
     , m_scrubAudio(false)
     , m_maxTextureSize(4096)
+    , m_hideVui(false)
 {
     LOG_DEBUG() << "begin";
     setAttribute(Qt::WA_AcceptTouchEvents);
@@ -486,12 +487,18 @@ void VideoWidget::requestImage() const
     m_frameRenderer->requestImage();
 }
 
+void VideoWidget::toggleVuiDisplay()
+{
+    m_hideVui = !m_hideVui;
+    refreshConsumer();
+}
+
 void VideoWidget::onFrameDisplayed(const SharedFrame &frame)
 {
     m_mutex.lock();
     m_sharedFrame = frame;
     m_mutex.unlock();
-    bool isVui = frame.get_int(kShotcutVuiMetaProperty);
+    bool isVui = frame.get_int(kShotcutVuiMetaProperty) && !m_hideVui;
     if (!isVui && source() != QmlUtilities::blankVui()) {
         m_savedQmlSource = source();
         setSource(QmlUtilities::blankVui());
@@ -533,6 +540,7 @@ void VideoWidget::setOffsetY(int y)
 
 void VideoWidget::setCurrentFilter(QmlFilter *filter, QmlMetadata *meta)
 {
+    m_hideVui = false;
     if (meta && meta->type() == QmlMetadata::Filter
         && QFile::exists(meta->vuiFilePath().toLocalFile())) {
         filter->producer().set(kShotcutVuiMetaProperty, 1);

diff --git a/src/videowidget.h b/src/videowidget.h
@@ -92,6 +92,7 @@ class VideoWidget : public QQuickWidget, public Controller
     void requestImage() const;
     bool snapToGrid() const { return m_snapToGrid; }
     int maxTextureSize() const { return m_maxTextureSize; }
+    void toggleVuiDisplay();
 
 public slots:
     void setGrid(int grid);
@@ -137,6 +138,7 @@ public slots:
     float m_zoom;
     QPoint m_offset;
     QUrl m_savedQmlSource;
+    bool m_hideVui;
     bool m_snapToGrid;
     QTimer m_refreshTimer;
     bool m_scrubAudio;