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