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