Compile fixes for recent commits
[blender.git] / source / blender / blenkernel / intern / ocean.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributors: Matt Ebb, Hamed Zaghaghi
22  * Based on original code by Drew Whitehouse / Houdini Ocean Toolkit
23  * OpenMP hints by Christian Schnellhammer
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28
29 #include <math.h>
30 #include <stdlib.h>
31
32 #include <string.h>
33
34 #include "MEM_guardedalloc.h"
35
36 #include "DNA_scene_types.h"
37
38 #include "BLI_math.h"
39 #include "BLI_path_util.h"
40 #include "BLI_rand.h"
41 #include "BLI_string.h"
42 #include "BLI_threads.h"
43 #include "BLI_utildefines.h"
44
45 #include "BKE_image.h"
46 #include "BKE_ocean.h"
47
48 #include "IMB_imbuf.h"
49 #include "IMB_imbuf_types.h"
50
51 #include "RE_render_ext.h"
52
53 #ifdef WITH_OCEANSIM
54
55 /* Ocean code */
56 #include "fftw3.h"
57
58 #define GRAVITY  9.81f
59
60 typedef struct Ocean {
61         /* ********* input parameters to the sim ********* */
62         float _V;
63         float _l;
64         float _w;
65         float _A;
66         float _damp_reflections;
67         float _wind_alignment;
68         float _depth;
69
70         float _wx;
71         float _wz;
72
73         float _L;
74
75         /* dimensions of computational grid */
76         int _M;
77         int _N;
78
79         /* spatial size of computational grid */
80         float _Lx;
81         float _Lz;
82
83         float normalize_factor;                 /* init w */
84         float time;
85
86         short _do_disp_y;
87         short _do_normals;
88         short _do_chop;
89         short _do_jacobian;
90
91         /* mutex for threaded texture access */
92         ThreadRWMutex oceanmutex;
93
94         /* ********* sim data arrays ********* */
95
96         /* two dimensional arrays of complex */
97         fftw_complex *_fft_in;          /* init w       sim w */
98         fftw_complex *_fft_in_x;        /* init w       sim w */
99         fftw_complex *_fft_in_z;        /* init w       sim w */
100         fftw_complex *_fft_in_jxx;      /* init w       sim w */
101         fftw_complex *_fft_in_jzz;      /* init w       sim w */
102         fftw_complex *_fft_in_jxz;      /* init w       sim w */
103         fftw_complex *_fft_in_nx;       /* init w       sim w */
104         fftw_complex *_fft_in_nz;       /* init w       sim w */
105         fftw_complex *_htilda;          /* init w       sim w (only once) */
106
107         /* fftw "plans" */
108         fftw_plan _disp_y_plan;         /* init w       sim r */
109         fftw_plan _disp_x_plan;         /* init w       sim r */
110         fftw_plan _disp_z_plan;         /* init w       sim r */
111         fftw_plan _N_x_plan;            /* init w       sim r */
112         fftw_plan _N_z_plan;            /* init w       sim r */
113         fftw_plan _Jxx_plan;            /* init w       sim r */
114         fftw_plan _Jxz_plan;            /* init w       sim r */
115         fftw_plan _Jzz_plan;            /* init w       sim r */
116
117         /* two dimensional arrays of float */
118         double *_disp_y;                /* init w       sim w via plan? */
119         double *_N_x;                   /* init w       sim w via plan? */
120         /* all member of this array has same values, so convert this array to a float to reduce memory usage (MEM01)*/
121         /*float * _N_y; */
122         double _N_y;                    /*                      sim w ********* can be rearranged? */
123         double *_N_z;                   /* init w       sim w via plan? */
124         double *_disp_x;                /* init w       sim w via plan? */
125         double *_disp_z;                /* init w       sim w via plan? */
126
127         /* two dimensional arrays of float */
128         /* Jacobian and minimum eigenvalue */
129         double *_Jxx;                   /* init w       sim w */
130         double *_Jzz;                   /* init w       sim w */
131         double *_Jxz;                   /* init w       sim w */
132
133         /* one dimensional float array */
134         float *_kx;                     /* init w       sim r */
135         float *_kz;                     /* init w       sim r */
136
137         /* two dimensional complex array */
138         fftw_complex *_h0;              /* init w       sim r */
139         fftw_complex *_h0_minus;        /* init w       sim r */
140
141         /* two dimensional float array */
142         float *_k;                      /* init w       sim r */
143 } Ocean;
144
145
146
147 static float nextfr(RNG *rng, float min, float max)
148 {
149         return BLI_rng_get_float(rng) * (min - max) + max;
150 }
151
152 static float gaussRand(RNG *rng)
153 {
154         /* Note: to avoid numerical problems with very small numbers, we make these variables singe-precision floats,
155          * but later we call the double-precision log() and sqrt() functions instead of logf() and sqrtf().
156          */ 
157         float x;
158         float y;
159         float length2;
160
161         do {
162                 x = (float) (nextfr(rng, -1, 1));
163                 y = (float)(nextfr(rng, -1, 1));
164                 length2 = x * x + y * y;
165         } while (length2 >= 1 || length2 == 0);
166
167         return x * sqrtf(-2.0f * logf(length2) / length2);
168 }
169
170 /**
171  * Some useful functions
172  */
173 MINLINE float catrom(float p0, float p1, float p2, float p3, float f)
174 {
175         return 0.5f * ((2.0f * p1) +
176                        (-p0 + p2) * f +
177                        (2.0f * p0 - 5.0f * p1 + 4.0f * p2 - p3) * f * f +
178                        (-p0 + 3.0f * p1 - 3.0f * p2 + p3) * f * f * f);
179 }
180
181 MINLINE float omega(float k, float depth)
182 {
183         return sqrtf(GRAVITY * k * tanhf(k * depth));
184 }
185
186 /* modified Phillips spectrum */
187 static float Ph(struct Ocean *o, float kx, float kz)
188 {
189         float tmp;
190         float k2 = kx * kx + kz * kz;
191
192         if (k2 == 0.0f) {
193                 return 0.0f; /* no DC component */
194         }
195
196         /* damp out the waves going in the direction opposite the wind */
197         tmp = (o->_wx * kx + o->_wz * kz) / sqrtf(k2);
198         if (tmp < 0) {
199                 tmp *= o->_damp_reflections;
200         }
201
202         return o->_A * expf(-1.0f / (k2 * (o->_L * o->_L))) * expf(-k2 * (o->_l * o->_l)) *
203                powf(fabsf(tmp), o->_wind_alignment) / (k2 * k2);
204 }
205
206 static void compute_eigenstuff(struct OceanResult *ocr, float jxx, float jzz, float jxz)
207 {
208         float a, b, qplus, qminus;
209         a = jxx + jzz;
210         b = sqrt((jxx - jzz) * (jxx - jzz) + 4 * jxz * jxz);
211
212         ocr->Jminus = 0.5f * (a - b);
213         ocr->Jplus  = 0.5f * (a + b);
214
215         qplus  = (ocr->Jplus  - jxx) / jxz;
216         qminus = (ocr->Jminus - jxx) / jxz;
217
218         a = sqrt(1 + qplus * qplus);
219         b = sqrt(1 + qminus * qminus);
220
221         ocr->Eplus[0] = 1.0f / a;
222         ocr->Eplus[1] = 0.0f;
223         ocr->Eplus[2] = qplus / a;
224
225         ocr->Eminus[0] = 1.0f / b;
226         ocr->Eminus[1] = 0.0f;
227         ocr->Eminus[2] = qminus / b;
228 }
229
230 /*
231  * instead of Complex.h
232  * in fftw.h "fftw_complex" typedefed as double[2]
233  * below you can see functions are needed to work with such complex numbers.
234  * */
235 static void init_complex(fftw_complex cmpl, float real, float image)
236 {
237         cmpl[0] = real;
238         cmpl[1] = image;
239 }
240
241 #if 0   /* unused */
242 static void add_complex_f(fftw_complex res, fftw_complex cmpl, float f)
243 {
244         res[0] = cmpl[0] + f;
245         res[1] = cmpl[1];
246 }
247 #endif
248
249 static void add_comlex_c(fftw_complex res, fftw_complex cmpl1, fftw_complex cmpl2)
250 {
251         res[0] = cmpl1[0] + cmpl2[0];
252         res[1] = cmpl1[1] + cmpl2[1];
253 }
254
255 static void mul_complex_f(fftw_complex res, fftw_complex cmpl, float f)
256 {
257         res[0] = cmpl[0] * (double)f;
258         res[1] = cmpl[1] * (double)f;
259 }
260
261 static void mul_complex_c(fftw_complex res, fftw_complex cmpl1, fftw_complex cmpl2)
262 {
263         fftwf_complex temp;
264         temp[0] = cmpl1[0] * cmpl2[0] - cmpl1[1] * cmpl2[1];
265         temp[1] = cmpl1[0] * cmpl2[1] + cmpl1[1] * cmpl2[0];
266         res[0] = temp[0];
267         res[1] = temp[1];
268 }
269
270 static float real_c(fftw_complex cmpl)
271 {
272         return cmpl[0];
273 }
274
275 static float image_c(fftw_complex cmpl)
276 {
277         return cmpl[1];
278 }
279
280 static void conj_complex(fftw_complex res, fftw_complex cmpl1)
281 {
282         res[0] = cmpl1[0];
283         res[1] = -cmpl1[1];
284 }
285
286 static void exp_complex(fftw_complex res, fftw_complex cmpl)
287 {
288         float r = expf(cmpl[0]);
289
290         res[0] = cosf(cmpl[1]) * r;
291         res[1] = sinf(cmpl[1]) * r;
292 }
293
294 float BKE_ocean_jminus_to_foam(float jminus, float coverage)
295 {
296         float foam = jminus * -0.005f + coverage;
297         CLAMP(foam, 0.0f, 1.0f);
298         return foam * foam;
299 }
300
301 void BKE_ocean_eval_uv(struct Ocean *oc, struct OceanResult *ocr, float u, float v)
302 {
303         int i0, i1, j0, j1;
304         float frac_x, frac_z;
305         float uu, vv;
306
307         /* first wrap the texture so 0 <= (u, v) < 1 */
308         u = fmodf(u, 1.0f);
309         v = fmodf(v, 1.0f);
310
311         if (u < 0) u += 1.0f;
312         if (v < 0) v += 1.0f;
313
314         BLI_rw_mutex_lock(&oc->oceanmutex, THREAD_LOCK_READ);
315
316         uu = u * oc->_M;
317         vv = v * oc->_N;
318
319         i0 = (int)floor(uu);
320         j0 = (int)floor(vv);
321
322         i1 = (i0 + 1);
323         j1 = (j0 + 1);
324
325         frac_x = uu - i0;
326         frac_z = vv - j0;
327
328         i0 = i0 % oc->_M;
329         j0 = j0 % oc->_N;
330
331         i1 = i1 % oc->_M;
332         j1 = j1 % oc->_N;
333
334
335 #define BILERP(m) (interpf(interpf(m[i1 * oc->_N + j1], m[i0 * oc->_N + j1], frac_x), \
336                            interpf(m[i1 * oc->_N + j0], m[i0 * oc->_N + j0], frac_x), \
337                            frac_z))
338         {
339                 if (oc->_do_disp_y) {
340                         ocr->disp[1] = BILERP(oc->_disp_y);
341                 }
342
343                 if (oc->_do_normals) {
344                         ocr->normal[0] = BILERP(oc->_N_x);
345                         ocr->normal[1] = oc->_N_y /*BILERP(oc->_N_y) (MEM01)*/;
346                         ocr->normal[2] = BILERP(oc->_N_z);
347                 }
348
349                 if (oc->_do_chop) {
350                         ocr->disp[0] = BILERP(oc->_disp_x);
351                         ocr->disp[2] = BILERP(oc->_disp_z);
352                 }
353                 else {
354                         ocr->disp[0] = 0.0;
355                         ocr->disp[2] = 0.0;
356                 }
357
358                 if (oc->_do_jacobian) {
359                         compute_eigenstuff(ocr, BILERP(oc->_Jxx), BILERP(oc->_Jzz), BILERP(oc->_Jxz));
360                 }
361         }
362 #undef BILERP
363
364         BLI_rw_mutex_unlock(&oc->oceanmutex);
365 }
366
367 /* use catmullrom interpolation rather than linear */
368 void BKE_ocean_eval_uv_catrom(struct Ocean *oc, struct OceanResult *ocr, float u, float v)
369 {
370         int i0, i1, i2, i3, j0, j1, j2, j3;
371         float frac_x, frac_z;
372         float uu, vv;
373
374         /* first wrap the texture so 0 <= (u, v) < 1 */
375         u = fmod(u, 1.0f);
376         v = fmod(v, 1.0f);
377
378         if (u < 0) u += 1.0f;
379         if (v < 0) v += 1.0f;
380
381         BLI_rw_mutex_lock(&oc->oceanmutex, THREAD_LOCK_READ);
382
383         uu = u * oc->_M;
384         vv = v * oc->_N;
385
386         i1 = (int)floor(uu);
387         j1 = (int)floor(vv);
388
389         i2 = (i1 + 1);
390         j2 = (j1 + 1);
391
392         frac_x = uu - i1;
393         frac_z = vv - j1;
394
395         i1 = i1 % oc->_M;
396         j1 = j1 % oc->_N;
397
398         i2 = i2 % oc->_M;
399         j2 = j2 % oc->_N;
400
401         i0 = (i1 - 1);
402         i3 = (i2 + 1);
403         i0 = i0 <   0 ? i0 + oc->_M : i0;
404         i3 = i3 >= oc->_M ? i3 - oc->_M : i3;
405
406         j0 = (j1 - 1);
407         j3 = (j2 + 1);
408         j0 = j0 <   0 ? j0 + oc->_N : j0;
409         j3 = j3 >= oc->_N ? j3 - oc->_N : j3;
410
411 #define INTERP(m) catrom(catrom(m[i0 * oc->_N + j0], m[i1 * oc->_N + j0], \
412                                 m[i2 * oc->_N + j0], m[i3 * oc->_N + j0], frac_x), \
413                          catrom(m[i0 * oc->_N + j1], m[i1 * oc->_N + j1], \
414                                 m[i2 * oc->_N + j1], m[i3 * oc->_N + j1], frac_x), \
415                          catrom(m[i0 * oc->_N + j2], m[i1 * oc->_N + j2], \
416                                 m[i2 * oc->_N + j2], m[i3 * oc->_N + j2], frac_x), \
417                          catrom(m[i0 * oc->_N + j3], m[i1 * oc->_N + j3], \
418                                 m[i2 * oc->_N + j3], m[i3 * oc->_N + j3], frac_x), \
419                          frac_z)
420
421         {
422                 if (oc->_do_disp_y) {
423                         ocr->disp[1] = INTERP(oc->_disp_y);
424                 }
425                 if (oc->_do_normals) {
426                         ocr->normal[0] = INTERP(oc->_N_x);
427                         ocr->normal[1] = oc->_N_y /*INTERP(oc->_N_y) (MEM01)*/;
428                         ocr->normal[2] = INTERP(oc->_N_z);
429                 }
430                 if (oc->_do_chop) {
431                         ocr->disp[0] = INTERP(oc->_disp_x);
432                         ocr->disp[2] = INTERP(oc->_disp_z);
433                 }
434                 else {
435                         ocr->disp[0] = 0.0;
436                         ocr->disp[2] = 0.0;
437                 }
438
439                 if (oc->_do_jacobian) {
440                         compute_eigenstuff(ocr, INTERP(oc->_Jxx), INTERP(oc->_Jzz), INTERP(oc->_Jxz));
441                 }
442         }
443 #undef INTERP
444
445         BLI_rw_mutex_unlock(&oc->oceanmutex);
446
447 }
448
449 void BKE_ocean_eval_xz(struct Ocean *oc, struct OceanResult *ocr, float x, float z)
450 {
451         BKE_ocean_eval_uv(oc, ocr, x / oc->_Lx, z / oc->_Lz);
452 }
453
454 void BKE_ocean_eval_xz_catrom(struct Ocean *oc, struct OceanResult *ocr, float x, float z)
455 {
456         BKE_ocean_eval_uv_catrom(oc, ocr, x / oc->_Lx, z / oc->_Lz);
457 }
458
459 /* note that this doesn't wrap properly for i, j < 0, but its not really meant for that being just a way to get
460  * the raw data out to save in some image format.
461  */
462 void BKE_ocean_eval_ij(struct Ocean *oc, struct OceanResult *ocr, int i, int j)
463 {
464         BLI_rw_mutex_lock(&oc->oceanmutex, THREAD_LOCK_READ);
465
466         i = abs(i) % oc->_M;
467         j = abs(j) % oc->_N;
468
469         ocr->disp[1] = oc->_do_disp_y ? (float)oc->_disp_y[i * oc->_N + j] : 0.0f;
470
471         if (oc->_do_chop) {
472                 ocr->disp[0] = oc->_disp_x[i * oc->_N + j];
473                 ocr->disp[2] = oc->_disp_z[i * oc->_N + j];
474         }
475         else {
476                 ocr->disp[0] = 0.0f;
477                 ocr->disp[2] = 0.0f;
478         }
479
480         if (oc->_do_normals) {
481                 ocr->normal[0] = oc->_N_x[i * oc->_N + j];
482                 ocr->normal[1] = oc->_N_y  /* oc->_N_y[i * oc->_N + j] (MEM01) */;
483                 ocr->normal[2] = oc->_N_z[i * oc->_N + j];
484
485                 normalize_v3(ocr->normal);
486         }
487
488         if (oc->_do_jacobian) {
489                 compute_eigenstuff(ocr, oc->_Jxx[i * oc->_N + j], oc->_Jzz[i * oc->_N + j], oc->_Jxz[i * oc->_N + j]);
490         }
491
492         BLI_rw_mutex_unlock(&oc->oceanmutex);
493 }
494
495 void BKE_simulate_ocean(struct Ocean *o, float t, float scale, float chop_amount)
496 {
497         int i, j;
498
499         scale *= o->normalize_factor;
500
501         BLI_rw_mutex_lock(&o->oceanmutex, THREAD_LOCK_WRITE);
502
503         /* compute a new htilda */
504 #pragma omp parallel for private(i, j)
505         for (i = 0; i < o->_M; ++i) {
506                 /* note the <= _N/2 here, see the fftw doco about the mechanics of the complex->real fft storage */
507                 for (j = 0; j <= o->_N / 2; ++j) {
508                         fftw_complex exp_param1;
509                         fftw_complex exp_param2;
510                         fftw_complex conj_param;
511
512
513                         init_complex(exp_param1, 0.0, omega(o->_k[i * (1 + o->_N / 2) + j], o->_depth) * t);
514                         init_complex(exp_param2, 0.0, -omega(o->_k[i * (1 + o->_N / 2) + j], o->_depth) * t);
515                         exp_complex(exp_param1, exp_param1);
516                         exp_complex(exp_param2, exp_param2);
517                         conj_complex(conj_param, o->_h0_minus[i * o->_N + j]);
518
519                         mul_complex_c(exp_param1, o->_h0[i * o->_N + j], exp_param1);
520                         mul_complex_c(exp_param2, conj_param, exp_param2);
521
522                         add_comlex_c(o->_htilda[i * (1 + o->_N / 2) + j], exp_param1, exp_param2);
523                         mul_complex_f(o->_fft_in[i * (1 + o->_N / 2) + j], o->_htilda[i * (1 + o->_N / 2) + j], scale);
524                 }
525         }
526
527 #pragma omp parallel sections private(i, j)
528         {
529
530 #pragma omp section
531                 {
532                         if (o->_do_disp_y) {
533                                 /* y displacement */
534                                 fftw_execute(o->_disp_y_plan);
535                         }
536                 } /* section 1 */
537
538 #pragma omp section
539                 {
540                         if (o->_do_chop) {
541                                 /* x displacement */
542                                 for (i = 0; i < o->_M; ++i) {
543                                         for (j = 0; j <= o->_N / 2; ++j) {
544                                                 fftw_complex mul_param;
545                                                 fftw_complex minus_i;
546
547                                                 init_complex(minus_i, 0.0, -1.0);
548                                                 init_complex(mul_param, -scale, 0);
549                                                 mul_complex_f(mul_param, mul_param, chop_amount);
550                                                 mul_complex_c(mul_param, mul_param, minus_i);
551                                                 mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
552                                                 mul_complex_f(mul_param, mul_param,
553                                                               ((o->_k[i * (1 + o->_N / 2) + j] == 0.0f) ?
554                                                                0.0f :
555                                                                o->_kx[i] / o->_k[i * (1 + o->_N / 2) + j]));
556                                                 init_complex(o->_fft_in_x[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
557                                         }
558                                 }
559                                 fftw_execute(o->_disp_x_plan);
560                         }
561                 } /* section 2 */
562
563 #pragma omp section
564                 {
565                         if (o->_do_chop) {
566                                 /* z displacement */
567                                 for (i = 0; i < o->_M; ++i) {
568                                         for (j = 0; j <= o->_N / 2; ++j) {
569                                                 fftw_complex mul_param;
570                                                 fftw_complex minus_i;
571
572                                                 init_complex(minus_i, 0.0, -1.0);
573                                                 init_complex(mul_param, -scale, 0);
574                                                 mul_complex_f(mul_param, mul_param, chop_amount);
575                                                 mul_complex_c(mul_param, mul_param, minus_i);
576                                                 mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
577                                                 mul_complex_f(mul_param, mul_param,
578                                                               ((o->_k[i * (1 + o->_N / 2) + j] == 0.0f) ?
579                                                                0.0f :
580                                                                o->_kz[j] / o->_k[i * (1 + o->_N / 2) + j]));
581                                                 init_complex(o->_fft_in_z[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
582                                         }
583                                 }
584                                 fftw_execute(o->_disp_z_plan);
585                         }
586                 } /* section 3 */
587
588 #pragma omp section
589                 {
590                         if (o->_do_jacobian) {
591                                 /* Jxx */
592                                 for (i = 0; i < o->_M; ++i) {
593                                         for (j = 0; j <= o->_N / 2; ++j) {
594                                                 fftw_complex mul_param;
595
596                                                 /* init_complex(mul_param, -scale, 0); */
597                                                 init_complex(mul_param, -1, 0);
598
599                                                 mul_complex_f(mul_param, mul_param, chop_amount);
600                                                 mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
601                                                 mul_complex_f(mul_param, mul_param,
602                                                               ((o->_k[i * (1 + o->_N / 2) + j] == 0.0f) ?
603                                                                0.0f :
604                                                                o->_kx[i] * o->_kx[i] / o->_k[i * (1 + o->_N / 2) + j]));
605                                                 init_complex(o->_fft_in_jxx[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
606                                         }
607                                 }
608                                 fftw_execute(o->_Jxx_plan);
609
610                                 for (i = 0; i < o->_M; ++i) {
611                                         for (j = 0; j < o->_N; ++j) {
612                                                 o->_Jxx[i * o->_N + j] += 1.0;
613                                         }
614                                 }
615                         }
616                 } /* section 4 */
617
618 #pragma omp section
619                 {
620                         if (o->_do_jacobian) {
621                                 /* Jzz */
622                                 for (i = 0; i < o->_M; ++i) {
623                                         for (j = 0; j <= o->_N / 2; ++j) {
624                                                 fftw_complex mul_param;
625
626                                                 /* init_complex(mul_param, -scale, 0); */
627                                                 init_complex(mul_param, -1, 0);
628
629                                                 mul_complex_f(mul_param, mul_param, chop_amount);
630                                                 mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
631                                                 mul_complex_f(mul_param, mul_param,
632                                                               ((o->_k[i * (1 + o->_N / 2) + j] == 0.0f) ?
633                                                                0.0f :
634                                                                o->_kz[j] * o->_kz[j] / o->_k[i * (1 + o->_N / 2) + j]));
635                                                 init_complex(o->_fft_in_jzz[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
636                                         }
637                                 }
638                                 fftw_execute(o->_Jzz_plan);
639                                 for (i = 0; i < o->_M; ++i) {
640                                         for (j = 0; j < o->_N; ++j) {
641                                                 o->_Jzz[i * o->_N + j] += 1.0;
642                                         }
643                                 }
644                         }
645                 } /* section 5 */
646
647 #pragma omp section
648                 {
649                         if (o->_do_jacobian) {
650                                 /* Jxz */
651                                 for (i = 0; i < o->_M; ++i) {
652                                         for (j = 0; j <= o->_N / 2; ++j) {
653                                                 fftw_complex mul_param;
654
655                                                 /* init_complex(mul_param, -scale, 0); */
656                                                 init_complex(mul_param, -1, 0);
657
658                                                 mul_complex_f(mul_param, mul_param, chop_amount);
659                                                 mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
660                                                 mul_complex_f(mul_param, mul_param,
661                                                               ((o->_k[i * (1 + o->_N / 2) + j] == 0.0f) ?
662                                                                0.0f :
663                                                                o->_kx[i] * o->_kz[j] / o->_k[i * (1 + o->_N / 2) + j]));
664                                                 init_complex(o->_fft_in_jxz[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
665                                         }
666                                 }
667                                 fftw_execute(o->_Jxz_plan);
668                         }
669                 } /* section 6 */
670
671 #pragma omp section
672                 {
673                         /* fft normals */
674                         if (o->_do_normals) {
675                                 for (i = 0; i < o->_M; ++i) {
676                                         for (j = 0; j <= o->_N / 2; ++j) {
677                                                 fftw_complex mul_param;
678
679                                                 init_complex(mul_param, 0.0, -1.0);
680                                                 mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
681                                                 mul_complex_f(mul_param, mul_param, o->_kx[i]);
682                                                 init_complex(o->_fft_in_nx[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
683                                         }
684                                 }
685                                 fftw_execute(o->_N_x_plan);
686
687                         }
688                 } /* section 7 */
689
690 #pragma omp section
691                 {
692                         if (o->_do_normals) {
693                                 for (i = 0; i < o->_M; ++i) {
694                                         for (j = 0; j <= o->_N / 2; ++j) {
695                                                 fftw_complex mul_param;
696
697                                                 init_complex(mul_param, 0.0, -1.0);
698                                                 mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
699                                                 mul_complex_f(mul_param, mul_param, o->_kz[i]);
700                                                 init_complex(o->_fft_in_nz[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
701                                         }
702                                 }
703                                 fftw_execute(o->_N_z_plan);
704
705 #if 0
706                                 for (i = 0; i < o->_M; ++i) {
707                                         for (j = 0; j < o->_N; ++j) {
708                                                 o->_N_y[i * o->_N + j] = 1.0f / scale;
709                                         }
710                                 }
711                                 (MEM01)
712 #endif
713                                 o->_N_y = 1.0f / scale;
714                         }
715                 } /* section 8 */
716
717         } /* omp sections */
718
719         BLI_rw_mutex_unlock(&o->oceanmutex);
720 }
721
722 static void set_height_normalize_factor(struct Ocean *oc)
723 {
724         float res = 1.0;
725         float max_h = 0.0;
726
727         int i, j;
728
729         if (!oc->_do_disp_y) return;
730
731         oc->normalize_factor = 1.0;
732
733         BKE_simulate_ocean(oc, 0.0, 1.0, 0);
734
735         BLI_rw_mutex_lock(&oc->oceanmutex, THREAD_LOCK_READ);
736
737         for (i = 0; i < oc->_M; ++i) {
738                 for (j = 0; j < oc->_N; ++j) {
739                         if (max_h < fabsf(oc->_disp_y[i * oc->_N + j])) {
740                                 max_h = fabsf(oc->_disp_y[i * oc->_N + j]);
741                         }
742                 }
743         }
744
745         BLI_rw_mutex_unlock(&oc->oceanmutex);
746
747         if (max_h == 0.0f)
748                 max_h = 0.00001f;  /* just in case ... */
749
750         res = 1.0f / (max_h);
751
752         oc->normalize_factor = res;
753 }
754
755 struct Ocean *BKE_add_ocean(void)
756 {
757         Ocean *oc = MEM_callocN(sizeof(Ocean), "ocean sim data");
758
759         BLI_rw_mutex_init(&oc->oceanmutex);
760
761         return oc;
762 }
763
764 void BKE_init_ocean(struct Ocean *o, int M, int N, float Lx, float Lz, float V, float l, float A, float w, float damp,
765                     float alignment, float depth, float time, short do_height_field, short do_chop, short do_normals,
766                     short do_jacobian, int seed)
767 {
768         RNG *rng;
769         int i, j, ii;
770
771         BLI_rw_mutex_lock(&o->oceanmutex, THREAD_LOCK_WRITE);
772
773         o->_M = M;
774         o->_N = N;
775         o->_V = V;
776         o->_l = l;
777         o->_A = A;
778         o->_w = w;
779         o->_damp_reflections = 1.0f - damp;
780         o->_wind_alignment = alignment;
781         o->_depth = depth;
782         o->_Lx = Lx;
783         o->_Lz = Lz;
784         o->_wx = cos(w);
785         o->_wz = -sin(w); /* wave direction */
786         o->_L = V * V / GRAVITY;  /* largest wave for a given velocity V */
787         o->time = time;
788
789         o->_do_disp_y = do_height_field;
790         o->_do_normals = do_normals;
791         o->_do_chop = do_chop;
792         o->_do_jacobian = do_jacobian;
793
794         o->_k = (float *) MEM_mallocN(M * (1 + N / 2) * sizeof(float), "ocean_k");
795         o->_h0 = (fftw_complex *) MEM_mallocN(M * N * sizeof(fftw_complex), "ocean_h0");
796         o->_h0_minus = (fftw_complex *) MEM_mallocN(M * N * sizeof(fftw_complex), "ocean_h0_minus");
797         o->_kx = (float *) MEM_mallocN(o->_M * sizeof(float), "ocean_kx");
798         o->_kz = (float *) MEM_mallocN(o->_N * sizeof(float), "ocean_kz");
799
800         /* make this robust in the face of erroneous usage */
801         if (o->_Lx == 0.0f)
802                 o->_Lx = 0.001f;
803
804         if (o->_Lz == 0.0f)
805                 o->_Lz = 0.001f;
806
807         /* the +ve components and DC */
808         for (i = 0; i <= o->_M / 2; ++i)
809                 o->_kx[i] = 2.0f * (float)M_PI * i / o->_Lx;
810
811         /* the -ve components */
812         for (i = o->_M - 1, ii = 0; i > o->_M / 2; --i, ++ii)
813                 o->_kx[i] = -2.0f * (float)M_PI * ii / o->_Lx;
814
815         /* the +ve components and DC */
816         for (i = 0; i <= o->_N / 2; ++i)
817                 o->_kz[i] = 2.0f * (float)M_PI * i / o->_Lz;
818
819         /* the -ve components */
820         for (i = o->_N - 1, ii = 0; i > o->_N / 2; --i, ++ii)
821                 o->_kz[i] = -2.0f * (float)M_PI * ii / o->_Lz;
822
823         /* pre-calculate the k matrix */
824         for (i = 0; i < o->_M; ++i)
825                 for (j = 0; j <= o->_N / 2; ++j)
826                         o->_k[i * (1 + o->_N / 2) + j] = sqrt(o->_kx[i] * o->_kx[i] + o->_kz[j] * o->_kz[j]);
827
828         /*srand(seed);*/
829         rng = BLI_rng_new(seed);
830
831         for (i = 0; i < o->_M; ++i) {
832                 for (j = 0; j < o->_N; ++j) {
833                         float r1 = gaussRand(rng);
834                         float r2 = gaussRand(rng);
835
836                         fftw_complex r1r2;
837                         init_complex(r1r2, r1, r2);
838                         mul_complex_f(o->_h0[i * o->_N + j], r1r2, (float)(sqrt(Ph(o, o->_kx[i], o->_kz[j]) / 2.0f)));
839                         mul_complex_f(o->_h0_minus[i * o->_N + j], r1r2, (float)(sqrt(Ph(o, -o->_kx[i], -o->_kz[j]) / 2.0f)));
840                 }
841         }
842
843         o->_fft_in = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex), "ocean_fft_in");
844         o->_htilda = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex), "ocean_htilda");
845
846         if (o->_do_disp_y) {
847                 o->_disp_y = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_disp_y");
848                 o->_disp_y_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in, o->_disp_y, FFTW_ESTIMATE);
849         }
850
851         if (o->_do_normals) {
852                 o->_fft_in_nx = (fftw_complex *) MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex), "ocean_fft_in_nx");
853                 o->_fft_in_nz = (fftw_complex *) MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex), "ocean_fft_in_nz");
854
855                 o->_N_x = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_N_x");
856                 /* o->_N_y = (float *) fftwf_malloc(o->_M * o->_N * sizeof(float)); (MEM01) */
857                 o->_N_z = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_N_z");
858
859                 o->_N_x_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_nx, o->_N_x, FFTW_ESTIMATE);
860                 o->_N_z_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_nz, o->_N_z, FFTW_ESTIMATE);
861         }
862
863         if (o->_do_chop) {
864                 o->_fft_in_x = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex), "ocean_fft_in_x");
865                 o->_fft_in_z = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex), "ocean_fft_in_z");
866
867                 o->_disp_x = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_disp_x");
868                 o->_disp_z = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_disp_z");
869
870                 o->_disp_x_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_x, o->_disp_x, FFTW_ESTIMATE);
871                 o->_disp_z_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_z, o->_disp_z, FFTW_ESTIMATE);
872         }
873         if (o->_do_jacobian) {
874                 o->_fft_in_jxx = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex),
875                                                              "ocean_fft_in_jxx");
876                 o->_fft_in_jzz = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex),
877                                                              "ocean_fft_in_jzz");
878                 o->_fft_in_jxz = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex),
879                                                              "ocean_fft_in_jxz");
880
881                 o->_Jxx = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_Jxx");
882                 o->_Jzz = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_Jzz");
883                 o->_Jxz = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_Jxz");
884
885                 o->_Jxx_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_jxx, o->_Jxx, FFTW_ESTIMATE);
886                 o->_Jzz_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_jzz, o->_Jzz, FFTW_ESTIMATE);
887                 o->_Jxz_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_jxz, o->_Jxz, FFTW_ESTIMATE);
888         }
889
890         BLI_rw_mutex_unlock(&o->oceanmutex);
891
892         set_height_normalize_factor(o);
893
894         BLI_rng_free(rng);
895 }
896
897 void BKE_free_ocean_data(struct Ocean *oc)
898 {
899         if (!oc) return;
900
901         BLI_rw_mutex_lock(&oc->oceanmutex, THREAD_LOCK_WRITE);
902
903         if (oc->_do_disp_y) {
904                 fftw_destroy_plan(oc->_disp_y_plan);
905                 MEM_freeN(oc->_disp_y);
906         }
907
908         if (oc->_do_normals) {
909                 MEM_freeN(oc->_fft_in_nx);
910                 MEM_freeN(oc->_fft_in_nz);
911                 fftw_destroy_plan(oc->_N_x_plan);
912                 fftw_destroy_plan(oc->_N_z_plan);
913                 MEM_freeN(oc->_N_x);
914                 /*fftwf_free(oc->_N_y); (MEM01)*/
915                 MEM_freeN(oc->_N_z);
916         }
917
918         if (oc->_do_chop) {
919                 MEM_freeN(oc->_fft_in_x);
920                 MEM_freeN(oc->_fft_in_z);
921                 fftw_destroy_plan(oc->_disp_x_plan);
922                 fftw_destroy_plan(oc->_disp_z_plan);
923                 MEM_freeN(oc->_disp_x);
924                 MEM_freeN(oc->_disp_z);
925         }
926
927         if (oc->_do_jacobian) {
928                 MEM_freeN(oc->_fft_in_jxx);
929                 MEM_freeN(oc->_fft_in_jzz);
930                 MEM_freeN(oc->_fft_in_jxz);
931                 fftw_destroy_plan(oc->_Jxx_plan);
932                 fftw_destroy_plan(oc->_Jzz_plan);
933                 fftw_destroy_plan(oc->_Jxz_plan);
934                 MEM_freeN(oc->_Jxx);
935                 MEM_freeN(oc->_Jzz);
936                 MEM_freeN(oc->_Jxz);
937         }
938
939         if (oc->_fft_in)
940                 MEM_freeN(oc->_fft_in);
941
942         /* check that ocean data has been initialized */
943         if (oc->_htilda) {
944                 MEM_freeN(oc->_htilda);
945                 MEM_freeN(oc->_k);
946                 MEM_freeN(oc->_h0);
947                 MEM_freeN(oc->_h0_minus);
948                 MEM_freeN(oc->_kx);
949                 MEM_freeN(oc->_kz);
950         }
951
952         BLI_rw_mutex_unlock(&oc->oceanmutex);
953 }
954
955 void BKE_free_ocean(struct Ocean *oc)
956 {
957         if (!oc) return;
958
959         BKE_free_ocean_data(oc);
960         BLI_rw_mutex_end(&oc->oceanmutex);
961
962         MEM_freeN(oc);
963 }
964
965 #undef GRAVITY
966
967
968 /* ********* Baking/Caching ********* */
969
970
971 #define CACHE_TYPE_DISPLACE 1
972 #define CACHE_TYPE_FOAM     2
973 #define CACHE_TYPE_NORMAL   3
974
975 static void cache_filename(char *string, const char *path, const char *relbase, int frame, int type)
976 {
977         char cachepath[FILE_MAX];
978         const char *fname;
979
980         switch (type) {
981                 case CACHE_TYPE_FOAM:
982                         fname = "foam_";
983                         break;
984                 case CACHE_TYPE_NORMAL:
985                         fname = "normal_";
986                         break;
987                 case CACHE_TYPE_DISPLACE:
988                 default:
989                         fname = "disp_";
990                         break;
991         }
992
993         BLI_join_dirfile(cachepath, sizeof(cachepath), path, fname);
994
995         BKE_makepicstring_from_type(string, cachepath, relbase, frame, R_IMF_IMTYPE_OPENEXR, 1, TRUE);
996 }
997
998 /* silly functions but useful to inline when the args do a lot of indirections */
999 MINLINE void rgb_to_rgba_unit_alpha(float r_rgba[4], const float rgb[3])
1000 {
1001         r_rgba[0] = rgb[0];
1002         r_rgba[1] = rgb[1];
1003         r_rgba[2] = rgb[2];
1004         r_rgba[3] = 1.0f;
1005 }
1006 MINLINE void value_to_rgba_unit_alpha(float r_rgba[4], const float value)
1007 {
1008         r_rgba[0] = value;
1009         r_rgba[1] = value;
1010         r_rgba[2] = value;
1011         r_rgba[3] = 1.0f;
1012 }
1013
1014 void BKE_free_ocean_cache(struct OceanCache *och)
1015 {
1016         int i, f = 0;
1017
1018         if (!och) return;
1019
1020         if (och->ibufs_disp) {
1021                 for (i = och->start, f = 0; i <= och->end; i++, f++) {
1022                         if (och->ibufs_disp[f]) {
1023                                 IMB_freeImBuf(och->ibufs_disp[f]);
1024                         }
1025                 }
1026                 MEM_freeN(och->ibufs_disp);
1027         }
1028
1029         if (och->ibufs_foam) {
1030                 for (i = och->start, f = 0; i <= och->end; i++, f++) {
1031                         if (och->ibufs_foam[f]) {
1032                                 IMB_freeImBuf(och->ibufs_foam[f]);
1033                         }
1034                 }
1035                 MEM_freeN(och->ibufs_foam);
1036         }
1037
1038         if (och->ibufs_norm) {
1039                 for (i = och->start, f = 0; i <= och->end; i++, f++) {
1040                         if (och->ibufs_norm[f]) {
1041                                 IMB_freeImBuf(och->ibufs_norm[f]);
1042                         }
1043                 }
1044                 MEM_freeN(och->ibufs_norm);
1045         }
1046
1047         if (och->time)
1048                 MEM_freeN(och->time);
1049         MEM_freeN(och);
1050 }
1051
1052 void BKE_ocean_cache_eval_uv(struct OceanCache *och, struct OceanResult *ocr, int f, float u, float v)
1053 {
1054         int res_x = och->resolution_x;
1055         int res_y = och->resolution_y;
1056         float result[4];
1057
1058         u = fmod(u, 1.0);
1059         v = fmod(v, 1.0);
1060
1061         if (u < 0) u += 1.0f;
1062         if (v < 0) v += 1.0f;
1063
1064         if (och->ibufs_disp[f]) {
1065                 ibuf_sample(och->ibufs_disp[f], u, v, (1.0f / (float)res_x), (1.0f / (float)res_y), result);
1066                 copy_v3_v3(ocr->disp, result);
1067         }
1068
1069         if (och->ibufs_foam[f]) {
1070                 ibuf_sample(och->ibufs_foam[f], u, v, (1.0f / (float)res_x), (1.0f / (float)res_y), result);
1071                 ocr->foam = result[0];
1072         }
1073
1074         if (och->ibufs_norm[f]) {
1075                 ibuf_sample(och->ibufs_norm[f], u, v, (1.0f / (float)res_x), (1.0f / (float)res_y), result);
1076                 copy_v3_v3(ocr->normal, result);
1077         }
1078 }
1079
1080 void BKE_ocean_cache_eval_ij(struct OceanCache *och, struct OceanResult *ocr, int f, int i, int j)
1081 {
1082         const int res_x = och->resolution_x;
1083         const int res_y = och->resolution_y;
1084
1085         if (i < 0) i = -i;
1086         if (j < 0) j = -j;
1087
1088         i = i % res_x;
1089         j = j % res_y;
1090
1091         if (och->ibufs_disp[f]) {
1092                 copy_v3_v3(ocr->disp, &och->ibufs_disp[f]->rect_float[4 * (res_x * j + i)]);
1093         }
1094
1095         if (och->ibufs_foam[f]) {
1096                 ocr->foam = och->ibufs_foam[f]->rect_float[4 * (res_x * j + i)];
1097         }
1098
1099         if (och->ibufs_norm[f]) {
1100                 copy_v3_v3(ocr->normal, &och->ibufs_norm[f]->rect_float[4 * (res_x * j + i)]);
1101         }
1102 }
1103
1104 struct OceanCache *BKE_init_ocean_cache(const char *bakepath, const char *relbase, int start, int end, float wave_scale,
1105                                         float chop_amount, float foam_coverage, float foam_fade, int resolution)
1106 {
1107         OceanCache *och = MEM_callocN(sizeof(OceanCache), "ocean cache data");
1108
1109         och->bakepath = bakepath;
1110         och->relbase = relbase;
1111
1112         och->start = start;
1113         och->end = end;
1114         och->duration = (end - start) + 1;
1115         och->wave_scale = wave_scale;
1116         och->chop_amount = chop_amount;
1117         och->foam_coverage = foam_coverage;
1118         och->foam_fade = foam_fade;
1119         och->resolution_x = resolution * resolution;
1120         och->resolution_y = resolution * resolution;
1121
1122         och->ibufs_disp = MEM_callocN(sizeof(ImBuf *) * och->duration, "displacement imbuf pointer array");
1123         och->ibufs_foam = MEM_callocN(sizeof(ImBuf *) * och->duration, "foam imbuf pointer array");
1124         och->ibufs_norm = MEM_callocN(sizeof(ImBuf *) * och->duration, "normal imbuf pointer array");
1125
1126         och->time = NULL;
1127
1128         return och;
1129 }
1130
1131 void BKE_simulate_ocean_cache(struct OceanCache *och, int frame)
1132 {
1133         char string[FILE_MAX];
1134         int f = frame;
1135
1136         /* ibufs array is zero based, but filenames are based on frame numbers */
1137         /* still need to clamp frame numbers to valid range of images on disk though */
1138         CLAMP(frame, och->start, och->end);
1139         f = frame - och->start; /* shift to 0 based */
1140
1141         /* if image is already loaded in mem, return */
1142         if (och->ibufs_disp[f] != NULL) return;
1143
1144         /* use default color spaces since we know for sure cache files were saved with default settings too */
1145
1146         cache_filename(string, och->bakepath, och->relbase, frame, CACHE_TYPE_DISPLACE);
1147         och->ibufs_disp[f] = IMB_loadiffname(string, 0, NULL);
1148 #if 0
1149         if (och->ibufs_disp[f] == NULL)
1150                 printf("error loading %s\n", string);
1151         else
1152                 printf("loaded cache %s\n", string);
1153 #endif
1154
1155         cache_filename(string, och->bakepath, och->relbase, frame, CACHE_TYPE_FOAM);
1156         och->ibufs_foam[f] = IMB_loadiffname(string, 0, NULL);
1157 #if 0
1158         if (och->ibufs_foam[f] == NULL)
1159                 printf("error loading %s\n", string);
1160         else
1161                 printf("loaded cache %s\n", string);
1162 #endif
1163
1164         cache_filename(string, och->bakepath, och->relbase, frame, CACHE_TYPE_NORMAL);
1165         och->ibufs_norm[f] = IMB_loadiffname(string, 0, NULL);
1166 #if 0
1167         if (och->ibufs_norm[f] == NULL)
1168                 printf("error loading %s\n", string);
1169         else
1170                 printf("loaded cache %s\n", string);
1171 #endif
1172 }
1173
1174
1175 void BKE_bake_ocean(struct Ocean *o, struct OceanCache *och, void (*update_cb)(void *, float progress, int *cancel),
1176                     void *update_cb_data)
1177 {
1178         /* note: some of these values remain uninitialized unless certain options
1179          * are enabled, take care that BKE_ocean_eval_ij() initializes a member
1180          * before use - campbell */
1181         OceanResult ocr;
1182
1183         ImageFormatData imf = {0};
1184
1185         int f, i = 0, x, y, cancel = 0;
1186         float progress;
1187
1188         ImBuf *ibuf_foam, *ibuf_disp, *ibuf_normal;
1189         float *prev_foam;
1190         int res_x = och->resolution_x;
1191         int res_y = och->resolution_y;
1192         char string[FILE_MAX];
1193         //RNG *rng;
1194
1195         if (!o) return;
1196
1197         if (o->_do_jacobian) prev_foam = MEM_callocN(res_x * res_y * sizeof(float), "previous frame foam bake data");
1198         else prev_foam = NULL;
1199
1200         //rng = BLI_rng_new(0);
1201
1202         /* setup image format */
1203         imf.imtype = R_IMF_IMTYPE_OPENEXR;
1204         imf.depth =  R_IMF_CHAN_DEPTH_16;
1205         imf.exr_codec = R_IMF_EXR_CODEC_ZIP;
1206
1207         for (f = och->start, i = 0; f <= och->end; f++, i++) {
1208
1209                 /* create a new imbuf to store image for this frame */
1210                 ibuf_foam = IMB_allocImBuf(res_x, res_y, 32, IB_rectfloat);
1211                 ibuf_disp = IMB_allocImBuf(res_x, res_y, 32, IB_rectfloat);
1212                 ibuf_normal = IMB_allocImBuf(res_x, res_y, 32, IB_rectfloat);
1213
1214                 BKE_simulate_ocean(o, och->time[i], och->wave_scale, och->chop_amount);
1215
1216                 /* add new foam */
1217                 for (y = 0; y < res_y; y++) {
1218                         for (x = 0; x < res_x; x++) {
1219
1220                                 BKE_ocean_eval_ij(o, &ocr, x, y);
1221
1222                                 /* add to the image */
1223                                 rgb_to_rgba_unit_alpha(&ibuf_disp->rect_float[4 * (res_x * y + x)], ocr.disp);
1224
1225                                 if (o->_do_jacobian) {
1226                                         /* TODO, cleanup unused code - campbell */
1227
1228                                         float /*r, */ /* UNUSED */ pr = 0.0f, foam_result;
1229                                         float neg_disp, neg_eplus;
1230
1231                                         ocr.foam = BKE_ocean_jminus_to_foam(ocr.Jminus, och->foam_coverage);
1232
1233                                         /* accumulate previous value for this cell */
1234                                         if (i > 0) {
1235                                                 pr = prev_foam[res_x * y + x];
1236                                         }
1237
1238                                         /* r = BLI_rng_get_float(rng); */ /* UNUSED */ /* randomly reduce foam */
1239
1240                                         /* pr = pr * och->foam_fade; */         /* overall fade */
1241
1242                                         /* remember ocean coord sys is Y up!
1243                                          * break up the foam where height (Y) is low (wave valley), and X and Z displacement is greatest
1244                                          */
1245
1246 #if 0
1247                                         vec[0] = ocr.disp[0];
1248                                         vec[1] = ocr.disp[2];
1249                                         hor_stretch = len_v2(vec);
1250                                         CLAMP(hor_stretch, 0.0, 1.0);
1251 #endif
1252
1253                                         neg_disp = ocr.disp[1] < 0.0f ? 1.0f + ocr.disp[1] : 1.0f;
1254                                         neg_disp = neg_disp < 0.0f ? 0.0f : neg_disp;
1255
1256                                         /* foam, 'ocr.Eplus' only initialized with do_jacobian */
1257                                         neg_eplus = ocr.Eplus[2] < 0.0f ? 1.0f + ocr.Eplus[2] : 1.0f;
1258                                         neg_eplus = neg_eplus < 0.0f ? 0.0f : neg_eplus;
1259
1260 #if 0
1261                                         if (ocr.disp[1] < 0.0 || r > och->foam_fade)
1262                                                 pr *= och->foam_fade;
1263
1264
1265                                         pr = pr * (1.0 - hor_stretch) * ocr.disp[1];
1266                                         pr = pr * neg_disp * neg_eplus;
1267 #endif
1268
1269                                         if (pr < 1.0f)
1270                                                 pr *= pr;
1271
1272                                         pr *= och->foam_fade * (0.75f + neg_eplus * 0.25f);
1273
1274                                         /* A full clamping should not be needed! */
1275                                         foam_result = min_ff(pr + ocr.foam, 1.0f);
1276
1277                                         prev_foam[res_x * y + x] = foam_result;
1278
1279                                         /*foam_result = min_ff(foam_result, 1.0f); */
1280
1281                                         value_to_rgba_unit_alpha(&ibuf_foam->rect_float[4 * (res_x * y + x)], foam_result);
1282                                 }
1283
1284                                 if (o->_do_normals) {
1285                                         rgb_to_rgba_unit_alpha(&ibuf_normal->rect_float[4 * (res_x * y + x)], ocr.normal);
1286                                 }
1287                         }
1288                 }
1289
1290                 /* write the images */
1291                 cache_filename(string, och->bakepath, och->relbase, f, CACHE_TYPE_DISPLACE);
1292                 if (0 == BKE_imbuf_write(ibuf_disp, string, &imf))
1293                         printf("Cannot save Displacement File Output to %s\n", string);
1294
1295                 if (o->_do_jacobian) {
1296                         cache_filename(string, och->bakepath, och->relbase, f, CACHE_TYPE_FOAM);
1297                         if (0 == BKE_imbuf_write(ibuf_foam, string, &imf))
1298                                 printf("Cannot save Foam File Output to %s\n", string);
1299                 }
1300
1301                 if (o->_do_normals) {
1302                         cache_filename(string, och->bakepath, och->relbase, f, CACHE_TYPE_NORMAL);
1303                         if (0 == BKE_imbuf_write(ibuf_normal, string, &imf))
1304                                 printf("Cannot save Normal File Output to %s\n", string);
1305                 }
1306
1307                 IMB_freeImBuf(ibuf_disp);
1308                 IMB_freeImBuf(ibuf_foam);
1309                 IMB_freeImBuf(ibuf_normal);
1310
1311                 progress = (f - och->start) / (float)och->duration;
1312
1313                 update_cb(update_cb_data, progress, &cancel);
1314
1315                 if (cancel) {
1316                         if (prev_foam) MEM_freeN(prev_foam);
1317                         //BLI_rng_free(rng);
1318                         return;
1319                 }
1320         }
1321
1322         //BLI_rng_free(rng);
1323         if (prev_foam) MEM_freeN(prev_foam);
1324         och->baked = 1;
1325 }
1326
1327 #else /* WITH_OCEANSIM */
1328
1329 /* stub */
1330 typedef struct Ocean {
1331         /* need some data here, C does not allow empty struct */
1332         int stub;
1333 } Ocean;
1334
1335
1336 float BKE_ocean_jminus_to_foam(float UNUSED(jminus), float UNUSED(coverage))
1337 {
1338         return 0.0f;
1339 }
1340
1341 void BKE_ocean_eval_uv(struct Ocean *UNUSED(oc), struct OceanResult *UNUSED(ocr), float UNUSED(u), float UNUSED(v))
1342 {
1343 }
1344
1345 /* use catmullrom interpolation rather than linear */
1346 void BKE_ocean_eval_uv_catrom(struct Ocean *UNUSED(oc), struct OceanResult *UNUSED(ocr), float UNUSED(u),
1347                               float UNUSED(v))
1348 {
1349 }
1350
1351 void BKE_ocean_eval_xz(struct Ocean *UNUSED(oc), struct OceanResult *UNUSED(ocr), float UNUSED(x), float UNUSED(z))
1352 {
1353 }
1354
1355 void BKE_ocean_eval_xz_catrom(struct Ocean *UNUSED(oc), struct OceanResult *UNUSED(ocr), float UNUSED(x),
1356                               float UNUSED(z))
1357 {
1358 }
1359
1360 void BKE_ocean_eval_ij(struct Ocean *UNUSED(oc), struct OceanResult *UNUSED(ocr), int UNUSED(i), int UNUSED(j))
1361 {
1362 }
1363
1364 void BKE_simulate_ocean(struct Ocean *UNUSED(o), float UNUSED(t), float UNUSED(scale), float UNUSED(chop_amount))
1365 {
1366 }
1367
1368 struct Ocean *BKE_add_ocean(void)
1369 {
1370         Ocean *oc = MEM_callocN(sizeof(Ocean), "ocean sim data");
1371
1372         return oc;
1373 }
1374
1375 void BKE_init_ocean(struct Ocean *UNUSED(o), int UNUSED(M), int UNUSED(N), float UNUSED(Lx), float UNUSED(Lz),
1376                     float UNUSED(V), float UNUSED(l), float UNUSED(A), float UNUSED(w), float UNUSED(damp),
1377                     float UNUSED(alignment), float UNUSED(depth), float UNUSED(time), short UNUSED(do_height_field),
1378                     short UNUSED(do_chop), short UNUSED(do_normals), short UNUSED(do_jacobian), int UNUSED(seed))
1379 {
1380 }
1381
1382 void BKE_free_ocean_data(struct Ocean *UNUSED(oc))
1383 {
1384 }
1385
1386 void BKE_free_ocean(struct Ocean *oc)
1387 {
1388         if (!oc) return;
1389         MEM_freeN(oc);
1390 }
1391
1392
1393 /* ********* Baking/Caching ********* */
1394
1395
1396 void BKE_free_ocean_cache(struct OceanCache *och)
1397 {
1398         if (!och) return;
1399
1400         MEM_freeN(och);
1401 }
1402
1403 void BKE_ocean_cache_eval_uv(struct OceanCache *UNUSED(och), struct OceanResult *UNUSED(ocr), int UNUSED(f),
1404                              float UNUSED(u), float UNUSED(v))
1405 {
1406 }
1407
1408 void BKE_ocean_cache_eval_ij(struct OceanCache *UNUSED(och), struct OceanResult *UNUSED(ocr), int UNUSED(f),
1409                              int UNUSED(i), int UNUSED(j))
1410 {
1411 }
1412
1413 OceanCache *BKE_init_ocean_cache(const char *UNUSED(bakepath), const char *UNUSED(relbase), int UNUSED(start),
1414                                  int UNUSED(end), float UNUSED(wave_scale), float UNUSED(chop_amount),
1415                                  float UNUSED(foam_coverage), float UNUSED(foam_fade), int UNUSED(resolution))
1416 {
1417         OceanCache *och = MEM_callocN(sizeof(OceanCache), "ocean cache data");
1418
1419         return och;
1420 }
1421
1422 void BKE_simulate_ocean_cache(struct OceanCache *UNUSED(och), int UNUSED(frame))
1423 {
1424 }
1425
1426 void BKE_bake_ocean(struct Ocean *UNUSED(o), struct OceanCache *UNUSED(och),
1427                     void (*update_cb)(void *, float progress, int *cancel), void *UNUSED(update_cb_data))
1428 {
1429         /* unused */
1430         (void)update_cb;
1431 }
1432 #endif /* WITH_OCEANSIM */