Cleanup: avoid function call for pointer compare
[blender.git] / source / blender / blenkernel / intern / anim_sys.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) 2009 Blender Foundation, Joshua Leung
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Joshua Leung (full recode)
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenkernel/intern/anim_sys.c
29  *  \ingroup bke
30  */
31
32
33 #include <stdio.h>
34 #include <string.h>
35 #include <stddef.h>
36 #include <float.h>
37 #include <math.h>
38
39 #include "MEM_guardedalloc.h"
40
41 #include "BLI_utildefines.h"
42 #include "BLI_blenlib.h"
43 #include "BLI_alloca.h"
44 #include "BLI_dynstr.h"
45 #include "BLI_listbase.h"
46 #include "BLI_string_utils.h"
47
48 #include "BLT_translation.h"
49
50 #include "DNA_anim_types.h"
51 #include "DNA_lamp_types.h"
52 #include "DNA_material_types.h"
53 #include "DNA_object_types.h"
54 #include "DNA_scene_types.h"
55 #include "DNA_screen_types.h"
56 #include "DNA_space_types.h"
57 #include "DNA_texture_types.h"
58 #include "DNA_world_types.h"
59
60 #include "BKE_action.h"
61 #include "BKE_animsys.h"
62 #include "BKE_context.h"
63 #include "BKE_fcurve.h"
64 #include "BKE_global.h"
65 #include "BKE_library.h"
66 #include "BKE_main.h"
67 #include "BKE_material.h"
68 #include "BKE_nla.h"
69 #include "BKE_report.h"
70 #include "BKE_texture.h"
71
72 #include "DEG_depsgraph.h"
73 #include "DEG_depsgraph_query.h"
74
75 #include "RNA_access.h"
76
77 #include "nla_private.h"
78
79 #include "atomic_ops.h"
80
81 /* ***************************************** */
82 /* AnimData API */
83
84 /* Getter/Setter -------------------------------------------- */
85
86 /* Check if ID can have AnimData */
87 bool id_type_can_have_animdata(const short id_type)
88 {
89         /* Only some ID-blocks have this info for now */
90         /* TODO: finish adding this for the other blocktypes */
91         switch (id_type) {
92                 /* has AnimData */
93                 case ID_OB:
94                 case ID_ME: case ID_MB: case ID_CU: case ID_AR: case ID_LT:
95                 case ID_KE:
96                 case ID_PA:
97                 case ID_MA: case ID_TE: case ID_NT:
98                 case ID_LA: case ID_CA: case ID_WO:
99                 case ID_LS:
100                 case ID_LP:
101                 case ID_SPK:
102                 case ID_SCE:
103                 case ID_MC:
104                 case ID_MSK:
105                 case ID_GD:
106                 case ID_CF:
107                         return true;
108
109                 /* no AnimData */
110                 default:
111                         return false;
112         }
113 }
114
115 bool id_can_have_animdata(const ID *id)
116 {
117         /* sanity check */
118         if (id == NULL)
119                 return false;
120
121         return id_type_can_have_animdata(GS(id->name));
122 }
123
124 /* Get AnimData from the given ID-block. In order for this to work, we assume that
125  * the AnimData pointer is stored immediately after the given ID-block in the struct,
126  * as per IdAdtTemplate.
127  */
128 AnimData *BKE_animdata_from_id(ID *id)
129 {
130         /* only some ID-blocks have this info for now, so we cast the
131          * types that do to be of type IdAdtTemplate, and extract the
132          * AnimData that way
133          */
134         if (id_can_have_animdata(id)) {
135                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
136                 return iat->adt;
137         }
138         else
139                 return NULL;
140 }
141
142 /* Add AnimData to the given ID-block. In order for this to work, we assume that
143  * the AnimData pointer is stored immediately after the given ID-block in the struct,
144  * as per IdAdtTemplate. Also note that
145  */
146 AnimData *BKE_animdata_add_id(ID *id)
147 {
148         /* Only some ID-blocks have this info for now, so we cast the
149          * types that do to be of type IdAdtTemplate, and add the AnimData
150          * to it using the template
151          */
152         if (id_can_have_animdata(id)) {
153                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
154
155                 /* check if there's already AnimData, in which case, don't add */
156                 if (iat->adt == NULL) {
157                         AnimData *adt;
158
159                         /* add animdata */
160                         adt = iat->adt = MEM_callocN(sizeof(AnimData), "AnimData");
161
162                         /* set default settings */
163                         adt->act_influence = 1.0f;
164                 }
165
166                 return iat->adt;
167         }
168         else
169                 return NULL;
170 }
171
172 /* Action Setter --------------------------------------- */
173
174 /* Called when user tries to change the active action of an AnimData block (via RNA, Outliner, etc.) */
175 bool BKE_animdata_set_action(ReportList *reports, ID *id, bAction *act)
176 {
177         AnimData *adt = BKE_animdata_from_id(id);
178         bool ok = false;
179
180         /* animdata validity check */
181         if (adt == NULL) {
182                 BKE_report(reports, RPT_WARNING, "No AnimData to set action on");
183                 return ok;
184         }
185
186         /* active action is only editable when it is not a tweaking strip
187          * see rna_AnimData_action_editable() in rna_animation.c
188          */
189         if ((adt->flag & ADT_NLA_EDIT_ON) || (adt->actstrip) || (adt->tmpact)) {
190                 /* cannot remove, otherwise things turn to custard */
191                 BKE_report(reports, RPT_ERROR, "Cannot change action, as it is still being edited in NLA");
192                 return ok;
193         }
194
195         /* manage usercount for current action */
196         if (adt->action)
197                 id_us_min((ID *)adt->action);
198
199         /* assume that AnimData's action can in fact be edited... */
200         if (act) {
201                 /* action must have same type as owner */
202                 if (ELEM(act->idroot, 0, GS(id->name))) {
203                         /* can set */
204                         adt->action = act;
205                         id_us_plus((ID *)adt->action);
206                         ok = true;
207                 }
208                 else {
209                         /* cannot set */
210                         BKE_reportf(reports, RPT_ERROR,
211                                     "Could not set action '%s' onto ID '%s', as it does not have suitably rooted paths "
212                                     "for this purpose", act->id.name + 2, id->name);
213                         /* ok = false; */
214                 }
215         }
216         else {
217                 /* just clearing the action... */
218                 adt->action = NULL;
219                 ok = true;
220         }
221
222         return ok;
223 }
224
225 /* Freeing -------------------------------------------- */
226
227 /* Free AnimData used by the nominated ID-block, and clear ID-block's AnimData pointer */
228 void BKE_animdata_free(ID *id, const bool do_id_user)
229 {
230         /* Only some ID-blocks have this info for now, so we cast the
231          * types that do to be of type IdAdtTemplate
232          */
233         if (id_can_have_animdata(id)) {
234                 IdAdtTemplate *iat = (IdAdtTemplate *)id;
235                 AnimData *adt = iat->adt;
236
237                 /* check if there's any AnimData to start with */
238                 if (adt) {
239                         if (do_id_user) {
240                                 /* unlink action (don't free, as it's in its own list) */
241                                 if (adt->action)
242                                         id_us_min(&adt->action->id);
243                                 /* same goes for the temporarily displaced action */
244                                 if (adt->tmpact)
245                                         id_us_min(&adt->tmpact->id);
246                         }
247
248                         /* free nla data */
249                         BKE_nla_tracks_free(&adt->nla_tracks, do_id_user);
250
251                         /* free drivers - stored as a list of F-Curves */
252                         free_fcurves(&adt->drivers);
253
254                         /* free driver array cache */
255                         MEM_SAFE_FREE(adt->driver_array);
256
257                         /* free overrides */
258                         /* TODO... */
259
260                         /* free animdata now */
261                         MEM_freeN(adt);
262                         iat->adt = NULL;
263                 }
264         }
265 }
266
267 /* Copying -------------------------------------------- */
268
269 /**
270  * Make a copy of the given AnimData - to be used when copying datablocks.
271  * \param flag: Control ID pointers management, see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_library.h
272  * \return The copied animdata.
273  */
274 AnimData *BKE_animdata_copy(Main *bmain, AnimData *adt, const int flag)
275 {
276         AnimData *dadt;
277
278         const bool do_action = (flag & LIB_ID_COPY_ACTIONS) != 0 && (flag & LIB_ID_CREATE_NO_MAIN) == 0;
279         const bool do_id_user = (flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0;
280
281         /* sanity check before duplicating struct */
282         if (adt == NULL)
283                 return NULL;
284         dadt = MEM_dupallocN(adt);
285
286         /* make a copy of action - at worst, user has to delete copies... */
287         if (do_action) {
288                 BLI_assert(bmain != NULL);
289                 BKE_id_copy_ex(bmain, (ID *)dadt->action, (ID **)&dadt->action, 0, false);
290                 BKE_id_copy_ex(bmain, (ID *)dadt->tmpact, (ID **)&dadt->tmpact, 0, false);
291         }
292         else if (do_id_user) {
293                 id_us_plus((ID *)dadt->action);
294                 id_us_plus((ID *)dadt->tmpact);
295         }
296
297         /* duplicate NLA data */
298         BKE_nla_tracks_copy(bmain, &dadt->nla_tracks, &adt->nla_tracks, flag);
299
300         /* duplicate drivers (F-Curves) */
301         copy_fcurves(&dadt->drivers, &adt->drivers);
302         dadt->driver_array = NULL;
303
304         /* don't copy overrides */
305         BLI_listbase_clear(&dadt->overrides);
306
307         /* return */
308         return dadt;
309 }
310
311 /**
312  * \param flag: Control ID pointers management, see LIB_ID_CREATE_.../LIB_ID_COPY_... flags in BKE_library.h
313  * \return true is succesfully copied.
314  */
315 bool BKE_animdata_copy_id(Main *bmain, ID *id_to, ID *id_from, const int flag)
316 {
317         AnimData *adt;
318
319         if ((id_to && id_from) && (GS(id_to->name) != GS(id_from->name)))
320                 return false;
321
322         BKE_animdata_free(id_to, (flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0);
323
324         adt = BKE_animdata_from_id(id_from);
325         if (adt) {
326                 IdAdtTemplate *iat = (IdAdtTemplate *)id_to;
327                 iat->adt = BKE_animdata_copy(bmain, adt, flag);
328         }
329
330         return true;
331 }
332
333 void BKE_animdata_copy_id_action(Main *bmain, ID *id, const bool set_newid)
334 {
335         AnimData *adt = BKE_animdata_from_id(id);
336         if (adt) {
337                 if (adt->action) {
338                         id_us_min((ID *)adt->action);
339                         adt->action = set_newid ? ID_NEW_SET(adt->action, BKE_action_copy(bmain, adt->action)) :
340                                                   BKE_action_copy(bmain, adt->action);
341                 }
342                 if (adt->tmpact) {
343                         id_us_min((ID *)adt->tmpact);
344                         adt->tmpact = set_newid ? ID_NEW_SET(adt->tmpact, BKE_action_copy(bmain, adt->tmpact)) :
345                                                   BKE_action_copy(bmain, adt->tmpact);
346                 }
347         }
348 }
349
350 /* Merge copies of the data from the src AnimData into the destination AnimData */
351 void BKE_animdata_merge_copy(
352         Main *bmain, ID *dst_id, ID *src_id,
353         eAnimData_MergeCopy_Modes action_mode, bool fix_drivers)
354 {
355         AnimData *src = BKE_animdata_from_id(src_id);
356         AnimData *dst = BKE_animdata_from_id(dst_id);
357
358         /* sanity checks */
359         if (ELEM(NULL, dst, src))
360                 return;
361
362         // TODO: we must unset all "tweakmode" flags
363         if ((src->flag & ADT_NLA_EDIT_ON) || (dst->flag & ADT_NLA_EDIT_ON)) {
364                 printf("ERROR: Merging AnimData blocks while editing NLA is dangerous as it may cause data corruption\n");
365                 return;
366         }
367
368         /* handle actions... */
369         if (action_mode == ADT_MERGECOPY_SRC_COPY) {
370                 /* make a copy of the actions */
371                 dst->action = BKE_action_copy(bmain, src->action);
372                 dst->tmpact = BKE_action_copy(bmain, src->tmpact);
373         }
374         else if (action_mode == ADT_MERGECOPY_SRC_REF) {
375                 /* make a reference to it */
376                 dst->action = src->action;
377                 id_us_plus((ID *)dst->action);
378
379                 dst->tmpact = src->tmpact;
380                 id_us_plus((ID *)dst->tmpact);
381         }
382
383         /* duplicate NLA data */
384         if (src->nla_tracks.first) {
385                 ListBase tracks = {NULL, NULL};
386
387                 BKE_nla_tracks_copy(bmain, &tracks, &src->nla_tracks, 0);
388                 BLI_movelisttolist(&dst->nla_tracks, &tracks);
389         }
390
391         /* duplicate drivers (F-Curves) */
392         if (src->drivers.first) {
393                 ListBase drivers = {NULL, NULL};
394
395                 copy_fcurves(&drivers, &src->drivers);
396
397                 /* Fix up all driver targets using the old target id
398                  * - This assumes that the src ID is being merged into the dst ID
399                  */
400                 if (fix_drivers) {
401                         FCurve *fcu;
402
403                         for (fcu = drivers.first; fcu; fcu = fcu->next) {
404                                 ChannelDriver *driver = fcu->driver;
405                                 DriverVar *dvar;
406
407                                 for (dvar = driver->variables.first; dvar; dvar = dvar->next) {
408                                         DRIVER_TARGETS_USED_LOOPER_BEGIN(dvar)
409                                         {
410                                                 if (dtar->id == src_id) {
411                                                         dtar->id = dst_id;
412                                                 }
413                                         }
414                                         DRIVER_TARGETS_LOOPER_END;
415                                 }
416                         }
417                 }
418
419                 BLI_movelisttolist(&dst->drivers, &drivers);
420         }
421 }
422
423 /* Sub-ID Regrouping ------------------------------------------- */
424
425 /**
426  * Helper heuristic for determining if a path is compatible with the basepath
427  *
428  * \param path: Full RNA-path from some data (usually an F-Curve) to compare
429  * \param basepath: Shorter path fragment to look for
430  * \return Whether there is a match
431  */
432 static bool animpath_matches_basepath(const char path[], const char basepath[])
433 {
434         /* we need start of path to be basepath */
435         return (path && basepath) && STRPREFIX(path, basepath);
436 }
437
438 /* Move F-Curves in src action to dst action, setting up all the necessary groups
439  * for this to happen, but only if the F-Curves being moved have the appropriate
440  * "base path".
441  * - This is used when data moves from one datablock to another, causing the
442  *   F-Curves to need to be moved over too
443  */
444 void action_move_fcurves_by_basepath(bAction *srcAct, bAction *dstAct, const char basepath[])
445 {
446         FCurve *fcu, *fcn = NULL;
447
448         /* sanity checks */
449         if (ELEM(NULL, srcAct, dstAct, basepath)) {
450                 if (G.debug & G_DEBUG) {
451                         printf("ERROR: action_partition_fcurves_by_basepath(%p, %p, %p) has insufficient info to work with\n",
452                                (void *)srcAct, (void *)dstAct, (void *)basepath);
453                 }
454                 return;
455         }
456
457         /* clear 'temp' flags on all groups in src, as we'll be needing them later
458          * to identify groups that we've managed to empty out here
459          */
460         action_groups_clear_tempflags(srcAct);
461
462         /* iterate over all src F-Curves, moving over the ones that need to be moved */
463         for (fcu = srcAct->curves.first; fcu; fcu = fcn) {
464                 /* store next pointer in case we move stuff */
465                 fcn = fcu->next;
466
467                 /* should F-Curve be moved over?
468                  * - we only need the start of the path to match basepath
469                  */
470                 if (animpath_matches_basepath(fcu->rna_path, basepath)) {
471                         bActionGroup *agrp = NULL;
472
473                         /* if grouped... */
474                         if (fcu->grp) {
475                                 /* make sure there will be a matching group on the other side for the migrants */
476                                 agrp = BKE_action_group_find_name(dstAct, fcu->grp->name);
477
478                                 if (agrp == NULL) {
479                                         /* add a new one with a similar name (usually will be the same though) */
480                                         agrp = action_groups_add_new(dstAct, fcu->grp->name);
481                                 }
482
483                                 /* old groups should be tagged with 'temp' flags so they can be removed later
484                                  * if we remove everything from them
485                                  */
486                                 fcu->grp->flag |= AGRP_TEMP;
487                         }
488
489                         /* perform the migration now */
490                         action_groups_remove_channel(srcAct, fcu);
491
492                         if (agrp)
493                                 action_groups_add_channel(dstAct, agrp, fcu);
494                         else
495                                 BLI_addtail(&dstAct->curves, fcu);
496                 }
497         }
498
499         /* cleanup groups (if present) */
500         if (srcAct->groups.first) {
501                 bActionGroup *agrp, *grp = NULL;
502
503                 for (agrp = srcAct->groups.first; agrp; agrp = grp) {
504                         grp = agrp->next;
505
506                         /* only tagged groups need to be considered - clearing these tags or removing them */
507                         if (agrp->flag & AGRP_TEMP) {
508                                 /* if group is empty and tagged, then we can remove as this operation
509                                  * moved out all the channels that were formerly here
510                                  */
511                                 if (BLI_listbase_is_empty(&agrp->channels))
512                                         BLI_freelinkN(&srcAct->groups, agrp);
513                                 else
514                                         agrp->flag &= ~AGRP_TEMP;
515                         }
516                 }
517         }
518 }
519
520 /* Transfer the animation data from srcID to dstID where the srcID
521  * animation data is based off "basepath", creating new AnimData and
522  * associated data as necessary
523  */
524 void BKE_animdata_separate_by_basepath(
525         Main *bmain, ID *srcID, ID *dstID, ListBase *basepaths)
526 {
527         AnimData *srcAdt = NULL, *dstAdt = NULL;
528         LinkData *ld;
529
530         /* sanity checks */
531         if (ELEM(NULL, srcID, dstID)) {
532                 if (G.debug & G_DEBUG)
533                         printf("ERROR: no source or destination ID to separate AnimData with\n");
534                 return;
535         }
536
537         /* get animdata from src, and create for destination (if needed) */
538         srcAdt = BKE_animdata_from_id(srcID);
539         dstAdt = BKE_animdata_add_id(dstID);
540
541         if (ELEM(NULL, srcAdt, dstAdt)) {
542                 if (G.debug & G_DEBUG)
543                         printf("ERROR: no AnimData for this pair of ID's\n");
544                 return;
545         }
546
547         /* active action */
548         if (srcAdt->action) {
549                 /* set up an action if necessary, and name it in a similar way so that it can be easily found again */
550                 if (dstAdt->action == NULL) {
551                         dstAdt->action = BKE_action_add(bmain, srcAdt->action->id.name + 2);
552                 }
553                 else if (dstAdt->action == srcAdt->action) {
554                         printf("Argh! Source and Destination share animation! ('%s' and '%s' both use '%s') Making new empty action\n",
555                                srcID->name, dstID->name, srcAdt->action->id.name);
556
557                         /* TODO: review this... */
558                         id_us_min(&dstAdt->action->id);
559                         dstAdt->action = BKE_action_add(bmain, dstAdt->action->id.name + 2);
560                 }
561
562                 /* loop over base paths, trying to fix for each one... */
563                 for (ld = basepaths->first; ld; ld = ld->next) {
564                         const char *basepath = (const char *)ld->data;
565                         action_move_fcurves_by_basepath(srcAdt->action, dstAdt->action, basepath);
566                 }
567         }
568
569         /* drivers */
570         if (srcAdt->drivers.first) {
571                 FCurve *fcu, *fcn = NULL;
572
573                 /* check each driver against all the base paths to see if any should go */
574                 for (fcu = srcAdt->drivers.first; fcu; fcu = fcn) {
575                         fcn = fcu->next;
576
577                         /* try each basepath in turn, but stop on the first one which works */
578                         for (ld = basepaths->first; ld; ld = ld->next) {
579                                 const char *basepath = (const char *)ld->data;
580
581                                 if (animpath_matches_basepath(fcu->rna_path, basepath)) {
582                                         /* just need to change lists */
583                                         BLI_remlink(&srcAdt->drivers, fcu);
584                                         BLI_addtail(&dstAdt->drivers, fcu);
585
586                                         /* TODO: add depsgraph flushing calls? */
587
588                                         /* can stop now, as moved already */
589                                         break;
590                                 }
591                         }
592                 }
593         }
594 }
595
596 /**
597  * Temporary wrapper for driver operators for buttons to make it easier to create
598  * such drivers by rerouting all paths through the active object instead so that
599  * they will get picked up by the dependency system.
600  *
601  * \param C: Context pointer - for getting active data
602  * \param[in,out] ptr RNA pointer for property's datablock. May be modified as result of path remapping.
603  * \param prop: RNA definition of property to add for
604  * \return MEM_alloc'd string representing the path to the property from the given #PointerRNA
605  */
606 char *BKE_animdata_driver_path_hack(bContext *C, PointerRNA *ptr, PropertyRNA *prop, char *base_path)
607 {
608         ID *id = (ID *)ptr->id.data;
609         ScrArea *sa = CTX_wm_area(C);
610
611         /* get standard path which may be extended */
612         char *basepath = base_path ? base_path : RNA_path_from_ID_to_property(ptr, prop);
613         char *path = basepath; /* in case no remapping is needed */
614
615         /* Remapping will only be performed in the Properties Editor, as only this
616          * restricts the subspace of options to the 'active' data (a manageable state)
617          */
618         /* TODO: watch out for pinned context? */
619         if ((sa) && (sa->spacetype == SPACE_BUTS)) {
620                 Object *ob = CTX_data_active_object(C);
621
622                 if (ob && id) {
623                         /* TODO: after material textures were removed, this function serves
624                          * no purpose anymore, but could be used again so was not removed. */
625
626                         /* fix RNA pointer, as we've now changed the ID root by changing the paths */
627                         if (basepath != path) {
628                                 /* rebase provided pointer so that it starts from object... */
629                                 RNA_pointer_create(&ob->id, ptr->type, ptr->data, ptr);
630                         }
631                 }
632         }
633
634         /* the path should now have been corrected for use */
635         return path;
636 }
637
638 /* Path Validation -------------------------------------------- */
639
640 /* Check if a given RNA Path is valid, by tracing it from the given ID, and seeing if we can resolve it */
641 static bool check_rna_path_is_valid(ID *owner_id, const char *path)
642 {
643         PointerRNA id_ptr, ptr;
644         PropertyRNA *prop = NULL;
645
646         /* make initial RNA pointer to start resolving from */
647         RNA_id_pointer_create(owner_id, &id_ptr);
648
649         /* try to resolve */
650         return RNA_path_resolve_property(&id_ptr, path, &ptr, &prop);
651 }
652
653 /* Check if some given RNA Path needs fixing - free the given path and set a new one as appropriate
654  * NOTE: we assume that oldName and newName have [" "] padding around them
655  */
656 static char *rna_path_rename_fix(ID *owner_id, const char *prefix, const char *oldName, const char *newName, char *oldpath, bool verify_paths)
657 {
658         char *prefixPtr = strstr(oldpath, prefix);
659         char *oldNamePtr = strstr(oldpath, oldName);
660         int prefixLen = strlen(prefix);
661         int oldNameLen = strlen(oldName);
662
663         /* only start fixing the path if the prefix and oldName feature in the path,
664          * and prefix occurs immediately before oldName
665          */
666         if ( (prefixPtr && oldNamePtr) && (prefixPtr + prefixLen == oldNamePtr) ) {
667                 /* if we haven't aren't able to resolve the path now, try again after fixing it */
668                 if (!verify_paths || check_rna_path_is_valid(owner_id, oldpath) == 0) {
669                         DynStr *ds = BLI_dynstr_new();
670                         const char *postfixPtr = oldNamePtr + oldNameLen;
671                         char *newPath = NULL;
672
673                         /* add the part of the string that goes up to the start of the prefix */
674                         if (prefixPtr > oldpath) {
675                                 BLI_dynstr_nappend(ds, oldpath, prefixPtr - oldpath);
676                         }
677
678                         /* add the prefix */
679                         BLI_dynstr_append(ds, prefix);
680
681                         /* add the new name (complete with brackets) */
682                         BLI_dynstr_append(ds, newName);
683
684                         /* add the postfix */
685                         BLI_dynstr_append(ds, postfixPtr);
686
687                         /* create new path, and cleanup old data */
688                         newPath = BLI_dynstr_get_cstring(ds);
689                         BLI_dynstr_free(ds);
690
691                         /* check if the new path will solve our problems */
692                         /* TODO: will need to check whether this step really helps in practice */
693                         if (!verify_paths || check_rna_path_is_valid(owner_id, newPath)) {
694                                 /* free the old path, and return the new one, since we've solved the issues */
695                                 MEM_freeN(oldpath);
696                                 return newPath;
697                         }
698                         else {
699                                 /* still couldn't resolve the path... so, might as well just leave it alone */
700                                 MEM_freeN(newPath);
701                         }
702                 }
703         }
704
705         /* the old path doesn't need to be changed */
706         return oldpath;
707 }
708
709 /* Check RNA-Paths for a list of F-Curves */
710 static void fcurves_path_rename_fix(ID *owner_id, const char *prefix, const char *oldName, const char *newName,
711                                     const char *oldKey, const char *newKey, ListBase *curves, bool verify_paths)
712 {
713         FCurve *fcu;
714
715         /* we need to check every curve... */
716         for (fcu = curves->first; fcu; fcu = fcu->next) {
717                 if (fcu->rna_path) {
718                         const char *old_path = fcu->rna_path;
719
720                         /* firstly, handle the F-Curve's own path */
721                         fcu->rna_path = rna_path_rename_fix(owner_id, prefix, oldKey, newKey, fcu->rna_path, verify_paths);
722
723                         /* if path changed and the F-Curve is grouped, check if its group also needs renaming
724                          * (i.e. F-Curve is first of a bone's F-Curves; hence renaming this should also trigger rename)
725                          */
726                         if (fcu->rna_path != old_path) {
727                                 bActionGroup *agrp = fcu->grp;
728
729                                 if ((agrp) && STREQ(oldName, agrp->name)) {
730                                         BLI_strncpy(agrp->name, newName, sizeof(agrp->name));
731                                 }
732                         }
733                 }
734         }
735 }
736
737 /* Check RNA-Paths for a list of Drivers */
738 static void drivers_path_rename_fix(ID *owner_id, ID *ref_id, const char *prefix, const char *oldName, const char *newName,
739                                     const char *oldKey, const char *newKey, ListBase *curves, bool verify_paths)
740 {
741         FCurve *fcu;
742
743         /* we need to check every curve - drivers are F-Curves too! */
744         for (fcu = curves->first; fcu; fcu = fcu->next) {
745                 /* firstly, handle the F-Curve's own path */
746                 if (fcu->rna_path)
747                         fcu->rna_path = rna_path_rename_fix(owner_id, prefix, oldKey, newKey, fcu->rna_path, verify_paths);
748
749                 /* driver? */
750                 if (fcu->driver) {
751                         ChannelDriver *driver = fcu->driver;
752                         DriverVar *dvar;
753
754                         /* driver variables */
755                         for (dvar = driver->variables.first; dvar; dvar = dvar->next) {
756                                 /* only change the used targets, since the others will need fixing manually anyway */
757                                 DRIVER_TARGETS_USED_LOOPER_BEGIN(dvar)
758                                 {
759                                         /* rename RNA path */
760                                         if (dtar->rna_path && dtar->id)
761                                                 dtar->rna_path = rna_path_rename_fix(dtar->id, prefix, oldKey, newKey, dtar->rna_path, verify_paths);
762
763                                         /* also fix the bone-name (if applicable) */
764                                         if (strstr(prefix, "bones")) {
765                                                 if ( ((dtar->id) && (GS(dtar->id->name) == ID_OB) && (!ref_id || ((Object *)(dtar->id))->data == ref_id)) &&
766                                                      (dtar->pchan_name[0]) && STREQ(oldName, dtar->pchan_name) )
767                                                 {
768                                                         BLI_strncpy(dtar->pchan_name, newName, sizeof(dtar->pchan_name));
769                                                 }
770                                         }
771                                 }
772                                 DRIVER_TARGETS_LOOPER_END;
773                         }
774                 }
775         }
776 }
777
778 /* Fix all RNA-Paths for Actions linked to NLA Strips */
779 static void nlastrips_path_rename_fix(ID *owner_id, const char *prefix, const char *oldName, const char *newName,
780                                       const char *oldKey, const char *newKey, ListBase *strips, bool verify_paths)
781 {
782         NlaStrip *strip;
783
784         /* recursively check strips, fixing only actions... */
785         for (strip = strips->first; strip; strip = strip->next) {
786                 /* fix strip's action */
787                 if (strip->act)
788                         fcurves_path_rename_fix(owner_id, prefix, oldName, newName, oldKey, newKey, &strip->act->curves, verify_paths);
789                 /* ignore own F-Curves, since those are local...  */
790
791                 /* check sub-strips (if metas) */
792                 nlastrips_path_rename_fix(owner_id, prefix, oldName, newName, oldKey, newKey, &strip->strips, verify_paths);
793         }
794 }
795
796 /* Rename Sub-ID Entities in RNA Paths ----------------------- */
797
798 /* Fix up the given RNA-Path
799  *
800  * This is just an external wrapper for the RNA-Path fixing function,
801  * with input validity checks on top of the basic method.
802  *
803  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
804  *       i.e. pose.bones["Bone"]
805  */
806 char *BKE_animsys_fix_rna_path_rename(ID *owner_id, char *old_path, const char *prefix, const char *oldName,
807                                       const char *newName, int oldSubscript, int newSubscript, bool verify_paths)
808 {
809         char *oldN, *newN;
810         char *result;
811
812         /* if no action, no need to proceed */
813         if (ELEM(NULL, owner_id, old_path)) {
814                 if (G.debug & G_DEBUG) printf("%s: early abort\n", __func__);
815                 return old_path;
816         }
817
818         /* Name sanitation logic - copied from BKE_animdata_fix_paths_rename() */
819         if ((oldName != NULL) && (newName != NULL)) {
820                 /* pad the names with [" "] so that only exact matches are made */
821                 const size_t name_old_len = strlen(oldName);
822                 const size_t name_new_len = strlen(newName);
823                 char *name_old_esc = BLI_array_alloca(name_old_esc, (name_old_len * 2) + 1);
824                 char *name_new_esc = BLI_array_alloca(name_new_esc, (name_new_len * 2) + 1);
825
826                 BLI_strescape(name_old_esc, oldName, (name_old_len * 2) + 1);
827                 BLI_strescape(name_new_esc, newName, (name_new_len * 2) + 1);
828                 oldN = BLI_sprintfN("[\"%s\"]", name_old_esc);
829                 newN = BLI_sprintfN("[\"%s\"]", name_new_esc);
830         }
831         else {
832                 oldN = BLI_sprintfN("[%d]", oldSubscript);
833                 newN = BLI_sprintfN("[%d]", newSubscript);
834         }
835
836         /* fix given path */
837         if (G.debug & G_DEBUG) printf("%s | %s  | oldpath = %p ", oldN, newN, old_path);
838         result = rna_path_rename_fix(owner_id, prefix, oldN, newN, old_path, verify_paths);
839         if (G.debug & G_DEBUG) printf("path rename result = %p\n", result);
840
841         /* free the temp names */
842         MEM_freeN(oldN);
843         MEM_freeN(newN);
844
845         /* return the resulting path - may be the same path again if nothing changed */
846         return result;
847 }
848
849 /* Fix all RNA_Paths in the given Action, relative to the given ID block
850  *
851  * This is just an external wrapper for the F-Curve fixing function,
852  * with input validity checks on top of the basic method.
853  *
854  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
855  *       i.e. pose.bones["Bone"]
856  */
857 void BKE_action_fix_paths_rename(ID *owner_id, bAction *act, const char *prefix, const char *oldName,
858                                  const char *newName, int oldSubscript, int newSubscript, bool verify_paths)
859 {
860         char *oldN, *newN;
861
862         /* if no action, no need to proceed */
863         if (ELEM(NULL, owner_id, act))
864                 return;
865
866         /* Name sanitation logic - copied from BKE_animdata_fix_paths_rename() */
867         if ((oldName != NULL) && (newName != NULL)) {
868                 /* pad the names with [" "] so that only exact matches are made */
869                 const size_t name_old_len = strlen(oldName);
870                 const size_t name_new_len = strlen(newName);
871                 char *name_old_esc = BLI_array_alloca(name_old_esc, (name_old_len * 2) + 1);
872                 char *name_new_esc = BLI_array_alloca(name_new_esc, (name_new_len * 2) + 1);
873
874                 BLI_strescape(name_old_esc, oldName, (name_old_len * 2) + 1);
875                 BLI_strescape(name_new_esc, newName, (name_new_len * 2) + 1);
876                 oldN = BLI_sprintfN("[\"%s\"]", name_old_esc);
877                 newN = BLI_sprintfN("[\"%s\"]", name_new_esc);
878         }
879         else {
880                 oldN = BLI_sprintfN("[%d]", oldSubscript);
881                 newN = BLI_sprintfN("[%d]", newSubscript);
882         }
883
884         /* fix paths in action */
885         fcurves_path_rename_fix(owner_id, prefix, oldName, newName, oldN, newN, &act->curves, verify_paths);
886
887         /* free the temp names */
888         MEM_freeN(oldN);
889         MEM_freeN(newN);
890 }
891
892 /* Fix all RNA-Paths in the AnimData block used by the given ID block
893  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
894  *       i.e. pose.bones["Bone"]
895  */
896 void BKE_animdata_fix_paths_rename(ID *owner_id, AnimData *adt, ID *ref_id, const char *prefix, const char *oldName,
897                                    const char *newName, int oldSubscript, int newSubscript, bool verify_paths)
898 {
899         NlaTrack *nlt;
900         char *oldN, *newN;
901
902         /* if no AnimData, no need to proceed */
903         if (ELEM(NULL, owner_id, adt))
904                 return;
905
906         /* Name sanitation logic - shared with BKE_action_fix_paths_rename() */
907         if ((oldName != NULL) && (newName != NULL)) {
908                 /* pad the names with [" "] so that only exact matches are made */
909                 const size_t name_old_len = strlen(oldName);
910                 const size_t name_new_len = strlen(newName);
911                 char *name_old_esc = BLI_array_alloca(name_old_esc, (name_old_len * 2) + 1);
912                 char *name_new_esc = BLI_array_alloca(name_new_esc, (name_new_len * 2) + 1);
913
914                 BLI_strescape(name_old_esc, oldName, (name_old_len * 2) + 1);
915                 BLI_strescape(name_new_esc, newName, (name_new_len * 2) + 1);
916                 oldN = BLI_sprintfN("[\"%s\"]", name_old_esc);
917                 newN = BLI_sprintfN("[\"%s\"]", name_new_esc);
918         }
919         else {
920                 oldN = BLI_sprintfN("[%d]", oldSubscript);
921                 newN = BLI_sprintfN("[%d]", newSubscript);
922         }
923
924         /* Active action and temp action */
925         if (adt->action)
926                 fcurves_path_rename_fix(owner_id, prefix, oldName, newName, oldN, newN, &adt->action->curves, verify_paths);
927         if (adt->tmpact)
928                 fcurves_path_rename_fix(owner_id, prefix, oldName, newName, oldN, newN, &adt->tmpact->curves, verify_paths);
929
930         /* Drivers - Drivers are really F-Curves */
931         drivers_path_rename_fix(owner_id, ref_id, prefix, oldName, newName, oldN, newN, &adt->drivers, verify_paths);
932
933         /* NLA Data - Animation Data for Strips */
934         for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next)
935                 nlastrips_path_rename_fix(owner_id, prefix, oldName, newName, oldN, newN, &nlt->strips, verify_paths);
936
937         /* free the temp names */
938         MEM_freeN(oldN);
939         MEM_freeN(newN);
940 }
941
942 /* Remove FCurves with Prefix  -------------------------------------- */
943
944 /* Check RNA-Paths for a list of F-Curves */
945 static bool fcurves_path_remove_fix(const char *prefix, ListBase *curves)
946 {
947         FCurve *fcu, *fcn;
948         bool any_removed = false;
949         if (!prefix) return any_removed;
950
951         /* we need to check every curve... */
952         for (fcu = curves->first; fcu; fcu = fcn) {
953                 fcn = fcu->next;
954
955                 if (fcu->rna_path) {
956                         if (STRPREFIX(fcu->rna_path, prefix)) {
957                                 BLI_remlink(curves, fcu);
958                                 free_fcurve(fcu);
959                                 any_removed = true;
960                         }
961                 }
962         }
963         return any_removed;
964 }
965
966 /* Check RNA-Paths for a list of F-Curves */
967 static bool nlastrips_path_remove_fix(const char *prefix, ListBase *strips)
968 {
969         NlaStrip *strip;
970         bool any_removed = false;
971
972         /* recursively check strips, fixing only actions... */
973         for (strip = strips->first; strip; strip = strip->next) {
974                 /* fix strip's action */
975                 if (strip->act) {
976                         any_removed |= fcurves_path_remove_fix(prefix, &strip->act->curves);
977                 }
978
979                 /* check sub-strips (if metas) */
980                 any_removed |= nlastrips_path_remove_fix(prefix, &strip->strips);
981         }
982         return any_removed;
983 }
984
985 bool BKE_animdata_fix_paths_remove(ID *id, const char *prefix)
986 {
987         /* Only some ID-blocks have this info for now, so we cast the
988          * types that do to be of type IdAdtTemplate
989          */
990         if (!id_can_have_animdata(id)) {
991                 return false;
992         }
993         bool any_removed = false;
994         IdAdtTemplate *iat = (IdAdtTemplate *)id;
995         AnimData *adt = iat->adt;
996         /* check if there's any AnimData to start with */
997         if (adt) {
998                 /* free fcurves */
999                 if (adt->action != NULL) {
1000                         any_removed |= fcurves_path_remove_fix(prefix, &adt->action->curves);
1001                 }
1002                 if (adt->tmpact != NULL) {
1003                         any_removed |= fcurves_path_remove_fix(prefix, &adt->tmpact->curves);
1004                 }
1005                 /* free drivers - stored as a list of F-Curves */
1006                 any_removed |= fcurves_path_remove_fix(prefix, &adt->drivers);
1007                 /* NLA Data - Animation Data for Strips */
1008                 for (NlaTrack *nlt = adt->nla_tracks.first; nlt; nlt = nlt->next) {
1009                         any_removed |= nlastrips_path_remove_fix(prefix, &nlt->strips);
1010                 }
1011         }
1012         return any_removed;
1013 }
1014
1015 /* Apply Op to All FCurves in Database --------------------------- */
1016
1017 /* "User-Data" wrapper used by BKE_fcurves_main_cb() */
1018 typedef struct AllFCurvesCbWrapper {
1019         ID_FCurve_Edit_Callback func;  /* Operation to apply on F-Curve */
1020         void *user_data;               /* Custom data for that operation */
1021 } AllFCurvesCbWrapper;
1022
1023 /* Helper for adt_apply_all_fcurves_cb() - Apply wrapped operator to list of F-Curves */
1024 static void fcurves_apply_cb(ID *id, ListBase *fcurves, ID_FCurve_Edit_Callback func, void *user_data)
1025 {
1026         FCurve *fcu;
1027
1028         for (fcu = fcurves->first; fcu; fcu = fcu->next) {
1029                 func(id, fcu, user_data);
1030         }
1031 }
1032
1033 /* Helper for adt_apply_all_fcurves_cb() - Recursively go through each NLA strip */
1034 static void nlastrips_apply_all_curves_cb(ID *id, ListBase *strips, AllFCurvesCbWrapper *wrapper)
1035 {
1036         NlaStrip *strip;
1037
1038         for (strip = strips->first; strip; strip = strip->next) {
1039                 /* fix strip's action */
1040                 if (strip->act) {
1041                         fcurves_apply_cb(id, &strip->act->curves, wrapper->func, wrapper->user_data);
1042                 }
1043
1044                 /* check sub-strips (if metas) */
1045                 nlastrips_apply_all_curves_cb(id, &strip->strips, wrapper);
1046         }
1047 }
1048
1049 /* Helper for BKE_fcurves_main_cb() - Dispatch wrapped operator to all F-Curves */
1050 static void adt_apply_all_fcurves_cb(ID *id, AnimData *adt, void *wrapper_data)
1051 {
1052         AllFCurvesCbWrapper *wrapper = wrapper_data;
1053         NlaTrack *nlt;
1054
1055         if (adt->action) {
1056                 fcurves_apply_cb(id, &adt->action->curves, wrapper->func, wrapper->user_data);
1057         }
1058
1059         if (adt->tmpact) {
1060                 fcurves_apply_cb(id, &adt->tmpact->curves, wrapper->func, wrapper->user_data);
1061         }
1062
1063         /* free drivers - stored as a list of F-Curves */
1064         fcurves_apply_cb(id, &adt->drivers, wrapper->func, wrapper->user_data);
1065
1066         /* NLA Data - Animation Data for Strips */
1067         for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next) {
1068                 nlastrips_apply_all_curves_cb(id, &nlt->strips, wrapper);
1069         }
1070 }
1071
1072 /* apply the given callback function on all F-Curves attached to data in main database */
1073 void BKE_fcurves_main_cb(Main *bmain, ID_FCurve_Edit_Callback func, void *user_data)
1074 {
1075         /* Wrap F-Curve operation stuff to pass to the general AnimData-level func */
1076         AllFCurvesCbWrapper wrapper = {func, user_data};
1077
1078         /* Use the AnimData-based function so that we don't have to reimplement all that stuff */
1079         BKE_animdata_main_cb(bmain, adt_apply_all_fcurves_cb, &wrapper);
1080 }
1081
1082
1083 /* Whole Database Ops -------------------------------------------- */
1084
1085 /* apply the given callback function on all data in main database */
1086 void BKE_animdata_main_cb(Main *bmain, ID_AnimData_Edit_Callback func, void *user_data)
1087 {
1088         ID *id;
1089
1090         /* standard data version */
1091 #define ANIMDATA_IDS_CB(first) \
1092         for (id = first; id; id = id->next) { \
1093                 AnimData *adt = BKE_animdata_from_id(id); \
1094                 if (adt) func(id, adt, user_data); \
1095         } (void)0
1096
1097         /* "embedded" nodetree cases (i.e. scene/material/texture->nodetree) */
1098 #define ANIMDATA_NODETREE_IDS_CB(first, NtId_Type) \
1099         for (id = first; id; id = id->next) { \
1100                 AnimData *adt = BKE_animdata_from_id(id); \
1101                 NtId_Type *ntp = (NtId_Type *)id; \
1102                 if (ntp->nodetree) { \
1103                         AnimData *adt2 = BKE_animdata_from_id((ID *)ntp->nodetree); \
1104                         if (adt2) func(id, adt2, user_data); \
1105                 } \
1106                 if (adt) func(id, adt, user_data); \
1107         } (void)0
1108
1109         /* nodes */
1110         ANIMDATA_IDS_CB(bmain->nodetree.first);
1111
1112         /* textures */
1113         ANIMDATA_NODETREE_IDS_CB(bmain->tex.first, Tex);
1114
1115         /* lamps */
1116         ANIMDATA_NODETREE_IDS_CB(bmain->lamp.first, Lamp);
1117
1118         /* materials */
1119         ANIMDATA_NODETREE_IDS_CB(bmain->mat.first, Material);
1120
1121         /* cameras */
1122         ANIMDATA_IDS_CB(bmain->camera.first);
1123
1124         /* shapekeys */
1125         ANIMDATA_IDS_CB(bmain->key.first);
1126
1127         /* metaballs */
1128         ANIMDATA_IDS_CB(bmain->mball.first);
1129
1130         /* curves */
1131         ANIMDATA_IDS_CB(bmain->curve.first);
1132
1133         /* armatures */
1134         ANIMDATA_IDS_CB(bmain->armature.first);
1135
1136         /* lattices */
1137         ANIMDATA_IDS_CB(bmain->latt.first);
1138
1139         /* meshes */
1140         ANIMDATA_IDS_CB(bmain->mesh.first);
1141
1142         /* particles */
1143         ANIMDATA_IDS_CB(bmain->particle.first);
1144
1145         /* speakers */
1146         ANIMDATA_IDS_CB(bmain->speaker.first);
1147
1148         /* movie clips */
1149         ANIMDATA_IDS_CB(bmain->movieclip.first);
1150
1151         /* objects */
1152         ANIMDATA_IDS_CB(bmain->object.first);
1153
1154         /* masks */
1155         ANIMDATA_IDS_CB(bmain->mask.first);
1156
1157         /* worlds */
1158         ANIMDATA_NODETREE_IDS_CB(bmain->world.first, World);
1159
1160         /* scenes */
1161         ANIMDATA_NODETREE_IDS_CB(bmain->scene.first, Scene);
1162
1163         /* line styles */
1164         ANIMDATA_IDS_CB(bmain->linestyle.first);
1165
1166         /* grease pencil */
1167         ANIMDATA_IDS_CB(bmain->gpencil.first);
1168
1169         /* palettes */
1170         ANIMDATA_IDS_CB(bmain->palettes.first);
1171
1172         /* cache files */
1173         ANIMDATA_IDS_CB(bmain->cachefiles.first);
1174 }
1175
1176 /* Fix all RNA-Paths throughout the database (directly access the Global.main version)
1177  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
1178  *      i.e. pose.bones["Bone"]
1179  */
1180 /* TODO: use BKE_animdata_main_cb for looping over all data  */
1181 void BKE_animdata_fix_paths_rename_all(ID *ref_id, const char *prefix, const char *oldName, const char *newName)
1182 {
1183         Main *bmain = G.main;  /* XXX UGLY! */
1184         ID *id;
1185
1186         /* macro for less typing
1187          * - whether animdata exists is checked for by the main renaming callback, though taking
1188          *   this outside of the function may make things slightly faster?
1189          */
1190 #define RENAMEFIX_ANIM_IDS(first) \
1191         for (id = first; id; id = id->next) { \
1192                 AnimData *adt = BKE_animdata_from_id(id); \
1193                 BKE_animdata_fix_paths_rename(id, adt, ref_id, prefix, oldName, newName, 0, 0, 1); \
1194         } (void)0
1195
1196         /* another version of this macro for nodetrees */
1197 #define RENAMEFIX_ANIM_NODETREE_IDS(first, NtId_Type) \
1198         for (id = first; id; id = id->next) { \
1199                 AnimData *adt = BKE_animdata_from_id(id); \
1200                 NtId_Type *ntp = (NtId_Type *)id; \
1201                 if (ntp->nodetree) { \
1202                         AnimData *adt2 = BKE_animdata_from_id((ID *)ntp->nodetree); \
1203                         BKE_animdata_fix_paths_rename((ID *)ntp->nodetree, adt2, ref_id, prefix, oldName, newName, 0, 0, 1); \
1204                 } \
1205                 BKE_animdata_fix_paths_rename(id, adt, ref_id, prefix, oldName, newName, 0, 0, 1); \
1206         } (void)0
1207
1208         /* nodes */
1209         RENAMEFIX_ANIM_IDS(bmain->nodetree.first);
1210
1211         /* textures */
1212         RENAMEFIX_ANIM_NODETREE_IDS(bmain->tex.first, Tex);
1213
1214         /* lamps */
1215         RENAMEFIX_ANIM_NODETREE_IDS(bmain->lamp.first, Lamp);
1216
1217         /* materials */
1218         RENAMEFIX_ANIM_NODETREE_IDS(bmain->mat.first, Material);
1219
1220         /* cameras */
1221         RENAMEFIX_ANIM_IDS(bmain->camera.first);
1222
1223         /* shapekeys */
1224         RENAMEFIX_ANIM_IDS(bmain->key.first);
1225
1226         /* metaballs */
1227         RENAMEFIX_ANIM_IDS(bmain->mball.first);
1228
1229         /* curves */
1230         RENAMEFIX_ANIM_IDS(bmain->curve.first);
1231
1232         /* armatures */
1233         RENAMEFIX_ANIM_IDS(bmain->armature.first);
1234
1235         /* lattices */
1236         RENAMEFIX_ANIM_IDS(bmain->latt.first);
1237
1238         /* meshes */
1239         RENAMEFIX_ANIM_IDS(bmain->mesh.first);
1240
1241         /* particles */
1242         RENAMEFIX_ANIM_IDS(bmain->particle.first);
1243
1244         /* speakers */
1245         RENAMEFIX_ANIM_IDS(bmain->speaker.first);
1246
1247         /* movie clips */
1248         RENAMEFIX_ANIM_IDS(bmain->movieclip.first);
1249
1250         /* objects */
1251         RENAMEFIX_ANIM_IDS(bmain->object.first);
1252
1253         /* masks */
1254         RENAMEFIX_ANIM_IDS(bmain->mask.first);
1255
1256         /* worlds */
1257         RENAMEFIX_ANIM_NODETREE_IDS(bmain->world.first, World);
1258
1259         /* linestyles */
1260         RENAMEFIX_ANIM_IDS(bmain->linestyle.first);
1261
1262         /* grease pencil */
1263         RENAMEFIX_ANIM_IDS(bmain->gpencil.first);
1264
1265         /* cache files */
1266         RENAMEFIX_ANIM_IDS(bmain->cachefiles.first);
1267
1268         /* scenes */
1269         RENAMEFIX_ANIM_NODETREE_IDS(bmain->scene.first, Scene);
1270 }
1271
1272 /* *********************************** */
1273 /* KeyingSet API */
1274
1275 /* Finding Tools --------------------------- */
1276
1277 /* Find the first path that matches the given criteria */
1278 /* TODO: do we want some method to perform partial matches too? */
1279 KS_Path *BKE_keyingset_find_path(KeyingSet *ks, ID *id, const char group_name[], const char rna_path[], int array_index, int UNUSED(group_mode))
1280 {
1281         KS_Path *ksp;
1282
1283         /* sanity checks */
1284         if (ELEM(NULL, ks, rna_path, id))
1285                 return NULL;
1286
1287         /* loop over paths in the current KeyingSet, finding the first one where all settings match
1288          * (i.e. the first one where none of the checks fail and equal 0)
1289          */
1290         for (ksp = ks->paths.first; ksp; ksp = ksp->next) {
1291                 short eq_id = 1, eq_path = 1, eq_index = 1, eq_group = 1;
1292
1293                 /* id */
1294                 if (id != ksp->id)
1295                         eq_id = 0;
1296
1297                 /* path */
1298                 if ((ksp->rna_path == NULL) || !STREQ(rna_path, ksp->rna_path))
1299                         eq_path = 0;
1300
1301                 /* index - need to compare whole-array setting too... */
1302                 if (ksp->array_index != array_index)
1303                         eq_index = 0;
1304
1305                 /* group */
1306                 if (group_name) {
1307                         /* FIXME: these checks need to be coded... for now, it's not too important though */
1308                 }
1309
1310                 /* if all aspects are ok, return */
1311                 if (eq_id && eq_path && eq_index && eq_group)
1312                         return ksp;
1313         }
1314
1315         /* none found */
1316         return NULL;
1317 }
1318
1319 /* Defining Tools --------------------------- */
1320
1321 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
1322 KeyingSet *BKE_keyingset_add(ListBase *list, const char idname[], const char name[], short flag, short keyingflag)
1323 {
1324         KeyingSet *ks;
1325
1326         /* allocate new KeyingSet */
1327         ks = MEM_callocN(sizeof(KeyingSet), "KeyingSet");
1328
1329         BLI_strncpy(ks->idname, (idname) ? idname : (name) ? name     : DATA_("KeyingSet"),  sizeof(ks->idname));
1330         BLI_strncpy(ks->name,   (name) ? name     : (idname) ? idname : DATA_("Keying Set"), sizeof(ks->name));
1331
1332         ks->flag = flag;
1333         ks->keyingflag = keyingflag;
1334         ks->keyingoverride = keyingflag; /* NOTE: assume that if one is set one way, the other should be too, so that it'll work */
1335
1336         /* add KeyingSet to list */
1337         BLI_addtail(list, ks);
1338
1339         /* Make sure KeyingSet has a unique idname */
1340         BLI_uniquename(list, ks, DATA_("KeyingSet"), '.', offsetof(KeyingSet, idname), sizeof(ks->idname));
1341
1342         /* Make sure KeyingSet has a unique label (this helps with identification) */
1343         BLI_uniquename(list, ks, DATA_("Keying Set"), '.', offsetof(KeyingSet, name), sizeof(ks->name));
1344
1345         /* return new KeyingSet for further editing */
1346         return ks;
1347 }
1348
1349 /* Add a path to a KeyingSet. Nothing is returned for now...
1350  * Checks are performed to ensure that destination is appropriate for the KeyingSet in question
1351  */
1352 KS_Path *BKE_keyingset_add_path(KeyingSet *ks, ID *id, const char group_name[], const char rna_path[], int array_index, short flag, short groupmode)
1353 {
1354         KS_Path *ksp;
1355
1356         /* sanity checks */
1357         if (ELEM(NULL, ks, rna_path)) {
1358                 printf("ERROR: no Keying Set and/or RNA Path to add path with\n");
1359                 return NULL;
1360         }
1361
1362         /* ID is required for all types of KeyingSets */
1363         if (id == NULL) {
1364                 printf("ERROR: No ID provided for Keying Set Path\n");
1365                 return NULL;
1366         }
1367
1368         /* don't add if there is already a matching KS_Path in the KeyingSet */
1369         if (BKE_keyingset_find_path(ks, id, group_name, rna_path, array_index, groupmode)) {
1370                 if (G.debug & G_DEBUG)
1371                         printf("ERROR: destination already exists in Keying Set\n");
1372                 return NULL;
1373         }
1374
1375         /* allocate a new KeyingSet Path */
1376         ksp = MEM_callocN(sizeof(KS_Path), "KeyingSet Path");
1377
1378         /* just store absolute info */
1379         ksp->id = id;
1380         if (group_name)
1381                 BLI_strncpy(ksp->group, group_name, sizeof(ksp->group));
1382         else
1383                 ksp->group[0] = '\0';
1384
1385         /* store additional info for relative paths (just in case user makes the set relative) */
1386         if (id)
1387                 ksp->idtype = GS(id->name);
1388
1389         /* just copy path info */
1390         /* TODO: should array index be checked too? */
1391         ksp->rna_path = BLI_strdup(rna_path);
1392         ksp->array_index = array_index;
1393
1394         /* store flags */
1395         ksp->flag = flag;
1396         ksp->groupmode = groupmode;
1397
1398         /* add KeyingSet path to KeyingSet */
1399         BLI_addtail(&ks->paths, ksp);
1400
1401         /* return this path */
1402         return ksp;
1403 }
1404
1405 /* Free the given Keying Set path */
1406 void BKE_keyingset_free_path(KeyingSet *ks, KS_Path *ksp)
1407 {
1408         /* sanity check */
1409         if (ELEM(NULL, ks, ksp))
1410                 return;
1411
1412         /* free RNA-path info */
1413         if (ksp->rna_path)
1414                 MEM_freeN(ksp->rna_path);
1415
1416         /* free path itself */
1417         BLI_freelinkN(&ks->paths, ksp);
1418 }
1419
1420 /* Copy all KeyingSets in the given list */
1421 void BKE_keyingsets_copy(ListBase *newlist, const ListBase *list)
1422 {
1423         KeyingSet *ksn;
1424         KS_Path *kspn;
1425
1426         BLI_duplicatelist(newlist, list);
1427
1428         for (ksn = newlist->first; ksn; ksn = ksn->next) {
1429                 BLI_duplicatelist(&ksn->paths, &ksn->paths);
1430
1431                 for (kspn = ksn->paths.first; kspn; kspn = kspn->next)
1432                         kspn->rna_path = MEM_dupallocN(kspn->rna_path);
1433         }
1434 }
1435
1436 /* Freeing Tools --------------------------- */
1437
1438 /* Free data for KeyingSet but not set itself */
1439 void BKE_keyingset_free(KeyingSet *ks)
1440 {
1441         KS_Path *ksp, *kspn;
1442
1443         /* sanity check */
1444         if (ks == NULL)
1445                 return;
1446
1447         /* free each path as we go to avoid looping twice */
1448         for (ksp = ks->paths.first; ksp; ksp = kspn) {
1449                 kspn = ksp->next;
1450                 BKE_keyingset_free_path(ks, ksp);
1451         }
1452 }
1453
1454 /* Free all the KeyingSets in the given list */
1455 void BKE_keyingsets_free(ListBase *list)
1456 {
1457         KeyingSet *ks, *ksn;
1458
1459         /* sanity check */
1460         if (list == NULL)
1461                 return;
1462
1463         /* loop over KeyingSets freeing them
1464          * - BKE_keyingset_free() doesn't free the set itself, but it frees its sub-data
1465          */
1466         for (ks = list->first; ks; ks = ksn) {
1467                 ksn = ks->next;
1468                 BKE_keyingset_free(ks);
1469                 BLI_freelinkN(list, ks);
1470         }
1471 }
1472
1473 /* ***************************************** */
1474 /* Evaluation Data-Setting Backend */
1475
1476 static bool animsys_store_rna_setting(
1477         PointerRNA *ptr,
1478         /* typically 'fcu->rna_path', 'fcu->array_index' */
1479         const char *rna_path, const int array_index,
1480         PathResolvedRNA *r_result)
1481 {
1482         bool success = false;
1483         const char *path = rna_path;
1484
1485         /* write value to setting */
1486         if (path) {
1487                 /* get property to write to */
1488                 if (RNA_path_resolve_property(ptr, path, &r_result->ptr, &r_result->prop)) {
1489                         if ((ptr->id.data == NULL) || RNA_property_animateable(&r_result->ptr, r_result->prop)) {
1490                                 int array_len = RNA_property_array_length(&r_result->ptr, r_result->prop);
1491
1492                                 if (array_len && array_index >= array_len) {
1493                                         if (G.debug & G_DEBUG) {
1494                                                 printf("Animato: Invalid array index. ID = '%s',  '%s[%d]', array length is %d\n",
1495                                                        (ptr->id.data) ? (((ID *)ptr->id.data)->name + 2) : "<No ID>",
1496                                                        path, array_index, array_len - 1);
1497                                         }
1498                                 }
1499                                 else {
1500                                         r_result->prop_index = array_len ? array_index : -1;
1501                                         success = true;
1502                                 }
1503                         }
1504                 }
1505                 else {
1506                         /* failed to get path */
1507                         /* XXX don't tag as failed yet though, as there are some legit situations (Action Constraint)
1508                          * where some channels will not exist, but shouldn't lock up Action */
1509                         if (G.debug & G_DEBUG) {
1510                                 printf("Animato: Invalid path. ID = '%s',  '%s[%d]'\n",
1511                                        (ptr->id.data) ? (((ID *)ptr->id.data)->name + 2) : "<No ID>",
1512                                        path, array_index);
1513                         }
1514                 }
1515         }
1516
1517         return success;
1518 }
1519
1520
1521 /* less than 1.0 evaluates to false, use epsilon to avoid float error */
1522 #define ANIMSYS_FLOAT_AS_BOOL(value) ((value) > ((1.0f - FLT_EPSILON)))
1523
1524 static bool animsys_read_rna_setting(PathResolvedRNA *anim_rna, float *r_value)
1525 {
1526         PropertyRNA *prop = anim_rna->prop;
1527         PointerRNA *ptr = &anim_rna->ptr;
1528         int array_index = anim_rna->prop_index;
1529         float orig_value;
1530
1531         /* caller must ensure this is animatable */
1532         BLI_assert(RNA_property_animateable(ptr, prop) || ptr->id.data == NULL);
1533
1534         switch (RNA_property_type(prop)) {
1535                 case PROP_BOOLEAN:
1536                 {
1537                         if (array_index != -1) {
1538                                 const int orig_value_coerce = RNA_property_boolean_get_index(ptr, prop, array_index);
1539                                 orig_value = (float)orig_value_coerce;
1540                         }
1541                         else {
1542                                 const int orig_value_coerce = RNA_property_boolean_get(ptr, prop);
1543                                 orig_value = (float)orig_value_coerce;
1544                         }
1545                         break;
1546                 }
1547                 case PROP_INT:
1548                 {
1549                         if (array_index != -1) {
1550                                 const int orig_value_coerce = RNA_property_int_get_index(ptr, prop, array_index);
1551                                 orig_value = (float)orig_value_coerce;
1552                         }
1553                         else {
1554                                 const int orig_value_coerce = RNA_property_int_get(ptr, prop);
1555                                 orig_value = (float)orig_value_coerce;
1556                         }
1557                         break;
1558                 }
1559                 case PROP_FLOAT:
1560                 {
1561                         if (array_index != -1) {
1562                                 const float orig_value_coerce = RNA_property_float_get_index(ptr, prop, array_index);
1563                                 orig_value = (float)orig_value_coerce;
1564                         }
1565                         else {
1566                                 const float orig_value_coerce = RNA_property_float_get(ptr, prop);
1567                                 orig_value = (float)orig_value_coerce;
1568                         }
1569                         break;
1570                 }
1571                 case PROP_ENUM:
1572                 {
1573                         const int orig_value_coerce = RNA_property_enum_get(ptr, prop);
1574                         orig_value = (float)orig_value_coerce;
1575                         break;
1576                 }
1577                 default:
1578                         /* nothing can be done here... so it is unsuccessful? */
1579                         return false;
1580         }
1581
1582         if (r_value != NULL) {
1583                 *r_value = orig_value;
1584         }
1585
1586         /* successful */
1587         return true;
1588 }
1589
1590 /* Write the given value to a setting using RNA, and return success */
1591 static bool animsys_write_rna_setting(PathResolvedRNA *anim_rna, const float value)
1592 {
1593         PropertyRNA *prop = anim_rna->prop;
1594         PointerRNA *ptr = &anim_rna->ptr;
1595         int array_index = anim_rna->prop_index;
1596
1597         /* caller must ensure this is animatable */
1598         BLI_assert(RNA_property_animateable(ptr, prop) || ptr->id.data == NULL);
1599
1600         /* Check whether value is new. Otherwise we skip all the updates. */
1601         float old_value;
1602         if (!animsys_read_rna_setting(anim_rna, &old_value)) {
1603                 return false;
1604         }
1605         if (old_value == value) {
1606                 return true;
1607         }
1608
1609         switch (RNA_property_type(prop)) {
1610                 case PROP_BOOLEAN:
1611                 {
1612                         const int value_coerce = ANIMSYS_FLOAT_AS_BOOL(value);
1613                         if (array_index != -1) {
1614                                 RNA_property_boolean_set_index(ptr, prop, array_index, value_coerce);
1615                         }
1616                         else {
1617                                 RNA_property_boolean_set(ptr, prop, value_coerce);
1618                         }
1619                         break;
1620                 }
1621                 case PROP_INT:
1622                 {
1623                         int value_coerce = (int)value;
1624                         RNA_property_int_clamp(ptr, prop, &value_coerce);
1625                         if (array_index != -1) {
1626                                 RNA_property_int_set_index(ptr, prop, array_index, value_coerce);
1627                         }
1628                         else {
1629                                 RNA_property_int_set(ptr, prop, value_coerce);
1630                         }
1631                         break;
1632                 }
1633                 case PROP_FLOAT:
1634                 {
1635                         float value_coerce = value;
1636                         RNA_property_float_clamp(ptr, prop, &value_coerce);
1637                         if (array_index != -1) {
1638                                 RNA_property_float_set_index(ptr, prop, array_index, value_coerce);
1639                         }
1640                         else {
1641                                 RNA_property_float_set(ptr, prop, value_coerce);
1642                         }
1643                         break;
1644                 }
1645                 case PROP_ENUM:
1646                 {
1647                         const int value_coerce = (int)value;
1648                         RNA_property_enum_set(ptr, prop, value_coerce);
1649                         break;
1650                 }
1651                 default:
1652                         /* nothing can be done here... so it is unsuccessful? */
1653                         return false;
1654         }
1655
1656         /* successful */
1657         return true;
1658 }
1659
1660 /* Simple replacement based data-setting of the FCurve using RNA */
1661 bool BKE_animsys_execute_fcurve(PointerRNA *ptr, FCurve *fcu, float curval)
1662 {
1663         PathResolvedRNA anim_rna;
1664         bool ok = false;
1665
1666         if (animsys_store_rna_setting(ptr, fcu->rna_path, fcu->array_index, &anim_rna)) {
1667                 ok = animsys_write_rna_setting(&anim_rna, curval);
1668         }
1669
1670         /* return whether we were successful */
1671         return ok;
1672 }
1673
1674 static void animsys_write_orig_anim_rna(
1675         PointerRNA *ptr,
1676         const char *rna_path,
1677         int array_index,
1678         float value)
1679 {
1680         /* Pointer is expected to be an ID pointer, if it's not -- we are doomed.
1681          *
1682          * NOTE: It is possible to have animation data on NLA strip, see T57360.
1683          * TODO(sergey): Find solution for those cases.
1684          */
1685         if (ptr->id.data == NULL) {
1686                 return;
1687         }
1688         PointerRNA orig_ptr = *ptr;
1689         orig_ptr.id.data = ((ID *)orig_ptr.id.data)->orig_id;
1690         orig_ptr.data = orig_ptr.id.data;
1691         PathResolvedRNA orig_anim_rna;
1692         /* TODO(sergey): Is there a faster way to get anim_rna of original ID? */
1693         if (animsys_store_rna_setting(&orig_ptr, rna_path, array_index, &orig_anim_rna)) {
1694                 animsys_write_rna_setting(&orig_anim_rna, value);
1695         }
1696 }
1697
1698 /* Evaluate all the F-Curves in the given list
1699  * This performs a set of standard checks. If extra checks are required, separate code should be used
1700  */
1701 static void animsys_evaluate_fcurves(
1702         Depsgraph *depsgraph, PointerRNA *ptr, ListBase *list, float ctime)
1703 {
1704         const bool is_active_depsgraph = DEG_is_active(depsgraph);
1705         /* Calculate then execute each curve. */
1706         for (FCurve *fcu = list->first; fcu; fcu = fcu->next) {
1707                 /* Check if this F-Curve doesn't belong to a muted group. */
1708                 if ((fcu->grp != NULL) && (fcu->grp->flag & AGRP_MUTED)) {
1709                         continue;
1710                 }
1711                 /* Check if this curve should be skipped. */
1712                 if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED))) {
1713                         continue;
1714                 }
1715                 PathResolvedRNA anim_rna;
1716                 if (animsys_store_rna_setting(ptr, fcu->rna_path, fcu->array_index, &anim_rna)) {
1717                         const float curval = calculate_fcurve(&anim_rna, fcu, ctime);
1718                         animsys_write_rna_setting(&anim_rna, curval);
1719                         if (is_active_depsgraph) {
1720                                 animsys_write_orig_anim_rna(ptr, fcu->rna_path, fcu->array_index, curval);
1721                         }
1722                 }
1723         }
1724 }
1725
1726 /* ***************************************** */
1727 /* Driver Evaluation */
1728
1729 /* Evaluate Drivers */
1730 static void animsys_evaluate_drivers(PointerRNA *ptr, AnimData *adt, float ctime)
1731 {
1732         FCurve *fcu;
1733
1734         /* drivers are stored as F-Curves, but we cannot use the standard code, as we need to check if
1735          * the depsgraph requested that this driver be evaluated...
1736          */
1737         for (fcu = adt->drivers.first; fcu; fcu = fcu->next) {
1738                 ChannelDriver *driver = fcu->driver;
1739                 bool ok = false;
1740
1741                 /* check if this driver's curve should be skipped */
1742                 if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED)) == 0) {
1743                         /* check if driver itself is tagged for recalculation */
1744                         /* XXX driver recalc flag is not set yet by depsgraph! */
1745                         if ((driver) && !(driver->flag & DRIVER_FLAG_INVALID) /*&& (driver->flag & DRIVER_FLAG_RECALC)*/) {
1746                                 /* evaluate this using values set already in other places
1747                                  * NOTE: for 'layering' option later on, we should check if we should remove old value before adding
1748                                  *       new to only be done when drivers only changed */
1749
1750                                 PathResolvedRNA anim_rna;
1751                                 if (animsys_store_rna_setting(ptr, fcu->rna_path, fcu->array_index, &anim_rna)) {
1752                                         const float curval = calculate_fcurve(&anim_rna, fcu, ctime);
1753                                         ok = animsys_write_rna_setting(&anim_rna, curval);
1754                                 }
1755
1756                                 /* clear recalc flag */
1757                                 driver->flag &= ~DRIVER_FLAG_RECALC;
1758
1759                                 /* set error-flag if evaluation failed */
1760                                 if (ok == 0)
1761                                         driver->flag |= DRIVER_FLAG_INVALID;
1762                         }
1763                 }
1764         }
1765 }
1766
1767 /* ***************************************** */
1768 /* Actions Evaluation */
1769
1770 /* strictly not necessary for actual "evaluation", but it is a useful safety check
1771  * to reduce the amount of times that users end up having to "revive" wrongly-assigned
1772  * actions
1773  */
1774 static void action_idcode_patch_check(ID *id, bAction *act)
1775 {
1776         int idcode = 0;
1777
1778         /* just in case */
1779         if (ELEM(NULL, id, act))
1780                 return;
1781         else
1782                 idcode = GS(id->name);
1783
1784         /* the actual checks... hopefully not too much of a performance hit in the long run... */
1785         if (act->idroot == 0) {
1786                 /* use the current root if not set already (i.e. newly created actions and actions from 2.50-2.57 builds)
1787                  * - this has problems if there are 2 users, and the first one encountered is the invalid one
1788                  *   in which case, the user will need to manually fix this (?)
1789                  */
1790                 act->idroot = idcode;
1791         }
1792         else if (act->idroot != idcode) {
1793                 /* only report this error if debug mode is enabled (to save performance everywhere else) */
1794                 if (G.debug & G_DEBUG) {
1795                         printf("AnimSys Safety Check Failed: Action '%s' is not meant to be used from ID-Blocks of type %d such as '%s'\n",
1796                                act->id.name + 2, idcode, id->name);
1797                 }
1798         }
1799 }
1800
1801 /* ----------------------------------------- */
1802
1803 /* Evaluate Action Group */
1804 void animsys_evaluate_action_group(PointerRNA *ptr, bAction *act, bActionGroup *agrp, float ctime)
1805 {
1806         FCurve *fcu;
1807
1808         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
1809         if (ELEM(NULL, act, agrp)) return;
1810
1811         action_idcode_patch_check(ptr->id.data, act);
1812
1813         /* if group is muted, don't evaluated any of the F-Curve */
1814         if (agrp->flag & AGRP_MUTED)
1815                 return;
1816
1817         /* calculate then execute each curve */
1818         for (fcu = agrp->channels.first; (fcu) && (fcu->grp == agrp); fcu = fcu->next) {
1819                 /* check if this curve should be skipped */
1820                 if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED)) == 0) {
1821                         PathResolvedRNA anim_rna;
1822                         if (animsys_store_rna_setting(ptr, fcu->rna_path, fcu->array_index, &anim_rna)) {
1823                                 const float curval = calculate_fcurve(&anim_rna, fcu, ctime);
1824                                 animsys_write_rna_setting(&anim_rna, curval);
1825                         }
1826                 }
1827         }
1828 }
1829
1830 /* Evaluate Action (F-Curve Bag) */
1831 static void animsys_evaluate_action_ex(
1832         Depsgraph *depsgraph, PointerRNA *ptr, bAction *act, float ctime)
1833 {
1834         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
1835         if (act == NULL) return;
1836
1837         action_idcode_patch_check(ptr->id.data, act);
1838
1839         /* calculate then execute each curve */
1840         animsys_evaluate_fcurves(depsgraph, ptr, &act->curves, ctime);
1841 }
1842
1843 void animsys_evaluate_action(Depsgraph *depsgraph, PointerRNA *ptr, bAction *act, float ctime)
1844 {
1845         animsys_evaluate_action_ex(depsgraph, ptr, act, ctime);
1846 }
1847
1848 /* ***************************************** */
1849 /* NLA System - Evaluation */
1850
1851 /* calculate influence of strip based for given frame based on blendin/out values */
1852 static float nlastrip_get_influence(NlaStrip *strip, float cframe)
1853 {
1854         /* sanity checks - normalize the blendin/out values? */
1855         strip->blendin = fabsf(strip->blendin);
1856         strip->blendout = fabsf(strip->blendout);
1857
1858         /* result depends on where frame is in respect to blendin/out values */
1859         if (IS_EQF(strip->blendin, 0.0f) == false && (cframe <= (strip->start + strip->blendin))) {
1860                 /* there is some blend-in */
1861                 return fabsf(cframe - strip->start) / (strip->blendin);
1862         }
1863         else if (IS_EQF(strip->blendout, 0.0f) == false && (cframe >= (strip->end - strip->blendout))) {
1864                 /* there is some blend-out */
1865                 return fabsf(strip->end - cframe) / (strip->blendout);
1866         }
1867         else {
1868                 /* in the middle of the strip, we should be full strength */
1869                 return 1.0f;
1870         }
1871 }
1872
1873 /* evaluate the evaluation time and influence for the strip, storing the results in the strip */
1874 static void nlastrip_evaluate_controls(Depsgraph *depsgraph, NlaStrip *strip, float ctime)
1875 {
1876         /* now strip's evaluate F-Curves for these settings (if applicable) */
1877         if (strip->fcurves.first) {
1878                 PointerRNA strip_ptr;
1879
1880                 /* create RNA-pointer needed to set values */
1881                 RNA_pointer_create(NULL, &RNA_NlaStrip, strip, &strip_ptr);
1882
1883                 /* execute these settings as per normal */
1884                 animsys_evaluate_fcurves(depsgraph, &strip_ptr, &strip->fcurves, ctime);
1885         }
1886
1887         /* analytically generate values for influence and time (if applicable)
1888          * - we do this after the F-Curves have been evaluated to override the effects of those
1889          *   in case the override has been turned off.
1890          */
1891         if ((strip->flag & NLASTRIP_FLAG_USR_TIME) == 0)
1892                 strip->strip_time = nlastrip_get_frame(strip, ctime, NLATIME_CONVERT_EVAL);
1893         if ((strip->flag & NLASTRIP_FLAG_USR_INFLUENCE) == 0)
1894                 strip->influence = nlastrip_get_influence(strip, ctime);
1895
1896         /* if user can control the evaluation time (using F-Curves), consider the option which allows this time to be clamped
1897          * to lie within extents of the action-clip, so that a steady changing rate of progress through several cycles of the clip
1898          * can be achieved easily
1899          */
1900         /* NOTE: if we add any more of these special cases, we better group them up nicely... */
1901         if ((strip->flag & NLASTRIP_FLAG_USR_TIME) && (strip->flag & NLASTRIP_FLAG_USR_TIME_CYCLIC))
1902                 strip->strip_time = fmod(strip->strip_time - strip->actstart, strip->actend - strip->actstart);
1903 }
1904
1905 /* gets the strip active at the current time for a list of strips for evaluation purposes */
1906 NlaEvalStrip *nlastrips_ctime_get_strip(Depsgraph *depsgraph, ListBase *list, ListBase *strips, short index, float ctime)
1907 {
1908         NlaStrip *strip, *estrip = NULL;
1909         NlaEvalStrip *nes;
1910         short side = 0;
1911
1912         /* loop over strips, checking if they fall within the range */
1913         for (strip = strips->first; strip; strip = strip->next) {
1914                 /* check if current time occurs within this strip  */
1915                 if (IN_RANGE_INCL(ctime, strip->start, strip->end)) {
1916                         /* this strip is active, so try to use it */
1917                         estrip = strip;
1918                         side = NES_TIME_WITHIN;
1919                         break;
1920                 }
1921
1922                 /* if time occurred before current strip... */
1923                 if (ctime < strip->start) {
1924                         if (strip == strips->first) {
1925                                 /* before first strip - only try to use it if it extends backwards in time too */
1926                                 if (strip->extendmode == NLASTRIP_EXTEND_HOLD)
1927                                         estrip = strip;
1928
1929                                 /* side is 'before' regardless of whether there's a useful strip */
1930                                 side = NES_TIME_BEFORE;
1931                         }
1932                         else {
1933                                 /* before next strip - previous strip has ended, but next hasn't begun,
1934                                  * so blending mode depends on whether strip is being held or not...
1935                                  * - only occurs when no transition strip added, otherwise the transition would have
1936                                  *   been picked up above...
1937                                  */
1938                                 strip = strip->prev;
1939
1940                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
1941                                         estrip = strip;
1942                                 side = NES_TIME_AFTER;
1943                         }
1944                         break;
1945                 }
1946
1947                 /* if time occurred after current strip... */
1948                 if (ctime > strip->end) {
1949                         /* only if this is the last strip should we do anything, and only if that is being held */
1950                         if (strip == strips->last) {
1951                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
1952                                         estrip = strip;
1953
1954                                 side = NES_TIME_AFTER;
1955                                 break;
1956                         }
1957
1958                         /* otherwise, skip... as the 'before' case will catch it more elegantly! */
1959                 }
1960         }
1961
1962         /* check if a valid strip was found
1963          * - must not be muted (i.e. will have contribution
1964          */
1965         if ((estrip == NULL) || (estrip->flag & NLASTRIP_FLAG_MUTED))
1966                 return NULL;
1967
1968         /* if ctime was not within the boundaries of the strip, clamp! */
1969         switch (side) {
1970                 case NES_TIME_BEFORE: /* extend first frame only */
1971                         ctime = estrip->start;
1972                         break;
1973                 case NES_TIME_AFTER: /* extend last frame only */
1974                         ctime = estrip->end;
1975                         break;
1976         }
1977
1978         /* evaluate strip's evaluation controls
1979          * - skip if no influence (i.e. same effect as muting the strip)
1980          * - negative influence is not supported yet... how would that be defined?
1981          */
1982         /* TODO: this sounds a bit hacky having a few isolated F-Curves stuck on some data it operates on... */
1983         nlastrip_evaluate_controls(depsgraph, estrip, ctime);
1984         if (estrip->influence <= 0.0f)
1985                 return NULL;
1986
1987         /* check if strip has valid data to evaluate,
1988          * and/or perform any additional type-specific actions
1989          */
1990         switch (estrip->type) {
1991                 case NLASTRIP_TYPE_CLIP:
1992                         /* clip must have some action to evaluate */
1993                         if (estrip->act == NULL)
1994                                 return NULL;
1995                         break;
1996                 case NLASTRIP_TYPE_TRANSITION:
1997                         /* there must be strips to transition from and to (i.e. prev and next required) */
1998                         if (ELEM(NULL, estrip->prev, estrip->next))
1999                                 return NULL;
2000
2001                         /* evaluate controls for the relevant extents of the bordering strips... */
2002                         nlastrip_evaluate_controls(depsgraph, estrip->prev, estrip->start);
2003                         nlastrip_evaluate_controls(depsgraph, estrip->next, estrip->end);
2004                         break;
2005         }
2006
2007         /* add to list of strips we need to evaluate */
2008         nes = MEM_callocN(sizeof(NlaEvalStrip), "NlaEvalStrip");
2009
2010         nes->strip = estrip;
2011         nes->strip_mode = side;
2012         nes->track_index = index;
2013         nes->strip_time = estrip->strip_time;
2014
2015         if (list)
2016                 BLI_addtail(list, nes);
2017
2018         return nes;
2019 }
2020
2021 /* ---------------------- */
2022
2023 /* Initialize a valid mask, allocating memory if necessary. */
2024 static void nlavalidmask_init(NlaValidMask *mask, int bits)
2025 {
2026         if (BLI_BITMAP_SIZE(bits) > sizeof(mask->buffer)) {
2027                 mask->ptr = BLI_BITMAP_NEW(bits, "NlaValidMask");
2028         }
2029         else {
2030                 mask->ptr = mask->buffer;
2031         }
2032 }
2033
2034 /* Free allocated memory for the mask. */
2035 static void nlavalidmask_free(NlaValidMask *mask)
2036 {
2037         if (mask->ptr != mask->buffer) {
2038                 MEM_freeN(mask->ptr);
2039         }
2040 }
2041
2042 /* ---------------------- */
2043
2044 /* Hashing functions for NlaEvalChannelKey. */
2045 static uint nlaevalchan_keyhash(const void *ptr)
2046 {
2047         const NlaEvalChannelKey *key = ptr;
2048         uint hash = BLI_ghashutil_ptrhash(key->ptr.data);
2049         return hash ^ BLI_ghashutil_ptrhash(key->prop);
2050 }
2051
2052 static bool nlaevalchan_keycmp(const void *a, const void *b)
2053 {
2054         const NlaEvalChannelKey *A = a;
2055         const NlaEvalChannelKey *B = b;
2056
2057         return ((A->ptr.data != B->ptr.data) ||
2058                 (A->prop != B->prop));
2059 }
2060
2061 /* ---------------------- */
2062
2063 /* Allocate a new blending value snapshot for the channel. */
2064 static NlaEvalChannelSnapshot *nlaevalchan_snapshot_new(NlaEvalChannel *nec)
2065 {
2066         int length = nec->base_snapshot.length;
2067
2068         size_t byte_size = sizeof(NlaEvalChannelSnapshot) + sizeof(float) * length;
2069         NlaEvalChannelSnapshot *nec_snapshot = MEM_callocN(byte_size, "NlaEvalChannelSnapshot");
2070
2071         nec_snapshot->channel = nec;
2072         nec_snapshot->length = length;
2073
2074         return nec_snapshot;
2075 }
2076
2077 /* Free a channel's blending value snapshot. */
2078 static void nlaevalchan_snapshot_free(NlaEvalChannelSnapshot *nec_snapshot)
2079 {
2080         BLI_assert(!nec_snapshot->is_base);
2081
2082         MEM_freeN(nec_snapshot);
2083 }
2084
2085 /* Copy all data in the snapshot. */
2086 static void nlaevalchan_snapshot_copy(NlaEvalChannelSnapshot *dst, const NlaEvalChannelSnapshot *src)
2087 {
2088         BLI_assert(dst->channel == src->channel);
2089
2090         memcpy(dst->values, src->values, sizeof(float) * dst->length);
2091 }
2092
2093 /* ---------------------- */
2094
2095 /* Initialize a blending state snapshot structure. */
2096 static void nlaeval_snapshot_init(NlaEvalSnapshot *snapshot, NlaEvalData *nlaeval, NlaEvalSnapshot *base)
2097 {
2098         snapshot->base = base;
2099         snapshot->size = MAX2(16, nlaeval->num_channels);
2100         snapshot->channels = MEM_callocN(sizeof(*snapshot->channels) * snapshot->size, "NlaEvalSnapshot::channels");
2101 }
2102
2103 /* Retrieve the individual channel snapshot. */
2104 static NlaEvalChannelSnapshot *nlaeval_snapshot_get(NlaEvalSnapshot *snapshot, int index)
2105 {
2106         return (index < snapshot->size) ? snapshot->channels[index] : NULL;
2107 }
2108
2109 /* Ensure at least this number of slots exists. */
2110 static void nlaeval_snapshot_ensure_size(NlaEvalSnapshot *snapshot, int size)
2111 {
2112         if (size > snapshot->size) {
2113                 snapshot->size *= 2;
2114                 CLAMP_MIN(snapshot->size, size);
2115                 CLAMP_MIN(snapshot->size, 16);
2116
2117                 size_t byte_size = sizeof(*snapshot->channels) * snapshot->size;
2118                 snapshot->channels = MEM_recallocN_id(snapshot->channels, byte_size, "NlaEvalSnapshot::channels");
2119         }
2120 }
2121
2122 /* Retrieve the address of a slot in the blending state snapshot for this channel (may realloc). */
2123 static NlaEvalChannelSnapshot **nlaeval_snapshot_ensure_slot(NlaEvalSnapshot *snapshot, NlaEvalChannel *nec)
2124 {
2125         nlaeval_snapshot_ensure_size(snapshot, nec->owner->num_channels);
2126         return &snapshot->channels[nec->index];
2127 }
2128
2129 /* Retrieve the blending snapshot for the specified channel, with fallback to base. */
2130 static NlaEvalChannelSnapshot *nlaeval_snapshot_find_channel(NlaEvalSnapshot *snapshot, NlaEvalChannel *nec)
2131 {
2132         while (snapshot != NULL) {
2133                 NlaEvalChannelSnapshot *nec_snapshot = nlaeval_snapshot_get(snapshot, nec->index);
2134                 if (nec_snapshot != NULL) {
2135                         return nec_snapshot;
2136                 }
2137                 snapshot = snapshot->base;
2138         }
2139
2140         return &nec->base_snapshot;
2141 }
2142
2143 /* Retrieve or create the channel value snapshot, copying from the other snapshot (or default values) */
2144 static NlaEvalChannelSnapshot *nlaeval_snapshot_ensure_channel(NlaEvalSnapshot *snapshot, NlaEvalChannel *nec)
2145 {
2146         NlaEvalChannelSnapshot **slot = nlaeval_snapshot_ensure_slot(snapshot, nec);
2147
2148         if (*slot == NULL) {
2149                 NlaEvalChannelSnapshot *base_snapshot, *nec_snapshot;
2150
2151                 nec_snapshot = nlaevalchan_snapshot_new(nec);
2152                 base_snapshot = nlaeval_snapshot_find_channel(snapshot->base, nec);
2153
2154                 nlaevalchan_snapshot_copy(nec_snapshot, base_snapshot);
2155
2156                 *slot = nec_snapshot;
2157         }
2158
2159         return *slot;
2160 }
2161
2162 /* Free all memory owned by this blending snapshot structure. */
2163 static void nlaeval_snapshot_free_data(NlaEvalSnapshot *snapshot)
2164 {
2165         if (snapshot->channels != NULL) {
2166                 for (int i = 0; i < snapshot->size; i++) {
2167                         NlaEvalChannelSnapshot *nec_snapshot = snapshot->channels[i];
2168                         if (nec_snapshot != NULL) {
2169                                 nlaevalchan_snapshot_free(nec_snapshot);
2170                         }
2171                 }
2172
2173                 MEM_freeN(snapshot->channels);
2174         }
2175
2176         snapshot->base = NULL;
2177         snapshot->size = 0;
2178         snapshot->channels = NULL;
2179 }
2180
2181 /* ---------------------- */
2182
2183 /* Free memory owned by this evaluation channel. */
2184 static void nlaevalchan_free_data(NlaEvalChannel *nec)
2185 {
2186         nlavalidmask_free(&nec->valid);
2187 }
2188
2189 /* Initialize a full NLA evaluation state structure. */
2190 static void nlaeval_init(NlaEvalData *nlaeval)
2191 {
2192         memset(nlaeval, 0, sizeof(*nlaeval));
2193
2194         nlaeval->path_hash = BLI_ghash_str_new("NlaEvalData::path_hash");
2195         nlaeval->key_hash = BLI_ghash_new(nlaevalchan_keyhash, nlaevalchan_keycmp, "NlaEvalData::key_hash");
2196 }
2197
2198 static void nlaeval_free(NlaEvalData *nlaeval)
2199 {
2200         /* Delete base snapshot - its channels are part of NlaEvalChannel and shouldn't be freed. */
2201         MEM_SAFE_FREE(nlaeval->base_snapshot.channels);
2202
2203         /* Delete result snapshot. */
2204         nlaeval_snapshot_free_data(&nlaeval->eval_snapshot);
2205
2206         /* Delete channels. */
2207         for (NlaEvalChannel *nec = nlaeval->channels.first; nec; nec = nec->next) {
2208                 nlaevalchan_free_data(nec);
2209         }
2210
2211         BLI_freelistN(&nlaeval->channels);
2212         BLI_ghash_free(nlaeval->path_hash, NULL, NULL);
2213         BLI_ghash_free(nlaeval->key_hash, NULL, NULL);
2214 }
2215
2216 /* ---------------------- */
2217
2218 static int nlaevalchan_validate_index(NlaEvalChannel *nec, int index)
2219 {
2220         if (nec->is_array) {
2221                 if (index >= 0 && index < nec->base_snapshot.length) {
2222                         return index;
2223                 }
2224
2225                 return -1;
2226         }
2227         else {
2228                 return 0;
2229         }
2230 }
2231
2232 /* Initialise default values for NlaEvalChannel from the property data. */
2233 static void nlaevalchan_get_default_values(NlaEvalChannel *nec, float *r_values)
2234 {
2235         PointerRNA *ptr = &nec->key.ptr;
2236         PropertyRNA *prop = nec->key.prop;
2237         int length = nec->base_snapshot.length;
2238
2239         /* NOTE: while this doesn't work for all RNA properties as default values aren't in fact
2240          * set properly for most of them, at least the common ones (which also happen to get used
2241          * in NLA strips a lot, e.g. scale) are set correctly.
2242          */
2243         if (RNA_property_array_check(prop)) {
2244                 BLI_assert(length == RNA_property_array_length(ptr, prop));
2245                 bool *tmp_bool;
2246                 int *tmp_int;
2247
2248                 switch (RNA_property_type(prop)) {
2249                         case PROP_BOOLEAN:
2250                                 tmp_bool = MEM_malloc_arrayN(sizeof(*tmp_bool), length, __func__);
2251                                 RNA_property_boolean_get_default_array(ptr, prop, tmp_bool);
2252                                 for (int i = 0; i < length; i++) {
2253                                         r_values[i] = (float)tmp_bool[i];
2254                                 }
2255                                 MEM_freeN(tmp_bool);
2256                                 break;
2257                         case PROP_INT:
2258                                 tmp_int = MEM_malloc_arrayN(sizeof(*tmp_int), length, __func__);
2259                                 RNA_property_int_get_default_array(ptr, prop, tmp_int);
2260                                 for (int i = 0; i < length; i++) {
2261                                         r_values[i] = (float)tmp_int[i];
2262                                 }
2263                                 MEM_freeN(tmp_int);
2264                                 break;
2265                         case PROP_FLOAT:
2266                                 RNA_property_float_get_default_array(ptr, prop, r_values);
2267                                 break;
2268                         default:
2269                                 memset(r_values, 0, sizeof(float) * length);
2270                 }
2271         }
2272         else {
2273                 BLI_assert(length == 1);
2274
2275                 switch (RNA_property_type(prop)) {
2276                         case PROP_BOOLEAN:
2277                                 *r_values = (float)RNA_property_boolean_get_default(ptr, prop);
2278                                 break;
2279                         case PROP_INT:
2280                                 *r_values = (float)RNA_property_int_get_default(ptr, prop);
2281                                 break;
2282                         case PROP_FLOAT:
2283                                 *r_values = RNA_property_float_get_default(ptr, prop);
2284                                 break;
2285                         case PROP_ENUM:
2286                                 *r_values = (float)RNA_property_enum_get_default(ptr, prop);
2287                                 break;
2288                         default:
2289                                 *r_values = 0.0f;
2290                 }
2291         }
2292 }
2293
2294 /* Verify that an appropriate NlaEvalChannel for this property exists. */
2295 static NlaEvalChannel *nlaevalchan_verify_key(NlaEvalData *nlaeval, const char *path, NlaEvalChannelKey *key)
2296 {
2297         /* Look it up in the key hash. */
2298         NlaEvalChannel **p_key_nec;
2299         NlaEvalChannelKey **p_key;
2300         bool found_key = BLI_ghash_ensure_p_ex(nlaeval->key_hash, key, (void***)&p_key, (void***)&p_key_nec);
2301
2302         if (found_key) {
2303                 return *p_key_nec;
2304         }
2305
2306         /* Create the channel. */
2307         bool is_array = RNA_property_array_check(key->prop);
2308         int length = is_array ? RNA_property_array_length(&key->ptr, key->prop) : 1;
2309
2310         NlaEvalChannel *nec = MEM_callocN(sizeof(NlaEvalChannel) + sizeof(float) * length, "NlaEvalChannel");
2311
2312         /* Initialize the channel. */
2313         nec->rna_path = path;
2314         nec->key = *key;
2315
2316         nec->owner = nlaeval;
2317         nec->index = nlaeval->num_channels++;
2318         nec->is_array = is_array;
2319
2320         nlavalidmask_init(&nec->valid, length);
2321
2322         nec->base_snapshot.channel = nec;
2323         nec->base_snapshot.length = length;
2324         nec->base_snapshot.is_base = true;
2325
2326         nlaevalchan_get_default_values(nec, nec->base_snapshot.values);
2327
2328         /* Store channel in data structures. */
2329         BLI_addtail(&nlaeval->channels, nec);
2330
2331         *nlaeval_snapshot_ensure_slot(&nlaeval->base_snapshot, nec) = &nec->base_snapshot;
2332
2333         *p_key_nec = nec;
2334         *p_key = &nec->key;
2335
2336         return nec;
2337 }
2338
2339 /* Verify that an appropriate NlaEvalChannel for this path exists. */
2340 static NlaEvalChannel *nlaevalchan_verify(PointerRNA *ptr, NlaEvalData *nlaeval, const char *path)
2341 {
2342         if (path == NULL) {
2343                 return NULL;
2344         }
2345
2346         /* Lookup the path in the path based hash. */
2347         NlaEvalChannel **p_path_nec;
2348         bool found_path = BLI_ghash_ensure_p(nlaeval->path_hash, (void*)path, (void***)&p_path_nec);
2349
2350         if (found_path) {
2351                 return *p_path_nec;
2352         }
2353
2354         /* Resolve the property and look it up in the key hash. */
2355         NlaEvalChannelKey key;
2356
2357         if (!RNA_path_resolve_property(ptr, path, &key.ptr, &key.prop)) {
2358                 /* Report failure to resolve the path. */
2359                 if (G.debug & G_DEBUG) {
2360                         printf("Animato: Invalid path. ID = '%s',  '%s'\n",
2361                                (ptr->id.data) ? (((ID *)ptr->id.data)->name + 2) : "<No ID>", path);
2362                 }
2363
2364                 /* Cache NULL result. */
2365                 *p_path_nec = NULL;
2366                 return NULL;
2367         }
2368
2369         NlaEvalChannel *nec = nlaevalchan_verify_key(nlaeval, path, &key);
2370
2371         if (nec->rna_path == NULL) {
2372                 nec->rna_path = path;
2373         }
2374
2375         return *p_path_nec = nec;
2376 }
2377
2378 /* ---------------------- */
2379
2380 /* accumulate the old and new values of a channel according to mode and influence */
2381 static float nla_blend_value(int blendmode, float old_value, float value, float inf)
2382 {
2383         /* optimisation: no need to try applying if there is no influence */
2384         if (IS_EQF(inf, 0.0f)) {
2385                 return old_value;
2386         }
2387
2388         /* perform blending */
2389         switch (blendmode) {
2390                 case NLASTRIP_MODE_ADD:
2391                         /* simply add the scaled value on to the stack */
2392                         return old_value + (value * inf);
2393
2394                 case NLASTRIP_MODE_SUBTRACT:
2395                         /* simply subtract the scaled value from the stack */
2396                         return old_value - (value * inf);
2397
2398                 case NLASTRIP_MODE_MULTIPLY:
2399                         /* multiply the scaled value with the stack */
2400                         /* Formula Used:
2401                          *     result = fac * (a * b) + (1 - fac) * a
2402                          */
2403                         return inf * (old_value * value)  +   (1 - inf) * old_value;
2404
2405                 case NLASTRIP_MODE_REPLACE:
2406                 default: /* TODO: do we really want to blend by default? it seems more uses might prefer add... */
2407                         /* do linear interpolation
2408                          * - the influence of the accumulated data (elsewhere, that is called dstweight)
2409                          *   is 1 - influence, since the strip's influence is srcweight
2410                          */
2411                         return old_value * (1.0f - inf)   +   (value * inf);
2412         }
2413 }
2414
2415 /* compute the value that would blend to the desired target value using nla_blend_value */
2416 static bool nla_invert_blend_value(int blend_mode, float old_value, float target_value, float influence, float *r_value)
2417 {
2418         switch (blend_mode) {
2419                 case NLASTRIP_MODE_ADD:
2420                         *r_value = (target_value - old_value) / influence;
2421                         return true;
2422
2423                 case NLASTRIP_MODE_SUBTRACT:
2424                         *r_value = (old_value - target_value) / influence;
2425                         return true;
2426
2427                 case NLASTRIP_MODE_MULTIPLY:
2428                         if (old_value == 0.0f) {
2429                                 /* Resolve 0/0 to 1. */
2430                                 if (target_value == 0.0f) {
2431                                         *r_value = 1.0f;
2432                                         return true;
2433                                 }
2434                                 /* Division by zero. */
2435                                 return false;
2436                         }
2437                         else {
2438                                 *r_value = (target_value - old_value) / influence / old_value + 1.0f;
2439                                 return true;
2440                         }
2441
2442                 case NLASTRIP_MODE_REPLACE:
2443                 default:
2444                         *r_value = (target_value - old_value) / influence + old_value;
2445                         return true;
2446         }
2447 }
2448
2449 /* Data about the current blend mode. */
2450 typedef struct NlaBlendData {
2451         NlaEvalSnapshot *snapshot;
2452         int mode;
2453         float influence;
2454 } NlaBlendData;
2455
2456 /* Accumulate (i.e. blend) the given value on to the channel it affects. */
2457 static bool nlaeval_blend_value(NlaBlendData *blend, NlaEvalChannel *nec, int array_index, float value)
2458 {
2459         if (nec == NULL) {
2460                 return false;
2461         }
2462
2463         int index = nlaevalchan_validate_index(nec, array_index);
2464
2465         if (index < 0) {
2466                 if (G.debug & G_DEBUG) {
2467                         ID *id = nec->key.ptr.id.data;
2468                         printf("Animato: Invalid array index. ID = '%s',  '%s[%d]', array length is %d\n",
2469                                id ? (id->name + 2) : "<No ID>", nec->rna_path, array_index, nec->base_snapshot.length);
2470                 }
2471
2472                 return false;
2473         }
2474
2475         BLI_BITMAP_ENABLE(nec->valid.ptr, index);
2476
2477         NlaEvalChannelSnapshot *nec_snapshot = nlaeval_snapshot_ensure_channel(blend->snapshot, nec);
2478
2479         nec_snapshot->values[index] = nla_blend_value(blend->mode, nec_snapshot->values[index], value, blend->influence);
2480
2481         return true;
2482 }
2483
2484 /* Blend the specified snapshots into the target, and free the input snapshots. */
2485 static void nlaeval_snapshot_mix_and_free(NlaEvalData *nlaeval, NlaEvalSnapshot *out, NlaEvalSnapshot *in1, NlaEvalSnapshot *in2, float alpha)
2486 {
2487         BLI_assert(in1->base == out && in2->base == out);
2488
2489         nlaeval_snapshot_ensure_size(out, nlaeval->num_channels);
2490
2491         for (int i = 0; i < nlaeval->num_channels; i++) {
2492                 NlaEvalChannelSnapshot *c_in1 = nlaeval_snapshot_get(in1, i);
2493                 NlaEvalChannelSnapshot *c_in2 = nlaeval_snapshot_get(in2, i);
2494
2495                 if (c_in1 || c_in2) {
2496                         NlaEvalChannelSnapshot *c_out = out->channels[i];
2497
2498                         /* Steal the entry from one of the input snapshots. */
2499                         if (c_out == NULL) {
2500                                 if (c_in1 != NULL) {
2501                                         c_out = c_in1;
2502                                         in1->channels[i] = NULL;
2503                                 }
2504                                 else {
2505                                         c_out = c_in2;
2506                                         in2->channels[i] = NULL;
2507                                 }
2508                         }
2509
2510                         if (c_in1 == NULL) {
2511                                 c_in1 = nlaeval_snapshot_find_channel(in1->base, c_out->channel);
2512                         }
2513                         if (c_in2 == NULL) {
2514                                 c_in2 = nlaeval_snapshot_find_channel(in2->base, c_out->channel);
2515                         }
2516
2517                         out->channels[i] = c_out;
2518
2519                         for (int j = 0; j < c_out->length; j++) {
2520                                 c_out->values[j] = c_in1->values[j] * (1.0f - alpha) + c_in2->values[j] * alpha;
2521                         }
2522                 }
2523         }
2524
2525         nlaeval_snapshot_free_data(in1);
2526         nlaeval_snapshot_free_data(in2);
2527 }
2528
2529 /* ---------------------- */
2530 /* F-Modifier stack joining/separation utilities - should we generalise these for BLI_listbase.h interface? */
2531
2532 /* Temporarily join two lists of modifiers together, storing the result in a third list */
2533 static void nlaeval_fmodifiers_join_stacks(ListBase *result, ListBase *list1, ListBase *list2)
2534 {
2535         FModifier *fcm1, *fcm2;
2536
2537         /* if list1 is invalid...  */
2538         if (ELEM(NULL, list1, list1->first)) {
2539                 if (list2 && list2->first) {
2540                         result->first = list2->first;
2541                         result->last = list2->last;
2542                 }
2543         }
2544         /* if list 2 is invalid... */
2545         else if (ELEM(NULL, list2, list2->first)) {
2546                 result->first = list1->first;
2547                 result->last = list1->last;
2548         }
2549         else {
2550                 /* list1 should be added first, and list2 second, with the endpoints of these being the endpoints for result
2551                  * - the original lists must be left unchanged though, as we need that fact for restoring
2552                  */
2553                 result->first = list1->first;
2554                 result->last = list2->last;
2555
2556                 fcm1 = list1->last;
2557                 fcm2 = list2->first;
2558
2559                 fcm1->next = fcm2;
2560                 fcm2->prev = fcm1;
2561         }
2562 }
2563
2564 /* Split two temporary lists of modifiers */
2565 static void nlaeval_fmodifiers_split_stacks(ListBase *list1, ListBase *list2)
2566 {
2567         FModifier *fcm1, *fcm2;
2568
2569         /* if list1/2 is invalid... just skip */
2570         if (ELEM(NULL, list1, list2))
2571                 return;
2572         if (ELEM(NULL, list1->first, list2->first))
2573                 return;
2574
2575         /* get endpoints */
2576         fcm1 = list1->last;
2577         fcm2 = list2->first;
2578
2579         /* clear their links */
2580         fcm1->next = NULL;
2581         fcm2->prev = NULL;
2582 }
2583
2584 /* ---------------------- */
2585
2586 /* evaluate action-clip strip */
2587 static void nlastrip_evaluate_actionclip(PointerRNA *ptr, NlaEvalData *channels, ListBase *modifiers, NlaEvalStrip *nes, NlaEvalSnapshot *snapshot)
2588 {
2589         FModifierStackStorage *storage;
2590         ListBase tmp_modifiers = {NULL, NULL};
2591         NlaStrip *strip = nes->strip;
2592         FCurve *fcu;
2593         float evaltime;
2594
2595         /* sanity checks for action */
2596         if (strip == NULL)
2597                 return;
2598
2599         if (strip->act == NULL) {
2600                 printf("NLA-Strip Eval Error: Strip '%s' has no Action\n", strip->name);
2601                 return;
2602         }
2603
2604         action_idcode_patch_check(ptr->id.data, strip->act);
2605
2606         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
2607         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers);
2608
2609         /* evaluate strip's modifiers which modify time to evaluate the base curves at */
2610         storage = evaluate_fmodifiers_storage_new(&tmp_modifiers);
2611         evaltime = evaluate_time_fmodifiers(storage, &tmp_modifiers, NULL, 0.0f, strip->strip_time);
2612
2613         NlaBlendData blend = {
2614             .snapshot = snapshot,
2615             .mode = strip->blendmode,
2616             .influence = strip->influence,
2617         };
2618
2619         /* evaluate all the F-Curves in the action, saving the relevant pointers to data that will need to be used */
2620         for (fcu = strip->act->curves.first; fcu; fcu = fcu->next) {
2621                 float value = 0.0f;
2622
2623                 /* check if this curve should be skipped */
2624                 if (fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED))
2625                         continue;
2626                 if ((fcu->grp) && (fcu->grp->flag & AGRP_MUTED))
2627                         continue;
2628
2629                 /* evaluate the F-Curve's value for the time given in the strip
2630                  * NOTE: we use the modified time here, since strip's F-Curve Modifiers are applied on top of this
2631                  */
2632                 value = evaluate_fcurve(fcu, evaltime);
2633
2634                 /* apply strip's F-Curve Modifiers on this value
2635                  * NOTE: we apply the strip's original evaluation time not the modified one (as per standard F-Curve eval)
2636                  */
2637                 evaluate_value_fmodifiers(storage, &tmp_modifiers, fcu, &value, strip->strip_time);
2638
2639                 /* get an NLA evaluation channel to work with, and accumulate the evaluated value with the value(s)
2640                  * stored in this channel if it has been used already
2641                  */
2642                 NlaEvalChannel *nec = nlaevalchan_verify(ptr, channels, fcu->rna_path);
2643
2644                 nlaeval_blend_value(&blend, nec, fcu->array_index, value);
2645         }
2646
2647         /* free temporary storage */
2648         evaluate_fmodifiers_storage_free(storage);
2649
2650         /* unlink this strip's modifiers from the parent's modifiers again */
2651         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
2652 }
2653
2654 /* evaluate transition strip */
2655 static void nlastrip_evaluate_transition(
2656         Depsgraph *depsgraph, PointerRNA *ptr, NlaEvalData *channels, ListBase *modifiers, NlaEvalStrip *nes, NlaEvalSnapshot *snapshot)
2657 {
2658         ListBase tmp_modifiers = {NULL, NULL};
2659         NlaEvalSnapshot snapshot1, snapshot2;
2660         NlaEvalStrip tmp_nes;
2661         NlaStrip *s1, *s2;
2662
2663         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
2664         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &nes->strip->modifiers, modifiers);
2665
2666         /* get the two strips to operate on
2667          * - we use the endpoints of the strips directly flanking our strip
2668          *   using these as the endpoints of the transition (destination and source)
2669          * - these should have already been determined to be valid...
2670          * - if this strip is being played in reverse, we need to swap these endpoints
2671          *   otherwise they will be interpolated wrong
2672          */
2673         if (nes->strip->flag & NLASTRIP_FLAG_REVERSE) {
2674                 s1 = nes->strip->next;
2675                 s2 = nes->strip->prev;
2676         }
2677         else {
2678                 s1 = nes->strip->prev;
2679                 s2 = nes->strip->next;
2680         }
2681
2682         /* prepare template for 'evaluation strip'
2683          * - based on the transition strip's evaluation strip data
2684          * - strip_mode is NES_TIME_TRANSITION_* based on which endpoint
2685          * - strip_time is the 'normalized' (i.e. in-strip) time for evaluation,
2686          *   which doubles up as an additional weighting factor for the strip influences
2687          *   which allows us to appear to be 'interpolating' between the two extremes
2688          */
2689         tmp_nes = *nes;
2690
2691         /* evaluate these strips into a temp-buffer (tmp_channels) */
2692         /* FIXME: modifier evaluation here needs some work... */
2693         /* first strip */
2694         tmp_nes.strip_mode = NES_TIME_TRANSITION_START;
2695         tmp_nes.strip = s1;
2696         nlaeval_snapshot_init(&snapshot1, channels, snapshot);
2697         nlastrip_evaluate(depsgraph, ptr, channels, &tmp_modifiers, &tmp_nes, &snapshot1);
2698
2699         /* second strip */
2700         tmp_nes.strip_mode = NES_TIME_TRANSITION_END;
2701         tmp_nes.strip = s2;
2702         nlaeval_snapshot_init(&snapshot2, channels, snapshot);
2703         nlastrip_evaluate(depsgraph, ptr, channels, &tmp_modifiers, &tmp_nes, &snapshot2);
2704
2705         /* accumulate temp-buffer and full-buffer, using the 'real' strip */
2706         nlaeval_snapshot_mix_and_free(channels, snapshot, &snapshot1, &snapshot2, nes->strip_time);
2707
2708         /* unlink this strip's modifiers from the parent's modifiers again */
2709         nlaeval_fmodifiers_split_stacks(&nes->strip->modifiers, modifiers);
2710 }
2711
2712 /* evaluate meta-strip */
2713 static void nlastrip_evaluate_meta(
2714         Depsgraph *depsgraph, PointerRNA *ptr, NlaEvalData *channels, ListBase *modifiers, NlaEvalStrip *nes, NlaEvalSnapshot *snapshot)
2715 {
2716         ListBase tmp_modifiers = {NULL, NULL};
2717         NlaStrip *strip = nes->strip;
2718         NlaEvalStrip *tmp_nes;
2719         float evaltime;
2720
2721         /* meta-strip was calculated normally to have some time to be evaluated at
2722          * and here we 'look inside' the meta strip, treating it as a decorated window to
2723          * it's child strips, which get evaluated as if they were some tracks on a strip
2724          * (but with some extra modifiers to apply).
2725          *
2726          * NOTE: keep this in sync with animsys_evaluate_nla()
2727          */
2728
2729         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
2730         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers);
2731
2732         /* find the child-strip to evaluate */
2733         evaltime = (nes->strip_time * (strip->end - strip->start)) + strip->start;
2734         tmp_nes = nlastrips_ctime_get_strip(depsgraph, NULL, &strip->strips, -1, evaltime);
2735
2736         /* directly evaluate child strip into accumulation buffer...
2737          * - there's no need to use a temporary buffer (as it causes issues [T40082])
2738          */
2739         if (tmp_nes) {
2740                 nlastrip_evaluate(depsgraph, ptr, channels, &tmp_modifiers, tmp_nes, snapshot);
2741
2742                 /* free temp eval-strip */
2743                 MEM_freeN(tmp_nes);
2744         }
2745
2746         /* unlink this strip's modifiers from the parent's modifiers again */
2747         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
2748 }
2749
2750 /* evaluates the given evaluation strip */
2751 void nlastrip_evaluate(Depsgraph *depsgraph, PointerRNA *ptr, NlaEvalData *channels, ListBase *modifiers, NlaEvalStrip *nes, NlaEvalSnapshot *snapshot)
2752 {
2753         NlaStrip *strip = nes->strip;
2754
2755         /* to prevent potential infinite recursion problems (i.e. transition strip, beside meta strip containing a transition
2756          * several levels deep inside it), we tag the current strip as being evaluated, and clear this when we leave
2757          */
2758         /* TODO: be careful with this flag, since some edit tools may be running and have set this while animplayback was running */
2759         if (strip->flag & NLASTRIP_FLAG_EDIT_TOUCHED)
2760                 return;
2761         strip->flag |= NLASTRIP_FLAG_EDIT_TOUCHED;
2762
2763         /* actions to take depend on the type of strip */
2764         switch (strip->type) {
2765                 case NLASTRIP_TYPE_CLIP: /* action-clip */
2766                         nlastrip_evaluate_actionclip(ptr, channels, modifiers, nes, snapshot);
2767                         break;
2768                 case NLASTRIP_TYPE_TRANSITION: /* transition */
2769                         nlastrip_evaluate_transition(depsgraph, ptr, channels, modifiers, nes, snapshot);
2770                         break;
2771                 case NLASTRIP_TYPE_META: /* meta */
2772                         nlastrip_evaluate_meta(depsgraph, ptr, channels, modifiers, nes, snapshot);
2773                         break;
2774
2775                 default: /* do nothing */
2776                         break;
2777         }
2778
2779         /* clear temp recursion safe-check */
2780         strip->flag &= ~NLASTRIP_FLAG_EDIT_TOUCHED;
2781 }
2782
2783 /* write the accumulated settings to */
2784 void nladata_flush_channels(Depsgraph *depsgraph, PointerRNA *ptr, NlaEvalData *channels, NlaEvalSnapshot *snapshot)
2785 {
2786         /* sanity checks */
2787         if (channels == NULL)
2788                 return;
2789
2790         const bool is_active_depsgraph = DEG_is_active(depsgraph);
2791
2792         /* for each channel with accumulated values, write its value on the property it affects */
2793         for (NlaEvalChannel *nec = channels->channels.first; nec; nec = nec->next) {
2794                 NlaEvalChannelSnapshot *nec_snapshot = nlaeval_snapshot_find_channel(snapshot, nec);
2795
2796                 PathResolvedRNA rna = { nec->key.ptr, nec->key.prop, -1 };
2797
2798                 for (int i = 0; i < nec_snapshot->length; i++) {
2799                         if (BLI_BITMAP_TEST(nec->valid.ptr, i)) {
2800                                 float value = nec_snapshot->values[i];
2801                                 if (nec->is_array) {
2802                                         rna.prop_index = i;
2803                                 }
2804                                 animsys_write_rna_setting(&rna, value);
2805                                 if (is_active_depsgraph) {
2806                                         animsys_write_orig_anim_rna(ptr, nec->rna_path, rna.prop_index, value);
2807                                 }
2808                         }
2809                 }
2810         }
2811 }
2812
2813 /* ---------------------- */
2814
2815 static void nla_eval_domain_action(PointerRNA *ptr, NlaEvalData *channels, bAction *act, GSet *touched_actions)
2816 {
2817         if (!BLI_gset_add(touched_actions, act)) {
2818                 return;
2819         }
2820
2821         for (FCurve *fcu = act->curves.first; fcu; fcu = fcu->next) {
2822                 /* check if this curve should be skipped */
2823                 if (fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED))
2824                         continue;
2825                 if ((fcu->grp) && (fcu->grp->flag & AGRP_MUTED))
2826                         continue;
2827
2828                 NlaEvalChannel *nec = nlaevalchan_verify(ptr, channels, fcu->rna_path);
2829
2830                 if (nec != NULL) {
2831                         int idx = nlaevalchan_validate_index(nec, fcu->array_index);
2832
2833                         if (idx >= 0) {
2834                                 BLI_BITMAP_ENABLE(nec->valid.ptr, idx);
2835                         }
2836                 }
2837         }
2838 }
2839
2840 static void nla_eval_domain_strips(PointerRNA *ptr, NlaEvalData *channels, ListBase *strips, GSet *touched_actions)
2841 {
2842         for (NlaStrip *strip = strips->first; strip; strip = strip->next) {
2843                 /* check strip's action */
2844                 if (strip->act) {
2845                         nla_eval_domain_action(ptr, channels, strip->act, touched_actions);
2846                 }
2847
2848                 /* check sub-strips (if metas) */
2849                 nla_eval_domain_strips(ptr, channels, &strip->strips, touched_actions);
2850         }
2851 }
2852
2853 /**
2854  * Ensure that all channels touched by any of the actions in enabled tracks exist.
2855  * This is necessary to ensure that evaluation result depends only on current frame.
2856  */
2857 static void animsys_evaluate_nla_domain(PointerRNA *ptr, NlaEvalData *channels, AnimData *adt)
2858 {
2859         GSet *touched_actions = BLI_gset_ptr_new(__func__);
2860
2861         if (adt->action) {
2862                 nla_eval_domain_action(ptr, channels, adt->action, touched_actions);
2863         }
2864
2865         /* NLA Data - Animation Data for Strips */
2866         for (NlaTrack *nlt = adt->nla_tracks.first; nlt; nlt = nlt->next) {
2867                 /* solo and muting are mutually exclusive... */
2868                 if (adt->flag & ADT_NLA_SOLO_TRACK) {
2869                         /* skip if there is a solo track, but this isn't it */
2870                         if ((nlt->flag & NLATRACK_SOLO) == 0)
2871                                 continue;
2872                         /* else - mute doesn't matter */
2873                 }
2874                 else {
2875                         /* no solo tracks - skip track if muted */
2876                         if (nlt->flag & NLATRACK_MUTED)
2877                                 continue;
2878                 }
2879
2880                 nla_eval_domain_strips(ptr, channels, &nlt->strips, touched_actions);
2881         }
2882
2883         BLI_gset_free(touched_actions, NULL);
2884 }
2885
2886 /* ---------------------- */
2887
2888 /**
2889  * NLA Evaluation function - values are calculated and stored in temporary "NlaEvalChannels"
2890  *
2891  * \param[out] echannels Evaluation channels with calculated values
2892  * \param[out] r_context If not NULL, data about the currently edited strip is stored here and excluded from value calculation.
2893  * \return false if NLA evaluation isn't actually applicable
2894  */
2895 static bool animsys_evaluate_nla(Depsgraph *depsgraph, NlaEvalData *echannels, PointerRNA *ptr, AnimData *adt, float ctime, NlaKeyframingContext *r_context)
2896 {
2897         NlaTrack *nlt;
2898         short track_index = 0;
2899         bool has_strips = false;
2900
2901         ListBase estrips = {NULL, NULL};
2902         NlaEvalStrip *nes;
2903         NlaStrip dummy_strip_buf;
2904
2905         /* dummy strip for active action */
2906         NlaStrip *dummy_strip = r_context ? &r_context->strip : &dummy_strip_buf;
2907
2908         memset(dummy_strip, 0, sizeof(*dummy_strip));
2909
2910         /* 1. get the stack of strips to evaluate at current time (influence calculated here) */
2911         for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next, track_index++) {
2912                 /* stop here if tweaking is on and this strip is the tweaking track (it will be the first one that's 'disabled')... */
2913                 if ((adt->flag & ADT_NLA_EDIT_ON) && (nlt->flag & NLATRACK_DISABLED))
2914                         break;
2915
2916                 /* solo and muting are mutually exclusive... */
2917                 if (adt->flag & ADT_NLA_SOLO_TRACK) {
2918                         /* skip if there is a solo track, but this isn't it */
2919                         if ((nlt->flag & NLATRACK_SOLO) == 0)
2920                                 continue;
2921                         /* else - mute doesn't matter */
2922                 }
2923                 else {
2924                         /* no solo tracks - skip track if muted */
2925                         if (nlt->flag & NLATRACK_MUTED)
2926                                 continue;
2927                 }
2928
2929                 /* if this track has strips (but maybe they won't be suitable), set has_strips
2930                  * - used for mainly for still allowing normal action evaluation...
2931                  */
2932                 if (nlt->strips.first)
2933                         has_strips = true;
2934
2935                 /* otherwise, get strip to evaluate for this channel */
2936                 nes = nlastrips_ctime_get_strip(depsgraph, &estrips, &nlt->strips, track_index, ctime);
2937                 if (nes) nes->track = nlt;
2938         }
2939
2940         /* add 'active' Action (may be tweaking track) as last strip to evaluate in NLA stack
2941          * - only do this if we're not exclusively evaluating the 'solo' NLA-track
2942          * - however, if the 'solo' track houses the current 'tweaking' strip,
2943          *   then we should allow this to play, otherwise nothing happens
2944          */
2945         if ((adt->action) && ((adt->flag & ADT_NLA_SOLO_TRACK) == 0 || (adt->flag & ADT_NLA_EDIT_ON))) {
2946                 /* if there are strips, evaluate action as per NLA rules */
2947                 if ((has_strips) || (adt->actstrip)) {
2948                         /* make dummy NLA strip, and add that to the stack */
2949                         ListBase dummy_trackslist;
2950
2951                         dummy_trackslist.first = dummy_trackslist.last = dummy_strip;
2952
2953                         /* Strips with a user-defined time curve don't get properly remapped for editing
2954                          * at the moment, so mapping them just for display may be confusing. */
2955                         bool is_inplace_tweak = (nlt) && !(adt->flag & ADT_NLA_EDIT_NOMAP) && !(adt->actstrip->flag & NLASTRIP_FLAG_USR_TIME);
2956
2957                         if (is_inplace_tweak) {
2958                                 /* edit active action in-place according to its active strip, so copy the data  */
2959                                 memcpy(dummy_strip, adt->actstrip, sizeof(NlaStrip));
2960                                 dummy_strip->next = dummy_strip->prev = NULL;
2961                         }
2962                         else {
2963                                 /* set settings of dummy NLA strip from AnimData settings */
2964                                 dummy_strip->act = adt->action;
2965
2966                                 /* action range is calculated taking F-Modifiers into account (which making new strips doesn't do due to the troublesome nature of that) */
2967                                 calc_action_range(dummy_strip->act, &dummy_strip->actstart, &dummy_strip->actend, 1);
2968                                 dummy_strip->start = dummy_strip->actstart;
2969                                 dummy_strip->end = (IS_EQF(dummy_strip->actstart, dummy_strip->actend)) ?  (dummy_strip->actstart + 1.0f) : (dummy_strip->actend);
2970
2971                                 /* Always use the blend mode of the strip in tweak mode, even if not in-place. */
2972                                 if (nlt && adt->actstrip) {
2973                                         dummy_strip->blendmode = adt->actstrip->blendmode;
2974                                         dummy_strip->extendmode = adt->actstrip->extendmode;
2975                                 }
2976                                 else {
2977                                         dummy_strip->blendmode = adt->act_blendmode;
2978                                         dummy_strip->extendmode = adt->act_extendmode;
2979                                 }
2980
2981                                 dummy_strip->influence = adt->act_influence;
2982
2983                                 /* NOTE: must set this, or else the default setting overrides, and this setting doesn't work */
2984                                 dummy_strip->flag |= NLASTRIP_FLAG_USR_INFLUENCE;
2985                         }
2986
2987                         /* add this to our list of evaluation strips */
2988                         if (r_context == NULL) {
2989                                 nlastrips_ctime_get_strip(depsgraph, &estrips, &dummy_trackslist, -1, ctime);
2990                         }
2991                         /* If computing the context for keyframing, store data there instead of the list. */
2992                         else {
2993                                 /* The extend mode here effectively controls whether it is possible to keyframe beyond the ends. */
2994                                 dummy_strip->extendmode = is_inplace_tweak ? NLASTRIP_EXTEND_NOTHING : NLASTRIP_EXTEND_HOLD;
2995
2996                                 r_context->eval_strip = nes = nlastrips_ctime_get_strip(depsgraph, NULL, &dummy_trackslist, -1, ctime);
2997
2998                                 /* These setting combinations require no data from strips below, so exit immediately. */
2999                                 if ((nes == NULL) || (dummy_strip->blendmode == NLASTRIP_MODE_REPLACE && dummy_strip->influence == 1.0f)) {
3000                                         BLI_freelistN(&estrips);
3001                                         return true;
3002                                 }
3003                         }
3004                 }
3005                 else {
3006                         /* special case - evaluate as if there isn't any NLA data */
3007                         BLI_freelistN(&estrips);
3008                         return false;
3009                 }
3010         }
3011
3012         /* only continue if there are strips to evaluate */
3013         if (BLI_listbase_is_empty(&estrips))
3014                 return true;
3015
3016         /* 2. for each strip, evaluate then accumulate on top of existing channels, but don't set values yet */
3017         for (nes = estrips.first; nes; nes = nes->next)
3018                 nlastrip_evaluate(depsgraph, ptr, echannels, NULL, nes, &echannels->eval_snapshot);
3019
3020         /* 3. free temporary evaluation data that's not used elsewhere */
3021         BLI_freelistN(&estrips);
3022         return true;
3023 }
3024
3025 /* NLA Evaluation function (mostly for use through do_animdata)
3026  * - All channels that will be affected are not cleared anymore. Instead, we just evaluate into
3027  *   some temp channels, where values can be accumulated in one go.
3028  */
3029 static void animsys_calculate_nla(Depsgraph *depsgraph, PointerRNA *ptr, AnimData *adt, float ctime)
3030 {
3031         NlaEvalData echannels;
3032
3033         nlaeval_init(&echannels);
3034
3035         /* evaluate the NLA stack, obtaining a set of values to flush */
3036         if (animsys_evaluate_nla(depsgraph, &echannels, ptr, adt, ctime, NULL)) {
3037                 /* reset any channels touched by currently inactive actions to default value */
3038                 animsys_evaluate_nla_domain(ptr, &echannels, adt);
3039
3040                 /* flush effects of accumulating channels in NLA to the actual data they affect */
3041                 nladata_flush_channels(depsgraph, ptr, &echannels, &echannels.eval_snapshot);
3042         }
3043         else {
3044                 /* special case - evaluate as if there isn't any NLA data */
3045                 /* TODO: this is really just a stop-gap measure... */
3046                 if (G.debug & G_DEBUG) printf("NLA Eval: Stopgap for active action on NLA Stack - no strips case\n");
3047
3048                 animsys_evaluate_action(depsgraph, ptr, adt->action, ctime);
3049         }
3050
3051         /* free temp data */
3052         nlaeval_free(&echannels);
3053 }
3054
3055 /* ---------------------- */
3056
3057 /**
3058  * Prepare data necessary to compute correct keyframe values for NLA strips
3059  * with non-Replace mode or influence different from 1.
3060  *
3061  * @param cache List used to cache contexts for reuse when keying multiple channels in one operation.
3062  * @param ptr RNA pointer to the Object with the animation.
3063  * @return Keyframing context, or NULL if not necessary.
3064  */
3065 NlaKeyframingContext *BKE_animsys_get_nla_keyframing_context(
3066         struct ListBase *cache, struct Depsgraph *depsgraph, struct PointerRNA *ptr, struct AnimData *adt, float ctime)
3067 {
3068         /* No remapping needed if NLA is off or no action. */
3069         if ((adt == NULL) || (adt->action == NULL) || (adt->nla_tracks.first == NULL) || (adt->flag & ADT_NLA_EVAL_OFF)) {
3070                 return NULL;
3071         }
3072
3073         /* No remapping if editing an ordinary Replace action with full influence. */
3074         if (!(adt->flag & ADT_NLA_EDIT_ON) && (adt->act_blendmode == NLASTRIP_MODE_REPLACE && adt->act_influence == 1.0f)) {
3075                 return NULL;
3076         }
3077
3078         /* Try to find a cached context. */
3079         NlaKeyframingContext *ctx = BLI_findptr(cache, adt, offsetof(NlaKeyframingContext, adt));
3080
3081         if (ctx == NULL) {
3082                 /* Allocate and evaluate a new context. */
3083                 ctx = MEM_callocN(sizeof(*ctx), "NlaKeyframingContext");
3084                 ctx->adt = adt;
3085
3086                 nlaeval_init(&ctx->nla_channels);
3087                 animsys_evaluate_nla(depsgraph, &ctx->nla_channels, ptr, adt, ctime, ctx);
3088
3089                 BLI_assert(ELEM(ctx->strip.act, NULL, adt->action));
3090                 BLI_addtail(cache, ctx);
3091         }
3092
3093         return ctx;
3094 }
3095
3096 /**
3097  * Apply correction from the NLA context to the value about to be keyframed.
3098  *
3099  * @param context Context to use (may be NULL).
3100  * @param prop_ptr Property about to be keyframed.
3101  * @param index Array index within the property.
3102  * @param[in,out] r_value Value to correct.
3103  * @return False if correction fails due to a division by zero.
3104  */
3105 bool BKE_animsys_nla_remap_keyframe_value(struct NlaKeyframingContext *context, struct PointerRNA *prop_ptr, struct PropertyRNA *prop, int index, float *r_value)
3106 {
3107         /* No context means no correction. */
3108         if (context == NULL || context->strip.act == NULL) {
3109                 return true;
3110         }
3111
3112         /* If the strip is not evaluated, it is the same as zero influence. */
3113         if (context->eval_strip == NULL) {
3114                 return false;
3115         }
3116
3117         /* Full influence Replace strips also require no correction. */
3118         int blend_mode = context->strip.blendmode;
3119         float influence = context->strip.influence;
3120
3121         if (blend_mode == NLASTRIP_MODE_REPLACE && influence == 1.0f) {
3122                 return true;
3123         }
3124
3125         /* Zero influence is division by zero. */
3126         if (influence <= 0.0f) {
3127                 return false;
3128         }
3129
3130         /* Find the evaluation channel for the NLA stack below current strip. */
3131         NlaEvalChannelKey key = { .ptr = *prop_ptr, .prop = prop };
3132         NlaEvalData *nlaeval = &context->nla_channels;
3133         NlaEvalChannel *nec = nlaevalchan_verify_key(nlaeval, NULL, &key);
3134         int real_index = nlaevalchan_validate_index(nec, index);
3135
3136         if (real_index < 0) {
3137                 return true;
3138         }
3139
3140         /* Invert the blending operation to compute the desired key value. */
3141         NlaEvalChannelSnapshot *nec_snapshot = nlaeval_snapshot_find_channel(&nlaeval->eval_snapshot, nec);
3142
3143         float old_value = nec_snapshot->values[real_index];
3144
3145         return nla_invert_blend_value(blend_mode, old_value, *r_value, influence, r_value);
3146 }
3147
3148 /**
3149  * Free all cached contexts from the list.
3150  */
3151 void BKE_animsys_free_nla_keyframing_context_cache(struct ListBase *cache)
3152 {
3153         for (NlaKeyframingContext *ctx = cache->first; ctx; ctx = ctx->next) {
3154                 MEM_SAFE_FREE(ctx->eval_strip);
3155                 nlaeval_free(&ctx->nla_channels);
3156         }
3157
3158         BLI_freelistN(cache);
3159 }
3160
3161 /* ***************************************** */
3162 /* Overrides System - Public API */
3163
3164 /* Evaluate Overrides */
3165 static void animsys_evaluate_overrides(PointerRNA *ptr, AnimData *adt)
3166 {
3167         AnimOverride *aor;
3168
3169         /* for each override, simply execute... */
3170         for (aor = adt->overrides.first; aor; aor = aor->next) {
3171                 PathResolvedRNA anim_rna;
3172                 if (animsys_store_rna_setting(ptr, aor->rna_path, aor->array_index, &anim_rna)) {
3173                         animsys_write_rna_setting(&anim_rna, aor->value);
3174                 }
3175         }
3176 }
3177
3178 /* ***************************************** */
3179 /* Evaluation System - Public API */
3180
3181 /* Overview of how this system works:
3182  * 1) Depsgraph sorts data as necessary, so that data is in an order that means
3183  *     that all dependencies are resolved before dependents.
3184  * 2) All normal animation is evaluated, so that drivers have some basis values to
3185  *    work with
3186  *    a.  NLA stacks are done first, as the Active Actions act as 'tweaking' tracks