b5e1419e5b
This commit solves couple of issues appeared with new integrator: - Render job progress bar is now shows progress based on number of rendered tiles. This is the same as Blender Internal does. This still requires some further thoughts because for GPU it's better to use single tile and in this case progress bar should be based on number of rendered samples. - Removes "global" sample counter from progress descriptor. There's no more global-being sample which makes sense. This counter was replaced with tile counter. - Use proper sample number when copying render buffer to blender. It used to be final sample number used which lead to tiles appearing from complete dark to normal brightness as they're being rendered. Now tile would be displayed with proper brightness starting from the very first sample. Use sample counter stored in render tile descriptor and pass it to update / write callbacks. This was tested on CPU and GPU CUDA rendering. Additional change: OpenCL rendering now should be cancellable before it finished rendering all the samples (the same change as for CPU/CUDA from a while ago). This part of commit wasn't actually tested, would do it later.
728 lines
17 KiB
C++
728 lines
17 KiB
C++
/*
|
|
* Copyright 2011, Blender Foundation.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#include <string.h>
|
|
#include <limits.h>
|
|
|
|
#include "buffers.h"
|
|
#include "camera.h"
|
|
#include "device.h"
|
|
#include "scene.h"
|
|
#include "session.h"
|
|
|
|
#include "util_foreach.h"
|
|
#include "util_function.h"
|
|
#include "util_math.h"
|
|
#include "util_opengl.h"
|
|
#include "util_task.h"
|
|
#include "util_time.h"
|
|
|
|
CCL_NAMESPACE_BEGIN
|
|
|
|
Session::Session(const SessionParams& params_)
|
|
: params(params_),
|
|
tile_manager(params.progressive, params.samples, params.tile_size, params.min_size,
|
|
(params.background)? 1: max(params.device.multi_devices.size(), 1))
|
|
{
|
|
device_use_gl = ((params.device.type != DEVICE_CPU) && !params.background);
|
|
|
|
TaskScheduler::init(params.threads);
|
|
|
|
device = Device::create(params.device, params.background, params.threads);
|
|
|
|
if(params.background) {
|
|
buffers = NULL;
|
|
display = NULL;
|
|
}
|
|
else {
|
|
buffers = new RenderBuffers(device);
|
|
display = new DisplayBuffer(device);
|
|
}
|
|
|
|
session_thread = NULL;
|
|
scene = NULL;
|
|
|
|
start_time = 0.0;
|
|
reset_time = 0.0;
|
|
preview_time = 0.0;
|
|
paused_time = 0.0;
|
|
sample = 0;
|
|
|
|
delayed_reset.do_reset = false;
|
|
delayed_reset.samples = 0;
|
|
|
|
display_outdated = false;
|
|
gpu_draw_ready = false;
|
|
gpu_need_tonemap = false;
|
|
pause = false;
|
|
kernels_loaded = false;
|
|
}
|
|
|
|
Session::~Session()
|
|
{
|
|
if(session_thread) {
|
|
progress.set_cancel("Exiting");
|
|
|
|
gpu_need_tonemap = false;
|
|
gpu_need_tonemap_cond.notify_all();
|
|
|
|
{
|
|
thread_scoped_lock pause_lock(pause_mutex);
|
|
pause = false;
|
|
}
|
|
pause_cond.notify_all();
|
|
|
|
wait();
|
|
}
|
|
|
|
if(display && params.output_path != "") {
|
|
tonemap();
|
|
|
|
progress.set_status("Writing Image", params.output_path);
|
|
display->write(device, params.output_path);
|
|
}
|
|
|
|
delete buffers;
|
|
delete display;
|
|
delete scene;
|
|
delete device;
|
|
|
|
TaskScheduler::exit();
|
|
}
|
|
|
|
void Session::start()
|
|
{
|
|
session_thread = new thread(function_bind(&Session::run, this));
|
|
}
|
|
|
|
bool Session::ready_to_reset()
|
|
{
|
|
double dt = time_dt() - reset_time;
|
|
|
|
if(!display_outdated)
|
|
return (dt > params.reset_timeout);
|
|
else
|
|
return (dt > params.cancel_timeout);
|
|
}
|
|
|
|
/* GPU Session */
|
|
|
|
void Session::reset_gpu(BufferParams& buffer_params, int samples)
|
|
{
|
|
/* block for buffer acces and reset immediately. we can't do this
|
|
* in the thread, because we need to allocate an OpenGL buffer, and
|
|
* that only works in the main thread */
|
|
thread_scoped_lock display_lock(display_mutex);
|
|
thread_scoped_lock buffers_lock(buffers_mutex);
|
|
|
|
display_outdated = true;
|
|
reset_time = time_dt();
|
|
|
|
reset_(buffer_params, samples);
|
|
|
|
gpu_need_tonemap = false;
|
|
gpu_need_tonemap_cond.notify_all();
|
|
|
|
pause_cond.notify_all();
|
|
}
|
|
|
|
bool Session::draw_gpu(BufferParams& buffer_params)
|
|
{
|
|
/* block for buffer access */
|
|
thread_scoped_lock display_lock(display_mutex);
|
|
|
|
/* first check we already rendered something */
|
|
if(gpu_draw_ready) {
|
|
/* then verify the buffers have the expected size, so we don't
|
|
* draw previous results in a resized window */
|
|
if(!buffer_params.modified(display->params)) {
|
|
/* for CUDA we need to do tonemapping still, since we can
|
|
* only access GL buffers from the main thread */
|
|
if(gpu_need_tonemap) {
|
|
thread_scoped_lock buffers_lock(buffers_mutex);
|
|
tonemap();
|
|
gpu_need_tonemap = false;
|
|
gpu_need_tonemap_cond.notify_all();
|
|
}
|
|
|
|
display->draw(device);
|
|
|
|
if(display_outdated && (time_dt() - reset_time) > params.text_timeout)
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
void Session::run_gpu()
|
|
{
|
|
start_time = time_dt();
|
|
reset_time = time_dt();
|
|
paused_time = 0.0;
|
|
|
|
if(!params.background)
|
|
progress.set_start_time(start_time + paused_time);
|
|
|
|
while(!progress.get_cancel()) {
|
|
/* advance to next tile */
|
|
bool no_tiles = !tile_manager.next();
|
|
|
|
if(params.background) {
|
|
/* if no work left and in background mode, we can stop immediately */
|
|
if(no_tiles) {
|
|
progress.set_status("Finished");
|
|
break;
|
|
}
|
|
}
|
|
else {
|
|
/* if in interactive mode, and we are either paused or done for now,
|
|
* wait for pause condition notify to wake up again */
|
|
thread_scoped_lock pause_lock(pause_mutex);
|
|
|
|
if(pause || no_tiles) {
|
|
update_status_time(pause, no_tiles);
|
|
|
|
while(1) {
|
|
double pause_start = time_dt();
|
|
pause_cond.wait(pause_lock);
|
|
paused_time += time_dt() - pause_start;
|
|
|
|
if(!params.background)
|
|
progress.set_start_time(start_time + paused_time);
|
|
|
|
update_status_time(pause, no_tiles);
|
|
progress.set_update();
|
|
|
|
if(!pause)
|
|
break;
|
|
}
|
|
}
|
|
|
|
if(progress.get_cancel())
|
|
break;
|
|
}
|
|
|
|
if(!no_tiles) {
|
|
/* update scene */
|
|
update_scene();
|
|
|
|
if(device->error_message() != "")
|
|
progress.set_cancel(device->error_message());
|
|
|
|
if(progress.get_cancel())
|
|
break;
|
|
}
|
|
|
|
if(!no_tiles) {
|
|
/* buffers mutex is locked entirely while rendering each
|
|
* sample, and released/reacquired on each iteration to allow
|
|
* reset and draw in between */
|
|
thread_scoped_lock buffers_lock(buffers_mutex);
|
|
|
|
/* update status and timing */
|
|
update_status_time();
|
|
|
|
/* path trace */
|
|
path_trace();
|
|
|
|
device->task_wait();
|
|
|
|
if(device->error_message() != "")
|
|
progress.set_cancel(device->error_message());
|
|
|
|
/* update status and timing */
|
|
update_status_time();
|
|
|
|
gpu_need_tonemap = true;
|
|
gpu_draw_ready = true;
|
|
progress.set_update();
|
|
|
|
/* wait for tonemap */
|
|
if(!params.background) {
|
|
while(gpu_need_tonemap) {
|
|
if(progress.get_cancel())
|
|
break;
|
|
|
|
gpu_need_tonemap_cond.wait(buffers_lock);
|
|
}
|
|
}
|
|
|
|
if(device->error_message() != "")
|
|
progress.set_cancel(device->error_message());
|
|
|
|
if(progress.get_cancel())
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
/* CPU Session */
|
|
|
|
void Session::reset_cpu(BufferParams& buffer_params, int samples)
|
|
{
|
|
thread_scoped_lock reset_lock(delayed_reset.mutex);
|
|
|
|
display_outdated = true;
|
|
reset_time = time_dt();
|
|
|
|
delayed_reset.params = buffer_params;
|
|
delayed_reset.samples = samples;
|
|
delayed_reset.do_reset = true;
|
|
device->task_cancel();
|
|
|
|
pause_cond.notify_all();
|
|
}
|
|
|
|
bool Session::draw_cpu(BufferParams& buffer_params)
|
|
{
|
|
thread_scoped_lock display_lock(display_mutex);
|
|
|
|
/* first check we already rendered something */
|
|
if(display->draw_ready()) {
|
|
/* then verify the buffers have the expected size, so we don't
|
|
* draw previous results in a resized window */
|
|
if(!buffer_params.modified(display->params)) {
|
|
display->draw(device);
|
|
|
|
if(display_outdated && (time_dt() - reset_time) > params.text_timeout)
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
bool Session::acquire_tile(Device *tile_device, RenderTile& rtile)
|
|
{
|
|
if(progress.get_cancel())
|
|
return false;
|
|
|
|
thread_scoped_lock tile_lock(tile_mutex);
|
|
|
|
/* get next tile from manager */
|
|
Tile tile;
|
|
int device_num = device->device_number(tile_device);
|
|
|
|
if(!tile_manager.next_tile(tile, device_num))
|
|
return false;
|
|
|
|
/* fill render tile */
|
|
rtile.x = tile_manager.state.buffer.full_x + tile.x;
|
|
rtile.y = tile_manager.state.buffer.full_y + tile.y;
|
|
rtile.w = tile.w;
|
|
rtile.h = tile.h;
|
|
rtile.start_sample = tile_manager.state.sample;
|
|
rtile.num_samples = tile_manager.state.num_samples;
|
|
rtile.resolution = tile_manager.state.resolution;
|
|
|
|
tile_lock.unlock();
|
|
|
|
/* in case of a permant buffer, return it, otherwise we will allocate
|
|
* a new temporary buffer */
|
|
if(!write_render_tile_cb) {
|
|
tile_manager.state.buffer.get_offset_stride(rtile.offset, rtile.stride);
|
|
|
|
rtile.buffer = buffers->buffer.device_pointer;
|
|
rtile.rng_state = buffers->rng_state.device_pointer;
|
|
rtile.rgba = display->rgba.device_pointer;
|
|
rtile.buffers = buffers;
|
|
|
|
device->map_tile(tile_device, rtile);
|
|
|
|
return true;
|
|
}
|
|
|
|
/* fill buffer parameters */
|
|
BufferParams buffer_params = tile_manager.params;
|
|
buffer_params.full_x = rtile.x;
|
|
buffer_params.full_y = rtile.y;
|
|
buffer_params.width = rtile.w;
|
|
buffer_params.height = rtile.h;
|
|
|
|
buffer_params.get_offset_stride(rtile.offset, rtile.stride);
|
|
|
|
/* allocate buffers */
|
|
RenderBuffers *tilebuffers = new RenderBuffers(tile_device);
|
|
tilebuffers->reset(tile_device, buffer_params);
|
|
|
|
rtile.buffer = tilebuffers->buffer.device_pointer;
|
|
rtile.rng_state = tilebuffers->rng_state.device_pointer;
|
|
rtile.rgba = 0;
|
|
rtile.buffers = tilebuffers;
|
|
|
|
return true;
|
|
}
|
|
|
|
void Session::update_tile_sample(RenderTile& rtile)
|
|
{
|
|
thread_scoped_lock tile_lock(tile_mutex);
|
|
|
|
if(update_render_tile_cb) {
|
|
/* todo: optimize this by making it thread safe and removing lock */
|
|
|
|
if(!progress.get_cancel())
|
|
update_render_tile_cb(rtile);
|
|
}
|
|
|
|
update_status_time();
|
|
}
|
|
|
|
void Session::release_tile(RenderTile& rtile)
|
|
{
|
|
thread_scoped_lock tile_lock(tile_mutex);
|
|
|
|
if(write_render_tile_cb) {
|
|
/* todo: optimize this by making it thread safe and removing lock */
|
|
if(!progress.get_cancel())
|
|
write_render_tile_cb(rtile);
|
|
delete rtile.buffers;
|
|
}
|
|
|
|
update_status_time();
|
|
}
|
|
|
|
void Session::run_cpu()
|
|
{
|
|
{
|
|
/* reset once to start */
|
|
thread_scoped_lock reset_lock(delayed_reset.mutex);
|
|
thread_scoped_lock buffers_lock(buffers_mutex);
|
|
thread_scoped_lock display_lock(display_mutex);
|
|
|
|
reset_(delayed_reset.params, delayed_reset.samples);
|
|
delayed_reset.do_reset = false;
|
|
}
|
|
|
|
while(!progress.get_cancel()) {
|
|
/* advance to next tile */
|
|
bool no_tiles = !tile_manager.next();
|
|
bool need_tonemap = false;
|
|
|
|
if(params.background) {
|
|
/* if no work left and in background mode, we can stop immediately */
|
|
if(no_tiles) {
|
|
progress.set_status("Finished");
|
|
break;
|
|
}
|
|
}
|
|
else {
|
|
/* if in interactive mode, and we are either paused or done for now,
|
|
* wait for pause condition notify to wake up again */
|
|
thread_scoped_lock pause_lock(pause_mutex);
|
|
|
|
if(pause || no_tiles) {
|
|
update_status_time(pause, no_tiles);
|
|
|
|
while(1) {
|
|
double pause_start = time_dt();
|
|
pause_cond.wait(pause_lock);
|
|
paused_time += time_dt() - pause_start;
|
|
|
|
if(!params.background)
|
|
progress.set_start_time(start_time + paused_time);
|
|
|
|
update_status_time(pause, no_tiles);
|
|
progress.set_update();
|
|
|
|
if(!pause)
|
|
break;
|
|
}
|
|
}
|
|
|
|
if(progress.get_cancel())
|
|
break;
|
|
}
|
|
|
|
if(!no_tiles) {
|
|
/* buffers mutex is locked entirely while rendering each
|
|
* sample, and released/reacquired on each iteration to allow
|
|
* reset and draw in between */
|
|
thread_scoped_lock buffers_lock(buffers_mutex);
|
|
|
|
/* update scene */
|
|
update_scene();
|
|
|
|
if(device->error_message() != "")
|
|
progress.set_cancel(device->error_message());
|
|
|
|
if(progress.get_cancel())
|
|
break;
|
|
|
|
/* update status and timing */
|
|
update_status_time();
|
|
|
|
/* path trace */
|
|
path_trace();
|
|
|
|
/* update status and timing */
|
|
update_status_time();
|
|
|
|
if(!params.background)
|
|
need_tonemap = true;
|
|
|
|
if(device->error_message() != "")
|
|
progress.set_cancel(device->error_message());
|
|
}
|
|
|
|
device->task_wait();
|
|
|
|
{
|
|
thread_scoped_lock reset_lock(delayed_reset.mutex);
|
|
thread_scoped_lock buffers_lock(buffers_mutex);
|
|
thread_scoped_lock display_lock(display_mutex);
|
|
|
|
if(delayed_reset.do_reset) {
|
|
/* reset rendering if request from main thread */
|
|
delayed_reset.do_reset = false;
|
|
reset_(delayed_reset.params, delayed_reset.samples);
|
|
}
|
|
else if(need_tonemap) {
|
|
/* tonemap only if we do not reset, we don't we don't
|
|
* wan't to show the result of an incomplete sample*/
|
|
tonemap();
|
|
}
|
|
|
|
if(device->error_message() != "")
|
|
progress.set_cancel(device->error_message());
|
|
}
|
|
|
|
progress.set_update();
|
|
}
|
|
}
|
|
|
|
void Session::run()
|
|
{
|
|
/* load kernels */
|
|
if(!kernels_loaded) {
|
|
progress.set_status("Loading render kernels (may take a few minutes the first time)");
|
|
|
|
if(!device->load_kernels(params.experimental)) {
|
|
string message = device->error_message();
|
|
if(message == "")
|
|
message = "Failed loading render kernel, see console for errors";
|
|
|
|
progress.set_status("Error", message);
|
|
progress.set_update();
|
|
return;
|
|
}
|
|
|
|
kernels_loaded = true;
|
|
}
|
|
|
|
/* session thread loop */
|
|
progress.set_status("Waiting for render to start");
|
|
|
|
/* run */
|
|
if(!progress.get_cancel()) {
|
|
if(device_use_gl)
|
|
run_gpu();
|
|
else
|
|
run_cpu();
|
|
}
|
|
|
|
/* progress update */
|
|
if(progress.get_cancel())
|
|
progress.set_status("Cancel", progress.get_cancel_message());
|
|
else
|
|
progress.set_update();
|
|
}
|
|
|
|
bool Session::draw(BufferParams& buffer_params)
|
|
{
|
|
if(device_use_gl)
|
|
return draw_gpu(buffer_params);
|
|
else
|
|
return draw_cpu(buffer_params);
|
|
}
|
|
|
|
void Session::reset_(BufferParams& buffer_params, int samples)
|
|
{
|
|
if(buffers) {
|
|
if(buffer_params.modified(buffers->params)) {
|
|
gpu_draw_ready = false;
|
|
buffers->reset(device, buffer_params);
|
|
display->reset(device, buffer_params);
|
|
}
|
|
}
|
|
|
|
tile_manager.reset(buffer_params, samples);
|
|
|
|
start_time = time_dt();
|
|
preview_time = 0.0;
|
|
paused_time = 0.0;
|
|
sample = 0;
|
|
|
|
if(!params.background)
|
|
progress.set_start_time(start_time + paused_time);
|
|
}
|
|
|
|
void Session::reset(BufferParams& buffer_params, int samples)
|
|
{
|
|
if(device_use_gl)
|
|
reset_gpu(buffer_params, samples);
|
|
else
|
|
reset_cpu(buffer_params, samples);
|
|
}
|
|
|
|
void Session::set_samples(int samples)
|
|
{
|
|
if(samples != params.samples) {
|
|
params.samples = samples;
|
|
tile_manager.set_samples(samples);
|
|
|
|
{
|
|
thread_scoped_lock pause_lock(pause_mutex);
|
|
}
|
|
pause_cond.notify_all();
|
|
}
|
|
}
|
|
|
|
void Session::set_pause(bool pause_)
|
|
{
|
|
bool notify = false;
|
|
|
|
{
|
|
thread_scoped_lock pause_lock(pause_mutex);
|
|
|
|
if(pause != pause_) {
|
|
pause = pause_;
|
|
notify = true;
|
|
}
|
|
}
|
|
|
|
if(notify)
|
|
pause_cond.notify_all();
|
|
}
|
|
|
|
void Session::wait()
|
|
{
|
|
session_thread->join();
|
|
delete session_thread;
|
|
|
|
session_thread = NULL;
|
|
}
|
|
|
|
void Session::update_scene()
|
|
{
|
|
thread_scoped_lock scene_lock(scene->mutex);
|
|
|
|
/* update camera if dimensions changed for progressive render. the camera
|
|
* knows nothing about progressive or cropped rendering, it just gets the
|
|
* image dimensions passed in */
|
|
Camera *cam = scene->camera;
|
|
int width = tile_manager.state.buffer.full_width;
|
|
int height = tile_manager.state.buffer.full_height;
|
|
|
|
if(width != cam->width || height != cam->height) {
|
|
cam->width = width;
|
|
cam->height = height;
|
|
cam->tag_update();
|
|
}
|
|
|
|
/* update scene */
|
|
if(scene->need_update()) {
|
|
progress.set_status("Updating Scene");
|
|
scene->device_update(device, progress);
|
|
}
|
|
}
|
|
|
|
void Session::update_status_time(bool show_pause, bool show_done)
|
|
{
|
|
int resolution = tile_manager.state.resolution;
|
|
int num_tiles = tile_manager.state.num_tiles;
|
|
int tile = tile_manager.state.num_rendered_tiles;
|
|
|
|
/* update status */
|
|
string status, substatus;
|
|
|
|
if(!params.progressive)
|
|
substatus = string_printf("Path Tracing Tile %d/%d", tile, num_tiles);
|
|
else if(params.samples == INT_MAX)
|
|
substatus = string_printf("Path Tracing Sample %d", sample+1);
|
|
else
|
|
substatus = string_printf("Path Tracing Sample %d/%d", sample+1, params.samples);
|
|
|
|
if(show_pause)
|
|
status = "Paused";
|
|
else if(show_done)
|
|
status = "Done";
|
|
else
|
|
status = "Rendering";
|
|
|
|
progress.set_status(status, substatus);
|
|
|
|
/* update timing */
|
|
if(preview_time == 0.0 && resolution == 1)
|
|
preview_time = time_dt();
|
|
|
|
double tile_time = (tile == 0)? 0.0: (time_dt() - preview_time - paused_time)/(sample);
|
|
|
|
/* negative can happen when we pause a bit before rendering, can discard that */
|
|
if(preview_time < 0.0) preview_time = 0.0;
|
|
|
|
progress.set_tile(tile, tile_time);
|
|
}
|
|
|
|
|
|
void Session::path_trace()
|
|
{
|
|
/* add path trace task */
|
|
DeviceTask task(DeviceTask::PATH_TRACE);
|
|
|
|
task.acquire_tile = function_bind(&Session::acquire_tile, this, _1, _2);
|
|
task.release_tile = function_bind(&Session::release_tile, this, _1);
|
|
task.get_cancel = function_bind(&Progress::get_cancel, &this->progress);
|
|
task.update_tile_sample = function_bind(&Session::update_tile_sample, this, _1);
|
|
|
|
device->task_add(task);
|
|
}
|
|
|
|
void Session::tonemap()
|
|
{
|
|
/* add tonemap task */
|
|
DeviceTask task(DeviceTask::TONEMAP);
|
|
|
|
task.x = tile_manager.state.buffer.full_x;
|
|
task.y = tile_manager.state.buffer.full_y;
|
|
task.w = tile_manager.state.buffer.width;
|
|
task.h = tile_manager.state.buffer.height;
|
|
task.rgba = display->rgba.device_pointer;
|
|
task.buffer = buffers->buffer.device_pointer;
|
|
task.sample = tile_manager.state.sample;
|
|
task.resolution = tile_manager.state.resolution;
|
|
tile_manager.state.buffer.get_offset_stride(task.offset, task.stride);
|
|
|
|
if(task.w > 0 && task.h > 0) {
|
|
device->task_add(task);
|
|
device->task_wait();
|
|
|
|
/* set display to new size */
|
|
display->draw_set(task.w, task.h);
|
|
}
|
|
|
|
display_outdated = false;
|
|
}
|
|
|
|
CCL_NAMESPACE_END
|
|
|