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