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