4 * ***** BEGIN GPL LICENSE BLOCK *****
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.
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.
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.
20 * The Original Code is Copyright (C) 2008 Blender Foundation.
21 * All rights reserved.
24 * ***** END GPL LICENSE BLOCK *****
31 #include "MEM_guardedalloc.h"
33 #include "BLI_blenlib.h"
35 #include "BLI_threads.h"
37 #include "DNA_scene_types.h"
39 #include "BKE_blender.h"
40 #include "BKE_colortools.h"
41 #include "BKE_context.h"
42 #include "BKE_global.h"
43 #include "BKE_image.h"
44 #include "BKE_library.h"
46 #include "BKE_multires.h"
47 #include "BKE_report.h"
48 #include "BKE_scene.h"
49 #include "BKE_screen.h"
50 #include "BKE_utildefines.h"
55 #include "ED_screen.h"
56 #include "ED_object.h"
58 #include "RE_pipeline.h"
59 #include "IMB_imbuf.h"
60 #include "IMB_imbuf_types.h"
62 #include "RNA_access.h"
63 #include "RNA_define.h"
65 #include "wm_window.h"
67 #include "render_intern.h"
69 static ScrArea *biggest_area(bContext *C);
70 static ScrArea *biggest_non_image_area(bContext *C);
71 static ScrArea *find_area_showing_r_result(bContext *C);
72 static ScrArea *find_area_image_empty(bContext *C);
74 /* called inside thread! */
75 void image_buffer_rect_update(Scene *scene, RenderResult *rr, ImBuf *ibuf, volatile rcti *renrect)
77 float x1, y1, *rectf= NULL;
78 int ymin, ymax, xmin, xmax;
82 /* if renrect argument, we only refresh scanlines */
84 /* if ymax==recty, rendering of layer is ready, we should not draw, other things happen... */
85 if(rr->renlay==NULL || renrect->ymax>=rr->recty)
88 /* xmin here is first subrect x coord, xmax defines subrect width */
89 xmin = renrect->xmin + rr->crop;
90 xmax = renrect->xmax - xmin - rr->crop;
93 ymin= renrect->ymin + rr->crop;
94 ymax= renrect->ymax - ymin - rr->crop;
97 renrect->ymin= renrect->ymax;
101 xmin = ymin = rr->crop;
102 xmax = rr->rectx - 2*rr->crop;
103 ymax = rr->recty - 2*rr->crop;
106 /* xmin ymin is in tile coords. transform to ibuf */
107 rxmin= rr->tilerect.xmin + xmin;
108 if(rxmin >= ibuf->x) return;
109 rymin= rr->tilerect.ymin + ymin;
110 if(rymin >= ibuf->y) return;
112 if(rxmin + xmax > ibuf->x)
113 xmax= ibuf->x - rxmin;
114 if(rymin + ymax > ibuf->y)
115 ymax= ibuf->y - rymin;
117 if(xmax < 1 || ymax < 1) return;
119 /* find current float rect for display, first case is after composit... still weak */
126 if(rr->renlay==NULL || rr->renlay->rectf==NULL) return;
127 rectf= rr->renlay->rectf;
130 if(rectf==NULL) return;
133 imb_addrectImBuf(ibuf);
135 rectf+= 4*(rr->rectx*ymin + xmin);
136 rectc= (char *)(ibuf->rect + ibuf->x*rymin + rxmin);
138 /* XXX make nice consistent functions for this */
139 if (scene && (scene->r.color_mgt_flag & R_COLOR_MANAGEMENT)) {
140 for(y1= 0; y1<ymax; y1++) {
145 /* XXX temp. because crop offset */
146 if( rectc >= (char *)(ibuf->rect)) {
147 for(x1= 0; x1<xmax; x1++, rf += 4, rc+=4) {
148 srgb[0]= linearrgb_to_srgb(rf[0]);
149 srgb[1]= linearrgb_to_srgb(rf[1]);
150 srgb[2]= linearrgb_to_srgb(rf[2]);
152 rc[0]= FTOCHAR(srgb[0]);
153 rc[1]= FTOCHAR(srgb[1]);
154 rc[2]= FTOCHAR(srgb[2]);
155 rc[3]= FTOCHAR(rf[3]);
158 rectf += 4*rr->rectx;
162 for(y1= 0; y1<ymax; y1++) {
166 /* XXX temp. because crop offset */
167 if( rectc >= (char *)(ibuf->rect)) {
168 for(x1= 0; x1<xmax; x1++, rf += 4, rc+=4) {
169 rc[0]= FTOCHAR(rf[0]);
170 rc[1]= FTOCHAR(rf[1]);
171 rc[2]= FTOCHAR(rf[2]);
172 rc[3]= FTOCHAR(rf[3]);
175 rectf += 4*rr->rectx;
181 /* new window uses x,y to set position */
182 void screen_set_image_output(bContext *C, int mx, int my)
184 wmWindow *win= CTX_wm_window(C);
185 Scene *scene= CTX_data_scene(C);
188 int area_was_image=0;
190 if(scene->r.displaymode==R_OUTPUT_WINDOW) {
194 sizex= 10 + (scene->r.xsch*scene->r.size)/100;
195 sizey= 40 + (scene->r.ysch*scene->r.size)/100;
197 /* arbitrary... miniature image window views don't make much sense */
198 if(sizex < 320) sizex= 320;
199 if(sizey < 256) sizey= 256;
201 /* XXX some magic to calculate postition */
202 rect.xmin= mx + win->posx - sizex/2;
203 rect.ymin= my + win->posy - sizey/2;
204 rect.xmax= rect.xmin + sizex;
205 rect.ymax= rect.ymin + sizey;
207 /* changes context! */
208 WM_window_open_temp(C, &rect, WM_WINDOW_RENDER);
212 else if(scene->r.displaymode==R_OUTPUT_SCREEN) {
213 if (CTX_wm_area(C)->spacetype == SPACE_IMAGE)
216 /* this function returns with changed context */
217 ED_screen_full_newspace(C, CTX_wm_area(C), SPACE_IMAGE);
222 sa= find_area_showing_r_result(C);
224 sa= find_area_image_empty(C);
227 /* find largest open non-image area */
228 sa= biggest_non_image_area(C);
230 ED_area_newspace(C, sa, SPACE_IMAGE);
231 sima= sa->spacedata.first;
233 /* makes ESC go back to prev space */
234 sima->flag |= SI_PREVSPACE;
237 /* use any area of decent size */
239 if(sa->spacetype!=SPACE_IMAGE) {
240 // XXX newspace(sa, SPACE_IMAGE);
241 sima= sa->spacedata.first;
243 /* makes ESC go back to prev space */
244 sima->flag |= SI_PREVSPACE;
249 sima= sa->spacedata.first;
251 /* get the correct image, and scale it */
252 sima->image= BKE_image_verify_viewer(IMA_TYPE_R_RESULT, "Render Result");
255 /* if we're rendering to full screen, set appropriate hints on image editor
256 * so it can restore properly on pressing esc */
258 sima->flag |= SI_FULLWINDOW;
260 /* Tell the image editor to revert to previous space in space list on close
261 * _only_ if it wasn't already an image editor when the render was invoked */
262 if (area_was_image == 0)
263 sima->flag |= SI_PREVSPACE;
265 /* Leave it alone so the image editor will just go back from
266 * full screen to the original tiled setup */
275 /* ****************************** render invoking ***************** */
277 /* set callbacks, exported to sequence render too.
278 Only call in foreground (UI) renders. */
280 /* returns biggest area that is not uv/image editor. Note that it uses buttons */
281 /* window as the last possible alternative. */
282 static ScrArea *biggest_non_image_area(bContext *C)
284 bScreen *sc= CTX_wm_screen(C);
285 ScrArea *sa, *big= NULL;
286 int size, maxsize= 0, bwmaxsize= 0;
289 for(sa= sc->areabase.first; sa; sa= sa->next) {
290 if(sa->winx > 30 && sa->winy > 30) {
291 size= sa->winx*sa->winy;
292 if(sa->spacetype == SPACE_BUTS) {
293 if(foundwin == 0 && size > bwmaxsize) {
298 else if(sa->spacetype != SPACE_IMAGE && size > maxsize) {
309 static ScrArea *biggest_area(bContext *C)
311 bScreen *sc= CTX_wm_screen(C);
312 ScrArea *sa, *big= NULL;
313 int size, maxsize= 0;
315 for(sa= sc->areabase.first; sa; sa= sa->next) {
316 size= sa->winx*sa->winy;
326 static ScrArea *find_area_showing_r_result(bContext *C)
328 wmWindowManager *wm= CTX_wm_manager(C);
333 /* find an imagewindow showing render result */
334 for(win=wm->windows.first; win; win=win->next) {
335 for(sa=win->screen->areabase.first; sa; sa= sa->next) {
336 if(sa->spacetype==SPACE_IMAGE) {
337 sima= sa->spacedata.first;
338 if(sima->image && sima->image->type==IMA_TYPE_R_RESULT)
347 static ScrArea *find_area_image_empty(bContext *C)
349 bScreen *sc= CTX_wm_screen(C);
353 /* find an imagewindow showing render result */
354 for(sa=sc->areabase.first; sa; sa= sa->next) {
355 if(sa->spacetype==SPACE_IMAGE) {
356 sima= sa->spacedata.first;
364 #if 0 // XXX not used
365 static ScrArea *find_empty_image_area(bContext *C)
367 bScreen *sc= CTX_wm_screen(C);
371 /* find an imagewindow showing render result */
372 for(sa=sc->areabase.first; sa; sa= sa->next) {
373 if(sa->spacetype==SPACE_IMAGE) {
374 sima= sa->spacedata.first;
381 #endif // XXX not used
383 static void render_error_reports(void *reports, char *str)
385 BKE_report(reports, RPT_ERROR, str);
388 /* executes blocking render */
389 static int screen_render_exec(bContext *C, wmOperator *op)
391 Scene *scene= CTX_data_scene(C);
392 Render *re= RE_NewRender(scene->id.name);
394 View3D *v3d= CTX_wm_view3d(C);
395 int lay= (v3d)? v3d->lay|scene->lay: scene->lay;
398 re= RE_NewRender(scene->id.name);
402 RE_test_break_cb(re, NULL, (int (*)(void *)) blender_test_break);
403 RE_error_cb(re, op->reports, render_error_reports);
405 ima= BKE_image_verify_viewer(IMA_TYPE_R_RESULT, "Render Result");
406 BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
407 BKE_image_backup_render(scene, ima);
409 if(RNA_boolean_get(op->ptr, "animation"))
410 RE_BlenderAnim(re, scene, lay, scene->r.sfra, scene->r.efra, scene->r.frame_step, op->reports);
412 RE_BlenderFrame(re, scene, NULL, lay, scene->r.cfra);
414 // no redraw needed, we leave state as we entered it
415 ED_update_for_newframe(C, 1);
417 WM_event_add_notifier(C, NC_SCENE|ND_RENDER_RESULT, scene);
419 return OPERATOR_FINISHED;
422 typedef struct RenderJob {
426 SceneRenderLayer *srl;
436 static void render_freejob(void *rjv)
443 /* str is IMA_MAX_RENDER_TEXT in size */
444 static void make_renderinfo_string(RenderStats *rs, Scene *scene, char *str)
446 char info_time_str[32]; // used to be extern to header_info.c
447 uintptr_t mem_in_use, mmap_in_use;
448 float megs_used_memory, mmap_used_memory;
451 mem_in_use= MEM_get_memory_in_use();
452 mmap_in_use= MEM_get_mapped_memory_in_use();
454 megs_used_memory= (mem_in_use-mmap_in_use)/(1024.0*1024.0);
455 mmap_used_memory= (mmap_in_use)/(1024.0*1024.0);
457 if(scene->lay & 0xFF000000)
458 spos+= sprintf(spos, "Localview | ");
459 else if(scene->r.scemode & R_SINGLE_LAYER)
460 spos+= sprintf(spos, "Single Layer | ");
463 spos+= sprintf(spos, "%s ", rs->statstr);
466 spos+= sprintf(spos, "Fra:%d Ve:%d Fa:%d ", (scene->r.cfra), rs->totvert, rs->totface);
467 if(rs->tothalo) spos+= sprintf(spos, "Ha:%d ", rs->tothalo);
468 if(rs->totstrand) spos+= sprintf(spos, "St:%d ", rs->totstrand);
469 spos+= sprintf(spos, "La:%d Mem:%.2fM (%.2fM) ", rs->totlamp, megs_used_memory, mmap_used_memory);
472 spos+= sprintf(spos, "Field %d ", rs->curfield);
474 spos+= sprintf(spos, "Blur %d ", rs->curblur);
477 BLI_timestr(rs->lastframetime, info_time_str);
478 spos+= sprintf(spos, "Time:%s ", info_time_str);
480 if(rs->infostr && rs->infostr[0])
481 spos+= sprintf(spos, "| %s ", rs->infostr);
483 /* very weak... but 512 characters is quite safe */
484 if(spos >= str+IMA_MAX_RENDER_TEXT)
486 printf("WARNING! renderwin text beyond limit \n");
490 static void image_renderinfo_cb(void *rjv, RenderStats *rs)
495 rr= RE_AcquireResultRead(rj->re);
497 /* malloc OK here, stats_draw is not in tile threads */
499 rr->text= MEM_callocN(IMA_MAX_RENDER_TEXT, "rendertext");
501 make_renderinfo_string(rs, rj->scene, rr->text);
502 RE_ReleaseResult(rj->re);
504 /* make jobs timer to send notifier */
509 static void image_rect_update(void *rjv, RenderResult *rr, volatile rcti *renrect)
512 Image *ima= rj->image;
516 /* only update if we are displaying the slot being rendered */
517 if(ima->render_slot != ima->last_render_slot)
520 ibuf= BKE_image_acquire_ibuf(ima, &rj->iuser, &lock);
522 image_buffer_rect_update(rj->scene, rr, ibuf, renrect);
524 /* make jobs timer to send notifier */
527 BKE_image_release_ibuf(ima, lock);
530 static void render_startjob(void *rjv, short *stop, short *do_update)
533 // Main *mainp= BKE_undo_get_main(&rj->scene);
536 rj->do_update= do_update;
539 RE_BlenderAnim(rj->re, rj->scene, rj->lay, rj->scene->r.sfra, rj->scene->r.efra, rj->scene->r.frame_step, rj->reports);
541 RE_BlenderFrame(rj->re, rj->scene, rj->srl, rj->lay, rj->scene->r.cfra);
547 /* called by render, check job 'stop' value or the global */
548 static int render_breakjob(void *rjv)
554 if(rj->stop && *(rj->stop))
560 static int screen_render_modal(bContext *C, wmOperator *op, wmEvent *event)
562 /* no running blender, remove handler and pass through */
563 if(0==WM_jobs_test(CTX_wm_manager(C), CTX_data_scene(C)))
564 return OPERATOR_FINISHED|OPERATOR_PASS_THROUGH;
567 switch (event->type) {
569 return OPERATOR_RUNNING_MODAL;
572 return OPERATOR_PASS_THROUGH;
575 /* using context, starts job */
576 static int screen_render_invoke(bContext *C, wmOperator *op, wmEvent *event)
578 /* new render clears all callbacks */
579 Scene *scene= CTX_data_scene(C);
580 SceneRenderLayer *srl=NULL;
581 bScreen *screen= CTX_wm_screen(C);
582 View3D *v3d= CTX_wm_view3d(C);
588 /* only one render job at a time */
589 if(WM_jobs_test(CTX_wm_manager(C), scene))
590 return OPERATOR_CANCELLED;
592 /* stop all running jobs, currently previews frustrate Render */
593 WM_jobs_stop_all(CTX_wm_manager(C));
595 /* cancel animation playback */
596 if (screen->animtimer)
597 ED_screen_animation_play(C, 0, 0);
599 /* handle UI stuff */
602 /* flush multires changes (for sculpt) */
603 multires_force_render_update(CTX_data_active_object(C));
605 /* get editmode results */
606 ED_object_exit_editmode(C, EM_FREEDATA|EM_DO_UNDO); /* 0 = does not exit editmode */
609 // get view3d layer, local layer, make this nice api call to render
612 /* ensure at least 1 area shows result */
613 screen_set_image_output(C, event->x, event->y);
615 /* single layer re-render */
616 if(RNA_property_is_set(op->ptr, "layer")) {
617 SceneRenderLayer *rl;
619 char scene_name[19], rl_name[RE_MAXNAME];
621 RNA_string_get(op->ptr, "layer", rl_name);
622 RNA_string_get(op->ptr, "scene", scene_name);
624 scn = (Scene *)BLI_findstring(&CTX_data_main(C)->scene, scene_name, offsetof(ID, name) + 2);
625 rl = (SceneRenderLayer *)BLI_findstring(&scene->r.layers, rl_name, offsetof(SceneRenderLayer, name));
633 /* job custom data */
634 rj= MEM_callocN(sizeof(RenderJob), "render job");
636 rj->win= CTX_wm_window(C);
638 rj->lay = (v3d)? v3d->lay|scene->lay: scene->lay;
639 rj->anim= RNA_boolean_get(op->ptr, "animation");
640 rj->iuser.scene= scene;
642 rj->reports= op->reports;
645 steve= WM_jobs_get(CTX_wm_manager(C), CTX_wm_window(C), scene, WM_JOB_EXCL_RENDER|WM_JOB_PRIORITY);
646 WM_jobs_customdata(steve, rj, render_freejob);
647 WM_jobs_timer(steve, 0.2, NC_SCENE|ND_RENDER_RESULT, 0);
648 WM_jobs_callbacks(steve, render_startjob, NULL, NULL);
650 /* get a render result image, and make sure it is empty */
651 ima= BKE_image_verify_viewer(IMA_TYPE_R_RESULT, "Render Result");
652 BKE_image_signal(ima, NULL, IMA_SIGNAL_FREE);
653 BKE_image_backup_render(rj->scene, ima);
656 /* setup new render */
657 re= RE_NewRender(scene->id.name);
658 RE_test_break_cb(re, rj, render_breakjob);
659 RE_display_draw_cb(re, rj, image_rect_update);
660 RE_stats_draw_cb(re, rj, image_renderinfo_cb);
665 RE_error_cb(re, op->reports, render_error_reports);
667 WM_jobs_start(CTX_wm_manager(C), steve);
670 WM_event_add_notifier(C, NC_SCENE|ND_RENDER_RESULT, scene);
672 /* add modal handler for ESC */
673 WM_event_add_modal_handler(C, op);
675 return OPERATOR_RUNNING_MODAL;
679 /* contextual render, using current scene, view3d? */
680 void RENDER_OT_render(wmOperatorType *ot)
684 ot->description= "Render active scene";
685 ot->idname= "RENDER_OT_render";
688 ot->invoke= screen_render_invoke;
689 ot->modal= screen_render_modal;
690 ot->exec= screen_render_exec;
692 ot->poll= ED_operator_screenactive;
694 RNA_def_boolean(ot->srna, "animation", 0, "Animation", "");
695 RNA_def_string(ot->srna, "layer", "", RE_MAXNAME, "Render Layer", "Single render layer to re-render");
696 RNA_def_string(ot->srna, "scene", "", 19, "Scene", "Re-render single layer in this scene");
699 /* ****************************** opengl render *************************** */
702 /* *********************** cancel render viewer *************** */
704 static int render_view_cancel_exec(bContext *C, wmOperator *unused)
706 wmWindow *win= CTX_wm_window(C);
707 ScrArea *sa= CTX_wm_area(C);
708 SpaceImage *sima= sa->spacedata.first;
710 /* test if we have a temp screen in front */
711 if(CTX_wm_window(C)->screen->full==SCREENTEMP) {
712 wm_window_lower(CTX_wm_window(C));
713 return OPERATOR_FINISHED;
715 /* determine if render already shows */
716 else if(sima->flag & SI_PREVSPACE) {
717 sima->flag &= ~SI_PREVSPACE;
719 if(sima->flag & SI_FULLWINDOW) {
720 sima->flag &= ~SI_FULLWINDOW;
721 ED_screen_full_prevspace(C, sa);
724 ED_area_prevspace(C, sa);
726 return OPERATOR_FINISHED;
728 else if(sima->flag & SI_FULLWINDOW) {
729 sima->flag &= ~SI_FULLWINDOW;
730 ED_screen_full_toggle(C, win, sa);
731 return OPERATOR_FINISHED;
734 return OPERATOR_PASS_THROUGH;
737 void RENDER_OT_view_cancel(struct wmOperatorType *ot)
740 ot->name= "Cancel Render View";
741 ot->description= "Cancel show render view";
742 ot->idname= "RENDER_OT_view_cancel";
745 ot->exec= render_view_cancel_exec;
746 ot->poll= ED_operator_image_active;
749 /* *********************** show render viewer *************** */
751 static int render_view_show_invoke(bContext *C, wmOperator *unused, wmEvent *event)
753 ScrArea *sa= find_area_showing_r_result(C);
755 /* test if we have a temp screen in front */
756 if(CTX_wm_window(C)->screen->full==SCREENTEMP) {
757 wm_window_lower(CTX_wm_window(C));
759 /* determine if render already shows */
761 SpaceImage *sima= sa->spacedata.first;
763 if(sima->flag & SI_PREVSPACE) {
764 sima->flag &= ~SI_PREVSPACE;
766 if(sima->flag & SI_FULLWINDOW) {
767 sima->flag &= ~SI_FULLWINDOW;
768 ED_screen_full_prevspace(C, sa);
770 else if(sima->next) {
771 ED_area_newspace(C, sa, sima->next->spacetype);
772 ED_area_tag_redraw(sa);
777 screen_set_image_output(C, event->x, event->y);
780 return OPERATOR_FINISHED;
783 void RENDER_OT_view_show(struct wmOperatorType *ot)
786 ot->name= "Show/Hide Render View";
787 ot->description= "Toggle show render view";
788 ot->idname= "RENDER_OT_view_show";
791 ot->invoke= render_view_show_invoke;
792 ot->poll= ED_operator_screenactive;