8be6742699a5d7bca434fce2dad34852146ac83e
[blender.git] / intern / cycles / kernel / kernel_projection.h
1 /*
2  * Parts adapted from Open Shading Language with this license:
3  *
4  * Copyright (c) 2009-2010 Sony Pictures Imageworks Inc., et al.
5  * All Rights Reserved.
6  *
7  * Modifications Copyright 2011, Blender Foundation.
8  * 
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions are
11  * met:
12  * * Redistributions of source code must retain the above copyright
13  *   notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above copyright
15  *   notice, this list of conditions and the following disclaimer in the
16  *   documentation and/or other materials provided with the distribution.
17  * * Neither the name of Sony Pictures Imageworks nor the names of its
18  *   contributors may be used to endorse or promote products derived from
19  *   this software without specific prior written permission.
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #ifndef __KERNEL_PROJECTION_CL__
34 #define __KERNEL_PROJECTION_CL__
35
36 CCL_NAMESPACE_BEGIN
37
38 /* Spherical coordinates <-> Cartesian direction  */
39
40 ccl_device float2 direction_to_spherical(float3 dir)
41 {
42         float theta = safe_acosf(dir.z);
43         float phi = atan2f(dir.x, dir.y);
44
45         return make_float2(theta, phi);
46 }
47
48 ccl_device float3 spherical_to_direction(float theta, float phi)
49 {
50         float sin_theta = sinf(theta);
51         return make_float3(sin_theta*cosf(phi),
52                            sin_theta*sinf(phi),
53                            cosf(theta));
54 }
55
56 /* Equirectangular coordinates <-> Cartesian direction */
57
58 ccl_device float2 direction_to_equirectangular_range(float3 dir, float4 range)
59 {
60         float u = (atan2f(dir.y, dir.x) - range.y) / range.x;
61         float v = (acosf(dir.z / len(dir)) - range.w) / range.z;
62
63         return make_float2(u, v);
64 }
65
66 ccl_device float3 equirectangular_range_to_direction(float u, float v, float4 range)
67 {
68         float phi = range.x*u + range.y;
69         float theta = range.z*v + range.w;
70         float sin_theta = sinf(theta);
71         return make_float3(sin_theta*cosf(phi),
72                            sin_theta*sinf(phi),
73                            cosf(theta));
74 }
75
76 ccl_device float2 direction_to_equirectangular(float3 dir)
77 {
78         return direction_to_equirectangular_range(dir, make_float4(-M_2PI_F, M_PI_F, -M_PI_F, M_PI_F));
79 }
80
81 ccl_device float3 equirectangular_to_direction(float u, float v)
82 {
83         return equirectangular_range_to_direction(u, v, make_float4(-M_2PI_F, M_PI_F, -M_PI_F, M_PI_F));
84 }
85
86 /* Fisheye <-> Cartesian direction */
87
88 ccl_device float2 direction_to_fisheye(float3 dir, float fov)
89 {
90         float r = atan2f(sqrtf(dir.y*dir.y +  dir.z*dir.z), dir.x) / fov;
91         float phi = atan2f(dir.z, dir.y);
92
93         float u = r * cosf(phi) + 0.5f;
94         float v = r * sinf(phi) + 0.5f;
95
96         return make_float2(u, v);
97 }
98
99 ccl_device float3 fisheye_to_direction(float u, float v, float fov)
100 {
101         u = (u - 0.5f) * 2.0f;
102         v = (v - 0.5f) * 2.0f;
103
104         float r = sqrtf(u*u + v*v);
105
106         if(r > 1.0f)
107                 return make_float3(0.0f, 0.0f, 0.0f);
108
109         float phi = safe_acosf((r != 0.0f)? u/r: 0.0f);
110         float theta = r * fov * 0.5f;
111
112         if(v < 0.0f) phi = -phi;
113
114         return make_float3(
115                  cosf(theta),
116                  -cosf(phi)*sinf(theta),
117                  sinf(phi)*sinf(theta)
118         );
119 }
120
121 ccl_device float2 direction_to_fisheye_equisolid(float3 dir, float lens, float width, float height)
122 {
123         float theta = safe_acosf(dir.x);
124         float r = 2.0f * lens * sinf(theta * 0.5f);
125         float phi = atan2f(dir.z, dir.y);
126
127         float u = r * cosf(phi) / width + 0.5f;
128         float v = r * sinf(phi) / height + 0.5f;
129
130         return make_float2(u, v);
131 }
132
133 ccl_device float3 fisheye_equisolid_to_direction(float u, float v, float lens, float fov, float width, float height)
134 {
135         u = (u - 0.5f) * width;
136         v = (v - 0.5f) * height;
137
138         float rmax = 2.0f * lens * sinf(fov * 0.25f);
139         float r = sqrtf(u*u + v*v);
140
141         if(r > rmax)
142                 return make_float3(0.0f, 0.0f, 0.0f);
143
144         float phi = safe_acosf((r != 0.0f)? u/r: 0.0f);
145         float theta = 2.0f * asinf(r/(2.0f * lens));
146
147         if(v < 0.0f) phi = -phi;
148
149         return make_float3(
150                  cosf(theta),
151                  -cosf(phi)*sinf(theta),
152                  sinf(phi)*sinf(theta)
153         );
154 }
155
156 /* Mirror Ball <-> Cartesion direction */
157
158 ccl_device float3 mirrorball_to_direction(float u, float v)
159 {
160         /* point on sphere */
161         float3 dir;
162
163         dir.x = 2.0f*u - 1.0f;
164         dir.z = 2.0f*v - 1.0f;
165
166         if(dir.x*dir.x + dir.z*dir.z > 1.0f)
167                 return make_float3(0.0f, 0.0f, 0.0f);
168
169         dir.y = -sqrtf(max(1.0f - dir.x*dir.x - dir.z*dir.z, 0.0f));
170
171         /* reflection */
172         float3 I = make_float3(0.0f, -1.0f, 0.0f);
173
174         return 2.0f*dot(dir, I)*dir - I;
175 }
176
177 ccl_device float2 direction_to_mirrorball(float3 dir)
178 {
179         /* inverse of mirrorball_to_direction */
180         dir.y -= 1.0f;
181
182         float div = 2.0f*sqrtf(max(-0.5f*dir.y, 0.0f));
183         if(div > 0.0f)
184                 dir /= div;
185
186         float u = 0.5f*(dir.x + 1.0f);
187         float v = 0.5f*(dir.z + 1.0f);
188
189         return make_float2(u, v);
190 }
191
192 ccl_device float3 panorama_to_direction(KernelGlobals *kg, float u, float v)
193 {
194         switch(kernel_data.cam.panorama_type) {
195                 case PANORAMA_EQUIRECTANGULAR:
196                         return equirectangular_range_to_direction(u, v, kernel_data.cam.equirectangular_range);
197                 case PANORAMA_MIRRORBALL:
198                         return mirrorball_to_direction(u, v);
199                 case PANORAMA_FISHEYE_EQUIDISTANT:
200                         return fisheye_to_direction(u, v, kernel_data.cam.fisheye_fov);
201                 case PANORAMA_FISHEYE_EQUISOLID:
202                 default:
203                         return fisheye_equisolid_to_direction(u, v, kernel_data.cam.fisheye_lens,
204                                 kernel_data.cam.fisheye_fov, kernel_data.cam.sensorwidth, kernel_data.cam.sensorheight);
205         }
206 }
207
208 ccl_device float2 direction_to_panorama(KernelGlobals *kg, float3 dir)
209 {
210         switch(kernel_data.cam.panorama_type) {
211                 case PANORAMA_EQUIRECTANGULAR:
212                         return direction_to_equirectangular_range(dir, kernel_data.cam.equirectangular_range);
213                 case PANORAMA_MIRRORBALL:
214                         return direction_to_mirrorball(dir);
215                 case PANORAMA_FISHEYE_EQUIDISTANT:
216                         return direction_to_fisheye(dir, kernel_data.cam.fisheye_fov);
217                 case PANORAMA_FISHEYE_EQUISOLID:
218                 default:
219                         return direction_to_fisheye_equisolid(dir, kernel_data.cam.fisheye_lens,
220                                 kernel_data.cam.sensorwidth, kernel_data.cam.sensorheight);
221         }
222 }
223
224 ccl_device float3 spherical_stereo_position(KernelGlobals *kg,
225                                             float3 dir,
226                                             float3 pos)
227 {
228         float interocular_offset = kernel_data.cam.interocular_offset;
229
230         /* Interocular offset of zero means either non stereo, or stereo without
231          * spherical stereo.
232          */
233         if(interocular_offset == 0.0f) {
234                 return pos;
235         }
236
237         if(kernel_data.cam.pole_merge_angle_to > 0.0f) {
238                 float3 normalized_direction = normalize(dir);
239                 const float pole_merge_angle_from = kernel_data.cam.pole_merge_angle_from,
240                             pole_merge_angle_to = kernel_data.cam.pole_merge_angle_to;
241                 float altitude = fabsf(safe_asinf(normalized_direction.z));
242                 if(altitude > pole_merge_angle_to) {
243                         interocular_offset = 0.0f;
244                 }
245                 else if(altitude > pole_merge_angle_from) {
246                         float fac = (altitude - pole_merge_angle_from) / (pole_merge_angle_to - pole_merge_angle_from);
247                         float fade = cosf(fac * M_PI_2_F);
248                         interocular_offset *= fade;
249                 }
250         }
251
252         float3 up = make_float3(0.0f, 0.0f, 1.0f);
253         float3 side = normalize(cross(dir, up));
254
255         return pos + (side * interocular_offset);
256 }
257
258 /* NOTE: Ensures direction is normalized. */
259 ccl_device float3 spherical_stereo_direction(KernelGlobals *kg,
260                                              float3 dir,
261                                              float3 pos,
262                                              float3 newpos)
263 {
264         const float convergence_distance = kernel_data.cam.convergence_distance;
265         const float3 normalized_dir = normalize(dir);
266         /* Interocular offset of zero means either no stereo, or stereo without
267          * spherical stereo.
268          * Convergence distance is FLT_MAX in the case of parallel convergence mode,
269          * no need to mdify direction in this case either.
270          */
271         if(kernel_data.cam.interocular_offset == 0.0f ||
272            convergence_distance == FLT_MAX)
273         {
274                 return normalized_dir;
275         }
276
277         float3 screenpos = pos + (normalized_dir * convergence_distance);
278         return normalize(screenpos - newpos);
279 }
280
281 CCL_NAMESPACE_END
282
283 #endif  /* __KERNEL_PROJECTION_CL__ */