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