API - separate Init and Boot methods

Previously the API Init method initialised all the paths, then booted the daemon and started the OSC server. However, the GUI now uses the API's path resolution to determine the config directory so it can read the audio config files and send the appropriate flag to the daemon to enable/disable audio inputs. Given the Init method both set paths and booted the daemon, this wasn't possible. Therefore, we Init just initialises the paths and other state, and Boot boots the servers. We can now Init, get the paths, figure out whether scsynth needs inputs, then pass that to the new Boot method.

Author: samaaron

app/api/include/api/sonicpi_api.h

@@ -40,17 +40,23 @@ class OscServer;
 
 enum class APIInitResult
 {
-  Successful,
-  TerminalError,
-  ScsynthBootError,
-  HomePathNotWritableError
+    Successful,
+    TerminalError,
+    HomePathNotWritableError
+};
+
+enum class APIBootResult
+{
+    Successful,
+    TerminalError,
+    ScsynthBootError,
 };
 
 enum class BootDaemonInitResult
 {
-  Successful,
-  TerminalError,
-  ScsynthBootError
+    Successful,
+    TerminalError,
+    ScsynthBootError
 };
 
 enum class SonicPiPath
@@ -282,7 +288,8 @@ class SonicPiAPI
     virtual ~SonicPiAPI();
 
     // Start the ruby server, connect the ports, find the paths.
-    virtual APIInitResult Init(const fs::path& rootPath, bool noScsynthInputs = false);
+    virtual APIInitResult Init(const fs::path& rootPath);
+    virtual APIBootResult Boot(bool noScsynthInputs = false);
 
     virtual void StartClearLogsScript();
 

app/api/src/sonicpi_api.cpp

@@ -592,11 +592,10 @@ bool SonicPiAPI::PingUntilServerCreated()
 }
 
 // Initialize the API with the sonic pi root path (the folder containing the app folder)
-APIInitResult SonicPiAPI::Init(const fs::path& root, bool noScsynthInputs)
+APIInitResult SonicPiAPI::Init(const fs::path& root)
 {
-
-  m_token = -1;
-  m_osc_mtx.lock();
+    m_token = -1;
+    m_osc_mtx.lock();
 
     if (m_state == State::Created)
     {
@@ -652,14 +651,20 @@ APIInitResult SonicPiAPI::Init(const fs::path& root, bool noScsynthInputs)
     }
 
     if (m_homeDirWriteable) {
-      LOG(INFO, "Home dir writable: ");
+
     } else {
+      LOG(INFO, "Home dir not writable ");
       return APIInitResult::HomePathNotWritableError;
     }
 
-
     EnsurePathsAreCanonical();
-    StartClearLogsScript();
+    m_osc_mtx.unlock();
+    return APIInitResult::Successful;
+}
+
+APIBootResult SonicPiAPI::Boot(bool noScsynthInputs)
+{
+    m_osc_mtx.lock();
 
     // Setup redirection of log from this app to our log file
     // stdout into ~/.sonic-pi/log/gui.log
@@ -670,6 +675,8 @@ APIInitResult SonicPiAPI::Init(const fs::path& root, bool noScsynthInputs)
         std::cout.rdbuf(m_stdlog.rdbuf());
     }
 
+    StartClearLogsScript();
+
     LOG(INFO, "Starting...");
 
     // Start again, shutdown if we fail init
@@ -694,9 +701,9 @@ APIInitResult SonicPiAPI::Init(const fs::path& root, bool noScsynthInputs)
         LOG(INFO, "Attempting to start Boot Daemon failed....";)
         m_osc_mtx.unlock();
         if (boot_daemon_res == BootDaemonInitResult::ScsynthBootError) {
-          return APIInitResult::ScsynthBootError;
+            return APIBootResult::ScsynthBootError;
         } else {
-          return APIInitResult::TerminalError;
+            return APIBootResult::TerminalError;
         }
     }
 
@@ -705,7 +712,7 @@ APIInitResult SonicPiAPI::Init(const fs::path& root, bool noScsynthInputs)
     {
         LOG(INFO, "Attempting to start OSC Server failed....");
         m_osc_mtx.unlock();
-        return APIInitResult::TerminalError;
+        return APIBootResult::TerminalError;
     }
 
     LOG(INFO, "API Init Started...");
@@ -720,7 +727,7 @@ APIInitResult SonicPiAPI::Init(const fs::path& root, bool noScsynthInputs)
         PingUntilServerCreated();
     });
 
-    return APIInitResult::Successful;
+    return APIBootResult::Successful;
 }
 
 bool SonicPiAPI::InitializePaths(const fs::path& root)

app/gui/imgui/app.cpp

@@ -107,6 +107,7 @@ void start_sonic_pi()
     sonic.spClient = std::make_shared<SPClient>();
     sonic.spApi = std::make_shared<SonicPiAPI>(sonic.spClient.get(), APIProtocol::UDP, LogOption::File);
     sonic.spApi->Init(fs::path(APP_INSTALL_ROOT) / "..");
+    sonic.spApi->Boot();
 }
 
 bool sync_sonic_pi()

app/gui/qt/mainwindow.cpp

@@ -136,26 +136,32 @@ MainWindow::MainWindow(QApplication& app, QSplashScreen* splash)
     latest_version_num = 0;
 
     bool startupOK = false;
-    bool noScsynthInputs = !piSettings->enable_scsynth_inputs;
-    APIInitResult init_success = m_spAPI->Init(rootPath().toStdString(), noScsynthInputs);
+
+    APIInitResult init_success = m_spAPI->Init(rootPath().toStdString());
+
 
     if(init_success == APIInitResult::Successful) {
-      std::cout << "[GUI] - API Init successful" << std::endl;
-    } else if (init_success == APIInitResult::ScsynthBootError) {
-      std::cout << "[GUI] - API Scsynth Boot Failed" << std::endl;
-      scsynthBootError();
     } else if (init_success == APIInitResult::HomePathNotWritableError) {
       std::cout << "[GUI] - API HomePath Not Writable" << std::endl;
       homeDirWriteError();
     } else {
       std::cout << "[GUI] - API Init failed" << std::endl;
     }
 
-    QString settings_path = sonicPiConfigPath() + QDir::separator() + "gui-settings.ini";
-
-    gui_settings = new QSettings(settings_path, QSettings::IniFormat);
-    readSettings();
     initPaths();
+    readSettings();
+    bool noScsynthInputs = !piSettings->enable_scsynth_inputs;
+    APIBootResult boot_success = m_spAPI->Boot(noScsynthInputs);
+
+    if(boot_success == APIBootResult::Successful) {
+      std::cout << "[GUI] - API Boot successful" << std::endl;
+    } else if (boot_success == APIBootResult::ScsynthBootError) {
+      std::cout << "[GUI] - API Scsynth Boot Failed" << std::endl;
+      scsynthBootError();
+    } else {
+      std::cout << "[GUI] - API Boot failed" << std::endl;
+    }
+
 
     const QRect rect = this->geometry();
     m_appWindowSizeRect = std::make_shared<QRect>(rect);
@@ -271,6 +277,10 @@ MainWindow::MainWindow(QApplication& app, QSplashScreen* splash)
 
 void MainWindow::initPaths()
 {
+
+    QString settings_path = sonicPiConfigPath() + QDir::separator() + "gui-settings.ini";
+    gui_settings = new QSettings(settings_path, QSettings::IniFormat);
+
     QString root_path = rootPath();
 
     qt_app_theme_path = QDir::toNativeSeparators(root_path + "/app/gui/qt/theme/app.qss");