Add liveatc and fix webaudio counter not decreasing w/ client errors

Fixes #52

Resolved an error where a client having an error sending the error to the server would not decrease the webaudio counter, leaving players without any slots left to use webaudio without rejoining.

Author: vurvdev

WHITELIST.md

@@ -29,4 +29,5 @@ This is the default whitelist that webaudio will abide by unless a ``webaudio_wh
 | Onedrive | ➖ | onedrive.live.com | Onedrive content | 🚧 |
 | Mattjeanes ytdl | ❔ | youtubedl.mattjeanes.com | Ytdl host by mattjeanes https://github.com/MattJeanes/YouTubeDL | 🚧 |
 | MyInstants | ✔️ | myinstants.com | Sound effects | https://myinstants.com/media/sounds/taco-bell-bong-sfx.mp3 |
-| Moonbase Alpha TTS | ✔️ | tts.cyzon.us | TTS almost identical to moonbase alpha's | https://tts.cyzon.us/tts?text=bruh |
+| Moonbase Alpha TTS | ✔️ | tts.cyzon.us | TTS almost identical to moonbase alpha's | https://tts.cyzon.us/tts?text=bruh |
+| LiveATC | ➖ | liveatc.net | US Air Traffic Control radio host | https://www.liveatc.net/hlisten.php?mount=lszh1_app_east&icao=lszh |

lua/autorun/stopwatch.lua

@@ -1,5 +1,3 @@
-
-
 --[[
 	StopWatch/TimerEx Library
 	Author: Vurv
@@ -31,7 +29,10 @@ local timer_now = RealTime
 ---@param duration number # How long the stopwatch will last
 ---@param callback fun(self: Stopwatch) # What to run when the stopwatch finishes.
 ---@return Stopwatch
-local function Initialize(_, duration, callback)
+function Stopwatch.new(duration, callback)
+	assert(duration, "bad argument #1 to 'Stopwatch.new' (number expected)")
+	assert(callback, "bad argument #2 to 'Stopwatch.new' (function expected)")
+
 	local self = setmetatable({}, Stopwatch)
 	self.playback_rate = 1
 	self.playback_now = timer_now()
@@ -64,8 +65,11 @@ local function Initialize(_, duration, callback)
 	return self
 end
 
+-- Backwards compatibility with __call version
 setmetatable(Stopwatch, {
-	__call = Initialize
+	__call = function(self, ...)
+		return self.new(...)
+	end
 })
 
 --- Pauses a stopwatch at the current time to be resumed with :Play
@@ -196,5 +200,6 @@ function Stopwatch:GetLooping()
 end
 
 _G.StopWatch = Stopwatch
+_G.Stopwatch = Stopwatch
 
 return Stopwatch

lua/autorun/webaudio.lua

@@ -3,8 +3,7 @@
 	(part 1)
 ]]
 
---- x86 branch is on an outdated luajit that doesn't support binary literals. Woo
--- i love the game "garry's mod" created by Garry Newman as a mod for Valve's Source game engine and released in December 2004, before being expanded into a standalone release that was published by Valve in November 2006.
+--- x86 branch is on LuaJIT 2.0.4 which doesn't support binary literals
 local function b(s)
 	return tonumber(s, 2)
 end
@@ -133,6 +132,7 @@ end
 ---@field id integer # Custom ID for webaudio stream allocated between 0-MAX
 ---@field ignored GCRecipientFilter # Players to ignore when sending net messages.
 ---@field mode WebAudioMode
+---@field hook_destroy table<fun(self: WebAudio), boolean> # SHARED. Hooks to run before/when the stream is destroyed.
 _G.WebAudio = {}
 WebAudio.__index = WebAudio
 
@@ -203,12 +203,22 @@ function WebAudio:IsDestroyed()
 	return self.destroyed
 end
 
+--- Calls the given function right before webaudio destruction.
+---@param fun fun(self: WebAudio)
+function WebAudio:OnDestroy(fun)
+	self.hook_destroy[fun] = true
+end
+
 --- Destroys a webaudio object and makes it the same (value wise) as WebAudio.getNULL()
 --- @param transmit boolean? If SERVER, should we transmit the destruction to the client? Default true
 function WebAudio:Destroy(transmit)
 	if self:IsDestroyed() then return end
 	if transmit == nil then transmit = true end
 
+	for callback in pairs(self.hook_destroy) do
+		callback(self)
+	end
+
 	if CLIENT and self.bass then
 		self.bass:Stop()
 	elseif transmit then
@@ -394,30 +404,9 @@ end
 
 --- Used internally. Should be called both server and client as it doesn't send any net messages to destroy the ids to the client.
 -- Called on WebAudio reload to stop all streams
