style cleanup
[blender-staging.git] / source / blender / modifiers / intern / MOD_fluidsim_util.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  * The Original Code is Copyright (C) 2005 by the Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Daniel Dunbar
22  *                 Ton Roosendaal,
23  *                 Ben Batt,
24  *                 Brecht Van Lommel,
25  *                 Campbell Barton
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  *
29  */
30
31 /** \file blender/modifiers/intern/MOD_fluidsim_util.c
32  *  \ingroup modifiers
33  */
34
35
36 #include <stddef.h>
37 #include <zlib.h>
38
39 #include "DNA_object_types.h"
40 #include "DNA_scene_types.h"
41 #include "DNA_mesh_types.h"
42 #include "DNA_meshdata_types.h"
43 #include "DNA_object_types.h"
44 #include "DNA_object_fluidsim.h"
45
46 #include "BLI_blenlib.h"
47 #include "BLI_math.h"
48 #include "BLI_utildefines.h"
49
50 #include "BKE_main.h"
51 #include "BKE_fluidsim.h" /* ensure definitions here match */
52 #include "BKE_cdderivedmesh.h"
53 #include "BKE_mesh.h"
54 #include "BKE_utildefines.h"
55 #include "BKE_global.h" /* G.main->name only */
56
57 #include "MOD_fluidsim_util.h"
58 #include "MOD_modifiertypes.h"
59
60 #include "MEM_guardedalloc.h"
61
62 // headers for fluidsim bobj meshes
63 #include "LBM_fluidsim.h"
64
65
66 void fluidsim_init(FluidsimModifierData *fluidmd)
67 {
68 #ifdef WITH_MOD_FLUID
69         if (fluidmd) {
70                 FluidsimSettings *fss = MEM_callocN(sizeof(FluidsimSettings), "fluidsimsettings");
71
72                 fluidmd->fss = fss;
73                 
74                 if (!fss)
75                         return;
76                 
77                 fss->fmd = fluidmd;
78                 fss->type = OB_FLUIDSIM_ENABLE;
79                 fss->show_advancedoptions = 0;
80
81                 fss->resolutionxyz = 65;
82                 fss->previewresxyz = 45;
83                 fss->realsize = 0.5;
84                 fss->guiDisplayMode = 2; // preview
85                 fss->renderDisplayMode = 3; // render
86
87                 fss->viscosityValue = 1.0;
88                 fss->viscosityExponent = 6;
89                 
90                 fss->grav[0] = 0.0;
91                 fss->grav[1] = 0.0;
92                 fss->grav[2] = -9.81;
93
94                 fss->animStart = 0.0; 
95                 fss->animEnd = 4.0;
96                 fss->animRate = 1.0;
97                 fss->gstar = 0.005; // used as normgstar
98                 fss->maxRefine = -1;
99                 /* maxRefine is set according to resolutionxyz during bake */
100
101                 /* fluid/inflow settings
102                  * fss->iniVel --> automatically set to 0 */
103
104                 modifier_path_init(fss->surfdataPath, sizeof(fss->surfdataPath), "cache_fluid");
105
106                 /* first init of bounding box */
107                 /* no bounding box needed */
108
109                 /* todo - reuse default init from elbeem! */
110                 fss->typeFlags = OB_FSBND_PARTSLIP | OB_FSSG_NOOBS;
111                 fss->domainNovecgen = 0;
112                 fss->volumeInitType = 1; /* volume */
113                 fss->partSlipValue = 0.2;
114
115                 fss->generateTracers = 0;
116                 fss->generateParticles = 0.0;
117                 fss->surfaceSmoothing = 1.0;
118                 fss->surfaceSubdivs = 0.0;
119                 fss->particleInfSize = 0.0;
120                 fss->particleInfAlpha = 0.0;
121
122                 /* init fluid control settings */
123                 fss->attractforceStrength = 0.2;
124                 fss->attractforceRadius = 0.75;
125                 fss->velocityforceStrength = 0.2;
126                 fss->velocityforceRadius = 0.75;
127                 fss->cpsTimeStart = fss->animStart;
128                 fss->cpsTimeEnd = fss->animEnd;
129                 fss->cpsQuality = 10.0; // 1.0 / 10.0 => means 0.1 width
130                 
131                 /*
132                  * BAD TODO: this is done in buttons_object.c in the moment
133                  * Mesh *mesh = ob->data;
134                  * // calculate bounding box
135                  * fluid_get_bb(mesh->mvert, mesh->totvert, ob->obmat, fss->bbStart, fss->bbSize);
136                  */
137                 
138                 fss->meshVelocities = NULL;
139                 
140                 fss->lastgoodframe = -1;
141                 
142                 fss->flag |= OB_FLUIDSIM_ACTIVE;
143
144         }
145 #else
146         (void)fluidmd; /* unused */
147 #endif
148         return;
149 }
150
151 void fluidsim_free(FluidsimModifierData *fluidmd)
152 {
153         if (fluidmd && fluidmd->fss) {
154                 if (fluidmd->fss->meshVelocities) {
155                         MEM_freeN(fluidmd->fss->meshVelocities);
156                         fluidmd->fss->meshVelocities = NULL;
157                 }
158                 MEM_freeN(fluidmd->fss);
159         }
160         
161         return;
162 }
163
164 #ifdef WITH_MOD_FLUID
165 /* read .bobj.gz file into a fluidsimDerivedMesh struct */
166 static DerivedMesh *fluidsim_read_obj(const char *filename, const MPoly *mp_example)
167 {
168         int wri = 0, i;
169         int gotBytes;
170         gzFile gzf;
171         int numverts = 0, numfaces = 0;
172         DerivedMesh *dm = NULL;
173         MPoly *mp;
174         MLoop *ml;
175         MVert *mv;
176         short *normals, *no_s;
177         float no[3];
178
179         const short mp_mat_nr = mp_example->mat_nr;
180         const char mp_flag =   mp_example->flag;
181
182         /* ------------------------------------------------
183          * get numverts + numfaces first
184          * ------------------------------------------------ */
185         gzf = BLI_gzopen(filename, "rb");
186         if (!gzf) {
187                 return NULL;
188         }
189
190         /* read numverts */
191         gotBytes = gzread(gzf, &wri, sizeof(wri));
192         numverts = wri;
193
194         /* skip verts */
195         gotBytes = gzseek(gzf, numverts * 3 * sizeof(float), SEEK_CUR) != -1;
196
197
198         /* read number of normals */
199         if (gotBytes)
200                 gotBytes = gzread(gzf, &wri, sizeof(wri));
201
202         /* skip normals */
203         gotBytes = gzseek(gzf, numverts * 3 * sizeof(float), SEEK_CUR) != -1;
204
205         /* get no. of triangles */
206         if (gotBytes)
207                 gotBytes = gzread(gzf, &wri, sizeof(wri));
208         numfaces = wri;
209
210         gzclose(gzf);
211         /* ------------------------------------------------ */
212
213         if (!numfaces || !numverts || !gotBytes)
214                 return NULL;
215
216         gzf = BLI_gzopen(filename, "rb");
217         if (!gzf) {
218                 return NULL;
219         }
220
221         dm = CDDM_new(numverts, 0, 0, numfaces * 3, numfaces);
222
223         if (!dm) {
224                 gzclose(gzf);
225                 return NULL;
226         }
227
228         /* read numverts */
229         gotBytes = gzread(gzf, &wri, sizeof(wri));
230
231         /* read vertex position from file */
232         mv = CDDM_get_verts(dm);
233
234         for (i = 0; i < numverts; i++, mv++)
235                 gotBytes = gzread(gzf, mv->co, sizeof(float) * 3);
236
237         /* should be the same as numverts */
238         gotBytes = gzread(gzf, &wri, sizeof(wri));
239         if (wri != numverts) {
240                 if (dm)
241                         dm->release(dm);
242                 gzclose(gzf);
243                 return NULL;
244         }
245
246         normals = MEM_callocN(sizeof(short) * numverts * 3, "fluid_tmp_normals");
247         if (!normals) {
248                 if (dm)
249                         dm->release(dm);
250                 gzclose(gzf);
251                 return NULL;
252         }
253
254         /* read normals from file (but don't save them yet) */
255         for (i = numverts, no_s = normals; i > 0; i--, no_s += 3) {
256                 gotBytes = gzread(gzf, no, sizeof(float) * 3);
257                 normal_float_to_short_v3(no_s, no);
258         }
259
260         /* read no. of triangles */
261         gotBytes = gzread(gzf, &wri, sizeof(wri));
262
263         if (wri != numfaces) {
264                 printf("Fluidsim: error in reading data from file.\n");
265                 if (dm)
266                         dm->release(dm);
267                 gzclose(gzf);
268                 MEM_freeN(normals);
269                 return NULL;
270         }
271
272         /* read triangles from file */
273         mp = CDDM_get_polys(dm);
274         ml = CDDM_get_loops(dm);
275         for (i = 0; i < numfaces; i++, mp++, ml += 3) {
276                 int face[3];
277
278                 gotBytes = gzread(gzf, face, sizeof(int) * 3);
279
280                 /* initialize from existing face */
281                 mp->mat_nr = mp_mat_nr;
282                 mp->flag =   mp_flag;
283
284                 mp->loopstart = i * 3;
285                 mp->totloop = 3;
286
287                 ml[0].v = face[0];
288                 ml[1].v = face[1];
289                 ml[2].v = face[2];
290
291         }
292
293         gzclose(gzf);
294
295         CDDM_calc_edges(dm);
296
297         CDDM_apply_vert_normals(dm, (short (*)[3])normals);
298         MEM_freeN(normals);
299
300         // CDDM_calc_normals(result);
301         return dm;
302 }
303
304
305 void fluid_get_bb(MVert *mvert, int totvert, float obmat[][4],
306                   /*RET*/ float start[3], /*RET*/ float size[3])
307 {
308         float bbsx = 0.0, bbsy = 0.0, bbsz = 0.0;
309         float bbex = 1.0, bbey = 1.0, bbez = 1.0;
310         int i;
311         float vec[3];
312
313         if (totvert == 0) {
314                 zero_v3(start);
315                 zero_v3(size);
316                 return;
317         }
318
319         copy_v3_v3(vec, mvert[0].co);
320         mul_m4_v3(obmat, vec);
321         bbsx = vec[0]; bbsy = vec[1]; bbsz = vec[2];
322         bbex = vec[0]; bbey = vec[1]; bbez = vec[2];
323
324         for (i = 1; i < totvert; i++) {
325                 copy_v3_v3(vec, mvert[i].co);
326                 mul_m4_v3(obmat, vec);
327
328                 if (vec[0] < bbsx) { bbsx = vec[0]; }
329                 if (vec[1] < bbsy) { bbsy = vec[1]; }
330                 if (vec[2] < bbsz) { bbsz = vec[2]; }
331                 if (vec[0] > bbex) { bbex = vec[0]; }
332                 if (vec[1] > bbey) { bbey = vec[1]; }
333                 if (vec[2] > bbez) { bbez = vec[2]; }
334         }
335
336         /* return values... */
337         if (start) {
338                 start[0] = bbsx;
339                 start[1] = bbsy;
340                 start[2] = bbsz;
341         }
342         if (size) {
343                 size[0] = bbex - bbsx;
344                 size[1] = bbey - bbsy;
345                 size[2] = bbez - bbsz;
346         }
347 }
348
349 //-------------------------------------------------------------------------------
350 // old interface
351 //-------------------------------------------------------------------------------
352
353 void fluid_estimate_memory(Object *ob, FluidsimSettings *fss, char *value)
354 {
355         Mesh *mesh;
356
357         value[0] = '\0';
358
359         if (ob->type == OB_MESH) {
360                 /* use mesh bounding box and object scaling */
361                 mesh = ob->data;
362
363                 fluid_get_bb(mesh->mvert, mesh->totvert, ob->obmat, fss->bbStart, fss->bbSize);
364                 elbeemEstimateMemreq(fss->resolutionxyz, fss->bbSize[0], fss->bbSize[1], fss->bbSize[2], fss->maxRefine, value);
365         }
366 }
367
368
369 /* read zipped fluidsim velocities into the co's of the fluidsimsettings normals struct */
370 static void fluidsim_read_vel_cache(FluidsimModifierData *fluidmd, DerivedMesh *dm, char *filename)
371 {
372         int wri, i, j;
373         float wrf;
374         gzFile gzf;
375         FluidsimSettings *fss = fluidmd->fss;
376         int len = strlen(filename);
377         int totvert = dm->getNumVerts(dm);
378         FluidVertexVelocity *velarray = NULL;
379
380         /* mesh and vverts have to be valid from loading... */
381
382         if (fss->meshVelocities)
383                 MEM_freeN(fss->meshVelocities);
384
385         if (len < 7) {
386                 return;
387         }
388
389         if (fss->domainNovecgen > 0) return;
390
391         fss->meshVelocities = MEM_callocN(sizeof(FluidVertexVelocity) * dm->getNumVerts(dm), "Fluidsim_velocities");
392         fss->totvert = totvert;
393
394         velarray = fss->meshVelocities;
395
396         /* .bobj.gz, correct filename
397          * 87654321 */
398         filename[len - 6] = 'v';
399         filename[len - 5] = 'e';
400         filename[len - 4] = 'l';
401
402         gzf = BLI_gzopen(filename, "rb");
403         if (!gzf) {
404                 MEM_freeN(fss->meshVelocities);
405                 fss->meshVelocities = NULL;
406                 return;
407         }
408
409         gzread(gzf, &wri, sizeof(wri));
410         if (wri != totvert) {
411                 MEM_freeN(fss->meshVelocities);
412                 fss->meshVelocities = NULL;
413                 return;
414         }
415
416         for (i = 0; i < totvert; i++) {
417                 for (j = 0; j < 3; j++) {
418                         gzread(gzf, &wrf, sizeof(wrf));
419                         velarray[i].vel[j] = wrf;
420                 }
421         }
422
423         gzclose(gzf);
424 }
425
426 static DerivedMesh *fluidsim_read_cache(Object *ob, DerivedMesh *orgdm,
427                                         FluidsimModifierData *fluidmd, int framenr, int useRenderParams)
428 {
429         int displaymode = 0;
430         int curFrame = framenr - 1 /*scene->r.sfra*/; /* start with 0 at start frame */
431         char targetFile[FILE_MAX];
432         FluidsimSettings *fss = fluidmd->fss;
433         DerivedMesh *dm = NULL;
434         MPoly *mpoly;
435         MPoly mp_example = {0};
436
437         if (!useRenderParams) {
438                 displaymode = fss->guiDisplayMode;
439         }
440         else {
441                 displaymode = fss->renderDisplayMode;
442         }
443
444         switch (displaymode) {
445                 case 1:
446                         /* just display original object */
447                         return NULL;
448                 case 2:
449                         /* use preview mesh */
450                         BLI_join_dirfile(targetFile, sizeof(targetFile), fss->surfdataPath, OB_FLUIDSIM_SURF_PREVIEW_OBJ_FNAME);
451                         break;
452                 default: /* 3 */
453                         /* 3. use final mesh */
454                         BLI_join_dirfile(targetFile, sizeof(targetFile), fss->surfdataPath, OB_FLUIDSIM_SURF_FINAL_OBJ_FNAME);
455                         break;
456         }
457
458         /* offset baked frame */
459         curFrame += fss->frameOffset;
460
461         BLI_path_abs(targetFile, modifier_path_relbase(ob));
462         BLI_path_frame(targetFile, curFrame, 0); // fixed #frame-no
463
464         /* assign material + flags to new dm
465          * if there's no faces in original dm, keep materials and flags unchanged */
466         mpoly = orgdm->getPolyArray(orgdm);
467         if (mpoly) {
468                 mp_example = *mpoly;
469         }
470         /* else leave NULL'd */
471
472         dm = fluidsim_read_obj(targetFile, &mp_example);
473
474         if (!dm) {
475                 /* switch, abort background rendering when fluidsim mesh is missing */
476                 const char *strEnvName2 = "BLENDER_ELBEEMBOBJABORT"; // from blendercall.cpp
477
478                 if (G.background == 1) {
479                         if (getenv(strEnvName2)) {
480                                 int elevel = atoi(getenv(strEnvName2));
481                                 if (elevel > 0) {
482                                         printf("Env. var %s set, fluid sim mesh '%s' not found, aborting render...\n",
483                                                strEnvName2, targetFile);
484                                         exit(1);
485                                 }
486                         }
487                 }
488
489                 /* display org. object upon failure which is in dm */
490                 return NULL;
491         }
492
493         /* load vertex velocities, if they exist...
494          * TODO? use generate flag as loading flag as well?
495          * warning, needs original .bobj.gz mesh loading filename */
496         if (displaymode == 3) {
497                 fluidsim_read_vel_cache(fluidmd, dm, targetFile);
498         }
499         else {
500                 if (fss->meshVelocities)
501                         MEM_freeN(fss->meshVelocities);
502
503                 fss->meshVelocities = NULL;
504         }
505
506         return dm;
507 }
508 #endif // WITH_MOD_FLUID
509
510 DerivedMesh *fluidsimModifier_do(FluidsimModifierData *fluidmd, Scene *scene,
511                                  Object *ob,
512                                  DerivedMesh *dm,
513                                  int useRenderParams, int UNUSED(isFinalCalc))
514 {
515 #ifdef WITH_MOD_FLUID
516         DerivedMesh *result = NULL;
517         int framenr;
518         FluidsimSettings *fss = NULL;
519
520         framenr = (int)scene->r.cfra;
521         
522         /* only handle fluidsim domains */
523         if (fluidmd && fluidmd->fss && (fluidmd->fss->type != OB_FLUIDSIM_DOMAIN))
524                 return dm;
525
526         /* sanity check */
527         if (!fluidmd || (fluidmd && !fluidmd->fss))
528                 return dm;
529
530         fss = fluidmd->fss;
531
532         /* timescale not supported yet
533          * clmd->sim_parms->timescale= timescale; */
534
535         /* support reversing of baked fluid frames here */
536         if ((fss->flag & OB_FLUIDSIM_REVERSE) && (fss->lastgoodframe >= 0)) {
537                 framenr = fss->lastgoodframe - framenr + 1;
538                 CLAMP(framenr, 1, fss->lastgoodframe);
539         }
540         
541         /* try to read from cache */
542         /* if the frame is there, fine, otherwise don't do anything */
543         if ((result = fluidsim_read_cache(ob, dm, fluidmd, framenr, useRenderParams)))
544                 return result;
545         
546         return dm;
547 #else
548         /* unused */
549         (void)fluidmd;
550         (void)scene;
551         (void)ob;
552         (void)dm;
553         (void)useRenderParams;
554         return NULL;
555 #endif
556 }