Merge branch 'master' into blender2.8
[blender.git] / source / blender / modifiers / intern / MOD_meshsequencecache.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
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.
8  *
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.
13  *
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.
17  *
18  * Contributor(s): Campbell Barton
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/modifiers/intern/MOD_meshsequencecache.c
24  *  \ingroup modifiers
25  */
26
27 #include "DNA_cachefile_types.h"
28 #include "DNA_mesh_types.h"
29 #include "DNA_modifier_types.h"
30 #include "DNA_object_types.h"
31 #include "DNA_scene_types.h"
32
33 #include "BKE_cachefile.h"
34 #include "BKE_DerivedMesh.h"
35 #include "BKE_cdderivedmesh.h"
36 #include "BKE_global.h"
37 #include "BKE_library.h"
38 #include "BKE_library_query.h"
39 #include "BKE_scene.h"
40
41 #include "DEG_depsgraph_build.h"
42
43 #include "MOD_modifiertypes.h"
44
45 #ifdef WITH_ALEMBIC
46 #       include "ABC_alembic.h"
47 #endif
48
49 static void initData(ModifierData *md)
50 {
51         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *)md;
52
53         mcmd->cache_file = NULL;
54         mcmd->object_path[0] = '\0';
55         mcmd->read_flag = MOD_MESHSEQ_READ_ALL;
56 }
57
58 static void copyData(ModifierData *md, ModifierData *target)
59 {
60 #if 0
61         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *)md;
62 #endif
63         MeshSeqCacheModifierData *tmcmd = (MeshSeqCacheModifierData *)target;
64
65         modifier_copyData_generic(md, target);
66
67         if (tmcmd->cache_file) {
68                 id_us_plus(&tmcmd->cache_file->id);
69                 tmcmd->reader = NULL;
70         }
71 }
72
73 static void freeData(ModifierData *md)
74 {
75         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
76
77         if (mcmd->cache_file) {
78                 id_us_min(&mcmd->cache_file->id);
79         }
80
81         if (mcmd->reader) {
82 #ifdef WITH_ALEMBIC
83                 CacheReader_free(mcmd->reader);
84 #endif
85                 mcmd->reader = NULL;
86         }
87 }
88
89 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
90 {
91         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
92
93         /* leave it up to the modifier to check the file is valid on calculation */
94         return (mcmd->cache_file == NULL) || (mcmd->object_path[0] == '\0');
95 }
96
97 static DerivedMesh *applyModifier(ModifierData *md, struct EvaluationContext *UNUSED(eval_ctx),
98                                   Object *ob, DerivedMesh *dm,
99                                   ModifierApplyFlag UNUSED(flag))
100 {
101 #ifdef WITH_ALEMBIC
102         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
103
104         /* Only used to check wehther we are operating on org data or not... */
105         Mesh *me = (ob->type == OB_MESH) ? ob->data : NULL;
106         DerivedMesh *org_dm = dm;
107
108         Scene *scene = md->scene;
109         const float frame = BKE_scene_frame_get(scene);
110         const float time = BKE_cachefile_time_offset(mcmd->cache_file, frame, FPS);
111
112         const char *err_str = NULL;
113
114         CacheFile *cache_file = mcmd->cache_file;
115
116         BKE_cachefile_ensure_handle(G.main, cache_file);
117
118         if (!mcmd->reader) {
119                 mcmd->reader = CacheReader_open_alembic_object(cache_file->handle,
120                                                                NULL,
121                                                                ob,
122                                                                mcmd->object_path);
123                 if (!mcmd->reader) {
124                         modifier_setError(md, "Could not create Alembic reader for file %s", cache_file->filepath);
125                         return dm;
126                 }
127         }
128
129         if (me != NULL) {
130                 MVert *mvert = dm->getVertArray(dm);
131                 MEdge *medge = dm->getEdgeArray(dm);
132                 MPoly *mpoly = dm->getPolyArray(dm);
133                 if ((me->mvert == mvert) || (me->medge == medge) || (me->mpoly == mpoly)) {
134                         /* We need to duplicate data here, otherwise we'll modify org mesh, see T51701. */
135                         dm = CDDM_copy(dm);
136                 }
137         }
138
139         DerivedMesh *result = ABC_read_mesh(mcmd->reader,
140                                             ob,
141                                             dm,
142                                             time,
143                                             &err_str,
144                                             mcmd->read_flag);
145
146         if (err_str) {
147                 modifier_setError(md, "%s", err_str);
148         }
149
150         if (!ELEM(result, NULL, dm) && (dm != org_dm)) {
151                 dm->release(dm);
152                 dm = org_dm;
153         }
154
155         return result ? result : dm;
156 #else
157         return dm;
158         UNUSED_VARS(md, ob);
159 #endif
160 }
161
162 static bool dependsOnTime(ModifierData *md)
163 {
164         UNUSED_VARS(md);
165         return true;
166 }
167
168 static void foreachIDLink(ModifierData *md, Object *ob,
169                           IDWalkFunc walk, void *userData)
170 {
171         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
172
173         walk(userData, ob, (ID **)&mcmd->cache_file, IDWALK_CB_USER);
174 }
175
176
177 static void updateDepsgraph(ModifierData *md,
178                             struct Main *bmain,
179                             struct Scene *scene,
180                             Object *ob,
181                             struct DepsNodeHandle *node)
182 {
183         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
184
185         if (mcmd->cache_file != NULL) {
186                 DEG_add_object_cache_relation(node, mcmd->cache_file, DEG_OB_COMP_CACHE, "Mesh Cache File");
187         }
188
189         UNUSED_VARS(bmain, scene, ob);
190 }
191
192 ModifierTypeInfo modifierType_MeshSequenceCache = {
193     /* name */              "Mesh Sequence Cache",
194     /* structName */        "MeshSeqCacheModifierData",
195     /* structSize */        sizeof(MeshSeqCacheModifierData),
196     /* type */              eModifierTypeType_Constructive,
197     /* flags */             eModifierTypeFlag_AcceptsMesh |
198                             eModifierTypeFlag_AcceptsCVs,
199     /* copyData */          copyData,
200     /* deformVerts */       NULL,
201     /* deformMatrices */    NULL,
202     /* deformVertsEM */     NULL,
203     /* deformMatricesEM */  NULL,
204     /* applyModifier */     applyModifier,
205     /* applyModifierEM */   NULL,
206     /* initData */          initData,
207     /* requiredDataMask */  NULL,
208     /* freeData */          freeData,
209     /* isDisabled */        isDisabled,
210     /* updateDepsgraph */   updateDepsgraph,
211     /* dependsOnTime */     dependsOnTime,
212     /* dependsOnNormals */  NULL,
213     /* foreachObjectLink */ NULL,
214     /* foreachIDLink */     foreachIDLink,
215     /* foreachTexLink */    NULL,
216 };