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 static int multiresbake_check(bContext *C, wmOperator *op)
103 Scene *scene = CTX_data_scene(C);
106 MultiresModifierData *mmd;
109 CTX_DATA_BEGIN (C, Base *, base, selected_editable_bases)
113 if (ob->type != OB_MESH) {
114 BKE_report(op->reports, RPT_ERROR, "Baking of multires data only works with an active mesh object");
120 me = (Mesh *)ob->data;
121 mmd = get_multires_modifier(scene, ob, 0);
123 /* Multi-resolution should be and be last in the stack */
127 ok = mmd->totlvl > 0;
129 for (md = (ModifierData *)mmd->modifier.next; md && ok; md = md->next) {
130 if (modifier_isEnabled(scene, md, eModifierMode_Realtime)) {
138 BKE_report(op->reports, RPT_ERROR, "Multires data baking requires multi-resolution object");
144 BKE_report(op->reports, RPT_ERROR, "Multires data baking is not supported for preview subdivision level 0");
150 BKE_report(op->reports, RPT_ERROR, "Mesh should be unwrapped before multires data baking");
157 Image *ima = me->mtpoly[a].tpage;
160 BKE_report(op->reports, RPT_ERROR, "You should have active texture to use multires baker");
165 ImBuf *ibuf = BKE_image_acquire_ibuf(ima, NULL, NULL);
168 BKE_report(op->reports, RPT_ERROR, "Baking should happen to image with image buffer");
173 if (ibuf->rect == NULL && ibuf->rect_float == NULL)
176 if (ibuf->rect_float && !(ibuf->channels == 0 || ibuf->channels == 4))
180 BKE_report(op->reports, RPT_ERROR, "Baking to unsupported image type");
183 BKE_image_release_ibuf(ima, ibuf, NULL);
196 static DerivedMesh *multiresbake_create_loresdm(Scene *scene, Object *ob, int *lvl)
199 MultiresModifierData *mmd = get_multires_modifier(scene, ob, 0);
200 Mesh *me = (Mesh *)ob->data;
205 DerivedMesh *tmp_dm = CDDM_from_mesh(me, ob);
206 dm = CDDM_copy(tmp_dm);
207 tmp_dm->release(tmp_dm);
210 MultiresModifierData tmp_mmd = *mmd;
211 DerivedMesh *cddm = CDDM_from_mesh(me, ob);
214 tmp_mmd.sculptlvl = *lvl;
215 dm = multires_make_derived_from_derived(cddm, &tmp_mmd, ob, 0);
222 static DerivedMesh *multiresbake_create_hiresdm(Scene *scene, Object *ob, int *lvl, int *simple)
224 Mesh *me = (Mesh *)ob->data;
225 MultiresModifierData *mmd = get_multires_modifier(scene, ob, 0);
226 MultiresModifierData tmp_mmd = *mmd;
227 DerivedMesh *cddm = CDDM_from_mesh(me, ob);
231 *simple = mmd->simple;
233 tmp_mmd.lvl = mmd->totlvl;
234 tmp_mmd.sculptlvl = mmd->totlvl;
235 dm = multires_make_derived_from_derived(cddm, &tmp_mmd, ob, 0);
241 static void clear_images(MTFace *mtface, int totface)
244 const float vec_alpha[4] = {0.0f, 0.0f, 0.0f, 0.0f};
245 const float vec_solid[4] = {0.0f, 0.0f, 0.0f, 1.0f};
247 for (a = 0; a < totface; a++)
248 mtface[a].tpage->id.flag &= ~LIB_DOIT;
250 for (a = 0; a < totface; a++) {
251 Image *ima = mtface[a].tpage;
253 if ((ima->id.flag & LIB_DOIT) == 0) {
254 ImBuf *ibuf = BKE_image_acquire_ibuf(ima, NULL, NULL);
256 IMB_rectfill(ibuf, (ibuf->planes == R_IMF_PLANES_RGBA) ? vec_alpha : vec_solid);
257 ima->id.flag |= LIB_DOIT;
259 BKE_image_release_ibuf(ima, ibuf, NULL);
263 for (a = 0; a < totface; a++)
264 mtface[a].tpage->id.flag &= ~LIB_DOIT;
267 static int multiresbake_image_exec_locked(bContext *C, wmOperator *op)
270 Scene *scene = CTX_data_scene(C);
271 int objects_baked = 0;
273 if (!multiresbake_check(C, op))
274 return OPERATOR_CANCELLED;
276 if (scene->r.bake_flag & R_BAKE_CLEAR) { /* clear images */
277 CTX_DATA_BEGIN (C, Base *, base, selected_editable_bases)
282 me = (Mesh *)ob->data;
284 clear_images(me->mtface, me->totface);
289 CTX_DATA_BEGIN (C, Base *, base, selected_editable_bases)
291 MultiresBakeRender bkr = {0};
295 multires_force_update(ob);
297 /* copy data stored in job descriptor */
298 bkr.bake_filter = scene->r.bake_filter;
299 bkr.mode = scene->r.bake_mode;
300 bkr.use_lores_mesh = scene->r.bake_flag & R_BAKE_LORES_MESH;
302 /* create low-resolution DM (to bake to) and hi-resolution DM (to bake from) */
303 bkr.lores_dm = multiresbake_create_loresdm(scene, ob, &bkr.lvl);
308 bkr.hires_dm = multiresbake_create_hiresdm(scene, ob, &bkr.tot_lvl, &bkr.simple);
310 RE_multires_bake_images(&bkr);
312 BLI_freelistN(&bkr.image);
314 bkr.lores_dm->release(bkr.lores_dm);
315 bkr.hires_dm->release(bkr.hires_dm);
322 BKE_report(op->reports, RPT_ERROR, "No objects found to bake from");
324 return OPERATOR_FINISHED;
327 /* Multiresbake adopted for job-system executing */
328 static void init_multiresbake_job(bContext *C, MultiresBakeJob *bkj)
330 Scene *scene = CTX_data_scene(C);
333 /* backup scene settings, so their changing in UI would take no effect on baker */
334 bkj->bake_filter = scene->r.bake_filter;
335 bkj->mode = scene->r.bake_mode;
336 bkj->use_lores_mesh = scene->r.bake_flag & R_BAKE_LORES_MESH;
337 bkj->bake_clear = scene->r.bake_flag & R_BAKE_CLEAR;
339 CTX_DATA_BEGIN (C, Base *, base, selected_editable_bases)
341 MultiresBakerJobData *data;
342 DerivedMesh *lores_dm;
346 multires_force_update(ob);
348 lores_dm = multiresbake_create_loresdm(scene, ob, &lvl);
352 data = MEM_callocN(sizeof(MultiresBakerJobData), "multiresBaker derivedMesh_data");
353 data->lores_dm = lores_dm;
355 data->hires_dm = multiresbake_create_hiresdm(scene, ob, &data->tot_lvl, &data->simple);
357 BLI_addtail(&bkj->data, data);
362 static void multiresbake_startjob(void *bkv, short *stop, short *do_update, float *progress)
364 MultiresBakerJobData *data;
365 MultiresBakeJob *bkj = bkv;
366 int baked_objects = 0, tot_obj;
368 tot_obj = BLI_countlist(&bkj->data);
370 if (bkj->bake_clear) { /* clear images */
371 for (data = bkj->data.first; data; data = data->next) {
372 DerivedMesh *dm = data->lores_dm;
373 MTFace *mtface = CustomData_get_layer(&dm->faceData, CD_MTFACE);
375 clear_images(mtface, dm->getNumTessFaces(dm));
379 for (data = bkj->data.first; data; data = data->next) {
380 MultiresBakeRender bkr = {0};
382 /* copy data stored in job descriptor */
383 bkr.bake_filter = bkj->bake_filter;
384 bkr.mode = bkj->mode;
385 bkr.use_lores_mesh = bkj->use_lores_mesh;
387 /* create low-resolution DM (to bake to) and hi-resolution DM (to bake from) */
388 bkr.lores_dm = data->lores_dm;
389 bkr.hires_dm = data->hires_dm;
390 bkr.tot_lvl = data->tot_lvl;
392 bkr.simple = data->simple;
394 /* needed for proper progress bar */
395 bkr.tot_obj = tot_obj;
396 bkr.baked_objects = baked_objects;
399 bkr.do_update = do_update;
400 bkr.progress = progress;
402 RE_multires_bake_images(&bkr);
404 BLI_freelistN(&bkr.image);
410 static void multiresbake_freejob(void *bkv)
412 MultiresBakeJob *bkj = bkv;
413 MultiresBakerJobData *data, *next;
415 data = bkj->data.first;
418 data->lores_dm->release(data->lores_dm);
419 data->hires_dm->release(data->hires_dm);
427 static int multiresbake_image_exec(bContext *C, wmOperator *op)
429 Scene *scene = CTX_data_scene(C);
430 MultiresBakeJob *bkr;
433 if (!multiresbake_check(C, op))
434 return OPERATOR_CANCELLED;
436 bkr = MEM_callocN(sizeof(MultiresBakeJob), "MultiresBakeJob data");
437 init_multiresbake_job(C, bkr);
439 if (!bkr->data.first) {
440 BKE_report(op->reports, RPT_ERROR, "No objects found to bake from");
441 return OPERATOR_CANCELLED;
445 wm_job = WM_jobs_get(CTX_wm_manager(C), CTX_wm_window(C), scene, "Multires Bake",
446 WM_JOB_EXCL_RENDER | WM_JOB_PRIORITY | WM_JOB_PROGRESS, WM_JOB_TYPE_OBJECT_BAKE_TEXTURE);
447 WM_jobs_customdata_set(wm_job, bkr, multiresbake_freejob);
448 WM_jobs_timer(wm_job, 0.2, NC_IMAGE, 0); /* TODO - only draw bake image, can we enforce this */
449 WM_jobs_callbacks(wm_job, multiresbake_startjob, NULL, NULL, NULL);
453 WM_jobs_start(CTX_wm_manager(C), wm_job);
456 /* add modal handler for ESC */
457 WM_event_add_modal_handler(C, op);
459 return OPERATOR_RUNNING_MODAL;
462 /* ****************** render BAKING ********************** */
464 /* threaded break test */
465 static int thread_break(void *UNUSED(arg))
470 typedef struct BakeRender {
474 struct Object *actob;
486 short prev_wo_amb_occ;
487 short prev_r_raytrace;
493 /* use by exec and invoke */
494 static int test_bake_internal(bContext *C, ReportList *reports)
496 Scene *scene = CTX_data_scene(C);
498 if ((scene->r.bake_flag & R_BAKE_TO_ACTIVE) && CTX_data_active_object(C) == NULL) {
499 BKE_report(reports, RPT_ERROR, "No active object");
501 else if (scene->r.bake_mode == RE_BAKE_AO && scene->world == NULL) {
502 BKE_report(reports, RPT_ERROR, "No world set up");
511 static void init_bake_internal(BakeRender *bkr, bContext *C)
513 Scene *scene = CTX_data_scene(C);
514 bScreen *sc = CTX_wm_screen(C);
516 /* get editmode results */
517 ED_object_exit_editmode(C, 0); /* 0 = does not exit editmode */
519 bkr->sa = sc ? BKE_screen_find_big_area(sc, SPACE_IMAGE, 10) : NULL; /* can be NULL */
520 bkr->main = CTX_data_main(C);
522 bkr->actob = (scene->r.bake_flag & R_BAKE_TO_ACTIVE) ? OBACT : NULL;
523 bkr->re = RE_NewRender("_Bake View_");
525 if (scene->r.bake_mode == RE_BAKE_AO) {
526 /* If raytracing or AO is disabled, switch it on temporarily for baking. */
527 bkr->prev_wo_amb_occ = (scene->world->mode & WO_AMB_OCC) != 0;
528 scene->world->mode |= WO_AMB_OCC;
530 if (scene->r.bake_mode == RE_BAKE_AO || bkr->actob) {
531 bkr->prev_r_raytrace = (scene->r.mode & R_RAYTRACE) != 0;
532 scene->r.mode |= R_RAYTRACE;
536 static void finish_bake_internal(BakeRender *bkr)
540 RE_Database_Free(bkr->re);
542 /* restore raytrace and AO */
543 if (bkr->scene->r.bake_mode == RE_BAKE_AO)
544 if (bkr->prev_wo_amb_occ == 0)
545 bkr->scene->world->mode &= ~WO_AMB_OCC;
547 if (bkr->scene->r.bake_mode == RE_BAKE_AO || bkr->actob)
548 if (bkr->prev_r_raytrace == 0)
549 bkr->scene->r.mode &= ~R_RAYTRACE;
551 /* force OpenGL reload and mipmap recalc */
552 for (ima = G.main->image.first; ima; ima = ima->id.next) {
553 ImBuf *ibuf = BKE_image_acquire_ibuf(ima, NULL, NULL);
555 /* some of the images could have been changed during bake,
556 * so recreate mipmaps regardless bake result status
558 if (ima->ok == IMA_OK_LOADED) {
560 if (ibuf->userflags & IB_BITMAPDIRTY) {
562 imb_freemipmapImBuf(ibuf);
565 /* invalidate display buffers for changed images */
566 if (ibuf->userflags & IB_BITMAPDIRTY)
567 ibuf->userflags |= IB_DISPLAY_BUFFER_INVALID;
571 /* freed when baking is done, but if its canceled we need to free here */
573 if (ibuf->userdata) {
574 MEM_freeN(ibuf->userdata);
575 ibuf->userdata = NULL;
579 BKE_image_release_ibuf(ima, ibuf, NULL);
583 static void *do_bake_render(void *bake_v)
585 BakeRender *bkr = bake_v;
587 bkr->result = RE_bake_shade_all_selected(bkr->re, bkr->scene->r.bake_mode, bkr->actob, NULL, bkr->progress);
593 static void bake_startjob(void *bkv, short *stop, short *do_update, float *progress)
595 BakeRender *bkr = bkv;
596 Scene *scene = bkr->scene;
597 Main *bmain = bkr->main;
600 bkr->do_update = do_update;
601 bkr->progress = progress;
603 RE_test_break_cb(bkr->re, NULL, thread_break);
604 G.is_break = FALSE; /* blender_test_break uses this global */
606 RE_Database_Baking(bkr->re, bmain, scene, scene->lay, scene->r.bake_mode, bkr->actob);
608 /* baking itself is threaded, cannot use test_break in threads. we also update optional imagewindow */
609 bkr->result = RE_bake_shade_all_selected(bkr->re, scene->r.bake_mode, bkr->actob, bkr->do_update, bkr->progress);
612 static void bake_update(void *bkv)
614 BakeRender *bkr = bkv;
616 if (bkr->sa && bkr->sa->spacetype == SPACE_IMAGE) { /* in case the user changed while baking */
617 SpaceImage *sima = bkr->sa->spacedata.first;
619 sima->image = RE_bake_shade_get_image();
623 static void bake_freejob(void *bkv)
625 BakeRender *bkr = bkv;
626 finish_bake_internal(bkr);
628 if (bkr->result == BAKE_RESULT_NO_OBJECTS)
629 BKE_report(bkr->reports, RPT_ERROR, "No objects or images found to bake to");
630 else if (bkr->result == BAKE_RESULT_FEEDBACK_LOOP)
631 BKE_report(bkr->reports, RPT_WARNING, "Feedback loop detected");
634 G.is_rendering = FALSE;
638 static int objects_bake_render_modal(bContext *C, wmOperator *UNUSED(op), wmEvent *event)
640 /* no running blender, remove handler and pass through */
641 if (0 == WM_jobs_test(CTX_wm_manager(C), CTX_data_scene(C), WM_JOB_TYPE_OBJECT_BAKE_TEXTURE))
642 return OPERATOR_FINISHED | OPERATOR_PASS_THROUGH;
645 switch (event->type) {
647 return OPERATOR_RUNNING_MODAL;
650 return OPERATOR_PASS_THROUGH;
653 static int is_multires_bake(Scene *scene)
655 if (ELEM(scene->r.bake_mode, RE_BAKE_NORMALS, RE_BAKE_DISPLACEMENT))
656 return scene->r.bake_flag & R_BAKE_MULTIRES;
661 static int objects_bake_render_invoke(bContext *C, wmOperator *op, wmEvent *UNUSED(_event))
663 Scene *scene = CTX_data_scene(C);
664 int result = OPERATOR_CANCELLED;
666 if (is_multires_bake(scene)) {
667 result = multiresbake_image_exec(C, op);
670 /* only one render job at a time */
671 if (WM_jobs_test(CTX_wm_manager(C), scene, WM_JOB_TYPE_OBJECT_BAKE_TEXTURE))
672 return OPERATOR_CANCELLED;
674 if (test_bake_internal(C, op->reports) == 0) {
675 return OPERATOR_CANCELLED;
678 BakeRender *bkr = MEM_callocN(sizeof(BakeRender), "render bake");
681 init_bake_internal(bkr, C);
682 bkr->reports = op->reports;
685 wm_job = WM_jobs_get(CTX_wm_manager(C), CTX_wm_window(C), scene, "Texture Bake",
686 WM_JOB_EXCL_RENDER | WM_JOB_PRIORITY | WM_JOB_PROGRESS, WM_JOB_TYPE_OBJECT_BAKE_TEXTURE);
687 WM_jobs_customdata_set(wm_job, bkr, bake_freejob);
688 WM_jobs_timer(wm_job, 0.2, NC_IMAGE, 0); /* TODO - only draw bake image, can we enforce this */
689 WM_jobs_callbacks(wm_job, bake_startjob, NULL, bake_update, NULL);
692 G.is_rendering = TRUE;
694 WM_jobs_start(CTX_wm_manager(C), wm_job);
698 /* add modal handler for ESC */
699 WM_event_add_modal_handler(C, op);
702 result = OPERATOR_RUNNING_MODAL;
705 WM_event_add_notifier(C, NC_SCENE | ND_RENDER_RESULT, scene);
711 static int bake_image_exec(bContext *C, wmOperator *op)
713 Main *bmain = CTX_data_main(C);
714 Scene *scene = CTX_data_scene(C);
715 int result = OPERATOR_CANCELLED;
717 if (is_multires_bake(scene)) {
718 result = multiresbake_image_exec_locked(C, op);
721 if (test_bake_internal(C, op->reports) == 0) {
722 return OPERATOR_CANCELLED;
726 BakeRender bkr = {NULL};
728 init_bake_internal(&bkr, C);
729 bkr.reports = op->reports;
731 RE_test_break_cb(bkr.re, NULL, thread_break);
732 G.is_break = FALSE; /* blender_test_break uses this global */
734 RE_Database_Baking(bkr.re, bmain, scene, scene->lay, scene->r.bake_mode, (scene->r.bake_flag & R_BAKE_TO_ACTIVE) ? OBACT : NULL);
736 /* baking itself is threaded, cannot use test_break in threads */
737 BLI_init_threads(&threads, do_bake_render, 1);
739 BLI_insert_thread(&threads, &bkr);
741 while (bkr.ready == 0) {
746 /* used to redraw in 2.4x but this is just for exec in 2.5 */
748 blender_test_break();
750 BLI_end_threads(&threads);
752 if (bkr.result == BAKE_RESULT_NO_OBJECTS)
753 BKE_report(op->reports, RPT_ERROR, "No valid images found to bake to");
754 else if (bkr.result == BAKE_RESULT_FEEDBACK_LOOP)
755 BKE_report(op->reports, RPT_ERROR, "Feedback loop detected");
757 finish_bake_internal(&bkr);
759 result = OPERATOR_FINISHED;
763 WM_event_add_notifier(C, NC_SCENE | ND_RENDER_RESULT, scene);
768 void OBJECT_OT_bake_image(wmOperatorType *ot)
772 ot->description = "Bake image textures of selected objects";
773 ot->idname = "OBJECT_OT_bake_image";
776 ot->exec = bake_image_exec;
777 ot->invoke = objects_bake_render_invoke;
778 ot->modal = objects_bake_render_modal;