merge with 2.5 at r18679
[blender.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 #ifndef RENDER_TYPES_H
29 #define RENDER_TYPES_H
30
31 /* ------------------------------------------------------------------------- */
32 /* exposed internal in render module only! */
33 /* ------------------------------------------------------------------------- */
34
35 #include "DNA_color_types.h"
36 #include "DNA_scene_types.h"
37 #include "DNA_world_types.h"
38 #include "DNA_object_types.h"
39 #include "DNA_vec_types.h"
40
41 #include "BLI_threads.h"
42
43 #include "RE_pipeline.h"
44 #include "RE_shader_ext.h"      /* TexResult, ShadeResult, ShadeInput */
45 #include "sunsky.h"
46
47 #include "BLO_sys_types.h" // for intptr_t support
48
49 struct Object;
50 struct MemArena;
51 struct VertTableNode;
52 struct VlakTableNode;
53 struct GHash;
54 struct RenderBuckets;
55 struct ObjectInstanceRen;
56
57 #define TABLEINITSIZE 1024
58 #define LAMPINITSIZE 256
59
60 typedef struct SampleTables
61 {
62         float centLut[16];
63         float *fmask1[9], *fmask2[9];
64         char cmask[256], *centmask;
65         
66 } SampleTables;
67
68 typedef struct QMCSampler
69 {
70         struct QMCSampler *next, *prev;
71         int type;
72         int tot;
73         int used;
74         double *samp2d;
75         double offs[BLENDER_MAX_THREADS][2];
76 } QMCSampler;
77
78 #define SAMP_TYPE_JITTERED              0
79 #define SAMP_TYPE_HALTON                1
80 #define SAMP_TYPE_HAMMERSLEY    2
81
82 /* this is handed over to threaded hiding/passes/shading engine */
83 typedef struct RenderPart
84 {
85         struct RenderPart *next, *prev;
86         
87         RenderResult *result;                   /* result of part rendering */
88         ListBase fullresult;                    /* optional full sample buffers */
89         
90         int *recto;                                             /* object table for objects */
91         int *rectp;                                             /* polygon index table */
92         int *rectz;                                             /* zbuffer */
93         int *rectmask;                                  /* negative zmask */
94         intptr_t *rectdaps;                                     /* delta acum buffer for pixel structs */
95         int *rectbacko;                                 /* object table for backside sss */
96         int *rectbackp;                                 /* polygon index table for backside sss */
97         int *rectbackz;                                 /* zbuffer for backside sss */
98         intptr_t *rectall;                                      /* buffer for all faces for sss */
99
100         rcti disprect;                                  /* part coordinates within total picture */
101         int rectx, recty;                               /* the size */
102         short crop, ready;                              /* crop is amount of pixels we crop, for filter */
103         short sample, nr;                               /* sample can be used by zbuffers, nr is partnr */
104         short thread;                                   /* thread id */
105         
106         char *clipflag;                                 /* clipflags for part zbuffering */
107 } RenderPart;
108
109 /* controls state of render, everything that's read-only during render stage */
110 struct Render
111 {
112         struct Render *next, *prev;
113         char name[RE_MAXNAME];
114         
115         /* state settings */
116         short flag, osa, ok, do_gamma;
117         
118         /* result of rendering */
119         RenderResult *result;
120         /* if render with single-layer option, other rendered layers are stored here */
121         RenderResult *pushedresult;
122         /* a list of RenderResults, for fullsample */
123         ListBase fullresult;    
124         
125         /* window size, display rect, viewplane */
126         int winx, winy;
127         rcti disprect;                  /* part within winx winy */
128         rctf viewplane;                 /* mapped on winx winy */
129         float viewdx, viewdy;   /* size of 1 pixel */
130         float clipcrop;                 /* 2 pixel boundary to prevent clip when filter used */
131         
132         /* final picture width and height (within disprect) */
133         int rectx, recty;
134         
135         /* real maximum amount of xparts/yparts after correction for minimum */
136         int xparts, yparts;
137         /* real maximum size of parts after correction for minimum 
138            partx*xparts can be larger than rectx, in that case last part is smaller */
139         int partx, party;
140         
141         /* values for viewing */
142         float lens, ycor, viewfac;
143         float panophi, panosi, panoco, panodxp, panodxv;
144         
145         /* Matrices */
146         float grvec[3];                 /* for world */
147         float imat[3][3];               /* copy of viewinv */
148         float viewmat[4][4], viewinv[4][4];
149         float winmat[4][4];
150         
151         /* clippping */
152         float clipsta;
153         float clipend;
154         
155         /* samples */
156         SampleTables *samples;
157         float jit[32][2];
158         ListBase *qmcsamplers;
159         
160         /* shadow counter, detect shadow-reuse for shaders */
161         int shadowsamplenr[BLENDER_MAX_THREADS];
162         
163         /* scene, and its full copy of renderdata and world */
164         Scene *scene;
165         RenderData r;
166         World wrld;
167         
168         ListBase parts;
169         
170         /* octree tables and variables for raytrace */
171         void *raytree;
172
173         /* occlusion tree */
174         void *occlusiontree;
175         ListBase strandsurface;
176         
177         /* use this instead of R.r.cfra */
178         float cfra;     
179         
180         /* render database */
181         int totvlak, totvert, tothalo, totstrand, totlamp;
182         struct HaloRen **sortedhalos;
183
184         ListBase lights;        /* GroupObject pointers */
185         ListBase lampren;       /* storage, for free */
186         
187         ListBase objecttable;
188
189         struct ObjectInstanceRen *objectinstance;
190         ListBase instancetable;
191         int totinstance;
192
193         struct Image *backbuf, *bakebuf;
194         
195         struct GHash *orco_hash;
196
197         struct GHash *sss_hash;
198         ListBase *sss_points;
199         struct Material *sss_mat;
200
201         ListBase customdata_names;
202
203         struct Object *excludeob;
204
205         /* arena for allocating data for use during render, for
206                 * example dynamic TFaces to go in the VlakRen structure.
207                 */
208         struct MemArena *memArena;
209         
210         /* callbacks */
211         void (*display_init)(void *handle, RenderResult *rr);
212         void *dih;
213         void (*display_clear)(void *handle, RenderResult *rr);
214         void *dch;
215         void (*display_draw)(void *handle, RenderResult *rr, volatile rcti *rect);
216         void *ddh;
217         
218         void (*stats_draw)(void *handle, RenderStats *ri);
219         void *sdh;
220         void (*timecursor)(void *handle, int i);
221         void *tch;
222         
223         int (*test_break)(void *handle);
224         void *tbh;
225         
226         void (*error)(void *handle, char *str);
227         void *erh;
228         
229         RenderStats i;
230 };
231
232 /* ------------------------------------------------------------------------- */
233
234 struct ISBData;
235
236 typedef struct ShadSampleBuf {
237         struct ShadSampleBuf *next, *prev;
238         intptr_t *zbuf;
239         char *cbuf;
240 } ShadSampleBuf;
241
242 typedef struct ShadBuf {
243         /* regular shadowbuffer */
244         short samp, shadhalostep, totbuf;
245         float persmat[4][4];
246         float viewmat[4][4];
247         float winmat[4][4];
248         float *jit, *weight;
249         float d, clipend, pixsize, soft;
250         int co[3];
251         int size, bias;
252         ListBase buffers;
253         
254         /* irregular shadowbufer, result stored per thread */
255         struct ISBData *isb_result[BLENDER_MAX_THREADS];
256 } ShadBuf;
257
258 /* ------------------------------------------------------------------------- */
259
260 typedef struct ObjectRen {
261         struct ObjectRen *next, *prev;
262         struct Object *ob, *par;
263         struct Scene *sce;
264         int index, psysindex, flag, lay;
265
266         float boundbox[2][3];
267
268         int totvert, totvlak, totstrand, tothalo;
269         int vertnodeslen, vlaknodeslen, strandnodeslen, blohalen;
270         struct VertTableNode *vertnodes;
271         struct VlakTableNode *vlaknodes;
272         struct StrandTableNode *strandnodes;
273         struct HaloRen **bloha;
274         struct StrandBuffer *strandbuf;
275
276         char (*mtface)[32];
277         char (*mcol)[32];
278         int  actmtface, actmcol, bakemtface;
279
280         float obmat[4][4];      /* only used in convertblender.c, for instancing */
281 } ObjectRen;
282
283 typedef struct ObjectInstanceRen {
284         struct ObjectInstanceRen *next, *prev;
285
286         ObjectRen *obr;
287         Object *ob, *par;
288         int index, psysindex, lay;
289
290         float mat[4][4], nmat[3][3]; /* nmat is inverse mat tranposed */
291         short flag;
292
293         float dupliorco[3], dupliuv[2];
294         float (*duplitexmat)[4];
295
296         float *vectors;
297         int totvector;
298 } ObjectInstanceRen;
299
300 /* ------------------------------------------------------------------------- */
301
302 typedef struct VertRen
303 {
304         float co[3];
305         float n[3];
306         float *orco;
307         short clip;
308         unsigned short flag;            /* in use for clipping zbuffer parts, temp setting stuff in convertblender.c */
309         float accum;            /* accum for radio weighting, and for strand texco static particles */
310         int index;                      /* index allows extending vertren with any property */
311 } VertRen;
312
313 /* ------------------------------------------------------------------------- */
314
315 struct halosort {
316         struct HaloRen *har;
317         int z;
318 };
319
320 /* ------------------------------------------------------------------------- */
321 struct Material;
322 struct MTFace;
323
324 typedef struct RadFace {
325         float unshot[3], totrad[3];
326         float norm[3], cent[3], area;
327         int flag;
328 } RadFace;
329
330 typedef struct VlakRen {
331         struct VertRen *v1, *v2, *v3, *v4;      /* keep in order for ** addressing */
332         float n[3];
333         struct Material *mat;
334         char puno;
335         char flag, ec;
336         int index;
337 } VlakRen;
338
339 typedef struct HaloRen
340 {       
341     short miny, maxy;
342     float alfa, xs, ys, rad, radsq, sin, cos, co[3], no[3];
343         float hard, b, g, r;
344     int zs, zd;
345     int zBufDist;       /* depth in the z-buffer coordinate system */
346     char starpoints, type, add, tex;
347     char linec, ringc, seed;
348         short flarec; /* used to be a char. why ?*/
349     float hasize;
350     int pixels;
351     unsigned int lay;
352     struct Material *mat;
353 } HaloRen;
354
355 /* ------------------------------------------------------------------------- */
356
357 typedef struct StrandVert {
358         float co[3];
359         float strandco;
360 } StrandVert;
361
362 typedef struct StrandSurface {
363         struct StrandSurface *next, *prev;
364         ObjectRen obr;
365         int (*face)[4];
366         float (*co)[3];
367         /* for occlusion caching */
368         float (*col)[3];
369         /* for speedvectors */
370         float (*prevco)[3], (*nextco)[3];
371         int totvert, totface;
372 } StrandSurface;
373
374 typedef struct StrandBound {
375         int start, end;
376         float boundbox[2][3];
377 } StrandBound;
378
379 typedef struct StrandBuffer {
380         struct StrandBuffer *next, *prev;
381         struct StrandVert *vert;
382         struct StrandBound *bound;
383         int totvert, totbound;
384
385         struct ObjectRen *obr;
386         struct Material *ma;
387         struct StrandSurface *surface;
388         unsigned int lay;
389         int overrideuv;
390         int flag, maxdepth;
391         float adaptcos, minwidth, widthfade;
392
393         float winmat[4][4];
394         int winx, winy;
395 } StrandBuffer;
396
397 typedef struct StrandRen {
398         StrandVert *vert;
399         StrandBuffer *buffer;
400         int totvert, flag;
401         int clip, index;
402         float orco[3];
403 } StrandRen;
404
405
406 struct LampRen;
407 struct MTex;
408
409 /**
410  * For each lamp in a scene, a LampRen is created. It determines the
411  * properties of a lightsource.
412  */
413
414 typedef struct LampShadowSubSample {
415         int samplenr;
416         float shadfac[4];       /* rgba shadow */
417 } LampShadowSubSample;
418
419 typedef struct LampShadowSample {
420         LampShadowSubSample s[16];      /* MAX OSA */
421 } LampShadowSample;
422
423 typedef struct LampRen {
424         struct LampRen *next, *prev;
425         
426         float xs, ys, dist;
427         float co[3];
428         short type;
429         int mode;
430         float r, g, b, k;
431         float shdwr, shdwg, shdwb;
432         float energy, haint;
433         int lay;
434         float spotsi,spotbl;
435         float vec[3];
436         float xsp, ysp, distkw, inpr;
437         float halokw, halo;
438         
439         short falloff_type;
440         float ld1,ld2;
441         struct CurveMapping *curfalloff;
442
443         /* copied from Lamp, to decouple more rendering stuff */
444         /** Size of the shadowbuffer */
445         short bufsize;
446         /** Number of samples for the shadows */
447         short samp;
448         /** Softness factor for shadow */
449         float soft;
450         /** amount of subsample buffers and type of filter for sampling */
451         short buffers, filtertype;
452         /** shadow buffer type (regular, irregular) */
453         short buftype;
454         /** autoclip */
455         short bufflag;
456         /** shadow plus halo: detail level */
457         short shadhalostep;
458         /** Near clip of the lamp */
459         float clipsta;
460         /** Far clip of the lamp */
461         float clipend;
462         /** A small depth offset to prevent self-shadowing. */
463         float bias;
464         
465         short ray_samp, ray_sampy, ray_sampz, ray_samp_method, ray_samp_type, area_shape, ray_totsamp;
466         short xold[BLENDER_MAX_THREADS], yold[BLENDER_MAX_THREADS];     /* last jitter table for area lights */
467         float area_size, area_sizey, area_sizez;
468         float adapt_thresh;
469
470         /* sun/sky */
471         struct SunSky *sunsky;
472         
473         struct ShadBuf *shb;
474         float *jitter;
475         
476         float imat[3][3];
477         float spottexfac;
478         float sh_invcampos[3], sh_zfac; /* sh_= spothalo */
479         
480         float mat[3][3];        /* 3x3 part from lampmat x viewmat */
481         float area[8][3], areasize;
482         
483         /* passes & node shader support: all shadow info for a pixel */
484         LampShadowSample *shadsamp;
485                 
486         /* yafray: photonlight params */
487         int YF_numphotons, YF_numsearch;
488         short YF_phdepth, YF_useqmc, YF_bufsize;
489         float YF_causticblur, YF_ltradius;
490         float YF_glowint, YF_glowofs;
491         short YF_glowtype;
492         
493         /* ray optim */
494         VlakRen *vlr_last[BLENDER_MAX_THREADS];
495         ObjectInstanceRen *obi_last[BLENDER_MAX_THREADS];
496         
497         struct MTex *mtex[MAX_MTEX];
498
499         /* threading */
500         int thread_assigned;
501         int thread_ready;
502 } LampRen;
503
504 /* **************** defines ********************* */
505
506 /* R.r.mode flag is same as for renderdata */
507
508 /* R.flag */
509 #define R_ZTRA                  1
510 #define R_HALO                  2
511 #define R_SEC_FIELD             4
512 #define R_LAMPHALO              8
513 #define R_GLOB_NOPUNOFLIP       16
514 #define R_NEED_TANGENT  32
515 #define R_BAKE_TRACE    128
516 #define R_BAKING                256
517
518 /* vlakren->flag (vlak = face in dutch) char!!! */
519 #define R_SMOOTH                1
520 #define R_HIDDEN                2
521 /* strand flag, means special handling */
522 #define R_STRAND                4
523 #define R_NOPUNOFLIP    8
524 #define R_FULL_OSA              16
525 #define R_FACE_SPLIT    32
526 /* Tells render to divide face other way. */
527 #define R_DIVIDE_24             64      
528 /* vertex normals are tangent or view-corrected vector, for hair strands */
529 #define R_TANGENT               128             
530
531 /* strandbuffer->flag */
532 #define R_STRAND_BSPLINE        1
533 #define R_STRAND_B_UNITS        2
534
535 /* objectren->flag */
536 #define R_INSTANCEABLE          1
537
538 /* objectinstance->flag */
539 #define R_DUPLI_TRANSFORMED     1
540 #define R_ENV_TRANSFORMED       2
541 #define R_TRANSFORMED           (1|2)
542 #define R_NEED_VECTORS          4
543
544 #endif /* RENDER_TYPES_H */
545