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