resource_format_binary.cpp 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879
  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-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 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/image.h"
  32. #include "core/io/file_access_compressed.h"
  33. #include "core/io/marshalls.h"
  34. #include "core/os/dir_access.h"
  35. #include "core/project_settings.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_REAL = 4,
  45. VARIANT_STRING = 5,
  46. VARIANT_VECTOR2 = 10,
  47. VARIANT_RECT2 = 11,
  48. VARIANT_VECTOR3 = 12,
  49. VARIANT_PLANE = 13,
  50. VARIANT_QUAT = 14,
  51. VARIANT_AABB = 15,
  52. VARIANT_MATRIX3 = 16,
  53. VARIANT_TRANSFORM = 17,
  54. VARIANT_MATRIX32 = 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_RAW_ARRAY = 31,
  63. VARIANT_INT_ARRAY = 32,
  64. VARIANT_REAL_ARRAY = 33,
  65. VARIANT_STRING_ARRAY = 34,
  66. VARIANT_VECTOR3_ARRAY = 35,
  67. VARIANT_COLOR_ARRAY = 36,
  68. VARIANT_VECTOR2_ARRAY = 37,
  69. VARIANT_INT64 = 40,
  70. VARIANT_DOUBLE = 41,
  71. #ifndef DISABLE_DEPRECATED
  72. VARIANT_IMAGE = 21, // - no longer variant type
  73. IMAGE_ENCODING_EMPTY = 0,
  74. IMAGE_ENCODING_RAW = 1,
  75. IMAGE_ENCODING_LOSSLESS = 2,
  76. IMAGE_ENCODING_LOSSY = 3,
  77. #endif
  78. OBJECT_EMPTY = 0,
  79. OBJECT_EXTERNAL_RESOURCE = 1,
  80. OBJECT_INTERNAL_RESOURCE = 2,
  81. OBJECT_EXTERNAL_RESOURCE_INDEX = 3,
  82. //version 2: added 64 bits support for float and int
  83. //version 3: changed nodepath encoding
  84. FORMAT_VERSION = 3,
  85. FORMAT_VERSION_CAN_RENAME_DEPS = 1,
  86. FORMAT_VERSION_NO_NODEPATH_PROPERTY = 3,
  87. };
  88. void ResourceInteractiveLoaderBinary::_advance_padding(uint32_t p_len) {
  89. uint32_t extra = 4 - (p_len % 4);
  90. if (extra < 4) {
  91. for (uint32_t i = 0; i < extra; i++) {
  92. f->get_8(); //pad to 32
  93. }
  94. }
  95. }
  96. StringName ResourceInteractiveLoaderBinary::_get_string() {
  97. uint32_t id = f->get_32();
  98. if (id & 0x80000000) {
  99. uint32_t len = id & 0x7FFFFFFF;
  100. if ((int)len > str_buf.size()) {
  101. str_buf.resize(len);
  102. }
  103. if (len == 0) {
  104. return StringName();
  105. }
  106. f->get_buffer((uint8_t *)&str_buf[0], len);
  107. String s;
  108. s.parse_utf8(&str_buf[0]);
  109. return s;
  110. }
  111. return string_map[id];
  112. }
  113. Error ResourceInteractiveLoaderBinary::parse_variant(Variant &r_v) {
  114. uint32_t type = f->get_32();
  115. print_bl("find property of type: " + itos(type));
  116. switch (type) {
  117. case VARIANT_NIL: {
  118. r_v = Variant();
  119. } break;
  120. case VARIANT_BOOL: {
  121. r_v = bool(f->get_32());
  122. } break;
  123. case VARIANT_INT: {
  124. r_v = int(f->get_32());
  125. } break;
  126. case VARIANT_INT64: {
  127. r_v = int64_t(f->get_64());
  128. } break;
  129. case VARIANT_REAL: {
  130. r_v = f->get_real();
  131. } break;
  132. case VARIANT_DOUBLE: {
  133. r_v = f->get_double();
  134. } break;
  135. case VARIANT_STRING: {
  136. r_v = get_unicode_string();
  137. } break;
  138. case VARIANT_VECTOR2: {
  139. Vector2 v;
  140. v.x = f->get_real();
  141. v.y = f->get_real();
  142. r_v = v;
  143. } break;
  144. case VARIANT_RECT2: {
  145. Rect2 v;
  146. v.position.x = f->get_real();
  147. v.position.y = f->get_real();
  148. v.size.x = f->get_real();
  149. v.size.y = f->get_real();
  150. r_v = v;
  151. } break;
  152. case VARIANT_VECTOR3: {
  153. Vector3 v;
  154. v.x = f->get_real();
  155. v.y = f->get_real();
  156. v.z = f->get_real();
  157. r_v = v;
  158. } break;
  159. case VARIANT_PLANE: {
  160. Plane v;
  161. v.normal.x = f->get_real();
  162. v.normal.y = f->get_real();
  163. v.normal.z = f->get_real();
  164. v.d = f->get_real();
  165. r_v = v;
  166. } break;
  167. case VARIANT_QUAT: {
  168. Quat v;
  169. v.x = f->get_real();
  170. v.y = f->get_real();
  171. v.z = f->get_real();
  172. v.w = f->get_real();
  173. r_v = v;
  174. } break;
  175. case VARIANT_AABB: {
  176. AABB v;
  177. v.position.x = f->get_real();
  178. v.position.y = f->get_real();
  179. v.position.z = f->get_real();
  180. v.size.x = f->get_real();
  181. v.size.y = f->get_real();
  182. v.size.z = f->get_real();
  183. r_v = v;
  184. } break;
  185. case VARIANT_MATRIX32: {
  186. Transform2D v;
  187. v.elements[0].x = f->get_real();
  188. v.elements[0].y = f->get_real();
  189. v.elements[1].x = f->get_real();
  190. v.elements[1].y = f->get_real();
  191. v.elements[2].x = f->get_real();
  192. v.elements[2].y = f->get_real();
  193. r_v = v;
  194. } break;
  195. case VARIANT_MATRIX3: {
  196. Basis v;
  197. v.elements[0].x = f->get_real();
  198. v.elements[0].y = f->get_real();
  199. v.elements[0].z = f->get_real();
  200. v.elements[1].x = f->get_real();
  201. v.elements[1].y = f->get_real();
  202. v.elements[1].z = f->get_real();
  203. v.elements[2].x = f->get_real();
  204. v.elements[2].y = f->get_real();
  205. v.elements[2].z = f->get_real();
  206. r_v = v;
  207. } break;
  208. case VARIANT_TRANSFORM: {
  209. Transform v;
  210. v.basis.elements[0].x = f->get_real();
  211. v.basis.elements[0].y = f->get_real();
  212. v.basis.elements[0].z = f->get_real();
  213. v.basis.elements[1].x = f->get_real();
  214. v.basis.elements[1].y = f->get_real();
  215. v.basis.elements[1].z = f->get_real();
  216. v.basis.elements[2].x = f->get_real();
  217. v.basis.elements[2].y = f->get_real();
  218. v.basis.elements[2].z = f->get_real();
  219. v.origin.x = f->get_real();
  220. v.origin.y = f->get_real();
  221. v.origin.z = f->get_real();
  222. r_v = v;
  223. } break;
  224. case VARIANT_COLOR: {
  225. Color v;
  226. v.r = f->get_real();
  227. v.g = f->get_real();
  228. v.b = f->get_real();
  229. v.a = f->get_real();
  230. r_v = v;
  231. } break;
  232. case VARIANT_NODE_PATH: {
  233. Vector<StringName> names;
  234. Vector<StringName> subnames;
  235. bool absolute;
  236. int name_count = f->get_16();
  237. uint32_t subname_count = f->get_16();
  238. absolute = subname_count & 0x8000;
  239. subname_count &= 0x7FFF;
  240. if (ver_format < FORMAT_VERSION_NO_NODEPATH_PROPERTY) {
  241. subname_count += 1; // has a property field, so we should count it as well
  242. }
  243. for (int i = 0; i < name_count; i++) {
  244. names.push_back(_get_string());
  245. }
  246. for (uint32_t i = 0; i < subname_count; i++) {
  247. subnames.push_back(_get_string());
  248. }
  249. NodePath np = NodePath(names, subnames, absolute);
  250. r_v = np;
  251. } break;
  252. case VARIANT_RID: {
  253. r_v = f->get_32();
  254. } break;
  255. case VARIANT_OBJECT: {
  256. uint32_t objtype = f->get_32();
  257. switch (objtype) {
  258. case OBJECT_EMPTY: {
  259. //do none
  260. } break;
  261. case OBJECT_INTERNAL_RESOURCE: {
  262. uint32_t index = f->get_32();
  263. String path = res_path + "::" + itos(index);
  264. RES res = ResourceLoader::load(path);
  265. if (res.is_null()) {
  266. WARN_PRINT(String("Couldn't load resource: " + path).utf8().get_data());
  267. }
  268. r_v = res;
  269. } break;
  270. case OBJECT_EXTERNAL_RESOURCE: {
  271. //old file format, still around for compatibility
  272. String exttype = get_unicode_string();
  273. String path = get_unicode_string();
  274. if (path.find("://") == -1 && path.is_rel_path()) {
  275. // path is relative to file being loaded, so convert to a resource path
  276. path = ProjectSettings::get_singleton()->localize_path(res_path.get_base_dir().plus_file(path));
  277. }
  278. if (remaps.find(path)) {
  279. path = remaps[path];
  280. }
  281. RES res = ResourceLoader::load(path, exttype);
  282. if (res.is_null()) {
  283. WARN_PRINT(String("Couldn't load resource: " + path).utf8().get_data());
  284. }
  285. r_v = res;
  286. } break;
  287. case OBJECT_EXTERNAL_RESOURCE_INDEX: {
  288. //new file format, just refers to an index in the external list
  289. int erindex = f->get_32();
  290. if (erindex < 0 || erindex >= external_resources.size()) {
  291. WARN_PRINT("Broken external resource! (index out of size)");
  292. r_v = Variant();
  293. } else {
  294. String exttype = external_resources[erindex].type;
  295. String path = external_resources[erindex].path;
  296. if (path.find("://") == -1 && path.is_rel_path()) {
  297. // path is relative to file being loaded, so convert to a resource path
  298. path = ProjectSettings::get_singleton()->localize_path(res_path.get_base_dir().plus_file(path));
  299. }
  300. RES res = ResourceLoader::load(path, exttype);
  301. if (res.is_null()) {
  302. WARN_PRINT(String("Couldn't load resource: " + path).utf8().get_data());
  303. }
  304. r_v = res;
  305. }
  306. } break;
  307. default: {
  308. ERR_FAIL_V(ERR_FILE_CORRUPT);
  309. } break;
  310. }
  311. } break;
  312. case VARIANT_DICTIONARY: {
  313. uint32_t len = f->get_32();
  314. Dictionary d; //last bit means shared
  315. len &= 0x7FFFFFFF;
  316. for (uint32_t i = 0; i < len; i++) {
  317. Variant key;
  318. Error err = parse_variant(key);
  319. ERR_FAIL_COND_V_MSG(err, ERR_FILE_CORRUPT, "Error when trying to parse Variant.");
  320. Variant value;
  321. err = parse_variant(value);
  322. ERR_FAIL_COND_V_MSG(err, ERR_FILE_CORRUPT, "Error when trying to parse Variant.");
  323. d[key] = value;
  324. }
  325. r_v = d;
  326. } break;
  327. case VARIANT_ARRAY: {
  328. uint32_t len = f->get_32();
  329. Array a; //last bit means shared
  330. len &= 0x7FFFFFFF;
  331. a.resize(len);
  332. for (uint32_t i = 0; i < len; i++) {
  333. Variant val;
  334. Error err = parse_variant(val);
  335. ERR_FAIL_COND_V_MSG(err, ERR_FILE_CORRUPT, "Error when trying to parse Variant.");
  336. a[i] = val;
  337. }
  338. r_v = a;
  339. } break;
  340. case VARIANT_RAW_ARRAY: {
  341. uint32_t len = f->get_32();
  342. PoolVector<uint8_t> array;
  343. array.resize(len);
  344. PoolVector<uint8_t>::Write w = array.write();
  345. f->get_buffer(w.ptr(), len);
  346. _advance_padding(len);
  347. w.release();
  348. r_v = array;
  349. } break;
  350. case VARIANT_INT_ARRAY: {
  351. uint32_t len = f->get_32();
  352. PoolVector<int> array;
  353. array.resize(len);
  354. PoolVector<int>::Write w = array.write();
  355. f->get_buffer((uint8_t *)w.ptr(), len * 4);
  356. #ifdef BIG_ENDIAN_ENABLED
  357. {
  358. uint32_t *ptr = (uint32_t *)w.ptr();
  359. for (int i = 0; i < len; i++) {
  360. ptr[i] = BSWAP32(ptr[i]);
  361. }
  362. }
  363. #endif
  364. w.release();
  365. r_v = array;
  366. } break;
  367. case VARIANT_REAL_ARRAY: {
  368. uint32_t len = f->get_32();
  369. PoolVector<real_t> array;
  370. array.resize(len);
  371. PoolVector<real_t>::Write w = array.write();
  372. f->get_buffer((uint8_t *)w.ptr(), len * sizeof(real_t));
  373. #ifdef BIG_ENDIAN_ENABLED
  374. {
  375. uint32_t *ptr = (uint32_t *)w.ptr();
  376. for (int i = 0; i < len; i++) {
  377. ptr[i] = BSWAP32(ptr[i]);
  378. }
  379. }
  380. #endif
  381. w.release();
  382. r_v = array;
  383. } break;
  384. case VARIANT_STRING_ARRAY: {
  385. uint32_t len = f->get_32();
  386. PoolVector<String> array;
  387. array.resize(len);
  388. PoolVector<String>::Write w = array.write();
  389. for (uint32_t i = 0; i < len; i++) {
  390. w[i] = get_unicode_string();
  391. }
  392. w.release();
  393. r_v = array;
  394. } break;
  395. case VARIANT_VECTOR2_ARRAY: {
  396. uint32_t len = f->get_32();
  397. PoolVector<Vector2> array;
  398. array.resize(len);
  399. PoolVector<Vector2>::Write w = array.write();
  400. if (sizeof(Vector2) == 8) {
  401. f->get_buffer((uint8_t *)w.ptr(), len * sizeof(real_t) * 2);
  402. #ifdef BIG_ENDIAN_ENABLED
  403. {
  404. uint32_t *ptr = (uint32_t *)w.ptr();
  405. for (int i = 0; i < len * 2; i++) {
  406. ptr[i] = BSWAP32(ptr[i]);
  407. }
  408. }
  409. #endif
  410. } else {
  411. ERR_FAIL_V_MSG(ERR_UNAVAILABLE, "Vector2 size is NOT 8!");
  412. }
  413. w.release();
  414. r_v = array;
  415. } break;
  416. case VARIANT_VECTOR3_ARRAY: {
  417. uint32_t len = f->get_32();
  418. PoolVector<Vector3> array;
  419. array.resize(len);
  420. PoolVector<Vector3>::Write w = array.write();
  421. if (sizeof(Vector3) == 12) {
  422. f->get_buffer((uint8_t *)w.ptr(), len * sizeof(real_t) * 3);
  423. #ifdef BIG_ENDIAN_ENABLED
  424. {
  425. uint32_t *ptr = (uint32_t *)w.ptr();
  426. for (int i = 0; i < len * 3; i++) {
  427. ptr[i] = BSWAP32(ptr[i]);
  428. }
  429. }
  430. #endif
  431. } else {
  432. ERR_FAIL_V_MSG(ERR_UNAVAILABLE, "Vector3 size is NOT 12!");
  433. }
  434. w.release();
  435. r_v = array;
  436. } break;
  437. case VARIANT_COLOR_ARRAY: {
  438. uint32_t len = f->get_32();
  439. PoolVector<Color> array;
  440. array.resize(len);
  441. PoolVector<Color>::Write w = array.write();
  442. if (sizeof(Color) == 16) {
  443. f->get_buffer((uint8_t *)w.ptr(), len * sizeof(real_t) * 4);
  444. #ifdef BIG_ENDIAN_ENABLED
  445. {
  446. uint32_t *ptr = (uint32_t *)w.ptr();
  447. for (int i = 0; i < len * 4; i++) {
  448. ptr[i] = BSWAP32(ptr[i]);
  449. }
  450. }
  451. #endif
  452. } else {
  453. ERR_FAIL_V_MSG(ERR_UNAVAILABLE, "Color size is NOT 16!");
  454. }
  455. w.release();
  456. r_v = array;
  457. } break;
  458. #ifndef DISABLE_DEPRECATED
  459. case VARIANT_IMAGE: {
  460. uint32_t encoding = f->get_32();
  461. if (encoding == IMAGE_ENCODING_EMPTY) {
  462. r_v = Ref<Image>();
  463. break;
  464. } else if (encoding == IMAGE_ENCODING_RAW) {
  465. uint32_t width = f->get_32();
  466. uint32_t height = f->get_32();
  467. uint32_t mipmaps = f->get_32();
  468. uint32_t format = f->get_32();
  469. const uint32_t format_version_shift = 24;
  470. const uint32_t format_version_mask = format_version_shift - 1;
  471. uint32_t format_version = format >> format_version_shift;
  472. const uint32_t current_version = 0;
  473. if (format_version > current_version) {
  474. ERR_PRINT("Format version for encoded binary image is too new.");
  475. return ERR_PARSE_ERROR;
  476. }
  477. Image::Format fmt = Image::Format(format & format_version_mask); //if format changes, we can add a compatibility bit on top
  478. uint32_t datalen = f->get_32();
  479. PoolVector<uint8_t> imgdata;
  480. imgdata.resize(datalen);
  481. PoolVector<uint8_t>::Write w = imgdata.write();
  482. f->get_buffer(w.ptr(), datalen);
  483. _advance_padding(datalen);
  484. w.release();
  485. Ref<Image> image;
  486. image.instance();
  487. image->create(width, height, mipmaps, fmt, imgdata);
  488. r_v = image;
  489. } else {
  490. //compressed
  491. PoolVector<uint8_t> data;
  492. data.resize(f->get_32());
  493. PoolVector<uint8_t>::Write w = data.write();
  494. f->get_buffer(w.ptr(), data.size());
  495. w.release();
  496. Ref<Image> image;
  497. if (encoding == IMAGE_ENCODING_LOSSY && Image::lossy_unpacker) {
  498. image = Image::lossy_unpacker(data);
  499. } else if (encoding == IMAGE_ENCODING_LOSSLESS && Image::lossless_unpacker) {
  500. image = Image::lossless_unpacker(data);
  501. }
  502. _advance_padding(data.size());
  503. r_v = image;
  504. }
  505. } break;
  506. #endif
  507. default: {
  508. ERR_FAIL_V(ERR_FILE_CORRUPT);
  509. } break;
  510. }
  511. return OK; //never reach anyway
  512. }
  513. void ResourceInteractiveLoaderBinary::set_local_path(const String &p_local_path) {
  514. res_path = p_local_path;
  515. }
  516. Ref<Resource> ResourceInteractiveLoaderBinary::get_resource() {
  517. return resource;
  518. }
  519. Error ResourceInteractiveLoaderBinary::poll() {
  520. if (error != OK) {
  521. return error;
  522. }
  523. int s = stage;
  524. if (s < external_resources.size()) {
  525. String path = external_resources[s].path;
  526. if (remaps.has(path)) {
  527. path = remaps[path];
  528. }
  529. RES res = ResourceLoader::load(path, external_resources[s].type);
  530. if (res.is_null()) {
  531. if (!ResourceLoader::get_abort_on_missing_resources()) {
  532. ResourceLoader::notify_dependency_error(local_path, path, external_resources[s].type);
  533. } else {
  534. error = ERR_FILE_MISSING_DEPENDENCIES;
  535. ERR_FAIL_V_MSG(error, "Can't load dependency: " + path + ".");
  536. }
  537. } else {
  538. resource_cache.push_back(res);
  539. }
  540. stage++;
  541. return error;
  542. }
  543. s -= external_resources.size();
  544. if (s >= internal_resources.size()) {
  545. error = ERR_BUG;
  546. ERR_FAIL_COND_V(s >= internal_resources.size(), error);
  547. }
  548. bool main = s == (internal_resources.size() - 1);
  549. //maybe it is loaded already
  550. String path;
  551. int subindex = 0;
  552. if (!main) {
  553. path = internal_resources[s].path;
  554. if (path.begins_with("local://")) {
  555. path = path.replace_first("local://", "");
  556. subindex = path.to_int();
  557. path = res_path + "::" + path;
  558. }
  559. if (ResourceCache::has(path)) {
  560. //already loaded, don't do anything
  561. stage++;
  562. error = OK;
  563. return error;
  564. }
  565. } else {
  566. if (!ResourceCache::has(res_path)) {
  567. path = res_path;
  568. }
  569. }
  570. uint64_t offset = internal_resources[s].offset;
  571. f->seek(offset);
  572. String t = get_unicode_string();
  573. Object *obj = ClassDB::instance(t);
  574. if (!obj) {
  575. error = ERR_FILE_CORRUPT;
  576. ERR_FAIL_V_MSG(ERR_FILE_CORRUPT, local_path + ":Resource of unrecognized type in file: " + t + ".");
  577. }
  578. Resource *r = Object::cast_to<Resource>(obj);
  579. if (!r) {
  580. String obj_class = obj->get_class();
  581. error = ERR_FILE_CORRUPT;
  582. memdelete(obj); //bye
  583. ERR_FAIL_V_MSG(ERR_FILE_CORRUPT, local_path + ":Resource type in resource field not a resource, type is: " + obj_class + ".");
  584. }
  585. RES res = RES(r);
  586. r->set_path(path);
  587. r->set_subindex(subindex);
  588. int pc = f->get_32();
  589. //set properties
  590. for (int i = 0; i < pc; i++) {
  591. StringName name = _get_string();
  592. if (name == StringName()) {
  593. error = ERR_FILE_CORRUPT;
  594. ERR_FAIL_V(ERR_FILE_CORRUPT);
  595. }
  596. Variant value;
  597. error = parse_variant(value);
  598. if (error) {
  599. return error;
  600. }
  601. res->set(name, value);
  602. }
  603. #ifdef TOOLS_ENABLED
  604. res->set_edited(false);
  605. #endif
  606. stage++;
  607. resource_cache.push_back(res);
  608. if (main) {
  609. f->close();
  610. resource = res;
  611. resource->set_as_translation_remapped(translation_remapped);
  612. error = ERR_FILE_EOF;
  613. } else {
  614. error = OK;
  615. }
  616. return OK;
  617. }
  618. int ResourceInteractiveLoaderBinary::get_stage() const {
  619. return stage;
  620. }
  621. int ResourceInteractiveLoaderBinary::get_stage_count() const {
  622. return external_resources.size() + internal_resources.size();
  623. }
  624. void ResourceInteractiveLoaderBinary::set_translation_remapped(bool p_remapped) {
  625. translation_remapped = p_remapped;
  626. }
  627. static void save_ustring(FileAccess *f, const String &p_string) {
  628. CharString utf8 = p_string.utf8();
  629. f->store_32(utf8.length() + 1);
  630. f->store_buffer((const uint8_t *)utf8.get_data(), utf8.length() + 1);
  631. }
  632. static String get_ustring(FileAccess *f) {
  633. int len = f->get_32();
  634. Vector<char> str_buf;
  635. str_buf.resize(len);
  636. f->get_buffer((uint8_t *)&str_buf[0], len);
  637. String s;
  638. s.parse_utf8(&str_buf[0]);
  639. return s;
  640. }
  641. String ResourceInteractiveLoaderBinary::get_unicode_string() {
  642. int len = f->get_32();
  643. if (len > str_buf.size()) {
  644. str_buf.resize(len);
  645. }
  646. if (len == 0) {
  647. return String();
  648. }
  649. f->get_buffer((uint8_t *)&str_buf[0], len);
  650. String s;
  651. s.parse_utf8(&str_buf[0]);
  652. return s;
  653. }
  654. void ResourceInteractiveLoaderBinary::get_dependencies(FileAccess *p_f, List<String> *p_dependencies, bool p_add_types) {
  655. open(p_f);
  656. if (error) {
  657. return;
  658. }
  659. for (int i = 0; i < external_resources.size(); i++) {
  660. String dep = external_resources[i].path;
  661. if (p_add_types && external_resources[i].type != String()) {
  662. dep += "::" + external_resources[i].type;
  663. }
  664. p_dependencies->push_back(dep);
  665. }
  666. }
  667. void ResourceInteractiveLoaderBinary::open(FileAccess *p_f) {
  668. error = OK;
  669. f = p_f;
  670. uint8_t header[4];
  671. f->get_buffer(header, 4);
  672. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  673. // Compressed.
  674. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  675. error = fac->open_after_magic(f);
  676. if (error != OK) {
  677. memdelete(fac);
  678. f->close();
  679. ERR_FAIL_MSG("Failed to open binary resource file: " + local_path + ".");
  680. }
  681. f = fac;
  682. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  683. // Not normal.
  684. error = ERR_FILE_UNRECOGNIZED;
  685. f->close();
  686. ERR_FAIL_MSG("Unrecognized binary resource file: " + local_path + ".");
  687. }
  688. bool big_endian = f->get_32();
  689. bool use_real64 = f->get_32();
  690. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  691. uint32_t ver_major = f->get_32();
  692. uint32_t ver_minor = f->get_32();
  693. ver_format = f->get_32();
  694. print_bl("big endian: " + itos(big_endian));
  695. #ifdef BIG_ENDIAN_ENABLED
  696. print_bl("endian swap: " + itos(!big_endian));
  697. #else
  698. print_bl("endian swap: " + itos(big_endian));
  699. #endif
  700. print_bl("real64: " + itos(use_real64));
  701. print_bl("major: " + itos(ver_major));
  702. print_bl("minor: " + itos(ver_minor));
  703. print_bl("format: " + itos(ver_format));
  704. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  705. f->close();
  706. 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).",
  707. local_path, ver_format, ver_major, ver_minor, VERSION_BRANCH));
  708. }
  709. type = get_unicode_string();
  710. print_bl("type: " + type);
  711. importmd_ofs = f->get_64();
  712. for (int i = 0; i < 14; i++) {
  713. f->get_32(); //skip a few reserved fields
  714. }
  715. uint32_t string_table_size = f->get_32();
  716. string_map.resize(string_table_size);
  717. for (uint32_t i = 0; i < string_table_size; i++) {
  718. StringName s = get_unicode_string();
  719. string_map.write[i] = s;
  720. }
  721. print_bl("strings: " + itos(string_table_size));
  722. uint32_t ext_resources_size = f->get_32();
  723. for (uint32_t i = 0; i < ext_resources_size; i++) {
  724. ExtResource er;
  725. er.type = get_unicode_string();
  726. er.path = get_unicode_string();
  727. external_resources.push_back(er);
  728. }
  729. print_bl("ext resources: " + itos(ext_resources_size));
  730. uint32_t int_resources_size = f->get_32();
  731. for (uint32_t i = 0; i < int_resources_size; i++) {
  732. IntResource ir;
  733. ir.path = get_unicode_string();
  734. ir.offset = f->get_64();
  735. internal_resources.push_back(ir);
  736. }
  737. print_bl("int resources: " + itos(int_resources_size));
  738. if (f->eof_reached()) {
  739. error = ERR_FILE_CORRUPT;
  740. f->close();
  741. ERR_FAIL_MSG("Premature end of file (EOF): " + local_path + ".");
  742. }
  743. }
  744. String ResourceInteractiveLoaderBinary::recognize(FileAccess *p_f) {
  745. error = OK;
  746. f = p_f;
  747. uint8_t header[4];
  748. f->get_buffer(header, 4);
  749. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  750. // Compressed.
  751. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  752. error = fac->open_after_magic(f);
  753. if (error != OK) {
  754. memdelete(fac);
  755. f->close();
  756. return "";
  757. }
  758. f = fac;
  759. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  760. // Not normal.
  761. error = ERR_FILE_UNRECOGNIZED;
  762. f->close();
  763. return "";
  764. }
  765. bool big_endian = f->get_32();
  766. f->get_32(); // use_real64
  767. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  768. uint32_t ver_major = f->get_32();
  769. f->get_32(); // ver_minor
  770. uint32_t ver_format = f->get_32();
  771. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  772. f->close();
  773. return "";
  774. }
  775. String type = get_unicode_string();
  776. return type;
  777. }
  778. ResourceInteractiveLoaderBinary::ResourceInteractiveLoaderBinary() :
  779. translation_remapped(false),
  780. f(nullptr),
  781. error(OK),
  782. stage(0) {
  783. }
  784. ResourceInteractiveLoaderBinary::~ResourceInteractiveLoaderBinary() {
  785. if (f) {
  786. memdelete(f);
  787. }
  788. }
  789. Ref<ResourceInteractiveLoader> ResourceFormatLoaderBinary::load_interactive(const String &p_path, const String &p_original_path, Error *r_error) {
  790. if (r_error) {
  791. *r_error = ERR_FILE_CANT_OPEN;
  792. }
  793. Error err;
  794. FileAccess *f = FileAccess::open(p_path, FileAccess::READ, &err);
  795. ERR_FAIL_COND_V_MSG(err != OK, Ref<ResourceInteractiveLoader>(), "Cannot open file '" + p_path + "'.");
  796. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  797. String path = p_original_path != "" ? p_original_path : p_path;
  798. ria->local_path = ProjectSettings::get_singleton()->localize_path(path);
  799. ria->res_path = ria->local_path;
  800. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  801. ria->open(f);
  802. return ria;
  803. }
  804. void ResourceFormatLoaderBinary::get_recognized_extensions_for_type(const String &p_type, List<String> *p_extensions) const {
  805. if (p_type == "") {
  806. get_recognized_extensions(p_extensions);
  807. return;
  808. }
  809. List<String> extensions;
  810. ClassDB::get_extensions_for_type(p_type, &extensions);
  811. extensions.sort();
  812. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  813. String ext = E->get().to_lower();
  814. p_extensions->push_back(ext);
  815. }
  816. }
  817. void ResourceFormatLoaderBinary::get_recognized_extensions(List<String> *p_extensions) const {
  818. List<String> extensions;
  819. ClassDB::get_resource_base_extensions(&extensions);
  820. extensions.sort();
  821. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  822. String ext = E->get().to_lower();
  823. p_extensions->push_back(ext);
  824. }
  825. }
  826. bool ResourceFormatLoaderBinary::handles_type(const String &p_type) const {
  827. return true; //handles all
  828. }
  829. void ResourceFormatLoaderBinary::get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types) {
  830. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  831. ERR_FAIL_COND_MSG(!f, "Cannot open file '" + p_path + "'.");
  832. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  833. ria->local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  834. ria->res_path = ria->local_path;
  835. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  836. ria->get_dependencies(f, p_dependencies, p_add_types);
  837. }
  838. Error ResourceFormatLoaderBinary::rename_dependencies(const String &p_path, const Map<String, String> &p_map) {
  839. //Error error=OK;
  840. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  841. ERR_FAIL_COND_V_MSG(!f, ERR_CANT_OPEN, "Cannot open file '" + p_path + "'.");
  842. FileAccess *fw = nullptr; //=FileAccess::open(p_path+".depren");
  843. String local_path = p_path.get_base_dir();
  844. uint8_t header[4];
  845. f->get_buffer(header, 4);
  846. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  847. // Compressed.
  848. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  849. Error err = fac->open_after_magic(f);
  850. if (err != OK) {
  851. memdelete(fac);
  852. memdelete(f);
  853. ERR_FAIL_V_MSG(err, "Cannot open file '" + p_path + "'.");
  854. }
  855. f = fac;
  856. FileAccessCompressed *facw = memnew(FileAccessCompressed);
  857. facw->configure("RSCC");
  858. err = facw->_open(p_path + ".depren", FileAccess::WRITE);
  859. if (err) {
  860. memdelete(fac);
  861. memdelete(facw);
  862. ERR_FAIL_COND_V_MSG(err, ERR_FILE_CORRUPT, "Cannot create file '" + p_path + ".depren'.");
  863. }
  864. fw = facw;
  865. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  866. // Not normal.
  867. memdelete(f);
  868. ERR_FAIL_V_MSG(ERR_FILE_UNRECOGNIZED, "Unrecognized binary resource file '" + local_path + "'.");
  869. } else {
  870. fw = FileAccess::open(p_path + ".depren", FileAccess::WRITE);
  871. if (!fw) {
  872. memdelete(f);
  873. }
  874. ERR_FAIL_COND_V_MSG(!fw, ERR_CANT_CREATE, "Cannot create file '" + p_path + ".depren'.");
  875. uint8_t magic[4] = { 'R', 'S', 'R', 'C' };
  876. fw->store_buffer(magic, 4);
  877. }
  878. bool big_endian = f->get_32();
  879. bool use_real64 = f->get_32();
  880. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  881. #ifdef BIG_ENDIAN_ENABLED
  882. fw->store_32(!big_endian);
  883. #else
  884. fw->store_32(big_endian);
  885. #endif
  886. fw->set_endian_swap(big_endian != 0);
  887. fw->store_32(use_real64); //use real64
  888. uint32_t ver_major = f->get_32();
  889. uint32_t ver_minor = f->get_32();
  890. uint32_t ver_format = f->get_32();
  891. if (ver_format < FORMAT_VERSION_CAN_RENAME_DEPS) {
  892. memdelete(f);
  893. memdelete(fw);
  894. DirAccess *da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  895. da->remove(p_path + ".depren");
  896. memdelete(da);
  897. //use the old approach
  898. WARN_PRINTS("This file is old, so it can't refactor dependencies, opening and resaving '" + p_path + "'.");
  899. Error err;
  900. f = FileAccess::open(p_path, FileAccess::READ, &err);
  901. ERR_FAIL_COND_V_MSG(err != OK, ERR_FILE_CANT_OPEN, "Cannot open file '" + p_path + "'.");
  902. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  903. ria->local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  904. ria->res_path = ria->local_path;
  905. ria->remaps = p_map;
  906. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  907. ria->open(f);
  908. err = ria->poll();
  909. while (err == OK) {
  910. err = ria->poll();
  911. }
  912. ERR_FAIL_COND_V(err != ERR_FILE_EOF, ERR_FILE_CORRUPT);
  913. RES res = ria->get_resource();
  914. ERR_FAIL_COND_V(!res.is_valid(), ERR_FILE_CORRUPT);
  915. return ResourceFormatSaverBinary::singleton->save(p_path, res);
  916. }
  917. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  918. memdelete(f);
  919. memdelete(fw);
  920. ERR_FAIL_V_MSG(ERR_FILE_UNRECOGNIZED,
  921. 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).",
  922. local_path, ver_format, ver_major, ver_minor, VERSION_BRANCH));
  923. }
  924. // Since we're not actually converting the file contents, leave the version
  925. // numbers in the file untouched.
  926. fw->store_32(ver_major);
  927. fw->store_32(ver_minor);
  928. fw->store_32(ver_format);
  929. save_ustring(fw, get_ustring(f)); //type
  930. uint64_t md_ofs = f->get_position();
  931. uint64_t importmd_ofs = f->get_64();
  932. fw->store_64(0); //metadata offset
  933. for (int i = 0; i < 14; i++) {
  934. fw->store_32(0);
  935. f->get_32();
  936. }
  937. //string table
  938. uint32_t string_table_size = f->get_32();
  939. fw->store_32(string_table_size);
  940. for (uint32_t i = 0; i < string_table_size; i++) {
  941. String s = get_ustring(f);
  942. save_ustring(fw, s);
  943. }
  944. //external resources
  945. uint32_t ext_resources_size = f->get_32();
  946. fw->store_32(ext_resources_size);
  947. for (uint32_t i = 0; i < ext_resources_size; i++) {
  948. String type = get_ustring(f);
  949. String path = get_ustring(f);
  950. bool relative = false;
  951. if (!path.begins_with("res://")) {
  952. path = local_path.plus_file(path).simplify_path();
  953. relative = true;
  954. }
  955. if (p_map.has(path)) {
  956. String np = p_map[path];
  957. path = np;
  958. }
  959. if (relative) {
  960. //restore relative
  961. path = local_path.path_to_file(path);
  962. }
  963. save_ustring(fw, type);
  964. save_ustring(fw, path);
  965. }
  966. int64_t size_diff = (int64_t)fw->get_position() - (int64_t)f->get_position();
  967. //internal resources
  968. uint32_t int_resources_size = f->get_32();
  969. fw->store_32(int_resources_size);
  970. for (uint32_t i = 0; i < int_resources_size; i++) {
  971. String path = get_ustring(f);
  972. uint64_t offset = f->get_64();
  973. save_ustring(fw, path);
  974. fw->store_64(offset + size_diff);
  975. }
  976. //rest of file
  977. uint8_t b = f->get_8();
  978. while (!f->eof_reached()) {
  979. fw->store_8(b);
  980. b = f->get_8();
  981. }
  982. bool all_ok = fw->get_error() == OK;
  983. fw->seek(md_ofs);
  984. fw->store_64(importmd_ofs + size_diff);
  985. memdelete(f);
  986. memdelete(fw);
  987. if (!all_ok) {
  988. return ERR_CANT_CREATE;
  989. }
  990. DirAccess *da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  991. da->remove(p_path);
  992. da->rename(p_path + ".depren", p_path);
  993. memdelete(da);
  994. return OK;
  995. }
  996. String ResourceFormatLoaderBinary::get_resource_type(const String &p_path) const {
  997. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  998. if (!f) {
  999. return ""; //could not rwead
  1000. }
  1001. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  1002. ria->local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  1003. ria->res_path = ria->local_path;
  1004. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  1005. String r = ria->recognize(f);
  1006. return r;
  1007. }
  1008. ///////////////////////////////////////////////////////////
  1009. ///////////////////////////////////////////////////////////
  1010. ///////////////////////////////////////////////////////////
  1011. void ResourceFormatSaverBinaryInstance::_pad_buffer(FileAccess *f, int p_bytes) {
  1012. int extra = 4 - (p_bytes % 4);
  1013. if (extra < 4) {
  1014. for (int i = 0; i < extra; i++) {
  1015. f->store_8(0); //pad to 32
  1016. }
  1017. }
  1018. }
  1019. void ResourceFormatSaverBinaryInstance::_write_variant(const Variant &p_property, const PropertyInfo &p_hint) {
  1020. write_variant(f, p_property, resource_set, external_resources, string_map, p_hint);
  1021. }
  1022. void ResourceFormatSaverBinaryInstance::write_variant(FileAccess *f, const Variant &p_property, Set<RES> &resource_set, Map<RES, int> &external_resources, Map<StringName, int> &string_map, const PropertyInfo &p_hint) {
  1023. switch (p_property.get_type()) {
  1024. case Variant::NIL: {
  1025. f->store_32(VARIANT_NIL);
  1026. // don't store anything
  1027. } break;
  1028. case Variant::BOOL: {
  1029. f->store_32(VARIANT_BOOL);
  1030. bool val = p_property;
  1031. f->store_32(val);
  1032. } break;
  1033. case Variant::INT: {
  1034. int64_t val = p_property;
  1035. if (val > 0x7FFFFFFF || val < -(int64_t)0x80000000) {
  1036. f->store_32(VARIANT_INT64);
  1037. f->store_64(val);
  1038. } else {
  1039. f->store_32(VARIANT_INT);
  1040. f->store_32(int32_t(p_property));
  1041. }
  1042. } break;
  1043. case Variant::REAL: {
  1044. double d = p_property;
  1045. float fl = d;
  1046. if (double(fl) != d) {
  1047. f->store_32(VARIANT_DOUBLE);
  1048. f->store_double(d);
  1049. } else {
  1050. f->store_32(VARIANT_REAL);
  1051. f->store_real(fl);
  1052. }
  1053. } break;
  1054. case Variant::STRING: {
  1055. f->store_32(VARIANT_STRING);
  1056. String val = p_property;
  1057. save_unicode_string(f, val);
  1058. } break;
  1059. case Variant::VECTOR2: {
  1060. f->store_32(VARIANT_VECTOR2);
  1061. Vector2 val = p_property;
  1062. f->store_real(val.x);
  1063. f->store_real(val.y);
  1064. } break;
  1065. case Variant::RECT2: {
  1066. f->store_32(VARIANT_RECT2);
  1067. Rect2 val = p_property;
  1068. f->store_real(val.position.x);
  1069. f->store_real(val.position.y);
  1070. f->store_real(val.size.x);
  1071. f->store_real(val.size.y);
  1072. } break;
  1073. case Variant::VECTOR3: {
  1074. f->store_32(VARIANT_VECTOR3);
  1075. Vector3 val = p_property;
  1076. f->store_real(val.x);
  1077. f->store_real(val.y);
  1078. f->store_real(val.z);
  1079. } break;
  1080. case Variant::PLANE: {
  1081. f->store_32(VARIANT_PLANE);
  1082. Plane val = p_property;
  1083. f->store_real(val.normal.x);
  1084. f->store_real(val.normal.y);
  1085. f->store_real(val.normal.z);
  1086. f->store_real(val.d);
  1087. } break;
  1088. case Variant::QUAT: {
  1089. f->store_32(VARIANT_QUAT);
  1090. Quat val = p_property;
  1091. f->store_real(val.x);
  1092. f->store_real(val.y);
  1093. f->store_real(val.z);
  1094. f->store_real(val.w);
  1095. } break;
  1096. case Variant::AABB: {
  1097. f->store_32(VARIANT_AABB);
  1098. AABB val = p_property;
  1099. f->store_real(val.position.x);
  1100. f->store_real(val.position.y);
  1101. f->store_real(val.position.z);
  1102. f->store_real(val.size.x);
  1103. f->store_real(val.size.y);
  1104. f->store_real(val.size.z);
  1105. } break;
  1106. case Variant::TRANSFORM2D: {
  1107. f->store_32(VARIANT_MATRIX32);
  1108. Transform2D val = p_property;
  1109. f->store_real(val.elements[0].x);
  1110. f->store_real(val.elements[0].y);
  1111. f->store_real(val.elements[1].x);
  1112. f->store_real(val.elements[1].y);
  1113. f->store_real(val.elements[2].x);
  1114. f->store_real(val.elements[2].y);
  1115. } break;
  1116. case Variant::BASIS: {
  1117. f->store_32(VARIANT_MATRIX3);
  1118. Basis val = p_property;
  1119. f->store_real(val.elements[0].x);
  1120. f->store_real(val.elements[0].y);
  1121. f->store_real(val.elements[0].z);
  1122. f->store_real(val.elements[1].x);
  1123. f->store_real(val.elements[1].y);
  1124. f->store_real(val.elements[1].z);
  1125. f->store_real(val.elements[2].x);
  1126. f->store_real(val.elements[2].y);
  1127. f->store_real(val.elements[2].z);
  1128. } break;
  1129. case Variant::TRANSFORM: {
  1130. f->store_32(VARIANT_TRANSFORM);
  1131. Transform val = p_property;
  1132. f->store_real(val.basis.elements[0].x);
  1133. f->store_real(val.basis.elements[0].y);
  1134. f->store_real(val.basis.elements[0].z);
  1135. f->store_real(val.basis.elements[1].x);
  1136. f->store_real(val.basis.elements[1].y);
  1137. f->store_real(val.basis.elements[1].z);
  1138. f->store_real(val.basis.elements[2].x);
  1139. f->store_real(val.basis.elements[2].y);
  1140. f->store_real(val.basis.elements[2].z);
  1141. f->store_real(val.origin.x);
  1142. f->store_real(val.origin.y);
  1143. f->store_real(val.origin.z);
  1144. } break;
  1145. case Variant::COLOR: {
  1146. f->store_32(VARIANT_COLOR);
  1147. Color val = p_property;
  1148. f->store_real(val.r);
  1149. f->store_real(val.g);
  1150. f->store_real(val.b);
  1151. f->store_real(val.a);
  1152. } break;
  1153. case Variant::NODE_PATH: {
  1154. f->store_32(VARIANT_NODE_PATH);
  1155. NodePath np = p_property;
  1156. f->store_16(np.get_name_count());
  1157. uint16_t snc = np.get_subname_count();
  1158. if (np.is_absolute()) {
  1159. snc |= 0x8000;
  1160. }
  1161. f->store_16(snc);
  1162. for (int i = 0; i < np.get_name_count(); i++) {
  1163. if (string_map.has(np.get_name(i))) {
  1164. f->store_32(string_map[np.get_name(i)]);
  1165. } else {
  1166. save_unicode_string(f, np.get_name(i), true);
  1167. }
  1168. }
  1169. for (int i = 0; i < np.get_subname_count(); i++) {
  1170. if (string_map.has(np.get_subname(i))) {
  1171. f->store_32(string_map[np.get_subname(i)]);
  1172. } else {
  1173. save_unicode_string(f, np.get_subname(i), true);
  1174. }
  1175. }
  1176. } break;
  1177. case Variant::_RID: {
  1178. f->store_32(VARIANT_RID);
  1179. WARN_PRINT("Can't save RIDs.");
  1180. RID val = p_property;
  1181. f->store_32(val.get_id());
  1182. } break;
  1183. case Variant::OBJECT: {
  1184. f->store_32(VARIANT_OBJECT);
  1185. RES res = p_property;
  1186. if (res.is_null()) {
  1187. f->store_32(OBJECT_EMPTY);
  1188. return; // don't save it
  1189. }
  1190. if (res->get_path().length() && res->get_path().find("::") == -1) {
  1191. f->store_32(OBJECT_EXTERNAL_RESOURCE_INDEX);
  1192. f->store_32(external_resources[res]);
  1193. } else {
  1194. if (!resource_set.has(res)) {
  1195. f->store_32(OBJECT_EMPTY);
  1196. ERR_FAIL_MSG("Resource was not pre cached for the resource section, most likely due to circular reference.");
  1197. }
  1198. f->store_32(OBJECT_INTERNAL_RESOURCE);
  1199. f->store_32(res->get_subindex());
  1200. //internal resource
  1201. }
  1202. } break;
  1203. case Variant::DICTIONARY: {
  1204. f->store_32(VARIANT_DICTIONARY);
  1205. Dictionary d = p_property;
  1206. f->store_32(uint32_t(d.size()));
  1207. List<Variant> keys;
  1208. d.get_key_list(&keys);
  1209. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  1210. /*
  1211. if (!_check_type(dict[E->get()]))
  1212. continue;
  1213. */
  1214. write_variant(f, E->get(), resource_set, external_resources, string_map);
  1215. write_variant(f, d[E->get()], resource_set, external_resources, string_map);
  1216. }
  1217. } break;
  1218. case Variant::ARRAY: {
  1219. f->store_32(VARIANT_ARRAY);
  1220. Array a = p_property;
  1221. f->store_32(uint32_t(a.size()));
  1222. for (int i = 0; i < a.size(); i++) {
  1223. write_variant(f, a[i], resource_set, external_resources, string_map);
  1224. }
  1225. } break;
  1226. case Variant::POOL_BYTE_ARRAY: {
  1227. f->store_32(VARIANT_RAW_ARRAY);
  1228. PoolVector<uint8_t> arr = p_property;
  1229. int len = arr.size();
  1230. f->store_32(len);
  1231. PoolVector<uint8_t>::Read r = arr.read();
  1232. f->store_buffer(r.ptr(), len);
  1233. _pad_buffer(f, len);
  1234. } break;
  1235. case Variant::POOL_INT_ARRAY: {
  1236. f->store_32(VARIANT_INT_ARRAY);
  1237. PoolVector<int> arr = p_property;
  1238. int len = arr.size();
  1239. f->store_32(len);
  1240. PoolVector<int>::Read r = arr.read();
  1241. for (int i = 0; i < len; i++) {
  1242. f->store_32(r[i]);
  1243. }
  1244. } break;
  1245. case Variant::POOL_REAL_ARRAY: {
  1246. f->store_32(VARIANT_REAL_ARRAY);
  1247. PoolVector<real_t> arr = p_property;
  1248. int len = arr.size();
  1249. f->store_32(len);
  1250. PoolVector<real_t>::Read r = arr.read();
  1251. for (int i = 0; i < len; i++) {
  1252. f->store_real(r[i]);
  1253. }
  1254. } break;
  1255. case Variant::POOL_STRING_ARRAY: {
  1256. f->store_32(VARIANT_STRING_ARRAY);
  1257. PoolVector<String> arr = p_property;
  1258. int len = arr.size();
  1259. f->store_32(len);
  1260. PoolVector<String>::Read r = arr.read();
  1261. for (int i = 0; i < len; i++) {
  1262. save_unicode_string(f, r[i]);
  1263. }
  1264. } break;
  1265. case Variant::POOL_VECTOR3_ARRAY: {
  1266. f->store_32(VARIANT_VECTOR3_ARRAY);
  1267. PoolVector<Vector3> arr = p_property;
  1268. int len = arr.size();
  1269. f->store_32(len);
  1270. PoolVector<Vector3>::Read r = arr.read();
  1271. for (int i = 0; i < len; i++) {
  1272. f->store_real(r[i].x);
  1273. f->store_real(r[i].y);
  1274. f->store_real(r[i].z);
  1275. }
  1276. } break;
  1277. case Variant::POOL_VECTOR2_ARRAY: {
  1278. f->store_32(VARIANT_VECTOR2_ARRAY);
  1279. PoolVector<Vector2> arr = p_property;
  1280. int len = arr.size();
  1281. f->store_32(len);
  1282. PoolVector<Vector2>::Read r = arr.read();
  1283. for (int i = 0; i < len; i++) {
  1284. f->store_real(r[i].x);
  1285. f->store_real(r[i].y);
  1286. }
  1287. } break;
  1288. case Variant::POOL_COLOR_ARRAY: {
  1289. f->store_32(VARIANT_COLOR_ARRAY);
  1290. PoolVector<Color> arr = p_property;
  1291. int len = arr.size();
  1292. f->store_32(len);
  1293. PoolVector<Color>::Read r = arr.read();
  1294. for (int i = 0; i < len; i++) {
  1295. f->store_real(r[i].r);
  1296. f->store_real(r[i].g);
  1297. f->store_real(r[i].b);
  1298. f->store_real(r[i].a);
  1299. }
  1300. } break;
  1301. default: {
  1302. ERR_FAIL_MSG("Invalid variant.");
  1303. }
  1304. }
  1305. }
  1306. void ResourceFormatSaverBinaryInstance::_find_resources(const Variant &p_variant, bool p_main) {
  1307. switch (p_variant.get_type()) {
  1308. case Variant::OBJECT: {
  1309. RES res = p_variant.operator RefPtr();
  1310. if (res.is_null() || external_resources.has(res)) {
  1311. return;
  1312. }
  1313. if (!p_main && (!bundle_resources) && res->get_path().length() && res->get_path().find("::") == -1) {
  1314. if (res->get_path() == path) {
  1315. ERR_PRINTS("Circular reference to resource being saved found: '" + local_path + "' will be null next time it's loaded.");
  1316. return;
  1317. }
  1318. int idx = external_resources.size();
  1319. external_resources[res] = idx;
  1320. return;
  1321. }
  1322. if (resource_set.has(res)) {
  1323. return;
  1324. }
  1325. List<PropertyInfo> property_list;
  1326. res->get_property_list(&property_list);
  1327. for (List<PropertyInfo>::Element *E = property_list.front(); E; E = E->next()) {
  1328. if (E->get().usage & PROPERTY_USAGE_STORAGE) {
  1329. Variant value = res->get(E->get().name);
  1330. if (E->get().usage & PROPERTY_USAGE_RESOURCE_NOT_PERSISTENT) {
  1331. RES sres = value;
  1332. if (sres.is_valid()) {
  1333. NonPersistentKey npk;
  1334. npk.base = res;
  1335. npk.property = E->get().name;
  1336. non_persistent_map[npk] = sres;
  1337. resource_set.insert(sres);
  1338. saved_resources.push_back(sres);
  1339. }
  1340. } else {
  1341. _find_resources(value);
  1342. }
  1343. }
  1344. }
  1345. resource_set.insert(res);
  1346. saved_resources.push_back(res);
  1347. } break;
  1348. case Variant::ARRAY: {
  1349. Array varray = p_variant;
  1350. int len = varray.size();
  1351. for (int i = 0; i < len; i++) {
  1352. const Variant &v = varray.get(i);
  1353. _find_resources(v);
  1354. }
  1355. } break;
  1356. case Variant::DICTIONARY: {
  1357. Dictionary d = p_variant;
  1358. List<Variant> keys;
  1359. d.get_key_list(&keys);
  1360. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  1361. _find_resources(E->get());
  1362. Variant v = d[E->get()];
  1363. _find_resources(v);
  1364. }
  1365. } break;
  1366. case Variant::NODE_PATH: {
  1367. //take the chance and save node path strings
  1368. NodePath np = p_variant;
  1369. for (int i = 0; i < np.get_name_count(); i++) {
  1370. get_string_index(np.get_name(i));
  1371. }
  1372. for (int i = 0; i < np.get_subname_count(); i++) {
  1373. get_string_index(np.get_subname(i));
  1374. }
  1375. } break;
  1376. default: {
  1377. }
  1378. }
  1379. }
  1380. void ResourceFormatSaverBinaryInstance::save_unicode_string(FileAccess *f, const String &p_string, bool p_bit_on_len) {
  1381. CharString utf8 = p_string.utf8();
  1382. if (p_bit_on_len) {
  1383. f->store_32((utf8.length() + 1) | 0x80000000);
  1384. } else {
  1385. f->store_32(utf8.length() + 1);
  1386. }
  1387. f->store_buffer((const uint8_t *)utf8.get_data(), utf8.length() + 1);
  1388. }
  1389. int ResourceFormatSaverBinaryInstance::get_string_index(const String &p_string) {
  1390. StringName s = p_string;
  1391. if (string_map.has(s)) {
  1392. return string_map[s];
  1393. }
  1394. string_map[s] = strings.size();
  1395. strings.push_back(s);
  1396. return strings.size() - 1;
  1397. }
  1398. Error ResourceFormatSaverBinaryInstance::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  1399. Error err;
  1400. if (p_flags & ResourceSaver::FLAG_COMPRESS) {
  1401. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  1402. fac->configure("RSCC");
  1403. f = fac;
  1404. err = fac->_open(p_path, FileAccess::WRITE);
  1405. if (err) {
  1406. memdelete(f);
  1407. }
  1408. } else {
  1409. f = FileAccess::open(p_path, FileAccess::WRITE, &err);
  1410. }
  1411. ERR_FAIL_COND_V_MSG(err != OK, err, "Cannot create file '" + p_path + "'.");
  1412. relative_paths = p_flags & ResourceSaver::FLAG_RELATIVE_PATHS;
  1413. skip_editor = p_flags & ResourceSaver::FLAG_OMIT_EDITOR_PROPERTIES;
  1414. bundle_resources = p_flags & ResourceSaver::FLAG_BUNDLE_RESOURCES;
  1415. big_endian = p_flags & ResourceSaver::FLAG_SAVE_BIG_ENDIAN;
  1416. takeover_paths = p_flags & ResourceSaver::FLAG_REPLACE_SUBRESOURCE_PATHS;
  1417. if (!p_path.begins_with("res://")) {
  1418. takeover_paths = false;
  1419. }
  1420. local_path = p_path.get_base_dir();
  1421. path = ProjectSettings::get_singleton()->localize_path(p_path);
  1422. _find_resources(p_resource, true);
  1423. if (!(p_flags & ResourceSaver::FLAG_COMPRESS)) {
  1424. //save header compressed
  1425. static const uint8_t header[4] = { 'R', 'S', 'R', 'C' };
  1426. f->store_buffer(header, 4);
  1427. }
  1428. if (big_endian) {
  1429. f->store_32(1);
  1430. f->set_endian_swap(true);
  1431. } else {
  1432. f->store_32(0);
  1433. }
  1434. f->store_32(0); //64 bits file, false for now
  1435. f->store_32(VERSION_MAJOR);
  1436. f->store_32(VERSION_MINOR);
  1437. f->store_32(FORMAT_VERSION);
  1438. if (f->get_error() != OK && f->get_error() != ERR_FILE_EOF) {
  1439. f->close();
  1440. memdelete(f);
  1441. return ERR_CANT_CREATE;
  1442. }
  1443. save_unicode_string(f, p_resource->get_class());
  1444. f->store_64(0); //offset to import metadata
  1445. for (int i = 0; i < 14; i++) {
  1446. f->store_32(0); // reserved
  1447. }
  1448. List<ResourceData> resources;
  1449. {
  1450. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1451. ResourceData &rd = resources.push_back(ResourceData())->get();
  1452. rd.type = E->get()->get_class();
  1453. List<PropertyInfo> property_list;
  1454. E->get()->get_property_list(&property_list);
  1455. for (List<PropertyInfo>::Element *F = property_list.front(); F; F = F->next()) {
  1456. if (skip_editor && F->get().name.begins_with("__editor")) {
  1457. continue;
  1458. }
  1459. if ((F->get().usage & PROPERTY_USAGE_STORAGE)) {
  1460. Property p;
  1461. p.name_idx = get_string_index(F->get().name);
  1462. if (F->get().usage & PROPERTY_USAGE_RESOURCE_NOT_PERSISTENT) {
  1463. NonPersistentKey npk;
  1464. npk.base = E->get();
  1465. npk.property = F->get().name;
  1466. if (non_persistent_map.has(npk)) {
  1467. p.value = non_persistent_map[npk];
  1468. }
  1469. } else {
  1470. p.value = E->get()->get(F->get().name);
  1471. }
  1472. Variant default_value = ClassDB::class_get_default_property_value(E->get()->get_class(), F->get().name);
  1473. if (default_value.get_type() != Variant::NIL && bool(Variant::evaluate(Variant::OP_EQUAL, p.value, default_value))) {
  1474. continue;
  1475. }
  1476. p.pi = F->get();
  1477. rd.properties.push_back(p);
  1478. }
  1479. }
  1480. }
  1481. }
  1482. f->store_32(strings.size()); //string table size
  1483. for (int i = 0; i < strings.size(); i++) {
  1484. save_unicode_string(f, strings[i]);
  1485. }
  1486. // save external resource table
  1487. f->store_32(external_resources.size()); //amount of external resources
  1488. Vector<RES> save_order;
  1489. save_order.resize(external_resources.size());
  1490. for (Map<RES, int>::Element *E = external_resources.front(); E; E = E->next()) {
  1491. save_order.write[E->get()] = E->key();
  1492. }
  1493. for (int i = 0; i < save_order.size(); i++) {
  1494. save_unicode_string(f, save_order[i]->get_save_class());
  1495. String path = save_order[i]->get_path();
  1496. path = relative_paths ? local_path.path_to_file(path) : path;
  1497. save_unicode_string(f, path);
  1498. }
  1499. // save internal resource table
  1500. f->store_32(saved_resources.size()); //amount of internal resources
  1501. Vector<uint64_t> ofs_pos;
  1502. Set<int> used_indices;
  1503. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1504. RES r = E->get();
  1505. if (r->get_path() == "" || r->get_path().find("::") != -1) {
  1506. if (r->get_subindex() != 0) {
  1507. if (used_indices.has(r->get_subindex())) {
  1508. r->set_subindex(0); //repeated
  1509. } else {
  1510. used_indices.insert(r->get_subindex());
  1511. }
  1512. }
  1513. }
  1514. }
  1515. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1516. RES r = E->get();
  1517. if (r->get_path() == "" || r->get_path().find("::") != -1) {
  1518. if (r->get_subindex() == 0) {
  1519. int new_subindex = 1;
  1520. if (used_indices.size()) {
  1521. new_subindex = used_indices.back()->get() + 1;
  1522. }
  1523. r->set_subindex(new_subindex);
  1524. used_indices.insert(new_subindex);
  1525. }
  1526. save_unicode_string(f, "local://" + itos(r->get_subindex()));
  1527. if (takeover_paths) {
  1528. r->set_path(p_path + "::" + itos(r->get_subindex()), true);
  1529. }
  1530. #ifdef TOOLS_ENABLED
  1531. r->set_edited(false);
  1532. #endif
  1533. } else {
  1534. save_unicode_string(f, r->get_path()); //actual external
  1535. }
  1536. ofs_pos.push_back(f->get_position());
  1537. f->store_64(0); //offset in 64 bits
  1538. }
  1539. Vector<uint64_t> ofs_table;
  1540. //now actually save the resources
  1541. for (List<ResourceData>::Element *E = resources.front(); E; E = E->next()) {
  1542. ResourceData &rd = E->get();
  1543. ofs_table.push_back(f->get_position());
  1544. save_unicode_string(f, rd.type);
  1545. f->store_32(rd.properties.size());
  1546. for (List<Property>::Element *F = rd.properties.front(); F; F = F->next()) {
  1547. Property &p = F->get();
  1548. f->store_32(p.name_idx);
  1549. _write_variant(p.value, F->get().pi);
  1550. }
  1551. }
  1552. for (int i = 0; i < ofs_table.size(); i++) {
  1553. f->seek(ofs_pos[i]);
  1554. f->store_64(ofs_table[i]);
  1555. }
  1556. f->seek_end();
  1557. f->store_buffer((const uint8_t *)"RSRC", 4); //magic at end
  1558. if (f->get_error() != OK && f->get_error() != ERR_FILE_EOF) {
  1559. f->close();
  1560. memdelete(f);
  1561. return ERR_CANT_CREATE;
  1562. }
  1563. f->close();
  1564. memdelete(f);
  1565. return OK;
  1566. }
  1567. Error ResourceFormatSaverBinary::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  1568. String local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  1569. ResourceFormatSaverBinaryInstance saver;
  1570. return saver.save(local_path, p_resource, p_flags);
  1571. }
  1572. bool ResourceFormatSaverBinary::recognize(const RES &p_resource) const {
  1573. return true; //all recognized
  1574. }
  1575. void ResourceFormatSaverBinary::get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const {
  1576. String base = p_resource->get_base_extension().to_lower();
  1577. p_extensions->push_back(base);
  1578. if (base != "res") {
  1579. p_extensions->push_back("res");
  1580. }
  1581. }
  1582. ResourceFormatSaverBinary *ResourceFormatSaverBinary::singleton = nullptr;
  1583. ResourceFormatSaverBinary::ResourceFormatSaverBinary() {
  1584. singleton = this;
  1585. }