Feature: Adds command line arguments to set initial voice and device and to enable logging in release builds

Author: Kirill Belousov

CMakeLists.txt

@@ -39,6 +39,15 @@ target_compile_definitions(sim PRIVATE
 include(FetchContent)
 set(FETCHCONTENT_BASE_DIR ${CMAKE_BINARY_DIR}/_dependencies)
 
+# cli11
+FetchContent_Declare(CLI11
+GIT_REPOSITORY https://github.com/CLIUtils/CLI11
+GIT_TAG v2.5.0
+GIT_SHALLOW ON
+SYSTEM
+)
+FetchContent_MakeAvailable(CLI11)
+
 # miniaudio
 FetchContent_Declare(miniaudio
   GIT_REPOSITORY https://github.com/mackron/miniaudio.git
@@ -129,6 +138,7 @@ target_include_directories(sim PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}/src")
 
 target_link_libraries(sim PRIVATE
   miniaudio
+  CLI11::CLI11
   SRAL::SRAL_static
   spdlog::spdlog_header_only
   wx::core

src/loggerSetup.cpp

@@ -13,30 +13,37 @@
 
 constexpr int LOGGER_THREAD_POOL_QUEUE_SIZE = 8192;
 constexpr int LOGGER_THREAD_POOL_BACKING_THREAD_COUNT = 1;
-#ifndef NDEBUG
-constexpr const char* LOG_FORMAT = "%R Level: %l, Thread: %t, Message: %v";
-#else
 constexpr const char* LOG_FORMAT = "%R Level: %l, Thread: %t, Message: %v";
-#endif
 
-void InitializeLogging(int argc, char* argv[]) {
+void InitializeLogging(int argc, char* argv[], bool isDebuggingEnabled) {
     try {
-#ifdef DEBUG
-        spdlog::set_level(spdlog::level::debug);
+#ifndef NDEBUG
+        bool isDebugBuild = true;
 #else
-        spdlog::set_level(spdlog::level::warn);
+        bool isDebugBuild = false;
 #endif
-        spdlog::cfg::load_env_levels();
-        spdlog::cfg::load_argv_levels(argc, argv);
+        // spdlog::cfg::load_env_levels();
+        // spdlog::cfg::load_argv_levels(argc, argv);
         spdlog::init_thread_pool(LOGGER_THREAD_POOL_QUEUE_SIZE, LOGGER_THREAD_POOL_BACKING_THREAD_COUNT);
         auto consoleSink = std::make_shared<spdlog::sinks::stdout_sink_mt>();
         auto fileSink = std::make_shared<spdlog::sinks::basic_file_sink_mt>("sim.log", true);
         std::vector<spdlog::sink_ptr> sinks{consoleSink, fileSink};
         auto logger = std::make_shared<spdlog::async_logger>(
             "simlogger", sinks.begin(), sinks.end(), spdlog::thread_pool(), spdlog::async_overflow_policy::block);
-        logger->set_level(spdlog::level::trace);
         logger->set_pattern(LOG_FORMAT);
+        if (isDebuggingEnabled || isDebugBuild) {
+            logger->set_level(spdlog::level::trace);
+        } else {
+            logger->set_level(spdlog::level::warn);
+        }
         spdlog::register_logger(logger);
         spdlog::set_default_logger(logger);
+        if (isDebugBuild) {
+            spdlog::debug("Log level is set to trace because of debug build");
+        }
+        if (isDebuggingEnabled) {
+            spdlog::debug("Log level is set to debug via command line parameter");
+        }
+        std::atexit(spdlog::shutdown);
     } catch (spdlog::spdlog_ex& ex) { std::cerr << "Unable to initialize logger: " << ex.what() << '\n'; }
 }

src/loggerSetup.h

@@ -1,3 +1,3 @@
 #pragma once
 
-void InitializeLogging(int argc, char* argv[]);
+void InitializeLogging(int argc, char* argv[], bool isDebuggingEnabled);

src/ui.cpp

@@ -5,11 +5,16 @@
 #include "loggerSetup.h"
 #include "speech.h"
 
+#include <CLI/CLI.hpp>
 #include <spdlog/spdlog.h>
 #include <string>
 #include <wx/string.h>
 
-MainFrame::MainFrame(const wxString& title) : wxFrame(nullptr, wxID_ANY, title) {
+MainFrame::MainFrame(const wxString& title, int cliVoiceIndex, int cliOutputDeviceIndex, bool cliIsHelpRequested)
+    : wxFrame(nullptr, wxID_ANY, title) {
+    m_cliVoiceIndex = cliVoiceIndex;
+    m_cliOutputDeviceIndex = cliOutputDeviceIndex;
+    m_cliIsHelpRequested = cliIsHelpRequested;
     m_panel = new wxPanel(this, wxID_ANY);
     auto* mainSizer = new wxBoxSizer(wxVERTICAL);
     auto* selectionsSizer = new wxBoxSizer(wxHORIZONTAL);
@@ -80,7 +85,7 @@ void MainFrame::populateVoicesList() {
     for (const auto& voiceName : voices) {
         m_voicesList->AppendString(wxString::FromUTF8(voiceName));
     }
-    m_voicesList->SetSelection(0);
+    m_voicesList->SetSelection(m_cliVoiceIndex);
 }
 
 void MainFrame::populateDevicesList() {
@@ -94,7 +99,7 @@ void MainFrame::populateDevicesList() {
         auto isDefaultStr = device.isDefault ? "[default]" : "";
         m_outputDevicesList->AppendString(wxString::FromUTF8(std::format("{} {}", isDefaultStr, device.name)));
     }
-    m_outputDevicesList->SetSelection(0);
+    m_outputDevicesList->SetSelection(m_cliOutputDeviceIndex);
 }
 
 void MainFrame::OnRateSliderChange(wxCommandEvent& event) {
@@ -151,13 +156,24 @@ void MainFrame::OnCharEvent(wxKeyEvent& event) {
 }
 
 bool MyApp::OnInit() {
-    InitializeLogging(MyApp::argc, MyApp::argv);
-    if (!wxApp::OnInit()) {
-        spdlog::critical("Failed to initialize WX");
-        return false;
-    }
-    MainFrame* frame = new MainFrame("SIM test");
+    CLI::App cliApp{"SIM - Speak Instead of Me speech utility"};
+    auto argv = cliApp.ensure_utf8(MyApp::argv);
+    bool cliIsDebugEnabled = false;
+    cliApp.add_flag("-D,--debug", cliIsDebugEnabled, "Enable the debug logging for release builds");
+    int cliVoiceIndex = 0;
+    cliApp.add_option("-v,--voice", cliVoiceIndex, "Specify SAPI voice index to be selected at program start");
+    int cliOutputDeviceIndex = 0;
+    cliApp.add_option("-d,--device", cliOutputDeviceIndex,
+                      "Specify output device number to be selected at program start");
+    bool cliIsHelpRequested = false;
+    CLI11_PARSE(cliApp, MyApp::argc, argv);
+    InitializeLogging(MyApp::argc, MyApp::argv, cliIsDebugEnabled);
+    auto* frame = new MainFrame("SIM test", cliVoiceIndex, cliOutputDeviceIndex, cliIsHelpRequested);
     frame->Show(true);
     spdlog::debug("Main window shown");
     return true;
 }
+
+void MyApp::OnInitCmdLine(wxCmdLineParser& parser) {
+    // Left empty to bypass wxWidgets cli parsing
+}

src/ui.h

@@ -5,7 +5,8 @@
 
 class MainFrame : public wxFrame {
   public:
-    MainFrame(const wxString& title);
+    MainFrame(const wxString& title, int cliVoiceIndex = 0, int cliOutputDeviceIndex = 0,
+              bool cliIsHelpRequested = false);
 
   private:
     wxPanel* m_panel;
@@ -14,6 +15,9 @@ class MainFrame : public wxFrame {
     wxListBox* m_outputDevicesList;
     wxSlider* m_rateSlider;
     wxSlider* m_volumeSlider;
+    int m_cliVoiceIndex = 0;
+    int m_cliOutputDeviceIndex = 0;
+    bool m_cliIsHelpRequested = false;
 
     void populateVoicesList();
     void populateDevicesList();
@@ -29,5 +33,6 @@ class MainFrame : public wxFrame {
 
 class MyApp : public wxApp {
   public:
-    virtual bool OnInit();
+    virtual bool OnInit() override;
+    virtual void OnInitCmdLine(wxCmdLineParser& parser) override;
 };