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