2 * ***** BEGIN GPL LICENSE BLOCK *****
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * The Original Code is Copyright (C) 2004 by Blender Foundation
19 * All rights reserved.
21 * The Original Code is: all of this file.
23 * Contributor(s): Morten Mikkelsen,
26 * ***** END GPL LICENSE BLOCK *****
29 /** \file blender/editors/object/object_bake.c
35 #include "MEM_guardedalloc.h"
37 #include "DNA_scene_types.h"
38 #include "DNA_screen_types.h"
39 #include "DNA_space_types.h"
40 #include "DNA_world_types.h"
41 #include "DNA_object_types.h"
42 #include "DNA_mesh_types.h"
43 #include "DNA_meshdata_types.h"
45 #include "BLI_blenlib.h"
46 #include "BLI_threads.h"
47 #include "BLI_utildefines.h"
49 #include "BLI_math_geom.h"
51 #include "BKE_blender.h"
53 #include "BKE_screen.h"
54 #include "BKE_context.h"
55 #include "BKE_global.h"
56 #include "BKE_image.h"
58 #include "BKE_multires.h"
59 #include "BKE_report.h"
60 #include "BKE_cdderivedmesh.h"
61 #include "BKE_modifier.h"
62 #include "BKE_DerivedMesh.h"
63 #include "BKE_subsurf.h"
65 #include "RE_pipeline.h"
66 #include "RE_shader_ext.h"
67 #include "RE_multires_bake.h"
71 #include "IMB_imbuf_types.h"
72 #include "IMB_imbuf.h"
73 #include "IMB_colormanagement.h"
75 #include "GPU_draw.h" /* GPU_free_image */
80 #include "ED_object.h"
82 #include "object_intern.h"
84 /* ****************** multires BAKING ********************** */
86 /* holder of per-object data needed for bake job
87 * needed to make job totally thread-safe */
88 typedef struct MultiresBakerJobData {
89 struct MultiresBakerJobData *next, *prev;
90 DerivedMesh *lores_dm, *hires_dm;
91 int simple, lvl, tot_lvl;
92 } MultiresBakerJobData;
94 /* data passing to multires-baker job */
97 int bake_clear, bake_filter;
98 short mode, use_lores_mesh;
101 int raytrace_structure;
104 static int multiresbake_check(bContext *C, wmOperator *op)
106 Scene *scene = CTX_data_scene(C);
109 MultiresModifierData *mmd;
112 CTX_DATA_BEGIN (C, Base *, base, selected_editable_bases)
116 if (ob->type != OB_MESH) {
117 BKE_report(op->reports, RPT_ERROR, "Baking of multires data only works with an active mesh object");
123 me = (Mesh *)ob->data;
124 mmd = get_multires_modifier(scene, ob, 0);
126 /* Multi-resolution should be and be last in the stack */
130 ok = mmd->totlvl > 0;
132 for (md = (ModifierData *)mmd->modifier.next; md && ok; md = md->next) {
133 if (modifier_isEnabled(scene, md, eModifierMode_Realtime)) {
141 BKE_report(op->reports, RPT_ERROR, "Multires data baking requires multi-resolution object");
147 BKE_report(op->reports, RPT_ERROR, "Multires data baking is not supported for preview subdivision level 0");
153 BKE_report(op->reports, RPT_ERROR, "Mesh should be unwrapped before multires data baking");
160 Image *ima = me->mtpoly[a].tpage;
163 BKE_report(op->reports, RPT_ERROR, "You should have active texture to use multires baker");
168 ImBuf *ibuf = BKE_image_acquire_ibuf(ima, NULL, NULL);
171 BKE_report(op->reports, RPT_ERROR, "Baking should happen to image with image buffer");
176 if (ibuf->rect == NULL && ibuf->rect_float == NULL)
179 if (ibuf->rect_float && !(ibuf->channels == 0 || ibuf->channels == 4))
183 BKE_report(op->reports, RPT_ERROR, "Baking to unsupported image type");
186 BKE_image_release_ibuf(ima, ibuf, NULL);
199 static DerivedMesh *multiresbake_create_loresdm(Scene *scene, Object *ob, int *lvl)
202 MultiresModifierData *mmd = get_multires_modifier(scene, ob, 0);
203 Mesh *me = (Mesh *)ob->data;
208 DerivedMesh *tmp_dm = CDDM_from_mesh(me, ob);
210 DM_set_only_copy(tmp_dm, CD_MASK_BAREMESH | CD_MASK_MTFACE);
212 dm = CDDM_copy(tmp_dm);
213 tmp_dm->release(tmp_dm);
216 MultiresModifierData tmp_mmd = *mmd;
217 DerivedMesh *cddm = CDDM_from_mesh(me, ob);
219 DM_set_only_copy(cddm, CD_MASK_BAREMESH | CD_MASK_MTFACE);
222 tmp_mmd.sculptlvl = *lvl;
223 dm = multires_make_derived_from_derived(cddm, &tmp_mmd, ob, 0);
230 static DerivedMesh *multiresbake_create_hiresdm(Scene *scene, Object *ob, int *lvl, int *simple)
232 Mesh *me = (Mesh *)ob->data;
233 MultiresModifierData *mmd = get_multires_modifier(scene, ob, 0);
234 MultiresModifierData tmp_mmd = *mmd;
235 DerivedMesh *cddm = CDDM_from_mesh(me, ob);
238 DM_set_only_copy(cddm, CD_MASK_BAREMESH);
240 /* TODO: DM_set_only_copy wouldn't set mask for loop and poly data,
241 * but we really need BAREMESH only to save lots of memory
243 CustomData_set_only_copy(&cddm->loopData, CD_MASK_BAREMESH);
244 CustomData_set_only_copy(&cddm->polyData, CD_MASK_BAREMESH);
247 *simple = mmd->simple;
249 tmp_mmd.lvl = mmd->totlvl;
250 tmp_mmd.sculptlvl = mmd->totlvl;
251 dm = multires_make_derived_from_derived(cddm, &tmp_mmd, ob, 0);
257 static void clear_images(MTFace *mtface, int totface)
260 const float vec_alpha[4] = {0.0f, 0.0f, 0.0f, 0.0f};
261 const float vec_solid[4] = {0.0f, 0.0f, 0.0f, 1.0f};
263 for (a = 0; a < totface; a++)
264 mtface[a].tpage->id.flag &= ~LIB_DOIT;
266 for (a = 0; a < totface; a++) {
267 Image *ima = mtface[a].tpage;
269 if ((ima->id.flag & LIB_DOIT) == 0) {
270 ImBuf *ibuf = BKE_image_acquire_ibuf(ima, NULL, NULL);
272 IMB_rectfill(ibuf, (ibuf->planes == R_IMF_PLANES_RGBA) ? vec_alpha : vec_solid);
273 ima->id.flag |= LIB_DOIT;
275 BKE_image_release_ibuf(ima, ibuf, NULL);
279 for (a = 0; a < totface; a++)
280 mtface[a].tpage->id.flag &= ~LIB_DOIT;
283 static int multiresbake_image_exec_locked(bContext *C, wmOperator *op)
286 Scene *scene = CTX_data_scene(C);
287 int objects_baked = 0;
289 if (!multiresbake_check(C, op))
290 return OPERATOR_CANCELLED;
292 if (scene->r.bake_flag & R_BAKE_CLEAR) { /* clear images */
293 CTX_DATA_BEGIN (C, Base *, base, selected_editable_bases)
298 me = (Mesh *)ob->data;
300 clear_images(me->mtface, me->totface);
305 CTX_DATA_BEGIN (C, Base *, base, selected_editable_bases)
307 MultiresBakeRender bkr = {0};
311 multires_force_update(ob);
313 /* copy data stored in job descriptor */
314 bkr.bake_filter = scene->r.bake_filter;
315 bkr.mode = scene->r.bake_mode;
316 bkr.use_lores_mesh = scene->r.bake_flag & R_BAKE_LORES_MESH;
317 bkr.bias = scene->r.bake_biasdist;
318 bkr.number_of_rays = scene->r.bake_rays_number;
319 bkr.raytrace_structure = scene->r.raytrace_structure;
321 /* create low-resolution DM (to bake to) and hi-resolution DM (to bake from) */
322 bkr.hires_dm = multiresbake_create_hiresdm(scene, ob, &bkr.tot_lvl, &bkr.simple);
323 bkr.lores_dm = multiresbake_create_loresdm(scene, ob, &bkr.lvl);
325 RE_multires_bake_images(&bkr);
327 BLI_freelistN(&bkr.image);
329 bkr.lores_dm->release(bkr.lores_dm);
330 bkr.hires_dm->release(bkr.hires_dm);
337 BKE_report(op->reports, RPT_ERROR, "No objects found to bake from");
339 return OPERATOR_FINISHED;
342 /* Multiresbake adopted for job-system executing */
343 static void init_multiresbake_job(bContext *C, MultiresBakeJob *bkj)
345 Scene *scene = CTX_data_scene(C);
348 /* backup scene settings, so their changing in UI would take no effect on baker */
349 bkj->bake_filter = scene->r.bake_filter;
350 bkj->mode = scene->r.bake_mode;
351 bkj->use_lores_mesh = scene->r.bake_flag & R_BAKE_LORES_MESH;
352 bkj->bake_clear = scene->r.bake_flag & R_BAKE_CLEAR;
353 bkj->bias = scene->r.bake_biasdist;
354 bkj->number_of_rays = scene->r.bake_rays_number;
355 bkj->raytrace_structure = scene->r.raytrace_structure;
357 CTX_DATA_BEGIN (C, Base *, base, selected_editable_bases)
359 MultiresBakerJobData *data;
364 multires_force_update(ob);
366 data = MEM_callocN(sizeof(MultiresBakerJobData), "multiresBaker derivedMesh_data");
368 /* create low-resolution DM (to bake to) and hi-resolution DM (to bake from) */
369 data->hires_dm = multiresbake_create_hiresdm(scene, ob, &data->tot_lvl, &data->simple);
370 data->lores_dm = multiresbake_create_loresdm(scene, ob, &lvl);
373 BLI_addtail(&bkj->data, data);
378 static void multiresbake_startjob(void *bkv, short *stop, short *do_update, float *progress)
380 MultiresBakerJobData *data;
381 MultiresBakeJob *bkj = bkv;
382 int baked_objects = 0, tot_obj;
384 tot_obj = BLI_countlist(&bkj->data);
386 if (bkj->bake_clear) { /* clear images */
387 for (data = bkj->data.first; data; data = data->next) {
388 DerivedMesh *dm = data->lores_dm;
389 MTFace *mtface = CustomData_get_layer(&dm->faceData, CD_MTFACE);
391 clear_images(mtface, dm->getNumTessFaces(dm));
395 for (data = bkj->data.first; data; data = data->next) {
396 MultiresBakeRender bkr = {0};
398 /* copy data stored in job descriptor */
399 bkr.bake_filter = bkj->bake_filter;
400 bkr.mode = bkj->mode;
401 bkr.use_lores_mesh = bkj->use_lores_mesh;
403 /* create low-resolution DM (to bake to) and hi-resolution DM (to bake from) */
404 bkr.lores_dm = data->lores_dm;
405 bkr.hires_dm = data->hires_dm;
406 bkr.tot_lvl = data->tot_lvl;
408 bkr.simple = data->simple;
410 /* needed for proper progress bar */
411 bkr.tot_obj = tot_obj;
412 bkr.baked_objects = baked_objects;
415 bkr.do_update = do_update;
416 bkr.progress = progress;
418 bkr.bias = bkj->bias;
419 bkr.number_of_rays = bkj->number_of_rays;
420 bkr.raytrace_structure = bkj->raytrace_structure;
422 RE_multires_bake_images(&bkr);
424 BLI_freelistN(&bkr.image);
430 static void multiresbake_freejob(void *bkv)
432 MultiresBakeJob *bkj = bkv;
433 MultiresBakerJobData *data, *next;
435 data = bkj->data.first;
438 data->lores_dm->release(data->lores_dm);
439 data->hires_dm->release(data->hires_dm);
447 static int multiresbake_image_exec(bContext *C, wmOperator *op)
449 Scene *scene = CTX_data_scene(C);
450 MultiresBakeJob *bkr;
453 if (!multiresbake_check(C, op))
454 return OPERATOR_CANCELLED;
456 bkr = MEM_callocN(sizeof(MultiresBakeJob), "MultiresBakeJob data");
457 init_multiresbake_job(C, bkr);
459 if (!bkr->data.first) {
460 BKE_report(op->reports, RPT_ERROR, "No objects found to bake from");
461 return OPERATOR_CANCELLED;
465 wm_job = WM_jobs_get(CTX_wm_manager(C), CTX_wm_window(C), scene, "Multires Bake",
466 WM_JOB_EXCL_RENDER | WM_JOB_PRIORITY | WM_JOB_PROGRESS, WM_JOB_TYPE_OBJECT_BAKE_TEXTURE);
467 WM_jobs_customdata_set(wm_job, bkr, multiresbake_freejob);
468 WM_jobs_timer(wm_job, 0.2, NC_IMAGE, 0); /* TODO - only draw bake image, can we enforce this */
469 WM_jobs_callbacks(wm_job, multiresbake_startjob, NULL, NULL, NULL);
473 WM_jobs_start(CTX_wm_manager(C), wm_job);
476 /* add modal handler for ESC */
477 WM_event_add_modal_handler(C, op);
479 return OPERATOR_RUNNING_MODAL;
482 /* ****************** render BAKING ********************** */
484 /* threaded break test */
485 static int thread_break(void *UNUSED(arg))
490 typedef struct BakeRender {
494 struct Object *actob;
506 short prev_wo_amb_occ;
507 short prev_r_raytrace;
513 /* use by exec and invoke */
514 static int test_bake_internal(bContext *C, ReportList *reports)
516 Scene *scene = CTX_data_scene(C);
518 if ((scene->r.bake_flag & R_BAKE_TO_ACTIVE) && CTX_data_active_object(C) == NULL) {
519 BKE_report(reports, RPT_ERROR, "No active object");
521 else if (scene->r.bake_mode == RE_BAKE_AO && scene->world == NULL) {
522 BKE_report(reports, RPT_ERROR, "No world set up");
531 static void init_bake_internal(BakeRender *bkr, bContext *C)
533 Scene *scene = CTX_data_scene(C);
534 bScreen *sc = CTX_wm_screen(C);
536 /* get editmode results */
537 ED_object_exit_editmode(C, 0); /* 0 = does not exit editmode */
539 bkr->sa = sc ? BKE_screen_find_big_area(sc, SPACE_IMAGE, 10) : NULL; /* can be NULL */
540 bkr->main = CTX_data_main(C);
542 bkr->actob = (scene->r.bake_flag & R_BAKE_TO_ACTIVE) ? OBACT : NULL;
543 bkr->re = RE_NewRender("_Bake View_");
545 if (scene->r.bake_mode == RE_BAKE_AO) {
546 /* If raytracing or AO is disabled, switch it on temporarily for baking. */
547 bkr->prev_wo_amb_occ = (scene->world->mode & WO_AMB_OCC) != 0;
548 scene->world->mode |= WO_AMB_OCC;
550 if (scene->r.bake_mode == RE_BAKE_AO || bkr->actob) {
551 bkr->prev_r_raytrace = (scene->r.mode & R_RAYTRACE) != 0;
552 scene->r.mode |= R_RAYTRACE;
556 static void finish_bake_internal(BakeRender *bkr)
560 RE_Database_Free(bkr->re);
562 /* restore raytrace and AO */
563 if (bkr->scene->r.bake_mode == RE_BAKE_AO)
564 if (bkr->prev_wo_amb_occ == 0)
565 bkr->scene->world->mode &= ~WO_AMB_OCC;
567 if (bkr->scene->r.bake_mode == RE_BAKE_AO || bkr->actob)
568 if (bkr->prev_r_raytrace == 0)
569 bkr->scene->r.mode &= ~R_RAYTRACE;
571 /* force OpenGL reload and mipmap recalc */
572 for (ima = G.main->image.first; ima; ima = ima->id.next) {
573 ImBuf *ibuf = BKE_image_acquire_ibuf(ima, NULL, NULL);
575 /* some of the images could have been changed during bake,
576 * so recreate mipmaps regardless bake result status
578 if (ima->ok == IMA_OK_LOADED) {
580 if (ibuf->userflags & IB_BITMAPDIRTY) {
582 imb_freemipmapImBuf(ibuf);
585 /* invalidate display buffers for changed images */
586 if (ibuf->userflags & IB_BITMAPDIRTY)
587 ibuf->userflags |= IB_DISPLAY_BUFFER_INVALID;
591 /* freed when baking is done, but if its canceled we need to free here */
593 if (ibuf->userdata) {
594 MEM_freeN(ibuf->userdata);
595 ibuf->userdata = NULL;
599 BKE_image_release_ibuf(ima, ibuf, NULL);
603 static void *do_bake_render(void *bake_v)
605 BakeRender *bkr = bake_v;
607 bkr->result = RE_bake_shade_all_selected(bkr->re, bkr->scene->r.bake_mode, bkr->actob, NULL, bkr->progress);
613 static void bake_startjob(void *bkv, short *stop, short *do_update, float *progress)
615 BakeRender *bkr = bkv;
616 Scene *scene = bkr->scene;
617 Main *bmain = bkr->main;
620 bkr->do_update = do_update;
621 bkr->progress = progress;
623 RE_test_break_cb(bkr->re, NULL, thread_break);
624 G.is_break = FALSE; /* blender_test_break uses this global */
626 RE_Database_Baking(bkr->re, bmain, scene, scene->lay, scene->r.bake_mode, bkr->actob);
628 /* baking itself is threaded, cannot use test_break in threads. we also update optional imagewindow */
629 bkr->result = RE_bake_shade_all_selected(bkr->re, scene->r.bake_mode, bkr->actob, bkr->do_update, bkr->progress);
632 static void bake_update(void *bkv)
634 BakeRender *bkr = bkv;
636 if (bkr->sa && bkr->sa->spacetype == SPACE_IMAGE) { /* in case the user changed while baking */
637 SpaceImage *sima = bkr->sa->spacedata.first;
639 sima->image = RE_bake_shade_get_image();
643 static void bake_freejob(void *bkv)
645 BakeRender *bkr = bkv;
646 finish_bake_internal(bkr);
648 if (bkr->result == BAKE_RESULT_NO_OBJECTS)
649 BKE_report(bkr->reports, RPT_ERROR, "No objects or images found to bake to");
650 else if (bkr->result == BAKE_RESULT_FEEDBACK_LOOP)
651 BKE_report(bkr->reports, RPT_WARNING, "Feedback loop detected");
654 G.is_rendering = FALSE;
658 static int objects_bake_render_modal(bContext *C, wmOperator *UNUSED(op), wmEvent *event)
660 /* no running blender, remove handler and pass through */
661 if (0 == WM_jobs_test(CTX_wm_manager(C), CTX_data_scene(C), WM_JOB_TYPE_OBJECT_BAKE_TEXTURE))
662 return OPERATOR_FINISHED | OPERATOR_PASS_THROUGH;
665 switch (event->type) {
667 return OPERATOR_RUNNING_MODAL;
670 return OPERATOR_PASS_THROUGH;
673 static int is_multires_bake(Scene *scene)
675 if (ELEM3(scene->r.bake_mode, RE_BAKE_NORMALS, RE_BAKE_DISPLACEMENT, RE_BAKE_AO))
676 return scene->r.bake_flag & R_BAKE_MULTIRES;
681 static int objects_bake_render_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(_event))
683 Scene *scene = CTX_data_scene(C);
684 int result = OPERATOR_CANCELLED;
686 if (is_multires_bake(scene)) {
687 result = multiresbake_image_exec(C, op);
690 /* only one render job at a time */
691 if (WM_jobs_test(CTX_wm_manager(C), scene, WM_JOB_TYPE_OBJECT_BAKE_TEXTURE))
692 return OPERATOR_CANCELLED;
694 if (test_bake_internal(C, op->reports) == 0) {
695 return OPERATOR_CANCELLED;
698 BakeRender *bkr = MEM_callocN(sizeof(BakeRender), "render bake");
701 init_bake_internal(bkr, C);
702 bkr->reports = op->reports;
705 wm_job = WM_jobs_get(CTX_wm_manager(C), CTX_wm_window(C), scene, "Texture Bake",
706 WM_JOB_EXCL_RENDER | WM_JOB_PRIORITY | WM_JOB_PROGRESS, WM_JOB_TYPE_OBJECT_BAKE_TEXTURE);
707 WM_jobs_customdata_set(wm_job, bkr, bake_freejob);
708 WM_jobs_timer(wm_job, 0.2, NC_IMAGE, 0); /* TODO - only draw bake image, can we enforce this */
709 WM_jobs_callbacks(wm_job, bake_startjob, NULL, bake_update, NULL);
712 G.is_rendering = TRUE;
714 WM_jobs_start(CTX_wm_manager(C), wm_job);
718 /* add modal handler for ESC */
719 WM_event_add_modal_handler(C, op);
722 result = OPERATOR_RUNNING_MODAL;
725 WM_event_add_notifier(C, NC_SCENE | ND_RENDER_RESULT, scene);
731 static int bake_image_exec(bContext *C, wmOperator *op)
733 Main *bmain = CTX_data_main(C);
734 Scene *scene = CTX_data_scene(C);
735 int result = OPERATOR_CANCELLED;
737 if (is_multires_bake(scene)) {
738 result = multiresbake_image_exec_locked(C, op);
741 if (test_bake_internal(C, op->reports) == 0) {
742 return OPERATOR_CANCELLED;
746 BakeRender bkr = {NULL};
748 init_bake_internal(&bkr, C);
749 bkr.reports = op->reports;
751 RE_test_break_cb(bkr.re, NULL, thread_break);
752 G.is_break = FALSE; /* blender_test_break uses this global */
754 RE_Database_Baking(bkr.re, bmain, scene, scene->lay, scene->r.bake_mode, (scene->r.bake_flag & R_BAKE_TO_ACTIVE) ? OBACT : NULL);
756 /* baking itself is threaded, cannot use test_break in threads */
757 BLI_init_threads(&threads, do_bake_render, 1);
759 BLI_insert_thread(&threads, &bkr);
761 while (bkr.ready == 0) {
766 /* used to redraw in 2.4x but this is just for exec in 2.5 */
768 blender_test_break();
770 BLI_end_threads(&threads);
772 if (bkr.result == BAKE_RESULT_NO_OBJECTS)
773 BKE_report(op->reports, RPT_ERROR, "No valid images found to bake to");
774 else if (bkr.result == BAKE_RESULT_FEEDBACK_LOOP)
775 BKE_report(op->reports, RPT_ERROR, "Feedback loop detected");
777 finish_bake_internal(&bkr);
779 result = OPERATOR_FINISHED;
783 WM_event_add_notifier(C, NC_SCENE | ND_RENDER_RESULT, scene);
788 void OBJECT_OT_bake_image(wmOperatorType *ot)
792 ot->description = "Bake image textures of selected objects";
793 ot->idname = "OBJECT_OT_bake_image";
796 ot->exec = bake_image_exec;
797 ot->invoke = objects_bake_render_invoke;
798 ot->modal = objects_bake_render_modal;