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