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_library.h"
37 #include "BKE_library_query.h"
38 #include "BKE_scene.h"
39
40 #include "DEG_depsgraph_build.h"
41
42 #include "MOD_modifiertypes.h"
43
44 #ifdef WITH_ALEMBIC
45 #       include "ABC_alembic.h"
46 #       include "BKE_global.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(const ModifierData *md, ModifierData *target)
59 {
60 #if 0
61         const MeshSeqCacheModifierData *mcmd = (const MeshSeqCacheModifierData *)md;
62 #endif
63         MeshSeqCacheModifierData *tmcmd = (MeshSeqCacheModifierData *)target;
64
65         modifier_copyData_generic(md, target);
66
67         tmcmd->reader = NULL;
68 }
69
70 static void freeData(ModifierData *md)
71 {
72         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
73
74         if (mcmd->reader) {
75 #ifdef WITH_ALEMBIC
76                 CacheReader_free(mcmd->reader);
77 #endif
78                 mcmd->reader = NULL;
79         }
80 }
81
82 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
83 {
84         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
85
86         /* leave it up to the modifier to check the file is valid on calculation */
87         return (mcmd->cache_file == NULL) || (mcmd->object_path[0] == '\0');
88 }
89
90 static DerivedMesh *applyModifier(ModifierData *md, const ModifierEvalContext *ctx,
91                                   DerivedMesh *dm)
92 {
93 #ifdef WITH_ALEMBIC
94         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
95
96         /* Only used to check whether we are operating on org data or not... */
97         Mesh *me = (ctx->object->type == OB_MESH) ? ctx->object->data : NULL;
98         DerivedMesh *org_dm = dm;
99
100         Scene *scene = md->scene;
101         const float frame = BKE_scene_frame_get(scene);
102         const float time = BKE_cachefile_time_offset(mcmd->cache_file, frame, FPS);
103         const char *err_str = NULL;
104
105         CacheFile *cache_file = mcmd->cache_file;
106
107         BKE_cachefile_ensure_handle(G.main, cache_file);
108
109         if (!mcmd->reader) {
110                 mcmd->reader = CacheReader_open_alembic_object(cache_file->handle,
111                                                                NULL,
112                                                                ctx->object,
113                                                                mcmd->object_path);
114                 if (!mcmd->reader) {
115                         modifier_setError(md, "Could not create Alembic reader for file %s", cache_file->filepath);
116                         return dm;
117                 }
118         }
119
120         if (me != NULL) {
121                 MVert *mvert = dm->getVertArray(dm);
122                 MEdge *medge = dm->getEdgeArray(dm);
123                 MPoly *mpoly = dm->getPolyArray(dm);
124                 if ((me->mvert == mvert) || (me->medge == medge) || (me->mpoly == mpoly)) {
125                         /* We need to duplicate data here, otherwise we'll modify org mesh, see T51701. */
126                         dm = CDDM_copy(dm);
127                 }
128         }
129
130         DerivedMesh *result = ABC_read_mesh(mcmd->reader,
131                                             ctx->object,
132                                             dm,
133                                             time,
134                                             &err_str,
135                                             mcmd->read_flag);
136
137         if (err_str) {
138                 modifier_setError(md, "%s", err_str);
139         }
140
141         if (!ELEM(result, NULL, dm) && (dm != org_dm)) {
142                 dm->release(dm);
143                 dm = org_dm;
144         }
145
146         return result ? result : dm;
147 #else
148         return dm;
149         UNUSED_VARS(ctx, md);
150 #endif
151 }
152
153 static bool dependsOnTime(ModifierData *md)
154 {
155         UNUSED_VARS(md);
156         return true;
157 }
158
159 static void foreachIDLink(ModifierData *md, Object *ob,
160                           IDWalkFunc walk, void *userData)
161 {
162         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
163
164         walk(userData, ob, (ID **)&mcmd->cache_file, IDWALK_CB_USER);
165 }
166
167
168 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
169 {
170         MeshSeqCacheModifierData *mcmd = (MeshSeqCacheModifierData *) md;
171
172         if (mcmd->cache_file != NULL) {
173                 DEG_add_object_cache_relation(ctx->node, mcmd->cache_file, DEG_OB_COMP_CACHE, "Mesh Cache File");
174         }
175 }
176
177 ModifierTypeInfo modifierType_MeshSequenceCache = {
178         /* name */              "Mesh Sequence Cache",
179         /* structName */        "MeshSeqCacheModifierData",
180         /* structSize */        sizeof(MeshSeqCacheModifierData),
181         /* type */              eModifierTypeType_Constructive,
182         /* flags */             eModifierTypeFlag_AcceptsMesh |
183                                 eModifierTypeFlag_AcceptsCVs,
184
185         /* copyData */          copyData,
186
187         /* deformVerts_DM */    NULL,
188         /* deformMatrices_DM */ NULL,
189         /* deformVertsEM_DM */  NULL,
190         /* deformMatricesEM_DM*/NULL,
191         /* applyModifier_DM */  applyModifier,
192         /* applyModifierEM_DM */NULL,
193
194         /* deformVerts */       NULL,
195         /* deformMatrices */    NULL,
196         /* deformVertsEM */     NULL,
197         /* deformMatricesEM */  NULL,
198         /* applyModifier */     NULL,
199         /* applyModifierEM */   NULL,
200
201         /* initData */          initData,
202         /* requiredDataMask */  NULL,
203         /* freeData */          freeData,
204         /* isDisabled */        isDisabled,
205         /* updateDepsgraph */   updateDepsgraph,
206         /* dependsOnTime */     dependsOnTime,
207         /* dependsOnNormals */  NULL,
208         /* foreachObjectLink */ NULL,
209         /* foreachIDLink */     foreachIDLink,
210         /* foreachTexLink */    NULL,
211 };