9c126074e837dac2a559bc7bdf6296a3cd2bb9d4
[blender.git] / intern / cycles / kernel / kernel_types.h
1 /*
2  * Copyright 2011, Blender Foundation.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  */
18
19 #ifndef __KERNEL_TYPES_H__
20 #define __KERNEL_TYPES_H__
21
22 #include "kernel_math.h"
23 #include "svm/svm_types.h"
24
25 #ifndef __KERNEL_GPU__
26 #define __KERNEL_CPU__
27 #endif
28
29 CCL_NAMESPACE_BEGIN
30
31 /* constants */
32 #define OBJECT_SIZE             11
33 #define OBJECT_VECTOR_SIZE      6
34 #define LIGHT_SIZE                      4
35 #define FILTER_TABLE_SIZE       256
36 #define RAMP_TABLE_SIZE         256
37 #define PARTICLE_SIZE           5
38 #define TIME_INVALID            FLT_MAX
39
40 #define BSSRDF_RADIUS_TABLE_SIZE        1024
41 #define BSSRDF_REFL_TABLE_SIZE          256
42 #define BSSRDF_PDF_TABLE_OFFSET         (BSSRDF_RADIUS_TABLE_SIZE*BSSRDF_REFL_TABLE_SIZE)
43 #define BSSRDF_LOOKUP_TABLE_SIZE        (BSSRDF_RADIUS_TABLE_SIZE*BSSRDF_REFL_TABLE_SIZE*2)
44 #define BSSRDF_MIN_RADIUS                       1e-8f
45 #define BSSRDF_MAX_ATTEMPTS                     8
46
47 #define TEX_NUM_FLOAT_IMAGES    5
48
49 /* device capabilities */
50 #ifdef __KERNEL_CPU__
51 #define __KERNEL_SHADING__
52 #define __KERNEL_ADV_SHADING__
53 #define __NON_PROGRESSIVE__
54 #define __HAIR__
55 #ifdef WITH_OSL
56 #define __OSL__
57 #endif
58 #define __SUBSURFACE__
59 #endif
60
61 #ifdef __KERNEL_CUDA__
62 #define __KERNEL_SHADING__
63 #if __CUDA_ARCH__ >= 200
64 #define __KERNEL_ADV_SHADING__
65 #endif
66 #endif
67
68 #ifdef __KERNEL_OPENCL__
69
70 #ifdef __KERNEL_OPENCL_NVIDIA__
71 #define __KERNEL_SHADING__
72 #define __MULTI_CLOSURE__
73 #endif
74
75 #ifdef __KERNEL_OPENCL_APPLE__
76 //#define __SVM__
77 //#define __EMISSION__
78 //#define __IMAGE_TEXTURES__
79 //#define __HOLDOUT__
80 //#define __PROCEDURAL_TEXTURES__
81 //#define __EXTRA_NODES__
82 #endif
83
84 #ifdef __KERNEL_OPENCL_AMD__
85 #define __SVM__
86 #define __EMISSION__
87 #define __IMAGE_TEXTURES__
88 #define __HOLDOUT__
89 #define __PROCEDURAL_TEXTURES__
90 #define __EXTRA_NODES__
91 #endif
92
93 #endif
94
95 /* kernel features */
96 #define __SOBOL__
97 #define __INSTANCING__
98 #define __DPDU__
99 #define __UV__
100 #define __BACKGROUND__
101 #define __CAUSTICS_TRICKS__
102 #define __VISIBILITY_FLAG__
103 #define __RAY_DIFFERENTIALS__
104 #define __CAMERA_CLIPPING__
105 #define __INTERSECTION_REFINE__
106 #define __CLAMP_SAMPLE__
107
108 #ifdef __KERNEL_SHADING__
109 #define __SVM__
110 #define __EMISSION__
111 #define __PROCEDURAL_TEXTURES__
112 #define __IMAGE_TEXTURES__
113 #define __EXTRA_NODES__
114 #define __HOLDOUT__
115 #define __NORMAL_MAP__
116 #endif
117
118 #ifdef __KERNEL_ADV_SHADING__
119 #define __MULTI_CLOSURE__
120 #define __TRANSPARENT_SHADOWS__
121 #define __PASSES__
122 #define __BACKGROUND_MIS__
123 #define __LAMP_MIS__
124 #define __AO__
125 #define __ANISOTROPIC__
126 #define __CAMERA_MOTION__
127 #define __OBJECT_MOTION__
128 #endif
129 //#define __SOBOL_FULL_SCREEN__
130
131 /* Shader Evaluation */
132
133 enum ShaderEvalType {
134         SHADER_EVAL_DISPLACE,
135         SHADER_EVAL_BACKGROUND
136 };
137
138 /* Path Tracing
139  * note we need to keep the u/v pairs at even values */
140
141 enum PathTraceDimension {
142         PRNG_FILTER_U = 0,
143         PRNG_FILTER_V = 1,
144         PRNG_LENS_U = 2,
145         PRNG_LENS_V = 3,
146 #ifdef __CAMERA_MOTION__
147         PRNG_TIME = 4,
148         PRNG_UNUSED = 5,
149         PRNG_BASE_NUM = 6,
150 #else
151         PRNG_BASE_NUM = 4,
152 #endif
153
154         PRNG_BSDF_U = 0,
155         PRNG_BSDF_V = 1,
156         PRNG_BSDF = 2,
157         PRNG_LIGHT = 3,
158         PRNG_LIGHT_U = 4,
159         PRNG_LIGHT_V = 5,
160         PRNG_LIGHT_F = 6,
161         PRNG_TERMINATE = 7,
162         PRNG_BOUNCE_NUM = 8
163 };
164
165 /* these flags values correspond to raytypes in osl.cpp, so keep them in sync!
166  *
167  * for ray visibility tests in BVH traversal, the upper 20 bits are used for
168  * layer visibility tests. */
169
170 enum PathRayFlag {
171         PATH_RAY_CAMERA = 1,
172         PATH_RAY_REFLECT = 2,
173         PATH_RAY_TRANSMIT = 4,
174         PATH_RAY_DIFFUSE = 8,
175         PATH_RAY_GLOSSY = 16,
176         PATH_RAY_SINGULAR = 32,
177         PATH_RAY_TRANSPARENT = 64,
178
179         PATH_RAY_SHADOW_OPAQUE = 128,
180         PATH_RAY_SHADOW_TRANSPARENT = 256,
181         PATH_RAY_SHADOW = (PATH_RAY_SHADOW_OPAQUE|PATH_RAY_SHADOW_TRANSPARENT),
182
183         PATH_RAY_MIS_SKIP = 512,
184
185         PATH_RAY_ALL = (1|2|4|8|16|32|64|128|256|512),
186
187         /* this gives collisions with localview bits
188          * see: CYCLES_LOCAL_LAYER_HACK(), grr - Campbell */
189         PATH_RAY_LAYER_SHIFT = (32-20)
190 };
191
192 /* Closure Label */
193
194 typedef enum ClosureLabel {
195         LABEL_NONE = 0,
196         LABEL_CAMERA = 1,
197         LABEL_LIGHT = 2,
198         LABEL_BACKGROUND = 4,
199         LABEL_TRANSMIT = 8,
200         LABEL_REFLECT = 16,
201         LABEL_VOLUME = 32,
202         LABEL_OBJECT = 64,
203         LABEL_DIFFUSE = 128,
204         LABEL_GLOSSY = 256,
205         LABEL_SINGULAR = 512,
206         LABEL_TRANSPARENT = 1024,
207         LABEL_STOP = 2048
208 } ClosureLabel;
209
210 /* Render Passes */
211
212 typedef enum PassType {
213         PASS_NONE = 0,
214         PASS_COMBINED = 1,
215         PASS_DEPTH = 2,
216         PASS_NORMAL = 4,
217         PASS_UV = 8,
218         PASS_OBJECT_ID = 16,
219         PASS_MATERIAL_ID = 32,
220         PASS_DIFFUSE_COLOR = 64,
221         PASS_GLOSSY_COLOR = 128,
222         PASS_TRANSMISSION_COLOR = 256,
223         PASS_DIFFUSE_INDIRECT = 512,
224         PASS_GLOSSY_INDIRECT = 1024,
225         PASS_TRANSMISSION_INDIRECT = 2048,
226         PASS_DIFFUSE_DIRECT = 4096,
227         PASS_GLOSSY_DIRECT = 8192,
228         PASS_TRANSMISSION_DIRECT = 16384,
229         PASS_EMISSION = 32768,
230         PASS_BACKGROUND = 65536,
231         PASS_AO = 131072,
232         PASS_SHADOW = 262144,
233         PASS_MOTION = 524288,
234         PASS_MOTION_WEIGHT = 1048576
235 } PassType;
236
237 #define PASS_ALL (~0)
238
239 #ifdef __PASSES__
240
241 typedef float3 PathThroughput;
242
243 typedef struct PathRadiance {
244         int use_light_pass;
245
246         float3 emission;
247         float3 background;
248         float3 ao;
249
250         float3 indirect;
251         float3 direct_throughput;
252         float3 direct_emission;
253
254         float3 color_diffuse;
255         float3 color_glossy;
256         float3 color_transmission;
257
258         float3 direct_diffuse;
259         float3 direct_glossy;
260         float3 direct_transmission;
261
262         float3 indirect_diffuse;
263         float3 indirect_glossy;
264         float3 indirect_transmission;
265
266         float3 path_diffuse;
267         float3 path_glossy;
268         float3 path_transmission;
269
270         float4 shadow;
271 } PathRadiance;
272
273 typedef struct BsdfEval {
274         int use_light_pass;
275
276         float3 diffuse;
277         float3 glossy;
278         float3 transmission;
279         float3 transparent;
280 } BsdfEval;
281
282 #else
283
284 typedef float3 PathThroughput;
285 typedef float3 PathRadiance;
286 typedef float3 BsdfEval;
287
288 #endif
289
290 /* Shader Flag */
291
292 typedef enum ShaderFlag {
293         SHADER_SMOOTH_NORMAL = (1 << 31),
294         SHADER_CAST_SHADOW = (1 << 30),
295         SHADER_AREA_LIGHT = (1 << 29),
296         SHADER_USE_MIS = (1 << 28),
297
298         SHADER_MASK = ~(SHADER_SMOOTH_NORMAL|SHADER_CAST_SHADOW|SHADER_AREA_LIGHT|SHADER_USE_MIS)
299 } ShaderFlag;
300
301 /* Light Type */
302
303 typedef enum LightType {
304         LIGHT_POINT,
305         LIGHT_DISTANT,
306         LIGHT_BACKGROUND,
307         LIGHT_AREA,
308         LIGHT_AO,
309         LIGHT_SPOT,
310         LIGHT_TRIANGLE,
311         LIGHT_STRAND
312 } LightType;
313
314 /* Camera Type */
315
316 enum CameraType {
317         CAMERA_PERSPECTIVE,
318         CAMERA_ORTHOGRAPHIC,
319         CAMERA_PANORAMA
320 };
321
322 /* Panorama Type */
323
324 enum PanoramaType {
325         PANORAMA_EQUIRECTANGULAR,
326         PANORAMA_FISHEYE_EQUIDISTANT,
327         PANORAMA_FISHEYE_EQUISOLID
328 };
329
330 /* Differential */
331
332 typedef struct differential3 {
333         float3 dx;
334         float3 dy;
335 } differential3;
336
337 typedef struct differential {
338         float dx;
339         float dy;
340 } differential;
341
342 /* Ray */
343
344 typedef struct Ray {
345         float3 P;
346         float3 D;
347         float t;
348         float time;
349
350 #ifdef __RAY_DIFFERENTIALS__
351         differential3 dP;
352         differential3 dD;
353 #endif
354 } Ray;
355
356 /* Intersection */
357
358 typedef struct Intersection {
359         float t, u, v;
360         int prim;
361         int object;
362         int segment;
363 } Intersection;
364
365 /* Attributes */
366
367 #define ATTR_PRIM_TYPES         2
368 #define ATTR_PRIM_CURVE         1
369
370 typedef enum AttributeElement {
371         ATTR_ELEMENT_NONE,
372         ATTR_ELEMENT_VALUE,
373         ATTR_ELEMENT_FACE,
374         ATTR_ELEMENT_VERTEX,
375         ATTR_ELEMENT_CORNER,
376         ATTR_ELEMENT_CURVE,
377         ATTR_ELEMENT_CURVE_KEY
378 } AttributeElement;
379
380 typedef enum AttributeStandard {
381         ATTR_STD_NONE = 0,
382         ATTR_STD_VERTEX_NORMAL,
383         ATTR_STD_FACE_NORMAL,
384         ATTR_STD_UV,
385         ATTR_STD_UV_TANGENT,
386         ATTR_STD_UV_TANGENT_SIGN,
387         ATTR_STD_GENERATED,
388         ATTR_STD_POSITION_UNDEFORMED,
389         ATTR_STD_POSITION_UNDISPLACED,
390         ATTR_STD_MOTION_PRE,
391         ATTR_STD_MOTION_POST,
392         ATTR_STD_PARTICLE,
393         ATTR_STD_CURVE_TANGENT,
394         ATTR_STD_CURVE_INTERCEPT,
395         ATTR_STD_NUM,
396
397         ATTR_STD_NOT_FOUND = ~0
398 } AttributeStandard;
399
400 /* Closure data */
401
402 #define MAX_CLOSURE 16
403
404 typedef struct ShaderClosure {
405         ClosureType type;
406         float3 weight;
407
408 #ifdef __MULTI_CLOSURE__
409         float sample_weight;
410 #endif
411
412         float data0;
413         float data1;
414
415         float3 N;
416 #ifdef __ANISOTROPIC__
417         float3 T;
418 #endif
419
420 #ifdef __OSL__
421         void *prim;
422 #endif
423 } ShaderClosure;
424
425 /* Shader Context
426  *
427  * For OSL we recycle a fixed number of contexts for speed */
428
429 typedef enum ShaderContext {
430         SHADER_CONTEXT_MAIN = 0,
431         SHADER_CONTEXT_INDIRECT = 1,
432         SHADER_CONTEXT_EMISSION = 2,
433         SHADER_CONTEXT_SHADOW = 3,
434         SHADER_CONTEXT_SSS = 4,
435         SHADER_CONTEXT_NUM = 5
436 } ShaderContext;
437
438 /* Shader Data
439  *
440  * Main shader state at a point on the surface or in a volume. All coordinates
441  * are in world space. */
442
443 enum ShaderDataFlag {
444         /* runtime flags */
445         SD_BACKFACING = 1,              /* backside of surface? */
446         SD_EMISSION = 2,                /* have emissive closure? */
447         SD_BSDF = 4,                    /* have bsdf closure? */
448         SD_BSDF_HAS_EVAL = 8,   /* have non-singular bsdf closure? */
449         SD_BSDF_GLOSSY = 16,    /* have glossy bsdf */
450         SD_BSSRDF = 32,                 /* have bssrdf */
451         SD_HOLDOUT = 64,                /* have holdout closure? */
452         SD_VOLUME = 128,                /* have volume closure? */
453         SD_AO = 256,                    /* have ao closure? */
454
455         /* shader flags */
456         SD_SAMPLE_AS_LIGHT = 512,                       /* direct light sample */
457         SD_HAS_SURFACE_TRANSPARENT = 1024,      /* has surface transparency */
458         SD_HAS_VOLUME = 2048,                           /* has volume shader */
459         SD_HOMOGENEOUS_VOLUME = 4096,           /* has homogeneous volume */
460
461         /* object flags */
462         SD_HOLDOUT_MASK = 8192,                         /* holdout for camera rays */
463         SD_OBJECT_MOTION = 16384,                       /* has object motion blur */
464         SD_TRANSFORM_APPLIED = 32768            /* vertices have transform applied */
465 };
466
467 typedef struct ShaderData {
468         /* position */
469         float3 P;
470         /* smooth normal for shading */
471         float3 N;
472         /* true geometric normal */
473         float3 Ng;
474         /* view/incoming direction */
475         float3 I;
476         /* shader id */
477         int shader;
478         /* booleans describing shader, see ShaderDataFlag */
479         int flag;
480
481         /* primitive id if there is one, ~0 otherwise */
482         int prim;
483
484 #ifdef __HAIR__
485         /* for curves, segment number in curve, ~0 for triangles */
486         int segment;
487 #endif
488         /* parametric coordinates
489          * - barycentric weights for triangles */
490         float u, v;
491         /* object id if there is one, ~0 otherwise */
492         int object;
493
494         /* motion blur sample time */
495         float time;
496         
497         /* length of the ray being shaded */
498         float ray_length;
499
500 #ifdef __RAY_DIFFERENTIALS__
501         /* differential of P. these are orthogonal to Ng, not N */
502         differential3 dP;
503         /* differential of I */
504         differential3 dI;
505         /* differential of u, v */
506         differential du;
507         differential dv;
508 #endif
509 #ifdef __DPDU__
510         /* differential of P w.r.t. parametric coordinates. note that dPdu is
511          * not readily suitable as a tangent for shading on triangles. */
512         float3 dPdu, dPdv;
513 #endif
514
515 #ifdef __OBJECT_MOTION__
516         /* object <-> world space transformations, cached to avoid
517          * re-interpolating them constantly for shading */
518         Transform ob_tfm;
519         Transform ob_itfm;
520 #endif
521
522 #ifdef __MULTI_CLOSURE__
523         /* Closure data, we store a fixed array of closures */
524         ShaderClosure closure[MAX_CLOSURE];
525         int num_closure;
526         float randb_closure;
527 #else
528         /* Closure data, with a single sampled closure for low memory usage */
529         ShaderClosure closure;
530 #endif
531 } ShaderData;
532
533 /* Constrant Kernel Data
534  *
535  * These structs are passed from CPU to various devices, and the struct layout
536  * must match exactly. Structs are padded to ensure 16 byte alignment, and we
537  * do not use float3 because its size may not be the same on all devices. */
538
539 typedef struct KernelCamera {
540         /* type */
541         int type;
542
543         /* panorama */
544         int panorama_type;
545         float fisheye_fov;
546         float fisheye_lens;
547
548         /* matrices */
549         Transform cameratoworld;
550         Transform rastertocamera;
551
552         /* differentials */
553         float4 dx;
554         float4 dy;
555
556         /* depth of field */
557         float aperturesize;
558         float blades;
559         float bladesrotation;
560         float focaldistance;
561
562         /* motion blur */
563         float shuttertime;
564         int have_motion;
565
566         /* clipping */
567         float nearclip;
568         float cliplength;
569
570         /* sensor size */
571         float sensorwidth;
572         float sensorheight;
573
574         /* render size */
575         float width, height;
576
577         /* more matrices */
578         Transform screentoworld;
579         Transform rastertoworld;
580         /* work around cuda sm 2.0 crash, this seems to
581          * cross some limit in combination with motion 
582          * Transform ndctoworld; */
583         Transform worldtoscreen;
584         Transform worldtoraster;
585         Transform worldtondc;
586         Transform worldtocamera;
587
588         MotionTransform motion;
589 } KernelCamera;
590
591 typedef struct KernelFilm {
592         float exposure;
593         int pass_flag;
594         int pass_stride;
595         int use_light_pass;
596
597         int pass_combined;
598         int pass_depth;
599         int pass_normal;
600         int pass_motion;
601
602         int pass_motion_weight;
603         int pass_uv;
604         int pass_object_id;
605         int pass_material_id;
606
607         int pass_diffuse_color;
608         int pass_glossy_color;
609         int pass_transmission_color;
610         int pass_diffuse_indirect;
611
612         int pass_glossy_indirect;
613         int pass_transmission_indirect;
614         int pass_diffuse_direct;
615         int pass_glossy_direct;
616
617         int pass_transmission_direct;
618         int pass_emission;
619         int pass_background;
620         int pass_ao;
621
622         int pass_shadow;
623         float pass_shadow_scale;
624
625         int filter_table_offset;
626         int filter_pad;
627 } KernelFilm;
628
629 typedef struct KernelBackground {
630         /* only shader index */
631         int shader;
632         int transparent;
633
634         /* ambient occlusion */
635         float ao_factor;
636         float ao_distance;
637 } KernelBackground;
638
639 typedef struct KernelSunSky {
640         /* sun direction in spherical and cartesian */
641         float theta, phi, pad3, pad4;
642
643         /* perez function parameters */
644         float zenith_Y, zenith_x, zenith_y, pad2;
645         float perez_Y[5], perez_x[5], perez_y[5];
646         float pad5;
647 } KernelSunSky;
648
649 typedef struct KernelIntegrator {
650         /* emission */
651         int use_direct_light;
652         int use_ambient_occlusion;
653         int num_distribution;
654         int num_all_lights;
655         float pdf_triangles;
656         float pdf_lights;
657         float inv_pdf_lights;
658         int pdf_background_res;
659
660         /* bounces */
661         int min_bounce;
662         int max_bounce;
663
664         int max_diffuse_bounce;
665         int max_glossy_bounce;
666         int max_transmission_bounce;
667
668         /* transparent */
669         int transparent_min_bounce;
670         int transparent_max_bounce;
671         int transparent_shadows;
672
673         /* caustics */
674         int no_caustics;
675         float filter_glossy;
676
677         /* seed */
678         int seed;
679
680         /* render layer */
681         int layer_flag;
682
683         /* clamp */
684         float sample_clamp;
685
686         /* non-progressive */
687         int progressive;
688         int diffuse_samples;
689         int glossy_samples;
690         int transmission_samples;
691         int ao_samples;
692         int mesh_light_samples;
693         int use_lamp_mis;
694         int subsurface_samples;
695
696         int pad1, pad2, pad3;
697 } KernelIntegrator;
698
699 typedef struct KernelBVH {
700         /* root node */
701         int root;
702         int attributes_map_stride;
703         int have_motion;
704         int pad2;
705 } KernelBVH;
706
707 typedef enum CurveFlag {
708         /* runtime flags */
709         CURVE_KN_BACKFACING = 1,                                /* backside of cylinder? */
710         CURVE_KN_ENCLOSEFILTER = 2,                             /* don't consider strands surrounding start point? */
711         CURVE_KN_CURVEDATA = 4,                         /* curve data available? */
712         CURVE_KN_INTERPOLATE = 8,                               /* render as a curve? - not supported yet */
713         CURVE_KN_ACCURATE = 16,                         /* use accurate intersections test? */
714         CURVE_KN_INTERSECTCORRECTION = 32,              /* correct for width after determing closest midpoint? */
715         CURVE_KN_POSTINTERSECTCORRECTION = 64,  /* correct for width after intersect? */
716         CURVE_KN_NORMALCORRECTION = 128,                /* correct tangent normal for slope? */
717         CURVE_KN_TRUETANGENTGNORMAL = 256,              /* use tangent normal for geometry? */
718         CURVE_KN_TANGENTGNORMAL = 512,                  /* use tangent normal for shader? */
719         CURVE_KN_RIBBONS = 1024,                                /* use flat curve ribbons */
720 } CurveFlag;
721
722 typedef struct KernelCurves {
723         /* strand intersect and normal parameters - many can be changed to flags*/
724         float normalmix;
725         float encasing_ratio;
726         int curveflags;
727         int subdivisions;
728 } KernelCurves;
729
730 typedef struct KernelBSSRDF {
731         int table_offset;
732         int num_attempts;
733         int pad1, pad2;
734 } KernelBSSRDF;
735
736 typedef struct KernelData {
737         KernelCamera cam;
738         KernelFilm film;
739         KernelBackground background;
740         KernelSunSky sunsky;
741         KernelIntegrator integrator;
742         KernelBVH bvh;
743         KernelCurves curve_kernel_data;
744         KernelBSSRDF bssrdf;
745 } KernelData;
746
747 CCL_NAMESPACE_END
748
749 #endif /*  __KERNEL_TYPES_H__ */
750