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