Fix part of #20090: boolean modifier would lose link to object
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 #include <stdio.h>
31 #include <string.h>
32 #include <stddef.h>
33 #include <float.h>
34 #include <math.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "BLI_blenlib.h"
39 #include "BLI_math.h"
40 #include "BLI_dynstr.h"
41
42 #include "DNA_anim_types.h"
43 #include "DNA_scene_types.h"
44
45 #include "BKE_animsys.h"
46 #include "BKE_action.h"
47 #include "BKE_fcurve.h"
48 #include "BKE_nla.h"
49 #include "BKE_global.h"
50 #include "BKE_main.h"
51 #include "BKE_utildefines.h"
52
53 #include "RNA_access.h"
54 #include "RNA_types.h"
55
56 #include "nla_private.h"
57
58 /* ***************************************** */
59 /* AnimData API */
60
61 /* Getter/Setter -------------------------------------------- */
62
63 /* Check if ID can have AnimData */
64 short id_type_can_have_animdata (ID *id)
65 {
66         /* sanity check */
67         if (id == NULL)
68                 return 0;
69                 
70         /* Only some ID-blocks have this info for now */
71         // TODO: finish adding this for the other blocktypes
72         switch (GS(id->name)) {
73                         /* has AnimData */
74                 case ID_OB:
75                 case ID_ME: case ID_MB: case ID_CU: case ID_AR:
76                 case ID_KE:
77                 case ID_PA:
78                 case ID_MA: case ID_TE: case ID_NT:
79                 case ID_LA: case ID_CA: case ID_WO:
80                 case ID_SCE:
81                 {
82                         return 1;
83                 }
84                 
85                         /* no AnimData */
86                 default:
87                         return 0;
88         }
89 }
90
91
92 /* Get AnimData from the given ID-block. In order for this to work, we assume that 
93  * the AnimData pointer is stored immediately after the given ID-block in the struct,
94  * as per IdAdtTemplate.
95  */
96 AnimData *BKE_animdata_from_id (ID *id)
97 {
98         /* only some ID-blocks have this info for now, so we cast the 
99          * types that do to be of type IdAdtTemplate, and extract the
100          * AnimData that way
101          */
102         if (id_type_can_have_animdata(id)) {
103                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
104                 return iat->adt;
105         }
106         else
107                 return NULL;
108 }
109
110 /* Add AnimData to the given ID-block. In order for this to work, we assume that 
111  * the AnimData pointer is stored immediately after the given ID-block in the struct,
112  * as per IdAdtTemplate. Also note that 
113  */
114 AnimData *BKE_id_add_animdata (ID *id)
115 {
116         /* Only some ID-blocks have this info for now, so we cast the 
117          * types that do to be of type IdAdtTemplate, and add the AnimData
118          * to it using the template
119          */
120         if (id_type_can_have_animdata(id)) {
121                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
122                 
123                 /* check if there's already AnimData, in which case, don't add */
124                 if (iat->adt == NULL) {
125                         AnimData *adt;
126                         
127                         /* add animdata */
128                         adt= iat->adt= MEM_callocN(sizeof(AnimData), "AnimData");
129                         
130                         /* set default settings */
131                         adt->act_influence= 1.0f;
132                 }
133                 
134                 return iat->adt;
135         }
136         else 
137                 return NULL;
138 }
139
140 /* Freeing -------------------------------------------- */
141
142 /* Free AnimData used by the nominated ID-block, and clear ID-block's AnimData pointer */
143 void BKE_free_animdata (ID *id)
144 {
145         /* Only some ID-blocks have this info for now, so we cast the 
146          * types that do to be of type IdAdtTemplate
147          */
148         if (id_type_can_have_animdata(id)) {
149                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
150                 AnimData *adt= iat->adt;
151                 
152                 /* check if there's any AnimData to start with */
153                 if (adt) {
154                         /* unlink action (don't free, as it's in its own list) */
155                         if (adt->action)
156                                 adt->action->id.us--;
157                         /* same goes for the temporarily displaced action */
158                         if (adt->tmpact)
159                                 adt->tmpact->id.us--;
160                                 
161                         /* free nla data */
162                         free_nladata(&adt->nla_tracks);
163                         
164                         /* free drivers - stored as a list of F-Curves */
165                         free_fcurves(&adt->drivers);
166                         
167                         /* free overrides */
168                         // TODO...
169                         
170                         /* free animdata now */
171                         MEM_freeN(adt);
172                         iat->adt= NULL;
173                 }
174         }
175 }
176
177 /* Freeing -------------------------------------------- */
178
179 /* Make a copy of the given AnimData - to be used when copying datablocks */
180 AnimData *BKE_copy_animdata (AnimData *adt)
181 {
182         AnimData *dadt;
183         
184         /* sanity check before duplicating struct */
185         if (adt == NULL)
186                 return NULL;
187         dadt= MEM_dupallocN(adt);
188         
189         /* make a copy of action - at worst, user has to delete copies... */
190         dadt->action= copy_action(adt->action);
191         dadt->tmpact= copy_action(adt->tmpact);
192         
193         /* duplicate NLA data */
194         copy_nladata(&dadt->nla_tracks, &adt->nla_tracks);
195         
196         /* duplicate drivers (F-Curves) */
197         copy_fcurves(&dadt->drivers, &adt->drivers);
198         
199         /* don't copy overrides */
200         dadt->overrides.first= dadt->overrides.last= NULL;
201         
202         /* return */
203         return dadt;
204 }
205
206 int BKE_copy_animdata_id(struct ID *id_to, struct ID *id_from)
207 {
208         AnimData *adt;
209
210         if((id_to && id_from) && (GS(id_to->name) != GS(id_from->name)))
211                 return 0;
212
213         BKE_free_animdata(id_to);
214
215         adt = BKE_animdata_from_id(id_from);
216         if (adt) {
217                 IdAdtTemplate *iat = (IdAdtTemplate *)id_to;
218                 iat->adt= BKE_copy_animdata(adt);
219         }
220
221         return 1;
222 }
223
224
225
226 /* Make Local -------------------------------------------- */
227
228 static void make_local_strips(ListBase *strips)
229 {
230         NlaStrip *strip;
231
232         for (strip=strips->first; strip; strip=strip->next) {
233                 if (strip->act) make_local_action(strip->act);
234                 if (strip->remap && strip->remap->target) make_local_action(strip->remap->target);
235                 
236                 make_local_strips(&strip->strips);
237         }
238 }
239
240 /* Use local copy instead of linked copy of various ID-blocks */
241 void BKE_animdata_make_local(AnimData *adt)
242 {
243         NlaTrack *nlt;
244         
245         /* Actions - Active and Temp */
246         if (adt->action) make_local_action(adt->action);
247         if (adt->tmpact) make_local_action(adt->tmpact);
248         /* Remaps */
249         if (adt->remap && adt->remap->target) make_local_action(adt->remap->target);
250         
251         /* Drivers */
252         // TODO: need to remap the ID-targets too?
253         
254         /* NLA Data */
255         for (nlt=adt->nla_tracks.first; nlt; nlt=nlt->next) 
256                 make_local_strips(&nlt->strips);
257 }
258
259 /* Path Validation -------------------------------------------- */
260
261 /* Check if a given RNA Path is valid, by tracing it from the given ID, and seeing if we can resolve it */
262 static short check_rna_path_is_valid (ID *owner_id, char *path)
263 {
264         PointerRNA id_ptr, ptr;
265         PropertyRNA *prop=NULL;
266         
267         /* make initial RNA pointer to start resolving from */
268         RNA_id_pointer_create(owner_id, &id_ptr);
269         
270         /* try to resolve */
271         return RNA_path_resolve(&id_ptr, path, &ptr, &prop); 
272 }
273
274 /* Check if some given RNA Path needs fixing - free the given path and set a new one as appropriate 
275  * NOTE: we assume that oldName and newName have [" "] padding around them
276  */
277 static char *rna_path_rename_fix (ID *owner_id, char *prefix, char *oldName, char *newName, char *oldpath)
278 {
279         char *prefixPtr= strstr(oldpath, prefix);
280         char *oldNamePtr= strstr(oldpath, oldName);
281         int prefixLen= strlen(prefix);
282         int oldNameLen= strlen(oldName);
283         
284         /* only start fixing the path if the prefix and oldName feature in the path,
285          * and prefix occurs immediately before oldName
286          */
287         if ( (prefixPtr && oldNamePtr) && (prefixPtr+prefixLen == oldNamePtr) ) {
288                 /* if we haven't aren't able to resolve the path now, try again after fixing it */
289                 if (check_rna_path_is_valid(owner_id, oldpath) == 0) {          
290                         DynStr *ds= BLI_dynstr_new();
291                         char *postfixPtr= oldNamePtr+oldNameLen;
292                         char *newPath = NULL;
293                         char oldChar;
294                         
295                         /* add the part of the string that goes up to the start of the prefix */
296                         if (prefixPtr > oldpath) {
297                                 oldChar= prefixPtr[0]; 
298                                 prefixPtr[0]= 0;
299                                 BLI_dynstr_append(ds, oldpath);
300                                 prefixPtr[0]= oldChar;
301                         }
302                         
303                         /* add the prefix */
304                         BLI_dynstr_append(ds, prefix);
305                         
306                         /* add the new name (complete with brackets) */
307                         BLI_dynstr_append(ds, newName);
308                         
309                         /* add the postfix */
310                         BLI_dynstr_append(ds, postfixPtr);
311                         
312                         /* create new path, and cleanup old data */
313                         newPath= BLI_dynstr_get_cstring(ds);
314                         BLI_dynstr_free(ds);
315                         
316                         /* check if the new path will solve our problems */
317                         // TODO: will need to check whether this step really helps in practice
318                         if (check_rna_path_is_valid(owner_id, newPath)) {
319                                 /* free the old path, and return the new one, since we've solved the issues */
320                                 MEM_freeN(oldpath);
321                                 return newPath;
322                         }
323                         else {
324                                 /* still couldn't resolve the path... so, might as well just leave it alone */
325                                 MEM_freeN(newPath);
326                         }
327                 }
328         }
329         
330         /* the old path doesn't need to be changed */
331         return oldpath;
332 }
333
334 /* Check RNA-Paths for a list of F-Curves */
335 static void fcurves_path_rename_fix (ID *owner_id, char *prefix, char *oldName, char *newName, ListBase *curves)
336 {
337         FCurve *fcu;
338         
339         /* we need to check every curve... */
340         for (fcu= curves->first; fcu; fcu= fcu->next) {
341                 /* firstly, handle the F-Curve's own path */
342                 if (fcu->rna_path)
343                         fcu->rna_path= rna_path_rename_fix(owner_id, prefix, oldName, newName, fcu->rna_path);
344                 
345                 /* driver? */
346                 if (fcu->driver) {
347                         ChannelDriver *driver= fcu->driver;
348                         DriverVar *dvar;
349                         
350                         /* driver variables */
351                         for (dvar= driver->variables.first; dvar; dvar=dvar->next) {
352                                 /* only change the used targets, since the others will need fixing manually anyway */
353                                 DRIVER_TARGETS_USED_LOOPER(dvar) 
354                                 {
355                                         /* rename RNA path */
356                                         if (dtar->rna_path)
357                                                 dtar->rna_path= rna_path_rename_fix(dtar->id, prefix, oldName, newName, dtar->rna_path);
358                                         
359                                         /* also fix the bone-name (if applicable) */
360                                         // XXX this has been disabled because the old/new names have padding which means this check will fail
361                                         //if ( ((dtar->id) && (GS(dtar->id->name) == ID_OB)) &&
362                                         //       (dtar->pchan_name[0]) && (strcmp(oldName, dtar->pchan_name)==0) )
363                                         //{
364                                         //      BLI_strncpy(dtar->pchan_name, newName, sizeof(dtar->pchan_name));
365                                         //}
366                                 }
367                                 DRIVER_TARGETS_LOOPER_END
368                         }
369                 }
370         }
371 }
372
373 /* Fix all RNA-Paths for Actions linked to NLA Strips */
374 static void nlastrips_path_rename_fix (ID *owner_id, char *prefix, char *oldName, char *newName, ListBase *strips)
375 {
376         NlaStrip *strip;
377         
378         /* recursively check strips, fixing only actions... */
379         for (strip= strips->first; strip; strip= strip->next) {
380                 /* fix strip's action */
381                 if (strip->act)
382                         fcurves_path_rename_fix(owner_id, prefix, oldName, newName, &strip->act->curves);
383                 /* ignore own F-Curves, since those are local...  */
384                 
385                 /* check sub-strips (if metas) */
386                 nlastrips_path_rename_fix(owner_id, prefix, oldName, newName, &strip->strips);
387         }
388 }
389
390 /* Fix all RNA-Paths in the AnimData block used by the given ID block
391  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
392  *              i.e. pose.bones["Bone"]
393  */
394 void BKE_animdata_fix_paths_rename (ID *owner_id, AnimData *adt, char *prefix, char *oldName, char *newName)
395 {
396         NlaTrack *nlt;
397         char *oldN, *newN;
398         
399         /* if no AnimData, no need to proceed */
400         if (ELEM4(NULL, owner_id, adt, oldName, newName))
401                 return;
402         
403         /* pad the names with [" "] so that only exact matches are made */
404         oldN= BLI_sprintfN("[\"%s\"]", oldName);
405         newN= BLI_sprintfN("[\"%s\"]", newName);
406         
407         /* Active action and temp action */
408         if (adt->action)
409                 fcurves_path_rename_fix(owner_id, prefix, oldN, newN, &adt->action->curves);
410         if (adt->tmpact)
411                 fcurves_path_rename_fix(owner_id, prefix, oldN, newN, &adt->tmpact->curves);
412                 
413         /* Drivers - Drivers are really F-Curves */
414         fcurves_path_rename_fix(owner_id, prefix, oldN, newN, &adt->drivers);
415         
416         /* NLA Data - Animation Data for Strips */
417         for (nlt= adt->nla_tracks.first; nlt; nlt= nlt->next)
418                 nlastrips_path_rename_fix(owner_id, prefix, oldN, newN, &nlt->strips);
419                 
420         /* free the temp names */
421         MEM_freeN(oldN);
422         MEM_freeN(newN);
423 }
424
425 /* Fix all RNA-Paths throughout the database (directly access the Global.main version)
426  * NOTE: it is assumed that the structure we're replacing is <prefix><["><name><"]>
427  *              i.e. pose.bones["Bone"]
428  */
429 void BKE_all_animdata_fix_paths_rename (char *prefix, char *oldName, char *newName)
430 {
431         Main *mainptr= G.main;
432         ID *id;
433         
434         /* macro for less typing 
435          *      - whether animdata exists is checked for by the main renaming callback, though taking 
436          *        this outside of the function may make things slightly faster?
437          */
438 #define RENAMEFIX_ANIM_IDS(first) \
439         for (id= first; id; id= id->next) { \
440                 AnimData *adt= BKE_animdata_from_id(id); \
441                 BKE_animdata_fix_paths_rename(id, adt, prefix, oldName, newName);\
442         }
443         
444         /* nodes */
445         RENAMEFIX_ANIM_IDS(mainptr->nodetree.first);
446         
447         /* textures */
448         RENAMEFIX_ANIM_IDS(mainptr->tex.first);
449         
450         /* lamps */
451         RENAMEFIX_ANIM_IDS(mainptr->lamp.first);
452         
453         /* materials */
454         RENAMEFIX_ANIM_IDS(mainptr->mat.first);
455         
456         /* cameras */
457         RENAMEFIX_ANIM_IDS(mainptr->camera.first);
458         
459         /* shapekeys */
460         RENAMEFIX_ANIM_IDS(mainptr->key.first);
461         
462         /* metaballs */
463         RENAMEFIX_ANIM_IDS(mainptr->mball.first);
464         
465         /* curves */
466         RENAMEFIX_ANIM_IDS(mainptr->curve.first);
467         
468         /* armatures */
469         RENAMEFIX_ANIM_IDS(mainptr->armature.first);
470         
471         /* meshes */
472         // TODO...
473         
474         /* particles */
475         RENAMEFIX_ANIM_IDS(mainptr->particle.first);
476         
477         /* objects */
478         RENAMEFIX_ANIM_IDS(mainptr->object.first); 
479         
480         /* worlds */
481         RENAMEFIX_ANIM_IDS(mainptr->world.first);
482         
483         /* scenes */
484         for (id= mainptr->scene.first; id; id= id->next) {
485                 AnimData *adt= BKE_animdata_from_id(id);
486                 Scene *scene= (Scene *)id;
487                 
488                 /* do compositing nodes first (since these aren't included in main tree) */
489                 if (scene->nodetree) {
490                         AnimData *adt2= BKE_animdata_from_id((ID *)scene->nodetree);
491                         BKE_animdata_fix_paths_rename((ID *)scene->nodetree, adt2, prefix, oldName, newName);
492                 }
493                 
494                 /* now fix scene animation data as per normal */
495                 BKE_animdata_fix_paths_rename((ID *)id, adt, prefix, oldName, newName);
496         }
497 }
498
499 /* *********************************** */ 
500 /* KeyingSet API */
501
502 /* Finding Tools --------------------------- */
503
504 /* Find the first path that matches the given criteria */
505 // TODO: do we want some method to perform partial matches too?
506 KS_Path *BKE_keyingset_find_destination (KeyingSet *ks, ID *id, const char group_name[], const char rna_path[], int array_index, int group_mode)
507 {
508         KS_Path *ksp;
509         
510         /* sanity checks */
511         if ELEM(NULL, ks, rna_path)
512                 return NULL;
513         
514         /* ID is optional for relative KeyingSets, but is necessary for absolute KeyingSets */
515         if (id == NULL) {
516                 if (ks->flag & KEYINGSET_ABSOLUTE)
517                         return NULL;
518         }
519         
520         /* loop over paths in the current KeyingSet, finding the first one where all settings match 
521          * (i.e. the first one where none of the checks fail and equal 0)
522          */
523         for (ksp= ks->paths.first; ksp; ksp= ksp->next) {
524                 short eq_id=1, eq_path=1, eq_index=1, eq_group=1;
525                 
526                 /* id */
527                 if ((ks->flag & KEYINGSET_ABSOLUTE) && (id != ksp->id))
528                         eq_id= 0;
529                 
530                 /* path */
531                 if ((ksp->rna_path==0) || strcmp(rna_path, ksp->rna_path))
532                         eq_path= 0;
533                         
534                 /* index - need to compare whole-array setting too... */
535                 if (ksp->array_index != array_index)
536                         eq_index= 0;
537                         
538                 /* group */
539                 if (group_name) {
540                         // FIXME: these checks need to be coded... for now, it's not too important though
541                 }
542                         
543                 /* if all aspects are ok, return */
544                 if (eq_id && eq_path && eq_index && eq_group)
545                         return ksp;
546         }
547         
548         /* none found */
549         return NULL;
550 }
551  
552 /* Defining Tools --------------------------- */
553
554 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
555 KeyingSet *BKE_keyingset_add (ListBase *list, const char name[], short flag, short keyingflag)
556 {
557         KeyingSet *ks;
558         
559         /* allocate new KeyingSet */
560         ks= MEM_callocN(sizeof(KeyingSet), "KeyingSet");
561         
562         if (name)
563                 BLI_snprintf(ks->name, 64, name);
564         else
565                 strcpy(ks->name, "KeyingSet");
566         
567         ks->flag= flag;
568         ks->keyingflag= keyingflag;
569         
570         /* add KeyingSet to list */
571         BLI_addtail(list, ks);
572         
573         /* make sure KeyingSet has a unique name (this helps with identification) */
574         BLI_uniquename(list, ks, "KeyingSet", '.', offsetof(KeyingSet, name), 64);
575         
576         /* return new KeyingSet for further editing */
577         return ks;
578 }
579
580 /* Add a destination to a KeyingSet. Nothing is returned for now...
581  * Checks are performed to ensure that destination is appropriate for the KeyingSet in question
582  */
583 void BKE_keyingset_add_destination (KeyingSet *ks, ID *id, const char group_name[], const char rna_path[], int array_index, short flag, short groupmode)
584 {
585         KS_Path *ksp;
586         
587         /* sanity checks */
588         if ELEM(NULL, ks, rna_path) {
589                 printf("ERROR: no Keying Set and/or RNA Path to add destination with \n");
590                 return;
591         }
592         
593         /* ID is optional for relative KeyingSets, but is necessary for absolute KeyingSets */
594         if (id == NULL) {
595                 if (ks->flag & KEYINGSET_ABSOLUTE) {
596                         printf("ERROR: No ID provided for absolute destination. \n");
597                         return;
598                 }
599         }
600         
601         /* don't add if there is already a matching KS_Path in the KeyingSet */
602         if (BKE_keyingset_find_destination(ks, id, group_name, rna_path, array_index, groupmode)) {
603                 if (G.f & G_DEBUG)
604                         printf("ERROR: destination already exists in Keying Set \n");
605                 return;
606         }
607         
608         /* allocate a new KeyingSet Path */
609         ksp= MEM_callocN(sizeof(KS_Path), "KeyingSet Path");
610         
611         /* just store absolute info */
612         if (ks->flag & KEYINGSET_ABSOLUTE) {
613                 ksp->id= id;
614                 if (group_name)
615                         BLI_snprintf(ksp->group, 64, group_name);
616                 else
617                         strcpy(ksp->group, "");
618         }
619         
620         /* store additional info for relative paths (just in case user makes the set relative) */
621         if (id)
622                 ksp->idtype= GS(id->name);
623         
624         /* just copy path info */
625         // XXX no checks are performed for templates yet
626         // should array index be checked too?
627         ksp->rna_path= BLI_strdupn(rna_path, strlen(rna_path));
628         ksp->array_index= array_index;
629         
630         /* store flags */
631         ksp->flag= flag;
632         ksp->groupmode= groupmode;
633         
634         /* add KeyingSet path to KeyingSet */
635         BLI_addtail(&ks->paths, ksp);
636 }       
637
638 /* Copy all KeyingSets in the given list */
639 void BKE_keyingsets_copy(ListBase *newlist, ListBase *list)
640 {
641         KeyingSet *ksn;
642         KS_Path *kspn;
643
644         BLI_duplicatelist(newlist, list);
645
646         for(ksn=newlist->first; ksn; ksn=ksn->next) {
647                 BLI_duplicatelist(&ksn->paths, &ksn->paths);
648
649                 for(kspn=ksn->paths.first; kspn; kspn=kspn->next)
650                         kspn->rna_path= MEM_dupallocN(kspn->rna_path);
651         }
652 }
653
654 /* Freeing Tools --------------------------- */
655
656 /* Free data for KeyingSet but not set itself */
657 void BKE_keyingset_free (KeyingSet *ks)
658 {
659         KS_Path *ksp, *kspn;
660         
661         /* sanity check */
662         if (ks == NULL)
663                 return;
664         
665         /* free each path as we go to avoid looping twice */
666         for (ksp= ks->paths.first; ksp; ksp= kspn) {
667                 kspn= ksp->next;
668                 
669                 /* free RNA-path info */
670                 MEM_freeN(ksp->rna_path);
671                 
672                 /* free path itself */
673                 BLI_freelinkN(&ks->paths, ksp);
674         }
675 }
676
677 /* Free all the KeyingSets in the given list */
678 void BKE_keyingsets_free (ListBase *list)
679 {
680         KeyingSet *ks, *ksn;
681         
682         /* sanity check */
683         if (list == NULL)
684                 return;
685         
686         /* loop over KeyingSets freeing them 
687          *      - BKE_keyingset_free() doesn't free the set itself, but it frees its sub-data
688          */
689         for (ks= list->first; ks; ks= ksn) {
690                 ksn= ks->next;
691                 BKE_keyingset_free(ks);
692                 BLI_freelinkN(list, ks);
693         }
694 }
695
696 /* ***************************************** */
697 /* Evaluation Data-Setting Backend */
698
699 /* Retrieve string to act as RNA-path, adjusted using mapping-table if provided 
700  * It returns whether the string needs to be freed (i.e. if it was a temp remapped one)
701  * // 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
702  *
703  *      - remap: remapping table to use
704  *      - path: original path string (as stored in F-Curve data)
705  *      - dst: destination string to write data to
706  */
707 static short animsys_remap_path (AnimMapper *remap, char *path, char **dst)
708 {
709         /* is there a valid remapping table to use? */
710         //if (remap) {
711                 /* find a matching entry... to use to remap */
712                 // ...TODO...
713         //}
714         
715         /* nothing suitable found, so just set dst to look at path (i.e. no alloc/free needed) */
716         *dst= path;
717         return 0;
718 }
719
720
721 /* Write the given value to a setting using RNA, and return success */
722 static short animsys_write_rna_setting (PointerRNA *ptr, char *path, int array_index, float value)
723 {
724         PropertyRNA *prop;
725         PointerRNA new_ptr;
726         
727         /* get property to write to */
728         if (RNA_path_resolve(ptr, path, &new_ptr, &prop)) 
729         {
730                 /* set value - only for animatable numerical values */
731                 if (RNA_property_animateable(&new_ptr, prop)) 
732                 {
733                         switch (RNA_property_type(prop)) 
734                         {
735                                 case PROP_BOOLEAN:
736                                         if (RNA_property_array_length(&new_ptr, prop))
737                                                 RNA_property_boolean_set_index(&new_ptr, prop, array_index, (int)value);
738                                         else
739                                                 RNA_property_boolean_set(&new_ptr, prop, (int)value);
740                                         break;
741                                 case PROP_INT:
742                                         if (RNA_property_array_length(&new_ptr, prop))
743                                                 RNA_property_int_set_index(&new_ptr, prop, array_index, (int)value);
744                                         else
745                                                 RNA_property_int_set(&new_ptr, prop, (int)value);
746                                         break;
747                                 case PROP_FLOAT:
748                                         if (RNA_property_array_length(&new_ptr, prop))
749                                                 RNA_property_float_set_index(&new_ptr, prop, array_index, value);
750                                         else
751                                                 RNA_property_float_set(&new_ptr, prop, value);
752                                         break;
753                                 case PROP_ENUM:
754                                         RNA_property_enum_set(&new_ptr, prop, (int)value);
755                                         break;
756                                 default:
757                                         /* nothing can be done here... so it is unsuccessful? */
758                                         return 0;
759                         }
760                 }
761                 
762                 /* successful */
763                 return 1;
764         }
765         else {
766                 /* failed to get path */
767                 // XXX don't tag as failed yet though, as there are some legit situations (Action Constraint) 
768                 // where some channels will not exist, but shouldn't lock up Action
769                 if (G.f & G_DEBUG) {
770                         printf("Animato: Invalid path. ID = '%s',  '%s [%d]' \n", 
771                                 (ptr && ptr->id.data) ? (((ID *)ptr->id.data)->name+2) : "<No ID>", 
772                                 path, array_index);
773                 }
774                 return 0;
775         }
776 }
777
778 /* Simple replacement based data-setting of the FCurve using RNA */
779 static short animsys_execute_fcurve (PointerRNA *ptr, AnimMapper *remap, FCurve *fcu)
780 {
781         char *path = NULL;
782         short free_path=0;
783         short ok= 0;
784         
785         /* get path, remapped as appropriate to work in its new environment */
786         free_path= animsys_remap_path(remap, fcu->rna_path, &path);
787         
788         /* write value to setting */
789         if (path)
790                 ok= animsys_write_rna_setting(ptr, path, fcu->array_index, fcu->curval);
791         
792         /* free temp path-info */
793         if (free_path)
794                 MEM_freeN(path);
795                 
796         /* return whether we were successful */
797         return ok;
798 }
799
800 /* Evaluate all the F-Curves in the given list 
801  * This performs a set of standard checks. If extra checks are required, separate code should be used
802  */
803 static void animsys_evaluate_fcurves (PointerRNA *ptr, ListBase *list, AnimMapper *remap, float ctime)
804 {
805         FCurve *fcu;
806         
807         /* calculate then execute each curve */
808         for (fcu= list->first; fcu; fcu= fcu->next) 
809         {
810                 /* check if this F-Curve doesn't belong to a muted group */
811                 if ((fcu->grp == NULL) || (fcu->grp->flag & AGRP_MUTED)==0) {
812                         /* check if this curve should be skipped */
813                         if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
814                         {
815                                 calculate_fcurve(fcu, ctime);
816                                 animsys_execute_fcurve(ptr, remap, fcu); 
817                         }
818                 }
819         }
820 }
821
822 /* ***************************************** */
823 /* Driver Evaluation */
824
825 /* Evaluate Drivers */
826 static void animsys_evaluate_drivers (PointerRNA *ptr, AnimData *adt, float ctime)
827 {
828         FCurve *fcu;
829         
830         /* drivers are stored as F-Curves, but we cannot use the standard code, as we need to check if
831          * the depsgraph requested that this driver be evaluated...
832          */
833         for (fcu= adt->drivers.first; fcu; fcu= fcu->next) 
834         {
835                 ChannelDriver *driver= fcu->driver;
836                 short ok= 0;
837                 
838                 /* check if this driver's curve should be skipped */
839                 if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
840                 {
841                         /* check if driver itself is tagged for recalculation */
842                         if ((driver) && !(driver->flag & DRIVER_FLAG_INVALID)/*&& (driver->flag & DRIVER_FLAG_RECALC)*/) {      // XXX driver recalc flag is not set yet by depsgraph!
843                                 /* evaluate this using values set already in other places */
844                                 // 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
845                                 calculate_fcurve(fcu, ctime);
846                                 ok= animsys_execute_fcurve(ptr, NULL, fcu);
847                                 
848                                 /* clear recalc flag */
849                                 driver->flag &= ~DRIVER_FLAG_RECALC;
850                                 
851                                 /* set error-flag if evaluation failed */
852                                 if (ok == 0)
853                                         driver->flag |= DRIVER_FLAG_INVALID; 
854                         }
855                 }
856         }
857 }
858
859 /* ***************************************** */
860 /* Actions Evaluation */
861
862 /* Evaluate Action Group */
863 void animsys_evaluate_action_group (PointerRNA *ptr, bAction *act, bActionGroup *agrp, AnimMapper *remap, float ctime)
864 {
865         FCurve *fcu;
866         
867         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
868         if ELEM(NULL, act, agrp) return;
869         if ((remap) && (remap->target != act)) remap= NULL;
870         
871         /* if group is muted, don't evaluated any of the F-Curve */
872         if (agrp->flag & AGRP_MUTED)
873                 return;
874         
875         /* calculate then execute each curve */
876         for (fcu= agrp->channels.first; (fcu) && (fcu->grp == agrp); fcu= fcu->next) 
877         {
878                 /* check if this curve should be skipped */
879                 if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
880                 {
881                         calculate_fcurve(fcu, ctime);
882                         animsys_execute_fcurve(ptr, remap, fcu); 
883                 }
884         }
885 }
886
887 /* Evaluate Action (F-Curve Bag) */
888 void animsys_evaluate_action (PointerRNA *ptr, bAction *act, AnimMapper *remap, float ctime)
889 {
890         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
891         if (act == NULL) return;
892         if ((remap) && (remap->target != act)) remap= NULL;
893         
894         /* calculate then execute each curve */
895         animsys_evaluate_fcurves(ptr, &act->curves, remap, ctime);
896 }
897
898 /* ***************************************** */
899 /* NLA System - Evaluation */
900
901 /* calculate influence of strip based for given frame based on blendin/out values */
902 static float nlastrip_get_influence (NlaStrip *strip, float cframe)
903 {
904         /* sanity checks - normalise the blendin/out values? */
905         strip->blendin= (float)fabs(strip->blendin);
906         strip->blendout= (float)fabs(strip->blendout);
907         
908         /* result depends on where frame is in respect to blendin/out values */
909         if (IS_EQ(strip->blendin, 0)==0 && (cframe <= (strip->start + strip->blendin))) {
910                 /* there is some blend-in */
911                 return (float)fabs(cframe - strip->start) / (strip->blendin);
912         }
913         else if (IS_EQ(strip->blendout, 0)==0 && (cframe >= (strip->end - strip->blendout))) {
914                 /* there is some blend-out */
915                 return (float)fabs(strip->end - cframe) / (strip->blendout);
916         }
917         else {
918                 /* in the middle of the strip, we should be full strength */
919                 return 1.0f;
920         }
921 }
922
923 /* evaluate the evaluation time and influence for the strip, storing the results in the strip */
924 static void nlastrip_evaluate_controls (NlaStrip *strip, float ctime)
925 {
926         /* firstly, analytically generate values for influence and time (if applicable) */
927         if ((strip->flag & NLASTRIP_FLAG_USR_TIME) == 0)
928                 strip->strip_time= nlastrip_get_frame(strip, ctime, NLATIME_CONVERT_EVAL);
929         if ((strip->flag & NLASTRIP_FLAG_USR_INFLUENCE) == 0)
930                 strip->influence= nlastrip_get_influence(strip, ctime);
931         
932         /* now strip's evaluate F-Curves for these settings (if applicable) */
933         if (strip->fcurves.first) {
934                 PointerRNA strip_ptr;
935                 
936                 /* create RNA-pointer needed to set values */
937                 RNA_pointer_create(NULL, &RNA_NlaStrip, strip, &strip_ptr);
938                 
939                 /* execute these settings as per normal */
940                 animsys_evaluate_fcurves(&strip_ptr, &strip->fcurves, NULL, ctime);
941         }
942 }
943
944 /* gets the strip active at the current time for a list of strips for evaluation purposes */
945 NlaEvalStrip *nlastrips_ctime_get_strip (ListBase *list, ListBase *strips, short index, float ctime)
946 {
947         NlaStrip *strip, *estrip=NULL;
948         NlaEvalStrip *nes;
949         short side= 0;
950         
951         /* loop over strips, checking if they fall within the range */
952         for (strip= strips->first; strip; strip= strip->next) {
953                 /* check if current time occurs within this strip  */
954                 if (IN_RANGE_INCL(ctime, strip->start, strip->end)) {
955                         /* this strip is active, so try to use it */
956                         estrip= strip;
957                         side= NES_TIME_WITHIN;
958                         break;
959                 }
960                 
961                 /* if time occurred before current strip... */
962                 if (ctime < strip->start) {
963                         if (strip == strips->first) {
964                                 /* before first strip - only try to use it if it extends backwards in time too */
965                                 if (strip->extendmode == NLASTRIP_EXTEND_HOLD)
966                                         estrip= strip;
967                                         
968                                 /* side is 'before' regardless of whether there's a useful strip */
969                                 side= NES_TIME_BEFORE;
970                         }
971                         else {
972                                 /* before next strip - previous strip has ended, but next hasn't begun, 
973                                  * so blending mode depends on whether strip is being held or not...
974                                  *      - only occurs when no transition strip added, otherwise the transition would have
975                                  *        been picked up above...
976                                  */
977                                 strip= strip->prev;
978                                 
979                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
980                                         estrip= strip;
981                                 side= NES_TIME_AFTER;
982                         }
983                         break;
984                 }
985                 
986                 /* if time occurred after current strip... */
987                 if (ctime > strip->end) {
988                         /* only if this is the last strip should we do anything, and only if that is being held */
989                         if (strip == strips->last) {
990                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
991                                         estrip= strip;
992                                         
993                                 side= NES_TIME_AFTER;
994                                 break;
995                         }
996                         
997                         /* otherwise, skip... as the 'before' case will catch it more elegantly! */
998                 }
999         }
1000         
1001         /* check if a valid strip was found
1002          *      - must not be muted (i.e. will have contribution
1003          */
1004         if ((estrip == NULL) || (estrip->flag & NLASTRIP_FLAG_MUTED)) 
1005                 return NULL;
1006                 
1007         /* if ctime was not within the boundaries of the strip, clamp! */
1008         switch (side) {
1009                 case NES_TIME_BEFORE: /* extend first frame only */
1010                         ctime= estrip->start;
1011                         break;
1012                 case NES_TIME_AFTER: /* extend last frame only */
1013                         ctime= estrip->end;
1014                         break;
1015         }
1016         
1017         /* evaluate strip's evaluation controls  
1018          *      - skip if no influence (i.e. same effect as muting the strip)
1019          *      - negative influence is not supported yet... how would that be defined?
1020          */
1021         // TODO: this sounds a bit hacky having a few isolated F-Curves stuck on some data it operates on...
1022         nlastrip_evaluate_controls(estrip, ctime);
1023         if (estrip->influence <= 0.0f)
1024                 return NULL;
1025                 
1026         /* check if strip has valid data to evaluate,
1027          * and/or perform any additional type-specific actions
1028          */
1029         switch (estrip->type) {
1030                 case NLASTRIP_TYPE_CLIP: 
1031                         /* clip must have some action to evaluate */
1032                         if (estrip->act == NULL)
1033                                 return NULL;
1034                         break;
1035                 case NLASTRIP_TYPE_TRANSITION:
1036                         /* there must be strips to transition from and to (i.e. prev and next required) */
1037                         if (ELEM(NULL, estrip->prev, estrip->next))
1038                                 return NULL;
1039                                 
1040                         /* evaluate controls for the relevant extents of the bordering strips... */
1041                         nlastrip_evaluate_controls(estrip->prev, estrip->start);
1042                         nlastrip_evaluate_controls(estrip->next, estrip->end);
1043                         break;
1044         }
1045         
1046         /* add to list of strips we need to evaluate */
1047         nes= MEM_callocN(sizeof(NlaEvalStrip), "NlaEvalStrip");
1048         
1049         nes->strip= estrip;
1050         nes->strip_mode= side;
1051         nes->track_index= index;
1052         nes->strip_time= estrip->strip_time;
1053         
1054         if (list)
1055                 BLI_addtail(list, nes);
1056         
1057         return nes;
1058 }
1059
1060 /* ---------------------- */
1061
1062 /* find an NlaEvalChannel that matches the given criteria 
1063  *      - ptr and prop are the RNA data to find a match for
1064  */
1065 static NlaEvalChannel *nlaevalchan_find_match (ListBase *channels, PointerRNA *ptr, PropertyRNA *prop, int array_index)
1066 {
1067         NlaEvalChannel *nec;
1068         
1069         /* sanity check */
1070         if (channels == NULL)
1071                 return NULL;
1072         
1073         /* loop through existing channels, checking for a channel which affects the same property */
1074         for (nec= channels->first; nec; nec= nec->next) {
1075                 /* - comparing the PointerRNA's is done by comparing the pointers
1076                  *   to the actual struct the property resides in, since that all the
1077                  *   other data stored in PointerRNA cannot allow us to definitively 
1078                  *      identify the data 
1079                  */
1080                 if ((nec->ptr.data == ptr->data) && (nec->prop == prop) && (nec->index == array_index))
1081                         return nec;
1082         }
1083         
1084         /* not found */
1085         return NULL;
1086 }
1087
1088 /* verify that an appropriate NlaEvalChannel for this F-Curve exists */
1089 static NlaEvalChannel *nlaevalchan_verify (PointerRNA *ptr, ListBase *channels, NlaEvalStrip *nes, FCurve *fcu, short *newChan)
1090 {
1091         NlaEvalChannel *nec;
1092         NlaStrip *strip= nes->strip;
1093         PropertyRNA *prop;
1094         PointerRNA new_ptr;
1095         char *path = NULL;
1096         short free_path=0;
1097         
1098         /* sanity checks */
1099         if (channels == NULL)
1100                 return NULL;
1101         
1102         /* get RNA pointer+property info from F-Curve for more convenient handling */
1103                 /* get path, remapped as appropriate to work in its new environment */
1104         free_path= animsys_remap_path(strip->remap, fcu->rna_path, &path);
1105         
1106                 /* a valid property must be available, and it must be animateable */
1107         if (RNA_path_resolve(ptr, path, &new_ptr, &prop) == 0) {
1108                 if (G.f & G_DEBUG) printf("NLA Strip Eval: Cannot resolve path \n");
1109                 return NULL;
1110         }
1111                 /* only ok if animateable */
1112         else if (RNA_property_animateable(&new_ptr, prop) == 0) {
1113                 if (G.f & G_DEBUG) printf("NLA Strip Eval: Property not animateable \n");
1114                 return NULL;
1115         }
1116         
1117         /* try to find a match */
1118         nec= nlaevalchan_find_match(channels, &new_ptr, prop, fcu->array_index);
1119         
1120         /* allocate a new struct for this if none found */
1121         if (nec == NULL) {
1122                 nec= MEM_callocN(sizeof(NlaEvalChannel), "NlaEvalChannel");
1123                 *newChan= 1;
1124                 BLI_addtail(channels, nec);
1125                 
1126                 nec->ptr= new_ptr; 
1127                 nec->prop= prop;
1128                 nec->index= fcu->array_index;
1129         }
1130         else
1131                 *newChan= 0;
1132         
1133         /* we can now return */
1134         return nec;
1135 }
1136
1137 /* accumulate (i.e. blend) the given value on to the channel it affects */
1138 static void nlaevalchan_accumulate (NlaEvalChannel *nec, NlaEvalStrip *nes, short newChan, float value)
1139 {
1140         NlaStrip *strip= nes->strip;
1141         short blendmode= strip->blendmode;
1142         float inf= strip->influence;
1143         
1144         /* if channel is new, just store value regardless of blending factors, etc. */
1145         if (newChan) {
1146                 nec->value= value;
1147                 return;
1148         }
1149                 
1150         /* if this is being performed as part of transition evaluation, incorporate
1151          * an additional weighting factor for the influence
1152          */
1153         if (nes->strip_mode == NES_TIME_TRANSITION_END) 
1154                 inf *= nes->strip_time;
1155         
1156         /* premultiply the value by the weighting factor */
1157         if (IS_EQ(inf, 0)) return;
1158         value *= inf;
1159         
1160         /* perform blending */
1161         switch (blendmode) {
1162                 case NLASTRIP_MODE_ADD:
1163                         /* simply add the scaled value on to the stack */
1164                         nec->value += value;
1165                         break;
1166                         
1167                 case NLASTRIP_MODE_SUBTRACT:
1168                         /* simply subtract the scaled value from the stack */
1169                         nec->value -= value;
1170                         break;
1171                         
1172                 case NLASTRIP_MODE_MULTIPLY:
1173                         /* multiply the scaled value with the stack */
1174                         nec->value *= value;
1175                         break;
1176                 
1177                 case NLASTRIP_MODE_REPLACE:
1178                 default: // TODO: do we really want to blend by default? it seems more uses might prefer add...
1179                         /* do linear interpolation 
1180                          *      - the influence of the accumulated data (elsewhere, that is called dstweight) 
1181                          *        is 1 - influence, since the strip's influence is srcweight
1182                          */
1183                         nec->value= nec->value * (1.0f - inf)   +   value;
1184                         break;
1185         }
1186 }
1187
1188 /* accumulate the results of a temporary buffer with the results of the full-buffer */
1189 static void nlaevalchan_buffers_accumulate (ListBase *channels, ListBase *tmp_buffer, NlaEvalStrip *nes)
1190 {
1191         NlaEvalChannel *nec, *necn, *necd;
1192         
1193         /* optimise - abort if no channels */
1194         if (tmp_buffer->first == NULL)
1195                 return;
1196         
1197         /* accumulate results in tmp_channels buffer to the accumulation buffer */
1198         for (nec= tmp_buffer->first; nec; nec= necn) {
1199                 /* get pointer to next channel in case we remove the current channel from the temp-buffer */
1200                 necn= nec->next;
1201                 
1202                 /* try to find an existing matching channel for this setting in the accumulation buffer */
1203                 necd= nlaevalchan_find_match(channels, &nec->ptr, nec->prop, nec->index);
1204                 
1205                 /* if there was a matching channel already in the buffer, accumulate to it,
1206                  * otherwise, add the current channel to the buffer for efficiency
1207                  */
1208                 if (necd)
1209                         nlaevalchan_accumulate(necd, nes, 0, nec->value);
1210                 else {
1211                         BLI_remlink(tmp_buffer, nec);
1212                         BLI_addtail(channels, nec);
1213                 }
1214         }
1215         
1216         /* free temp-channels that haven't been assimilated into the buffer */
1217         BLI_freelistN(tmp_buffer);
1218 }
1219
1220 /* ---------------------- */
1221 /* F-Modifier stack joining/separation utilities - should we generalise these for BLI_listbase.h interface? */
1222
1223 /* Temporarily join two lists of modifiers together, storing the result in a third list */
1224 static void nlaeval_fmodifiers_join_stacks (ListBase *result, ListBase *list1, ListBase *list2)
1225 {
1226         FModifier *fcm1, *fcm2;
1227         
1228         /* if list1 is invalid...  */
1229         if ELEM(NULL, list1, list1->first) {
1230                 if (list2 && list2->first) {
1231                         result->first= list2->first;
1232                         result->last= list2->last;
1233                 }
1234         }
1235         /* if list 2 is invalid... */
1236         else if ELEM(NULL, list2, list2->first) {
1237                 result->first= list1->first;
1238                 result->last= list1->last;
1239         }
1240         else {
1241                 /* list1 should be added first, and list2 second, with the endpoints of these being the endpoints for result 
1242                  *      - the original lists must be left unchanged though, as we need that fact for restoring
1243                  */
1244                 result->first= list1->first;
1245                 result->last= list2->last;
1246                 
1247                 fcm1= list1->last;
1248                 fcm2= list2->first;
1249                 
1250                 fcm1->next= fcm2;
1251                 fcm2->prev= fcm1;
1252         }
1253 }
1254
1255 /* Split two temporary lists of modifiers */
1256 static void nlaeval_fmodifiers_split_stacks (ListBase *list1, ListBase *list2)
1257 {
1258         FModifier *fcm1, *fcm2;
1259         
1260         /* if list1/2 is invalid... just skip */
1261         if ELEM(NULL, list1, list2)
1262                 return;
1263         if ELEM(NULL, list1->first, list2->first)
1264                 return;
1265                 
1266         /* get endpoints */
1267         fcm1= list1->last;
1268         fcm2= list2->first;
1269         
1270         /* clear their links */
1271         fcm1->next= NULL;
1272         fcm2->prev= NULL;
1273 }
1274
1275 /* ---------------------- */
1276
1277 /* evaluate action-clip strip */
1278 static void nlastrip_evaluate_actionclip (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1279 {
1280         ListBase tmp_modifiers = {NULL, NULL};
1281         NlaStrip *strip= nes->strip;
1282         FCurve *fcu;
1283         float evaltime;
1284         
1285         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
1286         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers);
1287         
1288         /* evaluate strip's modifiers which modify time to evaluate the base curves at */
1289         evaltime= evaluate_time_fmodifiers(&tmp_modifiers, NULL, 0.0f, strip->strip_time);
1290         
1291         /* evaluate all the F-Curves in the action, saving the relevant pointers to data that will need to be used */
1292         for (fcu= strip->act->curves.first; fcu; fcu= fcu->next) {
1293                 NlaEvalChannel *nec;
1294                 float value = 0.0f;
1295                 short newChan = -1;
1296                 
1297                 /* check if this curve should be skipped */
1298                 if (fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) 
1299                         continue;
1300                 if ((fcu->grp) && (fcu->grp->flag & AGRP_MUTED))
1301                         continue;
1302                         
1303                 /* evaluate the F-Curve's value for the time given in the strip 
1304                  * NOTE: we use the modified time here, since strip's F-Curve Modifiers are applied on top of this 
1305                  */
1306                 value= evaluate_fcurve(fcu, evaltime);
1307                 
1308                 /* apply strip's F-Curve Modifiers on this value 
1309                  * NOTE: we apply the strip's original evaluation time not the modified one (as per standard F-Curve eval)
1310                  */
1311                 evaluate_value_fmodifiers(&tmp_modifiers, fcu, &value, strip->strip_time);
1312                 
1313                 
1314                 /* get an NLA evaluation channel to work with, and accumulate the evaluated value with the value(s)
1315                  * stored in this channel if it has been used already
1316                  */
1317                 nec= nlaevalchan_verify(ptr, channels, nes, fcu, &newChan);
1318                 if (nec)
1319                         nlaevalchan_accumulate(nec, nes, newChan, value);
1320         }
1321         
1322         /* unlink this strip's modifiers from the parent's modifiers again */
1323         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
1324 }
1325
1326 /* evaluate transition strip */
1327 static void nlastrip_evaluate_transition (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1328 {
1329         ListBase tmp_channels = {NULL, NULL};
1330         ListBase tmp_modifiers = {NULL, NULL};
1331         NlaEvalStrip tmp_nes;
1332         NlaStrip *s1, *s2;
1333         
1334         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
1335         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &nes->strip->modifiers, modifiers);
1336         
1337         /* get the two strips to operate on 
1338          *      - we use the endpoints of the strips directly flanking our strip
1339          *        using these as the endpoints of the transition (destination and source)
1340          *      - these should have already been determined to be valid...
1341          *      - if this strip is being played in reverse, we need to swap these endpoints
1342          *        otherwise they will be interpolated wrong
1343          */
1344         if (nes->strip->flag & NLASTRIP_FLAG_REVERSE) {
1345                 s1= nes->strip->next;
1346                 s2= nes->strip->prev;
1347         }
1348         else {
1349                 s1= nes->strip->prev;
1350                 s2= nes->strip->next;
1351         }
1352         
1353         /* prepare template for 'evaluation strip' 
1354          *      - based on the transition strip's evaluation strip data
1355          *      - strip_mode is NES_TIME_TRANSITION_* based on which endpoint
1356          *      - strip_time is the 'normalised' (i.e. in-strip) time for evaluation,
1357          *        which doubles up as an additional weighting factor for the strip influences
1358          *        which allows us to appear to be 'interpolating' between the two extremes
1359          */
1360         tmp_nes= *nes;
1361         
1362         /* evaluate these strips into a temp-buffer (tmp_channels) */
1363         // FIXME: modifier evalation here needs some work...
1364                 /* first strip */
1365         tmp_nes.strip_mode= NES_TIME_TRANSITION_START;
1366         tmp_nes.strip= s1;
1367         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, &tmp_nes);
1368         
1369                 /* second strip */
1370         tmp_nes.strip_mode= NES_TIME_TRANSITION_END;
1371         tmp_nes.strip= s2;
1372         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, &tmp_nes);
1373         
1374         
1375         /* assumulate temp-buffer and full-buffer, using the 'real' strip */
1376         nlaevalchan_buffers_accumulate(channels, &tmp_channels, nes);
1377         
1378         /* unlink this strip's modifiers from the parent's modifiers again */
1379         nlaeval_fmodifiers_split_stacks(&nes->strip->modifiers, modifiers);
1380 }
1381
1382 /* evaluate meta-strip */
1383 static void nlastrip_evaluate_meta (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1384 {
1385         ListBase tmp_channels = {NULL, NULL};
1386         ListBase tmp_modifiers = {NULL, NULL};
1387         NlaStrip *strip= nes->strip;
1388         NlaEvalStrip *tmp_nes;
1389         float evaltime;
1390         
1391         /* meta-strip was calculated normally to have some time to be evaluated at
1392          * and here we 'look inside' the meta strip, treating it as a decorated window to
1393          * it's child strips, which get evaluated as if they were some tracks on a strip 
1394          * (but with some extra modifiers to apply).
1395          *
1396          * NOTE: keep this in sync with animsys_evaluate_nla()
1397          */
1398          
1399         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
1400         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers); 
1401         
1402         /* find the child-strip to evaluate */
1403         evaltime= (nes->strip_time * (strip->end - strip->start)) + strip->start;
1404         tmp_nes= nlastrips_ctime_get_strip(NULL, &strip->strips, -1, evaltime);
1405         if (tmp_nes == NULL)
1406                 return;
1407                 
1408         /* evaluate child-strip into tmp_channels buffer before accumulating 
1409          * in the accumulation buffer
1410          */
1411         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, tmp_nes);
1412         
1413         /* assumulate temp-buffer and full-buffer, using the 'real' strip */
1414         nlaevalchan_buffers_accumulate(channels, &tmp_channels, nes);
1415         
1416         /* free temp eval-strip */
1417         MEM_freeN(tmp_nes);
1418         
1419         /* unlink this strip's modifiers from the parent's modifiers again */
1420         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
1421 }
1422
1423 /* evaluates the given evaluation strip */
1424 void nlastrip_evaluate (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1425 {
1426         NlaStrip *strip= nes->strip;
1427         
1428         /* to prevent potential infinite recursion problems (i.e. transition strip, beside meta strip containing a transition
1429          * several levels deep inside it), we tag the current strip as being evaluated, and clear this when we leave
1430          */
1431         // TODO: be careful with this flag, since some edit tools may be running and have set this while animplayback was running
1432         if (strip->flag & NLASTRIP_FLAG_EDIT_TOUCHED)
1433                 return;
1434         strip->flag |= NLASTRIP_FLAG_EDIT_TOUCHED;
1435         
1436         /* actions to take depend on the type of strip */
1437         switch (strip->type) {
1438                 case NLASTRIP_TYPE_CLIP: /* action-clip */
1439                         nlastrip_evaluate_actionclip(ptr, channels, modifiers, nes);
1440                         break;
1441                 case NLASTRIP_TYPE_TRANSITION: /* transition */
1442                         nlastrip_evaluate_transition(ptr, channels, modifiers, nes);
1443                         break;
1444                 case NLASTRIP_TYPE_META: /* meta */
1445                         nlastrip_evaluate_meta(ptr, channels, modifiers, nes);
1446                         break;
1447         }
1448         
1449         /* clear temp recursion safe-check */
1450         strip->flag &= ~NLASTRIP_FLAG_EDIT_TOUCHED;
1451 }
1452
1453 /* write the accumulated settings to */
1454 void nladata_flush_channels (ListBase *channels)
1455 {
1456         NlaEvalChannel *nec;
1457         
1458         /* sanity checks */
1459         if (channels == NULL)
1460                 return;
1461         
1462         /* for each channel with accumulated values, write its value on the property it affects */
1463         for (nec= channels->first; nec; nec= nec->next) {
1464                 PointerRNA *ptr= &nec->ptr;
1465                 PropertyRNA *prop= nec->prop;
1466                 int array_index= nec->index;
1467                 float value= nec->value;
1468                 
1469                 /* write values - see animsys_write_rna_setting() to sync the code */
1470                 switch (RNA_property_type(prop)) 
1471                 {
1472                         case PROP_BOOLEAN:
1473                                 if (RNA_property_array_length(ptr, prop))
1474                                         RNA_property_boolean_set_index(ptr, prop, array_index, (int)value);
1475                                 else
1476                                         RNA_property_boolean_set(ptr, prop, (int)value);
1477                                 break;
1478                         case PROP_INT:
1479                                 if (RNA_property_array_length(ptr, prop))
1480                                         RNA_property_int_set_index(ptr, prop, array_index, (int)value);
1481                                 else
1482                                         RNA_property_int_set(ptr, prop, (int)value);
1483                                 break;
1484                         case PROP_FLOAT:
1485                                 if (RNA_property_array_length(ptr, prop))
1486                                         RNA_property_float_set_index(ptr, prop, array_index, value);
1487                                 else
1488                                         RNA_property_float_set(ptr, prop, value);
1489                                 break;
1490                         case PROP_ENUM:
1491                                 RNA_property_enum_set(ptr, prop, (int)value);
1492                                 break;
1493                         default:
1494                                 // can't do anything with other types of property....
1495                                 break;
1496                 }
1497         }
1498 }
1499
1500 /* ---------------------- */
1501
1502 /* NLA Evaluation function (mostly for use through do_animdata) 
1503  *      - All channels that will be affected are not cleared anymore. Instead, we just evaluate into 
1504  *              some temp channels, where values can be accumulated in one go.
1505  */
1506 static void animsys_evaluate_nla (PointerRNA *ptr, AnimData *adt, float ctime)
1507 {
1508         ListBase dummy_trackslist = {NULL, NULL};
1509         NlaStrip dummy_strip;
1510         
1511         NlaTrack *nlt;
1512         short track_index=0;
1513         short has_strips = 0;
1514         
1515         ListBase estrips= {NULL, NULL};
1516         ListBase echannels= {NULL, NULL};
1517         NlaEvalStrip *nes;
1518         
1519         // TODO: need to zero out all channels used, otherwise we have problems with threadsafety
1520         // and also when the user jumps between different times instead of moving sequentially...
1521         
1522         /* 1. get the stack of strips to evaluate at current time (influence calculated here) */
1523         for (nlt=adt->nla_tracks.first; nlt; nlt=nlt->next, track_index++) { 
1524                 /* if tweaking is on and this strip is the tweaking track, stop on this one */
1525                 if ((adt->flag & ADT_NLA_EDIT_ON) && (nlt->flag & NLATRACK_DISABLED))
1526                         break;
1527                         
1528                 /* skip if we're only considering a track tagged 'solo' */
1529                 if ((adt->flag & ADT_NLA_SOLO_TRACK) && (nlt->flag & NLATRACK_SOLO)==0)
1530                         continue;
1531                 /* skip if track is muted */
1532                 if (nlt->flag & NLATRACK_MUTED) 
1533                         continue;
1534                         
1535                 /* if this track has strips (but maybe they won't be suitable), set has_strips 
1536                  *      - used for mainly for still allowing normal action evaluation...
1537                  */
1538                 if (nlt->strips.first)
1539                         has_strips= 1;
1540                         
1541                 /* otherwise, get strip to evaluate for this channel */
1542                 nes= nlastrips_ctime_get_strip(&estrips, &nlt->strips, track_index, ctime);
1543                 if (nes) nes->track= nlt;
1544         }
1545         
1546         /* add 'active' Action (may be tweaking track) as last strip to evaluate in NLA stack
1547          *      - only do this if we're not exclusively evaluating the 'solo' NLA-track
1548          */
1549         if ((adt->action) && !(adt->flag & ADT_NLA_SOLO_TRACK)) {
1550                 /* if there are strips, evaluate action as per NLA rules */
1551                 if (has_strips) {
1552                         /* make dummy NLA strip, and add that to the stack */
1553                         memset(&dummy_strip, 0, sizeof(NlaStrip));
1554                         dummy_trackslist.first= dummy_trackslist.last= &dummy_strip;
1555                         
1556                         dummy_strip.act= adt->action;
1557                         dummy_strip.remap= adt->remap;
1558                         
1559                         /* action range is calculated taking F-Modifiers into account (which making new strips doesn't do due to the troublesome nature of that) */
1560                         calc_action_range(dummy_strip.act, &dummy_strip.actstart, &dummy_strip.actend, 1);
1561                         dummy_strip.start = dummy_strip.actstart;
1562                         dummy_strip.end = (IS_EQ(dummy_strip.actstart, dummy_strip.actend)) ?  (dummy_strip.actstart + 1.0f): (dummy_strip.actend);
1563                         
1564                         dummy_strip.blendmode= adt->act_blendmode;
1565                         dummy_strip.extendmode= adt->act_extendmode;
1566                         dummy_strip.influence= adt->act_influence;
1567                         
1568                         /* add this to our list of evaluation strips */
1569                         nlastrips_ctime_get_strip(&estrips, &dummy_trackslist, -1, ctime);
1570                 }
1571                 else {
1572                         /* special case - evaluate as if there isn't any NLA data */
1573                         // TODO: this is really just a stop-gap measure...
1574                         animsys_evaluate_action(ptr, adt->action, adt->remap, ctime);
1575                         return;
1576                 }
1577         }
1578         
1579         /* only continue if there are strips to evaluate */
1580         if (estrips.first == NULL)
1581                 return;
1582         
1583         
1584         /* 2. for each strip, evaluate then accumulate on top of existing channels, but don't set values yet */
1585         for (nes= estrips.first; nes; nes= nes->next) 
1586                 nlastrip_evaluate(ptr, &echannels, NULL, nes);
1587         
1588         /* 3. flush effects of accumulating channels in NLA to the actual data they affect */
1589         nladata_flush_channels(&echannels);
1590         
1591         /* 4. free temporary evaluation data */
1592         BLI_freelistN(&estrips);
1593         BLI_freelistN(&echannels);
1594 }
1595
1596 /* ***************************************** */ 
1597 /* Overrides System - Public API */
1598
1599 /* Clear all overides */
1600
1601 /* Add or get existing Override for given setting */
1602 AnimOverride *BKE_animsys_validate_override (PointerRNA *ptr, char *path, int array_index)
1603 {
1604         // FIXME: need to define how to get overrides
1605         return NULL;
1606
1607
1608 /* -------------------- */
1609
1610 /* Evaluate Overrides */
1611 static void animsys_evaluate_overrides (PointerRNA *ptr, AnimData *adt, float ctime)
1612 {
1613         AnimOverride *aor;
1614         
1615         /* for each override, simply execute... */
1616         for (aor= adt->overrides.first; aor; aor= aor->next)
1617                 animsys_write_rna_setting(ptr, aor->rna_path, aor->array_index, aor->value);
1618 }
1619
1620 /* ***************************************** */
1621 /* Evaluation System - Public API */
1622
1623 /* Overview of how this system works:
1624  *      1) Depsgraph sorts data as necessary, so that data is in an order that means 
1625  *              that all dependences are resolved before dependants.
1626  *      2) All normal animation is evaluated, so that drivers have some basis values to
1627  *              work with
1628  *              a.      NLA stacks are done first, as the Active Actions act as 'tweaking' tracks
1629  *                      which modify the effects of the NLA-stacks
1630  *              b.      Active Action is evaluated as per normal, on top of the results of the NLA tracks
1631  *
1632  * --------------< often in a separate phase... >------------------ 
1633  *
1634  *      3) Drivers/expressions are evaluated on top of this, in an order where dependences are
1635  *              resolved nicely. 
1636  *         Note: it may be necessary to have some tools to handle the cases where some higher-level
1637  *              drivers are added and cause some problematic dependencies that didn't exist in the local levels...
1638  *
1639  * --------------< always executed >------------------ 
1640  *
1641  * Maintainance of editability of settings (XXX):
1642  *      In order to ensure that settings that are animated can still be manipulated in the UI without requiring
1643  *      that keyframes are added to prevent these values from being overwritten, we use 'overrides'. 
1644  *
1645  * Unresolved things:
1646  *      - Handling of multi-user settings (i.e. time-offset, group-instancing) -> big cache grids or nodal system? but stored where?
1647  *      - Multiple-block dependencies (i.e. drivers for settings are in both local and higher levels) -> split into separate lists? 
1648  *
1649  * Current Status:
1650  *      - Currently (as of September 2009), overrides we haven't needed to (fully) implement overrides. 
1651  *        However, the code fo this is relatively harmless, so is left in the code for now.
1652  */
1653
1654 /* Evaluation loop for evaluation animation data 
1655  *
1656  * This assumes that the animation-data provided belongs to the ID block in question,
1657  * and that the flags for which parts of the anim-data settings need to be recalculated 
1658  * have been set already by the depsgraph. Now, we use the recalc 
1659  */
1660 void BKE_animsys_evaluate_animdata (ID *id, AnimData *adt, float ctime, short recalc)
1661 {
1662         PointerRNA id_ptr;
1663         
1664         /* sanity checks */
1665         if ELEM(NULL, id, adt)
1666                 return;
1667         
1668         /* get pointer to ID-block for RNA to use */
1669         RNA_id_pointer_create(id, &id_ptr);
1670         
1671         /* recalculate keyframe data:
1672          *      - NLA before Active Action, as Active Action behaves as 'tweaking track'
1673          *        that overrides 'rough' work in NLA
1674          */
1675         // TODO: need to double check that this all works correctly
1676         if ((recalc & ADT_RECALC_ANIM) || (adt->recalc & ADT_RECALC_ANIM))
1677         {
1678                 /* evaluate NLA data */
1679                 if ((adt->nla_tracks.first) && !(adt->flag & ADT_NLA_EVAL_OFF))
1680                 {
1681                         /* evaluate NLA-stack 
1682                          *      - active action is evaluated as part of the NLA stack as the last item
1683                          */
1684                         animsys_evaluate_nla(&id_ptr, adt, ctime);
1685                 }
1686                 /* evaluate Active Action only */
1687                 else if (adt->action)
1688                         animsys_evaluate_action(&id_ptr, adt->action, adt->remap, ctime);
1689                 
1690                 /* reset tag */
1691                 adt->recalc &= ~ADT_RECALC_ANIM;
1692         }
1693         
1694         /* recalculate drivers 
1695          *      - Drivers need to be evaluated afterwards, as they can either override 
1696          *        or be layered on top of existing animation data.
1697          *      - Drivers should be in the appropriate order to be evaluated without problems...
1698          */
1699         if ((recalc & ADT_RECALC_DRIVERS) /*&& (adt->recalc & ADT_RECALC_DRIVERS)*/) // XXX for now, don't check yet, as depsgraph hasn't been updated
1700         {
1701                 animsys_evaluate_drivers(&id_ptr, adt, ctime);
1702         }
1703         
1704         /* always execute 'overrides' 
1705          *      - Overrides allow editing, by overwriting the value(s) set from animation-data, with the
1706          *        value last set by the user (and not keyframed yet). 
1707          *      - Overrides are cleared upon frame change and/or keyframing
1708          *      - It is best that we execute this everytime, so that no errors are likely to occur.
1709          */
1710         animsys_evaluate_overrides(&id_ptr, adt, ctime);
1711         
1712         /* clear recalc flag now */
1713         adt->recalc= 0;
1714 }
1715
1716 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only
1717  *
1718  * This will evaluate only the animation info available in the animation data-blocks
1719  * encountered. In order to enforce the system by which some settings controlled by a
1720  * 'local' (i.e. belonging in the nearest ID-block that setting is related to, not a
1721  * standard 'root') block are overridden by a larger 'user'
1722  */
1723 void BKE_animsys_evaluate_all_animation (Main *main, float ctime)
1724 {
1725         ID *id;
1726         
1727         if (G.f & G_DEBUG)
1728                 printf("Evaluate all animation - %f \n", ctime);
1729         
1730         /* macro for less typing 
1731          *      - only evaluate animation data for id if it has users (and not just fake ones)
1732          *      - whether animdata exists is checked for by the evaluation function, though taking 
1733          *        this outside of the function may make things slightly faster?
1734          */
1735 #define EVAL_ANIM_IDS(first, aflag) \
1736         for (id= first; id; id= id->next) { \
1737                 AnimData *adt= BKE_animdata_from_id(id); \
1738                 if ( (id->us > 1) || (id->us && !(id->flag & LIB_FAKEUSER)) ) \
1739                         BKE_animsys_evaluate_animdata(id, adt, ctime, aflag); \
1740         }
1741         
1742         /* optimisation: 
1743          * when there are no actions, don't go over database and loop over heaps of datablocks, 
1744          * which should ultimately be empty, since it is not possible for now to have any animation 
1745          * without some actions, and drivers wouldn't get affected by any state changes
1746          *
1747          * however, if there are some curves, we will need to make sure that their 'ctime' property gets
1748          * set correctly, so this optimisation must be skipped in that case...
1749          */
1750         if ((main->action.first == NULL) && (main->curve.first == NULL)) {
1751                 if (G.f & G_DEBUG)
1752                         printf("\tNo Actions, so no animation needs to be evaluated...\n");
1753                         
1754                 return;
1755         }
1756         
1757         /* nodes */
1758         EVAL_ANIM_IDS(main->nodetree.first, ADT_RECALC_ANIM);
1759         
1760         /* textures */
1761         EVAL_ANIM_IDS(main->tex.first, ADT_RECALC_ANIM);
1762         
1763         /* lamps */
1764         EVAL_ANIM_IDS(main->lamp.first, ADT_RECALC_ANIM);
1765         
1766         /* materials */
1767         EVAL_ANIM_IDS(main->mat.first, ADT_RECALC_ANIM);
1768         
1769         /* cameras */
1770         EVAL_ANIM_IDS(main->camera.first, ADT_RECALC_ANIM);
1771         
1772         /* shapekeys */
1773                 // TODO: we probably need the same hack as for curves (ctime-hack)
1774         EVAL_ANIM_IDS(main->key.first, ADT_RECALC_ANIM);
1775         
1776         /* metaballs */
1777         EVAL_ANIM_IDS(main->mball.first, ADT_RECALC_ANIM);
1778         
1779         /* curves */
1780                 /* we need to perform a special hack here to ensure that the ctime 
1781                  * value of the curve gets set in case there's no animation for that
1782                  *      - it needs to be set before animation is evaluated just so that 
1783                  *        animation can successfully override...
1784                  *      - it shouldn't get set when calculating drivers...
1785                  */
1786         for (id= main->curve.first; id; id= id->next) {
1787                 AnimData *adt= BKE_animdata_from_id(id);
1788                 Curve *cu= (Curve *)id;
1789                 
1790                 /* set ctime variable for curve */
1791                 cu->ctime= ctime;
1792                 
1793                 /* now execute animation data on top of this as per normal */
1794                 BKE_animsys_evaluate_animdata(id, adt, ctime, ADT_RECALC_ANIM);
1795         }
1796         
1797         /* armatures */
1798         EVAL_ANIM_IDS(main->armature.first, ADT_RECALC_ANIM);
1799         
1800         /* meshes */
1801         EVAL_ANIM_IDS(main->mesh.first, ADT_RECALC_ANIM);
1802         
1803         /* particles */
1804         EVAL_ANIM_IDS(main->particle.first, ADT_RECALC_ANIM);
1805         
1806         /* objects */
1807                 /* ADT_RECALC_ANIM doesn't need to be supplied here, since object AnimData gets 
1808                  * this tagged by Depsgraph on framechange. This optimisation means that objects
1809                  * linked from other (not-visible) scenes will not need their data calculated.
1810                  */
1811         EVAL_ANIM_IDS(main->object.first, 0); 
1812         
1813         /* worlds */
1814         EVAL_ANIM_IDS(main->world.first, ADT_RECALC_ANIM);
1815         
1816         /* scenes */
1817         for (id= main->scene.first; id; id= id->next) {
1818                 AnimData *adt= BKE_animdata_from_id(id);
1819                 Scene *scene= (Scene *)id;
1820                 
1821                 /* do compositing nodes first (since these aren't included in main tree) */
1822                 if (scene->nodetree) {
1823                         AnimData *adt2= BKE_animdata_from_id((ID *)scene->nodetree);
1824                         BKE_animsys_evaluate_animdata((ID *)scene->nodetree, adt2, ctime, ADT_RECALC_ANIM);
1825                 }
1826                 
1827                 /* now execute scene animation data as per normal */
1828                 BKE_animsys_evaluate_animdata(id, adt, ctime, ADT_RECALC_ANIM);
1829         }
1830 }
1831
1832 /* ***************************************** */