Basic custom resource

Author: Bamcane

CMakeLists.txt

@@ -1306,6 +1306,7 @@ set_src(GAME_SHARED GLOB src/game
   layers.cpp
   layers.h
   mapitems.h
+  resource.h
   tuning.h
   variables.h
   version.h
@@ -1415,6 +1416,8 @@ if(CLIENT)
     components/particles.h
     components/players.cpp
     components/players.h
+    components/resource.cpp
+    components/resource.h
     components/scoreboard.cpp
     components/scoreboard.h
     components/skins.cpp
@@ -1559,6 +1562,8 @@ set_src(GAME_SERVER GLOB_RECURSE src/game/server
   gameworld.h
   player.cpp
   player.h
+  resource.cpp
+  resource.h
 )
 set(GAME_GENERATED_SERVER
   src/generated/server_data.cpp

datasrc/datatypes.py

@@ -304,6 +304,33 @@ def emit_unpack(self):
 	def emit_unpack_check(self):
 		return []
 
+
+class NetRawData(NetVariable):
+	def emit_declaration(self):
+		return [f"const void *{self.name};", f"int {self.name}Size;"]
+	def emit_unpack(self):
+		return [f"pMsg->{self.name}Size = pUnpacker->GetInt();", f"pMsg->{self.name} = pUnpacker->GetRaw(pMsg->{self.name}Size);"]
+	def emit_pack(self):
+		return [f"pPacker->AddInt({self.name}Size);", f"pPacker->AddRaw({self.name}, {self.name}Size);"]
+
+class NetRawDataFixed(NetVariable):
+	def __init__(self, name, data_size, default=None):
+		NetVariable.__init__(self,name,default=default)
+		self.data_size = data_size
+	def emit_declaration(self):
+		return [f"const void *{self.name};"]
+	def emit_unpack(self):
+		return [f"pMsg->{self.name} = pUnpacker->GetRaw({self.data_size});"]
+	def emit_pack(self):
+		return [f"pPacker->AddRaw({self.name}, {self.data_size});"]
+
+class NetRawDataFixedSnapshot(NetVariable):
+	def __init__(self, name, data_size, default=None):
+		NetVariable.__init__(self,name,default=default)
+		self.data_size = data_size
+	def emit_declaration(self):
+		return [f"unsigned char {self.name}[{self.data_size}];"]
+
 class NetString(NetVariable):
 	def emit_declaration(self):
 		return ["const char *%s;"%self.name]

datasrc/network.py

@@ -22,8 +22,12 @@
 
 GamePredictionFlags = Flags("GAMEPREDICTIONFLAG", ["EVENT", "INPUT"])
 
+Resources = Enum("RESOURCE", ["SOUND", "IMAGE"])
+
 RawHeader = '''
 
+#include <base/hash.h>
+#include <base/uuid.h>
 #include <engine/message.h>
 #include <engine/shared/protocol_ex.h>
 
@@ -75,6 +79,7 @@
 	Votes,
 	ChatModes,
 	GameMsgIDs,
+    Resources,
 ]
 
 Flags = [
@@ -274,6 +279,10 @@
 
 	NetObjectEx("GameDataPrediction", "game-data-prediction@netobj.teeworlds.wiki", [
         NetFlag("m_PredictionFlags", GamePredictionFlags),
+	]),
+
+	NetEventEx("CustomSoundWorld:Common", "custom-sound-world@netevent.teeworlds.wiki", [
+        NetRawDataFixedSnapshot("m_Uuid", "sizeof(Uuid)")
 	])
 ]
 
@@ -490,4 +499,19 @@
 			NetStringStrict("m_Arguments")
 	]),
 
+	NetMessageEx("Sv_CustomRes", "custom-res@netmsg.teeworlds.wiki", [
+			NetRawDataFixed("m_Uuid", "sizeof(Uuid)"),
+            NetEnum("m_Type", Resources),
+			NetStringStrict("m_Name"),
+			NetIntAny("m_Crc"),
+            NetIntRange("m_Size", 0, 'max_int'),
+            NetRawDataFixed("m_Sha256", "sizeof(SHA256_DIGEST)"),
+	]),
+	NetMessageEx("Sv_CustomResData", "custom-res-data@netmsg.teeworlds.wiki", [
+			NetRawDataFixed("m_Uuid", "sizeof(Uuid)"),
+            NetRawData("m_Data"),
+	]),
+	NetMessageEx("Cl_ReqeustCustomRes", "request-custom-res@netmsg.teeworlds.wiki", [
+			NetRawDataFixed("m_Uuid", "sizeof(Uuid)"),
+    ]),
 ]

src/base/uuid.h

@@ -46,6 +46,16 @@ inline bool operator!=(const Uuid &that, const Uuid &other)
 {
 	return !(that == other);
 }
+
+inline bool operator<(const Uuid &that, const Uuid &other)
+{
+	return uuid_comp(that, other) < 0;
+}
+
+inline bool operator<=(const Uuid &that, const Uuid &other)
+{
+	return uuid_comp(that, other) < 1;
+}
 #endif
 
 #endif // BASE_UUID_H

src/engine/client/sound.cpp

@@ -332,11 +332,10 @@ void CSound::RateConvert(int SampleID)
 	pSample->m_NumFrames = NumFrames;
 }
 
-ISound::CSampleHandle CSound::LoadOpus(const char *pFilename)
+ISound::CSampleHandle CSound::LoadOpusMemory(const char *pContext, const unsigned char *pData, int DataSize)
 {
 	CSample *pSample;
 	int SampleID = -1;
-
 	// don't waste memory on sound when we are stress testing
 #ifdef CONF_DEBUG
 	if(m_pConfig->m_DbgStress)
@@ -349,23 +348,16 @@ ISound::CSampleHandle CSound::LoadOpus(const char *pFilename)
 
 	if(!m_pStorage)
 		return CSampleHandle();
-
-	lock_wait(m_SoundLock);
-	unsigned char *pFileData;
-	unsigned FileSize;
-	if(!m_pStorage->ReadFile(pFilename, IStorage::TYPE_ALL, (void **) &pFileData, &FileSize))
-	{
-		dbg_msg("sound/opus", "failed to open file. filename='%s'", pFilename);
-		lock_unlock(m_SoundLock);
+	
+	if(!pContext || !pData || DataSize <= 0)
 		return CSampleHandle();
-	}
 
+	lock_wait(m_SoundLock);
 	int Error = 0;
-	OggOpusFile *pOpusFile = op_open_memory(pFileData, FileSize, &Error);
+	OggOpusFile *pOpusFile = op_open_memory(pData, DataSize, &Error);
 	if(!pOpusFile)
 	{
-		dbg_msg("sound/opus", "failed to open opus file '%s': error %d", pFilename, Error);
-		mem_free(pFileData);
+		dbg_msg("sound/opus", "failed to open opus '%s': error %d", pContext, Error);
 		lock_unlock(m_SoundLock);
 		return CSampleHandle();
 	}
@@ -374,19 +366,17 @@ ISound::CSampleHandle CSound::LoadOpus(const char *pFilename)
 	;
 	if(NumChannels < 0 || NumChannels > 2)
 	{
-		dbg_msg("sound/opus", "only mono/stereo supported. channels=%d, file='%s'", NumChannels, pFilename);
+		dbg_msg("sound/opus", "only mono/stereo supported. channels=%d, file='%s'", NumChannels, pContext);
 		op_free(pOpusFile);
-		mem_free(pFileData);
 		lock_unlock(m_SoundLock);
 		return CSampleHandle();
 	}
 
 	int TotalSamples = op_pcm_total(pOpusFile, -1);
 	if(TotalSamples < 0)
 	{
-		dbg_msg("sound/opus", "failed to get number of samples, error %d. file='%s'", TotalSamples, pFilename);
+		dbg_msg("sound/opus", "failed to get number of samples, error %d. file='%s'", TotalSamples, pContext);
 		op_free(pOpusFile);
-		mem_free(pFileData);
 		lock_unlock(m_SoundLock);
 		return CSampleHandle();
 	}
@@ -395,7 +385,6 @@ ISound::CSampleHandle CSound::LoadOpus(const char *pFilename)
 	if(SampleID < 0)
 	{
 		op_free(pOpusFile);
-		mem_free(pFileData);
 		lock_unlock(m_SoundLock);
 		return CSampleHandle();
 	}
@@ -404,7 +393,6 @@ ISound::CSampleHandle CSound::LoadOpus(const char *pFilename)
 	if(!pSample->m_pData)
 	{
 		op_free(pOpusFile);
-		mem_free(pFileData);
 		lock_unlock(m_SoundLock);
 		return CSampleHandle();
 	}
@@ -417,8 +405,7 @@ ISound::CSampleHandle CSound::LoadOpus(const char *pFilename)
 		{
 			mem_free(pSample->m_pData);
 			op_free(pOpusFile);
-			mem_free(pFileData);
-			dbg_msg("sound/opus", "op_read error %d at %d. file='%s'", Read, Pos, pFilename);
+			dbg_msg("sound/opus", "op_read error %d at %d. file='%s'", Read, Pos, pContext);
 			return CSampleHandle();
 		}
 		else if(Read == 0) // EOF
@@ -428,7 +415,6 @@ ISound::CSampleHandle CSound::LoadOpus(const char *pFilename)
 	}
 
 	op_free(pOpusFile);
-	mem_free(pFileData);
 
 	pSample->m_Channels = NumChannels;
 	pSample->m_Rate = 48000;
@@ -438,13 +424,56 @@ ISound::CSampleHandle CSound::LoadOpus(const char *pFilename)
 	pSample->m_PausedAt = 0;
 
 	if(m_pConfig->m_Debug)
-		dbg_msg("sound/opus", "loaded %s (%d samples, %d channels)", pFilename, TotalSamples, NumChannels);
+		dbg_msg("sound/opus", "loaded %s (%d samples, %d channels)", pContext, TotalSamples, NumChannels);
 
 	RateConvert(SampleID);
 	lock_unlock(m_SoundLock);
 	return CreateSampleHandle(SampleID);
 }
 
+ISound::CSampleHandle CSound::LoadOpus(const char *pFilename)
+{
+	// don't waste memory on sound when we are stress testing
+#ifdef CONF_DEBUG
+	if(m_pConfig->m_DbgStress)
+		return CSampleHandle();
+#endif
+
+	// no need to load sound when we are running with no sound
+	if(!m_SoundEnabled)
+		return CSampleHandle();
+
+	if(!m_pStorage)
+		return CSampleHandle();
+
+	unsigned char *pFileData;
+	unsigned FileSize;
+	if(!m_pStorage->ReadFile(pFilename, IStorage::TYPE_ALL, (void **) &pFileData, &FileSize))
+	{
+		dbg_msg("sound/opus", "failed to open file. filename='%s'", pFilename);
+		return CSampleHandle();
+	}
+
+	ISound::CSampleHandle Sample = LoadOpusMemory(pFilename, pFileData, FileSize);
+	mem_free(pFileData);
+	return Sample;
+}
+
+bool CSound::UnloadSample(CSampleHandle *pSampleID)
+{
+	if(!pSampleID)
+		return false;
+
+	if(m_aSamples[pSampleID->Id()].m_pData)
+	{
+		mem_free(m_aSamples[pSampleID->Id()].m_pData);
+		m_aSamples[pSampleID->Id()].m_pData = 0;
+		pSampleID->Invalidate();
+		return true;
+	}
+	return false;
+}
+
 void CSound::SetListenerPos(float x, float y)
 {
 	m_CenterX = (int) x;

src/engine/client/sound.h

@@ -24,7 +24,9 @@ class CSound : public IEngineSound
 
 	virtual bool IsSoundEnabled() { return m_SoundEnabled != 0; }
 
+	virtual CSampleHandle LoadOpusMemory(const char *pContext, const unsigned char *pData, int DataSize);
 	virtual CSampleHandle LoadOpus(const char *pFilename);
+	virtual bool UnloadSample(CSampleHandle *pSampleID);
 
 	virtual void SetListenerPos(float x, float y);
 	virtual void SetChannelVolume(int ChannelID, float Vol);

src/engine/shared/storage.cpp

@@ -69,6 +69,7 @@ class CStorage : public IStorage
 					fs_makedir(GetPath(TYPE_SAVE, "screenshots/auto", aPath, sizeof(aPath)));
 					fs_makedir(GetPath(TYPE_SAVE, "maps", aPath, sizeof(aPath)));
 					fs_makedir(GetPath(TYPE_SAVE, "downloadedmaps", aPath, sizeof(aPath)));
+					fs_makedir(GetPath(TYPE_SAVE, "downloadedres", aPath, sizeof(aPath)));
 					fs_makedir(GetPath(TYPE_SAVE, "skins", aPath, sizeof(aPath)));
 					fs_makedir(GetPath(TYPE_SAVE, "editor", aPath, sizeof(aPath)));
 				}

src/engine/sound.h

@@ -28,11 +28,14 @@ class ISound : public IInterface
 
 		bool IsValid() const { return Id() >= 0; }
 		int Id() const { return m_Id; }
+		void Invalidate() { m_Id = -1; }
 	};
 
 	virtual bool IsSoundEnabled() = 0;
 
+	virtual CSampleHandle LoadOpusMemory(const char *pContext, const unsigned char *pData, int DataSize) = 0;
 	virtual CSampleHandle LoadOpus(const char *pFilename) = 0;
+	virtual bool UnloadSample(CSampleHandle *pSampleID) = 0;
 
 	virtual void SetChannelVolume(int ChannelID, float Volume) = 0;
 	virtual void SetListenerPos(float x, float y) = 0;