Add: Video capability for MCMP and Lua API

src/CMakeLists.txt

@@ -78,6 +78,7 @@ set(mudlet_SRCS
     dlgTriggerPatternEdit.cpp
     dlgTriggersMainArea.cpp
     dlgVarsMainArea.cpp
+    dlgVideoPlayer.cpp
     EAction.cpp
     exitstreewidget.cpp
     FontManager.cpp
@@ -154,6 +155,7 @@ set(mudlet_SRCS
     TTreeWidget.cpp
     TTrigger.cpp
     TVar.cpp
+    TVideoPlayer.cpp
     VarUnit.cpp
     XMLexport.cpp
     XMLimport.cpp)
@@ -196,7 +198,8 @@ set(mudlet_UIS
     ui/triggers_main_area.ui
     ui/trigger_editor.ui
     ui/trigger_pattern_edit.ui
-    ui/vars_main_area.ui)
+    ui/vars_main_area.ui
+    ui/videoplayer.ui)
 
 set(mudlet_HDRS
     ActionUnit.h
@@ -233,6 +236,7 @@ set(mudlet_HDRS
     dlgTriggerPatternEdit.h
     dlgTriggersMainArea.h
     dlgVarsMainArea.h
+    dlgVideoPlayer.h
     EAction.h
     exitstreewidget.h
     FontManager.h
@@ -318,6 +322,7 @@ set(mudlet_HDRS
     TTreeWidget.h
     TTrigger.h
     TVar.h
+    TVideoPlayer.h
     VarUnit.h
     utils.h
     widechar_width.h
@@ -362,6 +367,7 @@ find_package(
   Qt5 5.14 REQUIRED
   COMPONENTS Core
              Multimedia
+             MultimediaWidgets
              Network
              OpenGL
              UiTools
@@ -476,6 +482,7 @@ target_link_libraries(
   Qt5::Core
   Qt5::Network
   Qt5::Multimedia
+  Qt5::MultimediaWidgets
   Qt5::OpenGL
   Qt5::UiTools
   Qt5::Widgets

src/Host.cpp

@@ -26,14 +26,13 @@
 
 
 #include "LuaInterface.h"
-#include "TConsole.h"
-#include "TDebug.h"
-#include "TMainConsole.h"
 #include "TCommandLine.h"
+#include "TConsole.h"
 #include "TDebug.h"
 #include "TDockWidget.h"
 #include "TEvent.h"
 #include "TLabel.h"
+#include "TMainConsole.h"
 #include "TMap.h"
 #include "TMedia.h"
 #include "TRoomDB.h"
@@ -42,12 +41,13 @@
 #include "TToolBar.h"
 #include "VarUnit.h"
 #include "XMLimport.h"
+#include "dlgIRC.h"
 #include "dlgMapper.h"
 #include "dlgModuleManager.h"
 #include "dlgNotepad.h"
 #include "dlgPackageManager.h"
 #include "dlgProfilePreferences.h"
-#include "dlgIRC.h"
+#include "dlgVideoPlayer.h"
 #include "mudlet.h"
 
 #include "pre_guard.h"
@@ -314,6 +314,7 @@ Host::Host(int port, const QString& hostname, const QString& login, const QStrin
 , mBubbleMode(false)
 , mShowRoomID(false)
 , mShowPanel(true)
+, mShowVideoPlayerPanel(true)
 , mServerGUI_Package_version(QLatin1String("-1"))
 , mServerGUI_Package_name(QLatin1String("nothing"))
 , mAcceptServerGUI(true)
@@ -325,6 +326,7 @@ Host::Host(int port, const QString& hostname, const QString& login, const QStrin
 , mFORCE_MXP_NEGOTIATION_OFF(false)
 , mFORCE_CHARSET_NEGOTIATION_OFF(false)
 , mpDockableMapWidget()
+, mpDockableVideoPlayerWidget()
 , mEnableTextAnalyzer(false)
 , mTimerDebugOutputSuppressionInterval(QTime())
 , mSearchOptions(dlgTriggerEditor::SearchOption::SearchOptionNone)
@@ -467,6 +469,11 @@ Host::~Host()
     if (mpDockableMapWidget) {
         mpDockableMapWidget->deleteLater();
     }
+
+    if (mpDockableVideoPlayerWidget) {
+        mpDockableVideoPlayerWidget->deleteLater();
+    }
+
     mIsGoingDown = true;
     mIsClosingDown = true;
     mErrorLogStream.flush();
@@ -2794,6 +2801,21 @@ std::pair<bool, QString> Host::setMapperTitle(const QString& title)
     return {true, QString()};
 }
 
+std::pair<bool, QString> Host::setVideoPlayerTitle(const QString& title)
+{
+    if (!mpDockableVideoPlayerWidget) {
+        return {false, "no floating/dockable type video player window found"};
+    }
+
+    if (title.isEmpty()) {
+        mpDockableVideoPlayerWidget->setWindowTitle(tr("Video Player - %1").arg(mHostName));
+    } else {
+        mpDockableVideoPlayerWidget->setWindowTitle(title);
+    }
+
+    return {true, QString()};
+}
+
 void Host::setDebugShowAllProblemCodepoints(const bool state)
 {
     if (mDebugShowAllProblemCodepoints != state) {
@@ -3432,6 +3454,88 @@ std::pair<bool, QString> Host::closeMapWidget()
     return {true, QString()};
 }
 
+std::pair<bool, QString> Host::openVideoPlayerWidget(const QString& area, int x, int y, int width, int height)
+{
+    if (!mpConsole) {
+        return {false, QString()};
+    }
+
+    auto pM = mpDockableVideoPlayerWidget;
+    auto pVideoPlayer = mpMedia->mpVideoPlayer;
+
+    if (!pM && !pVideoPlayer) {
+        showHideOrCreateVideoPlayer();
+        pM = mpDockableVideoPlayerWidget;
+    }
+
+    if (!pM) {
+        return {false, qsl("cannot create video player widget. Do you already use an embedded video player?")};
+    }
+
+    pM->show();
+
+    if (area.isEmpty()) {
+        return {true, QString()};
+    }
+
+    if (area == QLatin1String("f") || area == QLatin1String("floating")) {
+        if (!pM->isFloating()) {
+            // Undock a docked window
+            // Change of position or size is only possible when floating
+            pM->setFloating(true);
+        }
+
+        if ((x != -1) && (y != -1)) {
+            pM->move(x, y);
+        }
+
+        if ((width != -1) && (height != -1)) {
+            pM->resize(width, height);
+        }
+        return {true, QString()};
+    } else {
+        if (area == QLatin1String("r") || area == QLatin1String("right")) {
+            pM->setFloating(false);
+            mudlet::self()->addDockWidget(Qt::RightDockWidgetArea, pM);
+            return {true, QString()};
+        } else if (area == QLatin1String("l") || area == QLatin1String("left")) {
+            pM->setFloating(false);
+            mudlet::self()->addDockWidget(Qt::LeftDockWidgetArea, pM);
+            return {true, QString()};
+        } else if (area == QLatin1String("t") || area == QLatin1String("top")) {
+            pM->setFloating(false);
+            mudlet::self()->addDockWidget(Qt::TopDockWidgetArea, pM);
+            return {true, QString()};
+        } else if (area == QLatin1String("b") || area == QLatin1String("bottom")) {
+            pM->setFloating(false);
+            mudlet::self()->addDockWidget(Qt::BottomDockWidgetArea, pM);
+            return {true, QString()};
+        } else {
+            return {false, qsl(R"("docking option "%1" not available. available docking options are "t" top, "b" bottom, "r" right, "l" left and "f" floating")").arg(area)};
+        }
+    }
+}
+
+std::pair<bool, QString> Host::closeVideoPlayerWidget()
+{
+    if (!mpConsole) {
+        return {false, QString()};
+    }
+
+    auto pM = mpDockableVideoPlayerWidget;
+
+    if (!pM) {
+        return {false, qsl("no video player widget found to close")};
+    }
+
+    if (!pM->isVisible()) {
+        return {false, qsl("video player widget already closed")};
+    }
+
+    pM->hide();
+    return {true, QString()};
+}
+
 bool Host::closeWindow(const QString& name)
 {
     if (!mpConsole) {
@@ -3675,17 +3779,24 @@ bool Host::setProfileStyleSheet(const QString& styleSheet)
     if (mpDlgProfilePreferences) {
         mpDlgProfilePreferences->setStyleSheet(styleSheet);
     }
+
     if (mpNotePad) {
         mpNotePad->setStyleSheet(styleSheet);
         mpNotePad->notesEdit->setStyleSheet(styleSheet);
     }
+
     if (mpDockableMapWidget) {
         mpDockableMapWidget->setStyleSheet(styleSheet);
     }
 
+    if (mpDockableVideoPlayerWidget) {
+        mpDockableVideoPlayerWidget->setStyleSheet(styleSheet);
+    }
+
     for (auto& dockWidget : mpConsole->mDockWidgetMap) {
         dockWidget->setStyleSheet(styleSheet);
     }
+
     if (this == mudlet::self()->mpCurrentActiveHost) {
         mudlet::self()->setGlobalStyleSheet(styleSheet);
     }
@@ -3903,6 +4014,48 @@ void Host::createMapper(const bool loadDefaultMap)
     raiseEvent(mapOpenEvent);
 }
 
+void Host::showHideOrCreateVideoPlayer()
+{
+    if (mpMedia->mpVideoPlayer) {
+        toggleVideoPlayerVisibility();
+        return;
+    }
+
+    createVideoPlayer();
+}
+
+void Host::toggleVideoPlayerVisibility()
+{
+    bool visStatus = mpMedia->mpVideoPlayer->isVisible();
+
+    if (mpMedia->mpVideoPlayer->isFloatAndDockable()) {
+        mpMedia->mpVideoPlayer->parentWidget()->setVisible(!visStatus);
+    } else {
+        mpMedia->mpVideoPlayer->setVisible(!visStatus);
+    }
+}
+
+void Host::createVideoPlayer()
+{
+    auto pMedia = mpMedia.data();
+    auto hostName(getName());
+
+    mpDockableVideoPlayerWidget = new QDockWidget(tr("Video Player - %1").arg(hostName));
+    mpDockableVideoPlayerWidget->setObjectName(qsl("dockVideoPlayer_%1").arg(hostName));
+
+    pMedia->mpVideoPlayer = new dlgVideoPlayer(mpDockableVideoPlayerWidget, this, pMedia);
+    pMedia->mpVideoPlayer->setStyleSheet(mProfileStyleSheet);
+    mpDockableVideoPlayerWidget->setWidget(pMedia->mpVideoPlayer);
+
+    mudlet::self()->addDockWidget(Qt::RightDockWidgetArea, mpDockableVideoPlayerWidget);
+    mudlet::self()->loadWindowLayout();
+
+    TEvent videoPlayerOpenEvent{};
+    videoPlayerOpenEvent.mArgumentList.append(QLatin1String("videoPlayerOpenEvent"));
+    videoPlayerOpenEvent.mArgumentTypeList.append(ARGUMENT_TYPE_STRING);
+    raiseEvent(videoPlayerOpenEvent);
+}
+
 void Host::setDockLayoutUpdated(const QString& name)
 {
     if (!mpConsole) {

src/Host.h

@@ -341,6 +341,7 @@ class Host : public QObject
     void setSearchOptions(const dlgTriggerEditor::SearchOptions);
     void setBufferSearchOptions(const TConsole::SearchOptions);
     std::pair<bool, QString> setMapperTitle(const QString&);
+    std::pair<bool, QString> setVideoPlayerTitle(const QString&);
     void setDebugShowAllProblemCodepoints(const bool);
     bool debugShowAllProblemCodepoints() const { return mDebugShowAllProblemCodepoints; }
     void setCompactInputLine(const bool state);
@@ -365,6 +366,8 @@ class Host : public QObject
     std::pair<bool, QString> setWindow(const QString& windowname, const QString& name, int x1, int y1, bool show);
     std::pair<bool, QString> openMapWidget(const QString& area, int x, int y, int width, int height);
     std::pair<bool, QString> closeMapWidget();
+    std::pair<bool, QString> openVideoPlayerWidget(const QString& area, int x, int y, int width, int height);
+    std::pair<bool, QString> closeVideoPlayerWidget();
     bool closeWindow(const QString&);
     bool echoWindow(const QString&, const QString&);
     bool pasteWindow(const QString& name);
@@ -386,6 +389,7 @@ class Host : public QObject
     bool setBackgroundImage(const QString& name, QString& path, int mode);
     bool resetBackgroundImage(const QString& name);
     void showHideOrCreateMapper(const bool loadDefaultMap);
+    void showHideOrCreateVideoPlayer();
     bool setProfileStyleSheet(const QString& styleSheet);
     void check_for_mappingscript();
     void setupIreDriverBugfix();
@@ -619,7 +623,8 @@ class Host : public QObject
     bool mBubbleMode;
     bool mMapViewOnly = true;
     bool mShowRoomID;
-    bool mShowPanel;
+    bool mShowPanel; // Mapper
+    bool mShowVideoPlayerPanel;
     QString mServerGUI_Package_version;
     QString mServerGUI_Package_name;
     bool mAcceptServerGUI;
@@ -632,6 +637,7 @@ class Host : public QObject
     bool mFORCE_CHARSET_NEGOTIATION_OFF;
     QSet<QChar> mDoubleClickIgnore;
     QPointer<QDockWidget> mpDockableMapWidget;
+    QPointer<QDockWidget> mpDockableVideoPlayerWidget;
     bool mEnableTextAnalyzer;
     bool mWritingHostAndModules = false;
     // Set from profile preferences, if the timer interval is less
@@ -704,6 +710,8 @@ private slots:
     void thankForUsingPTB();
     void toggleMapperVisibility();
     void createMapper(const bool);
+    void createVideoPlayer();
+    void toggleVideoPlayerVisibility();
     void removePackageInfo(const QString &packageName, const bool);
     static void createModuleBackup(const QString &filename, const QString& saveName);
     void writeModule(const QString &moduleName, const QString &filename);

src/TConsole.cpp

@@ -38,6 +38,7 @@
 #include "TSplitter.h"
 #include "TTextEdit.h"
 #include "dlgMapper.h"
+#include "dlgVideoPlayer.h"
 #include "mudlet.h"
 
 #include "pre_guard.h"

src/TConsole.h

@@ -64,6 +64,7 @@ class QScrollBar;
 class QToolButton;
 
 class dlgMapper;
+class dlgVideoPlayer;
 class Host;
 class TTextEdit;
 class TCommandLine;
@@ -266,6 +267,7 @@ class TConsole : public QWidget
     QWidget* mpMainDisplay = nullptr;
 
     dlgMapper* mpMapper = nullptr;
+    dlgVideoPlayer* mpVideoPlayer = nullptr;
 
     QScrollBar* mpScrollBar = nullptr;
     QScrollBar* mpHScrollBar = nullptr;