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