render_opengl.c

Go to the documentation of this file.

/*
 * $Id: render_opengl.c 38109 2011-07-05 07:46:25Z campbellbarton $
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2008 Blender Foundation.
 * All rights reserved.
 *
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include <math.h>
#include <string.h>
#include <stddef.h>

#include <GL/glew.h>

#include "MEM_guardedalloc.h"

#include "BLI_math.h"
#include "BLI_blenlib.h"
#include "BLI_editVert.h"
#include "BLI_dlrbTree.h"
#include "BLI_utildefines.h"

#include "DNA_scene_types.h"
#include "DNA_object_types.h"

#include "BKE_context.h"
#include "BKE_image.h"
#include "BKE_main.h"
#include "BKE_report.h"
#include "BKE_scene.h"
#include "BKE_writeavi.h"

#include "WM_api.h"
#include "WM_types.h"

#include "ED_screen.h"
#include "ED_view3d.h"
#include "ED_image.h"

#include "RE_pipeline.h"
#include "IMB_imbuf_types.h"
#include "IMB_imbuf.h"

#include "RNA_access.h"
#include "RNA_define.h"


#include "GPU_extensions.h"

#include "wm_window.h"

#include "render_intern.h"

typedef struct OGLRender {
        Render *re;
        Scene *scene;

        View3D *v3d;
        RegionView3D *rv3d;
        ARegion *ar;

        Image *ima;
        ImageUser iuser;

        GPUOffScreen *ofs;
        int sizex, sizey;
        int write_still;

        ReportList *reports;
        bMovieHandle *mh;
        int cfrao, nfra;

        wmTimer *timer; /* use to check if running modal or not (invoke'd or exec'd)*/
} OGLRender;

/* added because v3d is not always valid */
static unsigned int screen_opengl_layers(OGLRender *oglrender)
{
        if(oglrender->v3d) {
                return oglrender->scene->lay | oglrender->v3d->lay;
        }
        else {
                return oglrender->scene->lay;
        }
}

