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