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