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