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