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