project scaffolding

CMakeLists.txt

@@ -27,7 +27,7 @@ qt_add_executable(sonobulus
 qt_add_qml_module(sonobulus
     URI sonobulus
     VERSION 1.0
-    QML_FILES src/Main.qml
+    QML_FILES ui/Main.qml
 )
 
 target_link_libraries(sonobulus PRIVATE
@@ -46,3 +46,6 @@ if (WIN32)
         VERBATIM
     )
 endif()
+
+# add_subdirectory(src)
+# add_subdirectory(ui)

src/CMakeLists.txt

@@ -0,0 +1,2 @@
+
+# empty

src/main.cpp

@@ -15,11 +15,12 @@ int main(int argc, char* argv[]) {
 
     // attach backend gui components
     qmlRegisterType<TimerComponent>("AppDemo", 1, 0, "TimerComponent");
+    // adds the TimerComponent type (exposed in qml as "TimerComponent") to the module named"AppDemo" (numbers mean version 1.0)
 
     // load qml
     //engine.loadFromModule("sonobulus", "Main");
     //engine.load(QUrl("qrc:/Main.qml"));
-    engine.load(QUrl::fromLocalFile("src/Main.qml")); // ugh
+    engine.load(QUrl::fromLocalFile("ui/Main.qml")); // ugh
 
     if(engine.rootObjects().isEmpty()) {
         std::cout << "engine is empty" << std::endl;

src/synth/AudioEngine.cpp

@@ -0,0 +1,2 @@
+
+#include "AudioEngine.hpp"

src/synth/AudioEngine.hpp

@@ -0,0 +1,2 @@
+
+// The audio engine handles the RtAudio implementation of outputing samples to audio. the audio callback fills a buffer of audio samples and submits it for playback

src/synth/KeyboardController.cpp

@@ -0,0 +1,2 @@
+
+#include "KeyboardController.hpp"

src/synth/KeyboardController.hpp

@@ -0,0 +1,2 @@
+
+// the keyboard controller acts as an instrument input device for creating note events from a computer keyboard

src/synth/MidiController.cpp

@@ -0,0 +1,2 @@
+
+#include "MidiController.hpp"

src/synth/MidiController.hpp

@@ -0,0 +1,2 @@
+
+// the midi controller handles interfacing a stream from a midi input device and processing them into note events for the synthesizer

src/synth/NoteQueue.cpp

@@ -0,0 +1,2 @@
+
+#include "NoteQueue.hpp"

src/synth/NoteQueue.hpp

@@ -0,0 +1,2 @@
+
+// the note queue is a wrapper for a FIFO array to which the midi/keyboard controller enters note events into and the synthesizer consumes from

ui/CMakeLists.txt

@@ -0,0 +1,2 @@
+
+# empty