resource_format_binary.cpp 47 KB

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