Fix #34679: cycles image texture alpha fringes. New rule is now that color output
[blender-staging.git] / intern / cycles / kernel / svm / svm_image.h
1 /*
2  * Copyright 2011, Blender Foundation.
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
19 CCL_NAMESPACE_BEGIN
20
21 #ifdef __KERNEL_OPENCL__
22
23 /* For OpenCL all images are packed in a single array, and we do manual lookup
24  * and interpolation. */
25
26 __device_inline float4 svm_image_texture_read(KernelGlobals *kg, int offset)
27 {
28         uchar4 r = kernel_tex_fetch(__tex_image_packed, offset);
29         float f = 1.0f/255.0f;
30         return make_float4(r.x*f, r.y*f, r.z*f, r.w*f);
31 }
32
33 __device_inline int svm_image_texture_wrap_periodic(int x, int width)
34 {
35         x %= width;
36         if(x < 0)
37                 x += width;
38         return x;
39 }
40
41 __device_inline int svm_image_texture_wrap_clamp(int x, int width)
42 {
43         return clamp(x, 0, width-1);
44 }
45
46 __device_inline float svm_image_texture_frac(float x, int *ix)
47 {
48         int i = (int)x - ((x < 0.0f)? 1: 0);
49         *ix = i;
50         return x - (float)i;
51 }
52
53 __device float4 svm_image_texture(KernelGlobals *kg, int id, float x, float y, uint srgb, uint use_alpha)
54 {
55         /* first slots are used by float textures, which are not supported here */
56         if(id < TEX_NUM_FLOAT_IMAGES)
57                 return make_float4(1.0f, 0.0f, 1.0f, 1.0f);
58
59         id -= TEX_NUM_FLOAT_IMAGES;
60
61         uint4 info = kernel_tex_fetch(__tex_image_packed_info, id);
62         uint width = info.x;
63         uint height = info.y;
64         uint offset = info.z;
65         uint periodic = info.w;
66
67         int ix, iy, nix, niy;
68         float tx = svm_image_texture_frac(x*width, &ix);
69         float ty = svm_image_texture_frac(y*height, &iy);
70
71         if(periodic) {
72                 ix = svm_image_texture_wrap_periodic(ix, width);
73                 iy = svm_image_texture_wrap_periodic(iy, height);
74
75                 nix = svm_image_texture_wrap_periodic(ix+1, width);
76                 niy = svm_image_texture_wrap_periodic(iy+1, height);
77         }
78         else {
79                 ix = svm_image_texture_wrap_clamp(ix, width);
80                 iy = svm_image_texture_wrap_clamp(iy, height);
81
82                 nix = svm_image_texture_wrap_clamp(ix+1, width);
83                 niy = svm_image_texture_wrap_clamp(iy+1, height);
84         }
85
86         float4 r = (1.0f - ty)*(1.0f - tx)*svm_image_texture_read(kg, offset + ix + iy*width);
87         r += (1.0f - ty)*tx*svm_image_texture_read(kg, offset + nix + iy*width);
88         r += ty*(1.0f - tx)*svm_image_texture_read(kg, offset + ix + niy*width);
89         r += ty*tx*svm_image_texture_read(kg, offset + nix + niy*width);
90
91         if(use_alpha && r.w != 1.0f && r.w != 0.0f) {
92                 float invw = 1.0f/r.w;
93                 r.x *= invw;
94                 r.y *= invw;
95                 r.z *= invw;
96         }
97
98         if(srgb) {
99                 r.x = color_srgb_to_scene_linear(r.x);
100                 r.y = color_srgb_to_scene_linear(r.y);
101                 r.z = color_srgb_to_scene_linear(r.z);
102         }
103
104         return r;
105 }
106
107 #else
108
109 __device float4 svm_image_texture(KernelGlobals *kg, int id, float x, float y, uint srgb, uint use_alpha)
110 {
111         float4 r;
112
113 #ifdef __KERNEL_CPU__
114         r = kernel_tex_image_interp(id, x, y);
115 #else
116         /* not particularly proud of this massive switch, what are the
117          * alternatives?
118          * - use a single big 1D texture, and do our own lookup/filtering
119          * - group by size and use a 3d texture, performance impact
120          * - group into larger texture with some padding for correct lerp
121          *
122          * also note that cuda has 128 textures limit, we use 100 now, since
123          * we still need some for other storage */
124
125         switch(id) {
126                 case 0: r = kernel_tex_image_interp(__tex_image_float_000, x, y); break;
127                 case 1: r = kernel_tex_image_interp(__tex_image_float_001, x, y); break;
128                 case 2: r = kernel_tex_image_interp(__tex_image_float_002, x, y); break;
129                 case 3: r = kernel_tex_image_interp(__tex_image_float_003, x, y); break;
130                 case 4: r = kernel_tex_image_interp(__tex_image_float_004, x, y); break;
131                 case 5: r = kernel_tex_image_interp(__tex_image_005, x, y); break;
132                 case 6: r = kernel_tex_image_interp(__tex_image_006, x, y); break;
133                 case 7: r = kernel_tex_image_interp(__tex_image_007, x, y); break;
134                 case 8: r = kernel_tex_image_interp(__tex_image_008, x, y); break;
135                 case 9: r = kernel_tex_image_interp(__tex_image_009, x, y); break;
136                 case 10: r = kernel_tex_image_interp(__tex_image_010, x, y); break;
137                 case 11: r = kernel_tex_image_interp(__tex_image_011, x, y); break;
138                 case 12: r = kernel_tex_image_interp(__tex_image_012, x, y); break;
139                 case 13: r = kernel_tex_image_interp(__tex_image_013, x, y); break;
140                 case 14: r = kernel_tex_image_interp(__tex_image_014, x, y); break;
141                 case 15: r = kernel_tex_image_interp(__tex_image_015, x, y); break;
142                 case 16: r = kernel_tex_image_interp(__tex_image_016, x, y); break;
143                 case 17: r = kernel_tex_image_interp(__tex_image_017, x, y); break;
144                 case 18: r = kernel_tex_image_interp(__tex_image_018, x, y); break;
145                 case 19: r = kernel_tex_image_interp(__tex_image_019, x, y); break;
146                 case 20: r = kernel_tex_image_interp(__tex_image_020, x, y); break;
147                 case 21: r = kernel_tex_image_interp(__tex_image_021, x, y); break;
148                 case 22: r = kernel_tex_image_interp(__tex_image_022, x, y); break;
149                 case 23: r = kernel_tex_image_interp(__tex_image_023, x, y); break;
150                 case 24: r = kernel_tex_image_interp(__tex_image_024, x, y); break;
151                 case 25: r = kernel_tex_image_interp(__tex_image_025, x, y); break;
152                 case 26: r = kernel_tex_image_interp(__tex_image_026, x, y); break;
153                 case 27: r = kernel_tex_image_interp(__tex_image_027, x, y); break;
154                 case 28: r = kernel_tex_image_interp(__tex_image_028, x, y); break;
155                 case 29: r = kernel_tex_image_interp(__tex_image_029, x, y); break;
156                 case 30: r = kernel_tex_image_interp(__tex_image_030, x, y); break;
157                 case 31: r = kernel_tex_image_interp(__tex_image_031, x, y); break;
158                 case 32: r = kernel_tex_image_interp(__tex_image_032, x, y); break;
159                 case 33: r = kernel_tex_image_interp(__tex_image_033, x, y); break;
160                 case 34: r = kernel_tex_image_interp(__tex_image_034, x, y); break;
161                 case 35: r = kernel_tex_image_interp(__tex_image_035, x, y); break;
162                 case 36: r = kernel_tex_image_interp(__tex_image_036, x, y); break;
163                 case 37: r = kernel_tex_image_interp(__tex_image_037, x, y); break;
164                 case 38: r = kernel_tex_image_interp(__tex_image_038, x, y); break;
165                 case 39: r = kernel_tex_image_interp(__tex_image_039, x, y); break;
166                 case 40: r = kernel_tex_image_interp(__tex_image_040, x, y); break;
167                 case 41: r = kernel_tex_image_interp(__tex_image_041, x, y); break;
168                 case 42: r = kernel_tex_image_interp(__tex_image_042, x, y); break;
169                 case 43: r = kernel_tex_image_interp(__tex_image_043, x, y); break;
170                 case 44: r = kernel_tex_image_interp(__tex_image_044, x, y); break;
171                 case 45: r = kernel_tex_image_interp(__tex_image_045, x, y); break;
172                 case 46: r = kernel_tex_image_interp(__tex_image_046, x, y); break;
173                 case 47: r = kernel_tex_image_interp(__tex_image_047, x, y); break;
174                 case 48: r = kernel_tex_image_interp(__tex_image_048, x, y); break;
175                 case 49: r = kernel_tex_image_interp(__tex_image_049, x, y); break;
176                 case 50: r = kernel_tex_image_interp(__tex_image_050, x, y); break;
177                 case 51: r = kernel_tex_image_interp(__tex_image_051, x, y); break;
178                 case 52: r = kernel_tex_image_interp(__tex_image_052, x, y); break;
179                 case 53: r = kernel_tex_image_interp(__tex_image_053, x, y); break;
180                 case 54: r = kernel_tex_image_interp(__tex_image_054, x, y); break;
181                 case 55: r = kernel_tex_image_interp(__tex_image_055, x, y); break;
182                 case 56: r = kernel_tex_image_interp(__tex_image_056, x, y); break;
183                 case 57: r = kernel_tex_image_interp(__tex_image_057, x, y); break;
184                 case 58: r = kernel_tex_image_interp(__tex_image_058, x, y); break;
185                 case 59: r = kernel_tex_image_interp(__tex_image_059, x, y); break;
186                 case 60: r = kernel_tex_image_interp(__tex_image_060, x, y); break;
187                 case 61: r = kernel_tex_image_interp(__tex_image_061, x, y); break;
188                 case 62: r = kernel_tex_image_interp(__tex_image_062, x, y); break;
189                 case 63: r = kernel_tex_image_interp(__tex_image_063, x, y); break;
190                 case 64: r = kernel_tex_image_interp(__tex_image_064, x, y); break;
191                 case 65: r = kernel_tex_image_interp(__tex_image_065, x, y); break;
192                 case 66: r = kernel_tex_image_interp(__tex_image_066, x, y); break;
193                 case 67: r = kernel_tex_image_interp(__tex_image_067, x, y); break;
194                 case 68: r = kernel_tex_image_interp(__tex_image_068, x, y); break;
195                 case 69: r = kernel_tex_image_interp(__tex_image_069, x, y); break;
196                 case 70: r = kernel_tex_image_interp(__tex_image_070, x, y); break;
197                 case 71: r = kernel_tex_image_interp(__tex_image_071, x, y); break;
198                 case 72: r = kernel_tex_image_interp(__tex_image_072, x, y); break;
199                 case 73: r = kernel_tex_image_interp(__tex_image_073, x, y); break;
200                 case 74: r = kernel_tex_image_interp(__tex_image_074, x, y); break;
201                 case 75: r = kernel_tex_image_interp(__tex_image_075, x, y); break;
202                 case 76: r = kernel_tex_image_interp(__tex_image_076, x, y); break;
203                 case 77: r = kernel_tex_image_interp(__tex_image_077, x, y); break;
204                 case 78: r = kernel_tex_image_interp(__tex_image_078, x, y); break;
205                 case 79: r = kernel_tex_image_interp(__tex_image_079, x, y); break;
206                 case 80: r = kernel_tex_image_interp(__tex_image_080, x, y); break;
207                 case 81: r = kernel_tex_image_interp(__tex_image_081, x, y); break;
208                 case 82: r = kernel_tex_image_interp(__tex_image_082, x, y); break;
209                 case 83: r = kernel_tex_image_interp(__tex_image_083, x, y); break;
210                 case 84: r = kernel_tex_image_interp(__tex_image_084, x, y); break;
211                 case 85: r = kernel_tex_image_interp(__tex_image_085, x, y); break;
212                 case 86: r = kernel_tex_image_interp(__tex_image_086, x, y); break;
213                 case 87: r = kernel_tex_image_interp(__tex_image_087, x, y); break;
214                 case 88: r = kernel_tex_image_interp(__tex_image_088, x, y); break;
215                 case 89: r = kernel_tex_image_interp(__tex_image_089, x, y); break;
216                 case 90: r = kernel_tex_image_interp(__tex_image_090, x, y); break;
217                 case 91: r = kernel_tex_image_interp(__tex_image_091, x, y); break;
218                 case 92: r = kernel_tex_image_interp(__tex_image_092, x, y); break;
219                 case 93: r = kernel_tex_image_interp(__tex_image_093, x, y); break;
220                 case 94: r = kernel_tex_image_interp(__tex_image_094, x, y); break;
221                 case 95: r = kernel_tex_image_interp(__tex_image_095, x, y); break;
222                 case 96: r = kernel_tex_image_interp(__tex_image_096, x, y); break;
223                 case 97: r = kernel_tex_image_interp(__tex_image_097, x, y); break;
224                 case 98: r = kernel_tex_image_interp(__tex_image_098, x, y); break;
225                 case 99: r = kernel_tex_image_interp(__tex_image_099, x, y); break;
226                 default: 
227                         kernel_assert(0);
228                         return make_float4(0.0f, 0.0f, 0.0f, 0.0f);
229         }
230 #endif
231
232         if(use_alpha && r.w != 1.0f && r.w != 0.0f) {
233                 float invw = 1.0f/r.w;
234                 r.x *= invw;
235                 r.y *= invw;
236                 r.z *= invw;
237         }
238
239         if(srgb) {
240                 r.x = color_srgb_to_scene_linear(r.x);
241                 r.y = color_srgb_to_scene_linear(r.y);
242                 r.z = color_srgb_to_scene_linear(r.z);
243         }
244
245         return r;
246 }
247
248 #endif
249
250 __device void svm_node_tex_image(KernelGlobals *kg, ShaderData *sd, float *stack, uint4 node)
251 {
252         uint id = node.y;
253         uint co_offset, out_offset, alpha_offset, srgb;
254
255         decode_node_uchar4(node.z, &co_offset, &out_offset, &alpha_offset, &srgb);
256
257         float3 co = stack_load_float3(stack, co_offset);
258         uint use_alpha = stack_valid(alpha_offset);
259         float4 f = svm_image_texture(kg, id, co.x, co.y, srgb, use_alpha);
260
261         if(stack_valid(out_offset))
262                 stack_store_float3(stack, out_offset, make_float3(f.x, f.y, f.z));
263         if(stack_valid(alpha_offset))
264                 stack_store_float(stack, alpha_offset, f.w);
265 }
266
267 __device void svm_node_tex_image_box(KernelGlobals *kg, ShaderData *sd, float *stack, uint4 node)
268 {
269         /* get object space normal */
270         float3 N = sd->N;
271
272         N = sd->N;
273         if(sd->object != ~0)
274                 object_inverse_normal_transform(kg, sd, &N);
275
276         /* project from direction vector to barycentric coordinates in triangles */
277         N.x = fabsf(N.x);
278         N.y = fabsf(N.y);
279         N.z = fabsf(N.z);
280
281         N /= (N.x + N.y + N.z);
282
283         /* basic idea is to think of this as a triangle, each corner representing
284          * one of the 3 faces of the cube. in the corners we have single textures,
285          * in between we blend between two textures, and in the middle we a blend
286          * between three textures.
287          *
288          * the Nxyz values are the barycentric coordinates in an equilateral
289          * triangle, which in case of blending, in the middle has a smaller
290          * equilateral triangle where 3 textures blend. this divides things into
291          * 7 zones, with an if() test for each zone */
292
293         float3 weight = make_float3(0.0f, 0.0f, 0.0f);
294         float blend = __int_as_float(node.w);
295         float limit = 0.5f*(1.0f + blend);
296
297         /* first test for corners with single texture */
298         if(N.x > limit*(N.x + N.y) && N.x > limit*(N.x + N.z)) {
299                 weight.x = 1.0f;
300         }
301         else if(N.y > limit*(N.x + N.y) && N.y > limit*(N.y + N.z)) {
302                 weight.y = 1.0f;
303         }
304         else if(N.z > limit*(N.x + N.z) && N.z > limit*(N.y + N.z)) {
305                 weight.z = 1.0f;
306         }
307         else if(blend > 0.0f) {
308                 /* in case of blending, test for mixes between two textures */
309                 if(N.z < (1.0f - limit)*(N.y + N.x)) {
310                         weight.x = N.x/(N.x + N.y);
311                         weight.x = clamp((weight.x - 0.5f*(1.0f - blend))/blend, 0.0f, 1.0f);
312                         weight.y = 1.0f - weight.x;
313                 }
314                 else if(N.x < (1.0f - limit)*(N.y + N.z)) {
315                         weight.y = N.y/(N.y + N.z);
316                         weight.y = clamp((weight.y - 0.5f*(1.0f - blend))/blend, 0.0f, 1.0f);
317                         weight.z = 1.0f - weight.y;
318                 }
319                 else if(N.y < (1.0f - limit)*(N.x + N.z)) {
320                         weight.x = N.x/(N.x + N.z);
321                         weight.x = clamp((weight.x - 0.5f*(1.0f - blend))/blend, 0.0f, 1.0f);
322                         weight.z = 1.0f - weight.x;
323                 }
324                 else {
325                         /* last case, we have a mix between three */
326                         weight.x = ((2.0f - limit)*N.x + (limit - 1.0f))/(2.0f*limit - 1.0f);
327                         weight.y = ((2.0f - limit)*N.y + (limit - 1.0f))/(2.0f*limit - 1.0f);
328                         weight.z = ((2.0f - limit)*N.z + (limit - 1.0f))/(2.0f*limit - 1.0f);
329                 }
330         }
331
332         /* now fetch textures */
333         uint co_offset, out_offset, alpha_offset, srgb;
334         decode_node_uchar4(node.z, &co_offset, &out_offset, &alpha_offset, &srgb);
335
336         float3 co = stack_load_float3(stack, co_offset);
337         uint id = node.y;
338
339         float4 f = make_float4(0.0f, 0.0f, 0.0f, 0.0f);
340         uint use_alpha = stack_valid(alpha_offset);
341
342         if(weight.x > 0.0f)
343                 f += weight.x*svm_image_texture(kg, id, co.y, co.z, srgb, use_alpha);
344         if(weight.y > 0.0f)
345                 f += weight.y*svm_image_texture(kg, id, co.x, co.z, srgb, use_alpha);
346         if(weight.z > 0.0f)
347                 f += weight.z*svm_image_texture(kg, id, co.y, co.x, srgb, use_alpha);
348
349         if(stack_valid(out_offset))
350                 stack_store_float3(stack, out_offset, make_float3(f.x, f.y, f.z));
351         if(stack_valid(alpha_offset))
352                 stack_store_float(stack, alpha_offset, f.w);
353 }
354
355
356 __device void svm_node_tex_environment(KernelGlobals *kg, ShaderData *sd, float *stack, uint4 node)
357 {
358         uint id = node.y;
359         uint co_offset, out_offset, alpha_offset, srgb;
360         uint projection = node.w;
361
362         decode_node_uchar4(node.z, &co_offset, &out_offset, &alpha_offset, &srgb);
363
364         float3 co = stack_load_float3(stack, co_offset);
365         float2 uv;
366
367         co = normalize(co);
368         
369         if(projection == 0)
370                 uv = direction_to_equirectangular(co);
371         else
372                 uv = direction_to_mirrorball(co);
373
374         uint use_alpha = stack_valid(alpha_offset);
375         float4 f = svm_image_texture(kg, id, uv.x, uv.y, srgb, use_alpha);
376
377         if(stack_valid(out_offset))
378                 stack_store_float3(stack, out_offset, make_float3(f.x, f.y, f.z));
379         if(stack_valid(alpha_offset))
380                 stack_store_float(stack, alpha_offset, f.w);
381 }
382
383 CCL_NAMESPACE_END
384