[#34013] [video sequence editor] Offset and crop of strips are wrong
[blender.git] / source / blender / blenkernel / BKE_pointcache.h
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  * The Original Code is Copyright (C) 2006 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Campbell Barton <ideasman42@gmail.com>
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BKE_POINTCACHE_H__
29 #define __BKE_POINTCACHE_H__
30
31 /** \file BKE_pointcache.h
32  *  \ingroup bke
33  */
34
35 #include "DNA_ID.h"
36 #include "DNA_dynamicpaint_types.h"
37 #include "DNA_object_force.h"
38 #include "DNA_boid_types.h"
39 #include <stdio.h> /* for FILE */
40
41 /* Point cache clearing option, for BKE_ptcache_id_clear, before
42  * and after are non inclusive (they wont remove the cfra) */
43 #define PTCACHE_CLEAR_ALL       0
44 #define PTCACHE_CLEAR_FRAME     1
45 #define PTCACHE_CLEAR_BEFORE    2
46 #define PTCACHE_CLEAR_AFTER     3
47
48 /* Point cache reset options */
49 #define PTCACHE_RESET_DEPSGRAPH     0
50 #define PTCACHE_RESET_BAKED         1
51 #define PTCACHE_RESET_OUTDATED      2
52 /* #define PTCACHE_RESET_FREE                   3 */ /*UNUSED*/
53
54 /* Add the blendfile name after blendcache_ */
55 #define PTCACHE_EXT ".bphys"
56 #define PTCACHE_PATH "blendcache_"
57
58 /* File open options, for BKE_ptcache_file_open */
59 #define PTCACHE_FILE_READ   0
60 #define PTCACHE_FILE_WRITE  1
61 #define PTCACHE_FILE_UPDATE 2
62
63 /* PTCacheID types */
64 #define PTCACHE_TYPE_SOFTBODY           0
65 #define PTCACHE_TYPE_PARTICLES          1
66 #define PTCACHE_TYPE_CLOTH              2
67 #define PTCACHE_TYPE_SMOKE_DOMAIN       3
68 #define PTCACHE_TYPE_SMOKE_HIGHRES      4
69 #define PTCACHE_TYPE_DYNAMICPAINT       5
70 #define PTCACHE_TYPE_RIGIDBODY          6
71
72 /* high bits reserved for flags that need to be stored in file */
73 #define PTCACHE_TYPEFLAG_COMPRESS       (1 << 16)
74 #define PTCACHE_TYPEFLAG_EXTRADATA      (1 << 17)
75
76 #define PTCACHE_TYPEFLAG_TYPEMASK           0x0000FFFF
77 #define PTCACHE_TYPEFLAG_FLAGMASK           0xFFFF0000
78
79 /* PTCache read return code */
80 #define PTCACHE_READ_EXACT              1
81 #define PTCACHE_READ_INTERPOLATED       2
82 #define PTCACHE_READ_OLD                3
83
84 /* Structs */
85 struct ClothModifierData;
86 struct ListBase;
87 struct Main;
88 struct Object;
89 struct ParticleKey;
90 struct ParticleSystem;
91 struct PointCache;
92 struct Scene;
93 struct SmokeModifierData;
94 struct SoftBody;
95 struct RigidBodyWorld;
96
97 /* temp structure for read/write */
98 typedef struct PTCacheData {
99         unsigned int index;
100         float loc[3];
101         float vel[3];
102         float rot[4];
103         float ave[3];
104         float size;
105         float times[3];
106         struct BoidData boids;
107 } PTCacheData;
108
109 typedef struct PTCacheFile {
110         FILE *fp;
111
112         int frame, old_format;
113         unsigned int totpoint, type;
114         unsigned int data_types, flag;
115
116         struct PTCacheData data;
117         void *cur[BPHYS_TOT_DATA];
118 } PTCacheFile;
119
120 #define PTCACHE_VEL_PER_SEC     1
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;
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.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 custom extradata to cache data */
151         void (*write_extra_data)(void *calldata, struct PTCacheMem *pm, int cfra);
152         /* copies custom extradata to cache data */
153         void (*read_extra_data)(void *calldata, struct PTCacheMem *pm, float cfra);
154         /* copies custom extradata to cache data */
155         void (*interpolate_extra_data)(void *calldata, struct PTCacheMem *pm, float cfra, float cfra1, float cfra2);
156
157         /* total number of simulated points (the cfra parameter is just for using same function pointer with totwrite) */
158         int (*totpoint)(void *calldata, int cfra);
159         /* number of points written for current cache frame */
160         int (*totwrite)(void *calldata, int cfra);
161
162         int (*write_header)(PTCacheFile *pf);
163         int (*read_header)(PTCacheFile *pf);
164
165         struct PointCache *cache;
166         /* used for setting the current cache from ptcaches list */
167         struct PointCache **cache_ptr;
168         struct ListBase *ptcaches;
169 } PTCacheID;
170
171 typedef struct PTCacheBaker {
172         struct Main *main;
173         struct Scene *scene;
174         int bake;
175         int render;
176         int anim_init;
177         int quick_step;
178         struct PTCacheID *pid;
179         int (*break_test)(void *data);
180         void *break_data;
181         void (*progressbar)(void *data, int num);
182         void (*progressend)(void *data);
183         void *progresscontext;
184 } PTCacheBaker;
185
186 /* PTCacheEditKey->flag */
187 #define PEK_SELECT      1
188 #define PEK_TAG         2
189 #define PEK_HIDE        4
190 #define PEK_USE_WCO     8
191
192 typedef struct PTCacheEditKey {
193         float *co;
194         float *vel;
195         float *rot;
196         float *time;
197
198         float world_co[3];
199         float ftime;
200         float length;
201         short flag;
202 } PTCacheEditKey;
203
204 /* PTCacheEditPoint->flag */
205 #define PEP_TAG             1
206 #define PEP_EDIT_RECALC     2
207 #define PEP_TRANSFORM       4
208 #define PEP_HIDE            8
209
210 typedef struct PTCacheEditPoint {
211         struct PTCacheEditKey *keys;
212         int totkey;
213         short flag;
214 } PTCacheEditPoint;
215
216 typedef struct PTCacheUndo {
217         struct PTCacheUndo *next, *prev;
218         struct PTCacheEditPoint *points;
219
220         /* particles stuff */
221         struct ParticleData *particles;
222         struct KDTree *emitter_field;
223         float *emitter_cosnos;
224         int psys_flag;
225
226         /* cache stuff */
227         struct ListBase mem_cache;
228
229         int totpoint;
230         char name[64];
231 } PTCacheUndo;
232
233 typedef struct PTCacheEdit {
234         ListBase undo;
235         struct PTCacheUndo *curundo;
236         PTCacheEditPoint *points;
237
238         struct PTCacheID pid;
239
240         /* particles stuff */
241         struct ParticleSystem *psys;
242         struct ParticleData *particles;
243         struct KDTree *emitter_field;
244         float *emitter_cosnos; /* localspace face centers and normals (average of its verts), from the derived mesh */
245         int *mirror_cache;
246
247         struct ParticleCacheKey **pathcache;    /* path cache (runtime) */
248         ListBase pathcachebufs;
249
250         int totpoint, totframes, totcached, edited;
251
252         unsigned char sel_col[3];
253         unsigned char nosel_col[3];
254 } PTCacheEdit;
255
256 /* Particle functions */
257 void BKE_ptcache_make_particle_key(struct ParticleKey *key, int index, void **data, float time);
258
259 /**************** Creating ID's ****************************/
260 void BKE_ptcache_id_from_softbody(PTCacheID *pid, struct Object *ob, struct SoftBody *sb);
261 void BKE_ptcache_id_from_particles(PTCacheID *pid, struct Object *ob, struct ParticleSystem *psys);
262 void BKE_ptcache_id_from_cloth(PTCacheID *pid, struct Object *ob, struct ClothModifierData *clmd);
263 void BKE_ptcache_id_from_smoke(PTCacheID *pid, struct Object *ob, struct SmokeModifierData *smd);
264 void BKE_ptcache_id_from_dynamicpaint(PTCacheID *pid, struct Object *ob, struct DynamicPaintSurface *surface);
265 void BKE_ptcache_id_from_rigidbody(PTCacheID *pid, struct Object *ob, struct RigidBodyWorld *rbw);
266
267 void BKE_ptcache_ids_from_object(struct ListBase *lb, struct Object *ob, struct Scene *scene, int duplis);
268
269 /***************** Global funcs ****************************/
270 void BKE_ptcache_remove(void);
271
272 /************ ID specific functions ************************/
273 void    BKE_ptcache_id_clear(PTCacheID *id, int mode, unsigned int cfra);
274 int     BKE_ptcache_id_exist(PTCacheID *id, int cfra);
275 int     BKE_ptcache_id_reset(struct Scene *scene, PTCacheID *id, int mode);
276 void    BKE_ptcache_id_time(PTCacheID *pid, struct Scene *scene, float cfra, int *startframe, int *endframe, float *timescale);
277 int     BKE_ptcache_object_reset(struct Scene *scene, struct Object *ob, int mode);
278
279 void BKE_ptcache_update_info(PTCacheID *pid);
280
281 /*********** General cache reading/writing ******************/
282
283 /* Size of cache data type. */
284 int     BKE_ptcache_data_size(int data_type);
285
286 /* Is point with indes in memory cache */
287 int BKE_ptcache_mem_index_find(struct PTCacheMem *pm, unsigned int index);
288
289 /* Memory cache read/write helpers. */
290 void BKE_ptcache_mem_pointers_init(struct PTCacheMem *pm);
291 void BKE_ptcache_mem_pointers_incr(struct PTCacheMem *pm);
292 int  BKE_ptcache_mem_pointers_seek(int point_index, struct PTCacheMem *pm);
293
294 /* Main cache reading call. */
295 int     BKE_ptcache_read(PTCacheID *pid, float cfra);
296
297 /* Main cache writing call. */
298 int     BKE_ptcache_write(PTCacheID *pid, unsigned int cfra);
299
300 /******************* Allocate & free ***************/
301 struct PointCache *BKE_ptcache_add(struct ListBase *ptcaches);
302 void BKE_ptcache_free_mem(struct ListBase *mem_cache);
303 void BKE_ptcache_free(struct PointCache *cache);
304 void BKE_ptcache_free_list(struct ListBase *ptcaches);
305 struct PointCache *BKE_ptcache_copy_list(struct ListBase *ptcaches_new, struct ListBase *ptcaches_old, int copy_data);
306
307 /********************** Baking *********************/
308
309 /* Bakes cache with cache_step sized jumps in time, not accurate but very fast. */
310 void BKE_ptcache_quick_cache_all(struct Main *bmain, struct Scene *scene);
311
312 /* Bake cache or simulate to current frame with settings defined in the baker. */
313 void BKE_ptcache_bake(struct PTCacheBaker *baker);
314
315 /* Convert disk cache to memory cache. */
316 void BKE_ptcache_disk_to_mem(struct PTCacheID *pid);
317
318 /* Convert memory cache to disk cache. */
319 void BKE_ptcache_mem_to_disk(struct PTCacheID *pid);
320
321 /* Convert disk cache to memory cache and vice versa. Clears the cache that was converted. */
322 void BKE_ptcache_toggle_disk_cache(struct PTCacheID *pid);
323
324 /* Rename all disk cache files with a new name. Doesn't touch the actual content of the files. */
325 void BKE_ptcache_disk_cache_rename(struct PTCacheID *pid, const char *name_src, const char *name_dst);
326
327 /* Loads simulation from external (disk) cache files. */
328 void BKE_ptcache_load_external(struct PTCacheID *pid);
329
330 /* Set correct flags after successful simulation step */
331 void BKE_ptcache_validate(struct PointCache *cache, int framenr);
332
333 /* Set correct flags after unsuccessful simulation step */
334 void BKE_ptcache_invalidate(struct PointCache *cache);
335
336 #endif