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