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