resource_format_binary.cpp 49 KB

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