Cleanup: remove some G.main usages.
[blender.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_fluidsim_types.h"
44
45 #include "BLI_blenlib.h"
46 #include "BLI_math.h"
47 #include "BLI_utildefines.h"
48
49 #include "BKE_fluidsim.h" /* ensure definitions here match */
50 #include "BKE_cdderivedmesh.h"
51 #include "BKE_main.h"
52 #ifdef WITH_MOD_FLUID
53 #  include "BKE_global.h"
54 #endif
55
56 #include "MOD_fluidsim_util.h"
57 #include "MOD_modifiertypes.h"
58
59 #include "MEM_guardedalloc.h"
60
61 // headers for fluidsim bobj meshes
62 #include "LBM_fluidsim.h"
63
64
65 void fluidsim_init(FluidsimModifierData *fluidmd)
66 {
67 #ifdef WITH_MOD_FLUID
68         if (fluidmd) {
69                 FluidsimSettings *fss = MEM_callocN(sizeof(FluidsimSettings), "fluidsimsettings");
70
71                 fluidmd->fss = fss;
72                 
73                 if (!fss)
74                         return;
75                 
76                 fss->fmd = fluidmd;
77                 fss->type = OB_FLUIDSIM_ENABLE;
78                 fss->threads = 0;
79                 fss->show_advancedoptions = 0;
80
81                 fss->resolutionxyz = 65;
82                 fss->previewresxyz = 45;
83                 fss->realsize = 0.5;
84                 fss->guiDisplayMode = OB_FSDOM_PREVIEW;
85                 fss->renderDisplayMode = OB_FSDOM_FINAL;
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), OB_FLUIDSIM_SURF_DIR_DEFAULT);
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                 }
157                 MEM_SAFE_FREE(fluidmd->fss);
158         }
159
160         /* Seems to never be used, but for sqke of consistency... */
161         BLI_assert(fluidmd->point_cache == NULL);
162         fluidmd->point_cache = NULL;
163         
164         return;
165 }
166
167 #ifdef WITH_MOD_FLUID
168 /* read .bobj.gz file into a fluidsimDerivedMesh struct */
169 static DerivedMesh *fluidsim_read_obj(const char *filename, const MPoly *mp_example)
170 {
171         int wri = 0, i;
172         int gotBytes;
173         gzFile gzf;
174         int numverts = 0, numfaces = 0;
175         DerivedMesh *dm = NULL;
176         MPoly *mp;
177         MLoop *ml;
178         MVert *mv;
179         short *normals, *no_s;
180         float no[3];
181
182         const short mp_mat_nr = mp_example->mat_nr;
183         const char mp_flag =   mp_example->flag;
184
185         /* ------------------------------------------------
186          * get numverts + numfaces first
187          * ------------------------------------------------ */
188         gzf = BLI_gzopen(filename, "rb");
189         if (!gzf) {
190                 return NULL;
191         }
192
193         /* read numverts */
194         gotBytes = gzread(gzf, &wri, sizeof(wri));
195         numverts = wri;
196
197         /* skip verts */
198         gotBytes = gzseek(gzf, numverts * 3 * sizeof(float), SEEK_CUR) != -1;
199
200
201         /* read number of normals */
202         if (gotBytes)
203                 gotBytes = gzread(gzf, &wri, sizeof(wri));
204
205         /* skip normals */
206         gotBytes = gzseek(gzf, numverts * 3 * sizeof(float), SEEK_CUR) != -1;
207
208         /* get no. of triangles */
209         if (gotBytes)
210                 gotBytes = gzread(gzf, &wri, sizeof(wri));
211         numfaces = wri;
212
213         gzclose(gzf);
214         /* ------------------------------------------------ */
215
216         if (!numfaces || !numverts || !gotBytes)
217                 return NULL;
218
219         gzf = BLI_gzopen(filename, "rb");
220         if (!gzf) {
221                 return NULL;
222         }
223
224         dm = CDDM_new(numverts, 0, 0, numfaces * 3, numfaces);
225
226         if (!dm) {
227                 gzclose(gzf);
228                 return NULL;
229         }
230
231         /* read numverts */
232         gotBytes = gzread(gzf, &wri, sizeof(wri));
233
234         /* read vertex position from file */
235         mv = CDDM_get_verts(dm);
236
237         for (i = 0; i < numverts; i++, mv++)
238                 gotBytes = gzread(gzf, mv->co, sizeof(float) * 3);
239
240         /* should be the same as numverts */
241         gotBytes = gzread(gzf, &wri, sizeof(wri));
242         if (wri != numverts) {
243                 if (dm)
244                         dm->release(dm);
245                 gzclose(gzf);
246                 return NULL;
247         }
248
249         normals = MEM_calloc_arrayN(numverts, 3 * sizeof(short), "fluid_tmp_normals");
250         if (!normals) {
251                 if (dm)
252                         dm->release(dm);
253                 gzclose(gzf);
254                 return NULL;
255         }
256
257         /* read normals from file (but don't save them yet) */
258         for (i = numverts, no_s = normals; i > 0; i--, no_s += 3) {
259                 gotBytes = gzread(gzf, no, sizeof(float) * 3);
260                 normal_float_to_short_v3(no_s, no);
261         }
262
263         /* read no. of triangles */
264         gotBytes = gzread(gzf, &wri, sizeof(wri));
265
266         if (wri != numfaces) {
267                 printf("Fluidsim: error in reading data from file.\n");
268                 if (dm)
269                         dm->release(dm);
270                 gzclose(gzf);
271                 MEM_freeN(normals);
272                 return NULL;
273         }
274
275         /* read triangles from file */
276         mp = CDDM_get_polys(dm);
277         ml = CDDM_get_loops(dm);
278         for (i = 0; i < numfaces; i++, mp++, ml += 3) {
279                 int face[3];
280
281                 gotBytes = gzread(gzf, face, sizeof(int) * 3);
282
283                 /* initialize from existing face */
284                 mp->mat_nr = mp_mat_nr;
285                 mp->flag =   mp_flag;
286
287                 mp->loopstart = i * 3;
288                 mp->totloop = 3;
289
290                 ml[0].v = face[0];
291                 ml[1].v = face[1];
292                 ml[2].v = face[2];
293
294         }
295
296         gzclose(gzf);
297
298         CDDM_calc_edges(dm);
299
300         CDDM_apply_vert_normals(dm, (short (*)[3])normals);
301         MEM_freeN(normals);
302
303         // CDDM_calc_normals(result);
304         return dm;
305 }
306
307
308 void fluid_get_bb(
309         MVert *mvert, int totvert, float obmat[4][4],
310         /*RET*/ float start[3], /*RET*/ float size[3])
311 {
312         float bbsx = 0.0, bbsy = 0.0, bbsz = 0.0;
313         float bbex = 1.0, bbey = 1.0, bbez = 1.0;
314         int i;
315         float vec[3];
316
317         if (totvert == 0) {
318                 zero_v3(start);
319                 zero_v3(size);
320                 return;
321         }
322
323         copy_v3_v3(vec, mvert[0].co);
324         mul_m4_v3(obmat, vec);
325         bbsx = vec[0]; bbsy = vec[1]; bbsz = vec[2];
326         bbex = vec[0]; bbey = vec[1]; bbez = vec[2];
327
328         for (i = 1; i < totvert; i++) {
329                 copy_v3_v3(vec, mvert[i].co);
330                 mul_m4_v3(obmat, vec);
331
332                 if (vec[0] < bbsx) { bbsx = vec[0]; }
333                 if (vec[1] < bbsy) { bbsy = vec[1]; }
334                 if (vec[2] < bbsz) { bbsz = vec[2]; }
335                 if (vec[0] > bbex) { bbex = vec[0]; }
336                 if (vec[1] > bbey) { bbey = vec[1]; }
337                 if (vec[2] > bbez) { bbez = vec[2]; }
338         }
339
340         /* return values... */
341         if (start) {
342                 start[0] = bbsx;
343                 start[1] = bbsy;
344                 start[2] = bbsz;
345         }
346         if (size) {
347                 size[0] = bbex - bbsx;
348                 size[1] = bbey - bbsy;
349                 size[2] = bbez - bbsz;
350         }
351 }
352
353 //-------------------------------------------------------------------------------
354 // old interface
355 //-------------------------------------------------------------------------------
356
357 void fluid_estimate_memory(Object *ob, FluidsimSettings *fss, char *value)
358 {
359         Mesh *mesh;
360
361         value[0] = '\0';
362
363         if (ob->type == OB_MESH) {
364                 /* use mesh bounding box and object scaling */
365                 mesh = ob->data;
366
367                 fluid_get_bb(mesh->mvert, mesh->totvert, ob->obmat, fss->bbStart, fss->bbSize);
368                 elbeemEstimateMemreq(fss->resolutionxyz, fss->bbSize[0], fss->bbSize[1], fss->bbSize[2], fss->maxRefine, value);
369         }
370 }
371
372
373 /* read zipped fluidsim velocities into the co's of the fluidsimsettings normals struct */
374 static void fluidsim_read_vel_cache(FluidsimModifierData *fluidmd, DerivedMesh *dm, char *filename)
375 {
376         int wri, i, j;
377         float wrf;
378         gzFile gzf;
379         FluidsimSettings *fss = fluidmd->fss;
380         int len = strlen(filename);
381         int totvert = dm->getNumVerts(dm);
382         FluidVertexVelocity *velarray = NULL;
383
384         /* mesh and vverts have to be valid from loading... */
385
386         if (fss->meshVelocities)
387                 MEM_freeN(fss->meshVelocities);
388
389         if (len < 7) {
390                 return;
391         }
392
393         if (fss->domainNovecgen > 0) return;
394
395         fss->meshVelocities = MEM_calloc_arrayN(dm->getNumVerts(dm), sizeof(FluidVertexVelocity), "Fluidsim_velocities");
396         fss->totvert = totvert;
397
398         velarray = fss->meshVelocities;
399
400         /* .bobj.gz, correct filename
401          * 87654321 */
402         filename[len - 6] = 'v';
403         filename[len - 5] = 'e';
404         filename[len - 4] = 'l';
405
406         gzf = BLI_gzopen(filename, "rb");
407         if (!gzf) {
408                 MEM_freeN(fss->meshVelocities);
409                 fss->meshVelocities = NULL;
410                 return;
411         }
412
413         gzread(gzf, &wri, sizeof(wri));
414         if (wri != totvert) {
415                 MEM_freeN(fss->meshVelocities);
416                 fss->meshVelocities = NULL;
417                 return;
418         }
419
420         for (i = 0; i < totvert; i++) {
421                 for (j = 0; j < 3; j++) {
422                         gzread(gzf, &wrf, sizeof(wrf));
423                         velarray[i].vel[j] = wrf;
424                 }
425         }
426
427         gzclose(gzf);
428 }
429
430 static DerivedMesh *fluidsim_read_cache(
431         Object *ob, DerivedMesh *orgdm,
432         FluidsimModifierData *fluidmd, int framenr, int useRenderParams)
433 {
434         int curFrame = framenr /* - 1 */ /*scene->r.sfra*/; /* start with 0 at start frame */ 
435         /*  why start with 0 as start frame?? Animations + time are frozen for frame 0 anyway. (See physics_fluid.c for that. - DG */
436         /* If we start with frame 0, we need to remap all animation channels, too, because they will all be 1 frame late if using frame-1! - DG */
437
438         char targetFile[FILE_MAX];
439         FluidsimSettings *fss = fluidmd->fss;
440         DerivedMesh *dm = NULL;
441         MPoly *mpoly;
442         MPoly mp_example = {0};
443
444         const int displaymode = useRenderParams ? fss->renderDisplayMode : fss->guiDisplayMode;
445
446         switch (displaymode) {
447                 case OB_FSDOM_GEOM:
448                         /* just display original object */
449                         return NULL;
450                 case OB_FSDOM_PREVIEW:
451                         /* use preview mesh */
452                         BLI_join_dirfile(targetFile, sizeof(targetFile), fss->surfdataPath, OB_FLUIDSIM_SURF_PREVIEW_OBJ_FNAME);
453                         break;
454                 case OB_FSDOM_FINAL:
455                         /* use final mesh */
456                         BLI_join_dirfile(targetFile, sizeof(targetFile), fss->surfdataPath, OB_FLUIDSIM_SURF_FINAL_OBJ_FNAME);
457                         break;
458                 default:
459                         BLI_assert(!"Wrong fluidsim display type");
460                         return NULL;
461         }
462
463         /* offset baked frame */
464         curFrame += fss->frameOffset;
465
466         BLI_path_abs(targetFile, modifier_path_relbase_from_global(ob));
467         BLI_path_frame(targetFile, curFrame, 0); // fixed #frame-no
468
469         /* assign material + flags to new dm
470          * if there's no faces in original dm, keep materials and flags unchanged */
471         mpoly = orgdm->getPolyArray(orgdm);
472         if (mpoly) {
473                 mp_example = *mpoly;
474         }
475         /* else leave NULL'd */
476
477         dm = fluidsim_read_obj(targetFile, &mp_example);
478
479         if (!dm) {
480                 /* switch, abort background rendering when fluidsim mesh is missing */
481                 const char *strEnvName2 = "BLENDER_ELBEEMBOBJABORT"; // from blendercall.cpp
482
483                 if (G.background == 1) {
484                         if (getenv(strEnvName2)) {
485                                 int elevel = atoi(getenv(strEnvName2));
486                                 if (elevel > 0) {
487                                         printf("Env. var %s set, fluid sim mesh '%s' not found, aborting render...\n",
488                                                strEnvName2, targetFile);
489                                         exit(1);
490                                 }
491                         }
492                 }
493
494                 /* display org. object upon failure which is in dm */
495                 return NULL;
496         }
497
498         /* load vertex velocities, if they exist...
499          * TODO? use generate flag as loading flag as well?
500          * warning, needs original .bobj.gz mesh loading filename */
501         if (displaymode == OB_FSDOM_FINAL) {
502                 fluidsim_read_vel_cache(fluidmd, dm, targetFile);
503         }
504         else {
505                 if (fss->meshVelocities)
506                         MEM_freeN(fss->meshVelocities);
507
508                 fss->meshVelocities = NULL;
509         }
510
511         return dm;
512 }
513 #endif // WITH_MOD_FLUID
514
515 DerivedMesh *fluidsimModifier_do(
516         FluidsimModifierData *fluidmd, Scene *scene,
517         Object *ob,
518         DerivedMesh *dm,
519         int useRenderParams, int UNUSED(isFinalCalc))
520 {
521 #ifdef WITH_MOD_FLUID
522         DerivedMesh *result = NULL;
523         int framenr;
524         FluidsimSettings *fss = NULL;
525
526         framenr = (int)scene->r.cfra;
527         
528         /* only handle fluidsim domains */
529         if (fluidmd && fluidmd->fss && (fluidmd->fss->type != OB_FLUIDSIM_DOMAIN))
530                 return dm;
531
532         /* sanity check */
533         if (!fluidmd || !fluidmd->fss)
534                 return dm;
535
536         fss = fluidmd->fss;
537
538         /* timescale not supported yet
539          * clmd->sim_parms->timescale = timescale; */
540
541         /* support reversing of baked fluid frames here */
542         if ((fss->flag & OB_FLUIDSIM_REVERSE) && (fss->lastgoodframe >= 0)) {
543                 framenr = fss->lastgoodframe - framenr + 1;
544                 CLAMP(framenr, 1, fss->lastgoodframe);
545         }
546         
547         /* try to read from cache */
548         /* if the frame is there, fine, otherwise don't do anything */
549         if ((result = fluidsim_read_cache(ob, dm, fluidmd, framenr, useRenderParams)))
550                 return result;
551         
552         return dm;
553 #else
554         /* unused */
555         (void)fluidmd;
556         (void)scene;
557         (void)ob;
558         (void)dm;
559         (void)useRenderParams;
560         return NULL;
561 #endif
562 }