bb
157c6af18e
Avoid cases of filenames Update years in terms and other legal(ish) documents Don't update years in license headers, since change is not meaningful Will add linter rule in seperate commit Happy recompiling everyone! Original Patch By: Nescio Comment By: Gallaecio Differential Revision: D2620 This was SVN commit r27786.
422 lines
12 KiB
C++
422 lines
12 KiB
C++
/* Copyright (C) 2023 Wildfire Games.
|
|
* This file is part of 0 A.D.
|
|
*
|
|
* 0 A.D. is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* 0 A.D. is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "precompiled.h"
|
|
|
|
#include "MapGenerator.h"
|
|
|
|
#include "graphics/MapIO.h"
|
|
#include "graphics/Patch.h"
|
|
#include "graphics/Terrain.h"
|
|
#include "lib/status.h"
|
|
#include "lib/timer.h"
|
|
#include "lib/file/vfs/vfs_path.h"
|
|
#include "maths/MathUtil.h"
|
|
#include "ps/CLogger.h"
|
|
#include "ps/FileIo.h"
|
|
#include "ps/Profile.h"
|
|
#include "ps/TaskManager.h"
|
|
#include "ps/scripting/JSInterface_VFS.h"
|
|
#include "scriptinterface/FunctionWrapper.h"
|
|
#include "scriptinterface/JSON.h"
|
|
#include "scriptinterface/Object.h"
|
|
#include "scriptinterface/ScriptContext.h"
|
|
#include "scriptinterface/ScriptConversions.h"
|
|
#include "scriptinterface/ScriptInterface.h"
|
|
#include "simulation2/helpers/MapEdgeTiles.h"
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
// TODO: Maybe this should be optimized depending on the map size.
|
|
constexpr int RMS_CONTEXT_SIZE = 96 * 1024 * 1024;
|
|
|
|
extern bool IsQuitRequested();
|
|
|
|
static bool
|
|
MapGeneratorInterruptCallback(JSContext* UNUSED(cx))
|
|
{
|
|
// This may not use SDL_IsQuitRequested(), because it runs in a thread separate to SDL, see SDL_PumpEvents
|
|
if (IsQuitRequested())
|
|
{
|
|
LOGWARNING("Quit requested!");
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
CMapGeneratorWorker::CMapGeneratorWorker(ScriptInterface* scriptInterface) :
|
|
m_ScriptInterface(scriptInterface)
|
|
{}
|
|
|
|
CMapGeneratorWorker::~CMapGeneratorWorker()
|
|
{
|
|
// Cancel or wait for the task to end.
|
|
m_WorkerThread.CancelOrWait();
|
|
}
|
|
|
|
void CMapGeneratorWorker::Initialize(const VfsPath& scriptFile, const std::string& settings)
|
|
{
|
|
std::lock_guard<std::mutex> lock(m_WorkerMutex);
|
|
|
|
// Set progress to positive value
|
|
m_Progress.store(1);
|
|
m_ScriptPath = scriptFile;
|
|
m_Settings = settings;
|
|
|
|
// Start generating the map asynchronously.
|
|
m_WorkerThread = Threading::TaskManager::Instance().PushTask([this]() {
|
|
PROFILE2("Map Generation");
|
|
|
|
std::shared_ptr<ScriptContext> mapgenContext = ScriptContext::CreateContext(RMS_CONTEXT_SIZE);
|
|
|
|
// Enable the script to be aborted
|
|
JS_AddInterruptCallback(mapgenContext->GetGeneralJSContext(), MapGeneratorInterruptCallback);
|
|
|
|
m_ScriptInterface = new ScriptInterface("Engine", "MapGenerator", mapgenContext);
|
|
|
|
// Run map generation scripts
|
|
if (!Run() || m_Progress.load() > 0)
|
|
{
|
|
// Don't leave progress in an unknown state, if generator failed, set it to -1
|
|
m_Progress.store(-1);
|
|
}
|
|
|
|
SAFE_DELETE(m_ScriptInterface);
|
|
|
|
// At this point the random map scripts are done running, so the thread has no further purpose
|
|
// and can die. The data will be stored in m_MapData already if successful, or m_Progress
|
|
// will contain an error value on failure.
|
|
});
|
|
}
|
|
|
|
bool CMapGeneratorWorker::Run()
|
|
{
|
|
ScriptRequest rq(m_ScriptInterface);
|
|
|
|
// Parse settings
|
|
JS::RootedValue settingsVal(rq.cx);
|
|
if (!Script::ParseJSON(rq, m_Settings, &settingsVal) && settingsVal.isUndefined())
|
|
{
|
|
LOGERROR("CMapGeneratorWorker::Run: Failed to parse settings");
|
|
return false;
|
|
}
|
|
|
|
// Prevent unintentional modifications to the settings object by random map scripts
|
|
if (!Script::FreezeObject(rq, settingsVal, true))
|
|
{
|
|
LOGERROR("CMapGeneratorWorker::Run: Failed to deepfreeze settings");
|
|
return false;
|
|
}
|
|
|
|
// Init RNG seed
|
|
u32 seed = 0;
|
|
if (!Script::HasProperty(rq, settingsVal, "Seed") ||
|
|
!Script::GetProperty(rq, settingsVal, "Seed", seed))
|
|
LOGWARNING("CMapGeneratorWorker::Run: No seed value specified - using 0");
|
|
|
|
InitScriptInterface(seed);
|
|
|
|
RegisterScriptFunctions_MapGenerator();
|
|
|
|
// Copy settings to global variable
|
|
JS::RootedValue global(rq.cx, rq.globalValue());
|
|
if (!Script::SetProperty(rq, global, "g_MapSettings", settingsVal, true, true))
|
|
{
|
|
LOGERROR("CMapGeneratorWorker::Run: Failed to define g_MapSettings");
|
|
return false;
|
|
}
|
|
|
|
// Load RMS
|
|
LOGMESSAGE("Loading RMS '%s'", m_ScriptPath.string8());
|
|
if (!m_ScriptInterface->LoadGlobalScriptFile(m_ScriptPath))
|
|
{
|
|
LOGERROR("CMapGeneratorWorker::Run: Failed to load RMS '%s'", m_ScriptPath.string8());
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
#define REGISTER_MAPGEN_FUNC(func) \
|
|
ScriptFunction::Register<&CMapGeneratorWorker::func, ScriptInterface::ObjectFromCBData<CMapGeneratorWorker>>(rq, #func);
|
|
#define REGISTER_MAPGEN_FUNC_NAME(func, name) \
|
|
ScriptFunction::Register<&CMapGeneratorWorker::func, ScriptInterface::ObjectFromCBData<CMapGeneratorWorker>>(rq, name);
|
|
|
|
void CMapGeneratorWorker::InitScriptInterface(const u32 seed)
|
|
{
|
|
m_ScriptInterface->SetCallbackData(static_cast<void*>(this));
|
|
|
|
m_ScriptInterface->ReplaceNondeterministicRNG(m_MapGenRNG);
|
|
m_MapGenRNG.seed(seed);
|
|
|
|
// VFS
|
|
JSI_VFS::RegisterScriptFunctions_ReadOnlySimulationMaps(*m_ScriptInterface);
|
|
|
|
// Globalscripts may use VFS script functions
|
|
m_ScriptInterface->LoadGlobalScripts();
|
|
|
|
// File loading
|
|
ScriptRequest rq(m_ScriptInterface);
|
|
REGISTER_MAPGEN_FUNC_NAME(LoadScripts, "LoadLibrary");
|
|
REGISTER_MAPGEN_FUNC_NAME(LoadHeightmap, "LoadHeightmapImage");
|
|
REGISTER_MAPGEN_FUNC(LoadMapTerrain);
|
|
|
|
// Engine constants
|
|
|
|
// Length of one tile of the terrain grid in metres.
|
|
// Useful to transform footprint sizes to the tilegrid coordinate system.
|
|
m_ScriptInterface->SetGlobal("TERRAIN_TILE_SIZE", static_cast<int>(TERRAIN_TILE_SIZE));
|
|
|
|
// Number of impassable tiles at the map border
|
|
m_ScriptInterface->SetGlobal("MAP_BORDER_WIDTH", static_cast<int>(MAP_EDGE_TILES));
|
|
}
|
|
|
|
void CMapGeneratorWorker::RegisterScriptFunctions_MapGenerator()
|
|
{
|
|
ScriptRequest rq(m_ScriptInterface);
|
|
|
|
// Template functions
|
|
REGISTER_MAPGEN_FUNC(GetTemplate);
|
|
REGISTER_MAPGEN_FUNC(TemplateExists);
|
|
REGISTER_MAPGEN_FUNC(FindTemplates);
|
|
REGISTER_MAPGEN_FUNC(FindActorTemplates);
|
|
|
|
// Progression and profiling
|
|
REGISTER_MAPGEN_FUNC(SetProgress);
|
|
REGISTER_MAPGEN_FUNC(GetMicroseconds);
|
|
REGISTER_MAPGEN_FUNC(ExportMap);
|
|
}
|
|
|
|
#undef REGISTER_MAPGEN_FUNC
|
|
#undef REGISTER_MAPGEN_FUNC_NAME
|
|
|
|
int CMapGeneratorWorker::GetProgress() const
|
|
{
|
|
return m_Progress.load();
|
|
}
|
|
|
|
double CMapGeneratorWorker::GetMicroseconds()
|
|
{
|
|
return JS_Now();
|
|
}
|
|
|
|
Script::StructuredClone CMapGeneratorWorker::GetResults()
|
|
{
|
|
std::lock_guard<std::mutex> lock(m_WorkerMutex);
|
|
return m_MapData;
|
|
}
|
|
|
|
void CMapGeneratorWorker::ExportMap(JS::HandleValue data)
|
|
{
|
|
{
|
|
// Copy results
|
|
std::lock_guard<std::mutex> lock(m_WorkerMutex);
|
|
m_MapData = Script::WriteStructuredClone(ScriptRequest(m_ScriptInterface), data);
|
|
}
|
|
m_Progress.store(0);
|
|
}
|
|
|
|
void CMapGeneratorWorker::SetProgress(int progress)
|
|
{
|
|
// When the task is started, `m_Progress` is only mutated by this thread.
|
|
const int currentProgress = m_Progress.load();
|
|
if (progress >= currentProgress)
|
|
m_Progress.store(progress);
|
|
else
|
|
LOGWARNING("The random map script tried to reduce the loading progress from %d to %d",
|
|
currentProgress, progress);
|
|
}
|
|
|
|
CParamNode CMapGeneratorWorker::GetTemplate(const std::string& templateName)
|
|
{
|
|
const CParamNode& templateRoot = m_TemplateLoader.GetTemplateFileData(templateName).GetOnlyChild();
|
|
if (!templateRoot.IsOk())
|
|
LOGERROR("Invalid template found for '%s'", templateName.c_str());
|
|
|
|
return templateRoot;
|
|
}
|
|
|
|
bool CMapGeneratorWorker::TemplateExists(const std::string& templateName)
|
|
{
|
|
return m_TemplateLoader.TemplateExists(templateName);
|
|
}
|
|
|
|
std::vector<std::string> CMapGeneratorWorker::FindTemplates(const std::string& path, bool includeSubdirectories)
|
|
{
|
|
return m_TemplateLoader.FindTemplates(path, includeSubdirectories, SIMULATION_TEMPLATES);
|
|
}
|
|
|
|
std::vector<std::string> CMapGeneratorWorker::FindActorTemplates(const std::string& path, bool includeSubdirectories)
|
|
{
|
|
return m_TemplateLoader.FindTemplates(path, includeSubdirectories, ACTOR_TEMPLATES);
|
|
}
|
|
|
|
bool CMapGeneratorWorker::LoadScripts(const VfsPath& libraryName)
|
|
{
|
|
// Ignore libraries that are already loaded
|
|
if (m_LoadedLibraries.find(libraryName) != m_LoadedLibraries.end())
|
|
return true;
|
|
|
|
// Mark this as loaded, to prevent it recursively loading itself
|
|
m_LoadedLibraries.insert(libraryName);
|
|
|
|
VfsPath path = VfsPath(L"maps/random/") / libraryName / VfsPath();
|
|
VfsPaths pathnames;
|
|
|
|
// Load all scripts in mapgen directory
|
|
Status ret = vfs::GetPathnames(g_VFS, path, L"*.js", pathnames);
|
|
if (ret == INFO::OK)
|
|
{
|
|
for (const VfsPath& p : pathnames)
|
|
{
|
|
LOGMESSAGE("Loading map generator script '%s'", p.string8());
|
|
|
|
if (!m_ScriptInterface->LoadGlobalScriptFile(p))
|
|
{
|
|
LOGERROR("CMapGeneratorWorker::LoadScripts: Failed to load script '%s'", p.string8());
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Some error reading directory
|
|
wchar_t error[200];
|
|
LOGERROR("CMapGeneratorWorker::LoadScripts: Error reading scripts in directory '%s': %s", path.string8(), utf8_from_wstring(StatusDescription(ret, error, ARRAY_SIZE(error))));
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
JS::Value CMapGeneratorWorker::LoadHeightmap(const VfsPath& filename)
|
|
{
|
|
std::vector<u16> heightmap;
|
|
if (LoadHeightmapImageVfs(filename, heightmap) != INFO::OK)
|
|
{
|
|
LOGERROR("Could not load heightmap file '%s'", filename.string8());
|
|
return JS::UndefinedValue();
|
|
}
|
|
|
|
ScriptRequest rq(m_ScriptInterface);
|
|
JS::RootedValue returnValue(rq.cx);
|
|
Script::ToJSVal(rq, &returnValue, heightmap);
|
|
return returnValue;
|
|
}
|
|
|
|
// See CMapReader::UnpackTerrain, CMapReader::ParseTerrain for the reordering
|
|
JS::Value CMapGeneratorWorker::LoadMapTerrain(const VfsPath& filename)
|
|
{
|
|
ScriptRequest rq(m_ScriptInterface);
|
|
|
|
if (!VfsFileExists(filename))
|
|
{
|
|
ScriptException::Raise(rq, "Terrain file \"%s\" does not exist!", filename.string8().c_str());
|
|
return JS::UndefinedValue();
|
|
}
|
|
|
|
CFileUnpacker unpacker;
|
|
unpacker.Read(filename, "PSMP");
|
|
|
|
if (unpacker.GetVersion() < CMapIO::FILE_READ_VERSION)
|
|
{
|
|
ScriptException::Raise(rq, "Could not load terrain file \"%s\" too old version!", filename.string8().c_str());
|
|
return JS::UndefinedValue();
|
|
}
|
|
|
|
// unpack size
|
|
ssize_t patchesPerSide = (ssize_t)unpacker.UnpackSize();
|
|
size_t verticesPerSide = patchesPerSide * PATCH_SIZE + 1;
|
|
|
|
// unpack heightmap
|
|
std::vector<u16> heightmap;
|
|
heightmap.resize(SQR(verticesPerSide));
|
|
unpacker.UnpackRaw(&heightmap[0], SQR(verticesPerSide) * sizeof(u16));
|
|
|
|
// unpack texture names
|
|
size_t textureCount = unpacker.UnpackSize();
|
|
std::vector<std::string> textureNames;
|
|
textureNames.reserve(textureCount);
|
|
for (size_t i = 0; i < textureCount; ++i)
|
|
{
|
|
CStr texturename;
|
|
unpacker.UnpackString(texturename);
|
|
textureNames.push_back(texturename);
|
|
}
|
|
|
|
// unpack texture IDs per tile
|
|
ssize_t tilesPerSide = patchesPerSide * PATCH_SIZE;
|
|
std::vector<CMapIO::STileDesc> tiles;
|
|
tiles.resize(size_t(SQR(tilesPerSide)));
|
|
unpacker.UnpackRaw(&tiles[0], sizeof(CMapIO::STileDesc) * tiles.size());
|
|
|
|
// reorder by patches and store and save texture IDs per tile
|
|
std::vector<u16> textureIDs;
|
|
for (ssize_t x = 0; x < tilesPerSide; ++x)
|
|
{
|
|
size_t patchX = x / PATCH_SIZE;
|
|
size_t offX = x % PATCH_SIZE;
|
|
for (ssize_t y = 0; y < tilesPerSide; ++y)
|
|
{
|
|
size_t patchY = y / PATCH_SIZE;
|
|
size_t offY = y % PATCH_SIZE;
|
|
// m_Priority and m_Tex2Index unused
|
|
textureIDs.push_back(tiles[(patchY * patchesPerSide + patchX) * SQR(PATCH_SIZE) + (offY * PATCH_SIZE + offX)].m_Tex1Index);
|
|
}
|
|
}
|
|
|
|
JS::RootedValue returnValue(rq.cx);
|
|
|
|
Script::CreateObject(
|
|
rq,
|
|
&returnValue,
|
|
"height", heightmap,
|
|
"textureNames", textureNames,
|
|
"textureIDs", textureIDs);
|
|
|
|
return returnValue;
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////
|
|
//////////////////////////////////////////////////////////////////////////////////
|
|
|
|
CMapGenerator::CMapGenerator() : m_Worker(new CMapGeneratorWorker(nullptr))
|
|
{
|
|
}
|
|
|
|
CMapGenerator::~CMapGenerator()
|
|
{
|
|
delete m_Worker;
|
|
}
|
|
|
|
void CMapGenerator::GenerateMap(const VfsPath& scriptFile, const std::string& settings)
|
|
{
|
|
m_Worker->Initialize(scriptFile, settings);
|
|
}
|
|
|
|
int CMapGenerator::GetProgress() const
|
|
{
|
|
return m_Worker->GetProgress();
|
|
}
|
|
|
|
Script::StructuredClone CMapGenerator::GetResults()
|
|
{
|
|
return m_Worker->GetResults();
|
|
}
|