Merged changes in the trunk up to revision 51718.
[blender.git] / source / blender / render / intern / include / render_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributor(s): (c) 2006 Blender Foundation, full refactor
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/render/intern/include/render_types.h
27  *  \ingroup render
28  */
29
30
31 #ifndef __RENDER_TYPES_H__
32 #define __RENDER_TYPES_H__
33
34 /* ------------------------------------------------------------------------- */
35 /* exposed internal in render module only! */
36 /* ------------------------------------------------------------------------- */
37
38 #include "DNA_color_types.h"
39 #include "DNA_customdata_types.h"
40 #include "DNA_scene_types.h"
41 #include "DNA_world_types.h"
42 #include "DNA_object_types.h"
43 #include "DNA_vec_types.h"
44
45 #include "BLI_threads.h"
46
47 #include "RE_pipeline.h"
48 #include "RE_shader_ext.h"      /* TexResult, ShadeResult, ShadeInput */
49 #include "sunsky.h"
50
51 #include "BLO_sys_types.h" // for intptr_t support
52
53 struct Object;
54 struct MemArena;
55 struct VertTableNode;
56 struct VlakTableNode;
57 struct GHash;
58 struct RenderBuckets;
59 struct ObjectInstanceRen;
60 struct RayObject;
61 struct RayFace;
62 struct ReportList;
63 struct Main;
64
65 #define TABLEINITSIZE 1024
66
67 typedef struct SampleTables {
68         float centLut[16];
69         float *fmask1[9], *fmask2[9];
70         char cmask[256], *centmask;
71         
72 } SampleTables;
73
74 typedef struct QMCSampler {
75         struct QMCSampler *next, *prev;
76         int type;
77         int tot;
78         int used;
79         double *samp2d;
80         double offs[BLENDER_MAX_THREADS][2];
81 } QMCSampler;
82
83 #define SAMP_TYPE_JITTERED              0
84 #define SAMP_TYPE_HALTON                1
85 #define SAMP_TYPE_HAMMERSLEY    2
86
87 /* this is handed over to threaded hiding/passes/shading engine */
88 typedef struct RenderPart {
89         struct RenderPart *next, *prev;
90         
91         RenderResult *result;                   /* result of part rendering */
92         ListBase fullresult;                    /* optional full sample buffers */
93         
94         int *recto;                                             /* object table for objects */
95         int *rectp;                                             /* polygon index table */
96         int *rectz;                                             /* zbuffer */
97         int *rectmask;                                  /* negative zmask */
98         intptr_t *rectdaps;                                     /* delta acum buffer for pixel structs */
99         int *rectbacko;                                 /* object table for backside sss */
100         int *rectbackp;                                 /* polygon index table for backside sss */
101         int *rectbackz;                                 /* zbuffer for backside sss */
102         intptr_t *rectall;                                      /* buffer for all faces for sss */
103
104         rcti disprect;                                  /* part coordinates within total picture */
105         int rectx, recty;                               /* the size */
106         short crop, ready;                              /* crop is amount of pixels we crop, for filter */
107         short sample, nr;                               /* sample can be used by zbuffers, nr is partnr */
108         short thread;                                   /* thread id */
109         
110         char *clipflag;                                 /* clipflags for part zbuffering */
111 } RenderPart;
112
113 /* controls state of render, everything that's read-only during render stage */
114 struct Render
115 {
116         struct Render *next, *prev;
117         char name[RE_MAXNAME];
118         int slot;
119         
120         /* state settings */
121         short flag, osa, ok, result_ok;
122         
123         /* due to performance issues, getting initialized from color management settings once on Render initialization */
124         short scene_color_manage;
125         
126         /* result of rendering */
127         RenderResult *result;
128         /* if render with single-layer option, other rendered layers are stored here */
129         RenderResult *pushedresult;
130         /* a list of RenderResults, for fullsample */
131         ListBase fullresult;
132         /* read/write mutex, all internal code that writes to re->result must use a
133          * write lock, all external code must use a read lock. internal code is assumed
134          * to not conflict with writes, so no lock used for that */
135         ThreadRWMutex resultmutex;
136         
137         /* window size, display rect, viewplane */
138         int winx, winy;                 /* buffer width and height with percentage applied
139                                                          * without border & crop. convert to long before multiplying together to avoid overflow. */
140         rcti disprect;                  /* part within winx winy */
141         rctf viewplane;                 /* mapped on winx winy */
142         float viewdx, viewdy;   /* size of 1 pixel */
143         float clipcrop;                 /* 2 pixel boundary to prevent clip when filter used */
144         
145         /* final picture width and height (within disprect) */
146         int rectx, recty;
147         
148         /* real maximum amount of xparts/yparts after correction for minimum */
149         int xparts, yparts;
150         /* real maximum size of parts after correction for minimum 
151          * partx*xparts can be larger than rectx, in that case last part is smaller */
152         int partx, party;
153         
154         /* values for viewing */
155         float ycor; /* (scene->xasp / scene->yasp), multiplied with 'winy' */
156         
157         float panophi, panosi, panoco, panodxp, panodxv;
158         
159         /* Matrices */
160         float grvec[3];                 /* for world */
161         float imat[3][3];               /* copy of viewinv */
162         float viewmat[4][4], viewinv[4][4];
163         float winmat[4][4];
164         
165         /* clippping */
166         float clipsta;
167         float clipend;
168         
169         /* samples */
170         SampleTables *samples;
171         float jit[32][2];
172         float mblur_jit[32][2];
173         ListBase *qmcsamplers;
174         
175         /* shadow counter, detect shadow-reuse for shaders */
176         int shadowsamplenr[BLENDER_MAX_THREADS];
177         
178         /* main, scene, and its full copy of renderdata and world */
179         struct Main *main;
180         Scene *scene;
181         RenderData r;
182         World wrld;
183         struct Object *camera_override;
184         unsigned int lay;
185         
186         ListBase parts;
187         
188         /* octree tables and variables for raytrace */
189         struct RayObject *raytree;
190         struct RayFace *rayfaces;
191         struct VlakPrimitive *rayprimitives;
192         float maxdist; /* needed for keeping an incorrect behavior of SUN and HEMI lights (avoid breaking old scenes) */
193
194         /* occlusion tree */
195         void *occlusiontree;
196         ListBase strandsurface;
197         
198         /* use this instead of R.r.cfra */
199         float cfra;
200         float mblur_offs, field_offs;
201         
202         /* render database */
203         int totvlak, totvert, tothalo, totstrand, totlamp;
204         struct HaloRen **sortedhalos;
205
206         ListBase lights;        /* GroupObject pointers */
207         ListBase lampren;       /* storage, for free */
208         
209         ListBase objecttable;
210
211         struct ObjectInstanceRen *objectinstance;
212         ListBase instancetable;
213         int totinstance;
214
215         struct Image *bakebuf;
216         
217         struct GHash *orco_hash;
218
219         struct GHash *sss_hash;
220         ListBase *sss_points;
221         struct Material *sss_mat;
222
223         ListBase customdata_names;
224
225         struct Object *excludeob;
226         ListBase render_volumes_inside;
227         ListBase volumes;
228         ListBase volume_precache_parts;
229
230         ListBase freestyle_renders;
231
232         /* arena for allocating data for use during render, for
233          * example dynamic TFaces to go in the VlakRen structure.
234          */
235         struct MemArena *memArena;
236         
237         /* callbacks */
238         void (*display_init)(void *handle, RenderResult *rr);
239         void *dih;
240         void (*display_clear)(void *handle, RenderResult *rr);
241         void *dch;
242         void (*display_draw)(void *handle, RenderResult *rr, volatile rcti *rect);
243         void *ddh;
244         
245         void (*stats_draw)(void *handle, RenderStats *ri);
246         void *sdh;
247         void (*progress)(void *handle, float i);
248         void *prh;
249         
250         void (*draw_lock)(void *handle, int i);
251         void *dlh;
252         int (*test_break)(void *handle);
253         void *tbh;
254         
255         RenderStats i;
256
257         struct ReportList *reports;
258 };
259
260 /* ------------------------------------------------------------------------- */
261
262 struct ISBData;
263
264 typedef struct DeepSample {
265         int z;
266         float v;
267 } DeepSample;
268  
269 typedef struct ShadSampleBuf {
270         struct ShadSampleBuf *next, *prev;
271         intptr_t *zbuf;
272         char *cbuf;
273         DeepSample **deepbuf;
274         int *totbuf;
275 } ShadSampleBuf;
276
277 typedef struct ShadBuf {
278         /* regular shadowbuffer */
279         short samp, shadhalostep, totbuf;
280         float persmat[4][4];
281         float viewmat[4][4];
282         float winmat[4][4];
283         float *jit, *weight;
284         float d, clipend, pixsize, soft, compressthresh;
285         int co[3];
286         int size, bias;
287         ListBase buffers;
288         
289         /* irregular shadowbufer, result stored per thread */
290         struct ISBData *isb_result[BLENDER_MAX_THREADS];
291 } ShadBuf;
292
293 /* ------------------------------------------------------------------------- */
294
295 typedef struct ObjectRen {
296         struct ObjectRen *next, *prev;
297         struct Object *ob, *par;
298         struct Scene *sce;
299         int index, psysindex, flag, lay;
300
301         float boundbox[2][3];
302
303         int totvert, totvlak, totstrand, tothalo;
304         int vertnodeslen, vlaknodeslen, strandnodeslen, blohalen;
305         struct VertTableNode *vertnodes;
306         struct VlakTableNode *vlaknodes;
307         struct StrandTableNode *strandnodes;
308         struct HaloRen **bloha;
309         struct StrandBuffer *strandbuf;
310
311         char (*mtface)[MAX_CUSTOMDATA_LAYER_NAME];
312         char (*mcol)[MAX_CUSTOMDATA_LAYER_NAME];
313         int  actmtface, actmcol, bakemtface;
314
315         float obmat[4][4];      /* only used in convertblender.c, for instancing */
316
317         /* used on makeraytree */
318         struct RayObject *raytree;
319         struct RayFace *rayfaces;
320         struct VlakPrimitive *rayprimitives;
321         struct ObjectInstanceRen *rayobi;
322         
323 } ObjectRen;
324
325 typedef struct ObjectInstanceRen {
326         struct ObjectInstanceRen *next, *prev;
327
328         ObjectRen *obr;
329         Object *ob, *par;
330         int index, psysindex, lay;
331
332         float mat[4][4], nmat[3][3]; /* nmat is inverse mat tranposed */
333         short flag;
334
335         float dupliorco[3], dupliuv[2];
336         float (*duplitexmat)[4];
337         
338         struct VolumePrecache *volume_precache;
339         
340         float *vectors; /* (RE_WINSPEED_ELEMS * VertRen.index) */
341         int totvector;
342         
343         /* used on makeraytree */
344         struct RayObject *raytree;
345         int transform_primitives;
346
347 } ObjectInstanceRen;
348
349 /* ------------------------------------------------------------------------- */
350
351 typedef struct VertRen {
352         float co[3];
353         float n[3];
354         float *orco;
355         unsigned int flag;      /* in use for clipping zbuffer parts, temp setting stuff in convertblender.c
356                                                  * only an 'int' because of alignment, could be a char too */
357         float accum;            /* accum for radio weighting, and for strand texco static particles */
358         int index;                      /* index allows extending vertren with any property */
359 } VertRen;
360
361 /* ------------------------------------------------------------------------- */
362
363 struct halosort {
364         struct HaloRen *har;
365         int z;
366 };
367
368 /* ------------------------------------------------------------------------- */
369 struct Material;
370 struct MTFace;
371
372 typedef struct RadFace {
373         float unshot[3], totrad[3];
374         float norm[3], cent[3], area;
375         int flag;
376 } RadFace;
377
378 typedef struct VlakRen {
379         struct VertRen *v1, *v2, *v3, *v4;      /* keep in order for ** addressing */
380         float n[3];
381         struct Material *mat;
382         char puno;
383         char flag, ec;
384         char freestyle_edge_mark;
385         int index;
386 } VlakRen;
387
388 typedef struct HaloRen {
389         short miny, maxy;
390         float alfa, xs, ys, rad, radsq, sin, cos, co[3], no[3];
391         float hard, b, g, r;
392         int zs, zd;
393         int zBufDist;   /* depth in the z-buffer coordinate system */
394         char starpoints, type, add, tex;
395         char linec, ringc, seed;
396         short flarec; /* used to be a char. why ?*/
397         float hasize;
398         int pixels;
399         unsigned int lay;
400         struct Material *mat;
401 } HaloRen;
402
403 /* ------------------------------------------------------------------------- */
404
405 typedef struct StrandVert {
406         float co[3];
407         float strandco;
408 } StrandVert;
409
410 typedef struct StrandSurface {
411         struct StrandSurface *next, *prev;
412         ObjectRen obr;
413         int (*face)[4];
414         float (*co)[3];
415         /* for occlusion caching */
416         float (*ao)[3];
417         float (*env)[3];
418         float (*indirect)[3];
419         /* for speedvectors */
420         float (*prevco)[3], (*nextco)[3];
421         int totvert, totface;
422 } StrandSurface;
423
424 typedef struct StrandBound {
425         int start, end;
426         float boundbox[2][3];
427 } StrandBound;
428
429 typedef struct StrandBuffer {
430         struct StrandBuffer *next, *prev;
431         struct StrandVert *vert;
432         struct StrandBound *bound;
433         int totvert, totbound;
434
435         struct ObjectRen *obr;
436         struct Material *ma;
437         struct StrandSurface *surface;
438         unsigned int lay;
439         int overrideuv;
440         int flag, maxdepth;
441         float adaptcos, minwidth, widthfade;
442         
443         float maxwidth; /* for cliptest of strands in blender unit */
444         
445         float winmat[4][4];
446         int winx, winy;
447 } StrandBuffer;
448
449 typedef struct StrandRen {
450         StrandVert *vert;
451         StrandBuffer *buffer;
452         int totvert, flag;
453         int clip, index;
454         float orco[3];
455 } StrandRen;
456
457 /* ------------------------------------------------------------------------- */
458
459 typedef struct VolumeOb {
460         struct VolumeOb *next, *prev;
461         struct Material *ma;
462         struct ObjectRen *obr;
463 } VolumeOb;
464
465 typedef struct MatInside {
466         struct MatInside *next, *prev;
467         struct Material *ma;
468         struct ObjectInstanceRen *obi;
469 } MatInside;
470
471 typedef struct VolPrecachePart {
472         struct VolPrecachePart *next, *prev;
473         struct RayObject *tree;
474         struct ShadeInput *shi;
475         struct ObjectInstanceRen *obi;
476         float viewmat[4][4];
477         int num;
478         int minx, maxx;
479         int miny, maxy;
480         int minz, maxz;
481         int res[3];
482         float bbmin[3];
483         float voxel[3];
484         struct Render *re;
485 } VolPrecachePart;
486
487 typedef struct VolumePrecache {
488         int res[3];
489         float *bbmin, *bbmax;
490         float *data_r;
491         float *data_g;
492         float *data_b;
493 } VolumePrecache;
494
495 /* ------------------------------------------------------------------------- */
496
497 struct LampRen;
498 struct MTex;
499
500 /**
501  * For each lamp in a scene, a LampRen is created. It determines the
502  * properties of a lightsource.
503  */
504
505 typedef struct LampShadowSubSample {
506         int samplenr;
507         float shadfac[4];       /* rgba shadow */
508 } LampShadowSubSample;
509
510 typedef struct LampShadowSample {
511         LampShadowSubSample s[16];      /* MAX OSA */
512 } LampShadowSample;
513
514 typedef struct LampRen {
515         struct LampRen *next, *prev;
516         
517         float xs, ys, dist;
518         float co[3];
519         short type;
520         int mode;
521         float r, g, b, k;
522         float shdwr, shdwg, shdwb;
523         float energy, haint;
524         int lay;
525         float spotsi, spotbl;
526         float vec[3];
527         float xsp, ysp, distkw, inpr;
528         float halokw, halo;
529         
530         short falloff_type;
531         float ld1, ld2;
532         struct CurveMapping *curfalloff;
533
534         /* copied from Lamp, to decouple more rendering stuff */
535         /** Size of the shadowbuffer */
536         short bufsize;
537         /** Number of samples for the shadows */
538         short samp;
539         /** Softness factor for shadow */
540         float soft;
541         /** amount of subsample buffers and type of filter for sampling */
542         short buffers, filtertype;
543         /** shadow buffer type (regular, irregular) */
544         short buftype;
545         /** autoclip */
546         short bufflag;
547         /** shadow plus halo: detail level */
548         short shadhalostep;
549         /** Near clip of the lamp */
550         float clipsta;
551         /** Far clip of the lamp */
552         float clipend;
553         /** A small depth offset to prevent self-shadowing. */
554         float bias;
555         /* Compression threshold for deep shadow maps */
556         float compressthresh;
557         
558         short ray_samp, ray_sampy, ray_sampz, ray_samp_method, ray_samp_type, area_shape, ray_totsamp;
559         short xold[BLENDER_MAX_THREADS], yold[BLENDER_MAX_THREADS];     /* last jitter table for area lights */
560         float area_size, area_sizey, area_sizez;
561         float adapt_thresh;
562
563         /* sun/sky */
564         struct SunSky *sunsky;
565         
566         struct ShadBuf *shb;
567         float *jitter;
568         
569         float imat[3][3];
570         float spottexfac;
571         float sh_invcampos[3], sh_zfac; /* sh_= spothalo */
572         
573         float mat[3][3];        /* 3x3 part from lampmat x viewmat */
574         float area[8][3], areasize;
575         
576         /* passes & node shader support: all shadow info for a pixel */
577         LampShadowSample *shadsamp;
578         
579         /* ray optim */
580         struct RayObject *last_hit[BLENDER_MAX_THREADS];
581         
582         struct MTex *mtex[MAX_MTEX];
583
584         /* threading */
585         int thread_assigned;
586         int thread_ready;
587 } LampRen;
588
589 /* **************** defines ********************* */
590
591 /* R.r.mode flag is same as for renderdata */
592
593 /* R.flag */
594 #define R_ZTRA                  1
595 #define R_HALO                  2
596 #define R_SEC_FIELD             4
597 #define R_LAMPHALO              8
598 #define R_NEED_TANGENT  16
599 #define R_BAKE_TRACE    32
600 #define R_BAKING                64
601 #define R_ANIMATION             128
602
603 /* vlakren->flag (vlak = face in dutch) char!!! */
604 #define R_SMOOTH                1
605 #define R_HIDDEN                2
606 /* strand flag, means special handling */
607 #define R_STRAND                4
608 #define R_FULL_OSA              8
609 #define R_FACE_SPLIT    16
610 /* Tells render to divide face other way. */
611 #define R_DIVIDE_24             32      
612 /* vertex normals are tangent or view-corrected vector, for hair strands */
613 #define R_TANGENT               64              
614 #define R_TRACEBLE              128
615
616 /* vlakren->freestyle_edge_mark */
617 #define R_EDGE_V1V2             1
618 #define R_EDGE_V2V3             2
619 #define R_EDGE_V3V4             4
620 #define R_EDGE_V3V1             4
621 #define R_EDGE_V4V1             8
622
623 /* strandbuffer->flag */
624 #define R_STRAND_BSPLINE        1
625 #define R_STRAND_B_UNITS        2
626
627 /* objectren->flag */
628 #define R_INSTANCEABLE          1
629
630 /* objectinstance->flag */
631 #define R_DUPLI_TRANSFORMED     1
632 #define R_ENV_TRANSFORMED       2
633 #define R_TRANSFORMED           (1|2)
634
635 #endif /* __RENDER_TYPES_H__ */
636