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