intern/cycles/blender/blender_sync.cpp

   1 /*
   2  * Copyright 2011, Blender Foundation.
   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
  19 #include "background.h"
  20 #include "film.h"
  21 #include "../render/filter.h"
  22 #include "graph.h"
  23 #include "integrator.h"
  24 #include "light.h"
  25 #include "mesh.h"
  26 #include "nodes.h"
  27 #include "object.h"
  28 #include "scene.h"
  29 #include "shader.h"
  30
  31 #include "device.h"
  32
  33 #include "blender_sync.h"
  34 #include "blender_util.h"
  35
  36 #include "util_debug.h"
  37 #include "util_foreach.h"
  38
  39 CCL_NAMESPACE_BEGIN
  40
  41 /* Constructor */
  42
  43 BlenderSync::BlenderSync(BL::BlendData b_data_, BL::Scene b_scene_, Scene *scene_, bool preview_)
  44 : b_data(b_data_), b_scene(b_scene_),
  45   shader_map(&scene_->shaders),
  46   object_map(&scene_->objects),
  47   mesh_map(&scene_->meshes),
  48   light_map(&scene_->lights),
  49   world_map(NULL),
  50   world_recalc(false),
  51   experimental(false)
  52 {
  53         scene = scene_;
  54         preview = preview_;
  55 }
  56
  57 BlenderSync::~BlenderSync()
  58 {
  59 }
  60
  61 /* Sync */
  62
  63 bool BlenderSync::sync_recalc()
  64 {
  65         /* sync recalc flags from blender to cycles. actual update is done separate,
  66            so we can do it later on if doing it immediate is not suitable */
  67
  68         BL::BlendData::materials_iterator b_mat;
  69
  70         for(b_data.materials.begin(b_mat); b_mat != b_data.materials.end(); ++b_mat)
  71                 if(b_mat->is_updated() || (b_mat->node_tree() && b_mat->node_tree().is_updated()))
  72                         shader_map.set_recalc(*b_mat);
  73
  74         BL::BlendData::lamps_iterator b_lamp;
  75
  76         for(b_data.lamps.begin(b_lamp); b_lamp != b_data.lamps.end(); ++b_lamp)
  77                 if(b_lamp->is_updated() || (b_lamp->node_tree() && b_lamp->node_tree().is_updated()))
  78                         shader_map.set_recalc(*b_lamp);
  79
  80         BL::BlendData::objects_iterator b_ob;
  81
  82         for(b_data.objects.begin(b_ob); b_ob != b_data.objects.end(); ++b_ob) {
  83                 if(b_ob->is_updated()) {
  84                         object_map.set_recalc(*b_ob);
  85                         light_map.set_recalc(*b_ob);
  86                 }
  87
  88                 if(object_is_mesh(*b_ob)) {
  89                         if(b_ob->is_updated_data() || b_ob->data().is_updated()) {
  90                                 BL::ID key = object_is_modified(*b_ob)? *b_ob: b_ob->data();
  91                                 mesh_map.set_recalc(key);
  92                         }
  93                 }
  94                 else if(object_is_light(*b_ob)) {
  95                         if(b_ob->is_updated_data() || b_ob->data().is_updated())
  96                                 light_map.set_recalc(*b_ob);
  97                 }
  98         }
  99
 100         BL::BlendData::meshes_iterator b_mesh;
 101
 102         for(b_data.meshes.begin(b_mesh); b_mesh != b_data.meshes.end(); ++b_mesh)
 103                 if(b_mesh->is_updated())
 104                         mesh_map.set_recalc(*b_mesh);
 105
 106         BL::BlendData::worlds_iterator b_world;
 107
 108         for(b_data.worlds.begin(b_world); b_world != b_data.worlds.end(); ++b_world)
 109                 if(world_map == b_world->ptr.data &&
 110                         (b_world->is_updated() || (b_world->node_tree() && b_world->node_tree().is_updated())))
 111                         world_recalc = true;
 112
 113         bool recalc =
 114                 shader_map.has_recalc() ||
 115                 object_map.has_recalc() ||
 116                 light_map.has_recalc() ||
 117                 mesh_map.has_recalc() ||
 118                 BlendDataObjects_is_updated_get(&b_data.ptr) ||
 119                 world_recalc;
 120
 121         return recalc;
 122 }
 123
 124 void BlenderSync::sync_data(BL::SpaceView3D b_v3d, const char *layer)
 125 {
 126         sync_render_layers(b_v3d, layer);
 127         sync_integrator();
 128         sync_film();
 129         sync_shaders();
 130         sync_objects(b_v3d);
 131 }
 132
 133 /* Integrator */
 134
 135 void BlenderSync::sync_integrator()
 136 {
 137         PointerRNA cscene = RNA_pointer_get(&b_scene.ptr, "cycles");
 138
 139         experimental = (RNA_enum_get(&cscene, "feature_set") != 0);
 140
 141         Integrator *integrator = scene->integrator;
 142         Integrator previntegrator = *integrator;
 143
 144         integrator->min_bounce = get_int(cscene, "min_bounces");
 145         integrator->max_bounce = get_int(cscene, "max_bounces");
 146
 147         integrator->max_diffuse_bounce = get_int(cscene, "diffuse_bounces");
 148         integrator->max_glossy_bounce = get_int(cscene, "glossy_bounces");
 149         integrator->max_transmission_bounce = get_int(cscene, "transmission_bounces");
 150
 151         integrator->transparent_max_bounce = get_int(cscene, "transparent_max_bounces");
 152         integrator->transparent_min_bounce = get_int(cscene, "transparent_min_bounces");
 153         integrator->transparent_shadows = get_boolean(cscene, "use_transparent_shadows");
 154
 155         integrator->no_caustics = get_boolean(cscene, "no_caustics");
 156         integrator->seed = get_int(cscene, "seed");
 157
 158         integrator->layer_flag = render_layer.layer;
 159
 160         if(integrator->modified(previntegrator))
 161                 integrator->tag_update(scene);
 162 }
 163
 164 /* Film */
 165
 166 void BlenderSync::sync_film()
 167 {
 168         PointerRNA cscene = RNA_pointer_get(&b_scene.ptr, "cycles");
 169
 170         Film *film = scene->film;
 171         Film prevfilm = *film;
 172
 173         film->exposure = get_float(cscene, "film_exposure");
 174
 175         if(film->modified(prevfilm))
 176                 film->tag_update(scene);
 177
 178         Filter *filter = scene->filter;
 179         Filter prevfilter = *filter;
 180
 181         filter->filter_type = (FilterType)RNA_enum_get(&cscene, "filter_type");
 182         filter->filter_width = (filter->filter_type == FILTER_BOX)? 1.0f: get_float(cscene, "filter_width");
 183
 184         if(filter->modified(prevfilter))
 185                 filter->tag_update(scene);
 186 }
 187
 188 /* Render Layer */
 189
 190 void BlenderSync::sync_render_layers(BL::SpaceView3D b_v3d, const char *layer)
 191 {
 192         if(b_v3d) {
 193                 render_layer.scene_layer = get_layer(b_v3d.layers());
 194                 render_layer.layer = render_layer.scene_layer;
 195                 render_layer.material_override = PointerRNA_NULL;
 196         }
 197         else {
 198                 BL::RenderSettings r = b_scene.render();
 199                 BL::RenderSettings::layers_iterator b_rlay;
 200                 bool first_layer = true;
 201
 202                 for(r.layers.begin(b_rlay); b_rlay != r.layers.end(); ++b_rlay) {
 203                         if((!layer && first_layer) || (layer && b_rlay->name() == layer)) {
 204                                 render_layer.name = b_rlay->name();
 205                                 render_layer.scene_layer = get_layer(b_scene.layers());
 206                                 render_layer.layer = get_layer(b_rlay->layers());
 207                                 render_layer.holdout_layer = (b_rlay->use_zmask())? ~get_layer(b_rlay->layers_zmask()): 0;
 208                                 render_layer.layer |= render_layer.holdout_layer;
 209                                 render_layer.material_override = b_rlay->material_override();
 210                         }
 211
 212                         first_layer = false;
 213                 }
 214         }
 215 }
 216
 217 /* Scene Parameters */
 218
 219 SceneParams BlenderSync::get_scene_params(BL::Scene b_scene, bool background)
 220 {
 221         SceneParams params;
 222         PointerRNA cscene = RNA_pointer_get(&b_scene.ptr, "cycles");
 223         int shadingsystem = RNA_enum_get(&cscene, "shading_system");
 224
 225         if(shadingsystem == 0)
 226                 params.shadingsystem = SceneParams::SVM;
 227         else if(shadingsystem == 1)
 228                 params.shadingsystem = SceneParams::OSL;
 229
 230         if(background)
 231                 params.bvh_type = SceneParams::BVH_STATIC;
 232         else
 233                 params.bvh_type = (SceneParams::BVHType)RNA_enum_get(&cscene, "debug_bvh_type");
 234
 235         params.use_bvh_spatial_split = RNA_boolean_get(&cscene, "debug_use_spatial_splits");
 236         params.use_bvh_cache = (background)? RNA_boolean_get(&cscene, "use_cache"): false;
 237
 238         return params;
 239 }
 240
 241 /* Session Parameters */
 242
 243 bool BlenderSync::get_session_pause(BL::Scene b_scene, bool background)
 244 {
 245         PointerRNA cscene = RNA_pointer_get(&b_scene.ptr, "cycles");
 246         return (background)? false: get_boolean(cscene, "preview_pause");
 247 }
 248
 249 SessionParams BlenderSync::get_session_params(BL::UserPreferences b_userpref, BL::Scene b_scene, bool background)
 250 {
 251         SessionParams params;
 252         PointerRNA cscene = RNA_pointer_get(&b_scene.ptr, "cycles");
 253
 254         /* feature set */
 255         params.experimental = (RNA_enum_get(&cscene, "feature_set") != 0);
 256
 257         /* device type */
 258         vector<DeviceInfo>& devices = Device::available_devices();
 259
 260         /* device default CPU */
 261         params.device = devices[0];
 262
 263         if(RNA_enum_get(&cscene, "device") != 0) {
 264                 /* find GPU device with given id */
 265                 PointerRNA systemptr = b_userpref.system().ptr;
 266                 PropertyRNA *deviceprop = RNA_struct_find_property(&systemptr, "compute_device");
 267                 int device_id = b_userpref.system().compute_device();
 268
 269                 const char *id;
 270
 271                 if(RNA_property_enum_identifier(NULL, &systemptr, deviceprop, device_id, &id)) {
 272                         foreach(DeviceInfo& info, devices)
 273                                 if(info.id == id)
 274                                         params.device = info;
 275                 }
 276         }
 277
 278         /* Background */
 279         params.background = background;
 280
 281         /* samples */
 282         if(background) {
 283                 params.samples = get_int(cscene, "samples");
 284         }
 285         else {
 286                 params.samples = get_int(cscene, "preview_samples");
 287                 if(params.samples == 0)
 288                         params.samples = INT_MAX;
 289         }
 290
 291         /* other parameters */
 292         params.threads = b_scene.render().threads();
 293         params.tile_size = get_int(cscene, "debug_tile_size");
 294         params.min_size = get_int(cscene, "debug_min_size");
 295         params.cancel_timeout = get_float(cscene, "debug_cancel_timeout");
 296         params.reset_timeout = get_float(cscene, "debug_reset_timeout");
 297         params.text_timeout = get_float(cscene, "debug_text_timeout");
 298
 299         if(background) {
 300                 params.progressive = true;
 301                 params.min_size = INT_MAX;
 302         }
 303         else
 304                 params.progressive = true;
 305
 306         /* todo: multi device only works with single tiles now */
 307         if(params.device.type == DEVICE_MULTI)
 308                 params.tile_size = INT_MAX;
 309
 310         return params;
 311 }
 312
 313 CCL_NAMESPACE_END
 314