resource_format_binary.cpp 49 KB

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