Fix T62614: Copy eevee settings when scene is copied
[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 /* TODO(sergey): Ideally this will be an utility function in util string.h, but
397  * currently is relying on Blender side function, so can not do that. */
398 static string make_human_readable_time(double time)
399 {
400         char time_str[128];
401         BLI_timecode_string_from_time_simple(time_str, sizeof(time_str), time);
402         return time_str;
403 }
404
405 void BlenderSession::stamp_view_layer_metadata(Scene *scene, const string& view_layer_name)
406 {
407         BL::RenderResult b_rr = b_engine.get_result();
408         string prefix = "cycles." + view_layer_name + ".";
409
410         /* Configured number of samples for the view layer. */
411         b_rr.stamp_data_add_field(
412                 (prefix + "samples").c_str(),
413                 to_string(session->params.samples).c_str());
414
415         /* Store ranged samples information. */
416         if(session->tile_manager.range_num_samples != -1) {
417                 b_rr.stamp_data_add_field(
418                         (prefix + "range_start_sample").c_str(),
419                         to_string(session->tile_manager.range_start_sample).c_str());
420                 b_rr.stamp_data_add_field(
421                         (prefix + "range_num_samples").c_str(),
422                         to_string(session->tile_manager.range_num_samples).c_str());
423         }
424
425         /* Write cryptomatte metadata. */
426         if(scene->film->cryptomatte_passes & CRYPT_OBJECT) {
427                 add_cryptomatte_layer(b_rr, view_layer_name + ".CryptoObject",
428                                       scene->object_manager->get_cryptomatte_objects(scene));
429         }
430         if(scene->film->cryptomatte_passes & CRYPT_MATERIAL) {
431                 add_cryptomatte_layer(b_rr, view_layer_name + ".CryptoMaterial",
432                                       scene->shader_manager->get_cryptomatte_materials(scene));
433         }
434         if(scene->film->cryptomatte_passes & CRYPT_ASSET) {
435                 add_cryptomatte_layer(b_rr, view_layer_name + ".CryptoAsset",
436                                       scene->object_manager->get_cryptomatte_assets(scene));
437         }
438
439         /* Store synchronization and bare-render times. */
440         double total_time, render_time;
441         session->progress.get_time(total_time, render_time);
442         b_rr.stamp_data_add_field((prefix + "total_time").c_str(),
443                                   make_human_readable_time(total_time).c_str());
444         b_rr.stamp_data_add_field((prefix + "render_time").c_str(),
445                                   make_human_readable_time(render_time).c_str());
446         b_rr.stamp_data_add_field((prefix + "synchronization_time").c_str(),
447                                   make_human_readable_time(total_time - render_time).c_str());
448 }
449
450 void BlenderSession::render(BL::Depsgraph& b_depsgraph_)
451 {
452         b_depsgraph = b_depsgraph_;
453
454         /* set callback to write out render results */
455         session->write_render_tile_cb = function_bind(&BlenderSession::write_render_tile, this, _1);
456         session->update_render_tile_cb = function_bind(&BlenderSession::update_render_tile, this, _1, _2);
457
458         /* get buffer parameters */
459         SessionParams session_params = BlenderSync::get_session_params(b_engine, b_userpref, b_scene, background);
460         BufferParams buffer_params = BlenderSync::get_buffer_params(b_render, b_v3d, b_rv3d, scene->camera, width, height);
461
462         /* render each layer */
463         BL::ViewLayer b_view_layer = b_depsgraph.view_layer_eval();
464
465         /* temporary render result to find needed passes and views */
466         BL::RenderResult b_rr = begin_render_result(b_engine, 0, 0, 1, 1, b_view_layer.name().c_str(), NULL);
467         BL::RenderResult::layers_iterator b_single_rlay;
468         b_rr.layers.begin(b_single_rlay);
469         BL::RenderLayer b_rlay = *b_single_rlay;
470         b_rlay_name = b_view_layer.name();
471
472         /* add passes */
473         vector<Pass> passes = sync->sync_render_passes(b_rlay, b_view_layer, session_params);
474         buffer_params.passes = passes;
475
476         PointerRNA crl = RNA_pointer_get(&b_view_layer.ptr, "cycles");
477         bool full_denoising = get_boolean(crl, "use_denoising");
478         bool write_denoising_passes = get_boolean(crl, "denoising_store_passes");
479
480         bool run_denoising = full_denoising || write_denoising_passes;
481
482         session->tile_manager.schedule_denoising = run_denoising;
483         buffer_params.denoising_data_pass = run_denoising;
484         buffer_params.denoising_clean_pass = (scene->film->denoising_flags & DENOISING_CLEAN_ALL_PASSES);
485         buffer_params.denoising_prefiltered_pass = write_denoising_passes;
486
487         session->params.run_denoising = run_denoising;
488         session->params.full_denoising = full_denoising;
489         session->params.write_denoising_passes = write_denoising_passes;
490         session->params.denoising.radius = get_int(crl, "denoising_radius");
491         session->params.denoising.strength = get_float(crl, "denoising_strength");
492         session->params.denoising.feature_strength = get_float(crl, "denoising_feature_strength");
493         session->params.denoising.relative_pca = get_boolean(crl, "denoising_relative_pca");
494
495         scene->film->denoising_data_pass = buffer_params.denoising_data_pass;
496         scene->film->denoising_clean_pass = buffer_params.denoising_clean_pass;
497         scene->film->denoising_prefiltered_pass = buffer_params.denoising_prefiltered_pass;
498
499         scene->film->pass_alpha_threshold = b_view_layer.pass_alpha_threshold();
500         scene->film->tag_passes_update(scene, passes);
501         scene->film->tag_update(scene);
502         scene->integrator->tag_update(scene);
503
504         BL::RenderResult::views_iterator b_view_iter;
505
506         int num_views = 0;
507         for(b_rr.views.begin(b_view_iter); b_view_iter != b_rr.views.end(); ++b_view_iter) {
508                 num_views++;
509         }
510
511         int view_index = 0;
512         for(b_rr.views.begin(b_view_iter); b_view_iter != b_rr.views.end(); ++b_view_iter, ++view_index) {
513                 b_rview_name = b_view_iter->name();
514
515                 /* set the current view */
516                 b_engine.active_view_set(b_rview_name.c_str());
517
518                 /* update scene */
519                 BL::Object b_camera_override(b_engine.camera_override());
520                 sync->sync_camera(b_render, b_camera_override, width, height, b_rview_name.c_str());
521                 sync->sync_data(b_render,
522                                 b_depsgraph,
523                                 b_v3d,
524                                 b_camera_override,
525                                 width, height,
526                                 &python_thread_state);
527                 builtin_images_load();
528
529                 /* Attempt to free all data which is held by Blender side, since at this
530                  * point we knwo that we've got everything to render current view layer.
531                  */
532                 /* At the moment we only free if we are not doing multi-view (or if we are rendering the last view).
533                  * See T58142/D4239 for discussion.
534                  */
535                 if(view_index == num_views - 1) {
536                         free_blender_memory_if_possible();
537                 }
538
539                 /* Make sure all views have different noise patterns. - hardcoded value just to make it random */
540                 if(view_index != 0) {
541                         scene->integrator->seed += hash_int_2d(scene->integrator->seed, hash_int(view_index * 0xdeadbeef));
542                         scene->integrator->tag_update(scene);
543                 }
544
545                 /* Update number of samples per layer. */
546                 int samples = sync->get_layer_samples();
547                 bool bound_samples = sync->get_layer_bound_samples();
548                 int effective_layer_samples;
549
550                 if(samples != 0 && (!bound_samples || (samples < session_params.samples)))
551                         effective_layer_samples = samples;
552                 else
553                         effective_layer_samples = session_params.samples;
554
555                 /* Update tile manager if we're doing resumable render. */
556                 update_resumable_tile_manager(effective_layer_samples);
557
558                 /* Update session itself. */
559                 session->reset(buffer_params, effective_layer_samples);
560
561                 /* render */
562                 session->start();
563                 session->wait();
564
565                 if(!b_engine.is_preview() && background && print_render_stats) {
566                         RenderStats stats;
567                         session->collect_statistics(&stats);
568                         printf("Render statistics:\n%s\n", stats.full_report().c_str());
569                 }
570
571                 if(session->progress.get_cancel())
572                         break;
573         }
574
575         /* add metadata */
576         stamp_view_layer_metadata(scene, b_rlay_name);
577
578         /* free result without merging */
579         end_render_result(b_engine, b_rr, true, true, false);
580
581         double total_time, render_time;
582         session->progress.get_time(total_time, render_time);
583         VLOG(1) << "Total render time: " << total_time;
584         VLOG(1) << "Render time (without synchronization): " << render_time;
585
586         /* clear callback */
587         session->write_render_tile_cb = function_null;
588         session->update_render_tile_cb = function_null;
589
590         /* TODO: find a way to clear this data for persistent data render */
591 #if 0
592         /* free all memory used (host and device), so we wouldn't leave render
593          * engine with extra memory allocated
594          */
595
596         session->device_free();
597
598         delete sync;
599         sync = NULL;
600 #endif
601 }
602
603 static void populate_bake_data(BakeData *data, const
604                                int object_id,
605                                BL::BakePixel& pixel_array,
606                                const int num_pixels)
607 {
608         BL::BakePixel bp = pixel_array;
609
610         int i;
611         for(i = 0; i < num_pixels; i++) {
612                 if(bp.object_id() == object_id) {
613                         data->set(i, bp.primitive_id(), bp.uv(), bp.du_dx(), bp.du_dy(), bp.dv_dx(), bp.dv_dy());
614                 } else {
615                         data->set_null(i);
616                 }
617                 bp = bp.next();
618         }
619 }
620
621 static int bake_pass_filter_get(const int pass_filter)
622 {
623         int flag = BAKE_FILTER_NONE;
624
625         if((pass_filter & BL::BakeSettings::pass_filter_DIRECT) != 0)
626                 flag |= BAKE_FILTER_DIRECT;
627         if((pass_filter & BL::BakeSettings::pass_filter_INDIRECT) != 0)
628                 flag |= BAKE_FILTER_INDIRECT;
629         if((pass_filter & BL::BakeSettings::pass_filter_COLOR) != 0)
630                 flag |= BAKE_FILTER_COLOR;
631
632         if((pass_filter & BL::BakeSettings::pass_filter_DIFFUSE) != 0)
633                 flag |= BAKE_FILTER_DIFFUSE;
634         if((pass_filter & BL::BakeSettings::pass_filter_GLOSSY) != 0)
635                 flag |= BAKE_FILTER_GLOSSY;
636         if((pass_filter & BL::BakeSettings::pass_filter_TRANSMISSION) != 0)
637                 flag |= BAKE_FILTER_TRANSMISSION;
638         if((pass_filter & BL::BakeSettings::pass_filter_SUBSURFACE) != 0)
639                 flag |= BAKE_FILTER_SUBSURFACE;
640
641         if((pass_filter & BL::BakeSettings::pass_filter_EMIT) != 0)
642                 flag |= BAKE_FILTER_EMISSION;
643         if((pass_filter & BL::BakeSettings::pass_filter_AO) != 0)
644                 flag |= BAKE_FILTER_AO;
645
646         return flag;
647 }
648
649 void BlenderSession::bake(BL::Depsgraph& b_depsgraph_,
650                           BL::Object& b_object,
651                           const string& pass_type,
652                           const int pass_filter,
653                           const int object_id,
654                           BL::BakePixel& pixel_array,
655                           const size_t num_pixels,
656                           const int /*depth*/,
657                           float result[])
658 {
659         b_depsgraph = b_depsgraph_;
660
661         ShaderEvalType shader_type = get_shader_type(pass_type);
662
663         /* Set baking flag in advance, so kernel loading can check if we need
664          * any baking capabilities.
665          */
666         scene->bake_manager->set_baking(true);
667
668         /* ensure kernels are loaded before we do any scene updates */
669         session->load_kernels();
670
671         if(shader_type == SHADER_EVAL_UV) {
672                 /* force UV to be available */
673                 Pass::add(PASS_UV, scene->film->passes);
674         }
675
676         int bake_pass_filter = bake_pass_filter_get(pass_filter);
677         bake_pass_filter = BakeManager::shader_type_to_pass_filter(shader_type, bake_pass_filter);
678
679         /* force use_light_pass to be true if we bake more than just colors */
680         if(bake_pass_filter & ~BAKE_FILTER_COLOR) {
681                 Pass::add(PASS_LIGHT, scene->film->passes);
682         }
683
684         /* create device and update scene */
685         scene->film->tag_update(scene);
686         scene->integrator->tag_update(scene);
687
688         if(!session->progress.get_cancel()) {
689                 /* update scene */
690                 BL::Object b_camera_override(b_engine.camera_override());
691                 sync->sync_camera(b_render, b_camera_override, width, height, "");
692                 sync->sync_data(b_render,
693                                 b_depsgraph,
694                                 b_v3d,
695                                 b_camera_override,
696                                 width, height,
697                                 &python_thread_state);
698                 builtin_images_load();
699         }
700
701         BakeData *bake_data = NULL;
702
703         if(!session->progress.get_cancel()) {
704                 /* get buffer parameters */
705                 SessionParams session_params = BlenderSync::get_session_params(b_engine, b_userpref, b_scene, background);
706                 BufferParams buffer_params = BlenderSync::get_buffer_params(b_render, b_v3d, b_rv3d, scene->camera, width, height);
707
708                 scene->bake_manager->set_shader_limit((size_t)b_engine.tile_x(), (size_t)b_engine.tile_y());
709
710                 /* set number of samples */
711                 session->tile_manager.set_samples(session_params.samples);
712                 session->reset(buffer_params, session_params.samples);
713                 session->update_scene();
714
715                 /* find object index. todo: is arbitrary - copied from mesh_displace.cpp */
716                 size_t object_index = OBJECT_NONE;
717                 int tri_offset = 0;
718
719                 for(size_t i = 0; i < scene->objects.size(); i++) {
720                         if(strcmp(scene->objects[i]->name.c_str(), b_object.name().c_str()) == 0) {
721                                 object_index = i;
722                                 tri_offset = scene->objects[i]->mesh->tri_offset;
723                                 break;
724                         }
725                 }
726
727                 /* Object might have been disabled for rendering or excluded in some
728                  * other way, in that case Blender will report a warning afterwards. */
729                 if (object_index != OBJECT_NONE) {
730                         int object = object_index;
731
732                         bake_data = scene->bake_manager->init(object, tri_offset, num_pixels);
733                         populate_bake_data(bake_data, object_id, pixel_array, num_pixels);
734                 }
735
736                 /* set number of samples */
737                 session->tile_manager.set_samples(session_params.samples);
738                 session->reset(buffer_params, session_params.samples);
739                 session->update_scene();
740
741                 session->progress.set_update_callback(function_bind(&BlenderSession::update_bake_progress, this));
742         }
743
744         /* Perform bake. Check cancel to avoid crash with incomplete scene data. */
745         if(!session->progress.get_cancel() && bake_data) {
746                 scene->bake_manager->bake(scene->device, &scene->dscene, scene, session->progress, shader_type, bake_pass_filter, bake_data, result);
747         }
748
749         /* free all memory used (host and device), so we wouldn't leave render
750          * engine with extra memory allocated
751          */
752
753         session->device_free();
754
755         delete sync;
756         sync = NULL;
757 }
758
759 void BlenderSession::do_write_update_render_result(BL::RenderResult& b_rr,
760                                                    BL::RenderLayer& b_rlay,
761                                                    RenderTile& rtile,
762                                                    bool do_update_only)
763 {
764         RenderBuffers *buffers = rtile.buffers;
765
766         /* copy data from device */
767         if(!buffers->copy_from_device())
768                 return;
769
770         float exposure = scene->film->exposure;
771
772         vector<float> pixels(rtile.w*rtile.h*4);
773
774         /* Adjust absolute sample number to the range. */
775         int sample = rtile.sample;
776         const int range_start_sample = session->tile_manager.range_start_sample;
777         if(range_start_sample != -1) {
778                 sample -= range_start_sample;
779         }
780
781         if(!do_update_only) {
782                 /* copy each pass */
783                 BL::RenderLayer::passes_iterator b_iter;
784
785                 for(b_rlay.passes.begin(b_iter); b_iter != b_rlay.passes.end(); ++b_iter) {
786                         BL::RenderPass b_pass(*b_iter);
787
788                         /* find matching pass type */
789                         PassType pass_type = BlenderSync::get_pass_type(b_pass);
790                         int components = b_pass.channels();
791
792                         bool read = false;
793                         if(pass_type != PASS_NONE) {
794                                 /* copy pixels */
795                                 read = buffers->get_pass_rect(pass_type, exposure, sample, components, &pixels[0], b_pass.name());
796                         }
797                         else {
798                                 int denoising_offset = BlenderSync::get_denoising_pass(b_pass);
799                                 if(denoising_offset >= 0) {
800                                         read = buffers->get_denoising_pass_rect(denoising_offset, exposure, sample, components, &pixels[0]);
801                                 }
802                         }
803
804                         if(!read) {
805                                 memset(&pixels[0], 0, pixels.size()*sizeof(float));
806                         }
807
808                         b_pass.rect(&pixels[0]);
809                 }
810         }
811         else {
812                 /* copy combined pass */
813                 BL::RenderPass b_combined_pass(b_rlay.passes.find_by_name("Combined", b_rview_name.c_str()));
814                 if(buffers->get_pass_rect(PASS_COMBINED, exposure, sample, 4, &pixels[0], "Combined"))
815                         b_combined_pass.rect(&pixels[0]);
816         }
817
818         /* tag result as updated */
819         b_engine.update_result(b_rr);
820 }
821
822 void BlenderSession::write_render_result(BL::RenderResult& b_rr,
823                                          BL::RenderLayer& b_rlay,
824                                          RenderTile& rtile)
825 {
826         do_write_update_render_result(b_rr, b_rlay, rtile, false);
827 }
828
829 void BlenderSession::update_render_result(BL::RenderResult& b_rr,
830                                           BL::RenderLayer& b_rlay,
831                                           RenderTile& rtile)
832 {
833         do_write_update_render_result(b_rr, b_rlay, rtile, true);
834 }
835
836 void BlenderSession::synchronize(BL::Depsgraph& b_depsgraph_)
837 {
838         /* only used for viewport render */
839         if(!b_v3d)
840                 return;
841
842         /* on session/scene parameter changes, we recreate session entirely */
843         SessionParams session_params = BlenderSync::get_session_params(b_engine, b_userpref, b_scene, background);
844         SceneParams scene_params = BlenderSync::get_scene_params(b_scene, background);
845         bool session_pause = BlenderSync::get_session_pause(b_scene, background);
846
847         if(session->params.modified(session_params) ||
848            scene->params.modified(scene_params))
849         {
850                 free_session();
851                 create_session();
852                 return;
853         }
854
855         /* increase samples, but never decrease */
856         session->set_samples(session_params.samples);
857         session->set_pause(session_pause);
858
859         /* copy recalc flags, outside of mutex so we can decide to do the real
860          * synchronization at a later time to not block on running updates */
861         sync->sync_recalc(b_depsgraph_);
862
863         /* don't do synchronization if on pause */
864         if(session_pause) {
865                 tag_update();
866                 return;
867         }
868
869         /* try to acquire mutex. if we don't want to or can't, come back later */
870         if(!session->ready_to_reset() || !session->scene->mutex.try_lock()) {
871                 tag_update();
872                 return;
873         }
874
875         /* data and camera synchronize */
876         b_depsgraph = b_depsgraph_;
877
878         BL::Object b_camera_override(b_engine.camera_override());
879         sync->sync_data(b_render,
880                         b_depsgraph,
881                         b_v3d,
882                         b_camera_override,
883                         width, height,
884                         &python_thread_state);
885
886         if(b_rv3d)
887                 sync->sync_view(b_v3d, b_rv3d, width, height);
888         else
889                 sync->sync_camera(b_render, b_camera_override, width, height, "");
890
891         builtin_images_load();
892
893         /* unlock */
894         session->scene->mutex.unlock();
895
896         /* reset if needed */
897         if(scene->need_reset()) {
898                 BufferParams buffer_params = BlenderSync::get_buffer_params(b_render, b_v3d, b_rv3d, scene->camera, width, height);
899                 session->reset(buffer_params, session_params.samples);
900
901                 /* reset time */
902                 start_resize_time = 0.0;
903         }
904
905         /* Start rendering thread, if it's not running already. Do this
906          * after all scene data has been synced at least once. */
907         session->start();
908 }
909
910 bool BlenderSession::draw(int w, int h)
911 {
912         /* pause in redraw in case update is not being called due to final render */
913         session->set_pause(BlenderSync::get_session_pause(b_scene, background));
914
915         /* before drawing, we verify camera and viewport size changes, because
916          * we do not get update callbacks for those, we must detect them here */
917         if(session->ready_to_reset()) {
918                 bool reset = false;
919
920                 /* if dimensions changed, reset */
921                 if(width != w || height != h) {
922                         if(start_resize_time == 0.0) {
923                                 /* don't react immediately to resizes to avoid flickery resizing
924                                  * of the viewport, and some window managers changing the window
925                                  * size temporarily on unminimize */
926                                 start_resize_time = time_dt();
927                                 tag_redraw();
928                         }
929                         else if(time_dt() - start_resize_time < 0.2) {
930                                 tag_redraw();
931                         }
932                         else {
933                                 width = w;
934                                 height = h;
935                                 reset = true;
936                         }
937                 }
938
939                 /* try to acquire mutex. if we can't, come back later */
940                 if(!session->scene->mutex.try_lock()) {
941                         tag_update();
942                 }
943                 else {
944                         /* update camera from 3d view */
945
946                         sync->sync_view(b_v3d, b_rv3d, width, height);
947
948                         if(scene->camera->need_update)
949                                 reset = true;
950
951                         session->scene->mutex.unlock();
952                 }
953
954                 /* reset if requested */
955                 if(reset) {
956                         SessionParams session_params = BlenderSync::get_session_params(b_engine, b_userpref, b_scene, background);
957                         BufferParams buffer_params = BlenderSync::get_buffer_params(b_render, b_v3d, b_rv3d, scene->camera, width, height);
958                         bool session_pause = BlenderSync::get_session_pause(b_scene, background);
959
960                         if(session_pause == false) {
961                                 session->reset(buffer_params, session_params.samples);
962                                 start_resize_time = 0.0;
963                         }
964                 }
965         }
966         else {
967                 tag_update();
968         }
969
970         /* update status and progress for 3d view draw */
971         update_status_progress();
972
973         /* draw */
974         BufferParams buffer_params = BlenderSync::get_buffer_params(b_render, b_v3d, b_rv3d, scene->camera, width, height);
975         DeviceDrawParams draw_params;
976
977         if(session->params.display_buffer_linear) {
978                 draw_params.bind_display_space_shader_cb = function_bind(&BL::RenderEngine::bind_display_space_shader, &b_engine, b_scene);
979                 draw_params.unbind_display_space_shader_cb = function_bind(&BL::RenderEngine::unbind_display_space_shader, &b_engine);
980         }
981
982         return !session->draw(buffer_params, draw_params);
983 }
984
985 void BlenderSession::get_status(string& status, string& substatus)
986 {
987         session->progress.get_status(status, substatus);
988 }
989
990 void BlenderSession::get_progress(float& progress, double& total_time, double& render_time)
991 {
992         session->progress.get_time(total_time, render_time);
993         progress = session->progress.get_progress();
994 }
995
996 void BlenderSession::update_bake_progress()
997 {
998         float progress = session->progress.get_progress();
999
1000         if(progress != last_progress) {
1001                 b_engine.update_progress(progress);
1002                 last_progress = progress;
1003         }
1004 }
1005
1006 void BlenderSession::update_status_progress()
1007 {
1008         string timestatus, status, substatus;
1009         string scene_status = "";
1010         float progress;
1011         double total_time, remaining_time = 0, render_time;
1012         char time_str[128];
1013         float mem_used = (float)session->stats.mem_used / 1024.0f / 1024.0f;
1014         float mem_peak = (float)session->stats.mem_peak / 1024.0f / 1024.0f;
1015
1016         get_status(status, substatus);
1017         get_progress(progress, total_time, render_time);
1018
1019         if(progress > 0)
1020                 remaining_time = (1.0 - (double)progress) * (render_time / (double)progress);
1021
1022         if(background) {
1023                 scene_status += " | " + scene->name;
1024                 if(b_rlay_name != "")
1025                         scene_status += ", "  + b_rlay_name;
1026
1027                 if(b_rview_name != "")
1028                         scene_status += ", " + b_rview_name;
1029
1030                 if(remaining_time > 0) {
1031                         BLI_timecode_string_from_time_simple(time_str, sizeof(time_str), remaining_time);
1032                         timestatus += "Remaining:" + string(time_str) + " | ";
1033                 }
1034
1035                 timestatus += string_printf("Mem:%.2fM, Peak:%.2fM", (double)mem_used, (double)mem_peak);
1036
1037                 if(status.size() > 0)
1038                         status = " | " + status;
1039                 if(substatus.size() > 0)
1040                         status += " | " + substatus;
1041         }
1042
1043         double current_time = time_dt();
1044         /* When rendering in a window, redraw the status at least once per second to keep the elapsed and remaining time up-to-date.
1045          * For headless rendering, only report when something significant changes to keep the console output readable. */
1046         if(status != last_status || (!headless && (current_time - last_status_time) > 1.0)) {
1047                 b_engine.update_stats("", (timestatus + scene_status + status).c_str());
1048                 b_engine.update_memory_stats(mem_used, mem_peak);
1049                 last_status = status;
1050                 last_status_time = current_time;
1051         }
1052         if(progress != last_progress) {
1053                 b_engine.update_progress(progress);
1054                 last_progress = progress;
1055         }
1056
1057         if(session->progress.get_error()) {
1058                 string error = session->progress.get_error_message();
1059                 if(error != last_error) {
1060                         /* TODO(sergey): Currently C++ RNA API doesn't let us to
1061                          * use mnemonic name for the variable. Would be nice to
1062                          * have this figured out.
1063                          *
1064                          * For until then, 1 << 5 means RPT_ERROR.
1065                          */
1066                         b_engine.report(1 << 5, error.c_str());
1067                         b_engine.error_set(error.c_str());
1068                         last_error = error;
1069                 }
1070         }
1071 }
1072
1073 void BlenderSession::tag_update()
1074 {
1075         /* tell blender that we want to get another update callback */
1076         b_engine.tag_update();
1077 }
1078
1079 void BlenderSession::tag_redraw()
1080 {
1081         if(background) {
1082                 /* update stats and progress, only for background here because
1083                  * in 3d view we do it in draw for thread safety reasons */
1084                 update_status_progress();
1085
1086                 /* offline render, redraw if timeout passed */
1087                 if(time_dt() - last_redraw_time > 1.0) {
1088                         b_engine.tag_redraw();
1089                         last_redraw_time = time_dt();
1090                 }
1091         }
1092         else {
1093                 /* tell blender that we want to redraw */
1094                 b_engine.tag_redraw();
1095         }
1096 }
1097
1098 void BlenderSession::test_cancel()
1099 {
1100         /* test if we need to cancel rendering */
1101         if(background)
1102                 if(b_engine.test_break())
1103                         session->progress.set_cancel("Cancelled");
1104 }
1105
1106 /* builtin image file name is actually an image datablock name with
1107  * absolute sequence frame number concatenated via '@' character
1108  *
1109  * this function splits frame from builtin name
1110  */
1111 int BlenderSession::builtin_image_frame(const string &builtin_name)
1112 {
1113         int last = builtin_name.find_last_of('@');
1114         return atoi(builtin_name.substr(last + 1, builtin_name.size() - last - 1).c_str());
1115 }
1116
1117 void BlenderSession::builtin_image_info(const string &builtin_name,
1118                                         void *builtin_data,
1119                                         ImageMetaData& metadata)
1120 {
1121         /* empty image */
1122         metadata.width = 1;
1123         metadata.height = 1;
1124
1125         if(!builtin_data)
1126                 return;
1127
1128         /* recover ID pointer */
1129         PointerRNA ptr;
1130         RNA_id_pointer_create((ID*)builtin_data, &ptr);
1131         BL::ID b_id(ptr);
1132
1133         if(b_id.is_a(&RNA_Image)) {
1134                 /* image data */
1135                 BL::Image b_image(b_id);
1136
1137                 metadata.builtin_free_cache = !b_image.has_data();
1138                 metadata.is_float = b_image.is_float();
1139                 metadata.width = b_image.size()[0];
1140                 metadata.height = b_image.size()[1];
1141                 metadata.depth = 1;
1142                 metadata.channels = b_image.channels();
1143         }
1144         else if(b_id.is_a(&RNA_Object)) {
1145                 /* smoke volume data */
1146                 BL::Object b_ob(b_id);
1147                 BL::SmokeDomainSettings b_domain = object_smoke_domain_find(b_ob);
1148
1149                 metadata.is_float = true;
1150                 metadata.depth = 1;
1151                 metadata.channels = 1;
1152
1153                 if(!b_domain)
1154                         return;
1155
1156                 if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_DENSITY) ||
1157                    builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_FLAME) ||
1158                    builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_HEAT) ||
1159                    builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_TEMPERATURE))
1160                         metadata.channels = 1;
1161                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_COLOR))
1162                         metadata.channels = 4;
1163                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_VELOCITY))
1164                         metadata.channels = 3;
1165                 else
1166                         return;
1167
1168                 int3 resolution = get_int3(b_domain.domain_resolution());
1169                 int amplify = (b_domain.use_high_resolution())? b_domain.amplify() + 1: 1;
1170
1171                 /* Velocity and heat data is always low-resolution. */
1172                 if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_VELOCITY) ||
1173                    builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_HEAT))
1174                 {
1175                         amplify = 1;
1176                 }
1177
1178                 metadata.width = resolution.x * amplify;
1179                 metadata.height = resolution.y * amplify;
1180                 metadata.depth = resolution.z * amplify;
1181         }
1182         else {
1183                 /* TODO(sergey): Check we're indeed in shader node tree. */
1184                 PointerRNA ptr;
1185                 RNA_pointer_create(NULL, &RNA_Node, builtin_data, &ptr);
1186                 BL::Node b_node(ptr);
1187                 if(b_node.is_a(&RNA_ShaderNodeTexPointDensity)) {
1188                         BL::ShaderNodeTexPointDensity b_point_density_node(b_node);
1189                         metadata.channels = 4;
1190                         metadata.width = b_point_density_node.resolution();
1191                         metadata.height = metadata.width;
1192                         metadata.depth = metadata.width;
1193                         metadata.is_float = true;
1194                 }
1195         }
1196 }
1197
1198 bool BlenderSession::builtin_image_pixels(const string &builtin_name,
1199                                           void *builtin_data,
1200                                           unsigned char *pixels,
1201                                           const size_t pixels_size,
1202                                           const bool free_cache)
1203 {
1204         if(!builtin_data) {
1205                 return false;
1206         }
1207
1208         const int frame = builtin_image_frame(builtin_name);
1209
1210         PointerRNA ptr;
1211         RNA_id_pointer_create((ID*)builtin_data, &ptr);
1212         BL::Image b_image(ptr);
1213
1214         const int width = b_image.size()[0];
1215         const int height = b_image.size()[1];
1216         const int channels = b_image.channels();
1217
1218         unsigned char *image_pixels = image_get_pixels_for_frame(b_image, frame);
1219         const size_t num_pixels = ((size_t)width) * height;
1220
1221         if(image_pixels && num_pixels * channels == pixels_size) {
1222                 memcpy(pixels, image_pixels, pixels_size * sizeof(unsigned char));
1223         }
1224         else {
1225                 if(channels == 1) {
1226                         memset(pixels, 0, pixels_size * sizeof(unsigned char));
1227                 }
1228                 else {
1229                         const size_t num_pixels_safe = pixels_size / channels;
1230                         unsigned char *cp = pixels;
1231                         for(size_t i = 0; i < num_pixels_safe; i++, cp += channels) {
1232                                 cp[0] = 255;
1233                                 cp[1] = 0;
1234                                 cp[2] = 255;
1235                                 if(channels == 4) {
1236                                         cp[3] = 255;
1237                                 }
1238                         }
1239                 }
1240         }
1241
1242         if(image_pixels) {
1243                 MEM_freeN(image_pixels);
1244         }
1245
1246         /* Free image buffers to save memory during render. */
1247         if(free_cache) {
1248                 b_image.buffers_free();
1249         }
1250
1251         /* Premultiply, byte images are always straight for Blender. */
1252         unsigned char *cp = pixels;
1253         for(size_t i = 0; i < num_pixels; i++, cp += channels) {
1254                 cp[0] = (cp[0] * cp[3]) >> 8;
1255                 cp[1] = (cp[1] * cp[3]) >> 8;
1256                 cp[2] = (cp[2] * cp[3]) >> 8;
1257         }
1258         return true;
1259 }
1260
1261 bool BlenderSession::builtin_image_float_pixels(const string &builtin_name,
1262                                                 void *builtin_data,
1263                                                 float *pixels,
1264                                                 const size_t pixels_size,
1265                                                 const bool free_cache)
1266 {
1267         if(!builtin_data) {
1268                 return false;
1269         }
1270
1271         PointerRNA ptr;
1272         RNA_id_pointer_create((ID*)builtin_data, &ptr);
1273         BL::ID b_id(ptr);
1274
1275         if(b_id.is_a(&RNA_Image)) {
1276                 /* image data */
1277                 BL::Image b_image(b_id);
1278                 int frame = builtin_image_frame(builtin_name);
1279
1280                 const int width = b_image.size()[0];
1281                 const int height = b_image.size()[1];
1282                 const int channels = b_image.channels();
1283
1284                 float *image_pixels;
1285                 image_pixels = image_get_float_pixels_for_frame(b_image, frame);
1286                 const size_t num_pixels = ((size_t)width) * height;
1287
1288                 if(image_pixels && num_pixels * channels == pixels_size) {
1289                         memcpy(pixels, image_pixels, pixels_size * sizeof(float));
1290                 }
1291                 else {
1292                         if(channels == 1) {
1293                                 memset(pixels, 0, num_pixels * sizeof(float));
1294                         }
1295                         else {
1296                                 const size_t num_pixels_safe = pixels_size / channels;
1297                                 float *fp = pixels;
1298                                 for(int i = 0; i < num_pixels_safe; i++, fp += channels) {
1299                                         fp[0] = 1.0f;
1300                                         fp[1] = 0.0f;
1301                                         fp[2] = 1.0f;
1302                                         if(channels == 4) {
1303                                                 fp[3] = 1.0f;
1304                                         }
1305                                 }
1306                         }
1307                 }
1308
1309                 if(image_pixels) {
1310                         MEM_freeN(image_pixels);
1311                 }
1312
1313                 /* Free image buffers to save memory during render. */
1314                 if(free_cache) {
1315                         b_image.buffers_free();
1316                 }
1317
1318                 return true;
1319         }
1320         else if(b_id.is_a(&RNA_Object)) {
1321                 /* smoke volume data */
1322                 BL::Object b_ob(b_id);
1323                 BL::SmokeDomainSettings b_domain = object_smoke_domain_find(b_ob);
1324
1325                 if(!b_domain) {
1326                         return false;
1327                 }
1328
1329                 int3 resolution = get_int3(b_domain.domain_resolution());
1330                 int length, amplify = (b_domain.use_high_resolution())? b_domain.amplify() + 1: 1;
1331
1332                 /* Velocity and heat data is always low-resolution. */
1333                 if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_VELOCITY) ||
1334                    builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_HEAT))
1335                 {
1336                         amplify = 1;
1337                 }
1338
1339                 const int width = resolution.x * amplify;
1340                 const int height = resolution.y * amplify;
1341                 const int depth = resolution.z * amplify;
1342                 const size_t num_pixels = ((size_t)width) * height * depth;
1343
1344                 if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_DENSITY)) {
1345                         SmokeDomainSettings_density_grid_get_length(&b_domain.ptr, &length);
1346                         if(length == num_pixels) {
1347                                 SmokeDomainSettings_density_grid_get(&b_domain.ptr, pixels);
1348                                 return true;
1349                         }
1350                 }
1351                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_FLAME)) {
1352                         /* this is in range 0..1, and interpreted by the OpenGL smoke viewer
1353                          * as 1500..3000 K with the first part faded to zero density */
1354                         SmokeDomainSettings_flame_grid_get_length(&b_domain.ptr, &length);
1355                         if(length == num_pixels) {
1356                                 SmokeDomainSettings_flame_grid_get(&b_domain.ptr, pixels);
1357                                 return true;
1358                         }
1359                 }
1360                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_COLOR)) {
1361                         /* the RGB is "premultiplied" by density for better interpolation results */
1362                         SmokeDomainSettings_color_grid_get_length(&b_domain.ptr, &length);
1363                         if(length == num_pixels*4) {
1364                                 SmokeDomainSettings_color_grid_get(&b_domain.ptr, pixels);
1365                                 return true;
1366                         }
1367                 }
1368                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_VELOCITY)) {
1369                         SmokeDomainSettings_velocity_grid_get_length(&b_domain.ptr, &length);
1370                         if(length == num_pixels*3) {
1371                                 SmokeDomainSettings_velocity_grid_get(&b_domain.ptr, pixels);
1372                                 return true;
1373                         }
1374                 }
1375                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_HEAT)) {
1376                         SmokeDomainSettings_heat_grid_get_length(&b_domain.ptr, &length);
1377                         if(length == num_pixels) {
1378                                 SmokeDomainSettings_heat_grid_get(&b_domain.ptr, pixels);
1379                                 return true;
1380                         }
1381                 }
1382                 else if(builtin_name == Attribute::standard_name(ATTR_STD_VOLUME_TEMPERATURE)) {
1383                         SmokeDomainSettings_temperature_grid_get_length(&b_domain.ptr, &length);
1384                         if(length == num_pixels) {
1385                                 SmokeDomainSettings_temperature_grid_get(&b_domain.ptr, pixels);
1386                                 return true;
1387                         }
1388                 }
1389                 else {
1390                         fprintf(stderr,
1391                                 "Cycles error: unknown volume attribute %s, skipping\n",
1392                                 builtin_name.c_str());
1393                         pixels[0] = 0.0f;
1394                         return false;
1395                 }
1396
1397                 fprintf(stderr, "Cycles error: unexpected smoke volume resolution, skipping\n");
1398         }
1399         else {
1400                 /* We originally were passing view_layer here but in reality we need a
1401                  * a depsgraph to pass to the RE_point_density_minmax() function.
1402                  */
1403                 /* TODO(sergey): Check we're indeed in shader node tree. */
1404                 PointerRNA ptr;
1405                 RNA_pointer_create(NULL, &RNA_Node, builtin_data, &ptr);
1406                 BL::Node b_node(ptr);
1407                 if(b_node.is_a(&RNA_ShaderNodeTexPointDensity)) {
1408                         BL::ShaderNodeTexPointDensity b_point_density_node(b_node);
1409                         int length;
1410                         b_point_density_node.calc_point_density(b_depsgraph, &length, &pixels);
1411                 }
1412         }
1413
1414         return false;
1415 }
1416
1417 void BlenderSession::builtin_images_load()
1418 {
1419         /* Force builtin images to be loaded along with Blender data sync. This
1420          * is needed because we may be reading from depsgraph evaluated data which
1421          * can be freed by Blender before Cycles reads it. */
1422         ImageManager *manager = session->scene->image_manager;
1423         Device *device = session->device;
1424         manager->device_load_builtin(device, session->scene, session->progress);
1425 }
1426
1427 void BlenderSession::update_resumable_tile_manager(int num_samples)
1428 {
1429         const int num_resumable_chunks = BlenderSession::num_resumable_chunks,
1430                   current_resumable_chunk = BlenderSession::current_resumable_chunk;
1431         if(num_resumable_chunks == 0) {
1432                 return;
1433         }
1434
1435         if (num_resumable_chunks > num_samples) {
1436                 fprintf(stderr, "Cycles warning: more sample chunks (%d) than samples (%d), "
1437                         "this will cause some samples to be included in multiple chunks.\n",
1438                         num_resumable_chunks, num_samples);
1439         }
1440
1441         const float num_samples_per_chunk = (float)num_samples / num_resumable_chunks;
1442
1443         float range_start_sample, range_num_samples;
1444         if(current_resumable_chunk != 0) {
1445                 /* Single chunk rendering. */
1446                 range_start_sample = num_samples_per_chunk * (current_resumable_chunk - 1);
1447                 range_num_samples = num_samples_per_chunk;
1448         }
1449         else {
1450                 /* Ranged-chunks. */
1451                 const int num_chunks = end_resumable_chunk - start_resumable_chunk + 1;
1452                 range_start_sample = num_samples_per_chunk * (start_resumable_chunk - 1);
1453                 range_num_samples = num_chunks * num_samples_per_chunk;
1454         }
1455
1456         /* Round after doing the multiplications with num_chunks and num_samples_per_chunk
1457          * to allow for many small chunks. */
1458         int rounded_range_start_sample = (int)floor(range_start_sample + 0.5f);
1459         int rounded_range_num_samples = max((int)floor(range_num_samples + 0.5f), 1);
1460
1461         /* Make sure we don't overshoot. */
1462         if(rounded_range_start_sample + rounded_range_num_samples > num_samples) {
1463                 rounded_range_num_samples = num_samples - rounded_range_num_samples;
1464         }
1465
1466         VLOG(1) << "Samples range start is " << range_start_sample << ", "
1467                 << "number of samples to render is " << range_num_samples;
1468
1469         scene->integrator->start_sample = rounded_range_start_sample;
1470         scene->integrator->tag_update(scene);
1471
1472         session->tile_manager.range_start_sample = rounded_range_start_sample;
1473         session->tile_manager.range_num_samples = rounded_range_num_samples;
1474 }
1475
1476 void BlenderSession::free_blender_memory_if_possible()
1477 {
1478         if(!background) {
1479                 /* During interactive render we can not free anything: attempts to save
1480                  * memory would cause things to be allocated and evaluated for every
1481                  * updated sample.
1482                  */
1483                 return;
1484         }
1485         b_engine.free_blender_memory();
1486 }
1487
1488 CCL_NAMESPACE_END