Cycles: Selectively include denoising in kernel
[blender-staging.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/kernel_math.h"
21 #include "kernel/svm/svm_types.h"
22 #include "util/util_static_assert.h"
23
24 #ifndef __KERNEL_GPU__
25 #  define __KERNEL_CPU__
26 #endif
27
28 /* TODO(sergey): This is only to make it possible to include this header
29  * from outside of the kernel. but this could be done somewhat cleaner?
30  */
31 #ifndef ccl_addr_space
32 #  define ccl_addr_space
33 #endif
34
35 CCL_NAMESPACE_BEGIN
36
37 /* constants */
38 #define OBJECT_SIZE             12
39 #define OBJECT_VECTOR_SIZE      6
40 #define LIGHT_SIZE              11
41 #define FILTER_TABLE_SIZE       1024
42 #define RAMP_TABLE_SIZE         256
43 #define SHUTTER_TABLE_SIZE              256
44 #define PARTICLE_SIZE           5
45 #define SHADER_SIZE             5
46
47 #define BSSRDF_MIN_RADIUS                       1e-8f
48 #define BSSRDF_MAX_HITS                         4
49
50 #define BECKMANN_TABLE_SIZE             256
51
52 #define SHADER_NONE                             (~0)
53 #define OBJECT_NONE                             (~0)
54 #define PRIM_NONE                               (~0)
55 #define LAMP_NONE                               (~0)
56
57 #define VOLUME_STACK_SIZE               16
58
59 #define WORK_POOL_SIZE_GPU 64
60 #define WORK_POOL_SIZE_CPU 1
61 #ifdef __KERNEL_GPU__
62 #  define WORK_POOL_SIZE WORK_POOL_SIZE_GPU
63 #else
64 #  define WORK_POOL_SIZE WORK_POOL_SIZE_CPU
65 #endif
66
67
68 #define SHADER_SORT_BLOCK_SIZE 2048
69
70 #ifdef __KERNEL_OPENCL__
71 #  define SHADER_SORT_LOCAL_SIZE 64
72 #elif defined(__KERNEL_CUDA__)
73 #  define SHADER_SORT_LOCAL_SIZE 32
74 #else
75 #  define SHADER_SORT_LOCAL_SIZE 1
76 #endif
77
78
79 /* device capabilities */
80 #ifdef __KERNEL_CPU__
81 #  ifdef __KERNEL_SSE2__
82 #    define __QBVH__
83 #  endif
84 #  define __KERNEL_SHADING__
85 #  define __KERNEL_ADV_SHADING__
86 #  define __BRANCHED_PATH__
87 #  ifdef WITH_OSL
88 #    define __OSL__
89 #  endif
90 #  define __PRINCIPLED__
91 #  define __SUBSURFACE__
92 #  define __CMJ__
93 #  define __VOLUME__
94 #  define __VOLUME_SCATTER__
95 #  define __SHADOW_RECORD_ALL__
96 #  define __VOLUME_DECOUPLED__
97 #  define __VOLUME_RECORD_ALL__
98 #endif  /* __KERNEL_CPU__ */
99
100 #ifdef __KERNEL_CUDA__
101 #  define __KERNEL_SHADING__
102 #  define __KERNEL_ADV_SHADING__
103 #  define __VOLUME__
104 #  define __VOLUME_SCATTER__
105 #  define __SUBSURFACE__
106 #  define __PRINCIPLED__
107 #  define __SHADOW_RECORD_ALL__
108 #  define __CMJ__
109 #  ifndef __SPLIT_KERNEL__
110 #    define __BRANCHED_PATH__
111 #  endif
112 #endif  /* __KERNEL_CUDA__ */
113
114 #ifdef __KERNEL_OPENCL__
115
116 /* keep __KERNEL_ADV_SHADING__ in sync with opencl_kernel_use_advanced_shading! */
117
118 #  ifdef __KERNEL_OPENCL_NVIDIA__
119 #    define __KERNEL_SHADING__
120 #    define __KERNEL_ADV_SHADING__
121 #    define __SUBSURFACE__
122 #    define __PRINCIPLED__
123 #    define __VOLUME__
124 #    define __VOLUME_SCATTER__
125 #    define __SHADOW_RECORD_ALL__
126 #    define __CMJ__
127 #    define __BRANCHED_PATH__
128 #  endif  /* __KERNEL_OPENCL_NVIDIA__ */
129
130 #  ifdef __KERNEL_OPENCL_APPLE__
131 #    define __KERNEL_SHADING__
132 #    define __KERNEL_ADV_SHADING__
133 #    define __CMJ__
134 /* TODO(sergey): Currently experimental section is ignored here,
135  * this is because megakernel in device_opencl does not support
136  * custom cflags depending on the scene features.
137  */
138 #  endif  /* __KERNEL_OPENCL_NVIDIA__ */
139
140 #  ifdef __KERNEL_OPENCL_AMD__
141 #    define __CL_USE_NATIVE__
142 #    define __KERNEL_SHADING__
143 #    define __KERNEL_ADV_SHADING__
144 #    define __SUBSURFACE__
145 #    define __PRINCIPLED__
146 #    define __VOLUME__
147 #    define __VOLUME_SCATTER__
148 #    define __SHADOW_RECORD_ALL__
149 #    define __CMJ__
150 #    define __BRANCHED_PATH__
151 #  endif  /* __KERNEL_OPENCL_AMD__ */
152
153 #  ifdef __KERNEL_OPENCL_INTEL_CPU__
154 #    define __CL_USE_NATIVE__
155 #    define __KERNEL_SHADING__
156 #    define __KERNEL_ADV_SHADING__
157 #    define __CMJ__
158 #  endif  /* __KERNEL_OPENCL_INTEL_CPU__ */
159
160 #endif  /* __KERNEL_OPENCL__ */
161
162 /* kernel features */
163 #define __SOBOL__
164 #define __INSTANCING__
165 #define __DPDU__
166 #define __UV__
167 #define __BACKGROUND__
168 #define __CAUSTICS_TRICKS__
169 #define __VISIBILITY_FLAG__
170 #define __RAY_DIFFERENTIALS__
171 #define __CAMERA_CLIPPING__
172 #define __INTERSECTION_REFINE__
173 #define __CLAMP_SAMPLE__
174 #define __PATCH_EVAL__
175 #define __SHADOW_TRICKS__
176
177 #define __DENOISING_FEATURES__
178
179 #ifdef __KERNEL_SHADING__
180 #  define __SVM__
181 #  define __EMISSION__
182 #  define __TEXTURES__
183 #  define __EXTRA_NODES__
184 #  define __HOLDOUT__
185 #endif
186
187 #ifdef __KERNEL_ADV_SHADING__
188 #  define __MULTI_CLOSURE__
189 #  define __TRANSPARENT_SHADOWS__
190 #  define __PASSES__
191 #  define __BACKGROUND_MIS__
192 #  define __LAMP_MIS__
193 #  define __AO__
194 #  define __CAMERA_MOTION__
195 #  define __OBJECT_MOTION__
196 #  define __HAIR__
197 #  define __BAKING__
198 #endif
199
200 #ifdef WITH_CYCLES_DEBUG
201 #  define __KERNEL_DEBUG__
202 #endif
203
204 /* Scene-based selective features compilation. */
205 #ifdef __NO_CAMERA_MOTION__
206 #  undef __CAMERA_MOTION__
207 #endif
208 #ifdef __NO_OBJECT_MOTION__
209 #  undef __OBJECT_MOTION__
210 #endif
211 #ifdef __NO_HAIR__
212 #  undef __HAIR__
213 #endif
214 #ifdef __NO_VOLUME__
215 #  undef __VOLUME__
216 #  undef __VOLUME_SCATTER__
217 #endif
218 #ifdef __NO_SUBSURFACE__
219 #  undef __SUBSURFACE__
220 #endif
221 #ifdef __NO_BAKING__
222 #  undef __BAKING__
223 #endif
224 #ifdef __NO_BRANCHED_PATH__
225 #  undef __BRANCHED_PATH__
226 #endif
227 #ifdef __NO_PATCH_EVAL__
228 #  undef __PATCH_EVAL__
229 #endif
230 #ifdef __NO_TRANSPARENT__
231 #  undef __TRANSPARENT_SHADOWS__
232 #endif
233 #ifdef __NO_SHADOW_TRICKS__
234 #  undef __SHADOW_TRICKS__
235 #endif
236 #ifdef __NO_PRINCIPLED__
237 #  undef __PRINCIPLED__
238 #endif
239 #ifdef __NO_DENOISING__
240 #  undef __DENOISING_FEATURES__
241 #endif
242
243 /* Random Numbers */
244
245 typedef uint RNG;
246
247 /* Shader Evaluation */
248
249 typedef enum ShaderEvalType {
250         SHADER_EVAL_DISPLACE,
251         SHADER_EVAL_BACKGROUND,
252         /* bake types */
253         SHADER_EVAL_BAKE, /* no real shade, it's used in the code to
254                            * differentiate the type of shader eval from the above
255                            */
256         /* data passes */
257         SHADER_EVAL_NORMAL,
258         SHADER_EVAL_UV,
259         SHADER_EVAL_DIFFUSE_COLOR,
260         SHADER_EVAL_GLOSSY_COLOR,
261         SHADER_EVAL_TRANSMISSION_COLOR,
262         SHADER_EVAL_SUBSURFACE_COLOR,
263         SHADER_EVAL_EMISSION,
264
265         /* light passes */
266         SHADER_EVAL_AO,
267         SHADER_EVAL_COMBINED,
268         SHADER_EVAL_SHADOW,
269         SHADER_EVAL_DIFFUSE,
270         SHADER_EVAL_GLOSSY,
271         SHADER_EVAL_TRANSMISSION,
272         SHADER_EVAL_SUBSURFACE,
273
274         /* extra */
275         SHADER_EVAL_ENVIRONMENT,
276 } ShaderEvalType;
277
278 /* Path Tracing
279  * note we need to keep the u/v pairs at even values */
280
281 enum PathTraceDimension {
282         PRNG_FILTER_U = 0,
283         PRNG_FILTER_V = 1,
284         PRNG_LENS_U = 2,
285         PRNG_LENS_V = 3,
286 #ifdef __CAMERA_MOTION__
287         PRNG_TIME = 4,
288         PRNG_UNUSED_0 = 5,
289         PRNG_UNUSED_1 = 6,      /* for some reason (6, 7) is a bad sobol pattern */
290         PRNG_UNUSED_2 = 7,  /* with a low number of samples (< 64) */
291 #endif
292         PRNG_BASE_NUM = 8,
293
294         PRNG_BSDF_U = 0,
295         PRNG_BSDF_V = 1,
296         PRNG_BSDF = 2,
297         PRNG_LIGHT = 3,
298         PRNG_LIGHT_U = 4,
299         PRNG_LIGHT_V = 5,
300         PRNG_LIGHT_TERMINATE = 6,
301         PRNG_TERMINATE = 7,
302
303 #ifdef __VOLUME__
304         PRNG_PHASE_U = 8,
305         PRNG_PHASE_V = 9,
306         PRNG_PHASE = 10,
307         PRNG_SCATTER_DISTANCE = 11,
308 #endif
309
310         PRNG_BOUNCE_NUM = 12,
311 };
312
313 enum SamplingPattern {
314         SAMPLING_PATTERN_SOBOL = 0,
315         SAMPLING_PATTERN_CMJ = 1,
316
317         SAMPLING_NUM_PATTERNS,
318 };
319
320 /* these flags values correspond to raytypes in osl.cpp, so keep them in sync! */
321
322 enum PathRayFlag {
323         PATH_RAY_CAMERA              = (1 << 0),
324         PATH_RAY_REFLECT             = (1 << 1),
325         PATH_RAY_TRANSMIT            = (1 << 2),
326         PATH_RAY_DIFFUSE             = (1 << 3),
327         PATH_RAY_GLOSSY              = (1 << 4),
328         PATH_RAY_SINGULAR            = (1 << 5),
329         PATH_RAY_TRANSPARENT         = (1 << 6),
330
331         PATH_RAY_SHADOW_OPAQUE       = (1 << 7),
332         PATH_RAY_SHADOW_TRANSPARENT  = (1 << 8),
333         PATH_RAY_SHADOW = (PATH_RAY_SHADOW_OPAQUE|PATH_RAY_SHADOW_TRANSPARENT),
334
335         PATH_RAY_CURVE               = (1 << 9), /* visibility flag to define curve segments */
336         PATH_RAY_VOLUME_SCATTER      = (1 << 10), /* volume scattering */
337
338         /* Special flag to tag unaligned BVH nodes. */
339         PATH_RAY_NODE_UNALIGNED = (1 << 11),
340
341         PATH_RAY_ALL_VISIBILITY = ((1 << 12)-1),
342
343         PATH_RAY_MIS_SKIP            = (1 << 12),
344         PATH_RAY_DIFFUSE_ANCESTOR    = (1 << 13),
345         PATH_RAY_SINGLE_PASS_DONE    = (1 << 14),
346         PATH_RAY_SHADOW_CATCHER      = (1 << 15),
347         PATH_RAY_SHADOW_CATCHER_ONLY = (1 << 16),
348         PATH_RAY_STORE_SHADOW_INFO   = (1 << 17),
349 };
350
351 /* Closure Label */
352
353 typedef enum ClosureLabel {
354         LABEL_NONE = 0,
355         LABEL_TRANSMIT = 1,
356         LABEL_REFLECT = 2,
357         LABEL_DIFFUSE = 4,
358         LABEL_GLOSSY = 8,
359         LABEL_SINGULAR = 16,
360         LABEL_TRANSPARENT = 32,
361         LABEL_VOLUME_SCATTER = 64,
362 } ClosureLabel;
363
364 /* Render Passes */
365
366 typedef enum PassType {
367         PASS_NONE = 0,
368         PASS_COMBINED = (1 << 0),
369         PASS_DEPTH = (1 << 1),
370         PASS_NORMAL = (1 << 2),
371         PASS_UV = (1 << 3),
372         PASS_OBJECT_ID = (1 << 4),
373         PASS_MATERIAL_ID = (1 << 5),
374         PASS_DIFFUSE_COLOR = (1 << 6),
375         PASS_GLOSSY_COLOR = (1 << 7),
376         PASS_TRANSMISSION_COLOR = (1 << 8),
377         PASS_DIFFUSE_INDIRECT = (1 << 9),
378         PASS_GLOSSY_INDIRECT = (1 << 10),
379         PASS_TRANSMISSION_INDIRECT = (1 << 11),
380         PASS_DIFFUSE_DIRECT = (1 << 12),
381         PASS_GLOSSY_DIRECT = (1 << 13),
382         PASS_TRANSMISSION_DIRECT = (1 << 14),
383         PASS_EMISSION = (1 << 15),
384         PASS_BACKGROUND = (1 << 16),
385         PASS_AO = (1 << 17),
386         PASS_SHADOW = (1 << 18),
387         PASS_MOTION = (1 << 19),
388         PASS_MOTION_WEIGHT = (1 << 20),
389         PASS_MIST = (1 << 21),
390         PASS_SUBSURFACE_DIRECT = (1 << 22),
391         PASS_SUBSURFACE_INDIRECT = (1 << 23),
392         PASS_SUBSURFACE_COLOR = (1 << 24),
393         PASS_LIGHT = (1 << 25), /* no real pass, used to force use_light_pass */
394 #ifdef __KERNEL_DEBUG__
395         PASS_BVH_TRAVERSED_NODES = (1 << 26),
396         PASS_BVH_TRAVERSED_INSTANCES = (1 << 27),
397         PASS_BVH_INTERSECTIONS = (1 << 28),
398         PASS_RAY_BOUNCES = (1 << 29),
399 #endif
400 } PassType;
401
402 #define PASS_ALL (~0)
403
404 typedef enum DenoisingPassOffsets {
405         DENOISING_PASS_NORMAL             = 0,
406         DENOISING_PASS_NORMAL_VAR         = 3,
407         DENOISING_PASS_ALBEDO             = 6,
408         DENOISING_PASS_ALBEDO_VAR         = 9,
409         DENOISING_PASS_DEPTH              = 12,
410         DENOISING_PASS_DEPTH_VAR          = 13,
411         DENOISING_PASS_SHADOW_A           = 14,
412         DENOISING_PASS_SHADOW_B           = 17,
413         DENOISING_PASS_COLOR              = 20,
414         DENOISING_PASS_COLOR_VAR          = 23,
415
416         DENOISING_PASS_SIZE_BASE          = 26,
417         DENOISING_PASS_SIZE_CLEAN         = 3,
418 } DenoisingPassOffsets;
419
420 typedef enum BakePassFilter {
421         BAKE_FILTER_NONE = 0,
422         BAKE_FILTER_DIRECT = (1 << 0),
423         BAKE_FILTER_INDIRECT = (1 << 1),
424         BAKE_FILTER_COLOR = (1 << 2),
425         BAKE_FILTER_DIFFUSE = (1 << 3),
426         BAKE_FILTER_GLOSSY = (1 << 4),
427         BAKE_FILTER_TRANSMISSION = (1 << 5),
428         BAKE_FILTER_SUBSURFACE = (1 << 6),
429         BAKE_FILTER_EMISSION = (1 << 7),
430         BAKE_FILTER_AO = (1 << 8),
431 } BakePassFilter;
432
433 typedef enum BakePassFilterCombos {
434         BAKE_FILTER_COMBINED = (
435             BAKE_FILTER_DIRECT |
436             BAKE_FILTER_INDIRECT |
437             BAKE_FILTER_DIFFUSE |
438             BAKE_FILTER_GLOSSY |
439             BAKE_FILTER_TRANSMISSION |
440             BAKE_FILTER_SUBSURFACE |
441             BAKE_FILTER_EMISSION |
442             BAKE_FILTER_AO),
443         BAKE_FILTER_DIFFUSE_DIRECT = (BAKE_FILTER_DIRECT | BAKE_FILTER_DIFFUSE),
444         BAKE_FILTER_GLOSSY_DIRECT = (BAKE_FILTER_DIRECT | BAKE_FILTER_GLOSSY),
445         BAKE_FILTER_TRANSMISSION_DIRECT = (BAKE_FILTER_DIRECT | BAKE_FILTER_TRANSMISSION),
446         BAKE_FILTER_SUBSURFACE_DIRECT = (BAKE_FILTER_DIRECT | BAKE_FILTER_SUBSURFACE),
447         BAKE_FILTER_DIFFUSE_INDIRECT = (BAKE_FILTER_INDIRECT | BAKE_FILTER_DIFFUSE),
448         BAKE_FILTER_GLOSSY_INDIRECT = (BAKE_FILTER_INDIRECT | BAKE_FILTER_GLOSSY),
449         BAKE_FILTER_TRANSMISSION_INDIRECT = (BAKE_FILTER_INDIRECT | BAKE_FILTER_TRANSMISSION),
450         BAKE_FILTER_SUBSURFACE_INDIRECT = (BAKE_FILTER_INDIRECT | BAKE_FILTER_SUBSURFACE),
451 } BakePassFilterCombos;
452
453 typedef enum DenoiseFlag {
454         DENOISING_CLEAN_DIFFUSE_DIR      = (1 << 0),
455         DENOISING_CLEAN_DIFFUSE_IND      = (1 << 1),
456         DENOISING_CLEAN_GLOSSY_DIR       = (1 << 2),
457         DENOISING_CLEAN_GLOSSY_IND       = (1 << 3),
458         DENOISING_CLEAN_TRANSMISSION_DIR = (1 << 4),
459         DENOISING_CLEAN_TRANSMISSION_IND = (1 << 5),
460         DENOISING_CLEAN_SUBSURFACE_DIR   = (1 << 6),
461         DENOISING_CLEAN_SUBSURFACE_IND   = (1 << 7),
462         DENOISING_CLEAN_ALL_PASSES       = (1 << 8)-1,
463 } DenoiseFlag;
464
465 typedef ccl_addr_space struct PathRadiance {
466 #ifdef __PASSES__
467         int use_light_pass;
468 #endif
469
470         float3 emission;
471 #ifdef __PASSES__
472         float3 background;
473         float3 ao;
474
475         float3 indirect;
476         float3 direct_throughput;
477         float3 direct_emission;
478
479         float3 color_diffuse;
480         float3 color_glossy;
481         float3 color_transmission;
482         float3 color_subsurface;
483         float3 color_scatter;
484
485         float3 direct_diffuse;
486         float3 direct_glossy;
487         float3 direct_transmission;
488         float3 direct_subsurface;
489         float3 direct_scatter;
490
491         float3 indirect_diffuse;
492         float3 indirect_glossy;
493         float3 indirect_transmission;
494         float3 indirect_subsurface;
495         float3 indirect_scatter;
496
497         float3 path_diffuse;
498         float3 path_glossy;
499         float3 path_transmission;
500         float3 path_subsurface;
501         float3 path_scatter;
502
503         float4 shadow;
504         float mist;
505 #endif
506
507 #ifdef __SHADOW_TRICKS__
508         /* Total light reachable across the path, ignoring shadow blocked queries. */
509         float3 path_total;
510         /* Total light reachable across the path with shadow blocked queries
511          * applied here.
512          *
513          * Dividing this figure by path_total will give estimate of shadow pass.
514          */
515         float3 path_total_shaded;
516
517         /* Color of the background on which shadow is alpha-overed. */
518         float3 shadow_color;
519 #endif
520
521 #ifdef __DENOISING_FEATURES__
522         float3 denoising_normal;
523         float3 denoising_albedo;
524         float denoising_depth;
525 #endif  /* __DENOISING_FEATURES__ */
526 } PathRadiance;
527
528 typedef struct BsdfEval {
529 #ifdef __PASSES__
530         int use_light_pass;
531 #endif
532
533         float3 diffuse;
534 #ifdef __PASSES__
535         float3 glossy;
536         float3 transmission;
537         float3 transparent;
538         float3 subsurface;
539         float3 scatter;
540 #endif
541 #ifdef __SHADOW_TRICKS__
542         float3 sum_no_mis;
543 #endif
544 } BsdfEval;
545
546 /* Shader Flag */
547
548 typedef enum ShaderFlag {
549         SHADER_SMOOTH_NORMAL = (1 << 31),
550         SHADER_CAST_SHADOW = (1 << 30),
551         SHADER_AREA_LIGHT = (1 << 29),
552         SHADER_USE_MIS = (1 << 28),
553         SHADER_EXCLUDE_DIFFUSE = (1 << 27),
554         SHADER_EXCLUDE_GLOSSY = (1 << 26),
555         SHADER_EXCLUDE_TRANSMIT = (1 << 25),
556         SHADER_EXCLUDE_CAMERA = (1 << 24),
557         SHADER_EXCLUDE_SCATTER = (1 << 23),
558         SHADER_EXCLUDE_ANY = (SHADER_EXCLUDE_DIFFUSE|SHADER_EXCLUDE_GLOSSY|SHADER_EXCLUDE_TRANSMIT|SHADER_EXCLUDE_CAMERA|SHADER_EXCLUDE_SCATTER),
559
560         SHADER_MASK = ~(SHADER_SMOOTH_NORMAL|SHADER_CAST_SHADOW|SHADER_AREA_LIGHT|SHADER_USE_MIS|SHADER_EXCLUDE_ANY)
561 } ShaderFlag;
562
563 /* Light Type */
564
565 typedef enum LightType {
566         LIGHT_POINT,
567         LIGHT_DISTANT,
568         LIGHT_BACKGROUND,
569         LIGHT_AREA,
570         LIGHT_SPOT,
571         LIGHT_TRIANGLE
572 } LightType;
573
574 /* Camera Type */
575
576 enum CameraType {
577         CAMERA_PERSPECTIVE,
578         CAMERA_ORTHOGRAPHIC,
579         CAMERA_PANORAMA
580 };
581
582 /* Panorama Type */
583
584 enum PanoramaType {
585         PANORAMA_EQUIRECTANGULAR = 0,
586         PANORAMA_FISHEYE_EQUIDISTANT = 1,
587         PANORAMA_FISHEYE_EQUISOLID = 2,
588         PANORAMA_MIRRORBALL = 3,
589
590         PANORAMA_NUM_TYPES,
591 };
592
593 /* Differential */
594
595 typedef struct differential3 {
596         float3 dx;
597         float3 dy;
598 } differential3;
599
600 typedef struct differential {
601         float dx;
602         float dy;
603 } differential;
604
605 /* Ray */
606
607 typedef struct Ray {
608 /* TODO(sergey): This is only needed because current AMD
609  * compiler has hard time building the kernel with this
610  * reshuffle. And at the same time reshuffle will cause
611  * less optimal CPU code in certain places.
612  *
613  * We'll get rid of this nasty exception once AMD compiler
614  * is fixed.
615  */
616 #ifndef __KERNEL_OPENCL_AMD__
617         float3 P;               /* origin */
618         float3 D;               /* direction */
619
620         float t;                /* length of the ray */
621         float time;             /* time (for motion blur) */
622 #else
623         float t;                /* length of the ray */
624         float time;             /* time (for motion blur) */
625         float3 P;               /* origin */
626         float3 D;               /* direction */
627 #endif
628
629 #ifdef __RAY_DIFFERENTIALS__
630         differential3 dP;
631         differential3 dD;
632 #endif
633 } Ray;
634
635 /* Intersection */
636
637 typedef struct Intersection {
638         float t, u, v;
639         int prim;
640         int object;
641         int type;
642
643 #ifdef __KERNEL_DEBUG__
644         int num_traversed_nodes;
645         int num_traversed_instances;
646         int num_intersections;
647 #endif
648 } Intersection;
649
650 /* Primitives */
651
652 typedef enum PrimitiveType {
653         PRIMITIVE_NONE            = 0,
654         PRIMITIVE_TRIANGLE        = (1 << 0),
655         PRIMITIVE_MOTION_TRIANGLE = (1 << 1),
656         PRIMITIVE_CURVE           = (1 << 2),
657         PRIMITIVE_MOTION_CURVE    = (1 << 3),
658         /* Lamp primitive is not included below on purpose,
659          * since it is no real traceable primitive.
660          */
661         PRIMITIVE_LAMP            = (1 << 4),
662
663         PRIMITIVE_ALL_TRIANGLE = (PRIMITIVE_TRIANGLE|PRIMITIVE_MOTION_TRIANGLE),
664         PRIMITIVE_ALL_CURVE = (PRIMITIVE_CURVE|PRIMITIVE_MOTION_CURVE),
665         PRIMITIVE_ALL_MOTION = (PRIMITIVE_MOTION_TRIANGLE|PRIMITIVE_MOTION_CURVE),
666         PRIMITIVE_ALL = (PRIMITIVE_ALL_TRIANGLE|PRIMITIVE_ALL_CURVE),
667
668         /* Total number of different traceable primitives.
669          * NOTE: This is an actual value, not a bitflag.
670          */
671         PRIMITIVE_NUM_TOTAL = 4,
672 } PrimitiveType;
673
674 #define PRIMITIVE_PACK_SEGMENT(type, segment) ((segment << PRIMITIVE_NUM_TOTAL) | (type))
675 #define PRIMITIVE_UNPACK_SEGMENT(type) (type >> PRIMITIVE_NUM_TOTAL)
676
677 /* Attributes */
678
679 typedef enum AttributePrimitive {
680         ATTR_PRIM_TRIANGLE = 0,
681         ATTR_PRIM_CURVE,
682         ATTR_PRIM_SUBD,
683
684         ATTR_PRIM_TYPES
685 } AttributePrimitive;
686
687 typedef enum AttributeElement {
688         ATTR_ELEMENT_NONE,
689         ATTR_ELEMENT_OBJECT,
690         ATTR_ELEMENT_MESH,
691         ATTR_ELEMENT_FACE,
692         ATTR_ELEMENT_VERTEX,
693         ATTR_ELEMENT_VERTEX_MOTION,
694         ATTR_ELEMENT_CORNER,
695         ATTR_ELEMENT_CORNER_BYTE,
696         ATTR_ELEMENT_CURVE,
697         ATTR_ELEMENT_CURVE_KEY,
698         ATTR_ELEMENT_CURVE_KEY_MOTION,
699         ATTR_ELEMENT_VOXEL
700 } AttributeElement;
701
702 typedef enum AttributeStandard {
703         ATTR_STD_NONE = 0,
704         ATTR_STD_VERTEX_NORMAL,
705         ATTR_STD_FACE_NORMAL,
706         ATTR_STD_UV,
707         ATTR_STD_UV_TANGENT,
708         ATTR_STD_UV_TANGENT_SIGN,
709         ATTR_STD_GENERATED,
710         ATTR_STD_GENERATED_TRANSFORM,
711         ATTR_STD_POSITION_UNDEFORMED,
712         ATTR_STD_POSITION_UNDISPLACED,
713         ATTR_STD_MOTION_VERTEX_POSITION,
714         ATTR_STD_MOTION_VERTEX_NORMAL,
715         ATTR_STD_PARTICLE,
716         ATTR_STD_CURVE_INTERCEPT,
717         ATTR_STD_PTEX_FACE_ID,
718         ATTR_STD_PTEX_UV,
719         ATTR_STD_VOLUME_DENSITY,
720         ATTR_STD_VOLUME_COLOR,
721         ATTR_STD_VOLUME_FLAME,
722         ATTR_STD_VOLUME_HEAT,
723         ATTR_STD_VOLUME_VELOCITY,
724         ATTR_STD_POINTINESS,
725         ATTR_STD_NUM,
726
727         ATTR_STD_NOT_FOUND = ~0
728 } AttributeStandard;
729
730 typedef enum AttributeFlag {
731         ATTR_FINAL_SIZE = (1 << 0),
732         ATTR_SUBDIVIDED = (1 << 1),
733 } AttributeFlag;
734
735 typedef struct AttributeDescriptor {
736         AttributeElement element;
737         NodeAttributeType type;
738         uint flags; /* see enum AttributeFlag */
739         int offset;
740 } AttributeDescriptor;
741
742 /* Closure data */
743
744 #ifdef __MULTI_CLOSURE__
745 #  ifndef __MAX_CLOSURE__
746 #     define MAX_CLOSURE 64
747 #  else
748 #    define MAX_CLOSURE __MAX_CLOSURE__
749 #  endif
750 #else
751 #  define MAX_CLOSURE 1
752 #endif
753
754 /* This struct is the base class for all closures. The common members are
755  * duplicated in all derived classes since we don't have C++ in the kernel
756  * yet, and because it lets us lay out the members to minimize padding. The
757  * weight member is located at the beginning of the struct for this reason.
758  *
759  * ShaderClosure has a fixed size, and any extra space must be allocated
760  * with closure_alloc_extra().
761  *
762  * We pad the struct to 80 bytes and ensure it is aligned to 16 bytes, which
763  * we assume to be the maximum required alignment for any struct. */
764
765 #define SHADER_CLOSURE_BASE \
766         float3 weight; \
767         ClosureType type; \
768         float sample_weight; \
769         float3 N
770
771 typedef ccl_addr_space struct ccl_align(16) ShaderClosure {
772         SHADER_CLOSURE_BASE;
773
774         float data[10]; /* pad to 80 bytes */
775 } ShaderClosure;
776
777 /* Shader Context
778  *
779  * For OSL we recycle a fixed number of contexts for speed */
780
781 typedef enum ShaderContext {
782         SHADER_CONTEXT_MAIN = 0,
783         SHADER_CONTEXT_INDIRECT = 1,
784         SHADER_CONTEXT_EMISSION = 2,
785         SHADER_CONTEXT_SHADOW = 3,
786         SHADER_CONTEXT_SSS = 4,
787         SHADER_CONTEXT_VOLUME = 5,
788         SHADER_CONTEXT_NUM = 6
789 } ShaderContext;
790
791 /* Shader Data
792  *
793  * Main shader state at a point on the surface or in a volume. All coordinates
794  * are in world space.
795  */
796
797 enum ShaderDataFlag {
798         /* Runtime flags. */
799
800         /* Set when ray hits backside of surface. */
801         SD_BACKFACING      = (1 << 0),
802         /* Shader has emissive closure. */
803         SD_EMISSION        = (1 << 1),
804         /* Shader has BSDF closure. */
805         SD_BSDF            = (1 << 2),
806         /* Shader has non-singular BSDF closure. */
807         SD_BSDF_HAS_EVAL   = (1 << 3),
808         /* Shader has BSSRDF closure. */
809         SD_BSSRDF          = (1 << 4),
810         /* Shader has holdout closure. */
811         SD_HOLDOUT         = (1 << 5),
812         /* Shader has volume absorption closure. */
813         SD_ABSORPTION      = (1 << 6),
814         /* Shader has have volume phase (scatter) closure. */
815         SD_SCATTER         = (1 << 7),
816         /* Shader has AO closure. */
817         SD_AO              = (1 << 8),
818         /* Shader has transparent closure. */
819         SD_TRANSPARENT     = (1 << 9),
820         /* BSDF requires LCG for evaluation. */
821         SD_BSDF_NEEDS_LCG  = (1 << 10),
822
823         SD_CLOSURE_FLAGS = (SD_EMISSION |
824                             SD_BSDF |
825                             SD_BSDF_HAS_EVAL |
826                             SD_BSSRDF |
827                             SD_HOLDOUT |
828                             SD_ABSORPTION |
829                             SD_SCATTER |
830                             SD_AO |
831                             SD_BSDF_NEEDS_LCG),
832
833         /* Shader flags. */
834
835         /* direct light sample */
836         SD_USE_MIS                = (1 << 16),
837         /* Has transparent shadow. */
838         SD_HAS_TRANSPARENT_SHADOW = (1 << 17),
839         /* Has volume shader. */
840         SD_HAS_VOLUME             = (1 << 18),
841         /* Has only volume shader, no surface. */
842         SD_HAS_ONLY_VOLUME        = (1 << 19),
843         /* Has heterogeneous volume. */
844         SD_HETEROGENEOUS_VOLUME   = (1 << 20),
845         /* BSSRDF normal uses bump. */
846         SD_HAS_BSSRDF_BUMP        = (1 << 21),
847         /* Use equiangular volume sampling */
848         SD_VOLUME_EQUIANGULAR     = (1 << 22),
849         /* Use multiple importance volume sampling. */
850         SD_VOLUME_MIS             = (1 << 23),
851         /* Use cubic interpolation for voxels. */
852         SD_VOLUME_CUBIC           = (1 << 24),
853         /* Has data connected to the displacement input. */
854         SD_HAS_BUMP               = (1 << 25),
855         /* Has true displacement. */
856         SD_HAS_DISPLACEMENT       = (1 << 26),
857         /* Has constant emission (value stored in __shader_flag) */
858         SD_HAS_CONSTANT_EMISSION  = (1 << 27),
859
860         SD_SHADER_FLAGS = (SD_USE_MIS |
861                            SD_HAS_TRANSPARENT_SHADOW |
862                            SD_HAS_VOLUME |
863                            SD_HAS_ONLY_VOLUME |
864                            SD_HETEROGENEOUS_VOLUME|
865                            SD_HAS_BSSRDF_BUMP |
866                            SD_VOLUME_EQUIANGULAR |
867                            SD_VOLUME_MIS |
868                            SD_VOLUME_CUBIC |
869                            SD_HAS_BUMP |
870                            SD_HAS_DISPLACEMENT |
871                            SD_HAS_CONSTANT_EMISSION)
872 };
873
874         /* Object flags. */
875 enum ShaderDataObjectFlag {
876         /* Holdout for camera rays. */
877         SD_OBJECT_HOLDOUT_MASK           = (1 << 0),
878         /* Has object motion blur. */
879         SD_OBJECT_MOTION                 = (1 << 1),
880         /* Vertices have transform applied. */
881         SD_OBJECT_TRANSFORM_APPLIED      = (1 << 2),
882         /* Vertices have negative scale applied. */
883         SD_OBJECT_NEGATIVE_SCALE_APPLIED = (1 << 3),
884         /* Object has a volume shader. */
885         SD_OBJECT_HAS_VOLUME             = (1 << 4),
886         /* Object intersects AABB of an object with volume shader. */
887         SD_OBJECT_INTERSECTS_VOLUME      = (1 << 5),
888         /* Has position for motion vertices. */
889         SD_OBJECT_HAS_VERTEX_MOTION      = (1 << 6),
890         /* object is used to catch shadows */
891         SD_OBJECT_SHADOW_CATCHER         = (1 << 7),
892
893         SD_OBJECT_FLAGS = (SD_OBJECT_HOLDOUT_MASK |
894                            SD_OBJECT_MOTION |
895                            SD_OBJECT_TRANSFORM_APPLIED |
896                            SD_OBJECT_NEGATIVE_SCALE_APPLIED |
897                            SD_OBJECT_HAS_VOLUME |
898                            SD_OBJECT_INTERSECTS_VOLUME |
899                            SD_OBJECT_SHADOW_CATCHER)
900 };
901
902 typedef ccl_addr_space struct ShaderData {
903         /* position */
904         float3 P;
905         /* smooth normal for shading */
906         float3 N;
907         /* true geometric normal */
908         float3 Ng;
909         /* view/incoming direction */
910         float3 I;
911         /* shader id */
912         int shader;
913         /* booleans describing shader, see ShaderDataFlag */
914         int flag;
915         /* booleans describing object of the shader, see ShaderDataObjectFlag */
916         int object_flag;
917
918         /* primitive id if there is one, ~0 otherwise */
919         int prim;
920
921         /* combined type and curve segment for hair */
922         int type;
923
924         /* parametric coordinates
925          * - barycentric weights for triangles */
926         float u;
927         float v;
928         /* object id if there is one, ~0 otherwise */
929         int object;
930
931         /* motion blur sample time */
932         float time;
933
934         /* length of the ray being shaded */
935         float ray_length;
936
937 #ifdef __RAY_DIFFERENTIALS__
938         /* differential of P. these are orthogonal to Ng, not N */
939         differential3 dP;
940         /* differential of I */
941         differential3 dI;
942         /* differential of u, v */
943         differential du;
944         differential dv;
945 #endif
946 #ifdef __DPDU__
947         /* differential of P w.r.t. parametric coordinates. note that dPdu is
948          * not readily suitable as a tangent for shading on triangles. */
949         float3 dPdu;
950         float3 dPdv;
951 #endif
952
953 #ifdef __OBJECT_MOTION__
954         /* object <-> world space transformations, cached to avoid
955          * re-interpolating them constantly for shading */
956         Transform ob_tfm;
957         Transform ob_itfm;
958 #endif
959
960         /* Closure data, we store a fixed array of closures */
961         struct ShaderClosure closure[MAX_CLOSURE];
962         int num_closure;
963         int num_closure_extra;
964         float randb_closure;
965         float3 svm_closure_weight;
966
967         /* LCG state for closures that require additional random numbers. */
968         uint lcg_state;
969
970         /* ray start position, only set for backgrounds */
971         float3 ray_P;
972         differential3 ray_dP;
973
974 #ifdef __OSL__
975         struct KernelGlobals *osl_globals;
976         struct PathState *osl_path_state;
977 #endif
978 } ShaderData;
979
980 /* Path State */
981
982 #ifdef __VOLUME__
983 typedef struct VolumeStack {
984         int object;
985         int shader;
986 } VolumeStack;
987 #endif
988
989 typedef struct PathState {
990         /* see enum PathRayFlag */
991         int flag;
992
993         /* random number generator state */
994         int rng_offset;                 /* dimension offset */
995         int sample;                     /* path sample number */
996         int num_samples;                /* total number of times this path will be sampled */
997
998         /* bounce counting */
999         int bounce;
1000         int diffuse_bounce;
1001         int glossy_bounce;
1002         int transmission_bounce;
1003         int transparent_bounce;
1004
1005 #ifdef __DENOISING_FEATURES__
1006         float denoising_feature_weight;
1007 #endif  /* __DENOISING_FEATURES__ */
1008
1009         /* multiple importance sampling */
1010         float min_ray_pdf; /* smallest bounce pdf over entire path up to now */
1011         float ray_pdf;     /* last bounce pdf */
1012 #ifdef __LAMP_MIS__
1013         float ray_t;       /* accumulated distance through transparent surfaces */
1014 #endif
1015
1016         /* volume rendering */
1017 #ifdef __VOLUME__
1018         int volume_bounce;
1019         RNG rng_congruential;
1020         VolumeStack volume_stack[VOLUME_STACK_SIZE];
1021 #endif
1022
1023 #ifdef __SHADOW_TRICKS__
1024         int catcher_object;
1025 #endif
1026 } PathState;
1027
1028 /* Subsurface */
1029
1030 /* Struct to gather multiple SSS hits. */
1031 typedef struct SubsurfaceIntersection
1032 {
1033         Ray ray;
1034         float3 weight[BSSRDF_MAX_HITS];
1035
1036         int num_hits;
1037         struct Intersection hits[BSSRDF_MAX_HITS];
1038         float3 Ng[BSSRDF_MAX_HITS];
1039 } SubsurfaceIntersection;
1040
1041 /* Struct to gather SSS indirect rays and delay tracing them. */
1042 typedef struct SubsurfaceIndirectRays
1043 {
1044         bool need_update_volume_stack;
1045         bool tracing;
1046         PathState state[BSSRDF_MAX_HITS];
1047         struct PathRadiance direct_L;
1048
1049         int num_rays;
1050         struct Ray rays[BSSRDF_MAX_HITS];
1051         float3 throughputs[BSSRDF_MAX_HITS];
1052         struct PathRadiance L[BSSRDF_MAX_HITS];
1053 } SubsurfaceIndirectRays;
1054
1055 /* Constant Kernel Data
1056  *
1057  * These structs are passed from CPU to various devices, and the struct layout
1058  * must match exactly. Structs are padded to ensure 16 byte alignment, and we
1059  * do not use float3 because its size may not be the same on all devices. */
1060
1061 typedef struct KernelCamera {
1062         /* type */
1063         int type;
1064
1065         /* panorama */
1066         int panorama_type;
1067         float fisheye_fov;
1068         float fisheye_lens;
1069         float4 equirectangular_range;
1070
1071         /* stereo */
1072         float interocular_offset;
1073         float convergence_distance;
1074         float pole_merge_angle_from;
1075         float pole_merge_angle_to;
1076
1077         /* matrices */
1078         Transform cameratoworld;
1079         Transform rastertocamera;
1080
1081         /* differentials */
1082         float4 dx;
1083         float4 dy;
1084
1085         /* depth of field */
1086         float aperturesize;
1087         float blades;
1088         float bladesrotation;
1089         float focaldistance;
1090
1091         /* motion blur */
1092         float shuttertime;
1093         int have_motion, have_perspective_motion;
1094
1095         /* clipping */
1096         float nearclip;
1097         float cliplength;
1098
1099         /* sensor size */
1100         float sensorwidth;
1101         float sensorheight;
1102
1103         /* render size */
1104         float width, height;
1105         int resolution;
1106
1107         /* anamorphic lens bokeh */
1108         float inv_aperture_ratio;
1109
1110         int is_inside_volume;
1111
1112         /* more matrices */
1113         Transform screentoworld;
1114         Transform rastertoworld;
1115         /* work around cuda sm 2.0 crash, this seems to
1116          * cross some limit in combination with motion 
1117          * Transform ndctoworld; */
1118         Transform worldtoscreen;
1119         Transform worldtoraster;
1120         Transform worldtondc;
1121         Transform worldtocamera;
1122
1123         MotionTransform motion;
1124
1125         /* Denotes changes in the projective matrix, namely in rastertocamera.
1126          * Used for camera zoom motion blur,
1127          */
1128         PerspectiveMotionTransform perspective_motion;
1129
1130         int shutter_table_offset;
1131
1132         /* Rolling shutter */
1133         int rolling_shutter_type;
1134         float rolling_shutter_duration;
1135
1136         int pad;
1137 } KernelCamera;
1138 static_assert_align(KernelCamera, 16);
1139
1140 typedef struct KernelFilm {
1141         float exposure;
1142         int pass_flag;
1143         int pass_stride;
1144         int use_light_pass;
1145
1146         int pass_combined;
1147         int pass_depth;
1148         int pass_normal;
1149         int pass_motion;
1150
1151         int pass_motion_weight;
1152         int pass_uv;
1153         int pass_object_id;
1154         int pass_material_id;
1155
1156         int pass_diffuse_color;
1157         int pass_glossy_color;
1158         int pass_transmission_color;
1159         int pass_subsurface_color;
1160         
1161         int pass_diffuse_indirect;
1162         int pass_glossy_indirect;
1163         int pass_transmission_indirect;
1164         int pass_subsurface_indirect;
1165         
1166         int pass_diffuse_direct;
1167         int pass_glossy_direct;
1168         int pass_transmission_direct;
1169         int pass_subsurface_direct;
1170         
1171         int pass_emission;
1172         int pass_background;
1173         int pass_ao;
1174         float pass_alpha_threshold;
1175
1176         int pass_shadow;
1177         float pass_shadow_scale;
1178         int filter_table_offset;
1179         int pass_pad2;
1180
1181         int pass_mist;
1182         float mist_start;
1183         float mist_inv_depth;
1184         float mist_falloff;
1185
1186         int pass_denoising_data;
1187         int pass_denoising_clean;
1188         int denoising_flags;
1189         int pad;
1190
1191 #ifdef __KERNEL_DEBUG__
1192         int pass_bvh_traversed_nodes;
1193         int pass_bvh_traversed_instances;
1194         int pass_bvh_intersections;
1195         int pass_ray_bounces;
1196 #endif
1197 } KernelFilm;
1198 static_assert_align(KernelFilm, 16);
1199
1200 typedef struct KernelBackground {
1201         /* only shader index */
1202         int surface_shader;
1203         int volume_shader;
1204         int transparent;
1205         int pad;
1206
1207         /* ambient occlusion */
1208         float ao_factor;
1209         float ao_distance;
1210         float ao_pad1, ao_pad2;
1211 } KernelBackground;
1212 static_assert_align(KernelBackground, 16);
1213
1214 typedef struct KernelIntegrator {
1215         /* emission */
1216         int use_direct_light;
1217         int use_ambient_occlusion;
1218         int num_distribution;
1219         int num_all_lights;
1220         float pdf_triangles;
1221         float pdf_lights;
1222         float inv_pdf_lights;
1223         int pdf_background_res;
1224
1225         /* light portals */
1226         float portal_pdf;
1227         int num_portals;
1228         int portal_offset;
1229
1230         /* bounces */
1231         int min_bounce;
1232         int max_bounce;
1233
1234         int max_diffuse_bounce;
1235         int max_glossy_bounce;
1236         int max_transmission_bounce;
1237         int max_volume_bounce;
1238
1239         int ao_bounces;
1240
1241         /* transparent */
1242         int transparent_min_bounce;
1243         int transparent_max_bounce;
1244         int transparent_shadows;
1245
1246         /* caustics */
1247         int caustics_reflective;
1248         int caustics_refractive;
1249         float filter_glossy;
1250
1251         /* seed */
1252         int seed;
1253
1254         /* clamp */
1255         float sample_clamp_direct;
1256         float sample_clamp_indirect;
1257
1258         /* branched path */
1259         int branched;
1260         int diffuse_samples;
1261         int glossy_samples;
1262         int transmission_samples;
1263         int ao_samples;
1264         int mesh_light_samples;
1265         int subsurface_samples;
1266         int sample_all_lights_direct;
1267         int sample_all_lights_indirect;
1268
1269         /* mis */
1270         int use_lamp_mis;
1271
1272         /* sampler */
1273         int sampling_pattern;
1274         int aa_samples;
1275
1276         /* volume render */
1277         int use_volumes;
1278         int volume_max_steps;
1279         float volume_step_size;
1280         int volume_samples;
1281
1282         float light_inv_rr_threshold;
1283
1284         int start_sample;
1285         int pad1, pad2, pad3;
1286 } KernelIntegrator;
1287 static_assert_align(KernelIntegrator, 16);
1288
1289 typedef struct KernelBVH {
1290         /* root node */
1291         int root;
1292         int attributes_map_stride;
1293         int have_motion;
1294         int have_curves;
1295         int have_instancing;
1296         int use_qbvh;
1297         int use_bvh_steps;
1298         int pad1;
1299 } KernelBVH;
1300 static_assert_align(KernelBVH, 16);
1301
1302 typedef enum CurveFlag {
1303         /* runtime flags */
1304         CURVE_KN_BACKFACING = 1,                                /* backside of cylinder? */
1305         CURVE_KN_ENCLOSEFILTER = 2,                             /* don't consider strands surrounding start point? */
1306         CURVE_KN_INTERPOLATE = 4,                               /* render as a curve? */
1307         CURVE_KN_ACCURATE = 8,                                  /* use accurate intersections test? */
1308         CURVE_KN_INTERSECTCORRECTION = 16,              /* correct for width after determing closest midpoint? */
1309         CURVE_KN_TRUETANGENTGNORMAL = 32,               /* use tangent normal for geometry? */
1310         CURVE_KN_RIBBONS = 64,                                  /* use flat curve ribbons */
1311 } CurveFlag;
1312
1313 typedef struct KernelCurves {
1314         int curveflags;
1315         int subdivisions;
1316
1317         float minimum_width;
1318         float maximum_width;
1319 } KernelCurves;
1320 static_assert_align(KernelCurves, 16);
1321
1322 typedef struct KernelTables {
1323         int beckmann_offset;
1324         int pad1, pad2, pad3;
1325 } KernelTables;
1326 static_assert_align(KernelTables, 16);
1327
1328 typedef struct KernelData {
1329         KernelCamera cam;
1330         KernelFilm film;
1331         KernelBackground background;
1332         KernelIntegrator integrator;
1333         KernelBVH bvh;
1334         KernelCurves curve;
1335         KernelTables tables;
1336 } KernelData;
1337 static_assert_align(KernelData, 16);
1338
1339 #ifdef __KERNEL_DEBUG__
1340 /* NOTE: This is a runtime-only struct, alignment is not
1341  * really important here.
1342  */
1343 typedef ccl_addr_space struct DebugData {
1344         int num_bvh_traversed_nodes;
1345         int num_bvh_traversed_instances;
1346         int num_bvh_intersections;
1347         int num_ray_bounces;
1348 } DebugData;
1349 #endif
1350
1351 /* Declarations required for split kernel */
1352
1353 /* Macro for queues */
1354 /* Value marking queue's empty slot */
1355 #define QUEUE_EMPTY_SLOT -1
1356
1357 /*
1358  * Queue 1 - Active rays
1359  * Queue 2 - Background queue
1360  * Queue 3 - Shadow ray cast kernel - AO
1361  * Queeu 4 - Shadow ray cast kernel - direct lighting
1362  */
1363
1364 /* Queue names */
1365 enum QueueNumber {
1366         /* All active rays and regenerated rays are enqueued here. */
1367         QUEUE_ACTIVE_AND_REGENERATED_RAYS = 0,
1368
1369         /* All
1370          * 1. Background-hit rays,
1371          * 2. Rays that has exited path-iteration but needs to update output buffer
1372          * 3. Rays to be regenerated
1373          * are enqueued here.
1374          */
1375         QUEUE_HITBG_BUFF_UPDATE_TOREGEN_RAYS,
1376
1377         /* All rays for which a shadow ray should be cast to determine radiance
1378          * contribution for AO are enqueued here.
1379          */
1380         QUEUE_SHADOW_RAY_CAST_AO_RAYS,
1381
1382         /* All rays for which a shadow ray should be cast to determine radiance
1383          * contributing for direct lighting are enqueued here.
1384          */
1385         QUEUE_SHADOW_RAY_CAST_DL_RAYS,
1386
1387         /* Rays sorted according to shader->id */
1388         QUEUE_SHADER_SORTED_RAYS,
1389
1390 #ifdef __BRANCHED_PATH__
1391         /* All rays moving to next iteration of the indirect loop for light */
1392         QUEUE_LIGHT_INDIRECT_ITER,
1393         /* Queue of all inactive rays. These are candidates for sharing work of indirect loops */
1394         QUEUE_INACTIVE_RAYS,
1395 #  ifdef __VOLUME__
1396         /* All rays moving to next iteration of the indirect loop for volumes */
1397         QUEUE_VOLUME_INDIRECT_ITER,
1398 #  endif
1399 #  ifdef __SUBSURFACE__
1400         /* All rays moving to next iteration of the indirect loop for subsurface */
1401         QUEUE_SUBSURFACE_INDIRECT_ITER,
1402 #  endif
1403 #endif  /* __BRANCHED_PATH__ */
1404
1405         NUM_QUEUES
1406 };
1407
1408 /* We use RAY_STATE_MASK to get ray_state */
1409 #define RAY_STATE_MASK 0x0F
1410 #define RAY_FLAG_MASK 0xF0
1411 enum RayState {
1412         RAY_INVALID = 0,
1413         /* Denotes ray is actively involved in path-iteration. */
1414         RAY_ACTIVE,
1415         /* Denotes ray has completed processing all samples and is inactive. */
1416         RAY_INACTIVE,
1417         /* Denoted ray has exited path-iteration and needs to update output buffer. */
1418         RAY_UPDATE_BUFFER,
1419         /* Donotes ray has hit background */
1420         RAY_HIT_BACKGROUND,
1421         /* Denotes ray has to be regenerated */
1422         RAY_TO_REGENERATE,
1423         /* Denotes ray has been regenerated */
1424         RAY_REGENERATED,
1425         /* Denotes ray is moving to next iteration of the branched indirect loop */
1426         RAY_LIGHT_INDIRECT_NEXT_ITER,
1427         RAY_VOLUME_INDIRECT_NEXT_ITER,
1428         RAY_SUBSURFACE_INDIRECT_NEXT_ITER,
1429
1430         /* Ray flags */
1431
1432         /* Flags to denote that the ray is currently evaluating the branched indirect loop */
1433         RAY_BRANCHED_LIGHT_INDIRECT = (1 << 4),
1434         RAY_BRANCHED_VOLUME_INDIRECT = (1 << 5),
1435         RAY_BRANCHED_SUBSURFACE_INDIRECT = (1 << 6),
1436         RAY_BRANCHED_INDIRECT = (RAY_BRANCHED_LIGHT_INDIRECT | RAY_BRANCHED_VOLUME_INDIRECT | RAY_BRANCHED_SUBSURFACE_INDIRECT),
1437
1438         /* Ray is evaluating an iteration of an indirect loop for another thread */
1439         RAY_BRANCHED_INDIRECT_SHARED = (1 << 7),
1440 };
1441
1442 #define ASSIGN_RAY_STATE(ray_state, ray_index, state) (ray_state[ray_index] = ((ray_state[ray_index] & RAY_FLAG_MASK) | state))
1443 #define IS_STATE(ray_state, ray_index, state) ((ray_index) != QUEUE_EMPTY_SLOT && ((ray_state)[(ray_index)] & RAY_STATE_MASK) == (state))
1444 #define ADD_RAY_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] = (ray_state[ray_index] | flag))
1445 #define REMOVE_RAY_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] = (ray_state[ray_index] & (~flag)))
1446 #define IS_FLAG(ray_state, ray_index, flag) (ray_state[ray_index] & flag)
1447
1448 /* Patches */
1449
1450 #define PATCH_MAX_CONTROL_VERTS 16
1451
1452 /* Patch map node flags */
1453
1454 #define PATCH_MAP_NODE_IS_SET (1 << 30)
1455 #define PATCH_MAP_NODE_IS_LEAF (1u << 31)
1456 #define PATCH_MAP_NODE_INDEX_MASK (~(PATCH_MAP_NODE_IS_SET | PATCH_MAP_NODE_IS_LEAF))
1457
1458 CCL_NAMESPACE_END
1459
1460 #endif /*  __KERNEL_TYPES_H__ */
1461