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