Cleanup: BLI_task - API changes.
[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
338 #define BILERP(m) (interpf(interpf(m[i1 * oc->_N + j1], m[i0 * oc->_N + j1], frac_x), \
339                            interpf(m[i1 * oc->_N + j0], m[i0 * oc->_N + j0], frac_x), \
340                            frac_z))
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 {
507         OceanSimulateData *osd = userdata;
508         const Ocean *o = osd->o;
509         const float scale = osd->scale;
510         const float t = osd->t;
511
512         int j;
513
514         /* note the <= _N/2 here, see the fftw doco about the mechanics of the complex->real fft storage */
515         for (j = 0; j <= o->_N / 2; ++j) {
516                 fftw_complex exp_param1;
517                 fftw_complex exp_param2;
518                 fftw_complex conj_param;
519
520                 init_complex(exp_param1, 0.0, omega(o->_k[i * (1 + o->_N / 2) + j], o->_depth) * t);
521                 init_complex(exp_param2, 0.0, -omega(o->_k[i * (1 + o->_N / 2) + j], o->_depth) * t);
522                 exp_complex(exp_param1, exp_param1);
523                 exp_complex(exp_param2, exp_param2);
524                 conj_complex(conj_param, o->_h0_minus[i * o->_N + j]);
525
526                 mul_complex_c(exp_param1, o->_h0[i * o->_N + j], exp_param1);
527                 mul_complex_c(exp_param2, conj_param, exp_param2);
528
529                 add_comlex_c(o->_htilda[i * (1 + o->_N / 2) + j], exp_param1, exp_param2);
530                 mul_complex_f(o->_fft_in[i * (1 + o->_N / 2) + j], o->_htilda[i * (1 + o->_N / 2) + j], scale);
531         }
532 }
533
534 static void ocean_compute_displacement_y(TaskPool *pool, void *UNUSED(taskdata), int UNUSED(threadid))
535 {
536         OceanSimulateData *osd = BLI_task_pool_userdata(pool);
537         const Ocean *o = osd->o;
538
539         fftw_execute(o->_disp_y_plan);
540 }
541
542 static void ocean_compute_displacement_x(TaskPool *pool, void *UNUSED(taskdata), int UNUSED(threadid))
543 {
544         OceanSimulateData *osd = BLI_task_pool_userdata(pool);
545         const Ocean *o = osd->o;
546         const float scale = osd->scale;
547         const float chop_amount = osd->chop_amount;
548         int i, j;
549
550         for (i = 0; i < o->_M; ++i) {
551                 for (j = 0; j <= o->_N / 2; ++j) {
552                         fftw_complex mul_param;
553                         fftw_complex minus_i;
554
555                         init_complex(minus_i, 0.0, -1.0);
556                         init_complex(mul_param, -scale, 0);
557                         mul_complex_f(mul_param, mul_param, chop_amount);
558                         mul_complex_c(mul_param, mul_param, minus_i);
559                         mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
560                         mul_complex_f(mul_param, mul_param,
561                                       ((o->_k[i * (1 + o->_N / 2) + j] == 0.0f) ?
562                                        0.0f :
563                                        o->_kx[i] / o->_k[i * (1 + o->_N / 2) + j]));
564                         init_complex(o->_fft_in_x[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
565                 }
566         }
567         fftw_execute(o->_disp_x_plan);
568 }
569
570 static void ocean_compute_displacement_z(TaskPool *pool, void *UNUSED(taskdata), int UNUSED(threadid))
571 {
572         OceanSimulateData *osd = BLI_task_pool_userdata(pool);
573         const Ocean *o = osd->o;
574         const float scale = osd->scale;
575         const float chop_amount = osd->chop_amount;
576         int i, j;
577
578         for (i = 0; i < o->_M; ++i) {
579                 for (j = 0; j <= o->_N / 2; ++j) {
580                         fftw_complex mul_param;
581                         fftw_complex minus_i;
582
583                         init_complex(minus_i, 0.0, -1.0);
584                         init_complex(mul_param, -scale, 0);
585                         mul_complex_f(mul_param, mul_param, chop_amount);
586                         mul_complex_c(mul_param, mul_param, minus_i);
587                         mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
588                         mul_complex_f(mul_param, mul_param,
589                                       ((o->_k[i * (1 + o->_N / 2) + j] == 0.0f) ?
590                                        0.0f :
591                                        o->_kz[j] / o->_k[i * (1 + o->_N / 2) + j]));
592                         init_complex(o->_fft_in_z[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
593                 }
594         }
595         fftw_execute(o->_disp_z_plan);
596 }
597
598 static void ocean_compute_jacobian_jxx(TaskPool *pool, void *UNUSED(taskdata), int UNUSED(threadid))
599 {
600         OceanSimulateData *osd = BLI_task_pool_userdata(pool);
601         const Ocean *o = osd->o;
602         const float chop_amount = osd->chop_amount;
603         int i, j;
604
605         for (i = 0; i < o->_M; ++i) {
606                 for (j = 0; j <= o->_N / 2; ++j) {
607                         fftw_complex mul_param;
608
609                         /* init_complex(mul_param, -scale, 0); */
610                         init_complex(mul_param, -1, 0);
611
612                         mul_complex_f(mul_param, mul_param, chop_amount);
613                         mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
614                         mul_complex_f(mul_param, mul_param,
615                                       ((o->_k[i * (1 + o->_N / 2) + j] == 0.0f) ?
616                                        0.0f :
617                                        o->_kx[i] * o->_kx[i] / o->_k[i * (1 + o->_N / 2) + j]));
618                         init_complex(o->_fft_in_jxx[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
619                 }
620         }
621         fftw_execute(o->_Jxx_plan);
622
623         for (i = 0; i < o->_M; ++i) {
624                 for (j = 0; j < o->_N; ++j) {
625                         o->_Jxx[i * o->_N + j] += 1.0;
626                 }
627         }
628 }
629
630 static void ocean_compute_jacobian_jzz(TaskPool *pool, void *UNUSED(taskdata), int UNUSED(threadid))
631 {
632         OceanSimulateData *osd = BLI_task_pool_userdata(pool);
633         const Ocean *o = osd->o;
634         const float chop_amount = osd->chop_amount;
635         int i, j;
636
637         for (i = 0; i < o->_M; ++i) {
638                 for (j = 0; j <= o->_N / 2; ++j) {
639                         fftw_complex mul_param;
640
641                         /* init_complex(mul_param, -scale, 0); */
642                         init_complex(mul_param, -1, 0);
643
644                         mul_complex_f(mul_param, mul_param, chop_amount);
645                         mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
646                         mul_complex_f(mul_param, mul_param,
647                                       ((o->_k[i * (1 + o->_N / 2) + j] == 0.0f) ?
648                                        0.0f :
649                                        o->_kz[j] * o->_kz[j] / o->_k[i * (1 + o->_N / 2) + j]));
650                         init_complex(o->_fft_in_jzz[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
651                 }
652         }
653         fftw_execute(o->_Jzz_plan);
654
655         for (i = 0; i < o->_M; ++i) {
656                 for (j = 0; j < o->_N; ++j) {
657                         o->_Jzz[i * o->_N + j] += 1.0;
658                 }
659         }
660 }
661
662 static void ocean_compute_jacobian_jxz(TaskPool *pool, void *UNUSED(taskdata), int UNUSED(threadid))
663 {
664         OceanSimulateData *osd = BLI_task_pool_userdata(pool);
665         const Ocean *o = osd->o;
666         const float chop_amount = osd->chop_amount;
667         int i, j;
668
669         for (i = 0; i < o->_M; ++i) {
670                 for (j = 0; j <= o->_N / 2; ++j) {
671                         fftw_complex mul_param;
672
673                         /* init_complex(mul_param, -scale, 0); */
674                         init_complex(mul_param, -1, 0);
675
676                         mul_complex_f(mul_param, mul_param, chop_amount);
677                         mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
678                         mul_complex_f(mul_param, mul_param,
679                                       ((o->_k[i * (1 + o->_N / 2) + j] == 0.0f) ?
680                                        0.0f :
681                                        o->_kx[i] * o->_kz[j] / o->_k[i * (1 + o->_N / 2) + j]));
682                         init_complex(o->_fft_in_jxz[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
683                 }
684         }
685         fftw_execute(o->_Jxz_plan);
686 }
687
688 static void ocean_compute_normal_x(TaskPool *pool, void *UNUSED(taskdata), int UNUSED(threadid))
689 {
690         OceanSimulateData *osd = BLI_task_pool_userdata(pool);
691         const Ocean *o = osd->o;
692         int i, j;
693
694         for (i = 0; i < o->_M; ++i) {
695                 for (j = 0; j <= o->_N / 2; ++j) {
696                         fftw_complex mul_param;
697
698                         init_complex(mul_param, 0.0, -1.0);
699                         mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
700                         mul_complex_f(mul_param, mul_param, o->_kx[i]);
701                         init_complex(o->_fft_in_nx[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
702                 }
703         }
704         fftw_execute(o->_N_x_plan);
705 }
706
707 static void ocean_compute_normal_z(TaskPool *pool, void *UNUSED(taskdata), int UNUSED(threadid))
708 {
709         OceanSimulateData *osd = BLI_task_pool_userdata(pool);
710         const Ocean *o = osd->o;
711         int i, j;
712
713         for (i = 0; i < o->_M; ++i) {
714                 for (j = 0; j <= o->_N / 2; ++j) {
715                         fftw_complex mul_param;
716
717                         init_complex(mul_param, 0.0, -1.0);
718                         mul_complex_c(mul_param, mul_param, o->_htilda[i * (1 + o->_N / 2) + j]);
719                         mul_complex_f(mul_param, mul_param, o->_kz[i]);
720                         init_complex(o->_fft_in_nz[i * (1 + o->_N / 2) + j], real_c(mul_param), image_c(mul_param));
721                 }
722         }
723         fftw_execute(o->_N_z_plan);
724 }
725
726 void BKE_ocean_simulate(struct Ocean *o, float t, float scale, float chop_amount)
727 {
728         TaskScheduler *scheduler = BLI_task_scheduler_get();
729         TaskPool *pool;
730
731         OceanSimulateData osd;
732
733         scale *= o->normalize_factor;
734
735         osd.o = o;
736         osd.t = t;
737         osd.scale = scale;
738         osd.chop_amount = chop_amount;
739
740         pool = BLI_task_pool_create(scheduler, &osd);
741
742         BLI_rw_mutex_lock(&o->oceanmutex, THREAD_LOCK_WRITE);
743
744         /* Note about multi-threading here: we have to run a first set of computations (htilda one) before we can run
745          * all others, since they all depend on it.
746          * So we make a first parallelized forloop run for htilda, and then pack all other computations into
747          * a set of parallel tasks.
748          * This is not optimal in all cases, but remains reasonably simple and should be OK most of the time. */
749
750         /* compute a new htilda */
751         BLI_task_parallel_range(0, o->_M, &osd, ocean_compute_htilda, o->_M > 16);
752
753         if (o->_do_disp_y) {
754                 BLI_task_pool_push(pool, ocean_compute_displacement_y, NULL, false, TASK_PRIORITY_HIGH);
755         }
756
757         if (o->_do_chop) {
758                 BLI_task_pool_push(pool, ocean_compute_displacement_x, NULL, false, TASK_PRIORITY_HIGH);
759                 BLI_task_pool_push(pool, ocean_compute_displacement_z, NULL, false, TASK_PRIORITY_HIGH);
760         }
761
762         if (o->_do_jacobian) {
763                 BLI_task_pool_push(pool, ocean_compute_jacobian_jxx, NULL, false, TASK_PRIORITY_HIGH);
764                 BLI_task_pool_push(pool, ocean_compute_jacobian_jzz, NULL, false, TASK_PRIORITY_HIGH);
765                 BLI_task_pool_push(pool, ocean_compute_jacobian_jxz, NULL, false, TASK_PRIORITY_HIGH);
766         }
767
768         if (o->_do_normals) {
769                 BLI_task_pool_push(pool, ocean_compute_normal_x, NULL, false, TASK_PRIORITY_HIGH);
770                 BLI_task_pool_push(pool, ocean_compute_normal_z, NULL, false, TASK_PRIORITY_HIGH);
771
772 #if 0
773                 for (i = 0; i < o->_M; ++i) {
774                         for (j = 0; j < o->_N; ++j) {
775                                 o->_N_y[i * o->_N + j] = 1.0f / scale;
776                         }
777                 }
778                 (MEM01)
779 #endif
780                 o->_N_y = 1.0f / scale;
781         }
782
783         BLI_task_pool_work_and_wait(pool);
784
785         BLI_rw_mutex_unlock(&o->oceanmutex);
786
787         BLI_task_pool_free(pool);
788 }
789
790 static void set_height_normalize_factor(struct Ocean *oc)
791 {
792         float res = 1.0;
793         float max_h = 0.0;
794
795         int i, j;
796
797         if (!oc->_do_disp_y) return;
798
799         oc->normalize_factor = 1.0;
800
801         BKE_ocean_simulate(oc, 0.0, 1.0, 0);
802
803         BLI_rw_mutex_lock(&oc->oceanmutex, THREAD_LOCK_READ);
804
805         for (i = 0; i < oc->_M; ++i) {
806                 for (j = 0; j < oc->_N; ++j) {
807                         if (max_h < fabs(oc->_disp_y[i * oc->_N + j])) {
808                                 max_h = fabs(oc->_disp_y[i * oc->_N + j]);
809                         }
810                 }
811         }
812
813         BLI_rw_mutex_unlock(&oc->oceanmutex);
814
815         if (max_h == 0.0f)
816                 max_h = 0.00001f;  /* just in case ... */
817
818         res = 1.0f / (max_h);
819
820         oc->normalize_factor = res;
821 }
822
823 struct Ocean *BKE_ocean_add(void)
824 {
825         Ocean *oc = MEM_callocN(sizeof(Ocean), "ocean sim data");
826
827         BLI_rw_mutex_init(&oc->oceanmutex);
828
829         return oc;
830 }
831
832 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,
833                     float alignment, float depth, float time, short do_height_field, short do_chop, short do_normals,
834                     short do_jacobian, int seed)
835 {
836         RNG *rng;
837         int i, j, ii;
838
839         BLI_rw_mutex_lock(&o->oceanmutex, THREAD_LOCK_WRITE);
840
841         o->_M = M;
842         o->_N = N;
843         o->_V = V;
844         o->_l = l;
845         o->_A = A;
846         o->_w = w;
847         o->_damp_reflections = 1.0f - damp;
848         o->_wind_alignment = alignment;
849         o->_depth = depth;
850         o->_Lx = Lx;
851         o->_Lz = Lz;
852         o->_wx = cos(w);
853         o->_wz = -sin(w); /* wave direction */
854         o->_L = V * V / GRAVITY;  /* largest wave for a given velocity V */
855         o->time = time;
856
857         o->_do_disp_y = do_height_field;
858         o->_do_normals = do_normals;
859         o->_do_chop = do_chop;
860         o->_do_jacobian = do_jacobian;
861
862         o->_k = (float *) MEM_mallocN(M * (1 + N / 2) * sizeof(float), "ocean_k");
863         o->_h0 = (fftw_complex *) MEM_mallocN(M * N * sizeof(fftw_complex), "ocean_h0");
864         o->_h0_minus = (fftw_complex *) MEM_mallocN(M * N * sizeof(fftw_complex), "ocean_h0_minus");
865         o->_kx = (float *) MEM_mallocN(o->_M * sizeof(float), "ocean_kx");
866         o->_kz = (float *) MEM_mallocN(o->_N * sizeof(float), "ocean_kz");
867
868         /* make this robust in the face of erroneous usage */
869         if (o->_Lx == 0.0f)
870                 o->_Lx = 0.001f;
871
872         if (o->_Lz == 0.0f)
873                 o->_Lz = 0.001f;
874
875         /* the +ve components and DC */
876         for (i = 0; i <= o->_M / 2; ++i)
877                 o->_kx[i] = 2.0f * (float)M_PI * i / o->_Lx;
878
879         /* the -ve components */
880         for (i = o->_M - 1, ii = 0; i > o->_M / 2; --i, ++ii)
881                 o->_kx[i] = -2.0f * (float)M_PI * ii / o->_Lx;
882
883         /* the +ve components and DC */
884         for (i = 0; i <= o->_N / 2; ++i)
885                 o->_kz[i] = 2.0f * (float)M_PI * i / o->_Lz;
886
887         /* the -ve components */
888         for (i = o->_N - 1, ii = 0; i > o->_N / 2; --i, ++ii)
889                 o->_kz[i] = -2.0f * (float)M_PI * ii / o->_Lz;
890
891         /* pre-calculate the k matrix */
892         for (i = 0; i < o->_M; ++i)
893                 for (j = 0; j <= o->_N / 2; ++j)
894                         o->_k[i * (1 + o->_N / 2) + j] = sqrt(o->_kx[i] * o->_kx[i] + o->_kz[j] * o->_kz[j]);
895
896         /*srand(seed);*/
897         rng = BLI_rng_new(seed);
898
899         for (i = 0; i < o->_M; ++i) {
900                 for (j = 0; j < o->_N; ++j) {
901                         float r1 = gaussRand(rng);
902                         float r2 = gaussRand(rng);
903
904                         fftw_complex r1r2;
905                         init_complex(r1r2, r1, r2);
906                         mul_complex_f(o->_h0[i * o->_N + j], r1r2, (float)(sqrt(Ph(o, o->_kx[i], o->_kz[j]) / 2.0f)));
907                         mul_complex_f(o->_h0_minus[i * o->_N + j], r1r2, (float)(sqrt(Ph(o, -o->_kx[i], -o->_kz[j]) / 2.0f)));
908                 }
909         }
910
911         o->_fft_in = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex), "ocean_fft_in");
912         o->_htilda = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex), "ocean_htilda");
913
914         BLI_lock_thread(LOCK_FFTW);
915
916         if (o->_do_disp_y) {
917                 o->_disp_y = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_disp_y");
918                 o->_disp_y_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in, o->_disp_y, FFTW_ESTIMATE);
919         }
920
921         if (o->_do_normals) {
922                 o->_fft_in_nx = (fftw_complex *) MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex), "ocean_fft_in_nx");
923                 o->_fft_in_nz = (fftw_complex *) MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex), "ocean_fft_in_nz");
924
925                 o->_N_x = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_N_x");
926                 /* o->_N_y = (float *) fftwf_malloc(o->_M * o->_N * sizeof(float)); (MEM01) */
927                 o->_N_z = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_N_z");
928
929                 o->_N_x_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_nx, o->_N_x, FFTW_ESTIMATE);
930                 o->_N_z_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_nz, o->_N_z, FFTW_ESTIMATE);
931         }
932
933         if (o->_do_chop) {
934                 o->_fft_in_x = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex), "ocean_fft_in_x");
935                 o->_fft_in_z = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex), "ocean_fft_in_z");
936
937                 o->_disp_x = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_disp_x");
938                 o->_disp_z = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_disp_z");
939
940                 o->_disp_x_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_x, o->_disp_x, FFTW_ESTIMATE);
941                 o->_disp_z_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_z, o->_disp_z, FFTW_ESTIMATE);
942         }
943         if (o->_do_jacobian) {
944                 o->_fft_in_jxx = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex),
945                                                              "ocean_fft_in_jxx");
946                 o->_fft_in_jzz = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex),
947                                                              "ocean_fft_in_jzz");
948                 o->_fft_in_jxz = (fftw_complex *)MEM_mallocN(o->_M * (1 + o->_N / 2) * sizeof(fftw_complex),
949                                                              "ocean_fft_in_jxz");
950
951                 o->_Jxx = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_Jxx");
952                 o->_Jzz = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_Jzz");
953                 o->_Jxz = (double *)MEM_mallocN(o->_M * o->_N * sizeof(double), "ocean_Jxz");
954
955                 o->_Jxx_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_jxx, o->_Jxx, FFTW_ESTIMATE);
956                 o->_Jzz_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_jzz, o->_Jzz, FFTW_ESTIMATE);
957                 o->_Jxz_plan = fftw_plan_dft_c2r_2d(o->_M, o->_N, o->_fft_in_jxz, o->_Jxz, FFTW_ESTIMATE);
958         }
959
960         BLI_unlock_thread(LOCK_FFTW);
961
962         BLI_rw_mutex_unlock(&o->oceanmutex);
963
964         set_height_normalize_factor(o);
965
966         BLI_rng_free(rng);
967 }
968
969 void BKE_ocean_free_data(struct Ocean *oc)
970 {
971         if (!oc) return;
972
973         BLI_rw_mutex_lock(&oc->oceanmutex, THREAD_LOCK_WRITE);
974
975         BLI_lock_thread(LOCK_FFTW);
976
977         if (oc->_do_disp_y) {
978                 fftw_destroy_plan(oc->_disp_y_plan);
979                 MEM_freeN(oc->_disp_y);
980         }
981
982         if (oc->_do_normals) {
983                 MEM_freeN(oc->_fft_in_nx);
984                 MEM_freeN(oc->_fft_in_nz);
985                 fftw_destroy_plan(oc->_N_x_plan);
986                 fftw_destroy_plan(oc->_N_z_plan);
987                 MEM_freeN(oc->_N_x);
988                 /*fftwf_free(oc->_N_y); (MEM01)*/
989                 MEM_freeN(oc->_N_z);
990         }
991
992         if (oc->_do_chop) {
993                 MEM_freeN(oc->_fft_in_x);
994                 MEM_freeN(oc->_fft_in_z);
995                 fftw_destroy_plan(oc->_disp_x_plan);
996                 fftw_destroy_plan(oc->_disp_z_plan);
997                 MEM_freeN(oc->_disp_x);
998                 MEM_freeN(oc->_disp_z);
999         }
1000
1001         if (oc->_do_jacobian) {
1002                 MEM_freeN(oc->_fft_in_jxx);
1003                 MEM_freeN(oc->_fft_in_jzz);
1004                 MEM_freeN(oc->_fft_in_jxz);
1005                 fftw_destroy_plan(oc->_Jxx_plan);
1006                 fftw_destroy_plan(oc->_Jzz_plan);
1007                 fftw_destroy_plan(oc->_Jxz_plan);
1008                 MEM_freeN(oc->_Jxx);
1009                 MEM_freeN(oc->_Jzz);
1010                 MEM_freeN(oc->_Jxz);
1011         }
1012
1013         BLI_unlock_thread(LOCK_FFTW);
1014
1015         if (oc->_fft_in)
1016                 MEM_freeN(oc->_fft_in);
1017
1018         /* check that ocean data has been initialized */
1019         if (oc->_htilda) {
1020                 MEM_freeN(oc->_htilda);
1021                 MEM_freeN(oc->_k);
1022                 MEM_freeN(oc->_h0);
1023                 MEM_freeN(oc->_h0_minus);
1024                 MEM_freeN(oc->_kx);
1025                 MEM_freeN(oc->_kz);
1026         }
1027
1028         BLI_rw_mutex_unlock(&oc->oceanmutex);
1029 }
1030
1031 void BKE_ocean_free(struct Ocean *oc)
1032 {
1033         if (!oc) return;
1034
1035         BKE_ocean_free_data(oc);
1036         BLI_rw_mutex_end(&oc->oceanmutex);
1037
1038         MEM_freeN(oc);
1039 }
1040
1041 #undef GRAVITY
1042
1043
1044 /* ********* Baking/Caching ********* */
1045
1046
1047 #define CACHE_TYPE_DISPLACE 1
1048 #define CACHE_TYPE_FOAM     2
1049 #define CACHE_TYPE_NORMAL   3
1050
1051 static void cache_filename(char *string, const char *path, const char *relbase, int frame, int type)
1052 {
1053         char cachepath[FILE_MAX];
1054         const char *fname;
1055
1056         switch (type) {
1057                 case CACHE_TYPE_FOAM:
1058                         fname = "foam_";
1059                         break;
1060                 case CACHE_TYPE_NORMAL:
1061                         fname = "normal_";
1062                         break;
1063                 case CACHE_TYPE_DISPLACE:
1064                 default:
1065                         fname = "disp_";
1066                         break;
1067         }
1068
1069         BLI_join_dirfile(cachepath, sizeof(cachepath), path, fname);
1070
1071         BKE_image_path_from_imtype(string, cachepath, relbase, frame, R_IMF_IMTYPE_OPENEXR, true, true, "");
1072 }
1073
1074 /* silly functions but useful to inline when the args do a lot of indirections */
1075 MINLINE void rgb_to_rgba_unit_alpha(float r_rgba[4], const float rgb[3])
1076 {
1077         r_rgba[0] = rgb[0];
1078         r_rgba[1] = rgb[1];
1079         r_rgba[2] = rgb[2];
1080         r_rgba[3] = 1.0f;
1081 }
1082 MINLINE void value_to_rgba_unit_alpha(float r_rgba[4], const float value)
1083 {
1084         r_rgba[0] = value;
1085         r_rgba[1] = value;
1086         r_rgba[2] = value;
1087         r_rgba[3] = 1.0f;
1088 }
1089
1090 void BKE_ocean_free_cache(struct OceanCache *och)
1091 {
1092         int i, f = 0;
1093
1094         if (!och) return;
1095
1096         if (och->ibufs_disp) {
1097                 for (i = och->start, f = 0; i <= och->end; i++, f++) {
1098                         if (och->ibufs_disp[f]) {
1099                                 IMB_freeImBuf(och->ibufs_disp[f]);
1100                         }
1101                 }
1102                 MEM_freeN(och->ibufs_disp);
1103         }
1104
1105         if (och->ibufs_foam) {
1106                 for (i = och->start, f = 0; i <= och->end; i++, f++) {
1107                         if (och->ibufs_foam[f]) {
1108                                 IMB_freeImBuf(och->ibufs_foam[f]);
1109                         }
1110                 }
1111                 MEM_freeN(och->ibufs_foam);
1112         }
1113
1114         if (och->ibufs_norm) {
1115                 for (i = och->start, f = 0; i <= och->end; i++, f++) {
1116                         if (och->ibufs_norm[f]) {
1117                                 IMB_freeImBuf(och->ibufs_norm[f]);
1118                         }
1119                 }
1120                 MEM_freeN(och->ibufs_norm);
1121         }
1122
1123         if (och->time)
1124                 MEM_freeN(och->time);
1125         MEM_freeN(och);
1126 }
1127
1128 void BKE_ocean_cache_eval_uv(struct OceanCache *och, struct OceanResult *ocr, int f, float u, float v)
1129 {
1130         int res_x = och->resolution_x;
1131         int res_y = och->resolution_y;
1132         float result[4];
1133
1134         u = fmod(u, 1.0);
1135         v = fmod(v, 1.0);
1136
1137         if (u < 0) u += 1.0f;
1138         if (v < 0) v += 1.0f;
1139
1140         if (och->ibufs_disp[f]) {
1141                 ibuf_sample(och->ibufs_disp[f], u, v, (1.0f / (float)res_x), (1.0f / (float)res_y), result);
1142                 copy_v3_v3(ocr->disp, result);
1143         }
1144
1145         if (och->ibufs_foam[f]) {
1146                 ibuf_sample(och->ibufs_foam[f], u, v, (1.0f / (float)res_x), (1.0f / (float)res_y), result);
1147                 ocr->foam = result[0];
1148         }
1149
1150         if (och->ibufs_norm[f]) {
1151                 ibuf_sample(och->ibufs_norm[f], u, v, (1.0f / (float)res_x), (1.0f / (float)res_y), result);
1152                 copy_v3_v3(ocr->normal, result);
1153         }
1154 }
1155
1156 void BKE_ocean_cache_eval_ij(struct OceanCache *och, struct OceanResult *ocr, int f, int i, int j)
1157 {
1158         const int res_x = och->resolution_x;
1159         const int res_y = och->resolution_y;
1160
1161         if (i < 0) i = -i;
1162         if (j < 0) j = -j;
1163
1164         i = i % res_x;
1165         j = j % res_y;
1166
1167         if (och->ibufs_disp[f]) {
1168                 copy_v3_v3(ocr->disp, &och->ibufs_disp[f]->rect_float[4 * (res_x * j + i)]);
1169         }
1170
1171         if (och->ibufs_foam[f]) {
1172                 ocr->foam = och->ibufs_foam[f]->rect_float[4 * (res_x * j + i)];
1173         }
1174
1175         if (och->ibufs_norm[f]) {
1176                 copy_v3_v3(ocr->normal, &och->ibufs_norm[f]->rect_float[4 * (res_x * j + i)]);
1177         }
1178 }
1179
1180 struct OceanCache *BKE_ocean_init_cache(const char *bakepath, const char *relbase, int start, int end, float wave_scale,
1181                                         float chop_amount, float foam_coverage, float foam_fade, int resolution)
1182 {
1183         OceanCache *och = MEM_callocN(sizeof(OceanCache), "ocean cache data");
1184
1185         och->bakepath = bakepath;
1186         och->relbase = relbase;
1187
1188         och->start = start;
1189         och->end = end;
1190         och->duration = (end - start) + 1;
1191         och->wave_scale = wave_scale;
1192         och->chop_amount = chop_amount;
1193         och->foam_coverage = foam_coverage;
1194         och->foam_fade = foam_fade;
1195         och->resolution_x = resolution * resolution;
1196         och->resolution_y = resolution * resolution;
1197
1198         och->ibufs_disp = MEM_callocN(sizeof(ImBuf *) * och->duration, "displacement imbuf pointer array");
1199         och->ibufs_foam = MEM_callocN(sizeof(ImBuf *) * och->duration, "foam imbuf pointer array");
1200         och->ibufs_norm = MEM_callocN(sizeof(ImBuf *) * och->duration, "normal imbuf pointer array");
1201
1202         och->time = NULL;
1203
1204         return och;
1205 }
1206
1207 void BKE_ocean_simulate_cache(struct OceanCache *och, int frame)
1208 {
1209         char string[FILE_MAX];
1210         int f = frame;
1211
1212         /* ibufs array is zero based, but filenames are based on frame numbers */
1213         /* still need to clamp frame numbers to valid range of images on disk though */
1214         CLAMP(frame, och->start, och->end);
1215         f = frame - och->start; /* shift to 0 based */
1216
1217         /* if image is already loaded in mem, return */
1218         if (och->ibufs_disp[f] != NULL) return;
1219
1220         /* use default color spaces since we know for sure cache files were saved with default settings too */
1221
1222         cache_filename(string, och->bakepath, och->relbase, frame, CACHE_TYPE_DISPLACE);
1223         och->ibufs_disp[f] = IMB_loadiffname(string, 0, NULL);
1224 #if 0
1225         if (och->ibufs_disp[f] == NULL)
1226                 printf("error loading %s\n", string);
1227         else
1228                 printf("loaded cache %s\n", string);
1229 #endif
1230
1231         cache_filename(string, och->bakepath, och->relbase, frame, CACHE_TYPE_FOAM);
1232         och->ibufs_foam[f] = IMB_loadiffname(string, 0, NULL);
1233 #if 0
1234         if (och->ibufs_foam[f] == NULL)
1235                 printf("error loading %s\n", string);
1236         else
1237                 printf("loaded cache %s\n", string);
1238 #endif
1239
1240         cache_filename(string, och->bakepath, och->relbase, frame, CACHE_TYPE_NORMAL);
1241         och->ibufs_norm[f] = IMB_loadiffname(string, 0, NULL);
1242 #if 0
1243         if (och->ibufs_norm[f] == NULL)
1244                 printf("error loading %s\n", string);
1245         else
1246                 printf("loaded cache %s\n", string);
1247 #endif
1248 }
1249
1250
1251 void BKE_ocean_bake(struct Ocean *o, struct OceanCache *och, void (*update_cb)(void *, float progress, int *cancel),
1252                     void *update_cb_data)
1253 {
1254         /* note: some of these values remain uninitialized unless certain options
1255          * are enabled, take care that BKE_ocean_eval_ij() initializes a member
1256          * before use - campbell */
1257         OceanResult ocr;
1258
1259         ImageFormatData imf = {0};
1260
1261         int f, i = 0, x, y, cancel = 0;
1262         float progress;
1263
1264         ImBuf *ibuf_foam, *ibuf_disp, *ibuf_normal;
1265         float *prev_foam;
1266         int res_x = och->resolution_x;
1267         int res_y = och->resolution_y;
1268         char string[FILE_MAX];
1269         //RNG *rng;
1270
1271         if (!o) return;
1272
1273         if (o->_do_jacobian) prev_foam = MEM_callocN(res_x * res_y * sizeof(float), "previous frame foam bake data");
1274         else prev_foam = NULL;
1275
1276         //rng = BLI_rng_new(0);
1277
1278         /* setup image format */
1279         imf.imtype = R_IMF_IMTYPE_OPENEXR;
1280         imf.depth =  R_IMF_CHAN_DEPTH_16;
1281         imf.exr_codec = R_IMF_EXR_CODEC_ZIP;
1282
1283         for (f = och->start, i = 0; f <= och->end; f++, i++) {
1284
1285                 /* create a new imbuf to store image for this frame */
1286                 ibuf_foam = IMB_allocImBuf(res_x, res_y, 32, IB_rectfloat);
1287                 ibuf_disp = IMB_allocImBuf(res_x, res_y, 32, IB_rectfloat);
1288                 ibuf_normal = IMB_allocImBuf(res_x, res_y, 32, IB_rectfloat);
1289
1290                 BKE_ocean_simulate(o, och->time[i], och->wave_scale, och->chop_amount);
1291
1292                 /* add new foam */
1293                 for (y = 0; y < res_y; y++) {
1294                         for (x = 0; x < res_x; x++) {
1295
1296                                 BKE_ocean_eval_ij(o, &ocr, x, y);
1297
1298                                 /* add to the image */
1299                                 rgb_to_rgba_unit_alpha(&ibuf_disp->rect_float[4 * (res_x * y + x)], ocr.disp);
1300
1301                                 if (o->_do_jacobian) {
1302                                         /* TODO, cleanup unused code - campbell */
1303
1304                                         float /*r, */ /* UNUSED */ pr = 0.0f, foam_result;
1305                                         float neg_disp, neg_eplus;
1306
1307                                         ocr.foam = BKE_ocean_jminus_to_foam(ocr.Jminus, och->foam_coverage);
1308
1309                                         /* accumulate previous value for this cell */
1310                                         if (i > 0) {
1311                                                 pr = prev_foam[res_x * y + x];
1312                                         }
1313
1314                                         /* r = BLI_rng_get_float(rng); */ /* UNUSED */ /* randomly reduce foam */
1315
1316                                         /* pr = pr * och->foam_fade; */         /* overall fade */
1317
1318                                         /* remember ocean coord sys is Y up!
1319                                          * break up the foam where height (Y) is low (wave valley), and X and Z displacement is greatest
1320                                          */
1321
1322 #if 0
1323                                         vec[0] = ocr.disp[0];
1324                                         vec[1] = ocr.disp[2];
1325                                         hor_stretch = len_v2(vec);
1326                                         CLAMP(hor_stretch, 0.0, 1.0);
1327 #endif
1328
1329                                         neg_disp = ocr.disp[1] < 0.0f ? 1.0f + ocr.disp[1] : 1.0f;
1330                                         neg_disp = neg_disp < 0.0f ? 0.0f : neg_disp;
1331
1332                                         /* foam, 'ocr.Eplus' only initialized with do_jacobian */
1333                                         neg_eplus = ocr.Eplus[2] < 0.0f ? 1.0f + ocr.Eplus[2] : 1.0f;
1334                                         neg_eplus = neg_eplus < 0.0f ? 0.0f : neg_eplus;
1335
1336 #if 0
1337                                         if (ocr.disp[1] < 0.0 || r > och->foam_fade)
1338                                                 pr *= och->foam_fade;
1339
1340
1341                                         pr = pr * (1.0 - hor_stretch) * ocr.disp[1];
1342                                         pr = pr * neg_disp * neg_eplus;
1343 #endif
1344
1345                                         if (pr < 1.0f)
1346                                                 pr *= pr;
1347
1348                                         pr *= och->foam_fade * (0.75f + neg_eplus * 0.25f);
1349
1350                                         /* A full clamping should not be needed! */
1351                                         foam_result = min_ff(pr + ocr.foam, 1.0f);
1352
1353                                         prev_foam[res_x * y + x] = foam_result;
1354
1355                                         /*foam_result = min_ff(foam_result, 1.0f); */
1356
1357                                         value_to_rgba_unit_alpha(&ibuf_foam->rect_float[4 * (res_x * y + x)], foam_result);
1358                                 }
1359
1360                                 if (o->_do_normals) {
1361                                         rgb_to_rgba_unit_alpha(&ibuf_normal->rect_float[4 * (res_x * y + x)], ocr.normal);
1362                                 }
1363                         }
1364                 }
1365
1366                 /* write the images */
1367                 cache_filename(string, och->bakepath, och->relbase, f, CACHE_TYPE_DISPLACE);
1368                 if (0 == BKE_imbuf_write(ibuf_disp, string, &imf))
1369                         printf("Cannot save Displacement File Output to %s\n", string);
1370
1371                 if (o->_do_jacobian) {
1372                         cache_filename(string, och->bakepath, och->relbase, f, CACHE_TYPE_FOAM);
1373                         if (0 == BKE_imbuf_write(ibuf_foam, string, &imf))
1374                                 printf("Cannot save Foam File Output to %s\n", string);
1375                 }
1376
1377                 if (o->_do_normals) {
1378                         cache_filename(string, och->bakepath, och->relbase, f, CACHE_TYPE_NORMAL);
1379                         if (0 == BKE_imbuf_write(ibuf_normal, string, &imf))
1380                                 printf("Cannot save Normal File Output to %s\n", string);
1381                 }
1382
1383                 IMB_freeImBuf(ibuf_disp);
1384                 IMB_freeImBuf(ibuf_foam);
1385                 IMB_freeImBuf(ibuf_normal);
1386
1387                 progress = (f - och->start) / (float)och->duration;
1388
1389                 update_cb(update_cb_data, progress, &cancel);
1390
1391                 if (cancel) {
1392                         if (prev_foam) MEM_freeN(prev_foam);
1393                         //BLI_rng_free(rng);
1394                         return;
1395                 }
1396         }
1397
1398         //BLI_rng_free(rng);
1399         if (prev_foam) MEM_freeN(prev_foam);
1400         och->baked = 1;
1401 }
1402
1403 #else /* WITH_OCEANSIM */
1404
1405 /* stub */
1406 typedef struct Ocean {
1407         /* need some data here, C does not allow empty struct */
1408         int stub;
1409 } Ocean;
1410
1411
1412 float BKE_ocean_jminus_to_foam(float UNUSED(jminus), float UNUSED(coverage))
1413 {
1414         return 0.0f;
1415 }
1416
1417 void BKE_ocean_eval_uv(struct Ocean *UNUSED(oc), struct OceanResult *UNUSED(ocr), float UNUSED(u), float UNUSED(v))
1418 {
1419 }
1420
1421 /* use catmullrom interpolation rather than linear */
1422 void BKE_ocean_eval_uv_catrom(struct Ocean *UNUSED(oc), struct OceanResult *UNUSED(ocr), float UNUSED(u),
1423                               float UNUSED(v))
1424 {
1425 }
1426
1427 void BKE_ocean_eval_xz(struct Ocean *UNUSED(oc), struct OceanResult *UNUSED(ocr), float UNUSED(x), float UNUSED(z))
1428 {
1429 }
1430
1431 void BKE_ocean_eval_xz_catrom(struct Ocean *UNUSED(oc), struct OceanResult *UNUSED(ocr), float UNUSED(x),
1432                               float UNUSED(z))
1433 {
1434 }
1435
1436 void BKE_ocean_eval_ij(struct Ocean *UNUSED(oc), struct OceanResult *UNUSED(ocr), int UNUSED(i), int UNUSED(j))
1437 {
1438 }
1439
1440 void BKE_ocean_simulate(struct Ocean *UNUSED(o), float UNUSED(t), float UNUSED(scale), float UNUSED(chop_amount))
1441 {
1442 }
1443
1444 struct Ocean *BKE_ocean_add(void)
1445 {
1446         Ocean *oc = MEM_callocN(sizeof(Ocean), "ocean sim data");
1447
1448         return oc;
1449 }
1450
1451 void BKE_ocean_init(struct Ocean *UNUSED(o), int UNUSED(M), int UNUSED(N), float UNUSED(Lx), float UNUSED(Lz),
1452                     float UNUSED(V), float UNUSED(l), float UNUSED(A), float UNUSED(w), float UNUSED(damp),
1453                     float UNUSED(alignment), float UNUSED(depth), float UNUSED(time), short UNUSED(do_height_field),
1454                     short UNUSED(do_chop), short UNUSED(do_normals), short UNUSED(do_jacobian), int UNUSED(seed))
1455 {
1456 }
1457
1458 void BKE_ocean_free_data(struct Ocean *UNUSED(oc))
1459 {
1460 }
1461
1462 void BKE_ocean_free(struct Ocean *oc)
1463 {
1464         if (!oc) return;
1465         MEM_freeN(oc);
1466 }
1467
1468
1469 /* ********* Baking/Caching ********* */
1470
1471
1472 void BKE_ocean_free_cache(struct OceanCache *och)
1473 {
1474         if (!och) return;
1475
1476         MEM_freeN(och);
1477 }
1478
1479 void BKE_ocean_cache_eval_uv(struct OceanCache *UNUSED(och), struct OceanResult *UNUSED(ocr), int UNUSED(f),
1480                              float UNUSED(u), float UNUSED(v))
1481 {
1482 }
1483
1484 void BKE_ocean_cache_eval_ij(struct OceanCache *UNUSED(och), struct OceanResult *UNUSED(ocr), int UNUSED(f),
1485                              int UNUSED(i), int UNUSED(j))
1486 {
1487 }
1488
1489 OceanCache *BKE_ocean_init_cache(const char *UNUSED(bakepath), const char *UNUSED(relbase), int UNUSED(start),
1490                                  int UNUSED(end), float UNUSED(wave_scale), float UNUSED(chop_amount),
1491                                  float UNUSED(foam_coverage), float UNUSED(foam_fade), int UNUSED(resolution))
1492 {
1493         OceanCache *och = MEM_callocN(sizeof(OceanCache), "ocean cache data");
1494
1495         return och;
1496 }
1497
1498 void BKE_ocean_simulate_cache(struct OceanCache *UNUSED(och), int UNUSED(frame))
1499 {
1500 }
1501
1502 void BKE_ocean_bake(struct Ocean *UNUSED(o), struct OceanCache *UNUSED(och),
1503                     void (*update_cb)(void *, float progress, int *cancel), void *UNUSED(update_cb_data))
1504 {
1505         /* unused */
1506         (void)update_cb;
1507 }
1508 #endif /* WITH_OCEANSIM */