bass: enable this again after figuring out I was a fucking idiot

Author: RaphaelIT7

README.md

@@ -3313,7 +3313,10 @@ Restarts the channel.<br>
 Computes the DFT of the sound channel.<br>
 What even is that.<br>
 
-#### IGModAudioChannel:EncodeToDisk(string fileName, number bassFlags, function callback, bool async = false)
+#### bool(success), string(errMsg - nil) IGModAudioChannel:EncodeToDisk(string fileName, number bassFlags, function callback, bool async = false)
+callback - `function(success, errMsg) end`<br>
+bassFlags - bitflags, see https://www.un4seen.com/doc/#bassenc/BASS_Encode_Start.html<br>
+
 Writes the channel into a file, the encoder internally used depends on the filename.<br>
 Valid encoders are:<br>
 - `.wav` (Requres `BASSENC` plugin)<br>
@@ -3327,11 +3330,6 @@ Valid encoders are:<br>
 > This function requires the `BASSENC` plugin to work at all!<br>
 > You can find all the plugins at https://www.un4seen.com/ drop them into the `bin/` folder besides `libbass.so`<br>
 
-> [!WARNING]
-> This function is a fucking gamble, I do not know why BASS decides this, though it behaves sometimes randomly.<br>
-> the current code for it seems to be somewhat stable, though any change like shifting it, adding arguments will cause issues<br>
-> until this is figured out this won't be changed in any way further (This could all point back to BASSENC itself having a bug specific to my usecase)<br>
-
 #### IGModAudioChannel:Update(number time)
 Updates the channel for the given time in seconds<br>
 See: https://www.un4seen.com/doc/#bass/BASS_ChannelUpdate.html<br>

source/modules/bass.cpp

@@ -336,95 +336,73 @@ LUA_FUNCTION_STATIC(IGModAudioChannel_Restart)
 
 
 
