Cleanup: remove Cycles layer bits checking in the kernel.
[blender.git] / intern / cycles / kernel / kernel_types.h
1 /*
2  * Copyright 2011-2013 Blender Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __KERNEL_TYPES_H__
18 #define __KERNEL_TYPES_H__
19
20 #include "kernel_math.h"
21 #include "svm/svm_types.h"
22
23 #ifndef __KERNEL_GPU__
24 #  define __KERNEL_CPU__
25 #endif
26
27 /* TODO(sergey): This is only to make it possible to include this header
28  * from outside of the kernel. but this could be done somewhat cleaner?
29  */
30 #ifndef ccl_addr_space
31 #  define ccl_addr_space
32 #endif
33
34 CCL_NAMESPACE_BEGIN
35
36 /* constants */
37 #define OBJECT_SIZE             11
38 #define OBJECT_VECTOR_SIZE      6
39 #define LIGHT_SIZE                      5
40 #define FILTER_TABLE_SIZE       1024
41 #define RAMP_TABLE_SIZE         256
42 #define SHUTTER_TABLE_SIZE              256
43 #define PARTICLE_SIZE           5
44 #define TIME_INVALID            FLT_MAX
45
46 #define BSSRDF_MIN_RADIUS                       1e-8f
47 #define BSSRDF_MAX_HITS                         4
48
49 #define BECKMANN_TABLE_SIZE             256
50
51 #define SHADER_NONE                             (~0)
52 #define OBJECT_NONE                             (~0)
53 #define PRIM_NONE                               (~0)
54 #define LAMP_NONE                               (~0)
55
56 #define VOLUME_STACK_SIZE               16
57
58 /* device capabilities */
59 #ifdef __KERNEL_CPU__
60 #  ifdef __KERNEL_SSE2__
61 #    define __QBVH__
62 #  endif
63 #  define __KERNEL_SHADING__
64 #  define __KERNEL_ADV_SHADING__
65 #  define __BRANCHED_PATH__
66 #  ifdef WITH_OSL
67 #    define __OSL__
68 #  endif
69 #  define __SUBSURFACE__
70 #  define __CMJ__
71 #  define __VOLUME__
72 #  define __VOLUME_DECOUPLED__
73 #  define __VOLUME_SCATTER__
74 #  define __SHADOW_RECORD_ALL__
75 #  define __VOLUME_RECORD_ALL__
76 #endif  /* __KERNEL_CPU__ */
77
78 #ifdef __KERNEL_CUDA__
79 #  define __KERNEL_SHADING__
80 #  define __KERNEL_ADV_SHADING__
81 #  define __BRANCHED_PATH__
82 #  define __VOLUME__
83 #  define __VOLUME_SCATTER__
84 #  define __SUBSURFACE__
85 #  define __CMJ__
86 #endif  /* __KERNEL_CUDA__ */
87
88 #ifdef __KERNEL_OPENCL__
89
90 /* keep __KERNEL_ADV_SHADING__ in sync with opencl_kernel_use_advanced_shading! */
91
92 #  ifdef __KERNEL_OPENCL_NVIDIA__
93 #    define __KERNEL_SHADING__
94 #    define __KERNEL_ADV_SHADING__
95 #    ifdef __KERNEL_EXPERIMENTAL__
96 #      define __CMJ__
97 #    endif
98 #  endif  /* __KERNEL_OPENCL_NVIDIA__ */
99
100 #  ifdef __KERNEL_OPENCL_APPLE__
101 #    define __KERNEL_SHADING__
102 #    define __KERNEL_ADV_SHADING__
103 /* TODO(sergey): Currently experimental section is ignored here,
104  * this is because megakernel in device_opencl does not support
105  * custom cflags depending on the scene features.
106  */
107 #    ifdef __KERNEL_EXPERIMENTAL__
108 #      define __CMJ__
109 #    endif
110 #  endif  /* __KERNEL_OPENCL_NVIDIA__ */
111
112 #  ifdef __KERNEL_OPENCL_AMD__
113 #    define __CL_USE_NATIVE__
114 #    define __KERNEL_SHADING__
115 #    define __MULTI_CLOSURE__
116 #    define __PASSES__
117 #    define __BACKGROUND_MIS__
118 #    define __LAMP_MIS__
119 #    define __AO__
120 #    define __CAMERA_MOTION__
121 #    define __OBJECT_MOTION__
122 #    define __HAIR__
123 #    define __BAKING__
124 #    ifdef __KERNEL_EXPERIMENTAL__
125 #      define __TRANSPARENT_SHADOWS__
126 #    endif
127 #  endif  /* __KERNEL_OPENCL_AMD__ */
128
129 #  ifdef __KERNEL_OPENCL_INTEL_CPU__
130 #    define __CL_USE_NATIVE__
131 #    define __KERNEL_SHADING__
132 #    define __KERNEL_ADV_SHADING__
133 #    ifdef __KERNEL_EXPERIMENTAL__
134 #      define __CMJ__
135 #    endif
136 #  endif  /* __KERNEL_OPENCL_INTEL_CPU__ */
137
138 #endif  /* __KERNEL_OPENCL__ */
139
140 /* kernel features */
141 #define __SOBOL__
142 #define __INSTANCING__
143 #define __DPDU__
144 #define __UV__
145 #define __BACKGROUND__
146 #define __CAUSTICS_TRICKS__
147 #define __VISIBILITY_FLAG__
148 #define __RAY_DIFFERENTIALS__
149 #define __CAMERA_CLIPPING__
150 #define __INTERSECTION_REFINE__
151 #define __CLAMP_SAMPLE__
152
153 #ifdef __KERNEL_SHADING__
154 #  define __SVM__
155 #  define __EMISSION__
156 #  define __TEXTURES__
157 #  define __EXTRA_NODES__
158 #  define __HOLDOUT__
159 #endif
160
161 #ifdef __KERNEL_ADV_SHADING__
162 #  define __MULTI_CLOSURE__
163 #  define __TRANSPARENT_SHADOWS__
164 #  define __PASSES__
165 #  define __BACKGROUND_MIS__
166 #  define __LAMP_MIS__
167 #  define __AO__
168 #  define __CAMERA_MOTION__
169 #  define __OBJECT_MOTION__
170 #  define __HAIR__
171 #  define __BAKING__
172 #endif
173
174 #ifdef WITH_CYCLES_DEBUG
175 #  define __KERNEL_DEBUG__
176 #endif
177
178 /* Scene-based selective features compilation. */
179 #ifdef __NO_CAMERA_MOTION__
180 #  undef __CAMERA_MOTION__
181 #endif
182 #ifdef __NO_OBJECT_MOTION__
183 #  undef __OBJECT_MOTION__
184 #endif
185 #ifdef __NO_HAIR__
186 #  undef __HAIR__
187 #endif
188 #ifdef __NO_VOLUME__
189 #  undef __VOLUME__
190 #  undef __VOLUME_SCATTER__
191 #endif
192 #ifdef __NO_SUBSURFACE__
193 #  undef __SUBSURFACE__
194 #endif
195 #ifdef __NO_BAKING__
196 #  undef __BAKING__
197 #endif
198 #ifdef __NO_BRANCHED_PATH__
199 #  undef __BRANCHED_PATH__
200 #endif
201
202 /* Random Numbers */
203
204 typedef uint RNG;
205
206 /* Shader Evaluation */
207
208 typedef enum ShaderEvalType {
209         SHADER_EVAL_DISPLACE,
210         SHADER_EVAL_BACKGROUND,
211         /* bake types */
212         SHADER_EVAL_BAKE, /* no real shade, it's used in the code to
213                            * differentiate the type of shader eval from the above
214                            */
215         /* data passes */
216         SHADER_EVAL_NORMAL,
217         SHADER_EVAL_UV,
218         SHADER_EVAL_DIFFUSE_COLOR,
219         SHADER_EVAL_GLOSSY_COLOR,
220         SHADER_EVAL_TRANSMISSION_COLOR,
221         SHADER_EVAL_SUBSURFACE_COLOR,
222         SHADER_EVAL_EMISSION,
223
224         /* light passes */
225         SHADER_EVAL_AO,
226         SHADER_EVAL_COMBINED,
227         SHADER_EVAL_SHADOW,
228         SHADER_EVAL_DIFFUSE,
229         SHADER_EVAL_GLOSSY,
230         SHADER_EVAL_TRANSMISSION,
231         SHADER_EVAL_SUBSURFACE,
232
233         /* extra */
234         SHADER_EVAL_ENVIRONMENT,
235 } ShaderEvalType;
236
237 /* Path Tracing
238  * note we need to keep the u/v pairs at even values */
239
240 enum PathTraceDimension {
241         PRNG_FILTER_U = 0,
242         PRNG_FILTER_V = 1,
243         PRNG_LENS_U = 2,
244         PRNG_LENS_V = 3,
245 #ifdef __CAMERA_MOTION__
246         PRNG_TIME = 4,
247         PRNG_UNUSED_0 = 5,
248         PRNG_UNUSED_1 = 6,      /* for some reason (6, 7) is a bad sobol pattern */
249         PRNG_UNUSED_2 = 7,  /* with a low number of samples (< 64) */
250 #endif
251         PRNG_BASE_NUM = 8,
252
253         PRNG_BSDF_U = 0,
254         PRNG_BSDF_V = 1,
255         PRNG_BSDF = 2,
256         PRNG_LIGHT = 3,
257         PRNG_LIGHT_U = 4,
258         PRNG_LIGHT_V = 5,
259         PRNG_UNUSED_3 = 6,
260         PRNG_TERMINATE = 7,
261
262 #ifdef __VOLUME__
263         PRNG_PHASE_U = 8,
264         PRNG_PHASE_V = 9,
265         PRNG_PHASE = 10,
266         PRNG_SCATTER_DISTANCE = 11,
267 #endif
268
269         PRNG_BOUNCE_NUM = 12,
270 };
271
272 enum SamplingPattern {
273         SAMPLING_PATTERN_SOBOL = 0,
274         SAMPLING_PATTERN_CMJ = 1,
275
276         SAMPLING_NUM_PATTERNS,
277 };
278
279 /* these flags values correspond to raytypes in osl.cpp, so keep them in sync! */
280
281 enum PathRayFlag {
282         PATH_RAY_CAMERA = 1,
283         PATH_RAY_REFLECT = 2,
284         PATH_RAY_TRANSMIT = 4,
285         PATH_RAY_DIFFUSE = 8,
286         PATH_RAY_GLOSSY = 16,
287         PATH_RAY_SINGULAR = 32,
288         PATH_RAY_TRANSPARENT = 64,
289
290         PATH_RAY_SHADOW_OPAQUE = 128,
291         PATH_RAY_SHADOW_TRANSPARENT = 256,
292         PATH_RAY_SHADOW = (PATH_RAY_SHADOW_OPAQUE|PATH_RAY_SHADOW_TRANSPARENT),
293
294         PATH_RAY_CURVE = 512, /* visibility flag to define curve segments */
295         PATH_RAY_VOLUME_SCATTER = 1024, /* volume scattering */
296
297         /* note that these can use maximum 12 bits, the other are for layers */
298         PATH_RAY_ALL_VISIBILITY = (1|2|4|8|16|32|64|128|256|512|1024),
299
300         PATH_RAY_MIS_SKIP = 2048,
301         PATH_RAY_DIFFUSE_ANCESTOR = 4096,
302         PATH_RAY_SINGLE_PASS_DONE = 8192,
303 };
304
305 /* Closure Label */
306
307 typedef enum ClosureLabel {
308         LABEL_NONE = 0,
309         LABEL_TRANSMIT = 1,
310         LABEL_REFLECT = 2,
311         LABEL_DIFFUSE = 4,
312         LABEL_GLOSSY = 8,
313         LABEL_SINGULAR = 16,
314         LABEL_TRANSPARENT = 32,
315         LABEL_VOLUME_SCATTER = 64,
316 } ClosureLabel;
317
318 /* Render Passes */
319
320 typedef enum PassType {
321         PASS_NONE = 0,
322         PASS_COMBINED = (1 << 0),
323         PASS_DEPTH = (1 << 1),
324         PASS_NORMAL = (1 << 2),
325         PASS_UV = (1 << 3),
326         PASS_OBJECT_ID = (1 << 4),
327         PASS_MATERIAL_ID = (1 << 5),
328         PASS_DIFFUSE_COLOR = (1 << 6),
329         PASS_GLOSSY_COLOR = (1 << 7),
330         PASS_TRANSMISSION_COLOR = (1 << 8),
331         PASS_DIFFUSE_INDIRECT = (1 << 9),
332         PASS_GLOSSY_INDIRECT = (1 << 10),
333         PASS_TRANSMISSION_INDIRECT = (1 << 11),
334         PASS_DIFFUSE_DIRECT = (1 << 12),
335         PASS_GLOSSY_DIRECT = (1 << 13),
336         PASS_TRANSMISSION_DIRECT = (1 << 14),
337         PASS_EMISSION = (1 << 15),
338         PASS_BACKGROUND = (1 << 16),
339         PASS_AO = (1 << 17),
340         PASS_SHADOW = (1 << 18),
341         PASS_MOTION = (1 << 19),
342         PASS_MOTION_WEIGHT = (1 << 20),
343         PASS_MIST = (1 << 21),
344         PASS_SUBSURFACE_DIRECT = (1 << 22),
345         PASS_SUBSURFACE_INDIRECT = (1 << 23),
346         PASS_SUBSURFACE_COLOR = (1 << 24),
347         PASS_LIGHT = (1 << 25), /* no real pass, used to force use_light_pass */
348 #ifdef __KERNEL_DEBUG__
349         PASS_BVH_TRAVERSAL_STEPS = (1 << 26),
350         PASS_BVH_TRAVERSED_INSTANCES = (1 << 27),
351         PASS_RAY_BOUNCES = (1 << 28),
352 #endif
353 } PassType;
354
355 #define PASS_ALL (~0)
356
357 typedef enum BakePassFilter {
358         BAKE_FILTER_NONE = 0,
359         BAKE_FILTER_DIRECT = (1 << 0),
360         BAKE_FILTER_INDIRECT = (1 << 1),
361         BAKE_FILTER_COLOR = (1 << 2),
362         BAKE_FILTER_DIFFUSE = (1 << 3),
363         BAKE_FILTER_GLOSSY = (1 << 4),
364         BAKE_FILTER_TRANSMISSION = (1 << 5),
365         BAKE_FILTER_SUBSURFACE = (1 << 6),
366         BAKE_FILTER_EMISSION = (1 << 7),
367         BAKE_FILTER_AO = (1 << 8),
368 } BakePassFilter;
369
370 typedef enum BakePassFilterCombos {
371         BAKE_FILTER_COMBINED = (
372             BAKE_FILTER_DIRECT |
373             BAKE_FILTER_INDIRECT |
374             BAKE_FILTER_DIFFUSE |
375             BAKE_FILTER_GLOSSY |
376             BAKE_FILTER_TRANSMISSION |
377             BAKE_FILTER_SUBSURFACE |
378             BAKE_FILTER_EMISSION |
379             BAKE_FILTER_AO),
380         BAKE_FILTER_DIFFUSE_DIRECT = (BAKE_FILTER_DIRECT | BAKE_FILTER_DIFFUSE),
381         BAKE_FILTER_GLOSSY_DIRECT = (BAKE_FILTER_DIRECT | BAKE_FILTER_GLOSSY),
382         BAKE_FILTER_TRANSMISSION_DIRECT = (BAKE_FILTER_DIRECT | BAKE_FILTER_TRANSMISSION),
383         BAKE_FILTER_SUBSURFACE_DIRECT = (BAKE_FILTER_DIRECT | BAKE_FILTER_SUBSURFACE),
384         BAKE_FILTER_DIFFUSE_INDIRECT = (BAKE_FILTER_INDIRECT | BAKE_FILTER_DIFFUSE),
385         BAKE_FILTER_GLOSSY_INDIRECT = (BAKE_FILTER_INDIRECT | BAKE_FILTER_GLOSSY),
386         BAKE_FILTER_TRANSMISSION_INDIRECT = (BAKE_FILTER_INDIRECT | BAKE_FILTER_TRANSMISSION),
387         BAKE_FILTER_SUBSURFACE_INDIRECT = (BAKE_FILTER_INDIRECT | BAKE_FILTER_SUBSURFACE),
388 } BakePassFilterCombos;
389
390 #ifdef __PASSES__
391
392 typedef ccl_addr_space struct PathRadiance {
393         int use_light_pass;
394
395         float3 emission;
396         float3 background;
397         float3 ao;
398
399         float3 indirect;
400         float3 direct_throughput;
401         float3 direct_emission;
402
403         float3 color_diffuse;
404         float3 color_glossy;
405         float3 color_transmission;
406         float3 color_subsurface;
407         float3 color_scatter;
408
409         float3 direct_diffuse;
410         float3 direct_glossy;
411         float3 direct_transmission;
412         float3 direct_subsurface;
413         float3 direct_scatter;
414
415         float3 indirect_diffuse;
416         float3 indirect_glossy;
417         float3 indirect_transmission;
418         float3 indirect_subsurface;
419         float3 indirect_scatter;
420
421         float3 path_diffuse;
422         float3 path_glossy;
423         float3 path_transmission;
424         float3 path_subsurface;
425         float3 path_scatter;
426
427         float4 shadow;
428         float mist;
429 } PathRadiance;
430
431 typedef struct BsdfEval {
432         int use_light_pass;
433
434         float3 diffuse;
435         float3 glossy;
436         float3 transmission;
437         float3 transparent;
438         float3 subsurface;
439         float3 scatter;
440 } BsdfEval;
441
442 #else
443
444 typedef ccl_addr_space float3 PathRadiance;
445 typedef float3 BsdfEval;
446
447 #endif
448
449 /* Shader Flag */
450
451 typedef enum ShaderFlag {
452         SHADER_SMOOTH_NORMAL = (1 << 31),
453         SHADER_CAST_SHADOW = (1 << 30),
454         SHADER_AREA_LIGHT = (1 << 29),
455         SHADER_USE_MIS = (1 << 28),
456         SHADER_EXCLUDE_DIFFUSE = (1 << 27),
457         SHADER_EXCLUDE_GLOSSY = (1 << 26),
458         SHADER_EXCLUDE_TRANSMIT = (1 << 25),
459         SHADER_EXCLUDE_CAMERA = (1 << 24),
460         SHADER_EXCLUDE_SCATTER = (1 << 23),
461         SHADER_EXCLUDE_ANY = (SHADER_EXCLUDE_DIFFUSE|SHADER_EXCLUDE_GLOSSY|SHADER_EXCLUDE_TRANSMIT|SHADER_EXCLUDE_CAMERA|SHADER_EXCLUDE_SCATTER),
462
463         SHADER_MASK = ~(SHADER_SMOOTH_NORMAL|SHADER_CAST_SHADOW|SHADER_AREA_LIGHT|SHADER_USE_MIS|SHADER_EXCLUDE_ANY)
464 } ShaderFlag;
465
466 /* Light Type */
467
468 typedef enum LightType {
469         LIGHT_POINT,
470         LIGHT_DISTANT,
471         LIGHT_BACKGROUND,
472         LIGHT_AREA,
473         LIGHT_SPOT,
474         LIGHT_TRIANGLE
475 } LightType;
476
477 /* Camera Type */
478
479 enum CameraType {
480         CAMERA_PERSPECTIVE,
481         CAMERA_ORTHOGRAPHIC,
482         CAMERA_PANORAMA
483 };
484
485 /* Panorama Type */
486
487 enum PanoramaType {
488         PANORAMA_EQUIRECTANGULAR = 0,
489         PANORAMA_FISHEYE_EQUIDISTANT = 1,
490         PANORAMA_FISHEYE_EQUISOLID = 2,
491         PANORAMA_MIRRORBALL = 3,
492
493         PANORAMA_NUM_TYPES,
494 };
495
496 /* Differential */
497
498 typedef struct differential3 {
499         float3 dx;
500         float3 dy;
501 } differential3;
502
503 typedef struct differential {
504         float dx;
505         float dy;
506 } differential;
507
508 /* Ray */
509
510 typedef struct Ray {
511 /* TODO(sergey): This is only needed because current AMD
512  * compiler has hard time building the kernel with this
513  * reshuffle. And at the same time reshuffle will cause
514  * less optimal CPU code in certain places.
515  *
516  * We'll get rid of this nasty exception once AMD compiler
517  * is fixed.
518  */
519 #ifndef __KERNEL_OPENCL_AMD__
520         float3 P;               /* origin */
521         float3 D;               /* direction */
522
523         float t;                /* length of the ray */
524         float time;             /* time (for motion blur) */
525 #else
526         float t;                /* length of the ray */
527         float time;             /* time (for motion blur) */
528         float3 P;               /* origin */
529         float3 D;               /* direction */
530 #endif
531
532 #ifdef __RAY_DIFFERENTIALS__
533         differential3 dP;
534         differential3 dD;
535 #endif
536 } Ray;
537
538 /* Intersection */
539
540 typedef ccl_addr_space struct Intersection {
541         float t, u, v;
542         int prim;
543         int object;
544         int type;
545
546 #ifdef __KERNEL_DEBUG__
547         int num_traversal_steps;
548         int num_traversed_instances;
549 #endif
550 } Intersection;
551
552 /* Primitives */
553
554 typedef enum PrimitiveType {
555         PRIMITIVE_NONE = 0,
556         PRIMITIVE_TRIANGLE = 1,
557         PRIMITIVE_MOTION_TRIANGLE = 2,
558         PRIMITIVE_CURVE = 4,
559         PRIMITIVE_MOTION_CURVE = 8,
560
561         PRIMITIVE_ALL_TRIANGLE = (PRIMITIVE_TRIANGLE|PRIMITIVE_MOTION_TRIANGLE),
562         PRIMITIVE_ALL_CURVE = (PRIMITIVE_CURVE|PRIMITIVE_MOTION_CURVE),
563         PRIMITIVE_ALL_MOTION = (PRIMITIVE_MOTION_TRIANGLE|PRIMITIVE_MOTION_CURVE),
564         PRIMITIVE_ALL = (PRIMITIVE_ALL_TRIANGLE|PRIMITIVE_ALL_CURVE),
565
566         /* Total number of different primitives.
567          * NOTE: This is an actual value, not a bitflag.
568          */
569         PRIMITIVE_NUM_TOTAL = 4,
570 } PrimitiveType;
571
572 #define PRIMITIVE_PACK_SEGMENT(type, segment) ((segment << 16) | type)
573 #define PRIMITIVE_UNPACK_SEGMENT(type) (type >> 16)
574
575 /* Attributes */
576
577 #define ATTR_PRIM_TYPES         2
578 #define ATTR_PRIM_CURVE         1
579
580 typedef enum AttributeElement {
581         ATTR_ELEMENT_NONE,
582         ATTR_ELEMENT_OBJECT,
583         ATTR_ELEMENT_MESH,
584         ATTR_ELEMENT_FACE,
585         ATTR_ELEMENT_VERTEX,
586         ATTR_ELEMENT_VERTEX_MOTION,
587         ATTR_ELEMENT_CORNER,
588         ATTR_ELEMENT_CORNER_BYTE,
589         ATTR_ELEMENT_CURVE,
590         ATTR_ELEMENT_CURVE_KEY,
591         ATTR_ELEMENT_CURVE_KEY_MOTION,
592         ATTR_ELEMENT_VOXEL
593 } AttributeElement;
594
595 typedef enum AttributeStandard {
596         ATTR_STD_NONE = 0,
597         ATTR_STD_VERTEX_NORMAL,
598         ATTR_STD_FACE_NORMAL,
599         ATTR_STD_UV,
600         ATTR_STD_UV_TANGENT,
601         ATTR_STD_UV_TANGENT_SIGN,
602         ATTR_STD_GENERATED,
603         ATTR_STD_GENERATED_TRANSFORM,
604         ATTR_STD_POSITION_UNDEFORMED,
605         ATTR_STD_POSITION_UNDISPLACED,
606         ATTR_STD_MOTION_VERTEX_POSITION,
607         ATTR_STD_MOTION_VERTEX_NORMAL,
608         ATTR_STD_PARTICLE,
609         ATTR_STD_CURVE_INTERCEPT,
610         ATTR_STD_PTEX_FACE_ID,
611         ATTR_STD_PTEX_UV,
612         ATTR_STD_VOLUME_DENSITY,
613         ATTR_STD_VOLUME_COLOR,
614         ATTR_STD_VOLUME_FLAME,
615         ATTR_STD_VOLUME_HEAT,
616         ATTR_STD_VOLUME_VELOCITY,
617         ATTR_STD_POINTINESS,
618         ATTR_STD_NUM,
619
620         ATTR_STD_NOT_FOUND = ~0
621 } AttributeStandard;
622
623 /* Closure data */
624
625 #ifdef __MULTI_CLOSURE__
626 #  ifndef __MAX_CLOSURE__
627 #     define MAX_CLOSURE 64
628 #  else
629 #    define MAX_CLOSURE __MAX_CLOSURE__
630 #  endif
631 #else
632 #  define MAX_CLOSURE 1
633 #endif
634
635 /* This struct is to be 16 bytes aligned, we also keep some extra precautions:
636  * - All the float3 members are in the beginning of the struct, so compiler
637  *   does not put own padding trying to align this members.
638  * - We make sure OSL pointer is also 16 bytes aligned.
639  */
640 typedef ccl_addr_space struct ShaderClosure {
641         float3 weight;
642         float3 N;
643         float3 T;
644
645         ClosureType type;
646         float sample_weight;
647         float data0;
648         float data1;
649         float data2;
650
651         /* Following fields could be used to store pre-calculated
652          * values by various BSDF closures for more effective sampling
653          * and evaluation.
654          */
655         float custom1;
656         float custom2;
657         float custom3;
658
659 #ifdef __OSL__
660         void *prim, *pad4;
661 #endif
662 } ShaderClosure;
663
664 /* Shader Context
665  *
666  * For OSL we recycle a fixed number of contexts for speed */
667
668 typedef enum ShaderContext {
669         SHADER_CONTEXT_MAIN = 0,
670         SHADER_CONTEXT_INDIRECT = 1,
671         SHADER_CONTEXT_EMISSION = 2,
672         SHADER_CONTEXT_SHADOW = 3,
673         SHADER_CONTEXT_SSS = 4,
674         SHADER_CONTEXT_VOLUME = 5,
675         SHADER_CONTEXT_NUM = 6
676 } ShaderContext;
677
678 /* Shader Data
679  *
680  * Main shader state at a point on the surface or in a volume. All coordinates
681  * are in world space. */
682
683 enum ShaderDataFlag {
684         /* runtime flags */
685         SD_BACKFACING     = (1 << 0),   /* backside of surface? */
686         SD_EMISSION       = (1 << 1),   /* have emissive closure? */
687         SD_BSDF           = (1 << 2),   /* have bsdf closure? */
688         SD_BSDF_HAS_EVAL  = (1 << 3),   /* have non-singular bsdf closure? */
689         SD_BSSRDF         = (1 << 4),   /* have bssrdf */
690         SD_HOLDOUT        = (1 << 5),   /* have holdout closure? */
691         SD_ABSORPTION     = (1 << 6),   /* have volume absorption closure? */
692         SD_SCATTER        = (1 << 7),   /* have volume phase closure? */
693         SD_AO             = (1 << 8),   /* have ao closure? */
694         SD_TRANSPARENT    = (1 << 9),  /* have transparent closure? */
695
696         SD_CLOSURE_FLAGS = (SD_EMISSION|SD_BSDF|SD_BSDF_HAS_EVAL|SD_BSSRDF|
697                             SD_HOLDOUT|SD_ABSORPTION|SD_SCATTER|SD_AO),
698
699         /* shader flags */
700         SD_USE_MIS                = (1 << 10),  /* direct light sample */
701         SD_HAS_TRANSPARENT_SHADOW = (1 << 11),  /* has transparent shadow */
702         SD_HAS_VOLUME             = (1 << 12),  /* has volume shader */
703         SD_HAS_ONLY_VOLUME        = (1 << 13),  /* has only volume shader, no surface */
704         SD_HETEROGENEOUS_VOLUME   = (1 << 14),  /* has heterogeneous volume */
705         SD_HAS_BSSRDF_BUMP        = (1 << 15),  /* bssrdf normal uses bump */
706         SD_VOLUME_EQUIANGULAR     = (1 << 16),  /* use equiangular sampling */
707         SD_VOLUME_MIS             = (1 << 17),  /* use multiple importance sampling */
708         SD_VOLUME_CUBIC           = (1 << 18),  /* use cubic interpolation for voxels */
709         SD_HAS_BUMP               = (1 << 19),  /* has data connected to the displacement input */
710
711         SD_SHADER_FLAGS = (SD_USE_MIS|SD_HAS_TRANSPARENT_SHADOW|SD_HAS_VOLUME|
712                            SD_HAS_ONLY_VOLUME|SD_HETEROGENEOUS_VOLUME|
713                            SD_HAS_BSSRDF_BUMP|SD_VOLUME_EQUIANGULAR|SD_VOLUME_MIS|
714                            SD_VOLUME_CUBIC|SD_HAS_BUMP),
715
716         /* object flags */
717         SD_HOLDOUT_MASK             = (1 << 20),  /* holdout for camera rays */
718         SD_OBJECT_MOTION            = (1 << 21),  /* has object motion blur */
719         SD_TRANSFORM_APPLIED        = (1 << 22),  /* vertices have transform applied */
720         SD_NEGATIVE_SCALE_APPLIED   = (1 << 23),  /* vertices have negative scale applied */
721         SD_OBJECT_HAS_VOLUME        = (1 << 24),  /* object has a volume shader */
722         SD_OBJECT_INTERSECTS_VOLUME = (1 << 25),  /* object intersects AABB of an object with volume shader */
723         SD_OBJECT_HAS_VERTEX_MOTION = (1 << 26),  /* has position for motion vertices */
724
725         SD_OBJECT_FLAGS = (SD_HOLDOUT_MASK|SD_OBJECT_MOTION|SD_TRANSFORM_APPLIED|
726                            SD_NEGATIVE_SCALE_APPLIED|SD_OBJECT_HAS_VOLUME|
727                            SD_OBJECT_INTERSECTS_VOLUME)
728 };
729
730 struct KernelGlobals;
731
732 #ifdef __SPLIT_KERNEL__
733 #  define SD_THREAD (get_global_id(1) * get_global_size(0) + get_global_id(0))
734 #  if defined(__SPLIT_KERNEL_AOS__)
735      /* ShaderData is stored as an Array-of-Structures */
736 #    define ccl_fetch(s, t) (s[SD_THREAD].t)
737 #    define ccl_fetch_array(s, t, index) (&s[SD_THREAD].t[index])
738 #  else
739      /* ShaderData is stored as an Structure-of-Arrays */
740 #    define SD_GLOBAL_SIZE (get_global_size(0) * get_global_size(1))
741 #    define SD_FIELD_SIZE(t) sizeof(((struct ShaderData*)0)->t)
742 #    define SD_OFFSETOF(t) ((char*)(&((struct ShaderData*)0)->t) - (char*)0)
743 #    define ccl_fetch(s, t) (((ShaderData*)((ccl_addr_space char*)s + SD_GLOBAL_SIZE * SD_OFFSETOF(t) +  SD_FIELD_SIZE(t) * SD_THREAD - SD_OFFSETOF(t)))->t)
744 #    define ccl_fetch_array(s, t, index) (&ccl_fetch(s, t)[index])
745 #  endif
746 #else
747 #  define ccl_fetch(s, t) (s->t)
748 #  define ccl_fetch_array(s, t, index) (&s->t[index])
749 #endif
750
751 typedef ccl_addr_space struct ShaderData {
752         /* position */
753         float3 P;
754         /* smooth normal for shading */
755         float3 N;
756         /* true geometric normal */
757         float3 Ng;
758         /* view/incoming direction */
759         float3 I;
760         /* shader id */
761         int shader;
762         /* booleans describing shader, see ShaderDataFlag */
763         int flag;
764
765         /* primitive id if there is one, ~0 otherwise */
766         int prim;
767
768         /* combined type and curve segment for hair */
769         int type;
770
771         /* parametric coordinates
772         * - barycentric weights for triangles */
773         float u;
774         float v;
775         /* object id if there is one, ~0 otherwise */
776         int object;
777
778         /* motion blur sample time */
779         float time;
780
781         /* length of the ray being shaded */
782         float ray_length;
783
784 #ifdef __RAY_DIFFERENTIALS__
785         /* differential of P. these are orthogonal to Ng, not N */
786         differential3 dP;
787         /* differential of I */
788         differential3 dI;
789         /* differential of u, v */
790         differential du;
791         differential dv;
792 #endif
793 #ifdef __DPDU__
794         /* differential of P w.r.t. parametric coordinates. note that dPdu is
795         * not readily suitable as a tangent for shading on triangles. */
796         float3 dPdu;
797         float3 dPdv;
798 #endif
799
800 #ifdef __OBJECT_MOTION__
801         /* object <-> world space transformations, cached to avoid
802         * re-interpolating them constantly for shading */
803         Transform ob_tfm;
804         Transform ob_itfm;
805 #endif
806
807         /* Closure data, we store a fixed array of closures */
808         struct ShaderClosure closure[MAX_CLOSURE];
809         int num_closure;
810         float randb_closure;
811
812         /* ray start position, only set for backgrounds */
813         float3 ray_P;
814         differential3 ray_dP;
815
816 #ifdef __OSL__
817         struct KernelGlobals * osl_globals;
818         struct PathState *osl_path_state;
819 #endif
820 } ShaderData;
821
822 /* Path State */
823
824 #ifdef __VOLUME__
825 typedef struct VolumeStack {
826         int object;
827         int shader;
828 } VolumeStack;
829 #endif
830
831 typedef struct PathState {
832         /* see enum PathRayFlag */
833         int flag;
834
835         /* random number generator state */
836         int rng_offset;                 /* dimension offset */
837         int sample;                     /* path sample number */
838         int num_samples;                /* total number of times this path will be sampled */
839
840         /* bounce counting */
841         int bounce;
842         int diffuse_bounce;
843         int glossy_bounce;
844         int transmission_bounce;
845         int transparent_bounce;
846
847         /* multiple importance sampling */
848         float min_ray_pdf; /* smallest bounce pdf over entire path up to now */
849         float ray_pdf;     /* last bounce pdf */
850 #ifdef __LAMP_MIS__
851         float ray_t;       /* accumulated distance through transparent surfaces */
852 #endif
853
854         /* volume rendering */
855 #ifdef __VOLUME__
856         int volume_bounce;
857         RNG rng_congruential;
858         VolumeStack volume_stack[VOLUME_STACK_SIZE];
859 #endif
860 } PathState;
861
862 /* Subsurface */
863
864 /* Struct to gather multiple SSS hits. */
865 struct SubsurfaceIntersection
866 {
867         Ray ray;
868         float3 weight[BSSRDF_MAX_HITS];
869
870         int num_hits;
871         struct Intersection hits[BSSRDF_MAX_HITS];
872         float3 Ng[BSSRDF_MAX_HITS];
873 };
874
875 /* Struct to gather SSS indirect rays and delay tracing them. */
876 struct SubsurfaceIndirectRays
877 {
878         bool need_update_volume_stack;
879         bool tracing;
880         PathState state[BSSRDF_MAX_HITS];
881         struct PathRadiance direct_L;
882
883         int num_rays;
884         struct Ray rays[BSSRDF_MAX_HITS];
885         float3 throughputs[BSSRDF_MAX_HITS];
886         struct PathRadiance L[BSSRDF_MAX_HITS];
887 };
888
889 /* Constant Kernel Data
890  *
891  * These structs are passed from CPU to various devices, and the struct layout
892  * must match exactly. Structs are padded to ensure 16 byte alignment, and we
893  * do not use float3 because its size may not be the same on all devices. */
894
895 typedef struct KernelCamera {
896         /* type */
897         int type;
898
899         /* panorama */
900         int panorama_type;
901         float fisheye_fov;
902         float fisheye_lens;
903         float4 equirectangular_range;
904
905         /* stereo */
906         float interocular_offset;
907         float convergence_distance;
908         float pole_merge_angle_from;
909         float pole_merge_angle_to;
910
911         /* matrices */
912         Transform cameratoworld;
913         Transform rastertocamera;
914
915         /* differentials */
916         float4 dx;
917         float4 dy;
918
919         /* depth of field */
920         float aperturesize;
921         float blades;
922         float bladesrotation;
923         float focaldistance;
924
925         /* motion blur */
926         float shuttertime;
927         int have_motion, have_perspective_motion;
928
929         /* clipping */
930         float nearclip;
931         float cliplength;
932
933         /* sensor size */
934         float sensorwidth;
935         float sensorheight;
936
937         /* render size */
938         float width, height;
939         int resolution;
940
941         /* anamorphic lens bokeh */
942         float inv_aperture_ratio;
943
944         int is_inside_volume;
945
946         /* more matrices */
947         Transform screentoworld;
948         Transform rastertoworld;
949         /* work around cuda sm 2.0 crash, this seems to
950          * cross some limit in combination with motion 
951          * Transform ndctoworld; */
952         Transform worldtoscreen;
953         Transform worldtoraster;
954         Transform worldtondc;
955         Transform worldtocamera;
956
957         MotionTransform motion;
958
959         /* Denotes changes in the projective matrix, namely in rastertocamera.
960          * Used for camera zoom motion blur,
961          */
962         PerspectiveMotionTransform perspective_motion;
963
964         int shutter_table_offset;
965
966         /* Rolling shutter */
967         int rolling_shutter_type;
968         float rolling_shutter_duration;
969
970         int pad;
971 } KernelCamera;
972
973 typedef struct KernelFilm {
974         float exposure;
975         int pass_flag;
976         int pass_stride;
977         int use_light_pass;
978
979         int pass_combined;
980         int pass_depth;
981         int pass_normal;
982         int pass_motion;
983
984         int pass_motion_weight;
985         int pass_uv;
986         int pass_object_id;
987         int pass_material_id;
988
989         int pass_diffuse_color;
990         int pass_glossy_color;
991         int pass_transmission_color;
992         int pass_subsurface_color;
993         
994         int pass_diffuse_indirect;
995         int pass_glossy_indirect;
996         int pass_transmission_indirect;
997         int pass_subsurface_indirect;
998         
999         int pass_diffuse_direct;
1000         int pass_glossy_direct;
1001         int pass_transmission_direct;
1002         int pass_subsurface_direct;
1003         
1004         int pass_emission;
1005         int pass_background;
1006         int pass_ao;
1007         float pass_alpha_threshold;
1008
1009         int pass_shadow;
1010         float pass_shadow_scale;
1011         int filter_table_offset;
1012         int pass_pad2;
1013
1014         int pass_mist;
1015         float mist_start;
1016         float mist_inv_depth;
1017         float mist_falloff;
1018
1019 #ifdef __KERNEL_DEBUG__
1020         int pass_bvh_traversal_steps;
1021         int pass_bvh_traversed_instances;
1022         int pass_ray_bounces;
1023         int pass_pad3;
1024 #endif
1025 } KernelFilm;
1026
1027 typedef struct KernelBackground {
1028         /* only shader index */
1029         int surface_shader;
1030         int volume_shader;
1031         int transparent;
1032         int pad;
1033
1034         /* ambient occlusion */
1035         float ao_factor;
1036         float ao_distance;
1037         float ao_pad1, ao_pad2;
1038 } KernelBackground;
1039
1040 typedef struct KernelIntegrator {
1041         /* emission */
1042         int use_direct_light;
1043         int use_ambient_occlusion;
1044         int num_distribution;
1045         int num_all_lights;
1046         float pdf_triangles;
1047         float pdf_lights;
1048         float inv_pdf_lights;
1049         int pdf_background_res;
1050
1051         /* light portals */
1052         float portal_pdf;
1053         int num_portals;
1054         int portal_offset;
1055
1056         /* bounces */
1057         int min_bounce;
1058         int max_bounce;
1059
1060         int max_diffuse_bounce;
1061         int max_glossy_bounce;
1062         int max_transmission_bounce;
1063         int max_volume_bounce;
1064
1065         /* transparent */
1066         int transparent_min_bounce;
1067         int transparent_max_bounce;
1068         int transparent_shadows;
1069
1070         /* caustics */
1071         int caustics_reflective;
1072         int caustics_refractive;
1073         float filter_glossy;
1074
1075         /* seed */
1076         int seed;
1077
1078         /* clamp */
1079         float sample_clamp_direct;
1080         float sample_clamp_indirect;
1081
1082         /* branched path */
1083         int branched;
1084         int diffuse_samples;
1085         int glossy_samples;
1086         int transmission_samples;
1087         int ao_samples;
1088         int mesh_light_samples;
1089         int subsurface_samples;
1090         int sample_all_lights_direct;
1091         int sample_all_lights_indirect;
1092
1093         /* mis */
1094         int use_lamp_mis;
1095
1096         /* sampler */
1097         int sampling_pattern;
1098         int aa_samples;
1099
1100         /* volume render */
1101         int use_volumes;
1102         int volume_max_steps;
1103         float volume_step_size;
1104         int volume_samples;
1105
1106         int pad;
1107 } KernelIntegrator;
1108
1109 typedef struct KernelBVH {
1110         /* root node */
1111         int root;
1112         int attributes_map_stride;
1113         int have_motion;
1114         int have_curves;
1115         int have_instancing;
1116         int use_qbvh;
1117         int pad1, pad2;
1118 } KernelBVH;
1119
1120 typedef enum CurveFlag {
1121         /* runtime flags */
1122         CURVE_KN_BACKFACING = 1,                                /* backside of cylinder? */
1123         CURVE_KN_ENCLOSEFILTER = 2,                             /* don't consider strands surrounding start point? */
1124         CURVE_KN_INTERPOLATE = 4,                               /* render as a curve? */
1125         CURVE_KN_ACCURATE = 8,                                  /* use accurate intersections test? */
1126         CURVE_KN_INTERSECTCORRECTION = 16,              /* correct for width after determing closest midpoint? */
1127         CURVE_KN_TRUETANGENTGNORMAL = 32,               /* use tangent normal for geometry? */
1128         CURVE_KN_RIBBONS = 64,                                  /* use flat curve ribbons */
1129 } CurveFlag;
1130
1131 typedef struct KernelCurves {
1132         int curveflags;
1133         int subdivisions;
1134
1135         float minimum_width;
1136         float maximum_width;
1137 } KernelCurves;
1138
1139 typedef struct KernelTables {
1140         int beckmann_offset;
1141         int pad1, pad2, pad3;
1142 } KernelTables;
1143
1144 typedef struct KernelData {
1145         KernelCamera cam;
1146         KernelFilm film;
1147         KernelBackground background;
1148         KernelIntegrator integrator;
1149         KernelBVH bvh;
1150         KernelCurves curve;
1151         KernelTables tables;
1152 } KernelData;
1153
1154 #ifdef __KERNEL_DEBUG__
1155 typedef ccl_addr_space struct DebugData {
1156         // Total number of BVH node traversal steps and primitives intersections
1157         // for the camera rays.
1158         int num_bvh_traversal_steps;
1159         int num_bvh_traversed_instances;
1160         int num_ray_bounces;
1161 } DebugData;
1162 #endif
1163
1164 /* Declarations required for split kernel */
1165
1166 /* Macro for queues */
1167 /* Value marking queue's empty slot */
1168 #define QUEUE_EMPTY_SLOT -1
1169
1170 /*
1171 * Queue 1 - Active rays
1172 * Queue 2 - Background queue
1173 * Queue 3 - Shadow ray cast kernel - AO
1174 * Queeu 4 - Shadow ray cast kernel - direct lighting
1175 */
1176 #define NUM_QUEUES 4
1177
1178 /* Queue names */
1179 enum QueueNumber {
1180         /* All active rays and regenerated rays are enqueued here. */
1181         QUEUE_ACTIVE_AND_REGENERATED_RAYS = 0,
1182
1183         /* All
1184          * 1. Background-hit rays,
1185          * 2. Rays that has exited path-iteration but needs to update output buffer
1186          * 3. Rays to be regenerated
1187          * are enqueued here.
1188          */
1189         QUEUE_HITBG_BUFF_UPDATE_TOREGEN_RAYS = 1,
1190
1191         /* All rays for which a shadow ray should be cast to determine radiance
1192          * contribution for AO are enqueued here.
1193          */
1194         QUEUE_SHADOW_RAY_CAST_AO_RAYS = 2,
1195
1196         /* All rays for which a shadow ray should be cast to determine radiance
1197          * contributing for direct lighting are enqueued here.
1198          */
1199         QUEUE_SHADOW_RAY_CAST_DL_RAYS = 3,
1200 };
1201
1202 /* We use RAY_STATE_MASK to get ray_state (enums 0 to 5) */
1203 #define RAY_STATE_MASK 0x007
1204 #define RAY_FLAG_MASK 0x0F8
1205 enum RayState {
1206         /* Denotes ray is actively involved in path-iteration. */
1207         RAY_ACTIVE = 0,
1208         /* Denotes ray has completed processing all samples and is inactive. */
1209         RAY_INACTIVE = 1,
1210         /* Denoted ray has exited path-iteration and needs to update output buffer. */
1211         RAY_UPDATE_BUFFER = 2,
1212         /* Donotes ray has hit background */
1213         RAY_HIT_BACKGROUND = 3,
1214         /* Denotes ray has to be regenerated */
1215         RAY_TO_REGENERATE = 4,
1216         /* Denotes ray has been regenerated */
1217         RAY_REGENERATED = 5,
1218         /* Denotes ray should skip direct lighting */
1219         RAY_SKIP_DL = 6,
1220         /* Flag's ray has to execute shadow blocked function in AO part */
1221         RAY_SHADOW_RAY_CAST_AO = 16,
1222         /* Flag's ray has to execute shadow blocked function in direct lighting part. */
1223         RAY_SHADOW_RAY_CAST_DL = 32,
1224 };
1225
1226 #define ASSIGN_RAY_STATE(ray_state, ray_index, state) (ray_state[ray_index] = ((ray_state[ray_index] & RAY_FLAG_MASK) | state))
1227 #define IS_STATE(ray_state, ray_index, state) ((ray_state[ray_index] & RAY_STATE_MASK) == state)
1228 #define ADD_RAY_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] = (ray_state[ray_index] | flag))
1229 #define REMOVE_RAY_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] = (ray_state[ray_index] & (~flag)))
1230 #define IS_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] & flag)
1231
1232 CCL_NAMESPACE_END
1233
1234 #endif /*  __KERNEL_TYPES_H__ */
1235