resource_format_binary.cpp 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950
  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_AABB = 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.pos.x = f->get_real();
  136. v.pos.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_AABB: {
  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_INPUT_EVENT: {
  300. InputEvent ev;
  301. ev.type = f->get_32(); //will only work for null though.
  302. r_v = ev;
  303. } break;
  304. case VARIANT_DICTIONARY: {
  305. uint32_t len = f->get_32();
  306. Dictionary d; //last bit means shared
  307. len &= 0x7FFFFFFF;
  308. for (uint32_t i = 0; i < len; i++) {
  309. Variant key;
  310. Error err = parse_variant(key);
  311. ERR_FAIL_COND_V(err, ERR_FILE_CORRUPT);
  312. Variant value;
  313. err = parse_variant(value);
  314. ERR_FAIL_COND_V(err, ERR_FILE_CORRUPT);
  315. d[key] = value;
  316. }
  317. r_v = d;
  318. } break;
  319. case VARIANT_ARRAY: {
  320. uint32_t len = f->get_32();
  321. Array a; //last bit means shared
  322. len &= 0x7FFFFFFF;
  323. a.resize(len);
  324. for (uint32_t i = 0; i < len; i++) {
  325. Variant val;
  326. Error err = parse_variant(val);
  327. ERR_FAIL_COND_V(err, ERR_FILE_CORRUPT);
  328. a[i] = val;
  329. }
  330. r_v = a;
  331. } break;
  332. case VARIANT_RAW_ARRAY: {
  333. uint32_t len = f->get_32();
  334. PoolVector<uint8_t> array;
  335. array.resize(len);
  336. PoolVector<uint8_t>::Write w = array.write();
  337. f->get_buffer(w.ptr(), len);
  338. _advance_padding(len);
  339. w = PoolVector<uint8_t>::Write();
  340. r_v = array;
  341. } break;
  342. case VARIANT_INT_ARRAY: {
  343. uint32_t len = f->get_32();
  344. PoolVector<int> array;
  345. array.resize(len);
  346. PoolVector<int>::Write w = array.write();
  347. f->get_buffer((uint8_t *)w.ptr(), len * 4);
  348. #ifdef BIG_ENDIAN_ENABLED
  349. {
  350. uint32_t *ptr = (uint32_t *)w.ptr();
  351. for (int i = 0; i < len; i++) {
  352. ptr[i] = BSWAP32(ptr[i]);
  353. }
  354. }
  355. #endif
  356. w = PoolVector<int>::Write();
  357. r_v = array;
  358. } break;
  359. case VARIANT_REAL_ARRAY: {
  360. uint32_t len = f->get_32();
  361. PoolVector<real_t> array;
  362. array.resize(len);
  363. PoolVector<real_t>::Write w = array.write();
  364. f->get_buffer((uint8_t *)w.ptr(), len * sizeof(real_t));
  365. #ifdef BIG_ENDIAN_ENABLED
  366. {
  367. uint32_t *ptr = (uint32_t *)w.ptr();
  368. for (int i = 0; i < len; i++) {
  369. ptr[i] = BSWAP32(ptr[i]);
  370. }
  371. }
  372. #endif
  373. w = PoolVector<real_t>::Write();
  374. r_v = array;
  375. } break;
  376. case VARIANT_STRING_ARRAY: {
  377. uint32_t len = f->get_32();
  378. PoolVector<String> array;
  379. array.resize(len);
  380. PoolVector<String>::Write w = array.write();
  381. for (uint32_t i = 0; i < len; i++)
  382. w[i] = get_unicode_string();
  383. w = PoolVector<String>::Write();
  384. r_v = array;
  385. } break;
  386. case VARIANT_VECTOR2_ARRAY: {
  387. uint32_t len = f->get_32();
  388. PoolVector<Vector2> array;
  389. array.resize(len);
  390. PoolVector<Vector2>::Write w = array.write();
  391. if (sizeof(Vector2) == 8) {
  392. f->get_buffer((uint8_t *)w.ptr(), len * sizeof(real_t) * 2);
  393. #ifdef BIG_ENDIAN_ENABLED
  394. {
  395. uint32_t *ptr = (uint32_t *)w.ptr();
  396. for (int i = 0; i < len * 2; i++) {
  397. ptr[i] = BSWAP32(ptr[i]);
  398. }
  399. }
  400. #endif
  401. } else {
  402. ERR_EXPLAIN("Vector2 size is NOT 8!");
  403. ERR_FAIL_V(ERR_UNAVAILABLE);
  404. }
  405. w = PoolVector<Vector2>::Write();
  406. r_v = array;
  407. } break;
  408. case VARIANT_VECTOR3_ARRAY: {
  409. uint32_t len = f->get_32();
  410. PoolVector<Vector3> array;
  411. array.resize(len);
  412. PoolVector<Vector3>::Write w = array.write();
  413. if (sizeof(Vector3) == 12) {
  414. f->get_buffer((uint8_t *)w.ptr(), len * sizeof(real_t) * 3);
  415. #ifdef BIG_ENDIAN_ENABLED
  416. {
  417. uint32_t *ptr = (uint32_t *)w.ptr();
  418. for (int i = 0; i < len * 3; i++) {
  419. ptr[i] = BSWAP32(ptr[i]);
  420. }
  421. }
  422. #endif
  423. } else {
  424. ERR_EXPLAIN("Vector3 size is NOT 12!");
  425. ERR_FAIL_V(ERR_UNAVAILABLE);
  426. }
  427. w = PoolVector<Vector3>::Write();
  428. r_v = array;
  429. } break;
  430. case VARIANT_COLOR_ARRAY: {
  431. uint32_t len = f->get_32();
  432. PoolVector<Color> array;
  433. array.resize(len);
  434. PoolVector<Color>::Write w = array.write();
  435. if (sizeof(Color) == 16) {
  436. f->get_buffer((uint8_t *)w.ptr(), len * sizeof(real_t) * 4);
  437. #ifdef BIG_ENDIAN_ENABLED
  438. {
  439. uint32_t *ptr = (uint32_t *)w.ptr();
  440. for (int i = 0; i < len * 4; i++) {
  441. ptr[i] = BSWAP32(ptr[i]);
  442. }
  443. }
  444. #endif
  445. } else {
  446. ERR_EXPLAIN("Color size is NOT 16!");
  447. ERR_FAIL_V(ERR_UNAVAILABLE);
  448. }
  449. w = PoolVector<Color>::Write();
  450. r_v = array;
  451. } break;
  452. default: {
  453. ERR_FAIL_V(ERR_FILE_CORRUPT);
  454. } break;
  455. }
  456. return OK; //never reach anyway
  457. }
  458. void ResourceInteractiveLoaderBinary::set_local_path(const String &p_local_path) {
  459. res_path = p_local_path;
  460. }
  461. Ref<Resource> ResourceInteractiveLoaderBinary::get_resource() {
  462. return resource;
  463. }
  464. Error ResourceInteractiveLoaderBinary::poll() {
  465. if (error != OK)
  466. return error;
  467. int s = stage;
  468. if (s < external_resources.size()) {
  469. String path = external_resources[s].path;
  470. print_line("load external res: " + path);
  471. if (remaps.has(path)) {
  472. path = remaps[path];
  473. }
  474. RES res = ResourceLoader::load(path, external_resources[s].type);
  475. if (res.is_null()) {
  476. if (!ResourceLoader::get_abort_on_missing_resources()) {
  477. ResourceLoader::notify_dependency_error(local_path, path, external_resources[s].type);
  478. } else {
  479. error = ERR_FILE_MISSING_DEPENDENCIES;
  480. ERR_EXPLAIN("Can't load dependency: " + path);
  481. ERR_FAIL_V(error);
  482. }
  483. } else {
  484. resource_cache.push_back(res);
  485. }
  486. stage++;
  487. return error;
  488. }
  489. s -= external_resources.size();
  490. if (s >= internal_resources.size()) {
  491. error = ERR_BUG;
  492. ERR_FAIL_COND_V(s >= internal_resources.size(), error);
  493. }
  494. bool main = s == (internal_resources.size() - 1);
  495. //maybe it is loaded already
  496. String path;
  497. int subindex = 0;
  498. if (!main) {
  499. path = internal_resources[s].path;
  500. if (path.begins_with("local://")) {
  501. path = path.replace_first("local://", "");
  502. subindex = path.to_int();
  503. path = res_path + "::" + path;
  504. }
  505. if (ResourceCache::has(path)) {
  506. //already loaded, don't do anything
  507. stage++;
  508. error = OK;
  509. return error;
  510. }
  511. } else {
  512. if (!ResourceCache::has(res_path))
  513. path = res_path;
  514. }
  515. uint64_t offset = internal_resources[s].offset;
  516. f->seek(offset);
  517. String t = get_unicode_string();
  518. // print_line("loading resource of type "+t+" path is "+path);
  519. Object *obj = ClassDB::instance(t);
  520. if (!obj) {
  521. error = ERR_FILE_CORRUPT;
  522. ERR_EXPLAIN(local_path + ":Resource of unrecognized type in file: " + t);
  523. }
  524. ERR_FAIL_COND_V(!obj, ERR_FILE_CORRUPT);
  525. Resource *r = obj->cast_to<Resource>();
  526. if (!r) {
  527. error = ERR_FILE_CORRUPT;
  528. memdelete(obj); //bye
  529. ERR_EXPLAIN(local_path + ":Resoucre type in resource field not a resource, type is: " + obj->get_class());
  530. ERR_FAIL_COND_V(!r, ERR_FILE_CORRUPT);
  531. }
  532. RES res = RES(r);
  533. r->set_path(path);
  534. r->set_subindex(subindex);
  535. int pc = f->get_32();
  536. //set properties
  537. for (int i = 0; i < pc; i++) {
  538. StringName name = _get_string();
  539. if (name == StringName()) {
  540. error = ERR_FILE_CORRUPT;
  541. ERR_FAIL_V(ERR_FILE_CORRUPT);
  542. }
  543. Variant value;
  544. error = parse_variant(value);
  545. if (error)
  546. return error;
  547. res->set(name, value);
  548. }
  549. #ifdef TOOLS_ENABLED
  550. res->set_edited(false);
  551. #endif
  552. stage++;
  553. resource_cache.push_back(res);
  554. if (main) {
  555. f->close();
  556. resource = res;
  557. error = ERR_FILE_EOF;
  558. } else {
  559. error = OK;
  560. }
  561. return OK;
  562. }
  563. int ResourceInteractiveLoaderBinary::get_stage() const {
  564. return stage;
  565. }
  566. int ResourceInteractiveLoaderBinary::get_stage_count() const {
  567. return external_resources.size() + internal_resources.size();
  568. }
  569. static void save_ustring(FileAccess *f, const String &p_string) {
  570. CharString utf8 = p_string.utf8();
  571. f->store_32(utf8.length() + 1);
  572. f->store_buffer((const uint8_t *)utf8.get_data(), utf8.length() + 1);
  573. }
  574. static String get_ustring(FileAccess *f) {
  575. int len = f->get_32();
  576. Vector<char> str_buf;
  577. str_buf.resize(len);
  578. f->get_buffer((uint8_t *)&str_buf[0], len);
  579. String s;
  580. s.parse_utf8(&str_buf[0]);
  581. return s;
  582. }
  583. String ResourceInteractiveLoaderBinary::get_unicode_string() {
  584. int len = f->get_32();
  585. if (len > str_buf.size()) {
  586. str_buf.resize(len);
  587. }
  588. if (len == 0)
  589. return String();
  590. f->get_buffer((uint8_t *)&str_buf[0], len);
  591. String s;
  592. s.parse_utf8(&str_buf[0]);
  593. return s;
  594. }
  595. void ResourceInteractiveLoaderBinary::get_dependencies(FileAccess *p_f, List<String> *p_dependencies, bool p_add_types) {
  596. open(p_f);
  597. if (error)
  598. return;
  599. for (int i = 0; i < external_resources.size(); i++) {
  600. String dep = external_resources[i].path;
  601. if (p_add_types && external_resources[i].type != String()) {
  602. dep += "::" + external_resources[i].type;
  603. }
  604. p_dependencies->push_back(dep);
  605. }
  606. }
  607. void ResourceInteractiveLoaderBinary::open(FileAccess *p_f) {
  608. error = OK;
  609. f = p_f;
  610. uint8_t header[4];
  611. f->get_buffer(header, 4);
  612. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  613. //compressed
  614. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  615. fac->open_after_magic(f);
  616. f = fac;
  617. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  618. //not normal
  619. error = ERR_FILE_UNRECOGNIZED;
  620. ERR_EXPLAIN("Unrecognized binary resource file: " + local_path);
  621. ERR_FAIL();
  622. }
  623. bool big_endian = f->get_32();
  624. #ifdef BIG_ENDIAN_ENABLED
  625. endian_swap = !big_endian;
  626. #else
  627. bool endian_swap = big_endian;
  628. #endif
  629. bool use_real64 = f->get_32();
  630. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  631. uint32_t ver_major = f->get_32();
  632. uint32_t ver_minor = f->get_32();
  633. uint32_t ver_format = f->get_32();
  634. print_bl("big endian: " + itos(big_endian));
  635. print_bl("endian swap: " + itos(endian_swap));
  636. print_bl("real64: " + itos(use_real64));
  637. print_bl("major: " + itos(ver_major));
  638. print_bl("minor: " + itos(ver_minor));
  639. print_bl("format: " + itos(ver_format));
  640. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  641. f->close();
  642. 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);
  643. ERR_FAIL();
  644. }
  645. type = get_unicode_string();
  646. print_bl("type: " + type);
  647. importmd_ofs = f->get_64();
  648. for (int i = 0; i < 14; i++)
  649. f->get_32(); //skip a few reserved fields
  650. uint32_t string_table_size = f->get_32();
  651. string_map.resize(string_table_size);
  652. for (uint32_t i = 0; i < string_table_size; i++) {
  653. StringName s = get_unicode_string();
  654. string_map[i] = s;
  655. }
  656. print_bl("strings: " + itos(string_table_size));
  657. uint32_t ext_resources_size = f->get_32();
  658. for (uint32_t i = 0; i < ext_resources_size; i++) {
  659. ExtResoucre er;
  660. er.type = get_unicode_string();
  661. er.path = get_unicode_string();
  662. external_resources.push_back(er);
  663. }
  664. //see if the exporter has different set of external resources for more efficient loading
  665. /*
  666. String preload_depts = "deps/"+res_path.md5_text();
  667. if (Globals::get_singleton()->has(preload_depts)) {
  668. external_resources.clear();
  669. //ignore external resources and use these
  670. NodePath depts=Globals::get_singleton()->get(preload_depts);
  671. external_resources.resize(depts.get_name_count());
  672. for(int i=0;i<depts.get_name_count();i++) {
  673. external_resources[i].path=depts.get_name(i);
  674. }
  675. print_line(res_path+" - EXTERNAL RESOURCES: "+itos(external_resources.size()));
  676. }*/
  677. print_bl("ext resources: " + itos(ext_resources_size));
  678. uint32_t int_resources_size = f->get_32();
  679. for (uint32_t i = 0; i < int_resources_size; i++) {
  680. IntResoucre ir;
  681. ir.path = get_unicode_string();
  682. ir.offset = f->get_64();
  683. internal_resources.push_back(ir);
  684. }
  685. print_bl("int resources: " + itos(int_resources_size));
  686. if (f->eof_reached()) {
  687. error = ERR_FILE_CORRUPT;
  688. ERR_EXPLAIN("Premature End Of File: " + local_path);
  689. ERR_FAIL();
  690. }
  691. }
  692. String ResourceInteractiveLoaderBinary::recognize(FileAccess *p_f) {
  693. error = OK;
  694. f = p_f;
  695. uint8_t header[4];
  696. f->get_buffer(header, 4);
  697. if (header[0] == 'R' && header[1] == 'S' && header[2] == 'C' && header[3] == 'C') {
  698. //compressed
  699. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  700. fac->open_after_magic(f);
  701. f = fac;
  702. } else if (header[0] != 'R' || header[1] != 'S' || header[2] != 'R' || header[3] != 'C') {
  703. //not normal
  704. error = ERR_FILE_UNRECOGNIZED;
  705. return "";
  706. }
  707. bool big_endian = f->get_32();
  708. #ifdef BIG_ENDIAN_ENABLED
  709. endian_swap = !big_endian;
  710. #else
  711. bool endian_swap = big_endian;
  712. #endif
  713. bool use_real64 = f->get_32();
  714. f->set_endian_swap(big_endian != 0); //read big endian if saved as big endian
  715. uint32_t ver_major = f->get_32();
  716. uint32_t ver_minor = f->get_32();
  717. uint32_t ver_format = f->get_32();
  718. if (ver_format > FORMAT_VERSION || ver_major > VERSION_MAJOR) {
  719. f->close();
  720. return "";
  721. }
  722. String type = get_unicode_string();
  723. return type;
  724. }
  725. ResourceInteractiveLoaderBinary::ResourceInteractiveLoaderBinary() {
  726. f = NULL;
  727. stage = 0;
  728. endian_swap = false;
  729. use_real64 = false;
  730. error = OK;
  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.pos.x);
  1008. f->store_real(val.pos.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_AABB);
  1037. Rect3 val = p_property;
  1038. f->store_real(val.pos.x);
  1039. f->store_real(val.pos.y);
  1040. f->store_real(val.pos.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::INPUT_EVENT: {
  1134. f->store_32(VARIANT_INPUT_EVENT);
  1135. InputEvent event = p_property;
  1136. f->store_32(0); //event type none, nothing else suported for now.
  1137. } break;
  1138. case Variant::DICTIONARY: {
  1139. f->store_32(VARIANT_DICTIONARY);
  1140. Dictionary d = p_property;
  1141. f->store_32(uint32_t(d.size()));
  1142. List<Variant> keys;
  1143. d.get_key_list(&keys);
  1144. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  1145. /*
  1146. if (!_check_type(dict[E->get()]))
  1147. continue;
  1148. */
  1149. write_variant(E->get());
  1150. write_variant(d[E->get()]);
  1151. }
  1152. } break;
  1153. case Variant::ARRAY: {
  1154. f->store_32(VARIANT_ARRAY);
  1155. Array a = p_property;
  1156. f->store_32(uint32_t(a.size()));
  1157. for (int i = 0; i < a.size(); i++) {
  1158. write_variant(a[i]);
  1159. }
  1160. } break;
  1161. case Variant::POOL_BYTE_ARRAY: {
  1162. f->store_32(VARIANT_RAW_ARRAY);
  1163. PoolVector<uint8_t> arr = p_property;
  1164. int len = arr.size();
  1165. f->store_32(len);
  1166. PoolVector<uint8_t>::Read r = arr.read();
  1167. f->store_buffer(r.ptr(), len);
  1168. _pad_buffer(len);
  1169. } break;
  1170. case Variant::POOL_INT_ARRAY: {
  1171. f->store_32(VARIANT_INT_ARRAY);
  1172. PoolVector<int> arr = p_property;
  1173. int len = arr.size();
  1174. f->store_32(len);
  1175. PoolVector<int>::Read r = arr.read();
  1176. for (int i = 0; i < len; i++)
  1177. f->store_32(r[i]);
  1178. } break;
  1179. case Variant::POOL_REAL_ARRAY: {
  1180. f->store_32(VARIANT_REAL_ARRAY);
  1181. PoolVector<real_t> arr = p_property;
  1182. int len = arr.size();
  1183. f->store_32(len);
  1184. PoolVector<real_t>::Read r = arr.read();
  1185. for (int i = 0; i < len; i++) {
  1186. f->store_real(r[i]);
  1187. }
  1188. } break;
  1189. case Variant::POOL_STRING_ARRAY: {
  1190. f->store_32(VARIANT_STRING_ARRAY);
  1191. PoolVector<String> arr = p_property;
  1192. int len = arr.size();
  1193. f->store_32(len);
  1194. PoolVector<String>::Read r = arr.read();
  1195. for (int i = 0; i < len; i++) {
  1196. save_unicode_string(r[i]);
  1197. }
  1198. } break;
  1199. case Variant::POOL_VECTOR3_ARRAY: {
  1200. f->store_32(VARIANT_VECTOR3_ARRAY);
  1201. PoolVector<Vector3> arr = p_property;
  1202. int len = arr.size();
  1203. f->store_32(len);
  1204. PoolVector<Vector3>::Read r = arr.read();
  1205. for (int i = 0; i < len; i++) {
  1206. f->store_real(r[i].x);
  1207. f->store_real(r[i].y);
  1208. f->store_real(r[i].z);
  1209. }
  1210. } break;
  1211. case Variant::POOL_VECTOR2_ARRAY: {
  1212. f->store_32(VARIANT_VECTOR2_ARRAY);
  1213. PoolVector<Vector2> arr = p_property;
  1214. int len = arr.size();
  1215. f->store_32(len);
  1216. PoolVector<Vector2>::Read r = arr.read();
  1217. for (int i = 0; i < len; i++) {
  1218. f->store_real(r[i].x);
  1219. f->store_real(r[i].y);
  1220. }
  1221. } break;
  1222. case Variant::POOL_COLOR_ARRAY: {
  1223. f->store_32(VARIANT_COLOR_ARRAY);
  1224. PoolVector<Color> arr = p_property;
  1225. int len = arr.size();
  1226. f->store_32(len);
  1227. PoolVector<Color>::Read r = arr.read();
  1228. for (int i = 0; i < len; i++) {
  1229. f->store_real(r[i].r);
  1230. f->store_real(r[i].g);
  1231. f->store_real(r[i].b);
  1232. f->store_real(r[i].a);
  1233. }
  1234. } break;
  1235. default: {
  1236. ERR_EXPLAIN("Invalid variant");
  1237. ERR_FAIL();
  1238. }
  1239. }
  1240. }
  1241. void ResourceFormatSaverBinaryInstance::_find_resources(const Variant &p_variant, bool p_main) {
  1242. switch (p_variant.get_type()) {
  1243. case Variant::OBJECT: {
  1244. RES res = p_variant.operator RefPtr();
  1245. if (res.is_null() || external_resources.has(res))
  1246. return;
  1247. if (!p_main && (!bundle_resources) && res->get_path().length() && res->get_path().find("::") == -1) {
  1248. int idx = external_resources.size();
  1249. external_resources[res] = idx;
  1250. return;
  1251. }
  1252. if (resource_set.has(res))
  1253. return;
  1254. List<PropertyInfo> property_list;
  1255. res->get_property_list(&property_list);
  1256. for (List<PropertyInfo>::Element *E = property_list.front(); E; E = E->next()) {
  1257. if (E->get().usage & PROPERTY_USAGE_STORAGE) {
  1258. _find_resources(res->get(E->get().name));
  1259. }
  1260. }
  1261. resource_set.insert(res);
  1262. saved_resources.push_back(res);
  1263. } break;
  1264. case Variant::ARRAY: {
  1265. Array varray = p_variant;
  1266. int len = varray.size();
  1267. for (int i = 0; i < len; i++) {
  1268. Variant v = varray.get(i);
  1269. _find_resources(v);
  1270. }
  1271. } break;
  1272. case Variant::DICTIONARY: {
  1273. Dictionary d = p_variant;
  1274. List<Variant> keys;
  1275. d.get_key_list(&keys);
  1276. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  1277. _find_resources(E->get());
  1278. Variant v = d[E->get()];
  1279. _find_resources(v);
  1280. }
  1281. } break;
  1282. case Variant::NODE_PATH: {
  1283. //take the chance and save node path strings
  1284. NodePath np = p_variant;
  1285. for (int i = 0; i < np.get_name_count(); i++)
  1286. get_string_index(np.get_name(i));
  1287. for (int i = 0; i < np.get_subname_count(); i++)
  1288. get_string_index(np.get_subname(i));
  1289. get_string_index(np.get_property());
  1290. } break;
  1291. default: {}
  1292. }
  1293. }
  1294. #if 0
  1295. Error ResourceFormatSaverBinary::_save_obj(const Object *p_object,SavedObject *so) {
  1296. //use classic way
  1297. List<PropertyInfo> property_list;
  1298. p_object->get_property_list( &property_list );
  1299. for(List<PropertyInfo>::Element *E=property_list.front();E;E=E->next()) {
  1300. if (skip_editor && E->get().name.begins_with("__editor"))
  1301. continue;
  1302. if (E->get().usage&PROPERTY_USAGE_STORAGE || (bundle_resources && E->get().usage&PROPERTY_USAGE_BUNDLE)) {
  1303. SavedObject::SavedProperty sp;
  1304. sp.name_idx=get_string_index(E->get().name);
  1305. sp.value = p_object->get(E->get().name);
  1306. _find_resources(sp.value);
  1307. so->properties.push_back(sp);
  1308. }
  1309. }
  1310. return OK;
  1311. }
  1312. Error ResourceFormatSaverBinary::save(const Object *p_object,const Variant &p_meta) {
  1313. ERR_FAIL_COND_V(!f,ERR_UNCONFIGURED);
  1314. ERR_EXPLAIN("write_object should supply either an object, a meta, or both");
  1315. ERR_FAIL_COND_V(!p_object && p_meta.get_type()==Variant::NIL, ERR_INVALID_PARAMETER);
  1316. SavedObject *so = memnew( SavedObject );
  1317. if (p_object)
  1318. so->type=p_object->get_type();
  1319. _find_resources(p_meta);
  1320. so->meta=p_meta;
  1321. Error err = _save_obj(p_object,so);
  1322. ERR_FAIL_COND_V( err, ERR_INVALID_DATA );
  1323. saved_objects.push_back(so);
  1324. return OK;
  1325. }
  1326. #endif
  1327. void ResourceFormatSaverBinaryInstance::save_unicode_string(const String &p_string) {
  1328. CharString utf8 = p_string.utf8();
  1329. f->store_32(utf8.length() + 1);
  1330. f->store_buffer((const uint8_t *)utf8.get_data(), utf8.length() + 1);
  1331. }
  1332. int ResourceFormatSaverBinaryInstance::get_string_index(const String &p_string) {
  1333. StringName s = p_string;
  1334. if (string_map.has(s))
  1335. return string_map[s];
  1336. string_map[s] = strings.size();
  1337. strings.push_back(s);
  1338. return strings.size() - 1;
  1339. }
  1340. Error ResourceFormatSaverBinaryInstance::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  1341. Error err;
  1342. if (p_flags & ResourceSaver::FLAG_COMPRESS) {
  1343. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  1344. fac->configure("RSCC");
  1345. f = fac;
  1346. err = fac->_open(p_path, FileAccess::WRITE);
  1347. if (err)
  1348. memdelete(f);
  1349. } else {
  1350. f = FileAccess::open(p_path, FileAccess::WRITE, &err);
  1351. }
  1352. ERR_FAIL_COND_V(err, err);
  1353. FileAccessRef _fref(f);
  1354. relative_paths = p_flags & ResourceSaver::FLAG_RELATIVE_PATHS;
  1355. skip_editor = p_flags & ResourceSaver::FLAG_OMIT_EDITOR_PROPERTIES;
  1356. bundle_resources = p_flags & ResourceSaver::FLAG_BUNDLE_RESOURCES;
  1357. big_endian = p_flags & ResourceSaver::FLAG_SAVE_BIG_ENDIAN;
  1358. takeover_paths = p_flags & ResourceSaver::FLAG_REPLACE_SUBRESOURCE_PATHS;
  1359. if (!p_path.begins_with("res://"))
  1360. takeover_paths = false;
  1361. local_path = p_path.get_base_dir();
  1362. //bin_meta_idx = get_string_index("__bin_meta__"); //is often used, so create
  1363. _find_resources(p_resource, true);
  1364. if (!(p_flags & ResourceSaver::FLAG_COMPRESS)) {
  1365. //save header compressed
  1366. static const uint8_t header[4] = { 'R', 'S', 'R', 'C' };
  1367. f->store_buffer(header, 4);
  1368. }
  1369. if (big_endian) {
  1370. f->store_32(1);
  1371. f->set_endian_swap(true);
  1372. } else
  1373. f->store_32(0);
  1374. f->store_32(0); //64 bits file, false for now
  1375. f->store_32(VERSION_MAJOR);
  1376. f->store_32(VERSION_MINOR);
  1377. f->store_32(FORMAT_VERSION);
  1378. if (f->get_error() != OK && f->get_error() != ERR_FILE_EOF) {
  1379. f->close();
  1380. return ERR_CANT_CREATE;
  1381. }
  1382. //f->store_32(saved_resources.size()+external_resources.size()); // load steps -not needed
  1383. save_unicode_string(p_resource->get_class());
  1384. uint64_t md_at = f->get_pos();
  1385. f->store_64(0); //offset to impoty metadata
  1386. for (int i = 0; i < 14; i++)
  1387. f->store_32(0); // reserved
  1388. List<ResourceData> resources;
  1389. {
  1390. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1391. ResourceData &rd = resources.push_back(ResourceData())->get();
  1392. rd.type = E->get()->get_class();
  1393. List<PropertyInfo> property_list;
  1394. E->get()->get_property_list(&property_list);
  1395. for (List<PropertyInfo>::Element *F = property_list.front(); F; F = F->next()) {
  1396. if (skip_editor && F->get().name.begins_with("__editor"))
  1397. continue;
  1398. if (F->get().usage & PROPERTY_USAGE_STORAGE) {
  1399. Property p;
  1400. p.name_idx = get_string_index(F->get().name);
  1401. p.value = E->get()->get(F->get().name);
  1402. 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()))
  1403. continue;
  1404. p.pi = F->get();
  1405. rd.properties.push_back(p);
  1406. }
  1407. }
  1408. }
  1409. }
  1410. f->store_32(strings.size()); //string table size
  1411. for (int i = 0; i < strings.size(); i++) {
  1412. //print_bl("saving string: "+strings[i]);
  1413. save_unicode_string(strings[i]);
  1414. }
  1415. // save external resource table
  1416. f->store_32(external_resources.size()); //amount of external resources
  1417. Vector<RES> save_order;
  1418. save_order.resize(external_resources.size());
  1419. for (Map<RES, int>::Element *E = external_resources.front(); E; E = E->next()) {
  1420. save_order[E->get()] = E->key();
  1421. }
  1422. for (int i = 0; i < save_order.size(); i++) {
  1423. save_unicode_string(save_order[i]->get_save_class());
  1424. String path = save_order[i]->get_path();
  1425. path = relative_paths ? local_path.path_to_file(path) : path;
  1426. save_unicode_string(path);
  1427. }
  1428. // save internal resource table
  1429. f->store_32(saved_resources.size()); //amount of internal resources
  1430. Vector<uint64_t> ofs_pos;
  1431. Set<int> used_indices;
  1432. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1433. RES r = E->get();
  1434. if (r->get_path() == "" || r->get_path().find("::") != -1) {
  1435. if (r->get_subindex() != 0) {
  1436. if (used_indices.has(r->get_subindex())) {
  1437. r->set_subindex(0); //repeated
  1438. } else {
  1439. used_indices.insert(r->get_subindex());
  1440. }
  1441. }
  1442. }
  1443. }
  1444. for (List<RES>::Element *E = saved_resources.front(); E; E = E->next()) {
  1445. RES r = E->get();
  1446. if (r->get_path() == "" || r->get_path().find("::") != -1) {
  1447. if (r->get_subindex() == 0) {
  1448. int new_subindex = 1;
  1449. if (used_indices.size()) {
  1450. new_subindex = used_indices.back()->get() + 1;
  1451. }
  1452. r->set_subindex(new_subindex);
  1453. used_indices.insert(new_subindex);
  1454. }
  1455. save_unicode_string("local://" + itos(r->get_subindex()));
  1456. if (takeover_paths) {
  1457. r->set_path(p_path + "::" + itos(r->get_subindex()), true);
  1458. }
  1459. #ifdef TOOLS_ENABLED
  1460. r->set_edited(false);
  1461. #endif
  1462. } else {
  1463. save_unicode_string(r->get_path()); //actual external
  1464. }
  1465. ofs_pos.push_back(f->get_pos());
  1466. f->store_64(0); //offset in 64 bits
  1467. }
  1468. Vector<uint64_t> ofs_table;
  1469. //int saved_idx=0;
  1470. //now actually save the resources
  1471. for (List<ResourceData>::Element *E = resources.front(); E; E = E->next()) {
  1472. ResourceData &rd = E->get();
  1473. ofs_table.push_back(f->get_pos());
  1474. save_unicode_string(rd.type);
  1475. f->store_32(rd.properties.size());
  1476. for (List<Property>::Element *F = rd.properties.front(); F; F = F->next()) {
  1477. Property &p = F->get();
  1478. f->store_32(p.name_idx);
  1479. write_variant(p.value, F->get().pi);
  1480. }
  1481. }
  1482. for (int i = 0; i < ofs_table.size(); i++) {
  1483. f->seek(ofs_pos[i]);
  1484. f->store_64(ofs_table[i]);
  1485. }
  1486. f->seek_end();
  1487. f->store_buffer((const uint8_t *)"RSRC", 4); //magic at end
  1488. if (f->get_error() != OK && f->get_error() != ERR_FILE_EOF) {
  1489. f->close();
  1490. return ERR_CANT_CREATE;
  1491. }
  1492. f->close();
  1493. return OK;
  1494. }
  1495. Error ResourceFormatSaverBinary::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  1496. String local_path = GlobalConfig::get_singleton()->localize_path(p_path);
  1497. ResourceFormatSaverBinaryInstance saver;
  1498. return saver.save(local_path, p_resource, p_flags);
  1499. }
  1500. bool ResourceFormatSaverBinary::recognize(const RES &p_resource) const {
  1501. return true; //all recognized
  1502. }
  1503. void ResourceFormatSaverBinary::get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const {
  1504. String base = p_resource->get_base_extension().to_lower();
  1505. p_extensions->push_back(base);
  1506. if (base != "res")
  1507. p_extensions->push_back("res");
  1508. }
  1509. ResourceFormatSaverBinary *ResourceFormatSaverBinary::singleton = NULL;
  1510. ResourceFormatSaverBinary::ResourceFormatSaverBinary() {
  1511. singleton = this;
  1512. }