static void screen_opengl_render_apply(OGLRender *oglrender)
{
        Scene *scene= oglrender->scene;
        ARegion *ar= oglrender->ar;
        View3D *v3d= oglrender->v3d;
        RegionView3D *rv3d= oglrender->rv3d;
        RenderResult *rr;
        Object *camera= NULL;
        ImBuf *ibuf;
        void *lock;
        float winmat[4][4];
        int sizex= oglrender->sizex;
        int sizey= oglrender->sizey;
        const short view_context= (v3d != NULL);

        rr= RE_AcquireResultRead(oglrender->re);
        
        /* note on color management:
         * looked into how best to deal with color management here and found heres how it should work.
         *
         * OpenGL materials etc are color corrected, so a float buffer from the graphics card is
         * color corrected, without running any conversion functions.
         * 
         * With color correction disabled blender expects the rr->rectf to be non-color managed so
         * just do a direct copy from the byte array to the rectf with no conversion too.
         * notice IMB_float_from_rect has the profile set so no conversion is done.
         */

        if(view_context) {
                GPU_offscreen_bind(oglrender->ofs); /* bind */

                /* render 3d view */
                if(rv3d->persp==RV3D_CAMOB && v3d->camera) {
                        /*int is_ortho= scene->r.mode & R_ORTHO;*/
                        camera= v3d->camera;
                        RE_GetCameraWindow(oglrender->re, camera, scene->r.cfra, winmat);
                        
                }
                else {
                        rctf viewplane;
                        float clipsta, clipend;

                        int is_ortho= ED_view3d_viewplane_get(v3d, rv3d, sizex, sizey, &viewplane, &clipsta, &clipend, NULL);
                        if(is_ortho) orthographic_m4(winmat, viewplane.xmin, viewplane.xmax, viewplane.ymin, viewplane.ymax, -clipend, clipend);
                        else  perspective_m4(winmat, viewplane.xmin, viewplane.xmax, viewplane.ymin, viewplane.ymax, clipsta, clipend);
                }

                if((scene->r.mode & R_OSA) == 0) { 
                        ED_view3d_draw_offscreen(scene, v3d, ar, sizex, sizey, NULL, winmat);
                        glReadPixels(0, 0, sizex, sizey, GL_RGBA, GL_FLOAT, rr->rectf);
                }
                else {
                        /* simple accumulation, less hassle then FSAA FBO's */
#                       define SAMPLES 5 /* fixed, easy to have more but for now this is ok */
                        const float jit_ofs[SAMPLES][2] = {{0, 0}, {0.5f, 0.5f}, {-0.5f,-0.5f}, {-0.5f, 0.5f}, {0.5f, -0.5f}};
                        float winmat_jitter[4][4];
                        float *accum_buffer= MEM_mallocN(sizex * sizey * sizeof(float) * 4, "accum1");
                        float *accum_tmp= MEM_mallocN(sizex * sizey * sizeof(float) * 4, "accum2");
                        int j;

                        /* first sample buffer, also initializes 'rv3d->persmat' */
                        ED_view3d_draw_offscreen(scene, v3d, ar, sizex, sizey, NULL, winmat);
                        glReadPixels(0, 0, sizex, sizey, GL_RGBA, GL_FLOAT, accum_buffer);

                        /* skip the first sample */
                        for(j=1; j < SAMPLES; j++) {
                                copy_m4_m4(winmat_jitter, winmat);
                                window_translate_m4(winmat_jitter, rv3d->persmat, jit_ofs[j][0] / sizex, jit_ofs[j][1] / sizey);

                                ED_view3d_draw_offscreen(scene, v3d, ar, sizex, sizey, NULL, winmat_jitter);
                                glReadPixels(0, 0, sizex, sizey, GL_RGBA, GL_FLOAT, accum_tmp);
                                add_vn_vn(accum_buffer, accum_tmp, sizex*sizey*sizeof(float));
                        }

                        mul_vn_vn_fl(rr->rectf, accum_buffer, sizex*sizey*sizeof(float), 1.0/SAMPLES);

                        MEM_freeN(accum_buffer);
                        MEM_freeN(accum_tmp);
                }

                GPU_offscreen_unbind(oglrender->ofs); /* unbind */
        }
        else {
                /* shouldnt suddenly give errors mid-render but possible */
                char err_out[256]= "unknown";
                ImBuf *ibuf_view= ED_view3d_draw_offscreen_imbuf_simple(scene, scene->camera, oglrender->sizex, oglrender->sizey, IB_rectfloat, OB_SOLID, err_out);
                camera= scene->camera;

                if(ibuf_view) {
                        memcpy(rr->rectf, ibuf_view->rect_float, sizeof(float) * 4 * oglrender->sizex * oglrender->sizey);
                        IMB_freeImBuf(ibuf_view);
                }
                else {
                        fprintf(stderr, "screen_opengl_render_apply: failed to get buffer, %s\n", err_out);
                }
        }
        
        /* rr->rectf is now filled with image data */

        if((scene->r.stamp & R_STAMP_ALL) && (scene->r.stamp & R_STAMP_DRAW))
                BKE_stamp_buf(scene, camera, NULL, rr->rectf, rr->rectx, rr->recty, 4);

        RE_ReleaseResult(oglrender->re);

        /* update byte from float buffer */
        ibuf= BKE_image_acquire_ibuf(oglrender->ima, &oglrender->iuser, &lock);

        if(ibuf) {
                image_buffer_rect_update(NULL, rr, ibuf, NULL);

                if(oglrender->write_still) {
                        char name[FILE_MAX];
                        int ok;

                        if(scene->r.planes == 8) {
                                IMB_color_to_bw(ibuf);
                        }

                        BKE_makepicstring(name, scene->r.pic, scene->r.cfra, scene->r.imtype, scene->r.scemode & R_EXTENSION, FALSE);
                        ok= BKE_write_ibuf(ibuf, name, scene->r.imtype, scene->r.subimtype, scene->r.quality); /* no need to stamp here */
                        if(ok)  printf("OpenGL Render written to '%s'\n", name);
                        else    printf("OpenGL Render failed to write '%s'\n", name);
                }
        }
        
        BKE_image_release_ibuf(oglrender->ima, lock);
}

