dev-threads Qt example fork changes

.gitignore

@@ -1,3 +1,8 @@
 .vscode
 *.pro.user
 
+/openigtlink/debug/
+/openigtlink/release/
+openigtlink/build/
+.DS_Store
+examples/solum_qt/CMakeLists.txt.user

README.md

@@ -42,3 +42,17 @@ How to obtain a probe certificate:
 ```
 curl -H "Authorization: OEM-API-Key <your key>" "https://cloud.clarius.com/api/public/v0/devices/oem/"
 ```
+
+
+## Deploy with all dependencies of QT
+
+[windeployqt](https://doc.qt.io/qt-6/windows-deployment.html) needs to be executed in order to copy all required QT dependencies into the directory of the executable:
+
+
+For example, open a terminal where the solum.exe was build and enter the following command:
+
+```
+C:\Qt\6.6.0\msvc2019_64\bin\windeployqt.exe solum.exe
+```
+
+This copies all required dependencies into the same folder. **The solum.dll file though needs to be copied manually in addition.**

examples/solum_qt/CMakeLists.txt

@@ -1,46 +1,8 @@
 cmake_minimum_required(VERSION 3.25)
 
-project(solum_qt LANGUAGES CXX)
+project(solum)
 
-set(CMAKE_AUTOUIC ON)
-set(CMAKE_AUTOMOC ON)
-set(CMAKE_AUTORCC ON)
+set(OpenIGTLink_BUILD_TESTING OFF)
 
-set(CMAKE_CXX_STANDARD 17)
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
-
-find_package(Qt6 REQUIRED COMPONENTS Core Gui 3DExtras Bluetooth Widgets)
-message("Found Qt? ${Qt6_FOUND}")
-
-find_library(SOLUM_SDK_BINARY solum PATHS ${CMAKE_SOURCE_DIR}/../../lib)
-message("Solum SDK binary location: ${SOLUM_SDK_BINARY}")
-add_library(SOLUM_SDK UNKNOWN IMPORTED)
-set_target_properties(SOLUM_SDK PROPERTIES
-    IMPORTED_LOCATION ${SOLUM_SDK_BINARY}
-    INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_SOURCE_DIR}/../../include
-)
-
-qt_add_executable(solum_qt
-    main.cpp solumqt.cpp ble.cpp display.cpp 3d.cpp
-    solumqt.h ble.h display.h 3d.h
-    solum.qrc
-    solumqt.ui
-)
-
-set_target_properties(solum_qt PROPERTIES
-    WIN32_EXECUTABLE TRUE
-    MACOSX_BUNDLE TRUE
-    MACOSX_BUNDLE_INFO_PLIST ${CMAKE_SOURCE_DIR}/macos/Info.plist
-    MACOSX_BUNDLE_GUI_IDENTIFIER "me.clarius.sdk.solum_qt"
-)
-
-target_precompile_headers(solum_qt PRIVATE pch.h)
-
-target_link_libraries(solum_qt PRIVATE
-    Qt::Core
-    Qt::Gui
-    Qt::3DExtras
-    Qt::Bluetooth
-    Qt::Widgets
-    SOLUM_SDK
-)
+add_subdirectory(solum)
+add_subdirectory(../../openigtlink/repo openigtlink)

examples/solum_qt/solum/CMakeLists.txt

