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 void 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
717         /* we need to check every curve... */
718         for (fcu = curves->first; fcu; fcu = fcu->next) {
719                 if (fcu->rna_path) {
720                         const char *old_path = fcu->rna_path;
721
722                         /* firstly, handle the F-Curve's own path */
723                         fcu->rna_path = rna_path_rename_fix(owner_id, prefix, oldKey, newKey, fcu->rna_path, verify_paths);
724
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                          */
728                         if (fcu->rna_path != old_path) {
729                                 bActionGroup *agrp = fcu->grp;
730
731                                 if ((agrp) && STREQ(oldName, agrp->name)) {
732                                         BLI_strncpy(agrp->name, newName, sizeof(agrp->name));
733                                 }
734                         }
735                 }
736         }
737 }
738
739 /* Check RNA-Paths for a list of Drivers */
740 static void drivers_path_rename_fix(ID *owner_id, ID *ref_id, const char *prefix, const char *oldName, const char *newName,
741                                     const char *oldKey, const char *newKey, ListBase *curves, bool verify_paths)
742 {
743         FCurve *fcu;
744
745         /* we need to check every curve - drivers are F-Curves too! */
746         for (fcu = curves->first; fcu; fcu = fcu->next) {
747                 /* firstly, handle the F-Curve's own path */
748                 if (fcu->rna_path)
749                         fcu->rna_path = rna_path_rename_fix(owner_id, prefix, oldKey, newKey, fcu->rna_path, verify_paths);
750
751                 /* driver? */
752                 if (fcu->driver) {
753                         ChannelDriver *driver = fcu->driver;
754                         DriverVar *dvar;
755
756                         /* driver variables */
757                         for (dvar = driver->variables.first; dvar; dvar = dvar->next) {
758                                 /* only change the used targets, since the others will need fixing manually anyway */
759                                 DRIVER_TARGETS_USED_LOOPER_BEGIN(dvar)
760                                 {
761                                         /* rename RNA path */
762                                         if (dtar->rna_path && dtar->id)
763                                                 dtar->rna_path = rna_path_rename_fix(dtar->id, prefix, oldKey, newKey, dtar->rna_path, verify_paths);
764
765                                         /* also fix the bone-name (if applicable) */
766                                         if (strstr(prefix, "bones")) {
767                                                 if ( ((dtar->id) && (GS(dtar->id->name) == ID_OB) && (!ref_id || ((Object *)(dtar->id))->data == ref_id)) &&
768                                                      (dtar->pchan_name[0]) && STREQ(oldName, dtar->pchan_name) )
769                                                 {
770                                                         BLI_strncpy(dtar->pchan_name, newName, sizeof(dtar->pchan_name));
771                                                 }
772                                         }
773                                 }
774                                 DRIVER_TARGETS_LOOPER_END;
775                         }
776                 }
777         }
778 }
779
780 /* Fix all RNA-Paths for Actions linked to NLA Strips */
781 static void nlastrips_path_rename_fix(ID *owner_id, const char *prefix, const char *oldName, const char *newName,
782                                       const char *oldKey, const char *newKey, ListBase *strips, bool verify_paths)
783 {
784         NlaStrip *strip;
785
786         /* recursively check strips, fixing only actions... */
787         for (strip = strips->first; strip; strip = strip->next) {
788                 /* fix strip's action */
789                 if (strip->act)
790                         fcurves_path_rename_fix(owner_id, prefix, oldName, newName, oldKey, newKey, &strip->act->curves, verify_paths);
791                 /* ignore own F-Curves, since those are local...  */
792
793                 /* check sub-strips (if metas) */
794                 nlastrips_path_rename_fix(owner_id, prefix, oldName, newName, oldKey, newKey, &strip->strips, verify_paths);
795         }
796 }
797
798 /* Rename Sub-ID Entities in RNA Paths ----------------------- */
799
800 /* Fix up the given RNA-Path
801  *
802  * This is just an external wrapper for the RNA-Path fixing function,
803  * with input validity checks on top of the basic method.
804  *
805  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
806  *       i.e. pose.bones["Bone"]
807  */
808 char *BKE_animsys_fix_rna_path_rename(ID *owner_id, char *old_path, const char *prefix, const char *oldName,
809                                       const char *newName, int oldSubscript, int newSubscript, bool verify_paths)
810 {
811         char *oldN, *newN;
812         char *result;
813
814         /* if no action, no need to proceed */
815         if (ELEM(NULL, owner_id, old_path)) {
816                 if (G.debug & G_DEBUG) printf("%s: early abort\n", __func__);
817                 return old_path;
818         }
819
820         /* Name sanitation logic - copied from BKE_animdata_fix_paths_rename() */
821         if ((oldName != NULL) && (newName != NULL)) {
822                 /* pad the names with [" "] so that only exact matches are made */
823                 const size_t name_old_len = strlen(oldName);
824                 const size_t name_new_len = strlen(newName);
825                 char *name_old_esc = BLI_array_alloca(name_old_esc, (name_old_len * 2) + 1);
826                 char *name_new_esc = BLI_array_alloca(name_new_esc, (name_new_len * 2) + 1);
827
828                 BLI_strescape(name_old_esc, oldName, (name_old_len * 2) + 1);
829                 BLI_strescape(name_new_esc, newName, (name_new_len * 2) + 1);
830                 oldN = BLI_sprintfN("[\"%s\"]", name_old_esc);
831                 newN = BLI_sprintfN("[\"%s\"]", name_new_esc);
832         }
833         else {
834                 oldN = BLI_sprintfN("[%d]", oldSubscript);
835                 newN = BLI_sprintfN("[%d]", newSubscript);
836         }
837
838         /* fix given path */
839         if (G.debug & G_DEBUG) printf("%s | %s  | oldpath = %p ", oldN, newN, old_path);
840         result = rna_path_rename_fix(owner_id, prefix, oldN, newN, old_path, verify_paths);
841         if (G.debug & G_DEBUG) printf("path rename result = %p\n", result);
842
843         /* free the temp names */
844         MEM_freeN(oldN);
845         MEM_freeN(newN);
846
847         /* return the resulting path - may be the same path again if nothing changed */
848         return result;
849 }
850
851 /* Fix all RNA_Paths in the given Action, relative to the given ID block
852  *
853  * This is just an external wrapper for the F-Curve fixing function,
854  * with input validity checks on top of the basic method.
855  *
856  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
857  *       i.e. pose.bones["Bone"]
858  */
859 void BKE_action_fix_paths_rename(ID *owner_id, bAction *act, const char *prefix, const char *oldName,
860                                  const char *newName, int oldSubscript, int newSubscript, bool verify_paths)
861 {
862         char *oldN, *newN;
863
864         /* if no action, no need to proceed */
865         if (ELEM(NULL, owner_id, act))
866                 return;
867
868         /* Name sanitation logic - copied from BKE_animdata_fix_paths_rename() */
869         if ((oldName != NULL) && (newName != NULL)) {
870                 /* pad the names with [" "] so that only exact matches are made */
871                 const size_t name_old_len = strlen(oldName);
872                 const size_t name_new_len = strlen(newName);
873                 char *name_old_esc = BLI_array_alloca(name_old_esc, (name_old_len * 2) + 1);
874                 char *name_new_esc = BLI_array_alloca(name_new_esc, (name_new_len * 2) + 1);
875
876                 BLI_strescape(name_old_esc, oldName, (name_old_len * 2) + 1);
877                 BLI_strescape(name_new_esc, newName, (name_new_len * 2) + 1);
878                 oldN = BLI_sprintfN("[\"%s\"]", name_old_esc);
879                 newN = BLI_sprintfN("[\"%s\"]", name_new_esc);
880         }
881         else {
882                 oldN = BLI_sprintfN("[%d]", oldSubscript);
883                 newN = BLI_sprintfN("[%d]", newSubscript);
884         }
885
886         /* fix paths in action */
887         fcurves_path_rename_fix(owner_id, prefix, oldName, newName, oldN, newN, &act->curves, verify_paths);
888
889         /* free the temp names */
890         MEM_freeN(oldN);
891         MEM_freeN(newN);
892 }
893
894 /* Fix all RNA-Paths in the AnimData block used by the given ID block
895  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
896  *       i.e. pose.bones["Bone"]
897  */
898 void BKE_animdata_fix_paths_rename(ID *owner_id, AnimData *adt, ID *ref_id, const char *prefix, const char *oldName,
899                                    const char *newName, int oldSubscript, int newSubscript, bool verify_paths)
900 {
901         NlaTrack *nlt;
902         char *oldN, *newN;
903
904         /* if no AnimData, no need to proceed */
905         if (ELEM(NULL, owner_id, adt))
906                 return;
907
908         /* Name sanitation logic - shared with BKE_action_fix_paths_rename() */
909         if ((oldName != NULL) && (newName != NULL)) {
910                 /* pad the names with [" "] so that only exact matches are made */
911                 const size_t name_old_len = strlen(oldName);
912                 const size_t name_new_len = strlen(newName);
913                 char *name_old_esc = BLI_array_alloca(name_old_esc, (name_old_len * 2) + 1);
914                 char *name_new_esc = BLI_array_alloca(name_new_esc, (name_new_len * 2) + 1);
915
916                 BLI_strescape(name_old_esc, oldName, (name_old_len * 2) + 1);
917                 BLI_strescape(name_new_esc, newName, (name_new_len * 2) + 1);
918                 oldN = BLI_sprintfN("[\"%s\"]", name_old_esc);
919                 newN = BLI_sprintfN("[\"%s\"]", name_new_esc);
920         }
921         else {
922                 oldN = BLI_sprintfN("[%d]", oldSubscript);
923                 newN = BLI_sprintfN("[%d]", newSubscript);
924         }
925
926         /* Active action and temp action */
927         if (adt->action)
928                 fcurves_path_rename_fix(owner_id, prefix, oldName, newName, oldN, newN, &adt->action->curves, verify_paths);
929         if (adt->tmpact)
930                 fcurves_path_rename_fix(owner_id, prefix, oldName, newName, oldN, newN, &adt->tmpact->curves, verify_paths);
931
932         /* Drivers - Drivers are really F-Curves */
933         drivers_path_rename_fix(owner_id, ref_id, prefix, oldName, newName, oldN, newN, &adt->drivers, verify_paths);
934
935         /* NLA Data - Animation Data for Strips */
936         for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next)
937                 nlastrips_path_rename_fix(owner_id, prefix, oldName, newName, oldN, newN, &nlt->strips, verify_paths);
938
939         /* free the temp names */
940         MEM_freeN(oldN);
941         MEM_freeN(newN);
942 }
943
944 /* Remove FCurves with Prefix  -------------------------------------- */
945
946 /* Check RNA-Paths for a list of F-Curves */
947 static bool fcurves_path_remove_fix(const char *prefix, ListBase *curves)
948 {
949         FCurve *fcu, *fcn;
950         bool any_removed = false;
951         if (!prefix) return any_removed;
952
953         /* we need to check every curve... */
954         for (fcu = curves->first; fcu; fcu = fcn) {
955                 fcn = fcu->next;
956
957                 if (fcu->rna_path) {
958                         if (STRPREFIX(fcu->rna_path, prefix)) {
959                                 BLI_remlink(curves, fcu);
960                                 free_fcurve(fcu);
961                                 any_removed = true;
962                         }
963                 }
964         }
965         return any_removed;
966 }
967
968 /* Check RNA-Paths for a list of F-Curves */
969 static bool nlastrips_path_remove_fix(const char *prefix, ListBase *strips)
970 {
971         NlaStrip *strip;
972         bool any_removed = false;
973
974         /* recursively check strips, fixing only actions... */
975         for (strip = strips->first; strip; strip = strip->next) {
976                 /* fix strip's action */
977                 if (strip->act) {
978                         any_removed |= fcurves_path_remove_fix(prefix, &strip->act->curves);
979                 }
980
981                 /* check sub-strips (if metas) */
982                 any_removed |= nlastrips_path_remove_fix(prefix, &strip->strips);
983         }
984         return any_removed;
985 }
986
987 bool BKE_animdata_fix_paths_remove(ID *id, const char *prefix)
988 {
989         /* Only some ID-blocks have this info for now, so we cast the
990          * types that do to be of type IdAdtTemplate
991          */
992         if (!id_can_have_animdata(id)) {
993                 return false;
994         }
995         bool any_removed = false;
996         IdAdtTemplate *iat = (IdAdtTemplate *)id;
997         AnimData *adt = iat->adt;
998         /* check if there's any AnimData to start with */
999         if (adt) {
1000                 /* free fcurves */
1001                 if (adt->action != NULL) {
1002                         any_removed |= fcurves_path_remove_fix(prefix, &adt->action->curves);
1003                 }
1004                 if (adt->tmpact != NULL) {
1005                         any_removed |= fcurves_path_remove_fix(prefix, &adt->tmpact->curves);
1006                 }
1007                 /* free drivers - stored as a list of F-Curves */
1008                 any_removed |= fcurves_path_remove_fix(prefix, &adt->drivers);
1009                 /* NLA Data - Animation Data for Strips */
1010                 for (NlaTrack *nlt = adt->nla_tracks.first; nlt; nlt = nlt->next) {
1011                         any_removed |= nlastrips_path_remove_fix(prefix, &nlt->strips);
1012                 }
1013         }
1014         return any_removed;
1015 }
1016
1017 /* Apply Op to All FCurves in Database --------------------------- */
1018
1019 /* "User-Data" wrapper used by BKE_fcurves_main_cb() */
1020 typedef struct AllFCurvesCbWrapper {
1021         ID_FCurve_Edit_Callback func;  /* Operation to apply on F-Curve */
1022         void *user_data;               /* Custom data for that operation */
1023 } AllFCurvesCbWrapper;
1024
1025 /* Helper for adt_apply_all_fcurves_cb() - Apply wrapped operator to list of F-Curves */
1026 static void fcurves_apply_cb(ID *id, ListBase *fcurves, ID_FCurve_Edit_Callback func, void *user_data)
1027 {
1028         FCurve *fcu;
1029
1030         for (fcu = fcurves->first; fcu; fcu = fcu->next) {
1031                 func(id, fcu, user_data);
1032         }
1033 }
1034
1035 /* Helper for adt_apply_all_fcurves_cb() - Recursively go through each NLA strip */
1036 static void nlastrips_apply_all_curves_cb(ID *id, ListBase *strips, AllFCurvesCbWrapper *wrapper)
1037 {
1038         NlaStrip *strip;
1039
1040         for (strip = strips->first; strip; strip = strip->next) {
1041                 /* fix strip's action */
1042                 if (strip->act) {
1043                         fcurves_apply_cb(id, &strip->act->curves, wrapper->func, wrapper->user_data);
1044                 }
1045
1046                 /* check sub-strips (if metas) */
1047                 nlastrips_apply_all_curves_cb(id, &strip->strips, wrapper);
1048         }
1049 }
1050
1051 /* Helper for BKE_fcurves_main_cb() - Dispatch wrapped operator to all F-Curves */
1052 static void adt_apply_all_fcurves_cb(ID *id, AnimData *adt, void *wrapper_data)
1053 {
1054         AllFCurvesCbWrapper *wrapper = wrapper_data;
1055         NlaTrack *nlt;
1056
1057         if (adt->action) {
1058                 fcurves_apply_cb(id, &adt->action->curves, wrapper->func, wrapper->user_data);
1059         }
1060
1061         if (adt->tmpact) {
1062                 fcurves_apply_cb(id, &adt->tmpact->curves, wrapper->func, wrapper->user_data);
1063         }
1064
1065         /* free drivers - stored as a list of F-Curves */
1066         fcurves_apply_cb(id, &adt->drivers, wrapper->func, wrapper->user_data);
1067
1068         /* NLA Data - Animation Data for Strips */
1069         for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next) {
1070                 nlastrips_apply_all_curves_cb(id, &nlt->strips, wrapper);
1071         }
1072 }
1073
1074 /* apply the given callback function on all F-Curves attached to data in main database */
1075 void BKE_fcurves_main_cb(Main *bmain, ID_FCurve_Edit_Callback func, void *user_data)
1076 {
1077         /* Wrap F-Curve operation stuff to pass to the general AnimData-level func */
1078         AllFCurvesCbWrapper wrapper = {func, user_data};
1079
1080         /* Use the AnimData-based function so that we don't have to reimplement all that stuff */
1081         BKE_animdata_main_cb(bmain, adt_apply_all_fcurves_cb, &wrapper);
1082 }
1083
1084
1085 /* Whole Database Ops -------------------------------------------- */
1086
1087 /* apply the given callback function on all data in main database */
1088 void BKE_animdata_main_cb(Main *bmain, ID_AnimData_Edit_Callback func, void *user_data)
1089 {
1090         ID *id;
1091
1092         /* standard data version */
1093 #define ANIMDATA_IDS_CB(first) \
1094         for (id = first; id; id = id->next) { \
1095                 AnimData *adt = BKE_animdata_from_id(id); \
1096                 if (adt) func(id, adt, user_data); \
1097         } (void)0
1098
1099         /* "embedded" nodetree cases (i.e. scene/material/texture->nodetree) */
1100 #define ANIMDATA_NODETREE_IDS_CB(first, NtId_Type) \
1101         for (id = first; id; id = id->next) { \
1102                 AnimData *adt = BKE_animdata_from_id(id); \
1103                 NtId_Type *ntp = (NtId_Type *)id; \
1104                 if (ntp->nodetree) { \
1105                         AnimData *adt2 = BKE_animdata_from_id((ID *)ntp->nodetree); \
1106                         if (adt2) func(id, adt2, user_data); \
1107                 } \
1108                 if (adt) func(id, adt, user_data); \
1109         } (void)0
1110
1111         /* nodes */
1112         ANIMDATA_IDS_CB(bmain->nodetree.first);
1113
1114         /* textures */
1115         ANIMDATA_NODETREE_IDS_CB(bmain->tex.first, Tex);
1116
1117         /* lamps */
1118         ANIMDATA_NODETREE_IDS_CB(bmain->lamp.first, Lamp);
1119
1120         /* materials */
1121         ANIMDATA_NODETREE_IDS_CB(bmain->mat.first, Material);
1122
1123         /* cameras */
1124         ANIMDATA_IDS_CB(bmain->camera.first);
1125
1126         /* shapekeys */
1127         ANIMDATA_IDS_CB(bmain->key.first);
1128
1129         /* metaballs */
1130         ANIMDATA_IDS_CB(bmain->mball.first);
1131
1132         /* curves */
1133         ANIMDATA_IDS_CB(bmain->curve.first);
1134
1135         /* armatures */
1136         ANIMDATA_IDS_CB(bmain->armature.first);
1137
1138         /* lattices */
1139         ANIMDATA_IDS_CB(bmain->latt.first);
1140
1141         /* meshes */
1142         ANIMDATA_IDS_CB(bmain->mesh.first);
1143
1144         /* particles */
1145         ANIMDATA_IDS_CB(bmain->particle.first);
1146
1147         /* speakers */
1148         ANIMDATA_IDS_CB(bmain->speaker.first);
1149
1150         /* movie clips */
1151         ANIMDATA_IDS_CB(bmain->movieclip.first);
1152
1153         /* objects */
1154         ANIMDATA_IDS_CB(bmain->object.first);
1155
1156         /* masks */
1157         ANIMDATA_IDS_CB(bmain->mask.first);
1158
1159         /* worlds */
1160         ANIMDATA_NODETREE_IDS_CB(bmain->world.first, World);
1161
1162         /* scenes */
1163         ANIMDATA_NODETREE_IDS_CB(bmain->scene.first, Scene);
1164
1165         /* line styles */
1166         ANIMDATA_IDS_CB(bmain->linestyle.first);
1167
1168         /* grease pencil */
1169         ANIMDATA_IDS_CB(bmain->gpencil.first);
1170
1171         /* palettes */
1172         ANIMDATA_IDS_CB(bmain->palettes.first);
1173
1174         /* cache files */
1175         ANIMDATA_IDS_CB(bmain->cachefiles.first);
1176 }
1177
1178 /* Fix all RNA-Paths throughout the database (directly access the Global.main version)
1179  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
1180  *      i.e. pose.bones["Bone"]
1181  */
1182 /* TODO: use BKE_animdata_main_cb for looping over all data  */
1183 void BKE_animdata_fix_paths_rename_all(ID *ref_id, const char *prefix, const char *oldName, const char *newName)
1184 {
1185         Main *bmain = G.main;  /* XXX UGLY! */
1186         ID *id;
1187
1188         /* macro for less typing
1189          * - whether animdata exists is checked for by the main renaming callback, though taking
1190          *   this outside of the function may make things slightly faster?
1191          */
1192 #define RENAMEFIX_ANIM_IDS(first) \
1193         for (id = first; id; id = id->next) { \
1194                 AnimData *adt = BKE_animdata_from_id(id); \
1195                 BKE_animdata_fix_paths_rename(id, adt, ref_id, prefix, oldName, newName, 0, 0, 1); \
1196         } (void)0
1197
1198         /* another version of this macro for nodetrees */
1199 #define RENAMEFIX_ANIM_NODETREE_IDS(first, NtId_Type) \
1200         for (id = first; id; id = id->next) { \
1201                 AnimData *adt = BKE_animdata_from_id(id); \
1202                 NtId_Type *ntp = (NtId_Type *)id; \
1203                 if (ntp->nodetree) { \
1204                         AnimData *adt2 = BKE_animdata_from_id((ID *)ntp->nodetree); \
1205                         BKE_animdata_fix_paths_rename((ID *)ntp->nodetree, adt2, ref_id, prefix, oldName, newName, 0, 0, 1); \
1206                 } \
1207                 BKE_animdata_fix_paths_rename(id, adt, ref_id, prefix, oldName, newName, 0, 0, 1); \
1208         } (void)0
1209
1210         /* nodes */
1211         RENAMEFIX_ANIM_IDS(bmain->nodetree.first);
1212
1213         /* textures */
1214         RENAMEFIX_ANIM_NODETREE_IDS(bmain->tex.first, Tex);
1215
1216         /* lamps */
1217         RENAMEFIX_ANIM_NODETREE_IDS(bmain->lamp.first, Lamp);
1218
1219         /* materials */
1220         RENAMEFIX_ANIM_NODETREE_IDS(bmain->mat.first, Material);
1221
1222         /* cameras */
1223         RENAMEFIX_ANIM_IDS(bmain->camera.first);
1224
1225         /* shapekeys */
1226         RENAMEFIX_ANIM_IDS(bmain->key.first);
1227
1228         /* metaballs */
1229         RENAMEFIX_ANIM_IDS(bmain->mball.first);
1230
1231         /* curves */
1232         RENAMEFIX_ANIM_IDS(bmain->curve.first);
1233
1234         /* armatures */
1235         RENAMEFIX_ANIM_IDS(bmain->armature.first);
1236
1237         /* lattices */
1238         RENAMEFIX_ANIM_IDS(bmain->latt.first);
1239
1240         /* meshes */
1241         RENAMEFIX_ANIM_IDS(bmain->mesh.first);
1242
1243         /* particles */
1244         RENAMEFIX_ANIM_IDS(bmain->particle.first);
1245
1246         /* speakers */
1247         RENAMEFIX_ANIM_IDS(bmain->speaker.first);
1248
1249         /* movie clips */
1250         RENAMEFIX_ANIM_IDS(bmain->movieclip.first);
1251
1252         /* objects */
1253         RENAMEFIX_ANIM_IDS(bmain->object.first);
1254
1255         /* masks */
1256         RENAMEFIX_ANIM_IDS(bmain->mask.first);
1257
1258         /* worlds */
1259         RENAMEFIX_ANIM_NODETREE_IDS(bmain->world.first, World);
1260
1261         /* linestyles */
1262         RENAMEFIX_ANIM_IDS(bmain->linestyle.first);
1263
1264         /* grease pencil */
1265         RENAMEFIX_ANIM_IDS(bmain->gpencil.first);
1266
1267         /* cache files */
1268         RENAMEFIX_ANIM_IDS(bmain->cachefiles.first);
1269
1270         /* scenes */
1271         RENAMEFIX_ANIM_NODETREE_IDS(bmain->scene.first, Scene);
1272 }
1273
1274 /* *********************************** */
1275 /* KeyingSet API */
1276
1277 /* Finding Tools --------------------------- */
1278
1279 /* Find the first path that matches the given criteria */
1280 /* TODO: do we want some method to perform partial matches too? */
1281 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))
1282 {
1283         KS_Path *ksp;
1284
1285         /* sanity checks */
1286         if (ELEM(NULL, ks, rna_path, id))
1287                 return NULL;
1288
1289         /* loop over paths in the current KeyingSet, finding the first one where all settings match
1290          * (i.e. the first one where none of the checks fail and equal 0)
1291          */
1292         for (ksp = ks->paths.first; ksp; ksp = ksp->next) {
1293                 short eq_id = 1, eq_path = 1, eq_index = 1, eq_group = 1;
1294
1295                 /* id */
1296                 if (id != ksp->id)
1297                         eq_id = 0;
1298
1299                 /* path */
1300                 if ((ksp->rna_path == NULL) || !STREQ(rna_path, ksp->rna_path))
1301                         eq_path = 0;
1302
1303                 /* index - need to compare whole-array setting too... */
1304                 if (ksp->array_index != array_index)
1305                         eq_index = 0;
1306
1307                 /* group */
1308                 if (group_name) {
1309                         /* FIXME: these checks need to be coded... for now, it's not too important though */
1310                 }
1311
1312                 /* if all aspects are ok, return */
1313                 if (eq_id && eq_path && eq_index && eq_group)
1314                         return ksp;
1315         }
1316
1317         /* none found */
1318         return NULL;
1319 }
1320
1321 /* Defining Tools --------------------------- */
1322
1323 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
1324 KeyingSet *BKE_keyingset_add(ListBase *list, const char idname[], const char name[], short flag, short keyingflag)
1325 {
1326         KeyingSet *ks;
1327
1328         /* allocate new KeyingSet */
1329         ks = MEM_callocN(sizeof(KeyingSet), "KeyingSet");
1330
1331         BLI_strncpy(ks->idname, (idname) ? idname : (name) ? name     : DATA_("KeyingSet"),  sizeof(ks->idname));
1332         BLI_strncpy(ks->name,   (name) ? name     : (idname) ? idname : DATA_("Keying Set"), sizeof(ks->name));
1333
1334         ks->flag = flag;
1335         ks->keyingflag = keyingflag;
1336         ks->keyingoverride = keyingflag; /* NOTE: assume that if one is set one way, the other should be too, so that it'll work */
1337
1338         /* add KeyingSet to list */
1339         BLI_addtail(list, ks);
1340
1341         /* Make sure KeyingSet has a unique idname */
1342         BLI_uniquename(list, ks, DATA_("KeyingSet"), '.', offsetof(KeyingSet, idname), sizeof(ks->idname));
1343
1344         /* Make sure KeyingSet has a unique label (this helps with identification) */
1345         BLI_uniquename(list, ks, DATA_("Keying Set"), '.', offsetof(KeyingSet, name), sizeof(ks->name));
1346
1347         /* return new KeyingSet for further editing */
1348         return ks;
1349 }
1350
1351 /* Add a path to a KeyingSet. Nothing is returned for now...
1352  * Checks are performed to ensure that destination is appropriate for the KeyingSet in question
1353  */
1354 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)
1355 {
1356         KS_Path *ksp;
1357
1358         /* sanity checks */
1359         if (ELEM(NULL, ks, rna_path)) {
1360                 printf("ERROR: no Keying Set and/or RNA Path to add path with\n");
1361                 return NULL;
1362         }
1363
1364         /* ID is required for all types of KeyingSets */
1365         if (id == NULL) {
1366                 printf("ERROR: No ID provided for Keying Set Path\n");
1367                 return NULL;
1368         }
1369
1370         /* don't add if there is already a matching KS_Path in the KeyingSet */
1371         if (BKE_keyingset_find_path(ks, id, group_name, rna_path, array_index, groupmode)) {
1372                 if (G.debug & G_DEBUG)
1373                         printf("ERROR: destination already exists in Keying Set\n");
1374                 return NULL;
1375         }
1376
1377         /* allocate a new KeyingSet Path */
1378         ksp = MEM_callocN(sizeof(KS_Path), "KeyingSet Path");
1379
1380         /* just store absolute info */
1381         ksp->id = id;
1382         if (group_name)
1383                 BLI_strncpy(ksp->group, group_name, sizeof(ksp->group));
1384         else
1385                 ksp->group[0] = '\0';
1386
1387         /* store additional info for relative paths (just in case user makes the set relative) */
1388         if (id)
1389                 ksp->idtype = GS(id->name);
1390
1391         /* just copy path info */
1392         /* TODO: should array index be checked too? */
1393         ksp->rna_path = BLI_strdup(rna_path);
1394         ksp->array_index = array_index;
1395
1396         /* store flags */
1397         ksp->flag = flag;
1398         ksp->groupmode = groupmode;
1399
1400         /* add KeyingSet path to KeyingSet */
1401         BLI_addtail(&ks->paths, ksp);
1402
1403         /* return this path */
1404         return ksp;
1405 }
1406
1407 /* Free the given Keying Set path */
1408 void BKE_keyingset_free_path(KeyingSet *ks, KS_Path *ksp)
1409 {
1410         /* sanity check */
1411         if (ELEM(NULL, ks, ksp))
1412                 return;
1413
1414         /* free RNA-path info */
1415         if (ksp->rna_path)
1416                 MEM_freeN(ksp->rna_path);
1417
1418         /* free path itself */
1419         BLI_freelinkN(&ks->paths, ksp);
1420 }
1421
1422 /* Copy all KeyingSets in the given list */
1423 void BKE_keyingsets_copy(ListBase *newlist, const ListBase *list)
1424 {
1425         KeyingSet *ksn;
1426         KS_Path *kspn;
1427
1428         BLI_duplicatelist(newlist, list);
1429
1430         for (ksn = newlist->first; ksn; ksn = ksn->next) {
1431                 BLI_duplicatelist(&ksn->paths, &ksn->paths);
1432
1433                 for (kspn = ksn->paths.first; kspn; kspn = kspn->next)
1434                         kspn->rna_path = MEM_dupallocN(kspn->rna_path);
1435         }
1436 }
1437
1438 /* Freeing Tools --------------------------- */
1439
1440 /* Free data for KeyingSet but not set itself */
1441 void BKE_keyingset_free(KeyingSet *ks)
1442 {
1443         KS_Path *ksp, *kspn;
1444
1445         /* sanity check */
1446         if (ks == NULL)
1447                 return;
1448
1449         /* free each path as we go to avoid looping twice */
1450         for (ksp = ks->paths.first; ksp; ksp = kspn) {
1451                 kspn = ksp->next;
1452                 BKE_keyingset_free_path(ks, ksp);
1453         }
1454 }
1455
1456 /* Free all the KeyingSets in the given list */
1457 void BKE_keyingsets_free(ListBase *list)
1458 {
1459         KeyingSet *ks, *ksn;
1460
1461         /* sanity check */
1462         if (list == NULL)
1463                 return;
1464
1465         /* loop over KeyingSets freeing them
1466          * - BKE_keyingset_free() doesn't free the set itself, but it frees its sub-data
1467          */
1468         for (ks = list->first; ks; ks = ksn) {
1469                 ksn = ks->next;
1470                 BKE_keyingset_free(ks);
1471                 BLI_freelinkN(list, ks);
1472         }
1473 }
1474
1475 /* ***************************************** */
1476 /* Evaluation Data-Setting Backend */
1477
1478 static bool animsys_store_rna_setting(
1479         PointerRNA *ptr,
1480         /* typically 'fcu->rna_path', 'fcu->array_index' */
1481         const char *rna_path, const int array_index,
1482         PathResolvedRNA *r_result)
1483 {
1484         bool success = false;
1485         const char *path = rna_path;
1486
1487         /* write value to setting */
1488         if (path) {
1489                 /* get property to write to */
1490                 if (RNA_path_resolve_property(ptr, path, &r_result->ptr, &r_result->prop)) {
1491                         if ((ptr->id.data == NULL) || RNA_property_animateable(&r_result->ptr, r_result->prop)) {
1492                                 int array_len = RNA_property_array_length(&r_result->ptr, r_result->prop);
1493
1494                                 if (array_len && array_index >= array_len) {
1495                                         if (G.debug & G_DEBUG) {
1496                                                 printf("Animato: Invalid array index. ID = '%s',  '%s[%d]', array length is %d\n",
1497                                                        (ptr->id.data) ? (((ID *)ptr->id.data)->name + 2) : "<No ID>",
1498                                                        path, array_index, array_len - 1);
1499                                         }
1500                                 }
1501                                 else {
1502                                         r_result->prop_index = array_len ? array_index : -1;
1503                                         success = true;
1504                                 }
1505                         }
1506                 }
1507                 else {
1508                         /* failed to get path */
1509                         /* XXX don't tag as failed yet though, as there are some legit situations (Action Constraint)
1510                          * where some channels will not exist, but shouldn't lock up Action */
1511                         if (G.debug & G_DEBUG) {
1512                                 printf("Animato: Invalid path. ID = '%s',  '%s[%d]'\n",
1513                                        (ptr->id.data) ? (((ID *)ptr->id.data)->name + 2) : "<No ID>",
1514                                        path, array_index);
1515                         }
1516                 }
1517         }
1518
1519         return success;
1520 }
1521
1522
1523 /* less than 1.0 evaluates to false, use epsilon to avoid float error */
1524 #define ANIMSYS_FLOAT_AS_BOOL(value) ((value) > ((1.0f - FLT_EPSILON)))
1525
1526 static bool animsys_read_rna_setting(PathResolvedRNA *anim_rna, float *r_value)
1527 {
1528         PropertyRNA *prop = anim_rna->prop;
1529         PointerRNA *ptr = &anim_rna->ptr;
1530         int array_index = anim_rna->prop_index;
1531         float orig_value;
1532
1533         /* caller must ensure this is animatable */
1534         BLI_assert(RNA_property_animateable(ptr, prop) || ptr->id.data == NULL);
1535
1536         switch (RNA_property_type(prop)) {
1537                 case PROP_BOOLEAN:
1538                 {
1539                         if (array_index != -1) {
1540                                 const int orig_value_coerce = RNA_property_boolean_get_index(ptr, prop, array_index);
1541                                 orig_value = (float)orig_value_coerce;
1542                         }
1543                         else {
1544                                 const int orig_value_coerce = RNA_property_boolean_get(ptr, prop);
1545                                 orig_value = (float)orig_value_coerce;
1546                         }
1547                         break;
1548                 }
1549                 case PROP_INT:
1550                 {
1551                         if (array_index != -1) {
1552                                 const int orig_value_coerce = RNA_property_int_get_index(ptr, prop, array_index);
1553                                 orig_value = (float)orig_value_coerce;
1554                         }
1555                         else {
1556                                 const int orig_value_coerce = RNA_property_int_get(ptr, prop);
1557                                 orig_value = (float)orig_value_coerce;
1558                         }
1559                         break;
1560                 }
1561                 case PROP_FLOAT:
1562                 {
1563                         if (array_index != -1) {
1564                                 const float orig_value_coerce = RNA_property_float_get_index(ptr, prop, array_index);
1565                                 orig_value = (float)orig_value_coerce;
1566                         }
1567                         else {
1568                                 const float orig_value_coerce = RNA_property_float_get(ptr, prop);
1569                                 orig_value = (float)orig_value_coerce;
1570                         }
1571                         break;
1572                 }
1573                 case PROP_ENUM:
1574                 {
1575                         const int orig_value_coerce = RNA_property_enum_get(ptr, prop);
1576                         orig_value = (float)orig_value_coerce;
1577                         break;
1578                 }
1579                 default:
1580                         /* nothing can be done here... so it is unsuccessful? */
1581                         return false;
1582         }
1583
1584         if (r_value != NULL) {
1585                 *r_value = orig_value;
1586         }
1587
1588         /* successful */
1589         return true;
1590 }
1591
1592 /* Write the given value to a setting using RNA, and return success */
1593 static bool animsys_write_rna_setting(PathResolvedRNA *anim_rna, const float value)
1594 {
1595         PropertyRNA *prop = anim_rna->prop;
1596         PointerRNA *ptr = &anim_rna->ptr;
1597         int array_index = anim_rna->prop_index;
1598
1599         /* caller must ensure this is animatable */
1600         BLI_assert(RNA_property_animateable(ptr, prop) || ptr->id.data == NULL);
1601
1602         /* Check whether value is new. Otherwise we skip all the updates. */
1603         float old_value;
1604         if (!animsys_read_rna_setting(anim_rna, &old_value)) {
1605                 return false;
1606         }
1607         if (old_value == value) {
1608                 return true;
1609         }
1610
1611         switch (RNA_property_type(prop)) {
1612                 case PROP_BOOLEAN:
1613                 {
1614                         const int value_coerce = ANIMSYS_FLOAT_AS_BOOL(value);
1615                         if (array_index != -1) {
1616                                 RNA_property_boolean_set_index(ptr, prop, array_index, value_coerce);
1617                         }
1618                         else {
1619                                 RNA_property_boolean_set(ptr, prop, value_coerce);
1620                         }
1621                         break;
1622                 }
1623                 case PROP_INT:
1624                 {
1625                         int value_coerce = (int)value;
1626                         RNA_property_int_clamp(ptr, prop, &value_coerce);
1627                         if (array_index != -1) {
1628                                 RNA_property_int_set_index(ptr, prop, array_index, value_coerce);
1629                         }
1630                         else {
1631                                 RNA_property_int_set(ptr, prop, value_coerce);
1632                         }
1633                         break;
1634                 }
1635                 case PROP_FLOAT:
1636                 {
1637                         float value_coerce = value;
1638                         RNA_property_float_clamp(ptr, prop, &value_coerce);
1639                         if (array_index != -1) {
1640                                 RNA_property_float_set_index(ptr, prop, array_index, value_coerce);
1641                         }
1642                         else {
1643                                 RNA_property_float_set(ptr, prop, value_coerce);
1644                         }
1645                         break;
1646                 }
1647                 case PROP_ENUM:
1648                 {
1649                         const int value_coerce = (int)value;
1650                         RNA_property_enum_set(ptr, prop, value_coerce);
1651                         break;
1652                 }
1653                 default:
1654                         /* nothing can be done here... so it is unsuccessful? */
1655                         return false;
1656         }
1657
1658         /* successful */
1659         return true;
1660 }
1661
1662 /* Simple replacement based data-setting of the FCurve using RNA */
1663 bool BKE_animsys_execute_fcurve(PointerRNA *ptr, FCurve *fcu, float curval)
1664 {
1665         PathResolvedRNA anim_rna;
1666         bool ok = false;
1667
1668         if (animsys_store_rna_setting(ptr, fcu->rna_path, fcu->array_index, &anim_rna)) {
1669                 ok = animsys_write_rna_setting(&anim_rna, curval);
1670         }
1671
1672         /* return whether we were successful */
1673         return ok;
1674 }
1675
1676 static void animsys_write_orig_anim_rna(
1677         PointerRNA *ptr,
1678         const char *rna_path,
1679         int array_index,
1680         float value)
1681 {
1682         /* Pointer is expected to be an ID pointer, if it's not -- we are doomed.
1683          *
1684          * NOTE: It is possible to have animation data on NLA strip, see T57360.
1685          * TODO(sergey): Find solution for those cases.
1686          */
1687         if (ptr->id.data == NULL) {
1688                 return;
1689         }
1690         PointerRNA orig_ptr = *ptr;
1691         orig_ptr.id.data = ((ID *)orig_ptr.id.data)->orig_id;
1692         orig_ptr.data = orig_ptr.id.data;
1693         PathResolvedRNA orig_anim_rna;
1694         /* TODO(sergey): Is there a faster way to get anim_rna of original ID? */
1695         if (animsys_store_rna_setting(&orig_ptr, rna_path, array_index, &orig_anim_rna)) {
1696                 animsys_write_rna_setting(&orig_anim_rna, value);
1697         }
1698 }
1699
1700 /* Evaluate all the F-Curves in the given list
1701  * This performs a set of standard checks. If extra checks are required, separate code should be used
1702  */
1703 static void animsys_evaluate_fcurves(
1704         Depsgraph *depsgraph, PointerRNA *ptr, ListBase *list, float ctime)
1705 {
1706         const bool is_active_depsgraph = DEG_is_active(depsgraph);
1707         /* Calculate then execute each curve. */
1708         for (FCurve *fcu = list->first; fcu; fcu = fcu->next) {
1709                 /* Check if this F-Curve doesn't belong to a muted group. */
1710                 if ((fcu->grp != NULL) && (fcu->grp->flag & AGRP_MUTED)) {
1711                         continue;
1712                 }
1713                 /* Check if this curve should be skipped. */
1714                 if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED))) {
1715                         continue;
1716                 }
1717                 PathResolvedRNA anim_rna;
1718                 if (animsys_store_rna_setting(ptr, fcu->rna_path, fcu->array_index, &anim_rna)) {
1719                         const float curval = calculate_fcurve(&anim_rna, fcu, ctime);
1720                         animsys_write_rna_setting(&anim_rna, curval);
1721                         if (is_active_depsgraph) {
1722                                 animsys_write_orig_anim_rna(ptr, fcu->rna_path, fcu->array_index, curval);
1723                         }
1724                 }
1725         }
1726 }
1727
1728 /* ***************************************** */
1729 /* Driver Evaluation */
1730
1731 /* Evaluate Drivers */
1732 static void animsys_evaluate_drivers(PointerRNA *ptr, AnimData *adt, float ctime)
1733 {
1734         FCurve *fcu;
1735
1736         /* drivers are stored as F-Curves, but we cannot use the standard code, as we need to check if
1737          * the depsgraph requested that this driver be evaluated...
1738          */
1739         for (fcu = adt->drivers.first; fcu; fcu = fcu->next) {
1740                 ChannelDriver *driver = fcu->driver;
1741                 bool ok = false;
1742
1743                 /* check if this driver's curve should be skipped */
1744                 if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED)) == 0) {
1745                         /* check if driver itself is tagged for recalculation */
1746                         /* XXX driver recalc flag is not set yet by depsgraph! */
1747                         if ((driver) && !(driver->flag & DRIVER_FLAG_INVALID) /*&& (driver->flag & DRIVER_FLAG_RECALC)*/) {
1748                                 /* evaluate this using values set already in other places
1749                                  * NOTE: for 'layering' option later on, we should check if we should remove old value before adding
1750                                  *       new to only be done when drivers only changed */
1751
1752                                 PathResolvedRNA anim_rna;
1753                                 if (animsys_store_rna_setting(ptr, fcu->rna_path, fcu->array_index, &anim_rna)) {
1754                                         const float curval = calculate_fcurve(&anim_rna, fcu, ctime);
1755                                         ok = animsys_write_rna_setting(&anim_rna, curval);
1756                                 }
1757
1758                                 /* clear recalc flag */
1759                                 driver->flag &= ~DRIVER_FLAG_RECALC;
1760
1761                                 /* set error-flag if evaluation failed */
1762                                 if (ok == 0)
1763                                         driver->flag |= DRIVER_FLAG_INVALID;
1764                         }
1765                 }
1766         }
1767 }
1768
1769 /* ***************************************** */
1770 /* Actions Evaluation */
1771
1772 /* strictly not necessary for actual "evaluation", but it is a useful safety check
1773  * to reduce the amount of times that users end up having to "revive" wrongly-assigned
1774  * actions
1775  */
1776 static void action_idcode_patch_check(ID *id, bAction *act)
1777 {
1778         int idcode = 0;
1779
1780         /* just in case */
1781         if (ELEM(NULL, id, act))
1782                 return;
1783         else
1784                 idcode = GS(id->name);
1785
1786         /* the actual checks... hopefully not too much of a performance hit in the long run... */
1787         if (act->idroot == 0) {
1788                 /* use the current root if not set already (i.e. newly created actions and actions from 2.50-2.57 builds)
1789                  * - this has problems if there are 2 users, and the first one encountered is the invalid one
1790                  *   in which case, the user will need to manually fix this (?)
1791                  */
1792                 act->idroot = idcode;
1793         }
1794         else if (act->idroot != idcode) {
1795                 /* only report this error if debug mode is enabled (to save performance everywhere else) */
1796                 if (G.debug & G_DEBUG) {
1797                         printf("AnimSys Safety Check Failed: Action '%s' is not meant to be used from ID-Blocks of type %d such as '%s'\n",
1798                                act->id.name + 2, idcode, id->name);
1799                 }
1800         }
1801 }
1802
1803 /* ----------------------------------------- */
1804
1805 /* Evaluate Action Group */
1806 void animsys_evaluate_action_group(PointerRNA *ptr, bAction *act, bActionGroup *agrp, float ctime)
1807 {
1808         FCurve *fcu;
1809
1810         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
1811         if (ELEM(NULL, act, agrp)) return;
1812
1813         action_idcode_patch_check(ptr->id.data, act);
1814
1815         /* if group is muted, don't evaluated any of the F-Curve */
1816         if (agrp->flag & AGRP_MUTED)
1817                 return;
1818
1819         /* calculate then execute each curve */
1820         for (fcu = agrp->channels.first; (fcu) && (fcu->grp == agrp); fcu = fcu->next) {
1821                 /* check if this curve should be skipped */
1822                 if ((fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED)) == 0) {
1823                         PathResolvedRNA anim_rna;
1824                         if (animsys_store_rna_setting(ptr, fcu->rna_path, fcu->array_index, &anim_rna)) {
1825                                 const float curval = calculate_fcurve(&anim_rna, fcu, ctime);
1826                                 animsys_write_rna_setting(&anim_rna, curval);
1827                         }
1828                 }
1829         }
1830 }
1831
1832 /* Evaluate Action (F-Curve Bag) */
1833 static void animsys_evaluate_action_ex(
1834         Depsgraph *depsgraph, PointerRNA *ptr, bAction *act, float ctime)
1835 {
1836         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
1837         if (act == NULL) return;
1838
1839         action_idcode_patch_check(ptr->id.data, act);
1840
1841         /* calculate then execute each curve */
1842         animsys_evaluate_fcurves(depsgraph, ptr, &act->curves, ctime);
1843 }
1844
1845 void animsys_evaluate_action(Depsgraph *depsgraph, PointerRNA *ptr, bAction *act, float ctime)
1846 {
1847         animsys_evaluate_action_ex(depsgraph, ptr, act, ctime);
1848 }
1849
1850 /* ***************************************** */
1851 /* NLA System - Evaluation */
1852
1853 /* calculate influence of strip based for given frame based on blendin/out values */
1854 static float nlastrip_get_influence(NlaStrip *strip, float cframe)
1855 {
1856         /* sanity checks - normalize the blendin/out values? */
1857         strip->blendin = fabsf(strip->blendin);
1858         strip->blendout = fabsf(strip->blendout);
1859
1860         /* result depends on where frame is in respect to blendin/out values */
1861         if (IS_EQF(strip->blendin, 0.0f) == false && (cframe <= (strip->start + strip->blendin))) {
1862                 /* there is some blend-in */
1863                 return fabsf(cframe - strip->start) / (strip->blendin);
1864         }
1865         else if (IS_EQF(strip->blendout, 0.0f) == false && (cframe >= (strip->end - strip->blendout))) {
1866                 /* there is some blend-out */
1867                 return fabsf(strip->end - cframe) / (strip->blendout);
1868         }
1869         else {
1870                 /* in the middle of the strip, we should be full strength */
1871                 return 1.0f;
1872         }
1873 }
1874
1875 /* evaluate the evaluation time and influence for the strip, storing the results in the strip */
1876 static void nlastrip_evaluate_controls(Depsgraph *depsgraph, NlaStrip *strip, float ctime)
1877 {
1878         /* now strip's evaluate F-Curves for these settings (if applicable) */
1879         if (strip->fcurves.first) {
1880                 PointerRNA strip_ptr;
1881
1882                 /* create RNA-pointer needed to set values */
1883                 RNA_pointer_create(NULL, &RNA_NlaStrip, strip, &strip_ptr);
1884
1885                 /* execute these settings as per normal */
1886                 animsys_evaluate_fcurves(depsgraph, &strip_ptr, &strip->fcurves, ctime);
1887         }
1888
1889         /* analytically generate values for influence and time (if applicable)
1890          * - we do this after the F-Curves have been evaluated to override the effects of those
1891          *   in case the override has been turned off.
1892          */
1893         if ((strip->flag & NLASTRIP_FLAG_USR_INFLUENCE) == 0)
1894                 strip->influence = nlastrip_get_influence(strip, ctime);
1895
1896         /* Bypass evaluation time computation if time mapping is disabled. */
1897         if ((strip->flag & NLASTRIP_FLAG_NO_TIME_MAP) != 0) {
1898                 strip->strip_time = ctime;
1899                 return;
1900         }
1901
1902         if ((strip->flag & NLASTRIP_FLAG_USR_TIME) == 0)
1903                 strip->strip_time = nlastrip_get_frame(strip, ctime, NLATIME_CONVERT_EVAL);
1904
1905         /* if user can control the evaluation time (using F-Curves), consider the option which allows this time to be clamped
1906          * to lie within extents of the action-clip, so that a steady changing rate of progress through several cycles of the clip
1907          * can be achieved easily
1908          */
1909         /* NOTE: if we add any more of these special cases, we better group them up nicely... */
1910         if ((strip->flag & NLASTRIP_FLAG_USR_TIME) && (strip->flag & NLASTRIP_FLAG_USR_TIME_CYCLIC))
1911                 strip->strip_time = fmod(strip->strip_time - strip->actstart, strip->actend - strip->actstart);
1912 }
1913
1914 /* gets the strip active at the current time for a list of strips for evaluation purposes */
1915 NlaEvalStrip *nlastrips_ctime_get_strip(Depsgraph *depsgraph, ListBase *list, ListBase *strips, short index, float ctime)
1916 {
1917         NlaStrip *strip, *estrip = NULL;
1918         NlaEvalStrip *nes;
1919         short side = 0;
1920
1921         /* loop over strips, checking if they fall within the range */
1922         for (strip = strips->first; strip; strip = strip->next) {
1923                 /* check if current time occurs within this strip  */
1924                 if (IN_RANGE_INCL(ctime, strip->start, strip->end) || (strip->flag & NLASTRIP_FLAG_NO_TIME_MAP)) {
1925                         /* this strip is active, so try to use it */
1926                         estrip = strip;
1927                         side = NES_TIME_WITHIN;
1928                         break;
1929                 }
1930
1931                 /* if time occurred before current strip... */
1932                 if (ctime < strip->start) {
1933                         if (strip == strips->first) {
1934                                 /* before first strip - only try to use it if it extends backwards in time too */
1935                                 if (strip->extendmode == NLASTRIP_EXTEND_HOLD)
1936                                         estrip = strip;
1937
1938                                 /* side is 'before' regardless of whether there's a useful strip */
1939                                 side = NES_TIME_BEFORE;
1940                         }
1941                         else {
1942                                 /* before next strip - previous strip has ended, but next hasn't begun,
1943                                  * so blending mode depends on whether strip is being held or not...
1944                                  * - only occurs when no transition strip added, otherwise the transition would have
1945                                  *   been picked up above...
1946                                  */
1947                                 strip = strip->prev;
1948
1949                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
1950                                         estrip = strip;
1951                                 side = NES_TIME_AFTER;
1952                         }
1953                         break;
1954                 }
1955
1956                 /* if time occurred after current strip... */
1957                 if (ctime > strip->end) {
1958                         /* only if this is the last strip should we do anything, and only if that is being held */
1959                         if (strip == strips->last) {
1960                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
1961                                         estrip = strip;
1962
1963                                 side = NES_TIME_AFTER;
1964                                 break;
1965                         }
1966
1967                         /* otherwise, skip... as the 'before' case will catch it more elegantly! */
1968                 }
1969         }
1970
1971         /* check if a valid strip was found
1972          * - must not be muted (i.e. will have contribution
1973          */
1974         if ((estrip == NULL) || (estrip->flag & NLASTRIP_FLAG_MUTED))
1975                 return NULL;
1976
1977         /* if ctime was not within the boundaries of the strip, clamp! */
1978         switch (side) {
1979                 case NES_TIME_BEFORE: /* extend first frame only */
1980                         ctime = estrip->start;
1981                         break;
1982                 case NES_TIME_AFTER: /* extend last frame only */
1983                         ctime = estrip->end;
1984                         break;
1985         }
1986
1987         /* evaluate strip's evaluation controls
1988          * - skip if no influence (i.e. same effect as muting the strip)
1989          * - negative influence is not supported yet... how would that be defined?
1990          */
1991         /* TODO: this sounds a bit hacky having a few isolated F-Curves stuck on some data it operates on... */
1992         nlastrip_evaluate_controls(depsgraph, estrip, ctime);
1993         if (estrip->influence <= 0.0f)
1994                 return NULL;
1995
1996         /* check if strip has valid data to evaluate,
1997          * and/or perform any additional type-specific actions
1998          */
1999         switch (estrip->type) {
2000                 case NLASTRIP_TYPE_CLIP:
2001                         /* clip must have some action to evaluate */
2002                         if (estrip->act == NULL)
2003                                 return NULL;
2004                         break;
2005                 case NLASTRIP_TYPE_TRANSITION:
2006                         /* there must be strips to transition from and to (i.e. prev and next required) */
2007                         if (ELEM(NULL, estrip->prev, estrip->next))
2008                                 return NULL;
2009
2010                         /* evaluate controls for the relevant extents of the bordering strips... */
2011                         nlastrip_evaluate_controls(depsgraph, estrip->prev, estrip->start);
2012                         nlastrip_evaluate_controls(depsgraph, estrip->next, estrip->end);
2013                         break;
2014         }
2015
2016         /* add to list of strips we need to evaluate */
2017         nes = MEM_callocN(sizeof(NlaEvalStrip), "NlaEvalStrip");
2018
2019         nes->strip = estrip;
2020         nes->strip_mode = side;
2021         nes->track_index = index;
2022         nes->strip_time = estrip->strip_time;
2023
2024         if (list)
2025                 BLI_addtail(list, nes);
2026
2027         return nes;
2028 }
2029
2030 /* ---------------------- */
2031
2032 /* Initialize a valid mask, allocating memory if necessary. */
2033 static void nlavalidmask_init(NlaValidMask *mask, int bits)
2034 {
2035         if (BLI_BITMAP_SIZE(bits) > sizeof(mask->buffer)) {
2036                 mask->ptr = BLI_BITMAP_NEW(bits, "NlaValidMask");
2037         }
2038         else {
2039                 mask->ptr = mask->buffer;
2040         }
2041 }
2042
2043 /* Free allocated memory for the mask. */
2044 static void nlavalidmask_free(NlaValidMask *mask)
2045 {
2046         if (mask->ptr != mask->buffer) {
2047                 MEM_freeN(mask->ptr);
2048         }
2049 }
2050
2051 /* ---------------------- */
2052
2053 /* Hashing functions for NlaEvalChannelKey. */
2054 static uint nlaevalchan_keyhash(const void *ptr)
2055 {
2056         const NlaEvalChannelKey *key = ptr;
2057         uint hash = BLI_ghashutil_ptrhash(key->ptr.data);
2058         return hash ^ BLI_ghashutil_ptrhash(key->prop);
2059 }
2060
2061 static bool nlaevalchan_keycmp(const void *a, const void *b)
2062 {
2063         const NlaEvalChannelKey *A = a;
2064         const NlaEvalChannelKey *B = b;
2065
2066         return ((A->ptr.data != B->ptr.data) ||
2067                 (A->prop != B->prop));
2068 }
2069
2070 /* ---------------------- */
2071
2072 /* Allocate a new blending value snapshot for the channel. */
2073 static NlaEvalChannelSnapshot *nlaevalchan_snapshot_new(NlaEvalChannel *nec)
2074 {
2075         int length = nec->base_snapshot.length;
2076
2077         size_t byte_size = sizeof(NlaEvalChannelSnapshot) + sizeof(float) * length;
2078         NlaEvalChannelSnapshot *nec_snapshot = MEM_callocN(byte_size, "NlaEvalChannelSnapshot");
2079
2080         nec_snapshot->channel = nec;
2081         nec_snapshot->length = length;
2082
2083         return nec_snapshot;
2084 }
2085
2086 /* Free a channel's blending value snapshot. */
2087 static void nlaevalchan_snapshot_free(NlaEvalChannelSnapshot *nec_snapshot)
2088 {
2089         BLI_assert(!nec_snapshot->is_base);
2090
2091         MEM_freeN(nec_snapshot);
2092 }
2093
2094 /* Copy all data in the snapshot. */
2095 static void nlaevalchan_snapshot_copy(NlaEvalChannelSnapshot *dst, const NlaEvalChannelSnapshot *src)
2096 {
2097         BLI_assert(dst->channel == src->channel);
2098
2099         memcpy(dst->values, src->values, sizeof(float) * dst->length);
2100 }
2101
2102 /* ---------------------- */
2103
2104 /* Initialize a blending state snapshot structure. */
2105 static void nlaeval_snapshot_init(NlaEvalSnapshot *snapshot, NlaEvalData *nlaeval, NlaEvalSnapshot *base)
2106 {
2107         snapshot->base = base;
2108         snapshot->size = MAX2(16, nlaeval->num_channels);
2109         snapshot->channels = MEM_callocN(sizeof(*snapshot->channels) * snapshot->size, "NlaEvalSnapshot::channels");
2110 }
2111
2112 /* Retrieve the individual channel snapshot. */
2113 static NlaEvalChannelSnapshot *nlaeval_snapshot_get(NlaEvalSnapshot *snapshot, int index)
2114 {
2115         return (index < snapshot->size) ? snapshot->channels[index] : NULL;
2116 }
2117
2118 /* Ensure at least this number of slots exists. */
2119 static void nlaeval_snapshot_ensure_size(NlaEvalSnapshot *snapshot, int size)
2120 {
2121         if (size > snapshot->size) {
2122                 snapshot->size *= 2;
2123                 CLAMP_MIN(snapshot->size, size);
2124                 CLAMP_MIN(snapshot->size, 16);
2125
2126                 size_t byte_size = sizeof(*snapshot->channels) * snapshot->size;
2127                 snapshot->channels = MEM_recallocN_id(snapshot->channels, byte_size, "NlaEvalSnapshot::channels");
2128         }
2129 }
2130
2131 /* Retrieve the address of a slot in the blending state snapshot for this channel (may realloc). */
2132 static NlaEvalChannelSnapshot **nlaeval_snapshot_ensure_slot(NlaEvalSnapshot *snapshot, NlaEvalChannel *nec)
2133 {
2134         nlaeval_snapshot_ensure_size(snapshot, nec->owner->num_channels);
2135         return &snapshot->channels[nec->index];
2136 }
2137
2138 /* Retrieve the blending snapshot for the specified channel, with fallback to base. */
2139 static NlaEvalChannelSnapshot *nlaeval_snapshot_find_channel(NlaEvalSnapshot *snapshot, NlaEvalChannel *nec)
2140 {
2141         while (snapshot != NULL) {
2142                 NlaEvalChannelSnapshot *nec_snapshot = nlaeval_snapshot_get(snapshot, nec->index);
2143                 if (nec_snapshot != NULL) {
2144                         return nec_snapshot;
2145                 }
2146                 snapshot = snapshot->base;
2147         }
2148
2149         return &nec->base_snapshot;
2150 }
2151
2152 /* Retrieve or create the channel value snapshot, copying from the other snapshot (or default values) */
2153 static NlaEvalChannelSnapshot *nlaeval_snapshot_ensure_channel(NlaEvalSnapshot *snapshot, NlaEvalChannel *nec)
2154 {
2155         NlaEvalChannelSnapshot **slot = nlaeval_snapshot_ensure_slot(snapshot, nec);
2156
2157         if (*slot == NULL) {
2158                 NlaEvalChannelSnapshot *base_snapshot, *nec_snapshot;
2159
2160                 nec_snapshot = nlaevalchan_snapshot_new(nec);
2161                 base_snapshot = nlaeval_snapshot_find_channel(snapshot->base, nec);
2162
2163                 nlaevalchan_snapshot_copy(nec_snapshot, base_snapshot);
2164
2165                 *slot = nec_snapshot;
2166         }
2167
2168         return *slot;
2169 }
2170
2171 /* Free all memory owned by this blending snapshot structure. */
2172 static void nlaeval_snapshot_free_data(NlaEvalSnapshot *snapshot)
2173 {
2174         if (snapshot->channels != NULL) {
2175                 for (int i = 0; i < snapshot->size; i++) {
2176                         NlaEvalChannelSnapshot *nec_snapshot = snapshot->channels[i];
2177                         if (nec_snapshot != NULL) {
2178                                 nlaevalchan_snapshot_free(nec_snapshot);
2179                         }
2180                 }
2181
2182                 MEM_freeN(snapshot->channels);
2183         }
2184
2185         snapshot->base = NULL;
2186         snapshot->size = 0;
2187         snapshot->channels = NULL;
2188 }
2189
2190 /* ---------------------- */
2191
2192 /* Free memory owned by this evaluation channel. */
2193 static void nlaevalchan_free_data(NlaEvalChannel *nec)
2194 {
2195         nlavalidmask_free(&nec->valid);
2196
2197         if (nec->blend_snapshot != NULL) {
2198                 nlaevalchan_snapshot_free(nec->blend_snapshot);
2199         }
2200 }
2201
2202 /* Initialize a full NLA evaluation state structure. */
2203 static void nlaeval_init(NlaEvalData *nlaeval)
2204 {
2205         memset(nlaeval, 0, sizeof(*nlaeval));
2206
2207         nlaeval->path_hash = BLI_ghash_str_new("NlaEvalData::path_hash");
2208         nlaeval->key_hash = BLI_ghash_new(nlaevalchan_keyhash, nlaevalchan_keycmp, "NlaEvalData::key_hash");
2209 }
2210
2211 static void nlaeval_free(NlaEvalData *nlaeval)
2212 {
2213         /* Delete base snapshot - its channels are part of NlaEvalChannel and shouldn't be freed. */
2214         MEM_SAFE_FREE(nlaeval->base_snapshot.channels);
2215
2216         /* Delete result snapshot. */
2217         nlaeval_snapshot_free_data(&nlaeval->eval_snapshot);
2218
2219         /* Delete channels. */
2220         for (NlaEvalChannel *nec = nlaeval->channels.first; nec; nec = nec->next) {
2221                 nlaevalchan_free_data(nec);
2222         }
2223
2224         BLI_freelistN(&nlaeval->channels);
2225         BLI_ghash_free(nlaeval->path_hash, NULL, NULL);
2226         BLI_ghash_free(nlaeval->key_hash, NULL, NULL);
2227 }
2228
2229 /* ---------------------- */
2230
2231 static int nlaevalchan_validate_index(NlaEvalChannel *nec, int index)
2232 {
2233         if (nec->is_array) {
2234                 if (index >= 0 && index < nec->base_snapshot.length) {
2235                         return index;
2236                 }
2237
2238                 return -1;
2239         }
2240         else {
2241                 return 0;
2242         }
2243 }
2244
2245 /* Initialise default values for NlaEvalChannel from the property data. */
2246 static void nlaevalchan_get_default_values(NlaEvalChannel *nec, float *r_values)
2247 {
2248         PointerRNA *ptr = &nec->key.ptr;
2249         PropertyRNA *prop = nec->key.prop;
2250         int length = nec->base_snapshot.length;
2251
2252         /* Use unit quaternion for quaternion properties. */
2253         if (nec->mix_mode == NEC_MIX_QUATERNION) {
2254                 unit_qt(r_values);
2255                 return;
2256         }
2257         /* Use all zero for Axis-Angle properties. */
2258         if (nec->mix_mode == NEC_MIX_AXIS_ANGLE) {
2259                 zero_v4(r_values);
2260                 return;
2261         }
2262
2263         /* NOTE: while this doesn't work for all RNA properties as default values aren't in fact
2264          * set properly for most of them, at least the common ones (which also happen to get used
2265          * in NLA strips a lot, e.g. scale) are set correctly.
2266          */
2267         if (RNA_property_array_check(prop)) {
2268                 BLI_assert(length == RNA_property_array_length(ptr, prop));
2269                 bool *tmp_bool;
2270                 int *tmp_int;
2271
2272                 switch (RNA_property_type(prop)) {
2273                         case PROP_BOOLEAN:
2274                                 tmp_bool = MEM_malloc_arrayN(sizeof(*tmp_bool), length, __func__);
2275                                 RNA_property_boolean_get_default_array(ptr, prop, tmp_bool);
2276                                 for (int i = 0; i < length; i++) {
2277                                         r_values[i] = (float)tmp_bool[i];
2278                                 }
2279                                 MEM_freeN(tmp_bool);
2280                                 break;
2281                         case PROP_INT:
2282                                 tmp_int = MEM_malloc_arrayN(sizeof(*tmp_int), length, __func__);
2283                                 RNA_property_int_get_default_array(ptr, prop, tmp_int);
2284                                 for (int i = 0; i < length; i++) {
2285                                         r_values[i] = (float)tmp_int[i];
2286                                 }
2287                                 MEM_freeN(tmp_int);
2288                                 break;
2289                         case PROP_FLOAT:
2290                                 RNA_property_float_get_default_array(ptr, prop, r_values);
2291                                 break;
2292                         default:
2293                                 memset(r_values, 0, sizeof(float) * length);
2294                 }
2295         }
2296         else {
2297                 BLI_assert(length == 1);
2298
2299                 switch (RNA_property_type(prop)) {
2300                         case PROP_BOOLEAN:
2301                                 *r_values = (float)RNA_property_boolean_get_default(ptr, prop);
2302                                 break;
2303                         case PROP_INT:
2304                                 *r_values = (float)RNA_property_int_get_default(ptr, prop);
2305                                 break;
2306                         case PROP_FLOAT:
2307                                 *r_values = RNA_property_float_get_default(ptr, prop);
2308                                 break;
2309                         case PROP_ENUM:
2310                                 *r_values = (float)RNA_property_enum_get_default(ptr, prop);
2311                                 break;
2312                         default:
2313                                 *r_values = 0.0f;
2314                 }
2315         }
2316
2317         /* Ensure multiplicative properties aren't reset to 0. */
2318         if (nec->mix_mode == NEC_MIX_MULTIPLY) {
2319                 for (int i = 0; i < length; i++) {
2320                         if (r_values[i] == 0.0f) {
2321                                 r_values[i] = 1.0f;
2322                         }
2323                 }
2324         }
2325 }
2326
2327 static char nlaevalchan_detect_mix_mode(NlaEvalChannelKey *key, int length)
2328 {
2329         PropertySubType subtype = RNA_property_subtype(key->prop);
2330
2331         if (subtype == PROP_QUATERNION && length == 4) {
2332                 return NEC_MIX_QUATERNION;
2333         }
2334         else if (subtype == PROP_AXISANGLE && length == 4) {
2335                 return NEC_MIX_AXIS_ANGLE;
2336         }
2337         else if (RNA_property_flag(key->prop) & PROP_PROPORTIONAL) {
2338                 return NEC_MIX_MULTIPLY;
2339         }
2340         else {
2341                 return NEC_MIX_ADD;
2342         }
2343 }
2344
2345 /* Verify that an appropriate NlaEvalChannel for this property exists. */
2346 static NlaEvalChannel *nlaevalchan_verify_key(NlaEvalData *nlaeval, const char *path, NlaEvalChannelKey *key)
2347 {
2348         /* Look it up in the key hash. */
2349         NlaEvalChannel **p_key_nec;
2350         NlaEvalChannelKey **p_key;
2351         bool found_key = BLI_ghash_ensure_p_ex(nlaeval->key_hash, key, (void ***)&p_key, (void ***)&p_key_nec);
2352
2353         if (found_key) {
2354                 return *p_key_nec;
2355         }
2356
2357         /* Create the channel. */
2358         bool is_array = RNA_property_array_check(key->prop);
2359         int length = is_array ? RNA_property_array_length(&key->ptr, key->prop) : 1;
2360
2361         NlaEvalChannel *nec = MEM_callocN(sizeof(NlaEvalChannel) + sizeof(float) * length, "NlaEvalChannel");
2362
2363         /* Initialize the channel. */
2364         nec->rna_path = path;
2365         nec->key = *key;
2366
2367         nec->owner = nlaeval;
2368         nec->index = nlaeval->num_channels++;
2369         nec->is_array = is_array;
2370
2371         nec->mix_mode = nlaevalchan_detect_mix_mode(key, length);
2372
2373         nlavalidmask_init(&nec->valid, length);
2374
2375         nec->base_snapshot.channel = nec;
2376         nec->base_snapshot.length = length;
2377         nec->base_snapshot.is_base = true;
2378
2379         nlaevalchan_get_default_values(nec, nec->base_snapshot.values);
2380
2381         /* Store channel in data structures. */
2382         BLI_addtail(&nlaeval->channels, nec);
2383
2384         *nlaeval_snapshot_ensure_slot(&nlaeval->base_snapshot, nec) = &nec->base_snapshot;
2385
2386         *p_key_nec = nec;
2387         *p_key = &nec->key;
2388
2389         return nec;
2390 }
2391
2392 /* Verify that an appropriate NlaEvalChannel for this path exists. */
2393 static NlaEvalChannel *nlaevalchan_verify(PointerRNA *ptr, NlaEvalData *nlaeval, const char *path)
2394 {
2395         if (path == NULL) {
2396                 return NULL;
2397         }
2398
2399         /* Lookup the path in the path based hash. */
2400         NlaEvalChannel **p_path_nec;
2401         bool found_path = BLI_ghash_ensure_p(nlaeval->path_hash, (void *)path, (void ***)&p_path_nec);
2402
2403         if (found_path) {
2404                 return *p_path_nec;
2405         }
2406
2407         /* Resolve the property and look it up in the key hash. */
2408         NlaEvalChannelKey key;
2409
2410         if (!RNA_path_resolve_property(ptr, path, &key.ptr, &key.prop)) {
2411                 /* Report failure to resolve the path. */
2412                 if (G.debug & G_DEBUG) {
2413                         printf("Animato: Invalid path. ID = '%s',  '%s'\n",
2414                                (ptr->id.data) ? (((ID *)ptr->id.data)->name + 2) : "<No ID>", path);
2415                 }
2416
2417                 /* Cache NULL result. */
2418                 *p_path_nec = NULL;
2419                 return NULL;
2420         }
2421
2422         NlaEvalChannel *nec = nlaevalchan_verify_key(nlaeval, path, &key);
2423
2424         if (nec->rna_path == NULL) {
2425                 nec->rna_path = path;
2426         }
2427
2428         return *p_path_nec = nec;
2429 }
2430
2431 /* ---------------------- */
2432
2433 /* accumulate the old and new values of a channel according to mode and influence */
2434 static float nla_blend_value(int blendmode, float old_value, float value, float inf)
2435 {
2436         /* optimisation: no need to try applying if there is no influence */
2437         if (IS_EQF(inf, 0.0f)) {
2438                 return old_value;
2439         }
2440
2441         /* perform blending */
2442         switch (blendmode) {
2443                 case NLASTRIP_MODE_ADD:
2444                         /* simply add the scaled value on to the stack */
2445                         return old_value + (value * inf);
2446
2447                 case NLASTRIP_MODE_SUBTRACT:
2448                         /* simply subtract the scaled value from the stack */
2449                         return old_value - (value * inf);
2450
2451                 case NLASTRIP_MODE_MULTIPLY:
2452                         /* multiply the scaled value with the stack */
2453                         /* Formula Used:
2454                          *     result = fac * (a * b) + (1 - fac) * a
2455                          */
2456                         return inf * (old_value * value)  +   (1 - inf) * old_value;
2457
2458                 case NLASTRIP_MODE_COMBINE:
2459                         BLI_assert(!"combine mode");
2460                         ATTR_FALLTHROUGH;
2461
2462                 case NLASTRIP_MODE_REPLACE:
2463                 default: /* TODO: do we really want to blend by default? it seems more uses might prefer add... */
2464                         /* do linear interpolation
2465                          * - the influence of the accumulated data (elsewhere, that is called dstweight)
2466                          *   is 1 - influence, since the strip's influence is srcweight
2467                          */
2468                         return old_value * (1.0f - inf)   +   (value * inf);
2469         }
2470 }
2471
2472 /* accumulate the old and new values of a channel according to mode and influence */
2473 static float nla_combine_value(int mix_mode, float base_value, float old_value, float value, float inf)
2474 {
2475         /* optimisation: no need to try applying if there is no influence */
2476         if (IS_EQF(inf, 0.0f)) {
2477                 return old_value;
2478         }
2479
2480         /* perform blending */
2481         switch (mix_mode) {
2482                 case NEC_MIX_ADD:
2483                 case NEC_MIX_AXIS_ANGLE:
2484                         return old_value + (value - base_value) * inf;
2485
2486                 case NEC_MIX_MULTIPLY:
2487                         if (base_value == 0.0f) {
2488                                 base_value = 1.0f;
2489                         }
2490                         return old_value * powf(value / base_value, inf);
2491
2492                 case NEC_MIX_QUATERNION:
2493                 default:
2494                         BLI_assert(!"invalid mix mode");
2495                         return old_value;
2496         }
2497 }
2498
2499 /* compute the value that would blend to the desired target value using nla_blend_value */
2500 static bool nla_invert_blend_value(int blend_mode, float old_value, float target_value, float influence, float *r_value)
2501 {
2502         switch (blend_mode) {
2503                 case NLASTRIP_MODE_ADD:
2504                         *r_value = (target_value - old_value) / influence;
2505                         return true;
2506
2507                 case NLASTRIP_MODE_SUBTRACT:
2508                         *r_value = (old_value - target_value) / influence;
2509                         return true;
2510
2511                 case NLASTRIP_MODE_MULTIPLY:
2512                         if (old_value == 0.0f) {
2513                                 /* Resolve 0/0 to 1. */
2514                                 if (target_value == 0.0f) {
2515                                         *r_value = 1.0f;
2516                                         return true;
2517                                 }
2518                                 /* Division by zero. */
2519                                 return false;
2520                         }
2521                         else {
2522                                 *r_value = (target_value - old_value) / influence / old_value + 1.0f;
2523                                 return true;
2524                         }
2525
2526                 case NLASTRIP_MODE_COMBINE:
2527                         BLI_assert(!"combine mode");
2528                         ATTR_FALLTHROUGH;
2529
2530                 case NLASTRIP_MODE_REPLACE:
2531                 default:
2532                         *r_value = (target_value - old_value) / influence + old_value;
2533                         return true;
2534         }
2535 }
2536
2537 /* compute the value that would blend to the desired target value using nla_combine_value */
2538 static bool nla_invert_combine_value(int mix_mode, float base_value, float old_value, float target_value, float influence, float *r_value)
2539 {
2540         switch (mix_mode) {
2541                 case NEC_MIX_ADD:
2542                 case NEC_MIX_AXIS_ANGLE:
2543                         *r_value = base_value + (target_value - old_value) / influence;
2544                         return true;
2545
2546                 case NEC_MIX_MULTIPLY:
2547                         if (base_value == 0.0f) {
2548                                 base_value = 1.0f;
2549                         }
2550                         if (old_value == 0.0f) {
2551                                 /* Resolve 0/0 to 1. */
2552                                 if (target_value == 0.0f) {
2553                                         *r_value = base_value;
2554                                         return true;
2555                                 }
2556                                 /* Division by zero. */
2557                                 return false;
2558                         }
2559                         else {
2560                                 *r_value = base_value * powf(target_value / old_value, 1.0f / influence);
2561                                 return true;
2562                         }
2563
2564                 case NEC_MIX_QUATERNION:
2565                 default:
2566                         BLI_assert(!"invalid mix mode");
2567                         return false;
2568         }
2569 }
2570
2571 /* accumulate quaternion channels for Combine mode according to influence */
2572 static void nla_combine_quaternion(const float old_values[4], const float values[4], float influence, float result[4])
2573 {
2574         float tmp_old[4], tmp_new[4];
2575
2576         normalize_qt_qt(tmp_old, old_values);
2577         normalize_qt_qt(tmp_new, values);
2578
2579         pow_qt_fl_normalized(tmp_new, influence);
2580         mul_qt_qtqt(result, tmp_old, tmp_new);
2581 }
2582
2583 /* invert accumulation of quaternion channels for Combine mode according to influence */
2584 static void nla_invert_combine_quaternion(const float old_values[4], const float values[4], float influence, float result[4])
2585 {
2586         float tmp_old[4], tmp_new[4];
2587
2588         normalize_qt_qt(tmp_old, old_values);
2589         normalize_qt_qt(tmp_new, values);
2590         invert_qt_normalized(tmp_old);
2591
2592         mul_qt_qtqt(result, tmp_old, tmp_new);
2593         pow_qt_fl_normalized(result, 1.0f / influence);
2594 }
2595
2596 /* Data about the current blend mode. */
2597 typedef struct NlaBlendData {
2598         NlaEvalSnapshot *snapshot;
2599         int mode;
2600         float influence;
2601
2602         NlaEvalChannel *blend_queue;
2603 } NlaBlendData;
2604
2605 /* Queue the channel for deferred blending. */
2606 static NlaEvalChannelSnapshot *nlaevalchan_queue_blend(NlaBlendData *blend, NlaEvalChannel *nec)
2607 {
2608         if (!nec->in_blend) {
2609                 if (nec->blend_snapshot == NULL) {
2610                         nec->blend_snapshot = nlaevalchan_snapshot_new(nec);
2611                 }
2612
2613                 nec->in_blend = true;
2614                 nlaevalchan_snapshot_copy(nec->blend_snapshot, &nec->base_snapshot);
2615
2616                 nec->next_blend = blend->blend_queue;
2617                 blend->blend_queue = nec;
2618         }
2619
2620         return nec->blend_snapshot;
2621 }
2622
2623 /* Accumulate (i.e. blend) the given value on to the channel it affects. */
2624 static bool nlaeval_blend_value(NlaBlendData *blend, NlaEvalChannel *nec, int array_index, float value)
2625 {
2626         if (nec == NULL) {
2627                 return false;
2628         }
2629
2630         int index = nlaevalchan_validate_index(nec, array_index);
2631
2632         if (index < 0) {
2633                 if (G.debug & G_DEBUG) {
2634                         ID *id = nec->key.ptr.id.data;
2635                         printf("Animato: Invalid array index. ID = '%s',  '%s[%d]', array length is %d\n",
2636                                id ? (id->name + 2) : "<No ID>", nec->rna_path, array_index, nec->base_snapshot.length);
2637                 }
2638
2639                 return false;
2640         }
2641
2642         if (nec->mix_mode == NEC_MIX_QUATERNION) {
2643                 /* For quaternion properties, always output all sub-channels. */
2644                 BLI_bitmap_set_all(nec->valid.ptr, true, 4);
2645         }
2646         else {
2647                 BLI_BITMAP_ENABLE(nec->valid.ptr, index);
2648         }
2649
2650         NlaEvalChannelSnapshot *nec_snapshot = nlaeval_snapshot_ensure_channel(blend->snapshot, nec);
2651         float *p_value = &nec_snapshot->values[index];
2652
2653         if (blend->mode == NLASTRIP_MODE_COMBINE) {
2654                 /* Quaternion blending is deferred until all sub-channel values are known. */
2655                 if (nec->mix_mode == NEC_MIX_QUATERNION) {
2656                         NlaEvalChannelSnapshot *blend_snapshot = nlaevalchan_queue_blend(blend, nec);
2657
2658                         blend_snapshot->values[index] = value;
2659                 }
2660                 else {
2661                         float base_value = nec->base_snapshot.values[index];
2662
2663                         *p_value = nla_combine_value(nec->mix_mode, base_value, *p_value, value, blend->influence);
2664                 }
2665         }
2666         else {
2667                 *p_value = nla_blend_value(blend->mode, *p_value, value, blend->influence);
2668         }
2669
2670         return true;
2671 }
2672
2673 /* Finish deferred quaternion blending. */
2674 static void nlaeval_blend_flush(NlaBlendData *blend)
2675 {
2676         NlaEvalChannel *nec;
2677
2678         while ((nec = blend->blend_queue)) {
2679                 blend->blend_queue = nec->next_blend;
2680                 nec->in_blend = false;
2681
2682                 NlaEvalChannelSnapshot *nec_snapshot = nlaeval_snapshot_ensure_channel(blend->snapshot, nec);
2683                 NlaEvalChannelSnapshot *blend_snapshot = nec->blend_snapshot;
2684
2685                 if (nec->mix_mode == NEC_MIX_QUATERNION) {
2686                         nla_combine_quaternion(nec_snapshot->values, blend_snapshot->values, blend->influence, nec_snapshot->values);
2687                 }
2688                 else {
2689                         BLI_assert(!"mix quaternion");
2690                 }
2691         }
2692 }
2693
2694 /* Blend the specified snapshots into the target, and free the input snapshots. */
2695 static void nlaeval_snapshot_mix_and_free(NlaEvalData *nlaeval, NlaEvalSnapshot *out, NlaEvalSnapshot *in1, NlaEvalSnapshot *in2, float alpha)
2696 {
2697         BLI_assert(in1->base == out && in2->base == out);
2698
2699         nlaeval_snapshot_ensure_size(out, nlaeval->num_channels);
2700
2701         for (int i = 0; i < nlaeval->num_channels; i++) {
2702                 NlaEvalChannelSnapshot *c_in1 = nlaeval_snapshot_get(in1, i);
2703                 NlaEvalChannelSnapshot *c_in2 = nlaeval_snapshot_get(in2, i);
2704
2705                 if (c_in1 || c_in2) {
2706                         NlaEvalChannelSnapshot *c_out = out->channels[i];
2707
2708                         /* Steal the entry from one of the input snapshots. */
2709                         if (c_out == NULL) {
2710                                 if (c_in1 != NULL) {
2711                                         c_out = c_in1;
2712                                         in1->channels[i] = NULL;
2713                                 }
2714                                 else {
2715                                         c_out = c_in2;
2716                                         in2->channels[i] = NULL;
2717                                 }
2718                         }
2719
2720                         if (c_in1 == NULL) {
2721                                 c_in1 = nlaeval_snapshot_find_channel(in1->base, c_out->channel);
2722                         }
2723                         if (c_in2 == NULL) {
2724                                 c_in2 = nlaeval_snapshot_find_channel(in2->base, c_out->channel);
2725                         }
2726
2727                         out->channels[i] = c_out;
2728
2729                         for (int j = 0; j < c_out->length; j++) {
2730                                 c_out->values[j] = c_in1->values[j] * (1.0f - alpha) + c_in2->values[j] * alpha;
2731                         }
2732                 }
2733         }
2734
2735         nlaeval_snapshot_free_data(in1);
2736         nlaeval_snapshot_free_data(in2);
2737 }
2738
2739 /* ---------------------- */
2740 /* F-Modifier stack joining/separation utilities - should we generalise these for BLI_listbase.h interface? */
2741
2742 /* Temporarily join two lists of modifiers together, storing the result in a third list */
2743 static void nlaeval_fmodifiers_join_stacks(ListBase *result, ListBase *list1, ListBase *list2)
2744 {
2745         FModifier *fcm1, *fcm2;
2746
2747         /* if list1 is invalid...  */
2748         if (ELEM(NULL, list1, list1->first)) {
2749                 if (list2 && list2->first) {
2750                         result->first = list2->first;
2751                         result->last = list2->last;
2752                 }
2753         }
2754         /* if list 2 is invalid... */
2755         else if (ELEM(NULL, list2, list2->first)) {
2756                 result->first = list1->first;
2757                 result->last = list1->last;
2758         }
2759         else {
2760                 /* list1 should be added first, and list2 second, with the endpoints of these being the endpoints for result
2761                  * - the original lists must be left unchanged though, as we need that fact for restoring
2762                  */
2763                 result->first = list1->first;
2764                 result->last = list2->last;
2765
2766                 fcm1 = list1->last;
2767                 fcm2 = list2->first;
2768
2769                 fcm1->next = fcm2;
2770                 fcm2->prev = fcm1;
2771         }
2772 }
2773
2774 /* Split two temporary lists of modifiers */
2775 static void nlaeval_fmodifiers_split_stacks(ListBase *list1, ListBase *list2)
2776 {
2777         FModifier *fcm1, *fcm2;
2778
2779         /* if list1/2 is invalid... just skip */
2780         if (ELEM(NULL, list1, list2))
2781                 return;
2782         if (ELEM(NULL, list1->first, list2->first))
2783                 return;
2784
2785         /* get endpoints */
2786         fcm1 = list1->last;
2787         fcm2 = list2->first;
2788
2789         /* clear their links */
2790         fcm1->next = NULL;
2791         fcm2->prev = NULL;
2792 }
2793
2794 /* ---------------------- */
2795
2796 /* evaluate action-clip strip */
2797 static void nlastrip_evaluate_actionclip(PointerRNA *ptr, NlaEvalData *channels, ListBase *modifiers, NlaEvalStrip *nes, NlaEvalSnapshot *snapshot)
2798 {
2799         FModifierStackStorage *storage;
2800         ListBase tmp_modifiers = {NULL, NULL};
2801         NlaStrip *strip = nes->strip;
2802         FCurve *fcu;
2803         float evaltime;
2804
2805         /* sanity checks for action */
2806         if (strip == NULL)
2807                 return;
2808
2809         if (strip->act == NULL) {
2810                 printf("NLA-Strip Eval Error: Strip '%s' has no Action\n", strip->name);
2811                 return;
2812         }
2813
2814         action_idcode_patch_check(ptr->id.data, strip->act);
2815
2816         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
2817         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers);
2818
2819         /* evaluate strip's modifiers which modify time to evaluate the base curves at */
2820         storage = evaluate_fmodifiers_storage_new(&tmp_modifiers);
2821         evaltime = evaluate_time_fmodifiers(storage, &tmp_modifiers, NULL, 0.0f, strip->strip_time);
2822
2823         NlaBlendData blend = {
2824             .snapshot = snapshot,
2825             .mode = strip->blendmode,
2826             .influence = strip->influence,
2827         };
2828
2829         /* evaluate all the F-Curves in the action, saving the relevant pointers to data that will need to be used */
2830         for (fcu = strip->act->curves.first; fcu; fcu = fcu->next) {
2831                 float value = 0.0f;
2832
2833                 /* check if this curve should be skipped */
2834                 if (fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED))
2835                         continue;
2836                 if ((fcu->grp) && (fcu->grp->flag & AGRP_MUTED))
2837                         continue;
2838
2839                 /* evaluate the F-Curve's value for the time given in the strip
2840                  * NOTE: we use the modified time here, since strip's F-Curve Modifiers are applied on top of this
2841                  */
2842                 value = evaluate_fcurve(fcu, evaltime);
2843
2844                 /* apply strip's F-Curve Modifiers on this value
2845                  * NOTE: we apply the strip's original evaluation time not the modified one (as per standard F-Curve eval)
2846                  */
2847                 evaluate_value_fmodifiers(storage, &tmp_modifiers, fcu, &value, strip->strip_time);
2848
2849                 /* get an NLA evaluation channel to work with, and accumulate the evaluated value with the value(s)
2850                  * stored in this channel if it has been used already
2851                  */
2852                 NlaEvalChannel *nec = nlaevalchan_verify(ptr, channels, fcu->rna_path);
2853
2854                 nlaeval_blend_value(&blend, nec, fcu->array_index, value);
2855         }
2856
2857         nlaeval_blend_flush(&blend);
2858
2859         /* free temporary storage */
2860         evaluate_fmodifiers_storage_free(storage);
2861
2862         /* unlink this strip's modifiers from the parent's modifiers again */
2863         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
2864 }
2865
2866 /* evaluate transition strip */
2867 static void nlastrip_evaluate_transition(
2868         Depsgraph *depsgraph, PointerRNA *ptr, NlaEvalData *channels, ListBase *modifiers, NlaEvalStrip *nes, NlaEvalSnapshot *snapshot)
2869 {
2870         ListBase tmp_modifiers = {NULL, NULL};
2871         NlaEvalSnapshot snapshot1, snapshot2;
2872         NlaEvalStrip tmp_nes;
2873         NlaStrip *s1, *s2;
2874
2875         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
2876         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &nes->strip->modifiers, modifiers);
2877
2878         /* get the two strips to operate on
2879          * - we use the endpoints of the strips directly flanking our strip
2880          *   using these as the endpoints of the transition (destination and source)
2881          * - these should have already been determined to be valid...
2882          * - if this strip is being played in reverse, we need to swap these endpoints
2883          *   otherwise they will be interpolated wrong
2884          */
2885         if (nes->strip->flag & NLASTRIP_FLAG_REVERSE) {
2886                 s1 = nes->strip->next;
2887                 s2 = nes->strip->prev;
2888         }
2889         else {
2890                 s1 = nes->strip->prev;
2891                 s2 = nes->strip->next;
2892         }
2893
2894         /* prepare template for 'evaluation strip'
2895          * - based on the transition strip's evaluation strip data
2896          * - strip_mode is NES_TIME_TRANSITION_* based on which endpoint
2897          * - strip_time is the 'normalized' (i.e. in-strip) time for evaluation,
2898          *   which doubles up as an additional weighting factor for the strip influences
2899          *   which allows us to appear to be 'interpolating' between the two extremes
2900          */
2901         tmp_nes = *nes;
2902
2903         /* evaluate these strips into a temp-buffer (tmp_channels) */
2904         /* FIXME: modifier evaluation here needs some work... */
2905         /* first strip */
2906         tmp_nes.strip_mode = NES_TIME_TRANSITION_START;
2907         tmp_nes.strip = s1;
2908         nlaeval_snapshot_init(&snapshot1, channels, snapshot);
2909         nlastrip_evaluate(depsgraph, ptr, channels, &tmp_modifiers, &tmp_nes, &snapshot1);
2910
2911         /* second strip */
2912         tmp_nes.strip_mode = NES_TIME_TRANSITION_END;
2913         tmp_nes.strip = s2;
2914         nlaeval_snapshot_init(&snapshot2, channels, snapshot);
2915         nlastrip_evaluate(depsgraph, ptr, channels, &tmp_modifiers, &tmp_nes, &snapshot2);
2916
2917         /* accumulate temp-buffer and full-buffer, using the 'real' strip */
2918         nlaeval_snapshot_mix_and_free(channels, snapshot, &snapshot1, &snapshot2, nes->strip_time);
2919
2920         /* unlink this strip's modifiers from the parent's modifiers again */
2921         nlaeval_fmodifiers_split_stacks(&nes->strip->modifiers, modifiers);
2922 }
2923
2924 /* evaluate meta-strip */
2925 static void nlastrip_evaluate_meta(
2926         Depsgraph *depsgraph, PointerRNA *ptr, NlaEvalData *channels, ListBase *modifiers, NlaEvalStrip *nes, NlaEvalSnapshot *snapshot)
2927 {
2928         ListBase tmp_modifiers = {NULL, NULL};
2929         NlaStrip *strip = nes->strip;
2930         NlaEvalStrip *tmp_nes;
2931         float evaltime;
2932
2933         /* meta-strip was calculated normally to have some time to be evaluated at
2934          * and here we 'look inside' the meta strip, treating it as a decorated window to
2935          * it's child strips, which get evaluated as if they were some tracks on a strip
2936          * (but with some extra modifiers to apply).
2937          *
2938          * NOTE: keep this in sync with animsys_evaluate_nla()
2939          */
2940
2941         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
2942         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers);
2943
2944         /* find the child-strip to evaluate */
2945         evaltime = (nes->strip_time * (strip->end - strip->start)) + strip->start;
2946         tmp_nes = nlastrips_ctime_get_strip(depsgraph, NULL, &strip->strips, -1, evaltime);
2947
2948         /* directly evaluate child strip into accumulation buffer...
2949          * - there's no need to use a temporary buffer (as it causes issues [T40082])
2950          */
2951         if (tmp_nes) {
2952                 nlastrip_evaluate(depsgraph, ptr, channels, &tmp_modifiers, tmp_nes, snapshot);
2953
2954                 /* free temp eval-strip */
2955                 MEM_freeN(tmp_nes);
2956         }
2957
2958         /* unlink this strip's modifiers from the parent's modifiers again */
2959         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
2960 }
2961
2962 /* evaluates the given evaluation strip */
2963 void nlastrip_evaluate(Depsgraph *depsgraph, PointerRNA *ptr, NlaEvalData *channels, ListBase *modifiers, NlaEvalStrip *nes, NlaEvalSnapshot *snapshot)
2964 {
2965         NlaStrip *strip = nes->strip;
2966
2967         /* to prevent potential infinite recursion problems (i.e. transition strip, beside meta strip containing a transition
2968          * several levels deep inside it), we tag the current strip as being evaluated, and clear this when we leave
2969          */
2970         /* TODO: be careful with this flag, since some edit tools may be running and have set this while animplayback was running */
2971         if (strip->flag & NLASTRIP_FLAG_EDIT_TOUCHED)
2972                 return;
2973         strip->flag |= NLASTRIP_FLAG_EDIT_TOUCHED;
2974
2975         /* actions to take depend on the type of strip */
2976         switch (strip->type) {
2977                 case NLASTRIP_TYPE_CLIP: /* action-clip */
2978                         nlastrip_evaluate_actionclip(ptr, channels, modifiers, nes, snapshot);
2979                         break;
2980                 case NLASTRIP_TYPE_TRANSITION: /* transition */
2981                         nlastrip_evaluate_transition(depsgraph, ptr, channels, modifiers, nes, snapshot);
2982                         break;
2983                 case NLASTRIP_TYPE_META: /* meta */
2984                         nlastrip_evaluate_meta(depsgraph, ptr, channels, modifiers, nes, snapshot);
2985                         break;
2986
2987                 default: /* do nothing */
2988                         break;
2989         }
2990
2991         /* clear temp recursion safe-check */
2992         strip->flag &= ~NLASTRIP_FLAG_EDIT_TOUCHED;
2993 }
2994
2995 /* write the accumulated settings to */
2996 void nladata_flush_channels(Depsgraph *depsgraph, PointerRNA *ptr, NlaEvalData *channels, NlaEvalSnapshot *snapshot)
2997 {
2998         /* sanity checks */
2999         if (channels == NULL)
3000                 return;
3001
3002         const bool is_active_depsgraph = DEG_is_active(depsgraph);
3003
3004         /* for each channel with accumulated values, write its value on the property it affects */
3005         for (NlaEvalChannel *nec = channels->channels.first; nec; nec = nec->next) {
3006                 NlaEvalChannelSnapshot *nec_snapshot = nlaeval_snapshot_find_channel(snapshot, nec);
3007
3008                 PathResolvedRNA rna = { nec->key.ptr, nec->key.prop, -1 };
3009
3010                 for (int i = 0; i < nec_snapshot->length; i++) {
3011                         if (BLI_BITMAP_TEST(nec->valid.ptr, i)) {
3012                                 float value = nec_snapshot->values[i];
3013                                 if (nec->is_array) {
3014                                         rna.prop_index = i;
3015                                 }
3016                                 animsys_write_rna_setting(&rna, value);
3017                                 if (is_active_depsgraph) {
3018                                         animsys_write_orig_anim_rna(ptr, nec->rna_path, rna.prop_index, value);
3019                                 }
3020                         }
3021                 }
3022         }
3023 }
3024
3025 /* ---------------------- */
3026
3027 static void nla_eval_domain_action(PointerRNA *ptr, NlaEvalData *channels, bAction *act, GSet *touched_actions)
3028 {
3029         if (!BLI_gset_add(touched_actions, act)) {
3030                 return;
3031         }
3032
3033         for (FCurve *fcu = act->curves.first; fcu; fcu = fcu->next) {
3034                 /* check if this curve should be skipped */
3035                 if (fcu->flag & (FCURVE_MUTED | FCURVE_DISABLED))
3036                         continue;
3037                 if ((fcu->grp) && (fcu->grp->flag & AGRP_MUTED))
3038                         continue;
3039
3040                 NlaEvalChannel *nec = nlaevalchan_verify(ptr, channels, fcu->rna_path);
3041
3042                 if (nec != NULL) {
3043                         /* For quaternion properties, enable all sub-channels. */
3044                         if (nec->mix_mode == NEC_MIX_QUATERNION) {
3045                                 BLI_bitmap_set_all(nec->valid.ptr, true, 4);
3046                                 continue;
3047                         }
3048
3049                         int idx = nlaevalchan_validate_index(nec, fcu->array_index);
3050
3051                         if (idx >= 0) {
3052                                 BLI_BITMAP_ENABLE(nec->valid.ptr, idx);
3053                         }
3054                 }
3055         }
3056 }
3057
3058 static void nla_eval_domain_strips(PointerRNA *ptr, NlaEvalData *channels, ListBase *strips, GSet *touched_actions)
3059 {
3060         for (NlaStrip *strip = strips->first; strip; strip = strip->next) {
3061                 /* check strip's action */
3062                 if (strip->act) {
3063                         nla_eval_domain_action(ptr, channels, strip->act, touched_actions);
3064                 }
3065
3066                 /* check sub-strips (if metas) */
3067                 nla_eval_domain_strips(ptr, channels, &strip->strips, touched_actions);
3068         }
3069 }
3070
3071 /**
3072  * Ensure that all channels touched by any of the actions in enabled tracks exist.
3073  * This is necessary to ensure that evaluation result depends only on current frame.
3074  */
3075 static void animsys_evaluate_nla_domain(PointerRNA *ptr, NlaEvalData *channels, AnimData *adt)
3076 {
3077         GSet *touched_actions = BLI_gset_ptr_new(__func__);
3078
3079         if (adt->action) {
3080                 nla_eval_domain_action(ptr, channels, adt->action, touched_actions);
3081         }
3082
3083         /* NLA Data - Animation Data for Strips */
3084         for (NlaTrack *nlt = adt->nla_tracks.first; nlt; nlt = nlt->next) {
3085                 /* solo and muting are mutually exclusive... */
3086                 if (adt->flag & ADT_NLA_SOLO_TRACK) {
3087                         /* skip if there is a solo track, but this isn't it */
3088                         if ((nlt->flag & NLATRACK_SOLO) == 0)
3089                                 continue;
3090                         /* else - mute doesn't matter */
3091                 }
3092                 else {
3093                         /* no solo tracks - skip track if muted */
3094                         if (nlt->flag & NLATRACK_MUTED)
3095                                 continue;
3096                 }
3097
3098                 nla_eval_domain_strips(ptr, channels, &nlt->strips, touched_actions);
3099         }
3100
3101         BLI_gset_free(touched_actions, NULL);
3102 }
3103
3104 /* ---------------------- */
3105
3106 /**
3107  * NLA Evaluation function - values are calculated and stored in temporary "NlaEvalChannels"
3108  *
3109  * \param[out] echannels Evaluation channels with calculated values
3110  * \param[out] r_context If not NULL, data about the currently edited strip is stored here and excluded from value calculation.
3111  * \return false if NLA evaluation isn't actually applicable
3112  */
3113 static bool animsys_evaluate_nla(Depsgraph *depsgraph, NlaEvalData *echannels, PointerRNA *ptr, AnimData *adt, float ctime, NlaKeyframingContext *r_context)
3114 {
3115         NlaTrack *nlt;
3116         short track_index = 0;
3117         bool has_strips = false;
3118
3119         ListBase estrips = {NULL, NULL};
3120         NlaEvalStrip *nes;
3121         NlaStrip dummy_strip_buf;
3122
3123         /* dummy strip for active action */
3124         NlaStrip *dummy_strip = r_context ? &r_context->strip : &dummy_strip_buf;
3125
3126         memset(dummy_strip, 0, sizeof(*dummy_strip));
3127
3128         /* 1. get the stack of strips to evaluate at current time (influence calculated here) */
3129         for (nlt = adt->nla_tracks.first; nlt; nlt = nlt->next, track_index++) {
3130                 /* stop here if tweaking is on and this strip is the tweaking track (it will be the first one that's 'disabled')... */
3131                 if ((adt->flag & ADT_NLA_EDIT_ON) && (nlt->flag & NLATRACK_DISABLED))
3132                         break;
3133
3134                 /* solo and muting are mutually exclusive... */
3135                 if (adt->flag & ADT_NLA_SOLO_TRACK) {
3136                         /* skip if there is a solo track, but this isn't it */
3137                         if ((nlt->flag & NLATRACK_SOLO) == 0)
3138                                 continue;
3139                         /* else - mute doesn't matter */
3140                 }
3141                 else {
3142                         /* no solo tracks - skip track if muted */
3143                         if (nlt->flag & NLATRACK_MUTED)
3144                                 continue;
3145                 }
3146
3147                 /* if this track has strips (but maybe they won't be suitable), set has_strips
3148                  * - used for mainly for still allowing normal action evaluation...
3149                  */
3150                 if (nlt->strips.first)
3151                         has_strips = true;
3152
3153                 /* otherwise, get strip to evaluate for this channel */
3154                 nes = nlastrips_ctime_get_strip(depsgraph, &estrips, &nlt->strips, track_index, ctime);
3155                 if (nes) nes->track = nlt;
3156         }
3157
3158         /* add 'active' Action (may be tweaking track) as last strip to evaluate in NLA stack
3159          * - only do this if we're not exclusively evaluating the 'solo' NLA-track
3160          * - however, if the 'solo' track houses the current 'tweaking' strip,
3161          *   then we should allow this to play, otherwise nothing happens
3162          */
3163         if ((adt->action) && ((adt->flag & ADT_NLA_SOLO_TRACK) == 0 || (adt->flag & ADT_NLA_EDIT_ON))) {
3164                 /* if there are strips, evaluate action as per NLA rules */
3165                 if ((has_strips) || (adt->actstrip)) {
3166                         /* make dummy NLA strip, and add that to the stack */
3167                         ListBase dummy_trackslist;
3168
3169                         dummy_trackslist.first = dummy_trackslist.last = dummy_strip;
3170
3171                         /* Strips with a user-defined time curve don't get properly remapped for editing
3172                          * at the moment, so mapping them just for display may be confusing. */
3173                         bool is_inplace_tweak = (nlt) && !(adt->flag & ADT_NLA_EDIT_NOMAP) && !(adt->actstrip->flag & NLASTRIP_FLAG_USR_TIME);
3174
3175                         if (is_inplace_tweak) {
3176                                 /* edit active action in-place according to its active strip, so copy the data  */
3177                                 memcpy(dummy_strip, adt->actstrip, sizeof(NlaStrip));
3178                                 dummy_strip->next = dummy_strip->prev = NULL;
3179                         }
3180                         else {
3181                                 /* set settings of dummy NLA strip from AnimData settings */
3182                                 dummy_strip->act = adt->action;
3183
3184                                 /* action range is calculated taking F-Modifiers into account (which making new strips doesn't do due to the troublesome nature of that) */
3185                                 calc_action_range(dummy_strip->act, &dummy_strip->actstart, &dummy_strip->actend, 1);
3186                                 dummy_strip->start = dummy_strip->actstart;
3187                                 dummy_strip->end = (IS_EQF(dummy_strip->actstart, dummy_strip->actend)) ?  (dummy_strip->actstart + 1.0f) : (dummy_strip->actend);
3188
3189                                 /* Always use the blend mode of the strip in tweak mode, even if not in-place. */