resource_format_binary.cpp 47 KB

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