svn merge: Merging r46558 through r46612, from trunk
[blender.git] / intern / cycles / kernel / kernel_types.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 #ifndef __KERNEL_TYPES_H__
20 #define __KERNEL_TYPES_H__
21
22 #include "kernel_math.h"
23 #include "svm/svm_types.h"
24
25 #ifndef __KERNEL_GPU__
26 #define __KERNEL_CPU__
27 #endif
28
29 CCL_NAMESPACE_BEGIN
30
31 /* constants */
32 #define OBJECT_SIZE             16
33 #define LIGHT_SIZE                      4
34 #define FILTER_TABLE_SIZE       256
35 #define RAMP_TABLE_SIZE         256
36 #define TIME_INVALID            FLT_MAX
37
38 /* device capabilities */
39 #ifdef __KERNEL_CPU__
40 #define __KERNEL_SHADING__
41 #define __KERNEL_ADV_SHADING__
42 #endif
43
44 #ifdef __KERNEL_CUDA__
45 #define __KERNEL_SHADING__
46 #if __CUDA_ARCH__ >= 200
47 #define __KERNEL_ADV_SHADING__
48 #endif
49 #endif
50
51 #ifdef __KERNEL_OPENCL__
52
53 #ifdef __KERNEL_OPENCL_NVIDIA__
54 #define __KERNEL_SHADING__
55 #define __MULTI_CLOSURE__
56 #endif
57
58 #ifdef __KERNEL_OPENCL_APPLE__
59 //#define __SVM__
60 //#define __EMISSION__
61 //#define __IMAGE_TEXTURES__
62 //#define __HOLDOUT__
63 //#define __PROCEDURAL_TEXTURES__
64 //#define __EXTRA_NODES__
65 #endif
66
67 #ifdef __KERNEL_OPENCL_AMD__
68 #define __SVM__
69 #define __EMISSION__
70 #define __IMAGE_TEXTURES__
71 #define __HOLDOUT__
72 #define __PROCEDURAL_TEXTURES__
73 #define __EXTRA_NODES__
74 #endif
75
76 #endif
77
78 /* kernel features */
79 #define __SOBOL__
80 #define __INSTANCING__
81 #define __DPDU__
82 #define __UV__
83 #define __BACKGROUND__
84 #define __CAUSTICS_TRICKS__
85 #define __VISIBILITY_FLAG__
86 #define __RAY_DIFFERENTIALS__
87 #define __CAMERA_CLIPPING__
88 #define __INTERSECTION_REFINE__
89 #define __CLAMP_SAMPLE__
90
91 #ifdef __KERNEL_SHADING__
92 #define __SVM__
93 #define __EMISSION__
94 #define __PROCEDURAL_TEXTURES__
95 #define __IMAGE_TEXTURES__
96 #define __EXTRA_NODES__
97 #define __HOLDOUT__
98 #endif
99
100 #ifdef __KERNEL_ADV_SHADING__
101 #define __MULTI_CLOSURE__
102 #define __TRANSPARENT_SHADOWS__
103 #define __PASSES__
104 #define __BACKGROUND_MIS__
105 #define __AO__
106 //#define __MOTION__
107 #endif
108
109 //#define __MULTI_LIGHT__
110 //#define __OSL__
111 //#define __SOBOL_FULL_SCREEN__
112 //#define __QBVH__
113
114 /* Shader Evaluation */
115
116 enum ShaderEvalType {
117         SHADER_EVAL_DISPLACE,
118         SHADER_EVAL_BACKGROUND
119 };
120
121 /* Path Tracing
122  * note we need to keep the u/v pairs at even values */
123
124 enum PathTraceDimension {
125         PRNG_FILTER_U = 0,
126         PRNG_FILTER_V = 1,
127         PRNG_LENS_U = 2,
128         PRNG_LENS_V = 3,
129 #ifdef __MOTION__
130         PRNG_TIME = 4,
131         PRNG_UNUSED = 5,
132         PRNG_BASE_NUM = 6,
133 #else
134         PRNG_BASE_NUM = 4,
135 #endif
136
137         PRNG_BSDF_U = 0,
138         PRNG_BSDF_V = 1,
139         PRNG_BSDF = 2,
140         PRNG_LIGHT = 3,
141         PRNG_LIGHT_U = 4,
142         PRNG_LIGHT_V = 5,
143         PRNG_LIGHT_F = 6,
144         PRNG_TERMINATE = 7,
145         PRNG_BOUNCE_NUM = 8
146 };
147
148 /* these flag values correspond exactly to OSL defaults, so be careful not to
149  * change this, or if you do, set the "raytypes" shading system attribute with
150  * your own new ray types and bitflag values.
151  *
152  * for ray visibility tests in BVH traversal, the upper 20 bits are used for
153  * layer visibility tests. */
154
155 enum PathRayFlag {
156         PATH_RAY_CAMERA = 1,
157         PATH_RAY_REFLECT = 2,
158         PATH_RAY_TRANSMIT = 4,
159         PATH_RAY_DIFFUSE = 8,
160         PATH_RAY_GLOSSY = 16,
161         PATH_RAY_SINGULAR = 32,
162         PATH_RAY_TRANSPARENT = 64,
163
164         PATH_RAY_SHADOW_OPAQUE = 128,
165         PATH_RAY_SHADOW_TRANSPARENT = 256,
166         PATH_RAY_SHADOW = (PATH_RAY_SHADOW_OPAQUE|PATH_RAY_SHADOW_TRANSPARENT),
167
168         PATH_RAY_MIS_SKIP = 512,
169
170         PATH_RAY_ALL = (1|2|4|8|16|32|64|128|256|512),
171
172         PATH_RAY_LAYER_SHIFT = (32-20)
173 };
174
175 /* Closure Label */
176
177 typedef enum ClosureLabel {
178         LABEL_NONE = 0,
179         LABEL_CAMERA = 1,
180         LABEL_LIGHT = 2,
181         LABEL_BACKGROUND = 4,
182         LABEL_TRANSMIT = 8,
183         LABEL_REFLECT = 16,
184         LABEL_VOLUME = 32,
185         LABEL_OBJECT = 64,
186         LABEL_DIFFUSE = 128,
187         LABEL_GLOSSY = 256,
188         LABEL_SINGULAR = 512,
189         LABEL_TRANSPARENT = 1024,
190         LABEL_STOP = 2048
191 } ClosureLabel;
192
193 /* Render Passes */
194
195 typedef enum PassType {
196         PASS_NONE = 0,
197         PASS_COMBINED = 1,
198         PASS_DEPTH = 2,
199         PASS_NORMAL = 4,
200         PASS_UV = 8,
201         PASS_OBJECT_ID = 16,
202         PASS_MATERIAL_ID = 32,
203         PASS_DIFFUSE_COLOR = 64,
204         PASS_GLOSSY_COLOR = 128,
205         PASS_TRANSMISSION_COLOR = 256,
206         PASS_DIFFUSE_INDIRECT = 512,
207         PASS_GLOSSY_INDIRECT = 1024,
208         PASS_TRANSMISSION_INDIRECT = 2048,
209         PASS_DIFFUSE_DIRECT = 4096,
210         PASS_GLOSSY_DIRECT = 8192,
211         PASS_TRANSMISSION_DIRECT = 16384,
212         PASS_EMISSION = 32768,
213         PASS_BACKGROUND = 65536,
214         PASS_AO = 131072,
215         PASS_SHADOW = 262144,
216         PASS_MOTION = 524288,
217         PASS_MOTION_WEIGHT = 1048576
218 } PassType;
219
220 #define PASS_ALL (~0)
221
222 #ifdef __PASSES__
223
224 typedef float3 PathThroughput;
225
226 typedef struct PathRadiance {
227         int use_light_pass;
228
229         float3 emission;
230         float3 background;
231         float3 ao;
232
233         float3 indirect;
234         float3 direct_throughput;
235         float3 direct_emission;
236
237         float3 color_diffuse;
238         float3 color_glossy;
239         float3 color_transmission;
240
241         float3 direct_diffuse;
242         float3 direct_glossy;
243         float3 direct_transmission;
244
245         float3 indirect_diffuse;
246         float3 indirect_glossy;
247         float3 indirect_transmission;
248
249         float4 shadow;
250 } PathRadiance;
251
252 typedef struct BsdfEval {
253         int use_light_pass;
254
255         float3 diffuse;
256         float3 glossy;
257         float3 transmission;
258         float3 transparent;
259 } BsdfEval;
260
261 #else
262
263 typedef float3 PathThroughput;
264 typedef float3 PathRadiance;
265 typedef float3 BsdfEval;
266
267 #endif
268
269 /* Shader Flag */
270
271 typedef enum ShaderFlag {
272         SHADER_SMOOTH_NORMAL = (1 << 31),
273         SHADER_CAST_SHADOW = (1 << 30),
274         SHADER_AREA_LIGHT = (1 << 29),
275
276         SHADER_MASK = ~(SHADER_SMOOTH_NORMAL|SHADER_CAST_SHADOW|SHADER_AREA_LIGHT)
277 } ShaderFlag;
278
279 /* Light Type */
280
281 typedef enum LightType {
282         LIGHT_POINT,
283         LIGHT_DISTANT,
284         LIGHT_BACKGROUND,
285         LIGHT_AREA,
286         LIGHT_AO
287 } LightType;
288
289 /* Camera Type */
290
291 enum CameraType {
292         CAMERA_PERSPECTIVE,
293         CAMERA_ORTHOGRAPHIC,
294         CAMERA_PANORAMA
295 };
296
297 /* Panorama Type */
298
299 enum PanoramaType {
300         PANORAMA_EQUIRECTANGULAR,
301         PANORAMA_FISHEYE_EQUIDISTANT,
302         PANORAMA_FISHEYE_EQUISOLID
303 };
304
305 /* Differential */
306
307 typedef struct differential3 {
308         float3 dx;
309         float3 dy;
310 } differential3;
311
312 typedef struct differential {
313         float dx;
314         float dy;
315 } differential;
316
317 /* Ray */
318
319 typedef struct Ray {
320         float3 P;
321         float3 D;
322         float t;
323         float time;
324
325 #ifdef __RAY_DIFFERENTIALS__
326         differential3 dP;
327         differential3 dD;
328 #endif
329 } Ray;
330
331 /* Intersection */
332
333 typedef struct Intersection {
334         float t, u, v;
335         int prim;
336         int object;
337 } Intersection;
338
339 /* Attributes */
340
341 typedef enum AttributeElement {
342         ATTR_ELEMENT_FACE,
343         ATTR_ELEMENT_VERTEX,
344         ATTR_ELEMENT_CORNER,
345         ATTR_ELEMENT_VALUE,
346         ATTR_ELEMENT_NONE
347 } AttributeElement;
348
349 typedef enum AttributeStandard {
350         ATTR_STD_NONE = 0,
351         ATTR_STD_VERTEX_NORMAL,
352         ATTR_STD_FACE_NORMAL,
353         ATTR_STD_UV,
354         ATTR_STD_GENERATED,
355         ATTR_STD_POSITION_UNDEFORMED,
356         ATTR_STD_POSITION_UNDISPLACED,
357         ATTR_STD_MOTION_PRE,
358         ATTR_STD_MOTION_POST,
359         ATTR_STD_NUM,
360
361         ATTR_STD_NOT_FOUND = ~0
362 } AttributeStandard;
363
364 /* Closure data */
365
366 #define MAX_CLOSURE 8
367
368 typedef struct ShaderClosure {
369         ClosureType type;
370         float3 weight;
371
372 #ifdef __MULTI_CLOSURE__
373         float sample_weight;
374 #endif
375
376 #ifdef __OSL__
377         void *prim;
378 #else
379         float data0;
380         float data1;
381 #endif
382
383 } ShaderClosure;
384
385 /* Shader Data
386  *
387  * Main shader state at a point on the surface or in a volume. All coordinates
388  * are in world space. */
389
390 enum ShaderDataFlag {
391         /* runtime flags */
392         SD_BACKFACING = 1,              /* backside of surface? */
393         SD_EMISSION = 2,                /* have emissive closure? */
394         SD_BSDF = 4,                    /* have bsdf closure? */
395         SD_BSDF_HAS_EVAL = 8,   /* have non-singular bsdf closure? */
396         SD_BSDF_GLOSSY = 16,    /* have glossy bsdf */
397         SD_HOLDOUT = 32,                /* have holdout closure? */
398         SD_VOLUME = 64,                 /* have volume closure? */
399
400         /* shader flags */
401         SD_SAMPLE_AS_LIGHT = 128,                       /* direct light sample */
402         SD_HAS_SURFACE_TRANSPARENT = 256,       /* has surface transparency */
403         SD_HAS_VOLUME = 512,                            /* has volume shader */
404         SD_HOMOGENEOUS_VOLUME = 1024,           /* has homogeneous volume */
405
406         /* object flags */
407         SD_HOLDOUT_MASK = 2048,                         /* holdout for camera rays */
408         SD_OBJECT_MOTION = 4096                         /* has object motion blur */
409 };
410
411 typedef struct ShaderData {
412         /* position */
413         float3 P;
414         /* smooth normal for shading */
415         float3 N;
416         /* true geometric normal */
417         float3 Ng;
418         /* view/incoming direction */
419         float3 I;
420         /* shader id */
421         int shader;     
422         /* booleans describing shader, see ShaderDataFlag */
423         int flag;
424
425         /* primitive id if there is one, ~0 otherwise */
426         int prim;
427         /* parametric coordinates
428          * - barycentric weights for triangles */
429         float u, v;
430         /* object id if there is one, ~0 otherwise */
431         int object;
432
433         /* motion blur sample time */
434         float time;
435         
436         /* length of the ray being shaded */
437         float ray_length;
438
439 #ifdef __MOTION__
440         /* object <-> world space transformations, cached to avoid
441          * re-interpolating them constantly for shading */
442         Transform ob_tfm;
443         Transform ob_itfm;
444 #endif
445
446 #ifdef __RAY_DIFFERENTIALS__
447         /* differential of P. these are orthogonal to Ng, not N */
448         differential3 dP;
449         /* differential of I */
450         differential3 dI;
451         /* differential of u, v */
452         differential du;
453         differential dv;
454 #endif
455 #ifdef __DPDU__
456         /* differential of P w.r.t. parametric coordinates. note that dPdu is
457          * not readily suitable as a tangent for shading on triangles. */
458         float3 dPdu, dPdv;
459 #endif
460
461 #ifdef __MULTI_CLOSURE__
462         /* Closure data, we store a fixed array of closures */
463         ShaderClosure closure[MAX_CLOSURE];
464         int num_closure;
465         float randb_closure;
466 #else
467         /* Closure data, with a single sampled closure for low memory usage */
468         ShaderClosure closure;
469 #endif
470
471 #ifdef __OSL__
472         /* OSL context */
473         void *osl_ctx;
474 #endif
475 } ShaderData;
476
477 /* Constrant Kernel Data
478  *
479  * These structs are passed from CPU to various devices, and the struct layout
480  * must match exactly. Structs are padded to ensure 16 byte alignment, and we
481  * do not use float3 because its size may not be the same on all devices. */
482
483 typedef struct KernelCamera {
484         /* type */
485         int type;
486
487         /* panorama */
488         int panorama_type;
489         float fisheye_fov;
490         float fisheye_lens;
491
492         /* matrices */
493         Transform cameratoworld;
494         Transform rastertocamera;
495
496         /* differentials */
497         float4 dx;
498         float4 dy;
499
500         /* depth of field */
501         float aperturesize;
502         float blades;
503         float bladesrotation;
504         float focaldistance;
505
506         /* motion blur */
507         float shuttertime;
508         int have_motion;
509
510         /* clipping */
511         float nearclip;
512         float cliplength;
513
514         /* sensor size */
515         float sensorwidth;
516         float sensorheight;
517
518         /* render size */
519         float width, height;
520
521         /* more matrices */
522         Transform screentoworld;
523         Transform rastertoworld;
524         Transform ndctoworld;
525         Transform worldtoscreen;
526         Transform worldtoraster;
527         Transform worldtondc;
528         Transform worldtocamera;
529
530         MotionTransform motion;
531 } KernelCamera;
532
533 typedef struct KernelFilm {
534         float exposure;
535         int pass_flag;
536         int pass_stride;
537         int use_light_pass;
538
539         int pass_combined;
540         int pass_depth;
541         int pass_normal;
542         int pass_motion;
543
544         int pass_motion_weight;
545         int pass_uv;
546         int pass_object_id;
547         int pass_material_id;
548
549         int pass_diffuse_color;
550         int pass_glossy_color;
551         int pass_transmission_color;
552         int pass_diffuse_indirect;
553
554         int pass_glossy_indirect;
555         int pass_transmission_indirect;
556         int pass_diffuse_direct;
557         int pass_glossy_direct;
558
559         int pass_transmission_direct;
560         int pass_emission;
561         int pass_background;
562         int pass_ao;
563
564         int pass_shadow;
565         int pass_pad1;
566         int pass_pad2;
567         int pass_pad3;
568 } KernelFilm;
569
570 typedef struct KernelBackground {
571         /* only shader index */
572         int shader;
573         int transparent;
574
575         /* ambient occlusion */
576         float ao_factor;
577         float ao_distance;
578 } KernelBackground;
579
580 typedef struct KernelSunSky {
581         /* sun direction in spherical and cartesian */
582         float theta, phi, pad3, pad4;
583
584         /* perez function parameters */
585         float zenith_Y, zenith_x, zenith_y, pad2;
586         float perez_Y[5], perez_x[5], perez_y[5];
587         float pad5;
588 } KernelSunSky;
589
590 typedef struct KernelIntegrator {
591         /* emission */
592         int use_direct_light;
593         int use_ambient_occlusion;
594         int num_distribution;
595         int num_all_lights;
596         float pdf_triangles;
597         float pdf_lights;
598         int pdf_background_res;
599
600         /* bounces */
601         int min_bounce;
602         int max_bounce;
603
604         int max_diffuse_bounce;
605         int max_glossy_bounce;
606         int max_transmission_bounce;
607
608         /* transparent */
609         int transparent_min_bounce;
610         int transparent_max_bounce;
611         int transparent_shadows;
612
613         /* caustics */
614         int no_caustics;
615         float filter_glossy;
616
617         /* seed */
618         int seed;
619
620         /* render layer */
621         int layer_flag;
622
623         /* clamp */
624         float sample_clamp;
625 } KernelIntegrator;
626
627 typedef struct KernelBVH {
628         /* root node */
629         int root;
630         int attributes_map_stride;
631         int pad1, pad2;
632 } KernelBVH;
633
634 typedef struct KernelData {
635         KernelCamera cam;
636         KernelFilm film;
637         KernelBackground background;
638         KernelSunSky sunsky;
639         KernelIntegrator integrator;
640         KernelBVH bvh;
641 } KernelData;
642
643 CCL_NAMESPACE_END
644
645 #endif /*  __KERNEL_TYPES_H__ */
646