static int screen_opengl_render_init(bContext *C, wmOperator *op)
{
        /* new render clears all callbacks */
        Scene *scene= CTX_data_scene(C);
        RenderResult *rr;
        GPUOffScreen *ofs;
        OGLRender *oglrender;
        int sizex, sizey;
        short is_view_context= RNA_boolean_get(op->ptr, "view_context");
        const short is_animation= RNA_boolean_get(op->ptr, "animation");
        const short is_write_still= RNA_boolean_get(op->ptr, "write_still");
        char err_out[256]= "unknown";

        /* ensure we have a 3d view */

        if(!ED_view3d_context_activate(C)) {
                RNA_boolean_set(op->ptr, "view_context", 0);
                is_view_context= 0;
        }

        /* only one render job at a time */
        if(WM_jobs_test(CTX_wm_manager(C), scene))
                return 0;
        
        if(!is_view_context && scene->camera==NULL) {
                BKE_report(op->reports, RPT_ERROR, "Scene has no camera.");
                return 0;
        }

        if(!is_animation && is_write_still && BKE_imtype_is_movie(scene->r.imtype)) {
                BKE_report(op->reports, RPT_ERROR, "Can't write a single file with an animation format selected.");
                return 0;
        }

        /* stop all running jobs, currently previews frustrate Render */
        WM_jobs_stop_all(CTX_wm_manager(C));

        /* handle UI stuff */
        WM_cursor_wait(1);

        /* create offscreen buffer */
        sizex= (scene->r.size*scene->r.xsch)/100;
        sizey= (scene->r.size*scene->r.ysch)/100;

        /* corrects render size with actual size, not every card supports non-power-of-two dimensions */
        ofs= GPU_offscreen_create(&sizex, &sizey, err_out);

        if(!ofs) {
                BKE_reportf(op->reports, RPT_ERROR, "Failed to create OpenGL offscreen buffer, %s", err_out);
                return 0;
        }

        /* allocate opengl render */
        oglrender= MEM_callocN(sizeof(OGLRender), "OGLRender");
        op->customdata= oglrender;

        oglrender->ofs= ofs;
        oglrender->sizex= sizex;
        oglrender->sizey= sizey;
        oglrender->scene= scene;

        oglrender->write_still= is_write_still && !is_animation;

        if(is_view_context) {
                oglrender->v3d= CTX_wm_view3d(C);
                oglrender->ar= CTX_wm_region(C);
                oglrender->rv3d= CTX_wm_region_view3d(C);

                /* MUST be cleared on exit */
                oglrender->scene->customdata_mask_modal= ED_view3d_datamask(oglrender->scene, oglrender->v3d);
        }

        /* create image and image user */
        oglrender->ima= BKE_image_verify_viewer(IMA_TYPE_R_RESULT, "Render Result");
        BKE_image_signal(oglrender->ima, NULL, IMA_SIGNAL_FREE);

        oglrender->iuser.scene= scene;
        oglrender->iuser.ok= 1;

        /* create render and render result */
        oglrender->re= RE_NewRender(scene->id.name);
        RE_InitState(oglrender->re, NULL, &scene->r, NULL, sizex, sizey, NULL);

        rr= RE_AcquireResultWrite(oglrender->re);
        if(rr->rectf==NULL)
                rr->rectf= MEM_callocN(sizeof(float)*4*sizex*sizey, "screen_opengl_render_init rect");
        RE_ReleaseResult(oglrender->re);

        return 1;
}

static void screen_opengl_render_end(bContext *C, OGLRender *oglrender)
{
        Main *bmain= CTX_data_main(C);
        Scene *scene= oglrender->scene;

        if(oglrender->mh) {
                if(BKE_imtype_is_movie(scene->r.imtype))
                        oglrender->mh->end_movie();
        }

        if(oglrender->timer) { /* exec will not have a timer */
                scene->r.cfra= oglrender->cfrao;
                scene_update_for_newframe(bmain, scene, screen_opengl_layers(oglrender));

                WM_event_remove_timer(CTX_wm_manager(C), CTX_wm_window(C), oglrender->timer);
        }

        WM_cursor_wait(0);
        WM_event_add_notifier(C, NC_SCENE|ND_RENDER_RESULT, oglrender->scene);

        GPU_offscreen_free(oglrender->ofs);

        oglrender->scene->customdata_mask_modal= 0;

        MEM_freeN(oglrender);
}

static int screen_opengl_render_cancel(bContext *C, wmOperator *op)
{
        screen_opengl_render_end(C, op->customdata);

        return OPERATOR_CANCELLED;
}

