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