[feat] cli: integrate cli in main executable

Author: bgallois

.github/workflows/build_linux.yml

@@ -43,20 +43,11 @@ jobs:
           wget https://github.com/bgallois/SoBundle/releases/download/continuous/so_bundle
           chmod +x so_bundle
           ./so_bundle --exec ./bin/fasttrack --qt ${{ github.workspace }}/Qt/${{ env.QT_VERSION }}/gcc_64/ --bundle
-      - name: build_run_cli
-        run: |
-          cd build
-          ./so_bundle --exec ./bin/fasttrack-cli --qt ${{ github.workspace }}/Qt/${{ env.QT_VERSION }}/gcc_64/ --bundle
       - name: upload_artefact
         uses: actions/upload-artifact@v4
         with:
           name: FastTrack
           path: ./build/bin/fasttrack.run
-      - name: upload_artefact
-        uses: actions/upload-artifact@v4
-        with:
-          name: FastTrack-Cli
-          path: ./build/bin/fasttrack-cli.run
 
   test_bundle:
     runs-on: ubuntu-latest
@@ -65,11 +56,11 @@ jobs:
       - name: download artifact
         uses: actions/download-artifact@v4
         with:
-          name: FastTrack-Cli
-          path: FastTrack-Cli
+          name: FastTrack
+          path: FastTrack
 
       - name: Run FastTrack executable
         run: |
-          cd FastTrack-Cli
-          chmod +x fasttrack-cli.run
-          ./fasttrack-cli.run -- --help
+          cd FastTrack
+          chmod +x fasttrack.run
+          ./fasttrack.run -- --cli --help

.github/workflows/build_mac.yml

@@ -118,33 +118,6 @@ jobs:
         with:
           name: FastTrack.dmg
           path: ./build/bin/FastTrack.dmg
-      - name: build_ft_cli
-        run: |
-          cd build/bin
-          APP=FastTrack-Cli.app
-          APP_BINARY=$APP/Contents/MacOS/FastTrack-Cli
-          mv fasttrack-cli.app "$APP"
-          macdeployqt "$APP" \
-            -always-overwrite \
-            -verbose=2
-          find / -name "libutf8_validity.dylib" -exec cp {} $APP/Contents/Frameworks/ \; 2> >(tee /dev/stderr) || true
-          find / -name "libgcc_s.1.1.dylib" -exec cp {} $APP/Contents/Frameworks/ \; 2> >(tee /dev/stderr) || true
-          find / -name "libsharpyuv.0.dylib" -exec cp {} $APP/Contents/Frameworks/ \; 2> >(tee /dev/stderr) || true
-          find / -name "libjxl_cms.0.11.dylib" -exec cp {} $APP/Contents/Frameworks/ \; 2> >(tee /dev/stderr) || true
-          find / -name "libvtk*.dylib" -exec cp {} $APP/Contents/Frameworks/ \; 2> >(tee /dev/stderr) || true
-          find / -name "libsqlite3*.dylib" -exec cp {} $APP/Contents/Frameworks/ \; 2> >(tee /dev/stderr) || true
-          find / -name "libhpdf*.dylib" -exec cp {} $APP/Contents/Frameworks/ \; 2> >(tee /dev/stderr) || true
-          cp -v /opt/homebrew/opt/little-cms2/lib/lib*.dylib $APP/Contents/Frameworks/ || true
-          cp -v /opt/homebrew/opt/jpeg-xl/lib/lib*.dylib $APP/Contents/Frameworks/ || true
-          find "$APP/Contents/Frameworks" -type f -name "*.dylib" -exec codesign --remove-signature {} \; 2>/dev/null || true
-          find "$APP/Contents/Frameworks" -type f -name "*.dylib" -exec codesign --force --sign - {} \;
-          python macdeployqtfix.py fasttrack-cli.app/contents/macos/fasttrack-cli ../../Qt/${{ env.QT_VERSION }}/
-          hdiutil create -volname FastTrack-Cli -srcfolder $APP -ov -format UDZO FastTrack-Cli.dmg
-      - name: upload_artefact_cli
-        uses: actions/upload-artifact@v4
-        with:
-          name: FastTrack-Cli.dmg
-          path: ./build/bin/FastTrack-Cli.dmg
 
   test_bundle:
     runs-on: macos-latest
@@ -153,11 +126,11 @@ jobs:
       - name: download artifact
         uses: actions/download-artifact@v4
         with:
-          name: FastTrack-Cli.dmg
-          path: FastTrack-Cli
+          name: FastTrack.dmg
+          path: FastTrack
 
       - name: Run FastTrack executable
         run: |