/* share between invoke and exec */
static int screen_opengl_render_anim_initialize(bContext *C, wmOperator *op)
{
        /* initialize animation */
        OGLRender *oglrender;
        Scene *scene;

        oglrender= op->customdata;
        scene= oglrender->scene;

        oglrender->reports= op->reports;
        oglrender->mh= BKE_get_movie_handle(scene->r.imtype);
        if(BKE_imtype_is_movie(scene->r.imtype)) {
                if(!oglrender->mh->start_movie(scene, &scene->r, oglrender->sizex, oglrender->sizey, oglrender->reports)) {
                        screen_opengl_render_end(C, oglrender);
                        return 0;
                }
        }

        oglrender->cfrao= scene->r.cfra;
        oglrender->nfra= PSFRA;
        scene->r.cfra= PSFRA;

        return 1;
}
static int screen_opengl_render_anim_step(bContext *C, wmOperator *op)
{
        Main *bmain= CTX_data_main(C);
        OGLRender *oglrender= op->customdata;
        Scene *scene= oglrender->scene;
        ImBuf *ibuf;
        void *lock;
        char name[FILE_MAXDIR+FILE_MAXFILE];
        int ok= 0;
        const short  view_context= (oglrender->v3d != NULL);
        Object *camera= NULL;

        /* update animated image textures for gpu, etc,
         * call before scene_update_for_newframe so modifiers with textuers dont lag 1 frame */
        ED_image_update_frame(bmain, scene->r.cfra);

        /* go to next frame */
        while(CFRA<oglrender->nfra) {
                unsigned int lay= screen_opengl_layers(oglrender);

                if(lay & 0xFF000000)
                        lay &= 0xFF000000;

                scene_update_for_newframe(bmain, scene, lay);
                CFRA++;
        }

        scene_update_for_newframe(bmain, scene, screen_opengl_layers(oglrender));

        if(view_context) {
                if(oglrender->rv3d->persp==RV3D_CAMOB && oglrender->v3d->camera && oglrender->v3d->scenelock) {
                        /* since scene_update_for_newframe() is used rather
                         * then ED_update_for_newframe() the camera needs to be set */
                        if(scene_camera_switch_update(scene)) {
                                oglrender->v3d->camera= scene->camera;
                        }

                        camera= oglrender->v3d->camera;
                }
        }
        else {
                scene_camera_switch_update(scene);

                camera= scene->camera;
        }

        /* render into offscreen buffer */
        screen_opengl_render_apply(oglrender);

        /* save to disk */
        ibuf= BKE_image_acquire_ibuf(oglrender->ima, &oglrender->iuser, &lock);

        if(ibuf) {
                /* color -> greyscale */
                /* editing directly would alter the render view */
                if(scene->r.planes == 8) {
                        ImBuf *ibuf_bw= IMB_dupImBuf(ibuf);
                        IMB_color_to_bw(ibuf_bw);
                        // IMB_freeImBuf(ibuf); /* owned by the image */
                        ibuf= ibuf_bw;
                }
                else {
                        /* this is lightweight & doesnt re-alloc the buffers, only do this
                         * to save the correct bit depth since the image is always RGBA */
                        ImBuf *ibuf_cpy= IMB_allocImBuf(ibuf->x, ibuf->y, scene->r.planes, 0);
                        ibuf_cpy->rect= ibuf->rect;
                        ibuf_cpy->rect_float= ibuf->rect_float;
                        ibuf_cpy->zbuf_float= ibuf->zbuf_float;
                        ibuf= ibuf_cpy;
                }

                if(BKE_imtype_is_movie(scene->r.imtype)) {
                        ok= oglrender->mh->append_movie(&scene->r, CFRA, (int*)ibuf->rect, oglrender->sizex, oglrender->sizey, oglrender->reports);
                        if(ok) {
                                printf("Append frame %d", scene->r.cfra);
                                BKE_reportf(op->reports, RPT_INFO, "Appended frame: %d", scene->r.cfra);
                        }
                }
                else {
                        BKE_makepicstring(name, scene->r.pic, scene->r.cfra, scene->r.imtype, scene->r.scemode & R_EXTENSION, TRUE);
                        ok= BKE_write_ibuf_stamp(scene, camera, ibuf, name, scene->r.imtype, scene->r.subimtype, scene->r.quality);

                        if(ok==0) {
                                printf("Write error: cannot save %s\n", name);
                                BKE_reportf(op->reports, RPT_ERROR, "Write error: cannot save %s", name);
                        }
                        else {
                                printf("Saved: %s", name);
                                BKE_reportf(op->reports, RPT_INFO, "Saved file: %s", name);
                        }
                }

                /* imbuf knows which rects are not part of ibuf */
                IMB_freeImBuf(ibuf);
        }

        BKE_image_release_ibuf(oglrender->ima, lock);

        /* movie stats prints have no line break */
        printf("\n");

        /* go to next frame */
        oglrender->nfra += scene->r.frame_step;
        scene->r.cfra++;

        /* stop at the end or on error */
        if(scene->r.cfra > PEFRA || !ok) {
                screen_opengl_render_end(C, op->customdata);
                return 0;
        }

        return 1;
}


