Camera: some code refactoring, use an intermediate CameraParams struct instead
[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_scene_types.h"
40 #include "DNA_world_types.h"
41 #include "DNA_object_types.h"
42 #include "DNA_vec_types.h"
43
44 #include "BLI_threads.h"
45
46 #include "RE_pipeline.h"
47 #include "RE_shader_ext.h"      /* TexResult, ShadeResult, ShadeInput */
48 #include "sunsky.h"
49
50 #include "BLO_sys_types.h" // for intptr_t support
51
52 struct Object;
53 struct MemArena;
54 struct VertTableNode;
55 struct VlakTableNode;
56 struct GHash;
57 struct RenderBuckets;
58 struct ObjectInstanceRen;
59 struct RayObject;
60 struct RayFace;
61 struct ReportList;
62 struct Main;
63
64 #define TABLEINITSIZE 1024
65 #define LAMPINITSIZE 256
66
67 typedef struct SampleTables
68 {
69         float centLut[16];
70         float *fmask1[9], *fmask2[9];
71         char cmask[256], *centmask;
72         
73 } SampleTables;
74
75 typedef struct QMCSampler
76 {
77         struct QMCSampler *next, *prev;
78         int type;
79         int tot;
80         int used;
81         double *samp2d;
82         double offs[BLENDER_MAX_THREADS][2];
83 } QMCSampler;
84
85 #define SAMP_TYPE_JITTERED              0
86 #define SAMP_TYPE_HALTON                1
87 #define SAMP_TYPE_HAMMERSLEY    2
88
89 /* this is handed over to threaded hiding/passes/shading engine */
90 typedef struct RenderPart
91 {
92         struct RenderPart *next, *prev;
93         
94         RenderResult *result;                   /* result of part rendering */
95         ListBase fullresult;                    /* optional full sample buffers */
96         
97         int *recto;                                             /* object table for objects */
98         int *rectp;                                             /* polygon index table */
99         int *rectz;                                             /* zbuffer */
100         int *rectmask;                                  /* negative zmask */
101         intptr_t *rectdaps;                                     /* delta acum buffer for pixel structs */
102         int *rectbacko;                                 /* object table for backside sss */
103         int *rectbackp;                                 /* polygon index table for backside sss */
104         int *rectbackz;                                 /* zbuffer for backside sss */
105         intptr_t *rectall;                                      /* buffer for all faces for sss */
106
107         rcti disprect;                                  /* part coordinates within total picture */
108         int rectx, recty;                               /* the size */
109         short crop, ready;                              /* crop is amount of pixels we crop, for filter */
110         short sample, nr;                               /* sample can be used by zbuffers, nr is partnr */
111         short thread;                                   /* thread id */
112         
113         char *clipflag;                                 /* clipflags for part zbuffering */
114 } RenderPart;
115
116 /* controls state of render, everything that's read-only during render stage */
117 struct Render
118 {
119         struct Render *next, *prev;
120         char name[RE_MAXNAME];
121         int slot;
122         
123         /* state settings */
124         short flag, osa, ok, result_ok;
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 behaviour 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         /* arena for allocating data for use during render, for
231                 * example dynamic TFaces to go in the VlakRen structure.
232                 */
233         struct MemArena *memArena;
234         
235         /* callbacks */
236         void (*display_init)(void *handle, RenderResult *rr);
237         void *dih;
238         void (*display_clear)(void *handle, RenderResult *rr);
239         void *dch;
240         void (*display_draw)(void *handle, RenderResult *rr, volatile rcti *rect);
241         void *ddh;
242         
243         void (*stats_draw)(void *handle, RenderStats *ri);
244         void *sdh;
245         void (*progress)(void *handle, float i);
246         void *prh;
247         
248         void (*draw_lock)(void *handle, int i);
249         void *dlh;
250         int (*test_break)(void *handle);
251         void *tbh;
252         
253         RenderStats i;
254
255         struct ReportList *reports;
256 };
257
258 /* ------------------------------------------------------------------------- */
259
260 struct ISBData;
261
262 typedef struct DeepSample {
263         int z;
264         float v;
265 } DeepSample;
266  
267 typedef struct ShadSampleBuf {
268         struct ShadSampleBuf *next, *prev;
269         intptr_t *zbuf;
270         char *cbuf;
271         DeepSample **deepbuf;
272         int *totbuf;
273 } ShadSampleBuf;
274
275 typedef struct ShadBuf {
276         /* regular shadowbuffer */
277         short samp, shadhalostep, totbuf;
278         float persmat[4][4];
279         float viewmat[4][4];
280         float winmat[4][4];
281         float *jit, *weight;
282         float d, clipend, pixsize, soft, compressthresh;
283         int co[3];
284         int size, bias;
285         ListBase buffers;
286         
287         /* irregular shadowbufer, result stored per thread */
288         struct ISBData *isb_result[BLENDER_MAX_THREADS];
289 } ShadBuf;
290
291 /* ------------------------------------------------------------------------- */
292
293 typedef struct ObjectRen {
294         struct ObjectRen *next, *prev;
295         struct Object *ob, *par;
296         struct Scene *sce;
297         int index, psysindex, flag, lay;
298
299         float boundbox[2][3];
300
301         int totvert, totvlak, totstrand, tothalo;
302         int vertnodeslen, vlaknodeslen, strandnodeslen, blohalen;
303         struct VertTableNode *vertnodes;
304         struct VlakTableNode *vlaknodes;
305         struct StrandTableNode *strandnodes;
306         struct HaloRen **bloha;
307         struct StrandBuffer *strandbuf;
308
309         char (*mtface)[32];
310         char (*mcol)[32];
311         int  actmtface, actmcol, bakemtface;
312
313         float obmat[4][4];      /* only used in convertblender.c, for instancing */
314
315         /* used on makeraytree */
316         struct RayObject *raytree;
317         struct RayFace *rayfaces;
318         struct VlakPrimitive *rayprimitives;
319         struct ObjectInstanceRen *rayobi;
320         
321 } ObjectRen;
322
323 typedef struct ObjectInstanceRen {
324         struct ObjectInstanceRen *next, *prev;
325
326         ObjectRen *obr;
327         Object *ob, *par;
328         int index, psysindex, lay;
329
330         float mat[4][4], nmat[3][3]; /* nmat is inverse mat tranposed */
331         short flag;
332
333         float dupliorco[3], dupliuv[2];
334         float (*duplitexmat)[4];
335         
336         struct VolumePrecache *volume_precache;
337         
338         float *vectors; /* (RE_WINSPEED_ELEMS * VertRen.index) */
339         int totvector;
340         
341         /* used on makeraytree */
342         struct RayObject *raytree;
343         int transform_primitives;
344
345 } ObjectInstanceRen;
346
347 /* ------------------------------------------------------------------------- */
348
349 typedef struct VertRen
350 {
351         float co[3];
352         float n[3];
353         float *orco;
354         unsigned int flag;      /* in use for clipping zbuffer parts, temp setting stuff in convertblender.c
355                                                  * only an 'int' because of alignment, could be a char too */
356         float accum;            /* accum for radio weighting, and for strand texco static particles */
357         int index;                      /* index allows extending vertren with any property */
358 } VertRen;
359
360 /* ------------------------------------------------------------------------- */
361
362 struct halosort {
363         struct HaloRen *har;
364         int z;
365 };
366
367 /* ------------------------------------------------------------------------- */
368 struct Material;
369 struct MTFace;
370
371 typedef struct RadFace {
372         float unshot[3], totrad[3];
373         float norm[3], cent[3], area;
374         int flag;
375 } RadFace;
376
377 typedef struct VlakRen {
378         struct VertRen *v1, *v2, *v3, *v4;      /* keep in order for ** addressing */
379         float n[3];
380         struct Material *mat;
381         char puno;
382         char flag, ec;
383         int index;
384 } VlakRen;
385
386 typedef struct HaloRen
387 {       
388         short miny, maxy;
389         float alfa, xs, ys, rad, radsq, sin, cos, co[3], no[3];
390         float hard, b, g, r;
391         int zs, zd;
392         int zBufDist;   /* depth in the z-buffer coordinate system */
393         char starpoints, type, add, tex;
394         char linec, ringc, seed;
395         short flarec; /* used to be a char. why ?*/
396         float hasize;
397         int pixels;
398         unsigned int lay;
399         struct Material *mat;
400 } HaloRen;
401
402 /* ------------------------------------------------------------------------- */
403
404 typedef struct StrandVert {
405         float co[3];
406         float strandco;
407 } StrandVert;
408
409 typedef struct StrandSurface {
410         struct StrandSurface *next, *prev;
411         ObjectRen obr;
412         int (*face)[4];
413         float (*co)[3];
414         /* for occlusion caching */
415         float (*ao)[3];
416         float (*env)[3];
417         float (*indirect)[3];
418         /* for speedvectors */
419         float (*prevco)[3], (*nextco)[3];
420         int totvert, totface;
421 } StrandSurface;
422
423 typedef struct StrandBound {
424         int start, end;
425         float boundbox[2][3];
426 } StrandBound;
427
428 typedef struct StrandBuffer {
429         struct StrandBuffer *next, *prev;
430         struct StrandVert *vert;
431         struct StrandBound *bound;
432         int totvert, totbound;
433
434         struct ObjectRen *obr;
435         struct Material *ma;
436         struct StrandSurface *surface;
437         unsigned int lay;
438         int overrideuv;
439         int flag, maxdepth;
440         float adaptcos, minwidth, widthfade;
441         
442         float maxwidth; /* for cliptest of strands in blender unit */
443         
444         float winmat[4][4];
445         int winx, winy;
446 } StrandBuffer;
447
448 typedef struct StrandRen {
449         StrandVert *vert;
450         StrandBuffer *buffer;
451         int totvert, flag;
452         int clip, index;
453         float orco[3];
454 } StrandRen;
455
456 /* ------------------------------------------------------------------------- */
457
458 typedef struct VolumeOb
459 {
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 {
473         struct VolPrecachePart *next, *prev;
474         struct RayObject *tree;
475         struct ShadeInput *shi;
476         struct ObjectInstanceRen *obi;
477         float viewmat[4][4];
478         int num;
479         int minx, maxx;
480         int miny, maxy;
481         int minz, maxz;
482         int res[3];
483         float bbmin[3];
484         float voxel[3];
485         struct Render *re;
486 } VolPrecachePart;
487
488 typedef struct VolumePrecache
489 {
490         int res[3];
491         float *bbmin, *bbmax;
492         float *data_r;
493         float *data_g;
494         float *data_b;
495 } VolumePrecache;
496
497 /* ------------------------------------------------------------------------- */
498
499 struct LampRen;
500 struct MTex;
501
502 /**
503  * For each lamp in a scene, a LampRen is created. It determines the
504  * properties of a lightsource.
505  */
506
507 typedef struct LampShadowSubSample {
508         int samplenr;
509         float shadfac[4];       /* rgba shadow */
510 } LampShadowSubSample;
511
512 typedef struct LampShadowSample {
513         LampShadowSubSample s[16];      /* MAX OSA */
514 } LampShadowSample;
515
516 typedef struct LampRen {
517         struct LampRen *next, *prev;
518         
519         float xs, ys, dist;
520         float co[3];
521         short type;
522         int mode;
523         float r, g, b, k;
524         float shdwr, shdwg, shdwb;
525         float energy, haint;
526         int lay;
527         float spotsi,spotbl;
528         float vec[3];
529         float xsp, ysp, distkw, inpr;
530         float halokw, halo;
531         
532         short falloff_type;
533         float ld1,ld2;
534         struct CurveMapping *curfalloff;
535
536         /* copied from Lamp, to decouple more rendering stuff */
537         /** Size of the shadowbuffer */
538         short bufsize;
539         /** Number of samples for the shadows */
540         short samp;
541         /** Softness factor for shadow */
542         float soft;
543         /** amount of subsample buffers and type of filter for sampling */
544         short buffers, filtertype;
545         /** shadow buffer type (regular, irregular) */
546         short buftype;
547         /** autoclip */
548         short bufflag;
549         /** shadow plus halo: detail level */
550         short shadhalostep;
551         /** Near clip of the lamp */
552         float clipsta;
553         /** Far clip of the lamp */
554         float clipend;
555         /** A small depth offset to prevent self-shadowing. */
556         float bias;
557         /* Compression threshold for deep shadow maps */
558         float compressthresh;
559         
560         short ray_samp, ray_sampy, ray_sampz, ray_samp_method, ray_samp_type, area_shape, ray_totsamp;
561         short xold[BLENDER_MAX_THREADS], yold[BLENDER_MAX_THREADS];     /* last jitter table for area lights */
562         float area_size, area_sizey, area_sizez;
563         float adapt_thresh;
564
565         /* sun/sky */
566         struct SunSky *sunsky;
567         
568         struct ShadBuf *shb;
569         float *jitter;
570         
571         float imat[3][3];
572         float spottexfac;
573         float sh_invcampos[3], sh_zfac; /* sh_= spothalo */
574         
575         float mat[3][3];        /* 3x3 part from lampmat x viewmat */
576         float area[8][3], areasize;
577         
578         /* passes & node shader support: all shadow info for a pixel */
579         LampShadowSample *shadsamp;
580         
581         /* ray optim */
582         struct RayObject *last_hit[BLENDER_MAX_THREADS];
583         
584         struct MTex *mtex[MAX_MTEX];
585
586         /* threading */
587         int thread_assigned;
588         int thread_ready;
589 } LampRen;
590
591 /* **************** defines ********************* */
592
593 /* R.r.mode flag is same as for renderdata */
594
595 /* R.flag */
596 #define R_ZTRA                  1
597 #define R_HALO                  2
598 #define R_SEC_FIELD             4
599 #define R_LAMPHALO              8
600 #define R_NEED_TANGENT  16
601 #define R_BAKE_TRACE    32
602 #define R_BAKING                64
603 #define R_ANIMATION             128
604
605 /* vlakren->flag (vlak = face in dutch) char!!! */
606 #define R_SMOOTH                1
607 #define R_HIDDEN                2
608 /* strand flag, means special handling */
609 #define R_STRAND                4
610 #define R_FULL_OSA              8
611 #define R_FACE_SPLIT    16
612 /* Tells render to divide face other way. */
613 #define R_DIVIDE_24             32      
614 /* vertex normals are tangent or view-corrected vector, for hair strands */
615 #define R_TANGENT               64              
616 #define R_TRACEBLE              128
617
618 /* strandbuffer->flag */
619 #define R_STRAND_BSPLINE        1
620 #define R_STRAND_B_UNITS        2
621
622 /* objectren->flag */
623 #define R_INSTANCEABLE          1
624
625 /* objectinstance->flag */
626 #define R_DUPLI_TRANSFORMED     1
627 #define R_ENV_TRANSFORMED       2
628 #define R_TRANSFORMED           (1|2)
629 #define R_NEED_VECTORS          4
630
631 #endif /* RENDER_TYPES_H */
632