-if CLIENT then
-	function WebAudioStatic.disassemble()
-		for _, stream in WebAudio.getIterator() do
-			stream:Destroy(false)
-		end
-	end
-else
-	function WebAudioStatic.disassemble()
-		-- Todo: This is a dumb hack. There should be a hook mechanism so that the E2 core doesn't need special treatment in webaudio.
-		local E2StreamCounter = WebAudio.E2StreamCounter
-
-		if E2StreamCounter then
-			for _, stream in WebAudio.getIterator() do
-				if stream.owner and E2StreamCounter[stream.owner] then
-					E2StreamCounter[stream.owner] = math.max( E2StreamCounter[stream.owner] - 1, 0 )
-				end
-
-				stream:Destroy(false)
-			end
-		else
-			for _, stream in WebAudio.getIterator() do
-				stream:Destroy(false)
-			end
-		end
+function WebAudioStatic.disassemble()
+	for _, stream in WebAudio.getIterator() do
+		stream:Destroy(false)
 	end
 end
 
@@ -426,51 +415,50 @@ local function createWebAudio(_, url, owner, bassobj, id)
 	-- assert( owner and isentity(owner) and owner:IsPlayer(), "'owner' argument must be a valid player." )
 	-- Commenting this out in case someone wants a webaudio object to be owned by the world or something.
 
-	local self = setmetatable({}, WebAudio)
-
-	self.id = id or allocID()
-	-- allocID will return nil if there's no slots left.
-	if id == nil and not self.id then
-		error("Reached maximum amount of concurrent WebAudio streams!")
-	end
+	local self = setmetatable({
+		-- allocID will return nil if there's no slots left.
+		id = assert( id or allocID(), "Reached maximum amount of concurrent WebAudio streams!" ),
+		url = url,
+		owner = owner,
+		mode = WebAudio.MODE_3D,
 
-	self.url = url
-	self.owner = owner
-	self.mode = WebAudio.MODE_3D
+		--#region mutable
+		playing = false,
+		destroyed = false,
 
-	-- Mutable --
-	self.playing = false
-	self.destroyed = false
+		parented = false,
+		parent = nil, -- Entity
 
-	self.parented = false
-	self.parent = nil -- Entity
+		modified = 0,
+		playback_rate = 1,
+		volume = 1,
+		time = 0,
 
-	self.modified = 0
+		radius = math.min(200, WAMaxRadius:GetInt()), -- Default IGmodAudioChannel radius
+		radius_sqr = math.min(200, WAMaxRadius:GetInt()) ^ 2,
 
-	self.playback_rate = 1
-	self.volume = 1
-	self.time = 0
+		pos = nil,
+		direction = Vector(0, 0, 0),
+		looping = false,
+		--#endregion mutable
 
-	self.radius = math.min(200, WAMaxRadius:GetInt()) -- Default IGmodAudioChannel radius
-	self.radius_sqr = self.radius * self.radius
+		--#region net vars
+		needs_info = SERVER, -- Whether this stream still needs information from the client.
+		length = -1,
+		filename = "",
+		fft = {},
 
-	self.pos = nil
-	self.direction = Vector(0, 0, 0)
-	self.looping = false
-	-- Mutable --
+		hook_destroy = {}
+		--#endregion net vars
+	}, WebAudio)
 
-	-- Net vars
-	self.needs_info = SERVER -- Whether this stream still needs information from the client.
-	self.length = -1
-	self.filename = ""
-	self.fft = {}
 
 	if CLIENT then
 		self.bass = bassobj
 		self.parent_pos = Vector(0, 0, 0) -- Parent pos being nil means we will go directly to the parent's position w/o calculating local pos.
 	else
 		-- Stream will be set to 100 second length until the length of the audio stream is determined by the client.
