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