static int screen_opengl_render_modal(bContext *C, wmOperator *op, wmEvent *event)
{
        OGLRender *oglrender= op->customdata;
        int anim= RNA_boolean_get(op->ptr, "animation");
        int ret;

        switch(event->type) {
                case ESCKEY:
                        /* cancel */
                        screen_opengl_render_end(C, op->customdata);
                        return OPERATOR_FINISHED;
                case TIMER:
                        /* render frame? */
                        if(oglrender->timer == event->customdata)
                                break;
                default:
                        /* nothing to do */
                        return OPERATOR_RUNNING_MODAL;
        }

        /* run first because screen_opengl_render_anim_step can free oglrender */
        WM_event_add_notifier(C, NC_SCENE|ND_RENDER_RESULT, oglrender->scene);
        
        if(anim == 0) {
                screen_opengl_render_apply(op->customdata);
                screen_opengl_render_end(C, op->customdata);
                return OPERATOR_FINISHED;
        }
        else
                ret= screen_opengl_render_anim_step(C, op);

        /* stop at the end or on error */
        if(ret == 0) {
                return OPERATOR_FINISHED;
        }

        return OPERATOR_RUNNING_MODAL;
}

static int screen_opengl_render_invoke(bContext *C, wmOperator *op, wmEvent *event)
{
        OGLRender *oglrender;
        int anim= RNA_boolean_get(op->ptr, "animation");

        if(!screen_opengl_render_init(C, op))
                return OPERATOR_CANCELLED;

        if(anim) {
                if(!screen_opengl_render_anim_initialize(C, op))
                        return OPERATOR_CANCELLED;
        }
        
        oglrender= op->customdata;
        render_view_open(C, event->x, event->y);
        
        WM_event_add_modal_handler(C, op);
        oglrender->timer= WM_event_add_timer(CTX_wm_manager(C), CTX_wm_window(C), TIMER, 0.01f);
        
        return OPERATOR_RUNNING_MODAL;
}

/* executes blocking render */
static int screen_opengl_render_exec(bContext *C, wmOperator *op)
{
        const short is_animation= RNA_boolean_get(op->ptr, "animation");

        if(!screen_opengl_render_init(C, op))
                return OPERATOR_CANCELLED;

        if(!is_animation) { /* same as invoke */
                /* render image */
                screen_opengl_render_apply(op->customdata);
                screen_opengl_render_end(C, op->customdata);

                return OPERATOR_FINISHED;
        }
        else {
                int ret= 1;

                if(!screen_opengl_render_anim_initialize(C, op))
                        return OPERATOR_CANCELLED;

                while(ret) {
                        ret= screen_opengl_render_anim_step(C, op);
                }
        }

        // no redraw needed, we leave state as we entered it
//      ED_update_for_newframe(C, 1);
        WM_event_add_notifier(C, NC_SCENE|ND_RENDER_RESULT, CTX_data_scene(C));

        return OPERATOR_FINISHED;
}

void RENDER_OT_opengl(wmOperatorType *ot)
{
        /* identifiers */
        ot->name= "OpenGL Render";
        ot->description= "OpenGL render active viewport";
        ot->idname= "RENDER_OT_opengl";

        /* api callbacks */
        ot->invoke= screen_opengl_render_invoke;
        ot->exec= screen_opengl_render_exec; /* blocking */
        ot->modal= screen_opengl_render_modal;
        ot->cancel= screen_opengl_render_cancel;

        ot->poll= ED_operator_screenactive;

        RNA_def_boolean(ot->srna, "animation", 0, "Animation", "Render files from the animation range of this scene");
        RNA_def_boolean(ot->srna, "write_still", 0, "Write Image", "Save rendered the image to the output path (used only when animation is disabled)");
        RNA_def_boolean(ot->srna, "view_context", 1, "View Context", "Use the current 3D view for rendering, else use scene settings.");
}

/* function for getting an opengl buffer from a View3D, used by sequencer */
// extern void *sequencer_view3d_cb;