Merge branch 'blender2.7'
[blender.git] / intern / cycles / blender / blender_session.cpp
1 /*
2  * Copyright 2011-2013 Blender Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <stdlib.h>
18
19 #include "render/background.h"
20 #include "render/buffers.h"
21 #include "render/camera.h"
22 #include "device/device.h"
23 #include "render/integrator.h"
24 #include "render/film.h"
25 #include "render/light.h"
26 #include "render/mesh.h"
27 #include "render/object.h"
28 #include "render/scene.h"
29 #include "render/session.h"
30 #include "render/shader.h"
31 #include "render/stats.h"
32
33 #include "util/util_algorithm.h"
34 #include "util/util_color.h"
35 #include "util/util_foreach.h"
36 #include "util/util_function.h"
37 #include "util/util_hash.h"
38 #include "util/util_logging.h"
39 #include "util/util_murmurhash.h"
40 #include "util/util_progress.h"
41 #include "util/util_time.h"
42
43 #include "blender/blender_sync.h"
44 #include "blender/blender_session.h"
45 #include "blender/blender_util.h"
46
47 CCL_NAMESPACE_BEGIN
48
49 bool BlenderSession::headless = false;
50 int BlenderSession::num_resumable_chunks = 0;
51 int BlenderSession::current_resumable_chunk = 0;
52 int BlenderSession::start_resumable_chunk = 0;
53 int BlenderSession::end_resumable_chunk = 0;
54 bool BlenderSession::print_render_stats = false;
55
56 BlenderSession::BlenderSession(BL::RenderEngine& b_engine,
57                                BL::Preferences& b_userpref,
58                                BL::BlendData& b_data,
59                                bool preview_osl)
60 : session(NULL),
61   sync(NULL),
62   b_engine(b_engine),
63   b_userpref(b_userpref),
64   b_data(b_data),
65   b_render(b_engine.render()),
66   b_depsgraph(PointerRNA_NULL),
67   b_scene(PointerRNA_NULL),
68   b_v3d(PointerRNA_NULL),
69   b_rv3d(PointerRNA_NULL),
70   width(0),
71   height(0),
72   preview_osl(preview_osl),
73   python_thread_state(NULL)
74 {
75         /* offline render */
76         background = true;
77         last_redraw_time = 0.0;
78         start_resize_time = 0.0;
79         last_status_time = 0.0;
80 }
81
82 BlenderSession::BlenderSession(BL::RenderEngine& b_engine,
83                                BL::Preferences& b_userpref,
84                                BL::BlendData& b_data,
85                                BL::SpaceView3D& b_v3d,
86                                BL::RegionView3D& b_rv3d,
87                                int width, int height)
88 : session(NULL),
89   sync(NULL),
90   b_engine(b_engine),
91   b_userpref(b_userpref),
92   b_data(b_data),
93   b_render(b_engine.render()),
94   b_depsgraph(PointerRNA_NULL),
95   b_scene(PointerRNA_NULL),
96   b_v3d(b_v3d),
97   b_rv3d(b_rv3d),
98   width(width),
99   height(height),
100   preview_osl(false),
101   python_thread_state(NULL)
102 {
103         /* 3d view render */
104         background = false;
105         last_redraw_time = 0.0;
106         start_resize_time = 0.0;
107         last_status_time = 0.0;
108 }
109
110 BlenderSession::~BlenderSession()
111 {
112         free_session();
113 }
114
115 void BlenderSession::create()
116 {
117         create_session();
118 }
119
120 void BlenderSession::create_session()
121 {
122         SessionParams session_params = BlenderSync::get_session_params(b_engine, b_userpref, b_scene, background);
123         SceneParams scene_params = BlenderSync::get_scene_params(b_scene, background);
124         bool session_pause = BlenderSync::get_session_pause(b_scene, background);
125
126         /* reset status/progress */
127         last_status = "";
128         last_error = "";
129         last_progress = -1.0f;
130         start_resize_time = 0.0;
131
132         /* create session */
133         session = new Session(session_params);
134         session->scene = scene;
135         session->progress.set_update_callback(function_bind(&BlenderSession::tag_redraw, this));
136         session->progress.set_cancel_callback(function_bind(&BlenderSession::test_cancel, this));
137         session->set_pause(session_pause);
138
139         /* create scene */
140         scene = new Scene(scene_params, session->device);
141         scene->name = b_scene.name();
142
143         /* setup callbacks for builtin image support */
144         scene->image_manager->builtin_image_info_cb = function_bind(&BlenderSession::builtin_image_info, this, _1, _2, _3);
145         scene->image_manager->builtin_image_pixels_cb = function_bind(&BlenderSession::builtin_image_pixels, this, _1, _2, _3, _4, _5);
146         scene->image_manager->builtin_image_float_pixels_cb = function_bind(&BlenderSession::builtin_image_float_pixels, this, _1, _2, _3, _4, _5);
147
148         session->scene = scene;
149
150         /* There is no single depsgraph to use for the entire render.
151          * So we need to handle this differently.
152          *
153          * We could loop over the final render result render layers in pipeline and keep Cycles unaware of multiple layers,
154          * or perhaps move syncing further down in the pipeline.
155          */
156         /* create sync */
157         sync = new BlenderSync(b_engine, b_data, b_scene, scene, !background, session->progress);
158         BL::Object b_camera_override(b_engine.camera_override());
159         if(b_v3d) {
160                 sync->sync_view(b_v3d, b_rv3d, width, height);
161         }
162         else {
163                 sync->sync_camera(b_render, b_camera_override, width, height, "");
164         }
165
166         /* set buffer parameters */
167         BufferParams buffer_params = BlenderSync::get_buffer_params(b_render, b_v3d, b_rv3d, scene->camera, width, height);
168         session->reset(buffer_params, session_params.samples);
169
170         b_engine.use_highlight_tiles(session_params.progressive_refine == false);
171
172         update_resumable_tile_manager(session_params.samples);
173 }
174
175 void BlenderSession::reset_session(BL::BlendData& b_data, BL::Depsgraph& b_depsgraph)
176 {
177         this->b_data = b_data;
178         this->b_depsgraph = b_depsgraph;
179         this->b_scene = b_depsgraph.scene_eval();
180
181         if(preview_osl) {
182                 PointerRNA cscene = RNA_pointer_get(&b_scene.ptr, "cycles");
183                 RNA_boolean_set(&cscene, "shading_system", preview_osl);
184         }
185
186         if(b_v3d) {
187                 this->b_render = b_scene.render();
188         }
189         else {
190                 this->b_render = b_engine.render();
191                 width = render_resolution_x(b_render);
192                 height = render_resolution_y(b_render);
193         }
194
195         if(session == NULL) {
196                 create();
197         }
198
199         if(b_v3d) {
200                 /* NOTE: We need to create session, but all the code from below
201                  * will make viewport render to stuck on initialization.
202                  */
203                 return;
204         }
205
206         SessionParams session_params = BlenderSync::get_session_params(b_engine, b_userpref, b_scene, background);
207         SceneParams scene_params = BlenderSync::get_scene_params(b_scene, background);
208
209         if(scene->params.modified(scene_params) ||
210            session->params.modified(session_params) ||
211            !scene_params.persistent_data)
212         {
213                 /* if scene or session parameters changed, it's easier to simply re-create
214                  * them rather than trying to distinguish which settings need to be updated
215                  */
216                 free_session();
217                 create_session();
218                 return;
219         }
220
221         session->progress.reset();
222         scene->reset();
223
224         session->tile_manager.set_tile_order(session_params.tile_order);
225
226         /* peak memory usage should show current render peak, not peak for all renders
227          * made by this render session
228          */
229         session->stats.mem_peak = session->stats.mem_used;
230
231         /* There is no single depsgraph to use for the entire render.
232          * See note on create_session().
233          */
234         /* sync object should be re-created */
235         sync = new BlenderSync(b_engine, b_data, b_scene, scene, !background, session->progress);
236
237         BL::SpaceView3D b_null_space_view3d(PointerRNA_NULL);
238         BL::RegionView3D b_null_region_view3d(PointerRNA_NULL);
239         BufferParams buffer_params = BlenderSync::get_buffer_params(b_render,
240                                                                     b_null_space_view3d,
241                                                                     b_null_region_view3d,
242                                                                     scene->camera,
243                                                                     width, height);
244         session->reset(buffer_params, session_params.samples);
245
246         b_engine.use_highlight_tiles(session_params.progressive_refine == false);
247
248         /* reset time */
249         start_resize_time = 0.0;
250 }
251
252 void BlenderSession::free_session()
253 {
254         if(sync)
255                 delete sync;
256
257         delete session;
258 }
259
260 static ShaderEvalType get_shader_type(const string& pass_type)
261 {
262         const char *shader_type = pass_type.c_str();
263
264         /* data passes */
265         if(strcmp(shader_type, "NORMAL")==0)
266                 return SHADER_EVAL_NORMAL;
267         else if(strcmp(shader_type, "UV")==0)
268                 return SHADER_EVAL_UV;
269         else if(strcmp(shader_type, "ROUGHNESS")==0)
270                 return SHADER_EVAL_ROUGHNESS;
271         else if(strcmp(shader_type, "DIFFUSE_COLOR")==0)
272                 return SHADER_EVAL_DIFFUSE_COLOR;
273         else if(strcmp(shader_type, "GLOSSY_COLOR")==0)
274                 return SHADER_EVAL_GLOSSY_COLOR;
275         else if(strcmp(shader_type, "TRANSMISSION_COLOR")==0)
276                 return SHADER_EVAL_TRANSMISSION_COLOR;
277         else if(strcmp(shader_type, "SUBSURFACE_COLOR")==0)
278                 return SHADER_EVAL_SUBSURFACE_COLOR;
279         else if(strcmp(shader_type, "EMIT")==0)
280                 return SHADER_EVAL_EMISSION;
281
282         /* light passes */
283         else if(strcmp(shader_type, "AO")==0)
284                 return SHADER_EVAL_AO;
285         else if(strcmp(shader_type, "COMBINED")==0)
286                 return SHADER_EVAL_COMBINED;
287         else if(strcmp(shader_type, "SHADOW")==0)
288                 return SHADER_EVAL_SHADOW;
289         else if(strcmp(shader_type, "DIFFUSE")==0)
290                 return SHADER_EVAL_DIFFUSE;
291         else if(strcmp(shader_type, "GLOSSY")==0)
292                 return SHADER_EVAL_GLOSSY;
293         else if(strcmp(shader_type, "TRANSMISSION")==0)
294                 return SHADER_EVAL_TRANSMISSION;
295         else if(strcmp(shader_type, "SUBSURFACE")==0)
296                 return SHADER_EVAL_SUBSURFACE;
297
298         /* extra */
299         else if(strcmp(shader_type, "ENVIRONMENT")==0)
300                 return SHADER_EVAL_ENVIRONMENT;
301
302         else
303                 return SHADER_EVAL_BAKE;
304 }
305
306 static BL::RenderResult begin_render_result(BL::RenderEngine& b_engine,
307                                             int x, int y,
308                                             int w, int h,
309                                             const char *layername,
310                                             const char *viewname)
311 {
312         return b_engine.begin_result(x, y, w, h, layername, viewname);
313 }
314
315 static void end_render_result(BL::RenderEngine& b_engine,
316                               BL::RenderResult& b_rr,
317                               bool cancel,
318                               bool highlight,
319                               bool do_merge_results)
320 {
321         b_engine.end_result(b_rr, (int)cancel, (int) highlight, (int)do_merge_results);
322 }
323
324 void BlenderSession::do_write_update_render_tile(RenderTile& rtile, bool do_update_only, bool highlight)
325 {
326         int x = rtile.x - session->tile_manager.params.full_x;
327         int y = rtile.y - session->tile_manager.params.full_y;
328         int w = rtile.w;
329         int h = rtile.h;
330
331         /* get render result */
332         BL::RenderResult b_rr = begin_render_result(b_engine, x, y, w, h, b_rlay_name.c_str(), b_rview_name.c_str());
333
334         /* can happen if the intersected rectangle gives 0 width or height */
335         if(b_rr.ptr.data == NULL) {
336                 return;
337         }
338
339         BL::RenderResult::layers_iterator b_single_rlay;
340         b_rr.layers.begin(b_single_rlay);
341
342         /* layer will be missing if it was disabled in the UI */
343         if(b_single_rlay == b_rr.layers.end())
344                 return;
345
346         BL::RenderLayer b_rlay = *b_single_rlay;
347
348         if(do_update_only) {
349                 /* Sample would be zero at initial tile update, which is only needed
350                  * to tag tile form blender side as IN PROGRESS for proper highlight
351                  * no buffers should be sent to blender yet. For denoise we also
352                  * keep showing the noisy buffers until denoise is done. */
353                 bool merge = (rtile.sample != 0) && (rtile.task != RenderTile::DENOISE);
354
355                 if(merge) {
356                         update_render_result(b_rr, b_rlay, rtile);
357                 }
358
359                 end_render_result(b_engine, b_rr, true, highlight, merge);
360         }
361         else {
362                 /* Write final render result. */
363                 write_render_result(b_rr, b_rlay, rtile);
364                 end_render_result(b_engine, b_rr, false, false, true);
365         }
366 }
367
368 void BlenderSession::write_render_tile(RenderTile& rtile)
369 {
370         do_write_update_render_tile(rtile, false, false);
371 }
372
373 void BlenderSession::update_render_tile(RenderTile& rtile, bool highlight)
374 {
375         /* use final write for preview renders, otherwise render result wouldn't be
376          * be updated in blender side
377          * would need to be investigated a bit further, but for now shall be fine
378          */
379         if(!b_engine.is_preview())
380                 do_write_update_render_tile(rtile, true, highlight);
381         else
382                 do_write_update_render_tile(rtile, false, false);
383 }
384
385 static void add_cryptomatte_layer(BL::RenderResult& b_rr, string name, string manifest)
386 {
387         string identifier = string_printf("%08x", util_murmur_hash3(name.c_str(), name.length(), 0));
388         string prefix = "cryptomatte/" + identifier.substr(0, 7) + "/";
389
390         render_add_metadata(b_rr, prefix+"name", name);
391         render_add_metadata(b_rr, prefix+"hash", "MurmurHash3_32");
392         render_add_metadata(b_rr, prefix+"conversion", "uint32_to_float32");
393         render_add_metadata(b_rr, prefix+"manifest", manifest);
394 }
395
396 void BlenderSession::stamp_view_layer_metadata(Scene *scene, const string& view_layer_name)
397 {
398         BL::RenderResult b_rr = b_engine.get_result();
399         string prefix = "cycles." + view_layer_name + ".";
400
401         /* Configured number of samples for the view layer. */
402         b_rr.stamp_data_add_field(
403                 (prefix + "samples").c_str(),
404                 to_string(session->params.samples).c_str());
405
406         /* Store ranged samples information. */
407         if(session->tile_manager.range_num_samples != -1) {
408                 b_rr.stamp_data_add_field(
409                         (prefix + "range_start_sample").c_str(),
410                         to_string(session->tile_manager.range_start_sample).c_str());
411                 b_rr.stamp_data_add_field(
412                         (prefix + "range_num_samples").c_str(),
413                         to_string(session->tile_manager.range_num_samples).c_str());
414         }
415
416         /* Write cryptomatte metadata. */
417         if(scene->film->cryptomatte_passes & CRYPT_OBJECT) {
418                 add_cryptomatte_layer(b_rr, view_layer_name + ".CryptoObject",
419                                       scene->object_manager->get_cryptomatte_objects(scene));
420         }
421         if(scene->film->cryptomatte_passes & CRYPT_MATERIAL) {
422                 add_cryptomatte_layer(b_rr, view_layer_name + ".CryptoMaterial",
423                                       scene->shader_manager->get_cryptomatte_materials(scene));
424         }
425         if(scene->film->cryptomatte_passes & CRYPT_ASSET) {
426                 add_cryptomatte_layer(b_rr, view_layer_name + ".CryptoAsset",
427                                       scene->object_manager->get_cryptomatte_assets(scene));
428         }
429
430         /* Store synchronization and bare-render times. */
431         double total_time, render_time;
432         session->progress.get_time(total_time, render_time);
433         b_rr.stamp_data_add_field((prefix + "total_time").c_str(),
434                                   time_human_readable_from_seconds(total_time).c_str());
435         b_rr.stamp_data_add_field((prefix + "render_time").c_str(),
436                                   time_human_readable_from_seconds(render_time).c_str());
437         b_rr.stamp_data_add_field((prefix + "synchronization_time").c_str(),
438                                   time_human_readable_from_seconds(total_time - render_time).c_str());
439 }
440
441 void BlenderSession::render(BL::Depsgraph& b_depsgraph_)
442 {
443         b_depsgraph = b_depsgraph_;
444
445         /* set callback to write out render results */
446         session->write_render_tile_cb = function_bind(&BlenderSession::write_render_tile, this, _1);
447         session->update_render_tile_cb = function_bind(&BlenderSession::update_render_tile, this, _1, _2);
448
449         /* get buffer parameters */
450         SessionParams session_params = BlenderSync::get_session_params(b_engine, b_userpref, b_scene, background);
451         BufferParams buffer_params = BlenderSync::get_buffer_params(b_render, b_v3d, b_rv3d, scene->camera, width, height);
452
453         /* render each layer */
454         BL::ViewLayer b_view_layer = b_depsgraph.view_layer_eval();
455
456         /* temporary render result to find needed passes and views */
457         BL::RenderResult b_rr = begin_render_result(b_engine, 0, 0, 1, 1, b_view_layer.name().c_str(), NULL);
458         BL::RenderResult::layers_iterator b_single_rlay;
459         b_rr.layers.begin(b_single_rlay);
460         BL::RenderLayer b_rlay = *b_single_rlay;
461         b_rlay_name = b_view_layer.name();
462
463         /* add passes */
464         vector<Pass> passes = sync->sync_render_passes(b_rlay, b_view_layer);
465         buffer_params.passes = passes;
466
467         PointerRNA crl = RNA_pointer_get(&b_view_layer.ptr, "cycles");
468         bool full_denoising = get_boolean(crl, "use_denoising");
469         bool write_denoising_passes = get_boolean(crl, "denoising_store_passes");
470
471         bool run_denoising = full_denoising || write_denoising_passes;
472
473         session->tile_manager.schedule_denoising = run_denoising;
474         buffer_params.denoising_data_pass = run_denoising;
475         buffer_params.denoising_clean_pass = (scene->film->denoising_flags & DENOISING_CLEAN_ALL_PASSES);
476         buffer_params.denoising_prefiltered_pass = write_denoising_passes;
477
478         session->params.run_denoising = run_denoising;
479         session->params.full_denoising = full_denoising;
480         session->params.write_denoising_passes = write_denoising_passes;
481         session->params.denoising.radius = get_int(crl, "denoising_radius");
482         session->params.denoising.strength = get_float(crl, "denoising_strength");
483         session->params.denoising.feature_strength = get_float(crl, "denoising_feature_strength");
484         session->params.denoising.relative_pca = get_boolean(crl, "denoising_relative_pca");
485
486         scene->film->denoising_data_pass = buffer_params.denoising_data_pass;
487         scene->film->denoising_clean_pass = buffer_params.denoising_clean_pass;
488         scene->film->denoising_prefiltered_pass = buffer_params.denoising_prefiltered_pass;
489
490         scene->film->pass_alpha_threshold = b_view_layer.pass_alpha_threshold();
491         scene->film->tag_passes_update(scene, passes);
492         scene->film->tag_update(scene);
493         scene->integrator->tag_update(scene);
494
495         BL::RenderResult::views_iterator b_view_iter;
496
497         int num_views = 0;
498         for(b_rr.views.begin(b_view_iter); b_view_iter != b_rr.views.end(); ++b_view_iter) {
499                 num_views++;
500         }
501
502         int view_index = 0;
503         for(b_rr.views.begin(b_view_iter); b_view_iter != b_rr.views.end(); ++b_view_iter, ++view_index) {
504                 b_rview_name = b_view_iter->name();
505
506                 /* set the current view */
507                 b_engine.active_view_set(b_rview_name.c_str());
508
509                 /* update scene */
510                 BL::Object b_camera_override(b_engine.camera_override());
511                 sync->sync_camera(b_render, b_camera_override, width, height, b_rview_name.c_str());
512                 sync->sync_data(b_render,
513                                 b_depsgraph,
514                                 b_v3d,
515                                 b_camera_override,
516                                 width, height,
517                                 &python_thread_state);
518                 builtin_images_load();
519
520                 /* Attempt to free all data which is held by Blender side, since at this
521                  * point we knwo that we've got everything to render current view layer.
522                  */
523                 /* At the moment we only free if we are not doing multi-view (or if we are rendering the last view).
524                  * See T58142/D4239 for discussion.
525                  */
526                 if(view_index == num_views - 1) {
527                         free_blender_memory_if_possible();
528                 }
529
530                 /* Make sure all views have different noise patterns. - hardcoded value just to make it random */
531                 if(view_index != 0) {
532                         scene->integrator->seed += hash_int_2d(scene->integrator->seed, hash_int(view_index * 0xdeadbeef));
533                         scene->integrator->tag_update(scene);
534                 }
535
536                 /* Update number of samples per layer. */
537                 int samples = sync->get_layer_samples();
538                 bool bound_samples = sync->get_layer_bound_samples();
539                 int effective_layer_samples;
540
541                 if(samples != 0 && (!bound_samples || (samples < session_params.samples)))
542                         effective_layer_samples = samples;
543                 else
544                         effective_layer_samples = session_params.samples;
545
546                 /* Update tile manager if we're doing resumable render. */
547                 update_resumable_tile_manager(effective_layer_samples);
548
549                 /* Update session itself. */
550                 session->reset(buffer_params, effective_layer_samples);
551
552                 /* render */
553                 session->start();
554                 session->wait();
555
556                 if(!b_engine.is_preview() && background && print_render_stats) {
557                         RenderStats stats;
558                         session->collect_statistics(&stats);
559                         printf("Render statistics:\n%s\n", stats.full_report().c_str());
560                 }
561
562                 if(session->progress.get_cancel())
563                         break;
564         }
565
566         /* add metadata */
567         stamp_view_layer_metadata(scene, b_rlay_name);
568
569         /* free result without merging */
570         end_render_result(b_engine, b_rr, true, true, false);
571
572         double total_time, render_time;
573         session->progress.get_time(total_time, render_time);
574         VLOG(1) << "Total render time: " << total_time;
575         VLOG(1) << "Render time (without synchronization): " << render_time;
576
577         /* clear callback */
578         session->write_render_tile_cb = function_null;
579         session->update_render_tile_cb = function_null;
580
581         /* TODO: find a way to clear this data for persistent data render */
582 #if 0
583         /* free all memory used (host and device), so we wouldn't leave render
584          * engine with extra memory allocated
585          */
586
587         session->device_free();
588
589         delete sync;
590         sync = NULL;
591 #endif
592 }
593
594 static void populate_bake_data(BakeData *data, const
595                                int object_id,
596                                BL::BakePixel& pixel_array,
597                                const int num_pixels)
598 {
599         BL::BakePixel bp = pixel_array;
600
601         int i;
602         for(i = 0; i < num_pixels; i++) {
603                 if(bp.object_id() == object_id) {
604                         data->set(i, bp.primitive_id(), bp.uv(), bp.du_dx(), bp.du_dy(), bp.dv_dx(), bp.dv_dy());
605                 } else {
606                         data->set_null(i);
607                 }
608                 bp = bp.next();
609         }
610 }
611
612 static int bake_pass_filter_get(const int pass_filter)
613 {
614         int flag = BAKE_FILTER_NONE;
615
616         if((pass_filter & BL::BakeSettings::pass_filter_DIRECT) != 0)
617                 flag |= BAKE_FILTER_DIRECT;
618         if((pass_filter & BL::BakeSettings::pass_filter_INDIRECT) != 0)
619                 flag |= BAKE_FILTER_INDIRECT;
620         if((pass_filter & BL::BakeSettings::pass_filter_COLOR) != 0)
621                 flag |= BAKE_FILTER_COLOR;
622
623         if((pass_filter & BL::BakeSettings::pass_filter_DIFFUSE) != 0)
624                 flag |= BAKE_FILTER_DIFFUSE;
625         if((pass_filter & BL::BakeSettings::pass_filter_GLOSSY) != 0)
626                 flag |= BAKE_FILTER_GLOSSY;
627         if((pass_filter & BL::BakeSettings::pass_filter_TRANSMISSION) != 0)
628                 flag |= BAKE_FILTER_TRANSMISSION;
629         if((pass_filter & BL::BakeSettings::pass_filter_SUBSURFACE) != 0)
630                 flag |= BAKE_FILTER_SUBSURFACE;
631
632         if((pass_filter & BL::BakeSettings::pass_filter_EMIT) != 0)
633                 flag |= BAKE_FILTER_EMISSION;
634         if((pass_filter & BL::BakeSettings::pass_filter_AO) != 0)
635                 flag |= BAKE_FILTER_AO;
636
637         return flag;
638 }
639
640 void BlenderSession::bake(BL::Depsgraph& b_depsgraph_,
641                           BL::Object& b_object,
642                           const string& pass_type,
643                           const int pass_filter,
644                           const int object_id,
645                           BL::BakePixel& pixel_array,
646                           const size_t num_pixels,
647                           const int /*depth*/,
648                           float result[])
649 {
650         b_depsgraph = b_depsgraph_;
651
652         ShaderEvalType shader_type = get_shader_type(pass_type);
653
654         /* Set baking flag in advance, so kernel loading can check if we need
655          * any baking capabilities.
656          */
657         scene->bake_manager->set_baking(true);
658
659         /* ensure kernels are loaded before we do any scene updates */
660         session->load_kernels();
661
662         if(shader_type == SHADER_EVAL_UV) {
663                 /* force UV to be available */
664                 Pass::add(PASS_UV, scene->film->passes);
665         }
666
667         int bake_pass_filter = bake_pass_filter_get(pass_filter);
668         bake_pass_filter = BakeManager::shader_type_to_pass_filter(shader_type, bake_pass_filter);
669
670         /* force use_light_pass to be true if we bake more than just colors */
671         if(bake_pass_filter & ~BAKE_FILTER_COLOR) {
672                 Pass::add(PASS_LIGHT, scene->film->passes);
673         }
674
675         /* create device and update scene */
676         scene->film->tag_update(scene);
677         scene->integrator->tag_update(scene);
678
679         if(!session->progress.get_cancel()) {
680                 /* update scene */
681                 BL::Object b_camera_override(b_engine.camera_override());
682                 sync->sync_camera(b_render, b_camera_override, width, height, "");
683                 sync->sync_data(b_render,
684                                 b_depsgraph,
685                                 b_v3d,
686                                 b_camera_override,
687                                 width, height,
688                                 &python_thread_state);
689                 builtin_images_load();
690         }
691
692         BakeData *bake_data = NULL;
693
694         if(!session->progress.get_cancel()) {
695                 /* get buffer parameters */
696                 SessionParams session_params = BlenderSync::get_session_params(b_engine, b_userpref, b_scene, background);
697                 BufferParams buffer_params = BlenderSync::get_buffer_params(b_render, b_v3d, b_rv3d, scene->camera, width, height);
698
699                 scene->bake_manager->set_shader_limit((size_t)b_engine.tile_x(), (size_t)b_engine.tile_y());
700
701                 /* set number of samples */
702                 session->tile_manager.set_samples(session_params.samples);
703                 session->reset(buffer_params, session_params.samples);
704                 session->update_scene();
705
706                 /* find object index. todo: is arbitrary - copied from mesh_displace.cpp */
707                 size_t object_index = OBJECT_NONE;
708                 int tri_offset = 0;
709
710                 for(size_t i = 0; i < scene->objects.size(); i++) {
711                         if(strcmp(scene->objects[i]->name.c_str(), b_object.name().c_str()) == 0) {
712                                 object_index = i;
713                                 tri_offset = scene->objects[i]->mesh->tri_offset;
714                                 break;
715                         }
716                 }
717
718                 /* Object might have been disabled for rendering or excluded in some
719                  * other way, in that case Blender will report a warning afterwards. */
720                 if (object_index != OBJECT_NONE) {
721                         int object = object_index;
722
723                         bake_data = scene->bake_manager->init(object, tri_offset, num_pixels);
724                         populate_bake_data(bake_data, object_id, pixel_array, num_pixels);
725                 }
726
727                 /* set number of samples */
728                 session->tile_manager.set_samples(session_params.samples);
729                 session->reset(buffer_params, session_params.samples);
730                 session->update_scene();
731
732                 session->progress.set_update_callback(function_bind(&BlenderSession::update_bake_progress, this));
733         }
734
735         /* Perform bake. Check cancel to avoid crash with incomplete scene data. */
736         if(!session->progress.get_cancel() && bake_data) {
737                 scene->bake_manager->bake(scene->device, &scene->dscene, scene, session->progress, shader_type, bake_pass_filter, bake_data, result);
738         }
739
740         /* free all memory used (host and device), so we wouldn't leave render
741          * engine with extra memory allocated
742          */
743
744         session->device_free();
745
746         delete sync;
747         sync = NULL;
748 }
749
750 void BlenderSession::do_write_update_render_result(BL::RenderResult& b_rr,
751                                                    BL::RenderLayer& b_rlay,
752                                                    RenderTile& rtile,
753                                                    bool do_update_only)
754 {
755         RenderBuffers *buffers = rtile.buffers;
756
757         /* copy data from device */
758         if(!buffers->copy_from_device())
759                 return;
760
761         float exposure = scene->film->exposure;
762
763         vector<float> pixels(rtile.w*rtile.h*4);
764
765         /* Adjust absolute sample number to the range. */
766         int sample = rtile.sample;
767         const int range_start_sample = session->tile_manager.range_start_sample;
768         if(range_start_sample != -1) {
769                 sample -= range_start_sample;
770         }
771
772         if(!do_update_only) {
773                 /* copy each pass */
774                 BL::RenderLayer::passes_iterator b_iter;
775
776                 for(b_rlay.passes.begin(b_iter); b_iter != b_rlay.passes.end(); ++b_iter) {
777                         BL::RenderPass b_pass(*b_iter);
778
779                         /* find matching pass type */
780                         PassType pass_type = BlenderSync::get_pass_type(b_pass);
781                         int components = b_pass.channels();
782
783                         bool read = false;
784                         if(pass_type != PASS_NONE) {
785                                 /* copy pixels */
786                                 read = buffers->get_pass_rect(pass_type, exposure, sample, components, &pixels[0], b_pass.name());
787                         }
788                         else {
789                                 int denoising_offset = BlenderSync::get_denoising_pass(b_pass);
790                                 if(denoising_offset >= 0) {
791                                         read = buffers->get_denoising_pass_rect(denoising_offset, exposure, sample, components, &pixels[0]);
792                                 }
793                         }
794
795                         if(!read) {
796                                 memset(&pixels[0], 0, pixels.size()*sizeof(float));
797                         }
798
799                         b_pass.rect(&pixels[0]);
800                 }
801         }
802         else {
803                 /* copy combined pass */
804                 BL::RenderPass b_combined_pass(b_rlay.passes.find_by_name("Combined", b_rview_name.c_str()));
805                 if(buffers->get_pass_rect(PASS_COMBINED, exposure, sample, 4, &pixels[0], "Combined"))
806                         b_combined_pass.rect(&pixels[0]);
807         }
808
809         /* tag result as updated */
810         b_engine.update_result(b_rr);
811 }
812
813 void BlenderSession::write_render_result(BL::RenderResult& b_rr,
814                                          BL::RenderLayer& b_rlay,
815                                          RenderTile& rtile)
816 {
817         do_write_update_render_result(b_rr, b_rlay, rtile, false);
818 }
819
820 void BlenderSession::update_render_result(BL::RenderResult& b_rr,
821                                           BL::RenderLayer& b_rlay,
822                                           RenderTile& rtile)
823 {
824         do_write_update_render_result(b_rr, b_rlay, rtile, true);
825 }
826
827 void BlenderSession::synchronize(BL::Depsgraph& b_depsgraph_)
828 {
829         /* only used for viewport render */
830         if(!b_v3d)
831                 return;
832
833         /* on session/scene parameter changes, we recreate session entirely */
834         SessionParams session_params = BlenderSync::get_session_params(b_engine, b_userpref, b_scene, background);
835         SceneParams scene_params = BlenderSync::get_scene_params(b_scene, background);
836         bool session_pause = BlenderSync::get_session_pause(b_scene, background);
837
838         if(session->params.modified(session_params) ||
839            scene->params.modified(scene_params))
840         {
841                 free_session();
842                 create_session();
843                 return;
844         }
845
846         /* increase samples, but never decrease */
847         session->set_samples(session_params.samples);
848         session->set_pause(session_pause);
849
850         /* copy recalc flags, outside of mutex so we can decide to do the real
851          * synchronization at a later time to not block on running updates */
852         sync->sync_recalc(b_depsgraph_);
853
854         /* don't do synchronization if on pause */
855         if(session_pause) {
856                 tag_update();
857                 return;
858         }
859
860         /* try to acquire mutex. if we don't want to or can't, come back later */
861         if(!session->ready_to_reset() || !session->scene->mutex.try_lock()) {
862                 tag_update();
863                 return;
864         }
865
866         /* data and camera synchronize */
867         b_depsgraph = b_depsgraph_;
868
869         BL::Object b_camera_override(b_engine.camera_override());
870         sync->sync_data(b_render,
871                         b_depsgraph,
872                         b_v3d,
873                         b_camera_override,
874                         width, height,
875                         &python_thread_state);
876
877         if(b_rv3d)
878                 sync->sync_view(b_v3d, b_rv3d, width, height);
879         else
880                 sync->sync_camera(b_render, b_camera_override, width, height, "");
881
882         builtin_images_load();
883
884         /* unlock */
885         session->scene->mutex.unlock();
886
887         /* reset if needed */
888         if(scene->need_reset()) {
889                 BufferParams buffer_params = BlenderSync::get_buffer_params(b_render, b_v3d, b_rv3d, scene->camera, width, height);
890                 session->reset(buffer_params, session_params.samples);
891
892                 /* reset time */
893                 start_resize_time = 0.0;
894         }
895
896         /* Start rendering thread, if it's not running already. Do this
897          * after all scene data has been synced at least once. */
898         session->start();
899 }
900
901 bool BlenderSession::draw(int w, int h)
902 {
903         /* pause in redraw in case update is not being called due to final render */
904         session->set_pause(BlenderSync::get_session_pause(b_scene, background));
905
906         /* before drawing, we verify camera and viewport size changes, because
907          * we do not get update callbacks for those, we must detect them here */
908         if(session->ready_to_reset()) {
909                 bool reset = false;
910
911                 /* if dimensions changed, reset */
912                 if(width != w || height != h) {
913                         if(start_resize_time == 0.0) {
914                                 /* don't react immediately to resizes to avoid flickery resizing
915                                  * of the viewport, and some window managers changing the window
916                                  * size temporarily on unminimize */
917                                 start_resize_time = time_dt();
918                                 tag_redraw();
919                         }
920                         else if(time_dt() - start_resize_time < 0.2) {
921                                 tag_redraw();
922                         }
923                         else {
924                                 width = w;
925                                 height = h;
926                                 reset = true;
927                         }
928                 }
929
930                 /* try to acquire mutex. if we can't, come back later */
931                 if(!session->scene->mutex.try_lock()) {
932                         tag_update();
933                 }
934                 else {
935                         /* update camera from 3d view */
936
937                         sync->sync_view(b_v3d, b_rv3d, width, height);
938
939                         if(scene->camera->need_update)
940                                 reset = true;
941
942                         session->scene->mutex.unlock();
943                 }
944
945                 /* reset if requested */
946                 if(reset) {
947                         SessionParams session_params = BlenderSync::get_session_params(b_engine, b_userpref, b_scene, background);
948                         BufferParams buffer_params = BlenderSync::get_buffer_params(b_render, b_v3d, b_rv3d, scene->camera, width, height);
949                         bool session_pause = BlenderSync::get_session_pause(b_scene, background);
950
951                         if(session_pause == false) {
952                                 session->reset(buffer_params, session_params.samples);
953                                 start_resize_time = 0.0;
954                         }
955                 }
956         }
957         else {
958                 tag_update();
959         }
960
961         /* update status and progress for 3d view draw */
962         update_status_progress();
963
964         /* draw */
965         BufferParams buffer_params = BlenderSync::get_buffer_params(b_render, b_v3d, b_rv3d, scene->camera, width, height);
966         DeviceDrawParams draw_params;
967
968         if(session->params.display_buffer_linear) {
969                 draw_params.bind_display_space_shader_cb = function_bind(&BL::RenderEngine::bind_display_space_shader, &b_engine, b_scene);
970                 draw_params.unbind_display_space_shader_cb = function_bind(&BL::RenderEngine::unbind_display_space_shader, &b_engine);
971         }
972
973         return !session->draw(buffer_params, draw_params);
974 }
975
976 void BlenderSession::get_status(string& status, string& substatus)
977 {
978         session->progress.get_status(status, substatus);
979 }
980
981 void BlenderSession::get_kernel_status(string& kernel_status)
982 {
983         session->progress.get_kernel_status(kernel_status);
984 }
985
986 void BlenderSession::get_progress(float& progress, double& total_time, double& render_time)
987 {
988         session->progress.get_time(total_time, render_time);
989         progress = session->progress.get_progress();
990 }
991
992 void BlenderSession::update_bake_progress()
993 {
994         float progress = session->progress.get_progress();
995
996         if(progress != last_progress) {
997                 b_engine.update_progress(progress);
998                 last_progress = progress;
999         }
1000 }
1001
1002 void BlenderSession::update_status_progress()
1003 {
1004         string timestatus, status, substatus, kernel_status;
1005         string scene_status = "";
1006         float progress;
1007         double total_time, remaining_time = 0, render_time;
1008         float mem_used = (float)session->stats.mem_used / 1024.0f / 1024.0f;
1009         float mem_peak = (float)session->stats.mem_peak / 1024.0f / 1024.0f;
1010
1011         get_status(status, substatus);
1012         get_kernel_status(kernel_status);
1013         get_progress(progress, total_time, render_time);
1014
1015         if(progress > 0)
1016                 remaining_time = (1.0 - (double)progress) * (render_time / (double)progress);
1017
1018         if(background) {
1019                 scene_status += " | " + scene->name;
1020                 if(b_rlay_name != "")
1021                         scene_status += ", "  + b_rlay_name;
1022
1023                 if(b_rview_name != "")
1024                         scene_status += ", " + b_rview_name;
1025
1026                 if(remaining_time > 0) {
1027                         timestatus += "Remaining:" + time_human_readable_from_seconds(remaining_time) + " | ";
1028                 }
1029
1030                 timestatus += string_printf("Mem:%.2fM, Peak:%.2fM", (double)mem_used, (double)mem_peak);
1031
1032                 if(status.size() > 0)
1033                         status = " | " + status;
1034                 if(substatus.size() > 0)
1035                         status += " | " + substatus;
1036                 if(kernel_status.size() > 0)
1037                         status += " | " + kernel_status;
1038         }
1039
1040         double current_time = time_dt();
1041         /* When rendering in a window, redraw the status at least once per second to keep the elapsed and remaining time up-to-date.
1042          * For headless rendering, only report when something significant changes to keep the console output readable. */
1043         if(status != last_status || (!headless && (current_time - last_status_time) > 1.0)) {
1044                 b_engine.update_stats("", (timestatus + scene_status + status).c_str());
1045                 b_engine.update_memory_stats(mem_used, mem_peak);
1046                 last_status = status;
1047                 last_status_time = current_time;
1048         }
1049         if(progress != last_progress) {
1050                 b_engine.update_progress(progress);
1051                 last_progress = progress;
1052         }
1053
1054         if(session->progress.get_error()) {
1055                 string error = session->progress.get_error_message();
1056                 if(error != last_error) {
1057                         /* TODO(sergey): Currently C++ RNA API doesn't let us to
1058                          * use mnemonic name for the variable. Would be nice to
1059                          * have this figured out.
1060                          *
1061                          * For until then, 1 << 5 means RPT_ERROR.
1062                          */
1063                         b_engine.report(1 << 5, error.c_str());
1064                         b_engine.error_set(error.c_str());
1065                         last_error = error;
1066                 }
1067         }
1068 }
1069
1070 void BlenderSession::tag_update()
1071 {
1072         /* tell blender that we want to get another update callback */
1073         b_engine.tag_update();
1074 }
1075
1076 void BlenderSession::tag_redraw()
1077 {
1078         if(background) {
1079                 /* update stats and progress, only for background here because
1080                  * in 3d view we do it in draw for thread safety reasons */
1081                 update_status_progress();
1082
1083                 /* offline render, redraw if timeout passed */
1084                 if(time_dt() - last_redraw_time > 1.0) {
1085                         b_engine.tag_redraw();
1086                         last_redraw_time = time_dt();
1087                 }
1088         }
1089         else {
1090                 /* tell blender that we want to redraw */
1091                 b_engine.tag_redraw();
1092         }
1093 }
1094
1095 void BlenderSession::test_cancel()
1096 {
1097         /* test if we need to cancel rendering */
1098         if(background)
1099                 if(b_engine.test_break())
1100                         session->progress.set_cancel("Cancelled");
1101 }
1102
1103 /* builtin image file name is actually an image datablock name with
1104  * absolute sequence frame number concatenated via '@' character
1105  *
1106  * this function splits frame from builtin name
1107  */
1108 int BlenderSession::builtin_image_frame(const string &builtin_name)
1109 {
1110         int last = builtin_name.find_last_of('@');
1111         return atoi(builtin_name.substr(last + 1, builtin_name.size() - last - 1).c_str());
1112 }
1113
1114 void BlenderSession::builtin_image_info(const string &builtin_name,
1115                                         void *builtin_data,
1116                                         ImageMetaData& metadata)
1117 {
1118         /* empty image */
1119         metadata.width = 1;
1120         metadata.height = 1;
1121
1122         if(!builtin_data)
1123                 return;
1124
1125         /* recover ID pointer */
1126         PointerRNA ptr;
1127         RNA_id_pointer_create((ID*)builtin_data, &ptr);
1128         BL::ID b_id(ptr);
1129
1130         if(b_id.is_a(&RNA_Image)) {
1131                 /* image data */
1132                 BL::Image b_image(b_id);
1133
1134                 metadata.builtin_free_cache = !b_image.has_data();
1135                 metadata.is_float = b_image.is_float();
1136                 metadata.width = b_image.size()[0];
1137                 metadata.height = b_image.size()[1];
1138                 metadata.depth = 1;
1139                 metadata.channels = b_image.channels();
1140         }
1141         else if(b_id.is_a(&RNA_Object)) {
1142                 /* smoke volume data */
1143                 BL::Object b_ob(b_id);
1144                 BL::SmokeDomainSettings b_domain = object_smoke_domain_find(b_ob);
1145
1146                 metadata.is_float = true;
1147                 metadata.depth = 1;
1148                 metadata.channels = 1;
1149
1150                 if(!b_domain)
1151                         return;
1152
1153                 if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_DENSITY) ||
1154                    builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_FLAME) ||
1155                    builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_HEAT) ||
1156                    builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_TEMPERATURE))
1157                         metadata.channels = 1;
1158                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_COLOR))
1159                         metadata.channels = 4;
1160                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_VELOCITY))
1161                         metadata.channels = 3;
1162                 else
1163                         return;
1164
1165                 int3 resolution = get_int3(b_domain.domain_resolution());
1166                 int amplify = (b_domain.use_high_resolution())? b_domain.amplify() + 1: 1;
1167
1168                 /* Velocity and heat data is always low-resolution. */
1169                 if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_VELOCITY) ||
1170                    builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_HEAT))
1171                 {
1172                         amplify = 1;
1173                 }
1174
1175                 metadata.width = resolution.x * amplify;
1176                 metadata.height = resolution.y * amplify;
1177                 metadata.depth = resolution.z * amplify;
1178         }
1179         else {
1180                 /* TODO(sergey): Check we're indeed in shader node tree. */
1181                 PointerRNA ptr;
1182                 RNA_pointer_create(NULL, &RNA_Node, builtin_data, &ptr);
1183                 BL::Node b_node(ptr);
1184                 if(b_node.is_a(&RNA_ShaderNodeTexPointDensity)) {
1185                         BL::ShaderNodeTexPointDensity b_point_density_node(b_node);
1186                         metadata.channels = 4;
1187                         metadata.width = b_point_density_node.resolution();
1188                         metadata.height = metadata.width;
1189                         metadata.depth = metadata.width;
1190                         metadata.is_float = true;
1191                 }
1192         }
1193 }
1194
1195 bool BlenderSession::builtin_image_pixels(const string &builtin_name,
1196                                           void *builtin_data,
1197                                           unsigned char *pixels,
1198                                           const size_t pixels_size,
1199                                           const bool free_cache)
1200 {
1201         if(!builtin_data) {
1202                 return false;
1203         }
1204
1205         const int frame = builtin_image_frame(builtin_name);
1206
1207         PointerRNA ptr;
1208         RNA_id_pointer_create((ID*)builtin_data, &ptr);
1209         BL::Image b_image(ptr);
1210
1211         const int width = b_image.size()[0];
1212         const int height = b_image.size()[1];
1213         const int channels = b_image.channels();
1214
1215         unsigned char *image_pixels = image_get_pixels_for_frame(b_image, frame);
1216         const size_t num_pixels = ((size_t)width) * height;
1217
1218         if(image_pixels && num_pixels * channels == pixels_size) {
1219                 memcpy(pixels, image_pixels, pixels_size * sizeof(unsigned char));
1220         }
1221         else {
1222                 if(channels == 1) {
1223                         memset(pixels, 0, pixels_size * sizeof(unsigned char));
1224                 }
1225                 else {
1226                         const size_t num_pixels_safe = pixels_size / channels;
1227                         unsigned char *cp = pixels;
1228                         for(size_t i = 0; i < num_pixels_safe; i++, cp += channels) {
1229                                 cp[0] = 255;
1230                                 cp[1] = 0;
1231                                 cp[2] = 255;
1232                                 if(channels == 4) {
1233                                         cp[3] = 255;
1234                                 }
1235                         }
1236                 }
1237         }
1238
1239         if(image_pixels) {
1240                 MEM_freeN(image_pixels);
1241         }
1242
1243         /* Free image buffers to save memory during render. */
1244         if(free_cache) {
1245                 b_image.buffers_free();
1246         }
1247
1248         /* Premultiply, byte images are always straight for Blender. */
1249         unsigned char *cp = pixels;
1250         for(size_t i = 0; i < num_pixels; i++, cp += channels) {
1251                 cp[0] = (cp[0] * cp[3]) >> 8;
1252                 cp[1] = (cp[1] * cp[3]) >> 8;
1253                 cp[2] = (cp[2] * cp[3]) >> 8;
1254         }
1255         return true;
1256 }
1257
1258 bool BlenderSession::builtin_image_float_pixels(const string &builtin_name,
1259                                                 void *builtin_data,
1260                                                 float *pixels,
1261                                                 const size_t pixels_size,
1262                                                 const bool free_cache)
1263 {
1264         if(!builtin_data) {
1265                 return false;
1266         }
1267
1268         PointerRNA ptr;
1269         RNA_id_pointer_create((ID*)builtin_data, &ptr);
1270         BL::ID b_id(ptr);
1271
1272         if(b_id.is_a(&RNA_Image)) {
1273                 /* image data */
1274                 BL::Image b_image(b_id);
1275                 int frame = builtin_image_frame(builtin_name);
1276
1277                 const int width = b_image.size()[0];
1278                 const int height = b_image.size()[1];
1279                 const int channels = b_image.channels();
1280
1281                 float *image_pixels;
1282                 image_pixels = image_get_float_pixels_for_frame(b_image, frame);
1283                 const size_t num_pixels = ((size_t)width) * height;
1284
1285                 if(image_pixels && num_pixels * channels == pixels_size) {
1286                         memcpy(pixels, image_pixels, pixels_size * sizeof(float));
1287                 }
1288                 else {
1289                         if(channels == 1) {
1290                                 memset(pixels, 0, num_pixels * sizeof(float));
1291                         }
1292                         else {
1293                                 const size_t num_pixels_safe = pixels_size / channels;
1294                                 float *fp = pixels;
1295                                 for(int i = 0; i < num_pixels_safe; i++, fp += channels) {
1296                                         fp[0] = 1.0f;
1297                                         fp[1] = 0.0f;
1298                                         fp[2] = 1.0f;
1299                                         if(channels == 4) {
1300                                                 fp[3] = 1.0f;
1301                                         }
1302                                 }
1303                         }
1304                 }
1305
1306                 if(image_pixels) {
1307                         MEM_freeN(image_pixels);
1308                 }
1309
1310                 /* Free image buffers to save memory during render. */
1311                 if(free_cache) {
1312                         b_image.buffers_free();
1313                 }
1314
1315                 return true;
1316         }
1317         else if(b_id.is_a(&RNA_Object)) {
1318                 /* smoke volume data */
1319                 BL::Object b_ob(b_id);
1320                 BL::SmokeDomainSettings b_domain = object_smoke_domain_find(b_ob);
1321
1322                 if(!b_domain) {
1323                         return false;
1324                 }
1325
1326                 int3 resolution = get_int3(b_domain.domain_resolution());
1327                 int length, amplify = (b_domain.use_high_resolution())? b_domain.amplify() + 1: 1;
1328
1329                 /* Velocity and heat data is always low-resolution. */
1330                 if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_VELOCITY) ||
1331                    builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_HEAT))
1332                 {
1333                         amplify = 1;
1334                 }
1335
1336                 const int width = resolution.x * amplify;
1337                 const int height = resolution.y * amplify;
1338                 const int depth = resolution.z * amplify;
1339                 const size_t num_pixels = ((size_t)width) * height * depth;
1340
1341                 if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_DENSITY)) {
1342                         SmokeDomainSettings_density_grid_get_length(&b_domain.ptr, &length);
1343                         if(length == num_pixels) {
1344                                 SmokeDomainSettings_density_grid_get(&b_domain.ptr, pixels);
1345                                 return true;
1346                         }
1347                 }
1348                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_FLAME)) {
1349                         /* this is in range 0..1, and interpreted by the OpenGL smoke viewer
1350                          * as 1500..3000 K with the first part faded to zero density */
1351                         SmokeDomainSettings_flame_grid_get_length(&b_domain.ptr, &length);
1352                         if(length == num_pixels) {
1353                                 SmokeDomainSettings_flame_grid_get(&b_domain.ptr, pixels);
1354                                 return true;
1355                         }
1356                 }
1357                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_COLOR)) {
1358                         /* the RGB is "premultiplied" by density for better interpolation results */
1359                         SmokeDomainSettings_color_grid_get_length(&b_domain.ptr, &length);
1360                         if(length == num_pixels*4) {
1361                                 SmokeDomainSettings_color_grid_get(&b_domain.ptr, pixels);
1362                                 return true;
1363                         }
1364                 }
1365                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_VELOCITY)) {
1366                         SmokeDomainSettings_velocity_grid_get_length(&b_domain.ptr, &length);
1367                         if(length == num_pixels*3) {
1368                                 SmokeDomainSettings_velocity_grid_get(&b_domain.ptr, pixels);
1369                                 return true;
1370                         }
1371                 }
1372                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_HEAT)) {
1373                         SmokeDomainSettings_heat_grid_get_length(&b_domain.ptr, &length);
1374                         if(length == num_pixels) {
1375                                 SmokeDomainSettings_heat_grid_get(&b_domain.ptr, pixels);
1376                                 return true;
1377                         }
1378                 }
1379                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_TEMPERATURE)) {
1380                         SmokeDomainSettings_temperature_grid_get_length(&b_domain.ptr, &length);
1381                         if(length == num_pixels) {
1382                                 SmokeDomainSettings_temperature_grid_get(&b_domain.ptr, pixels);
1383                                 return true;
1384                         }
1385                 }
1386                 else {
1387                         fprintf(stderr,
1388                                 "Cycles error: unknown volume attribute %s, skipping\n",
1389                                 builtin_name.c_str());
1390                         pixels[0] = 0.0f;
1391                         return false;
1392                 }
1393
1394                 fprintf(stderr, "Cycles error: unexpected smoke volume resolution, skipping\n");
1395         }
1396         else {
1397                 /* We originally were passing view_layer here but in reality we need a
1398                  * a depsgraph to pass to the RE_point_density_minmax() function.
1399                  */
1400                 /* TODO(sergey): Check we're indeed in shader node tree. */
1401                 PointerRNA ptr;
1402                 RNA_pointer_create(NULL, &RNA_Node, builtin_data, &ptr);
1403                 BL::Node b_node(ptr);
1404                 if(b_node.is_a(&RNA_ShaderNodeTexPointDensity)) {
1405                         BL::ShaderNodeTexPointDensity b_point_density_node(b_node);
1406                         int length;
1407                         b_point_density_node.calc_point_density(b_depsgraph, &length, &pixels);
1408                 }
1409         }
1410
1411         return false;
1412 }
1413
1414 void BlenderSession::builtin_images_load()
1415 {
1416         /* Force builtin images to be loaded along with Blender data sync. This
1417          * is needed because we may be reading from depsgraph evaluated data which
1418          * can be freed by Blender before Cycles reads it. */
1419         ImageManager *manager = session->scene->image_manager;
1420         Device *device = session->device;
1421         manager->device_load_builtin(device, session->scene, session->progress);
1422 }
1423
1424 void BlenderSession::update_resumable_tile_manager(int num_samples)
1425 {
1426         const int num_resumable_chunks = BlenderSession::num_resumable_chunks,
1427                   current_resumable_chunk = BlenderSession::current_resumable_chunk;
1428         if(num_resumable_chunks == 0) {
1429                 return;
1430         }
1431
1432         if (num_resumable_chunks > num_samples) {
1433                 fprintf(stderr, "Cycles warning: more sample chunks (%d) than samples (%d), "
1434                         "this will cause some samples to be included in multiple chunks.\n",
1435                         num_resumable_chunks, num_samples);
1436         }
1437
1438         const float num_samples_per_chunk = (float)num_samples / num_resumable_chunks;
1439
1440         float range_start_sample, range_num_samples;
1441         if(current_resumable_chunk != 0) {
1442                 /* Single chunk rendering. */
1443                 range_start_sample = num_samples_per_chunk * (current_resumable_chunk - 1);
1444                 range_num_samples = num_samples_per_chunk;
1445         }
1446         else {
1447                 /* Ranged-chunks. */
1448                 const int num_chunks = end_resumable_chunk - start_resumable_chunk + 1;
1449                 range_start_sample = num_samples_per_chunk * (start_resumable_chunk - 1);
1450                 range_num_samples = num_chunks * num_samples_per_chunk;
1451         }
1452
1453         /* Round after doing the multiplications with num_chunks and num_samples_per_chunk
1454          * to allow for many small chunks. */
1455         int rounded_range_start_sample = (int)floor(range_start_sample + 0.5f);
1456         int rounded_range_num_samples = max((int)floor(range_num_samples + 0.5f), 1);
1457
1458         /* Make sure we don't overshoot. */
1459         if(rounded_range_start_sample + rounded_range_num_samples > num_samples) {
1460                 rounded_range_num_samples = num_samples - rounded_range_num_samples;
1461         }
1462
1463         VLOG(1) << "Samples range start is " << range_start_sample << ", "
1464                 << "number of samples to render is " << range_num_samples;
1465
1466         scene->integrator->start_sample = rounded_range_start_sample;
1467         scene->integrator->tag_update(scene);
1468
1469         session->tile_manager.range_start_sample = rounded_range_start_sample;
1470         session->tile_manager.range_num_samples = rounded_range_num_samples;
1471 }
1472
1473 void BlenderSession::free_blender_memory_if_possible()
1474 {
1475         if(!background) {
1476                 /* During interactive render we can not free anything: attempts to save
1477                  * memory would cause things to be allocated and evaluated for every
1478                  * updated sample.
1479                  */
1480                 return;
1481         }
1482         b_engine.free_blender_memory();
1483 }
1484
1485 CCL_NAMESPACE_END