fc2f7e4064559c42c9e9b7c574c8d7c21c125965
[blender.git] / source / blender / editors / physics / physics_pointcache.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2007 by Janne Karhu.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/editors/physics/physics_pointcache.c
29  *  \ingroup edphys
30  */
31
32 #include <stdlib.h>
33 #include <string.h>
34
35 #include "MEM_guardedalloc.h"
36
37 #include "BLI_blenlib.h"
38 #include "BLI_utildefines.h"
39
40 #include "DNA_scene_types.h"
41
42 #include "BKE_context.h"
43 #include "BKE_screen.h"
44 #include "BKE_global.h"
45 #include "BKE_main.h"
46 #include "BKE_particle.h"
47 #include "BKE_pointcache.h"
48
49 #include "ED_particle.h"
50
51 #include "WM_api.h"
52 #include "WM_types.h"
53
54 #include "RNA_access.h"
55 #include "RNA_define.h"
56
57 #include "physics_intern.h"
58
59 static int ptcache_bake_all_poll(bContext *C)
60 {
61         return CTX_data_scene(C) != NULL;
62 }
63
64 static int ptcache_poll(bContext *C)
65 {
66         PointerRNA ptr= CTX_data_pointer_get_type(C, "point_cache", &RNA_PointCache);
67         return (ptr.data && ptr.id.data);
68 }
69
70 typedef struct PointCacheJob {
71         void *owner;
72         short *stop, *do_update;
73         float *progress;
74
75         PTCacheBaker *baker;
76 } PointCacheJob;
77
78 static void ptcache_job_free(void *customdata)
79 {
80         PointCacheJob *job = customdata;
81         MEM_freeN(job->baker);
82         MEM_freeN(job);
83 }
84
85 static int ptcache_job_break(void *customdata)
86 {
87         PointCacheJob *job = customdata;
88
89         if (G.is_break) {
90                 return 1;
91         }
92
93         if (job->stop && *(job->stop)) {
94                 return 1;
95         }
96
97         return 0;
98 }
99
100 static void ptcache_job_update(void *customdata, float progress, int *cancel)
101 {
102         PointCacheJob *job = customdata;
103
104         if (ptcache_job_break(job)) {
105                 *cancel = 1;
106         }
107
108         *(job->do_update) = true;
109         *(job->progress) = progress;
110 }
111
112 static void ptcache_job_startjob(void *customdata, short *stop, short *do_update, float *progress)
113 {
114         PointCacheJob *job = customdata;
115
116         job->stop = stop;
117         job->do_update = do_update;
118         job->progress = progress;
119
120         G.is_break = false;
121
122         /* XXX annoying hack: needed to prevent data corruption when changing
123          * scene frame in separate threads
124          */
125         G.is_rendering = true;
126         BKE_spacedata_draw_locks(true);
127
128         BKE_ptcache_bake(job->baker);
129
130         *do_update = true;
131         *stop = 0;
132 }
133
134 static void ptcache_job_endjob(void *customdata)
135 {
136         PointCacheJob *job = customdata;
137         Scene *scene = job->baker->scene;
138
139         G.is_rendering = false;
140         BKE_spacedata_draw_locks(false);
141
142         WM_set_locked_interface(G.main->wm.first, false);
143
144         WM_main_add_notifier(NC_SCENE | ND_FRAME, scene);
145         WM_main_add_notifier(NC_OBJECT | ND_POINTCACHE, job->baker->pid.ob);
146 }
147
148 static void ptcache_free_bake(PointCache *cache)
149 {
150         if (cache->edit) {
151                 if (!cache->edit->edited || 1) {// XXX okee("Lose changes done in particle mode?")) {
152                         PE_free_ptcache_edit(cache->edit);
153                         cache->edit = NULL;
154                         cache->flag &= ~PTCACHE_BAKED;
155                 }
156         }
157         else {
158                 cache->flag &= ~PTCACHE_BAKED;
159         }
160 }
161
162 static PTCacheBaker *ptcache_baker_create(bContext *C, wmOperator *op, bool all)
163 {
164         PTCacheBaker *baker = MEM_callocN(sizeof(PTCacheBaker), "PTCacheBaker");
165
166         baker->bmain = CTX_data_main(C);
167         baker->scene = CTX_data_scene(C);
168         baker->bake = RNA_boolean_get(op->ptr, "bake");
169         baker->render = 0;
170         baker->anim_init = 0;
171         baker->quick_step = 1;
172
173         if (!all) {
174                 PointerRNA ptr = CTX_data_pointer_get_type(C, "point_cache", &RNA_PointCache);
175                 Object *ob = ptr.id.data;
176                 PointCache *cache = ptr.data;
177
178                 ListBase pidlist;
179                 BKE_ptcache_ids_from_object(&pidlist, ob, baker->scene, MAX_DUPLI_RECUR);
180
181                 for (PTCacheID *pid = pidlist.first; pid; pid = pid->next) {
182                         if (pid->cache == cache) {
183                                 baker->pid = *pid;
184                                 break;
185                         }
186                 }
187
188                 BLI_freelistN(&pidlist);
189         }
190
191         return baker;
192 }
193
194 static int ptcache_bake_exec(bContext *C, wmOperator *op)
195 {
196         bool all = STREQ(op->type->idname, "PTCACHE_OT_bake_all");
197
198         PTCacheBaker *baker = ptcache_baker_create(C, op, all);
199         BKE_ptcache_bake(baker);
200         MEM_freeN(baker);
201
202         return OPERATOR_FINISHED;
203 }
204
205 static int ptcache_bake_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
206 {
207         bool all = STREQ(op->type->idname, "PTCACHE_OT_bake_all");
208
209         PointCacheJob *job = MEM_mallocN(sizeof(PointCacheJob), "PointCacheJob");
210         job->baker = ptcache_baker_create(C, op, all);
211         job->baker->bake_job = job;
212         job->baker->update_progress = ptcache_job_update;
213
214         wmJob *wm_job = WM_jobs_get(CTX_wm_manager(C), CTX_wm_window(C), CTX_data_scene(C),
215                                     "Point Cache", WM_JOB_PROGRESS, WM_JOB_TYPE_POINTCACHE);
216
217         WM_jobs_customdata_set(wm_job, job, ptcache_job_free);
218         WM_jobs_timer(wm_job, 0.1, NC_OBJECT | ND_POINTCACHE, NC_OBJECT | ND_POINTCACHE);
219         WM_jobs_callbacks(wm_job, ptcache_job_startjob, NULL, NULL, ptcache_job_endjob);
220
221         WM_set_locked_interface(CTX_wm_manager(C), true);
222
223         WM_jobs_start(CTX_wm_manager(C), wm_job);
224
225         WM_event_add_modal_handler(C, op);
226
227         /* we must run modal until the bake job is done, otherwise the undo push
228          * happens before the job ends, which can lead to race conditions between
229          * the baking and file writing code */
230         return OPERATOR_RUNNING_MODAL;
231 }
232
233 static int ptcache_bake_modal(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
234 {
235         Scene *scene = (Scene *) op->customdata;
236
237         /* no running blender, remove handler and pass through */
238         if (0 == WM_jobs_test(CTX_wm_manager(C), scene, WM_JOB_TYPE_POINTCACHE)) {
239                 return OPERATOR_FINISHED | OPERATOR_PASS_THROUGH;
240         }
241
242         return OPERATOR_PASS_THROUGH;
243 }
244
245 static void ptcache_bake_cancel(bContext *C, wmOperator *op)
246 {
247         wmWindowManager *wm = CTX_wm_manager(C);
248         Scene *scene = (Scene *) op->customdata;
249
250         /* kill on cancel, because job is using op->reports */
251         WM_jobs_kill_type(wm, scene, WM_JOB_TYPE_POINTCACHE);
252 }
253
254 static int ptcache_free_bake_all_exec(bContext *C, wmOperator *UNUSED(op))
255 {
256         Scene *scene= CTX_data_scene(C);
257         Base *base;
258         PTCacheID *pid;
259         ListBase pidlist;
260
261         for (base=scene->base.first; base; base= base->next) {
262                 BKE_ptcache_ids_from_object(&pidlist, base->object, scene, MAX_DUPLI_RECUR);
263
264                 for (pid=pidlist.first; pid; pid=pid->next) {
265                         ptcache_free_bake(pid->cache);
266                 }
267
268                 BLI_freelistN(&pidlist);
269
270                 WM_event_add_notifier(C, NC_OBJECT|ND_POINTCACHE, base->object);
271         }
272
273         WM_event_add_notifier(C, NC_SCENE|ND_FRAME, scene);
274
275         return OPERATOR_FINISHED;
276 }
277
278 void PTCACHE_OT_bake_all(wmOperatorType *ot)
279 {
280         /* identifiers */
281         ot->name = "Bake All Physics";
282         ot->description = "Bake all physics";
283         ot->idname = "PTCACHE_OT_bake_all";
284
285         /* api callbacks */
286         ot->exec = ptcache_bake_exec;
287         ot->invoke = ptcache_bake_invoke;
288         ot->modal = ptcache_bake_modal;
289         ot->cancel = ptcache_bake_cancel;
290         ot->poll = ptcache_bake_all_poll;
291
292         /* flags */
293         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
294
295         RNA_def_boolean(ot->srna, "bake", 1, "Bake", "");
296 }
297 void PTCACHE_OT_free_bake_all(wmOperatorType *ot)
298 {
299         /* identifiers */
300         ot->name = "Free All Physics Bakes";
301         ot->idname = "PTCACHE_OT_free_bake_all";
302         ot->description = "Free all baked caches of all objects in the current scene";
303
304         /* api callbacks */
305         ot->exec = ptcache_free_bake_all_exec;
306         ot->poll = ptcache_bake_all_poll;
307
308         /* flags */
309         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
310 }
311
312 static int ptcache_free_bake_exec(bContext *C, wmOperator *UNUSED(op))
313 {
314         PointerRNA ptr= CTX_data_pointer_get_type(C, "point_cache", &RNA_PointCache);
315         PointCache *cache= ptr.data;
316         Object *ob= ptr.id.data;
317
318         ptcache_free_bake(cache);
319
320         WM_event_add_notifier(C, NC_OBJECT|ND_POINTCACHE, ob);
321
322         return OPERATOR_FINISHED;
323 }
324 static int ptcache_bake_from_cache_exec(bContext *C, wmOperator *UNUSED(op))
325 {
326         PointerRNA ptr= CTX_data_pointer_get_type(C, "point_cache", &RNA_PointCache);
327         PointCache *cache= ptr.data;
328         Object *ob= ptr.id.data;
329
330         cache->flag |= PTCACHE_BAKED;
331
332         WM_event_add_notifier(C, NC_OBJECT|ND_POINTCACHE, ob);
333
334         return OPERATOR_FINISHED;
335 }
336 void PTCACHE_OT_bake(wmOperatorType *ot)
337 {
338         /* identifiers */
339         ot->name = "Bake Physics";
340         ot->description = "Bake physics";
341         ot->idname = "PTCACHE_OT_bake";
342
343         /* api callbacks */
344         ot->exec = ptcache_bake_exec;
345         ot->invoke = ptcache_bake_invoke;
346         ot->modal = ptcache_bake_modal;
347         ot->cancel = ptcache_bake_cancel;
348         ot->poll = ptcache_poll;
349
350         /* flags */
351         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
352
353         RNA_def_boolean(ot->srna, "bake", 0, "Bake", "");
354 }
355 void PTCACHE_OT_free_bake(wmOperatorType *ot)
356 {
357         /* identifiers */
358         ot->name = "Free Physics Bake";
359         ot->description = "Free physics bake";
360         ot->idname = "PTCACHE_OT_free_bake";
361
362         /* api callbacks */
363         ot->exec = ptcache_free_bake_exec;
364         ot->poll = ptcache_poll;
365
366         /* flags */
367         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
368 }
369 void PTCACHE_OT_bake_from_cache(wmOperatorType *ot)
370 {
371         /* identifiers */
372         ot->name = "Bake From Cache";
373         ot->description = "Bake from cache";
374         ot->idname = "PTCACHE_OT_bake_from_cache";
375
376         /* api callbacks */
377         ot->exec = ptcache_bake_from_cache_exec;
378         ot->poll = ptcache_poll;
379
380         /* flags */
381         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
382 }
383
384 static int ptcache_add_new_exec(bContext *C, wmOperator *UNUSED(op))
385 {
386         Scene *scene = CTX_data_scene(C);
387         PointerRNA ptr= CTX_data_pointer_get_type(C, "point_cache", &RNA_PointCache);
388         Object *ob= ptr.id.data;
389         PointCache *cache= ptr.data;
390         PTCacheID *pid;
391         ListBase pidlist;
392
393         BKE_ptcache_ids_from_object(&pidlist, ob, scene, MAX_DUPLI_RECUR);
394
395         for (pid=pidlist.first; pid; pid=pid->next) {
396                 if (pid->cache == cache) {
397                         PointCache *cache_new = BKE_ptcache_add(pid->ptcaches);
398                         cache_new->step = pid->default_step;
399                         *(pid->cache_ptr) = cache_new;
400                         break;
401                 }
402         }
403
404         BLI_freelistN(&pidlist);
405
406         WM_event_add_notifier(C, NC_SCENE|ND_FRAME, scene);
407         WM_event_add_notifier(C, NC_OBJECT|ND_POINTCACHE, ob);
408
409         return OPERATOR_FINISHED;
410 }
411 static int ptcache_remove_exec(bContext *C, wmOperator *UNUSED(op))
412 {
413         PointerRNA ptr= CTX_data_pointer_get_type(C, "point_cache", &RNA_PointCache);
414         Scene *scene= CTX_data_scene(C);
415         Object *ob= ptr.id.data;
416         PointCache *cache= ptr.data;
417         PTCacheID *pid;
418         ListBase pidlist;
419
420         BKE_ptcache_ids_from_object(&pidlist, ob, scene, MAX_DUPLI_RECUR);
421
422         for (pid=pidlist.first; pid; pid=pid->next) {
423                 if (pid->cache == cache) {
424                         if (pid->ptcaches->first == pid->ptcaches->last)
425                                 continue; /* don't delete last cache */
426
427                         BLI_remlink(pid->ptcaches, pid->cache);
428                         BKE_ptcache_free(pid->cache);
429                         *(pid->cache_ptr) = pid->ptcaches->first;
430
431                         break;
432                 }
433         }
434
435         BLI_freelistN(&pidlist);
436
437         WM_event_add_notifier(C, NC_OBJECT|ND_POINTCACHE, ob);
438
439         return OPERATOR_FINISHED;
440 }
441 void PTCACHE_OT_add(wmOperatorType *ot)
442 {
443         /* identifiers */
444         ot->name = "Add New Cache";
445         ot->description = "Add new cache";
446         ot->idname = "PTCACHE_OT_add";
447
448         /* api callbacks */
449         ot->exec = ptcache_add_new_exec;
450         ot->poll = ptcache_poll;
451
452         /* flags */
453         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
454 }
455 void PTCACHE_OT_remove(wmOperatorType *ot)
456 {
457         /* identifiers */
458         ot->name = "Delete Current Cache";
459         ot->description = "Delete current cache";
460         ot->idname = "PTCACHE_OT_remove";
461
462         /* api callbacks */
463         ot->exec = ptcache_remove_exec;
464         ot->poll = ptcache_poll;
465
466         /* flags */
467         ot->flag = OPTYPE_REGISTER|OPTYPE_UNDO;
468 }
469