2 * ***** BEGIN GPL LICENSE BLOCK *****
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19 * All rights reserved.
22 * Contributor(s): Blender Foundation
24 * ***** END GPL LICENSE BLOCK *****
28 /** \file blender/blenloader/intern/readfile.c
36 #include <stdio.h> // for printf fopen fwrite fclose sprintf FILE
37 #include <stdlib.h> // for getenv atoi
38 #include <stddef.h> // for offsetof
39 #include <fcntl.h> // for open
40 #include <string.h> // for strrchr strncmp strstr
41 #include <math.h> // for fabs
42 #include <stdarg.h> /* for va_start/end */
43 #include <time.h> /* for gmtime */
44 #include <ctype.h> /* for isdigit */
46 #include "BLI_utildefines.h"
48 # include <unistd.h> // for read close
50 # include <io.h> // for open close read
51 # include "winsock2.h"
52 # include "BLI_winstuff.h"
55 /* allow readfile to use deprecated functionality */
56 #define DNA_DEPRECATED_ALLOW
57 /* Allow using DNA struct members that are marked as private for read/write.
58 * Note: Each header that uses this needs to define its own way of handling
59 * it. There's no generic implementation, direct use does nothing. */
60 #define DNA_PRIVATE_READ_WRITE_ALLOW
62 #include "DNA_anim_types.h"
63 #include "DNA_armature_types.h"
64 #include "DNA_brush_types.h"
65 #include "DNA_camera_types.h"
66 #include "DNA_cachefile_types.h"
67 #include "DNA_cloth_types.h"
68 #include "DNA_constraint_types.h"
69 #include "DNA_dynamicpaint_types.h"
70 #include "DNA_effect_types.h"
71 #include "DNA_fileglobal_types.h"
72 #include "DNA_genfile.h"
73 #include "DNA_group_types.h"
74 #include "DNA_gpencil_types.h"
75 #include "DNA_ipo_types.h"
76 #include "DNA_key_types.h"
77 #include "DNA_lattice_types.h"
78 #include "DNA_layer_types.h"
79 #include "DNA_lamp_types.h"
80 #include "DNA_linestyle_types.h"
81 #include "DNA_meta_types.h"
82 #include "DNA_material_types.h"
83 #include "DNA_mesh_types.h"
84 #include "DNA_meshdata_types.h"
85 #include "DNA_nla_types.h"
86 #include "DNA_node_types.h"
87 #include "DNA_object_fluidsim_types.h"
88 #include "DNA_object_types.h"
89 #include "DNA_packedFile_types.h"
90 #include "DNA_particle_types.h"
91 #include "DNA_lightprobe_types.h"
92 #include "DNA_rigidbody_types.h"
93 #include "DNA_text_types.h"
94 #include "DNA_view3d_types.h"
95 #include "DNA_screen_types.h"
96 #include "DNA_sdna_types.h"
97 #include "DNA_scene_types.h"
98 #include "DNA_sequence_types.h"
99 #include "DNA_smoke_types.h"
100 #include "DNA_speaker_types.h"
101 #include "DNA_sound_types.h"
102 #include "DNA_space_types.h"
103 #include "DNA_vfont_types.h"
104 #include "DNA_workspace_types.h"
105 #include "DNA_world_types.h"
106 #include "DNA_movieclip_types.h"
107 #include "DNA_mask_types.h"
109 #include "RNA_access.h"
111 #include "MEM_guardedalloc.h"
113 #include "BLI_endian_switch.h"
114 #include "BLI_blenlib.h"
115 #include "BLI_math.h"
116 #include "BLI_threads.h"
117 #include "BLI_mempool.h"
119 #include "BLT_translation.h"
121 #include "BKE_action.h"
122 #include "BKE_armature.h"
123 #include "BKE_brush.h"
124 #include "BKE_cachefile.h"
125 #include "BKE_cloth.h"
126 #include "BKE_constraint.h"
127 #include "BKE_context.h"
128 #include "BKE_curve.h"
129 #include "BKE_effect.h"
130 #include "BKE_fcurve.h"
131 #include "BKE_global.h" // for G
132 #include "BKE_group.h"
133 #include "BKE_layer.h"
134 #include "BKE_library.h" // for which_libbase
135 #include "BKE_library_idmap.h"
136 #include "BKE_library_override.h"
137 #include "BKE_library_query.h"
138 #include "BKE_idcode.h"
139 #include "BKE_idprop.h"
140 #include "BKE_material.h"
141 #include "BKE_main.h" // for Main
142 #include "BKE_mesh.h" // for ME_ defines (patching)
143 #include "BKE_modifier.h"
144 #include "BKE_multires.h"
145 #include "BKE_node.h" // for tree type defines
146 #include "BKE_object.h"
147 #include "BKE_paint.h"
148 #include "BKE_particle.h"
149 #include "BKE_pointcache.h"
150 #include "BKE_report.h"
151 #include "BKE_scene.h"
152 #include "BKE_screen.h"
153 #include "BKE_sequencer.h"
154 #include "BKE_outliner_treehash.h"
155 #include "BKE_sound.h"
156 #include "BKE_colortools.h"
157 #include "BKE_workspace.h"
159 #include "DEG_depsgraph.h"
161 #include "NOD_common.h"
162 #include "NOD_socket.h"
164 #include "BLO_readfile.h"
165 #include "BLO_undofile.h"
166 #include "BLO_blend_defs.h"
168 #include "RE_engine.h"
170 #include "readfile.h"
179 * - Existing Library (#Main) push or free
180 * - allocate new #Main
183 * - for each LibBlock
187 * - attach ID's to it
189 * - read associated 'direct data'
190 * - link direct data (internal and to LibBlock)
192 * - read #USER data, only when indicated (file is ``~/X.XX/startup.blend``)
194 * - per Library (per #Main)
197 * - find LibBlocks and attach #ID's to #Main
198 * - if external LibBlock
199 * - search all #Main's
200 * - or it's already read,
202 * - or make new #Main
205 * - read associated direct data
206 * - link direct data (internal and to LibBlock)
208 * - per Library with unread LibBlocks
213 * - read associated direct data
214 * - link direct data (internal and to LibBlock)
217 * - link all LibBlocks and indirect pointers to libblocks
218 * - initialize #FileGlobal and copy pointers to #Global
220 * \note Still a weak point is the new-address function, that doesnt solve reading from
221 * multiple files at the same time.
222 * (added remark: oh, i thought that was solved? will look at that... (ton).
225 /* use GHash for BHead name-based lookups (speeds up linking) */
226 #define USE_GHASH_BHEAD
228 /* Use GHash for restoring pointers by name */
229 #define USE_GHASH_RESTORE_POINTER
231 /* Define this to have verbose debug prints. */
232 #define USE_DEBUG_PRINT
234 #ifdef USE_DEBUG_PRINT
235 # define DEBUG_PRINTF(...) printf(__VA_ARGS__)
237 # define DEBUG_PRINTF(...)
242 typedef struct OldNew {
248 typedef struct OldNewMap {
250 int nentries, entriessize;
256 /* local prototypes */
257 static void *read_struct(FileData *fd, BHead *bh, const char *blockname);
258 static void direct_link_modifiers(FileData *fd, ListBase *lb);
259 static BHead *find_bhead_from_code_name(FileData *fd, const short idcode, const char *name);
260 static BHead *find_bhead_from_idname(FileData *fd, const char *idname);
261 static void expand_scene_collection(FileData *fd, Main *mainvar, SceneCollection *sc);
262 static SceneCollection *get_scene_collection_active_or_create(
263 struct Scene *scene, struct ViewLayer *view_layer, const int flag);
265 /* this function ensures that reports are printed,
266 * in the case of libraray linking errors this is important!
268 * bit kludge but better then doubling up on prints,
269 * we could alternatively have a versions of a report function which forces printing - campbell
272 void blo_reportf_wrap(ReportList *reports, ReportType type, const char *format, ...)
274 char fixed_buf[1024]; /* should be long enough */
278 va_start(args, format);
279 vsnprintf(fixed_buf, sizeof(fixed_buf), format, args);
282 fixed_buf[sizeof(fixed_buf) - 1] = '\0';
284 BKE_report(reports, type, fixed_buf);
286 if (G.background == 0) {
287 printf("%s: %s\n", BKE_report_type_str(type), fixed_buf);
291 /* for reporting linking messages */
292 static const char *library_parent_filepath(Library *lib)
294 return lib->parent ? lib->parent->filepath : "<direct>";
297 static OldNewMap *oldnewmap_new(void)
299 OldNewMap *onm= MEM_callocN(sizeof(*onm), "OldNewMap");
301 onm->entriessize = 1024;
302 onm->entries = MEM_malloc_arrayN(onm->entriessize, sizeof(*onm->entries), "OldNewMap.entries");
307 static int verg_oldnewmap(const void *v1, const void *v2)
309 const struct OldNew *x1=v1, *x2=v2;
311 if (x1->old > x2->old) return 1;
312 else if (x1->old < x2->old) return -1;
317 static void oldnewmap_sort(FileData *fd)
319 BLI_assert(fd->libmap->sorted == false);
320 qsort(fd->libmap->entries, fd->libmap->nentries, sizeof(OldNew), verg_oldnewmap);
321 fd->libmap->sorted = 1;
324 /* nr is zero for data, and ID code for libdata */
325 static void oldnewmap_insert(OldNewMap *onm, const void *oldaddr, void *newaddr, int nr)
329 if (oldaddr==NULL || newaddr==NULL) return;
331 if (UNLIKELY(onm->nentries == onm->entriessize)) {
332 onm->entriessize *= 2;
333 onm->entries = MEM_reallocN(onm->entries, sizeof(*onm->entries) * onm->entriessize);
336 entry = &onm->entries[onm->nentries++];
337 entry->old = oldaddr;
338 entry->newp = newaddr;
342 void blo_do_versions_oldnewmap_insert(OldNewMap *onm, const void *oldaddr, void *newaddr, int nr)
344 oldnewmap_insert(onm, oldaddr, newaddr, nr);
348 * Do a full search (no state).
350 * \param lasthit: Use as a reference position to avoid a full search
351 * from either end of the array, giving more efficient lookups.
353 * \note This would seem an ideal case for hash or btree lookups.
354 * However the data is written in-order, using the \a lasthit will normally avoid calling this function.
355 * Creating a btree/hash structure adds overhead for the common-case to optimize the corner-case
356 * (since most entries will never be retrieved).
357 * So just keep full lookups as a fall-back.
359 static int oldnewmap_lookup_entry_full(const OldNewMap *onm, const void *addr, int lasthit)
361 const int nentries = onm->nentries;
362 const OldNew *entries = onm->entries;
365 /* search relative to lasthit where possible */
366 if (lasthit >= 0 && lasthit < nentries) {
368 /* search forwards */
370 while (++i != nentries) {
371 if (entries[i].old == addr) {
376 /* search backwards */
379 if (entries[i].old == addr) {
385 /* search backwards (full) */
388 if (entries[i].old == addr) {
397 static void *oldnewmap_lookup_and_inc(OldNewMap *onm, const void *addr, bool increase_users)
401 if (addr == NULL) return NULL;
403 if (onm->lasthit < onm->nentries-1) {
404 OldNew *entry = &onm->entries[++onm->lasthit];
406 if (entry->old == addr) {
413 i = oldnewmap_lookup_entry_full(onm, addr, onm->lasthit);
415 OldNew *entry = &onm->entries[i];
416 BLI_assert(entry->old == addr);
426 /* for libdata, nr has ID code, no increment */
427 static void *oldnewmap_liblookup(OldNewMap *onm, const void *addr, const void *lib)
433 /* lasthit works fine for non-libdata, linking there is done in same sequence as writing */
435 const OldNew entry_s = {.old = addr};
436 OldNew *entry = bsearch(&entry_s, onm->entries, onm->nentries, sizeof(OldNew), verg_oldnewmap);
438 ID *id = entry->newp;
440 if (id && (!lib || id->lib)) {
446 /* note, this can be a bottle neck when loading some files */
447 const int i = oldnewmap_lookup_entry_full(onm, addr, -1);
449 OldNew *entry = &onm->entries[i];
450 ID *id = entry->newp;
451 BLI_assert(entry->old == addr);
452 if (id && (!lib || id->lib)) {
461 static void oldnewmap_free_unused(OldNewMap *onm)
465 for (i = 0; i < onm->nentries; i++) {
466 OldNew *entry = &onm->entries[i];
467 if (entry->nr == 0) {
468 MEM_freeN(entry->newp);
474 static void oldnewmap_clear(OldNewMap *onm)
480 static void oldnewmap_free(OldNewMap *onm)
482 MEM_freeN(onm->entries);
488 static void read_libraries(FileData *basefd, ListBase *mainlist);
490 /* ************ help functions ***************** */
492 static void add_main_to_main(Main *mainvar, Main *from)
494 ListBase *lbarray[MAX_LIBARRAY], *fromarray[MAX_LIBARRAY];
497 set_listbasepointers(mainvar, lbarray);
498 a = set_listbasepointers(from, fromarray);
500 BLI_movelisttolist(lbarray[a], fromarray[a]);
504 void blo_join_main(ListBase *mainlist)
506 Main *tojoin, *mainl;
508 mainl = mainlist->first;
509 while ((tojoin = mainl->next)) {
510 add_main_to_main(mainl, tojoin);
511 BLI_remlink(mainlist, tojoin);
512 BKE_main_free(tojoin);
516 static void split_libdata(ListBase *lb_src, Main **lib_main_array, const unsigned int lib_main_array_len)
518 for (ID *id = lb_src->first, *idnext; id; id = idnext) {
522 if (((unsigned int)id->lib->temp_index < lib_main_array_len) &&
523 /* this check should never fail, just incase 'id->lib' is a dangling pointer. */
524 (lib_main_array[id->lib->temp_index]->curlib == id->lib))
526 Main *mainvar = lib_main_array[id->lib->temp_index];
527 ListBase *lb_dst = which_libbase(mainvar, GS(id->name));
528 BLI_remlink(lb_src, id);
529 BLI_addtail(lb_dst, id);
532 printf("%s: invalid library for '%s'\n", __func__, id->name);
539 void blo_split_main(ListBase *mainlist, Main *main)
541 mainlist->first = mainlist->last = main;
544 if (BLI_listbase_is_empty(&main->library))
547 /* (Library.temp_index -> Main), lookup table */
548 const unsigned int lib_main_array_len = BLI_listbase_count(&main->library);
549 Main **lib_main_array = MEM_malloc_arrayN(lib_main_array_len, sizeof(*lib_main_array), __func__);
552 for (Library *lib = main->library.first; lib; lib = lib->id.next, i++) {
553 Main *libmain = BKE_main_new();
554 libmain->curlib = lib;
555 libmain->versionfile = lib->versionfile;
556 libmain->subversionfile = lib->subversionfile;
557 BLI_addtail(mainlist, libmain);
559 lib_main_array[i] = libmain;
562 ListBase *lbarray[MAX_LIBARRAY];
563 i = set_listbasepointers(main, lbarray);
565 ID *id = lbarray[i]->first;
566 if (id == NULL || GS(id->name) == ID_LI) {
567 continue; /* no ID_LI datablock should ever be linked anyway, but just in case, better be explicit. */
569 split_libdata(lbarray[i], lib_main_array, lib_main_array_len);
572 MEM_freeN(lib_main_array);
575 static void read_file_version(FileData *fd, Main *main)
579 for (bhead= blo_firstbhead(fd); bhead; bhead= blo_nextbhead(fd, bhead)) {
580 if (bhead->code == GLOB) {
581 FileGlobal *fg= read_struct(fd, bhead, "Global");
583 main->subversionfile= fg->subversion;
584 main->minversionfile= fg->minversion;
585 main->minsubversionfile= fg->minsubversion;
588 else if (bhead->code == ENDB)
593 main->curlib->versionfile = main->versionfile;
594 main->curlib->subversionfile = main->subversionfile;
598 #ifdef USE_GHASH_BHEAD
599 static void read_file_bhead_idname_map_create(FileData *fd)
604 bool is_link = false;
605 int code_prev = ENDB;
606 unsigned int reserve = 0;
608 for (bhead = blo_firstbhead(fd); bhead; bhead = blo_nextbhead(fd, bhead)) {
609 if (code_prev != bhead->code) {
610 code_prev = bhead->code;
611 is_link = BKE_idcode_is_valid(code_prev) ? BKE_idcode_is_linkable(code_prev) : false;
619 BLI_assert(fd->bhead_idname_hash == NULL);
621 fd->bhead_idname_hash = BLI_ghash_str_new_ex(__func__, reserve);
623 for (bhead = blo_firstbhead(fd); bhead; bhead = blo_nextbhead(fd, bhead)) {
624 if (code_prev != bhead->code) {
625 code_prev = bhead->code;
626 is_link = BKE_idcode_is_valid(code_prev) ? BKE_idcode_is_linkable(code_prev) : false;
630 BLI_ghash_insert(fd->bhead_idname_hash, (void *)bhead_id_name(fd, bhead), bhead);
637 static Main *blo_find_main(FileData *fd, const char *filepath, const char *relabase)
639 ListBase *mainlist = fd->mainlist;
642 char name1[FILE_MAX];
644 BLI_strncpy(name1, filepath, sizeof(name1));
645 BLI_cleanup_path(relabase, name1);
647 // printf("blo_find_main: relabase %s\n", relabase);
648 // printf("blo_find_main: original in %s\n", filepath);
649 // printf("blo_find_main: converted to %s\n", name1);
651 for (m = mainlist->first; m; m = m->next) {
652 const char *libname = (m->curlib) ? m->curlib->filepath : m->name;
654 if (BLI_path_cmp(name1, libname) == 0) {
655 if (G.debug & G_DEBUG) printf("blo_find_main: found library %s\n", libname);
661 BLI_addtail(mainlist, m);
663 /* Add library datablock itself to 'main' Main, since libraries are **never** linked data.
664 * Fixes bug where you could end with all ID_LI datablocks having the same name... */
665 lib = BKE_libblock_alloc(mainlist->first, ID_LI, "Lib", 0);
666 lib->id.us = ID_FAKE_USERS(lib); /* Important, consistency with main ID reading code from read_libblock(). */
667 BLI_strncpy(lib->name, filepath, sizeof(lib->name));
668 BLI_strncpy(lib->filepath, name1, sizeof(lib->filepath));
672 read_file_version(fd, m);
674 if (G.debug & G_DEBUG) printf("blo_find_main: added new lib %s\n", filepath);
679 /* ************ FILE PARSING ****************** */
681 static void switch_endian_bh4(BHead4 *bhead)
683 /* the ID_.. codes */
684 if ((bhead->code & 0xFFFF)==0) bhead->code >>= 16;
686 if (bhead->code != ENDB) {
687 BLI_endian_switch_int32(&bhead->len);
688 BLI_endian_switch_int32(&bhead->SDNAnr);
689 BLI_endian_switch_int32(&bhead->nr);
693 static void switch_endian_bh8(BHead8 *bhead)
695 /* the ID_.. codes */
696 if ((bhead->code & 0xFFFF)==0) bhead->code >>= 16;
698 if (bhead->code != ENDB) {
699 BLI_endian_switch_int32(&bhead->len);
700 BLI_endian_switch_int32(&bhead->SDNAnr);
701 BLI_endian_switch_int32(&bhead->nr);
705 static void bh4_from_bh8(BHead *bhead, BHead8 *bhead8, int do_endian_swap)
707 BHead4 *bhead4 = (BHead4 *) bhead;
710 bhead4->code = bhead8->code;
711 bhead4->len = bhead8->len;
713 if (bhead4->code != ENDB) {
714 /* perform a endian swap on 64bit pointers, otherwise the pointer might map to zero
715 * 0x0000000000000000000012345678 would become 0x12345678000000000000000000000000
717 if (do_endian_swap) {
718 BLI_endian_switch_int64(&bhead8->old);
721 /* this patch is to avoid a long long being read from not-eight aligned positions
722 * is necessary on any modern 64bit architecture) */
723 memcpy(&old, &bhead8->old, 8);
724 bhead4->old = (int) (old >> 3);
726 bhead4->SDNAnr = bhead8->SDNAnr;
727 bhead4->nr = bhead8->nr;
731 static void bh8_from_bh4(BHead *bhead, BHead4 *bhead4)
733 BHead8 *bhead8 = (BHead8 *) bhead;
735 bhead8->code = bhead4->code;
736 bhead8->len = bhead4->len;
738 if (bhead8->code != ENDB) {
739 bhead8->old = bhead4->old;
740 bhead8->SDNAnr = bhead4->SDNAnr;
741 bhead8->nr= bhead4->nr;
745 static BHeadN *get_bhead(FileData *fd)
747 BHeadN *new_bhead = NULL;
752 /* initializing to zero isn't strictly needed but shuts valgrind up
753 * since uninitialized memory gets compared */
758 /* First read the bhead structure.
759 * Depending on the platform the file was written on this can
760 * be a big or little endian BHead4 or BHead8 structure.
762 * As usual 'ENDB' (the last *partial* bhead of the file)
763 * needs some special handling. We don't want to EOF just yet.
765 if (fd->flags & FD_FLAGS_FILE_POINTSIZE_IS_4) {
767 readsize = fd->read(fd, &bhead4, sizeof(bhead4));
769 if (readsize == sizeof(bhead4) || bhead4.code == ENDB) {
770 if (fd->flags & FD_FLAGS_SWITCH_ENDIAN) {
771 switch_endian_bh4(&bhead4);
774 if (fd->flags & FD_FLAGS_POINTSIZE_DIFFERS) {
775 bh8_from_bh4(&bhead, &bhead4);
778 /* MIN2 is only to quiet '-Warray-bounds' compiler warning. */
779 BLI_assert(sizeof(bhead) == sizeof(bhead4));
780 memcpy(&bhead, &bhead4, MIN2(sizeof(bhead), sizeof(bhead4)));
790 readsize = fd->read(fd, &bhead8, sizeof(bhead8));
792 if (readsize == sizeof(bhead8) || bhead8.code == ENDB) {
793 if (fd->flags & FD_FLAGS_SWITCH_ENDIAN) {
794 switch_endian_bh8(&bhead8);
797 if (fd->flags & FD_FLAGS_POINTSIZE_DIFFERS) {
798 bh4_from_bh8(&bhead, &bhead8, (fd->flags & FD_FLAGS_SWITCH_ENDIAN));
801 /* MIN2 is only to quiet '-Warray-bounds' compiler warning. */
802 BLI_assert(sizeof(bhead) == sizeof(bhead8));
803 memcpy(&bhead, &bhead8, MIN2(sizeof(bhead), sizeof(bhead8)));
812 /* make sure people are not trying to pass bad blend files */
813 if (bhead.len < 0) fd->eof = 1;
815 /* bhead now contains the (converted) bhead structure. Now read
816 * the associated data and put everything in a BHeadN (creative naming !)
819 new_bhead = MEM_mallocN(sizeof(BHeadN) + bhead.len, "new_bhead");
821 new_bhead->next = new_bhead->prev = NULL;
822 new_bhead->bhead = bhead;
824 readsize = fd->read(fd, new_bhead + 1, bhead.len);
826 if (readsize != bhead.len) {
828 MEM_freeN(new_bhead);
839 /* We've read a new block. Now add it to the list
843 BLI_addtail(&fd->listbase, new_bhead);
849 BHead *blo_firstbhead(FileData *fd)
855 * Read in a new block if necessary
857 new_bhead = fd->listbase.first;
858 if (new_bhead == NULL) {
859 new_bhead = get_bhead(fd);
863 bhead = &new_bhead->bhead;
869 BHead *blo_prevbhead(FileData *UNUSED(fd), BHead *thisblock)
871 BHeadN *bheadn = (BHeadN *)POINTER_OFFSET(thisblock, -offsetof(BHeadN, bhead));
872 BHeadN *prev = bheadn->prev;
874 return (prev) ? &prev->bhead : NULL;
877 BHead *blo_nextbhead(FileData *fd, BHead *thisblock)
879 BHeadN *new_bhead = NULL;
883 /* bhead is actually a sub part of BHeadN
884 * We calculate the BHeadN pointer from the BHead pointer below */
885 new_bhead = (BHeadN *)POINTER_OFFSET(thisblock, -offsetof(BHeadN, bhead));
887 /* get the next BHeadN. If it doesn't exist we read in the next one */
888 new_bhead = new_bhead->next;
889 if (new_bhead == NULL) {
890 new_bhead = get_bhead(fd);
895 /* here we do the reverse:
896 * go from the BHeadN pointer to the BHead pointer */
897 bhead = &new_bhead->bhead;
903 /* Warning! Caller's responsibility to ensure given bhead **is** and ID one! */
904 const char *bhead_id_name(const FileData *fd, const BHead *bhead)
906 return (const char *)POINTER_OFFSET(bhead, sizeof(*bhead) + fd->id_name_offs);
909 static void decode_blender_header(FileData *fd)
911 char header[SIZEOFBLENDERHEADER], num[4];
914 /* read in the header data */
915 readsize = fd->read(fd, header, sizeof(header));
917 if (readsize == sizeof(header) &&
918 STREQLEN(header, "BLENDER", 7) &&
919 ELEM(header[7], '_', '-') &&
920 ELEM(header[8], 'v', 'V') &&
921 (isdigit(header[9]) && isdigit(header[10]) && isdigit(header[11])))
923 fd->flags |= FD_FLAGS_FILE_OK;
925 /* what size are pointers in the file ? */
926 if (header[7] == '_') {
927 fd->flags |= FD_FLAGS_FILE_POINTSIZE_IS_4;
928 if (sizeof(void *) != 4) {
929 fd->flags |= FD_FLAGS_POINTSIZE_DIFFERS;
933 if (sizeof(void *) != 8) {
934 fd->flags |= FD_FLAGS_POINTSIZE_DIFFERS;
938 /* is the file saved in a different endian
941 if (((header[8] == 'v') ? L_ENDIAN : B_ENDIAN) != ENDIAN_ORDER) {
942 fd->flags |= FD_FLAGS_SWITCH_ENDIAN;
945 /* get the version number */
946 memcpy(num, header + 9, 3);
948 fd->fileversion = atoi(num);
953 * \return Success if the file is read correctly, else set \a r_error_message.
955 static bool read_file_dna(FileData *fd, const char **r_error_message)
959 for (bhead = blo_firstbhead(fd); bhead; bhead = blo_nextbhead(fd, bhead)) {
960 if (bhead->code == DNA1) {
961 const bool do_endian_swap = (fd->flags & FD_FLAGS_SWITCH_ENDIAN) != 0;
963 fd->filesdna = DNA_sdna_from_data(&bhead[1], bhead->len, do_endian_swap, true, r_error_message);
965 fd->compflags = DNA_struct_get_compareflags(fd->filesdna, fd->memsdna);
966 /* used to retrieve ID names from (bhead+1) */
967 fd->id_name_offs = DNA_elem_offset(fd->filesdna, "ID", "char", "name[]");
976 else if (bhead->code == ENDB)
980 *r_error_message = "Missing DNA block";
984 static int *read_file_thumbnail(FileData *fd)
987 int *blend_thumb = NULL;
989 for (bhead = blo_firstbhead(fd); bhead; bhead = blo_nextbhead(fd, bhead)) {
990 if (bhead->code == TEST) {
991 const bool do_endian_swap = (fd->flags & FD_FLAGS_SWITCH_ENDIAN) != 0;
992 int *data = (int *)(bhead + 1);
994 if (bhead->len < (2 * sizeof(int))) {
998 if (do_endian_swap) {
999 BLI_endian_switch_int32(&data[0]);
1000 BLI_endian_switch_int32(&data[1]);
1003 int width = data[0];
1004 int height = data[1];
1006 if (!BLEN_THUMB_SAFE_MEMSIZE(width, height)) {
1009 if (bhead->len < BLEN_THUMB_MEMSIZE_FILE(width, height)) {
1016 else if (bhead->code != REND) {
1017 /* Thumbnail is stored in TEST immediately after first REND... */
1025 static int fd_read_from_file(FileData *filedata, void *buffer, unsigned int size)
1027 int readsize = read(filedata->filedes, buffer, size);
1033 filedata->seek += readsize;
1039 static int fd_read_gzip_from_file(FileData *filedata, void *buffer, unsigned int size)
1041 int readsize = gzread(filedata->gzfiledes, buffer, size);
1047 filedata->seek += readsize;
1053 static int fd_read_from_memory(FileData *filedata, void *buffer, unsigned int size)
1055 /* don't read more bytes then there are available in the buffer */
1056 int readsize = (int)MIN2(size, (unsigned int)(filedata->buffersize - filedata->seek));
1058 memcpy(buffer, filedata->buffer + filedata->seek, readsize);
1059 filedata->seek += readsize;
1064 static int fd_read_from_memfile(FileData *filedata, void *buffer, unsigned int size)
1066 static unsigned int seek = (1<<30); /* the current position */
1067 static unsigned int offset = 0; /* size of previous chunks */
1068 static MemFileChunk *chunk = NULL;
1069 unsigned int chunkoffset, readsize, totread;
1071 if (size == 0) return 0;
1073 if (seek != (unsigned int)filedata->seek) {
1074 chunk = filedata->memfile->chunks.first;
1078 if (seek + chunk->size > (unsigned) filedata->seek) break;
1079 seek += chunk->size;
1080 chunk = chunk->next;
1083 seek = filedata->seek;
1090 /* first check if it's on the end if current chunk */
1091 if (seek-offset == chunk->size) {
1092 offset += chunk->size;
1093 chunk = chunk->next;
1096 /* debug, should never happen */
1097 if (chunk == NULL) {
1098 printf("illegal read, chunk zero\n");
1102 chunkoffset = seek-offset;
1103 readsize = size-totread;
1105 /* data can be spread over multiple chunks, so clamp size
1106 * to within this chunk, and then it will read further in
1108 if (chunkoffset+readsize > chunk->size)
1109 readsize= chunk->size-chunkoffset;
1111 memcpy(POINTER_OFFSET(buffer, totread), chunk->buf + chunkoffset, readsize);
1112 totread += readsize;
1113 filedata->seek += readsize;
1115 } while (totread < size);
1123 static FileData *filedata_new(void)
1125 FileData *fd = MEM_callocN(sizeof(FileData), "FileData");
1128 fd->gzfiledes = NULL;
1130 fd->memsdna = DNA_sdna_current_get();
1132 fd->datamap = oldnewmap_new();
1133 fd->globmap = oldnewmap_new();
1134 fd->libmap = oldnewmap_new();
1139 static FileData *blo_decode_and_check(FileData *fd, ReportList *reports)
1141 decode_blender_header(fd);
1143 if (fd->flags & FD_FLAGS_FILE_OK) {
1144 const char *error_message = NULL;
1145 if (read_file_dna(fd, &error_message) == false) {
1146 BKE_reportf(reports, RPT_ERROR,
1147 "Failed to read blend file '%s': %s",
1148 fd->relabase, error_message);
1149 blo_freefiledata(fd);
1154 BKE_reportf(reports, RPT_ERROR, "Failed to read blend file '%s', not a blend file", fd->relabase);
1155 blo_freefiledata(fd);
1162 /* cannot be called with relative paths anymore! */
1163 /* on each new library added, it now checks for the current FileData and expands relativeness */
1164 FileData *blo_openblenderfile(const char *filepath, ReportList *reports)
1168 gzfile = BLI_gzopen(filepath, "rb");
1170 if (gzfile == (gzFile)Z_NULL) {
1171 BKE_reportf(reports, RPT_WARNING, "Unable to open '%s': %s",
1172 filepath, errno ? strerror(errno) : TIP_("unknown error reading file"));
1176 FileData *fd = filedata_new();
1177 fd->gzfiledes = gzfile;
1178 fd->read = fd_read_gzip_from_file;
1180 /* needed for library_append and read_libraries */
1181 BLI_strncpy(fd->relabase, filepath, sizeof(fd->relabase));
1183 return blo_decode_and_check(fd, reports);
1188 * Same as blo_openblenderfile(), but does not reads DNA data, only header. Use it for light access
1189 * (e.g. thumbnail reading).
1191 static FileData *blo_openblenderfile_minimal(const char *filepath)
1195 gzfile = BLI_gzopen(filepath, "rb");
1197 if (gzfile != (gzFile)Z_NULL) {
1198 FileData *fd = filedata_new();
1199 fd->gzfiledes = gzfile;
1200 fd->read = fd_read_gzip_from_file;
1202 decode_blender_header(fd);
1204 if (fd->flags & FD_FLAGS_FILE_OK) {
1208 blo_freefiledata(fd);
1214 static int fd_read_gzip_from_memory(FileData *filedata, void *buffer, unsigned int size)
1218 filedata->strm.next_out = (Bytef *) buffer;
1219 filedata->strm.avail_out = size;
1221 // Inflate another chunk.
1222 err = inflate (&filedata->strm, Z_SYNC_FLUSH);
1224 if (err == Z_STREAM_END) {
1227 else if (err != Z_OK) {
1228 printf("fd_read_gzip_from_memory: zlib error\n");
1232 filedata->seek += size;
1237 static int fd_read_gzip_from_memory_init(FileData *fd)
1240 fd->strm.next_in = (Bytef *) fd->buffer;
1241 fd->strm.avail_in = fd->buffersize;
1242 fd->strm.total_out = 0;
1243 fd->strm.zalloc = Z_NULL;
1244 fd->strm.zfree = Z_NULL;
1246 if (inflateInit2(&fd->strm, (16+MAX_WBITS)) != Z_OK)
1249 fd->read = fd_read_gzip_from_memory;
1254 FileData *blo_openblendermemory(const void *mem, int memsize, ReportList *reports)
1256 if (!mem || memsize<SIZEOFBLENDERHEADER) {
1257 BKE_report(reports, RPT_WARNING, (mem) ? TIP_("Unable to read"): TIP_("Unable to open"));
1261 FileData *fd = filedata_new();
1262 const char *cp = mem;
1265 fd->buffersize = memsize;
1268 if (cp[0] == 0x1f && cp[1] == 0x8b) {
1269 if (0 == fd_read_gzip_from_memory_init(fd)) {
1270 blo_freefiledata(fd);
1275 fd->read = fd_read_from_memory;
1277 fd->flags |= FD_FLAGS_NOT_MY_BUFFER;
1279 return blo_decode_and_check(fd, reports);
1283 FileData *blo_openblendermemfile(MemFile *memfile, ReportList *reports)
1286 BKE_report(reports, RPT_WARNING, "Unable to open blend <memory>");
1290 FileData *fd = filedata_new();
1291 fd->memfile = memfile;
1293 fd->read = fd_read_from_memfile;
1294 fd->flags |= FD_FLAGS_NOT_MY_BUFFER;
1296 return blo_decode_and_check(fd, reports);
1301 void blo_freefiledata(FileData *fd)
1304 if (fd->filedes != -1) {
1308 if (fd->gzfiledes != NULL) {
1309 gzclose(fd->gzfiledes);
1312 if (fd->strm.next_in) {
1313 if (inflateEnd(&fd->strm) != Z_OK) {
1314 printf("close gzip stream error\n");
1318 if (fd->buffer && !(fd->flags & FD_FLAGS_NOT_MY_BUFFER)) {
1319 MEM_freeN((void *)fd->buffer);
1323 // Free all BHeadN data blocks
1324 BLI_freelistN(&fd->listbase);
1327 DNA_sdna_free(fd->filesdna);
1329 MEM_freeN((void *)fd->compflags);
1332 oldnewmap_free(fd->datamap);
1334 oldnewmap_free(fd->globmap);
1336 oldnewmap_free(fd->imamap);
1337 if (fd->movieclipmap)
1338 oldnewmap_free(fd->movieclipmap);
1340 oldnewmap_free(fd->soundmap);
1342 oldnewmap_free(fd->packedmap);
1343 if (fd->libmap && !(fd->flags & FD_FLAGS_NOT_MY_LIBMAP))
1344 oldnewmap_free(fd->libmap);
1346 MEM_freeN(fd->bheadmap);
1348 #ifdef USE_GHASH_BHEAD
1349 if (fd->bhead_idname_hash) {
1350 BLI_ghash_free(fd->bhead_idname_hash, NULL, NULL);
1358 /* ************ DIV ****************** */
1361 * Check whether given path ends with a blend file compatible extension (.blend, .ble or .blend.gz).
1363 * \param str The path to check.
1364 * \return true is this path ends with a blender file extension.
1366 bool BLO_has_bfile_extension(const char *str)
1368 const char *ext_test[4] = {".blend", ".ble", ".blend.gz", NULL};
1369 return BLI_testextensie_array(str, ext_test);
1373 * Try to explode given path into its 'library components' (i.e. a .blend file, id type/group, and datablock itself).
1375 * \param path the full path to explode.
1376 * \param r_dir the string that'll contain path up to blend file itself ('library' path).
1377 * WARNING! Must be FILE_MAX_LIBEXTRA long (it also stores group and name strings)!
1378 * \param r_group the string that'll contain 'group' part of the path, if any. May be NULL.
1379 * \param r_name the string that'll contain data's name part of the path, if any. May be NULL.
1380 * \return true if path contains a blend file.
1382 bool BLO_library_path_explode(const char *path, char *r_dir, char **r_group, char **r_name)
1384 /* We might get some data names with slashes, so we have to go up in path until we find blend file itself,
1385 * then we now next path item is group, and everything else is data name. */
1386 char *slash = NULL, *prev_slash = NULL, c = '\0';
1396 /* if path leads to an existing directory, we can be sure we're not (in) a library */
1397 if (BLI_is_dir(path)) {
1401 strcpy(r_dir, path);
1403 while ((slash = (char *)BLI_last_slash(r_dir))) {
1406 if (BLO_has_bfile_extension(r_dir) && BLI_is_file(r_dir)) {
1421 if (slash[1] != '\0') {
1422 BLI_assert(strlen(slash + 1) < BLO_GROUP_MAX);
1424 *r_group = slash + 1;
1428 if (prev_slash && (prev_slash[1] != '\0')) {
1429 BLI_assert(strlen(prev_slash + 1) < MAX_ID_NAME - 2);
1431 *r_name = prev_slash + 1;
1439 * Does a very light reading of given .blend file to extract its stored thumbnail.
1441 * \param filepath The path of the file to extract thumbnail from.
1442 * \return The raw thumbnail
1443 * (MEM-allocated, as stored in file, use BKE_main_thumbnail_to_imbuf() to convert it to ImBuf image).
1445 BlendThumbnail *BLO_thumbnail_from_file(const char *filepath)
1448 BlendThumbnail *data = NULL;
1451 fd = blo_openblenderfile_minimal(filepath);
1452 fd_data = fd ? read_file_thumbnail(fd) : NULL;
1455 int width = fd_data[0];
1456 int height = fd_data[1];
1458 /* Protect against buffer overflow vulnerability. */
1459 if (BLEN_THUMB_SAFE_MEMSIZE(width, height)) {
1460 const size_t sz = BLEN_THUMB_MEMSIZE(width, height);
1461 data = MEM_mallocN(sz, __func__);
1464 BLI_assert((sz - sizeof(*data)) == (BLEN_THUMB_MEMSIZE_FILE(width, height) - (sizeof(*fd_data) * 2)));
1465 data->width = width;
1466 data->height = height;
1467 memcpy(data->rect, &fd_data[2], sz - sizeof(*data));
1472 blo_freefiledata(fd);
1477 /* ************** OLD POINTERS ******************* */
1479 static void *newdataadr(FileData *fd, const void *adr) /* only direct databocks */
1481 return oldnewmap_lookup_and_inc(fd->datamap, adr, true);
1484 /* This is a special version of newdataadr() which allows us to keep lasthit of
1485 * map unchanged. In certain cases this makes file loading time significantly
1488 * Use this function in cases like restoring pointer from one list element to
1489 * another list element, but keep lasthit value so we can continue restoring
1490 * pointers efficiently.
1492 * Example of this could be found in direct_link_fcurves() which restores the
1493 * fcurve group pointer and keeps lasthit optimal for linking all further
1496 static void *newdataadr_ex(FileData *fd, const void *adr, bool increase_lasthit) /* only direct databocks */
1498 if (increase_lasthit) {
1499 return newdataadr(fd, adr);
1502 int lasthit = fd->datamap->lasthit;
1503 void *newadr = newdataadr(fd, adr);
1504 fd->datamap->lasthit = lasthit;
1509 static void *newdataadr_no_us(FileData *fd, const void *adr) /* only direct databocks */
1511 return oldnewmap_lookup_and_inc(fd->datamap, adr, false);
1514 static void *newglobadr(FileData *fd, const void *adr) /* direct datablocks with global linking */
1516 return oldnewmap_lookup_and_inc(fd->globmap, adr, true);
1519 static void *newimaadr(FileData *fd, const void *adr) /* used to restore image data after undo */
1521 if (fd->imamap && adr)
1522 return oldnewmap_lookup_and_inc(fd->imamap, adr, true);
1526 static void *newmclipadr(FileData *fd, const void *adr) /* used to restore movie clip data after undo */
1528 if (fd->movieclipmap && adr)
1529 return oldnewmap_lookup_and_inc(fd->movieclipmap, adr, true);
1533 static void *newsoundadr(FileData *fd, const void *adr) /* used to restore sound data after undo */
1535 if (fd->soundmap && adr)
1536 return oldnewmap_lookup_and_inc(fd->soundmap, adr, true);
1540 static void *newpackedadr(FileData *fd, const void *adr) /* used to restore packed data after undo */
1542 if (fd->packedmap && adr)
1543 return oldnewmap_lookup_and_inc(fd->packedmap, adr, true);
1545 return oldnewmap_lookup_and_inc(fd->datamap, adr, true);
1549 static void *newlibadr(FileData *fd, const void *lib, const void *adr) /* only lib data */
1551 return oldnewmap_liblookup(fd->libmap, adr, lib);
1554 void *blo_do_versions_newlibadr(FileData *fd, const void *lib, const void *adr) /* only lib data */
1556 return newlibadr(fd, lib, adr);
1559 static void *newlibadr_us(FileData *fd, const void *lib, const void *adr) /* increases user number */
1561 ID *id = newlibadr(fd, lib, adr);
1563 id_us_plus_no_lib(id);
1568 void *blo_do_versions_newlibadr_us(FileData *fd, const void *lib, const void *adr) /* increases user number */
1570 return newlibadr_us(fd, lib, adr);
1573 static void *newlibadr_real_us(FileData *fd, const void *lib, const void *adr) /* ensures real user */
1575 ID *id = newlibadr(fd, lib, adr);
1577 id_us_ensure_real(id);
1582 static void change_idid_adr_fd(FileData *fd, const void *old, void *new)
1586 /* use a binary search if we have a sorted libmap, for now it's not needed. */
1587 BLI_assert(fd->libmap->sorted == false);
1589 for (i = 0; i < fd->libmap->nentries; i++) {
1590 OldNew *entry = &fd->libmap->entries[i];
1592 if (old==entry->newp && entry->nr==ID_ID) {
1594 if (new) entry->nr = GS( ((ID *)new)->name );
1599 static void change_idid_adr(ListBase *mainlist, FileData *basefd, void *old, void *new)
1603 for (mainptr = mainlist->first; mainptr; mainptr = mainptr->next) {
1606 if (mainptr->curlib)
1607 fd = mainptr->curlib->filedata;
1612 change_idid_adr_fd(fd, old, new);
1617 /* lib linked proxy objects point to our local data, we need
1618 * to clear that pointer before reading the undo memfile since
1619 * the object might be removed, it is set again in reading
1620 * if the local object still exists */
1621 void blo_clear_proxy_pointers_from_lib(Main *oldmain)
1623 Object *ob = oldmain->object.first;
1625 for (; ob; ob= ob->id.next) {
1627 ob->proxy_from = NULL;
1631 void blo_make_image_pointer_map(FileData *fd, Main *oldmain)
1633 Image *ima = oldmain->image.first;
1634 Scene *sce = oldmain->scene.first;
1637 fd->imamap = oldnewmap_new();
1639 for (; ima; ima = ima->id.next) {
1641 oldnewmap_insert(fd->imamap, ima->cache, ima->cache, 0);
1642 for (a = 0; a < TEXTARGET_COUNT; a++)
1643 if (ima->gputexture[a])
1644 oldnewmap_insert(fd->imamap, ima->gputexture[a], ima->gputexture[a], 0);
1646 oldnewmap_insert(fd->imamap, ima->rr, ima->rr, 0);
1647 for (a=0; a < IMA_MAX_RENDER_SLOT; a++)
1648 if (ima->renders[a])
1649 oldnewmap_insert(fd->imamap, ima->renders[a], ima->renders[a], 0);
1651 for (; sce; sce = sce->id.next) {
1652 if (sce->nodetree && sce->nodetree->previews) {
1653 bNodeInstanceHashIterator iter;
1654 NODE_INSTANCE_HASH_ITER(iter, sce->nodetree->previews) {
1655 bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
1656 oldnewmap_insert(fd->imamap, preview, preview, 0);
1662 /* set old main image ibufs to zero if it has been restored */
1663 /* this works because freeing old main only happens after this call */
1664 void blo_end_image_pointer_map(FileData *fd, Main *oldmain)
1666 OldNew *entry = fd->imamap->entries;
1667 Image *ima = oldmain->image.first;
1668 Scene *sce = oldmain->scene.first;
1671 /* used entries were restored, so we put them to zero */
1672 for (i = 0; i < fd->imamap->nentries; i++, entry++) {
1677 for (; ima; ima = ima->id.next) {
1678 ima->cache = newimaadr(fd, ima->cache);
1679 if (ima->cache == NULL) {
1680 ima->tpageflag &= ~IMA_GLBIND_IS_DATA;
1681 for (i = 0; i < TEXTARGET_COUNT; i++) {
1682 ima->bindcode[i] = 0;
1683 ima->gputexture[i] = NULL;
1687 for (i = 0; i < IMA_MAX_RENDER_SLOT; i++)
1688 ima->renders[i] = newimaadr(fd, ima->renders[i]);
1690 for (i = 0; i < TEXTARGET_COUNT; i++)
1691 ima->gputexture[i] = newimaadr(fd, ima->gputexture[i]);
1692 ima->rr = newimaadr(fd, ima->rr);
1694 for (; sce; sce = sce->id.next) {
1695 if (sce->nodetree && sce->nodetree->previews) {
1696 bNodeInstanceHash *new_previews = BKE_node_instance_hash_new("node previews");
1697 bNodeInstanceHashIterator iter;
1699 /* reconstruct the preview hash, only using remaining pointers */
1700 NODE_INSTANCE_HASH_ITER(iter, sce->nodetree->previews) {
1701 bNodePreview *preview = BKE_node_instance_hash_iterator_get_value(&iter);
1703 bNodePreview *new_preview = newimaadr(fd, preview);
1705 bNodeInstanceKey key = BKE_node_instance_hash_iterator_get_key(&iter);
1706 BKE_node_instance_hash_insert(new_previews, key, new_preview);
1710 BKE_node_instance_hash_free(sce->nodetree->previews, NULL);
1711 sce->nodetree->previews = new_previews;
1716 void blo_make_movieclip_pointer_map(FileData *fd, Main *oldmain)
1718 MovieClip *clip = oldmain->movieclip.first;
1719 Scene *sce = oldmain->scene.first;
1721 fd->movieclipmap = oldnewmap_new();
1723 for (; clip; clip = clip->id.next) {
1725 oldnewmap_insert(fd->movieclipmap, clip->cache, clip->cache, 0);
1727 if (clip->tracking.camera.intrinsics)
1728 oldnewmap_insert(fd->movieclipmap, clip->tracking.camera.intrinsics, clip->tracking.camera.intrinsics, 0);
1731 for (; sce; sce = sce->id.next) {
1732 if (sce->nodetree) {
1734 for (node = sce->nodetree->nodes.first; node; node = node->next)
1735 if (node->type == CMP_NODE_MOVIEDISTORTION)
1736 oldnewmap_insert(fd->movieclipmap, node->storage, node->storage, 0);
1741 /* set old main movie clips caches to zero if it has been restored */
1742 /* this works because freeing old main only happens after this call */
1743 void blo_end_movieclip_pointer_map(FileData *fd, Main *oldmain)
1745 OldNew *entry = fd->movieclipmap->entries;
1746 MovieClip *clip = oldmain->movieclip.first;
1747 Scene *sce = oldmain->scene.first;
1750 /* used entries were restored, so we put them to zero */
1751 for (i=0; i < fd->movieclipmap->nentries; i++, entry++) {
1756 for (; clip; clip = clip->id.next) {
1757 clip->cache = newmclipadr(fd, clip->cache);
1758 clip->tracking.camera.intrinsics = newmclipadr(fd, clip->tracking.camera.intrinsics);
1761 for (; sce; sce = sce->id.next) {
1762 if (sce->nodetree) {
1764 for (node = sce->nodetree->nodes.first; node; node = node->next)
1765 if (node->type == CMP_NODE_MOVIEDISTORTION)
1766 node->storage = newmclipadr(fd, node->storage);
1771 void blo_make_sound_pointer_map(FileData *fd, Main *oldmain)
1773 bSound *sound = oldmain->sound.first;
1775 fd->soundmap = oldnewmap_new();
1777 for (; sound; sound = sound->id.next) {
1778 if (sound->waveform)
1779 oldnewmap_insert(fd->soundmap, sound->waveform, sound->waveform, 0);
1783 /* set old main sound caches to zero if it has been restored */
1784 /* this works because freeing old main only happens after this call */
1785 void blo_end_sound_pointer_map(FileData *fd, Main *oldmain)
1787 OldNew *entry = fd->soundmap->entries;
1788 bSound *sound = oldmain->sound.first;
1791 /* used entries were restored, so we put them to zero */
1792 for (i = 0; i < fd->soundmap->nentries; i++, entry++) {
1797 for (; sound; sound = sound->id.next) {
1798 sound->waveform = newsoundadr(fd, sound->waveform);
1802 /* XXX disabled this feature - packed files also belong in temp saves and quit.blend, to make restore work */
1804 static void insert_packedmap(FileData *fd, PackedFile *pf)
1806 oldnewmap_insert(fd->packedmap, pf, pf, 0);
1807 oldnewmap_insert(fd->packedmap, pf->data, pf->data, 0);
1810 void blo_make_packed_pointer_map(FileData *fd, Main *oldmain)
1817 fd->packedmap = oldnewmap_new();
1819 for (ima = oldmain->image.first; ima; ima = ima->id.next) {
1820 ImagePackedFile *imapf;
1822 if (ima->packedfile)
1823 insert_packedmap(fd, ima->packedfile);
1825 for (imapf = ima->packedfiles.first; imapf; imapf = imapf->next)
1826 if (imapf->packedfile)
1827 insert_packedmap(fd, imapf->packedfile);
1830 for (vfont = oldmain->vfont.first; vfont; vfont = vfont->id.next)
1831 if (vfont->packedfile)
1832 insert_packedmap(fd, vfont->packedfile);
1834 for (sound = oldmain->sound.first; sound; sound = sound->id.next)
1835 if (sound->packedfile)
1836 insert_packedmap(fd, sound->packedfile);
1838 for (lib = oldmain->library.first; lib; lib = lib->id.next)
1839 if (lib->packedfile)
1840 insert_packedmap(fd, lib->packedfile);
1844 /* set old main packed data to zero if it has been restored */
1845 /* this works because freeing old main only happens after this call */
1846 void blo_end_packed_pointer_map(FileData *fd, Main *oldmain)
1852 OldNew *entry = fd->packedmap->entries;
1855 /* used entries were restored, so we put them to zero */
1856 for (i=0; i < fd->packedmap->nentries; i++, entry++) {
1861 for (ima = oldmain->image.first; ima; ima = ima->id.next) {
1862 ImagePackedFile *imapf;
1864 ima->packedfile = newpackedadr(fd, ima->packedfile);
1866 for (imapf = ima->packedfiles.first; imapf; imapf = imapf->next)
1867 imapf->packedfile = newpackedadr(fd, imapf->packedfile);
1870 for (vfont = oldmain->vfont.first; vfont; vfont = vfont->id.next)
1871 vfont->packedfile = newpackedadr(fd, vfont->packedfile);
1873 for (sound = oldmain->sound.first; sound; sound = sound->id.next)
1874 sound->packedfile = newpackedadr(fd, sound->packedfile);
1876 for (lib = oldmain->library.first; lib; lib = lib->id.next)
1877 lib->packedfile = newpackedadr(fd, lib->packedfile);
1881 /* undo file support: add all library pointers in lookup */
1882 void blo_add_library_pointer_map(ListBase *old_mainlist, FileData *fd)
1884 Main *ptr = old_mainlist->first;
1885 ListBase *lbarray[MAX_LIBARRAY];
1887 for (ptr = ptr->next; ptr; ptr = ptr->next) {
1888 int i = set_listbasepointers(ptr, lbarray);
1891 for (id = lbarray[i]->first; id; id = id->next)
1892 oldnewmap_insert(fd->libmap, id, id, GS(id->name));
1896 fd->old_mainlist = old_mainlist;
1900 /* ********** END OLD POINTERS ****************** */
1901 /* ********** READ FILE ****************** */
1903 static void switch_endian_structs(const struct SDNA *filesdna, BHead *bhead)
1905 int blocksize, nblocks;
1908 data = (char *)(bhead+1);
1909 blocksize = filesdna->typelens[ filesdna->structs[bhead->SDNAnr][0] ];
1911 nblocks = bhead->nr;
1913 DNA_struct_switch_endian(filesdna, bhead->SDNAnr, data);
1919 static void *read_struct(FileData *fd, BHead *bh, const char *blockname)
1924 /* switch is based on file dna */
1925 if (bh->SDNAnr && (fd->flags & FD_FLAGS_SWITCH_ENDIAN))
1926 switch_endian_structs(fd->filesdna, bh);
1928 if (fd->compflags[bh->SDNAnr] != SDNA_CMP_REMOVED) {
1929 if (fd->compflags[bh->SDNAnr] == SDNA_CMP_NOT_EQUAL) {
1930 temp = DNA_struct_reconstruct(fd->memsdna, fd->filesdna, fd->compflags, bh->SDNAnr, bh->nr, (bh+1));
1933 /* SDNA_CMP_EQUAL */
1934 temp = MEM_mallocN(bh->len, blockname);
1935 memcpy(temp, (bh+1), bh->len);
1943 typedef void (*link_list_cb)(FileData *fd, void *data);
1945 static void link_list_ex(FileData *fd, ListBase *lb, link_list_cb callback) /* only direct data */
1949 if (BLI_listbase_is_empty(lb)) return;
1951 lb->first = newdataadr(fd, lb->first);
1952 if (callback != NULL) {
1953 callback(fd, lb->first);
1958 ln->next = newdataadr(fd, ln->next);
1959 if (ln->next != NULL && callback != NULL) {
1960 callback(fd, ln->next);
1969 static void link_list(FileData *fd, ListBase *lb) /* only direct data */
1971 link_list_ex(fd, lb, NULL);
1974 static void link_glob_list(FileData *fd, ListBase *lb) /* for glob data */
1979 if (BLI_listbase_is_empty(lb)) return;
1980 poin = newdataadr(fd, lb->first);
1982 oldnewmap_insert(fd->globmap, lb->first, poin, 0);
1989 poin = newdataadr(fd, ln->next);
1991 oldnewmap_insert(fd->globmap, ln->next, poin, 0);
2001 static void test_pointer_array(FileData *fd, void **mat)
2003 int64_t *lpoin, *lmat;
2007 /* manually convert the pointer array in
2008 * the old dna format to a pointer array in
2009 * the new dna format.
2012 len = MEM_allocN_len(*mat)/fd->filesdna->pointerlen;
2014 if (fd->filesdna->pointerlen==8 && fd->memsdna->pointerlen==4) {
2015 ipoin=imat= MEM_malloc_arrayN(len, 4, "newmatar");
2019 if ((fd->flags & FD_FLAGS_SWITCH_ENDIAN))
2020 BLI_endian_switch_int64(lpoin);
2021 *ipoin = (int)((*lpoin) >> 3);
2029 if (fd->filesdna->pointerlen==4 && fd->memsdna->pointerlen==8) {
2030 lpoin = lmat = MEM_malloc_arrayN(len, 8, "newmatar");
2044 /* ************ READ ID Properties *************** */
2046 static void IDP_DirectLinkProperty(IDProperty *prop, int switch_endian, FileData *fd);
2047 static void IDP_LibLinkProperty(IDProperty *prop, FileData *fd);
2049 static void IDP_DirectLinkIDPArray(IDProperty *prop, int switch_endian, FileData *fd)
2054 /* since we didn't save the extra buffer, set totallen to len */
2055 prop->totallen = prop->len;
2056 prop->data.pointer = newdataadr(fd, prop->data.pointer);
2058 array = (IDProperty *)prop->data.pointer;
2060 /* note!, idp-arrays didn't exist in 2.4x, so the pointer will be cleared
2061 * theres not really anything we can do to correct this, at least don't crash */
2062 if (array == NULL) {
2068 for (i = 0; i < prop->len; i++)
2069 IDP_DirectLinkProperty(&array[i], switch_endian, fd);
2072 static void IDP_DirectLinkArray(IDProperty *prop, int switch_endian, FileData *fd)
2077 /* since we didn't save the extra buffer, set totallen to len */
2078 prop->totallen = prop->len;
2079 prop->data.pointer = newdataadr(fd, prop->data.pointer);
2081 if (prop->subtype == IDP_GROUP) {
2082 test_pointer_array(fd, prop->data.pointer);
2083 array = prop->data.pointer;
2085 for (i = 0; i < prop->len; i++)
2086 IDP_DirectLinkProperty(array[i], switch_endian, fd);
2088 else if (prop->subtype == IDP_DOUBLE) {
2089 if (switch_endian) {
2090 BLI_endian_switch_double_array(prop->data.pointer, prop->len);
2094 if (switch_endian) {
2095 /* also used for floats */
2096 BLI_endian_switch_int32_array(prop->data.pointer, prop->len);
2101 static void IDP_DirectLinkString(IDProperty *prop, FileData *fd)
2103 /*since we didn't save the extra string buffer, set totallen to len.*/
2104 prop->totallen = prop->len;
2105 prop->data.pointer = newdataadr(fd, prop->data.pointer);
2108 static void IDP_DirectLinkGroup(IDProperty *prop, int switch_endian, FileData *fd)
2110 ListBase *lb = &prop->data.group;
2115 /*Link child id properties now*/
2116 for (loop=prop->data.group.first; loop; loop=loop->next) {
2117 IDP_DirectLinkProperty(loop, switch_endian, fd);
2121 static void IDP_DirectLinkProperty(IDProperty *prop, int switch_endian, FileData *fd)
2123 switch (prop->type) {
2125 IDP_DirectLinkGroup(prop, switch_endian, fd);
2128 IDP_DirectLinkString(prop, fd);
2131 IDP_DirectLinkArray(prop, switch_endian, fd);
2134 IDP_DirectLinkIDPArray(prop, switch_endian, fd);
2137 /* erg, stupid doubles. since I'm storing them
2138 * in the same field as int val; val2 in the
2139 * IDPropertyData struct, they have to deal with
2140 * endianness specifically
2142 * in theory, val and val2 would've already been swapped
2143 * if switch_endian is true, so we have to first unswap
2144 * them then reswap them as a single 64-bit entity.
2147 if (switch_endian) {
2148 BLI_endian_switch_int32(&prop->data.val);
2149 BLI_endian_switch_int32(&prop->data.val2);
2150 BLI_endian_switch_int64((int64_t *)&prop->data.val);
2156 break; /* Nothing special to do here. */
2158 /* Unknown IDP type, nuke it (we cannot handle unknown types everywhere in code,
2159 * IDP are way too polymorphic to do it safely. */
2160 printf("%s: found unknown IDProperty type %d, reset to Integer one !\n", __func__, prop->type);
2161 /* Note: we do not attempt to free unknown prop, we have no way to know how to do that! */
2162 prop->type = IDP_INT;
2168 #define IDP_DirectLinkGroup_OrFree(prop, switch_endian, fd) \
2169 _IDP_DirectLinkGroup_OrFree(prop, switch_endian, fd, __func__)
2171 static void _IDP_DirectLinkGroup_OrFree(IDProperty **prop, int switch_endian, FileData *fd,
2172 const char *caller_func_id)
2175 if ((*prop)->type == IDP_GROUP) {
2176 IDP_DirectLinkGroup(*prop, switch_endian, fd);
2180 printf("%s: found non group data, freeing type %d!\n",
2181 caller_func_id, (*prop)->type);
2182 /* don't risk id, data's likely corrupt. */
2183 // IDP_FreeProperty(*prop);
2189 static void IDP_LibLinkProperty(IDProperty *prop, FileData *fd)
2194 switch (prop->type) {
2195 case IDP_ID: /* PointerProperty */
2197 void *newaddr = newlibadr_us(fd, NULL, IDP_Id(prop));
2198 if (IDP_Id(prop) && !newaddr && G.debug) {
2199 printf("Error while loading \"%s\". Data not found in file!\n", prop->name);
2201 prop->data.pointer = newaddr;
2204 case IDP_IDPARRAY: /* CollectionProperty */
2206 IDProperty *idp_array = IDP_IDPArray(prop);
2207 for (int i = 0; i < prop->len; i++) {
2208 IDP_LibLinkProperty(&(idp_array[i]), fd);
2212 case IDP_GROUP: /* PointerProperty */
2214 for (IDProperty *loop = prop->data.group.first; loop; loop = loop->next) {
2215 IDP_LibLinkProperty(loop, fd);
2220 break; /* Nothing to do for other IDProps. */
2224 /* ************ READ IMAGE PREVIEW *************** */
2226 static PreviewImage *direct_link_preview_image(FileData *fd, PreviewImage *old_prv)
2228 PreviewImage *prv = newdataadr(fd, old_prv);
2232 for (i = 0; i < NUM_ICON_SIZES; ++i) {
2234 prv->rect[i] = newdataadr(fd, prv->rect[i]);
2236 prv->gputexture[i] = NULL;
2245 /* ************ READ ID *************** */
2247 static void lib_link_id(FileData *fd, Main *main)
2249 ListBase *lbarray[MAX_LIBARRAY];
2252 base_count = set_listbasepointers(main, lbarray);
2254 for (i = 0; i < base_count; i++) {
2255 ListBase *lb = lbarray[i];
2258 for (id = lb->first; id; id = id->next) {
2259 if (id->override_static) {
2260 id->override_static->reference = newlibadr_us(fd, id->lib, id->override_static->reference);
2261 id->override_static->storage = newlibadr_us(fd, id->lib, id->override_static->storage);
2267 static void direct_link_id_override_property_operation_cb(FileData *fd, void *data)
2269 IDOverrideStaticPropertyOperation *opop = data;
2271 opop->subitem_reference_name = newdataadr(fd, opop->subitem_reference_name);
2272 opop->subitem_local_name = newdataadr(fd, opop->subitem_local_name);
2275 static void direct_link_id_override_property_cb(FileData *fd, void *data)
2277 IDOverrideStaticProperty *op = data;
2279 op->rna_path = newdataadr(fd, op->rna_path);
2280 link_list_ex(fd, &op->operations, direct_link_id_override_property_operation_cb);
2283 static void direct_link_id(FileData *fd, ID *id)
2285 /*link direct data of ID properties*/
2286 if (id->properties) {
2287 id->properties = newdataadr(fd, id->properties);
2288 /* this case means the data was written incorrectly, it should not happen */
2289 IDP_DirectLinkGroup_OrFree(&id->properties, (fd->flags & FD_FLAGS_SWITCH_ENDIAN), fd);
2291 id->py_instance = NULL;
2293 /* That way datablock reading not going through main read_libblock() function are still in a clear tag state.
2294 * (glowering at certain nodetree fake datablock here...). */
2297 /* Link direct data of overrides. */
2298 if (id->override_static) {
2299 id->override_static = newdataadr(fd, id->override_static);
2300 link_list_ex(fd, &id->override_static->properties, direct_link_id_override_property_cb);
2304 /* ************ READ CurveMapping *************** */
2306 /* cuma itself has been read! */
2307 static void direct_link_curvemapping(FileData *fd, CurveMapping *cumap)
2311 /* flag seems to be able to hang? Maybe old files... not bad to clear anyway */
2312 cumap->flag &= ~CUMA_PREMULLED;
2314 for (a = 0; a < CM_TOT; a++) {
2315 cumap->cm[a].curve = newdataadr(fd, cumap->cm[a].curve);
2316 cumap->cm[a].table = NULL;
2317 cumap->cm[a].premultable = NULL;
2321 /* ************ READ Brush *************** */
2322 /* library brush linking after fileread */
2323 static void lib_link_brush(FileData *fd, Main *main)
2325 /* only link ID pointers */
2326 for (Brush *brush = main->brush.first; brush; brush = brush->id.next) {
2327 if (brush->id.tag & LIB_TAG_NEED_LINK) {
2328 IDP_LibLinkProperty(brush->id.properties, fd);
2330 /* brush->(mask_)mtex.obj is ignored on purpose? */
2331 brush->mtex.tex = newlibadr_us(fd, brush->id.lib, brush->mtex.tex);
2332 brush->mask_mtex.tex = newlibadr_us(fd, brush->id.lib, brush->mask_mtex.tex);
2333 brush->clone.image = newlibadr(fd, brush->id.lib, brush->clone.image);
2334 brush->toggle_brush = newlibadr(fd, brush->id.lib, brush->toggle_brush);
2335 brush->paint_curve = newlibadr_us(fd, brush->id.lib, brush->paint_curve);
2337 brush->id.tag &= ~LIB_TAG_NEED_LINK;
2342 static void direct_link_brush(FileData *fd, Brush *brush)
2344 /* brush itself has been read */
2347 brush->curve = newdataadr(fd, brush->curve);
2348 brush->gradient = newdataadr(fd, brush->gradient);
2351 direct_link_curvemapping(fd, brush->curve);
2353 BKE_brush_curve_preset(brush, CURVE_PRESET_SHARP);
2355 brush->preview = NULL;
2356 brush->icon_imbuf = NULL;
2359 /* ************ READ Palette *************** */
2360 static void lib_link_palette(FileData *fd, Main *main)
2362 /* only link ID pointers */
2363 for (Palette *palette = main->palettes.first; palette; palette = palette->id.next) {
2364 if (palette->id.tag & LIB_TAG_NEED_LINK) {
2365 IDP_LibLinkProperty(palette->id.properties, fd);
2367 palette->id.tag &= ~LIB_TAG_NEED_LINK;
2372 static void direct_link_palette(FileData *fd, Palette *palette)
2374 /* palette itself has been read */
2375 link_list(fd, &palette->colors);
2378 static void lib_link_paint_curve(FileData *fd, Main *main)
2380 /* only link ID pointers */
2381 for (PaintCurve *pc = main->paintcurves.first; pc; pc = pc->id.next) {
2382 if (pc->id.tag & LIB_TAG_NEED_LINK) {
2383 IDP_LibLinkProperty(pc->id.properties, fd);
2385 pc->id.tag &= ~LIB_TAG_NEED_LINK;
2390 static void direct_link_paint_curve(FileData *fd, PaintCurve *pc)
2392 pc->points = newdataadr(fd, pc->points);
2395 /* ************ READ PACKEDFILE *************** */
2397 static PackedFile *direct_link_packedfile(FileData *fd, PackedFile *oldpf)
2399 PackedFile *pf = newpackedadr(fd, oldpf);
2402 pf->data = newpackedadr(fd, pf->data);
2408 /* ************ READ ANIMATION STUFF ***************** */
2410 /* Legacy Data Support (for Version Patching) ----------------------------- */
2412 // XXX deprecated - old animation system
2413 static void lib_link_ipo(FileData *fd, Main *main)
2417 for (ipo = main->ipo.first; ipo; ipo = ipo->id.next) {
2418 if (ipo->id.tag & LIB_TAG_NEED_LINK) {
2420 for (icu = ipo->curve.first; icu; icu = icu->next) {
2422 icu->driver->ob = newlibadr(fd, ipo->id.lib, icu->driver->ob);
2424 ipo->id.tag &= ~LIB_TAG_NEED_LINK;
2429 // XXX deprecated - old animation system
2430 static void direct_link_ipo(FileData *fd, Ipo *ipo)
2434 link_list(fd, &(ipo->curve));
2436 for (icu = ipo->curve.first; icu; icu = icu->next) {
2437 icu->bezt = newdataadr(fd, icu->bezt);
2438 icu->bp = newdataadr(fd, icu->bp);
2439 icu->driver = newdataadr(fd, icu->driver);
2443 // XXX deprecated - old animation system
2444 static void lib_link_nlastrips(FileData *fd, ID *id, ListBase *striplist)
2446 bActionStrip *strip;
2447 bActionModifier *amod;
2449 for (strip=striplist->first; strip; strip=strip->next) {
2450 strip->object = newlibadr(fd, id->lib, strip->object);
2451 strip->act = newlibadr_us(fd, id->lib, strip->act);
2452 strip->ipo = newlibadr(fd, id->lib, strip->ipo);
2453 for (amod = strip->modifiers.first; amod; amod = amod->next)
2454 amod->ob = newlibadr(fd, id->lib, amod->ob);
2458 // XXX deprecated - old animation system
2459 static void direct_link_nlastrips(FileData *fd, ListBase *strips)
2461 bActionStrip *strip;
2463 link_list(fd, strips);
2465 for (strip = strips->first; strip; strip = strip->next)
2466 link_list(fd, &strip->modifiers);
2469 // XXX deprecated - old animation system
2470 static void lib_link_constraint_channels(FileData *fd, ID *id, ListBase *chanbase)
2472 bConstraintChannel *chan;
2474 for (chan=chanbase->first; chan; chan=chan->next) {
2475 chan->ipo = newlibadr_us(fd, id->lib, chan->ipo);
2479 /* Data Linking ----------------------------- */
2481 static void lib_link_fmodifiers(FileData *fd, ID *id, ListBase *list)
2485 for (fcm = list->first; fcm; fcm = fcm->next) {
2486 /* data for specific modifiers */
2487 switch (fcm->type) {
2488 case FMODIFIER_TYPE_PYTHON:
2490 FMod_Python *data = (FMod_Python *)fcm->data;
2491 data->script = newlibadr(fd, id->lib, data->script);
2499 static void lib_link_fcurves(FileData *fd, ID *id, ListBase *list)
2506 /* relink ID-block references... */
2507 for (fcu = list->first; fcu; fcu = fcu->next) {
2510 ChannelDriver *driver = fcu->driver;
2513 for (dvar= driver->variables.first; dvar; dvar= dvar->next) {
2514 DRIVER_TARGETS_LOOPER(dvar)
2516 /* only relink if still used */
2517 if (tarIndex < dvar->num_targets)
2518 dtar->id = newlibadr(fd, id->lib, dtar->id);
2522 DRIVER_TARGETS_LOOPER_END
2527 lib_link_fmodifiers(fd, id, &fcu->modifiers);
2532 /* NOTE: this assumes that link_list has already been called on the list */
2533 static void direct_link_fmodifiers(FileData *fd, ListBase *list, FCurve *curve)
2537 for (fcm = list->first; fcm; fcm = fcm->next) {
2538 /* relink general data */
2539 fcm->data = newdataadr(fd, fcm->data);
2542 /* do relinking of data for specific types */
2543 switch (fcm->type) {
2544 case FMODIFIER_TYPE_GENERATOR:
2546 FMod_Generator *data = (FMod_Generator *)fcm->data;
2548 data->coefficients = newdataadr(fd, data->coefficients);
2550 if (fd->flags & FD_FLAGS_SWITCH_ENDIAN) {
2551 BLI_endian_switch_float_array(data->coefficients, data->arraysize);
2556 case FMODIFIER_TYPE_ENVELOPE:
2558 FMod_Envelope *data= (FMod_Envelope *)fcm->data;
2560 data->data= newdataadr(fd, data->data);
2564 case FMODIFIER_TYPE_PYTHON:
2566 FMod_Python *data = (FMod_Python *)fcm->data;
2568 data->prop = newdataadr(fd, data->prop);
2569 IDP_DirectLinkGroup_OrFree(&data->prop, (fd->flags & FD_FLAGS_SWITCH_ENDIAN), fd);
2577 /* NOTE: this assumes that link_list has already been called on the list */
2578 static void direct_link_fcurves(FileData *fd, ListBase *list)
2582 /* link F-Curve data to F-Curve again (non ID-libs) */
2583 for (fcu = list->first; fcu; fcu = fcu->next) {
2585 fcu->bezt = newdataadr(fd, fcu->bezt);
2586 fcu->fpt = newdataadr(fd, fcu->fpt);
2589 fcu->rna_path = newdataadr(fd, fcu->rna_path);
2592 fcu->grp = newdataadr_ex(fd, fcu->grp, false);
2594 /* clear disabled flag - allows disabled drivers to be tried again ([#32155]),
2595 * but also means that another method for "reviving disabled F-Curves" exists
2597 fcu->flag &= ~FCURVE_DISABLED;
2600 fcu->driver= newdataadr(fd, fcu->driver);
2602 ChannelDriver *driver= fcu->driver;
2605 /* compiled expression data will need to be regenerated (old pointer may still be set here) */
2606 driver->expr_comp = NULL;
2608 /* give the driver a fresh chance - the operating environment may be different now
2609 * (addons, etc. may be different) so the driver namespace may be sane now [#32155]
2611 driver->flag &= ~DRIVER_FLAG_INVALID;
2613 /* relink variables, targets and their paths */
2614 link_list(fd, &driver->variables);
2615 for (dvar= driver->variables.first; dvar; dvar= dvar->next) {
2616 DRIVER_TARGETS_LOOPER(dvar)
2618 /* only relink the targets being used */
2619 if (tarIndex < dvar->num_targets)
2620 dtar->rna_path = newdataadr(fd, dtar->rna_path);
2622 dtar->rna_path = NULL;
2624 DRIVER_TARGETS_LOOPER_END
2629 link_list(fd, &fcu->modifiers);
2630 direct_link_fmodifiers(fd, &fcu->modifiers, fcu);
2635 static void lib_link_action(FileData *fd, Main *main)
2637 for (bAction *act = main->action.first; act; act = act->id.next) {
2638 if (act->id.tag & LIB_TAG_NEED_LINK) {
2639 IDP_LibLinkProperty(act->id.properties, fd);
2641 // XXX deprecated - old animation system <<<
2642 for (bActionChannel *chan = act->chanbase.first; chan; chan = chan->next) {
2643 chan->ipo = newlibadr_us(fd, act->id.lib, chan->ipo);
2644 lib_link_constraint_channels(fd, &act->id, &chan->constraintChannels);
2646 // >>> XXX deprecated - old animation system
2648 lib_link_fcurves(fd, &act->id, &act->curves);
2650 for (TimeMarker *marker = act->markers.first; marker; marker = marker->next) {
2651 if (marker->camera) {
2652 marker->camera = newlibadr(fd, act->id.lib, marker->camera);
2656 act->id.tag &= ~LIB_TAG_NEED_LINK;
2661 static void direct_link_action(FileData *fd, bAction *act)
2663 bActionChannel *achan; // XXX deprecated - old animation system
2666 link_list(fd, &act->curves);
2667 link_list(fd, &act->chanbase); // XXX deprecated - old animation system
2668 link_list(fd, &act->groups);
2669 link_list(fd, &act->markers);
2671 // XXX deprecated - old animation system <<<
2672 for (achan = act->chanbase.first; achan; achan=achan->next) {
2673 achan->grp = newdataadr(fd, achan->grp);
2675 link_list(fd, &achan->constraintChannels);
2677 // >>> XXX deprecated - old animation system
2679 direct_link_fcurves(fd, &act->curves);
2681 for (agrp = act->groups.first; agrp; agrp= agrp->next) {
2682 agrp->channels.first= newdataadr(fd, agrp->channels.first);
2683 agrp->channels.last= newdataadr(fd, agrp->channels.last);
2687 static void lib_link_nladata_strips(FileData *fd, ID *id, ListBase *list)
2691 for (strip = list->first; strip; strip = strip->next) {
2692 /* check strip's children */
2693 lib_link_nladata_strips(fd, id, &strip->strips);
2695 /* check strip's F-Curves */
2696 lib_link_fcurves(fd, id, &strip->fcurves);
2698 /* reassign the counted-reference to action */
2699 strip->act = newlibadr_us(fd, id->lib, strip->act);
2701 /* fix action id-root (i.e. if it comes from a pre 2.57 .blend file) */
2702 if ((strip->act) && (strip->act->idroot == 0))
2703 strip->act->idroot = GS(id->name);
2707 static void lib_link_nladata(FileData *fd, ID *id, ListBase *list)
2711 /* we only care about the NLA strips inside the tracks */
2712 for (nlt = list->first; nlt; nlt = nlt->next) {
2713 lib_link_nladata_strips(fd, id, &nlt->strips);
2717 /* This handles Animato NLA-Strips linking
2718 * NOTE: this assumes that link_list has already been called on the list
2720 static void direct_link_nladata_strips(FileData *fd, ListBase *list)
2724 for (strip = list->first; strip; strip = strip->next) {
2725 /* strip's child strips */
2726 link_list(fd, &strip->strips);
2727 direct_link_nladata_strips(fd, &strip->strips);
2729 /* strip's F-Curves */
2730 link_list(fd, &strip->fcurves);
2731 direct_link_fcurves(fd, &strip->fcurves);
2733 /* strip's F-Modifiers */
2734 link_list(fd, &strip->modifiers);
2735 direct_link_fmodifiers(fd, &strip->modifiers, NULL);
2739 /* NOTE: this assumes that link_list has already been called on the list */
2740 static void direct_link_nladata(FileData *fd, ListBase *list)
2744 for (nlt = list->first; nlt; nlt = nlt->next) {
2745 /* relink list of strips */
2746 link_list(fd, &nlt->strips);
2748 /* relink strip data */
2749 direct_link_nladata_strips(fd, &nlt->strips);
2755 static void lib_link_keyingsets(FileData *fd, ID *id, ListBase *list)
2760 /* here, we're only interested in the ID pointer stored in some of the paths */
2761 for (ks = list->first; ks; ks = ks->next) {
2762 for (ksp = ks->paths.first; ksp; ksp = ksp->next) {
2763 ksp->id= newlibadr(fd, id->lib, ksp->id);
2768 /* NOTE: this assumes that link_list has already been called on the list */
2769 static void direct_link_keyingsets(FileData *fd, ListBase *list)
2774 /* link KeyingSet data to KeyingSet again (non ID-libs) */
2775 for (ks = list->first; ks; ks = ks->next) {
2777 link_list(fd, &ks->paths);
2779 for (ksp = ks->paths.first; ksp; ksp = ksp->next) {
2781 ksp->rna_path= newdataadr(fd, ksp->rna_path);
2788 static void lib_link_animdata(FileData *fd, ID *id, AnimData *adt)
2793 /* link action data */
2794 adt->action= newlibadr_us(fd, id->lib, adt->action);
2795 adt->tmpact= newlibadr_us(fd, id->lib, adt->tmpact);
2797 /* fix action id-roots (i.e. if they come from a pre 2.57 .blend file) */
2798 if ((adt->action) && (adt->action->idroot == 0))
2799 adt->action->idroot = GS(id->name);
2800 if ((adt->tmpact) && (adt->tmpact->idroot == 0))
2801 adt->tmpact->idroot = GS(id->name);
2804 lib_link_fcurves(fd, id, &adt->drivers);
2806 /* overrides don't have lib-link for now, so no need to do anything */
2809 lib_link_nladata(fd, id, &adt->nla_tracks);
2812 static void direct_link_animdata(FileData *fd, AnimData *adt)
2814 /* NOTE: must have called newdataadr already before doing this... */
2819 link_list(fd, &adt->drivers);
2820 direct_link_fcurves(fd, &adt->drivers);
2822 /* link overrides */
2826 link_list(fd, &adt->nla_tracks);
2827 direct_link_nladata(fd, &adt->nla_tracks);
2829 /* relink active track/strip - even though strictly speaking this should only be used
2830 * if we're in 'tweaking mode', we need to be able to have this loaded back for
2831 * undo, but also since users may not exit tweakmode before saving (#24535)
2833 // TODO: it's not really nice that anyone should be able to save the file in this
2834 // state, but it's going to be too hard to enforce this single case...
2835 adt->act_track = newdataadr(fd, adt->act_track);
2836 adt->actstrip = newdataadr(fd, adt->actstrip);
2839 /* ************ READ CACHEFILES *************** */
2841 static void lib_link_cachefiles(FileData *fd, Main *bmain)
2843 /* only link ID pointers */
2844 for (CacheFile *cache_file = bmain->cachefiles.first; cache_file; cache_file = cache_file->id.next) {
2845 if (cache_file->id.tag & LIB_TAG_NEED_LINK) {
2846 IDP_LibLinkProperty(cache_file->id.properties, fd);
2847 lib_link_animdata(fd, &cache_file->id, cache_file->adt);
2849 cache_file->id.tag &= ~LIB_TAG_NEED_LINK;
2854 static void direct_link_cachefile(FileData *fd, CacheFile *cache_file)
2856 BLI_listbase_clear(&cache_file->object_paths);
2857 cache_file->handle = NULL;
2858 cache_file->handle_mutex = NULL;
2860 /* relink animdata */
2861 cache_file->adt = newdataadr(fd, cache_file->adt);
2862 direct_link_animdata(fd, cache_file->adt);
2865 /* ************ READ WORKSPACES *************** */
2867 static void lib_link_workspaces(FileData *fd, Main *bmain)
2869 for (WorkSpace *workspace = bmain->workspaces.first; workspace; workspace = workspace->id.next) {
2870 ListBase *layouts = BKE_workspace_layouts_get(workspace);
2871 ID *id = (ID *)workspace;
2873 if ((id->tag & LIB_TAG_NEED_LINK) == 0) {
2876 IDP_LibLinkProperty(id->properties, fd);
2877 id_us_ensure_real(id);
2879 for (WorkSpaceDataRelation *relation = workspace->scene_viewlayer_relations.first;
2881 relation = relation->next)
2883 relation->parent = newlibadr(fd, id->lib, relation->parent);
2884 /* relation->value is set in direct_link_workspace_link_scene_data */
2887 for (WorkSpaceLayout *layout = layouts->first, *layout_next; layout; layout = layout_next) {
2888 bScreen *screen = newlibadr(fd, id->lib, BKE_workspace_layout_screen_get(layout));
2890 layout_next = layout->next;
2892 BKE_workspace_layout_screen_set(layout, screen);
2894 if (ID_IS_LINKED(id)) {
2897 /* delete temp layouts when appending */
2898 BKE_workspace_layout_remove(bmain, workspace, layout);
2904 id->tag &= ~LIB_TAG_NEED_LINK;
2908 static void direct_link_workspace(FileData *fd, WorkSpace *workspace, const Main *main)
2910 link_list(fd, BKE_workspace_layouts_get(workspace));
2911 link_list(fd, &workspace->hook_layout_relations);
2912 link_list(fd, &workspace->scene_viewlayer_relations);
2913 link_list(fd, &workspace->owner_ids);
2914 link_list(fd, &workspace->tools);
2916 for (WorkSpaceDataRelation *relation = workspace->hook_layout_relations.first;
2918 relation = relation->next)
2920 relation->parent = newglobadr(fd, relation->parent); /* data from window - need to access through global oldnew-map */
2921 relation->value = newdataadr(fd, relation->value);
2924 if (ID_IS_LINKED(&workspace->id)) {
2925 /* Appending workspace so render layer is likely from a different scene. Unset
2926 * now, when activating workspace later we set a valid one from current scene. */
2927 BKE_workspace_relations_free(&workspace->scene_viewlayer_relations);
2930 /* Same issue/fix as in direct_link_workspace_link_scene_data: Can't read workspace data
2931 * when reading windows, so have to update windows after/when reading workspaces. */
2932 for (wmWindowManager *wm = main->wm.first; wm; wm = wm->id.next) {
2933 for (wmWindow *win = wm->windows.first; win; win = win->next) {
2934 WorkSpaceLayout *act_layout = newdataadr(fd, BKE_workspace_active_layout_get(win->workspace_hook));
2936 BKE_workspace_active_layout_set(win->workspace_hook, act_layout);
2941 for (bToolRef *tref = workspace->tools.first; tref; tref = tref->next) {
2942 tref->runtime = NULL;
2946 static void lib_link_workspace_instance_hook(FileData *fd, WorkSpaceInstanceHook *hook, ID *id)
2948 WorkSpace *workspace = BKE_workspace_active_get(hook);
2949 BKE_workspace_active_set(hook, newlibadr(fd, id->lib, workspace));
2953 /* ************ READ MOTION PATHS *************** */
2955 /* direct data for cache */
2956 static void direct_link_motionpath(FileData *fd, bMotionPath *mpath)
2962 /* relink points cache */
2963 mpath->points = newdataadr(fd, mpath->points);
2966 /* ************ READ NODE TREE *************** */
2968 /* Single node tree (also used for material/scene trees), ntree is not NULL */
2969 static void lib_link_ntree(FileData *fd, ID *id, bNodeTree *ntree)
2974 IDP_LibLinkProperty(ntree->id.properties, fd);
2975 lib_link_animdata(fd, &ntree->id, ntree->adt);
2977 ntree->gpd = newlibadr_us(fd, id->lib, ntree->gpd);
2979 for (node = ntree->nodes.first; node; node = node->next) {
2980 /* Link ID Properties -- and copy this comment EXACTLY for easy finding
2981 * of library blocks that implement this.*/
2982 IDP_LibLinkProperty(node->prop, fd);
2984 node->id = newlibadr_us(fd, id->lib, node->id);
2986 for (sock = node->inputs.first; sock; sock = sock->next) {
2987 IDP_LibLinkProperty(sock->prop, fd);
2989 for (sock = node->outputs.first; sock; sock = sock->next) {
2990 IDP_LibLinkProperty(sock->prop, fd);
2994 for (sock = ntree->inputs.first; sock; sock = sock->next) {
2995 IDP_LibLinkProperty(sock->prop, fd);
2997 for (sock = ntree->outputs.first; sock; sock = sock->next) {
2998 IDP_LibLinkProperty(sock->prop, fd);
3002 /* library ntree linking after fileread */
3003 static void lib_link_nodetree(FileData *fd, Main *main)
3005 /* only link ID pointers */
3006 for (bNodeTree *ntree = main->nodetree.first; ntree; ntree = ntree->id.next) {
3007 if (ntree->id.tag & LIB_TAG_NEED_LINK) {
3008 lib_link_ntree(fd, &ntree->id, ntree);
3010 ntree->id.tag &= ~LIB_TAG_NEED_LINK;
3015 /* updates group node socket identifier so that
3016 * external links to/from the group node are preserved.
3018 static void lib_node_do_versions_group_indices(bNode *gnode)
3020 bNodeTree *ngroup = (bNodeTree*)gnode->id;
3024 for (sock=gnode->outputs.first; sock; sock = sock->next) {
3025 int old_index = sock->to_index;
3027 for (link = ngroup->links.first; link; link = link->next) {
3028 if (link->tonode == NULL && link->fromsock->own_index == old_index) {
3029 strcpy(sock->identifier, link->fromsock->identifier);
3031 sock->own_index = link->fromsock->own_index;
3033 sock->groupsock = NULL;
3037 for (sock=gnode->inputs.first; sock; sock = sock->next) {
3038 int old_index = sock->to_index;
3040 for (link = ngroup->links.first; link; link = link->next) {
3041 if (link->fromnode == NULL && link->tosock->own_index == old_index) {
3042 strcpy(sock->identifier, link->tosock->identifier);
3044 sock->own_index = link->tosock->own_index;
3046 sock->groupsock = NULL;
3052 /* verify types for nodes and groups, all data has to be read */
3053 /* open = 0: appending/linking, open = 1: open new file (need to clean out dynamic
3055 static void lib_verify_nodetree(Main *main, int UNUSED(open))
3057 /* this crashes blender on undo/redo */
3060 reinit_nodesystem();
3064 /* set node->typeinfo pointers */
3065 FOREACH_NODETREE(main, ntree, id) {
3066 ntreeSetTypes(NULL, ntree);
3067 } FOREACH_NODETREE_END
3069 /* verify static socket templates */
3070 FOREACH_NODETREE(main, ntree, id) {
3072 for (node=ntree->nodes.first; node; node=node->next)
3073 node_verify_socket_templates(ntree, node);
3074 } FOREACH_NODETREE_END
3077 bool has_old_groups = false;
3078 /* XXX this should actually be part of do_versions, but since we need
3079 * finished library linking, it is not possible there. Instead in do_versions
3080 * we have set the NTREE_DO_VERSIONS_GROUP_EXPOSE_2_56_2 flag, so at this point we can do the
3081 * actual group node updates.
3083 for (bNodeTree *ntree = main->nodetree.first; ntree; ntree = ntree->id.next) {
3084 if (ntree->flag & NTREE_DO_VERSIONS_GROUP_EXPOSE_2_56_2) {
3089 if (has_old_groups) {
3090 FOREACH_NODETREE(main, ntree, id) {
3091 /* updates external links for all group nodes in a tree */
3093 for (node = ntree->nodes.first; node; node = node->next) {
3094 if (node->type == NODE_GROUP) {
3095 bNodeTree *ngroup = (bNodeTree*)node->id;
3096 if (ngroup && (ngroup->flag & NTREE_DO_VERSIONS_GROUP_EXPOSE_2_56_2))
3097 lib_node_do_versions_group_indices(node);
3100 } FOREACH_NODETREE_END
3103 for (bNodeTree *ntree = main->nodetree.first; ntree; ntree = ntree->id.next) {
3104 ntree->flag &= ~NTREE_DO_VERSIONS_GROUP_EXPOSE_2_56_2;
3109 /* Convert the previously used ntree->inputs/ntree->outputs lists to interface nodes.
3110 * Pre 2.56.2 node trees automatically have all unlinked sockets exposed already
3111 * (see NTREE_DO_VERSIONS_GROUP_EXPOSE_2_56_2).
3113 * XXX this should actually be part of do_versions,
3114 * but needs valid typeinfo pointers to create interface nodes.
3116 * Note: theoretically only needed in node groups (main->nodetree),
3117 * but due to a temporary bug such links could have been added in all trees,
3118 * so have to clean up all of them ...
3121 FOREACH_NODETREE(main, ntree, id) {
3122 if (ntree->flag & NTREE_DO_VERSIONS_CUSTOMNODES_GROUP) {
3123 bNode *input_node = NULL, *output_node = NULL;
3124 int num_inputs = 0, num_outputs = 0;
3125 bNodeLink *link, *next_link;
3126 /* Only create new interface nodes for actual older files.
3127 * New file versions already have input/output nodes with duplicate links,
3128 * in that case just remove the invalid links.
3130 const bool create_io_nodes = (ntree->flag & NTREE_DO_VERSIONS_CUSTOMNODES_GROUP_CREATE_INTERFACE) != 0;
3132 float input_locx = 1000000.0f, input_locy = 0.0f;
3133 float output_locx = -1000000.0f, output_locy = 0.0f;
3134 /* rough guess, not nice but we don't have access to UI constants here ... */
3135 static const float offsetx = 42 + 3*20 + 20;
3136 /*static const float offsety = 0.0f;*/
3138 if (create_io_nodes) {
3139 if (ntree->inputs.first)
3140 input_node = nodeAddStaticNode(NULL, ntree, NODE_GROUP_INPUT);
3142 if (ntree->outputs.first)
3143 output_node = nodeAddStaticNode(NULL, ntree, NODE_GROUP_OUTPUT);
3146 /* Redirect links from/to the node tree interface to input/output node.
3147 * If the fromnode/tonode pointers are NULL, this means a link from/to
3148 * the ntree interface sockets, which need to be redirected to new interface nodes.
3150 for (link = ntree->links.first; link; link = next_link) {
3151 bool free_link = false;
3152 next_link = link->next;
3154 if (link->fromnode == NULL) {
3156 link->fromnode = input_node;
3157 link->fromsock = node_group_input_find_socket(input_node, link->fromsock->identifier);
3161 if (input_locx > link->tonode->locx - offsetx)
3162 input_locx = link->tonode->locx - offsetx;
3163 input_locy += link->tonode->locy;
3171 if (link->tonode == NULL) {
3173 link->tonode = output_node;
3174 link->tosock = node_group_output_find_socket(output_node, link->tosock->identifier);
3177 if (link->fromnode) {
3178 if (output_locx < link->fromnode->locx + offsetx)
3179 output_locx = link->fromnode->locx + offsetx;
3180 output_locy += link->fromnode->locy;
3189 nodeRemLink(ntree, link);
3192 if (num_inputs > 0) {