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