95c87b520436fd349f9308df3ab6d609f108d9d7
[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 bMovieHandle;
39 struct bNodeTree;
40 struct Image;
41 struct ImageFormatData;
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 struct StampData;
52
53 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
54 /* this include is what is exposed of render to outside world */
55 /* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
56
57 /* length of the scene name + passname */
58 #define RE_MAXNAME      ((MAX_ID_NAME - 2) + 10)
59
60 /* only used as handle */
61 typedef struct Render Render;
62
63 /* Render Result usage:
64  *
65  * - render engine allocates/frees and delivers raw floating point rects
66  * - right now it's full rects, but might become tiles or file
67  * - the display client has to allocate display rects, sort out what to display,
68  *   and how it's converted
69  */
70
71 typedef struct RenderView {
72         struct RenderView *next, *prev;
73         char name[64];          /* EXR_VIEW_MAXNAME */
74
75         /* if this exists, result of composited layers */
76         float *rectf;
77         /* if this exists, result of composited layers */
78         float *rectz;
79         /* optional, 32 bits version of picture, used for sequencer, ogl render and image curves */
80         int *rect32;
81
82 } RenderView;
83
84 typedef struct RenderPass {
85         struct RenderPass *next, *prev;
86         int channels;
87         char name[64];          /* amount defined in openexr_multi.h */
88         char chan_id[8];        /* amount defined in openexr_multi.h */
89         float *rect;
90         int rectx, recty;
91
92         char fullname[64]; /* EXR_PASS_MAXNAME */
93         char view[64];          /* EXR_VIEW_MAXNAME */
94         int view_id;    /* quick lookup */
95
96         int pad;
97 } RenderPass;
98
99
100 /* a renderlayer is a full image, but with all passes and samples */
101 /* size of the rects is defined in RenderResult */
102 /* after render, the Combined pass is in combined, for renderlayers read from files it is a real pass */
103 typedef struct RenderLayer {
104         struct RenderLayer *next, *prev;
105
106         /* copy of RenderData */
107         char name[RE_MAXNAME];
108         unsigned int lay, lay_zmask, lay_exclude;
109         int layflag, passflag, pass_xor;
110
111         struct Material *mat_override;
112         struct Group *light_override;
113
114         /* MULTIVIEW_TODO: acolrect and scolrect are not supported by multiview at the moment.
115          * If they are really required they should be in RenderView instead */
116
117         float *acolrect;        /* 4 float, optional transparent buffer, needs storage for display updates */
118         float *scolrect;        /* 4 float, optional strand buffer, needs storage for display updates */
119         int *display_buffer;    /* 4 char, optional color managed display buffer which is used when
120                                  * Save Buffer is enabled to display combined pass of the screen. */
121         int rectx, recty;
122
123         /* optional saved endresult on disk */
124         void *exrhandle;
125
126         ListBase passes;
127
128 } RenderLayer;
129
130 typedef struct RenderResult {
131         struct RenderResult *next, *prev;
132
133         /* target image size */
134         int rectx, recty;
135         short crop, sample_nr;
136
137         /* the following rect32, rectf and rectz buffers are for temporary storage only, for RenderResult structs
138          * created in #RE_AcquireResultImage - which do not have RenderView */
139
140         /* optional, 32 bits version of picture, used for ogl render and image curves */
141         int *rect32;
142         /* if this exists, a copy of one of layers, or result of composited layers */
143         float *rectf;
144         /* if this exists, a copy of one of layers, or result of composited layers */
145         float *rectz;
146
147         /* coordinates within final image (after cropping) */
148         rcti tilerect;
149         /* offset to apply to get a border render in full image */
150         int xof, yof;
151
152         /* the main buffers */
153         ListBase layers;
154
155         /* multiView maps to a StringVector in OpenEXR */
156         ListBase views;  /* RenderView */
157
158         /* allowing live updates: */
159         volatile rcti renrect;
160         volatile RenderLayer *renlay;
161
162         /* optional saved endresult on disk */
163         int do_exr_tile;
164
165         /* for render results in Image, verify validity for sequences */
166         int framenr;
167
168         /* for acquire image, to indicate if it there is a combined layer */
169         int have_combined;
170
171         /* render info text */
172         char *text;
173         char *error;
174
175         struct StampData *stamp_data;
176 } RenderResult;
177
178
179 typedef struct RenderStats {
180         int cfra;
181         int totface, totvert, totstrand, tothalo, totlamp, totpart;
182         short curfield, curblur, curpart, partsdone, convertdone, curfsa;
183         bool localview;
184         double starttime, lastframetime;
185         const char *infostr, *statstr;
186         char scene_name[MAX_ID_NAME - 2];
187         float mem_used, mem_peak;
188 } RenderStats;
189
190 /* *********************** API ******************** */
191
192 /* the name is used as identifier, so elsewhere in blender the result can retrieved */
193 /* calling a new render with same name, frees automatic existing render */
194 struct Render *RE_NewRender(const char *name);
195 struct Render *RE_GetRender(const char *name);
196
197 struct Scene;
198 struct Render *RE_NewSceneRender(const struct Scene *scene);
199 struct Render *RE_GetSceneRender(const struct Scene *scene);
200
201 /* assign default dummy callbacks */
202 void RE_InitRenderCB(struct Render *re);
203
204 /* use free render as signal to do everything over (previews) */
205 void RE_FreeRender(struct Render *re);
206 /* only called on exit */
207 void RE_FreeAllRender(void);
208 /* Free memory used by persistent data.
209  * Invoked when loading new file.
210  */
211 void RE_FreeAllPersistentData(void);
212 /* only call on file load */
213 void RE_FreeAllRenderResults(void);
214 /* for external render engines that can keep persistent data */
215 void RE_FreePersistentData(void);
216
217 /* get results and statistics */
218 void RE_FreeRenderResult(struct RenderResult *rr);
219 struct RenderResult *RE_AcquireResultRead(struct Render *re);
220 struct RenderResult *RE_AcquireResultWrite(struct Render *re);
221 void RE_ReleaseResult(struct Render *re);
222 void RE_AcquireResultImageViews(struct Render *re, struct RenderResult *rr);
223 void RE_ReleaseResultImageViews(struct Render *re, struct RenderResult *rr);
224 void RE_AcquireResultImage(struct Render *re, struct RenderResult *rr, const int view_id);
225 void RE_ReleaseResultImage(struct Render *re);
226 void RE_SwapResult(struct Render *re, struct RenderResult **rr);
227 struct RenderStats *RE_GetStats(struct Render *re);
228
229 void RE_ResultGet32(struct Render *re, unsigned int *rect);
230 void RE_AcquiredResultGet32(struct Render *re, struct RenderResult *result, unsigned int *rect, const int view_id);
231
232 void RE_render_result_rect_from_ibuf(
233         struct RenderResult *rr, struct RenderData *rd,
234         struct ImBuf *ibuf, const int view_id);
235
236 struct RenderLayer *RE_GetRenderLayer(struct RenderResult *rr, const char *name);
237 float *RE_RenderLayerGetPass(volatile struct RenderLayer *rl, const char *name, const char *viewname);
238
239 bool RE_HasSingleLayer(struct Render *re);
240
241 /* add passes for grease pencil */
242 struct RenderPass *RE_create_gp_pass(struct RenderResult *rr, const char *layername, const char *viewname);
243
244 /* obligatory initialize call, disprect is optional */
245 void RE_InitState(struct Render *re, struct Render *source, struct RenderData *rd,
246                   struct SceneRenderLayer *srl,
247                   int winx, int winy, rcti *disprect);
248 void RE_ChangeResolution(struct Render *re, int winx, int winy, rcti *disprect);
249 void RE_ChangeModeFlag(struct Render *re, int flag, bool clear);
250
251 /* set up the viewplane/perspective matrix, three choices */
252 struct Object *RE_GetCamera(struct Render *re); /* return camera override if set */
253 void RE_SetOverrideCamera(struct Render *re, struct Object *camera);
254 void RE_SetCamera(struct Render *re, struct Object *camera);
255 void RE_SetEnvmapCamera(struct Render *re, struct Object *cam_ob, float viewscale, float clipsta, float clipend);
256 void RE_SetWindow(struct Render *re, const rctf *viewplane, float clipsta, float clipend);
257 void RE_SetOrtho(struct Render *re, const rctf *viewplane, float clipsta, float clipend);
258 void RE_SetPixelSize(struct Render *re, float pixsize);
259
260 /* option to set viewmatrix before making dbase */
261 void RE_SetView(struct Render *re, float mat[4][4]);
262
263 /* get current view and window transform */
264 void RE_GetView(struct Render *re, float mat[4][4]);
265 void RE_GetViewPlane(struct Render *re, rctf *r_viewplane, rcti *r_disprect);
266
267 /* make or free the dbase */
268 void RE_Database_FromScene(
269         struct Render *re, struct Main *bmain, struct Scene *scene,
270         unsigned int lay, int use_camera_view);
271 void RE_Database_Preprocess(struct Render *re);
272 void RE_Database_Free(struct Render *re);
273
274 /* project dbase again, when viewplane/perspective changed */
275 void RE_DataBase_ApplyWindow(struct Render *re);
276 /* rotate scene again, for incremental render */
277 void RE_DataBase_IncrementalView(struct Render *re, float viewmat[4][4], int restore);
278
279 /* set the render threads based on the commandline and autothreads setting */
280 void RE_init_threadcount(Render *re);
281
282 /* the main processor, assumes all was set OK! */
283 void RE_TileProcessor(struct Render *re);
284
285 bool RE_WriteRenderViewsImage(
286         struct ReportList *reports, struct RenderResult *rr, struct Scene *scene, const bool stamp, char *name);
287 bool RE_WriteRenderViewsMovie(
288         struct ReportList *reports, struct RenderResult *rr, struct Scene *scene, struct RenderData *rd,
289         struct bMovieHandle *mh, void **movie_ctx_arr,
290         const int totvideos, bool preview);
291
292 /* only RE_NewRender() needed, main Blender render calls */
293 void RE_BlenderFrame(struct Render *re, struct Main *bmain, struct Scene *scene,
294                      struct SceneRenderLayer *srl, struct Object *camera_override,
295                      unsigned int lay_override, int frame, const bool write_still);
296 void RE_BlenderAnim(struct Render *re, struct Main *bmain, struct Scene *scene, struct Object *camera_override,
297                     unsigned int lay_override, int sfra, int efra, int tfra);
298 #ifdef WITH_FREESTYLE
299 void RE_RenderFreestyleStrokes(struct Render *re, struct Main *bmain, struct Scene *scene, int render);
300 void RE_RenderFreestyleExternal(struct Render *re);
301 #endif
302
303 void RE_SetActiveRenderView(struct Render *re, const char *viewname);
304 const char *RE_GetActiveRenderView(struct Render *re);
305
306 /* error reporting */
307 void RE_SetReports(struct Render *re, struct ReportList *reports);
308
309 /* main preview render call */
310 void RE_PreviewRender(struct Render *re, struct Main *bmain, struct Scene *scene);
311
312 bool RE_ReadRenderResult(struct Scene *scene, struct Scene *scenode);
313 bool RE_WriteRenderResult(
314         struct ReportList *reports, RenderResult *rr, const char *filename,
315         struct ImageFormatData *imf, const char *view, int layer);
316 struct RenderResult *RE_MultilayerConvert(
317         void *exrhandle, const char *colorspace, bool predivide, int rectx, int recty);
318
319 extern const float default_envmap_layout[];
320 bool RE_WriteEnvmapResult(
321         struct ReportList *reports, struct Scene *scene, struct EnvMap *env,
322         const char *relpath, const char imtype, float layout[12]);
323
324 /* do a full sample buffer compo */
325 void RE_MergeFullSample(struct Render *re, struct Main *bmain, struct Scene *sce, struct bNodeTree *ntree);
326
327 /* display and event callbacks */
328 void RE_display_init_cb (struct Render *re, void *handle, void (*f)(void *handle, RenderResult *rr));
329 void RE_display_clear_cb(struct Render *re, void *handle, void (*f)(void *handle, RenderResult *rr));
330 void RE_display_update_cb(struct Render *re, void *handle, void (*f)(void *handle, RenderResult *rr, volatile struct rcti *rect));
331 void RE_stats_draw_cb   (struct Render *re, void *handle, void (*f)(void *handle, RenderStats *rs));
332 void RE_progress_cb     (struct Render *re, void *handle, void (*f)(void *handle, float));
333 void RE_draw_lock_cb            (struct Render *re, void *handle, void (*f)(void *handle, int));
334 void RE_test_break_cb   (struct Render *re, void *handle, int (*f)(void *handle));
335 void RE_current_scene_update_cb(struct Render *re, void *handle, void (*f)(void *handle, struct Scene *scene));
336
337 /* should move to kernel once... still unsure on how/where */
338 float RE_filter_value(int type, float x);
339
340 int RE_seq_render_active(struct Scene *scene, struct RenderData *rd);
341
342 bool RE_layers_have_name(struct RenderResult *result);
343 bool RE_passes_have_name(struct RenderLayer *rl);
344
345 struct RenderPass *RE_pass_find_by_name(volatile struct RenderLayer *rl, const char *name, const char *viewname);
346 struct RenderPass *RE_pass_find_by_type(volatile struct RenderLayer *rl, int passtype, const char *viewname);
347
348 /* shaded view or baking options */
349 #define RE_BAKE_LIGHT                           0       /* not listed in rna_scene.c -> can't be enabled! */
350 #define RE_BAKE_ALL                                     1
351 #define RE_BAKE_AO                                      2
352 #define RE_BAKE_NORMALS                         3
353 #define RE_BAKE_TEXTURE                         4
354 #define RE_BAKE_DISPLACEMENT            5
355 #define RE_BAKE_SHADOW                          6
356 #define RE_BAKE_SPEC_COLOR                      7
357 #define RE_BAKE_SPEC_INTENSITY          8
358 #define RE_BAKE_MIRROR_COLOR            9
359 #define RE_BAKE_MIRROR_INTENSITY        10
360 #define RE_BAKE_ALPHA                           11
361 #define RE_BAKE_EMIT                            12
362 #define RE_BAKE_DERIVATIVE                      13
363 #define RE_BAKE_VERTEX_COLORS           14
364
365 void RE_Database_Baking(
366         struct Render *re, struct Main *bmain, struct Scene *scene,
367         unsigned int lay, const int type, struct Object *actob);
368
369 void RE_DataBase_GetView(struct Render *re, float mat[4][4]);
370 void RE_GetCameraWindow(struct Render *re, struct Object *camera, int frame, float mat[4][4]);
371 void RE_GetCameraModelMatrix(struct Render *re, struct Object *camera, float r_mat[4][4]);
372 struct Scene *RE_GetScene(struct Render *re);
373
374 bool RE_force_single_renderlayer(struct Scene *scene);
375 bool RE_is_rendering_allowed(struct Scene *scene, struct Object *camera_override, struct ReportList *reports);
376
377 bool RE_allow_render_generic_object(struct Object *ob);
378
379 /* RE_updateRenderInstances flag */
380 enum {
381         RE_OBJECT_INSTANCES_UPDATE_VIEW  = (1 << 0),
382         RE_OBJECT_INSTANCES_UPDATE_OBMAT = (1 << 1)
383 };
384 void RE_updateRenderInstances(Render *re, int flag);
385
386 /******* defined in render_result.c *********/
387
388 bool RE_HasCombinedLayer(RenderResult *res);
389 bool RE_HasFloatPixels(RenderResult *res);
390 bool RE_RenderResult_is_stereo(RenderResult *res);
391 struct RenderView *RE_RenderViewGetById(struct RenderResult *res, const int view_id);
392 struct RenderView *RE_RenderViewGetByName(struct RenderResult *res, const char *viewname);
393
394 RenderResult *RE_DuplicateRenderResult(RenderResult *rr);
395
396 #endif /* __RE_PIPELINE_H__ */