-		self.stopwatch = StopWatch(100, function(watch)
+		self.stopwatch = StopWatch.new(100, function(watch)
 			if not watch:GetLooping() then
 				self:Pause()
 			end
@@ -495,6 +483,16 @@ setmetatable(WebAudio, {
 	__call = createWebAudio
 })
 
+--- Creates a new webaudio object. Prefer this over the __call version
+---@param url string
+---@param owner GPlayer?
+---@param bassobj GIGModAudioChannel?
+---@param id number?
+---@return WebAudio
+function WebAudio.new(url, owner, bassobj, id)
+	return createWebAudio(WebAudio, url, owner, bassobj, id)
+end
+
 --[[
 	Whitelist handling
 ]]
@@ -569,7 +567,10 @@ local Whitelist = {
 	simple [[myinstants.com]],
 
 	-- TTS like moonbase alpha's
-	simple [[tts.cyzon.us]]
+	simple [[tts.cyzon.us]],
+
+	-- US Air Traffic Control radio host
+	simple [[liveatc.net]]
 }
 
 local OriginalWhitelist = table.Copy(Whitelist)

lua/entities/gmod_wire_expression2/core/custom/webaudio.lua

@@ -20,7 +20,6 @@ local Enabled, AdminOnly, FFTEnabled = Common.WAEnabled, Common.WAAdminOnly, Com
 local MaxStreams, MaxVolume, MaxRadius = Common.WAMaxStreamsPerUser, Common.WAMaxVolume, Common.WAMaxRadius
 
 local StreamCounter = WireLib.RegisterPlayerTable()
-WebAudio.E2StreamCounter = StreamCounter
 
 local CREATE_REGEN = 0.3 -- 300ms to regenerate a stream
 local NET_REGEN = 0.1 -- 100ms to regenerate net messages
@@ -57,8 +56,16 @@ registerType("webaudio", "xwa", WebAudio.getNULL(),
 )
 
 local function registerStream(self, url, owner)
-	local stream = WebAudio(url, owner)
-	table.insert(self.data.webaudio_streams, stream)
+	local stream = WebAudio.new(url, owner)
+
+	local idx = table.insert(self.data.webaudio_streams, stream)
+	StreamCounter[owner] = (StreamCounter[owner] or 0) + 1
+
+	stream:OnDestroy(function(_)
+		self.data.webaudio_streams[idx] = nil
+		StreamCounter[owner] = StreamCounter[owner] - 1
+	end)
+
 	return stream
 end
 
@@ -149,18 +156,25 @@ end
 
 --- Generic Burst limit until wiremod gets its own like Starfall.
 -- Also acts as a limit on the number of something.
-local Burst = setmetatable({}, {
-	__call = function(self, max, regen_time)
-		return setmetatable({
-			max = max, -- Will start full.
-
-			regen = regen_time,
-			tracker = WireLib.RegisterPlayerTable()
-		}, self)
-	end
-})
+---@class Burst
+---@field max number
+---@field regen number
+---@field tracker table<GPlayer, { stock: number, last: number }>
+local Burst = {}
 Burst.__index = Burst
 
+---@param max number
+---@param regen_time number
+---@return Burst
+function Burst.new(max, regen_time)
+	return setmetatable({
+		max = max, -- Will start full.
+
+		regen = regen_time,
+		tracker = WireLib.RegisterPlayerTable()
+	}, Burst)
+end
+
 function Burst:get(ply)
 	local data = self.tracker[ply]
 	if data then
@@ -188,6 +202,7 @@ function Burst:check(ply)
 	end
 end
 
+---@param ply GPlayer
 function Burst:use(ply)
 	local data = self.tracker[ply]
 	if data then
@@ -212,21 +227,18 @@ function Burst:use(ply)
 	end
 end
 
-local CreationBurst = Burst( MaxStreams:GetInt(), CREATE_REGEN ) -- Prevent too many creations at once. (To avoid Creation->Destruction net spam.)
-local NetBurst = Burst( 10, NET_REGEN ) -- In order to prevent too many updates at once.
+local CreationBurst = Burst.new( MaxStreams:GetInt(), CREATE_REGEN ) -- Prevent too many creations at once. (To avoid Creation->Destruction net spam.)
+local NetBurst = Burst.new( 10, NET_REGEN ) -- In order to prevent too many updates at once.
 
 cvars.RemoveChangeCallback("wa_stream_max", "wa_stream_max")
 
 cvars.AddChangeCallback("wa_stream_max", function(_cvar_name, _old, new)
 	CreationBurst.max = new
 end, "wa_stream_max")
 
-local function checkCounter(ply, use)
+local function checkCounter(ply)
 	local count = StreamCounter[ply] or 0
 	if count < MaxStreams:GetInt() then
-		if use then
-			StreamCounter[ply] = count + 1
-		end
 		return true
 	end
 	return false
@@ -257,7 +269,7 @@ registerFunction("webAudio", "s", "xwa", function(self, args)
 	end
 
 	-- Stream Count Quota
-	if not checkCounter(ply, true) then
+	if not checkCounter(ply) then
 		E2Lib.raiseException("Reached maximum amount of WebAudio streams! Check webAudioCanCreate or webAudiosLeft before calling!", nil, self.trace)
 	end
 
@@ -367,15 +379,8 @@ registerFunction("destroy", "xwa:", "n", function(self, args)
 	local op1 = args[2]
 	---@type WebAudio
 	local this = op1[1](self, op1)
-
 	-- No limit here because they'd already have been limited by the creation burst.
-	local owner = this.owner or self.player
-	-- Prevent people destroying others streams and getting more slots? Would be weird.
-	if this:Destroy() then
-		StreamCounter[owner] = StreamCounter[owner] - 1
-		return 1
-	end
-	return 0
+	return this:Destroy() and 1 or 0
 end)
 
 -- void webaudio:update()
@@ -849,21 +854,15 @@ registerCallback("construct", function(self)
 end)
 
 registerCallback("destruct", function(self)
-	---@type GPlayer
-	local owner = self.player
 	---@type table<number, WebAudio>
 	local streams = self.data.webaudio_streams
 
-	local count = StreamCounter[owner] or 0
-
 	for k, stream in pairs(streams) do
 		if stream:IsValid() then
-			count = count - 1 -- Assume StreamCounter[owner] is not nil since we're looping through self.webaudio_streams. If it is nil, something really fucked up.
 			stream:Destroy(true)
 		end
 		streams[k] = nil
 	end
-	StreamCounter[owner] = count
 end)
 
 --#endregion cleanup