Big i18n commit: add "reports" from bmesh/readfile/tracking/dynapaint (and a few...
[blender.git] / source / blender / editors / render / render_internal.c
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) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/editors/render/render_internal.c
26  *  \ingroup edrend
27  */
28
29
30 #include <math.h>
31 #include <string.h>
32 #include <stddef.h>
33
34 #include "MEM_guardedalloc.h"
35
36 #include "BLI_blenlib.h"
37 #include "BLI_math.h"
38 #include "BLI_threads.h"
39 #include "BLI_rand.h"
40 #include "BLI_utildefines.h"
41
42 #include "DNA_scene_types.h"
43
44 #include "BKE_blender.h"
45 #include "BKE_context.h"
46 #include "BKE_global.h"
47 #include "BKE_image.h"
48 #include "BKE_library.h"
49 #include "BKE_main.h"
50 #include "BKE_node.h"
51 #include "BKE_multires.h"
52 #include "BKE_report.h"
53 #include "BKE_sequencer.h"
54 #include "BKE_screen.h"
55 #include "BKE_scene.h"
56
57 #include "WM_api.h"
58 #include "WM_types.h"
59
60 #include "ED_screen.h"
61 #include "ED_object.h"
62
63 #include "RE_pipeline.h"
64 #include "IMB_colormanagement.h"
65 #include "IMB_imbuf.h"
66 #include "IMB_imbuf_types.h"
67
68 #include "RNA_access.h"
69 #include "RNA_define.h"
70
71 #include "wm_window.h"
72
73 #include "render_intern.h"
74
75 /* Render Callbacks */
76
77 /* called inside thread! */
78 void image_buffer_rect_update(Scene *scene, RenderResult *rr, ImBuf *ibuf, volatile rcti *renrect)
79 {
80         float *rectf = NULL;
81         int ymin, ymax, xmin, xmax;
82         int rymin, rxmin;
83
84         /* if renrect argument, we only refresh scanlines */
85         if (renrect) {
86                 /* if (ymax == recty), rendering of layer is ready, we should not draw, other things happen... */
87                 if (rr->renlay == NULL || renrect->ymax >= rr->recty)
88                         return;
89
90                 /* xmin here is first subrect x coord, xmax defines subrect width */
91                 xmin = renrect->xmin + rr->crop;
92                 xmax = renrect->xmax - xmin + rr->crop;
93                 if (xmax < 2)
94                         return;
95
96                 ymin = renrect->ymin + rr->crop;
97                 ymax = renrect->ymax - ymin + rr->crop;
98                 if (ymax < 2)
99                         return;
100                 renrect->ymin = renrect->ymax;
101
102         }
103         else {
104                 xmin = ymin = rr->crop;
105                 xmax = rr->rectx - 2 * rr->crop;
106                 ymax = rr->recty - 2 * rr->crop;
107         }
108
109         /* xmin ymin is in tile coords. transform to ibuf */
110         rxmin = rr->tilerect.xmin + xmin;
111         if (rxmin >= ibuf->x) return;
112         rymin = rr->tilerect.ymin + ymin;
113         if (rymin >= ibuf->y) return;
114
115         if (rxmin + xmax > ibuf->x)
116                 xmax = ibuf->x - rxmin;
117         if (rymin + ymax > ibuf->y)
118                 ymax = ibuf->y - rymin;
119
120         if (xmax < 1 || ymax < 1) return;
121
122         /* find current float rect for display, first case is after composite... still weak */
123         if (rr->rectf)
124                 rectf = rr->rectf;
125         else {
126                 if (rr->rect32) {
127                         /* special case, currently only happens with sequencer rendering,
128                          * which updates the whole frame, so we can only mark display buffer
129                          * as invalid here (sergey)
130                          */
131                         ibuf->userflags |= IB_DISPLAY_BUFFER_INVALID;
132                         return;
133                 }
134                 else {
135                         if (rr->renlay == NULL || rr->renlay->rectf == NULL) return;
136                         rectf = rr->renlay->rectf;
137                 }
138         }
139         if (rectf == NULL) return;
140
141         if (ibuf->rect == NULL)
142                 imb_addrectImBuf(ibuf);
143         
144         rectf += 4 * (rr->rectx * ymin + xmin);
145
146         IMB_partial_display_buffer_update(ibuf, rectf, NULL, rr->rectx, rxmin, rymin,
147                                           &scene->view_settings, &scene->display_settings,
148                                           rxmin, rymin, rxmin + xmax, rymin + ymax, TRUE);
149 }
150
151 /* ****************************** render invoking ***************** */
152
153 /* set callbacks, exported to sequence render too.
154  * Only call in foreground (UI) renders. */
155
156 static void screen_render_scene_layer_set(wmOperator *op, Main *mainp, Scene **scene, SceneRenderLayer **srl)
157 {
158         /* single layer re-render */
159         if (RNA_struct_property_is_set(op->ptr, "scene")) {
160                 Scene *scn;
161                 char scene_name[MAX_ID_NAME - 2];
162
163                 RNA_string_get(op->ptr, "scene", scene_name);
164                 scn = (Scene *)BLI_findstring(&mainp->scene, scene_name, offsetof(ID, name) + 2);
165                 
166                 if (scn) {
167                         /* camera switch wont have updated */
168                         scn->r.cfra = (*scene)->r.cfra;
169                         BKE_scene_camera_switch_update(scn);
170
171                         *scene = scn;
172                 }
173         }
174
175         if (RNA_struct_property_is_set(op->ptr, "layer")) {
176                 SceneRenderLayer *rl;
177                 char rl_name[RE_MAXNAME];
178
179                 RNA_string_get(op->ptr, "layer", rl_name);
180                 rl = (SceneRenderLayer *)BLI_findstring(&(*scene)->r.layers, rl_name, offsetof(SceneRenderLayer, name));
181                 
182                 if (rl)
183                         *srl = rl;
184         }
185 }
186
187 /* executes blocking render */
188 static int screen_render_exec(bContext *C, wmOperator *op)
189 {
190         Scene *scene = CTX_data_scene(C);
191         SceneRenderLayer *srl = NULL;
192         Render *re;
193         Image *ima;
194         View3D *v3d = CTX_wm_view3d(C);
195         Main *mainp = CTX_data_main(C);
196         unsigned int lay;
197         const short is_animation = RNA_boolean_get(op->ptr, "animation");
198         const short is_write_still = RNA_boolean_get(op->ptr, "write_still");
199         struct Object *camera_override = v3d ? V3D_CAMERA_LOCAL(v3d) : NULL;
200
201         /* custom scene and single layer re-render */
202         screen_render_scene_layer_set(op, mainp, &scene, &srl);
203
204         if (!is_animation && is_write_still && BKE_imtype_is_movie(scene->r.im_format.imtype)) {
205                 BKE_report(op->reports, RPT_ERROR, "Cannot write a single file with an animation format selected");
206                 return OPERATOR_CANCELLED;
207         }
208
209         re = RE_NewRender(scene->id.name);
210         lay = (v3d) ? v3d->lay : scene->lay;
211
212         G.is_break = FALSE;
213         RE_test_break_cb(re, NULL, (int (*)(void *))blender_test_break);
214
215         ima = BKE_image_verify_viewer(IMA_TYPE_R_RESULT, "Render Result");
216         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
217         BKE_image_backup_render(scene, ima);
218
219         /* cleanup sequencer caches before starting user triggered render.
220          * otherwise, invalidated cache entries can make their way into
221          * the output rendering. We can't put that into RE_BlenderFrame,
222          * since sequence rendering can call that recursively... (peter) */
223         BKE_sequencer_cache_cleanup();
224
225         RE_SetReports(re, op->reports);
226
227         if (is_animation)
228                 RE_BlenderAnim(re, mainp, scene, camera_override, lay, scene->r.sfra, scene->r.efra, scene->r.frame_step);
229         else
230                 RE_BlenderFrame(re, mainp, scene, srl, camera_override, lay, scene->r.cfra, is_write_still);
231
232         RE_SetReports(re, NULL);
233
234         // no redraw needed, we leave state as we entered it
235         ED_update_for_newframe(mainp, scene, 1);
236
237         WM_event_add_notifier(C, NC_SCENE | ND_RENDER_RESULT, scene);
238
239         return OPERATOR_FINISHED;
240 }
241
242 typedef struct RenderJob {
243         Main *main;
244         Scene *scene;
245         Render *re;
246         wmWindow *win;
247         SceneRenderLayer *srl;
248         struct Object *camera_override;
249         int lay;
250         short anim, write_still;
251         Image *image;
252         ImageUser iuser;
253         short *stop;
254         short *do_update;
255         float *progress;
256         ReportList *reports;
257 } RenderJob;
258
259 static void render_freejob(void *rjv)
260 {
261         RenderJob *rj = rjv;
262
263         MEM_freeN(rj);
264 }
265
266 /* str is IMA_MAX_RENDER_TEXT in size */
267 static void make_renderinfo_string(RenderStats *rs, Scene *scene, char *str)
268 {
269         char info_time_str[32]; // used to be extern to header_info.c
270         uintptr_t mem_in_use, mmap_in_use, peak_memory;
271         float megs_used_memory, mmap_used_memory, megs_peak_memory;
272         char *spos = str;
273
274         mem_in_use = MEM_get_memory_in_use();
275         mmap_in_use = MEM_get_mapped_memory_in_use();
276         peak_memory = MEM_get_peak_memory();
277
278         megs_used_memory = (mem_in_use - mmap_in_use) / (1024.0 * 1024.0);
279         mmap_used_memory = (mmap_in_use) / (1024.0 * 1024.0);
280         megs_peak_memory = (peak_memory) / (1024.0 * 1024.0);
281
282         if (scene->lay & 0xFF000000)
283                 spos += sprintf(spos, "Localview | ");
284         else if (scene->r.scemode & R_SINGLE_LAYER)
285                 spos += sprintf(spos, "Single Layer | ");
286
287         spos += sprintf(spos, "Frame:%d ", (scene->r.cfra));
288
289         if (rs->statstr) {
290                 spos += sprintf(spos, "| %s ", rs->statstr);
291         }
292         else {
293                 if (rs->totvert) spos += sprintf(spos, "Ve:%d ", rs->totvert);
294                 if (rs->totface) spos += sprintf(spos, "Fa:%d ", rs->totface);
295                 if (rs->tothalo) spos += sprintf(spos, "Ha:%d ", rs->tothalo);
296                 if (rs->totstrand) spos += sprintf(spos, "St:%d ", rs->totstrand);
297                 if (rs->totlamp) spos += sprintf(spos, "La:%d ", rs->totlamp);
298                 spos += sprintf(spos, "Mem:%.2fM (%.2fM, peak %.2fM) ", megs_used_memory, mmap_used_memory, megs_peak_memory);
299
300                 if (rs->curfield)
301                         spos += sprintf(spos, "Field %d ", rs->curfield);
302                 if (rs->curblur)
303                         spos += sprintf(spos, "Blur %d ", rs->curblur);
304         }
305
306         BLI_timestr(rs->lastframetime, info_time_str);
307         spos += sprintf(spos, "Time:%s ", info_time_str);
308
309         if (rs->curfsa)
310                 spos += sprintf(spos, "| Full Sample %d ", rs->curfsa);
311         
312         if (rs->infostr && rs->infostr[0])
313                 spos += sprintf(spos, "| %s ", rs->infostr);
314
315         /* very weak... but 512 characters is quite safe */
316         if (spos >= str + IMA_MAX_RENDER_TEXT)
317                 if (G.debug & G_DEBUG)
318                         printf("WARNING! renderwin text beyond limit\n");
319
320 }
321
322 static void image_renderinfo_cb(void *rjv, RenderStats *rs)
323 {
324         RenderJob *rj = rjv;
325         RenderResult *rr;
326
327         rr = RE_AcquireResultRead(rj->re);
328
329         if (rr) {
330                 /* malloc OK here, stats_draw is not in tile threads */
331                 if (rr->text == NULL)
332                         rr->text = MEM_callocN(IMA_MAX_RENDER_TEXT, "rendertext");
333
334                 make_renderinfo_string(rs, rj->scene, rr->text);
335         }
336
337         RE_ReleaseResult(rj->re);
338
339         /* make jobs timer to send notifier */
340         *(rj->do_update) = TRUE;
341
342 }
343
344 static void render_progress_update(void *rjv, float progress)
345 {
346         RenderJob *rj = rjv;
347         
348         if (rj->progress && *rj->progress != progress) {
349                 *rj->progress = progress;
350
351                 /* make jobs timer to send notifier */
352                 *(rj->do_update) = TRUE;
353         }
354 }
355
356 static void image_rect_update(void *rjv, RenderResult *rr, volatile rcti *renrect)
357 {
358         RenderJob *rj = rjv;
359         Image *ima = rj->image;
360         ImBuf *ibuf;
361         void *lock;
362
363         /* only update if we are displaying the slot being rendered */
364         if (ima->render_slot != ima->last_render_slot)
365                 return;
366
367         ibuf = BKE_image_acquire_ibuf(ima, &rj->iuser, &lock);
368         if (ibuf) {
369                 image_buffer_rect_update(rj->scene, rr, ibuf, renrect);
370
371                 /* make jobs timer to send notifier */
372                 *(rj->do_update) = TRUE;
373         }
374         BKE_image_release_ibuf(ima, lock);
375 }
376
377 static void render_startjob(void *rjv, short *stop, short *do_update, float *progress)
378 {
379         RenderJob *rj = rjv;
380
381         rj->stop = stop;
382         rj->do_update = do_update;
383         rj->progress = progress;
384
385         RE_SetReports(rj->re, rj->reports);
386
387         if (rj->anim)
388                 RE_BlenderAnim(rj->re, rj->main, rj->scene, rj->camera_override, rj->lay, rj->scene->r.sfra, rj->scene->r.efra, rj->scene->r.frame_step);
389         else
390                 RE_BlenderFrame(rj->re, rj->main, rj->scene, rj->srl, rj->camera_override, rj->lay, rj->scene->r.cfra, rj->write_still);
391
392         RE_SetReports(rj->re, NULL);
393 }
394
395 static void render_endjob(void *rjv)
396 {
397         RenderJob *rj = rjv;
398
399         /* this render may be used again by the sequencer without the active 'Render' where the callbacks
400          * would be re-assigned. assign dummy callbacks to avoid referencing freed renderjobs bug [#24508] */
401         RE_InitRenderCB(rj->re);
402
403         if (rj->main != G.main)
404                 free_main(rj->main);
405
406         /* else the frame will not update for the original value */
407         if (!(rj->scene->r.scemode & R_NO_FRAME_UPDATE)) {
408                 /* possible this fails of loading new file while rendering */
409                 if (G.main->wm.first) {
410                         ED_update_for_newframe(G.main, rj->scene, 1);
411                 }
412         }
413         
414         /* XXX above function sets all tags in nodes */
415         ntreeCompositClearTags(rj->scene->nodetree);
416         
417         /* potentially set by caller */
418         rj->scene->r.scemode &= ~R_NO_FRAME_UPDATE;
419         
420         if (rj->srl) {
421                 nodeUpdateID(rj->scene->nodetree, &rj->scene->id);
422                 WM_main_add_notifier(NC_NODE | NA_EDITED, rj->scene);
423         }
424         
425         /* XXX render stability hack */
426         G.is_rendering = FALSE;
427         WM_main_add_notifier(NC_WINDOW, NULL);
428 }
429
430 /* called by render, check job 'stop' value or the global */
431 static int render_breakjob(void *rjv)
432 {
433         RenderJob *rj = rjv;
434
435         if (G.is_break)
436                 return 1;
437         if (rj->stop && *(rj->stop))
438                 return 1;
439         return 0;
440 }
441
442 /* runs in thread, no cursor setting here works. careful with notifiers too (malloc conflicts) */
443 /* maybe need a way to get job send notifer? */
444 static void render_drawlock(void *UNUSED(rjv), int lock)
445 {
446         BKE_spacedata_draw_locks(lock);
447         
448 }
449
450 /* catch esc */
451 static int screen_render_modal(bContext *C, wmOperator *op, wmEvent *event)
452 {
453         Scene *scene = (Scene *) op->customdata;
454
455         /* no running blender, remove handler and pass through */
456         if (0 == WM_jobs_test(CTX_wm_manager(C), scene, WM_JOB_TYPE_RENDER)) {
457                 return OPERATOR_FINISHED | OPERATOR_PASS_THROUGH;
458         }
459
460         /* running render */
461         switch (event->type) {
462                 case ESCKEY:
463                         return OPERATOR_RUNNING_MODAL;
464                         break;
465         }
466         return OPERATOR_PASS_THROUGH;
467 }
468
469 /* using context, starts job */
470 static int screen_render_invoke(bContext *C, wmOperator *op, wmEvent *event)
471 {
472         /* new render clears all callbacks */
473         Main *mainp;
474         Scene *scene = CTX_data_scene(C);
475         SceneRenderLayer *srl = NULL;
476         View3D *v3d = CTX_wm_view3d(C);
477         Render *re;
478         wmJob *wm_job;
479         RenderJob *rj;
480         Image *ima;
481         int jobflag;
482         const short is_animation = RNA_boolean_get(op->ptr, "animation");
483         const short is_write_still = RNA_boolean_get(op->ptr, "write_still");
484         struct Object *camera_override = v3d ? V3D_CAMERA_LOCAL(v3d) : NULL;
485         const char *name;
486         
487         /* only one render job at a time */
488         if (WM_jobs_test(CTX_wm_manager(C), scene, WM_JOB_TYPE_RENDER))
489                 return OPERATOR_CANCELLED;
490
491         if (!RE_is_rendering_allowed(scene, camera_override, op->reports)) {
492                 return OPERATOR_CANCELLED;
493         }
494
495         if (!is_animation && is_write_still && BKE_imtype_is_movie(scene->r.im_format.imtype)) {
496                 BKE_report(op->reports, RPT_ERROR, "Cannot write a single file with an animation format selected");
497                 return OPERATOR_CANCELLED;
498         }
499         
500         /* stop all running jobs, currently previews frustrate Render */
501         WM_jobs_stop_all(CTX_wm_manager(C));
502
503         /* get main */
504         if (G.debug_value == 101) {
505                 /* thread-safety experiment, copy main from the undo buffer */
506                 mainp = BKE_undo_get_main(&scene);
507         }
508         else
509                 mainp = CTX_data_main(C);
510
511         /* cancel animation playback */
512         if (ED_screen_animation_playing(CTX_wm_manager(C)))
513                 ED_screen_animation_play(C, 0, 0);
514         
515         /* handle UI stuff */
516         WM_cursor_wait(1);
517
518         /* flush multires changes (for sculpt) */
519         multires_force_render_update(CTX_data_active_object(C));
520
521         /* cleanup sequencer caches before starting user triggered render.
522          * otherwise, invalidated cache entries can make their way into
523          * the output rendering. We can't put that into RE_BlenderFrame,
524          * since sequence rendering can call that recursively... (peter) */
525         BKE_sequencer_cache_cleanup();
526
527         /* get editmode results */
528         ED_object_exit_editmode(C, 0);  /* 0 = does not exit editmode */
529
530         // store spare
531         // get view3d layer, local layer, make this nice api call to render
532         // store spare
533
534         /* ensure at least 1 area shows result */
535         render_view_open(C, event->x, event->y);
536
537         jobflag = WM_JOB_EXCL_RENDER | WM_JOB_PRIORITY | WM_JOB_PROGRESS;
538         
539         /* custom scene and single layer re-render */
540         screen_render_scene_layer_set(op, mainp, &scene, &srl);
541
542         if (RNA_struct_property_is_set(op->ptr, "layer"))
543                 jobflag |= WM_JOB_SUSPEND;
544
545         /* job custom data */
546         rj = MEM_callocN(sizeof(RenderJob), "render job");
547         rj->main = mainp;
548         rj->scene = scene;
549         rj->win = CTX_wm_window(C);
550         rj->srl = srl;
551         rj->camera_override = camera_override;
552         rj->lay = (v3d) ? v3d->lay : scene->lay;
553         rj->anim = is_animation;
554         rj->write_still = is_write_still && !is_animation;
555         rj->iuser.scene = scene;
556         rj->iuser.ok = 1;
557         rj->reports = op->reports;
558
559         /* setup job */
560         if (RE_seq_render_active(scene, &scene->r)) name = "Sequence Render";
561         else name = "Render";
562
563         wm_job = WM_jobs_get(CTX_wm_manager(C), CTX_wm_window(C), scene, name, jobflag, WM_JOB_TYPE_RENDER);
564         WM_jobs_customdata_set(wm_job, rj, render_freejob);
565         WM_jobs_timer(wm_job, 0.2, NC_SCENE | ND_RENDER_RESULT, 0);
566         WM_jobs_callbacks(wm_job, render_startjob, NULL, NULL, render_endjob);
567
568         /* get a render result image, and make sure it is empty */
569         ima = BKE_image_verify_viewer(IMA_TYPE_R_RESULT, "Render Result");
570         BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
571         BKE_image_backup_render(rj->scene, ima);
572         rj->image = ima;
573
574         /* setup new render */
575         re = RE_NewRender(scene->id.name);
576         RE_test_break_cb(re, rj, render_breakjob);
577         RE_draw_lock_cb(re, rj, render_drawlock);
578         RE_display_draw_cb(re, rj, image_rect_update);
579         RE_stats_draw_cb(re, rj, image_renderinfo_cb);
580         RE_progress_cb(re, rj, render_progress_update);
581
582         rj->re = re;
583         G.is_break = FALSE;
584
585         /* store actual owner of job, so modal operator could check for it,
586          * the reason of this is that active scene could change when rendering
587          * several layers from compositor [#31800]
588          */
589         op->customdata = scene;
590
591         WM_jobs_start(CTX_wm_manager(C), wm_job);
592
593         WM_cursor_wait(0);
594         WM_event_add_notifier(C, NC_SCENE | ND_RENDER_RESULT, scene);
595
596         /* we set G.is_rendering here already instead of only in the job, this ensure
597          * main loop or other scene updates are disabled in time, since they may
598          * have started before the job thread */
599         G.is_rendering = TRUE;
600
601         /* add modal handler for ESC */
602         WM_event_add_modal_handler(C, op);
603
604         return OPERATOR_RUNNING_MODAL;
605 }
606
607 /* contextual render, using current scene, view3d? */
608 void RENDER_OT_render(wmOperatorType *ot)
609 {
610         /* identifiers */
611         ot->name = "Render";
612         ot->description = "Render active scene";
613         ot->idname = "RENDER_OT_render";
614
615         /* api callbacks */
616         ot->invoke = screen_render_invoke;
617         ot->modal = screen_render_modal;
618         ot->exec = screen_render_exec;
619
620         /*ot->poll = ED_operator_screenactive;*/ /* this isn't needed, causes failer in background mode */
621
622         RNA_def_boolean(ot->srna, "animation", 0, "Animation", "Render files from the animation range of this scene");
623         RNA_def_boolean(ot->srna, "write_still", 0, "Write Image", "Save rendered the image to the output path (used only when animation is disabled)");
624         RNA_def_string(ot->srna, "layer", "", RE_MAXNAME, "Render Layer", "Single render layer to re-render (used only when animation is disabled)");
625         RNA_def_string(ot->srna, "scene", "", MAX_ID_NAME - 2, "Scene", "Scene to render, current scene if not specified");
626 }
627