Click: Added a test

Author: drowaudio

modules/tracktion_core/tracktion_TestConfig.h

@@ -21,6 +21,7 @@
 #define ENGINE_UNIT_TESTS_AUTOMATION                    1
 #define ENGINE_UNIT_TESTS_AUTOMATION_CURVE_LIST         1
 #define ENGINE_UNIT_TESTS_AUX_SEND                      1
+#define ENGINE_UNIT_TESTS_CLICKNODE                     1
 #define ENGINE_UNIT_TESTS_CLIPBOARD                     1
 #define ENGINE_UNIT_TESTS_CLIPSLOT                      1
 #define ENGINE_UNIT_TESTS_CONSTRAINED_CACHED_VALUE      1

modules/tracktion_engine/playback/graph/tracktion_ClickNode.test.cpp

@@ -0,0 +1,53 @@
+/*
+    ,--.                     ,--.     ,--.  ,--.
+  ,-'  '-.,--.--.,--,--.,---.|  |,-.,-'  '-.`--' ,---. ,--,--,      Copyright 2024
+  '-.  .-'|  .--' ,-.  | .--'|     /'-.  .-',--.| .-. ||      \   Tracktion Software
+    |  |  |  |  \ '-'  \ `--.|  \  \  |  |  |  |' '-' '|  ||  |       Corporation
+    `---' `--'   `--`--'`---'`--'`--' `---' `--' `---' `--''--'    www.tracktion.com
+
+    Tracktion Engine uses a GPL/commercial licence - see LICENCE.md for details.
+*/
+
+#if TRACKTION_UNIT_TESTS && ENGINE_UNIT_TESTS_CLICKNODE
+
+#include <tracktion_engine/../3rd_party/doctest/tracktion_doctest.hpp>
+#include <tracktion_engine/testing/tracktion_EnginePlayer.h>
+#include <tracktion_engine/utilities/tracktion_TestUtilities.h>
+
+namespace tracktion::inline engine
+{
+    TEST_SUITE ("tracktion_engine")
+    {
+        TEST_CASE("ClickNode")
+        {
+            auto& engine = *Engine::getEngines()[0];
+
+            for (auto srbs : std::array<SampleRateAndBlockSize, 4>{{ { 44100.0, 2048 },
+                                                                     { 44100.0, 512 },
+                                                                     { 44100.0, 64 },
+                                                                     { 96000.0, 2048 } }})
+            {
+                HostedAudioDeviceInterface::Parameters params { .sampleRate = srbs.sampleRate, .blockSize = srbs.blockSize, .inputChannels = 0, .outputChannels = 1 };
+                test_utilities::EnginePlayer player (engine, params);
+
+                auto edit = engine::test_utilities::createTestEdit (engine, 1, Edit::EditRole::forEditing);
+                auto& tc = edit->getTransport();
+
+                edit->clickTrackEnabled = true;
+                edit->setClickTrackVolume (1.0f);
+                CHECK_EQ (edit->clickTrackGain.get(), 1.0f);
+                tc.play (false);
+
+                const auto totalNumSamples = toSamples (60_td, params.sampleRate);
+                auto resultBuffer = player.process (totalNumSamples);
+
+                auto f = graph::test_utilities::writeToTemporaryFile<juce::WavAudioFormat> (toBufferView (resultBuffer), params.sampleRate);
+
+                CHECK_GT (resultBuffer.getRMSLevel (0, 0, resultBuffer.getNumSamples()), 0.01f);
+                CHECK_GT (resultBuffer.getMagnitude (0, 0, resultBuffer.getNumSamples()), 0.5f);
+            }
+        }
+    }
+} // namespace tracktion::inline engine
+
+#endif

modules/tracktion_engine/playback/graph/tracktion_LoopingMidiNode.test.cpp

@@ -52,7 +52,7 @@ class LoopingMidiNodeTests : public juce::UnitTest
 private:
     //==============================================================================
     //==============================================================================
