Merged changes in the trunk up to revision 41225.
[blender-staging.git] / source / blender / render / extern / include / RE_pipeline.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) 2006 Blender Foundation.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file RE_pipeline.h
31  *  \ingroup render
32  */
33
34 #ifndef RE_PIPELINE_H
35 #define RE_PIPELINE_H
36
37 #include "DNA_listBase.h"
38 #include "DNA_vec_types.h"
39
40 struct bNodeTree;
41 struct Image;
42 struct Main;
43 struct NodeBlurData;
44 struct Object;
45 struct RenderData;
46 struct RenderResult;
47 struct ReportList;
48 struct Scene;
49 struct SceneRenderLayer;
50 struct EnvMap;
51
52 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
53 /* this include is what is exposed of render to outside world */
54 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
55
56
57 #define RE_MAXNAME      32
58
59 /* only used as handle */
60 typedef struct Render Render;
61
62 /* Render Result usage:
63
64 - render engine allocates/frees and delivers raw floating point rects
65 - right now it's full rects, but might become tiles or file 
66 - the display client has to allocate display rects, sort out what to display, 
67   and how it's converted
68 */
69
70 typedef struct RenderPass {
71         struct RenderPass *next, *prev;
72         int passtype, channels;
73         char name[16];          /* amount defined in openexr_multi.h */
74         char chan_id[8];        /* amount defined in openexr_multi.h */
75         float *rect;
76         int rectx, recty;
77 } RenderPass;
78
79 /* a renderlayer is a full image, but with all passes and samples */
80 /* size of the rects is defined in RenderResult */
81 /* after render, the Combined pass is in rectf, for renderlayers read from files it is a real pass */
82 typedef struct RenderLayer {
83         struct RenderLayer *next, *prev;
84         
85         /* copy of RenderData */
86         char name[RE_MAXNAME];          
87         unsigned int lay, lay_zmask;
88         int layflag, passflag, pass_xor;                
89         
90         struct Material *mat_override;
91         struct Group *light_override;
92         
93         float *rectf;           /* 4 float, standard rgba buffer (read not above!) */
94         float *acolrect;        /* 4 float, optional transparent buffer, needs storage for display updates */
95         float *scolrect;        /* 4 float, optional strand buffer, needs storage for display updates */
96         int rectx, recty;
97         
98         ListBase passes;
99         
100 } RenderLayer;
101
102 typedef struct RenderResult {
103         struct RenderResult *next, *prev;
104         
105         /* target image size */
106         int rectx, recty;
107         short crop, sample_nr;
108         
109         /* optional, 32 bits version of picture, used for ogl render and image curves */
110         int *rect32;
111         /* if this exists, a copy of one of layers, or result of composited layers */
112         float *rectf;
113         /* if this exists, a copy of one of layers, or result of composited layers */
114         float *rectz;
115         
116         /* coordinates within final image (after cropping) */
117         rcti tilerect;
118         /* offset to apply to get a border render in full image */
119         int xof, yof;
120         
121         /* the main buffers */
122         ListBase layers;
123         
124         /* allowing live updates: */
125         volatile rcti renrect;
126         volatile RenderLayer *renlay;
127         
128         /* optional saved endresult on disk */
129         void *exrhandle;
130         
131         /* for render results in Image, verify validity for sequences */
132         int framenr;
133
134         /* for acquire image, to indicate if it there is a combined layer */
135         int have_combined;
136
137         /* render info text */
138         char *text;
139         
140 } RenderResult;
141
142
143 typedef struct RenderStats {
144         int cfra;
145         int totface, totvert, totstrand, tothalo, totlamp, totpart;
146         short curfield, curblur, curpart, partsdone, convertdone, curfsa;
147         double starttime, lastframetime;
148         const char *infostr, *statstr;
149         char scenename[32];
150         
151 } RenderStats;
152
153 /* *********************** API ******************** */
154
155 /* the name is used as identifier, so elsewhere in blender the result can retrieved */
156 /* calling a new render with same name, frees automatic existing render */
157 struct Render *RE_NewRender (const char *name);
158 struct Render *RE_GetRender(const char *name);
159
160 /* returns 1 while render is working (or renders called from within render) */
161 int RE_RenderInProgress(struct Render *re);
162
163 /* assign default dummy callbacks */
164 void RE_InitRenderCB(struct Render *re);
165
166 /* use free render as signal to do everything over (previews) */
167 void RE_FreeRender (struct Render *re);
168 /* only called on exit */
169 void RE_FreeAllRender (void);
170
171 /* get results and statistics */
172 void RE_FreeRenderResult(struct RenderResult *rr);
173 struct RenderResult *RE_AcquireResultRead(struct Render *re);
174 struct RenderResult *RE_AcquireResultWrite(struct Render *re);
175 void RE_ReleaseResult(struct Render *re);
176 void RE_AcquireResultImage(struct Render *re, struct RenderResult *rr);
177 void RE_ReleaseResultImage(struct Render *re);
178 void RE_SwapResult(struct Render *re, struct RenderResult **rr);
179 struct RenderStats *RE_GetStats(struct Render *re);
180 void RE_ResultGet32(struct Render *re, unsigned int *rect);
181 struct RenderLayer *RE_GetRenderLayer(struct RenderResult *rr, const char *name);
182 float *RE_RenderLayerGetPass(struct RenderLayer *rl, int passtype);
183
184 /* obligatory initialize call, disprect is optional */
185 void RE_InitState (struct Render *re, struct Render *source, struct RenderData *rd, struct SceneRenderLayer *srl, int winx, int winy, rcti *disprect);
186
187 /* use this to change disprect of active render */
188 void RE_SetDispRect (struct Render *re, rcti *disprect);
189
190 /* set up the viewplane/perspective matrix, three choices */
191 struct Object *RE_GetCamera(struct Render *re); /* return camera override if set */
192 void RE_SetCamera(struct Render *re, struct Object *camera);
193 void RE_SetWindow (struct Render *re, rctf *viewplane, float clipsta, float clipend);
194 void RE_SetOrtho (struct Render *re, rctf *viewplane, float clipsta, float clipend);
195 void RE_SetPixelSize(struct Render *re, float pixsize);
196
197 /* option to set viewmatrix before making dbase */
198 void RE_SetView (struct Render *re, float mat[][4]);
199
200 /* make or free the dbase */
201 void RE_Database_FromScene(struct Render *re, struct Main *bmain, struct Scene *scene, unsigned int lay, int use_camera_view);
202 void RE_Database_Free (struct Render *re);
203
204 /* project dbase again, when viewplane/perspective changed */
205 void RE_DataBase_ApplyWindow(struct Render *re);
206
207 /* override the scene setting for amount threads, commandline */
208 void RE_set_max_threads(int threads);
209
210 /* set the render threads based on the commandline and autothreads setting */
211 void RE_init_threadcount(Render *re);
212
213 /* the main processor, assumes all was set OK! */
214 void RE_TileProcessor(struct Render *re);
215
216 /* only RE_NewRender() needed, main Blender render calls */
217 void RE_BlenderFrame(struct Render *re, struct Main *bmain, struct Scene *scene, struct SceneRenderLayer *srl, struct Object *camera_override, unsigned int lay, int frame, const short write_still);
218 void RE_BlenderAnim(struct Render *re, struct Main *bmain, struct Scene *scene, struct Object *camera_override, unsigned int lay, int sfra, int efra, int tfra);
219 void RE_RenderFreestyleStrokes(struct Render *re, struct Main *bmain, struct Scene *scene);
220
221 /* error reporting */
222 void RE_SetReports(struct Render *re, struct ReportList *reports);
223
224 /* main preview render call */
225 void RE_PreviewRender(struct Render *re, struct Main *bmain, struct Scene *scene);
226
227 int RE_ReadRenderResult(struct Scene *scene, struct Scene *scenode);
228 int RE_WriteRenderResult(struct ReportList *reports, RenderResult *rr, const char *filename, int compress);
229 struct RenderResult *RE_MultilayerConvert(void *exrhandle, int rectx, int recty);
230
231 extern const float default_envmap_layout[];
232 int RE_WriteEnvmapResult(struct ReportList *reports, struct Scene *scene, struct EnvMap *env, const char *relpath, int imtype, float layout[12]);
233
234 /* do a full sample buffer compo */
235 void RE_MergeFullSample(struct Render *re, struct Main *bmain, struct Scene *sce, struct bNodeTree *ntree);
236
237 /* ancient stars function... go away! */
238 void RE_make_stars(struct Render *re, struct Scene *scenev3d, void (*initfunc)(void),
239                                    void (*vertexfunc)(float*),  void (*termfunc)(void));
240
241 /* display and event callbacks */
242 void RE_display_init_cb (struct Render *re, void *handle, void (*f)(void *handle, RenderResult *rr));
243 void RE_display_clear_cb(struct Render *re, void *handle, void (*f)(void *handle, RenderResult *rr));
244 void RE_display_draw_cb (struct Render *re, void *handle, void (*f)(void *handle, RenderResult *rr, volatile struct rcti *rect));
245 void RE_stats_draw_cb   (struct Render *re, void *handle, void (*f)(void *handle, RenderStats *rs));
246 void RE_progress_cb     (struct Render *re, void *handle, void (*f)(void *handle, float));
247 void RE_draw_lock_cb            (struct Render *re, void *handle, void (*f)(void *handle, int));
248 void RE_test_break_cb   (struct Render *re, void *handle, int (*f)(void *handle));
249
250 /* should move to kernel once... still unsure on how/where */
251 float RE_filter_value(int type, float x);
252 /* vector blur zbuffer method */
253 void RE_zbuf_accumulate_vecblur(struct NodeBlurData *nbd, int xsize, int ysize, float *newrect, float *imgrect, float *vecbufrect, float *zbufrect);
254
255 /* shaded view or baking options */
256 #define RE_BAKE_LIGHT                           0       /* not listed in rna_scene.c -> can't be enabled! */
257 #define RE_BAKE_ALL                                     1
258 #define RE_BAKE_AO                                      2
259 #define RE_BAKE_NORMALS                         3
260 #define RE_BAKE_TEXTURE                         4
261 #define RE_BAKE_DISPLACEMENT            5
262 #define RE_BAKE_SHADOW                          6
263 #define RE_BAKE_SPEC_COLOR                      7
264 #define RE_BAKE_SPEC_INTENSITY          8
265 #define RE_BAKE_MIRROR_COLOR            9
266 #define RE_BAKE_MIRROR_INTENSITY        10
267 #define RE_BAKE_ALPHA                           11
268 #define RE_BAKE_EMIT                            12
269
270 void RE_Database_Baking(struct Render *re, struct Main *bmain, struct Scene *scene, unsigned int lay, const int type, struct Object *actob);
271
272 void RE_DataBase_GetView(struct Render *re, float mat[][4]);
273 void RE_GetCameraWindow(struct Render *re, struct Object *camera, int frame, float mat[][4]);
274 struct Scene *RE_GetScene(struct Render *re);
275
276 int RE_is_rendering_allowed(struct Scene *scene, struct Object *camera_override, struct ReportList *reports);
277
278 #endif /* RE_PIPELINE_H */
279