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