-    void runMidiTests (test_utilities::TestSetup ts)
+    void runMidiTests (graph::test_utilities::TestSetup ts)
     {
         beginTest ("Setup");
 
@@ -62,7 +62,7 @@ class LoopingMidiNodeTests : public juce::UnitTest
 
         auto r = ts.random;
         const auto duration = edit->tempoSequence.toTime ({ 4, 0_bd });
-        const auto seq = test_utilities::createRandomMidiMessageSequence (duration.inSeconds(), r);
+        const auto seq = graph::test_utilities::createRandomMidiMessageSequence (duration.inSeconds(), r);
 
         // Add sequnce and loop randomly in the first and last of the 4 bars (16 beats)
         auto mc = getAudioTracks (*edit)[0]->insertMIDIClip ({ 0_tp, duration }, nullptr);
@@ -96,7 +96,7 @@ class LoopingMidiNodeTests : public juce::UnitTest
         testMidiClip (*mc, ts);
     }
 
-    void runStuckNotesTests (test_utilities::TestSetup ts, bool usesProxy, int numLoopIterations)
+    void runStuckNotesTests (graph::test_utilities::TestSetup ts, bool usesProxy, int numLoopIterations)
     {
         beginTest ("Stuck notes");
 
@@ -343,7 +343,7 @@ class LoopingMidiNodeTests : public juce::UnitTest
         expect (allEventsWithinRange, "Not all events within the expected range");
     }
 
-    void runOffsetTests (test_utilities::TestSetup ts)
+    void runOffsetTests (graph::test_utilities::TestSetup ts)
     {
         beginTest ("MIDI clip with offset");
 
@@ -364,13 +364,13 @@ class LoopingMidiNodeTests : public juce::UnitTest
         sequence.addNote (49, 0_bp, 1_bd, 127, 0, nullptr);
         sequence.addNote (50, 1_bp, 1_bd, 127, 0, nullptr);
 
-        auto seq = test_utilities::stripNonNoteOnOffMessages (renderMidiClip (*mc, ts, { 0_tp, mc->getPosition().getEnd() }));
+        auto seq = graph::test_utilities::stripNonNoteOnOffMessages (renderMidiClip (*mc, ts, { 0_tp, mc->getPosition().getEnd() }));
         expectEquals (seq.getNumEvents(), 2);
 
         testMidiClip (*mc, ts);
     }
 
-    void testMidiClip (MidiClip& mc, test_utilities::TestSetup ts)
+    void testMidiClip (MidiClip& mc, graph::test_utilities::TestSetup ts)
     {
         auto renderOpts = RenderOptions::forClipRender ({ &mc }, true);
         renderOpts->setFormat (RenderOptions::midi);
@@ -391,12 +391,12 @@ class LoopingMidiNodeTests : public juce::UnitTest
         params.destFile = t2.getFile();
         const auto seqWithoutProxyFile = Renderer::renderToFile ("non-proxy", params);
 
-        test_utilities::expectMidiMessageSequence (*this,
-                                                   test_utilities::stripMetaEvents (getSeqFromFile (seqWithoutProxyFile)),
-                                                   test_utilities::stripMetaEvents (getSeqFromFile (seqWithProxyFile)));
+        graph::test_utilities::expectMidiMessageSequence (*this,
+                                                          graph::test_utilities::stripMetaEvents (getSeqFromFile (seqWithoutProxyFile)),
+                                                          graph::test_utilities::stripMetaEvents (getSeqFromFile (seqWithProxyFile)));
     }
 
-    juce::MidiMessageSequence renderMidiClip (MidiClip& mc, test_utilities::TestSetup ts,
+    juce::MidiMessageSequence renderMidiClip (MidiClip& mc, graph::test_utilities::TestSetup ts,
                                               TimeRange rangeToRender)
     {
         auto renderOpts = RenderOptions::forClipRender ({ &mc }, true);

modules/tracktion_engine/tracktion_engine_playback.cpp

@@ -218,6 +218,7 @@ using namespace std::literals;
 #include "playback/graph/tracktion_ArrangerLauncherSwitchingNode.cpp"
 #include "playback/graph/tracktion_AuxSendNode.cpp"
 #include "playback/graph/tracktion_ClickNode.cpp"
+#include "playback/graph/tracktion_ClickNode.test.cpp"
 #include "playback/graph/tracktion_CombiningNode.cpp"
 #include "playback/graph/tracktion_ContainerClipNode.cpp"
 #include "playback/graph/tracktion_DynamicOffsetNode.cpp"