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