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