LuaJIT, .gif failsafe, and external input to Lua #259

DJLevel3 · 2024-09-28T15:02:57Z

As advertised, this PR switches from the basic Lua interpreter to LuaJIT, a just-in-time compiler for Lua that offers immense performance gains. Additionally, it adds a failsafe to .gif loading that prevents a crash if the file fails to load, and it allows Lua programs to access the external audio input to osci-render.

This reverts commit 762b183. Revert changes that were done badly

This reverts commit 899f27d, reversing changes made to 9d9d3f8. Revert merge, as it was done incorrectly

DJLevel3 · 2024-09-28T15:16:48Z

Warning: Currently MIDI seems to be bugged. Working on it.

DJLevel3 · 2024-09-29T21:16:08Z

Source/img/ImageParser.cpp

This change makes it so that when the GIF decoder fails to decode an image, it falls back to a test pattern instead of crashing entirely.

DJLevel3 · 2024-09-29T21:17:13Z

Source/lua/LuaParser.cpp

@@ -325,7 +321,7 @@ static int luaPrint(lua_State* L) {
    int nargs = lua_gettop(L);

    for (int i = 1; i <= nargs; ++i) {
-        LuaParser::onPrint(luaL_tolstring(L, i, nullptr));
+        LuaParser::onPrint(lua_tolstring(L, i, nullptr));


Backing up to Lua 5.1 to use LuaJIT

DJLevel3 · 2024-09-29T21:18:19Z

Source/lua/LuaParser.cpp

@@ -468,7 +467,7 @@ void LuaParser::revertToFallback(lua_State*& L) {
 }

 void LuaParser::readTable(lua_State*& L, std::vector<float>& values) {
-    auto length = lua_rawlen(L, -1);
+    auto length = lua_objlen(L, -1);


Backing up to Lua 5.1 to use LuaJIT

DJLevel3 · 2024-09-29T21:18:26Z

Source/lua/LuaParser.cpp

@@ -493,7 +492,7 @@ std::vector<float> LuaParser::run(lua_State*& L, LuaVariables& vars) {
 	setGlobalVariables(L, vars);

 	// Get the function from the registry
-	lua_geti(L, LUA_REGISTRYINDEX, functionRef);
+	lua_rawgeti(L, LUA_REGISTRYINDEX, functionRef);


Backing up to Lua 5.1 to use LuaJIT

DJLevel3 · 2024-09-29T21:18:53Z

Source/lua/LuaParser.cpp

-		setGlobalVariable(L, "x", vars.x);
-		setGlobalVariable(L, "y", vars.y);
+        setGlobalVariable(L, "x", vars.x);
+        setGlobalVariable(L, "y", vars.y);


Replaced tabs with spaces (marked as a difference for some reason)

DJLevel3 · 2024-09-29T21:19:13Z

Source/lua/LuaParser.cpp

@@ -440,9 +436,12 @@ void LuaParser::setGlobalVariables(lua_State*& L, LuaVariables& vars) {
 		setGlobalVariable(L, SLIDER_NAMES[i], vars.sliders[i]);
    }

+    setGlobalVariable(L, "ext_x", vars.ext_x);
+    setGlobalVariable(L, "ext_y", vars.ext_y);


Pass external input into Lua interpreter

DJLevel3 · 2024-09-29T21:22:05Z

Source/lua/LuaParser.h

@@ -50,6 +54,9 @@ struct LuaVariables {
 	double sampleRate = 0;
 	double frequency = 0;

+	double ext_x = 0;
+	double ext_y = 0;
+


External input variables for Lua

DJLevel3 · 2024-09-29T21:26:02Z

Source/lua/lualib.h

This is auto-generated by LuaJIT

DJLevel3 · 2024-09-29T21:28:17Z

Source/shape/Point.cpp

Extra fields V and W added to the Point class. This is necessary because some audio effects are not able to take extra arguments. V and W are currently used for carrying external audio into effects, but they could also be used for other things in the future.

DJLevel3 · 2024-09-29T21:29:18Z

Source/shape/Point.cpp

+    }
+    else {
+        return std::string("(" + std::to_string(x) + ", " + std::to_string(y) + ", " + std::to_string(z) + ")");
+    }


I split this as adding stuff to the string for a field that's usually 0,0 seems unnecessary unless said stuff contains useful data

DJLevel3 · 2024-09-29T21:29:37Z

Source/shape/Point.h

Adding V and W as described in Point.cpp

DJLevel3 · 2024-09-29T21:30:21Z

osci-render.jucer

Auto-generated by Projucer

DJLevel3 · 2024-09-29T21:30:42Z

.gitmodules

Add LuaJIT as a submodule

DJLevel3 · 2024-09-29T21:35:50Z

Source/PluginProcessor.cpp


+    if (usingInput && totalNumInputChannels >= 2) {


Moved the copy of the input buffer into the output buffer from inside the check to outside. The buffer gets cleared by the synth instead, unless the audio will be used by Lua.

DJLevel3 · 2024-09-29T21:38:01Z

Source/PluginProcessor.cpp

+        double sx = outputBuffer3d.getSample(0, sample);
+        double sy = outputBuffer3d.getSample(1, sample);
+        double sz = outputBuffer3d.getSample(2, sample);
+        Point channels = { sx, sy, sz, left, right };


This will be optimized into the old version if building for Release, but by doing it this way debugging is much easier.

DJLevel3 · 2024-09-29T21:39:20Z

Source/PluginProcessor.cpp

+        auto lua = currentFile >= 0 ? sounds[currentFile]->parser->getLua() : nullptr;
+        if (lua != nullptr || custom->enabled->getBoolValue()) {
+            for (auto& effect : luaEffects) {
+                effect->apply(sample, channels, currentVolume);
            }
        }


This block is functionally identical but removes some stray brackets that didn't have any conditional or loop attached to them, making them do nothing.

DJLevel3 · 2024-09-29T21:40:00Z

Source/audio/CustomEffect.cpp

@@ -19,6 +19,8 @@ Point CustomEffect::apply(int index, Point input, const std::vector<std::atomic<
 	auto x = input.x;
 	auto y = input.y;
 	auto z = input.z;
+	auto eX = input.v;
+	auto eY = input.w;


Get external input variables from the input point

DJLevel3 · 2024-09-29T21:40:16Z

Source/audio/CustomEffect.cpp

@@ -30,16 +32,20 @@ Point CustomEffect::apply(int index, Point input, const std::vector<std::atomic<
 			vars.y = y;
 			vars.z = z;

+			vars.ext_x = eX;
+			vars.ext_y = eY;


Pass external input variables into the Lua variables

DJLevel3 · 2024-09-29T21:41:28Z

Source/audio/CustomEffect.cpp

+
+			x = result[0];
+			y = (rs > 1) ? result[1] : y;
+			z = (rs > 2) ? result[2] : z;


Simplified control flow

DJLevel3 · 2024-09-29T21:42:26Z

Source/audio/CustomEffect.cpp

-		(1 - effectScale) * input.z + effectScale * z
+		(1 - effectScale) * input.z + effectScale * z,
+		input.v,
+		input.w


This could be changed later so Lua can modify the external input, but at the moment that wouldn't change anything as Lua is the only thing that uses the external input points.

DJLevel3 · 2024-09-29T21:43:42Z

Source/audio/Effect.cpp

 		return effectApplication->apply(index, input, actualValues, sampleRate);
+	} else if (application) {
+		return application(index, input, actualValues, sampleRate);


Swapped to give precedence to the EffectApplication rather than the function pointer. This likely has no effect right now, but it makes debugging far easier if both are available.

DJLevel3 · 2024-09-29T21:44:06Z

Source/audio/ShapeVoice.cpp

@@ -13,7 +13,7 @@ bool ShapeVoice::canPlaySound(juce::SynthesiserSound* sound) {
 void ShapeVoice::startNote(int midiNoteNumber, float velocity, juce::SynthesiserSound* sound, int currentPitchWheelPosition) {
    this->velocity = velocity;
    pitchWheelMoved(currentPitchWheelPosition);
-    auto* shapeSound = dynamic_cast<ShapeSound*>(sound);
+    ShapeSound* shapeSound = dynamic_cast<ShapeSound*>(sound);


No actual effect, but easier to read. I really should do this for all the code...

DJLevel3 · 2024-09-29T21:44:54Z

Source/audio/ShapeVoice.cpp

+        if (!(parser != nullptr && parser->isSample())) {
+            outputBuffer.clear(startSample, numSamples);
+        }
+    }


Clear the audio buffer if the current sound is not a Lua synth

DJLevel3 · 2024-09-29T21:45:45Z

Source/audio/ShapeVoice.cpp

+    double x = 0.0;
+    double y = 0.0;
+    double z = 0.0;
+


Moved for debugging an issue that is now fixed, but could still be useful for later debugging

DJLevel3 · 2024-09-29T21:46:05Z

Source/audio/ShapeVoice.cpp

@@ -111,13 +123,16 @@ void ShapeVoice::renderNextBlock(juce::AudioSampleBuffer& outputBuffer, int star
                vars.sampleRate = audioProcessor.currentSampleRate;
                vars.frequency = actualFrequency;
                std::copy(std::begin(audioProcessor.luaValues), std::end(audioProcessor.luaValues), std::begin(vars.sliders));
-
+                vars.ext_x = outputBuffer.getSample(0, sample);
+                vars.ext_y = outputBuffer.getSample(1, sample);


External input strikes back

DJLevel3 · 2024-09-29T21:47:09Z

Source/audio/ShapeVoice.cpp

+                    double length = shape->length();
+                    double drawingProgress = length == 0.0 ? 1 : shapeDrawn / length;
+                    channels = shape->nextVector(drawingProgress);
+                }


Split open the if block as I had added some more code before the if statement, but it turned out not to be necessary. Gets optimized into the old version by the compiler.

DJLevel3 · 2024-09-29T21:47:54Z

Source/audio/ShapeVoice.cpp

@@ -162,7 +177,7 @@ void ShapeVoice::renderNextBlock(juce::AudioSampleBuffer& outputBuffer, int star
        double drawnFrameLength = traceMaxEnabled ? actualTraceMax * frameLength : frameLength;

        if (!renderingSample && frameDrawn >= drawnFrameLength) {
-            if (sound.load() != nullptr && currentlyPlaying) {
+            if (sound.load() != nullptr && currentlyPlaying) { 


Trailing whitespace that has no effect on the code whatsoever, but I wanted to add a comment because I spent a minute trying to figure out what changed

DJLevel3 · 2024-09-29T21:48:32Z

Source/audio/ShapeVoice.cpp

@@ -180,10 +195,10 @@ void ShapeVoice::renderNextBlock(juce::AudioSampleBuffer& outputBuffer, int star
            }
        }
    }
+    return;


Explicitly put here instead of relying on the compiler. Does nothing new, but adds a place to put a breakpoint during debugging.

DJLevel3 · 2024-09-29T21:48:59Z

Source/audio/ShapeVoice.cpp

@@ -192,6 +207,7 @@ void ShapeVoice::stopNote(float velocity, bool allowTailOff) {

 void ShapeVoice::noteStopped() {
    clearCurrentNote();
+    currentlyPlaying = false;


Moved here to fix animation during MIDI note release

DJLevel3 · 2024-09-29T21:50:05Z

Source/lua/LuaParser.cpp

-#include "luaimport.h"
-#include "../shape/Line.h"
-#include "../shape/CircleArc.h"
-#include "../shape/QuadraticBezierCurve.h"


Moved to the header because it's good practice and more readable

DJLevel3

Added comments to all the important changes. Things like newlines aren't commented, but they should be obvious.

DJLevel3 · 2024-09-30T15:26:31Z

Ready to merge if you think it's ready!

DJLevel3 added 21 commits August 13, 2024 08:56

Update README.md

de6adce

Add support for binary GPLA files, both in osci-render and in Blender

28081cd

Merge Json and Binary Line Art Files

772b968

whoops left the .jucer in an old state lol

15131d1

Typo lol

12efc0c

Merge branch 'jameshball:main' into gpla-binary

88f5404

Merge osci-render.jucer

9c73a04

Fix blender 3.1

09044bf

Make some updates

762b183

Add failsafe to prevent crash when .gif files fail to load

fedecab

Add external audio input support to the Lua effect

30ccb1d

Tell Lua about the ext_x and ext_y variables

a6f5108

More fixes

9d9d3f8

Revert "Make some updates"

ac72bbf

This reverts commit 762b183. Revert changes that were done badly

Merge branch 'gpla-binary' into gif-fix

899f27d

Revert "Merge branch 'gpla-binary' into gif-fix"

1f948ac

This reverts commit 899f27d, reversing changes made to 9d9d3f8. Revert merge, as it was done incorrectly

Add LuaJIT as a submodule

f60cc0e

LuaJIT, baby!

f300215

Work on getting Lua completely working

aa2d092

Get external input working correctly for Lua synths and effects

cc7118a

Add Xcode support back in

7407a28

Make MIDI messages work again

f894068