resource_format_binary.cpp 47 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943
  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.position.x = f->get_real();
  167. v.position.y = f->get_real();
  168. v.position.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. resource->set_as_translation_remapped(translation_remapped);
  553. error = ERR_FILE_EOF;
  554. } else {
  555. error = OK;
  556. }
  557. return OK;
  558. }
  559. int ResourceInteractiveLoaderBinary::get_stage() const {
  560. return stage;
  561. }
  562. int ResourceInteractiveLoaderBinary::get_stage_count() const {
  563. return external_resources.size() + internal_resources.size();
  564. }
  565. void ResourceInteractiveLoaderBinary::set_translation_remapped(bool p_remapped) {
  566. translation_remapped = p_remapped;
  567. }
  568. static void save_ustring(FileAccess *f, const String &p_string) {
  569. CharString utf8 = p_string.utf8();
  570. f->store_32(utf8.length() + 1);
  571. f->store_buffer((const uint8_t *)utf8.get_data(), utf8.length() + 1);
  572. }
  573. static String get_ustring(FileAccess *f) {
  574. int len = f->get_32();
  575. Vector<char> str_buf;
  576. str_buf.resize(len);
  577. f->get_buffer((uint8_t *)&str_buf[0], len);
  578. String s;
  579. s.parse_utf8(&str_buf[0]);
  580. return s;
  581. }
  582. String ResourceInteractiveLoaderBinary::get_unicode_string() {
  583. int len = f->get_32();
  584. if (len > str_buf.size()) {
  585. str_buf.resize(len);
  586. }
  587. if (len == 0)
  588. return String();
  589. f->get_buffer((uint8_t *)&str_buf[0], len);
  590. String s;
  591. s.parse_utf8(&str_buf[0]);
  592. return s;
  593. }
  594. void ResourceInteractiveLoaderBinary::get_dependencies(FileAccess *p_f, List<String> *p_dependencies, bool p_add_types) {
  595. open(p_f);
  596. if (error)
  597. return;
  598. for (int i = 0; i < external_resources.size(); i++) {
  599. String dep = external_resources[i].path;
  600. if (p_add_types && external_resources[i].type != String()) {
  601. dep += "::" + external_resources[i].type;
  602. }
  603. p_dependencies->push_back(dep);
  604. }
  605. }
  606. void ResourceInteractiveLoaderBinary::open(FileAccess *p_f) {
  607. error = OK;
  608. f = p_f;
  609. uint8_t header[4];
  610. f->get_buffer(header, 4);
  611. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  612. //compressed
  613. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  614. fac->open_after_magic(f);
  615. f = fac;
  616. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  617. //not normal
  618. error = ERR_FILE_UNRECOGNIZED;
  619. ERR_EXPLAIN("Unrecognized binary resource file: " + local_path);
  620. ERR_FAIL();
  621. }
  622. bool big_endian = f->get_32();
  623. #ifdef BIG_ENDIAN_ENABLED
  624. endian_swap = !big_endian;
  625. #else
  626. bool endian_swap = big_endian;
  627. #endif
  628. bool use_real64 = f->get_32();
  629. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  630. uint32_t ver_major = f->get_32();
  631. uint32_t ver_minor = f->get_32();
  632. uint32_t ver_format = f->get_32();
  633. print_bl("big endian: " + itos(big_endian));
  634. print_bl("endian swap: " + itos(endian_swap));
  635. print_bl("real64: " + itos(use_real64));
  636. print_bl("major: " + itos(ver_major));
  637. print_bl("minor: " + itos(ver_minor));
  638. print_bl("format: " + itos(ver_format));
  639. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  640. f->close();
  641. 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);
  642. ERR_FAIL();
  643. }
  644. type = get_unicode_string();
  645. print_bl("type: " + type);
  646. importmd_ofs = f->get_64();
  647. for (int i = 0; i < 14; i++)
  648. f->get_32(); //skip a few reserved fields
  649. uint32_t string_table_size = f->get_32();
  650. string_map.resize(string_table_size);
  651. for (uint32_t i = 0; i < string_table_size; i++) {
  652. StringName s = get_unicode_string();
  653. string_map[i] = s;
  654. }
  655. print_bl("strings: " + itos(string_table_size));
  656. uint32_t ext_resources_size = f->get_32();
  657. for (uint32_t i = 0; i < ext_resources_size; i++) {
  658. ExtResoucre er;
  659. er.type = get_unicode_string();
  660. er.path = get_unicode_string();
  661. external_resources.push_back(er);
  662. }
  663. //see if the exporter has different set of external resources for more efficient loading
  664. /*
  665. String preload_depts = "deps/"+res_path.md5_text();
  666. if (Globals::get_singleton()->has(preload_depts)) {
  667. external_resources.clear();
  668. //ignore external resources and use these
  669. NodePath depts=Globals::get_singleton()->get(preload_depts);
  670. external_resources.resize(depts.get_name_count());
  671. for(int i=0;i<depts.get_name_count();i++) {
  672. external_resources[i].path=depts.get_name(i);
  673. }
  674. print_line(res_path+" - EXTERNAL RESOURCES: "+itos(external_resources.size()));
  675. }*/
  676. print_bl("ext resources: " + itos(ext_resources_size));
  677. uint32_t int_resources_size = f->get_32();
  678. for (uint32_t i = 0; i < int_resources_size; i++) {
  679. IntResoucre ir;
  680. ir.path = get_unicode_string();
  681. ir.offset = f->get_64();
  682. internal_resources.push_back(ir);
  683. }
  684. print_bl("int resources: " + itos(int_resources_size));
  685. if (f->eof_reached()) {
  686. error = ERR_FILE_CORRUPT;
  687. ERR_EXPLAIN("Premature End Of File: " + local_path);
  688. ERR_FAIL();
  689. }
  690. }
  691. String ResourceInteractiveLoaderBinary::recognize(FileAccess *p_f) {
  692. error = OK;
  693. f = p_f;
  694. uint8_t header[4];
  695. f->get_buffer(header, 4);
  696. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  697. //compressed
  698. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  699. fac->open_after_magic(f);
  700. f = fac;
  701. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  702. //not normal
  703. error = ERR_FILE_UNRECOGNIZED;
  704. return "";
  705. }
  706. bool big_endian = f->get_32();
  707. #ifdef BIG_ENDIAN_ENABLED
  708. endian_swap = !big_endian;
  709. #else
  710. bool endian_swap = big_endian;
  711. #endif
  712. bool use_real64 = f->get_32();
  713. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  714. uint32_t ver_major = f->get_32();
  715. uint32_t ver_minor = f->get_32();
  716. uint32_t ver_format = f->get_32();
  717. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  718. f->close();
  719. return "";
  720. }
  721. String type = get_unicode_string();
  722. return type;
  723. }
  724. ResourceInteractiveLoaderBinary::ResourceInteractiveLoaderBinary() {
  725. f = NULL;
  726. stage = 0;
  727. endian_swap = false;
  728. use_real64 = false;
  729. error = OK;
  730. translation_remapped = false;
  731. }
  732. ResourceInteractiveLoaderBinary::~ResourceInteractiveLoaderBinary() {
  733. if (f)
  734. memdelete(f);
  735. }
  736. Ref<ResourceInteractiveLoader> ResourceFormatLoaderBinary::load_interactive(const String &p_path, Error *r_error) {
  737. if (r_error)
  738. *r_error = ERR_FILE_CANT_OPEN;
  739. Error err;
  740. FileAccess *f = FileAccess::open(p_path, FileAccess::READ, &err);
  741. if (err != OK) {
  742. ERR_FAIL_COND_V(err != OK, Ref<ResourceInteractiveLoader>());
  743. }
  744. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  745. ria->local_path = GlobalConfig::get_singleton()->localize_path(p_path);
  746. ria->res_path = ria->local_path;
  747. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  748. ria->open(f);
  749. return ria;
  750. }
  751. void ResourceFormatLoaderBinary::get_recognized_extensions_for_type(const String &p_type, List<String> *p_extensions) const {
  752. if (p_type == "") {
  753. get_recognized_extensions(p_extensions);
  754. return;
  755. }
  756. List<String> extensions;
  757. ClassDB::get_extensions_for_type(p_type, &extensions);
  758. extensions.sort();
  759. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  760. String ext = E->get().to_lower();
  761. p_extensions->push_back(ext);
  762. }
  763. }
  764. void ResourceFormatLoaderBinary::get_recognized_extensions(List<String> *p_extensions) const {
  765. List<String> extensions;
  766. ClassDB::get_resource_base_extensions(&extensions);
  767. extensions.sort();
  768. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  769. String ext = E->get().to_lower();
  770. p_extensions->push_back(ext);
  771. }
  772. }
  773. bool ResourceFormatLoaderBinary::handles_type(const String &p_type) const {
  774. return true; //handles all
  775. }
  776. void ResourceFormatLoaderBinary::get_dependencies(const String &p_path, List<String> *p_dependencies, bool p_add_types) {
  777. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  778. ERR_FAIL_COND(!f);
  779. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  780. ria->local_path = GlobalConfig::get_singleton()->localize_path(p_path);
  781. ria->res_path = ria->local_path;
  782. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  783. ria->get_dependencies(f, p_dependencies, p_add_types);
  784. }
  785. Error ResourceFormatLoaderBinary::rename_dependencies(const String &p_path, const Map<String, String> &p_map) {
  786. //Error error=OK;
  787. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  788. ERR_FAIL_COND_V(!f, ERR_CANT_OPEN);
  789. FileAccess *fw = NULL; //=FileAccess::open(p_path+".depren");
  790. String local_path = p_path.get_base_dir();
  791. uint8_t header[4];
  792. f->get_buffer(header, 4);
  793. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  794. //compressed
  795. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  796. fac->open_after_magic(f);
  797. f = fac;
  798. FileAccessCompressed *facw = memnew(FileAccessCompressed);
  799. facw->configure("RSCC");
  800. Error err = facw->_open(p_path + ".depren", FileAccess::WRITE);
  801. if (err) {
  802. memdelete(fac);
  803. memdelete(facw);
  804. ERR_FAIL_COND_V(err, ERR_FILE_CORRUPT);
  805. }
  806. fw = facw;
  807. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  808. //not normal
  809. //error=ERR_FILE_UNRECOGNIZED;
  810. memdelete(f);
  811. ERR_EXPLAIN("Unrecognized binary resource file: " + local_path);
  812. ERR_FAIL_V(ERR_FILE_UNRECOGNIZED);
  813. } else {
  814. fw = FileAccess::open(p_path + ".depren", FileAccess::WRITE);
  815. if (!fw) {
  816. memdelete(f);
  817. }
  818. ERR_FAIL_COND_V(!fw, ERR_CANT_CREATE);
  819. }
  820. bool big_endian = f->get_32();
  821. #ifdef BIG_ENDIAN_ENABLED
  822. endian_swap = !big_endian;
  823. #else
  824. bool endian_swap = big_endian;
  825. #endif
  826. bool use_real64 = f->get_32();
  827. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  828. fw->store_32(endian_swap);
  829. fw->set_endian_swap(big_endian != 0);
  830. fw->store_32(use_real64); //use real64
  831. uint32_t ver_major = f->get_32();
  832. uint32_t ver_minor = f->get_32();
  833. uint32_t ver_format = f->get_32();
  834. if (ver_format < FORMAT_VERSION_CAN_RENAME_DEPS) {
  835. memdelete(f);
  836. memdelete(fw);
  837. DirAccess *da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  838. da->remove(p_path + ".depren");
  839. memdelete(da);
  840. //fuck it, use the old approach;
  841. WARN_PRINT(("This file is old, so it can't refactor dependencies, opening and resaving: " + p_path).utf8().get_data());
  842. Error err;
  843. f = FileAccess::open(p_path, FileAccess::READ, &err);
  844. if (err != OK) {
  845. ERR_FAIL_COND_V(err != OK, ERR_FILE_CANT_OPEN);
  846. }
  847. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  848. ria->local_path = GlobalConfig::get_singleton()->localize_path(p_path);
  849. ria->res_path = ria->local_path;
  850. ria->remaps = p_map;
  851. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  852. ria->open(f);
  853. err = ria->poll();
  854. while (err == OK) {
  855. err = ria->poll();
  856. }
  857. ERR_FAIL_COND_V(err != ERR_FILE_EOF, ERR_FILE_CORRUPT);
  858. RES res = ria->get_resource();
  859. ERR_FAIL_COND_V(!res.is_valid(), ERR_FILE_CORRUPT);
  860. return ResourceFormatSaverBinary::singleton->save(p_path, res);
  861. }
  862. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  863. memdelete(f);
  864. memdelete(fw);
  865. 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);
  866. ERR_FAIL_V(ERR_FILE_UNRECOGNIZED);
  867. }
  868. fw->store_32(VERSION_MAJOR); //current version
  869. fw->store_32(VERSION_MINOR);
  870. fw->store_32(FORMAT_VERSION);
  871. save_ustring(fw, get_ustring(f)); //type
  872. size_t md_ofs = f->get_pos();
  873. size_t importmd_ofs = f->get_64();
  874. fw->store_64(0); //metadata offset
  875. for (int i = 0; i < 14; i++) {
  876. fw->store_32(0);
  877. f->get_32();
  878. }
  879. //string table
  880. uint32_t string_table_size = f->get_32();
  881. fw->store_32(string_table_size);
  882. for (uint32_t i = 0; i < string_table_size; i++) {
  883. String s = get_ustring(f);
  884. save_ustring(fw, s);
  885. }
  886. //external resources
  887. uint32_t ext_resources_size = f->get_32();
  888. fw->store_32(ext_resources_size);
  889. for (uint32_t i = 0; i < ext_resources_size; i++) {
  890. String type = get_ustring(f);
  891. String path = get_ustring(f);
  892. bool relative = false;
  893. if (!path.begins_with("res://")) {
  894. path = local_path.plus_file(path).simplify_path();
  895. relative = true;
  896. }
  897. if (p_map.has(path)) {
  898. String np = p_map[path];
  899. path = np;
  900. }
  901. if (relative) {
  902. //restore relative
  903. path = local_path.path_to_file(path);
  904. }
  905. save_ustring(fw, type);
  906. save_ustring(fw, path);
  907. }
  908. int64_t size_diff = (int64_t)fw->get_pos() - (int64_t)f->get_pos();
  909. //internal resources
  910. uint32_t int_resources_size = f->get_32();
  911. fw->store_32(int_resources_size);
  912. for (uint32_t i = 0; i < int_resources_size; i++) {
  913. String path = get_ustring(f);
  914. uint64_t offset = f->get_64();
  915. save_ustring(fw, path);
  916. fw->store_64(offset + size_diff);
  917. }
  918. //rest of file
  919. uint8_t b = f->get_8();
  920. while (!f->eof_reached()) {
  921. fw->store_8(b);
  922. b = f->get_8();
  923. }
  924. bool all_ok = fw->get_error() == OK;
  925. fw->seek(md_ofs);
  926. fw->store_64(importmd_ofs + size_diff);
  927. memdelete(f);
  928. memdelete(fw);
  929. if (!all_ok) {
  930. return ERR_CANT_CREATE;
  931. }
  932. DirAccess *da = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  933. da->remove(p_path);
  934. da->rename(p_path + ".depren", p_path);
  935. memdelete(da);
  936. return OK;
  937. }
  938. String ResourceFormatLoaderBinary::get_resource_type(const String &p_path) const {
  939. FileAccess *f = FileAccess::open(p_path, FileAccess::READ);
  940. if (!f) {
  941. return ""; //could not rwead
  942. }
  943. Ref<ResourceInteractiveLoaderBinary> ria = memnew(ResourceInteractiveLoaderBinary);
  944. ria->local_path = GlobalConfig::get_singleton()->localize_path(p_path);
  945. ria->res_path = ria->local_path;
  946. //ria->set_local_path( Globals::get_singleton()->localize_path(p_path) );
  947. String r = ria->recognize(f);
  948. return r;
  949. }
  950. ///////////////////////////////////////////////////////////
  951. ///////////////////////////////////////////////////////////
  952. ///////////////////////////////////////////////////////////
  953. void ResourceFormatSaverBinaryInstance::_pad_buffer(int p_bytes) {
  954. int extra = 4 - (p_bytes % 4);
  955. if (extra < 4) {
  956. for (int i = 0; i < extra; i++)
  957. f->store_8(0); //pad to 32
  958. }
  959. }
  960. void ResourceFormatSaverBinaryInstance::write_variant(const Variant &p_property, const PropertyInfo &p_hint) {
  961. switch (p_property.get_type()) {
  962. case Variant::NIL: {
  963. f->store_32(VARIANT_NIL);
  964. // don't store anything
  965. } break;
  966. case Variant::BOOL: {
  967. f->store_32(VARIANT_BOOL);
  968. bool val = p_property;
  969. f->store_32(val);
  970. } break;
  971. case Variant::INT: {
  972. int64_t val = p_property;
  973. if (val > 0x7FFFFFFF || val < -0x80000000) {
  974. f->store_32(VARIANT_INT64);
  975. f->store_64(val);
  976. } else {
  977. f->store_32(VARIANT_INT);
  978. int val = p_property;
  979. f->store_32(int32_t(val));
  980. }
  981. } break;
  982. case Variant::REAL: {
  983. double d = p_property;
  984. float fl = d;
  985. if (double(fl) != d) {
  986. f->store_32(VARIANT_DOUBLE);
  987. f->store_double(d);
  988. } else {
  989. f->store_32(VARIANT_REAL);
  990. f->store_real(fl);
  991. }
  992. } break;
  993. case Variant::STRING: {
  994. f->store_32(VARIANT_STRING);
  995. String val = p_property;
  996. save_unicode_string(val);
  997. } break;
  998. case Variant::VECTOR2: {
  999. f->store_32(VARIANT_VECTOR2);
  1000. Vector2 val = p_property;
  1001. f->store_real(val.x);
  1002. f->store_real(val.y);
  1003. } break;
  1004. case Variant::RECT2: {
  1005. f->store_32(VARIANT_RECT2);
  1006. Rect2 val = p_property;
  1007. f->store_real(val.position.x);
  1008. f->store_real(val.position.y);
  1009. f->store_real(val.size.x);
  1010. f->store_real(val.size.y);
  1011. } break;
  1012. case Variant::VECTOR3: {
  1013. f->store_32(VARIANT_VECTOR3);
  1014. Vector3 val = p_property;
  1015. f->store_real(val.x);
  1016. f->store_real(val.y);
  1017. f->store_real(val.z);
  1018. } break;
  1019. case Variant::PLANE: {
  1020. f->store_32(VARIANT_PLANE);
  1021. Plane val = p_property;
  1022. f->store_real(val.normal.x);
  1023. f->store_real(val.normal.y);
  1024. f->store_real(val.normal.z);
  1025. f->store_real(val.d);
  1026. } break;
  1027. case Variant::QUAT: {
  1028. f->store_32(VARIANT_QUAT);
  1029. Quat val = p_property;
  1030. f->store_real(val.x);
  1031. f->store_real(val.y);
  1032. f->store_real(val.z);
  1033. f->store_real(val.w);
  1034. } break;
  1035. case Variant::RECT3: {
  1036. f->store_32(VARIANT_RECT3);
  1037. Rect3 val = p_property;
  1038. f->store_real(val.position.x);
  1039. f->store_real(val.position.y);
  1040. f->store_real(val.position.z);
  1041. f->store_real(val.size.x);
  1042. f->store_real(val.size.y);
  1043. f->store_real(val.size.z);
  1044. } break;
  1045. case Variant::TRANSFORM2D: {
  1046. f->store_32(VARIANT_MATRIX32);
  1047. Transform2D val = p_property;
  1048. f->store_real(val.elements[0].x);
  1049. f->store_real(val.elements[0].y);
  1050. f->store_real(val.elements[1].x);
  1051. f->store_real(val.elements[1].y);
  1052. f->store_real(val.elements[2].x);
  1053. f->store_real(val.elements[2].y);
  1054. } break;
  1055. case Variant::BASIS: {
  1056. f->store_32(VARIANT_MATRIX3);
  1057. Basis val = p_property;
  1058. f->store_real(val.elements[0].x);
  1059. f->store_real(val.elements[0].y);
  1060. f->store_real(val.elements[0].z);
  1061. f->store_real(val.elements[1].x);
  1062. f->store_real(val.elements[1].y);
  1063. f->store_real(val.elements[1].z);
  1064. f->store_real(val.elements[2].x);
  1065. f->store_real(val.elements[2].y);
  1066. f->store_real(val.elements[2].z);
  1067. } break;
  1068. case Variant::TRANSFORM: {
  1069. f->store_32(VARIANT_TRANSFORM);
  1070. Transform val = p_property;
  1071. f->store_real(val.basis.elements[0].x);
  1072. f->store_real(val.basis.elements[0].y);
  1073. f->store_real(val.basis.elements[0].z);
  1074. f->store_real(val.basis.elements[1].x);
  1075. f->store_real(val.basis.elements[1].y);
  1076. f->store_real(val.basis.elements[1].z);
  1077. f->store_real(val.basis.elements[2].x);
  1078. f->store_real(val.basis.elements[2].y);
  1079. f->store_real(val.basis.elements[2].z);
  1080. f->store_real(val.origin.x);
  1081. f->store_real(val.origin.y);
  1082. f->store_real(val.origin.z);
  1083. } break;
  1084. case Variant::COLOR: {
  1085. f->store_32(VARIANT_COLOR);
  1086. Color val = p_property;
  1087. f->store_real(val.r);
  1088. f->store_real(val.g);
  1089. f->store_real(val.b);
  1090. f->store_real(val.a);
  1091. } break;
  1092. case Variant::NODE_PATH: {
  1093. f->store_32(VARIANT_NODE_PATH);
  1094. NodePath np = p_property;
  1095. f->store_16(np.get_name_count());
  1096. uint16_t snc = np.get_subname_count();
  1097. if (np.is_absolute())
  1098. snc |= 0x8000;
  1099. f->store_16(snc);
  1100. for (int i = 0; i < np.get_name_count(); i++)
  1101. f->store_32(get_string_index(np.get_name(i)));
  1102. for (int i = 0; i < np.get_subname_count(); i++)
  1103. f->store_32(get_string_index(np.get_subname(i)));
  1104. f->store_32(get_string_index(np.get_property()));
  1105. } break;
  1106. case Variant::_RID: {
  1107. f->store_32(VARIANT_RID);
  1108. WARN_PRINT("Can't save RIDs");
  1109. RID val = p_property;
  1110. f->store_32(val.get_id());
  1111. } break;
  1112. case Variant::OBJECT: {
  1113. f->store_32(VARIANT_OBJECT);
  1114. RES res = p_property;
  1115. if (res.is_null()) {
  1116. f->store_32(OBJECT_EMPTY);
  1117. return; // don't save it
  1118. }
  1119. if (res->get_path().length() && res->get_path().find("::") == -1) {
  1120. f->store_32(OBJECT_EXTERNAL_RESOURCE_INDEX);
  1121. f->store_32(external_resources[res]);
  1122. } else {
  1123. if (!resource_set.has(res)) {
  1124. f->store_32(OBJECT_EMPTY);
  1125. ERR_EXPLAIN("Resource was not pre cached for the resource section, bug?");
  1126. ERR_FAIL();
  1127. }
  1128. f->store_32(OBJECT_INTERNAL_RESOURCE);
  1129. f->store_32(res->get_subindex());
  1130. //internal resource
  1131. }
  1132. } break;
  1133. case Variant::DICTIONARY: {
  1134. f->store_32(VARIANT_DICTIONARY);
  1135. Dictionary d = p_property;
  1136. f->store_32(uint32_t(d.size()));
  1137. List<Variant> keys;
  1138. d.get_key_list(&keys);
  1139. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  1140. /*
  1141. if (!_check_type(dict[E->get()]))
  1142. continue;
  1143. */
  1144. write_variant(E->get());
  1145. write_variant(d[E->get()]);
  1146. }
  1147. } break;
  1148. case Variant::ARRAY: {
  1149. f->store_32(VARIANT_ARRAY);
  1150. Array a = p_property;
  1151. f->store_32(uint32_t(a.size()));
  1152. for (int i = 0; i < a.size(); i++) {
  1153. write_variant(a[i]);
  1154. }
  1155. } break;
  1156. case Variant::POOL_BYTE_ARRAY: {
  1157. f->store_32(VARIANT_RAW_ARRAY);
  1158. PoolVector<uint8_t> arr = p_property;
  1159. int len = arr.size();
  1160. f->store_32(len);
  1161. PoolVector<uint8_t>::Read r = arr.read();
  1162. f->store_buffer(r.ptr(), len);
  1163. _pad_buffer(len);
  1164. } break;
  1165. case Variant::POOL_INT_ARRAY: {
  1166. f->store_32(VARIANT_INT_ARRAY);
  1167. PoolVector<int> arr = p_property;
  1168. int len = arr.size();
  1169. f->store_32(len);
  1170. PoolVector<int>::Read r = arr.read();
  1171. for (int i = 0; i < len; i++)
  1172. f->store_32(r[i]);
  1173. } break;
  1174. case Variant::POOL_REAL_ARRAY: {
  1175. f->store_32(VARIANT_REAL_ARRAY);
  1176. PoolVector<real_t> arr = p_property;
  1177. int len = arr.size();
  1178. f->store_32(len);
  1179. PoolVector<real_t>::Read r = arr.read();
  1180. for (int i = 0; i < len; i++) {
  1181. f->store_real(r[i]);
  1182. }
  1183. } break;
  1184. case Variant::POOL_STRING_ARRAY: {
  1185. f->store_32(VARIANT_STRING_ARRAY);
  1186. PoolVector<String> arr = p_property;
  1187. int len = arr.size();
  1188. f->store_32(len);
  1189. PoolVector<String>::Read r = arr.read();
  1190. for (int i = 0; i < len; i++) {
  1191. save_unicode_string(r[i]);
  1192. }
  1193. } break;
  1194. case Variant::POOL_VECTOR3_ARRAY: {
  1195. f->store_32(VARIANT_VECTOR3_ARRAY);
  1196. PoolVector<Vector3> arr = p_property;
  1197. int len = arr.size();
  1198. f->store_32(len);
  1199. PoolVector<Vector3>::Read r = arr.read();
  1200. for (int i = 0; i < len; i++) {
  1201. f->store_real(r[i].x);
  1202. f->store_real(r[i].y);
  1203. f->store_real(r[i].z);
  1204. }
  1205. } break;
  1206. case Variant::POOL_VECTOR2_ARRAY: {
  1207. f->store_32(VARIANT_VECTOR2_ARRAY);
  1208. PoolVector<Vector2> arr = p_property;
  1209. int len = arr.size();
  1210. f->store_32(len);
  1211. PoolVector<Vector2>::Read r = arr.read();
  1212. for (int i = 0; i < len; i++) {
  1213. f->store_real(r[i].x);
  1214. f->store_real(r[i].y);
  1215. }
  1216. } break;
  1217. case Variant::POOL_COLOR_ARRAY: {
  1218. f->store_32(VARIANT_COLOR_ARRAY);
  1219. PoolVector<Color> arr = p_property;
  1220. int len = arr.size();
  1221. f->store_32(len);
  1222. PoolVector<Color>::Read r = arr.read();
  1223. for (int i = 0; i < len; i++) {
  1224. f->store_real(r[i].r);
  1225. f->store_real(r[i].g);
  1226. f->store_real(r[i].b);
  1227. f->store_real(r[i].a);
  1228. }
  1229. } break;
  1230. default: {
  1231. ERR_EXPLAIN("Invalid variant");
  1232. ERR_FAIL();
  1233. }
  1234. }
  1235. }
  1236. void ResourceFormatSaverBinaryInstance::_find_resources(const Variant &p_variant, bool p_main) {
  1237. switch (p_variant.get_type()) {
  1238. case Variant::OBJECT: {
  1239. RES res = p_variant.operator RefPtr();
  1240. if (res.is_null() || external_resources.has(res))
  1241. return;
  1242. if (!p_main && (!bundle_resources) && res->get_path().length() && res->get_path().find("::") == -1) {
  1243. int idx = external_resources.size();
  1244. external_resources[res] = idx;
  1245. return;
  1246. }
  1247. if (resource_set.has(res))
  1248. return;
  1249. List<PropertyInfo> property_list;
  1250. res->get_property_list(&property_list);
  1251. for (List<PropertyInfo>::Element *E = property_list.front(); E; E = E->next()) {
  1252. if (E->get().usage & PROPERTY_USAGE_STORAGE) {
  1253. _find_resources(res->get(E->get().name));
  1254. }
  1255. }
  1256. resource_set.insert(res);
  1257. saved_resources.push_back(res);
  1258. } break;
  1259. case Variant::ARRAY: {
  1260. Array varray = p_variant;
  1261. int len = varray.size();
  1262. for (int i = 0; i < len; i++) {
  1263. Variant v = varray.get(i);
  1264. _find_resources(v);
  1265. }
  1266. } break;
  1267. case Variant::DICTIONARY: {
  1268. Dictionary d = p_variant;
  1269. List<Variant> keys;
  1270. d.get_key_list(&keys);
  1271. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  1272. _find_resources(E->get());
  1273. Variant v = d[E->get()];
  1274. _find_resources(v);
  1275. }
  1276. } break;
  1277. case Variant::NODE_PATH: {
  1278. //take the chance and save node path strings
  1279. NodePath np = p_variant;
  1280. for (int i = 0; i < np.get_name_count(); i++)
  1281. get_string_index(np.get_name(i));
  1282. for (int i = 0; i < np.get_subname_count(); i++)
  1283. get_string_index(np.get_subname(i));
  1284. get_string_index(np.get_property());
  1285. } break;
  1286. default: {}
  1287. }
  1288. }
  1289. #if 0
  1290. Error ResourceFormatSaverBinary::_save_obj(const Object *p_object,SavedObject *so) {
  1291. //use classic way
  1292. List<PropertyInfo> property_list;
  1293. p_object->get_property_list( &property_list );
  1294. for(List<PropertyInfo>::Element *E=property_list.front();E;E=E->next()) {
  1295. if (skip_editor && E->get().name.begins_with("__editor"))
  1296. continue;
  1297. if (E->get().usage&PROPERTY_USAGE_STORAGE || (bundle_resources && E->get().usage&PROPERTY_USAGE_BUNDLE)) {
  1298. SavedObject::SavedProperty sp;
  1299. sp.name_idx=get_string_index(E->get().name);
  1300. sp.value = p_object->get(E->get().name);
  1301. _find_resources(sp.value);
  1302. so->properties.push_back(sp);
  1303. }
  1304. }
  1305. return OK;
  1306. }
  1307. Error ResourceFormatSaverBinary::save(const Object *p_object,const Variant &p_meta) {
  1308. ERR_FAIL_COND_V(!f,ERR_UNCONFIGURED);
  1309. ERR_EXPLAIN("write_object should supply either an object, a meta, or both");
  1310. ERR_FAIL_COND_V(!p_object && p_meta.get_type()==Variant::NIL, ERR_INVALID_PARAMETER);
  1311. SavedObject *so = memnew( SavedObject );
  1312. if (p_object)
  1313. so->type=p_object->get_type();
  1314. _find_resources(p_meta);
  1315. so->meta=p_meta;
  1316. Error err = _save_obj(p_object,so);
  1317. ERR_FAIL_COND_V( err, ERR_INVALID_DATA );
  1318. saved_objects.push_back(so);
  1319. return OK;
  1320. }
  1321. #endif
  1322. void ResourceFormatSaverBinaryInstance::save_unicode_string(const String &p_string) {
  1323. CharString utf8 = p_string.utf8();
  1324. f->store_32(utf8.length() + 1);
  1325. f->store_buffer((const uint8_t *)utf8.get_data(), utf8.length() + 1);
  1326. }
  1327. int ResourceFormatSaverBinaryInstance::get_string_index(const String &p_string) {
  1328. StringName s = p_string;
  1329. if (string_map.has(s))
  1330. return string_map[s];
  1331. string_map[s] = strings.size();
  1332. strings.push_back(s);
  1333. return strings.size() - 1;
  1334. }
  1335. Error ResourceFormatSaverBinaryInstance::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  1336. Error err;
  1337. if (p_flags & ResourceSaver::FLAG_COMPRESS) {
  1338. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  1339. fac->configure("RSCC");
  1340. f = fac;
  1341. err = fac->_open(p_path, FileAccess::WRITE);
  1342. if (err)
  1343. memdelete(f);
  1344. } else {
  1345. f = FileAccess::open(p_path, FileAccess::WRITE, &err);
  1346. }
  1347. ERR_FAIL_COND_V(err, err);
  1348. FileAccessRef _fref(f);
  1349. relative_paths = p_flags & ResourceSaver::FLAG_RELATIVE_PATHS;
  1350. skip_editor = p_flags & ResourceSaver::FLAG_OMIT_EDITOR_PROPERTIES;
  1351. bundle_resources = p_flags & ResourceSaver::FLAG_BUNDLE_RESOURCES;
  1352. big_endian = p_flags & ResourceSaver::FLAG_SAVE_BIG_ENDIAN;
  1353. takeover_paths = p_flags & ResourceSaver::FLAG_REPLACE_SUBRESOURCE_PATHS;
  1354. if (!p_path.begins_with("res://"))
  1355. takeover_paths = false;
  1356. local_path = p_path.get_base_dir();
  1357. //bin_meta_idx = get_string_index("__bin_meta__"); //is often used, so create
  1358. _find_resources(p_resource, true);
  1359. if (!(p_flags & ResourceSaver::FLAG_COMPRESS)) {
  1360. //save header compressed
  1361. static const uint8_t header[4] = { 'R', 'S', 'R', 'C' };
  1362. f->store_buffer(header, 4);
  1363. }
  1364. if (big_endian) {
  1365. f->store_32(1);
  1366. f->set_endian_swap(true);
  1367. } else
  1368. f->store_32(0);
  1369. f->store_32(0); //64 bits file, false for now
  1370. f->store_32(VERSION_MAJOR);
  1371. f->store_32(VERSION_MINOR);
  1372. f->store_32(FORMAT_VERSION);
  1373. if (f->get_error() != OK && f->get_error() != ERR_FILE_EOF) {
  1374. f->close();
  1375. return ERR_CANT_CREATE;
  1376. }
  1377. //f->store_32(saved_resources.size()+external_resources.size()); // load steps -not needed
  1378. save_unicode_string(p_resource->get_class());
  1379. uint64_t md_at = f->get_pos();
  1380. f->store_64(0); //offset to impoty metadata
  1381. for (int i = 0; i < 14; i++)
  1382. f->store_32(0); // reserved
  1383. List<ResourceData> resources;
  1384. {
  1385. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1386. ResourceData &rd = resources.push_back(ResourceData())->get();
  1387. rd.type = E->get()->get_class();
  1388. List<PropertyInfo> property_list;
  1389. E->get()->get_property_list(&property_list);
  1390. for (List<PropertyInfo>::Element *F = property_list.front(); F; F = F->next()) {
  1391. if (skip_editor && F->get().name.begins_with("__editor"))
  1392. continue;
  1393. if (F->get().usage & PROPERTY_USAGE_STORAGE) {
  1394. Property p;
  1395. p.name_idx = get_string_index(F->get().name);
  1396. p.value = E->get()->get(F->get().name);
  1397. 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()))
  1398. continue;
  1399. p.pi = F->get();
  1400. rd.properties.push_back(p);
  1401. }
  1402. }
  1403. }
  1404. }
  1405. f->store_32(strings.size()); //string table size
  1406. for (int i = 0; i < strings.size(); i++) {
  1407. //print_bl("saving string: "+strings[i]);
  1408. save_unicode_string(strings[i]);
  1409. }
  1410. // save external resource table
  1411. f->store_32(external_resources.size()); //amount of external resources
  1412. Vector<RES> save_order;
  1413. save_order.resize(external_resources.size());
  1414. for (Map<RES, int>::Element *E = external_resources.front(); E; E = E->next()) {
  1415. save_order[E->get()] = E->key();
  1416. }
  1417. for (int i = 0; i < save_order.size(); i++) {
  1418. save_unicode_string(save_order[i]->get_save_class());
  1419. String path = save_order[i]->get_path();
  1420. path = relative_paths ? local_path.path_to_file(path) : path;
  1421. save_unicode_string(path);
  1422. }
  1423. // save internal resource table
  1424. f->store_32(saved_resources.size()); //amount of internal resources
  1425. Vector<uint64_t> ofs_pos;
  1426. Set<int> used_indices;
  1427. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1428. RES r = E->get();
  1429. if (r->get_path() == "" || r->get_path().find("::") != -1) {
  1430. if (r->get_subindex() != 0) {
  1431. if (used_indices.has(r->get_subindex())) {
  1432. r->set_subindex(0); //repeated
  1433. } else {
  1434. used_indices.insert(r->get_subindex());
  1435. }
  1436. }
  1437. }
  1438. }
  1439. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1440. RES r = E->get();
  1441. if (r->get_path() == "" || r->get_path().find("::") != -1) {
  1442. if (r->get_subindex() == 0) {
  1443. int new_subindex = 1;
  1444. if (used_indices.size()) {
  1445. new_subindex = used_indices.back()->get() + 1;
  1446. }
  1447. r->set_subindex(new_subindex);
  1448. used_indices.insert(new_subindex);
  1449. }
  1450. save_unicode_string("local://" + itos(r->get_subindex()));
  1451. if (takeover_paths) {
  1452. r->set_path(p_path + "::" + itos(r->get_subindex()), true);
  1453. }
  1454. #ifdef TOOLS_ENABLED
  1455. r->set_edited(false);
  1456. #endif
  1457. } else {
  1458. save_unicode_string(r->get_path()); //actual external
  1459. }
  1460. ofs_pos.push_back(f->get_pos());
  1461. f->store_64(0); //offset in 64 bits
  1462. }
  1463. Vector<uint64_t> ofs_table;
  1464. //int saved_idx=0;
  1465. //now actually save the resources
  1466. for (List<ResourceData>::Element *E = resources.front(); E; E = E->next()) {
  1467. ResourceData &rd = E->get();
  1468. ofs_table.push_back(f->get_pos());
  1469. save_unicode_string(rd.type);
  1470. f->store_32(rd.properties.size());
  1471. for (List<Property>::Element *F = rd.properties.front(); F; F = F->next()) {
  1472. Property &p = F->get();
  1473. f->store_32(p.name_idx);
  1474. write_variant(p.value, F->get().pi);
  1475. }
  1476. }
  1477. for (int i = 0; i < ofs_table.size(); i++) {
  1478. f->seek(ofs_pos[i]);
  1479. f->store_64(ofs_table[i]);
  1480. }
  1481. f->seek_end();
  1482. f->store_buffer((const uint8_t *)"RSRC", 4); //magic at end
  1483. if (f->get_error() != OK && f->get_error() != ERR_FILE_EOF) {
  1484. f->close();
  1485. return ERR_CANT_CREATE;
  1486. }
  1487. f->close();
  1488. return OK;
  1489. }
  1490. Error ResourceFormatSaverBinary::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  1491. String local_path = GlobalConfig::get_singleton()->localize_path(p_path);
  1492. ResourceFormatSaverBinaryInstance saver;
  1493. return saver.save(local_path, p_resource, p_flags);
  1494. }
  1495. bool ResourceFormatSaverBinary::recognize(const RES &p_resource) const {
  1496. return true; //all recognized
  1497. }
  1498. void ResourceFormatSaverBinary::get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const {
  1499. String base = p_resource->get_base_extension().to_lower();
  1500. p_extensions->push_back(base);
  1501. if (base != "res")
  1502. p_extensions->push_back("res");
  1503. }
  1504. ResourceFormatSaverBinary *ResourceFormatSaverBinary::singleton = NULL;
  1505. ResourceFormatSaverBinary::ResourceFormatSaverBinary() {
  1506. singleton = this;
  1507. }