resource_format_binary.cpp 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082
  1. /*************************************************************************/
  2. /* resource_format_binary.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "resource_format_binary.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/io/dir_access.h"
  33. #include "core/io/file_access_compressed.h"
  34. #include "core/io/image.h"
  35. #include "core/io/marshalls.h"
  36. #include "core/version.h"
  37. //#define print_bl(m_what) print_line(m_what)
  38. #define print_bl(m_what) (void)(m_what)
  39. enum {
  40. //numbering must be different from variant, in case new variant types are added (variant must be always contiguous for jumptable optimization)
  41. VARIANT_NIL = 1,
  42. VARIANT_BOOL = 2,
  43. VARIANT_INT = 3,
  44. VARIANT_FLOAT = 4,
  45. VARIANT_STRING = 5,
  46. VARIANT_VECTOR2 = 10,
  47. VARIANT_RECT2 = 11,
  48. VARIANT_VECTOR3 = 12,
  49. VARIANT_PLANE = 13,
  50. VARIANT_QUATERNION = 14,
  51. VARIANT_AABB = 15,
  52. VARIANT_BASIS = 16,
  53. VARIANT_TRANSFORM3D = 17,
  54. VARIANT_TRANSFORM2D = 18,
  55. VARIANT_COLOR = 20,
  56. VARIANT_NODE_PATH = 22,
  57. VARIANT_RID = 23,
  58. VARIANT_OBJECT = 24,
  59. VARIANT_INPUT_EVENT = 25,
  60. VARIANT_DICTIONARY = 26,
  61. VARIANT_ARRAY = 30,
  62. VARIANT_PACKED_BYTE_ARRAY = 31,
  63. VARIANT_PACKED_INT32_ARRAY = 32,
  64. VARIANT_PACKED_FLOAT32_ARRAY = 33,
  65. VARIANT_PACKED_STRING_ARRAY = 34,
  66. VARIANT_PACKED_VECTOR3_ARRAY = 35,
  67. VARIANT_PACKED_COLOR_ARRAY = 36,
  68. VARIANT_PACKED_VECTOR2_ARRAY = 37,
  69. VARIANT_INT64 = 40,
  70. VARIANT_DOUBLE = 41,
  71. VARIANT_CALLABLE = 42,
  72. VARIANT_SIGNAL = 43,
  73. VARIANT_STRING_NAME = 44,
  74. VARIANT_VECTOR2I = 45,
  75. VARIANT_RECT2I = 46,
  76. VARIANT_VECTOR3I = 47,
  77. VARIANT_PACKED_INT64_ARRAY = 48,
  78. VARIANT_PACKED_FLOAT64_ARRAY = 49,
  79. OBJECT_EMPTY = 0,
  80. OBJECT_EXTERNAL_RESOURCE = 1,
  81. OBJECT_INTERNAL_RESOURCE = 2,
  82. OBJECT_EXTERNAL_RESOURCE_INDEX = 3,
  83. // Version 2: added 64 bits support for float and int.
  84. // Version 3: changed nodepath encoding.
  85. // Version 4: new string ID for ext/subresources, breaks forward compat.
  86. FORMAT_VERSION = 4,
  87. FORMAT_VERSION_CAN_RENAME_DEPS = 1,
  88. FORMAT_VERSION_NO_NODEPATH_PROPERTY = 3,
  89. };
  90. void ResourceLoaderBinary::_advance_padding(uint32_t p_len) {
  91. uint32_t extra = 4 - (p_len % 4);
  92. if (extra < 4) {
  93. for (uint32_t i = 0; i < extra; i++) {
  94. f->get_8(); //pad to 32
  95. }
  96. }
  97. }
  98. StringName ResourceLoaderBinary::_get_string() {
  99. uint32_t id = f->get_32();
  100. if (id & 0x80000000) {
  101. uint32_t len = id & 0x7FFFFFFF;
  102. if ((int)len > str_buf.size()) {
  103. str_buf.resize(len);
  104. }
  105. if (len == 0) {
  106. return StringName();
  107. }
  108. f->get_buffer((uint8_t *)&str_buf[0], len);
  109. String s;
  110. s.parse_utf8(&str_buf[0]);
  111. return s;
  112. }
  113. return string_map[id];
  114. }
  115. Error ResourceLoaderBinary::parse_variant(Variant &r_v) {
  116. uint32_t type = f->get_32();
  117. print_bl("find property of type: " + itos(type));
  118. switch (type) {
  119. case VARIANT_NIL: {
  120. r_v = Variant();
  121. } break;
  122. case VARIANT_BOOL: {
  123. r_v = bool(f->get_32());
  124. } break;
  125. case VARIANT_INT: {
  126. r_v = int(f->get_32());
  127. } break;
  128. case VARIANT_INT64: {
  129. r_v = int64_t(f->get_64());
  130. } break;
  131. case VARIANT_FLOAT: {
  132. r_v = f->get_real();
  133. } break;
  134. case VARIANT_DOUBLE: {
  135. r_v = f->get_double();
  136. } break;
  137. case VARIANT_STRING: {
  138. r_v = get_unicode_string();
  139. } break;
  140. case VARIANT_VECTOR2: {
  141. Vector2 v;
  142. v.x = f->get_real();
  143. v.y = f->get_real();
  144. r_v = v;
  145. } break;
  146. case VARIANT_VECTOR2I: {
  147. Vector2i v;
  148. v.x = f->get_32();
  149. v.y = f->get_32();
  150. r_v = v;
  151. } break;
  152. case VARIANT_RECT2: {
  153. Rect2 v;
  154. v.position.x = f->get_real();
  155. v.position.y = f->get_real();
  156. v.size.x = f->get_real();
  157. v.size.y = f->get_real();
  158. r_v = v;
  159. } break;
  160. case VARIANT_RECT2I: {
  161. Rect2i v;
  162. v.position.x = f->get_32();
  163. v.position.y = f->get_32();
  164. v.size.x = f->get_32();
  165. v.size.y = f->get_32();
  166. r_v = v;
  167. } break;
  168. case VARIANT_VECTOR3: {
  169. Vector3 v;
  170. v.x = f->get_real();
  171. v.y = f->get_real();
  172. v.z = f->get_real();
  173. r_v = v;
  174. } break;
  175. case VARIANT_VECTOR3I: {
  176. Vector3i v;
  177. v.x = f->get_32();
  178. v.y = f->get_32();
  179. v.z = f->get_32();
  180. r_v = v;
  181. } break;
  182. case VARIANT_PLANE: {
  183. Plane v;
  184. v.normal.x = f->get_real();
  185. v.normal.y = f->get_real();
  186. v.normal.z = f->get_real();
  187. v.d = f->get_real();
  188. r_v = v;
  189. } break;
  190. case VARIANT_QUATERNION: {
  191. Quaternion v;
  192. v.x = f->get_real();
  193. v.y = f->get_real();
  194. v.z = f->get_real();
  195. v.w = f->get_real();
  196. r_v = v;
  197. } break;
  198. case VARIANT_AABB: {
  199. AABB v;
  200. v.position.x = f->get_real();
  201. v.position.y = f->get_real();
  202. v.position.z = f->get_real();
  203. v.size.x = f->get_real();
  204. v.size.y = f->get_real();
  205. v.size.z = f->get_real();
  206. r_v = v;
  207. } break;
  208. case VARIANT_TRANSFORM2D: {
  209. Transform2D v;
  210. v.elements[0].x = f->get_real();
  211. v.elements[0].y = f->get_real();
  212. v.elements[1].x = f->get_real();
  213. v.elements[1].y = f->get_real();
  214. v.elements[2].x = f->get_real();
  215. v.elements[2].y = f->get_real();
  216. r_v = v;
  217. } break;
  218. case VARIANT_BASIS: {
  219. Basis v;
  220. v.elements[0].x = f->get_real();
  221. v.elements[0].y = f->get_real();
  222. v.elements[0].z = f->get_real();
  223. v.elements[1].x = f->get_real();
  224. v.elements[1].y = f->get_real();
  225. v.elements[1].z = f->get_real();
  226. v.elements[2].x = f->get_real();
  227. v.elements[2].y = f->get_real();
  228. v.elements[2].z = f->get_real();
  229. r_v = v;
  230. } break;
  231. case VARIANT_TRANSFORM3D: {
  232. Transform3D v;
  233. v.basis.elements[0].x = f->get_real();
  234. v.basis.elements[0].y = f->get_real();
  235. v.basis.elements[0].z = f->get_real();
  236. v.basis.elements[1].x = f->get_real();
  237. v.basis.elements[1].y = f->get_real();
  238. v.basis.elements[1].z = f->get_real();
  239. v.basis.elements[2].x = f->get_real();
  240. v.basis.elements[2].y = f->get_real();
  241. v.basis.elements[2].z = f->get_real();
  242. v.origin.x = f->get_real();
  243. v.origin.y = f->get_real();
  244. v.origin.z = f->get_real();
  245. r_v = v;
  246. } break;
  247. case VARIANT_COLOR: {
  248. Color v; // Colors should always be in single-precision.
  249. v.r = f->get_float();
  250. v.g = f->get_float();
  251. v.b = f->get_float();
  252. v.a = f->get_float();
  253. r_v = v;
  254. } break;
  255. case VARIANT_STRING_NAME: {
  256. r_v = StringName(get_unicode_string());
  257. } break;
  258. case VARIANT_NODE_PATH: {
  259. Vector<StringName> names;
  260. Vector<StringName> subnames;
  261. bool absolute;
  262. int name_count = f->get_16();
  263. uint32_t subname_count = f->get_16();
  264. absolute = subname_count & 0x8000;
  265. subname_count &= 0x7FFF;
  266. if (ver_format < FORMAT_VERSION_NO_NODEPATH_PROPERTY) {
  267. subname_count += 1; // has a property field, so we should count it as well
  268. }
  269. for (int i = 0; i < name_count; i++) {
  270. names.push_back(_get_string());
  271. }
  272. for (uint32_t i = 0; i < subname_count; i++) {
  273. subnames.push_back(_get_string());
  274. }
  275. NodePath np = NodePath(names, subnames, absolute);
  276. r_v = np;
  277. } break;
  278. case VARIANT_RID: {
  279. r_v = f->get_32();
  280. } break;
  281. case VARIANT_OBJECT: {
  282. uint32_t objtype = f->get_32();
  283. switch (objtype) {
  284. case OBJECT_EMPTY: {
  285. //do none
  286. } break;
  287. case OBJECT_INTERNAL_RESOURCE: {
  288. uint32_t index = f->get_32();
  289. String path;
  290. if (using_named_scene_ids) { // New format.
  291. ERR_FAIL_INDEX_V((int)index, internal_resources.size(), ERR_PARSE_ERROR);
  292. path = internal_resources[index].path;
  293. } else {
  294. path += res_path + "::" + itos(index);
  295. }
  296. //always use internal cache for loading internal resources
  297. if (!internal_index_cache.has(path)) {
  298. WARN_PRINT(String("Couldn't load resource (no cache): " + path).utf8().get_data());
  299. r_v = Variant();
  300. } else {
  301. r_v = internal_index_cache[path];
  302. }
  303. } break;
  304. case OBJECT_EXTERNAL_RESOURCE: {
  305. //old file format, still around for compatibility
  306. String exttype = get_unicode_string();
  307. String path = get_unicode_string();
  308. if (!path.contains("://") && path.is_relative_path()) {
  309. // path is relative to file being loaded, so convert to a resource path
  310. path = ProjectSettings::get_singleton()->localize_path(res_path.get_base_dir().plus_file(path));
  311. }
  312. if (remaps.find(path)) {
  313. path = remaps[path];
  314. }
  315. RES res = ResourceLoader::load(path, exttype);
  316. if (res.is_null()) {
  317. WARN_PRINT(String("Couldn't load resource: " + path).utf8().get_data());
  318. }
  319. r_v = res;
  320. } break;
  321. case OBJECT_EXTERNAL_RESOURCE_INDEX: {
  322. //new file format, just refers to an index in the external list
  323. int erindex = f->get_32();
  324. if (erindex < 0 || erindex >= external_resources.size()) {
  325. WARN_PRINT("Broken external resource! (index out of size)");
  326. r_v = Variant();
  327. } else {
  328. if (external_resources[erindex].cache.is_null()) {
  329. //cache not here yet, wait for it?
  330. if (use_sub_threads) {
  331. Error err;
  332. external_resources.write[erindex].cache = ResourceLoader::load_threaded_get(external_resources[erindex].path, &err);
  333. if (err != OK || external_resources[erindex].cache.is_null()) {
  334. if (!ResourceLoader::get_abort_on_missing_resources()) {
  335. ResourceLoader::notify_dependency_error(local_path, external_resources[erindex].path, external_resources[erindex].type);
  336. } else {
  337. error = ERR_FILE_MISSING_DEPENDENCIES;
  338. ERR_FAIL_V_MSG(error, "Can't load dependency: " + external_resources[erindex].path + ".");
  339. }
  340. }
  341. }
  342. }
  343. r_v = external_resources[erindex].cache;
  344. }
  345. } break;
  346. default: {
  347. ERR_FAIL_V(ERR_FILE_CORRUPT);
  348. } break;
  349. }
  350. } break;
  351. case VARIANT_CALLABLE: {
  352. r_v = Callable();
  353. } break;
  354. case VARIANT_SIGNAL: {
  355. r_v = Signal();
  356. } break;
  357. case VARIANT_DICTIONARY: {
  358. uint32_t len = f->get_32();
  359. Dictionary d; //last bit means shared
  360. len &= 0x7FFFFFFF;
  361. for (uint32_t i = 0; i < len; i++) {
  362. Variant key;
  363. Error err = parse_variant(key);
  364. ERR_FAIL_COND_V_MSG(err, ERR_FILE_CORRUPT, "Error when trying to parse Variant.");
  365. Variant value;
  366. err = parse_variant(value);
  367. ERR_FAIL_COND_V_MSG(err, ERR_FILE_CORRUPT, "Error when trying to parse Variant.");
  368. d[key] = value;
  369. }
  370. r_v = d;
  371. } break;
  372. case VARIANT_ARRAY: {
  373. uint32_t len = f->get_32();
  374. Array a; //last bit means shared
  375. len &= 0x7FFFFFFF;
  376. a.resize(len);
  377. for (uint32_t i = 0; i < len; i++) {
  378. Variant val;
  379. Error err = parse_variant(val);
  380. ERR_FAIL_COND_V_MSG(err, ERR_FILE_CORRUPT, "Error when trying to parse Variant.");
  381. a[i] = val;
  382. }
  383. r_v = a;
  384. } break;
  385. case VARIANT_PACKED_BYTE_ARRAY: {
  386. uint32_t len = f->get_32();
  387. Vector<uint8_t> array;
  388. array.resize(len);
  389. uint8_t *w = array.ptrw();
  390. f->get_buffer(w, len);
  391. _advance_padding(len);
  392. r_v = array;
  393. } break;
  394. case VARIANT_PACKED_INT32_ARRAY: {
  395. uint32_t len = f->get_32();
  396. Vector<int32_t> array;
  397. array.resize(len);
  398. int32_t *w = array.ptrw();
  399. f->get_buffer((uint8_t *)w, len * sizeof(int32_t));
  400. #ifdef BIG_ENDIAN_ENABLED
  401. {
  402. uint32_t *ptr = (uint32_t *)w.ptr();
  403. for (int i = 0; i < len; i++) {
  404. ptr[i] = BSWAP32(ptr[i]);
  405. }
  406. }
  407. #endif
  408. r_v = array;
  409. } break;
  410. case VARIANT_PACKED_INT64_ARRAY: {
  411. uint32_t len = f->get_32();
  412. Vector<int64_t> array;
  413. array.resize(len);
  414. int64_t *w = array.ptrw();
  415. f->get_buffer((uint8_t *)w, len * sizeof(int64_t));
  416. #ifdef BIG_ENDIAN_ENABLED
  417. {
  418. uint64_t *ptr = (uint64_t *)w.ptr();
  419. for (int i = 0; i < len; i++) {
  420. ptr[i] = BSWAP64(ptr[i]);
  421. }
  422. }
  423. #endif
  424. r_v = array;
  425. } break;
  426. case VARIANT_PACKED_FLOAT32_ARRAY: {
  427. uint32_t len = f->get_32();
  428. Vector<float> array;
  429. array.resize(len);
  430. float *w = array.ptrw();
  431. f->get_buffer((uint8_t *)w, len * sizeof(float));
  432. #ifdef BIG_ENDIAN_ENABLED
  433. {
  434. uint32_t *ptr = (uint32_t *)w.ptr();
  435. for (int i = 0; i < len; i++) {
  436. ptr[i] = BSWAP32(ptr[i]);
  437. }
  438. }
  439. #endif
  440. r_v = array;
  441. } break;
  442. case VARIANT_PACKED_FLOAT64_ARRAY: {
  443. uint32_t len = f->get_32();
  444. Vector<double> array;
  445. array.resize(len);
  446. double *w = array.ptrw();
  447. f->get_buffer((uint8_t *)w, len * sizeof(double));
  448. #ifdef BIG_ENDIAN_ENABLED
  449. {
  450. uint64_t *ptr = (uint64_t *)w.ptr();
  451. for (int i = 0; i < len; i++) {
  452. ptr[i] = BSWAP64(ptr[i]);
  453. }
  454. }
  455. #endif
  456. r_v = array;
  457. } break;
  458. case VARIANT_PACKED_STRING_ARRAY: {
  459. uint32_t len = f->get_32();
  460. Vector<String> array;
  461. array.resize(len);
  462. String *w = array.ptrw();
  463. for (uint32_t i = 0; i < len; i++) {
  464. w[i] = get_unicode_string();
  465. }
  466. r_v = array;
  467. } break;
  468. case VARIANT_PACKED_VECTOR2_ARRAY: {
  469. uint32_t len = f->get_32();
  470. Vector<Vector2> array;
  471. array.resize(len);
  472. Vector2 *w = array.ptrw();
  473. if (sizeof(Vector2) == 8) {
  474. f->get_buffer((uint8_t *)w, len * sizeof(real_t) * 2);
  475. #ifdef BIG_ENDIAN_ENABLED
  476. {
  477. uint32_t *ptr = (uint32_t *)w.ptr();
  478. for (int i = 0; i < len * 2; i++) {
  479. ptr[i] = BSWAP32(ptr[i]);
  480. }
  481. }
  482. #endif
  483. } else {
  484. ERR_FAIL_V_MSG(ERR_UNAVAILABLE, "Vector2 size is NOT 8!");
  485. }
  486. r_v = array;
  487. } break;
  488. case VARIANT_PACKED_VECTOR3_ARRAY: {
  489. uint32_t len = f->get_32();
  490. Vector<Vector3> array;
  491. array.resize(len);
  492. Vector3 *w = array.ptrw();
  493. if (sizeof(Vector3) == 12) {
  494. f->get_buffer((uint8_t *)w, len * sizeof(real_t) * 3);
  495. #ifdef BIG_ENDIAN_ENABLED
  496. {
  497. uint32_t *ptr = (uint32_t *)w.ptr();
  498. for (int i = 0; i < len * 3; i++) {
  499. ptr[i] = BSWAP32(ptr[i]);
  500. }
  501. }
  502. #endif
  503. } else {
  504. ERR_FAIL_V_MSG(ERR_UNAVAILABLE, "Vector3 size is NOT 12!");
  505. }
  506. r_v = array;
  507. } break;
  508. case VARIANT_PACKED_COLOR_ARRAY: {
  509. uint32_t len = f->get_32();
  510. Vector<Color> array;
  511. array.resize(len);
  512. Color *w = array.ptrw();
  513. if (sizeof(Color) == 16) {
  514. f->get_buffer((uint8_t *)w, len * sizeof(real_t) * 4);
  515. #ifdef BIG_ENDIAN_ENABLED
  516. {
  517. uint32_t *ptr = (uint32_t *)w.ptr();
  518. for (int i = 0; i < len * 4; i++) {
  519. ptr[i] = BSWAP32(ptr[i]);
  520. }
  521. }
  522. #endif
  523. } else {
  524. ERR_FAIL_V_MSG(ERR_UNAVAILABLE, "Color size is NOT 16!");
  525. }
  526. r_v = array;
  527. } break;
  528. default: {
  529. ERR_FAIL_V(ERR_FILE_CORRUPT);
  530. } break;
  531. }
  532. return OK; //never reach anyway
  533. }
  534. void ResourceLoaderBinary::set_local_path(const String &p_local_path) {
  535. res_path = p_local_path;
  536. }
  537. Ref<Resource> ResourceLoaderBinary::get_resource() {
  538. return resource;
  539. }
  540. Error ResourceLoaderBinary::load() {
  541. if (error != OK) {
  542. return error;
  543. }
  544. int stage = 0;
  545. for (int i = 0; i < external_resources.size(); i++) {
  546. String path = external_resources[i].path;
  547. if (remaps.has(path)) {
  548. path = remaps[path];
  549. }
  550. if (!path.contains("://") && path.is_relative_path()) {
  551. // path is relative to file being loaded, so convert to a resource path
  552. path = ProjectSettings::get_singleton()->localize_path(path.get_base_dir().plus_file(external_resources[i].path));
  553. }
  554. external_resources.write[i].path = path; //remap happens here, not on load because on load it can actually be used for filesystem dock resource remap
  555. if (!use_sub_threads) {
  556. external_resources.write[i].cache = ResourceLoader::load(path, external_resources[i].type);
  557. if (external_resources[i].cache.is_null()) {
  558. if (!ResourceLoader::get_abort_on_missing_resources()) {
  559. ResourceLoader::notify_dependency_error(local_path, path, external_resources[i].type);
  560. } else {
  561. error = ERR_FILE_MISSING_DEPENDENCIES;
  562. ERR_FAIL_V_MSG(error, "Can't load dependency: " + path + ".");
  563. }
  564. }
  565. } else {
  566. Error err = ResourceLoader::load_threaded_request(path, external_resources[i].type, use_sub_threads, ResourceFormatLoader::CACHE_MODE_REUSE, local_path);
  567. if (err != OK) {
  568. if (!ResourceLoader::get_abort_on_missing_resources()) {
  569. ResourceLoader::notify_dependency_error(local_path, path, external_resources[i].type);
  570. } else {
  571. error = ERR_FILE_MISSING_DEPENDENCIES;
  572. ERR_FAIL_V_MSG(error, "Can't load dependency: " + path + ".");
  573. }
  574. }
  575. }
  576. stage++;
  577. }
  578. for (int i = 0; i < internal_resources.size(); i++) {
  579. bool main = i == (internal_resources.size() - 1);
  580. //maybe it is loaded already
  581. String path;
  582. String id;
  583. if (!main) {
  584. path = internal_resources[i].path;
  585. if (path.begins_with("local://")) {
  586. path = path.replace_first("local://", "");
  587. id = path;
  588. path = res_path + "::" + path;
  589. internal_resources.write[i].path = path; // Update path.
  590. }
  591. if (cache_mode == ResourceFormatLoader::CACHE_MODE_REUSE) {
  592. if (ResourceCache::has(path)) {
  593. //already loaded, don't do anything
  594. stage++;
  595. error = OK;
  596. continue;
  597. }
  598. }
  599. } else {
  600. if (cache_mode != ResourceFormatLoader::CACHE_MODE_IGNORE && !ResourceCache::has(res_path)) {
  601. path = res_path;
  602. }
  603. }
  604. uint64_t offset = internal_resources[i].offset;
  605. f->seek(offset);
  606. String t = get_unicode_string();
  607. RES res;
  608. if (cache_mode == ResourceFormatLoader::CACHE_MODE_REPLACE && ResourceCache::has(path)) {
  609. //use the existing one
  610. Resource *r = ResourceCache::get(path);
  611. if (r->get_class() == t) {
  612. r->reset_state();
  613. res = Ref<Resource>(r);
  614. }
  615. }
  616. if (res.is_null()) {
  617. //did not replace
  618. Object *obj = ClassDB::instantiate(t);
  619. if (!obj) {
  620. error = ERR_FILE_CORRUPT;
  621. ERR_FAIL_V_MSG(ERR_FILE_CORRUPT, local_path + ":Resource of unrecognized type in file: " + t + ".");
  622. }
  623. Resource *r = Object::cast_to<Resource>(obj);
  624. if (!r) {
  625. String obj_class = obj->get_class();
  626. error = ERR_FILE_CORRUPT;
  627. memdelete(obj); //bye
  628. ERR_FAIL_V_MSG(ERR_FILE_CORRUPT, local_path + ":Resource type in resource field not a resource, type is: " + obj_class + ".");
  629. }
  630. res = RES(r);
  631. if (!path.is_empty() && cache_mode != ResourceFormatLoader::CACHE_MODE_IGNORE) {
  632. r->set_path(path, cache_mode == ResourceFormatLoader::CACHE_MODE_REPLACE); //if got here because the resource with same path has different type, replace it
  633. }
  634. r->set_scene_unique_id(id);
  635. }
  636. if (!main) {
  637. internal_index_cache[path] = res;
  638. }
  639. int pc = f->get_32();
  640. //set properties
  641. for (int j = 0; j < pc; j++) {
  642. StringName name = _get_string();
  643. if (name == StringName()) {
  644. error = ERR_FILE_CORRUPT;
  645. ERR_FAIL_V(ERR_FILE_CORRUPT);
  646. }
  647. Variant value;
  648. error = parse_variant(value);
  649. if (error) {
  650. return error;
  651. }
  652. res->set(name, value);
  653. }
  654. #ifdef TOOLS_ENABLED
  655. res->set_edited(false);
  656. #endif
  657. stage++;
  658. if (progress) {
  659. *progress = (i + 1) / float(internal_resources.size());
  660. }
  661. resource_cache.push_back(res);
  662. if (main) {
  663. f->close();
  664. resource = res;
  665. resource->set_as_translation_remapped(translation_remapped);
  666. error = OK;
  667. return OK;
  668. }
  669. }
  670. return ERR_FILE_EOF;
  671. }
  672. void ResourceLoaderBinary::set_translation_remapped(bool p_remapped) {
  673. translation_remapped = p_remapped;
  674. }
  675. static void save_ustring(FileAccess *f, const String &p_string) {
  676. CharString utf8 = p_string.utf8();
  677. f->store_32(utf8.length() + 1);
  678. f->store_buffer((const uint8_t *)utf8.get_data(), utf8.length() + 1);
  679. }
  680. static String get_ustring(FileAccess *f) {
  681. int len = f->get_32();
  682. Vector<char> str_buf;
  683. str_buf.resize(len);
  684. f->get_buffer((uint8_t *)&str_buf[0], len);
  685. String s;
  686. s.parse_utf8(&str_buf[0]);
  687. return s;
  688. }
  689. String ResourceLoaderBinary::get_unicode_string() {
  690. int len = f->get_32();
  691. if (len > str_buf.size()) {
  692. str_buf.resize(len);
  693. }
  694. if (len == 0) {
  695. return String();
  696. }
  697. f->get_buffer((uint8_t *)&str_buf[0], len);
  698. String s;
  699. s.parse_utf8(&str_buf[0]);
  700. return s;
  701. }
  702. void ResourceLoaderBinary::get_dependencies(FileAccess *p_f, List<String> *p_dependencies, bool p_add_types) {
  703. open(p_f, false, true);
  704. if (error) {
  705. return;
  706. }
  707. for (int i = 0; i < external_resources.size(); i++) {
  708. String dep;
  709. if (external_resources[i].uid != ResourceUID::INVALID_ID) {
  710. dep = ResourceUID::get_singleton()->id_to_text(external_resources[i].uid);
  711. } else {
  712. dep = external_resources[i].path;
  713. }
  714. if (p_add_types && !external_resources[i].type.is_empty()) {
  715. dep += "::" + external_resources[i].type;
  716. }
  717. p_dependencies->push_back(dep);
  718. }
  719. }
  720. void ResourceLoaderBinary::open(FileAccess *p_f, bool p_no_resources, bool p_keep_uuid_paths) {
  721. error = OK;
  722. f = p_f;
  723. uint8_t header[4];
  724. f->get_buffer(header, 4);
  725. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  726. // Compressed.
  727. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  728. error = fac->open_after_magic(f);
  729. if (error != OK) {
  730. memdelete(fac);
  731. f->close();
  732. ERR_FAIL_MSG("Failed to open binary resource file: " + local_path + ".");
  733. }
  734. f = fac;
  735. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  736. // Not normal.
  737. error = ERR_FILE_UNRECOGNIZED;
  738. f->close();
  739. ERR_FAIL_MSG("Unrecognized binary resource file: " + local_path + ".");
  740. }
  741. bool big_endian = f->get_32();
  742. bool use_real64 = f->get_32();
  743. f->set_big_endian(big_endian != 0); //read big endian if saved as big endian
  744. uint32_t ver_major = f->get_32();
  745. uint32_t ver_minor = f->get_32();
  746. ver_format = f->get_32();
  747. print_bl("big endian: " + itos(big_endian));
  748. #ifdef BIG_ENDIAN_ENABLED
  749. print_bl("endian swap: " + itos(!big_endian));
  750. #else
  751. print_bl("endian swap: " + itos(big_endian));
  752. #endif
  753. print_bl("real64: " + itos(use_real64));
  754. print_bl("major: " + itos(ver_major));
  755. print_bl("minor: " + itos(ver_minor));
  756. print_bl("format: " + itos(ver_format));
  757. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  758. f->close();
  759. ERR_FAIL_MSG(vformat("File '%s' can't be loaded, as it uses a format version (%d) or engine version (%d.%d) which are not supported by your engine version (%s).",
  760. local_path, ver_format, ver_major, ver_minor, VERSION_BRANCH));
  761. }
  762. type = get_unicode_string();
  763. print_bl("type: " + type);
  764. importmd_ofs = f->get_64();
  765. uint32_t flags = f->get_32();
  766. if (flags & ResourceFormatSaverBinaryInstance::FORMAT_FLAG_NAMED_SCENE_IDS) {
  767. using_named_scene_ids = true;
  768. }
  769. if (flags & ResourceFormatSaverBinaryInstance::FORMAT_FLAG_UIDS) {
  770. using_uids = true;
  771. }
  772. if (using_uids) {
  773. uid = f->get_64();
  774. } else {
  775. f->get_64(); // skip over uid field
  776. uid = ResourceUID::INVALID_ID;
  777. }
  778. for (int i = 0; i < ResourceFormatSaverBinaryInstance::RESERVED_FIELDS; i++) {
  779. f->get_32(); //skip a few reserved fields
  780. }
  781. if (p_no_resources) {
  782. return;
  783. }
  784. uint32_t string_table_size = f->get_32();
  785. string_map.resize(string_table_size);
  786. for (uint32_t i = 0; i < string_table_size; i++) {
  787. StringName s = get_unicode_string();
  788. string_map.write[i] = s;
  789. }
  790. print_bl("strings: " + itos(string_table_size));
  791. uint32_t ext_resources_size = f->get_32();
  792. for (uint32_t i = 0; i < ext_resources_size; i++) {
  793. ExtResource er;
  794. er.type = get_unicode_string();
  795. er.path = get_unicode_string();
  796. if (using_uids) {
  797. er.uid = f->get_64();
  798. if (!p_keep_uuid_paths && er.uid != ResourceUID::INVALID_ID) {
  799. if (ResourceUID::get_singleton()->has_id(er.uid)) {
  800. // If a UID is found and the path is valid, it will be used, otherwise, it falls back to the path.
  801. er.path = ResourceUID::get_singleton()->get_id_path(er.uid);
  802. } else {
  803. WARN_PRINT(String(res_path + ": In external resource #" + itos(i) + ", invalid UUID: " + ResourceUID::get_singleton()->id_to_text(er.uid) + " - using text path instead: " + er.path).utf8().get_data());
  804. }
  805. }
  806. }
  807. external_resources.push_back(er);
  808. }
  809. print_bl("ext resources: " + itos(ext_resources_size));
  810. uint32_t int_resources_size = f->get_32();
  811. for (uint32_t i = 0; i < int_resources_size; i++) {
  812. IntResource ir;
  813. ir.path = get_unicode_string();
  814. ir.offset = f->get_64();
  815. internal_resources.push_back(ir);
  816. }
  817. print_bl("int resources: " + itos(int_resources_size));
  818. if (f->eof_reached()) {
  819. error = ERR_FILE_CORRUPT;
  820. f->close();
  821. ERR_FAIL_MSG("Premature end of file (EOF): " + local_path + ".");
  822. }
  823. }
  824. String ResourceLoaderBinary::recognize(FileAccess *p_f) {
  825. error = OK;
  826. f = p_f;
  827. uint8_t header[4];
  828. f->get_buffer(header, 4);
  829. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  830. // Compressed.
  831. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  832. error = fac->open_after_magic(f);
  833. if (error != OK) {
  834. memdelete(fac);
  835. f->close();
  836. return "";
  837. }
  838. f = fac;
  839. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  840. // Not normal.
  841. error = ERR_FILE_UNRECOGNIZED;
  842. f->close();
  843. return "";
  844. }
  845. bool big_endian = f->get_32();
  846. f->get_32(); // use_real64
  847. f->set_big_endian(big_endian != 0); //read big endian if saved as big endian
  848. uint32_t ver_major = f->get_32();
  849. f->get_32(); // ver_minor
  850. uint32_t ver_format = f->get_32();
  851. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  852. f->close();
  853. return "";
  854. }
  855. String type = get_unicode_string();
  856. return type;
  857. }
  858. ResourceLoaderBinary::~ResourceLoaderBinary() {
  859. if (f) {
  860. memdelete(f);
  861. }
  862. }
  863. RES ResourceFormatLoaderBinary::load(const String &p_path, const String &p_original_path, Error *r_error, bool p_use_sub_threads, float *r_progress, CacheMode p_cache_mode) {
  864. if (r_error) {
  865. *r_error = ERR_FILE_CANT_OPEN;
  866. }
  867. Error err;
  868. FileAccess *f = FileAccess::open(p_path, FileAccess::READ, &err);
  869. ERR_FAIL_COND_V_MSG(err != OK, RES(), "Cannot open file '" + p_path + "'.");
  870. ResourceLoaderBinary loader;
  871. loader.cache_mode = p_cache_mode;
  872. loader.use_sub_threads = p_use_sub_threads;
  873. loader.progress = r_progress;
  874. String path = !p_original_path.is_empty() ? p_original_path : p_path;
  875. loader.local_path = ProjectSettings::get_singleton()->localize_path(path);
  876. loader.res_path = loader.local_path;
  877. //loader.set_local_path( Globals::get_singleton()->localize_path(p_path) );
  878. loader.open(f);
  879. err = loader.load();
  880. if (r_error) {
  881. *r_error = err;
  882. }
  883. if (err) {
  884. return RES();
  885. }
  886. return loader.resource;
  887. }
  888. void ResourceFormatLoaderBinary::get_recognized_extensions_for_type(const String &p_type, List<String> *p_extensions) const {
  889. if (p_type.is_empty()) {
  890. get_recognized_extensions(p_extensions);
  891. return;
  892. }
  893. List<String> extensions;
  894. ClassDB::get_extensions_for_type(p_type, &extensions);
  895. extensions.sort();
  896. for (const String &E : extensions) {
  897. String ext = E.to_lower();
  898. p_extensions->push_back(ext);
  899. }
  900. }
  901. void ResourceFormatLoaderBinary::get_recognized_extensions(List<String> *p_extensions) const {
  902. List<String> extensions;
  903. ClassDB::get_resource_base_extensions(&extensions);
  904. extensions.sort();
  905. for (const String &E : extensions) {
  906. String ext = E.to_lower();
  907. p_extensions->push_back(ext);
  908. }
  909. }
  910. bool ResourceFormatLoaderBinary::handles_type(const String &p_type) const {
  911. return true; //handles all
  912. }
  913. void ResourceFormatLoaderBinary::get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types) {
  914. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  915. ERR_FAIL_COND_MSG(!f, "Cannot open file '" + p_path + "'.");
  916. ResourceLoaderBinary loader;
  917. loader.local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  918. loader.res_path = loader.local_path;
  919. //loader.set_local_path( Globals::get_singleton()->localize_path(p_path) );
  920. loader.get_dependencies(f, p_dependencies, p_add_types);
  921. }
  922. Error ResourceFormatLoaderBinary::rename_dependencies(const String &p_path, const Map<String, String> &p_map) {
  923. //Error error=OK;
  924. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  925. ERR_FAIL_COND_V_MSG(!f, ERR_CANT_OPEN, "Cannot open file '" + p_path + "'.");
  926. FileAccess *fw = nullptr; //=FileAccess::open(p_path+".depren");
  927. String local_path = p_path.get_base_dir();
  928. uint8_t header[4];
  929. f->get_buffer(header, 4);
  930. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  931. // Compressed.
  932. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  933. Error err = fac->open_after_magic(f);
  934. if (err != OK) {
  935. memdelete(fac);
  936. memdelete(f);
  937. ERR_FAIL_V_MSG(err, "Cannot open file '" + p_path + "'.");
  938. }
  939. f = fac;
  940. FileAccessCompressed *facw = memnew(FileAccessCompressed);
  941. facw->configure("RSCC");
  942. err = facw->_open(p_path + ".depren", FileAccess::WRITE);
  943. if (err) {
  944. memdelete(fac);
  945. memdelete(facw);
  946. ERR_FAIL_COND_V_MSG(err, ERR_FILE_CORRUPT, "Cannot create file '" + p_path + ".depren'.");
  947. }
  948. fw = facw;
  949. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  950. // Not normal.
  951. memdelete(f);
  952. ERR_FAIL_V_MSG(ERR_FILE_UNRECOGNIZED, "Unrecognized binary resource file '" + local_path + "'.");
  953. } else {
  954. fw = FileAccess::open(p_path + ".depren", FileAccess::WRITE);
  955. if (!fw) {
  956. memdelete(f);
  957. }
  958. ERR_FAIL_COND_V_MSG(!fw, ERR_CANT_CREATE, "Cannot create file '" + p_path + ".depren'.");
  959. uint8_t magic[4] = { 'R', 'S', 'R', 'C' };
  960. fw->store_buffer(magic, 4);
  961. }
  962. bool big_endian = f->get_32();
  963. bool use_real64 = f->get_32();
  964. f->set_big_endian(big_endian != 0); //read big endian if saved as big endian
  965. #ifdef BIG_ENDIAN_ENABLED
  966. fw->store_32(!big_endian);
  967. #else
  968. fw->store_32(big_endian);
  969. #endif
  970. fw->set_big_endian(big_endian != 0);
  971. fw->store_32(use_real64); //use real64
  972. uint32_t ver_major = f->get_32();
  973. uint32_t ver_minor = f->get_32();
  974. uint32_t ver_format = f->get_32();
  975. if (ver_format < FORMAT_VERSION_CAN_RENAME_DEPS) {
  976. memdelete(f);
  977. memdelete(fw);
  978. DirAccess *da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  979. da->remove(p_path + ".depren");
  980. memdelete(da);
  981. //use the old approach
  982. WARN_PRINT("This file is old, so it can't refactor dependencies, opening and resaving '" + p_path + "'.");
  983. Error err;
  984. f = FileAccess::open(p_path, FileAccess::READ, &err);
  985. ERR_FAIL_COND_V_MSG(err != OK, ERR_FILE_CANT_OPEN, "Cannot open file '" + p_path + "'.");
  986. ResourceLoaderBinary loader;
  987. loader.local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  988. loader.res_path = loader.local_path;
  989. loader.remaps = p_map;
  990. //loader.set_local_path( Globals::get_singleton()->localize_path(p_path) );
  991. loader.open(f);
  992. err = loader.load();
  993. ERR_FAIL_COND_V(err != ERR_FILE_EOF, ERR_FILE_CORRUPT);
  994. RES res = loader.get_resource();
  995. ERR_FAIL_COND_V(!res.is_valid(), ERR_FILE_CORRUPT);
  996. return ResourceFormatSaverBinary::singleton->save(p_path, res);
  997. }
  998. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  999. memdelete(f);
  1000. memdelete(fw);
  1001. ERR_FAIL_V_MSG(ERR_FILE_UNRECOGNIZED,
  1002. vformat("File '%s' can't be loaded, as it uses a format version (%d) or engine version (%d.%d) which are not supported by your engine version (%s).",
  1003. local_path, ver_format, ver_major, ver_minor, VERSION_BRANCH));
  1004. }
  1005. // Since we're not actually converting the file contents, leave the version
  1006. // numbers in the file untouched.
  1007. fw->store_32(ver_major);
  1008. fw->store_32(ver_minor);
  1009. fw->store_32(ver_format);
  1010. save_ustring(fw, get_ustring(f)); //type
  1011. uint64_t md_ofs = f->get_position();
  1012. uint64_t importmd_ofs = f->get_64();
  1013. fw->store_64(0); //metadata offset
  1014. uint32_t flags = f->get_32();
  1015. bool using_uids = (flags & ResourceFormatSaverBinaryInstance::FORMAT_FLAG_UIDS);
  1016. uint64_t uid_data = f->get_64();
  1017. fw->store_32(flags);
  1018. fw->store_64(uid_data);
  1019. for (int i = 0; i < ResourceFormatSaverBinaryInstance::RESERVED_FIELDS; i++) {
  1020. fw->store_32(0); // reserved
  1021. f->get_32();
  1022. }
  1023. //string table
  1024. uint32_t string_table_size = f->get_32();
  1025. fw->store_32(string_table_size);
  1026. for (uint32_t i = 0; i < string_table_size; i++) {
  1027. String s = get_ustring(f);
  1028. save_ustring(fw, s);
  1029. }
  1030. //external resources
  1031. uint32_t ext_resources_size = f->get_32();
  1032. fw->store_32(ext_resources_size);
  1033. for (uint32_t i = 0; i < ext_resources_size; i++) {
  1034. String type = get_ustring(f);
  1035. String path = get_ustring(f);
  1036. if (using_uids) {
  1037. ResourceUID::ID uid = f->get_64();
  1038. if (uid != ResourceUID::INVALID_ID) {
  1039. if (ResourceUID::get_singleton()->has_id(uid)) {
  1040. // If a UID is found and the path is valid, it will be used, otherwise, it falls back to the path.
  1041. path = ResourceUID::get_singleton()->get_id_path(uid);
  1042. }
  1043. }
  1044. }
  1045. bool relative = false;
  1046. if (!path.begins_with("res://")) {
  1047. path = local_path.plus_file(path).simplify_path();
  1048. relative = true;
  1049. }
  1050. if (p_map.has(path)) {
  1051. String np = p_map[path];
  1052. path = np;
  1053. }
  1054. String full_path = path;
  1055. if (relative) {
  1056. //restore relative
  1057. path = local_path.path_to_file(path);
  1058. }
  1059. save_ustring(fw, type);
  1060. save_ustring(fw, path);
  1061. if (using_uids) {
  1062. ResourceUID::ID uid = ResourceSaver::get_resource_id_for_path(full_path);
  1063. fw->store_64(uid);
  1064. }
  1065. }
  1066. int64_t size_diff = (int64_t)fw->get_position() - (int64_t)f->get_position();
  1067. //internal resources
  1068. uint32_t int_resources_size = f->get_32();
  1069. fw->store_32(int_resources_size);
  1070. for (uint32_t i = 0; i < int_resources_size; i++) {
  1071. String path = get_ustring(f);
  1072. uint64_t offset = f->get_64();
  1073. save_ustring(fw, path);
  1074. fw->store_64(offset + size_diff);
  1075. }
  1076. //rest of file
  1077. uint8_t b = f->get_8();
  1078. while (!f->eof_reached()) {
  1079. fw->store_8(b);
  1080. b = f->get_8();
  1081. }
  1082. bool all_ok = fw->get_error() == OK;
  1083. fw->seek(md_ofs);
  1084. fw->store_64(importmd_ofs + size_diff);
  1085. memdelete(f);
  1086. memdelete(fw);
  1087. if (!all_ok) {
  1088. return ERR_CANT_CREATE;
  1089. }
  1090. DirAccess *da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  1091. da->remove(p_path);
  1092. da->rename(p_path + ".depren", p_path);
  1093. memdelete(da);
  1094. return OK;
  1095. }
  1096. String ResourceFormatLoaderBinary::get_resource_type(const String &p_path) const {
  1097. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  1098. if (!f) {
  1099. return ""; //could not read
  1100. }
  1101. ResourceLoaderBinary loader;
  1102. loader.local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  1103. loader.res_path = loader.local_path;
  1104. //loader.set_local_path( Globals::get_singleton()->localize_path(p_path) );
  1105. String r = loader.recognize(f);
  1106. return ClassDB::get_compatibility_remapped_class(r);
  1107. }
  1108. ResourceUID::ID ResourceFormatLoaderBinary::get_resource_uid(const String &p_path) const {
  1109. String ext = p_path.get_extension().to_lower();
  1110. if (!ClassDB::is_resource_extension(ext)) {
  1111. return ResourceUID::INVALID_ID;
  1112. }
  1113. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  1114. if (!f) {
  1115. return ResourceUID::INVALID_ID; //could not read
  1116. }
  1117. ResourceLoaderBinary loader;
  1118. loader.local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  1119. loader.res_path = loader.local_path;
  1120. //loader.set_local_path( Globals::get_singleton()->localize_path(p_path) );
  1121. loader.open(f, true);
  1122. if (loader.error != OK) {
  1123. return ResourceUID::INVALID_ID; //could not read
  1124. }
  1125. return loader.uid;
  1126. }
  1127. ///////////////////////////////////////////////////////////
  1128. ///////////////////////////////////////////////////////////
  1129. ///////////////////////////////////////////////////////////
  1130. void ResourceFormatSaverBinaryInstance::_pad_buffer(FileAccess *f, int p_bytes) {
  1131. int extra = 4 - (p_bytes % 4);
  1132. if (extra < 4) {
  1133. for (int i = 0; i < extra; i++) {
  1134. f->store_8(0); //pad to 32
  1135. }
  1136. }
  1137. }
  1138. void ResourceFormatSaverBinaryInstance::write_variant(FileAccess *f, const Variant &p_property, Map<RES, int> &resource_map, Map<RES, int> &external_resources, Map<StringName, int> &string_map, const PropertyInfo &p_hint) {
  1139. switch (p_property.get_type()) {
  1140. case Variant::NIL: {
  1141. f->store_32(VARIANT_NIL);
  1142. // don't store anything
  1143. } break;
  1144. case Variant::BOOL: {
  1145. f->store_32(VARIANT_BOOL);
  1146. bool val = p_property;
  1147. f->store_32(val);
  1148. } break;
  1149. case Variant::INT: {
  1150. int64_t val = p_property;
  1151. if (val > 0x7FFFFFFF || val < -(int64_t)0x80000000) {
  1152. f->store_32(VARIANT_INT64);
  1153. f->store_64(val);
  1154. } else {
  1155. f->store_32(VARIANT_INT);
  1156. f->store_32(int32_t(p_property));
  1157. }
  1158. } break;
  1159. case Variant::FLOAT: {
  1160. double d = p_property;
  1161. float fl = d;
  1162. if (double(fl) != d) {
  1163. f->store_32(VARIANT_DOUBLE);
  1164. f->store_double(d);
  1165. } else {
  1166. f->store_32(VARIANT_FLOAT);
  1167. f->store_real(fl);
  1168. }
  1169. } break;
  1170. case Variant::STRING: {
  1171. f->store_32(VARIANT_STRING);
  1172. String val = p_property;
  1173. save_unicode_string(f, val);
  1174. } break;
  1175. case Variant::VECTOR2: {
  1176. f->store_32(VARIANT_VECTOR2);
  1177. Vector2 val = p_property;
  1178. f->store_real(val.x);
  1179. f->store_real(val.y);
  1180. } break;
  1181. case Variant::VECTOR2I: {
  1182. f->store_32(VARIANT_VECTOR2I);
  1183. Vector2i val = p_property;
  1184. f->store_32(val.x);
  1185. f->store_32(val.y);
  1186. } break;
  1187. case Variant::RECT2: {
  1188. f->store_32(VARIANT_RECT2);
  1189. Rect2 val = p_property;
  1190. f->store_real(val.position.x);
  1191. f->store_real(val.position.y);
  1192. f->store_real(val.size.x);
  1193. f->store_real(val.size.y);
  1194. } break;
  1195. case Variant::RECT2I: {
  1196. f->store_32(VARIANT_RECT2I);
  1197. Rect2i val = p_property;
  1198. f->store_32(val.position.x);
  1199. f->store_32(val.position.y);
  1200. f->store_32(val.size.x);
  1201. f->store_32(val.size.y);
  1202. } break;
  1203. case Variant::VECTOR3: {
  1204. f->store_32(VARIANT_VECTOR3);
  1205. Vector3 val = p_property;
  1206. f->store_real(val.x);
  1207. f->store_real(val.y);
  1208. f->store_real(val.z);
  1209. } break;
  1210. case Variant::VECTOR3I: {
  1211. f->store_32(VARIANT_VECTOR3I);
  1212. Vector3i val = p_property;
  1213. f->store_32(val.x);
  1214. f->store_32(val.y);
  1215. f->store_32(val.z);
  1216. } break;
  1217. case Variant::PLANE: {
  1218. f->store_32(VARIANT_PLANE);
  1219. Plane val = p_property;
  1220. f->store_real(val.normal.x);
  1221. f->store_real(val.normal.y);
  1222. f->store_real(val.normal.z);
  1223. f->store_real(val.d);
  1224. } break;
  1225. case Variant::QUATERNION: {
  1226. f->store_32(VARIANT_QUATERNION);
  1227. Quaternion val = p_property;
  1228. f->store_real(val.x);
  1229. f->store_real(val.y);
  1230. f->store_real(val.z);
  1231. f->store_real(val.w);
  1232. } break;
  1233. case Variant::AABB: {
  1234. f->store_32(VARIANT_AABB);
  1235. AABB val = p_property;
  1236. f->store_real(val.position.x);
  1237. f->store_real(val.position.y);
  1238. f->store_real(val.position.z);
  1239. f->store_real(val.size.x);
  1240. f->store_real(val.size.y);
  1241. f->store_real(val.size.z);
  1242. } break;
  1243. case Variant::TRANSFORM2D: {
  1244. f->store_32(VARIANT_TRANSFORM2D);
  1245. Transform2D val = p_property;
  1246. f->store_real(val.elements[0].x);
  1247. f->store_real(val.elements[0].y);
  1248. f->store_real(val.elements[1].x);
  1249. f->store_real(val.elements[1].y);
  1250. f->store_real(val.elements[2].x);
  1251. f->store_real(val.elements[2].y);
  1252. } break;
  1253. case Variant::BASIS: {
  1254. f->store_32(VARIANT_BASIS);
  1255. Basis val = p_property;
  1256. f->store_real(val.elements[0].x);
  1257. f->store_real(val.elements[0].y);
  1258. f->store_real(val.elements[0].z);
  1259. f->store_real(val.elements[1].x);
  1260. f->store_real(val.elements[1].y);
  1261. f->store_real(val.elements[1].z);
  1262. f->store_real(val.elements[2].x);
  1263. f->store_real(val.elements[2].y);
  1264. f->store_real(val.elements[2].z);
  1265. } break;
  1266. case Variant::TRANSFORM3D: {
  1267. f->store_32(VARIANT_TRANSFORM3D);
  1268. Transform3D val = p_property;
  1269. f->store_real(val.basis.elements[0].x);
  1270. f->store_real(val.basis.elements[0].y);
  1271. f->store_real(val.basis.elements[0].z);
  1272. f->store_real(val.basis.elements[1].x);
  1273. f->store_real(val.basis.elements[1].y);
  1274. f->store_real(val.basis.elements[1].z);
  1275. f->store_real(val.basis.elements[2].x);
  1276. f->store_real(val.basis.elements[2].y);
  1277. f->store_real(val.basis.elements[2].z);
  1278. f->store_real(val.origin.x);
  1279. f->store_real(val.origin.y);
  1280. f->store_real(val.origin.z);
  1281. } break;
  1282. case Variant::COLOR: {
  1283. f->store_32(VARIANT_COLOR);
  1284. Color val = p_property;
  1285. f->store_real(val.r);
  1286. f->store_real(val.g);
  1287. f->store_real(val.b);
  1288. f->store_real(val.a);
  1289. } break;
  1290. case Variant::STRING_NAME: {
  1291. f->store_32(VARIANT_STRING_NAME);
  1292. String val = p_property;
  1293. save_unicode_string(f, val);
  1294. } break;
  1295. case Variant::NODE_PATH: {
  1296. f->store_32(VARIANT_NODE_PATH);
  1297. NodePath np = p_property;
  1298. f->store_16(np.get_name_count());
  1299. uint16_t snc = np.get_subname_count();
  1300. if (np.is_absolute()) {
  1301. snc |= 0x8000;
  1302. }
  1303. f->store_16(snc);
  1304. for (int i = 0; i < np.get_name_count(); i++) {
  1305. if (string_map.has(np.get_name(i))) {
  1306. f->store_32(string_map[np.get_name(i)]);
  1307. } else {
  1308. save_unicode_string(f, np.get_name(i), true);
  1309. }
  1310. }
  1311. for (int i = 0; i < np.get_subname_count(); i++) {
  1312. if (string_map.has(np.get_subname(i))) {
  1313. f->store_32(string_map[np.get_subname(i)]);
  1314. } else {
  1315. save_unicode_string(f, np.get_subname(i), true);
  1316. }
  1317. }
  1318. } break;
  1319. case Variant::RID: {
  1320. f->store_32(VARIANT_RID);
  1321. WARN_PRINT("Can't save RIDs.");
  1322. RID val = p_property;
  1323. f->store_32(val.get_id());
  1324. } break;
  1325. case Variant::OBJECT: {
  1326. f->store_32(VARIANT_OBJECT);
  1327. RES res = p_property;
  1328. if (res.is_null()) {
  1329. f->store_32(OBJECT_EMPTY);
  1330. return; // don't save it
  1331. }
  1332. if (!res->is_built_in()) {
  1333. f->store_32(OBJECT_EXTERNAL_RESOURCE_INDEX);
  1334. f->store_32(external_resources[res]);
  1335. } else {
  1336. if (!resource_map.has(res)) {
  1337. f->store_32(OBJECT_EMPTY);
  1338. ERR_FAIL_MSG("Resource was not pre cached for the resource section, most likely due to circular reference.");
  1339. }
  1340. f->store_32(OBJECT_INTERNAL_RESOURCE);
  1341. f->store_32(resource_map[res]);
  1342. //internal resource
  1343. }
  1344. } break;
  1345. case Variant::CALLABLE: {
  1346. f->store_32(VARIANT_CALLABLE);
  1347. WARN_PRINT("Can't save Callables.");
  1348. } break;
  1349. case Variant::SIGNAL: {
  1350. f->store_32(VARIANT_SIGNAL);
  1351. WARN_PRINT("Can't save Signals.");
  1352. } break;
  1353. case Variant::DICTIONARY: {
  1354. f->store_32(VARIANT_DICTIONARY);
  1355. Dictionary d = p_property;
  1356. f->store_32(uint32_t(d.size()));
  1357. List<Variant> keys;
  1358. d.get_key_list(&keys);
  1359. for (const Variant &E : keys) {
  1360. /*
  1361. if (!_check_type(dict[E]))
  1362. continue;
  1363. */
  1364. write_variant(f, E, resource_map, external_resources, string_map);
  1365. write_variant(f, d[E], resource_map, external_resources, string_map);
  1366. }
  1367. } break;
  1368. case Variant::ARRAY: {
  1369. f->store_32(VARIANT_ARRAY);
  1370. Array a = p_property;
  1371. f->store_32(uint32_t(a.size()));
  1372. for (int i = 0; i < a.size(); i++) {
  1373. write_variant(f, a[i], resource_map, external_resources, string_map);
  1374. }
  1375. } break;
  1376. case Variant::PACKED_BYTE_ARRAY: {
  1377. f->store_32(VARIANT_PACKED_BYTE_ARRAY);
  1378. Vector<uint8_t> arr = p_property;
  1379. int len = arr.size();
  1380. f->store_32(len);
  1381. const uint8_t *r = arr.ptr();
  1382. f->store_buffer(r, len);
  1383. _pad_buffer(f, len);
  1384. } break;
  1385. case Variant::PACKED_INT32_ARRAY: {
  1386. f->store_32(VARIANT_PACKED_INT32_ARRAY);
  1387. Vector<int32_t> arr = p_property;
  1388. int len = arr.size();
  1389. f->store_32(len);
  1390. const int32_t *r = arr.ptr();
  1391. for (int i = 0; i < len; i++) {
  1392. f->store_32(r[i]);
  1393. }
  1394. } break;
  1395. case Variant::PACKED_INT64_ARRAY: {
  1396. f->store_32(VARIANT_PACKED_INT64_ARRAY);
  1397. Vector<int64_t> arr = p_property;
  1398. int len = arr.size();
  1399. f->store_32(len);
  1400. const int64_t *r = arr.ptr();
  1401. for (int i = 0; i < len; i++) {
  1402. f->store_64(r[i]);
  1403. }
  1404. } break;
  1405. case Variant::PACKED_FLOAT32_ARRAY: {
  1406. f->store_32(VARIANT_PACKED_FLOAT32_ARRAY);
  1407. Vector<float> arr = p_property;
  1408. int len = arr.size();
  1409. f->store_32(len);
  1410. const float *r = arr.ptr();
  1411. for (int i = 0; i < len; i++) {
  1412. f->store_real(r[i]);
  1413. }
  1414. } break;
  1415. case Variant::PACKED_FLOAT64_ARRAY: {
  1416. f->store_32(VARIANT_PACKED_FLOAT64_ARRAY);
  1417. Vector<double> arr = p_property;
  1418. int len = arr.size();
  1419. f->store_32(len);
  1420. const double *r = arr.ptr();
  1421. for (int i = 0; i < len; i++) {
  1422. f->store_double(r[i]);
  1423. }
  1424. } break;
  1425. case Variant::PACKED_STRING_ARRAY: {
  1426. f->store_32(VARIANT_PACKED_STRING_ARRAY);
  1427. Vector<String> arr = p_property;
  1428. int len = arr.size();
  1429. f->store_32(len);
  1430. const String *r = arr.ptr();
  1431. for (int i = 0; i < len; i++) {
  1432. save_unicode_string(f, r[i]);
  1433. }
  1434. } break;
  1435. case Variant::PACKED_VECTOR3_ARRAY: {
  1436. f->store_32(VARIANT_PACKED_VECTOR3_ARRAY);
  1437. Vector<Vector3> arr = p_property;
  1438. int len = arr.size();
  1439. f->store_32(len);
  1440. const Vector3 *r = arr.ptr();
  1441. for (int i = 0; i < len; i++) {
  1442. f->store_real(r[i].x);
  1443. f->store_real(r[i].y);
  1444. f->store_real(r[i].z);
  1445. }
  1446. } break;
  1447. case Variant::PACKED_VECTOR2_ARRAY: {
  1448. f->store_32(VARIANT_PACKED_VECTOR2_ARRAY);
  1449. Vector<Vector2> arr = p_property;
  1450. int len = arr.size();
  1451. f->store_32(len);
  1452. const Vector2 *r = arr.ptr();
  1453. for (int i = 0; i < len; i++) {
  1454. f->store_real(r[i].x);
  1455. f->store_real(r[i].y);
  1456. }
  1457. } break;
  1458. case Variant::PACKED_COLOR_ARRAY: {
  1459. f->store_32(VARIANT_PACKED_COLOR_ARRAY);
  1460. Vector<Color> arr = p_property;
  1461. int len = arr.size();
  1462. f->store_32(len);
  1463. const Color *r = arr.ptr();
  1464. for (int i = 0; i < len; i++) {
  1465. f->store_real(r[i].r);
  1466. f->store_real(r[i].g);
  1467. f->store_real(r[i].b);
  1468. f->store_real(r[i].a);
  1469. }
  1470. } break;
  1471. default: {
  1472. ERR_FAIL_MSG("Invalid variant.");
  1473. }
  1474. }
  1475. }
  1476. void ResourceFormatSaverBinaryInstance::_find_resources(const Variant &p_variant, bool p_main) {
  1477. switch (p_variant.get_type()) {
  1478. case Variant::OBJECT: {
  1479. RES res = p_variant;
  1480. if (res.is_null() || external_resources.has(res)) {
  1481. return;
  1482. }
  1483. if (!p_main && (!bundle_resources) && !res->is_built_in()) {
  1484. if (res->get_path() == path) {
  1485. ERR_PRINT("Circular reference to resource being saved found: '" + local_path + "' will be null next time it's loaded.");
  1486. return;
  1487. }
  1488. int idx = external_resources.size();
  1489. external_resources[res] = idx;
  1490. return;
  1491. }
  1492. if (resource_set.has(res)) {
  1493. return;
  1494. }
  1495. List<PropertyInfo> property_list;
  1496. res->get_property_list(&property_list);
  1497. for (const PropertyInfo &E : property_list) {
  1498. if (E.usage & PROPERTY_USAGE_STORAGE) {
  1499. Variant value = res->get(E.name);
  1500. if (E.usage & PROPERTY_USAGE_RESOURCE_NOT_PERSISTENT) {
  1501. RES sres = value;
  1502. if (sres.is_valid()) {
  1503. NonPersistentKey npk;
  1504. npk.base = res;
  1505. npk.property = E.name;
  1506. non_persistent_map[npk] = sres;
  1507. resource_set.insert(sres);
  1508. saved_resources.push_back(sres);
  1509. }
  1510. } else {
  1511. _find_resources(value);
  1512. }
  1513. }
  1514. }
  1515. resource_set.insert(res);
  1516. saved_resources.push_back(res);
  1517. } break;
  1518. case Variant::ARRAY: {
  1519. Array varray = p_variant;
  1520. int len = varray.size();
  1521. for (int i = 0; i < len; i++) {
  1522. const Variant &v = varray.get(i);
  1523. _find_resources(v);
  1524. }
  1525. } break;
  1526. case Variant::DICTIONARY: {
  1527. Dictionary d = p_variant;
  1528. List<Variant> keys;
  1529. d.get_key_list(&keys);
  1530. for (const Variant &E : keys) {
  1531. _find_resources(E);
  1532. Variant v = d[E];
  1533. _find_resources(v);
  1534. }
  1535. } break;
  1536. case Variant::NODE_PATH: {
  1537. //take the chance and save node path strings
  1538. NodePath np = p_variant;
  1539. for (int i = 0; i < np.get_name_count(); i++) {
  1540. get_string_index(np.get_name(i));
  1541. }
  1542. for (int i = 0; i < np.get_subname_count(); i++) {
  1543. get_string_index(np.get_subname(i));
  1544. }
  1545. } break;
  1546. default: {
  1547. }
  1548. }
  1549. }
  1550. void ResourceFormatSaverBinaryInstance::save_unicode_string(FileAccess *f, const String &p_string, bool p_bit_on_len) {
  1551. CharString utf8 = p_string.utf8();
  1552. if (p_bit_on_len) {
  1553. f->store_32((utf8.length() + 1) | 0x80000000);
  1554. } else {
  1555. f->store_32(utf8.length() + 1);
  1556. }
  1557. f->store_buffer((const uint8_t *)utf8.get_data(), utf8.length() + 1);
  1558. }
  1559. int ResourceFormatSaverBinaryInstance::get_string_index(const String &p_string) {
  1560. StringName s = p_string;
  1561. if (string_map.has(s)) {
  1562. return string_map[s];
  1563. }
  1564. string_map[s] = strings.size();
  1565. strings.push_back(s);
  1566. return strings.size() - 1;
  1567. }
  1568. Error ResourceFormatSaverBinaryInstance::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  1569. Error err;
  1570. if (p_flags & ResourceSaver::FLAG_COMPRESS) {
  1571. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  1572. fac->configure("RSCC");
  1573. f = fac;
  1574. err = fac->_open(p_path, FileAccess::WRITE);
  1575. if (err) {
  1576. memdelete(f);
  1577. }
  1578. } else {
  1579. f = FileAccess::open(p_path, FileAccess::WRITE, &err);
  1580. }
  1581. ERR_FAIL_COND_V_MSG(err != OK, err, "Cannot create file '" + p_path + "'.");
  1582. relative_paths = p_flags & ResourceSaver::FLAG_RELATIVE_PATHS;
  1583. skip_editor = p_flags & ResourceSaver::FLAG_OMIT_EDITOR_PROPERTIES;
  1584. bundle_resources = p_flags & ResourceSaver::FLAG_BUNDLE_RESOURCES;
  1585. big_endian = p_flags & ResourceSaver::FLAG_SAVE_BIG_ENDIAN;
  1586. takeover_paths = p_flags & ResourceSaver::FLAG_REPLACE_SUBRESOURCE_PATHS;
  1587. if (!p_path.begins_with("res://")) {
  1588. takeover_paths = false;
  1589. }
  1590. local_path = p_path.get_base_dir();
  1591. path = ProjectSettings::get_singleton()->localize_path(p_path);
  1592. _find_resources(p_resource, true);
  1593. if (!(p_flags & ResourceSaver::FLAG_COMPRESS)) {
  1594. //save header compressed
  1595. static const uint8_t header[4] = { 'R', 'S', 'R', 'C' };
  1596. f->store_buffer(header, 4);
  1597. }
  1598. if (big_endian) {
  1599. f->store_32(1);
  1600. f->set_big_endian(true);
  1601. } else {
  1602. f->store_32(0);
  1603. }
  1604. f->store_32(0); //64 bits file, false for now
  1605. f->store_32(VERSION_MAJOR);
  1606. f->store_32(VERSION_MINOR);
  1607. f->store_32(FORMAT_VERSION);
  1608. if (f->get_error() != OK && f->get_error() != ERR_FILE_EOF) {
  1609. f->close();
  1610. memdelete(f);
  1611. return ERR_CANT_CREATE;
  1612. }
  1613. save_unicode_string(f, p_resource->get_class());
  1614. f->store_64(0); //offset to import metadata
  1615. f->store_32(FORMAT_FLAG_NAMED_SCENE_IDS | FORMAT_FLAG_UIDS);
  1616. ResourceUID::ID uid = ResourceSaver::get_resource_id_for_path(p_path, true);
  1617. f->store_64(uid);
  1618. for (int i = 0; i < ResourceFormatSaverBinaryInstance::RESERVED_FIELDS; i++) {
  1619. f->store_32(0); // reserved
  1620. }
  1621. List<ResourceData> resources;
  1622. {
  1623. for (const RES &E : saved_resources) {
  1624. ResourceData &rd = resources.push_back(ResourceData())->get();
  1625. rd.type = E->get_class();
  1626. List<PropertyInfo> property_list;
  1627. E->get_property_list(&property_list);
  1628. for (const PropertyInfo &F : property_list) {
  1629. if (skip_editor && F.name.begins_with("__editor")) {
  1630. continue;
  1631. }
  1632. if ((F.usage & PROPERTY_USAGE_STORAGE)) {
  1633. Property p;
  1634. p.name_idx = get_string_index(F.name);
  1635. if (F.usage & PROPERTY_USAGE_RESOURCE_NOT_PERSISTENT) {
  1636. NonPersistentKey npk;
  1637. npk.base = E;
  1638. npk.property = F.name;
  1639. if (non_persistent_map.has(npk)) {
  1640. p.value = non_persistent_map[npk];
  1641. }
  1642. } else {
  1643. p.value = E->get(F.name);
  1644. }
  1645. Variant default_value = ClassDB::class_get_default_property_value(E->get_class(), F.name);
  1646. if (default_value.get_type() != Variant::NIL && bool(Variant::evaluate(Variant::OP_EQUAL, p.value, default_value))) {
  1647. continue;
  1648. }
  1649. p.pi = F;
  1650. rd.properties.push_back(p);
  1651. }
  1652. }
  1653. }
  1654. }
  1655. f->store_32(strings.size()); //string table size
  1656. for (int i = 0; i < strings.size(); i++) {
  1657. save_unicode_string(f, strings[i]);
  1658. }
  1659. // save external resource table
  1660. f->store_32(external_resources.size()); //amount of external resources
  1661. Vector<RES> save_order;
  1662. save_order.resize(external_resources.size());
  1663. for (const KeyValue<RES, int> &E : external_resources) {
  1664. save_order.write[E.value] = E.key;
  1665. }
  1666. for (int i = 0; i < save_order.size(); i++) {
  1667. save_unicode_string(f, save_order[i]->get_save_class());
  1668. String path = save_order[i]->get_path();
  1669. path = relative_paths ? local_path.path_to_file(path) : path;
  1670. save_unicode_string(f, path);
  1671. ResourceUID::ID ruid = ResourceSaver::get_resource_id_for_path(save_order[i]->get_path(), false);
  1672. f->store_64(ruid);
  1673. }
  1674. // save internal resource table
  1675. f->store_32(saved_resources.size()); //amount of internal resources
  1676. Vector<uint64_t> ofs_pos;
  1677. Set<String> used_unique_ids;
  1678. for (RES &r : saved_resources) {
  1679. if (r->is_built_in()) {
  1680. if (!r->get_scene_unique_id().is_empty()) {
  1681. if (used_unique_ids.has(r->get_scene_unique_id())) {
  1682. r->set_scene_unique_id("");
  1683. } else {
  1684. used_unique_ids.insert(r->get_scene_unique_id());
  1685. }
  1686. }
  1687. }
  1688. }
  1689. Map<RES, int> resource_map;
  1690. int res_index = 0;
  1691. for (RES &r : saved_resources) {
  1692. if (r->is_built_in()) {
  1693. if (r->get_scene_unique_id().is_empty()) {
  1694. String new_id;
  1695. while (true) {
  1696. new_id = r->get_class() + "_" + Resource::generate_scene_unique_id();
  1697. if (!used_unique_ids.has(new_id)) {
  1698. break;
  1699. }
  1700. }
  1701. r->set_scene_unique_id(new_id);
  1702. used_unique_ids.insert(new_id);
  1703. }
  1704. save_unicode_string(f, "local://" + r->get_scene_unique_id());
  1705. if (takeover_paths) {
  1706. r->set_path(p_path + "::" + r->get_scene_unique_id(), true);
  1707. }
  1708. #ifdef TOOLS_ENABLED
  1709. r->set_edited(false);
  1710. #endif
  1711. } else {
  1712. save_unicode_string(f, r->get_path()); //actual external
  1713. }
  1714. ofs_pos.push_back(f->get_position());
  1715. f->store_64(0); //offset in 64 bits
  1716. resource_map[r] = res_index++;
  1717. }
  1718. Vector<uint64_t> ofs_table;
  1719. //now actually save the resources
  1720. for (const ResourceData &rd : resources) {
  1721. ofs_table.push_back(f->get_position());
  1722. save_unicode_string(f, rd.type);
  1723. f->store_32(rd.properties.size());
  1724. for (const Property &p : rd.properties) {
  1725. f->store_32(p.name_idx);
  1726. write_variant(f, p.value, resource_map, external_resources, string_map, p.pi);
  1727. }
  1728. }
  1729. for (int i = 0; i < ofs_table.size(); i++) {
  1730. f->seek(ofs_pos[i]);
  1731. f->store_64(ofs_table[i]);
  1732. }
  1733. f->seek_end();
  1734. f->store_buffer((const uint8_t *)"RSRC", 4); //magic at end
  1735. if (f->get_error() != OK && f->get_error() != ERR_FILE_EOF) {
  1736. f->close();
  1737. memdelete(f);
  1738. return ERR_CANT_CREATE;
  1739. }
  1740. f->close();
  1741. memdelete(f);
  1742. return OK;
  1743. }
  1744. Error ResourceFormatSaverBinary::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  1745. String local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  1746. ResourceFormatSaverBinaryInstance saver;
  1747. return saver.save(local_path, p_resource, p_flags);
  1748. }
  1749. bool ResourceFormatSaverBinary::recognize(const RES &p_resource) const {
  1750. return true; //all recognized
  1751. }
  1752. void ResourceFormatSaverBinary::get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const {
  1753. String base = p_resource->get_base_extension().to_lower();
  1754. p_extensions->push_back(base);
  1755. if (base != "res") {
  1756. p_extensions->push_back("res");
  1757. }
  1758. }
  1759. ResourceFormatSaverBinary *ResourceFormatSaverBinary::singleton = nullptr;
  1760. ResourceFormatSaverBinary::ResourceFormatSaverBinary() {
  1761. singleton = this;
  1762. }