3
0

BuilderSettingManager.cpp 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766
  1. /*
  2. * Copyright (c) Contributors to the Open 3D Engine Project.
  3. * For complete copyright and license terms please see the LICENSE at the root of this distribution.
  4. *
  5. * SPDX-License-Identifier: Apache-2.0 OR MIT
  6. *
  7. */
  8. #include "BuilderSettingManager.h"
  9. #include <QCoreApplication>
  10. #include <QDirIterator>
  11. #include <QFile>
  12. #include <QFileInfo>
  13. #include <QString>
  14. #include <Atom/ImageProcessing/PixelFormats.h>
  15. #include <BuilderSettings/CubemapSettings.h>
  16. #include <BuilderSettings/TextureSettings.h>
  17. #include <Converters/Cubemap.h>
  18. #include <Processing/ImageToProcess.h>
  19. #include <Processing/PixelFormatInfo.h>
  20. #include <Processing/Utils.h>
  21. #include <ImageLoader/ImageLoaders.h>
  22. #include <ImageProcessing_Traits_Platform.h>
  23. #include <AssetBuilderSDK/AssetBuilderSDK.h>
  24. #include <AzCore/IO/Path/Path.h>
  25. #include <AzCore/Math/Sha1.h>
  26. #include <AzCore/Serialization/Json/JsonSerialization.h>
  27. #include <AzCore/Serialization/SerializeContext.h>
  28. #include <AzCore/Serialization/ObjectStream.h>
  29. #include <AzCore/Serialization/Utils.h>
  30. #include <AzCore/std/smart_ptr/make_shared.h>
  31. #include <AzCore/std/string/string.h>
  32. #include <AzFramework/IO/LocalFileIO.h>
  33. #include <AzFramework/StringFunc/StringFunc.h>
  34. #include <AzFramework/Application/Application.h>
  35. #include <AzToolsFramework/API/EditorAssetSystemAPI.h>
  36. #include <AzCore/Serialization/Json/JsonUtils.h>
  37. namespace ImageProcessingAtom
  38. {
  39. const char* BuilderSettingManager::s_defaultConfigFolder = "@gemroot:ImageProcessingAtom@/Assets/Config/";
  40. const char* BuilderSettingManager::s_projectConfigRelativeFolder = "Config/AtomImageBuilder/";
  41. const char* BuilderSettingManager::s_builderSettingFileName = "ImageBuilder.settings";
  42. const char* BuilderSettingManager::s_presetFileExtension = "preset";
  43. const char FileMaskDelimiter = '_';
  44. namespace
  45. {
  46. [[maybe_unused]] static constexpr const char* const LogWindow = "Image Processing";
  47. }
  48. #if defined(AZ_TOOLS_EXPAND_FOR_RESTRICTED_PLATFORMS)
  49. #define AZ_RESTRICTED_PLATFORM_EXPANSION(CodeName, CODENAME, codename, PrivateName, PRIVATENAME, privatename, PublicName, PUBLICNAME, publicname, PublicAuxName1, PublicAuxName2, PublicAuxName3) \
  50. namespace ImageProcess##PrivateName \
  51. { \
  52. bool DoesSupport(AZStd::string); \
  53. }
  54. AZ_TOOLS_EXPAND_FOR_RESTRICTED_PLATFORMS
  55. #undef AZ_RESTRICTED_PLATFORM_EXPANSION
  56. #endif //AZ_TOOLS_EXPAND_FOR_RESTRICTED_PLATFORMS
  57. const char* BuilderSettingManager::s_environmentVariableName = "ImageBuilderSettingManager_Atom";
  58. AZ::EnvironmentVariable<BuilderSettingManager*> BuilderSettingManager::s_globalInstance = nullptr;
  59. AZStd::mutex BuilderSettingManager::s_instanceMutex;
  60. const PlatformName BuilderSettingManager::s_defaultPlatform = AZ_TRAIT_IMAGEPROCESSING_DEFAULT_PLATFORM;
  61. void BuilderSettingManager::Reflect(AZ::ReflectContext* context)
  62. {
  63. AZ::SerializeContext* serialize = azrtti_cast<AZ::SerializeContext*>(context);
  64. if (serialize)
  65. {
  66. serialize->Class<BuilderSettingManager>()
  67. ->Version(2)
  68. ->Field("BuildSettings", &BuilderSettingManager::m_builderSettings)
  69. ->Field("PresetsByFileMask", &BuilderSettingManager::m_presetFilterMap)
  70. ->Field("DefaultPreset", &BuilderSettingManager::m_defaultPreset)
  71. ->Field("DefaultPresetAlpha", &BuilderSettingManager::m_defaultPresetAlpha)
  72. ->Field("DefaultPresetNonePOT", &BuilderSettingManager::m_defaultPresetNonePOT)
  73. // deprecated properties
  74. ->Field("DefaultPresetsByFileMask", &BuilderSettingManager::m_defaultPresetByFileMask)
  75. ->Field("AnalysisFingerprint", &BuilderSettingManager::m_analysisFingerprint);
  76. }
  77. }
  78. BuilderSettingManager* BuilderSettingManager::Instance()
  79. {
  80. AZStd::lock_guard<AZStd::mutex> lock(s_instanceMutex);
  81. if (!s_globalInstance)
  82. {
  83. s_globalInstance = AZ::Environment::FindVariable<BuilderSettingManager*>(s_environmentVariableName);
  84. }
  85. AZ_Assert(s_globalInstance, "BuilderSettingManager not created!");
  86. return s_globalInstance.Get();
  87. }
  88. void BuilderSettingManager::CreateInstance()
  89. {
  90. AZStd::lock_guard<AZStd::mutex> lock(s_instanceMutex);
  91. if (s_globalInstance)
  92. {
  93. AZ_Assert(false, "BuilderSettingManager already created!");
  94. return;
  95. }
  96. if (!s_globalInstance)
  97. {
  98. s_globalInstance = AZ::Environment::CreateVariable<BuilderSettingManager*>(s_environmentVariableName);
  99. }
  100. if (!s_globalInstance.Get())
  101. {
  102. s_globalInstance.Set(aznew BuilderSettingManager());
  103. }
  104. }
  105. void BuilderSettingManager::DestroyInstance()
  106. {
  107. AZStd::lock_guard<AZStd::mutex> lock(s_instanceMutex);
  108. AZ_Assert(s_globalInstance, "Invalid call to DestroyInstance - no instance exists.");
  109. AZ_Assert(s_globalInstance.Get(), "You can only call DestroyInstance if you have called CreateInstance.");
  110. delete s_globalInstance.Get();
  111. s_globalInstance.Reset();
  112. }
  113. const PresetSettings* BuilderSettingManager::GetPreset(const PresetName& presetName, const PlatformName& platform, AZStd::string_view* settingsFilePathOut) const
  114. {
  115. AZStd::lock_guard<AZStd::recursive_mutex> lock(m_presetMapLock);
  116. auto itr = m_presets.find(presetName);
  117. if (itr != m_presets.end())
  118. {
  119. if (settingsFilePathOut)
  120. {
  121. *settingsFilePathOut = itr->second.m_presetFilePath;
  122. }
  123. return itr->second.m_multiPreset.GetPreset(platform);
  124. }
  125. return nullptr;
  126. }
  127. AZStd::vector<AZStd::string> BuilderSettingManager::GetFileMasksForPreset(const PresetName& presetName) const
  128. {
  129. AZStd::vector<AZStd::string> fileMasks;
  130. AZStd::lock_guard<AZStd::recursive_mutex> lock(m_presetMapLock);
  131. for (const auto& mapping:m_presetFilterMap)
  132. {
  133. for (const auto& preset : mapping.second)
  134. {
  135. if (preset == presetName)
  136. {
  137. fileMasks.push_back(mapping.first);
  138. break;
  139. }
  140. }
  141. }
  142. return fileMasks;
  143. }
  144. const BuilderSettings* BuilderSettingManager::GetBuilderSetting(const PlatformName& platform) const
  145. {
  146. auto itr = m_builderSettings.find(platform);
  147. if (itr != m_builderSettings.end())
  148. {
  149. return &itr->second;
  150. }
  151. return nullptr;
  152. }
  153. const PlatformNameList BuilderSettingManager::GetPlatformList() const
  154. {
  155. PlatformNameList platforms;
  156. for (auto& builderSetting : m_builderSettings)
  157. {
  158. if (builderSetting.second.m_enablePlatform)
  159. {
  160. platforms.push_back(builderSetting.first);
  161. }
  162. }
  163. return platforms;
  164. }
  165. const AZStd::map <FileMask, AZStd::unordered_set<PresetName>>& BuilderSettingManager::GetPresetFilterMap() const
  166. {
  167. AZStd::lock_guard<AZStd::recursive_mutex> lock(m_presetMapLock);
  168. return m_presetFilterMap;
  169. }
  170. const AZStd::unordered_set<PresetName>& BuilderSettingManager::GetFullPresetList() const
  171. {
  172. AZStd::lock_guard<AZStd::recursive_mutex> lock(m_presetMapLock);
  173. AZStd::string noFilter = AZStd::string();
  174. return m_presetFilterMap.find(noFilter)->second;
  175. }
  176. const PresetName BuilderSettingManager::GetPresetNameFromId(const AZ::Uuid& presetId)
  177. {
  178. AZStd::lock_guard<AZStd::recursive_mutex> lock(m_presetMapLock);
  179. for (const auto& itr : m_presets)
  180. {
  181. if (itr.second.m_multiPreset.GetPresetId() == presetId)
  182. {
  183. return itr.second.m_multiPreset.GetPresetName();
  184. }
  185. }
  186. return {};
  187. }
  188. void BuilderSettingManager::ClearSettings()
  189. {
  190. AZStd::lock_guard<AZStd::recursive_mutex> lock(m_presetMapLock);
  191. m_presetFilterMap.clear();
  192. m_builderSettings.clear();
  193. m_presets.clear();
  194. }
  195. StringOutcome BuilderSettingManager::LoadConfig()
  196. {
  197. StringOutcome outcome = STRING_OUTCOME_ERROR("");
  198. auto fileIoBase = AZ::IO::FileIOBase::GetInstance();
  199. if (fileIoBase == nullptr)
  200. {
  201. return AZ::Failure(
  202. AZStd::string("File IO instance needs to be initialized to resolve ImageProcessing builder file aliases"));
  203. }
  204. if (auto defaultConfigFolder = fileIoBase->ResolvePath(s_defaultConfigFolder); defaultConfigFolder.has_value())
  205. {
  206. m_defaultConfigFolder = *defaultConfigFolder;
  207. }
  208. if (auto sourceGameRoot = fileIoBase->ResolvePath("@projectroot@"); sourceGameRoot.has_value())
  209. {
  210. m_projectConfigFolder = *sourceGameRoot;
  211. m_projectConfigFolder /= s_projectConfigRelativeFolder;
  212. }
  213. AZStd::lock_guard<AZStd::recursive_mutex> lock(m_presetMapLock);
  214. ClearSettings();
  215. outcome = LoadSettings();
  216. if (outcome.IsSuccess())
  217. {
  218. // Load presets in default folder first, then load from project folder.
  219. // The same presets which loaded last will overwrite previous loaded one.
  220. LoadPresets(m_defaultConfigFolder.Native());
  221. LoadPresets(m_projectConfigFolder.Native());
  222. }
  223. // Collect extra file masks from preset files
  224. CollectFileMasksFromPresets();
  225. if (QCoreApplication::instance())
  226. {
  227. m_fileWatcher.reset(new QFileSystemWatcher);
  228. // track preset files
  229. // Note, the QT signal would only works for AP but not AssetBuilder
  230. // We use file time stamp to track preset file change in builder's CreateJob
  231. for (auto& preset : m_presets)
  232. {
  233. m_fileWatcher.data()->addPath(QString(preset.second.m_presetFilePath.c_str()));
  234. }
  235. m_fileWatcher.data()->addPath(QString(m_defaultConfigFolder.c_str()));
  236. m_fileWatcher.data()->addPath(QString(m_projectConfigFolder.c_str()));
  237. QObject::connect(m_fileWatcher.data(), &QFileSystemWatcher::fileChanged, this, &BuilderSettingManager::OnFileChanged);
  238. QObject::connect(m_fileWatcher.data(), &QFileSystemWatcher::directoryChanged, this, &BuilderSettingManager::OnFolderChanged);
  239. }
  240. return outcome;
  241. }
  242. void BuilderSettingManager::LoadPresets(AZStd::string_view presetFolder)
  243. {
  244. QDirIterator it(presetFolder.data(), QStringList() << "*.preset", QDir::Files, QDirIterator::NoIteratorFlags);
  245. while (it.hasNext())
  246. {
  247. QString filePath = it.next();
  248. LoadPreset(filePath.toUtf8().data());
  249. }
  250. }
  251. bool BuilderSettingManager::LoadPreset(const AZStd::string& filePath)
  252. {
  253. QFileInfo fileInfo (filePath.c_str());
  254. if (!fileInfo.exists())
  255. {
  256. return false;
  257. }
  258. MultiplatformPresetSettings preset;
  259. auto result = AZ::JsonSerializationUtils::LoadObjectFromFile(preset, filePath);
  260. if (!result.IsSuccess())
  261. {
  262. AZ_Warning(LogWindow, false, "Failed to load preset file %s. Error: %s",
  263. filePath.c_str(), result.GetError().c_str());
  264. return false;
  265. }
  266. PresetName presetName(fileInfo.baseName().toUtf8().data());
  267. AZ_Warning(LogWindow, presetName == preset.GetPresetName(), "Preset file name '%s' is not"
  268. " same as preset name '%s'. Using preset file name as preset name",
  269. filePath.c_str(), preset.GetPresetName().GetCStr());
  270. preset.SetPresetName(presetName);
  271. m_presets[presetName] = PresetEntry{preset, filePath.c_str(), fileInfo.lastModified()};
  272. return true;
  273. }
  274. void BuilderSettingManager::ReloadPreset(const PresetName& presetName)
  275. {
  276. // Find the preset file from project or default config folder
  277. AZStd::string presetFileName = AZStd::string::format("%s.%s", presetName.GetCStr(), s_presetFileExtension);
  278. AZ::IO::FixedMaxPath filePath = m_projectConfigFolder/presetFileName;
  279. QFileInfo fileInfo (filePath.c_str());
  280. if (!fileInfo.exists())
  281. {
  282. filePath = (m_defaultConfigFolder/presetFileName).c_str();
  283. fileInfo = QFileInfo(filePath.c_str());
  284. }
  285. AZStd::lock_guard<AZStd::recursive_mutex> lock(m_presetMapLock);
  286. //Skip the loading if the file wasn't chagned
  287. if (fileInfo.exists())
  288. {
  289. if (m_presets.find(presetName) != m_presets.end())
  290. {
  291. if (m_presets[presetName].m_lastModifiedTime == fileInfo.lastModified()
  292. && m_presets[presetName].m_presetFilePath == filePath.c_str())
  293. {
  294. return;
  295. }
  296. }
  297. }
  298. // remove preset
  299. m_presets.erase(presetName);
  300. if (fileInfo.exists())
  301. {
  302. LoadPreset(filePath.c_str());
  303. }
  304. }
  305. StringOutcome BuilderSettingManager::LoadConfigFromFolder(AZStd::string_view configFolder)
  306. {
  307. AZStd::lock_guard<AZStd::recursive_mutex> lock(m_presetMapLock);
  308. // Load builder settings
  309. AZStd::string settingFilePath = AZStd::string::format("%.*s%s", aznumeric_cast<int>(configFolder.size()),
  310. configFolder.data(), s_builderSettingFileName);
  311. auto result = LoadSettings(settingFilePath);
  312. // Load presets
  313. if (result.IsSuccess())
  314. {
  315. LoadPresets(configFolder);
  316. }
  317. return result;
  318. }
  319. void BuilderSettingManager::ReportDeprecatedSettings()
  320. {
  321. // reported deprecated attributes in image builder settings
  322. if (!m_analysisFingerprint.empty())
  323. {
  324. AZ_Warning(LogWindow, false, "'AnalysisFingerprint' is deprecated and it should be removed from file [%s]", s_builderSettingFileName);
  325. }
  326. if (!m_defaultPresetByFileMask.empty())
  327. {
  328. AZ_Warning(LogWindow, false, "'DefaultPresetsByFileMask' is deprecated and it should be removed from file [%s]. Use PresetsByFileMask instead", s_builderSettingFileName);
  329. }
  330. }
  331. StringOutcome BuilderSettingManager::LoadSettings()
  332. {
  333. // If the project image build setting file exist, it will merge image builder settings from project folder to the settings from default config folder.
  334. bool needMerge = false;
  335. AZStd::string projectSettingFile{ (m_projectConfigFolder / s_builderSettingFileName).Native() };
  336. if (AZ::IO::SystemFile::Exists(projectSettingFile.c_str()))
  337. {
  338. needMerge = true;
  339. }
  340. AZ::Outcome<void, AZStd::string> outcome;
  341. AZStd::string defaultSettingFile{ (m_defaultConfigFolder / s_builderSettingFileName).Native() };
  342. if (needMerge)
  343. {
  344. auto outcome1 = AZ::JsonSerializationUtils::ReadJsonFile(defaultSettingFile);
  345. auto outcome2 = AZ::JsonSerializationUtils::ReadJsonFile(projectSettingFile);
  346. // return error if it failed to load default settings
  347. if (!outcome1.IsSuccess())
  348. {
  349. return STRING_OUTCOME_ERROR(outcome1.GetError());
  350. }
  351. // if project config was loaded successfully, apply merge patch
  352. rapidjson::Document& originDoc = outcome1.GetValue();
  353. if (outcome2.IsSuccess())
  354. {
  355. const rapidjson::Document& patchDoc = outcome2.GetValue();
  356. AZ::JsonSerializationResult::ResultCode result =
  357. AZ::JsonSerialization::ApplyPatch(originDoc, originDoc.GetAllocator(), patchDoc, AZ::JsonMergeApproach::JsonMergePatch);
  358. if (result.GetProcessing() == AZ::JsonSerializationResult::Processing::Completed)
  359. {
  360. AZStd::vector<char> outBuffer;
  361. AZ::IO::ByteContainerStream<AZStd::vector<char>> outStream{ &outBuffer };
  362. AZ::JsonSerializationUtils::WriteJsonStream(originDoc, outStream);
  363. outStream.Seek(0, AZ::IO::GenericStream::ST_SEEK_BEGIN);
  364. outcome = AZ::JsonSerializationUtils::LoadObjectFromStream(*this, outStream);
  365. if (!outcome.IsSuccess())
  366. {
  367. return STRING_OUTCOME_ERROR(outcome.GetError());
  368. }
  369. ReportDeprecatedSettings();
  370. // Generate config file fingerprint
  371. outStream.Seek(0, AZ::IO::GenericStream::ST_SEEK_BEGIN);
  372. AZ::u64 hash = AssetBuilderSDK::GetHashFromIOStream(outStream);
  373. m_analysisFingerprint = AZStd::string::format("%llX", hash);
  374. }
  375. else
  376. {
  377. needMerge = false;
  378. AZ_Warning(LogWindow, false, "Failed to fully merge data into image builder settings. Skipping project build setting file [%s]", projectSettingFile.c_str());
  379. }
  380. }
  381. else
  382. {
  383. AZ_Warning(LogWindow, false, "Failed to load project setting file [%s]. Skipping", projectSettingFile.c_str());
  384. }
  385. }
  386. if (!needMerge)
  387. {
  388. outcome = AZ::JsonSerializationUtils::LoadObjectFromFile(*this, defaultSettingFile);
  389. if (!outcome.IsSuccess())
  390. {
  391. return STRING_OUTCOME_ERROR(outcome.GetError());
  392. }
  393. ReportDeprecatedSettings();
  394. // Generate config file fingerprint
  395. AZ::u64 hash = AssetBuilderSDK::GetFileHash(defaultSettingFile.c_str());
  396. m_analysisFingerprint = AZStd::string::format("%llX", hash);
  397. }
  398. return STRING_OUTCOME_SUCCESS;
  399. }
  400. StringOutcome BuilderSettingManager::LoadSettings(AZStd::string_view filepath)
  401. {
  402. AZStd::lock_guard<AZStd::recursive_mutex> lock(m_presetMapLock);
  403. auto result = AZ::JsonSerializationUtils::LoadObjectFromFile(*this, filepath);
  404. if (!result.IsSuccess())
  405. {
  406. return STRING_OUTCOME_ERROR(result.GetError());
  407. }
  408. //enable builder settings for enabled restricted platforms. These settings should be disabled by default in the setting file
  409. #if defined(AZ_TOOLS_EXPAND_FOR_RESTRICTED_PLATFORMS)
  410. #define AZ_RESTRICTED_PLATFORM_EXPANSION(CodeName, CODENAME, codename, PrivateName, PRIVATENAME, privatename, PublicName, PUBLICNAME, publicname, PublicAuxName1, PublicAuxName2, PublicAuxName3) \
  411. for (auto& buildSetting : m_builderSettings) \
  412. { \
  413. if (ImageProcess##PrivateName::DoesSupport(buildSetting.first)) \
  414. { \
  415. buildSetting.second.m_enablePlatform = true; \
  416. break; \
  417. } \
  418. }
  419. AZ_TOOLS_EXPAND_FOR_RESTRICTED_PLATFORMS
  420. #undef AZ_RESTRICTED_PLATFORM_EXPANSION
  421. #endif //AZ_TOOLS_EXPAND_FOR_RESTRICTED_PLATFORMS
  422. return STRING_OUTCOME_SUCCESS;
  423. }
  424. StringOutcome BuilderSettingManager::WriteSettings(AZStd::string_view filepath)
  425. {
  426. AZ::JsonSerializerSettings saveSettings;
  427. saveSettings.m_keepDefaults = true;
  428. auto result = AZ::JsonSerializationUtils::SaveObjectToFile(this, filepath,
  429. (BuilderSettingManager*)nullptr, &saveSettings);
  430. if (!result.IsSuccess())
  431. {
  432. return STRING_OUTCOME_ERROR(result.GetError());
  433. }
  434. return STRING_OUTCOME_SUCCESS;
  435. }
  436. const AZStd::string& BuilderSettingManager::GetAnalysisFingerprint() const
  437. {
  438. return m_analysisFingerprint;
  439. }
  440. void BuilderSettingManager::CollectFileMasksFromPresets()
  441. {
  442. AZStd::lock_guard<AZStd::recursive_mutex> lock(m_presetMapLock);
  443. AZStd::string noFilter = AZStd::string();
  444. AZStd::string extraString;
  445. for (const auto& presetIter : m_presets)
  446. {
  447. const MultiplatformPresetSettings& multiPreset = presetIter.second.m_multiPreset;
  448. const PresetSettings& preset = multiPreset.GetDefaultPreset();
  449. //Put into no filter preset list
  450. m_presetFilterMap[noFilter].insert(preset.m_name);
  451. //Put into file mask preset list if any
  452. for (const PlatformName& filemask : preset.m_fileMasks)
  453. {
  454. if (filemask.empty() || filemask[0] != FileMaskDelimiter)
  455. {
  456. AZ_Warning(LogWindow, false, "File mask '%s' is invalid. It must start with '%c'.", filemask.c_str(), FileMaskDelimiter);
  457. continue;
  458. }
  459. else if (filemask.size() < 2)
  460. {
  461. AZ_Warning(LogWindow, false, "File mask '%s' is invalid. The '%c' must be followed by at least one other character.", filemask.c_str());
  462. continue;
  463. }
  464. else if (filemask.find(FileMaskDelimiter, 1) != AZStd::string::npos)
  465. {
  466. AZ_Warning(LogWindow, false, "File mask '%s' is invalid. It must contain only a single '%c' character.", filemask.c_str(), FileMaskDelimiter);
  467. continue;
  468. }
  469. else if (filemask.find(AZ_FILESYSTEM_EXTENSION_SEPARATOR) != AZStd::string::npos)
  470. {
  471. AZ_Warning(LogWindow, false,
  472. "File mask '%s' is invalid. It must not contain a file extension separator ('%c').",
  473. filemask.c_str(),
  474. AZ_FILESYSTEM_EXTENSION_SEPARATOR);
  475. continue;
  476. }
  477. extraString += (filemask + preset.m_name.GetCStr());
  478. m_presetFilterMap[filemask].insert(preset.m_name);
  479. }
  480. }
  481. if (!extraString.empty())
  482. {
  483. AZ::u64 hash = AZStd::hash<AZStd::string>{}(extraString);
  484. m_analysisFingerprint += AZStd::string::format("%llX", hash);
  485. }
  486. }
  487. void BuilderSettingManager::MetafilePathFromImagePath(AZStd::string_view imagePath, AZStd::string& metafilePath)
  488. {
  489. // Determine if we have a meta file
  490. AZ::IO::LocalFileIO fileIO;
  491. AZStd::string settingFilePath = AZStd::string::format("%.*s%s", aznumeric_cast<int>(imagePath.size()),
  492. imagePath.data(), TextureSettings::ExtensionName);
  493. if (fileIO.Exists(settingFilePath.c_str()))
  494. {
  495. metafilePath = settingFilePath;
  496. return;
  497. }
  498. metafilePath = AZStd::string();
  499. }
  500. AZStd::string BuilderSettingManager::GetFileMask(AZStd::string_view imageFilePath) const
  501. {
  502. //get file name
  503. QString lowerFileName = imageFilePath.data();
  504. lowerFileName = lowerFileName.toLower();
  505. // If the complete file name contains multiple extension separators ('.'), only use the base name before the first separator
  506. // for the file mask. For example, 'name_filemask.something.extension' will only use 'name_filemask', producing a result
  507. // of '_filemask' that is returned from this method.
  508. AZStd::string fileName(QFileInfo(lowerFileName).baseName().toUtf8());
  509. //get the substring from last '_'
  510. size_t lastUnderScore = fileName.find_last_of(FileMaskDelimiter);
  511. if (lastUnderScore != AZStd::string::npos)
  512. {
  513. return fileName.substr(lastUnderScore);
  514. }
  515. return AZStd::string();
  516. }
  517. PresetName BuilderSettingManager::GetDefaultPreset() const
  518. {
  519. return m_defaultPreset;
  520. }
  521. PresetName BuilderSettingManager::GetDefaultAlphaPreset() const
  522. {
  523. return m_defaultPresetAlpha;
  524. }
  525. AZStd::vector<PresetName> BuilderSettingManager::GetPresetsForFileMask(const FileMask& fileMask) const
  526. {
  527. AZStd::vector<PresetName> presets;
  528. AZStd::lock_guard<AZStd::recursive_mutex> lock(m_presetMapLock);
  529. if (auto it = m_presetFilterMap.find(fileMask); it != m_presetFilterMap.end())
  530. {
  531. for (const PresetName& presetName : it->second)
  532. {
  533. presets.push_back(presetName);
  534. }
  535. }
  536. return presets;
  537. }
  538. bool BuilderSettingManager::IsValidPreset(PresetName presetName) const
  539. {
  540. if (presetName.IsEmpty())
  541. {
  542. return false;
  543. }
  544. return m_presets.find(presetName) != m_presets.end();
  545. }
  546. PresetName BuilderSettingManager::GetSuggestedPreset(AZStd::string_view imageFilePath) const
  547. {
  548. PresetName emptyPreset;
  549. //get file mask of this image file
  550. AZStd::string fileMask = GetFileMask(imageFilePath);
  551. PresetName outPreset = emptyPreset;
  552. //use the preset filter map to find
  553. if (outPreset.IsEmpty() && !fileMask.empty())
  554. {
  555. auto& presetFilterMap = GetPresetFilterMap();
  556. if (presetFilterMap.find(fileMask) != presetFilterMap.end())
  557. {
  558. outPreset = *(presetFilterMap.find(fileMask)->second.begin());
  559. }
  560. }
  561. if (outPreset == emptyPreset)
  562. {
  563. auto image = IImageObjectPtr(LoadImageFromFile(imageFilePath));
  564. if (image && ((image->GetAlphaContent() == EAlphaContent::eAlphaContent_Absent
  565. || image->GetAlphaContent() == EAlphaContent::eAlphaContent_OnlyWhite)))
  566. {
  567. outPreset = m_defaultPreset;
  568. }
  569. else
  570. {
  571. outPreset = m_defaultPresetAlpha;
  572. }
  573. }
  574. return outPreset;
  575. }
  576. AZStd::vector<AZStd::string> BuilderSettingManager::GetPossiblePresetPaths(const PresetName& presetName) const
  577. {
  578. AZStd::vector<AZStd::string> paths;
  579. AZStd::string presetFile = AZStd::string::format("%s.preset", presetName.GetCStr());
  580. paths.push_back((m_defaultConfigFolder / presetFile).c_str());
  581. paths.push_back((m_projectConfigFolder / presetFile).c_str());
  582. return paths;
  583. }
  584. bool BuilderSettingManager::DoesSupportPlatform(AZStd::string_view platformId)
  585. {
  586. if (const auto& itr = m_builderSettings.find(platformId); itr != m_builderSettings.end())
  587. {
  588. return itr->second.m_enablePlatform;
  589. }
  590. return false;
  591. }
  592. void BuilderSettingManager::SavePresets(AZStd::string_view outputFolder)
  593. {
  594. for (const auto& element : m_presets)
  595. {
  596. const PresetEntry& presetEntry = element.second;
  597. AZStd::string fileName = AZStd::string::format("%s.preset", presetEntry.m_multiPreset.GetDefaultPreset().m_name.GetCStr());
  598. AZStd::string filePath;
  599. if (!AzFramework::StringFunc::Path::Join(outputFolder.data(), fileName.c_str(), filePath))
  600. {
  601. AZ_Warning(LogWindow, false, "Failed to construct path with folder '%.*s' and file: '%s' to save preset",
  602. aznumeric_cast<int>(outputFolder.size()), outputFolder.data(), filePath.c_str());
  603. continue;
  604. }
  605. auto result = AZ::JsonSerializationUtils::SaveObjectToFile(&presetEntry.m_multiPreset, filePath);
  606. if (!result.IsSuccess())
  607. {
  608. AZ_Warning(LogWindow, false, "Failed to save preset '%s' to file '%s'. Error: %s",
  609. presetEntry.m_multiPreset.GetDefaultPreset().m_name.GetCStr(), filePath.c_str(), result.GetError().c_str());
  610. }
  611. }
  612. }
  613. void BuilderSettingManager::OnFileChanged(const QString &path)
  614. {
  615. // handles preset file change
  616. // Note: this signal only works with AP but not AssetBuilder
  617. AZ_TracePrintf(LogWindow, "File changed %s\n", path.toUtf8().data());
  618. QFileInfo info(path);
  619. // skip if the file is not a preset file
  620. // Note: for .settings file change it's handled when restart AP.
  621. if (info.suffix() != s_presetFileExtension)
  622. {
  623. return;
  624. }
  625. ReloadPreset(PresetName(info.baseName().toUtf8().data()));
  626. }
  627. void BuilderSettingManager::OnFolderChanged([[maybe_unused]] const QString &path)
  628. {
  629. // handles new file added or removed
  630. // Note: this signal only works with AP but not AssetBuilder
  631. AZ_TracePrintf(LogWindow, "folder changed %s\n", path.toUtf8().data());
  632. AZStd::lock_guard<AZStd::recursive_mutex> lock(m_presetMapLock);
  633. m_presets.clear();
  634. LoadPresets(m_defaultConfigFolder.Native());
  635. LoadPresets(m_projectConfigFolder.Native());
  636. for (auto& preset : m_presets)
  637. {
  638. m_fileWatcher.data()->addPath(QString(preset.second.m_presetFilePath.c_str()));
  639. }
  640. }
  641. } // namespace ImageProcessingAtom