Cleanup: comment blocks
[blender.git] / intern / cycles / kernel / kernel_types.h
1 /*
2  * Copyright 2011-2013 Blender Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __KERNEL_TYPES_H__
18 #define __KERNEL_TYPES_H__
19
20 #include "kernel_math.h"
21 #include "svm/svm_types.h"
22
23 #ifndef __KERNEL_GPU__
24 #  define __KERNEL_CPU__
25 #endif
26
27 /* TODO(sergey): This is only to make it possible to include this header
28  * from outside of the kernel. but this could be done somewhat cleaner?
29  */
30 #ifndef ccl_addr_space
31 #  define ccl_addr_space
32 #endif
33
34 CCL_NAMESPACE_BEGIN
35
36 /* constants */
37 #define OBJECT_SIZE             11
38 #define OBJECT_VECTOR_SIZE      6
39 #define LIGHT_SIZE                      5
40 #define FILTER_TABLE_SIZE       1024
41 #define RAMP_TABLE_SIZE         256
42 #define SHUTTER_TABLE_SIZE              256
43 #define PARTICLE_SIZE           5
44 #define TIME_INVALID            FLT_MAX
45
46 #define BSSRDF_MIN_RADIUS                       1e-8f
47 #define BSSRDF_MAX_HITS                         4
48
49 #define BECKMANN_TABLE_SIZE             256
50
51 #define SHADER_NONE                             (~0)
52 #define OBJECT_NONE                             (~0)
53 #define PRIM_NONE                               (~0)
54 #define LAMP_NONE                               (~0)
55
56 #define VOLUME_STACK_SIZE               16
57
58 /* device capabilities */
59 #ifdef __KERNEL_CPU__
60 #  ifdef __KERNEL_SSE2__
61 #    define __QBVH__
62 #  endif
63 #  define __KERNEL_SHADING__
64 #  define __KERNEL_ADV_SHADING__
65 #  define __BRANCHED_PATH__
66 #  ifdef WITH_OSL
67 #    define __OSL__
68 #  endif
69 #  define __SUBSURFACE__
70 #  define __CMJ__
71 #  define __VOLUME__
72 #  define __VOLUME_DECOUPLED__
73 #  define __VOLUME_SCATTER__
74 #  define __SHADOW_RECORD_ALL__
75 #  define __VOLUME_RECORD_ALL__
76 #endif  /* __KERNEL_CPU__ */
77
78 #ifdef __KERNEL_CUDA__
79 #  define __KERNEL_SHADING__
80 #  define __KERNEL_ADV_SHADING__
81 #  define __BRANCHED_PATH__
82 #  define __VOLUME__
83 #  define __VOLUME_SCATTER__
84 #  define __SUBSURFACE__
85 #  define __CMJ__
86 #endif  /* __KERNEL_CUDA__ */
87
88 #ifdef __KERNEL_OPENCL__
89
90 /* keep __KERNEL_ADV_SHADING__ in sync with opencl_kernel_use_advanced_shading! */
91
92 #  ifdef __KERNEL_OPENCL_NVIDIA__
93 #    define __KERNEL_SHADING__
94 #    define __KERNEL_ADV_SHADING__
95 #    ifdef __KERNEL_EXPERIMENTAL__
96 #      define __CMJ__
97 #    endif
98 #  endif  /* __KERNEL_OPENCL_NVIDIA__ */
99
100 #  ifdef __KERNEL_OPENCL_APPLE__
101 #    define __KERNEL_SHADING__
102 #    define __KERNEL_ADV_SHADING__
103 /* TODO(sergey): Currently experimental section is ignored here,
104  * this is because megakernel in device_opencl does not support
105  * custom cflags depending on the scene features.
106  */
107 #    ifdef __KERNEL_EXPERIMENTAL__
108 #      define __CMJ__
109 #    endif
110 #  endif  /* __KERNEL_OPENCL_NVIDIA__ */
111
112 #  ifdef __KERNEL_OPENCL_AMD__
113 #    define __CL_USE_NATIVE__
114 #    define __KERNEL_SHADING__
115 #    define __MULTI_CLOSURE__
116 #    define __PASSES__
117 #    define __BACKGROUND_MIS__
118 #    define __LAMP_MIS__
119 #    define __AO__
120 #    define __CAMERA_MOTION__
121 #    define __OBJECT_MOTION__
122 #    define __HAIR__
123 #    define __BAKING__
124 #    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         PATH_RAY_ALL_VISIBILITY = (1|2|4|8|16|32|64|128|256|512|1024),
296
297         PATH_RAY_MIS_SKIP = 2048,
298         PATH_RAY_DIFFUSE_ANCESTOR = 4096,
299         PATH_RAY_SINGLE_PASS_DONE = 8192,
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 = 0,
486         PANORAMA_FISHEYE_EQUIDISTANT = 1,
487         PANORAMA_FISHEYE_EQUISOLID = 2,
488         PANORAMA_MIRRORBALL = 3,
489
490         PANORAMA_NUM_TYPES,
491 };
492
493 /* Differential */
494
495 typedef struct differential3 {
496         float3 dx;
497         float3 dy;
498 } differential3;
499
500 typedef struct differential {
501         float dx;
502         float dy;
503 } differential;
504
505 /* Ray */
506
507 typedef struct Ray {
508 /* TODO(sergey): This is only needed because current AMD
509  * compiler has hard time building the kernel with this
510  * reshuffle. And at the same time reshuffle will cause
511  * less optimal CPU code in certain places.
512  *
513  * We'll get rid of this nasty exception once AMD compiler
514  * is fixed.
515  */
516 #ifndef __KERNEL_OPENCL_AMD__
517         float3 P;               /* origin */
518         float3 D;               /* direction */
519
520         float t;                /* length of the ray */
521         float time;             /* time (for motion blur) */
522 #else
523         float t;                /* length of the ray */
524         float time;             /* time (for motion blur) */
525         float3 P;               /* origin */
526         float3 D;               /* direction */
527 #endif
528
529 #ifdef __RAY_DIFFERENTIALS__
530         differential3 dP;
531         differential3 dD;
532 #endif
533 } Ray;
534
535 /* Intersection */
536
537 typedef ccl_addr_space struct Intersection {
538         float t, u, v;
539         int prim;
540         int object;
541         int type;
542
543 #ifdef __KERNEL_DEBUG__
544         int num_traversal_steps;
545         int num_traversed_instances;
546 #endif
547 } Intersection;
548
549 /* Primitives */
550
551 typedef enum PrimitiveType {
552         PRIMITIVE_NONE = 0,
553         PRIMITIVE_TRIANGLE = 1,
554         PRIMITIVE_MOTION_TRIANGLE = 2,
555         PRIMITIVE_CURVE = 4,
556         PRIMITIVE_MOTION_CURVE = 8,
557
558         PRIMITIVE_ALL_TRIANGLE = (PRIMITIVE_TRIANGLE|PRIMITIVE_MOTION_TRIANGLE),
559         PRIMITIVE_ALL_CURVE = (PRIMITIVE_CURVE|PRIMITIVE_MOTION_CURVE),
560         PRIMITIVE_ALL_MOTION = (PRIMITIVE_MOTION_TRIANGLE|PRIMITIVE_MOTION_CURVE),
561         PRIMITIVE_ALL = (PRIMITIVE_ALL_TRIANGLE|PRIMITIVE_ALL_CURVE),
562
563         /* Total number of different primitives.
564          * NOTE: This is an actual value, not a bitflag.
565          */
566         PRIMITIVE_NUM_TOTAL = 4,
567 } PrimitiveType;
568
569 #define PRIMITIVE_PACK_SEGMENT(type, segment) ((segment << 16) | type)
570 #define PRIMITIVE_UNPACK_SEGMENT(type) (type >> 16)
571
572 /* Attributes */
573
574 #define ATTR_PRIM_TYPES         2
575 #define ATTR_PRIM_CURVE         1
576
577 typedef enum AttributeElement {
578         ATTR_ELEMENT_NONE,
579         ATTR_ELEMENT_OBJECT,
580         ATTR_ELEMENT_MESH,
581         ATTR_ELEMENT_FACE,
582         ATTR_ELEMENT_VERTEX,
583         ATTR_ELEMENT_VERTEX_MOTION,
584         ATTR_ELEMENT_CORNER,
585         ATTR_ELEMENT_CORNER_BYTE,
586         ATTR_ELEMENT_CURVE,
587         ATTR_ELEMENT_CURVE_KEY,
588         ATTR_ELEMENT_CURVE_KEY_MOTION,
589         ATTR_ELEMENT_VOXEL
590 } AttributeElement;
591
592 typedef enum AttributeStandard {
593         ATTR_STD_NONE = 0,
594         ATTR_STD_VERTEX_NORMAL,
595         ATTR_STD_FACE_NORMAL,
596         ATTR_STD_UV,
597         ATTR_STD_UV_TANGENT,
598         ATTR_STD_UV_TANGENT_SIGN,
599         ATTR_STD_GENERATED,
600         ATTR_STD_GENERATED_TRANSFORM,
601         ATTR_STD_POSITION_UNDEFORMED,
602         ATTR_STD_POSITION_UNDISPLACED,
603         ATTR_STD_MOTION_VERTEX_POSITION,
604         ATTR_STD_MOTION_VERTEX_NORMAL,
605         ATTR_STD_PARTICLE,
606         ATTR_STD_CURVE_INTERCEPT,
607         ATTR_STD_PTEX_FACE_ID,
608         ATTR_STD_PTEX_UV,
609         ATTR_STD_VOLUME_DENSITY,
610         ATTR_STD_VOLUME_COLOR,
611         ATTR_STD_VOLUME_FLAME,
612         ATTR_STD_VOLUME_HEAT,
613         ATTR_STD_VOLUME_VELOCITY,
614         ATTR_STD_POINTINESS,
615         ATTR_STD_NUM,
616
617         ATTR_STD_NOT_FOUND = ~0
618 } AttributeStandard;
619
620 /* Closure data */
621
622 #ifdef __MULTI_CLOSURE__
623 #  ifndef __MAX_CLOSURE__
624 #     define MAX_CLOSURE 64
625 #  else
626 #    define MAX_CLOSURE __MAX_CLOSURE__
627 #  endif
628 #else
629 #  define MAX_CLOSURE 1
630 #endif
631
632 /* This struct is to be 16 bytes aligned, we also keep some extra precautions:
633  * - All the float3 members are in the beginning of the struct, so compiler
634  *   does not put own padding trying to align this members.
635  * - We make sure OSL pointer is also 16 bytes aligned.
636  */
637 typedef ccl_addr_space struct ShaderClosure {
638         float3 weight;
639         float3 N;
640         float3 T;
641
642         ClosureType type;
643         float sample_weight;
644         float data0;
645         float data1;
646         float data2;
647
648         /* Following fields could be used to store pre-calculated
649          * values by various BSDF closures for more effective sampling
650          * and evaluation.
651          */
652         float custom1;
653         float custom2;
654         float custom3;
655
656 #ifdef __OSL__
657         void *prim, *pad4;
658 #endif
659 } ShaderClosure;
660
661 /* Shader Context
662  *
663  * For OSL we recycle a fixed number of contexts for speed */
664
665 typedef enum ShaderContext {
666         SHADER_CONTEXT_MAIN = 0,
667         SHADER_CONTEXT_INDIRECT = 1,
668         SHADER_CONTEXT_EMISSION = 2,
669         SHADER_CONTEXT_SHADOW = 3,
670         SHADER_CONTEXT_SSS = 4,
671         SHADER_CONTEXT_VOLUME = 5,
672         SHADER_CONTEXT_NUM = 6
673 } ShaderContext;
674
675 /* Shader Data
676  *
677  * Main shader state at a point on the surface or in a volume. All coordinates
678  * are in world space. */
679
680 enum ShaderDataFlag {
681         /* runtime flags */
682         SD_BACKFACING      = (1 << 0),   /* backside of surface? */
683         SD_EMISSION        = (1 << 1),   /* have emissive closure? */
684         SD_BSDF            = (1 << 2),   /* have bsdf closure? */
685         SD_BSDF_HAS_EVAL   = (1 << 3),   /* have non-singular bsdf closure? */
686         SD_BSSRDF          = (1 << 4),   /* have bssrdf */
687         SD_HOLDOUT         = (1 << 5),   /* have holdout closure? */
688         SD_ABSORPTION      = (1 << 6),   /* have volume absorption closure? */
689         SD_SCATTER         = (1 << 7),   /* have volume phase closure? */
690         SD_AO              = (1 << 8),   /* have ao closure? */
691         SD_TRANSPARENT     = (1 << 9),  /* have transparent closure? */
692         SD_BSDF_NEEDS_LCG  = (1 << 10),
693         SD_BSDF_HAS_CUSTOM = (1 << 11), /* are the custom variables relevant? */
694
695         SD_CLOSURE_FLAGS = (SD_EMISSION|SD_BSDF|SD_BSDF_HAS_EVAL|SD_BSSRDF|
696                             SD_HOLDOUT|SD_ABSORPTION|SD_SCATTER|SD_AO|
697                             SD_BSDF_NEEDS_LCG|SD_BSDF_HAS_CUSTOM),
698
699         /* shader flags */
700         SD_USE_MIS                = (1 << 12),  /* direct light sample */
701         SD_HAS_TRANSPARENT_SHADOW = (1 << 13),  /* has transparent shadow */
702         SD_HAS_VOLUME             = (1 << 14),  /* has volume shader */
703         SD_HAS_ONLY_VOLUME        = (1 << 15),  /* has only volume shader, no surface */
704         SD_HETEROGENEOUS_VOLUME   = (1 << 16),  /* has heterogeneous volume */
705         SD_HAS_BSSRDF_BUMP        = (1 << 17),  /* bssrdf normal uses bump */
706         SD_VOLUME_EQUIANGULAR     = (1 << 18),  /* use equiangular sampling */
707         SD_VOLUME_MIS             = (1 << 19),  /* use multiple importance sampling */
708         SD_VOLUME_CUBIC           = (1 << 20),  /* use cubic interpolation for voxels */
709         SD_HAS_BUMP               = (1 << 21),  /* has data connected to the displacement input */
710
711         SD_SHADER_FLAGS = (SD_USE_MIS|SD_HAS_TRANSPARENT_SHADOW|SD_HAS_VOLUME|
712                            SD_HAS_ONLY_VOLUME|SD_HETEROGENEOUS_VOLUME|
713                            SD_HAS_BSSRDF_BUMP|SD_VOLUME_EQUIANGULAR|SD_VOLUME_MIS|
714                            SD_VOLUME_CUBIC|SD_HAS_BUMP),
715
716         /* object flags */
717         SD_HOLDOUT_MASK             = (1 << 22),  /* holdout for camera rays */
718         SD_OBJECT_MOTION            = (1 << 23),  /* has object motion blur */
719         SD_TRANSFORM_APPLIED        = (1 << 24),  /* vertices have transform applied */
720         SD_NEGATIVE_SCALE_APPLIED   = (1 << 25),  /* vertices have negative scale applied */
721         SD_OBJECT_HAS_VOLUME        = (1 << 26),  /* object has a volume shader */
722         SD_OBJECT_INTERSECTS_VOLUME = (1 << 27),  /* object intersects AABB of an object with volume shader */
723         SD_OBJECT_HAS_VERTEX_MOTION = (1 << 28),  /* has position for motion vertices */
724
725         SD_OBJECT_FLAGS = (SD_HOLDOUT_MASK|SD_OBJECT_MOTION|SD_TRANSFORM_APPLIED|
726                            SD_NEGATIVE_SCALE_APPLIED|SD_OBJECT_HAS_VOLUME|
727                            SD_OBJECT_INTERSECTS_VOLUME)
728 };
729
730 struct KernelGlobals;
731
732 #ifdef __SPLIT_KERNEL__
733 #  define SD_THREAD (get_global_id(1) * get_global_size(0) + get_global_id(0))
734 #  if defined(__SPLIT_KERNEL_AOS__)
735      /* ShaderData is stored as an Array-of-Structures */
736 #    define ccl_fetch(s, t) (s[SD_THREAD].t)
737 #    define ccl_fetch_array(s, t, index) (&s[SD_THREAD].t[index])
738 #  else
739      /* ShaderData is stored as an Structure-of-Arrays */
740 #    define SD_GLOBAL_SIZE (get_global_size(0) * get_global_size(1))
741 #    define SD_FIELD_SIZE(t) sizeof(((struct ShaderData*)0)->t)
742 #    define SD_OFFSETOF(t) ((char*)(&((struct ShaderData*)0)->t) - (char*)0)
743 #    define ccl_fetch(s, t) (((ShaderData*)((ccl_addr_space char*)s + SD_GLOBAL_SIZE * SD_OFFSETOF(t) +  SD_FIELD_SIZE(t) * SD_THREAD - SD_OFFSETOF(t)))->t)
744 #    define ccl_fetch_array(s, t, index) (&ccl_fetch(s, t)[index])
745 #  endif
746 #else
747 #  define ccl_fetch(s, t) (s->t)
748 #  define ccl_fetch_array(s, t, index) (&s->t[index])
749 #endif
750
751 typedef ccl_addr_space struct ShaderData {
752         /* position */
753         float3 P;
754         /* smooth normal for shading */
755         float3 N;
756         /* true geometric normal */
757         float3 Ng;
758         /* view/incoming direction */
759         float3 I;
760         /* shader id */
761         int shader;
762         /* booleans describing shader, see ShaderDataFlag */
763         int flag;
764
765         /* primitive id if there is one, ~0 otherwise */
766         int prim;
767
768         /* combined type and curve segment for hair */
769         int type;
770
771         /* parametric coordinates
772          * - barycentric weights for triangles */
773         float u;
774         float v;
775         /* object id if there is one, ~0 otherwise */
776         int object;
777
778         /* motion blur sample time */
779         float time;
780
781         /* length of the ray being shaded */
782         float ray_length;
783
784 #ifdef __RAY_DIFFERENTIALS__
785         /* differential of P. these are orthogonal to Ng, not N */
786         differential3 dP;
787         /* differential of I */
788         differential3 dI;
789         /* differential of u, v */
790         differential du;
791         differential dv;
792 #endif
793 #ifdef __DPDU__
794         /* differential of P w.r.t. parametric coordinates. note that dPdu is
795          * not readily suitable as a tangent for shading on triangles. */
796         float3 dPdu;
797         float3 dPdv;
798 #endif
799
800 #ifdef __OBJECT_MOTION__
801         /* object <-> world space transformations, cached to avoid
802          * re-interpolating them constantly for shading */
803         Transform ob_tfm;
804         Transform ob_itfm;
805 #endif
806
807         /* Closure data, we store a fixed array of closures */
808         struct ShaderClosure closure[MAX_CLOSURE];
809         int num_closure;
810         float randb_closure;
811
812         /* LCG state for closures that require additional random numbers. */
813         uint lcg_state;
814
815         /* ray start position, only set for backgrounds */
816         float3 ray_P;
817         differential3 ray_dP;
818
819 #ifdef __OSL__
820         struct KernelGlobals * osl_globals;
821         struct PathState *osl_path_state;
822 #endif
823 } ShaderData;
824
825 /* Path State */
826
827 #ifdef __VOLUME__
828 typedef struct VolumeStack {
829         int object;
830         int shader;
831 } VolumeStack;
832 #endif
833
834 typedef struct PathState {
835         /* see enum PathRayFlag */
836         int flag;
837
838         /* random number generator state */
839         int rng_offset;                 /* dimension offset */
840         int sample;                     /* path sample number */
841         int num_samples;                /* total number of times this path will be sampled */
842
843         /* bounce counting */
844         int bounce;
845         int diffuse_bounce;
846         int glossy_bounce;
847         int transmission_bounce;
848         int transparent_bounce;
849
850         /* multiple importance sampling */
851         float min_ray_pdf; /* smallest bounce pdf over entire path up to now */
852         float ray_pdf;     /* last bounce pdf */
853 #ifdef __LAMP_MIS__
854         float ray_t;       /* accumulated distance through transparent surfaces */
855 #endif
856
857         /* volume rendering */
858 #ifdef __VOLUME__
859         int volume_bounce;
860         RNG rng_congruential;
861         VolumeStack volume_stack[VOLUME_STACK_SIZE];
862 #endif
863 } PathState;
864
865 /* Subsurface */
866
867 /* Struct to gather multiple SSS hits. */
868 struct SubsurfaceIntersection
869 {
870         Ray ray;
871         float3 weight[BSSRDF_MAX_HITS];
872
873         int num_hits;
874         struct Intersection hits[BSSRDF_MAX_HITS];
875         float3 Ng[BSSRDF_MAX_HITS];
876 };
877
878 /* Struct to gather SSS indirect rays and delay tracing them. */
879 struct SubsurfaceIndirectRays
880 {
881         bool need_update_volume_stack;
882         bool tracing;
883         PathState state[BSSRDF_MAX_HITS];
884         struct PathRadiance direct_L;
885
886         int num_rays;
887         struct Ray rays[BSSRDF_MAX_HITS];
888         float3 throughputs[BSSRDF_MAX_HITS];
889         struct PathRadiance L[BSSRDF_MAX_HITS];
890 };
891
892 /* Constant Kernel Data
893  *
894  * These structs are passed from CPU to various devices, and the struct layout
895  * must match exactly. Structs are padded to ensure 16 byte alignment, and we
896  * do not use float3 because its size may not be the same on all devices. */
897
898 typedef struct KernelCamera {
899         /* type */
900         int type;
901
902         /* panorama */
903         int panorama_type;
904         float fisheye_fov;
905         float fisheye_lens;
906         float4 equirectangular_range;
907
908         /* stereo */
909         float interocular_offset;
910         float convergence_distance;
911         float pole_merge_angle_from;
912         float pole_merge_angle_to;
913
914         /* matrices */
915         Transform cameratoworld;
916         Transform rastertocamera;
917
918         /* differentials */
919         float4 dx;
920         float4 dy;
921
922         /* depth of field */
923         float aperturesize;
924         float blades;
925         float bladesrotation;
926         float focaldistance;
927
928         /* motion blur */
929         float shuttertime;
930         int have_motion, have_perspective_motion;
931
932         /* clipping */
933         float nearclip;
934         float cliplength;
935
936         /* sensor size */
937         float sensorwidth;
938         float sensorheight;
939
940         /* render size */
941         float width, height;
942         int resolution;
943
944         /* anamorphic lens bokeh */
945         float inv_aperture_ratio;
946
947         int is_inside_volume;
948
949         /* more matrices */
950         Transform screentoworld;
951         Transform rastertoworld;
952         /* work around cuda sm 2.0 crash, this seems to
953          * cross some limit in combination with motion 
954          * Transform ndctoworld; */
955         Transform worldtoscreen;
956         Transform worldtoraster;
957         Transform worldtondc;
958         Transform worldtocamera;
959
960         MotionTransform motion;
961
962         /* Denotes changes in the projective matrix, namely in rastertocamera.
963          * Used for camera zoom motion blur,
964          */
965         PerspectiveMotionTransform perspective_motion;
966
967         int shutter_table_offset;
968
969         /* Rolling shutter */
970         int rolling_shutter_type;
971         float rolling_shutter_duration;
972
973         int pad;
974 } KernelCamera;
975
976 typedef struct KernelFilm {
977         float exposure;
978         int pass_flag;
979         int pass_stride;
980         int use_light_pass;
981
982         int pass_combined;
983         int pass_depth;
984         int pass_normal;
985         int pass_motion;
986
987         int pass_motion_weight;
988         int pass_uv;
989         int pass_object_id;
990         int pass_material_id;
991
992         int pass_diffuse_color;
993         int pass_glossy_color;
994         int pass_transmission_color;
995         int pass_subsurface_color;
996         
997         int pass_diffuse_indirect;
998         int pass_glossy_indirect;
999         int pass_transmission_indirect;
1000         int pass_subsurface_indirect;
1001         
1002         int pass_diffuse_direct;
1003         int pass_glossy_direct;
1004         int pass_transmission_direct;
1005         int pass_subsurface_direct;
1006         
1007         int pass_emission;
1008         int pass_background;
1009         int pass_ao;
1010         float pass_alpha_threshold;
1011
1012         int pass_shadow;
1013         float pass_shadow_scale;
1014         int filter_table_offset;
1015         int pass_pad2;
1016
1017         int pass_mist;
1018         float mist_start;
1019         float mist_inv_depth;
1020         float mist_falloff;
1021
1022 #ifdef __KERNEL_DEBUG__
1023         int pass_bvh_traversal_steps;
1024         int pass_bvh_traversed_instances;
1025         int pass_ray_bounces;
1026         int pass_pad3;
1027 #endif
1028 } KernelFilm;
1029
1030 typedef struct KernelBackground {
1031         /* only shader index */
1032         int surface_shader;
1033         int volume_shader;
1034         int transparent;
1035         int pad;
1036
1037         /* ambient occlusion */
1038         float ao_factor;
1039         float ao_distance;
1040         float ao_pad1, ao_pad2;
1041 } KernelBackground;
1042
1043 typedef struct KernelIntegrator {
1044         /* emission */
1045         int use_direct_light;
1046         int use_ambient_occlusion;
1047         int num_distribution;
1048         int num_all_lights;
1049         float pdf_triangles;
1050         float pdf_lights;
1051         float inv_pdf_lights;
1052         int pdf_background_res;
1053
1054         /* light portals */
1055         float portal_pdf;
1056         int num_portals;
1057         int portal_offset;
1058
1059         /* bounces */
1060         int min_bounce;
1061         int max_bounce;
1062
1063         int max_diffuse_bounce;
1064         int max_glossy_bounce;
1065         int max_transmission_bounce;
1066         int max_volume_bounce;
1067
1068         /* transparent */
1069         int transparent_min_bounce;
1070         int transparent_max_bounce;
1071         int transparent_shadows;
1072
1073         /* caustics */
1074         int caustics_reflective;
1075         int caustics_refractive;
1076         float filter_glossy;
1077
1078         /* seed */
1079         int seed;
1080
1081         /* clamp */
1082         float sample_clamp_direct;
1083         float sample_clamp_indirect;
1084
1085         /* branched path */
1086         int branched;
1087         int diffuse_samples;
1088         int glossy_samples;
1089         int transmission_samples;
1090         int ao_samples;
1091         int mesh_light_samples;
1092         int subsurface_samples;
1093         int sample_all_lights_direct;
1094         int sample_all_lights_indirect;
1095
1096         /* mis */
1097         int use_lamp_mis;
1098
1099         /* sampler */
1100         int sampling_pattern;
1101         int aa_samples;
1102
1103         /* volume render */
1104         int use_volumes;
1105         int volume_max_steps;
1106         float volume_step_size;
1107         int volume_samples;
1108
1109         int pad;
1110 } KernelIntegrator;
1111
1112 typedef struct KernelBVH {
1113         /* root node */
1114         int root;
1115         int attributes_map_stride;
1116         int have_motion;
1117         int have_curves;
1118         int have_instancing;
1119         int use_qbvh;
1120         int pad1, pad2;
1121 } KernelBVH;
1122
1123 typedef enum CurveFlag {
1124         /* runtime flags */
1125         CURVE_KN_BACKFACING = 1,                                /* backside of cylinder? */
1126         CURVE_KN_ENCLOSEFILTER = 2,                             /* don't consider strands surrounding start point? */
1127         CURVE_KN_INTERPOLATE = 4,                               /* render as a curve? */
1128         CURVE_KN_ACCURATE = 8,                                  /* use accurate intersections test? */
1129         CURVE_KN_INTERSECTCORRECTION = 16,              /* correct for width after determing closest midpoint? */
1130         CURVE_KN_TRUETANGENTGNORMAL = 32,               /* use tangent normal for geometry? */
1131         CURVE_KN_RIBBONS = 64,                                  /* use flat curve ribbons */
1132 } CurveFlag;
1133
1134 typedef struct KernelCurves {
1135         int curveflags;
1136         int subdivisions;
1137
1138         float minimum_width;
1139         float maximum_width;
1140 } KernelCurves;
1141
1142 typedef struct KernelTables {
1143         int beckmann_offset;
1144         int pad1, pad2, pad3;
1145 } KernelTables;
1146
1147 typedef struct KernelData {
1148         KernelCamera cam;
1149         KernelFilm film;
1150         KernelBackground background;
1151         KernelIntegrator integrator;
1152         KernelBVH bvh;
1153         KernelCurves curve;
1154         KernelTables tables;
1155 } KernelData;
1156
1157 #ifdef __KERNEL_DEBUG__
1158 typedef ccl_addr_space struct DebugData {
1159         // Total number of BVH node traversal steps and primitives intersections
1160         // for the camera rays.
1161         int num_bvh_traversal_steps;
1162         int num_bvh_traversed_instances;
1163         int num_ray_bounces;
1164 } DebugData;
1165 #endif
1166
1167 /* Declarations required for split kernel */
1168
1169 /* Macro for queues */
1170 /* Value marking queue's empty slot */
1171 #define QUEUE_EMPTY_SLOT -1
1172
1173 /*
1174  * Queue 1 - Active rays
1175  * Queue 2 - Background queue
1176  * Queue 3 - Shadow ray cast kernel - AO
1177  * Queeu 4 - Shadow ray cast kernel - direct lighting
1178  */
1179 #define NUM_QUEUES 4
1180
1181 /* Queue names */
1182 enum QueueNumber {
1183         /* All active rays and regenerated rays are enqueued here. */
1184         QUEUE_ACTIVE_AND_REGENERATED_RAYS = 0,
1185
1186         /* All
1187          * 1. Background-hit rays,
1188          * 2. Rays that has exited path-iteration but needs to update output buffer
1189          * 3. Rays to be regenerated
1190          * are enqueued here.
1191          */
1192         QUEUE_HITBG_BUFF_UPDATE_TOREGEN_RAYS = 1,
1193
1194         /* All rays for which a shadow ray should be cast to determine radiance
1195          * contribution for AO are enqueued here.
1196          */
1197         QUEUE_SHADOW_RAY_CAST_AO_RAYS = 2,
1198
1199         /* All rays for which a shadow ray should be cast to determine radiance
1200          * contributing for direct lighting are enqueued here.
1201          */
1202         QUEUE_SHADOW_RAY_CAST_DL_RAYS = 3,
1203 };
1204
1205 /* We use RAY_STATE_MASK to get ray_state (enums 0 to 5) */
1206 #define RAY_STATE_MASK 0x007
1207 #define RAY_FLAG_MASK 0x0F8
1208 enum RayState {
1209         /* Denotes ray is actively involved in path-iteration. */
1210         RAY_ACTIVE = 0,
1211         /* Denotes ray has completed processing all samples and is inactive. */
1212         RAY_INACTIVE = 1,
1213         /* Denoted ray has exited path-iteration and needs to update output buffer. */
1214         RAY_UPDATE_BUFFER = 2,
1215         /* Donotes ray has hit background */
1216         RAY_HIT_BACKGROUND = 3,
1217         /* Denotes ray has to be regenerated */
1218         RAY_TO_REGENERATE = 4,
1219         /* Denotes ray has been regenerated */
1220         RAY_REGENERATED = 5,
1221         /* Denotes ray should skip direct lighting */
1222         RAY_SKIP_DL = 6,
1223         /* Flag's ray has to execute shadow blocked function in AO part */
1224         RAY_SHADOW_RAY_CAST_AO = 16,
1225         /* Flag's ray has to execute shadow blocked function in direct lighting part. */
1226         RAY_SHADOW_RAY_CAST_DL = 32,
1227 };
1228
1229 #define ASSIGN_RAY_STATE(ray_state, ray_index, state) (ray_state[ray_index] = ((ray_state[ray_index] & RAY_FLAG_MASK) | state))
1230 #define IS_STATE(ray_state, ray_index, state) ((ray_state[ray_index] & RAY_STATE_MASK) == state)
1231 #define ADD_RAY_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] = (ray_state[ray_index] | flag))
1232 #define REMOVE_RAY_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] = (ray_state[ray_index] & (~flag)))
1233 #define IS_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] & flag)
1234
1235 CCL_NAMESPACE_END
1236
1237 #endif /*  __KERNEL_TYPES_H__ */
1238