Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / BKE_pointcache.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software  Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2006 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_POINTCACHE_H__
21 #define __BKE_POINTCACHE_H__
22
23 /** \file \ingroup bke
24  */
25
26 #include "DNA_ID.h"
27 #include "DNA_dynamicpaint_types.h"
28 #include "DNA_object_force_types.h"
29 #include "DNA_boid_types.h"
30 #include <stdio.h> /* for FILE */
31
32 /* Point cache clearing option, for BKE_ptcache_id_clear, before
33  * and after are non inclusive (they wont remove the cfra) */
34 #define PTCACHE_CLEAR_ALL       0
35 #define PTCACHE_CLEAR_FRAME     1
36 #define PTCACHE_CLEAR_BEFORE    2
37 #define PTCACHE_CLEAR_AFTER     3
38
39 /* Point cache reset options */
40 #define PTCACHE_RESET_DEPSGRAPH     0
41 #define PTCACHE_RESET_BAKED         1
42 #define PTCACHE_RESET_OUTDATED      2
43 /* #define PTCACHE_RESET_FREE                   3 */ /*UNUSED*/
44
45 /* Add the blendfile name after blendcache_ */
46 #define PTCACHE_EXT ".bphys"
47 #define PTCACHE_PATH "blendcache_"
48
49 /* File open options, for BKE_ptcache_file_open */
50 #define PTCACHE_FILE_READ   0
51 #define PTCACHE_FILE_WRITE  1
52 #define PTCACHE_FILE_UPDATE 2
53
54 /* PTCacheID types */
55 #define PTCACHE_TYPE_SOFTBODY           0
56 #define PTCACHE_TYPE_PARTICLES          1
57 #define PTCACHE_TYPE_CLOTH              2
58 #define PTCACHE_TYPE_SMOKE_DOMAIN       3
59 #define PTCACHE_TYPE_SMOKE_HIGHRES      4
60 #define PTCACHE_TYPE_DYNAMICPAINT       5
61 #define PTCACHE_TYPE_RIGIDBODY          6
62
63 /* high bits reserved for flags that need to be stored in file */
64 #define PTCACHE_TYPEFLAG_COMPRESS       (1 << 16)
65 #define PTCACHE_TYPEFLAG_EXTRADATA      (1 << 17)
66
67 #define PTCACHE_TYPEFLAG_TYPEMASK           0x0000FFFF
68 #define PTCACHE_TYPEFLAG_FLAGMASK           0xFFFF0000
69
70 /* PTCache read return code */
71 #define PTCACHE_READ_EXACT              1
72 #define PTCACHE_READ_INTERPOLATED       2
73 #define PTCACHE_READ_OLD                3
74
75 /* Structs */
76 struct ClothModifierData;
77 struct ListBase;
78 struct Main;
79 struct Object;
80 struct ParticleKey;
81 struct ParticleSystem;
82 struct PointCache;
83 struct RigidBodyWorld;
84 struct Scene;
85 struct SmokeModifierData;
86 struct SoftBody;
87 struct ViewLayer;
88
89 struct OpenVDBReader;
90 struct OpenVDBWriter;
91
92 /* temp structure for read/write */
93 typedef struct PTCacheData {
94         unsigned int index;
95         float loc[3];
96         float vel[3];
97         float rot[4];
98         float ave[3];
99         float size;
100         float times[3];
101         struct BoidData boids;
102 } PTCacheData;
103
104 typedef struct PTCacheFile {
105         FILE *fp;
106
107         int frame, old_format;
108         unsigned int totpoint, type;
109         unsigned int data_types, flag;
110
111         struct PTCacheData data;
112         void *cur[BPHYS_TOT_DATA];
113 } PTCacheFile;
114
115 #define PTCACHE_VEL_PER_SEC     1
116
117 enum {
118         PTCACHE_FILE_PTCACHE = 0,
119         PTCACHE_FILE_OPENVDB = 1,
120 };
121
122 typedef struct PTCacheID {
123         struct PTCacheID *next, *prev;
124
125         struct Scene *scene;
126         struct Object *ob;
127         void *calldata;
128         unsigned int type, file_type;
129         unsigned int stack_index;
130         unsigned int flag;
131
132         unsigned int default_step;
133         unsigned int max_step;
134
135         /* flags defined in DNA_object_force_types.h */
136         unsigned int data_types, info_types;
137
138         /* copies point data to cache data */
139         int (*write_point)(int index, void *calldata, void **data, int cfra);
140         /* copies cache cata to point data */
141         void (*read_point)(int index, void *calldata, void **data, float cfra, float *old_data);
142         /* interpolated between previously read point data and cache data */
143         void (*interpolate_point)(int index, void *calldata, void **data, float cfra, float cfra1, float cfra2, float *old_data);
144
145         /* copies point data to cache data */
146         int (*write_stream)(PTCacheFile *pf, void *calldata);
147         /* copies cache cata to point data */
148         int (*read_stream)(PTCacheFile *pf, void *calldata);
149
150         /* copies point data to cache data */
151         int (*write_openvdb_stream)(struct OpenVDBWriter *writer, void *calldata);
152         /* copies cache cata to point data */
153         int (*read_openvdb_stream)(struct OpenVDBReader *reader, void *calldata);
154
155         /* copies custom extradata to cache data */
156         void (*write_extra_data)(void *calldata, struct PTCacheMem *pm, int cfra);
157         /* copies custom extradata to cache data */
158         void (*read_extra_data)(void *calldata, struct PTCacheMem *pm, float cfra);
159         /* copies custom extradata to cache data */
160         void (*interpolate_extra_data)(void *calldata, struct PTCacheMem *pm, float cfra, float cfra1, float cfra2);
161
162         /* total number of simulated points (the cfra parameter is just for using same function pointer with totwrite) */
163         int (*totpoint)(void *calldata, int cfra);
164         /* report error if number of points does not match */
165         void (*error)(void *calldata, const char *message);
166         /* number of points written for current cache frame */
167         int (*totwrite)(void *calldata, int cfra);
168
169         int (*write_header)(PTCacheFile *pf);
170         int (*read_header)(PTCacheFile *pf);
171
172         struct PointCache *cache;
173         /* used for setting the current cache from ptcaches list */
174         struct PointCache **cache_ptr;
175         struct ListBase *ptcaches;
176 } PTCacheID;
177
178 typedef struct PTCacheBaker {
179         struct Main *bmain;
180         struct Scene *scene;
181         struct ViewLayer *view_layer;
182         struct Depsgraph *depsgraph;
183         int bake;
184         int render;
185         int anim_init;
186         int quick_step;
187         struct PTCacheID pid;
188
189         void (*update_progress)(void *data, float progress, int *cancel);
190         void *bake_job;
191 } PTCacheBaker;
192
193 /* PTCacheEditKey->flag */
194 #define PEK_SELECT      1
195 #define PEK_TAG         2
196 #define PEK_HIDE        4
197 #define PEK_USE_WCO     8
198
199 typedef struct PTCacheEditKey {
200         float *co;
201         float *vel;
202         float *rot;
203         float *time;
204
205         float world_co[3];
206         float ftime;
207         float length;
208         short flag;
209 } PTCacheEditKey;
210
211 /* PTCacheEditPoint->flag */
212 #define PEP_TAG             1
213 #define PEP_EDIT_RECALC     2
214 #define PEP_TRANSFORM       4
215 #define PEP_HIDE            8
216
217 typedef struct PTCacheEditPoint {
218         struct PTCacheEditKey *keys;
219         int totkey;
220         short flag;
221 } PTCacheEditPoint;
222
223 typedef struct PTCacheUndo {
224         struct PTCacheEditPoint *points;
225
226         /* particles stuff */
227         struct ParticleData *particles;
228         struct KDTree *emitter_field;
229         float *emitter_cosnos;
230         int psys_flag;
231
232         /* cache stuff */
233         struct ListBase mem_cache;
234
235         int totpoint;
236
237         size_t undo_size;
238 } PTCacheUndo;
239
240 enum {
241         /* Modifier stack got evaluated during particle edit mode, need to copy
242          * new evaluated particles to the edit struct.
243          */
244         PT_CACHE_EDIT_UPDATE_PARTICLE_FROM_EVAL = (1 << 0),
245 };
246
247 typedef struct PTCacheEdit {
248         int flags;
249
250         PTCacheEditPoint *points;
251
252         struct PTCacheID pid;
253
254         /* particles stuff */
255         struct ParticleSystem *psys;
256         struct ParticleSystem *psys_eval;
257         struct ParticleSystemModifierData *psmd;
258         struct ParticleSystemModifierData *psmd_eval;
259         struct KDTree *emitter_field;
260         float *emitter_cosnos; /* localspace face centers and normals (average of its verts), from the derived mesh */
261         int *mirror_cache;
262
263         struct ParticleCacheKey **pathcache;    /* path cache (runtime) */
264         ListBase pathcachebufs;
265
266         int totpoint, totframes, totcached, edited;
267
268         unsigned char sel_col[3];
269         unsigned char nosel_col[3];
270 } PTCacheEdit;
271
272 /* Particle functions */
273 void BKE_ptcache_make_particle_key(struct ParticleKey *key, int index, void **data, float time);
274
275 /**************** Creating ID's ****************************/
276 void BKE_ptcache_id_from_softbody(PTCacheID *pid, struct Object *ob, struct SoftBody *sb);
277 void BKE_ptcache_id_from_particles(PTCacheID *pid, struct Object *ob, struct ParticleSystem *psys);
278 void BKE_ptcache_id_from_cloth(PTCacheID *pid, struct Object *ob, struct ClothModifierData *clmd);
279 void BKE_ptcache_id_from_smoke(PTCacheID *pid, struct Object *ob, struct SmokeModifierData *smd);
280 void BKE_ptcache_id_from_dynamicpaint(PTCacheID *pid, struct Object *ob, struct DynamicPaintSurface *surface);
281 void BKE_ptcache_id_from_rigidbody(PTCacheID *pid, struct Object *ob, struct RigidBodyWorld *rbw);
282
283 PTCacheID BKE_ptcache_id_find(struct Object *ob, struct Scene *scene, struct PointCache *cache);
284 void BKE_ptcache_ids_from_object(
285         struct ListBase *lb, struct Object *ob, struct Scene *scene, int duplis);
286
287 /****************** Query funcs ****************************/
288
289 /* Check whether object has a point cache. */
290 bool BKE_ptcache_object_has(struct Scene *scene, struct Object *ob, int duplis);
291
292 /***************** Global funcs ****************************/
293 void BKE_ptcache_remove(void);
294
295 /************ ID specific functions ************************/
296 void    BKE_ptcache_id_clear(PTCacheID *id, int mode, unsigned int cfra);
297 int     BKE_ptcache_id_exist(PTCacheID *id, int cfra);
298 int     BKE_ptcache_id_reset(struct Scene *scene, PTCacheID *id, int mode);
299 void    BKE_ptcache_id_time(PTCacheID *pid, struct Scene *scene, float cfra, int *startframe, int *endframe, float *timescale);
300 int     BKE_ptcache_object_reset(struct Scene *scene, struct Object *ob, int mode);
301
302 void BKE_ptcache_update_info(PTCacheID *pid);
303
304 /*********** General cache reading/writing ******************/
305
306 /* Size of cache data type. */
307 int     BKE_ptcache_data_size(int data_type);
308
309 /* Is point with index in memory cache */
310 int BKE_ptcache_mem_index_find(struct PTCacheMem *pm, unsigned int index);
311
312 /* Memory cache read/write helpers. */
313 void BKE_ptcache_mem_pointers_init(struct PTCacheMem *pm);
314 void BKE_ptcache_mem_pointers_incr(struct PTCacheMem *pm);
315 int  BKE_ptcache_mem_pointers_seek(int point_index, struct PTCacheMem *pm);
316
317 /* Main cache reading call. */
318 int     BKE_ptcache_read(PTCacheID *pid, float cfra, bool no_extrapolate_old);
319
320 /* Main cache writing call. */
321 int     BKE_ptcache_write(PTCacheID *pid, unsigned int cfra);
322
323 /******************* Allocate & free ***************/
324 struct PointCache *BKE_ptcache_add(struct ListBase *ptcaches);
325 void BKE_ptcache_free_mem(struct ListBase *mem_cache);
326 void BKE_ptcache_free(struct PointCache *cache);
327 void BKE_ptcache_free_list(struct ListBase *ptcaches);
328 struct PointCache *BKE_ptcache_copy_list(struct ListBase *ptcaches_new, const struct ListBase *ptcaches_old, const int flag);
329
330 /********************** Baking *********************/
331
332 /* Bakes cache with cache_step sized jumps in time, not accurate but very fast. */
333 void BKE_ptcache_quick_cache_all(struct Main *bmain, struct Scene *scene, struct ViewLayer *view_layer);
334
335 /* Bake cache or simulate to current frame with settings defined in the baker. */
336 void BKE_ptcache_bake(struct PTCacheBaker *baker);
337
338 /* Convert disk cache to memory cache. */
339 void BKE_ptcache_disk_to_mem(struct PTCacheID *pid);
340
341 /* Convert memory cache to disk cache. */
342 void BKE_ptcache_mem_to_disk(struct PTCacheID *pid);
343
344 /* Convert disk cache to memory cache and vice versa. Clears the cache that was converted. */
345 void BKE_ptcache_toggle_disk_cache(struct PTCacheID *pid);
346
347 /* Rename all disk cache files with a new name. Doesn't touch the actual content of the files. */
348 void BKE_ptcache_disk_cache_rename(struct PTCacheID *pid, const char *name_src, const char *name_dst);
349
350 /* Loads simulation from external (disk) cache files. */
351 void BKE_ptcache_load_external(struct PTCacheID *pid);
352
353 /* Set correct flags after successful simulation step */
354 void BKE_ptcache_validate(struct PointCache *cache, int framenr);
355
356 /* Set correct flags after unsuccessful simulation step */
357 void BKE_ptcache_invalidate(struct PointCache *cache);
358
359 #endif