@@ -0,0 +1,51 @@
+cmake_minimum_required(VERSION 3.25)
+
+project(solum_qt LANGUAGES CXX)
+
+set(CMAKE_AUTOUIC ON)
+set(CMAKE_AUTOMOC ON)
+set(CMAKE_AUTORCC ON)
+
+set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+find_package(Qt6 REQUIRED COMPONENTS Core Gui 3DExtras Bluetooth Widgets)
+message("Found Qt? ${Qt6_FOUND}")
+
+find_library(SOLUM_SDK_BINARY solum PATHS ${CMAKE_CURRENT_SOURCE_DIR}/../../../lib)
+message("Solum SDK binary location: ${SOLUM_SDK_BINARY}")
+add_library(SOLUM_SDK UNKNOWN IMPORTED)
+set_target_properties(SOLUM_SDK PROPERTIES
+    IMPORTED_LOCATION ${SOLUM_SDK_BINARY}
+    INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_CURRENT_SOURCE_DIR}/../../../include
+)
+
+find_package(OpenIGTLink REQUIRED)
+
+qt_add_executable(solum_qt
+    main.cpp solumqt.cpp ble.cpp display.cpp 3d.cpp jobbutton.cpp openigtlink.cpp
+    solumqt.h ble.h display.h 3d.h image.h jobbutton.h openigtlink.h
+    solum.qrc
+    solumqt.ui
+)
+
+set_target_properties(solum_qt PROPERTIES
+    WIN32_EXECUTABLE TRUE
+    MACOSX_BUNDLE TRUE
+    MACOSX_BUNDLE_INFO_PLIST ${CMAKE_CURRENT_SOURCE_DIR}/../macos/Info.plist
+    MACOSX_BUNDLE_GUI_IDENTIFIER "me.clarius.sdk.solum_qt"
+)
+
+target_precompile_headers(solum_qt PRIVATE pch.h)
+
+target_include_directories(solum_qt PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
+
+target_link_libraries(solum_qt PRIVATE
+    Qt::Core
+    Qt::Gui
+    Qt::3DExtras
+    Qt::Bluetooth
+    Qt::Widgets
+    SOLUM_SDK
+    OpenIGTLink
+)

examples/solum_qt/ble.cpp → examples/solum_qt/solum/ble.cpp

@@ -45,6 +45,9 @@ Ble::Ble()
 Ble::~Ble()
 {
     search_.stop();
+
+    // This would be done automatically by QLowEnergyController`'s destructor,
+    // but we must emit the `disconnect` signal while `ping_` is still valid.
     disconnectFromProbe();
 }
 
@@ -61,15 +64,16 @@ void Ble::search()
 /// called when ble search has completed
 void Ble::searchComplete()
 {
+    constexpr auto PREFIX = "CUS-";
     const auto devs = search_.discoveredDevices();
     probes_.clear();
     QStringList probes;
 
     for (auto d : devs)
     {
-        if (d.name().startsWith(QStringLiteral("CUS")))
+        if (d.name().startsWith(PREFIX))
         {
-            auto name = d.name().remove(QStringLiteral("CUS-"));
+            auto name = d.name().remove(PREFIX);
             probes_.push_back(qMakePair(name, d));
             probes.push_back(name);
         }
@@ -103,17 +107,19 @@ bool Ble::connectToProbe(const QString& name)
     if (probe_ && probe_->state() != QLowEnergyController::UnconnectedState)
         return false;
 
-    emit powerReady(false);
-    emit wifiReady(false);
+    name_ = name;
+
+    emit powerReady(false, name_);
+    emit wifiReady(false, name_);
 
     probe_.reset(QLowEnergyController::createCentral(dev, this));
     QObject::connect(probe_.get(), &QLowEnergyController::connected, this, &Ble::onConnected);
     QObject::connect(probe_.get(), &QLowEnergyController::disconnected, [this]()
     {
         // ensure we stop pinging on a disconnect
         ping_.stop();
-        emit powerReady(false);
-        emit wifiReady(false);
+        emit powerReady(false, name_);
+        emit wifiReady(false, name_);
     });
     QObject::connect(probe_.get(), &QLowEnergyController::serviceDiscovered, this, &Ble::onService);
     QObject::connect(probe_.get(), &QLowEnergyController::discoveryFinished, this, &Ble::onDiscoveryFinished);
@@ -125,10 +131,11 @@ bool Ble::connectToProbe(const QString& name)
 /// @return success of the call
 bool Ble::disconnectFromProbe()
 {
-    if (!probe_ || probe_->state() != QLowEnergyController::ConnectedState)
+    if (!probe_)
         return false;
 
     probe_->disconnectFromDevice();
+    emit connected(false);
     return true;
 }
 
@@ -137,8 +144,9 @@ void Ble::onConnected()
 {
     if (probe_)
     {
-        emit powerReady(false);
-        emit wifiReady(false);
+        emit connected(true);
+        emit powerReady(false, name_);
+        emit wifiReady(false, name_);
         probe_->discoverServices();
     }
 }
@@ -170,7 +178,7 @@ void Ble::onService(const QBluetoothUuid& u)
             });
             if (s == QLowEnergyService::RemoteServiceDiscovered)
             {
-                emit powerReady(true);
+                emit powerReady(true, name_);
 
                 auto ch = power_->characteristic(powerPublishedUuid());
                 if (ch.isValid())
@@ -206,7 +214,7 @@ void Ble::onService(const QBluetoothUuid& u)
             });
             if (s == QLowEnergyService::RemoteServiceDiscovered)
             {
-                emit wifiReady(true);
+                emit wifiReady(true, name_);
 
                 auto ch = wifi_->characteristic(wifiPublishedUuid());
                 if (ch.isValid())

examples/solum_qt/ble.h → examples/solum_qt/solum/ble.h

@@ -28,13 +28,17 @@ private slots:
     void onDiscoveryFinished();
 
 signals:
+    void connected(bool);
     void devices(const QStringList&);
-    void powerReady(bool);
+    void powerReady(bool, const QString&);
     void powered(bool);
-    void wifiReady(bool);
+    void wifiReady(bool, const QString&);
     void wifiInfo(const QString&);
 
 private:
+    ///< probe_->remoteName() might be prefixed with "CUS-", this one isn't.
+    QString name_;
+
     DiscoveredDevices probes_;
     QBluetoothDeviceDiscoveryAgent search_;
     std::unique_ptr<QLowEnergyController> probe_;

examples/solum_qt/display.cpp → examples/solum_qt/solum/display.cpp

@@ -16,38 +16,57 @@ UltrasoundImage::UltrasoundImage(bool overlay, QWidget* parent) : QGraphicsView(
     QSizePolicy p(QSizePolicy::Preferred, QSizePolicy::Preferred);
     p.setHeightForWidth(true);
     setSizePolicy(p);
+
+    auto* snapshot = new QToolButton(this);
+    snapshot->setText("💾");
+    snapshot->setToolTip("Saves the current ultrasound image to a PNG file.");
+    snapshot->setStyleSheet("QToolButton {"
+        "border: none;" // also hides the background?
+        "font-size: 16px;"
+    "}");
+    QObject::connect(snapshot, &QToolButton::clicked, [this]()
+    {
+        QMutexLocker locker(&saveLock_);
+        QString fileName = QFileDialog::getSaveFileName(
+            this, tr("Save Image File"), QString(), tr("Images (*.png)"));
+        if (!fileName.isEmpty()) {
+            image_.save(fileName);
+        }
+    });
 }
 
 /// loads a new image from raw data
-/// @param[in] img the new image data
-/// @param[in] w the image width
-/// @param[in] h the image height
-/// @param[in] bpp bits per pixel
-/// @param[in] format the image format
-/// @param[in] sz size of image in bytes
-void UltrasoundImage::loadImage(const void* img, int w, int h, int bpp, CusImageFormat format, int sz)
+/// @param[in] imgNew the new image
+void UltrasoundImage::loadImage(const SolumImage& imgNew)
 {
+    // If we're in the process of saving the image, we throw this one away to
+    // make sure that the image saved is the same that the user saw when
+    // clicking the 💾 button.
+    if (!saveLock_.try_lock())
+        return;
+
     // check for size match
-    if (image_.width() != w || image_.height() != h)
+    if (image_.width() != imgNew.width_ || image_.height() != imgNew.height_)
         return;
 
     // ensure the qimage format matches
-    if (format == Uncompressed8Bit && image_.format() != QImage::Format_Grayscale8)
+    if (imgNew.format_ == Uncompressed8Bit && image_.format() != QImage::Format_Grayscale8)
         image_.convertTo(QImage::Format_Grayscale8);
-    else if (format != Uncompressed8Bit && image_.format() != QImage::Format_ARGB32)
+    else if (imgNew.format_ != Uncompressed8Bit && image_.format() != QImage::Format_ARGB32)
         image_.convertTo(QImage::Format_ARGB32);
 
     // set the image data
     lock_.lock();
     // check that the size matches the dimensions (uncompressed)
-    if (sz >= (w * h * (bpp / 8)))
-        memcpy(image_.bits(), img, w * h * (bpp / 8));
+    if (imgNew.img_.size_bytes() == size_t(imgNew.width_ * imgNew.height_ * (imgNew.bpp_ / 8)))
+        memcpy(image_.bits(), imgNew.img_.data(), imgNew.img_.size_bytes());
     // try to load jpeg
-    else if (format == Jpeg)
-        image_.loadFromData(static_cast<const uchar*>(img), sz, "JPG");
-    else if (format == Png)
-        image_.loadFromData(static_cast<const uchar*>(img), sz, "PNG");
+    else if (imgNew.format_ == Jpeg)
+        image_.loadFromData(imgNew.img_.data(), imgNew.img_.size_bytes(), "JPG");
+    else if (imgNew.format_ == Png)
+        image_.loadFromData(imgNew.img_.data(), imgNew.img_.size_bytes(), "PNG");
     lock_.unlock();
+    saveLock_.unlock();
 
     // redraw
     scene()->invalidate();
@@ -447,21 +466,21 @@ Prescan::Prescan(QWidget* parent) : QGraphicsView(parent)
 /// @param[in] w width of image (aka # of spectrum lines)
 /// @param[in] h height of image (aka # of spectrum samples)
 /// @param[in] bpp bits per pixel (aka bits per sample)
-void Prescan::loadImage(const void* img, int w, int h, int bpp, CusImageFormat format, int sz)
+void Prescan::loadImage(const SolumImage& img)
 {
     lock_.lock();
 
     // check for size match
-    if (image_.width() != h || image_.height() != w)
+    if (image_.width() != img.height_ || image_.height() != img.width_)
     {
-        image_ = QImage(h, w, QImage::Format_Grayscale8);
+        image_ = QImage(img.height_, img.width_, QImage::Format_Grayscale8);
         image_.fill(Qt::black);
     }
 
-    if (format == Jpeg)
-        image_.loadFromData(static_cast<const uchar*>(img), sz, "JPG");
+    if (img.format_ == Jpeg)
+        image_.loadFromData(img.img_.data(), img.img_.size_bytes(), "JPG");
     else
-        memcpy(image_.bits(), img, w * h * (bpp / 8));
+        memcpy(image_.bits(), img.img_.data(), img.img_.size_bytes());
 
     lock_.unlock();