* Volume Rendering: Voxel data
[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         ListBase vol_precache_obs;
206         ListBase render_volumes_inside;
207         ListBase volumes;
208
209         /* arena for allocating data for use during render, for
210                 * example dynamic TFaces to go in the VlakRen structure.
211                 */
212         struct MemArena *memArena;
213         
214         /* callbacks */
215         void (*display_init)(RenderResult *rr);
216         void (*display_clear)(RenderResult *rr);
217         void (*display_draw)(RenderResult *rr, volatile rcti *rect);
218         
219         void (*stats_draw)(RenderStats *ri);
220         void (*timecursor)(int i);
221         
222         int (*test_break)(void);
223         int (*test_return)(void);
224         void (*error)(char *str);
225         
226         RenderStats i;
227 };
228
229 /* ------------------------------------------------------------------------- */
230
231 struct ISBData;
232
233 typedef struct ShadSampleBuf {
234         struct ShadSampleBuf *next, *prev;
235         intptr_t *zbuf;
236         char *cbuf;
237 } ShadSampleBuf;
238
239 typedef struct ShadBuf {
240         /* regular shadowbuffer */
241         short samp, shadhalostep, totbuf;
242         float persmat[4][4];
243         float viewmat[4][4];
244         float winmat[4][4];
245         float *jit, *weight;
246         float d, clipend, pixsize, soft;
247         int co[3];
248         int size, bias;
249         ListBase buffers;
250         
251         /* irregular shadowbufer, result stored per thread */
252         struct ISBData *isb_result[BLENDER_MAX_THREADS];
253 } ShadBuf;
254
255 /* ------------------------------------------------------------------------- */
256
257 typedef struct ObjectRen {
258         struct ObjectRen *next, *prev;
259         struct Object *ob, *par;
260         struct Scene *sce;
261         int index, psysindex, flag, lay;
262
263         float boundbox[2][3];
264
265         int totvert, totvlak, totstrand, tothalo;
266         int vertnodeslen, vlaknodeslen, strandnodeslen, blohalen;
267         struct VertTableNode *vertnodes;
268         struct VlakTableNode *vlaknodes;
269         struct StrandTableNode *strandnodes;
270         struct HaloRen **bloha;
271         struct StrandBuffer *strandbuf;
272
273         char (*mtface)[32];
274         char (*mcol)[32];
275         int  actmtface, actmcol, bakemtface;
276
277         float obmat[4][4];      /* only used in convertblender.c, for instancing */
278 } ObjectRen;
279
280 typedef struct ObjectInstanceRen {
281         struct ObjectInstanceRen *next, *prev;
282
283         ObjectRen *obr;
284         Object *ob, *par;
285         int index, psysindex, lay;
286
287         float mat[4][4], nmat[3][3]; /* nmat is inverse mat tranposed */
288         short flag;
289
290         float dupliorco[3], dupliuv[2];
291         float (*duplitexmat)[4];
292         
293         float *volume_precache;
294
295         float *vectors;
296         int totvector;
297 } ObjectInstanceRen;
298
299 /* ------------------------------------------------------------------------- */
300
301 typedef struct VertRen
302 {
303         float co[3];
304         float n[3];
305         float *orco;
306         short clip;
307         unsigned short flag;            /* in use for clipping zbuffer parts, temp setting stuff in convertblender.c */
308         float accum;            /* accum for radio weighting, and for strand texco static particles */
309         int index;                      /* index allows extending vertren with any property */
310 } VertRen;
311
312 /* ------------------------------------------------------------------------- */
313
314 struct halosort {
315         struct HaloRen *har;
316         int z;
317 };
318
319 /* ------------------------------------------------------------------------- */
320 struct Material;
321 struct MTFace;
322
323 typedef struct RadFace {
324         float unshot[3], totrad[3];
325         float norm[3], cent[3], area;
326         int flag;
327 } RadFace;
328
329 typedef struct VlakRen {
330         struct VertRen *v1, *v2, *v3, *v4;      /* keep in order for ** addressing */
331         float n[3];
332         struct Material *mat;
333         char puno;
334         char flag, ec;
335         int index;
336 } VlakRen;
337
338 typedef struct HaloRen
339 {       
340     short miny, maxy;
341     float alfa, xs, ys, rad, radsq, sin, cos, co[3], no[3];
342         float hard, b, g, r;
343     int zs, zd;
344     int zBufDist;       /* depth in the z-buffer coordinate system */
345     char starpoints, type, add, tex;
346     char linec, ringc, seed;
347         short flarec; /* used to be a char. why ?*/
348     float hasize;
349     int pixels;
350     unsigned int lay;
351     struct Material *mat;
352 } HaloRen;
353
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
407 typedef struct VolPrecache
408 {
409         struct VolPrecache *next, *prev;
410         struct Material *ma;
411         struct ObjectRen *obr;
412 } VolPrecache;
413
414 typedef struct VolumeOb
415 {
416         struct VolumeOb *next, *prev;
417         struct Material *ma;
418         struct ObjectRen *obr;
419 } VolumeOb;
420
421 typedef struct MatInside {
422         struct MatInside *next, *prev;
423         struct Material *ma;
424 } MatInside;
425
426 /* ------------------------------------------------------------------------- */
427
428 struct LampRen;
429 struct MTex;
430
431 /**
432  * For each lamp in a scene, a LampRen is created. It determines the
433  * properties of a lightsource.
434  */
435
436 typedef struct LampShadowSubSample {
437         int samplenr;
438         float shadfac[4];       /* rgba shadow */
439 } LampShadowSubSample;
440
441 typedef struct LampShadowSample {
442         LampShadowSubSample s[16];      /* MAX OSA */
443 } LampShadowSample;
444
445 typedef struct LampRen {
446         struct LampRen *next, *prev;
447         
448         float xs, ys, dist;
449         float co[3];
450         short type;
451         int mode;
452         float r, g, b, k;
453         float shdwr, shdwg, shdwb;
454         float energy, haint;
455         int lay;
456         float spotsi,spotbl;
457         float vec[3];
458         float xsp, ysp, distkw, inpr;
459         float halokw, halo;
460         
461         short falloff_type;
462         float ld1,ld2;
463         struct CurveMapping *curfalloff;
464
465         /* copied from Lamp, to decouple more rendering stuff */
466         /** Size of the shadowbuffer */
467         short bufsize;
468         /** Number of samples for the shadows */
469         short samp;
470         /** Softness factor for shadow */
471         float soft;
472         /** amount of subsample buffers and type of filter for sampling */
473         short buffers, filtertype;
474         /** shadow buffer type (regular, irregular) */
475         short buftype;
476         /** autoclip */
477         short bufflag;
478         /** shadow plus halo: detail level */
479         short shadhalostep;
480         /** Near clip of the lamp */
481         float clipsta;
482         /** Far clip of the lamp */
483         float clipend;
484         /** A small depth offset to prevent self-shadowing. */
485         float bias;
486         
487         short ray_samp, ray_sampy, ray_sampz, ray_samp_method, ray_samp_type, area_shape, ray_totsamp;
488         short xold[BLENDER_MAX_THREADS], yold[BLENDER_MAX_THREADS];     /* last jitter table for area lights */
489         float area_size, area_sizey, area_sizez;
490         float adapt_thresh;
491
492         /* sun/sky */
493         struct SunSky *sunsky;
494         
495         struct ShadBuf *shb;
496         float *jitter;
497         
498         float imat[3][3];
499         float spottexfac;
500         float sh_invcampos[3], sh_zfac; /* sh_= spothalo */
501         
502         float mat[3][3];        /* 3x3 part from lampmat x viewmat */
503         float area[8][3], areasize;
504         
505         /* passes & node shader support: all shadow info for a pixel */
506         LampShadowSample *shadsamp;
507                 
508         /* yafray: photonlight params */
509         int YF_numphotons, YF_numsearch;
510         short YF_phdepth, YF_useqmc, YF_bufsize;
511         float YF_causticblur, YF_ltradius;
512         float YF_glowint, YF_glowofs;
513         short YF_glowtype;
514         
515         /* ray optim */
516         VlakRen *vlr_last[BLENDER_MAX_THREADS];
517         ObjectInstanceRen *obi_last[BLENDER_MAX_THREADS];
518         
519         struct MTex *mtex[MAX_MTEX];
520
521         /* threading */
522         int thread_assigned;
523         int thread_ready;
524 } LampRen;
525
526 /* **************** defines ********************* */
527
528 /* R.r.mode flag is same as for renderdata */
529
530 /* R.flag */
531 #define R_ZTRA                  1
532 #define R_HALO                  2
533 #define R_SEC_FIELD             4
534 #define R_LAMPHALO              8
535 #define R_GLOB_NOPUNOFLIP       16
536 #define R_NEED_TANGENT  32
537 #define R_SKIP_MULTIRES 64
538 #define R_BAKE_TRACE    128
539 #define R_BAKING                256
540
541 /* vlakren->flag (vlak = face in dutch) char!!! */
542 #define R_SMOOTH                1
543 #define R_HIDDEN                2
544 /* strand flag, means special handling */
545 #define R_STRAND                4
546 #define R_NOPUNOFLIP    8
547 #define R_FULL_OSA              16
548 #define R_FACE_SPLIT    32
549 /* Tells render to divide face other way. */
550 #define R_DIVIDE_24             64      
551 /* vertex normals are tangent or view-corrected vector, for hair strands */
552 #define R_TANGENT               128             
553
554 /* strandbuffer->flag */
555 #define R_STRAND_BSPLINE        1
556 #define R_STRAND_B_UNITS        2
557
558 /* objectren->flag */
559 #define R_INSTANCEABLE          1
560
561 /* objectinstance->flag */
562 #define R_DUPLI_TRANSFORMED     1
563 #define R_ENV_TRANSFORMED       2
564 #define R_TRANSFORMED           (1|2)
565 #define R_NEED_VECTORS          4
566
567 #endif /* RENDER_TYPES_H */
568