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