-          cd FastTrack-Cli
-          hdiutil attach FastTrack-Cli.dmg -mountpoint /Volumes/FastTrackApp
-          /Volumes/FastTrackApp/FastTrack-Cli.app/Contents/MacOS/FastTrack-Cli --help
+          cd FastTrack
+          hdiutil attach FastTrack.dmg -mountpoint /Volumes/FastTrackApp
+          /Volumes/FastTrackApp/FastTrack.app/Contents/MacOS/FastTrack --cli --help

.github/workflows/build_win.yml

@@ -36,7 +36,6 @@ jobs:
           cmake -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Release -DSKIP_TEST=ON ../
           mingw32-make
           mv bin/fasttrack.exe bin/FastTrack.exe
-          mv bin/fasttrack-cli.exe bin/FastTrack-Cli.exe
           mv bin FastTrack
           windeployqt FastTrack/FastTrack.exe --no-translations  # https://bugreports.qt.io/browse/QTBUG-62103?jql=status%20%3D%20Open%20AND%20text%20~%20%22windeployqt%20platform%22 and https://bugreports.qt.io/browse/QTBUG-112204
           cp ${{ github.workspace }}/src/assets/icon.ico FastTrack
@@ -63,4 +62,4 @@ jobs:
       - name: Run FastTrack executable
         run: |
           cd FastTrack
-          ./FastTrack-Cli.exe --help
+          ./FastTrack.exe --cli --help

docs/user/trackingCli.md

@@ -14,26 +14,26 @@ The syntax to call FastTrack command line interface differs according to the pla
 
 ## Installing fasttrack-cli
 
