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