-class BassEncoderCallback : public IGModEncoderCallback, public GarrysMod::Lua::ILuaThreadedCall
+class BassEncoderCallback : public IGModEncoderCallback
 {
 public:
-	BassEncoderCallback(int nReference)
+	BassEncoderCallback(GarrysMod::Lua::ILuaInterface* pLua)
 	{
-		m_nCallbackReference = nReference;
+		m_pLua = pLua;
+		m_nCallbackReference = Util::ReferenceCreate(pLua, "BassEncoderCallback - callback reference");
 	}
 
 	virtual ~BassEncoderCallback() {
-		if (m_nCallbackReference != -1)
+		if (m_pLua && m_nCallbackReference != -1)
 		{
 			Msg("BassEncoderCallback deleted while still holding a reference!\n");
+			Util::ReferenceFree(m_pLua, m_nCallbackReference, "BassEncoderCallback - callback leftover deletion");
 			m_nCallbackReference = -1;
+			m_pLua = NULL;
 		}
 	};
 
 	virtual bool ShouldForceFinish(IGModAudioChannelEncoder* pEncoder, void* nSignalData)
 	{
-		//if (m_pLua == nSignalData)
-		//	return true; // Force finish as this is our signal that our interface is shutting down!
+		if (m_pLua == nSignalData)
+			return true; // Force finish as this is our signal that our interface is shutting down!
 
 		return false;
 	};
 
 	virtual void OnFinish(IGModAudioChannelEncoder* pEncoder, GModEncoderStatus nStatus)
-	{
-		m_bIsBassDone = true;
-
-		if (m_bForceDelete)
-			delete this; // We serve no purpose... Lua is gone :NOOOOO:
-	};
-
-	bool IsDone()
-	{
-		return m_bIsBassDone;
-	}
-
-	void Done(GarrysMod::Lua::ILuaInterface* LUA)
 	{
 		if (m_nCallbackReference == -1)
 			return;
 
-		Util::ReferencePush(LUA, m_nCallbackReference);
-		if (m_nBassStatus == GModEncoderStatus::FINISHED) {
-			LUA->PushBool(true);
-			LUA->PushNil();
+		Util::ReferencePush(m_pLua, m_nCallbackReference);
+		if (nStatus == GModEncoderStatus::FINISHED) {
+			m_pLua->PushBool(true);
+			m_pLua->PushNil();
 		} else {
-			LUA->PushBool(false);
-			LUA->PushString("Encoder was interrupted by Lua shutdown!");
+			m_pLua->PushBool(false);
+			m_pLua->PushString("Encoder was interrupted by Lua shutdown!");
 		}
-		LUA->CallFunctionProtected(2, 0, true);
-
-		Util::ReferenceFree(LUA, m_nCallbackReference, "BassEncoderCallback - callback deletion OnFinish");
-		m_nCallbackReference = -1;
-	}
+		m_pLua->CallFunctionProtected(2, 0, true);
 
-	void OnShutdown()
-	{
+		Util::ReferenceFree(m_pLua, m_nCallbackReference, "BassEncoderCallback - callback deletion OnFinish");
 		m_nCallbackReference = -1;
-		if (!m_bIsBassDone)
-		{
-			// Bass still uses us, so we gotta delay this
-			m_bForceDelete = true;
-			return;
-		}
-
-		delete this;
+		m_pLua = NULL;
 	}
 
 private:
-	bool m_bIsBassDone = false;
-	bool m_bForceDelete = false;
+	GarrysMod::Lua::ILuaInterface* m_pLua = nullptr;
 	int m_nCallbackReference = -1;
-	int m_nBassStatus = GModEncoderStatus::DIED;
 };
 
-#if ENABLE_UTTERLY_BROKEN_ENCODER_SHIT // https://github.com/RaphaelIT7/gmod-holylib/commit/48bc854f48aa26ec6539eabd01b66d87110b4598#diff-82711262b6e5109632243c62ed0ab8cba506cdf021817af4af807da268297bce
 LUA_FUNCTION_STATIC(IGModAudioChannel_EncodeToDisk)
 {
 	IGModAudioChannel* channel = Get_IGModAudioChannel(LUA, 1, true);
 
 	const char* pFileName = LUA->CheckString(2);
+	// NOTE: Next time ensure I fucking use CheckNumber and not CheckString to then cast :sob: only took 8+ hours to figure out
 	unsigned long nFlags = (unsigned long)LUA->CheckNumber(3);
 	LUA->CheckType(4, GarrysMod::Lua::Type::Function);
+	bool bAsync = LUA->GetBool(5);
 
 	LUA->Push(4);
-	BassEncoderCallback* pCallback = new BassEncoderCallback(LUA); // We do not manage this pointer! GModAudio does for us
+	BassEncoderCallback* pCallback = new BassEncoderCallback(LUA);
+	// We do not manage this pointer! GModAudio does for us
 
-	const char* pErrorMsg;
+	const char* pErrorMsg = NULL;
 	IGModAudioChannelEncoder* pEncoder = channel->CreateEncoder(pFileName, nFlags, pCallback, &pErrorMsg);
 	if (pErrorMsg)
 	{
@@ -433,7 +411,6 @@ LUA_FUNCTION_STATIC(IGModAudioChannel_EncodeToDisk)
 		return 2;
 	}
 
-	bool bAsync = LUA->GetBool(5);
 	pEncoder->ProcessNow(bAsync);
 	if (pEncoder->GetLastError(&pErrorMsg))
 	{
@@ -446,7 +423,6 @@ LUA_FUNCTION_STATIC(IGModAudioChannel_EncodeToDisk)
 	LUA->PushNil();
 	return 2;
 }
-#endif
 
 LUA_FUNCTION_STATIC(IGModAudioChannel_Update)
 {
@@ -488,36 +464,6 @@ LUA_FUNCTION_STATIC(IGModAudioChannel_DestroyLink)
 	return 2;
 }
 
-LUA_FUNCTION_STATIC(IGModAudioChannel_EncodeToDisk)
-{
-	IGModAudioChannel* channel = Get_IGModAudioChannel(LUA, 1, true);
-
-	const char* pFileName = LUA->CheckString(2);
-	unsigned long nFlags = (unsigned long)LUA->CheckNumber(3);
-
-	/*BassEncoderCallback* pCallback = nullptr;
-	if (LUA->IsType(4, GarrysMod::Lua::Type::Function))
-	{
-		LUA->Push(4);
-		pCallback = new BassEncoderCallback(Util::ReferenceCreate(LUA, "BassEncoderCallback - callback reference"));
-	}*/
-
-	const char* pErrorMsg = channel->EncodeToDisk(pFileName, nFlags/*, pCallback*/);
-	if (!pErrorMsg)
-	{ // Success
-		LUA->PushBool(true);
-		LUA->PushNil();
-		return 2;
-	}
-
-	// if (pCallback)
-	//	LUA->AddThreadedCall(pCallback);
-
-	LUA->PushBool(false);
-	LUA->PushString(pErrorMsg);
-	return 2;
-}
-
 LUA_FUNCTION_STATIC(IGModAudioChannel_MakeServer)
 {
 	IGModAudioChannel* channel = Get_IGModAudioChannel(LUA, 1, true);
@@ -527,8 +473,14 @@ LUA_FUNCTION_STATIC(IGModAudioChannel_MakeServer)
 	unsigned long nBurst = (unsigned long)LUA->CheckString(4);
 	unsigned long nFlags = (unsigned long)LUA->CheckString(5);
 
-	LUA->PushBool(channel->MakeServer(strPort, nBuffer, nBurst, nFlags));
-	return 1;
+	const char* pErrorCode = nullptr;
+	LUA->PushBool(channel->MakeServer(strPort, nBuffer, nBurst, nFlags, &pErrorCode));
+	if (pErrorCode) {
+		LUA->PushString(pErrorCode);
+	} else {
+		LUA->PushNil();
+	}
+	return 2;
 }
 
 LUA_FUNCTION_STATIC(bass_PlayFile)
@@ -710,9 +662,7 @@ void CBassModule::LuaShutdown(GarrysMod::Lua::ILuaInterface* pLua)
 {
 	// Finish all callbacks
 	// We pass pLua so that our BassEncoderCallback can check if its their state and force a finish
-#if ENABLE_UTTERLY_BROKEN_ENCODER_SHIT
 	gGModAudio->FinishAllAsync(pLua);
-#endif
 
 	Util::NukeTable(pLua, "bass");
 }

source/sourcesdk/IGmod_Audio.h

@@ -23,7 +23,6 @@ enum GModEncoderStatus {
 	DIED = 3,
 };
 
-#if ENABLE_UTTERLY_BROKEN_ENCODER_SHIT
 // HolyLib specific
 // NOTE: Always call GetLastError after any function call to check for errors!
 class IGModAudioChannelEncoder
@@ -40,7 +39,6 @@ class IGModAudioChannelEncoder
 	// Wasn't exposed since CreateEncoder already calls it so it has no real use
 	// virtual void InitEncoder(unsigned long nEncoderFlags) = 0;
 };
-#endif
 
 class IGModAudioChannelEncoder;
 class IGModEncoderCallback // Callback struct
@@ -95,14 +93,11 @@ class IGModAudioChannel
 	// Uses the "DATA" path for writes! Returns NULL on success, else the error message
 	// Does NOT require the channel to be a decoder channel!
 	// Call IGModAudioChannelEncoder->GetLastError and check if its even valid! (Else it will be invalidated/freed on the next tick)
-	virtual const char* EncodeToDisk( const char* pFileName, unsigned long nFlags ) = 0;
-#if ENABLE_UTTERLY_BROKEN_ENCODER_SHIT
 	virtual IGModAudioChannelEncoder* CreateEncoder( const char* pFileName, unsigned long nFlags, IGModEncoderCallback* pCallback, const char** pErrorOut ) = 0;
-#endif
 	virtual void Update( unsigned long length ) = 0; // Updates the playback buffer
 	virtual bool CreateLink( IGModAudioChannel* pChannel, const char** pErrorOut ) = 0;
 	virtual bool DestroyLink( IGModAudioChannel* pChannel, const char** pErrorOut ) = 0;
-	virtual bool MakeServer(const char* port, unsigned long buffer, unsigned long burst, unsigned long flags) = 0;
+	virtual bool MakeServer( const char* port, unsigned long buffer, unsigned long burst, unsigned long flags, const char** pErrorOut ) = 0;
 };
 
 class IAudioStreamEvent;
@@ -144,9 +139,7 @@ abstract_class IGMod_Audio
 	// HolyLib specific ones
 	virtual unsigned long GetVersion() = 0; // Returns bass version
 	virtual bool LoadPlugin(const char* pluginName, const char** pErrorOut) = 0;
-#if ENABLE_UTTERLY_BROKEN_ENCODER_SHIT
 	virtual void FinishAllAsync(void* nSignalData) = 0; // Called on Lua shutdown to finish all callbacks/async tasks for that interface
-#endif
 };
 
 #undef CALLBACK // Solves another error with minwindef.h