Merge pull request #13737 from acolombier/feat/improve-screen-renderi…

…ng-framework

feat: improve screen rendering framework

CMakeLists.txt

@@ -2789,6 +2789,7 @@ if(QML)
     src/qml/qmlvisibleeffectsmodel.cpp
     src/qml/qmlchainpresetmodel.cpp
     src/qml/qmlwaveformoverview.cpp
+    src/qml/qmlmixxxcontrollerscreen.cpp
     # The following sources need to be in this target to get QML_ELEMENT properly interpreted
     src/control/controlmodel.cpp
     src/control/controlsortfiltermodel.cpp
@@ -2800,6 +2801,7 @@ if(QML)
   # and :/mixxx.org/imports/Mixxx/Controls are placed into beginning of the binary
   qt_finalize_target(mixxx)
 
+
   install(
     DIRECTORY
       "${CMAKE_CURRENT_SOURCE_DIR}/res/qml"

res/controllers/DummyDeviceDefaultScreen.qml

@@ -13,7 +13,7 @@ import Mixxx.Controls 1.0 as MixxxControls
 
 import "." as Skin
 
-Item {
+Mixxx.ControllerScreen {
     id: root
 
     required property string screenId
@@ -23,7 +23,7 @@ Item {
     property string group: "[Channel1]"
     property var deckPlayer: Mixxx.PlayerManager.getPlayer(root.group)
 
-    function init(controlerName, isDebug) {
+    init: function(controlerName, isDebug) {
         console.log(`Screen ${root.screenId} has started`)
         switch (root.screenId) {
             case "jog":
@@ -34,13 +34,13 @@ Item {
         }
     }
 
-    function shutdown() {
+    shutdown: function() {
         console.log(`Screen ${root.screenId} is stopping`)
         loader.sourceComponent = splash
     }
 
     // function transformFrame(input: ArrayBuffer, timestamp: date) {
-    function transformFrame(input, timestamp) {
+    transformFrame: function(input, timestamp) {
         return new ArrayBuffer(0);
     }
 

src/controllers/bulk/bulkcontroller.cpp

@@ -7,6 +7,7 @@
 #include "controllers/bulk/bulksupported.h"
 #include "controllers/defs_controllers.h"
 #include "moc_bulkcontroller.cpp"
+#include "util/cmdlineargs.h"
 #include "util/time.h"
 #include "util/trace.h"
 
@@ -264,13 +265,13 @@ void BulkController::send(const QList<int>& data, unsigned int length) {
     sendBytes(temp);
 }
 
-void BulkController::sendBytes(const QByteArray& data) {
+bool BulkController::sendBytes(const QByteArray& data) {
     VERIFY_OR_DEBUG_ASSERT(!m_pMapping ||
             m_pMapping->getDeviceDirection() &
                     LegacyControllerMapping::DeviceDirection::Outgoing) {
         qDebug() << "The mapping for the bulk device" << getName()
                  << "doesn't require sending data. Ignoring sending request.";
-        return;
+        return false;
     }
 
     int ret;
@@ -287,8 +288,10 @@ void BulkController::sendBytes(const QByteArray& data) {
     if (ret < 0) {
         qCWarning(m_logOutput) << "Unable to send data to" << getName()
                                << "serial #" << m_sUID << "-" << libusb_error_name(ret);
+        return false;
     } else if (CmdlineArgs::Instance().getControllerDebug()) {
         qCDebug(m_logOutput) << transferred << "bytes sent to" << getName()
                              << "serial #" << m_sUID;
     }
+    return true;
 }

src/controllers/bulk/bulkcontroller.h

@@ -64,7 +64,7 @@ class BulkController : public Controller {
   private:
     // For devices which only support a single report, reportID must be set to
     // 0x0.
-    void sendBytes(const QByteArray& data) override;
+    bool sendBytes(const QByteArray& data) override;
 
     bool matchProductInfo(const ProductInfo& product);
 

src/controllers/controller.h

@@ -141,8 +141,9 @@ class Controller : public QObject {
 
   public:
     // This must be reimplemented by sub-classes desiring to send raw bytes to a
-    // controller.
-    virtual void sendBytes(const QByteArray& data) = 0;
+    // controller. Return true in case of successful completion, false in case
+    // of partial completion or failure.
+    virtual bool sendBytes(const QByteArray& data) = 0;
 
   private: // but used by ControllerManager
 

src/controllers/controllerscreenpreview.cpp

@@ -23,6 +23,7 @@ ControllerScreenPreview::ControllerScreenPreview(
     setMaximumWidth(screen.size.width());
     m_pStat->setAlignment(Qt::AlignRight);
     auto pLayout = make_parented<QVBoxLayout>(this);
+    pLayout->setContentsMargins(0, 0, 0, 0);
     auto* pBottomLayout = new QHBoxLayout();
     pLayout->addWidget(m_pFrame);
     pBottomLayout->addWidget(make_parented<QLabel>(

src/controllers/hid/hidcontroller.cpp

@@ -198,10 +198,11 @@ int HidController::close() {
 /// This function is only for class compatibility with the (midi)controller
 /// and will not do the same as for MIDI devices,
 /// because sending of raw bytes is not a supported HIDAPI feature.
-void HidController::sendBytes(const QByteArray& data) {
+bool HidController::sendBytes(const QByteArray& data) {
     // Some HIDAPI backends will fail if the device uses ReportIDs (as practical all DJ controllers),
     // because 0 is no valid ReportID for these devices.
     m_pHidIoThread->updateCachedOutputReportData(0, data, false);
+    return true;
 }
 
 ControllerJSProxy* HidController::jsProxy() {

src/controllers/hid/hidcontroller.h

@@ -36,7 +36,7 @@ class HidController final : public Controller {
   private:
     // For devices which only support a single report, reportID must be set to
     // 0x0.
-    void sendBytes(const QByteArray& data) override;
+    bool sendBytes(const QByteArray& data) override;
 
     const mixxx::hid::DeviceInfo m_deviceInfo;
 

src/controllers/midi/hss1394controller.cpp

@@ -185,13 +185,15 @@ void Hss1394Controller::sendShortMsg(unsigned char status, unsigned char byte1,
     }
 }
 
-void Hss1394Controller::sendBytes(const QByteArray& data) {
+bool Hss1394Controller::sendBytes(const QByteArray& data) {
     const int bytesSent = m_pChannel->SendChannelBytes(
             reinterpret_cast<const unsigned char*>(data.constData()), data.size());
 
     qCDebug(m_logOutput) << MidiUtils::formatSysexMessage(getName(), data);
     if (bytesSent != data.size()) {
         qCWarning(m_logOutput) << "Sent" << bytesSent << "of" << data.size() << "bytes (SysEx)";
         //m_pChannel->Flush();
+        return false;
     }
+    return true;
 }

src/controllers/midi/hss1394controller.h

@@ -53,7 +53,7 @@ class Hss1394Controller : public MidiController {
   private:
     // The sysex data must already contain the start byte 0xf0 and the end byte
     // 0xf7.
-    void sendBytes(const QByteArray& data) override;
+    bool sendBytes(const QByteArray& data) override;
 
     hss1394::TNodeInfo m_deviceInfo;
     int m_iDeviceIndex;

src/controllers/midi/portmidicontroller.cpp

@@ -222,28 +222,30 @@ void PortMidiController::sendShortMsg(unsigned char status, unsigned char byte1,
     }
 }
 
-void PortMidiController::sendBytes(const QByteArray& data) {
+bool PortMidiController::sendBytes(const QByteArray& data) {
     // PortMidi does not receive a length argument for the buffer we provide to
     // Pm_WriteSysEx. Instead, it scans for a MidiOpCode::EndOfExclusive byte
     // to know when the message is over. If one is not provided, it will
     // overflow the buffer and cause a segfault.
     if (!data.endsWith(MidiUtils::opCodeValue(MidiOpCode::EndOfExclusive))) {
         qCDebug(m_logOutput) << "SysEx message does not end with 0xF7 -- ignoring.";
-        return;
+        return false;
     }
 
     if (m_pOutputDevice.isNull() || !m_pOutputDevice->isOpen()) {
-        return;
+        return false;
     }
 
     PmError err = m_pOutputDevice->writeSysEx((unsigned char*)data.constData());
     if (err == pmNoError) {
         qCDebug(m_logOutput) << QStringLiteral("outgoing: ")
                              << MidiUtils::formatSysexMessage(getName(), data);
+        return true;
     } else {
         // Use two qWarnings() to ensure line break works on all operating systems
         qCWarning(m_logOutput) << "Error sending SysEx message:"
                                << MidiUtils::formatSysexMessage(getName(), data);
         qCWarning(m_logOutput) << "PortMidi error:" << Pm_GetErrorText(err);
     }
+    return false;
 }

src/controllers/midi/portmidicontroller.h

@@ -68,7 +68,7 @@ class PortMidiController : public MidiController {
   private:
     // The sysex data must already contain the start byte 0xf0 and the end byte
     // 0xf7.
-    void sendBytes(const QByteArray& data) override;
+    bool sendBytes(const QByteArray& data) override;
 
     bool isPolling() const override {
         return true;

src/controllers/rendering/controllerrenderingengine.cpp

@@ -375,7 +375,7 @@ void ControllerRenderingEngine::send(Controller* controller, const QByteArray& f
     DEBUG_ASSERT_THIS_QOBJECT_THREAD_AFFINITY();
     ScopedTimer t(QStringLiteral("ControllerRenderingEngine::send"));
     if (!frame.isEmpty()) {
-        controller->sendBytes(frame);
+        VERIFY_OR_TERMINATE(controller->sendBytes(frame), "Unable to send frame to device");
     }
 
     if (CmdlineArgs::Instance()