-The command-line interface is available for macOS, Linux, and Windows. It can be downloaded on [the release page](https://github.com/FastTrackOrg/FastTrack/releases/latest). Since version 6.4.0 the fasttrack-cli is installed in the same folder as fasttrack for Windows.
+The command-line interface is available for macOS, Linux, and Windows. Since version 6.5.0 the fasttrack-cli is incorporated into the main fasttrack executable.
 
-The full list of parameters can be found by calling ```./fasttrack-cli --help```. 
-Parameters can be declared individually by calling ```./fasttrack-cli --path path/to/movie.webm --parameter1 value --parameter2 value``` or in batch with a parameters file ```./fasttrack-cli --path path/to/movie.webm --cfg path/cfg.toml```. Note that the path option need to be the first option.
+The full list of parameters can be found by calling ```./fasttrack --cli --help```. 
+Parameters can be declared individually by calling ```./fasttrack --cli --path path/to/movie.webm --parameter1 value --parameter2 value``` or in batch with a parameters file ```./fasttrack-cli --path path/to/movie.webm --cfg path/cfg.toml```. Note that the path option need to be the first option.
 
-## Calling fasttrack-cli from a Python script
+## Calling fasttrack cli from a Python script
 
 FastTrack can be called inside a Python script to automate the tracking. 
 
 ```
 import os
 
-cmd = "./fasttrack-cli --maxArea 500 --minArea 50 --lightBack 0 --thresh 80 --reg 0 --spot 0 --nBack 50 --regBack 0 --methBack 1 --xTop 0 --yTop 0 --xBottom 0 --yBottom 0 --morph 0 --morphSize 0 --morphType 0 --normArea 0 --normPerim 0 --normDist 50 --normAngle 45 --maxDist 150 --maxTime 10 --path ZFJ_001.avi --backPath dataSet/images/Groundtruth/Tracking_Result/background.pgm " 
+cmd = "./fasttrack --cli --maxArea 500 --minArea 50 --lightBack 0 --thresh 80 --reg 0 --spot 0 --nBack 50 --regBack 0 --methBack 1 --xTop 0 --yTop 0 --xBottom 0 --yBottom 0 --morph 0 --morphSize 0 --morphType 0 --normArea 0 --normPerim 0 --normDist 50 --normAngle 45 --maxDist 150 --maxTime 10 --path ZFJ_001.avi --backPath dataSet/images/Groundtruth/Tracking_Result/background.pgm " 
 os.system(cmd)
 ```
 
 ```
 import os
 
-cmd = "./fasttrack-cli --path ZFJ_001.avi --cfg Tracking_Result_ZFJ_001/cfg.toml"
+cmd = "./fasttrack --cli --path ZFJ_001.avi --cfg Tracking_Result_ZFJ_001/cfg.toml"
 os.system(cmd)
 ```
 

src/CMakeLists.txt

@@ -23,6 +23,7 @@ add_executable(fasttrack
     timeline.cpp
     autolevel.cpp
     imageviewer.cpp
+    cli.cpp
 
     updater.h
     mainwindow.h
@@ -38,6 +39,7 @@ add_executable(fasttrack
     timeline.h
     autolevel.h
     imageviewer.h
+    cli.h
 
     mainwindow.ui
     replay.ui
@@ -58,19 +60,6 @@ add_custom_target(translations ALL DEPENDS ${QM_FILES})
 
 target_compile_definitions(fasttrack PRIVATE APP_VERSION="${PROJECT_VERSION}")
 
-add_executable(fasttrack-cli
-    fasttrack-cli.cpp
-    tracking.cpp
-    videoreader.cpp
-    Hungarian.cpp
-
-    tracking.h
-    videoreader.h
-    Hungarian.h
-)
-
-target_compile_definitions(fasttrack-cli PRIVATE APP_VERSION="${PROJECT_VERSION}")
-
 function(configure_target target_name)
     if(UNIX AND NOT APPLE)
         target_compile_options(${target_name} PRIVATE -O3)
@@ -116,7 +105,6 @@ function(configure_target target_name)
 endfunction()
 
 configure_target(fasttrack)
-configure_target(fasttrack-cli)
 
 if(UNIX AND NOT APPLE)
     install(TARGETS fasttrack DESTINATION /usr/bin)
@@ -132,5 +120,4 @@ if(UNIX AND NOT APPLE)
             DESTINATION share/licenses/fasttrack)
 endif()
 
-install(TARGETS fasttrack-cli DESTINATION /usr/bin)
 install(FILES ${CMAKE_SOURCE_DIR}/LICENSE DESTINATION /usr/share/licenses/fasttrack)

src/fasttrack-cli.cpp src/cli.cppsrc/fasttrack-cli.cpp renamed to src/cli.cpp

@@ -15,19 +15,7 @@ This file is part of Fast Track.
     along with FastTrack.  If not, see <https://www.gnu.org/licenses/>.
 */
 
-#include <getopt.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <tracking.h>
-#include <QCoreApplication>
-#include <QHash>
-#include <QHashIterator>
-#include <QObject>
-#include <QString>
-#include <QStringList>
-#include <QTextStream>
-
-using namespace std;
+#include "cli.h"
 
 void loadConfig(const QString &path, QHash<QString, QString> &parameters) {
   QFile parameterFile(path);
@@ -100,10 +88,7 @@ All arguments are mandatory except --backPath and --cfg. Loading a configuration
         stdout);
 }
 
-int main(int argc, char **argv) {
-  QCoreApplication app(argc, argv);
-  char env[] = "OPENCV_OPENCL_DEVICE=disabled";
-  putenv(env);  // disable OpenCL to fix windows memory leaks and increase performance
+int cli(int argc, char **argv) {
   static struct option long_options[] =
       {
           {"maxArea", required_argument, 0, 'a'},

src/cli.h

@@ -0,0 +1,38 @@
+/*
+This file is part of Fast Track.
+
+    FastTrack is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    FastTrack is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with FastTrack.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
+#ifndef CLI_H
+#define CLI_H
+#include <getopt.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <tracking.h>
+#include <QCoreApplication>
+#include <QHash>
+#include <QHashIterator>
+#include <QObject>
+#include <QString>
+#include <QStringList>
+#include <QTextStream>
+
+using namespace std;
+
+void loadConfig(const QString &path, QHash<QString, QString> &parameters);
+void help();
+int cli(int argc, char **argv);
+
+#endif

src/main.cpp

@@ -24,6 +24,7 @@ This file is part of Fast Track.
 #include <QScopedPointer>
 #include <QSplashScreen>
 #include <QString>
+#include "cli.h"
 #include "mainwindow.h"
 
 QScopedPointer<QFile> logFile;
@@ -35,27 +36,36 @@ void messageHandler(QtMsgType type, const QMessageLogContext &context, const QSt
 }
 
 int main(int argc, char *argv[]) {
-  char env[] = "OPENCV_OPENCL_DEVICE=disabled";
-  putenv(env);  // disable OpenCL to fix windows memory leaks and increase performance
-  QApplication a(argc, argv);
-  QPixmap pixmap(QStringLiteral(":/assets/icon.png"));
-  QSplashScreen splash(pixmap);
-  splash.show();
-  a.setApplicationName(QStringLiteral("FastTrack"));
-  a.setApplicationVersion(APP_VERSION);  // clazy:exclude=qstring-allocations
-  a.setOrganizationName(QStringLiteral("FastTrackOrg"));
-  a.setOrganizationDomain(QStringLiteral("www.fasttrack.sh"));
-  logFile.reset(new QFile(QStandardPaths::writableLocation(QStandardPaths::AppLocalDataLocation) + "/fasttrack.log"));
-  QDir().mkpath(QStandardPaths::writableLocation(QStandardPaths::AppLocalDataLocation));
-  logFile.data()->open(QFile::Append | QFile::Text);
+  qputenv("OPENCV_OPENCL_DEVICE", "disabled");  // disable OpenCL to fix windows memory leaks and increase performance
+  if (qstrcmp(argv[1], "--cli")) {
+    QApplication a(argc, argv);
+    QPixmap pixmap(QStringLiteral(":/assets/icon.png"));
+    QSplashScreen splash(pixmap);
+    splash.show();
+    a.setApplicationName(QStringLiteral("FastTrack"));
+    a.setApplicationVersion(APP_VERSION);  // clazy:exclude=qstring-allocations
+    a.setOrganizationName(QStringLiteral("FastTrackOrg"));
+    a.setOrganizationDomain(QStringLiteral("www.fasttrack.sh"));
+    logFile.reset(new QFile(QStandardPaths::writableLocation(QStandardPaths::AppLocalDataLocation) + "/fasttrack.log"));
+    QDir().mkpath(QStandardPaths::writableLocation(QStandardPaths::AppLocalDataLocation));
+    logFile.data()->open(QFile::Append | QFile::Text);
 #ifdef QT_NO_DEBUG
-  qInstallMessageHandler(messageHandler);
+    qInstallMessageHandler(messageHandler);
 #endif
-  MainWindow w;
-  w.setWindowIcon(QIcon(":/assets/icon.png"));
-  QFontDatabase::addApplicationFont(QStringLiteral(":/assets/Font.ttf"));
-  w.setStyleSheet(QStringLiteral("QWidget {font-family: 'Lato', sans-serif;}"));
-  w.show();
-  splash.finish(&w);
-  a.exec();
+    MainWindow w;
+    w.setWindowIcon(QIcon(":/assets/icon.png"));
+    QFontDatabase::addApplicationFont(QStringLiteral(":/assets/Font.ttf"));
+    w.setStyleSheet(QStringLiteral("QWidget {font-family: 'Lato', sans-serif;}"));
+    w.show();
+    splash.finish(&w);
+    a.exec();
+  }
+  else {
+    std::vector<char *> args(argv, argv + argc);
+    args.erase(args.begin() + 1);
+    argc = static_cast<int>(args.size());
+    argv = args.data();
+    QCoreApplication a(argc, argv);
+    return cli(argc, argv);
+  }
 }

test/accuracyTest.py

@@ -159,16 +159,16 @@ def tracking(path, imagePath, normDist=None, normAngle=None, maxDist=None, maxTi
   morphType = str(int(groundParameter.loc["morphType"][1]))
 
   if platform.system() == "Windows":
-    executable = "FastTrack-Cli.exe"
+    executable = "FastTrack.exe"
     prefix = ""
   elif platform.system() == "Linux":
-    executable = "fasttrack-cli"
+    executable = "fasttrack"
     prefix = ""
   elif platform.system() == "Darwin":
-    executable = "fasttrack-cli.app --args"
+    executable = "fasttrack.app --args"
     prefix = "open -W "
 
-  cmd = prefix + os.path.abspath("../build/bin/" + executable) + " --maxArea " + maxArea + " --minArea " + minArea + " --lightBack "+ lightBack + " --thresh "+ thresh + " --reg " + reg + " --spot "+ spot + " --nBack "+ nBack + " --regBack "+ regBack + " --methBack " + methBack+ " --xTop "+ xTop + " --yTop "+ yTop + " --xBottom " + xBottom + " --yBottom " + yBottom+ " --morph " + morph + " --morphSize " + morphSize+ " --morphType " + morphType +" --normArea " +str(normArea) + " --normPerim "+ str(normPerim) + " --normDist " + str(normDist) + " --normAngle " + str(normAngle) + " --maxDist " + str(maxDist) + " --maxTime " + str(maxTime) + " --path "+ os.path.abspath(path + imagePath) + " --backPath " + os.path.abspath("dataSet/images/Groundtruth/Tracking_Result/background.pgm") #+ " > /dev/null 2>&1" 
+  cmd = prefix + os.path.abspath("../build/bin/" + executable) + " --cli" + " --maxArea " + maxArea + " --minArea " + minArea + " --lightBack "+ lightBack + " --thresh "+ thresh + " --reg " + reg + " --spot "+ spot + " --nBack "+ nBack + " --regBack "+ regBack + " --methBack " + methBack+ " --xTop "+ xTop + " --yTop "+ yTop + " --xBottom " + xBottom + " --yBottom " + yBottom+ " --morph " + morph + " --morphSize " + morphSize+ " --morphType " + morphType +" --normArea " +str(normArea) + " --normPerim "+ str(normPerim) + " --normDist " + str(normDist) + " --normAngle " + str(normAngle) + " --maxDist " + str(maxDist) + " --maxTime " + str(maxTime) + " --path "+ os.path.abspath(path + imagePath) + " --backPath " + os.path.abspath("dataSet/images/Groundtruth/Tracking_Result/background.pgm") #+ " > /dev/null 2>&1" 
   print(cmd)
   out = os.system(cmd)