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