svn merge ^/trunk/blender -r42009:42053
[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->gstar = 0.005; // used as normgstar
99                 fss->maxRefine = -1;
100                 // maxRefine is set according to resolutionxyz during bake
101
102                 // fluid/inflow settings
103                 // fss->iniVel --> automatically set to 0
104
105                 modifier_path_init(fss->surfdataPath, sizeof(fss->surfdataPath), "cache_fluid");
106
107                 // first init of bounding box
108                 // no bounding box needed
109                 
110                 // todo - reuse default init from elbeem!
111                 fss->typeFlags = OB_FSBND_PARTSLIP | OB_FSSG_NOOBS;
112                 fss->domainNovecgen = 0;
113                 fss->volumeInitType = 1; // volume
114                 fss->partSlipValue = 0.2;
115
116                 fss->generateTracers = 0;
117                 fss->generateParticles = 0.0;
118                 fss->surfaceSmoothing = 1.0;
119                 fss->surfaceSubdivs = 0.0;
120                 fss->particleInfSize = 0.0;
121                 fss->particleInfAlpha = 0.0;
122         
123                 // init fluid control settings
124                 fss->attractforceStrength = 0.2;
125                 fss->attractforceRadius = 0.75;
126                 fss->velocityforceStrength = 0.2;
127                 fss->velocityforceRadius = 0.75;
128                 fss->cpsTimeStart = fss->animStart;
129                 fss->cpsTimeEnd = fss->animEnd;
130                 fss->cpsQuality = 10.0; // 1.0 / 10.0 => means 0.1 width
131                 
132                 /*
133                 BAD TODO: this is done in buttons_object.c in the moment 
134                 Mesh *mesh = ob->data;
135                 // calculate bounding box
136                 fluid_get_bb(mesh->mvert, mesh->totvert, ob->obmat, fss->bbStart, fss->bbSize); 
137                 */
138                 
139                 fss->meshVelocities = NULL;
140                 
141                 fss->lastgoodframe = -1;
142                 
143                 fss->flag |= OB_FLUIDSIM_ACTIVE;
144
145         }
146 #else
147         (void)fluidmd; /* unused */
148 #endif
149         return;
150 }
151
152 void fluidsim_free(FluidsimModifierData *fluidmd)
153 {
154 #ifdef WITH_MOD_FLUID
155         if(fluidmd)
156         {
157                 if(fluidmd->fss->meshVelocities)
158                 {
159                         MEM_freeN(fluidmd->fss->meshVelocities);
160                         fluidmd->fss->meshVelocities = NULL;
161                 }
162                 MEM_freeN(fluidmd->fss);
163         }
164 #else
165         (void)fluidmd; /* unused */
166 #endif
167         
168         return;
169 }
170
171 #ifdef WITH_MOD_FLUID
172 /* read .bobj.gz file into a fluidsimDerivedMesh struct */
173 static DerivedMesh *fluidsim_read_obj(const char *filename)
174 {
175         int wri = 0,i;
176         int gotBytes;
177         gzFile gzf;
178         int numverts = 0, numfaces = 0;
179         DerivedMesh *dm = NULL;
180         MFace *mf;
181         MVert *mv;
182         short *normals, *no_s;
183         float no[3];
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, numfaces, 0, 0);
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         mf = CDDM_get_tessfaces(dm);
283         for(i=numfaces; i>0; i--, mf++)
284         {
285                 int face[3];
286
287                 gotBytes = gzread(gzf, face, sizeof(int) * 3);
288
289                 // check if 3rd vertex has index 0 (not allowed in blender)
290                 if(face[2])
291                 {
292                         mf->v1 = face[0];
293                         mf->v2 = face[1];
294                         mf->v3 = face[2];
295                 }
296                 else
297                 {
298                         mf->v1 = face[1];
299                         mf->v2 = face[2];
300                         mf->v3 = face[0];
301                 }
302                 mf->v4 = 0;
303
304                 test_index_face(mf, NULL, 0, 3);
305         }
306
307         gzclose( gzf );
308
309         CDDM_calc_edges(dm);
310
311         CDDM_apply_vert_normals(dm, (short (*)[3])normals);
312         MEM_freeN(normals);
313
314         // CDDM_calc_normals(result);
315
316         return dm;
317 }
318
319
320 void fluid_get_bb(MVert *mvert, int totvert, float obmat[][4],
321                  /*RET*/ float start[3], /*RET*/ float size[3] )
322 {
323         float bbsx=0.0, bbsy=0.0, bbsz=0.0;
324         float bbex=1.0, bbey=1.0, bbez=1.0;
325         int i;
326         float vec[3];
327
328         if(totvert == 0) {
329                 zero_v3(start);
330                 zero_v3(size);
331                 return;
332         }
333
334         copy_v3_v3(vec, mvert[0].co);
335         mul_m4_v3(obmat, vec);
336         bbsx = vec[0]; bbsy = vec[1]; bbsz = vec[2];
337         bbex = vec[0]; bbey = vec[1]; bbez = vec[2];
338
339         for(i = 1; i < totvert; i++) {
340                 copy_v3_v3(vec, mvert[i].co);
341                 mul_m4_v3(obmat, vec);
342
343                 if(vec[0] < bbsx){ bbsx= vec[0]; }
344                 if(vec[1] < bbsy){ bbsy= vec[1]; }
345                 if(vec[2] < bbsz){ bbsz= vec[2]; }
346                 if(vec[0] > bbex){ bbex= vec[0]; }
347                 if(vec[1] > bbey){ bbey= vec[1]; }
348                 if(vec[2] > bbez){ bbez= vec[2]; }
349         }
350
351         // return values...
352         if(start) {
353                 start[0] = bbsx;
354                 start[1] = bbsy;
355                 start[2] = bbsz;
356         }
357         if(size) {
358                 size[0] = bbex-bbsx;
359                 size[1] = bbey-bbsy;
360                 size[2] = bbez-bbsz;
361         }
362 }
363
364 //-------------------------------------------------------------------------------
365 // old interface
366 //-------------------------------------------------------------------------------
367
368 void fluid_estimate_memory(Object *ob, FluidsimSettings *fss, char *value)
369 {
370         Mesh *mesh;
371
372         value[0]= '\0';
373
374         if(ob->type == OB_MESH) {
375                 /* use mesh bounding box and object scaling */
376                 mesh= ob->data;
377
378                 fluid_get_bb(mesh->mvert, mesh->totvert, ob->obmat, fss->bbStart, fss->bbSize);
379                 elbeemEstimateMemreq(fss->resolutionxyz, fss->bbSize[0],fss->bbSize[1],fss->bbSize[2], fss->maxRefine, value);
380         }
381 }
382
383
384 /* read zipped fluidsim velocities into the co's of the fluidsimsettings normals struct */
385 static void fluidsim_read_vel_cache(FluidsimModifierData *fluidmd, DerivedMesh *dm, char *filename)
386 {
387         int wri, i, j;
388         float wrf;
389         gzFile gzf;
390         FluidsimSettings *fss = fluidmd->fss;
391         int len = strlen(filename);
392         int totvert = dm->getNumVerts(dm);
393         FluidVertexVelocity *velarray = NULL;
394
395         // mesh and vverts have to be valid from loading...
396
397         if(fss->meshVelocities)
398                 MEM_freeN(fss->meshVelocities);
399
400         if(len<7)
401         {
402                 return;
403         }
404
405         if(fss->domainNovecgen>0) return;
406
407         fss->meshVelocities = MEM_callocN(sizeof(FluidVertexVelocity)*dm->getNumVerts(dm), "Fluidsim_velocities");
408         fss->totvert = totvert;
409
410         velarray = fss->meshVelocities;
411
412         // .bobj.gz , correct filename
413         // 87654321
414         filename[len-6] = 'v';
415         filename[len-5] = 'e';
416         filename[len-4] = 'l';
417
418         gzf = gzopen(filename, "rb");
419         if (!gzf)
420         {
421                 MEM_freeN(fss->meshVelocities);
422                 fss->meshVelocities = NULL;
423                 return;
424         }
425
426         gzread(gzf, &wri, sizeof( wri ));
427         if(wri != totvert)
428         {
429                 MEM_freeN(fss->meshVelocities);
430                 fss->meshVelocities = NULL;
431                 return;
432         }
433
434         for(i=0; i<totvert;i++)
435         {
436                 for(j=0; j<3; j++)
437                 {
438                         gzread(gzf, &wrf, sizeof( wrf ));
439                         velarray[i].vel[j] = wrf;
440                 }
441         }
442
443         gzclose(gzf);
444 }
445
446 static DerivedMesh *fluidsim_read_cache(Object *ob, DerivedMesh *orgdm, FluidsimModifierData *fluidmd, int framenr, int useRenderParams)
447 {
448         int displaymode = 0;
449         int curFrame = framenr - 1 /*scene->r.sfra*/; /* start with 0 at start frame */
450         char targetFile[FILE_MAXFILE+FILE_MAXDIR];
451         FluidsimSettings *fss = fluidmd->fss;
452         DerivedMesh *dm = NULL;
453         MFace *mface;
454         int numfaces;
455         int mat_nr, flag, i;
456
457         if(!useRenderParams) {
458                 displaymode = fss->guiDisplayMode;
459         } else {
460                 displaymode = fss->renderDisplayMode;
461         }
462
463         switch (displaymode) {
464         case 1:
465                 /* just display original object */
466                 return NULL;
467         case 2:
468                 /* use preview mesh */
469                 BLI_join_dirfile(targetFile, sizeof(targetFile), fss->surfdataPath, OB_FLUIDSIM_SURF_PREVIEW_OBJ_FNAME);
470                 break;
471         default: /* 3 */
472                 /* 3. use final mesh */
473                 BLI_join_dirfile(targetFile, sizeof(targetFile), fss->surfdataPath, OB_FLUIDSIM_SURF_FINAL_OBJ_FNAME);
474                 break;
475         }
476
477         BLI_path_abs(targetFile, modifier_path_relbase(ob));
478         BLI_path_frame(targetFile, curFrame, 0); // fixed #frame-no
479
480         dm = fluidsim_read_obj(targetFile);
481
482         if(!dm)
483         {
484                 // switch, abort background rendering when fluidsim mesh is missing
485                 const char *strEnvName2 = "BLENDER_ELBEEMBOBJABORT"; // from blendercall.cpp
486
487                 if(G.background==1) {
488                         if(getenv(strEnvName2)) {
489                                 int elevel = atoi(getenv(strEnvName2));
490                                 if(elevel>0) {
491                                         printf("Env. var %s set, fluid sim mesh '%s' not found, aborting render...\n",strEnvName2, targetFile);
492                                         exit(1);
493                                 }
494                         }
495                 }
496
497                 // display org. object upon failure which is in dm
498                 return NULL;
499         }
500
501         // assign material + flags to new dm
502         mface = orgdm->getTessFaceArray(orgdm);
503         mat_nr = mface[0].mat_nr;
504         flag = mface[0].flag;
505
506         mface = dm->getTessFaceArray(dm);
507         numfaces = dm->getNumTessFaces(dm);
508         for(i=0; i<numfaces; i++)
509         {
510                 mface[i].mat_nr = mat_nr;
511                 mface[i].flag = flag;
512         }
513
514         // load vertex velocities, if they exist...
515         // TODO? use generate flag as loading flag as well?
516         // warning, needs original .bobj.gz mesh loading filename
517         if(displaymode==3)
518         {
519                 fluidsim_read_vel_cache(fluidmd, dm, targetFile);
520         }
521         else
522         {
523                 if(fss->meshVelocities)
524                         MEM_freeN(fss->meshVelocities);
525
526                 fss->meshVelocities = NULL;
527         }
528
529         return dm;
530 }
531 #endif // WITH_MOD_FLUID
532
533 DerivedMesh *fluidsimModifier_do(FluidsimModifierData *fluidmd, Scene *scene,
534                                                 Object *ob,
535                                                 DerivedMesh *dm,
536                                                 int useRenderParams, int UNUSED(isFinalCalc))
537 {
538 #ifdef WITH_MOD_FLUID
539         DerivedMesh *result = NULL;
540         int framenr;
541         FluidsimSettings *fss = NULL;
542
543         framenr= (int)scene->r.cfra;
544         
545         // only handle fluidsim domains
546         if(fluidmd && fluidmd->fss && (fluidmd->fss->type != OB_FLUIDSIM_DOMAIN))
547                 return dm;
548         
549         // sanity check
550         if(!fluidmd || (fluidmd && !fluidmd->fss))
551                 return dm;
552         
553         fss = fluidmd->fss;
554         
555         // timescale not supported yet
556         // clmd->sim_parms->timescale= timescale;
557
558         // support reversing of baked fluid frames here
559         if((fss->flag & OB_FLUIDSIM_REVERSE) && (fss->lastgoodframe >= 0))
560         {
561                 framenr = fss->lastgoodframe - framenr + 1;
562                 CLAMP(framenr, 1, fss->lastgoodframe);
563         }
564         
565         /* try to read from cache */
566         /* if the frame is there, fine, otherwise don't do anything */
567         if((result = fluidsim_read_cache(ob, dm, fluidmd, framenr, useRenderParams)))
568                 return result;
569         
570         return dm;
571 #else
572         /* unused */
573         (void)fluidmd;
574         (void)scene;
575         (void)dm;
576         (void)useRenderParams;
577         return NULL;
578 #endif
579 }